Skip to content

Address BouncyCastle's deprecated AESFastEngine usage #16164

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 7, 2025
Merged

Address BouncyCastle's deprecated AESFastEngine usage #16164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ccc8386
Replace BouncyCastle's deprecated AESFastEngine with the default AESE…
fjacobs Nov 25, 2024
85c00e8
Polish gh-16164
sjohnr Feb 3, 2025
c9c064c
Remove Unnecessary Backwards Compatability
rwinch May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions ...in/java/org/springframework/security/crypto/encrypt/BouncyCastleAesCbcBytesEncryptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2011-2016 the original author or authors.
* Copyright 2011-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -18,7 +18,9 @@

import org.bouncycastle.crypto.BufferedBlockCipher;
import org.bouncycastle.crypto.InvalidCipherTextException;
import org.bouncycastle.crypto.engines.AESEngine;
import org.bouncycastle.crypto.modes.CBCBlockCipher;
import org.bouncycastle.crypto.modes.CBCModeCipher;
import org.bouncycastle.crypto.paddings.PKCS7Padding;
import org.bouncycastle.crypto.paddings.PaddedBufferedBlockCipher;
import org.bouncycastle.crypto.params.ParametersWithIV;
Expand All @@ -45,23 +47,21 @@ public BouncyCastleAesCbcBytesEncryptor(String password, CharSequence salt, Byte
}

@Override
@SuppressWarnings("deprecation")
public byte[] encrypt(byte[] bytes) {
byte[] iv = this.ivGenerator.generateKey();
PaddedBufferedBlockCipher blockCipher = new PaddedBufferedBlockCipher(
new CBCBlockCipher(new org.bouncycastle.crypto.engines.AESFastEngine()), new PKCS7Padding());
CBCModeCipher cbcModeCipher = CBCBlockCipher.newInstance(AESEngine.newInstance());
PaddedBufferedBlockCipher blockCipher = new PaddedBufferedBlockCipher(cbcModeCipher, new PKCS7Padding());
blockCipher.init(true, new ParametersWithIV(this.secretKey, iv));
byte[] encrypted = process(blockCipher, bytes);
return (iv != null) ? EncodingUtils.concatenate(iv, encrypted) : encrypted;
}

@Override
@SuppressWarnings("deprecation")
public byte[] decrypt(byte[] encryptedBytes) {
CBCModeCipher cbcModeCipher = CBCBlockCipher.newInstance(AESEngine.newInstance());
byte[] iv = EncodingUtils.subArray(encryptedBytes, 0, this.ivGenerator.getKeyLength());
encryptedBytes = EncodingUtils.subArray(encryptedBytes, this.ivGenerator.getKeyLength(), encryptedBytes.length);
PaddedBufferedBlockCipher blockCipher = new PaddedBufferedBlockCipher(
new CBCBlockCipher(new org.bouncycastle.crypto.engines.AESFastEngine()), new PKCS7Padding());
PaddedBufferedBlockCipher blockCipher = new PaddedBufferedBlockCipher(cbcModeCipher, new PKCS7Padding());
blockCipher.init(false, new ParametersWithIV(this.secretKey, iv));
return process(blockCipher, encryptedBytes);
}
Expand Down
9 changes: 4 additions & 5 deletions ...in/java/org/springframework/security/crypto/encrypt/BouncyCastleAesGcmBytesEncryptor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2011-2016 the original author or authors.
* Copyright 2011-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -17,6 +17,7 @@
package org.springframework.security.crypto.encrypt;

import org.bouncycastle.crypto.InvalidCipherTextException;
import org.bouncycastle.crypto.engines.AESEngine;
import org.bouncycastle.crypto.modes.AEADBlockCipher;
import org.bouncycastle.crypto.modes.GCMBlockCipher;
import org.bouncycastle.crypto.params.AEADParameters;
Expand Down Expand Up @@ -44,21 +45,19 @@ public BouncyCastleAesGcmBytesEncryptor(String password, CharSequence salt, Byte
}

@Override
@SuppressWarnings("deprecation")
public byte[] encrypt(byte[] bytes) {
byte[] iv = this.ivGenerator.generateKey();
GCMBlockCipher blockCipher = new GCMBlockCipher(new org.bouncycastle.crypto.engines.AESFastEngine());
AEADBlockCipher blockCipher = GCMBlockCipher.newInstance(AESEngine.newInstance());
blockCipher.init(true, new AEADParameters(this.secretKey, 128, iv, null));
byte[] encrypted = process(blockCipher, bytes);
return (iv != null) ? EncodingUtils.concatenate(iv, encrypted) : encrypted;
}

@Override
@SuppressWarnings("deprecation")
public byte[] decrypt(byte[] encryptedBytes) {
byte[] iv = EncodingUtils.subArray(encryptedBytes, 0, this.ivGenerator.getKeyLength());
encryptedBytes = EncodingUtils.subArray(encryptedBytes, this.ivGenerator.getKeyLength(), encryptedBytes.length);
GCMBlockCipher blockCipher = new GCMBlockCipher(new org.bouncycastle.crypto.engines.AESFastEngine());
AEADBlockCipher blockCipher = GCMBlockCipher.newInstance(AESEngine.newInstance());
blockCipher.init(false, new AEADParameters(this.secretKey, 128, iv, null));
return process(blockCipher, encryptedBytes);
}
Expand Down
25 changes: 23 additions & 2 deletions ...pringframework/security/crypto/encrypt/BouncyCastleAesBytesEncryptorEquivalencyTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright 2011-2021 the original author or authors.
* Copyright 2011-2025 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -17,6 +17,8 @@
package org.springframework.security.crypto.encrypt;

import java.security.SecureRandom;
import java.time.Duration;
import java.time.temporal.ChronoUnit;
import java.util.Random;
import java.util.UUID;

Expand Down Expand Up @@ -107,7 +109,7 @@ private void testEquivalence(BytesEncryptor left, BytesEncryptor right) {

private void testCompatibility(BytesEncryptor left, BytesEncryptor right) {
// tests that right can decrypt what left encrypted and vice versa
// and that the decypted data is the same as the original
// and that the decrypted data is the same as the original
for (int size = 1; size < 2048; size++) {
this.testData = new byte[size];
this.secureRandom.nextBytes(this.testData);
Expand All @@ -120,6 +122,25 @@ private void testCompatibility(BytesEncryptor left, BytesEncryptor right) {
}
}

private long testSpeed(BytesEncryptor bytesEncryptor) {
long start = System.nanoTime();
for (int size = 0; size < 2048; size++) {
this.testData = new byte[size];
this.secureRandom.nextBytes(this.testData);
byte[] encrypted = bytesEncryptor.encrypt(this.testData);
byte[] decrypted = bytesEncryptor.decrypt(encrypted);
assertThat(decrypted).containsExactly(this.testData);
}
return System.nanoTime() - start;
}

private String nanosToReadableString(String label, long nanos) {
Duration duration = Duration.ofNanos(nanos);
Duration millis = duration.truncatedTo(ChronoUnit.MILLIS);
Duration micros = duration.minus(millis).dividedBy(1000);
return "%s: %dms %dμs".formatted(label, duration.toMillis(), micros.toNanos());
}

/**
* A BytesKeyGenerator that always generates the same sequence of values
*/
Expand Down