Record Class HpkeSealResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.HpkeSealResult
Record Components:
ciphertext - the AEAD ciphertext, tag included; lowercase hex
encapsulatedKey - the KEM encapsulated key (enc); lowercase hex

public record HpkeSealResult(String ciphertext, String encapsulatedKey) extends Record
What POST /v2/hpke/seal answers: encrypt (seal) a message using HPKE (RFC 9180).
  • Constructor Details

    • HpkeSealResult

      public HpkeSealResult(String ciphertext, String encapsulatedKey)
      Creates an instance of a HpkeSealResult record class.
      Parameters:
      ciphertext - the value for the ciphertext record component
      encapsulatedKey - the value for the encapsulatedKey record component
  • Method Details

    • ciphertextBytes

      public byte[] ciphertextBytes()
      ciphertext() decoded from hex.
      Returns:
      the bytes, or null when ciphertext is absent
      Throws:
      IllegalArgumentException - when the server sent malformed hex
    • encapsulatedKeyBytes

      public byte[] encapsulatedKeyBytes()
      encapsulatedKey() decoded from hex.
      Returns:
      the bytes, or null when encapsulatedKey is absent
      Throws:
      IllegalArgumentException - when the server sent malformed hex
    • 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.
    • ciphertext

      public String ciphertext()
      Returns the value of the ciphertext record component.
      Returns:
      the value of the ciphertext record component
    • encapsulatedKey

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