Record Class PasswordEncryptResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.PasswordEncryptResult
Record Components:
algorithm - envelope algorithm
encrypted - self-describing envelope: version, Argon2id parameters, salt, nonce and ciphertext; pass it to /v2/password/decrypt as ciphertext; standard base64 (RFC 4648 section 4), padded

public record PasswordEncryptResult(String algorithm, String encrypted) extends Record
What POST /v2/password/encrypt answers: encrypt with password (Argon2id + XChaCha20-Poly1305).
  • Constructor Details

    • PasswordEncryptResult

      public PasswordEncryptResult(String algorithm, String encrypted)
      Creates an instance of a PasswordEncryptResult record class.
      Parameters:
      algorithm - the value for the algorithm record component
      encrypted - the value for the encrypted record component
  • Method Details

    • encryptedBytes

      public byte[] encryptedBytes()
      encrypted() decoded from base64.
      Returns:
      the bytes, or null when encrypted is absent
      Throws:
      IllegalArgumentException - when the server sent malformed base64
    • toString

      public String toString()
      Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.
      Specified by:
      toString in class Record
      Returns:
      a description safe to log
    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object
    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.
    • algorithm

      public String algorithm()
      Returns the value of the algorithm record component.
      Returns:
      the value of the algorithm record component
    • encrypted

      public String encrypted()
      Returns the value of the encrypted record component.
      Returns:
      the value of the encrypted record component