Package co.cryptoservice.sdk
Record Class MlKemEncapsulateResult
java.lang.Object
java.lang.Record
co.cryptoservice.sdk.MlKemEncapsulateResult
- Record Components:
algorithm- KEM algorithmciphertext- the 1088-byte ML-KEM-768 ciphertext; lowercase hex- 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 Summary
ConstructorsConstructorDescriptionMlKemEncapsulateResult(String algorithm, String ciphertext, String sharedSecret) Creates an instance of aMlKemEncapsulateResultrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thealgorithmrecord component.Returns the value of theciphertextrecord component.byte[]ciphertext()decoded from hex.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.Returns the value of thesharedSecretrecord component.byte[]sharedSecret()decoded from hex.toString()Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted.
-
Constructor Details
-
MlKemEncapsulateResult
Creates an instance of aMlKemEncapsulateResultrecord class.- Parameters:
algorithm- the value for thealgorithmrecord componentciphertext- the value for theciphertextrecord componentsharedSecret- the value for thesharedSecretrecord component
-
-
Method Details
-
ciphertextBytes
public byte[] ciphertextBytes()ciphertext()decoded from hex.- Returns:
- the bytes, or null when
ciphertextis absent - Throws:
IllegalArgumentException- when the server sent malformed hex
-
toString
Names the members; values that may be secret (keys, plaintexts, passwords, signatures) are redacted. -
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. -
equals
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 withObjects::equals(Object,Object). -
algorithm
Returns the value of thealgorithmrecord component.- Returns:
- the value of the
algorithmrecord component
-
ciphertext
Returns the value of theciphertextrecord component.- Returns:
- the value of the
ciphertextrecord component
-