Document expose-internals removal, bring part of internals back as hazmat
#352
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
External access to these functions was removed in RustCrypto#304 when the old `internals` module and `expose-internals` feature were removed. There are some valid use cases for them, though (see RustCrypto#351), so let's bring back a subset of what was in `internals` using the same naming and documentation conventions that the aes crate uses for its hazardous functions. Much of the added or changed documentation is derived from that in aes. Fixes RustCrypto#351.
Merged
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.
As per the discussion in #351, some of these functions are useful to external users, but we want to make it absolutely clear that they're unsafe. Keep them behind a feature flag for that reason, and additionally add scary documentation inspired by what's already in the aes crate.
Please don't squash when merging if possible; the commits are split appropriately as is.
This contribution is on behalf of my company.