Skip to content

scrypt: make Params output len customization optional #602

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 30, 2025

Conversation

tarcieri
Copy link
Member

This more or less goes back to the original API prior to when #255 added output length customization, adding a separate constructor function for adding length customization.

This keeps the output length out-of-the-way for users of the low-level scrypt::scrypt API. We've had several complaints about this (#415, #449, #596, #601), and hopefully this addresses them.

Additionally, since this functionality is only relevant to users of the password-hash API, it's feature-gated on that as well.

This more or less goes back to the original API prior to when #255 added
output length customization, adding a separate constructor function for
adding length customization.

This keeps the output length out-of-the-way for users of the low-level
`scrypt::scrypt` API. We've had several complaints about this
(#415, #449, #596, #601), and hopefully this addresses them.

Additionally, since this functionality is only relevant to users of the
`password-hash` API, it's feature-gated on that as well.
@tarcieri tarcieri requested a review from newpavlov May 29, 2025 13:41
@tarcieri tarcieri merged commit 2c641bf into master May 30, 2025
14 checks passed
@tarcieri tarcieri deleted the scrypt/make-params-output-len-optional branch May 30, 2025 16:58
tarcieri pushed a commit that referenced this pull request May 30, 2025
When scrypt used a dependency with `default-features = false`, the doc
compilation will fail because `password_hash::PasswordHasher` will be
unavailable (`password-hash` is only pulled `simple` feature is used).

It did not show up in CI, because `password-hash` is also provided as a
`dev-dependency` and is available when `cargo test` evaluates the
documentation.

Fixup #602
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.

1 participant