Package com.codevasp.lazysodium.utils

Class Key

java.lang.Object
com.codevasp.lazysodium.utils.Key
public class Key extends Object

  • Method Details

    • getAsBytes

      public byte[] getAsBytes()

    • getAsHexString

      public String getAsHexString()

    • getAsPlainString

      public String getAsPlainString(Charset charset)

    • getAsPlainString

      public String getAsPlainString()

    • fromHexString

      public static Key fromHexString(String hexString)
      Create a Key from a hexadecimal string.
      Parameters:
      hexString - A hexadecimal encoded string.
      Returns:
      A new Key.

    • fromBase64String

      public static Key fromBase64String(String base64String, Base64Facade base64Facade)
      Create a Key from a base64 string.
      Parameters:
      base64String - A base64 encoded string.
      base64Facade - A base64 encoder for Java or Android.
      Returns:
      A new Key.

    • fromBase64String

      public static Key fromBase64String(String base64String)
      Create a Key from a base64 string. Only use this if you have initialised Sodium.base64Facade either directly or via calling LazySodiumJava() or LazySodiumAndroid().
      Parameters:
      base64String - A base64 encoded string.
      Returns:
      A new Key.

    • fromPlainString

      public static Key fromPlainString(String str)
      Create a Key from a regular, unmodified, not encoded string.
      Parameters:
      str - A plain string.
      Returns:
      A new Key.

    • fromPlainString

      public static Key fromPlainString(String str, Charset charset)
      Create a Key from a regular, unmodified, not encoded string.
      Parameters:
      str - A plain string.
      charset - The charset to use.
      Returns:
      A new Key.

    • fromBytes

      public static Key fromBytes(byte[] bytes)
      Create a Key by supplying raw bytes. The byte array should not be encoded and should be from a plain string, UNLESS you know what you are doing and actively want to provide a byte array that has been encoded.
      Parameters:
      bytes - A byte array.
      Returns:
      A new Key.

    • generate

      public static Key generate(LazySodium ls, int size)
      Generate a random Key with a given size.
      Parameters:
      ls - LazySodium instance as we need to get true random bytes.
      size - The size of the key to generate.
      Returns:
      A new Key.

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object