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

Author: mattsb42-aws

src/examples/java/com/amazonaws/crypto/examples/FileStreamingDefaults.java

@@ -54,6 +54,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final File sourcePlaintextFi
         decryptedFile.deleteOnExit();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/InMemoryStreamingDefaults.java

@@ -44,6 +44,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/OneStepDefaults.java

@@ -36,6 +36,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/OneStepUnsigned.java

@@ -50,6 +50,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         awsEncryptionSdk.setEncryptionAlgorithm(CryptoAlgorithm.ALG_AES_256_GCM_IV12_TAG16_HKDF_SHA256);
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/cryptomaterialsmanager/caching/SimpleCache.java

@@ -54,6 +54,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/cryptomaterialsmanager/custom/AlgorithmSuiteEnforcement.java

@@ -114,6 +114,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/cryptomaterialsmanager/custom/RequiringEncryptionContextFields.java

@@ -103,6 +103,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/ActLikeAwsKmsMasterKeyProvider.java

@@ -59,6 +59,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final List<AwsKmsCmkId> awsK
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/CustomClientSupplier.java

@@ -89,6 +89,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/CustomKmsClientConfig.java

@@ -52,6 +52,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/DiscoveryDecrypt.java

@@ -57,6 +57,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/DiscoveryDecryptInRegionOnly.java

@@ -64,6 +64,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/DiscoveryDecryptWithPreferredRegions.java

@@ -70,6 +70,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/MultipleRegions.java

@@ -48,6 +48,7 @@ public static void run(final AwsKmsCmkId awsKmsGeneratorCmk, final List<AwsKmsCm
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/awskms/SingleCmk.java

@@ -45,6 +45,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/multi/AwsKmsWithEscrow.java

@@ -51,6 +51,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/rawaes/RawAes.java

@@ -36,6 +36,7 @@ public static void run(final byte[] sourcePlaintext) {
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/rawrsa/PublicPrivateKeySeparate.java

@@ -50,6 +50,7 @@ public static void run(final byte[] sourcePlaintext) throws GeneralSecurityExcep
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/rawrsa/RawRsa.java

@@ -40,6 +40,7 @@ public static void run(final byte[] sourcePlaintext) throws GeneralSecurityExcep
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/keyring/rawrsa/RawRsaDerEncoded.java

@@ -47,6 +47,7 @@ public static void run(final byte[] sourcePlaintext) throws GeneralSecurityExcep
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/awskms/DiscoveryDecrypt.java

@@ -45,6 +45,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/awskms/MultipleRegions.java

@@ -46,6 +46,7 @@ public static void run(final AwsKmsCmkId awsKmsGeneratorCmk, final List<AwsKmsCm
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/awskms/SingleCmk.java

@@ -41,6 +41,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/multi/AwsKmsWithEscrow.java

@@ -57,6 +57,7 @@ public static void run(final AwsKmsCmkId awsKmsCmk, final byte[] sourcePlaintext
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/rawaes/RawAes.java

@@ -37,6 +37,7 @@ public static void run(final byte[] sourcePlaintext) {
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");

src/examples/java/com/amazonaws/crypto/examples/masterkeyprovider/rawrsa/RawRsa.java

@@ -37,6 +37,7 @@ public static void run(final byte[] sourcePlaintext) throws GeneralSecurityExcep
         final AwsCrypto awsEncryptionSdk = new AwsCrypto();
 
         // 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
         final Map<String, String> encryptionContext = new HashMap<>();
         encryptionContext.put("encryption", "context");