Add HmacSHA3-* and HmacKeccak* Implementations (#21)

Author: 05nelsonm

README.md

@@ -25,7 +25,7 @@
 
 Message Authentication Code algorithms for Kotlin Multiplatform
 
-If you are looking for hashing algorithms (e.g. `SHA-256`, `SHA-512`, etc), see the [hash repo][url-hash].
+If you are looking for hashing algorithms (e.g. `SHA-256`, `SHA3-256`, etc), see the [hash repo][url-hash].
 
 If you are looking for `Encoding` (`Base16` a.k.a. `hex`, `Base32`, `Base64`, etc), see the [encoding repo][url-encoding].
 

gradle/libs.versions.toml

@@ -1,8 +1,9 @@
 [versions]
 binaryCompat = "0.13.0"
+bouncyCastle = "1.72"
 configuration = "0.1.0-beta02"
-cryptoCore = "0.2.0"
-cryptoHash = "0.2.1"
+cryptoCore = "0.2.2"
+cryptoHash = "0.2.2"
 encoding = "1.2.1"
 gradleVersions = "0.46.0"
 kotlin = "1.8.10"
@@ -11,14 +12,17 @@ publish = "0.24.0"
 [libraries]
 kotlincrypto-core-digest = { module = "org.kotlincrypto.core:digest", version.ref = "cryptoCore" }
 kotlincrypto-core-mac = { module = "org.kotlincrypto.core:mac", version.ref = "cryptoCore" }
+kotlincrypto-core-xof = { module = "org.kotlincrypto.core:xof", version.ref = "cryptoCore" }
 kotlincrypto-hash-md5 = { module = "org.kotlincrypto.hash:md5", version.ref = "cryptoHash" }
 kotlincrypto-hash-sha1 = { module = "org.kotlincrypto.hash:sha1", version.ref = "cryptoHash" }
 kotlincrypto-hash-sha2 = { module = "org.kotlincrypto.hash:sha2", version.ref = "cryptoHash" }
+kotlincrypto-hash-sha3 = { module = "org.kotlincrypto.hash:sha3", version.ref = "cryptoHash" }
 gradle-kmp-configuration = { module = "io.matthewnelson:gradle-kmp-configuration-plugin", version.ref = "configuration" }
 gradle-kotlin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
 gradle-maven-publish = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "publish" }
 
 # Tests
+bouncyCastle = { module = "org.bouncycastle:bcprov-ext-jdk15to18", version.ref = "bouncyCastle" }
 encoding-base16 = { module = "io.matthewnelson.kotlin-components:encoding-base16", version.ref = "encoding" }
 encoding-base64 = { module = "io.matthewnelson.kotlin-components:encoding-base64", version.ref = "encoding" }
 

library/hmac/hmac-md5/src/commonMain/kotlin/org/kotlincrypto/macs/HmacMD5.kt

@@ -36,7 +36,7 @@ public class HmacMD5: Hmac {
     public constructor(key: ByteArray): super(key, "HmacMD5", MD5())
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacMD5(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacMD5(engineCopy)
 }

library/hmac/hmac-sha1/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA1.kt

@@ -36,7 +36,7 @@ public class HmacSHA1: Hmac {
     public constructor(key: ByteArray): super(key, "HmacSHA1", SHA1())
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA1(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA1(engineCopy)
 }

library/hmac/hmac-sha2/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA224.kt

@@ -36,7 +36,7 @@ public class HmacSHA224: Hmac {
     public constructor(key: ByteArray): super(key, "HmacSHA224", SHA224())
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA224(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA224(engineCopy)
 }

library/hmac/hmac-sha2/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA256.kt

@@ -36,7 +36,7 @@ public class HmacSHA256: Hmac {
     public constructor(key: ByteArray): super(key, "HmacSHA256", SHA256())
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA256(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA256(engineCopy)
 }

library/hmac/hmac-sha2/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA384.kt

@@ -36,7 +36,7 @@ public class HmacSHA384: Hmac {
     public constructor(key: ByteArray): super(key, "HmacSHA384", SHA384())
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA384(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA384(engineCopy)
 }

library/hmac/hmac-sha2/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA512.kt

@@ -36,7 +36,7 @@ public class HmacSHA512: Hmac {
     public constructor(key: ByteArray): super(key, "HmacSHA512", SHA512())
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA512(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA512(engineCopy)
 }

library/hmac/hmac-sha2/src/commonMain/kotlin/org/kotlincrypto/macs/HmacSHA512t.kt

@@ -59,7 +59,7 @@ public class HmacSHA512t: Hmac {
     public constructor(key: ByteArray, t: Int): super(key, "HmacSHA512/$t", SHA512t(t))
 
     @OptIn(InternalKotlinCryptoApi::class)
-    private constructor(algorithm: String, engine: Engine): super(algorithm, engine)
+    private constructor(engine: Mac.Engine): super(engine)
 
-    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA512t(algorithm(), engineCopy as Engine)
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacSHA512t(engineCopy)
 }

library/hmac/hmac-sha3/.gitignore

@@ -0,0 +1 @@
+/build

library/hmac/hmac-sha3/api/hmac-sha3.api

@@ -0,0 +1,32 @@
+public final class org/kotlincrypto/macs/HmacKeccak224 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacKeccak256 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacKeccak384 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacKeccak512 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacSHA3_224 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacSHA3_256 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacSHA3_384 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+
+public final class org/kotlincrypto/macs/HmacSHA3_512 : org/kotlincrypto/macs/Hmac {
+	public fun <init> ([B)V
+}
+

library/hmac/hmac-sha3/build.gradle.kts

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2023 Matthew Nelson
+ *
+ * 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
+ *
+ *         https://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.
+ **/
+plugins {
+    id("configuration")
+    id("bom-include")
+}
+
+kmpConfiguration {
+    configureShared(publish = true) {
+        common {
+            sourceSetMain {
+                dependencies {
+                    implementation(libs.kotlincrypto.hash.sha3)
+                    api(project(":library:hmac:hmac"))
+                }
+            }
+            sourceSetTest {
+                dependencies {
+                    implementation(project(":tools:testing"))
+                }
+            }
+        }
+    }
+}

library/hmac/hmac-sha3/gradle.properties

@@ -0,0 +1,16 @@
+# Copyright (c) 2023 Matthew Nelson
+#
+# 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
+#
+#     https://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.
+POM_ARTIFACT_ID=hmac-sha3
+POM_NAME=KotlinCrypto HmacSHA3/HmacKeccak
+POM_DESCRIPTION=HmacSHA3-224, HmacSHA3-256, HmacSHA3-384, HmacSHA3-512, HmacKeccak224, HmacKeccak256, HmacKeccak384, HmacKeccak512 Message Authentication

library/hmac/hmac-sha3/src/commonMain/kotlin/org/kotlincrypto/macs/HmacKeccak224.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023 Matthew Nelson
+ *
+ * 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
+ *
+ *     https://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.
+ **/
+@file:Suppress("ClassName", "UnnecessaryOptInAnnotation")
+
+package org.kotlincrypto.macs
+
+import org.kotlincrypto.core.InternalKotlinCryptoApi
+import org.kotlincrypto.core.Mac
+import org.kotlincrypto.hash.sha3.Keccak224
+
+/**
+ * HmacKeccak224 implementation
+ * */
+public class HmacKeccak224: Hmac {
+
+    /**
+     * Instantiates a new instance of [HmacKeccak224].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
+    @OptIn(InternalKotlinCryptoApi::class)
+    @Throws(IllegalArgumentException::class)
+    public constructor(key: ByteArray): super(key, "HmacKeccak224", Keccak224())
+
+    @OptIn(InternalKotlinCryptoApi::class)
+    private constructor(engine: Mac.Engine): super(engine)
+
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacKeccak224(engineCopy)
+}

library/hmac/hmac-sha3/src/commonMain/kotlin/org/kotlincrypto/macs/HmacKeccak256.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023 Matthew Nelson
+ *
+ * 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
+ *
+ *     https://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.
+ **/
+@file:Suppress("ClassName", "UnnecessaryOptInAnnotation")
+
+package org.kotlincrypto.macs
+
+import org.kotlincrypto.core.InternalKotlinCryptoApi
+import org.kotlincrypto.core.Mac
+import org.kotlincrypto.hash.sha3.Keccak256
+
+/**
+ * HmacKeccak256 implementation
+ * */
+public class HmacKeccak256: Hmac {
+
+    /**
+     * Instantiates a new instance of [HmacKeccak256].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
+    @OptIn(InternalKotlinCryptoApi::class)
+    @Throws(IllegalArgumentException::class)
+    public constructor(key: ByteArray): super(key, "HmacKeccak256", Keccak256())
+
+    @OptIn(InternalKotlinCryptoApi::class)
+    private constructor(engine: Mac.Engine): super(engine)
+
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacKeccak256(engineCopy)
+}

library/hmac/hmac-sha3/src/commonMain/kotlin/org/kotlincrypto/macs/HmacKeccak384.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023 Matthew Nelson
+ *
+ * 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
+ *
+ *     https://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.
+ **/
+@file:Suppress("ClassName", "UnnecessaryOptInAnnotation")
+
+package org.kotlincrypto.macs
+
+import org.kotlincrypto.core.InternalKotlinCryptoApi
+import org.kotlincrypto.core.Mac
+import org.kotlincrypto.hash.sha3.Keccak384
+
+/**
+ * HmacKeccak384 implementation
+ * */
+public class HmacKeccak384: Hmac {
+
+    /**
+     * Instantiates a new instance of [HmacKeccak384].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
+    @OptIn(InternalKotlinCryptoApi::class)
+    @Throws(IllegalArgumentException::class)
+    public constructor(key: ByteArray): super(key, "HmacKeccak384", Keccak384())
+
+    @OptIn(InternalKotlinCryptoApi::class)
+    private constructor(engine: Mac.Engine): super(engine)
+
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacKeccak384(engineCopy)
+}

library/hmac/hmac-sha3/src/commonMain/kotlin/org/kotlincrypto/macs/HmacKeccak512.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright (c) 2023 Matthew Nelson
+ *
+ * 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
+ *
+ *     https://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.
+ **/
+@file:Suppress("ClassName", "UnnecessaryOptInAnnotation")
+
+package org.kotlincrypto.macs
+
+import org.kotlincrypto.core.InternalKotlinCryptoApi
+import org.kotlincrypto.core.Mac
+import org.kotlincrypto.hash.sha3.Keccak512
+
+/**
+ * HmacKeccak512 implementation
+ * */
+public class HmacKeccak512: Hmac {
+
+    /**
+     * Instantiates a new instance of [HmacKeccak512].
+     *
+     * @throws [IllegalArgumentException] if [key] is empty.
+     * */
+    @OptIn(InternalKotlinCryptoApi::class)
+    @Throws(IllegalArgumentException::class)
+    public constructor(key: ByteArray): super(key, "HmacKeccak512", Keccak512())
+
+    @OptIn(InternalKotlinCryptoApi::class)
+    private constructor(engine: Mac.Engine): super(engine)
+
+    protected override fun copy(engineCopy: Mac.Engine): Mac = HmacKeccak512(engineCopy)
+}