Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/KotlinCrypto/secure-random

A Kotlin Multiplatform library for obtaining cryptographically secure random data from system sources
https://github.com/KotlinCrypto/secure-random

android android-library cryptography cryptography-library java java-library kotlin kotlin-multiplatform kotlin-multiplatform-library kotlin-multiplatform-mobile

Last synced: about 1 month ago
JSON representation

A Kotlin Multiplatform library for obtaining cryptographically secure random data from system sources

Awesome Lists containing this project

README

        

# secure-random
[![badge-license]][url-license]
[![badge-latest-release]][url-latest-release]

[![badge-kotlin]][url-kotlin]

![badge-platform-android]
![badge-platform-jvm]
![badge-platform-js]
![badge-platform-js-node]
![badge-platform-wasm]
![badge-platform-linux]
![badge-platform-macos]
![badge-platform-ios]
![badge-platform-tvos]
![badge-platform-watchos]
![badge-platform-windows]
![badge-support-android-native]
![badge-support-apple-silicon]
![badge-support-js-ir]
![badge-support-linux-arm]

Kotlin Multiplatform library for obtaining cryptographically
secure random data from the system.

NOTE: For Jvm, `SecureRandom` extends `java.security.SecureRandom`
for interoperability.

The Linux/AndroidNative implementation was heavily inspired by
[rust-random/getrandom][url-rust-random].

### Example Usages

```kotlin
fun main() {
val sRandom = SecureRandom()

val bytes: ByteArray = try {
sRandom.nextBytesOf(count = 20)
} catch (e: SecRandomCopyException) {
e.printStackTrace()
return
}

println(bytes.toList())
}
```

```kotlin
fun main() {
val sRandom = SecureRandom()
val bytes = ByteArray(20)

try {
sRandom.nextBytesCopyTo(bytes)
} catch (e: SecRandomCopyException) {
e.printStackTrace()
return
}

println(bytes.toList())
}
```

### Samples

See the [sample](sample/README.md)

### Get Started

The best way to keep `KotlinCrypto` dependencies up to date is by using the
[version-catalog][url-version-catalog]. Alternatively, see below.

```kotlin
// build.gradle.kts
dependencies {
implementation("org.kotlincrypto:secure-random:0.3.2")
}
```

```groovy
// build.gradle
dependencies {
implementation "org.kotlincrypto:secure-random:0.3.2"
}
```

[badge-latest-release]: https://img.shields.io/badge/latest--release-0.3.2-blue.svg?style=flat
[badge-license]: https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat

[badge-kotlin]: https://img.shields.io/badge/kotlin-1.9.24-blue.svg?logo=kotlin

[badge-platform-android]: http://img.shields.io/badge/-android-6EDB8D.svg?style=flat
[badge-platform-jvm]: http://img.shields.io/badge/-jvm-DB413D.svg?style=flat
[badge-platform-js]: http://img.shields.io/badge/-js-F8DB5D.svg?style=flat
[badge-platform-js-node]: https://img.shields.io/badge/-nodejs-68a063.svg?style=flat
[badge-platform-linux]: http://img.shields.io/badge/-linux-2D3F6C.svg?style=flat
[badge-platform-macos]: http://img.shields.io/badge/-macos-111111.svg?style=flat
[badge-platform-ios]: http://img.shields.io/badge/-ios-CDCDCD.svg?style=flat
[badge-platform-tvos]: http://img.shields.io/badge/-tvos-808080.svg?style=flat
[badge-platform-watchos]: http://img.shields.io/badge/-watchos-C0C0C0.svg?style=flat
[badge-platform-wasm]: https://img.shields.io/badge/-wasm-624FE8.svg?style=flat
[badge-platform-windows]: http://img.shields.io/badge/-windows-4D76CD.svg?style=flat
[badge-support-android-native]: http://img.shields.io/badge/support-[AndroidNative]-6EDB8D.svg?style=flat
[badge-support-apple-silicon]: http://img.shields.io/badge/support-[AppleSilicon]-43BBFF.svg?style=flat
[badge-support-js-ir]: https://img.shields.io/badge/support-[js--IR]-AAC4E0.svg?style=flat
[badge-support-linux-arm]: http://img.shields.io/badge/support-[LinuxArm]-2D3F6C.svg?style=flat

[url-latest-release]: https://github.com/KotlinCrypto/secure-random/releases/latest
[url-license]: https://www.apache.org/licenses/LICENSE-2.0.txt
[url-kotlin]: https://kotlinlang.org
[url-rust-random]: https://github.com/rust-random/getrandom
[url-version-catalog]: https://github.com/KotlinCrypto/version-catalog