Skip to content

Commit 74c85cb

Browse files
Update docs in prep for 1.6.1 (#133)
* Update docs in prep for 1.6.1 * Actually bump version for release
1 parent 04423a3 commit 74c85cb

File tree

3 files changed

+44
-37
lines changed

3 files changed

+44
-37
lines changed

CHANGELOG.md

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

3-
## 1.6.1 -- Unreleased
3+
## 1.6.1 -- 2019-10-29
4+
5+
### Deprecation Warnings
6+
* Deprecated `AwsCrypto.encryptString()` and `AwsCrypto.decryptString()`.
7+
Replace your calls to these methods with calls to AwsCrypto.encryptData() and AwsCrypto.decryptData().
8+
Unlike the deprecated methods, these methods don't perform any Base64 encoding or decoding, so they are fully compatible with other language implementations of the AWS Encryption SDK.
9+
10+
If you need Base64 encoding or decoding for your application, you can add it outside of the AWS Encryption SDK.
11+
[PR #120](https://github.com/aws/aws-encryption-sdk-java/pull/120)
12+
13+
### Patches
14+
* Correctly validate version [PR #116](https://github.com/aws/aws-encryption-sdk-java/pull/116)
15+
* `ParsedCiphertext` now handles truncated input properly [PR #119](https://github.com/aws/aws-encryption-sdk-java/pull/119)
16+
417
### 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
18+
* Add support for standard test vectors via `testVectorZip` system property. [PR #127](https://github.com/aws/aws-encryption-sdk-java/pull/127)
19+
* Remove all explicit cryptographic dependencies on BouncyCastle. The AWS Encryption SDK for Java still uses Bouncy Castle for other tasks. PRs
20+
[#128](https://github.com/aws/aws-encryption-sdk-java/pull/128),
21+
[#129](https://github.com/aws/aws-encryption-sdk-java/pull/129),
22+
[#130](https://github.com/aws/aws-encryption-sdk-java/pull/130),
23+
[#131](https://github.com/aws/aws-encryption-sdk-java/pull/131),
24+
and [#132](https://github.com/aws/aws-encryption-sdk-java/pull/132).
825

926
## 1.6.0 -- 2019-05-31
1027

@@ -17,7 +34,7 @@
1734
## 1.5.0 -- 2019-05-30
1835

1936
### Minor Changes
20-
* Add dependency on Apache Commons Codec 1.12.
37+
* Added dependency on Apache Commons Codec 1.12.
2138
* Use org.apache.commons.codec.binary.Base64 instead of java.util.Base64 so
2239
that the SDK can be used on systems that do not have java.util.Base64 but
2340
support Java 8 language features.

README.md

Lines changed: 21 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,31 @@ 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+
The AWS Encryption SDK for Java uses Bouncy Castle to serialize and deserialize cryptographic objects.
21+
It does not explicitly use Bouncy Castle (or any other [JCA Provider](https://docs.oracle.com/javase/8/docs/api/java/security/Provider.html)) for the underlying cryptography.
22+
Instead, it uses the platform default, which you can configure or override as documented in the
23+
[Java Cryptography Architecture (JCA) Reference Guide](https://docs.oracle.com/javase/9/security/java-cryptography-architecture-jca-reference-guide.htm#JSSEC-GUID-2BCFDD85-D533-4E6C-8CE9-29990DEB0190).
2124

22-
```xml
23-
<dependency>
24-
<groupId>org.bouncycastle</groupId>
25-
<artifactId>bcprov-ext-jdk15on</artifactId>
26-
<version>1.61</version>
27-
</dependency>
28-
```
25+
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.
26+
Or, you can pick it up from Maven (groupId: `org.bouncycastle`, artifactId: `bcprov-ext-jdk15on`).
27+
28+
Beginning in version 1.6.1,
29+
the AWS Encryption SDK also works with Bouncy Castle FIPS (groupId: `org.bouncycastle`, artifactId: `bc-fips`)
30+
as an alternative to non-FIPS Bouncy Castle.
31+
For help installing and configuring Bouncy Castle FIPS properly, see [BC FIPS documentation](https://www.bouncycastle.org/documentation.html),
32+
in particular, **User Guides** and **Security Policy**.
2933

3034
### Optional Prerequisites
3135

36+
#### AWS Integration
3237
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.
3338

3439
* **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 +42,10 @@ You don't need an Amazon Web Services (AWS) account to use this SDK, but some of
3742

3843
* **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.
3944

45+
#### Amazon Corretto Crypto Provider
46+
Many users find that the Amazon Corretto Crypto Provider (ACCP) significantly improves the performance of the AWS Encryption SDK.
47+
For help installing and using ACCP, see the [ACCP GitHub Respository](https://github.com/corretto/amazon-corretto-crypto-provider) .
48+
4049
### Download
4150

4251
You can get the latest release from Maven:
@@ -45,29 +54,10 @@ You can get the latest release from Maven:
4554
<dependency>
4655
<groupId>com.amazonaws</groupId>
4756
<artifactId>aws-encryption-sdk-java</artifactId>
48-
<version>1.6.0</version>
57+
<version>1.6.1</version>
4958
</dependency>
5059
```
5160

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-
7161
### Get Started
7262

7363
The following code sample demonstrates how to get started:

pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<groupId>com.amazonaws</groupId>
66
<artifactId>aws-encryption-sdk-java</artifactId>
7-
<version>1.6.0</version>
7+
<version>1.6.1</version>
88
<packaging>jar</packaging>
99

1010
<name>aws-encryption-sdk-java</name>

0 commit comments

Comments
 (0)