Skip to content

Commit 4a20ce1

Browse files
committed
adding docstring warnings that EncryptionSuite, KDFSuite, and AuthenticationSuite members must only be used as part of an AlgorithmSuite
1 parent c63d82b commit 4a20ce1

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/aws_encryption_sdk/identifiers.py

+6
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
class EncryptionSuite(Enum):
2929
"""Static definition of encryption algorithm details.
3030
31+
.. warning:: These members must only be used as part of an AlgorithmSuite.
32+
3133
:param algorithm: Encryption algorithm to use
3234
:type algorithm: cryptography.io ciphers algorithm object
3335
:param mode: Encryption mode in which to operate
@@ -73,6 +75,8 @@ def valid_kdf(self, kdf):
7375
class KDFSuite(Enum):
7476
"""Static definition of key derivation algorithm details.
7577
78+
.. warning:: These members must only be used as part of an AlgorithmSuite.
79+
7680
:param algorithm: KDF algorithm to use
7781
:type algorithm: cryptography.io KDF object
7882
:param int input_length: Number of bytes of input data to feed into KDF function
@@ -108,6 +112,8 @@ def input_length(self, encryption):
108112
class AuthenticationSuite(Enum):
109113
"""Static definition of authentication algorithm details.
110114
115+
.. warning:: These members must only be used as part of an AlgorithmSuite.
116+
111117
:param algorithm: Information needed by signing algorithm to define behavior
112118
:type algorithm: may vary (currently only ECC curve object)
113119
:param hash_algorithm: Hash algorithm to use in signature

0 commit comments

Comments
 (0)