crypto: remove ERR_CRYPTO_SCRYPT_INVALID_PARAMETER #53305
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
It is confusing to have both ERR_CRYPTO_SCRYPT_INVALID_PARAMETER and ERR_CRYPTO_INVALID_SCRYPT_PARAMS. The former was the original error code, added in 371103d, but parameter validation gradually changed and now produces ERR_CRYPTO_INVALID_SCRYPT_PARAMS for all parameter validation errors coming from OpenSSL, as well as different error codes for validation errors coming from JavaScript. The only remaining use of ERR_CRYPTO_SCRYPT_INVALID_PARAMETER is in the validation logic that ensures that no two synonymous options were passed. We already have an error code for that particular case, ERR_INCOMPATIBLE_OPTION_PAIR, so replace these last instances of ERR_CRYPTO_SCRYPT_INVALID_PARAMETER with that error code and remove ERR_CRYPTO_SCRYPT_INVALID_PARAMETER. If there ever is need again for such an error code, we can just use ERR_CRYPTO_INVALID_SCRYPT_PARAMS. Refs: nodejs#35093 Refs: nodejs#21525 Refs: nodejs#20816
tniessen
added
crypto
|
Review requested:
|
nodejs-github-bot
added
errors
jasnell
approved these changes
Jun 3, 2024
panva
approved these changes
Jun 3, 2024
lpinca
approved these changes
Jun 3, 2024
github-actions
bot
removed
the
request-ci
This comment was marked as outdated.
This comment was marked as outdated.
panva
added
the
author ready
|
cc @nodejs/tsc since this is semver-major, strictly speaking. |
|
This PR has been waiting for a second approval from @nodejs/tsc for more than a month. CitGM: https://ci.nodejs.org/view/Node.js-citgm/job/citgm-smoker/3452/ |
richardlau
approved these changes
Jul 10, 2024
benjamingr
approved these changes
Jul 10, 2024
tniessen
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 33a6d1f |
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.
It is confusing to have both
ERR_CRYPTO_SCRYPT_INVALID_PARAMETERandERR_CRYPTO_INVALID_SCRYPT_PARAMS. The former was the original error code, added in 371103d, but parameter validation gradually changed and now producesERR_CRYPTO_INVALID_SCRYPT_PARAMSfor all parameter validation errors coming from OpenSSL, as well as different error codes for validation errors coming from JavaScript.The only remaining use of
ERR_CRYPTO_SCRYPT_INVALID_PARAMETERis in the validation logic that ensures that no two synonymous options were passed. We already have an error code for that particular case,ERR_INCOMPATIBLE_OPTION_PAIR, so replace these last instances ofERR_CRYPTO_SCRYPT_INVALID_PARAMETERwith that error code and removeERR_CRYPTO_SCRYPT_INVALID_PARAMETER. If there ever is need again for such an error code, we can just useERR_CRYPTO_INVALID_SCRYPT_PARAMS.This also improves the error messages where Node.js would previously throw
ERR_CRYPTO_SCRYPT_INVALID_PARAMETER.Refs: #35093
Refs: #21525
Refs: #20816