Documentation Layout
paragonie-scott opened this issue · comments
How does this sound as a basic outline?
- Introduction
- What is Libsodium?
- Terms and Concepts
- Installing Libsodium and the PHP extension
- Quick Start Guide
- Which tool to use, for which purpose?
- Random data
- Utilities and Helpers
bin2hex()
/hex2bin()
memzero()
increment()
memcmp()
- Basic Secret-key Cryptography
crypto_secretbox()
crypto_auth()
- Basic Public-key Cryptography
crypto_box()
crypto_sign()
- Hashing
crypto_generichash()
crypto_shorthash()
- Password Hashing
crypto_pwhash()
(when available)crypto_pwhash_scryptsalsa208sha256_str()
- Advanced
crypto_aead_*()
crypto_scalarmult()
crypto_stream()
crypto_stream_xor()
crypto_box_seal()
crypto_kx()
- Key conversion (get publickey from secretkey, get keypair from seed, etc.)
- Recipes
- Put some common use-cases here (e.g. encrypted cookies, sealed logs)
Sounds really good!