Skip to content

Commit 202bb59

Browse files
committed
docs: add docs explaining each keyring trace flag
1 parent 557a75a commit 202bb59

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

src/aws_encryption_sdk/identifiers.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -340,8 +340,16 @@ class KeyringTraceFlagValue(object):
340340

341341
name = attr.ib()
342342

343+
#: A flag to represent that a keyring has generated a plaintext data key.
343344
GENERATED_DATA_KEY = KeyringTraceFlagValue("GENERATED_DATA_KEY")
345+
#: A flag to represent that a keyring has created an encrypted data key.
344346
ENCRYPTED_DATA_KEY = KeyringTraceFlagValue("ENCRYPTED_DATA_KEY")
347+
#: A flag to represent that a keyring has obtained
348+
#: the corresponding plaintext data key from an encrypted data key.
345349
DECRYPTED_DATA_KEY = KeyringTraceFlagValue("DECRYPTED_DATA_KEY")
350+
#: A flag to represent that the keyring has cryptographically
351+
#: bound the encryption context to a newly created encrypted data key.
346352
SIGNED_ENCRYPTION_CONTEXT = KeyringTraceFlagValue("SIGNED_ENCRYPTION_CONTEXT")
353+
#: A flag to represent that the keyring has verified that an encrypted
354+
#: data key was originally created with a particular encryption context.
347355
VERIFIED_ENCRYPTION_CONTEXT = KeyringTraceFlagValue("VERIFIED_ENCRYPTION_CONTEXT")

0 commit comments

Comments
 (0)