Merge branch 'release/1.4.0'

Author: overheadhunter

README.md

@@ -1,4 +1,4 @@
-# RFC 5297 SIV mode of operation in Java
+# Java RFC 5297 SIV Authenticated Encryption
 
 [![Build Status](https://travis-ci.org/cryptomator/siv-mode.svg?branch=develop)](https://travis-ci.org/cryptomator/siv-mode)
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/8b274788dab046259a40e56688236790)](https://www.codacy.com/app/cryptomator/siv-mode)
@@ -14,7 +14,7 @@
 - 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
-- Compatible with Android API Level 16 (since version 1.2.0)
+- Compatible with Android API Level 24 (since version 1.4.0)
 
 ## Audits
 - [Version 1.0.8 audit by Tim McLean](https://www.chosenplaintext.ca/publications/20161104-siv-mode-report.pdf) (Issues fixed with 1.1.0)
@@ -47,14 +47,14 @@ public void encryptWithAssociatedData() {
   <dependency>
     <groupId>org.cryptomator</groupId>
     <artifactId>siv-mode</artifactId>
-    <version>1.3.0</version>
+    <version>1.3.2</version>
   </dependency>
 </dependencies>
 ```
 
 ## JPMS
 
-From version 1.3.0 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`.
+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`.
 
 ```java
 requires org.cryptomator.siv;
@@ -66,7 +66,7 @@ Because BouncyCastle classes are shaded, this library only depends on `java.base
 
 This is a Maven project. To build it, run `mvn clean install`.
 
-Requires JDK 9+ at build time due to JPMS support.
+Requires JDK 11.0.3 or newer at build time due to JPMS support.
 
 ## License
 Distributed under the MIT X Consortium license. See the LICENSE file for more info.

pom.xml

@@ -3,7 +3,7 @@
 	<modelVersion>4.0.0</modelVersion>
 	<groupId>org.cryptomator</groupId>
 	<artifactId>siv-mode</artifactId>
-	<version>1.3.2</version>
+	<version>1.4.0</version>
 
 	<name>SIV Mode</name>
 	<description>RFC 5297 SIV mode: deterministic authenticated encryption</description>
@@ -112,8 +112,7 @@
 				<artifactId>maven-compiler-plugin</artifactId>
 				<version>3.8.1</version>
 				<configuration>
-					<release>7</release>
-					<testRelease>8</testRelease>
+					<release>8</release>
 					<encoding>UTF-8</encoding>
 					<showWarnings>true</showWarnings>
 				</configuration>
@@ -164,7 +163,8 @@
 							<minimizeJar>true</minimizeJar>
 							<keepDependenciesWithProvidedScope>false</keepDependenciesWithProvidedScope>
 							<createDependencyReducedPom>false</createDependencyReducedPom>
-							<createSourcesJar>false</createSourcesJar>
+							<createSourcesJar>true</createSourcesJar>
+							<shadeSourcesContent>true</shadeSourcesContent>
 							<artifactSet>
 								<includes>
 									<include>org.bouncycastle:bcprov-jdk15on</include>
@@ -178,13 +178,9 @@
 							</relocations>
 							<filters>
 								<filter>
-									<artifact>*:*</artifact>
+									<artifact>org.bouncycastle:bcprov-jdk15on</artifact>
 									<excludes>
-										<exclude>META-INF/MANIFEST.MF</exclude>
-										<exclude>META-INF/*.SF</exclude>
-										<exclude>META-INF/*.DSA</exclude>
-										<exclude>META-INF/*.RSA</exclude>
-										<exclude>META-INF/services/**</exclude>
+										<exclude>META-INF/**</exclude>
 									</excludes>
 								</filter>
 							</filters>
@@ -196,31 +192,6 @@
 	</build>
 
 	<profiles>
-		<profile>
-			<id>intellij</id>
-			<!-- workaround for intellij bug: https://youtrack.jetbrains.com/issue/IDEA-85478 -->
-			<activation>
-				<activeByDefault>false</activeByDefault>
-				<property>
-					<name>idea.maven.embedder.version</name>
-				</property>
-			</activation>
-			<build>
-				<plugins>
-					<plugin>
-						<groupId>org.apache.maven.plugins</groupId>
-						<artifactId>maven-compiler-plugin</artifactId>
-						<version>3.8.1</version>
-						<configuration>
-							<release>8</release>
-							<source>1.8</source>
-							<target>1.8</target>
-						</configuration>
-					</plugin>
-				</plugins>
-			</build>
-		</profile>
-
 		<profile>
 			<id>dependency-check</id>
 			<build>
@@ -282,6 +253,7 @@
 						<executions>
 							<execution>
 								<id>attach-sources</id>
+								<phase>prepare-package</phase>
 								<goals>
 									<goal>jar-no-fork</goal>
 								</goals>

src/main/java/org/cryptomator/siv/CustomCtrComputer.java

@@ -0,0 +1,36 @@
+package org.cryptomator.siv;
+
+import org.bouncycastle.crypto.BlockCipher;
+import org.bouncycastle.crypto.CipherParameters;
+import org.bouncycastle.crypto.OutputLengthException;
+import org.bouncycastle.crypto.modes.SICBlockCipher;
+import org.bouncycastle.crypto.params.KeyParameter;
+import org.bouncycastle.crypto.params.ParametersWithIV;
+
+import java.util.function.Supplier;
+
+/**
+ * Performs CTR Mode computations facilitating BouncyCastle's {@link SICBlockCipher}.
+ */
+class CustomCtrComputer implements SivMode.CtrComputer {
+
+	private final Supplier<BlockCipher> blockCipherSupplier;
+
+	public CustomCtrComputer(Supplier<BlockCipher> blockCipherSupplier) {
+		this.blockCipherSupplier = blockCipherSupplier;
+	}
+	
+	@Override
+	public byte[] computeCtr(byte[] input, byte[] key, byte[] iv) {
+		SICBlockCipher cipher = new SICBlockCipher(blockCipherSupplier.get());
+		CipherParameters params = new ParametersWithIV(new KeyParameter(key), iv);
+		cipher.init(true, params);
+		try {
+			byte[] output = new byte[input.length];
+			cipher.processBytes(input, 0, input.length, output, 0);
+			return output;
+		} catch (OutputLengthException e) {
+			throw new IllegalStateException("In CTR mode output length must be equal to input length", e);
+		}
+	}
+}

src/main/java/org/cryptomator/siv/JceAesCtrComputer.java

@@ -0,0 +1,52 @@
+package org.cryptomator.siv;
+
+import javax.crypto.BadPaddingException;
+import javax.crypto.Cipher;
+import javax.crypto.IllegalBlockSizeException;
+import javax.crypto.NoSuchPaddingException;
+import javax.crypto.spec.IvParameterSpec;
+import javax.crypto.spec.SecretKeySpec;
+import java.security.InvalidAlgorithmParameterException;
+import java.security.InvalidKeyException;
+import java.security.NoSuchAlgorithmException;
+import java.security.Provider;
+
+/**
+ * Performs CTR Mode computations facilitating a cipher returned by JCE's <code>Cipher.getInstance("AES/CTR/NoPadding")</code>.
+ */
+final class JceAesCtrComputer implements SivMode.CtrComputer {
+
+	private final ThreadLocal<Cipher> threadLocalCipher;
+	
+	public JceAesCtrComputer(final Provider jceSecurityProvider) {
+		this.threadLocalCipher = new ThreadLocal<Cipher>(){
+			@Override
+			protected Cipher initialValue() {
+				try {
+					if (jceSecurityProvider == null) {
+						return Cipher.getInstance("AES/CTR/NoPadding");
+					} else {
+						return Cipher.getInstance("AES/CTR/NoPadding", jceSecurityProvider);
+					}
+				} catch (NoSuchAlgorithmException | NoSuchPaddingException e) {
+					throw new IllegalStateException("AES/CTR/NoPadding not available on this platform.", e);
+				}
+			}
+		};
+	}
+
+	@Override
+	public byte[] computeCtr(byte[] input, byte[] key, final byte[] iv) {
+		try {
+			Cipher cipher = threadLocalCipher.get();
+			cipher.init(Cipher.ENCRYPT_MODE, new SecretKeySpec(key, "AES"), new IvParameterSpec(iv));
+			return cipher.doFinal(input);
+		} catch (InvalidKeyException | InvalidAlgorithmParameterException e) {
+			throw new IllegalArgumentException("Key or IV invalid.");
+		} catch (BadPaddingException e) {
+			throw new IllegalStateException("Cipher doesn't require padding.", e);
+		} catch (IllegalBlockSizeException e) {
+			throw new IllegalStateException("Block size irrelevant for stream ciphers.", e);
+		}
+	}
+}