aws_encryption_sdk.key_providers.raw

Resources required for Raw Master Keys.

Classes

RawMasterKey(**kwargs)	Raw Master Key.
RawMasterKeyConfig(key_id, provider_id, ...)	Configuration object for RawMasterKey objects.
RawMasterKeyProvider(**kwargs)	Raw Master Key Provider.

class aws_encryption_sdk.key_providers.raw.RawMasterKeyConfig(key_id, provider_id, wrapping_key)

Bases: MasterKeyConfig

Configuration object for RawMasterKey objects.

Parameters

• key_id (bytes) – Key ID for Master Key

• provider_id (str) – String defining provider ID

• wrapping_key (aws_encryption_sdk.internal.crypto.WrappingKey) – Encryption key with which to wrap plaintext_data_key

Method generated by attrs for class RawMasterKeyConfig.

class aws_encryption_sdk.key_providers.raw.RawMasterKey(**kwargs)

Bases: MasterKey

Raw Master Key.

Parameters

• config (aws_encryption_sdk.key_providers.raw.RawMasterKeyConfig) – Configuration object (config or individual parameters required)

• key_id (bytes) – Key ID for Master Key

• provider_id (str) – String defining provider ID

• wrapping_key (aws_encryption_sdk.internal.crypto.WrappingKey) – Encryption key with which to wrap plaintext_data_key

Inject registration of the new Raw Master Key Provider into the creation of each instance.

Note

Overloaded here to allow definition of _key_info_prefix on instantiation.

provider_id = None

owns_data_key(data_key)

Determines if data_key object is owned by this RawMasterKey.

Parameters

data_key (aws_encryption_sdk.structures.DataKey, aws_encryption_sdk.structures.RawDataKey, or aws_encryption_sdk.structures.EncryptedDataKey) – Data key to evaluate

Returns

Boolean statement of ownership

Return type

bool

class aws_encryption_sdk.key_providers.raw.RawMasterKeyProvider(**kwargs)

Bases: MasterKeyProvider

Raw Master Key Provider.

Parameters

config (aws_encryption_sdk.key_providers.base.MasterKeyProviderConfig) – Configuration object (optional)

Set key index and member set for all new instances here to avoid requiring child classes to call super init.

vend_masterkey_on_decrypt = False

Determines whether a MasterKeyProvider attempts to add a MasterKey on decrypt_data_key call.