Adding example one_kms_cmk

examples/src/one_kms_cmk.py

@@ -0,0 +1,42 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Example showing basic encryption and decryption of a value already in memory using one KMS CMK."""
+import aws_encryption_sdk
+
+
+def encrypt_decrypt(key_arn, source_plaintext, botocore_session=None):
+
+    kwargs = dict(key_ids=[key_arn])
+
+    if botocore_session is not None:
+        kwargs["botocore_session"] = botocore_session
+
+    # Create master key provider using the ARN of the key and the session (botocore_session)
+    kms_key_provider = aws_encryption_sdk.KMSMasterKeyProvider(**kwargs)
+
+    # Encrypt the plaintext using the AWS Encryption SDK. It returns the encrypted message and the header
+    ciphertext, encrypted_message_header = aws_encryption_sdk.encrypt(
+        source=source_plaintext, key_provider=kms_key_provider
+    )
+
+    # Decrypt the encrypted message using the AWS Encryption SDK. It returns the decrypted message and the header
+    plaintext, decrypted_message_header = aws_encryption_sdk.decrypt(source=ciphertext, key_provider=kms_key_provider)
+
+    # Check if the original message and the decrypted message are the same
+    assert source_plaintext == plaintext
+
+    # Check if the headers of the encrypted message and decrypted message match
+    assert all(
+        pair in encrypted_message_header.encryption_context.items()
+        for pair in decrypted_message_header.encryption_context.items()
+    )

examples/test/examples_test_utils.py

@@ -17,4 +17,8 @@
 os.environ["AWS_ENCRYPTION_SDK_EXAMPLES_TESTING"] = "yes"
 sys.path.extend([os.sep.join([os.path.dirname(__file__), "..", "..", "test", "integration"])])
 
+static_plaintext = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent non feugiat leo. Aenean iaculis tellus ut velit consectetur, quis convallis orci eleifend. Sed eu dictum sapien. Nulla facilisi. Suspendisse potenti. Proin vehicula vehicula maximus. Donec varius et elit vel rutrum. Nulla lacinia neque turpis, quis consequat orci pharetra et. Etiam consequat ullamcorper mauris. Vivamus molestie mollis mauris a gravida. Curabitur sed bibendum nisl. Cras varius tortor non erat sodales, quis congue tellus laoreet. Etiam fermentum purus eu diam sagittis, vitae commodo est vehicula. Nulla feugiat viverra orci vel interdum. Quisque pulvinar elit eget nulla facilisis varius. Mauris at suscipit sem. Aliquam in purus ut velit fringilla volutpat id non mi. Curabitur quis nunc eleifend, ornare lectus non, fringilla quam. Nam maximus volutpat placerat. Nulla ullamcorper lorem velit, nec sagittis ex tristique posuere. Aliquam fringilla magna commodo libero faucibus tempor. Vestibulum non ligula tincidunt, finibus sapien in, sollicitudin ex. Pellentesque congue laoreet mi in condimentum. Cras convallis nisi ac nunc tincidunt venenatis. Suspendisse urna elit, cursus eu lacus a, aliquet porttitor mi. Nulla vel congue nibh, sed condimentum dui. Ut ante ligula, blandit eu finibus nec, scelerisque quis eros. Maecenas gravida odio eget nibh dictum, dictum varius lacus interdum. Integer quis nulla vulputate, rhoncus diam vitae, mollis mauris. Sed ut porttitor dolor. Fusce ut justo a ex bibendum imperdiet nec sit amet magna. Sed ullamcorper luctus augue, tempor viverra elit interdum sed. Cras sit amet arcu eu turpis molestie sollicitudin. Curabitur fermentum varius nibh, ut aliquet nisi. Aliquam id tempus tellus. Nulla porttitor nulla at nibh interdum, quis sollicitudin erat egestas. Ut blandit mauris quis efficitur efficitur. Morbi neque sapien, posuere ut aliquam eget, aliquam at velit. Morbi sit amet rhoncus felis, et hendrerit sem. Nulla porta dictum ligula eget iaculis. Cras lacinia ligula quis risus ultrices, sed consectetur metus imperdiet. Nullam id enim vestibulum nibh ultricies auctor. Morbi neque lacus, faucibus vitae commodo quis, malesuada sed velit.'
+static_plaintext = str.encode(static_plaintext)
+
 from integration_test_utils import get_cmk_arn  # noqa pylint: disable=unused-import,import-error
+

examples/test/test_i_basic_encryption.py

@@ -18,12 +18,13 @@
 
 from ..src.basic_encryption import cycle_string
 from .examples_test_utils import get_cmk_arn
+from .examples_test_utils import static_plaintext
 
 
 pytestmark = [pytest.mark.examples]
 
 
 def test_cycle_string():
-    plaintext = os.urandom(1024)
+    plaintext = static_plaintext
     cmk_arn = get_cmk_arn()
     cycle_string(key_arn=cmk_arn, source_plaintext=plaintext, botocore_session=botocore.session.Session())

examples/test/test_i_basic_file_encryption_with_multiple_providers.py

@@ -19,6 +19,7 @@
 
 from ..src.basic_file_encryption_with_multiple_providers import cycle_file
 from .examples_test_utils import get_cmk_arn
+from .examples_test_utils import static_plaintext
 
 
 pytestmark = [pytest.mark.examples]
@@ -28,7 +29,7 @@ def test_cycle_file():
     cmk_arn = get_cmk_arn()
     handle, filename = tempfile.mkstemp()
     with open(filename, "wb") as f:
-        f.write(os.urandom(1024))
+        f.write(static_plaintext)
     try:
         new_files = cycle_file(
             key_arn=cmk_arn, source_plaintext_filename=filename, botocore_session=botocore.session.Session()

examples/test/test_i_basic_file_encryption_with_raw_key_provider.py

@@ -17,6 +17,7 @@
 import pytest
 
 from ..src.basic_file_encryption_with_raw_key_provider import cycle_file
+from .examples_test_utils import static_plaintext
 
 
 pytestmark = [pytest.mark.examples]
@@ -25,7 +26,7 @@
 def test_cycle_file():
     handle, filename = tempfile.mkstemp()
     with open(filename, "wb") as f:
-        f.write(os.urandom(1024))
+        f.write(static_plaintext)
     try:
         new_files = cycle_file(source_plaintext_filename=filename)
         for f in new_files:

examples/test/test_i_one_kms_cmk.py

@@ -0,0 +1,30 @@
+# Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License"). You
+# may not use this file except in compliance with the License. A copy of
+# the License is located at
+#
+# http://aws.amazon.com/apache2.0/
+#
+# or in the "license" file accompanying this file. This file is
+# distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, either express or implied. See the License for the specific
+# language governing permissions and limitations under the License.
+"""Unit test suite for the encryption and decryption using one KMS CMK example."""
+import os
+
+import botocore.session
+import pytest
+
+from ..src.one_kms_cmk import encrypt_decrypt
+from .examples_test_utils import get_cmk_arn
+from .examples_test_utils import static_plaintext
+
+
+pytestmark = [pytest.mark.examples]
+
+
+def test_one_kms_cmk():
+    plaintext = static_plaintext
+    cmk_arn = get_cmk_arn()
+    encrypt_decrypt(key_arn=cmk_arn, source_plaintext=plaintext, botocore_session=botocore.session.Session())