paragonie / sodium-plus

Developer-friendly libsodium interface
Other
170 stars 21 forks source link

Document changes to 'Encrypted Streams' API made in #39 #41

Open andreiled opened 4 years ago

andreiled commented 4 years ago

Document changes to 'Encrypted Streams' API made in #39

  1. Update crypto_secretstream_xchacha20poly1305_init_* methods documentation to indicate that they both asynchronously return a Stream Encryptor/Decryptor object completely encapsulating the backend-specific state
  2. Document properties and methods available in the Stream Encryptor/Decryptor objects
  3. Remove documentation for private methods that can no longer be used directly as they require access to the underlying backend-specific state encapsulated by the Stream Encryptor/Decryptor objects:
    • crypto_secretstream_xchacha20poly1305_push
    • crypto_secretstream_xchacha20poly1305_pull
    • crypto_secretstream_xchacha20poly1305_rekey
  4. Update sample for stream encryption/decryption
andreiled commented 4 years ago
andreiled commented 4 years ago

@paragonie-scott, could you take a look at this documentation follow-up for the previously merged #39?

stevenroussey-privicy commented 4 years ago

The typescript return types need some updating as well.