Compare commits

..

4 Commits

Author SHA1 Message Date
a5c54ed16c replace IllegalArgumentException with require 2025-12-14 00:17:29 +01:00
f3a2e18d2e fix README 2025-12-13 23:52:51 +01:00
20d031fba6 update README 2025-12-13 23:51:23 +01:00
d4be1689e2 optimize nextBytes() 2025-12-13 23:51:08 +01:00
4 changed files with 38 additions and 20 deletions

View File

@@ -1,18 +1,21 @@
# Kotlin OTP # prng-kt
This library provides various [Pseudorandom Number Generator](https://en.wikipedia.org/wiki/Pseudorandom_number_generator) `prng-kt` is a Kotlin Multiplatform library that provides common pseudorandom number generators.
implementations in Kotlin Multiplatform.
## Features Supported PRNGs:
- LCG
* Generate random numbers using Kotlin's Random interface. Supported CSPRNGs:
* Seed the PRNGs to receive predictable results. - HMAC DRBG
* Reseed the PRNGs to add entropy to the following results.
* [HMAC DRBG](https://en.wikipedia.org/wiki/NIST_SP_800-90A#Hash_DRBG_and_HMAC_DRBG) ## Targets
* Multiplatform support
* JVM | Target | Status |
* JavaScript |------------------|---------------|
* Native (Linux) | JVM | Supported |
| JavaScript | Supported |
| Native (Linux) | Supported |
| Native (Windows) | Not Supported |
## Installation ## Installation
@@ -24,19 +27,19 @@ repositories {
} }
dependencies { dependencies {
implementation("com.infendro:random:1.1.0") implementation("com.infendro:prng:1.2.0")
} }
``` ```
## Usage ## Usage
```kotlin ```kotlin
import com.infendro.hash.SHA256 import com.infendro.hash.sha2.`SHA-256`
import com.infendro.random.PRNG import com.infendro.random.csprng.CSPRNG
fun main() { fun main() {
// create a PRNG instance // create a PRNG instance
val rng = PRNG.HMAC(SHA256) val rng = CSPRNG.HMAC(`SHA-256`)
// seed the PRNG to receive predictable results // seed the PRNG to receive predictable results
rng.seed(/* some seed */) rng.seed(/* some seed */)

View File

@@ -35,7 +35,6 @@ class HMAC internal constructor(
val bytes = buildList { val bytes = buildList {
while (size < count) { while (size < count) {
v = hmac.hash(k, v) v = hmac.hash(k, v)
addAll(v.take(min(count - size, function.bytes))) addAll(v.take(min(count - size, function.bytes)))
} }
}.toUByteArray() }.toUByteArray()

View File

@@ -26,7 +26,6 @@ class LCG internal constructor() : PRNG() {
return buildList { return buildList {
while (size < count) { while (size < count) {
x = (a * x + c) % m x = (a * x + c) % m
addAll(x.toUByteArray().takeLast(min(count - size, 6))) addAll(x.toUByteArray().takeLast(min(count - size, 6)))
} }
}.toUByteArray() }.toUByteArray()

View File

@@ -15,12 +15,29 @@ abstract class PRNG : Random() {
override fun nextBits( override fun nextBits(
bitCount: Int, bitCount: Int,
): Int { ): Int {
if (bitCount !in 0..32) throw Exception() require(bitCount in 0..32)
if (bitCount == 0) return 0
if (bitCount == 0) return 0
return generate(4).toInt() ushr (32 - bitCount) return generate(4).toInt() ushr (32 - bitCount)
} }
override fun nextBytes(
array: ByteArray,
fromIndex: Int,
toIndex: Int,
): ByteArray {
require(fromIndex in 0..array.size && toIndex in 0..array.size)
require(fromIndex <= toIndex)
val size = toIndex - fromIndex
val bytes = generate(size).asByteArray()
for (i in 0..<size) {
array[i + fromIndex] = bytes[i]
}
return array
}
companion object { companion object {
fun LCG() = com.infendro.random.prng.LCG() fun LCG() = com.infendro.random.prng.LCG()
} }