Document changes to 'Encrypted Streams' API made in #39 #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
andreiled
commented
Jul 25, 2020
andreiled
commented
Jul 25, 2020
| @@ -70,10 +70,7 @@ | |||
| * [Encrypted streams](SodiumPlus/encrypted-streams.md) | |||
| * [crypto_secretstream_xchacha20poly1305_init_push](SodiumPlus/encrypted-streams.md#crypto_secretstream_xchacha20poly1305_init_push) | |||
| * [crypto_secretstream_xchacha20poly1305_init_pull](SodiumPlus/encrypted-streams.md#crypto_secretstream_xchacha20poly1305_init_pull) | |||
| * [crypto_secretstream_xchacha20poly1305_push](SodiumPlus/encrypted-streams.md#crypto_secretstream_xchacha20poly1305_push) | |||
| * [crypto_secretstream_xchacha20poly1305_pull](SodiumPlus/encrypted-streams.md#crypto_secretstream_xchacha20poly1305_pull) | |||
There was a problem hiding this comment.
Please note that I am removing description of these methods since they are no longer directly usable as one needs to have access to the backend-specific state to use them which is now wrapped by the init_* method and is no longer accessible to the API users.
andreiled
force-pushed
the
feature/better_secretstream
branch
4 times, most recently
from
bbbd5c9
to
c94e6ac
Compare
andreiled
force-pushed
the
feature/better_secretstream
branch
from
c94e6ac
to
a245226
Compare
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` methods
4. Update sample for stream encryption/decryption
andreiled
force-pushed
the
feature/better_secretstream
branch
from
a245226
to
a213357
Compare
andreiled
changed the title
|
@paragonie-scott, could you take a look at this documentation follow-up for the previously merged #39? |
|
The typescript return types need some updating as well. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document changes to 'Encrypted Streams' API made in #39
crypto_secretstream_xchacha20poly1305_init_*methods documentation to indicate that they both asynchronously return a Stream Encryptor/Decryptor object completely encapsulating the backend-specific statecrypto_secretstream_xchacha20poly1305_pushcrypto_secretstream_xchacha20poly1305_pullcrypto_secretstream_xchacha20poly1305_rekey