Record Class MlKemKeyPair

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.MlKemKeyPair
Record Components:
algorithm - KEM algorithm
keyId - identifier of the server-held key; use it with the signing, decryption and decapsulation routes
publicKey - the 1184-byte ML-KEM-768 public key; lowercase hex

public record MlKemKeyPair(String algorithm, String keyId, String publicKey) extends Record
What POST /v2/pq/keygen answers: generate a server-held ML-KEM-768 key pair.
  • Constructor Details

    • MlKemKeyPair

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

    • publicKeyBytes

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

      public String keyId()
      Returns the value of the keyId record component.
      Returns:
      the value of the keyId record component
    • publicKey

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