class Aws::KMS::Types::VerifyRequest
@note When making an API call, you may pass VerifyRequest
data as a hash: { key_id: "KeyIdType", # required message: "data", # required message_type: "RAW", # accepts RAW, DIGEST signature: "data", # required signing_algorithm: "RSASSA_PSS_SHA_256", # required, accepts 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 grant_tokens: ["GrantTokenType"], }
@!attribute [rw] key_id
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. @return [String]
@!attribute [rw] message
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. @return [String]
@!attribute [rw] message_type
Tells KMS whether the value of the `Message` parameter is a message or message digest. The default value, RAW, indicates a message. To indicate a message digest, enter `DIGEST`. Use the `DIGEST` value only when the value of the `Message` parameter is a message digest. If you use the `DIGEST` value with a raw message, the security of the verification operation can be compromised. @return [String]
@!attribute [rw] signature
The signature that the `Sign` operation generated. @return [String]
@!attribute [rw] signing_algorithm
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails. @return [String]
@!attribute [rw] grant_tokens
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][1] and [Using a grant token][2] in the *Key Management Service Developer Guide*. [1]: https://docs.aws.amazon.com/kms/latest/developerguide/grants.html#grant_token [2]: https://docs.aws.amazon.com/kms/latest/developerguide/grant-manage.html#using-grant-token @return [Array<String>]
@see docs.aws.amazon.com/goto/WebAPI/kms-2014-11-01/VerifyRequest AWS API Documentation
Constants
- SENSITIVE