changes

Author: Lucas McDonald

Examples/runtimes/java/DynamoDbEncryption/README.md

@@ -2,6 +2,8 @@
 
 This project contains examples for using the AWS Database Encryption SDK for DynamoDb in Java. 
 
+Overview:
+
 ```
 ├── ..
 ├── src
@@ -16,3 +18,26 @@ This project contains examples for using the AWS Database Encryption SDK for Dyn
 │   │   └── searchableencryption: Examples demonstrating searchable encryption configuration and usage
 └── └── test: Our tests that run these examples
 ```
+
+## Getting Started
+
+### Development Requirements
+
+* A Java 8 or newer development environment
+
+### Building and Running
+
+Each example includes a runnable `main` method
+and a description of the required command line arguments.
+To run a given example, inspect its particular setup requirements,
+create and/or grant access to any required AWS resources,
+and run the example as specified in the file.
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+

Examples/runtimes/java/Migration/README.md

@@ -2,3 +2,26 @@
 
 This project contains an example project demonstrating how to safely upgrade
 from the DynamoDb Encryption Client (v2.0.1) to the AWS Database Encryption SDK for DynamoDb (v3.0.0).
+
+## Getting Started
+
+### Development Requirements
+
+* A Java 8 or newer development environment
+
+### Building and Running
+
+Each example includes a runnable `main` method
+and a description of the required command line arguments.
+To run a given example, inspect its particular setup requirements,
+create and/or grant access to any required AWS resources,
+and run the example as specified in the file.
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+

README.md

@@ -33,7 +33,7 @@ public class SimpleClass {
 
   private String partitionKey;
   private int sortKey;
-  // The next three fields represent attributes that we will perform cryptographic operations on.
+  // The next three fields represent DynamoDB item attributes that we will perform cryptographic operations on.
 
   // attribute1: Encrypt the data and sign it for authenticity
   private String attribute1;
@@ -52,17 +52,17 @@ public class SimpleClass {
   public int getSortKey() { return this.sortKey; }
   public void setSortKey(int sortKey) { this.sortKey = sortKey; }
 
-  @DynamoDbAttribute(value = "encrypt_and_sign")
+  @DynamoDbAttribute(value = "attribute1")
   public String getAttribute1() { return this.attribute1; }
   public void setAttribute1(String attribute1) { this.attribute1 = attribute1; }
 
   @DynamoDbEncryptionSignOnly
-  @DynamoDbAttribute(value = "sign_only")
+  @DynamoDbAttribute(value = "attribute2")
   public String getAttribute2() { return this.attribute2; }
   public void setAttribute2(String attribute2) { this.attribute2 = attribute2; }
 
   @DynamoDbEncryptionDoNothing
-  @DynamoDbAttribute(value = "do_nothing")
+  @DynamoDbAttribute(value = "attribute3")
   public String getAttribute3() { return this.attribute3; }
   public void setAttribute3(String attribute3) { this.attribute3 = attribute3; }
 }

TestVectors/README.md

@@ -1,3 +1,29 @@
 # AWS Database Encryption SDK for DynamoDb Java Test Vectors
 
-This project contains code encrypts and decrypts a suite of DynamoDB items to validate the Database Encryption SDK's cross-version compatibility.
+This project contains code encrypts and decrypts a suite of DynamoDB items.
+This validates the Database Encryption SDK's cross-version compatibility.
+
+## Getting Started
+
+### Development Requirements
+
+* Dafny 4.1.0: https://github.com/dafny-lang/dafny
+  
+  The code that executes the test vectors is written in Dafny. 
+  You must install the Dafny runtime to compile the Dafny tests into Java.
+* A Java 8 or newer development environment
+
+### Building and Running
+
+1. Start in the root `./TestVectors` directory
+2. Run `make build_java`
+3. Run `make test_java`
+
+## Security
+
+See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
+
+## License
+
+This project is licensed under the Apache-2.0 License.
+