change(jwt-auth): when algorithm is not RS256 or ES256, require the user to fill in secret#12611
Merged
SkyeYoung merged 6 commits intoSep 12, 2025
Conversation
… user to fill in secret
SkyeYoung
marked this pull request as ready for review
September 12, 2025 02:16
dosubot
Bot
added
size:M
SkyeYoung
changed the title
RS256 or ES256, require the user to fill in secretRS256 or ES256, require the user to fill in secret
nic-6443
reviewed
Sep 12, 2025
SkyeYoung
commented
Sep 12, 2025
|
|
||
| if conf.algorithm ~= "RS256" and conf.algorithm ~= "ES256" and not conf.secret then | ||
| conf.secret = ngx_encode_base64(resty_random.bytes(32, true)) | ||
| if (conf.algorithm == "HS256" or conf.algorithm == "HS512") and not conf.secret then |
Member
Author
There was a problem hiding this comment.
nic-6443
previously approved these changes
Sep 12, 2025
bzp2010
reviewed
Sep 12, 2025
Comment on lines
+1238
to
+1242
| if not ok then | ||
| ngx.say(err) | ||
| else | ||
| ngx.say("done") | ||
| end |
Contributor
There was a problem hiding this comment.
Just a suggestion: using assert is enough.
assert(ok, "HS256 but secret is not required")
bzp2010
approved these changes
Sep 12, 2025
bzp2010
left a comment
bzp2010
left a comment
Contributor
There was a problem hiding this comment.
Maybe this PR should be called change(jwt-auth): xxx 🤔
Member
Author
@bzp2010 This is not very common. I usually refer to https://github.com/TrigenSoftware/simple-release/blob/main/GUIDE.md Since this feature did not exist before, it should be |
membphis
approved these changes
Sep 12, 2025
nic-6443
approved these changes
Sep 12, 2025
Contributor
|
If the |
SkyeYoung
changed the title
RS256 or ES256, require the user to fill in secretRS256 or ES256, require the user to fill in secret
SkyeYoung
deleted the
young/feat/jwt-auth/error-msg-instead-of-gen-secret
branch
September 12, 2025 10:33
jizhuozhi
pushed a commit
to jizhuozhi/apisix
that referenced
this pull request
Oct 18, 2025
…he user to fill in `secret` (apache#12611)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
This PR is a part of #12603 and is separated out due to breaking changes.
Currently, the jwt-auth plugin generates a random value for
conf.secretin thecheck_schemafunction whenconf.algorithm ~= "RS256" and conf.algorithm ~= "ES256" and not conf.secret.Modifying the user-provided configuration can easily lead to user
confusion, which is clearly not best practice.
This also affects the diff logic in the adc that the apisix ingress
controller depends on.
I believe this generation behavior should be removed. To solve this problem, This PR removed the corresponding code and
instead return an error message, requiring users to fill in the
corresponding configuration themselves.
Which issue(s) this PR fixes:
Fixes #
Checklist