Record Class KmsDataKey

java.lang.Object
java.lang.Record
co.cryptoservice.sdk.KmsDataKey
Record Components:
ciphertext - the data key, encrypted by the KMS key; opaque, provider-specific string; pass it back unchanged
keyId - the provider's key identifier (local keys: local-<hex>)
plaintext - the data key bytes; use, then discard; lowercase hex
provider - the provider that served the request (local, aws, gcp, vault)

public record KmsDataKey(String ciphertext, String keyId, String plaintext, String provider) extends Record
What POST /v2/kms/generate-data-key answers: generate a Data Encryption Key (DEK) via KMS provider.
  • Constructor Details

    • KmsDataKey

      public KmsDataKey(String ciphertext, String keyId, String plaintext, String provider)
      Creates an instance of a KmsDataKey record class.
      Parameters:
      ciphertext - the value for the ciphertext record component
      keyId - the value for the keyId record component
      plaintext - the value for the plaintext record component
      provider - the value for the provider record component
  • Method Details

    • plaintextBytes

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

      public String ciphertext()
      Returns the value of the ciphertext record component.
      Returns:
      the value of the ciphertext record component
    • keyId

      public String keyId()
      Returns the value of the keyId record component.
      Returns:
      the value of the keyId record component
    • plaintext

      public String plaintext()
      Returns the value of the plaintext record component.
      Returns:
      the value of the plaintext record component
    • provider

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