Baguette/sodium.cr
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation. [skip ci]

Browse Source
This commit is contained in:
Didactic Drunk 2019-06-28 13:44:33 -07:00
parent 95ee0e63b1
commit b50e068b43
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -16,10 +16,10 @@ Updated Crystal bindings for the [libsodium API](https://libsodium.gitbook.io/do
- [x] [Combined mode](https://libsodium.gitbook.io/doc/secret-key_cryptography/authenticated_encryption) - [x] [Combined mode](https://libsodium.gitbook.io/doc/secret-key_cryptography/authenticated_encryption)
- [ ] [Detached mode](https://libsodium.gitbook.io/doc/secret-key_cryptography/authenticated_encryption) - [ ] [Detached mode](https://libsodium.gitbook.io/doc/secret-key_cryptography/authenticated_encryption)
- [AEAD](https://libsodium.gitbook.io/doc/secret-key_cryptography/aead) - [AEAD](https://libsodium.gitbook.io/doc/secret-key_cryptography/aead)
- [ ] AES256-GCM (Requires hardware acceleration) - [ ] AES256-GCM (Requires hardware acceleration)
- [ ] XChaCha20-Poly1305-IETF - [ ] XChaCha20-Poly1305-IETF
- [ ] ChaCha20-Poly1305-IETF - [ ] ChaCha20-Poly1305-IETF
- [ ] ChaCha20-Poly1305 - [ ] ChaCha20-Poly1305
- [Hashing](https://libsodium.gitbook.io/doc/hashing) - [Hashing](https://libsodium.gitbook.io/doc/hashing)
- [x] ☑ [Blake2b](https://libsodium.gitbook.io/doc/hashing/generic_hashing) - [x] ☑ [Blake2b](https://libsodium.gitbook.io/doc/hashing/generic_hashing)
- [ ] [SipHash](https://libsodium.gitbook.io/doc/hashing/short-input_hashing) - [ ] [SipHash](https://libsodium.gitbook.io/doc/hashing/short-input_hashing)
@ -77,10 +77,11 @@ dependencies:
| `Cox::Cipher::Chalsa` | What goes with guacamole? | | `Cox::Cipher::Chalsa` | What goes with guacamole? |
| Everything else | I want to design my own crypto protocol and probably do it wrong. | | Everything else | I want to design my own crypto protocol and probably do it wrong. |
The `specs` provide the best examples of how to use or misuse this shard.
## Usage ## Usage
The `specs` provide the best examples of how to use or misuse this shard.
### CryptoBox easy encryption ### CryptoBox easy encryption
```crystal ```crystal
require "cox" require "cox"