Adding new examples and example test runner by WesleyRosenblum · Pull Request #165 · aws/aws-encryption-sdk-java

WesleyRosenblum · 2020-03-20T21:21:25Z

This adds example code to match the format defined in
aws/aws-encryption-sdk-python#219. Legacy tests were reverted to how they are currently in the master branch and moved to the Legacy folder
All examples are tested using JUnit5 Dynamic tests.

Check any applicable:

Were any files moved? Moving files changes their URL, which breaks all hyperlinks to the files.

Legacy example code was moved to the examples/legacy package

in aws/aws-encryption-sdk-python#219

SalusaSecondus

LGTM

mattsb42-aws

Notes on the file streaming example that will apply to all.

src/examples/README.md

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

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

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

mattsb42-aws

Comments on KMS and multi-keyring examples. Raw keyring comments coming soon.

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

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

mattsb42-aws · 2020-03-23T21:54:28Z

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

+        // Generate an RSA key pair to use with your keyring.
+        // In practice, you should get this key from a secure key management system such as an HSM.
+        final KeyPairGenerator kg = KeyPairGenerator.getInstance("RSA");
+        kg.initialize(4096); // Escrow keys should be very strong


As a naive reader, what does that mean? How do I know that 4096 is strong?

I like actually mentioning the key size, but we should point to a reference for what key size we recommend and why.

What if I just say “The National Institute of Standards and Technology (NIST) recommends a minimum of 2048-bit keys for RSA” and maybe link to https://www.nist.gov/publications/transitioning-use-cryptographic-algorithms-and-key-lengths or https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-57Pt3r1.pdf

I'll link to https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-56Br2.pdf

Actually https://www.nist.gov/publications/transitioning-use-cryptographic-algorithms-and-key-lengths is a more readable reference and links to 56Br2 anyway

mattsb42-aws

A few more minor changes. Otherwise LGTM.

Very happy that we'll be running these examples in our test suite! :D

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

mattsb42-aws · 2020-03-24T04:29:03Z

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

+        SecureRandom rnd = new SecureRandom();
+        byte[] rawKey = new byte[16]; // 128 bits
+        rnd.nextBytes(rawKey);
+        SecretKey key = new SecretKeySpec(rawKey, "AES");


Should we add a note that the mode defined here (if any) does not affect the behavior of the keyring?

Actually it does have to be AES, the keyring fails if not

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

src/examples/README.md

mattsb42-aws · 2020-03-24T04:56:01Z

Oh, one other thing that I forgot: How different is the process for loading a RSA key/pair from PEM/DER? Does Java provide something for that in the standard JCE toolset?

mattsb42-aws

I'd like to hold off on merging until @juneb signs off on aws/aws-encryption-sdk-python#221, but other than that, this LGTM. :)

Adding new examples and example test runner to follow the format set

81091ae

in aws/aws-encryption-sdk-python#219

WesleyRosenblum requested review from SalusaSecondus and mattsb42-aws March 20, 2020 21:22

SalusaSecondus previously approved these changes Mar 20, 2020

View reviewed changes

mattsb42-aws requested changes Mar 23, 2020

View reviewed changes

mattsb42-aws reviewed Mar 23, 2020

View reviewed changes

src/examples/java/com/amazonaws/crypto/examples/FileStreamingDefaults.java Outdated Show resolved Hide resolved

Updated wording and copyright notice

2ad02ff

WesleyRosenblum dismissed SalusaSecondus’s stale review via 2ad02ff March 23, 2020 21:00

mattsb42-aws requested changes Mar 23, 2020

View reviewed changes

src/examples/java/com/amazonaws/crypto/examples/OneStepDefaults.java Outdated Show resolved Hide resolved

mattsb42-aws reviewed Mar 23, 2020

View reviewed changes

src/examples/java/com/amazonaws/crypto/examples/InMemoryStreamingDefaults.java Outdated Show resolved Hide resolved

Adding periods

619ad06

mattsb42-aws requested changes Mar 23, 2020

View reviewed changes

Adding NIST recommendation for RSA

66e8dab

mattsb42-aws requested changes Mar 24, 2020

View reviewed changes

Adding example for DER formatted RSA keys

ada84e8

mattsb42-aws previously approved these changes Mar 24, 2020

View reviewed changes

Wording changes based on feedback

3436adf

WesleyRosenblum dismissed mattsb42-aws’s stale review via 3436adf March 25, 2020 17:42

mattsb42-aws approved these changes Mar 31, 2020

View reviewed changes

WesleyRosenblum merged commit 2d025a8 into keyring Mar 31, 2020

WesleyRosenblum deleted the examples branch April 2, 2020 18:31

Conversation

WesleyRosenblum commented Mar 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Check any applicable:

Uh oh!

SalusaSecondus left a comment

Choose a reason for hiding this comment

Uh oh!

mattsb42-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattsb42-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattsb42-aws Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

WesleyRosenblum Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

WesleyRosenblum Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

WesleyRosenblum Mar 23, 2020

Choose a reason for hiding this comment

Uh oh!

mattsb42-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mattsb42-aws Mar 24, 2020

Choose a reason for hiding this comment

Uh oh!

WesleyRosenblum Mar 24, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mattsb42-aws commented Mar 24, 2020

Uh oh!

mattsb42-aws left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

WesleyRosenblum commented Mar 20, 2020 •

edited

Loading