IKeystoreSymmetricKeyBuilder

​

Interface IKeystoreSymmetricKeyBuilder

interface IKeystoreSymmetricKeyBuilder

Extends com.amazon.kepler.crypto.ISymmetricKeyBuilder An interface for generating or importing symmetric keys in a keystore.

​

Methods

​

digest()

IKeystoreSymmetricKeyBuilder* digest(com.amazon.kepler.crypto.IDigestAlgorithm* digest)

This function is deprecated, please use com.amazon.kepler.keystore.IKeystoreMacKeyBuilder.macAlgorithm instead. Set the digest algorithm supported for this key. This parameter is mandatory for keys with a purpose of signing or verifying (HMAC keys).

​

Parameters

digest

com.amazon.kepler.crypto.IDigestAlgorithm* — Required The digest to support.

​

Returns

IKeystoreSymmetricKeyBuilder* The builder.

---

​

addBlockMode()

IKeystoreSymmetricKeyBuilder* addBlockMode(BlockMode* mode)

Add a supported block mode for encrypting/decrypting with this key. This list should be kept as small as possible to limit the possibility of leaking the key.

​

Parameters

mode

BlockMode* — Required The block mode to add.

​

Returns

IKeystoreSymmetricKeyBuilder* The builder.

---

​

name()

IKeystoreSymmetricKeyBuilder* name(string name)

Set the name to identify this key. This parameter is mandatory. If a key with the same name already exists in the keystore, the build method will throw a DuplicateKeyError.

​

Parameters

name

string — Required The name for the key.

​

Returns

IKeystoreSymmetricKeyBuilder* The builder.

---