Merge pull request '1.5.0 Release' (#5) from develop into main

Reviewed-on: Infendro/mac-kt#5

.gitea/workflows/main.yaml

@@ -1,36 +0,0 @@
-on:
-  push:
-    branches:
-      - main
-
-env:
-  GIT__TOKEN: ${{ secrets.TOKEN }}
-
-jobs:
-  publish:
-    runs-on: linux
-    steps:
-      - uses: actions/checkout@v4
-
-      - uses: actions/cache/restore@v4
-        with:
-          key: gradle
-          path: |
-            ~/.gradle/caches/
-            ~/.gradle/wrapper/
-            ~/.konan/
-
-      - uses: actions/setup-java@v4
-        with:
-          java-version: '24'
-          distribution: 'temurin'
-
-      - run: ./gradlew publish
-
-      - uses: actions/cache/save@v4
-        with:
-          key: gradle
-          path: |
-            ~/.gradle/caches/
-            ~/.gradle/wrapper/
-            ~/.konan/

.gitea/workflows/publish.yaml

@@ -0,0 +1,47 @@
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  publish:
+    runs-on: linux
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          java-version: '24'
+          distribution: 'temurin'
+
+      - name: Cache Gradle
+        uses: actions/cache@v4
+        with:
+          key: gradle-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: gradle
+          path: |
+            ~/.gradle/caches/
+            ~/.gradle/wrapper/
+
+      - name: Cache Konan
+        uses: actions/cache@v4
+        with:
+          key: konan-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: konan
+          path: |
+            ~/.konan/
+
+      - name: Cache Node
+        uses: actions/cache@v4
+        with:
+          key: node-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: node
+          path: |
+            ~/.gradle/nodejs
+            ~/.gradle/yarn
+
+      - name: Publish
+        run: ./gradlew publish
+        env:
+          INFENDRO__TOKEN: ${{ secrets.TOKEN }}

.gitea/workflows/test.yaml

@@ -0,0 +1,28 @@
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: linux
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Java
+        uses: actions/setup-java@v4
+        with:
+          java-version: '24'
+          distribution: 'temurin'
+
+      - name: Cache Gradle
+        uses: actions/cache@v4
+        with:
+          key: gradle-${{ hashFiles('**/libs.versions.toml') }}
+          restore-keys: gradle
+          path: |
+            ~/.gradle/caches/
+            ~/.gradle/wrapper/
+
+      - name: Test
+        run: ./gradlew jvmTest

README.md

@@ -1,15 +1,9 @@
-# Kotlin MAC
+# mac-kt
 
-This library provides various [Message Authentication Code](https://en.wikipedia.org/wiki/Message_authentication_code) implementations in Kotlin Multiplatform.
+`mac-kt` is a Kotlin Multiplatform library that provides common [Message Authentication Codes](https://en.wikipedia.org/wiki/Message_authentication_code).
 
-## Features
+Supported algorithms:
-
+- HMAC
-* Generate message authentication codes.
-    * [HMAC](https://en.wikipedia.org/wiki/HMAC)
-* Multiplatform support
-    * JVM
-    * JavaScript
-    * Native (Linux)
 
 ## Installation
 
@@ -21,19 +15,16 @@ repositories {
 }
 
 dependencies {
-    implementation("com.infendro:mac:1.2.2")
+    implementation("com.infendro:mac:1.5.0")
 }
 ```
 
 ## Usage
 
 ```kotlin
-import com.infendro.hash.SHA1
-import com.infendro.mac.HMAC
-
 fun main() {
     // create an HMAC instance using SHA1
-    val hmac = HMAC(SHA1)
+    val hmac = HMAC(SHA1())
 
     // generate MAC
     val key = "secret".encodeToByteArray()

build.gradle.kts

@@ -1,60 +1,45 @@
-group = "com.infendro"
+@file:OptIn(ExperimentalWasmDsl::class)
-version = "1.2.1"
 
-repositories {
+import com.infendro.plugin.infendro
-    maven("https://git.infendro.com/api/packages/Infendro/maven")
+import com.infendro.plugin.token
-    mavenCentral()
+import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
-}
+
+group = "com.infendro"
+version = "1.5.0"
 
 plugins {
+    alias(libs.plugins.infendro)
     alias(libs.plugins.multiplatform)
     id("maven-publish")
 }
 
 kotlin {
     jvm()
-    js {
-        nodejs()
-    }
     linuxX64()
+    linuxArm64()
+    mingwX64()
+    macosX64()
+    macosArm64()
+    js { nodejs() }
+    wasmJs { nodejs() }
+    wasmWasi { nodejs() }
+
+    repositories {
+        infendro()
+        mavenCentral()
+    }
 
     sourceSets {
         commonMain.dependencies {
+            implementation(libs.bytes)
             implementation(libs.hash)
-            implementation(libs.bytearray)
-        }
-    }
-
-    compilerOptions {
-        freeCompilerArgs.add("-opt-in=kotlin.ExperimentalUnsignedTypes")
-    }
-}
-
-publishing {
-    repositories {
-        maven {
-            url = uri("https://git.infendro.com/api/packages/Infendro/maven")
-            authentication.create("header", HttpHeaderAuthentication::class)
-            credentials(HttpHeaderCredentials::class) {
-                val token = secret("git.token") ?: throw GradleException()
-
-                name = "Authorization"
-                value = "token $token"
         }
+        commonTest.dependencies {
+            implementation(libs.test)
         }
     }
 }
 
-fun secret(
+publishing.repositories {
-    key: String,
+    infendro(token)
-): String? {
-    val property = key
-    val environment = key
-        .uppercase()
-        .replace(".", "__")
-
-    val prop = properties[property] as String?
-    val env = System.getenv(environment)
-
-    return prop ?: env
 }

gradle/libs.versions.toml

@@ -1,11 +1,14 @@
 [versions]
-kotlin = "2.1.20"
+infendro = "1.1.0"
-hash = "1.3.1"
+kotlin = "2.3.0"
-bytearray = "1.2.1"
+bytes = "1.4.1"
+hash = "1.7.0"
 
 [plugins]
+infendro = { id = "com.infendro.plugin", version.ref = "infendro" }
 multiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
 
 [libraries]
+bytes = { module = "com.infendro:bytes", version.ref = "bytes" }
 hash = { module = "com.infendro:hash", version.ref = "hash" }
-bytearray = { module = "com.infendro:bytearray", version.ref = "bytearray" }
+test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }

settings.gradle.kts

@@ -1 +1,6 @@
 rootProject.name = "mac"
+
+pluginManagement.repositories {
+    maven("https://git.infendro.com/api/packages/Infendro/maven")
+    mavenCentral()
+}

src/commonMain/kotlin/com/infendro/mac/HMAC.kt

@@ -1,33 +1,63 @@
 package com.infendro.mac
 
-import com.infendro.bytearray.padEnd
+import com.infendro.bytes.bytearray.xorInto
 import com.infendro.hash.HashFunction
 
 class HMAC(
     val function: HashFunction,
-) : MAC() {
+) : MAC(function.bytes) {
-    override val bytes: Int
+    private var initialized = false
-        get() = function.bytes
+    private val innerPadding: ByteArray = ByteArray(function.block)
+    private val outerPadding: ByteArray = ByteArray(function.block)
+    private val inner: ByteArray = ByteArray(function.bytes)
 
-    override fun hash(
+    override fun reset() {
-        key: UByteArray,
+        function.reset()
-        value: UByteArray,
+        initialized = false
-    ): UByteArray {
+        innerPadding.fill(0x00)
-        val paddedKey = pad(key)
+        outerPadding.fill(0x00)
-
-        val innerKey = paddedKey.map { it xor 0x36U }.toUByteArray()
-        val outerKey = paddedKey.map { it xor 0x5CU }.toUByteArray()
-
-        return function.hash(outerKey + function.hash(innerKey + value))
     }
 
-    private fun pad(
+    override fun init(key: ByteArray) {
-        key: UByteArray,
+        val padded = pad(key)
-    ): UByteArray {
+        padded.xorInto(0x36, innerPadding)
-        return when {
+        padded.xorInto(0x5C, outerPadding)
-            key.size > function.block -> function.hash(key).padEnd(function.block, 0x00U)
+
-            key.size < function.block -> key.padEnd(function.block, 0x00U)
+        function.reset()
-            else -> key
+        function.update(innerPadding)
-        }
+
+        initialized = true
+    }
+
+    override fun update(byte: Byte) {
+        require(initialized)
+
+        function.update(byte)
+    }
+
+    override fun update(bytes: ByteArray) {
+        require(initialized)
+
+        function.update(bytes)
+    }
+
+    override fun digestInto(destination: ByteArray, destinationOffset: Int) {
+        require(initialized)
+
+        function.digestInto(inner)
+        function.update(outerPadding)
+        function.update(inner)
+        function.digestInto(destination, destinationOffset)
+
+        function.update(innerPadding)
+    }
+
+    private fun pad(key: ByteArray): ByteArray {
+        val padded = ByteArray(function.block)
+        when {
+            key.size > function.block -> function.hashInto(key, padded)
+            else -> key.copyInto(padded)
+        }
+        return padded
     }
 }

src/commonMain/kotlin/com/infendro/mac/MAC.kt

@@ -1,14 +1,38 @@
 package com.infendro.mac
 
-abstract class MAC {
+abstract class MAC(
-    abstract val bytes: Int
+    val bytes: Int,
-
+) {
-    @Suppress("UNUSED")
     val bits: Int
         get() = bytes * 8
 
-    abstract fun hash(
+    abstract fun reset()
-        key: UByteArray,
+
-        value: UByteArray,
+    abstract fun init(key: ByteArray)
-    ): UByteArray
+
+    abstract fun update(byte: Byte)
+    abstract fun update(bytes: ByteArray)
+
+    abstract fun digestInto(destination: ByteArray, destinationOffset: Int = 0)
+
+    fun digest(): ByteArray {
+        val result = ByteArray(bytes)
+        digestInto(result)
+        return result
+    }
+
+    fun hashInto(key: ByteArray, value: ByteArray, destination: ByteArray, destinationOffset: Int = 0) {
+        init(key)
+        update(value)
+        digestInto(destination, destinationOffset)
+        reset()
+    }
+
+    fun hash(key: ByteArray, value: ByteArray): ByteArray {
+        init(key)
+        update(value)
+        val result = digest()
+        reset()
+        return result
+    }
 }

src/commonTest/kotlin/com/infendro/mac/HMAC.kt

@@ -0,0 +1,31 @@
+package com.infendro.mac
+
+import com.infendro.hash.sha2.`SHA-256`
+import kotlin.test.Test
+import kotlin.test.assertContentEquals
+import kotlin.test.assertEquals
+
+class `HMAC Test` {
+    val hmac = HMAC(`SHA-256`())
+
+    @Test
+    fun bytes() {
+        assertEquals(32, hmac.bytes)
+        assertEquals(256, hmac.bits)
+    }
+
+    @Test
+    fun example() {
+        val expected = byteArrayOf(
+            -0x09, -0x44, -0x7d, -0x0c, +0x30, +0x53, -0x7c, +0x24,
+            -0x4f, +0x32, -0x68, -0x1a, -0x56, +0x6f, -0x4f, +0x43,
+            -0x11, +0x4d, +0x59, -0x5f, +0x49, +0x46, +0x17, +0x59,
+            -0x69, +0x47, -0x63, -0x44, +0x2d, +0x1a, +0x3c, -0x28,
+        )
+        val actual = hmac.hash(
+            "key".encodeToByteArray(),
+            "The quick brown fox jumps over the lazy dog".encodeToByteArray(),
+        )
+        assertContentEquals(expected, actual)
+    }
+}