Java RFC 5297 SIV Authenticated Encryption

Features

• No dependencies (required BouncyCastle classes are repackaged)
• Passes official RFC 5297 test vectors
• Constant time authentication
• Defaults on AES, but supports any block cipher with a 128-bit block size.
• Supports any key sizes that the block cipher supports (e.g. 128/192/256-bit keys for AES)
• Thread-safe
• Fast
• Requires JDK 8+ or Android API Level 24+ (since version 1.4.0)

Audits

• Version 1.0.8 audit by Tim McLean (Issues fixed with 1.1.0)
• Version 1.2.1 audit by Cure53

Usage

private static final SivMode AES_SIV = new SivMode();

public void encrypt() {
  byte[] encrypted = AES_SIV.encrypt(ctrKey, macKey, "hello world".getBytes());
  byte[] decrypted = AES_SIV.decrypt(ctrKey, macKey, encrypted);
}

public void encryptWithAssociatedData() {
  byte[] encrypted = AES_SIV.encrypt(ctrKey, macKey, "hello world".getBytes(), "associated".getBytes(), "data".getBytes());
  byte[] decrypted = AES_SIV.decrypt(ctrKey, macKey, encrypted, "associated".getBytes(), "data".getBytes());
}

Maven integration

<dependencies>
  <dependency>
    <groupId>org.cryptomator</groupId>
    <artifactId>siv-mode</artifactId>
    <version>1.4.0</version>
  </dependency>
</dependencies>

Java Module

From version 1.3.2 onwards this library is an explicit module with the name org.cryptomator.siv. You can use it by adding the following line to your module-info.java.

requires org.cryptomator.siv;

Because BouncyCastle classes are shaded, this library only depends on java.base.

Reproducible Builds

This is a Maven project that can be built using mvn install. However, if you want to build this reproducibly, please make sure:

1. Use the same build environment
   • The same JDK as our CI builds
   • Ideally the same same arch and OS (x86_64 Linux)
   • Same locale (en_US) and linebreaks (POSIX)
2. Use ./mvnw install instead (or ./mvnw verify or ./mvnw package -DskipTests, depending on your intentions)

License

Distributed under the MIT X Consortium license. See the LICENSE file for more info.

¹ The Cure53 pentesting was performed during the development of the apps for 1&1 Mail & Media GmbH.