CipherContextBuilder

Provides support for building contexts for symmetric cryptographic operations.

​

Extends

• BaseCryptoClass

​

Extended by

• GcmContextBuilder
• CbcContextBuilder
• CtrContextBuilder

​

Accessors

​

key

​

Set Signature

set key(key): void Specify the symmetric key to be used for encryption or decryption.

Remarks

This parameter is mandatory.

Parameters

key

SymmetricKey The symmetric key to use.

Returns

void

​

Methods

​

buildDecryptionContext()

buildDecryptionContext(): DecryptionContext Build a context that can be used for decryption operations.

​

Returns

DecryptionContext A decryption context.

​

Throws

AccessDeniedError If the key lacks the KeyPurpose.DECRYPT purpose.

​

Throws

InvalidArgumentError If any mandatory parameter is missing or the key is invalid.

---

​

buildEncryptionContext()

buildEncryptionContext(): EncryptionContext Build a context that can be used for encryption operations.

​

Returns

EncryptionContext An encryption context.

​

Throws

AccessDeniedError If the key lacks the KeyPurpose.ENCRYPT purpose.

​

Throws

InvalidArgumentError If any mandatory parameter is missing or the key is invalid.

---

​

buildWrappingContext()

buildWrappingContext(scheme): WrappingContext Build a context that can be used for wrapping keys.

​

Parameters

scheme

WrappingScheme The wrapping scheme to be used.

​

Returns

WrappingContext A wrapping context.

​

Throws

AccessDeniedError If the key lacks the KeyPurpose.WRAP and KeyPurpose.UNWRAP purposes.

​

Throws

InvalidArgumentError If any mandatory parameter is missing or the key is invalid.

​

Throws

NotSupportedError If the implementation does not support wrapping operations.

---