Record Class MlKemEncapsulateResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.MlKemEncapsulateResult
Record Components:
algorithm - KEM algorithm
ciphertext - the 1088-byte ML-KEM-768 ciphertext; lowercase hex
sharedSecret - the 32-byte shared secret; lowercase hex

public record MlKemEncapsulateResult(String algorithm, String ciphertext, String sharedSecret) extends Record
What POST /v2/pq/encapsulate answers: ML-KEM encapsulate.
  • Constructor Details

    • MlKemEncapsulateResult

      public MlKemEncapsulateResult(String algorithm, String ciphertext, String sharedSecret)
      Creates an instance of a MlKemEncapsulateResult record class.
      Parameters:
      algorithm - the value for the algorithm record component
      ciphertext - the value for the ciphertext record component
      sharedSecret - the value for the sharedSecret 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
    • sharedSecretBytes

      public byte[] sharedSecretBytes()
      sharedSecret() decoded from hex.
      Returns:
      the bytes, or null when sharedSecret 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.
    • algorithm

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

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

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