Add additional secret key algorithms. (#759)

Author: jonwltn

kse/src/main/java/org/kse/crypto/secretkey/SecretKeyType.java

@@ -26,14 +26,17 @@
 public enum SecretKeyType {
     AES("AES", "AES", 128, 256, 64),
     ARC4("ARC4", "ARC4", 40, 2048, 8),
+    ARIA("ARIA", "ARIA", 128, 256, 64),
     BLOWFISH("BLOWFISH", "Blowfish", 32, 448, 64),
     CAMELLIA("CAMELLIA", "Camellia", 128, 256, 64),
-    CHACHA("CHACHA", "ChaCha", 128, 256, 128),
     CAST5("CAST5", "CAST-128", 40, 128, 8),
     CAST6("CAST6", "CAST-256", 128, 256, 32),
+    CHACHA("CHACHA", "ChaCha", 128, 256, 128),
     DES("DES", "DES", 64, 64, 1),
     DESEDE("DESede", "DESEDE", 128, 192, 64),
+    DSTU7624("DSTU7624", "DSTU 7624", 128, 512, 128), // key sizes are 128, 256, 512
     GOST_28147("GOST28147", "GOST 28147-89", 256, 256, 1),
+    GOST_3412("GOST3412-2015", "GOST R 34.12-2015", 256, 256, 1),
     GRAIN_V1("Grainv1", "Grain v1", 80, 80, 1),
     GRAIN_128("Grain128", "Grain-128", 128, 128, 1),
     HC_128("HC128", "HC-128", 128, 128, 1),
@@ -49,22 +52,27 @@ public enum SecretKeyType {
     HMAC_SHA384("HMACSHA384", "HMac-SHA384", 384, 384, 1),
     HMAC_SHA512("HMACSHA512", "HMac-SHA512", 512, 512, 1),
     HMAC_TIGER("HMACTIGER", "HMac-Tiger", 192, 192, 1),
+    IDEA("IDEA", "IDEA", 128, 128, 1),
     NOEKEON("NOEKEON", "NOEKEON", 128, 128, 1),
     RC2("RC2", "RC2", 8, 128, 8),
     RC5("RC5", "RC5", 8, 2040, 8),
     RC6("RC6", "RC6", 128, 256, 64),
     RIJNDAEL("RIJNDAEL", "Rijndael", 128, 256, 32),
     SALSA_20("SALSA20", "Salsa20", 128, 256, 128),
     SERPENT("Serpent", "Serpent", 128, 256, 64),
+    TNEPRES("Tnepres", "Tnepres", 128, 256, 64),
     SEED("SEED", "SEED", 128, 128, 1),
     SKIPJACK("SKIPJACK", "Skipjack", 80, 80, 1),
+    SM4("SM4", "SM4", 128, 128, 1),
     TEA("TEA", "TEA", 128, 128, 1),
     TWOFISH("Twofish", "Twofish", 128, 256, 64),
     THREEFISH_256("Threefish-256", "Threefish-256", 256, 256, 1),
     THREEFISH_512("Threefish-512", "Threefish-512", 512, 512, 1),
     THREEFISH_1024("Threefish-1024", "Threefish-1024", 1024, 1024, 1),
     XSALSA_20("XSALSA20", "XSalsa20", 128, 256, 128),
-    XTEA("XTEA", "XTEA", 128, 128, 1);
+    XTEA("XTEA", "XTEA", 128, 128, 1),
+    ZUC_128("ZUC-128", "ZUC-128", 128, 128, 1),
+    ZUC_256("ZUC-256", "ZUC-256", 256, 256, 1);
 
     // Supported sets of secret key algorithms. Located here so that they can be
     // referenced by the KeyStoreType enum.

kse/src/main/java/org/kse/crypto/secretkey/SecretKeyUtil.java

@@ -34,6 +34,9 @@
 import org.kse.crypto.KeyInfo;
 import org.kse.utilities.rng.RNG;
 
+/**
+ * Provides utility methods relating to secret keys.
+ */
 public final class SecretKeyUtil {
     private static ResourceBundle res = ResourceBundle.getBundle("org/kse/crypto/secretkey/resources");
 
@@ -69,8 +72,12 @@ public static SecretKey generateSecretKey(SecretKeyType secretKeyType, int keySi
     public static KeyInfo getKeyInfo(SecretKey secretKey) {
         String algorithm = secretKey.getAlgorithm();
 
-        if (algorithm.equals("RC4")) {
+        if ("RC4".equals(algorithm)) {
             algorithm = "ARC4"; // RC4 is trademarked so we never want to display it
+        } else if ("ZUC128".equals(algorithm)) {
+            algorithm = "ZUC-128"; // BC uses ZUC-128 for the key generator and ZUC128 for the algorithm
+        } else if ("ZUC256".equals(algorithm)) {
+            algorithm = "ZUC-256"; // BC uses ZUC-256 for the key generator and ZUC256 for the algorithm
         }
 
         if (secretKey.getFormat().equals("RAW")) {

kse/src/test/java/org/kse/crypto/secretkey/SecretKeyUtilTest.java

@@ -23,21 +23,20 @@
 
 import javax.crypto.SecretKey;
 
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.EnumSource;
 import org.kse.crypto.CryptoException;
 import org.kse.crypto.CryptoTestsBase;
 import org.kse.crypto.KeyInfo;
 
+/**
+ * Unit tests for SecretKeyUtil.
+ */
 public class SecretKeyUtilTest extends CryptoTestsBase {
-    @Test
-    public void testAllSecretKeyTypes() throws CryptoException {
-        for (SecretKeyType secretKeyType : SecretKeyType.values()) {
-            testSecretKeyType(secretKeyType);
-        }
-    }
 
-    @Test
-    private void testSecretKeyType(SecretKeyType secretKeyType) throws CryptoException {
+    @ParameterizedTest
+    @EnumSource(value = SecretKeyType.class)
+    void testSecretKeyType(SecretKeyType secretKeyType) throws CryptoException {
         for (int keySize = secretKeyType.minSize(); keySize <= secretKeyType.maxSize(); keySize += secretKeyType
                 .stepSize()) {
             SecretKey secretKey = SecretKeyUtil.generateSecretKey(secretKeyType, keySize);