Package software.amazon.awssdk.services.kms.model

Interface SignRequest.Builder

    • Method Detail

      • keyId

        SignRequest.Builder keyId​(String 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • message

        SignRequest.Builder message​(SdkBytes 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • messageType

        SignRequest.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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • messageType

        SignRequest.Builder messageType​(MessageType 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        MessageType, MessageType

      • grantTokens

        SignRequest.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

        SignRequest.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.

      • signingAlgorithm

        SignRequest.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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SigningAlgorithmSpec, SigningAlgorithmSpec

      • signingAlgorithm

        SignRequest.Builder signingAlgorithm​(SigningAlgorithmSpec 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.

        Parameters:
        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.

        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        SigningAlgorithmSpec, SigningAlgorithmSpec

      • dryRun

        SignRequest.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.