feat(basic-auth): add context key and callback options #4645
+309
−0
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
Add two new options to basicAuth middleware: - `usernameContextKey`: stores authenticated username in context - `true`: uses default key 'basicAuthUsername' - `string`: uses custom key name - `onAuthSuccess`: callback invoked after successful authentication This allows route handlers to access the authenticated username without re-parsing the Authorization header.
Add test cases for: - usernameContextKey with default key 'basicAuthUsername' - usernameContextKey with custom key - usernameContextKey not set (should not store username) - usernameContextKey with verifyUser mode - onAuthSuccess callback execution - onAuthSuccess async callback support - onAuthSuccess not called on failed auth - onAuthSuccess with verifyUser mode - Both options used together
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4645 +/- ##
=======================================
Coverage 91.45% 91.45%
=======================================
Files 173 173
Lines 11322 11342 +20
Branches 3279 3288 +9
=======================================
+ Hits 10354 10373 +19
- Misses 967 968 +1
Partials 1 1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
yusukebe
reviewed
Feb 2, 2026
| * - `true`: stores under the key `'basicAuthUsername'` | ||
| * - `string`: stores under the specified custom key | ||
| */ | ||
| usernameContextKey?: boolean | string |
Member
There was a problem hiding this comment.
usernameContextKey is needed? I think it is unnecessary. You can use the following method:
basicAuth({
username: 'hono',
password: 'secret',
onAuthSuccess: (c, username) => {
c.set('basicAuthUsername', username)
},
})It's simple.
Contributor
Author
There was a problem hiding this comment.
usernameContextKey is indeed just a shortcut, and you are right, we should keep it simple.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Close #4192
Add two new options to basicAuth middleware:
usernameContextKey: stores authenticated username in contexttrue: uses default key 'basicAuthUsername'string: uses custom key nameonAuthSuccess: callback invoked after successful authenticationThis allows route handlers to access the authenticated username without
re-parsing the Authorization header.
The author should do the following, if applicable
bun run format:fix && bun run lint:fixto format the code