as

Settings
Sign out
Notifications
Alexa
Amazon Appstore
AWS
Documentation
Support
Contact Us
My Cases
Get Started
Design and Develop
Publish
Reference
Support

SignatureContextBuilder

Provides support for building signature contexts. This class allows the configuration of digital signature operations, including setting the signing algorithm and digest method.

Extends

  • BaseCryptoClass

Extended by

Accessors

digestAlgorithm

Set Signature

set digestAlgorithm(algorithm): void

Set the digest algorithm to use for hashing message contents. This will default to SHA-256 if not specified.

Throws

InvalidArgumentError If the algorithm is invalid.

Parameters
algorithm

DigestAlgorithm

The digest algorithm to use.

Returns

void


signingAlgorithm

Set Signature

set signingAlgorithm(algorithm): void

Set the algorithm to use for signing. If not specified, this will be determined from the key type if possible.

Throws

InvalidArgumentError If the algorithm is invalid.

Parameters
algorithm

AsymmetricAlgorithm

The asymmetric algorithm to use for signing.

Returns

void

Methods

buildSigningContext()

buildSigningContext(key): SigningContext

Build a context for signing operations. This context can be used to create digital signatures using the specified private key.

Parameters

key

PrivateKey

The private key to use for signing.

Returns

SigningContext

A signing context object.

Throws

AccessDeniedError If the key lacks the KeyPurpose.SIGN purpose.

Throws

InvalidArgumentError If the signing algorithm is not supported.


buildVerificationContext()

buildVerificationContext(key): VerificationContext

Build a context for verification operations. This context can be used to verify digital signatures using the specified public key.

Parameters

key

PublicKey

The public key to use for verification.

Returns

VerificationContext

A verification context object.

Throws

AccessDeniedError If the key lacks the KeyPurpose.VERIFY purpose.

Throws

InvalidArgumentError If the signing algorithm is not supported.


Last updated: Sep 30, 2025