You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-30Lines changed: 15 additions & 30 deletions
Original file line number
Diff line number
Diff line change
@@ -9,26 +9,26 @@ For more details about the design and architecture of the SDK, see the [official
9
9
### Required Prerequisites
10
10
To use this SDK you must have:
11
11
12
-
***A Java 8 development environment**
12
+
***A Java 8 or newer development environment**
13
13
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/).
15
15
16
16
**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).
17
17
18
-
***Bouncy Castle**
18
+
***Bouncy Castle** or **Bouncy Castle FIPS**
19
19
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`).
21
23
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.
29
28
30
29
### Optional Prerequisites
31
30
31
+
#### AWS Integration
32
32
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.
33
33
34
34
***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
37
37
38
38
***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.
39
39
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
+
40
44
### Download
41
45
42
46
You can get the latest release from Maven:
@@ -49,25 +53,6 @@ You can get the latest release from Maven:
49
53
</dependency>
50
54
```
51
55
52
-
Don't forget to enable the download of snapshot jars from Maven:
0 commit comments