Merge pull request #150 from cconlon/hmacSha3KeyGenerator

Add JCE support for HmacSHA3 KeyGenerator

Author: rlm2002

README_JCE.md

@@ -166,6 +166,10 @@ The JCE provider currently supports the following algorithms:
         HmacSHA256
         HmacSHA384
         HmacSHA512
+        HmacSHA3-224
+        HmacSHA3-256
+        HmacSHA3-384
+        HmacSHA3-512
 
     KeyPairGenerator Class
         RSA

src/main/java/com/wolfssl/provider/jce/WolfCryptKeyGenerator.java

@@ -27,6 +27,7 @@
 import com.wolfssl.wolfcrypt.Sha256;
 import com.wolfssl.wolfcrypt.Sha384;
 import com.wolfssl.wolfcrypt.Sha512;
+import com.wolfssl.wolfcrypt.Sha3;
 import javax.crypto.KeyGeneratorSpi;
 import javax.crypto.SecretKey;
 import javax.crypto.spec.SecretKeySpec;
@@ -49,7 +50,11 @@ enum AlgoType {
         WC_HMAC_SHA224,
         WC_HMAC_SHA256,
         WC_HMAC_SHA384,
-        WC_HMAC_SHA512
+        WC_HMAC_SHA512,
+        WC_HMAC_SHA3_224,
+        WC_HMAC_SHA3_256,
+        WC_HMAC_SHA3_384,
+        WC_HMAC_SHA3_512
     }
 
     private AlgoType algoType = AlgoType.WC_INVALID;
@@ -92,6 +97,22 @@ private WolfCryptKeyGenerator(AlgoType type) {
                 this.algString = "HmacSHA512";
                 this.keySizeBits = (Sha512.DIGEST_SIZE * 8);
                 break;
+            case WC_HMAC_SHA3_224:
+                this.algString = "HmacSHA3-224";
+                this.keySizeBits = (Sha3.DIGEST_SIZE_224 * 8);
+                break;
+            case WC_HMAC_SHA3_256:
+                this.algString = "HmacSHA3-256";
+                this.keySizeBits = (Sha3.DIGEST_SIZE_256 * 8);
+                break;
+            case WC_HMAC_SHA3_384:
+                this.algString = "HmacSHA3-384";
+                this.keySizeBits = (Sha3.DIGEST_SIZE_384 * 8);
+                break;
+            case WC_HMAC_SHA3_512:
+                this.algString = "HmacSHA3-512";
+                this.keySizeBits = (Sha3.DIGEST_SIZE_512 * 8);
+                break;
         }
 
         log("created KeyGenerator(" + this.algString + ")");
@@ -232,6 +253,10 @@ protected SecretKey engineGenerateKey() {
             case WC_HMAC_SHA256:
             case WC_HMAC_SHA384:
             case WC_HMAC_SHA512:
+            case WC_HMAC_SHA3_224:
+            case WC_HMAC_SHA3_256:
+            case WC_HMAC_SHA3_384:
+            case WC_HMAC_SHA3_512:
                 return new SecretKeySpec(keyArr, this.algString);
             default:
                 return null;
@@ -321,5 +346,61 @@ public wcHMACSha512KeyGenerator() {
             super(AlgoType.WC_HMAC_SHA512);
         }
     }
+
+    /**
+     * KeyGenerator(HmacSHA3-224) class, called by WolfCryptProvider.
+     */
+    public static final class wcHMACSha3_224KeyGenerator
+        extends WolfCryptKeyGenerator {
+
+        /**
+         * Constructor for wcHMACSha3_224KeyGenerator.
+         */
+        public wcHMACSha3_224KeyGenerator() {
+            super(AlgoType.WC_HMAC_SHA3_224);
+        }
+    }
+
+    /**
+     * KeyGenerator(HmacSHA3-256) class, called by WolfCryptProvider.
+     */
+    public static final class wcHMACSha3_256KeyGenerator
+        extends WolfCryptKeyGenerator {
+
+        /**
+         * Constructor for wcHMACSha3_256KeyGenerator.
+         */
+        public wcHMACSha3_256KeyGenerator() {
+            super(AlgoType.WC_HMAC_SHA3_256);
+        }
+    }
+
+    /**
+     * KeyGenerator(HmacSHA3-384) class, called by WolfCryptProvider.
+     */
+    public static final class wcHMACSha3_384KeyGenerator
+        extends WolfCryptKeyGenerator {
+
+        /**
+         * Constructor for wcHMACSha3_384KeyGenerator.
+         */
+        public wcHMACSha3_384KeyGenerator() {
+            super(AlgoType.WC_HMAC_SHA3_384);
+        }
+    }
+
+    /**
+     * KeyGenerator(HmacSHA3-512) class, called by WolfCryptProvider.
+     */
+    public static final class wcHMACSha3_512KeyGenerator
+        extends WolfCryptKeyGenerator {
+
+        /**
+         * Constructor for wcHMACSha3_512KeyGenerator.
+         */
+        public wcHMACSha3_512KeyGenerator() {
+            super(AlgoType.WC_HMAC_SHA3_512);
+        }
+    }
 }
 

src/main/java/com/wolfssl/provider/jce/WolfCryptProvider.java

@@ -364,6 +364,22 @@ private void registerServices() {
             put("KeyGenerator.HmacSHA512",
                 "com.wolfssl.provider.jce.WolfCryptKeyGenerator$wcHMACSha512KeyGenerator");
         }
+        if (FeatureDetect.HmacSha3_224Enabled()) {
+            put("KeyGenerator.HmacSHA3-224",
+                "com.wolfssl.provider.jce.WolfCryptKeyGenerator$wcHMACSha3_224KeyGenerator");
+        }
+        if (FeatureDetect.HmacSha3_256Enabled()) {
+            put("KeyGenerator.HmacSHA3-256",
+                "com.wolfssl.provider.jce.WolfCryptKeyGenerator$wcHMACSha3_256KeyGenerator");
+        }
+        if (FeatureDetect.HmacSha3_384Enabled()) {
+            put("KeyGenerator.HmacSHA3-384",
+                "com.wolfssl.provider.jce.WolfCryptKeyGenerator$wcHMACSha3_384KeyGenerator");
+        }
+        if (FeatureDetect.HmacSha3_512Enabled()) {
+            put("KeyGenerator.HmacSHA3-512",
+                "com.wolfssl.provider.jce.WolfCryptKeyGenerator$wcHMACSha3_512KeyGenerator");
+        }
 
         /* KeyPairGenerator */
         if (FeatureDetect.RsaKeyGenEnabled()) {

src/test/java/com/wolfssl/provider/jce/test/WolfCryptKeyGeneratorTest.java

@@ -47,6 +47,7 @@
 import com.wolfssl.wolfcrypt.Sha256;
 import com.wolfssl.wolfcrypt.Sha384;
 import com.wolfssl.wolfcrypt.Sha512;
+import com.wolfssl.wolfcrypt.Sha3;
 import com.wolfssl.provider.jce.WolfCryptProvider;
 
 public class WolfCryptKeyGeneratorTest {
@@ -57,7 +58,11 @@ public class WolfCryptKeyGeneratorTest {
         "HmacSHA224",
         "HmacSHA256",
         "HmacSHA384",
-        "HmacSHA512"
+        "HmacSHA512",
+        "HmacSHA3-224",
+        "HmacSHA3-256",
+        "HmacSHA3-384",
+        "HmacSHA3-512"
     };
 
     private static int[] aesKeySizes = { 128, 192, 256 };
@@ -98,6 +103,23 @@ public void testGetKeyGeneratorFromProvider()
                 !FeatureDetect.HmacSha224Enabled()) {
                 continue;
             }
+            /* Skip HmacSHA3 algorithms if not supported by native wolfSSL */
+            if (alg.equals("HmacSHA3-224") &&
+                !FeatureDetect.HmacSha3_224Enabled()) {
+                continue;
+            }
+            if (alg.equals("HmacSHA3-256") &&
+                !FeatureDetect.HmacSha3_256Enabled()) {
+                continue;
+            }
+            if (alg.equals("HmacSHA3-384") &&
+                !FeatureDetect.HmacSha3_384Enabled()) {
+                continue;
+            }
+            if (alg.equals("HmacSHA3-512") &&
+                !FeatureDetect.HmacSha3_512Enabled()) {
+                continue;
+            }
             kg = KeyGenerator.getInstance(alg, "wolfJCE");
             assertNotNull(kg);
         }
@@ -166,6 +188,62 @@ public void testHmacSHA512KeyGeneration()
         testKeyGenerationDefaultKeySize("HmacSHA512", Sha512.DIGEST_SIZE * 8);
     }
 
+    @Test
+    public void testHmacSHA3_224KeyGeneration()
+        throws NoSuchProviderException, NoSuchAlgorithmException {
+
+        /* Skip test if HmacSHA3-224 is not supported by native wolfSSL */
+        if (!FeatureDetect.HmacSha3_224Enabled()) {
+            return;
+        }
+
+        testKeyGeneration("HmacSHA3-224", new int[] { 224 });
+        testKeyGenerationDefaultKeySize("HmacSHA3-224",
+            Sha3.DIGEST_SIZE_224 * 8);
+    }
+
+    @Test
+    public void testHmacSHA3_256KeyGeneration()
+        throws NoSuchProviderException, NoSuchAlgorithmException {
+
+        /* Skip test if HmacSHA3-256 is not supported by native wolfSSL */
+        if (!FeatureDetect.HmacSha3_256Enabled()) {
+            return;
+        }
+
+        testKeyGeneration("HmacSHA3-256", new int[] { 256 });
+        testKeyGenerationDefaultKeySize("HmacSHA3-256",
+            Sha3.DIGEST_SIZE_256 * 8);
+    }
+
+    @Test
+    public void testHmacSHA3_384KeyGeneration()
+        throws NoSuchProviderException, NoSuchAlgorithmException {
+
+        /* Skip test if HmacSHA3-384 is not supported by native wolfSSL */
+        if (!FeatureDetect.HmacSha3_384Enabled()) {
+            return;
+        }
+
+        testKeyGeneration("HmacSHA3-384", new int[] { 384 });
+        testKeyGenerationDefaultKeySize("HmacSHA3-384",
+            Sha3.DIGEST_SIZE_384 * 8);
+    }
+
+    @Test
+    public void testHmacSHA3_512KeyGeneration()
+        throws NoSuchProviderException, NoSuchAlgorithmException {
+
+        /* Skip test if HmacSHA3-512 is not supported by native wolfSSL */
+        if (!FeatureDetect.HmacSha3_512Enabled()) {
+            return;
+        }
+
+        testKeyGeneration("HmacSHA3-512", new int[] { 512 });
+        testKeyGenerationDefaultKeySize("HmacSHA3-512",
+            Sha3.DIGEST_SIZE_512 * 8);
+    }
+
     /**
      * Test that KeyGenerator generates expected default sized keys when
      * no size is explicitly given.