Record Class HybridKeyPair

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

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

    • HybridKeyPair

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

    • mlKemPublicKeyBytes

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

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

      public String mlKemPublicKey()
      Returns the value of the mlKemPublicKey record component.
      Returns:
      the value of the mlKemPublicKey record component
    • x25519PublicKey

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