docs: add note in every example pointing out that encryption context is not secret (#267)

mattsb42-aws · web-flow · commit a48b3d34a2d3 · 2020-05-05T11:55:33.000-07:00
diff --git a/examples/src/crypto_materials_manager/caching/simple_cache.py b/examples/src/crypto_materials_manager/caching/simple_cache.py
@@ -36,6 +36,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/crypto_materials_manager/custom/algorithm_suite_enforcement.py b/examples/src/crypto_materials_manager/custom/algorithm_suite_enforcement.py
@@ -82,6 +82,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/crypto_materials_manager/custom/requiring_encryption_context_fields.py b/examples/src/crypto_materials_manager/custom/requiring_encryption_context_fields.py
@@ -77,6 +77,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/file_streaming_defaults.py b/examples/src/file_streaming_defaults.py
@@ -30,6 +30,7 @@ def run(aws_kms_cmk, source_plaintext_filename):
     decrypted_filename = ciphertext_filename + ".decrypted"
 
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/in_memory_streaming_defaults.py b/examples/src/in_memory_streaming_defaults.py
@@ -25,6 +25,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/act_like_aws_kms_master_key_provider.py b/examples/src/keyring/aws_kms/act_like_aws_kms_master_key_provider.py
@@ -46,6 +46,7 @@ def run(aws_kms_cmk, aws_kms_additional_cmks, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/custom_client_supplier.py b/examples/src/keyring/aws_kms/custom_client_supplier.py
@@ -78,6 +78,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/custom_kms_client_config.py b/examples/src/keyring/aws_kms/custom_kms_client_config.py
@@ -38,6 +38,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/discovery_decrypt.py b/examples/src/keyring/aws_kms/discovery_decrypt.py
@@ -41,6 +41,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/discovery_decrypt_in_region_only.py b/examples/src/keyring/aws_kms/discovery_decrypt_in_region_only.py
@@ -45,6 +45,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/discovery_decrypt_with_preferred_regions.py b/examples/src/keyring/aws_kms/discovery_decrypt_with_preferred_regions.py
@@ -54,6 +54,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/multiple_regions.py b/examples/src/keyring/aws_kms/multiple_regions.py
@@ -36,6 +36,7 @@ def run(aws_kms_generator_cmk, aws_kms_additional_cmks, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/aws_kms/single_cmk.py b/examples/src/keyring/aws_kms/single_cmk.py
@@ -29,6 +29,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/multi/aws_kms_with_escrow.py b/examples/src/keyring/multi/aws_kms_with_escrow.py
@@ -37,6 +37,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/raw_aes/raw_aes.py b/examples/src/keyring/raw_aes/raw_aes.py
@@ -20,6 +20,7 @@ def run(source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/raw_rsa/keypair.py b/examples/src/keyring/raw_rsa/keypair.py
@@ -25,6 +25,7 @@ def run(source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/raw_rsa/keypair_from_pem.py b/examples/src/keyring/raw_rsa/keypair_from_pem.py
@@ -28,6 +28,7 @@ def run(source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/keyring/raw_rsa/public_private_key_separate.py b/examples/src/keyring/raw_rsa/public_private_key_separate.py
@@ -35,6 +35,7 @@ def run(source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/master_key_provider/aws_kms/discovery_decrypt.py b/examples/src/master_key_provider/aws_kms/discovery_decrypt.py
@@ -31,6 +31,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/master_key_provider/aws_kms/multiple_regions.py b/examples/src/master_key_provider/aws_kms/multiple_regions.py
@@ -34,6 +34,7 @@ def run(aws_kms_generator_cmk, aws_kms_additional_cmks, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/master_key_provider/aws_kms/single_cmk.py b/examples/src/master_key_provider/aws_kms/single_cmk.py
@@ -27,6 +27,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/master_key_provider/multi/aws_kms_with_escrow.py b/examples/src/master_key_provider/multi/aws_kms_with_escrow.py
@@ -41,6 +41,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/master_key_provider/raw_aes/raw_aes.py b/examples/src/master_key_provider/raw_aes/raw_aes.py
@@ -25,6 +25,7 @@ def run(source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/master_key_provider/raw_rsa/private_key_only_from_pem.py b/examples/src/master_key_provider/raw_rsa/private_key_only_from_pem.py
@@ -30,6 +30,7 @@ def run(source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/onestep_defaults.py b/examples/src/onestep_defaults.py
@@ -20,6 +20,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
diff --git a/examples/src/onestep_unsigned.py b/examples/src/onestep_unsigned.py
@@ -33,6 +33,7 @@ def run(aws_kms_cmk, source_plaintext):
     :param bytes source_plaintext: Plaintext to encrypt
     """
     # Prepare your encryption context.
+    # Remember that your encryption context is NOT SECRET.
     # https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/concepts.html#encryption-context
     encryption_context = {
         "encryption": "context",
