aws_encryption_sdk.materials_managers.default¶
Default crypto material manager class.
Classes
DefaultCryptoMaterialsManager ([…]) |
Default crypto material manager. |
-
class
aws_encryption_sdk.materials_managers.default.
DefaultCryptoMaterialsManager
(master_key_provider=None, keyring=None)¶ Bases:
aws_encryption_sdk.materials_managers.base.CryptoMaterialsManager
Default crypto material manager.
New in version 1.3.0.
New in version 1.5.0: The keyring parameter.
Parameters: - master_key_provider (MasterKeyProvider) – Master key provider to use
(either
keyring
ormaster_key_provider
is required) - keyring (Keyring) – Keyring to use
(either
keyring
ormaster_key_provider
is required)
-
decrypt_materials
(request)¶ Obtains a plaintext data key from one or more encrypted data keys using underlying master key provider.
Parameters: request (aws_encryption_sdk.materials_managers.DecryptionMaterialsRequest) – decrypt materials request Returns: decryption materials Return type: aws_encryption_sdk.materials_managers.DecryptionMaterials
-
get_encryption_materials
(request)¶ Creates encryption materials using underlying master key provider.
Parameters: request (aws_encryption_sdk.materials_managers.EncryptionMaterialsRequest) – encryption materials request
Returns: encryption materials
Return type: Raises: - InvalidCryptographicMaterialsError – if keyring cannot complete encryption materials
- InvalidCryptographicMaterialsError – if encryption materials received from keyring do not match request
- MasterKeyProviderError – if no master keys are available from the underlying master key provider
- MasterKeyProviderError – if the primary master key provided by the underlying master key provider is not included in the full set of master keys provided by that provider
- master_key_provider (MasterKeyProvider) – Master key provider to use
(either