KMS / Client / verify

verify#

KMS.Client.verify(**kwargs)#

Verifies a digital signature that was generated by the Sign operation.

Verification confirms that an authorized user signed the message with the specified KMS key and signing algorithm, and the message hasn’t changed since it was signed. If the signature is verified, the value of the SignatureValid field in the response is True. If the signature verification fails, the Verify operation fails with an KMSInvalidSignatureException exception.

A digital signature is generated by using the private key in an asymmetric KMS key. The signature is verified by using the public key in the same asymmetric KMS key. For information about asymmetric KMS keys, see Asymmetric KMS keys in the Key Management Service Developer Guide.

To use the Verify operation, specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature. The message type does not need to be the same as the one used for signing, but it must indicate whether the value of the Message parameter should be hashed as part of the verification process.

You can also verify the digital signature by using the public key of the KMS key outside of KMS. Use the GetPublicKey operation to download the public key in the asymmetric KMS key and then use the public key to verify the signature outside of KMS. The advantage of using the Verify operation is that it is performed within KMS. As a result, it’s easy to call, the operation is performed within the FIPS boundary, it is logged in CloudTrail, and you can use key policy and IAM policy to determine who is authorized to use the KMS key to verify signatures.

To verify a signature outside of KMS with an SM2 public key (China Regions only), you must specify the distinguishing ID. By default, KMS uses 1234567812345678 as the distinguishing ID. For more information, see Offline verification with SM2 key pairs.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys in the Key Management Service Developer Guide.

Cross-account use: Yes. To perform this operation with a KMS key in a different Amazon Web Services account, specify the key ARN or alias ARN in the value of the KeyId parameter.

Required permissions: kms:Verify (key policy)

Related operations: Sign

See also: AWS API Documentation

Request Syntax

response = client.verify(
    KeyId='string',
    Message=b'bytes',
    MessageType='RAW'|'DIGEST',
    Signature=b'bytes',
    SigningAlgorithm='RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512'|'SM2DSA',
    GrantTokens=[
        'string',
    ],
    DryRun=True|False
)
Parameters:

  • KeyId (string) –

    [REQUIRED]

    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.

  • Message (bytes) –

    [REQUIRED]

    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.

  • MessageType (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.

    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.

    Warning

    Use the DIGEST 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 verification operation can be compromised.

    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.

    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 in 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.

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

  • Signature (bytes) –

    [REQUIRED]

    The signature that the Sign operation generated.

  • SigningAlgorithm (string) –

    [REQUIRED]

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

  • GrantTokens (list) –

    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.

    • (string) –

  • DryRun (boolean) –

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

    To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service Developer Guide.

Return type:

dict

Returns:

Response Syntax

{
    'KeyId': 'string',
    'SignatureValid': True|False,
    'SigningAlgorithm': 'RSASSA_PSS_SHA_256'|'RSASSA_PSS_SHA_384'|'RSASSA_PSS_SHA_512'|'RSASSA_PKCS1_V1_5_SHA_256'|'RSASSA_PKCS1_V1_5_SHA_384'|'RSASSA_PKCS1_V1_5_SHA_512'|'ECDSA_SHA_256'|'ECDSA_SHA_384'|'ECDSA_SHA_512'|'SM2DSA'
}

Response Structure

  • (dict) –

    • KeyId (string) –

      The Amazon Resource Name ( key ARN) of the asymmetric KMS key that was used to verify the signature.

    • SignatureValid (boolean) –

      A Boolean value that indicates whether the signature was verified. A value of True indicates that the Signature was produced by signing the Message with the specified KeyID and SigningAlgorithm. If the signature is not verified, the Verify operation fails with a KMSInvalidSignatureException exception.

    • SigningAlgorithm (string) –

      The signing algorithm that was used to verify the signature.

Exceptions

  • KMS.Client.exceptions.NotFoundException

  • KMS.Client.exceptions.DisabledException

  • KMS.Client.exceptions.KeyUnavailableException

  • KMS.Client.exceptions.DependencyTimeoutException

  • KMS.Client.exceptions.InvalidKeyUsageException

  • KMS.Client.exceptions.InvalidGrantTokenException

  • KMS.Client.exceptions.KMSInternalException

  • KMS.Client.exceptions.KMSInvalidStateException

  • KMS.Client.exceptions.KMSInvalidSignatureException

  • KMS.Client.exceptions.DryRunOperationException

Examples

This operation uses the public key in an elliptic curve (ECC) asymmetric key to verify a digital signature within AWS KMS.

response = client.verify(
    # The asymmetric KMS key to be used to verify the digital signature. This example uses an alias to identify the KMS key.
    KeyId='alias/ECC_signing_key',
    # The message that was signed.
    Message='<message to be verified>',
    # Indicates whether the message is RAW or a DIGEST.
    MessageType='RAW',
    # The signature to be verified.
    Signature='<binary data>',
    # The signing algorithm to be used to verify the signature.
    SigningAlgorithm='ECDSA_SHA_384',
)

print(response)

Expected Output:

{
    # The key ARN of the asymmetric KMS key that was used to verify the digital signature.
    'KeyId': 'arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab',
    # A value of 'true' Indicates that the signature was verified. If verification fails, the call to Verify fails.
    'SignatureValid': True,
    # The signing algorithm that was used to verify the signature.
    'SigningAlgorithm': 'ECDSA_SHA_384',
    'ResponseMetadata': {
        '...': '...',
    },
}