| 1 | |||
| 2 | package Paws::KMS::Verify; | ||
| 3 | use Moose; | ||
| 4 | has GrantTokens => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has KeyId => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Message => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | has MessageType => (is => 'ro', isa => 'Str'); | ||
| 8 | has Signature => (is => 'ro', isa => 'Str', required => 1); | ||
| 9 | has SigningAlgorithm => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'Verify'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::KMS::VerifyResponse'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::KMS::Verify - Arguments for method Verify on L<Paws::KMS> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method Verify on the | ||
| 27 | L<AWS Key Management Service|Paws::KMS> service. Use the attributes of this class | ||
| 28 | as arguments to method Verify. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to Verify. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $kms = Paws->service('KMS'); | ||
| 35 | my $VerifyResponse = $kms->Verify( | ||
| 36 | KeyId => 'MyKeyIdType', | ||
| 37 | Message => 'BlobPlaintextType', | ||
| 38 | Signature => 'BlobCiphertextType', | ||
| 39 | SigningAlgorithm => 'RSASSA_PSS_SHA_256', | ||
| 40 | GrantTokens => [ | ||
| 41 | 'MyGrantTokenType', ... # min: 1, max: 8192 | ||
| 42 | ], # OPTIONAL | ||
| 43 | MessageType => 'RAW', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $KeyId = $VerifyResponse->KeyId; | ||
| 48 | my $SignatureValid = $VerifyResponse->SignatureValid; | ||
| 49 | my $SigningAlgorithm = $VerifyResponse->SigningAlgorithm; | ||
| 50 | |||
| 51 | # Returns a L<Paws::KMS::VerifyResponse> object. | ||
| 52 | |||
| 53 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 54 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/kms/Verify> | ||
| 55 | |||
| 56 | =head1 ATTRIBUTES | ||
| 57 | |||
| 58 | |||
| 59 | =head2 GrantTokens => ArrayRef[Str|Undef] | ||
| 60 | |||
| 61 | A list of grant tokens. | ||
| 62 | |||
| 63 | Use a grant token when your permission to call this operation comes | ||
| 64 | from a new grant that has not yet achieved I<eventual consistency>. For | ||
| 65 | more information, see Grant token | ||
| 66 | (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#grant_token) | ||
| 67 | in the I<AWS Key Management Service Developer Guide>. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 B<REQUIRED> KeyId => Str | ||
| 72 | |||
| 73 | Identifies the asymmetric CMK that will be used to verify the | ||
| 74 | signature. This must be the same CMK that was used to generate the | ||
| 75 | signature. If you specify a different CMK, the signature verification | ||
| 76 | fails. | ||
| 77 | |||
| 78 | To specify a CMK, use its key ID, key ARN, alias name, or alias ARN. | ||
| 79 | When using an alias name, prefix it with C<"alias/">. To specify a CMK | ||
| 80 | in a different AWS account, you must use the key ARN or alias ARN. | ||
| 81 | |||
| 82 | For example: | ||
| 83 | |||
| 84 | =over | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | Key ID: C<1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 89 | |||
| 90 | =item * | ||
| 91 | |||
| 92 | Key ARN: | ||
| 93 | C<arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab> | ||
| 94 | |||
| 95 | =item * | ||
| 96 | |||
| 97 | Alias name: C<alias/ExampleAlias> | ||
| 98 | |||
| 99 | =item * | ||
| 100 | |||
| 101 | Alias ARN: C<arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias> | ||
| 102 | |||
| 103 | =back | ||
| 104 | |||
| 105 | To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey. | ||
| 106 | To get the alias name and alias ARN, use ListAliases. | ||
| 107 | |||
| 108 | |||
| 109 | |||
| 110 | =head2 B<REQUIRED> Message => Str | ||
| 111 | |||
| 112 | Specifies the message that was signed. You can submit a raw message of | ||
| 113 | up to 4096 bytes, or a hash digest of the message. If you submit a | ||
| 114 | digest, use the C<MessageType> parameter with a value of C<DIGEST>. | ||
| 115 | |||
| 116 | If the message specified here is different from the message that was | ||
| 117 | signed, the signature verification fails. A message and its hash digest | ||
| 118 | are considered to be the same message. | ||
| 119 | |||
| 120 | |||
| 121 | |||
| 122 | =head2 MessageType => Str | ||
| 123 | |||
| 124 | Tells AWS KMS whether the value of the C<Message> parameter is a | ||
| 125 | message or message digest. The default value, RAW, indicates a message. | ||
| 126 | To indicate a message digest, enter C<DIGEST>. | ||
| 127 | |||
| 128 | Use the C<DIGEST> value only when the value of the C<Message> parameter | ||
| 129 | is a message digest. If you use the C<DIGEST> value with a raw message, | ||
| 130 | the security of the verification operation can be compromised. | ||
| 131 | |||
| 132 | Valid values are: C<"RAW">, C<"DIGEST"> | ||
| 133 | |||
| 134 | =head2 B<REQUIRED> Signature => Str | ||
| 135 | |||
| 136 | The signature that the C<Sign> operation generated. | ||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 B<REQUIRED> SigningAlgorithm => Str | ||
| 141 | |||
| 142 | The signing algorithm that was used to sign the message. If you submit | ||
| 143 | a different algorithm, the signature verification fails. | ||
| 144 | |||
| 145 | Valid values are: C<"RSASSA_PSS_SHA_256">, C<"RSASSA_PSS_SHA_384">, C<"RSASSA_PSS_SHA_512">, C<"RSASSA_PKCS1_V1_5_SHA_256">, C<"RSASSA_PKCS1_V1_5_SHA_384">, C<"RSASSA_PKCS1_V1_5_SHA_512">, C<"ECDSA_SHA_256">, C<"ECDSA_SHA_384">, C<"ECDSA_SHA_512"> | ||
| 146 | |||
| 147 | |||
| 148 | =head1 SEE ALSO | ||
| 149 | |||
| 150 | This class forms part of L<Paws>, documenting arguments for method Verify in L<Paws::KMS> | ||
| 151 | |||
| 152 | =head1 BUGS and CONTRIBUTIONS | ||
| 153 | |||
| 154 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 155 | |||
| 156 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 157 | |||
| 158 | =cut | ||
| 159 |