Class: Aws::KMS::Types::VerifyRequest

Inherits:

Struct

• Object
• Struct
• Aws::KMS::Types::VerifyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-kms/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:message]

Instance Attribute Summary

• #dry_run ⇒ Boolean

  Checks if your request will succeed.

• #grant_tokens ⇒ Array<String>

  A list of grant tokens.

• #key_id ⇒ String

  Identifies the asymmetric KMS key that will be used to verify the signature.

• #message ⇒ String

  Specifies the message that was signed.

• #message_type ⇒ String

  Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm.

• #signature ⇒ String

  The signature that the Sign operation generated.

• #signing_algorithm ⇒ String

  The signing algorithm that was used to sign the message.

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)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  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>)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#key_id ⇒ String

Identifies the asymmetric KMS key that will be used to verify the signature. This must be the same KMS key that was used to generate the signature. If you specify a different KMS key, the signature verification fails.

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)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#message ⇒ String

Specifies the message that was signed. You can submit a raw message of up to 4096 bytes, or a hash digest of the message. If you submit a digest, use the MessageType parameter with a value of DIGEST.

If the message specified here is different from the message that was signed, the signature verification fails. A message and its hash digest are considered to be the same message.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#message_type ⇒ String

Tells KMS whether the value of the Message parameter should be hashed as part of the signing algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are already hashed; use EXTERNAL_MU for 64-byte representative μ used in ML-DSA signing as defined in NIST FIPS 204 Section 6.2.

When the value of MessageType is RAW, KMS uses the standard signing algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing algorithm. When the value is EXTERNAL_MU KMS skips the concatenated hashing of the public key hash and the message done in the ML-DSA signing algorithm.

Use the DIGEST or EXTERNAL_MU value only when the value of the Message parameter is a message digest. If you use the DIGEST value with an unhashed message, the security of the signing operation can be compromised.

When using ECC_NIST_EDWARDS25519 KMS keys:

• ED25519_SHA_512 signing algorithm requires KMS MessageType:RAW

• ED25519_PH_SHA_512 signing algorithm requires KMS MessageType:DIGEST

When the value of MessageType is DIGEST, the length of the Message value must match the length of hashed messages for the specified signing algorithm.

When the value of MessageType is EXTERNAL_MU the length of the Message value must be 64 bytes.

You can submit a message digest and omit the MessageType or specify RAW so the digest is hashed again while signing. However, if the signed message is hashed once while signing, but twice while verifying, verification fails, even when the message hasn’t changed.

The hashing algorithm that Verify uses is based on the SigningAlgorithm value.

• Signing algorithms that end in SHA_256 use the SHA_256 hashing algorithm.

• Signing algorithms that end in SHA_384 use the SHA_384 hashing algorithm.

• Signing algorithms that end in SHA_512 use the SHA_512 hashing algorithm.

• Signing algorithms that end in SHAKE_256 use the SHAKE_256 hashing algorithm.

• SM2DSA uses the SM3 hashing algorithm. For details, see [Offline verification with SM2 key pairs].

[1]: docs.aws.amazon.com/kms/latest/developerguide/offline-operations.html#key-spec-sm-offline-verification

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#signature ⇒ String

The signature that the Sign operation generated.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end

#signing_algorithm ⇒ String

The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.

Returns:

• (String)

# File 'lib/aws-sdk-kms/types.rb', line 7010

class VerifyRequest < Struct.new(
  :key_id,
  :message,
  :message_type,
  :signature,
  :signing_algorithm,
  :grant_tokens,
  :dry_run)
  SENSITIVE = [:message]
  include Aws::Structure
end