Skip to content

Commit 2da41df

Browse files
committed
fix
1 parent 6d44ed1 commit 2da41df

File tree

3 files changed

+10
-13
lines changed

3 files changed

+10
-13
lines changed

examples/src/migration/README.rst

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,13 @@ level cryptographic materials management of encryption and decryption materials.
77

88
This directory contains migration examples for:
99

10-
* Moving to Keyrings from Master Key Providers:
11-
#. Migration example to AWS KMS keyring from AWS KMS Master Key Provider.
12-
#. Migration example to Raw AES keyring from Raw AES Master Key Provider.
13-
#. Migration example to Raw RSA keyring from Raw RSA Master Key Provider.
10+
#. Moving to Keyrings from Master Key Providers:
11+
* Migration example to AWS KMS keyring from AWS KMS Master Key Provider.
12+
* Migration example to Raw AES keyring from Raw AES Master Key Provider.
13+
* Migration example to Raw RSA keyring from Raw RSA Master Key Provider.
1414

15-
* Migration to newer versions of the ESDK from the old version (1.x):
16-
#. Setting a 'CommitmentPolicy' during migration.
17-
If you have messages encrypted in the older versions of the ESDK (1.x),
18-
this example can guide you on how to decrypt those messages using the
19-
new version of the ESDK.
15+
#. Migration to newer versions of the ESDK (4.x+) from 1.x versions:
16+
* Setting a 'CommitmentPolicy' during migration - If you have messages encrypted with 1.x versions of the ESDK (i.e. not using key commitment) and want to migrate to encrypt with key commitment using the keyring providers introduced in ESDK 4.x, this example will guide you on how to decrypt those messages using the new version of the ESDK.
2017

2118
.. _AWS Cryptographic Material Providers Library: https://github.com/aws/aws-cryptographic-material-providers-library
2219
.. _Encryption SDK for Python: https://github.com/aws/aws-encryption-sdk-python/tree/9c34aad60fc918c1a9186ec5215a451e8bfd0f65

examples/src/migration/migration_raw_aes_key_example.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
2020
Note: The ciphertexts obtained by encrypting EXAMPLE_DATA using keyring and MKP are not
2121
the same because the ESDK generates different data keys each time for encryption of the data.
22-
But both ciphertexts when decrypted using keyring and MKP should give the same plaintext result.
22+
But both ciphertexts when decrypted using keyring and MKP will give the same plaintext result.
2323
2424
For more information on how to use Raw AES keyrings, see
2525
https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-raw-aes-keyring.html
@@ -172,7 +172,7 @@ def migration_raw_aes_key():
172172
# Note: The ciphertexts obtained by encrypting EXAMPLE_DATA using keyring and MKP
173173
# (that is ciphertext_keyring and ciphertext_mkp) are not the same because the ESDK
174174
# generates different data keys each time for encryption of the data. But both
175-
# ciphertexts when decrypted using keyring and MKP should give the same plaintext result.
175+
# ciphertexts when decrypted using keyring and MKP will give the same plaintext result.
176176

177177
# 3. Decrypt the ciphertext_keyring using both the keyring and MKP and ensure the
178178
# resulting plaintext is the same and also equal to EXAMPLE_DATA

examples/src/migration/migration_raw_rsa_key_example.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
2424
Note: The ciphertexts obtained by encrypting EXAMPLE_DATA using keyring and MKP are not
2525
the same because the ESDK generates different data keys each time for encryption of the data.
26-
But both ciphertexts when decrypted using keyring and MKP should give the same plaintext result.
26+
But both ciphertexts when decrypted using keyring and MKP will give the same plaintext result.
2727
2828
For more information on how to use Raw RSA keyrings, see
2929
https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/use-raw-rsa-keyring.html
@@ -224,7 +224,7 @@ def migration_raw_rsa_key(
224224
# Note: The ciphertexts obtained by encrypting EXAMPLE_DATA using keyring and MKP
225225
# (that is ciphertext_keyring and ciphertext_mkp) are not the same because the ESDK
226226
# generates different data keys each time for encryption of the data. But both
227-
# ciphertexts when decrypted using keyring and MKP should give the same plaintext result.
227+
# ciphertexts when decrypted using keyring and MKP will give the same plaintext result.
228228

229229
# 3. Decrypt the ciphertext_keyring using both the keyring and MKP and ensure the
230230
# resulting plaintext is the same and also equal to EXAMPLE_DATA

0 commit comments

Comments
 (0)