YoungBlood/libsodium_wasm_experimental
3
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Readme update

Browse Source
This commit is contained in:
Ugljesa Jovanovic 2020-05-21 14:23:45 +02:00 committed by Ugljesa Jovanovic
parent 67ab8fa46e
commit f9ddd7bc20
No known key found for this signature in database
GPG Key ID: 178E6DFCECCB0E0F
1 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -14,9 +14,8 @@ errors when using it.
**The API will move fast and break often until v1.0** **The API will move fast and break often until v1.0**
Make SHA hashes "updatable" like Blake2b Next step:
reduce ammount of allocations and introduce parallelization in Argon2
After that tenative plan is to add 25519 curve based signing and key exchange next.
## Should I use this in production? ## Should I use this in production?
@ -31,24 +30,22 @@ No.
This is an experimental implementation, mostly for expanding personal understanding of cryptography. This is an experimental implementation, mostly for expanding personal understanding of cryptography.
It's not peer reviewed, not guaranteed to be bug free, and not guaranteed to be secure. It's not peer reviewed, not guaranteed to be bug free, and not guaranteed to be secure.
## Integration ## Currently supported
### Hashing functions
## Hashing functions
* Blake2b * Blake2b
* SHA512 * SHA512
* SHA256 * SHA256
## Symmetric cipher ### Symmetric cipher
* AES * AES
* Modes: CBC, CTR * Modes: CBC, CTR
## Key Derivation ### Key Derivation
* Argon2 * Argon2
## AEAD ### AEAD
TODO() TODO()
@ -90,11 +87,11 @@ val input = "abc"
val result = Blake2b.digest(input) val result = Blake2b.digest(input)
``` ```
Result is returned as a `Array<Byte>` Result is returned as a `UByteArray`
##### Updatable instance version ##### Updatable instance version
You can create an instance and feed the data by using `update(input : Array<Byte>)` call. Once all data is supplied, You can create an instance and feed the data by using `update(input : UByteArray)` call. Once all data is supplied,
you should call `digest()` or `digestString()` convenience method that converts the `Array<Byte>` into hexadecimal string. you should call `digest()` or `digestString()` convenience method that converts the `UByteArray` into hexadecimal string.
If you want to use Blake2b with a key, you should supply it when creating the `Blake2b` instance. If you want to use Blake2b with a key, you should supply it when creating the `Blake2b` instance.
@ -111,8 +108,8 @@ After digest is called, the instance is reset and can be reused (Keep in mind ke
##### Stateless version ##### Stateless version
You need to deliver the complete data that is to be hashed in one go. You can either provide the `Array<Byte>` as input You need to deliver the complete data that is to be hashed in one go. You can either provide the `UByteArray` as input
or `String`. Result is always returned as `Array<Byte>` (At least in verision 0.0.1) or `String`. Result is always returned as `UByteArray` (At least in verision 0.0.1)
```kotlin ```kotlin
val input = "abc" val input = "abc"
@ -124,7 +121,7 @@ val input ="abc"
val result = Sha512.digest(message = input.encodeToByteArray().map { it.toUByte() }.toTypedArray()) val result = Sha512.digest(message = input.encodeToByteArray().map { it.toUByte() }.toTypedArray())
``` ```
Result is returned as a `Array<Byte>` Result is returned as a `UByteArray`
##### Updateable version ##### Updateable version