ISymmetricKeyBuilder

​

Interface ISymmetricKeyBuilder

interface ISymmetricKeyBuilder

Extends com.amazon.apmf.IStandard

​

Methods

​

algorithm()

ISymmetricKeyBuilder* algorithm(ISymmetricAlgorithm* alg)

Set the algorithm this key will be used with. Defaults to AES.

​

Parameters

alg

ISymmetricAlgorithm* — Required The symmetric algorithm.

​

Returns

ISymmetricKeyBuilder* The symmetric key builder.

---

​

bits()

ISymmetricKeyBuilder* bits(i32 bits)

Set the number of bits this key should be. Defaults to 256 for AES.

​

Parameters

bits

i32 — Required The number of bits.

​

Returns

ISymmetricKeyBuilder* The symmetric key builder.

---

​

purposes()

ISymmetricKeyBuilder* purposes(string[] purposes)

Set the purposes for the key to be generated.

​

Parameters

purposes

string[] — Required An array of strings whose elements are constants defined in IKeyWithPurpose.

​

Returns

ISymmetricKeyBuilder* The symmetric key builder.

---

​

exportable()

ISymmetricKeyBuilder* exportable(bool exportable)

Set the exportability for the key to be generated. A key is NOT exportable unless explicitly set so.

​

Parameters

exportable

bool — Required A boolean value indicating whether the key is exportable.

​

Returns

ISymmetricKeyBuilder* The symmetric key builder.

---

​

buildGenerated()

ISymmetricKey* buildGenerated()

Build a symmetric key generated by the builder.

​

Returns

ISymmetricKey* The generated symmetric key.

---

​

buildFromRaw()

ISymmetricKey* buildFromRaw(u8[] rawKey)

Build a symmetric key from a raw key.

​

Parameters

rawKey

u8[] — Required The raw key bytes.

​

Returns

ISymmetricKey* The built symmetric key.

---