Record Class KeyExportResult

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KeyExportResult
Record Components:
algorithm - algorithm of the key, e.g. ed25519, x25519, ml-kem-768, x25519-ml-kem-768, ml-dsa-65, slh-dsa-sha2-128f
keyId - identifier of the server-held key; use it with the signing, decryption and decapsulation routes
mlKemPublicKey - ML-KEM-768 public key (x25519-ml-kem-768); lowercase hex, or null when absent
mlKemSecretKey - ML-KEM-768 secret key (x25519-ml-kem-768); lowercase hex, or null when absent
privateKey - private key (POST /v2/keys/generate and POST /v2/hpke/keygen); lowercase hex, or null when absent
publicKey - public key (single-key algorithms); lowercase hex, or null when absent
secretKey - secret key (POST /v2/pq/keygen, /v2/pq/dsa/keygen, /v2/pq/slh-dsa/keygen); lowercase hex, or null when absent
x25519PrivateKey - X25519 private key (x25519-ml-kem-768); lowercase hex, or null when absent
x25519PublicKey - X25519 public key (x25519-ml-kem-768); lowercase hex, or null when absent

public record KeyExportResult(String algorithm, String keyId, String mlKemPublicKey, String mlKemSecretKey, String privateKey, String publicKey, String secretKey, String x25519PrivateKey, String x25519PublicKey) extends Record
What POST /v2/keys/export answers: export a server-held private key.
  • Constructor Details

    • KeyExportResult

      public KeyExportResult(String algorithm, String keyId, String mlKemPublicKey, String mlKemSecretKey, String privateKey, String publicKey, String secretKey, String x25519PrivateKey, String x25519PublicKey)
      Creates an instance of a KeyExportResult 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
      mlKemSecretKey - the value for the mlKemSecretKey record component
      privateKey - the value for the privateKey record component
      publicKey - the value for the publicKey record component
      secretKey - the value for the secretKey record component
      x25519PrivateKey - the value for the x25519PrivateKey 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
    • mlKemSecretKeyBytes

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

      public byte[] privateKeyBytes()
      privateKey() decoded from hex.
      Returns:
      the bytes, or null when privateKey is absent
      Throws:
      IllegalArgumentException - when the server sent malformed hex
    • 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
    • secretKeyBytes

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

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

      public String mlKemSecretKey()
      Returns the value of the mlKemSecretKey record component.
      Returns:
      the value of the mlKemSecretKey record component
    • privateKey

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

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

      public String secretKey()
      Returns the value of the secretKey record component.
      Returns:
      the value of the secretKey record component
    • x25519PrivateKey

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

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