Skip to content

Document expose-internals removal, bring part of internals back as hazmat#352

Merged
tarcieri merged 3 commits intoRustCrypto:masterfrom
tchebb:add-hazmat
Jul 23, 2023
Merged

Document expose-internals removal, bring part of internals back as hazmat#352
tarcieri merged 3 commits intoRustCrypto:masterfrom
tchebb:add-hazmat

Conversation

@tchebb
Copy link
Copy Markdown
Contributor

@tchebb tchebb commented Jul 21, 2023

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.

Thomas Hebb added 3 commits July 21, 2023 16:53
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.
Copy link
Copy Markdown
Member

@tarcieri tarcieri left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks

@tarcieri tarcieri requested a review from dignifiedquire July 21, 2023 21:58
@tarcieri tarcieri merged commit eb7e507 into RustCrypto:master Jul 23, 2023
@tchebb tchebb deleted the add-hazmat branch September 29, 2023 18:52
@tarcieri tarcieri mentioned this pull request Oct 26, 2023
takumi-earth pushed a commit to earthlings-dev/RSA that referenced this pull request Jan 27, 2026
…pto#352)

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
the `aes` crate.

Fixes RustCrypto#351.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants