feat: auth plugins respond with www-authenticate header with realm
#12864
+858
−6
Conversation
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
Signed-off-by: Abhishek Choudhary <[email protected]>
nic-6443
reviewed
Jan 6, 2026
Signed-off-by: Abhishek Choudhary <[email protected]>
dosubot
bot
added
size:XL
nic-6443
previously approved these changes
Jan 6, 2026
membphis
reviewed
Jan 7, 2026
apisix/plugins/basic-auth.lua
Outdated
| default = false, | ||
| }, | ||
| realm = { | ||
| type = "string", |
Member
There was a problem hiding this comment.
it can not contain any ', "
maybe we should limit it
apisix/plugins/ldap-auth.lua
Outdated
| tls_verify = { type = "boolean", default = false }, | ||
| uid = { type = "string", default = "cn" } | ||
| uid = { type = "string", default = "cn" }, | ||
| realm = { type = "string", default = "ldap" } |
Member
There was a problem hiding this comment.
we can add a , at the end of this line always
Signed-off-by: Abhishek Choudhary <[email protected]>
Signed-off-by: Abhishek Choudhary <[email protected]>
membphis
previously approved these changes
Jan 7, 2026
nic-6443
previously approved these changes
Jan 8, 2026
Signed-off-by: Abhishek Choudhary <[email protected]>
shreemaan-abhishek
dismissed stale reviews from nic-6443 and membphis
via
ce57ee7
membphis
previously approved these changes
Jan 8, 2026
Signed-off-by: Abhishek Choudhary <[email protected]>
nic-6443
approved these changes
Jan 8, 2026
membphis
approved these changes
Jan 8, 2026
Baoyuantop
approved these changes
Jan 8, 2026
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 adds a realm configuration option to several authentication plugins (basic-auth, key-auth, hmac-auth, jwt-auth, ldap-auth). This allows users to customize the realm value returned in the WWW-Authenticate header when an authentication request fails with a 401 Unauthorized status.
This is in line with standard concept in the HTTP authentication protocol (RFC 7235). It indicates to the client which "protection area" the currently requested resource belongs to. This helps the client (such as a browser or API client) determine which set of credentials to use to re-initiate the request.
Checklist