Skip to content

Commit eb3083e

Browse files
Update docs in prep for 1.6.1
1 parent 3ef8958 commit eb3083e

File tree

2 files changed

+32
-33
lines changed

2 files changed

+32
-33
lines changed

CHANGELOG.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,24 @@
11
# Changelog
22

33
## 1.6.1 -- Unreleased
4+
5+
### Deprecation Warnings
6+
* `AwsCrypto.encryptString()` and `AwsCrypto.decryptString()` are now deprecated.
7+
Please move to `AwsCrypto.encryptData()` and `AwsCrypto.decryptData()` with manual Base64 encoding/decoding.
8+
[PR #120](https://github.com/aws/aws-encryption-sdk-java/pull/120)
9+
10+
### Patches
11+
* Correctly validate version [PR #116](https://github.com/aws/aws-encryption-sdk-java/pull/116)
12+
* `ParsedCiphertext` now properly handles truncated input [PR #119](https://github.com/aws/aws-encryption-sdk-java/pull/119)
13+
414
### Maintenance
5-
* Add support for standard test vectors via `testVectorZip` system property.
6-
* No longer require use of BouncyCastle with RSA `JceMasterKey`s
7-
* No longer use BouncyCastle for Elliptic Curve key generation and point compression/decompression
15+
* Add support for standard test vectors via `testVectorZip` system property. [PR #127](https://github.com/aws/aws-encryption-sdk-java/pull/127)
16+
* Remove all explicit cryptographic dependencies on BouncyCastle. PRs
17+
[#128](https://github.com/aws/aws-encryption-sdk-java/pull/128),
18+
[#129](https://github.com/aws/aws-encryption-sdk-java/pull/129),
19+
[#130](https://github.com/aws/aws-encryption-sdk-java/pull/130),
20+
[#131](https://github.com/aws/aws-encryption-sdk-java/pull/131),
21+
and [#132](https://github.com/aws/aws-encryption-sdk-java/pull/132).
822

923
## 1.6.0 -- 2019-05-31
1024

README.md

Lines changed: 15 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,26 @@ For more details about the design and architecture of the SDK, see the [official
99
### Required Prerequisites
1010
To use this SDK you must have:
1111

12-
* **A Java 8 development environment**
12+
* **A Java 8 or newer development environment**
1313

14-
If you do not have one, go to [Java SE Downloads](https://www.oracle.com/technetwork/java/javase/downloads/index.html) on the Oracle website, then download and install the Java SE Development Kit (JDK). Java 8 or higher is required.
14+
If you do not have one, we recommend [Amazon Corretto](https://aws.amazon.com/corretto/).
1515

1616
**Note:** If you use the Oracle JDK, you must also download and install the [Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files](http://www.oracle.com/technetwork/java/javase/downloads/jce8-download-2133166.html).
1717

18-
* **Bouncy Castle**
18+
* **Bouncy Castle** or **Bouncy Castle FIPS**
1919

20-
Bouncy Castle provides a cryptography API for Java. If you do not have Bouncy Castle, go to https://bouncycastle.org/latest_releases.html, then download the provider file that corresponds to your JDK. Or, you can pick it up from Maven:
20+
Bouncy Castle provides some utilities the AWS Encryption SDK needs to handle cryptographic objects.
21+
If you do not have Bouncy Castle, go to https://bouncycastle.org/latest_releases.html, then download the provider file that corresponds to your JDK.
22+
Or, you can pick it up from Maven (groupId: `org.bouncycastle`, artifactId: `bcprov-ext-jdk15on`).
2123

22-
```xml
23-
<dependency>
24-
<groupId>org.bouncycastle</groupId>
25-
<artifactId>bcprov-ext-jdk15on</artifactId>
26-
<version>1.61</version>
27-
</dependency>
28-
```
24+
As of version 1.6.1,
25+
the AWS Encryption SDK will also work with Bouncy Castle FIPS (groupId: `org.bouncycastle`, artifactId: `bcprov-ext-jdk15on`).
26+
Please follow Bouncy Castle's FIPS [documentation](https://www.bouncycastle.org/documentation.html),
27+
including User Guides and Security Policy for proper installation and configuration.
2928

3029
### Optional Prerequisites
3130

31+
#### AWS Integration
3232
You don't need an Amazon Web Services (AWS) account to use this SDK, but some of the [example code][examples] requires an AWS account, a customer master key (CMK) in AWS KMS, and the AWS SDK for Java.
3333

3434
* **To create an AWS account**, go to [Sign In or Create an AWS Account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) and then choose **I am a new user.** Follow the instructions to create an AWS account.
@@ -37,6 +37,10 @@ You don't need an Amazon Web Services (AWS) account to use this SDK, but some of
3737

3838
* **To download and install the AWS SDK for Java**, go to [Installing the AWS SDK for Java](https://docs.aws.amazon.com/AWSSdkDocsJava/latest/DeveloperGuide/java-dg-install-sdk.html) in the AWS SDK for Java documentation and then follow the instructions on that page.
3939

40+
#### Amazon Corretto Crypto Provider
41+
Many users find that the Amazon Corretto Crypto Provider (ACCP) significantly improves the performance of the AWS Encryption SDK.
42+
Please see the [ACCP GitHub Respository](https://github.com/corretto/amazon-corretto-crypto-provider) for installation and use guidance.
43+
4044
### Download
4145

4246
You can get the latest release from Maven:
@@ -49,25 +53,6 @@ You can get the latest release from Maven:
4953
</dependency>
5054
```
5155

52-
Don't forget to enable the download of snapshot jars from Maven:
53-
54-
```xml
55-
<profiles>
56-
<profile>
57-
<id>allow-snapshots</id>
58-
<activation><activeByDefault>true</activeByDefault></activation>
59-
<repositories>
60-
<repository>
61-
<id>snapshots-repo</id>
62-
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
63-
<releases><enabled>false</enabled></releases>
64-
<snapshots><enabled>true</enabled></snapshots>
65-
</repository>
66-
</repositories>
67-
</profile>
68-
</profiles>
69-
```
70-
7156
### Get Started
7257

7358
The following code sample demonstrates how to get started:

0 commit comments

Comments
 (0)