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 verify a digital signature, you can use the Verify operation. Specify the
same asymmetric KMS key, message, and signing algorithm that were used to produce the
signature.
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.
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 isTrue
. If the signature verification fails, theVerify
operation fails with anKMSInvalidSignatureException
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 verify a digital signature, you can use the
Verify
operation. Specify the same asymmetric KMS key, message, and signing algorithm that were used to produce the signature.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
Use a bare-bones client and the command you need to make an API call.
import { KMSClient, VerifyCommand } from "@aws-sdk/client-kms"; // ES Modules import // const { KMSClient, VerifyCommand } = require("@aws-sdk/client-kms"); // CommonJS import const client = new KMSClient(config); const command = new VerifyCommand(input); const response = await client.send(command);
VerifyCommandInput for command's
input
shape.VerifyCommandOutput for command's
response
shape.config for KMSClient's
config
shape.