49 lines
1.1 KiB
Markdown
49 lines
1.1 KiB
Markdown
# hash-kt
|
|
|
|
`hash-kt` is a Kotlin Multiplatform library that provides common [Cryptographic Hash Functions](https://en.wikipedia.org/wiki/Cryptographic_hash_function).
|
|
|
|
Supported algorithms:
|
|
- MD5
|
|
- SHA-1
|
|
- SHA-2 (SHA-224, SHA-256, SHA-384, SHA-512)
|
|
- SHA-3 (SHA3-224, SHA3-256, SHA3-384, SHA3-512)
|
|
- SHAKE (SHAKE128, SHAKE256)
|
|
- Blake (Blake-224, Blake-256, Blake-384, Blake-512)
|
|
- Blake2 (Blake2s, Blake2b)
|
|
|
|
## Targets
|
|
|
|
| Target | Status |
|
|
|------------------|---------------|
|
|
| JVM | Supported |
|
|
| JavaScript | Supported |
|
|
| Native (Linux) | Supported |
|
|
| Native (Windows) | Not Supported |
|
|
|
|
## Installation
|
|
|
|
Add the following to your `build.gradle.kts`.
|
|
|
|
```kotlin
|
|
repositories {
|
|
maven("https://git.infendro.com/api/packages/Infendro/maven")
|
|
}
|
|
|
|
dependencies {
|
|
implementation("com.infendro:hash:1.3.2")
|
|
}
|
|
```
|
|
|
|
## Usage
|
|
|
|
```kotlin
|
|
import com.infendro.hash.sha2.`SHA-256`
|
|
|
|
fun main() {
|
|
// hash some value using SHA-256
|
|
val value = "Hello World!"
|
|
.encodeToByteArray().asUByteArray()
|
|
val hash = `SHA-256`.hash(value)
|
|
}
|
|
```
|