Add CryptoRand implementation (#28)

Author: 05nelsonm

README.md

@@ -3,6 +3,7 @@
 [![badge-latest-release]][url-latest-release]
 
 [![badge-kotlin]][url-kotlin]
+[![badge-error]][url-error]
 
 ![badge-platform-android]
 ![badge-platform-jvm]
@@ -96,6 +97,7 @@ dependencies {
 
 <!-- TAG_DEPENDENCIES -->
 [badge-kotlin]: https://img.shields.io/badge/kotlin-1.9.24-blue.svg?logo=kotlin
+[badge-error]: https://img.shields.io/badge/kotlincrypto.error-0.2.0-blue.svg
 
 <!-- TAG_PLATFORMS -->
 [badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
@@ -119,3 +121,4 @@ dependencies {
 [url-kotlin]: https://kotlinlang.org
 [url-rust-random]: https://github.com/rust-random/getrandom
 [url-version-catalog]: https://github.com/KotlinCrypto/version-catalog
+[url-error]: https://github.com/KotlinCrypto/error

benchmarks/README.md

@@ -1,7 +1,6 @@
 # benchmarks
 
-<!-- TODO: CryptoRand Issue #23 -->
-Benchmarks for tracking performance of `SecureRandom` implementation.
+Benchmarks for tracking performance of `CryptoRand` implementation.
 
 **NOTE:** Benchmarking is run on every Pull Request. Results can be viewed for each
 workflow run on the [GitHub Actions][url-actions] tab of the repository.
@@ -31,5 +30,4 @@ workflow run on the [GitHub Actions][url-actions] tab of the repository.
   ./gradlew nativeHostBenchmark
   ```
 
-<!-- TODO: CryptoRand Issue #23 -->
-[url-actions]: https://github.com/KotlinCrypto/secure-random/actions/
+[url-actions]: https://github.com/KotlinCrypto/crypto-rand/actions/

benchmarks/build.gradle.kts

@@ -54,7 +54,7 @@ kmpConfiguration {
             sourceSetMain {
                 dependencies {
                     implementation(libs.benchmark.runtime)
-                    implementation(project(":library:secure-random"))
+                    implementation(project(":library:crypto-rand"))
                 }
             }
         }

…ypto/benchmarks/SecureRandomBenchmark.kt …crypto/benchmarks/CryptoRandBenchmark.ktbenchmarks/src/commonMain/kotlin/org/kotlincrypto/benchmarks/SecureRandomBenchmark.kt renamed to benchmarks/src/commonMain/kotlin/org/kotlincrypto/benchmarks/CryptoRandBenchmark.kt benchmarks/src/commonMain/kotlin/org/kotlincrypto/benchmarks/SecureRandomBenchmark.kt renamed to benchmarks/src/commonMain/kotlin/org/kotlincrypto/benchmarks/CryptoRandBenchmark.kt

@@ -18,28 +18,24 @@
 package org.kotlincrypto.benchmarks
 
 import kotlinx.benchmark.*
-import org.kotlincrypto.SecureRandom
+import org.kotlincrypto.crypto.rand.CryptoRand
 
 @State(Scope.Benchmark)
 @BenchmarkMode(Mode.AverageTime)
 @OutputTimeUnit(BenchmarkTimeUnit.NANOSECONDS)
 @Warmup(iterations = 5, time = 2)
 @Measurement(iterations = 5, time = 3)
-open class SecureRandomBenchmark {
+open class CryptoRandBenchmark {
 
     private val buf = ByteArray(20)
 
     @Setup
     fun setup() {
-        SECURE_RANDOM.nextBytesCopyTo(buf)
+        CryptoRand.Default.nextBytes(buf)
     }
 
     @Benchmark
-    fun nextBytesCopyTo() {
-        SECURE_RANDOM.nextBytesCopyTo(buf)
-    }
-
-    private companion object {
-        private val SECURE_RANDOM = SecureRandom()
+    fun nextBytes() {
+        CryptoRand.Default.nextBytes(buf)
     }
 }

gradle/libs.versions.toml

@@ -5,16 +5,17 @@ gradle-kmp-configuration    = "0.3.2"
 gradle-kotlin               = "1.9.24"
 gradle-publish-maven        = "0.29.0"
 
-kotlinx-coroutines          = "1.8.1"
+kotlincrypto-error          = "0.2.0"
 
 [libraries]
 gradle-kmp-configuration    = { module = "io.matthewnelson:gradle-kmp-configuration-plugin", version.ref = "gradle-kmp-configuration" }
 gradle-kotlin               = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "gradle-kotlin" }
 gradle-publish-maven        = { module = "com.vanniktech:gradle-maven-publish-plugin", version.ref = "gradle-publish-maven" }
 
+kotlincrypto-error          = { module = "org.kotlincrypto:error", version.ref = "kotlincrypto-error" }
+
 # tests
 benchmark-runtime           = { module = "org.jetbrains.kotlinx:kotlinx-benchmark-runtime", version.ref = "gradle-benchmark" }
-kotlinx-coroutines-test     = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinx-coroutines" }
 
 [plugins]
 benchmark                   = { id = "org.jetbrains.kotlinx.benchmark", version.ref = "gradle-benchmark" }

library/crypto-rand/.gitignore

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

library/crypto-rand/api/crypto-rand.api

@@ -0,0 +1,20 @@
+public abstract class org/kotlincrypto/crypto/rand/CryptoRand {
+	public static final field Default Lorg/kotlincrypto/crypto/rand/CryptoRand$Default;
+	protected fun <init> ()V
+	public abstract fun nextBytes ([B)[B
+}
+
+public final class org/kotlincrypto/crypto/rand/CryptoRand$Default : org/kotlincrypto/crypto/rand/CryptoRand {
+	public fun nextBytes ([B)[B
+}
+
+public abstract interface annotation class org/kotlincrypto/crypto/rand/DelicateCryptoRandApi : java/lang/annotation/Annotation {
+}
+
+public final class org/kotlincrypto/crypto/rand/RNGException : java/security/GeneralSecurityException {
+	public fun <init> ()V
+	public fun <init> (Ljava/lang/String;)V
+	public fun <init> (Ljava/lang/String;Ljava/lang/Throwable;)V
+	public fun <init> (Ljava/lang/Throwable;)V
+}
+

library/crypto-rand/api/crypto-rand.klib.api

@@ -0,0 +1,28 @@
+// Klib ABI Dump
+// Targets: [androidNativeArm32, androidNativeArm64, androidNativeX64, androidNativeX86, iosArm64, iosSimulatorArm64, iosX64, js, linuxArm64, linuxX64, macosArm64, macosX64, mingwX64, tvosArm64, tvosSimulatorArm64, tvosX64, wasmJs, wasmWasi, watchosArm32, watchosArm64, watchosDeviceArm64, watchosSimulatorArm64, watchosX64]
+// Rendering settings:
+// - Signature version: 2
+// - Show manifest properties: true
+// - Show declarations: true
+
+// Library unique name: <org.kotlincrypto:crypto-rand>
+open annotation class org.kotlincrypto.crypto.rand/DelicateCryptoRandApi : kotlin/Annotation { // org.kotlincrypto.crypto.rand/DelicateCryptoRandApi|null[0]
+    constructor <init>() // org.kotlincrypto.crypto.rand/DelicateCryptoRandApi.<init>|<init>(){}[0]
+}
+
+abstract class org.kotlincrypto.crypto.rand/CryptoRand { // org.kotlincrypto.crypto.rand/CryptoRand|null[0]
+    constructor <init>() // org.kotlincrypto.crypto.rand/CryptoRand.<init>|<init>(){}[0]
+
+    abstract fun nextBytes(kotlin/ByteArray): kotlin/ByteArray // org.kotlincrypto.crypto.rand/CryptoRand.nextBytes|nextBytes(kotlin.ByteArray){}[0]
+
+    final object Default : org.kotlincrypto.crypto.rand/CryptoRand { // org.kotlincrypto.crypto.rand/CryptoRand.Default|null[0]
+        final fun nextBytes(kotlin/ByteArray): kotlin/ByteArray // org.kotlincrypto.crypto.rand/CryptoRand.Default.nextBytes|nextBytes(kotlin.ByteArray){}[0]
+    }
+}
+
+final class org.kotlincrypto.crypto.rand/RNGException : org.kotlincrypto.error/GeneralSecurityException { // org.kotlincrypto.crypto.rand/RNGException|null[0]
+    constructor <init>() // org.kotlincrypto.crypto.rand/RNGException.<init>|<init>(){}[0]
+    constructor <init>(kotlin/String?) // org.kotlincrypto.crypto.rand/RNGException.<init>|<init>(kotlin.String?){}[0]
+    constructor <init>(kotlin/String?, kotlin/Throwable?) // org.kotlincrypto.crypto.rand/RNGException.<init>|<init>(kotlin.String?;kotlin.Throwable?){}[0]
+    constructor <init>(kotlin/Throwable?) // org.kotlincrypto.crypto.rand/RNGException.<init>|<init>(kotlin.Throwable?){}[0]
+}

library/crypto-rand/build.gradle.kts

@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2025 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")
+}
+
+kmpConfiguration {
+    configureShared(java9ModuleName = "org.kotlincrypto.crypto.rand", publish = true) {
+        common {
+            sourceSetMain {
+                dependencies {
+                    api(libs.kotlincrypto.error)
+                }
+            }
+        }
+
+        kotlin {
+            with(sourceSets) {
+                val linuxMain = findByName("linuxMain")
+                val androidNativeMain = findByName("androidNativeMain")
+
+                if (linuxMain != null || androidNativeMain != null) {
+                    val linuxAndroidMain = maybeCreate("linuxAndroidMain").apply {
+                        dependsOn(getByName("unixMain"))
+                    }
+                    val linuxAndroidTest = maybeCreate("linuxAndroidTest").apply {
+                        dependsOn(getByName("unixTest"))
+                    }
+
+                    linuxMain?.apply { dependsOn(linuxAndroidMain) }
+                    findByName("linuxTest")?.apply { dependsOn(linuxAndroidTest) }
+
+                    androidNativeMain?.apply { dependsOn(linuxAndroidMain) }
+                    findByName("androidNativeTest")?.apply { dependsOn(linuxAndroidTest) }
+                }
+            }
+        }
+
+        kotlin {
+            with(sourceSets) {
+                val jsMain = findByName("jsMain")
+                val wasmJsMain = findByName("wasmJsMain")
+
+                if (jsMain != null || wasmJsMain != null) {
+                    val jsWasmJsMain = maybeCreate("jsWasmJsMain").apply {
+                        dependsOn(getByName("nonJvmMain"))
+                    }
+                    val jsWasmJsTest = maybeCreate("jsWasmJsTest").apply {
+                        dependsOn(getByName("nonJvmTest"))
+                    }
+
+                    jsMain?.apply { dependsOn(jsWasmJsMain) }
+                    findByName("linuxTest")?.apply { dependsOn(jsWasmJsTest) }
+
+                    wasmJsMain?.apply { dependsOn(jsWasmJsMain) }
+                    findByName("androidNativeTest")?.apply { dependsOn(jsWasmJsTest) }
+                }
+            }
+        }
+    }
+}

library/crypto-rand/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=crypto-rand
+POM_NAME=KotlinCrypto CryptoRand
+POM_DESCRIPTION=KotlinCrypto library for obtaining cryptographically secure random data from the system