JAVA-HOWTO.md (tink-1.6.0) | : | JAVA-HOWTO.md (tink-1.6.1) | ||
---|---|---|---|---|
skipping to change at line 12 | skipping to change at line 12 | |||
This document contains instructions and Java code snippets for common tasks in | This document contains instructions and Java code snippets for common tasks in | |||
[Tink](https://github.com/google/tink). | [Tink](https://github.com/google/tink). | |||
If you want to contribute code to the Java implementation, please read the [Java | If you want to contribute code to the Java implementation, please read the [Java | |||
hacking guide](JAVA-HACKING.md). | hacking guide](JAVA-HACKING.md). | |||
## Setup instructions | ## Setup instructions | |||
The most recent release is | The most recent release is | |||
[1.6.0](https://github.com/google/tink/releases/tag/v1.6.0), released | [1.6.1](https://github.com/google/tink/releases/tag/v1.6.1), released | |||
2021-05-17. | 2021-07-12. | |||
In addition to the versioned releases, snapshots of Tink are regularly built | In addition to the versioned releases, snapshots of Tink are regularly built | |||
using the master branch of the Tink GitHub repository. | using the master branch of the Tink GitHub repository. | |||
Tink for Java has two primary build targets specified: | Tink for Java has two primary build targets specified: | |||
- "tink": the default, for general purpose use | - "tink": the default, for general purpose use | |||
- "android": which is optimized for use in Android projects | - "android": which is optimized for use in Android projects | |||
### Maven | ### Maven | |||
skipping to change at line 38 | skipping to change at line 38 | |||
The Maven group ID is `com.google.crypto.tink`, and the artifact ID is `tink`. | The Maven group ID is `com.google.crypto.tink`, and the artifact ID is `tink`. | |||
You can specify the current release of Tink as a project dependency using the | You can specify the current release of Tink as a project dependency using the | |||
following configuration: | following configuration: | |||
```xml | ```xml | |||
<dependencies> | <dependencies> | |||
<dependency> | <dependency> | |||
<groupId>com.google.crypto.tink</groupId> | <groupId>com.google.crypto.tink</groupId> | |||
<artifactId>tink</artifactId> | <artifactId>tink</artifactId> | |||
<version>1.6.0</version> | <version>1.6.1</version> | |||
</dependency> | </dependency> | |||
</dependencies> | </dependencies> | |||
``` | ``` | |||
You can specify the latest snapshot as a project dependency by using the version | You can specify the latest snapshot as a project dependency by using the version | |||
`HEAD-SNAPSHOT`: | `HEAD-SNAPSHOT`: | |||
```xml | ```xml | |||
<repositories> | <repositories> | |||
<repository> | <repository> | |||
skipping to change at line 84 | skipping to change at line 84 | |||
Since 1.3.0 the support for AWS/GCP KMS has been moved to a separate package. To | Since 1.3.0 the support for AWS/GCP KMS has been moved to a separate package. To | |||
use AWS KMS, one should also add dependency on `tink-awskms`, and similarly | use AWS KMS, one should also add dependency on `tink-awskms`, and similarly | |||
`tink-gcpkms` for GCP KMS. | `tink-gcpkms` for GCP KMS. | |||
```xml | ```xml | |||
<dependencies> | <dependencies> | |||
<dependency> | <dependency> | |||
<groupId>com.google.crypto.tink</groupId> | <groupId>com.google.crypto.tink</groupId> | |||
<artifactId>tink-awskms</artifactId> | <artifactId>tink-awskms</artifactId> | |||
<version>1.5.0</version> | <version>1.6.1</version> | |||
</dependency> | </dependency> | |||
</dependencies> | </dependencies> | |||
``` | ``` | |||
```xml | ```xml | |||
<dependencies> | <dependencies> | |||
<dependency> | <dependency> | |||
<groupId>com.google.crypto.tink</groupId> | <groupId>com.google.crypto.tink</groupId> | |||
<artifactId>tink-gcpkms</artifactId> | <artifactId>tink-gcpkms</artifactId> | |||
<version>1.5.0</version> | <version>1.6.1</version> | |||
</dependency> | </dependency> | |||
</dependencies> | </dependencies> | |||
``` | ``` | |||
### Gradle | ### Gradle | |||
You can include Tink in Android projects using [Gradle](https://gradle.org). | You can include Tink in Android projects using [Gradle](https://gradle.org). | |||
You can specify the current release of Tink as a project dependency using the | You can specify the current release of Tink as a project dependency using the | |||
following configuration: | following configuration: | |||
``` | ``` | |||
dependencies { | dependencies { | |||
implementation 'com.google.crypto.tink:tink-android:1.5.0' | implementation 'com.google.crypto.tink:tink-android:1.6.1' | |||
} | } | |||
``` | ``` | |||
You can specify the latest snapshot as a project dependency using the following | You can specify the latest snapshot as a project dependency using the following | |||
configuration: | configuration: | |||
``` | ``` | |||
repositories { | repositories { | |||
maven { url "https://oss.sonatype.org/content/repositories/snapshots" } | maven { url "https://oss.sonatype.org/content/repositories/snapshots" } | |||
} | } | |||
dependencies { | dependencies { | |||
implementation 'com.google.crypto.tink:tink-android:HEAD-SNAPSHOT' | implementation 'com.google.crypto.tink:tink-android:HEAD-SNAPSHOT' | |||
} | } | |||
``` | ``` | |||
## API documentation | ## API documentation | |||
* Java: | * Java: | |||
* [1.5.0](https://google.github.io/tink/javadoc/tink/1.5.0) | * [1.6.1](https://google.github.io/tink/javadoc/tink/1.6.1) | |||
* [HEAD-SNAPSHOT](https://google.github.io/tink/javadoc/tink/HEAD-SNAPSHOT ) | * [HEAD-SNAPSHOT](https://google.github.io/tink/javadoc/tink/HEAD-SNAPSHOT ) | |||
* Android: | * Android: | |||
* [1.5.0](https://google.github.io/tink/javadoc/tink-android/1.5.0) | * [1.6.1](https://google.github.io/tink/javadoc/tink-android/1.6.1) | |||
* [HEAD-SNAPSHOT](https://google.github.io/tink/javadoc/tink-android/HEAD- SNAPSHOT) | * [HEAD-SNAPSHOT](https://google.github.io/tink/javadoc/tink-android/HEAD- SNAPSHOT) | |||
## Important warnings | ## Important warnings | |||
**Do not use APIs which have fields or methods marked with the `@Alpha` | **Do not use APIs which have fields or methods marked with the `@Alpha` | |||
annotation.** They can be modified in any way, or even removed, at any time. | annotation.** They can be modified in any way, or even removed, at any time. | |||
They are in the package, but not for official, production release, but only for | They are in the package, but not for official, production release, but only for | |||
testing. | testing. | |||
**Do not use APIs in `com.google.crypto.tink.subtle`.** While they're generally | **Do not use APIs in `com.google.crypto.tink.subtle`.** While they're generally | |||
End of changes. 7 change blocks. | ||||
8 lines changed or deleted | 8 lines changed or added |