Record Class HybridEncapsulateResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.HybridEncapsulateResult
Record Components:
algorithm - hybrid KEM algorithm
combiner - shared-secret combiner
mlKemCiphertext - the 1088-byte ML-KEM-768 ciphertext; lowercase hex
sharedSecret - the 32-byte shared secret; lowercase hex
x25519EphemeralPublic - the 32-byte ephemeral X25519 public key; lowercase hex

public record HybridEncapsulateResult(String algorithm, String combiner, String mlKemCiphertext, String sharedSecret, String x25519EphemeralPublic) extends Record
What POST /v2/pq/hybrid/encapsulate answers: hybrid encapsulate (X25519 + ML-KEM-768).
  • Constructor Details

    • HybridEncapsulateResult

      public HybridEncapsulateResult(String algorithm, String combiner, String mlKemCiphertext, String sharedSecret, String x25519EphemeralPublic)
      Creates an instance of a HybridEncapsulateResult record class.
      Parameters:
      algorithm - the value for the algorithm record component
      combiner - the value for the combiner record component
      mlKemCiphertext - the value for the mlKemCiphertext record component
      sharedSecret - the value for the sharedSecret record component
      x25519EphemeralPublic - the value for the x25519EphemeralPublic record component
  • Method Details

    • mlKemCiphertextBytes

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

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

      public String combiner()
      Returns the value of the combiner record component.
      Returns:
      the value of the combiner record component
    • mlKemCiphertext

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

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

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