You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by gg...@apache.org on 2020/12/28 15:15:10 UTC

[commons-crypto] branch master updated: More minor improvement:

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-crypto.git


The following commit(s) were added to refs/heads/master by this push:
     new 3d9116a  More minor improvement:
     new 661d2a2  Merge pull request #125 from arturobernalg/feature/minor_improvement
3d9116a is described below

commit 3d9116aa5956d3962d1ae877eba5eb9c26aeb928
Author: Arturo Bernal <ar...@gmail.com>
AuthorDate: Mon Dec 28 10:02:45 2020 +0100

    More minor improvement:
    
    * Add final
---
 .../commons/crypto/cipher/OpenSslCommonMode.java   |  2 +-
 .../crypto/cipher/OpenSslGaloisCounterMode.java    | 10 +++++-----
 .../commons/crypto/jna/OpenSslJnaCipher.java       |  2 +-
 .../crypto/stream/PositionedCryptoInputStream.java |  2 +-
 .../commons/crypto/utils/ReflectionUtils.java      |  4 ++--
 .../apache/commons/crypto/AbstractBenchmark.java   | 22 +++++++++++-----------
 .../commons/crypto/cipher/GcmCipherTest.java       |  8 ++++----
 .../commons/crypto/cipher/OpenSslCipherTest.java   |  2 +-
 .../crypto/random/CryptoRandomFactoryTest.java     |  6 +++---
 .../commons/crypto/random/OsCryptoRandomTest.java  |  2 +-
 .../crypto/stream/AbstractCipherStreamTest.java    |  2 +-
 .../commons/crypto/stream/CtrCryptoStreamTest.java |  2 +-
 12 files changed, 32 insertions(+), 32 deletions(-)

diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslCommonMode.java b/src/main/java/org/apache/commons/crypto/cipher/OpenSslCommonMode.java
index 61a01de..6ca17bb 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslCommonMode.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslCommonMode.java
@@ -41,7 +41,7 @@ class OpenSslCommonMode extends OpenSslFeedbackCipher {
     public void init(final int mode, final byte[] key, final AlgorithmParameterSpec params)
             throws InvalidAlgorithmParameterException {
         this.cipherMode = mode;
-        byte[] iv;
+        final byte[] iv;
         if (params instanceof IvParameterSpec) {
             iv = ((IvParameterSpec) params).getIV();
         } else {
diff --git a/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java b/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
index 52a236a..5129a29 100644
--- a/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
+++ b/src/main/java/org/apache/commons/crypto/cipher/OpenSslGaloisCounterMode.java
@@ -62,7 +62,7 @@ class OpenSslGaloisCounterMode extends OpenSslFeedbackCipher {
         }
 
         this.cipherMode = mode;
-        byte[] iv;
+        final byte[] iv;
         if (params instanceof GCMParameterSpec) {
             final GCMParameterSpec gcmParam = (GCMParameterSpec) params;
             iv = gcmParam.getIV();
@@ -85,7 +85,7 @@ class OpenSslGaloisCounterMode extends OpenSslFeedbackCipher {
 
         processAAD();
 
-        int len;
+        final int len;
         if (this.cipherMode == OpenSsl.DECRYPT_MODE) {
             // store internally until doFinal(decrypt) is called because
             // spec mentioned that only return recovered data after tag
@@ -137,7 +137,7 @@ class OpenSslGaloisCounterMode extends OpenSslFeedbackCipher {
             // and the retrieve the trailing tag from input
             int inputOffsetFinal = inputOffset;
             int inputLenFinal = inputLen;
-            byte[] inputFinal;
+            final byte[] inputFinal;
             if (inBuffer != null && inBuffer.size() > 0) {
                 inBuffer.write(input, inputOffset, inputLen);
                 inputFinal = inBuffer.toByteArray();
@@ -171,7 +171,7 @@ class OpenSslGaloisCounterMode extends OpenSslFeedbackCipher {
 
         // Keep the similar behavior as JCE, append the tag to end of output
         if (this.cipherMode == OpenSsl.ENCRYPT_MODE) {
-            ByteBuffer tag;
+            final ByteBuffer tag;
             tag = ByteBuffer.allocate(getTagLen());
             evpCipherCtxCtrl(context, OpenSslEvpCtrlValues.AEAD_GET_TAG.getValue(), getTagLen(), tag);
             tag.get(output, outputLength - getTagLen(), getTagLen());
@@ -251,7 +251,7 @@ class OpenSslGaloisCounterMode extends OpenSslFeedbackCipher {
 
         // Keep the similar behavior as JCE, append the tag to end of output
         if (this.cipherMode == OpenSsl.ENCRYPT_MODE) {
-            ByteBuffer tag;
+            final ByteBuffer tag;
             tag = ByteBuffer.allocate(getTagLen());
             evpCipherCtxCtrl(context, OpenSslEvpCtrlValues.AEAD_GET_TAG.getValue(), getTagLen(), tag);
             output.put(tag);
diff --git a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
index 90f1a5c..6cddba5 100644
--- a/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
+++ b/src/main/java/org/apache/commons/crypto/jna/OpenSslJnaCipher.java
@@ -96,7 +96,7 @@ class OpenSslJnaCipher implements CryptoCipher {
         if (mode == Cipher.ENCRYPT_MODE) {
             cipherMode = OpenSslNativeJna.OOSL_JNA_ENCRYPT_MODE;
         }
-        byte[] iv;
+        final byte[] iv;
         if (params instanceof IvParameterSpec) {
             iv = ((IvParameterSpec) params).getIV();
         } else {
diff --git a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
index 9bd0121..4555461 100644
--- a/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
+++ b/src/main/java/org/apache/commons/crypto/stream/PositionedCryptoInputStream.java
@@ -307,7 +307,7 @@ public class PositionedCryptoInputStream extends CtrCryptoInputStream {
     private CipherState getCipherState() throws IOException {
         CipherState state = cipherPool.poll();
         if (state == null) {
-            CryptoCipher cryptoCipher;
+            final CryptoCipher cryptoCipher;
             try {
                 cryptoCipher = CryptoCipherFactory.getCryptoCipher("AES/CTR/NoPadding", properties);
             } catch (final GeneralSecurityException e) {
diff --git a/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java b/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
index 4de5a69..e7f92b1 100644
--- a/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
+++ b/src/main/java/org/apache/commons/crypto/utils/ReflectionUtils.java
@@ -72,7 +72,7 @@ public final class ReflectionUtils {
      */
     public static <T> T newInstance(final Class<T> klass, final Object... args) {
         try {
-            Constructor<T> ctor;
+            final Constructor<T> ctor;
             final int argsLength = args.length;
 
             if (argsLength == 0) {
@@ -114,7 +114,7 @@ public final class ReflectionUtils {
      * @return the class object, or null if it could not be found.
      */
     private static Class<?> getClassByNameOrNull(final String name) {
-        Map<String, WeakReference<Class<?>>> map;
+        final Map<String, WeakReference<Class<?>>> map;
 
         synchronized (CACHE_CLASSES) {
             map = CACHE_CLASSES.computeIfAbsent(CLASSLOADER, k -> Collections.synchronizedMap(new WeakHashMap<String, WeakReference<Class<?>>>()));
diff --git a/src/test/java/org/apache/commons/crypto/AbstractBenchmark.java b/src/test/java/org/apache/commons/crypto/AbstractBenchmark.java
index 5a8874c..1f551ae 100644
--- a/src/test/java/org/apache/commons/crypto/AbstractBenchmark.java
+++ b/src/test/java/org/apache/commons/crypto/AbstractBenchmark.java
@@ -45,37 +45,37 @@ public abstract class AbstractBenchmark {
         super();
     }
 
-    protected void random(String cipherClass) throws Exception {
-        CryptoRandom random = getRandom(cipherClass);
+    protected void random(final String cipherClass) throws Exception {
+        final CryptoRandom random = getRandom(cipherClass);
         random.nextBytes(new byte[1000]);
         random.nextBytes(new byte[1000]);
         random.close();
     }
 
-    protected void encipher(String cipherClass) throws Exception {
-        CryptoCipher enCipher = getCipher(cipherClass);
+    protected void encipher(final String cipherClass) throws Exception {
+        final CryptoCipher enCipher = getCipher(cipherClass);
         enCipher.init(Cipher.ENCRYPT_MODE, keySpec, ivSpec);
         final int bufferSize = 1024;
-        ByteBuffer inBuffer = ByteBuffer.allocateDirect(bufferSize);
-        ByteBuffer outBuffer = ByteBuffer.allocateDirect(bufferSize);
+        final ByteBuffer inBuffer = ByteBuffer.allocateDirect(bufferSize);
+        final ByteBuffer outBuffer = ByteBuffer.allocateDirect(bufferSize);
         inBuffer.put(BUFFER);
         inBuffer.flip();
         enCipher.doFinal(inBuffer, outBuffer);
         enCipher.close();
     }
 
-    protected CryptoRandom getRandom(String className) throws Exception {
-        Properties props = new Properties();
+    protected CryptoRandom getRandom(final String className) throws Exception {
+        final Properties props = new Properties();
         props.setProperty(CryptoRandomFactory.CLASSES_KEY, className);
         final CryptoRandom cryptoRandom = CryptoRandomFactory.getCryptoRandom(props);
         assertEquals(className, cryptoRandom.getClass().getCanonicalName());
         return cryptoRandom;
     }
 
-    protected CryptoCipher getCipher(String className) throws Exception {
-        Properties properties = new Properties();
+    protected CryptoCipher getCipher(final String className) throws Exception {
+        final Properties properties = new Properties();
         properties.setProperty(CryptoCipherFactory.CLASSES_KEY, className);
-        CryptoCipher cipher = CryptoCipherFactory.getCryptoCipher("AES/CBC/PKCS5Padding", properties);
+        final CryptoCipher cipher = CryptoCipherFactory.getCryptoCipher("AES/CBC/PKCS5Padding", properties);
         assertEquals(className, cipher.getClass().getCanonicalName());
         return cipher;
     }
diff --git a/src/test/java/org/apache/commons/crypto/cipher/GcmCipherTest.java b/src/test/java/org/apache/commons/crypto/cipher/GcmCipherTest.java
index 8b29a0a..2c1b137 100644
--- a/src/test/java/org/apache/commons/crypto/cipher/GcmCipherTest.java
+++ b/src/test/java/org/apache/commons/crypto/cipher/GcmCipherTest.java
@@ -240,7 +240,7 @@ public class GcmCipherTest {
         final GCMParameterSpec iv = new GCMParameterSpec(tagLength, ivBytes);
         c.init(Cipher.DECRYPT_MODE, key, iv);
         c.updateAAD(aadBytes);
-        Exception ex = assertThrows(AEADBadTagException.class, () -> c.doFinal(encOutput, 0, encOutput.length, decOutput, 0));
+        final Exception ex = assertThrows(AEADBadTagException.class, () -> c.doFinal(encOutput, 0, encOutput.length, decOutput, 0));
         assertEquals(ex.getMessage(),"Tag mismatch!");
         c.close();
 
@@ -339,7 +339,7 @@ public class GcmCipherTest {
         aad[0] = (byte) (aad[0] + 1);
         c.updateAAD(aad);
 
-        Exception ex = assertThrows(AEADBadTagException.class,
+        final Exception ex = assertThrows(AEADBadTagException.class,
                 () -> c.doFinal(tag, 0, tag.length, input, 0));
         assertEquals(ex.getMessage(), "Tag mismatch!");
 
@@ -501,8 +501,8 @@ public class GcmCipherTest {
         final ByteBuffer bfAAD = ByteBuffer.allocateDirect(aad.length);
         bfAAD.put(aad);
 
-        ByteBuffer bfPlainText;
-        ByteBuffer bfCipherText;
+        final ByteBuffer bfPlainText;
+        final ByteBuffer bfCipherText;
         bfPlainText = ByteBuffer.allocateDirect(plainText.length);
         bfCipherText = ByteBuffer.allocateDirect(encOutput.length);
 
diff --git a/src/test/java/org/apache/commons/crypto/cipher/OpenSslCipherTest.java b/src/test/java/org/apache/commons/crypto/cipher/OpenSslCipherTest.java
index bc11b72..7c0e665 100644
--- a/src/test/java/org/apache/commons/crypto/cipher/OpenSslCipherTest.java
+++ b/src/test/java/org/apache/commons/crypto/cipher/OpenSslCipherTest.java
@@ -111,7 +111,7 @@ public class OpenSslCipherTest extends AbstractCipherTest {
         final ByteBuffer input = ByteBuffer.allocate(1024);
         final ByteBuffer output = ByteBuffer.allocate(1024);
 
-        Exception ex = assertThrows(IllegalArgumentException.class, () -> cipher.doFinal(input, output));
+        final Exception ex = assertThrows(IllegalArgumentException.class, () -> cipher.doFinal(input, output));
         assertTrue(ex.getMessage().contains("Direct buffer is required"));
     }
 
diff --git a/src/test/java/org/apache/commons/crypto/random/CryptoRandomFactoryTest.java b/src/test/java/org/apache/commons/crypto/random/CryptoRandomFactoryTest.java
index 07f7bdb..ee83a7d 100644
--- a/src/test/java/org/apache/commons/crypto/random/CryptoRandomFactoryTest.java
+++ b/src/test/java/org/apache/commons/crypto/random/CryptoRandomFactoryTest.java
@@ -114,7 +114,7 @@ public class CryptoRandomFactoryTest {
     public void testAbstractRandom() {
         final Properties props = new Properties();
         props.setProperty(CryptoRandomFactory.CLASSES_KEY, AbstractRandom.class.getName());
-        Exception ex = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
+        final Exception ex = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
         final String message = ex.getMessage();
         assertTrue(message.contains("InstantiationException"), message);
     }
@@ -123,7 +123,7 @@ public class CryptoRandomFactoryTest {
     public void testDummmyRandom() {
         final Properties props = new Properties();
         props.setProperty(CryptoRandomFactory.CLASSES_KEY, DummyRandom.class.getName());
-        Exception ex = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
+        final Exception ex = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
         final String message = ex.getMessage();
         assertTrue(message.contains("NoSuchMethodException"), message);
     }
@@ -141,7 +141,7 @@ public class CryptoRandomFactoryTest {
     public void testFailingRandom() {
         final Properties props = new Properties();
         props.setProperty(CryptoRandomFactory.CLASSES_KEY, FailingRandom.class.getName());
-        Exception ex = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
+        final Exception ex = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
 
         Throwable cause = ex.getCause();
         assertEquals(IllegalArgumentException.class, cause.getClass());
diff --git a/src/test/java/org/apache/commons/crypto/random/OsCryptoRandomTest.java b/src/test/java/org/apache/commons/crypto/random/OsCryptoRandomTest.java
index 3f8b80d..b2fe0f6 100644
--- a/src/test/java/org/apache/commons/crypto/random/OsCryptoRandomTest.java
+++ b/src/test/java/org/apache/commons/crypto/random/OsCryptoRandomTest.java
@@ -50,7 +50,7 @@ public class OsCryptoRandomTest extends AbstractRandomTest {
 		props.setProperty(CryptoRandomFactory.CLASSES_KEY, OsCryptoRandom.class.getName());
 		// Invalid device
 		props.setProperty(CryptoRandomFactory.DEVICE_FILE_PATH_KEY, "");
-		Exception e = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
+		final Exception e = assertThrows(GeneralSecurityException.class, () -> CryptoRandomFactory.getCryptoRandom(props));
 		Throwable cause;
 		cause = e.getCause();
 		assertEquals(IllegalArgumentException.class, cause.getClass());
diff --git a/src/test/java/org/apache/commons/crypto/stream/AbstractCipherStreamTest.java b/src/test/java/org/apache/commons/crypto/stream/AbstractCipherStreamTest.java
index 5950fad..6b75cb7 100644
--- a/src/test/java/org/apache/commons/crypto/stream/AbstractCipherStreamTest.java
+++ b/src/test/java/org/apache/commons/crypto/stream/AbstractCipherStreamTest.java
@@ -162,7 +162,7 @@ public abstract class AbstractCipherStreamTest {
             System.arraycopy(data, dataLen - n2, expectedData, 0, n2);
             assertArrayEquals(readData, expectedData);
 
-            Exception e = assertThrows(IllegalArgumentException.class, () -> in.skip(-3));
+            final Exception e = assertThrows(IllegalArgumentException.class, () -> in.skip(-3));
             assertTrue(e.getMessage().contains("Negative skip length"));
 
             // Skip after EOF
diff --git a/src/test/java/org/apache/commons/crypto/stream/CtrCryptoStreamTest.java b/src/test/java/org/apache/commons/crypto/stream/CtrCryptoStreamTest.java
index cc8f584..38a2eba 100644
--- a/src/test/java/org/apache/commons/crypto/stream/CtrCryptoStreamTest.java
+++ b/src/test/java/org/apache/commons/crypto/stream/CtrCryptoStreamTest.java
@@ -171,7 +171,7 @@ public class CtrCryptoStreamTest extends AbstractCipherStreamTest {
         buf.get(readData);
         System.arraycopy(data, 0, expectedData, 0, dataLen);
         assertArrayEquals(readData, expectedData);
-        Exception ex = assertThrows(IOException.class, () -> in.decryptBuffer(buf));
+        final Exception ex = assertThrows(IOException.class, () -> in.decryptBuffer(buf));
         assertEquals(ex.getCause().getClass(), ShortBufferException.class);
 
     }