com.google.crypto.tink.aead.internal.ChaCha20Poly1305Jce Maven / Gradle / Ivy
Show all versions of tink-android Show documentation
// Copyright 2024 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
////////////////////////////////////////////////////////////////////////////////
package com.google.crypto.tink.aead.internal;
import static com.google.crypto.tink.internal.Util.isPrefix;
import com.google.crypto.tink.AccessesPartialKey;
import com.google.crypto.tink.Aead;
import com.google.crypto.tink.InsecureSecretKeyAccess;
import com.google.crypto.tink.aead.ChaCha20Poly1305Key;
import com.google.crypto.tink.config.internal.TinkFipsUtil;
import com.google.crypto.tink.subtle.EngineFactory;
import com.google.crypto.tink.subtle.Hex;
import com.google.crypto.tink.subtle.Random;
import com.google.errorprone.annotations.Immutable;
import java.security.GeneralSecurityException;
import java.security.InvalidKeyException;
import java.security.spec.AlgorithmParameterSpec;
import java.util.Arrays;
import javax.annotation.Nullable;
import javax.crypto.Cipher;
import javax.crypto.SecretKey;
import javax.crypto.spec.IvParameterSpec;
import javax.crypto.spec.SecretKeySpec;
/**
* ChaCha20Poly1305Jce implements an AEAD for ChaCha20Poly1305, as described in RFC 8439, section 2.8.
*
* It uses the JCE, and requires that algorithm "ChaCha20-Poly1305" is present.
*/
@Immutable
public final class ChaCha20Poly1305Jce implements Aead {
private static final TinkFipsUtil.AlgorithmFipsCompatibility FIPS =
TinkFipsUtil.AlgorithmFipsCompatibility.ALGORITHM_NOT_FIPS;
private static final int NONCE_SIZE_IN_BYTES = 12;
private static final int TAG_SIZE_IN_BYTES = 16;
private static final int KEY_SIZE_IN_BYTES = 32;
private static final String CIPHER_NAME = "ChaCha20-Poly1305";
private static final String KEY_NAME = "ChaCha20";
private static final byte[] TEST_KEY =
Hex.decode("808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9f");
private static final byte[] TEST_NONCE = Hex.decode("070000004041424344454647");
private static final byte[] TEST_CIPHERTEXT_OF_EMPTY =
Hex.decode("a0784d7a4716f3feb4f64e7f4b39bf04");
private static boolean isValid(Cipher cipher) {
try {
AlgorithmParameterSpec params = new IvParameterSpec(TEST_NONCE);
cipher.init(Cipher.DECRYPT_MODE, new SecretKeySpec(TEST_KEY, KEY_NAME), params);
byte[] output = cipher.doFinal(TEST_CIPHERTEXT_OF_EMPTY);
if (output.length != 0) {
return false;
}
// Decrypt a 2nd time. This fails on OpenJDK11 because of a bug.
cipher.init(Cipher.DECRYPT_MODE, new SecretKeySpec(TEST_KEY, KEY_NAME), params);
byte[] output2 = cipher.doFinal(TEST_CIPHERTEXT_OF_EMPTY);
if (output2.length != 0) {
return false;
}
return true;
} catch (GeneralSecurityException ex) {
return false;
}
}
// A thread-local instance of the ChaCha20Poly1305, or null if ChaCha20Poly1305 is not supported.
private static final ThreadLocal localCipher =
new ThreadLocal() {
@Nullable
@Override
protected Cipher initialValue() {
try {
Cipher cipher = EngineFactory.CIPHER.getInstance(CIPHER_NAME);
if (!isValid(cipher)) {
return null;
}
return cipher;
} catch (GeneralSecurityException ex) {
// ChaCha20Poly1305 is not supported.
return null;
}
}
};
@SuppressWarnings("Immutable")
private final SecretKey keySpec;
@SuppressWarnings("Immutable")
private final byte[] outputPrefix;
private ChaCha20Poly1305Jce(final byte[] key, final byte[] outputPrefix)
throws GeneralSecurityException {
if (!FIPS.isCompatible()) {
throw new GeneralSecurityException("Can not use ChaCha20Poly1305 in FIPS-mode.");
}
if (!isSupported()) {
throw new GeneralSecurityException("JCE does not support algorithm: " + CIPHER_NAME);
}
if (key.length != KEY_SIZE_IN_BYTES) {
throw new InvalidKeyException("The key length in bytes must be 32.");
}
this.keySpec = new SecretKeySpec(key, KEY_NAME);
this.outputPrefix = outputPrefix;
}
@AccessesPartialKey
public static Aead create(ChaCha20Poly1305Key key) throws GeneralSecurityException {
return new ChaCha20Poly1305Jce(
key.getKeyBytes().toByteArray(InsecureSecretKeyAccess.get()),
key.getOutputPrefix().toByteArray());
}
/**
* Returns a thread-local instance of the ChaCha20Poly1305, or null if ChaCha20Poly1305 is
* not supported.
*/
@Nullable
static Cipher getThreadLocalCipherOrNull() {
return localCipher.get();
}
public static boolean isSupported() {
return localCipher.get() != null;
}
@Override
public byte[] encrypt(final byte[] plaintext, final byte[] associatedData)
throws GeneralSecurityException {
if (plaintext == null) {
throw new NullPointerException("plaintext is null");
}
byte[] nonce = Random.randBytes(NONCE_SIZE_IN_BYTES);
AlgorithmParameterSpec params = new IvParameterSpec(nonce);
Cipher cipher = localCipher.get();
cipher.init(Cipher.ENCRYPT_MODE, keySpec, params);
if (associatedData != null && associatedData.length != 0) {
cipher.updateAAD(associatedData);
}
int outputSize = cipher.getOutputSize(plaintext.length);
if (outputSize > Integer.MAX_VALUE - outputPrefix.length - NONCE_SIZE_IN_BYTES) {
throw new GeneralSecurityException("plaintext too long");
}
int len = outputPrefix.length + NONCE_SIZE_IN_BYTES + outputSize;
byte[] output = Arrays.copyOf(outputPrefix, len);
System.arraycopy(
/* src= */ nonce,
/* srcPos= */ 0,
/* dest= */ output,
/* destPos= */ outputPrefix.length,
/* length= */ NONCE_SIZE_IN_BYTES);
int written =
cipher.doFinal(
plaintext, 0, plaintext.length, output, outputPrefix.length + NONCE_SIZE_IN_BYTES);
if (written != outputSize) {
throw new GeneralSecurityException("not enough data written");
}
return output;
}
@Override
public byte[] decrypt(final byte[] ciphertext, final byte[] associatedData)
throws GeneralSecurityException {
if (ciphertext == null) {
throw new NullPointerException("ciphertext is null");
}
if (ciphertext.length < outputPrefix.length + NONCE_SIZE_IN_BYTES + TAG_SIZE_IN_BYTES) {
throw new GeneralSecurityException("ciphertext too short");
}
if (!isPrefix(outputPrefix, ciphertext)) {
throw new GeneralSecurityException("Decryption failed (OutputPrefix mismatch).");
}
byte[] nonce = new byte[NONCE_SIZE_IN_BYTES];
System.arraycopy(
/* src= */ ciphertext,
/* srcPos= */ outputPrefix.length,
/* dest= */ nonce,
/* destPos= */ 0,
/* length= */ NONCE_SIZE_IN_BYTES);
AlgorithmParameterSpec params = new IvParameterSpec(nonce);
Cipher cipher = localCipher.get();
cipher.init(Cipher.DECRYPT_MODE, keySpec, params);
if (associatedData != null && associatedData.length != 0) {
cipher.updateAAD(associatedData);
}
int offset = outputPrefix.length + NONCE_SIZE_IN_BYTES;
int len = ciphertext.length - outputPrefix.length - NONCE_SIZE_IN_BYTES;
return cipher.doFinal(ciphertext, offset, len);
}
}