software.amazon.awssdk.services.kms.model.SignRequest Maven / Gradle / Ivy
Show all versions of kms Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.kms.model;
import java.nio.ByteBuffer;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class SignRequest extends KmsRequest implements ToCopyableBuilder {
private static final SdkField KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING).memberName("KeyId")
.getter(getter(SignRequest::keyId)).setter(setter(Builder::keyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KeyId").build()).build();
private static final SdkField MESSAGE_FIELD = SdkField. builder(MarshallingType.SDK_BYTES)
.memberName("Message").getter(getter(SignRequest::message)).setter(setter(Builder::message))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Message").build()).build();
private static final SdkField MESSAGE_TYPE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("MessageType").getter(getter(SignRequest::messageTypeAsString)).setter(setter(Builder::messageType))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("MessageType").build()).build();
private static final SdkField> GRANT_TOKENS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("GrantTokens")
.getter(getter(SignRequest::grantTokens))
.setter(setter(Builder::grantTokens))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("GrantTokens").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SIGNING_ALGORITHM_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("SigningAlgorithm").getter(getter(SignRequest::signingAlgorithmAsString))
.setter(setter(Builder::signingAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SigningAlgorithm").build()).build();
private static final SdkField DRY_RUN_FIELD = SdkField. builder(MarshallingType.BOOLEAN)
.memberName("DryRun").getter(getter(SignRequest::dryRun)).setter(setter(Builder::dryRun))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("DryRun").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(KEY_ID_FIELD, MESSAGE_FIELD,
MESSAGE_TYPE_FIELD, GRANT_TOKENS_FIELD, SIGNING_ALGORITHM_FIELD, DRY_RUN_FIELD));
private final String keyId;
private final SdkBytes message;
private final String messageType;
private final List grantTokens;
private final String signingAlgorithm;
private final Boolean dryRun;
private SignRequest(BuilderImpl builder) {
super(builder);
this.keyId = builder.keyId;
this.message = builder.message;
this.messageType = builder.messageType;
this.grantTokens = builder.grantTokens;
this.signingAlgorithm = builder.signingAlgorithm;
this.dryRun = builder.dryRun;
}
/**
*
* Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The
* KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage of
* a KMS key, use the DescribeKey operation.
*
*
* 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 Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message.
* The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the
* KeyUsage of a KMS key, use the DescribeKey operation.
*
* 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.
*/
public final String keyId() {
return keyId;
}
/**
*
* Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message, provide
* a message digest.
*
*
* If you provide a message digest, use the DIGEST value of MessageType to prevent the
* digest from being hashed again while signing.
*
*
* @return Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message,
* provide a message digest.
*
* If you provide a message digest, use the DIGEST value of MessageType to prevent
* the digest from being hashed again while signing.
*/
public final SdkBytes message() {
return message;
}
/**
*
* Tells KMS whether the value of the Message parameter should be hashed as part of the signing
* algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are
* already hashed.
*
*
* When the value of MessageType is RAW, KMS uses the standard signing algorithm, which
* begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing
* algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a message digest.
* If you use the DIGEST value with an unhashed message, the security of the signing operation can be
* compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the Message value
* must match the length of hashed messages for the specified signing algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so the digest
* is hashed again while signing. However, this can cause verification failures when verifying with a system that
* assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm 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, {@link #messageType} will
* return {@link MessageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #messageTypeAsString}.
*
*
* @return Tells KMS whether the value of the Message parameter should be hashed as part of the signing
* algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which
* are already hashed.
*
* When the value of MessageType is RAW, KMS uses the standard signing algorithm,
* which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in
* the signing algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a message
* digest. If you use the DIGEST value with an unhashed message, the security of the signing
* operation can be compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the Message
* value must match the length of hashed messages for the specified signing algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so the
* digest is hashed again while signing. However, this can cause verification failures when verifying with a
* system that assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm 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 MessageType
*/
public final MessageType messageType() {
return MessageType.fromValue(messageType);
}
/**
*
* Tells KMS whether the value of the Message parameter should be hashed as part of the signing
* algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are
* already hashed.
*
*
* When the value of MessageType is RAW, KMS uses the standard signing algorithm, which
* begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the signing
* algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a message digest.
* If you use the DIGEST value with an unhashed message, the security of the signing operation can be
* compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the Message value
* must match the length of hashed messages for the specified signing algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so the digest
* is hashed again while signing. However, this can cause verification failures when verifying with a system that
* assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm 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, {@link #messageType} will
* return {@link MessageType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #messageTypeAsString}.
*
*
* @return Tells KMS whether the value of the Message parameter should be hashed as part of the signing
* algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which
* are already hashed.
*
* When the value of MessageType is RAW, KMS uses the standard signing algorithm,
* which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in
* the signing algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a message
* digest. If you use the DIGEST value with an unhashed message, the security of the signing
* operation can be compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the Message
* value must match the length of hashed messages for the specified signing algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so the
* digest is hashed again while signing. However, this can cause verification failures when verifying with a
* system that assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm 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 MessageType
*/
public final String messageTypeAsString() {
return messageType;
}
/**
* 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 the {@code isEmpty()} 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.
*/
public final boolean hasGrantTokens() {
return grantTokens != null && !(grantTokens instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasGrantTokens} method.
*
*
* @return 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.
*/
public final List grantTokens() {
return grantTokens;
}
/**
*
* Specifies the signing algorithm to use when signing the message.
*
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When signing
* with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for
* compatibility with existing applications.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #signingAlgorithm}
* will return {@link SigningAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #signingAlgorithmAsString}.
*
*
* @return Specifies the signing algorithm to use when signing the message.
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When
* signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms
* for compatibility with existing applications.
* @see SigningAlgorithmSpec
*/
public final SigningAlgorithmSpec signingAlgorithm() {
return SigningAlgorithmSpec.fromValue(signingAlgorithm);
}
/**
*
* Specifies the signing algorithm to use when signing the message.
*
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When signing
* with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for
* compatibility with existing applications.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #signingAlgorithm}
* will return {@link SigningAlgorithmSpec#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #signingAlgorithmAsString}.
*
*
* @return Specifies the signing algorithm to use when signing the message.
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When
* signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms
* for compatibility with existing applications.
* @see SigningAlgorithmSpec
*/
public final String signingAlgorithmAsString() {
return signingAlgorithm;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final Boolean dryRun() {
return dryRun;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(keyId());
hashCode = 31 * hashCode + Objects.hashCode(message());
hashCode = 31 * hashCode + Objects.hashCode(messageTypeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasGrantTokens() ? grantTokens() : null);
hashCode = 31 * hashCode + Objects.hashCode(signingAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(dryRun());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof SignRequest)) {
return false;
}
SignRequest other = (SignRequest) obj;
return Objects.equals(keyId(), other.keyId()) && Objects.equals(message(), other.message())
&& Objects.equals(messageTypeAsString(), other.messageTypeAsString())
&& hasGrantTokens() == other.hasGrantTokens() && Objects.equals(grantTokens(), other.grantTokens())
&& Objects.equals(signingAlgorithmAsString(), other.signingAlgorithmAsString())
&& Objects.equals(dryRun(), other.dryRun());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("SignRequest").add("KeyId", keyId())
.add("Message", message() == null ? null : "*** Sensitive Data Redacted ***")
.add("MessageType", messageTypeAsString()).add("GrantTokens", hasGrantTokens() ? grantTokens() : null)
.add("SigningAlgorithm", signingAlgorithmAsString()).add("DryRun", dryRun()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "KeyId":
return Optional.ofNullable(clazz.cast(keyId()));
case "Message":
return Optional.ofNullable(clazz.cast(message()));
case "MessageType":
return Optional.ofNullable(clazz.cast(messageTypeAsString()));
case "GrantTokens":
return Optional.ofNullable(clazz.cast(grantTokens()));
case "SigningAlgorithm":
return Optional.ofNullable(clazz.cast(signingAlgorithmAsString()));
case "DryRun":
return Optional.ofNullable(clazz.cast(dryRun()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((SignRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends KmsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the message. The
* KeyUsage type of the KMS key must be SIGN_VERIFY. To find the KeyUsage
* of a KMS key, use the DescribeKey operation.
*
*
* 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.
*
*
* @param keyId
* Identifies an asymmetric KMS key. KMS uses the private key in the asymmetric KMS key to sign the
* message. The KeyUsage type of the KMS key must be SIGN_VERIFY. To find the
* KeyUsage of a KMS key, use the DescribeKey operation.
*
* 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 Returns a reference to this object so that method calls can be chained together.
*/
Builder keyId(String keyId);
/**
*
* Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger message,
* provide a message digest.
*
*
* If you provide a message digest, use the DIGEST value of MessageType to prevent the
* digest from being hashed again while signing.
*
*
* @param message
* Specifies the message or message digest to sign. Messages can be 0-4096 bytes. To sign a larger
* message, provide a message digest.
*
* If you provide a message digest, use the DIGEST value of MessageType to
* prevent the digest from being hashed again while signing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder message(SdkBytes message);
/**
*
* Tells KMS whether the value of the Message parameter should be hashed as part of the signing
* algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are
* already hashed.
*
*
* When the value of MessageType is RAW, KMS uses the standard signing algorithm,
* which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the
* signing algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a message
* digest. If you use the DIGEST value with an unhashed message, the security of the signing
* operation can be compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the Message
* value must match the length of hashed messages for the specified signing algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so the
* digest is hashed again while signing. However, this can cause verification failures when verifying with a
* system that assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm 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.
*
*
*
*
* @param messageType
* Tells KMS whether the value of the Message parameter should be hashed as part of the
* signing algorithm. Use RAW for unhashed messages; use DIGEST for message
* digests, which are already hashed.
*
* When the value of MessageType is RAW, KMS uses the standard signing
* algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the
* hashing step in the signing algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a
* message digest. If you use the DIGEST value with an unhashed message, the security of the
* signing operation can be compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the
* Message value must match the length of hashed messages for the specified signing
* algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so
* the digest is hashed again while signing. However, this can cause verification failures when verifying
* with a system that assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm
* 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 MessageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
Builder messageType(String messageType);
/**
*
* Tells KMS whether the value of the Message parameter should be hashed as part of the signing
* algorithm. Use RAW for unhashed messages; use DIGEST for message digests, which are
* already hashed.
*
*
* When the value of MessageType is RAW, KMS uses the standard signing algorithm,
* which begins with a hash function. When the value is DIGEST, KMS skips the hashing step in the
* signing algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a message
* digest. If you use the DIGEST value with an unhashed message, the security of the signing
* operation can be compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the Message
* value must match the length of hashed messages for the specified signing algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so the
* digest is hashed again while signing. However, this can cause verification failures when verifying with a
* system that assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm 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.
*
*
*
*
* @param messageType
* Tells KMS whether the value of the Message parameter should be hashed as part of the
* signing algorithm. Use RAW for unhashed messages; use DIGEST for message
* digests, which are already hashed.
*
* When the value of MessageType is RAW, KMS uses the standard signing
* algorithm, which begins with a hash function. When the value is DIGEST, KMS skips the
* hashing step in the signing algorithm.
*
*
*
* Use the DIGEST value only when the value of the Message parameter is a
* message digest. If you use the DIGEST value with an unhashed message, the security of the
* signing operation can be compromised.
*
*
*
* When the value of MessageTypeis DIGEST, the length of the
* Message value must match the length of hashed messages for the specified signing
* algorithm.
*
*
* You can submit a message digest and omit the MessageType or specify RAW so
* the digest is hashed again while signing. However, this can cause verification failures when verifying
* with a system that assumes a single hash.
*
*
* The hashing algorithm in that Sign uses is based on the SigningAlgorithm
* 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 MessageType
* @return Returns a reference to this object so that method calls can be chained together.
* @see MessageType
*/
Builder messageType(MessageType messageType);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantTokens(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantTokens(String... grantTokens);
/**
*
* Specifies the signing algorithm to use when signing the message.
*
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When
* signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for
* compatibility with existing applications.
*
*
* @param signingAlgorithm
* Specifies the signing algorithm to use when signing the message.
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
* When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5
* algorithms for compatibility with existing applications.
* @see SigningAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see SigningAlgorithmSpec
*/
Builder signingAlgorithm(String signingAlgorithm);
/**
*
* Specifies the signing algorithm to use when signing the message.
*
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key. When
* signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5 algorithms for
* compatibility with existing applications.
*
*
* @param signingAlgorithm
* Specifies the signing algorithm to use when signing the message.
*
* Choose an algorithm that is compatible with the type and size of the specified asymmetric KMS key.
* When signing with RSA key pairs, RSASSA-PSS algorithms are preferred. We include RSASSA-PKCS1-v1_5
* algorithms for compatibility with existing applications.
* @see SigningAlgorithmSpec
* @return Returns a reference to this object so that method calls can be chained together.
* @see SigningAlgorithmSpec
*/
Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder dryRun(Boolean dryRun);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends KmsRequest.BuilderImpl implements Builder {
private String keyId;
private SdkBytes message;
private String messageType;
private List grantTokens = DefaultSdkAutoConstructList.getInstance();
private String signingAlgorithm;
private Boolean dryRun;
private BuilderImpl() {
}
private BuilderImpl(SignRequest model) {
super(model);
keyId(model.keyId);
message(model.message);
messageType(model.messageType);
grantTokens(model.grantTokens);
signingAlgorithm(model.signingAlgorithm);
dryRun(model.dryRun);
}
public final String getKeyId() {
return keyId;
}
public final void setKeyId(String keyId) {
this.keyId = keyId;
}
@Override
public final Builder keyId(String keyId) {
this.keyId = keyId;
return this;
}
public final ByteBuffer getMessage() {
return message == null ? null : message.asByteBuffer();
}
public final void setMessage(ByteBuffer message) {
message(message == null ? null : SdkBytes.fromByteBuffer(message));
}
@Override
public final Builder message(SdkBytes message) {
this.message = message;
return this;
}
public final String getMessageType() {
return messageType;
}
public final void setMessageType(String messageType) {
this.messageType = messageType;
}
@Override
public final Builder messageType(String messageType) {
this.messageType = messageType;
return this;
}
@Override
public final Builder messageType(MessageType messageType) {
this.messageType(messageType == null ? null : messageType.toString());
return this;
}
public final Collection getGrantTokens() {
if (grantTokens instanceof SdkAutoConstructList) {
return null;
}
return grantTokens;
}
public final void setGrantTokens(Collection grantTokens) {
this.grantTokens = GrantTokenListCopier.copy(grantTokens);
}
@Override
public final Builder grantTokens(Collection grantTokens) {
this.grantTokens = GrantTokenListCopier.copy(grantTokens);
return this;
}
@Override
@SafeVarargs
public final Builder grantTokens(String... grantTokens) {
grantTokens(Arrays.asList(grantTokens));
return this;
}
public final String getSigningAlgorithm() {
return signingAlgorithm;
}
public final void setSigningAlgorithm(String signingAlgorithm) {
this.signingAlgorithm = signingAlgorithm;
}
@Override
public final Builder signingAlgorithm(String signingAlgorithm) {
this.signingAlgorithm = signingAlgorithm;
return this;
}
@Override
public final Builder signingAlgorithm(SigningAlgorithmSpec signingAlgorithm) {
this.signingAlgorithm(signingAlgorithm == null ? null : signingAlgorithm.toString());
return this;
}
public final Boolean getDryRun() {
return dryRun;
}
public final void setDryRun(Boolean dryRun) {
this.dryRun = dryRun;
}
@Override
public final Builder dryRun(Boolean dryRun) {
this.dryRun = dryRun;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public SignRequest build() {
return new SignRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}