deprecated

Author: lucasmcdonald3

src/aws_encryption_sdk/key_providers/base.py

@@ -25,20 +25,23 @@
     InvalidKeyIdError,
     MasterKeyProviderError,
 )
+from aws_encryption_sdk.internal.deprecation import deprecated
 from aws_encryption_sdk.internal.str_ops import to_bytes
 from aws_encryption_sdk.structures import MasterKeyInfo
 
 _LOGGER = logging.getLogger(__name__)
 
 
 @attr.s(hash=True)
+@deprecated("Use keyrings from the aws-cryptographic-material-providers library.")
 class MasterKeyProviderConfig(object):
     """Provides a common ancestor for MasterKeyProvider configuration objects
     and a stand-in point if common params are needed later.
     """
 
 
 @six.add_metaclass(abc.ABCMeta)
+@deprecated("Use keyrings from the aws-cryptographic-material-providers library.")
 class MasterKeyProvider(object):
     """Parent interface for Master Key Provider classes.
 
@@ -325,6 +328,7 @@ def decrypt_data_key_from_list(self, encrypted_data_keys, algorithm, encryption_
 
 
 @attr.s(hash=True)
+@deprecated("Use keyrings from the aws-cryptographic-material-providers library.")
 class MasterKeyConfig(object):
     """Configuration object for MasterKey objects.
 
@@ -342,6 +346,7 @@ def __attrs_post_init__(self):
 
 
 @six.add_metaclass(abc.ABCMeta)
+@deprecated("Use keyrings from the aws-cryptographic-material-providers library.")
 class MasterKey(MasterKeyProvider):
     """Parent interface for Master Key classes.
 

src/aws_encryption_sdk/key_providers/kms.py

@@ -35,6 +35,7 @@
 )
 from aws_encryption_sdk.identifiers import USER_AGENT_SUFFIX
 from aws_encryption_sdk.internal.arn import arn_from_str, is_valid_mrk_identifier
+from aws_encryption_sdk.internal.deprecation import deprecated
 from aws_encryption_sdk.internal.str_ops import to_str
 from aws_encryption_sdk.key_providers.base import MasterKey, MasterKeyConfig, MasterKeyProvider, MasterKeyProviderConfig
 from aws_encryption_sdk.structures import DataKey, EncryptedDataKey, MasterKeyInfo
@@ -143,6 +144,7 @@ class DiscoveryFilter(object):
 
 
 @attr.s(hash=True)
+@deprecated("Use KMS keyrings from the aws-cryptographic-material-providers library.")
 class KMSMasterKeyConfig(MasterKeyConfig):
     """Configuration object for KMSMasterKey objects.
 
@@ -170,6 +172,7 @@ def client_default(self):
         return boto3.session.Session(**kwargs).client("kms", config=botocore_config)
 
 
+@deprecated("Use KMS keyrings from the aws-cryptographic-material-providers library.")
 class KMSMasterKey(MasterKey):
     """Master Key class for KMS CMKs.
 
@@ -383,6 +386,7 @@ def _validate_allowed_to_decrypt(self, edk_key_id):
 
 
 @attr.s(hash=True)
+@deprecated("Use KMS MRK keyrings from the aws-cryptographic-material-providers library.")
 class MRKAwareKMSMasterKeyConfig(MasterKeyConfig):
     """Configuration object for MRKAwareKMSMasterKey objects. Mostly the same as KMSMasterKey, except the
     client parameter is required rather than optional.
@@ -405,6 +409,7 @@ class MRKAwareKMSMasterKeyConfig(MasterKeyConfig):
     )
 
 
+@deprecated("Use KMS MRK keyrings from the aws-cryptographic-material-providers library.")
 class MRKAwareKMSMasterKey(KMSMasterKey):
     """Master Key class for KMS MRKAware CMKs. The logic for this class is almost entirely the same as a normal
     KMSMasterKey ("single-region key"). The primary difference is that this class is more flexible in what ciphertexts
@@ -515,6 +520,7 @@ def owns_data_key(self, data_key):
 
 
 @attr.s(hash=True)
+@deprecated("Use KMS keyrings from the aws-cryptographic-material-providers library.")
 class KMSMasterKeyProviderConfig(MasterKeyProviderConfig):
     """Configuration object for KMSMasterKeyProvider objects.
 
@@ -551,6 +557,7 @@ class KMSMasterKeyProviderConfig(MasterKeyProviderConfig):
 
 
 @six.add_metaclass(abc.ABCMeta)
+@deprecated("Use KMS keyrings from the aws-cryptographic-material-providers library.")
 class BaseKMSMasterKeyProvider(MasterKeyProvider):
     """Master Key Provider for KMS.
 
@@ -739,6 +746,7 @@ def _new_master_key_impl(self, key_id):
         )
 
 
+@deprecated("Use KMS keyrings from the aws-cryptographic-material-providers library.")
 class StrictAwsKmsMasterKeyProvider(BaseKMSMasterKeyProvider):
     """Strict Master Key Provider for KMS. It is configured with an explicit list of AWS KMS master keys that
     should be used for encryption and decryption. On encryption, the plaintext will be encrypted with all configured
@@ -805,6 +813,7 @@ def validate_config(self):
             )
 
 
+@deprecated("Use KMS MRK keyrings from the aws-cryptographic-material-providers library.")
 class MRKAwareStrictAwsKmsMasterKeyProvider(StrictAwsKmsMasterKeyProvider):
     """A Strict Master Key Provider for KMS that has smarts for handling Multi-Region keys.
 
@@ -874,6 +883,7 @@ def validate_unique_mrks(self):
             )
 
 
+@deprecated("Use KMS discovery keyrings from the aws-cryptographic-material-providers library.")
 class DiscoveryAwsKmsMasterKeyProvider(BaseKMSMasterKeyProvider):
     """Discovery Master Key Provider for KMS. This can only be used for decryption. It is configured with an optional
      Discovery Filter containing AWS account ids and partitions that should be trusted for decryption. If a ciphertext
@@ -929,6 +939,7 @@ def validate_config(self):
             )
 
 
+@deprecated("Use KMS MRK keyrings from the aws-cryptographic-material-providers library.")
 class MRKAwareDiscoveryAwsKmsMasterKeyProvider(DiscoveryAwsKmsMasterKeyProvider):
     """Discovery Master Key Provider for KMS that has smarts for handling Multi-Region keys
 

src/aws_encryption_sdk/key_providers/raw.py

@@ -22,13 +22,15 @@
 import aws_encryption_sdk.internal.formatting.serialize
 from aws_encryption_sdk.identifiers import EncryptionType
 from aws_encryption_sdk.internal.crypto.wrapping_keys import WrappingKey
+from aws_encryption_sdk.internal.deprecation import deprecated
 from aws_encryption_sdk.key_providers.base import MasterKey, MasterKeyConfig, MasterKeyProvider, MasterKeyProviderConfig
 from aws_encryption_sdk.structures import DataKey, RawDataKey
 
 _LOGGER = logging.getLogger(__name__)
 
 
 @attr.s(hash=True)
+@deprecated("Use raw keyrings from the aws-cryptographic-material-providers library.")
 class RawMasterKeyConfig(MasterKeyConfig):
     """Configuration object for RawMasterKey objects.
 
@@ -46,6 +48,7 @@ class RawMasterKeyConfig(MasterKeyConfig):
     wrapping_key = attr.ib(hash=True, validator=attr.validators.instance_of(WrappingKey))
 
 
+@deprecated("Use raw keyrings from the aws-cryptographic-material-providers library.")
 class RawMasterKey(MasterKey):
     """Raw Master Key.
 
@@ -189,6 +192,7 @@ def _decrypt_data_key(self, encrypted_data_key, algorithm, encryption_context):
 
 
 @six.add_metaclass(abc.ABCMeta)
+@deprecated("Use raw keyrings from the aws-cryptographic-material-providers library.")
 class RawMasterKeyProvider(MasterKeyProvider):
     """Raw Master Key Provider.