Record Class HybridDecapsulateResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.HybridDecapsulateResult
Record Components:
algorithm - hybrid KEM algorithm
combiner - shared-secret combiner
sharedSecret - the 32-byte shared secret; lowercase hex

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

    • HybridDecapsulateResult

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

    • 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
    • combiner

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

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