Class VerifyRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<VerifyRequest.Builder,
VerifyRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic VerifyRequest.Builder
builder()
final Boolean
dryRun()
Checks if your request will succeed.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.A list of grant tokens.final boolean
For responses, this returns true if the service returned a value for the GrantTokens property.final int
hashCode()
final String
keyId()
Identifies the asymmetric KMS key that will be used to verify the signature.final SdkBytes
message()
Specifies the message that was signed.final MessageType
Tells KMS whether the value of theMessage
parameter should be hashed as part of the signing algorithm.final String
Tells KMS whether the value of theMessage
parameter should be hashed as part of the signing algorithm.static Class
<? extends VerifyRequest.Builder> final SdkBytes
The signature that theSign
operation generated.final SigningAlgorithmSpec
The signing algorithm that was used to sign the message.final String
The signing algorithm that was used to sign the message.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
keyId
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:
- 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
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 ofDIGEST
.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:
- 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 ofDIGEST
.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
Tells KMS whether the value of the
Message
parameter should be hashed as part of the signing algorithm. UseRAW
for unhashed messages; useDIGEST
for message digests, which are already hashed.When the value of
MessageType
isRAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value isDIGEST
, KMS skips the hashing step in the signing algorithm.Use the
DIGEST
value only when the value of theMessage
parameter is a message digest. If you use theDIGEST
value with an unhashed message, the security of the verification operation can be compromised.When the value of
MessageType
isDIGEST
, the length of theMessage
value must match the length of hashed messages for the specified signing algorithm.You can submit a message digest and omit the
MessageType
or specifyRAW
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 theSigningAlgorithm
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.
If the service returns an enum value that is not available in the current SDK version,
messageType
will returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- Returns:
- Tells KMS whether the value of the
Message
parameter should be hashed as part of the signing algorithm. UseRAW
for unhashed messages; useDIGEST
for message digests, which are already hashed.When the value of
MessageType
isRAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value isDIGEST
, KMS skips the hashing step in the signing algorithm.Use the
DIGEST
value only when the value of theMessage
parameter is a message digest. If you use theDIGEST
value with an unhashed message, the security of the verification operation can be compromised.When the value of
MessageType
isDIGEST
, the length of theMessage
value must match the length of hashed messages for the specified signing algorithm.You can submit a message digest and omit the
MessageType
or specifyRAW
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 theSigningAlgorithm
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.
-
- See Also:
-
-
messageTypeAsString
Tells KMS whether the value of the
Message
parameter should be hashed as part of the signing algorithm. UseRAW
for unhashed messages; useDIGEST
for message digests, which are already hashed.When the value of
MessageType
isRAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value isDIGEST
, KMS skips the hashing step in the signing algorithm.Use the
DIGEST
value only when the value of theMessage
parameter is a message digest. If you use theDIGEST
value with an unhashed message, the security of the verification operation can be compromised.When the value of
MessageType
isDIGEST
, the length of theMessage
value must match the length of hashed messages for the specified signing algorithm.You can submit a message digest and omit the
MessageType
or specifyRAW
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 theSigningAlgorithm
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.
If the service returns an enum value that is not available in the current SDK version,
messageType
will returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- Returns:
- Tells KMS whether the value of the
Message
parameter should be hashed as part of the signing algorithm. UseRAW
for unhashed messages; useDIGEST
for message digests, which are already hashed.When the value of
MessageType
isRAW
, KMS uses the standard signing algorithm, which begins with a hash function. When the value isDIGEST
, KMS skips the hashing step in the signing algorithm.Use the
DIGEST
value only when the value of theMessage
parameter is a message digest. If you use theDIGEST
value with an unhashed message, the security of the verification operation can be compromised.When the value of
MessageType
isDIGEST
, the length of theMessage
value must match the length of hashed messages for the specified signing algorithm.You can submit a message digest and omit the
MessageType
or specifyRAW
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 theSigningAlgorithm
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.
-
- See Also:
-
-
signature
The signature that the
Sign
operation generated.- Returns:
- The signature that the
Sign
operation generated.
-
signingAlgorithm
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
If the service returns an enum value that is not available in the current SDK version,
signingAlgorithm
will returnSigningAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningAlgorithmAsString()
.- Returns:
- The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
- See Also:
-
signingAlgorithmAsString
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
If the service returns an enum value that is not available in the current SDK version,
signingAlgorithm
will returnSigningAlgorithmSpec.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromsigningAlgorithmAsString()
.- Returns:
- The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
- See Also:
-
hasGrantTokens
public final boolean hasGrantTokens()For responses, this returns true if the service returned a value for the GrantTokens property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
grantTokens
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasGrantTokens()
method.- Returns:
- 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.
-
dryRun
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.
- Returns:
- 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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<VerifyRequest.Builder,
VerifyRequest> - Specified by:
toBuilder
in classKmsRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-