paragonie / pecl-libsodium-doc

Free Online Documentation for the Libsodium PHP Extension
https://paragonie.com/book/pecl-libsodium
Creative Commons Attribution 4.0 International
88 stars 11 forks source link

Documentation Layout #1

Closed paragonie-scott closed 8 years ago

paragonie-scott commented 8 years ago

How does this sound as a basic outline?

  1. Introduction
    • What is Libsodium?
    • Terms and Concepts
    • Installing Libsodium and the PHP extension
  2. Quick Start Guide
    • Which tool to use, for which purpose?
  3. Random data
  4. Utilities and Helpers
    • bin2hex()/hex2bin()
    • memzero()
    • increment()
    • memcmp()
  5. Basic Secret-key Cryptography
    • crypto_secretbox()
    • crypto_auth()
  6. Basic Public-key Cryptography
    • crypto_box()
    • crypto_sign()
  7. Hashing
    • crypto_generichash()
    • crypto_shorthash()
  8. Password Hashing
    • crypto_pwhash() (when available)
    • crypto_pwhash_scryptsalsa208sha256_str()
  9. 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.)
  10. Recipes
    • Put some common use-cases here (e.g. encrypted cookies, sealed logs)
jedisct1 commented 8 years ago

Sounds really good!