Class: Aws::KMS::Types::DeriveSharedSecretRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-kms/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#dry_run ⇒ Boolean

Checks if your request will succeed. ‘DryRun` is an optional parameter.

To learn more about how to use this parameter, see [Testing your permissions] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/testing-permissions.html

Returns:

  • (Boolean) 


1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-kms/types.rb', line 1990

class DeriveSharedSecretRequest < Struct.new(
  :key_id,
  :key_agreement_algorithm,
  :public_key,
  :grant_tokens,
  :dry_run,
  :recipient)
  SENSITIVE = []
  include Aws::Structure
end

#grant_tokens ⇒ Array<String>

A list of grant tokens.

Use a grant token when your permission to call this operation comes from a new grant that has not yet achieved *eventual consistency*. For more information, see [Grant token] and [Using a grant token] in the *Key Management Service Developer Guide*.

[1]: docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: docs.aws.amazon.com/kms/latest/developerguide/using-grant-token.html

Returns:

  • (Array<String>) 


1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-kms/types.rb', line 1990

class DeriveSharedSecretRequest < Struct.new(
  :key_id,
  :key_agreement_algorithm,
  :public_key,
  :grant_tokens,
  :dry_run,
  :recipient)
  SENSITIVE = []
  include Aws::Structure
end

#key_agreement_algorithm ⇒ String

Specifies the key agreement algorithm used to derive the shared secret. The only valid value is ‘ECDH`.

Returns:

  • (String) 


1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-kms/types.rb', line 1990

class DeriveSharedSecretRequest < Struct.new(
  :key_id,
  :key_agreement_algorithm,
  :public_key,
  :grant_tokens,
  :dry_run,
  :recipient)
  SENSITIVE = []
  include Aws::Structure
end

#key_id ⇒ String

Identifies an asymmetric NIST-standard ECC or SM2 (China Regions only) KMS key. KMS uses the private key in the specified key pair to derive the shared secret. The key usage of the KMS key must be ‘KEY_AGREEMENT`. To find the `KeyUsage` of a KMS key, use the DescribeKey operation.

To specify a KMS key, use its key ID, key ARN, alias name, or alias ARN. When using an alias name, prefix it with ‘“alias/”`. To specify a KMS key in a different Amazon Web Services account, you must use the key ARN or alias ARN.

For example:

  • Key ID: ‘1234abcd-12ab-34cd-56ef-1234567890ab`

  • Key ARN: ‘arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`

  • Alias name: ‘alias/ExampleAlias`

  • Alias ARN: ‘arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias`

To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey. To get the alias name and alias ARN, use ListAliases.

Returns:

  • (String) 


1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-kms/types.rb', line 1990

class DeriveSharedSecretRequest < Struct.new(
  :key_id,
  :key_agreement_algorithm,
  :public_key,
  :grant_tokens,
  :dry_run,
  :recipient)
  SENSITIVE = []
  include Aws::Structure
end

#public_key ⇒ String

Specifies the public key in your peer’s NIST-standard elliptic curve (ECC) or SM2 (China Regions only) key pair.

The public key must be a DER-encoded X.509 public key, also known as ‘SubjectPublicKeyInfo` (SPKI), as defined in [RFC 5280].

GetPublicKey returns the public key of an asymmetric KMS key pair in the required DER-encoded format.

<note markdown=“1”> If you use [Amazon Web Services CLI version 1], you must provide the DER-encoded X.509 public key in a file. Otherwise, the Amazon Web Services CLI Base64-encodes the public key a second time, resulting in a ‘ValidationException`.

</note>

You can specify the public key as binary data in a file using fileb (‘fileb://<path-to-file>`) or in-line using a Base64 encoded string.

[1]: tools.ietf.org/html/rfc5280 [2]: docs.aws.amazon.com/cli/v1/userguide/cli-chap-welcome.html

Returns:

  • (String) 


1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-kms/types.rb', line 1990

class DeriveSharedSecretRequest < Struct.new(
  :key_id,
  :key_agreement_algorithm,
  :public_key,
  :grant_tokens,
  :dry_run,
  :recipient)
  SENSITIVE = []
  include Aws::Structure
end

#recipient ⇒ Types::RecipientInfo

A signed [attestation document] from an Amazon Web Services Nitro enclave or NitroTPM, and the encryption algorithm to use with the public key in the attestation document. The only valid encryption algorithm is ‘RSAES_OAEP_SHA_256`.

This parameter only supports attestation documents for Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM. To call DeriveSharedSecret generate an attestation document use either

Amazon Web Services Nitro Enclaves SDK][2

for an Amazon Web

Services Nitro Enclaves or [Amazon Web Services NitroTPM tools] for Amazon Web Services NitroTPM. Then use the Recipient parameter from any Amazon Web Services SDK to provide the attestation document for the attested environment.

When you use this parameter, instead of returning a plaintext copy of the shared secret, KMS encrypts the plaintext shared secret under the public key in the attestation document, and returns the resulting ciphertext in the ‘CiphertextForRecipient` field in the response. This ciphertext can be decrypted only with the private key in the attested environment. The `CiphertextBlob` field in the response contains the encrypted shared secret derived from the KMS key specified by the `KeyId` parameter and public key specified by the `PublicKey` parameter. The `SharedSecret` field in the response is null or empty.

For information about the interaction between KMS and Amazon Web Services Nitro Enclaves or Amazon Web Services NitroTPM, see

Cryptographic attestation support in KMS][4

in the *Key Management

Service Developer Guide*.

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitro-enclave-how.html#term-attestdoc [2]: docs.aws.amazon.com/enclaves/latest/user/developing-applications.html#sdk [3]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/attestation-get-doc.html [4]: docs.aws.amazon.com/kms/latest/developerguide/cryptographic-attestation.html

Returns:



1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
 
# File 'lib/aws-sdk-kms/types.rb', line 1990

class DeriveSharedSecretRequest < Struct.new(
  :key_id,
  :key_agreement_algorithm,
  :public_key,
  :grant_tokens,
  :dry_run,
  :recipient)
  SENSITIVE = []
  include Aws::Structure
end