Interface VerifyRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<VerifyRequest.Builder,VerifyRequest>
,KmsRequest.Builder
,SdkBuilder<VerifyRequest.Builder,VerifyRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- VerifyRequest
public static interface VerifyRequest.Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder<VerifyRequest.Builder,VerifyRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description VerifyRequest.Builder
dryRun(Boolean dryRun)
Checks if your request will succeed.VerifyRequest.Builder
grantTokens(String... grantTokens)
A list of grant tokens.VerifyRequest.Builder
grantTokens(Collection<String> grantTokens)
A list of grant tokens.VerifyRequest.Builder
keyId(String keyId)
Identifies the asymmetric KMS key that will be used to verify the signature.VerifyRequest.Builder
message(SdkBytes message)
Specifies the message that was signed.VerifyRequest.Builder
messageType(String messageType)
Tells KMS whether the value of theMessage
parameter should be hashed as part of the signing algorithm.VerifyRequest.Builder
messageType(MessageType messageType)
Tells KMS whether the value of theMessage
parameter should be hashed as part of the signing algorithm.VerifyRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
VerifyRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
VerifyRequest.Builder
signature(SdkBytes signature)
The signature that theSign
operation generated.VerifyRequest.Builder
signingAlgorithm(String signingAlgorithm)
The signing algorithm that was used to sign the message.VerifyRequest.Builder
signingAlgorithm(SigningAlgorithmSpec signingAlgorithm)
The signing algorithm that was used to sign the message.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.kms.model.KmsRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
keyId
VerifyRequest.Builder keyId(String 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
-
message
VerifyRequest.Builder message(SdkBytes 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.
- Parameters:
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 theMessageType
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:
- Returns a reference to this object so that method calls can be chained together.
-
messageType
VerifyRequest.Builder messageType(String 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.
- Parameters:
messageType
- Tells KMS whether the value of theMessage
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
MessageType
,MessageType
-
-
messageType
VerifyRequest.Builder messageType(MessageType 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.
- Parameters:
messageType
- Tells KMS whether the value of theMessage
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.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
MessageType
,MessageType
-
-
signature
VerifyRequest.Builder signature(SdkBytes signature)
The signature that the
Sign
operation generated.- Parameters:
signature
- The signature that theSign
operation generated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
signingAlgorithm
VerifyRequest.Builder signingAlgorithm(String signingAlgorithm)
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
- Parameters:
signingAlgorithm
- The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SigningAlgorithmSpec
,SigningAlgorithmSpec
-
signingAlgorithm
VerifyRequest.Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm)
The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.
- Parameters:
signingAlgorithm
- The signing algorithm that was used to sign the message. If you submit a different algorithm, the signature verification fails.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
SigningAlgorithmSpec
,SigningAlgorithmSpec
-
grantTokens
VerifyRequest.Builder grantTokens(Collection<String> 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
grantTokens
VerifyRequest.Builder grantTokens(String... 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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
VerifyRequest.Builder dryRun(Boolean 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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
VerifyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
VerifyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-