Update symmetric key API documentation #631
Merged
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
Reuse common test suite for Secure Cell modes with symmetric keys. Update them to use SymmetricKey instead of passphrases to avoid giving incorrect ideas that you can use short passphrases with key API. Yes, you *can* pass strings to this API but you shouldn't. There is no easy way to forbid that since &str implements AsRef<[u8]> and this is kinda fundamental property of strings in Rust. Even if we accepted &[u8] directly, users can still easily pass strings there.
Similarly, update documentation for existing methods to match the one used for passphrase API. Use properly generated symmetric keys there, setting a good example. Note passphrase API in the top-level docs too.
ilammy
added
docs 📚
|
@karenswry, I know that you're working on something in RustThemis docs too. I don't see any conflicts with your branch right now, but this is a heads up about some changed files that might cause conflicts later. Please consider syncing with master once this PR is merged. |
vixentael
approved these changes
Apr 29, 2020
Co-authored-by: vixentael <[email protected]>
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.
This is a companion PR for #630, updating existing symmetric key API documentation, code examples, and tests to correctly use symmetric keys, not passphrases. Various bits of documentation are also updated and unified.
On the one hand, this is a lot of API documentation, much more extensive than any other wrapper has. On the other hand, I find it valuable for those who don't ever bother browsing third-party documentation sites. Plus, it's kinda dishonest to lower the quality bar.
Checklist
Changelog is updated(nothing notable)