net: websocket: pass request context to callback #83597
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
zephyrbot
added
area: HTTP
zephyrbot
requested review from
carlescufi,
fabiobaltieri,
jakub-uC,
jukkar,
kartben,
nashif and
rlubos
mrodgers-witekio
force-pushed
the
websocket_pass_request_headers_to_callback
branch
from
e0df52b to
2229c90
Compare
rlubos
previously approved these changes
Jan 8, 2025
Passing HTTP upgrade request context to the user callback allows the user to decide whether to accept or reject the websocket connection based on the HTTP headers in the request. The primary reason for this is to enable authentication of the websocket connection (e.g. via cookies or Authorization header). Signed-off-by: Matt Rodgers <[email protected]>
Update HTTP server documentation and migration guide to account for added request_ctx parameter to the http_resource_websocket_cb_t callback. Signed-off-by: Matt Rodgers <[email protected]>
mrodgers-witekio
force-pushed
the
websocket_pass_request_headers_to_callback
branch
from
2229c90 to
15f48a3
Compare
Good spot, updated this and also removed the |
rlubos
approved these changes
Jan 8, 2025
I don'tt think they're needed either, probably just some copy-paste leftover. |
kartben
approved these changes
Jan 8, 2025
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.
When upgrading an HTTP1 connection to a websocket, pass the HTTP request context associated with the upgrade request to the user callback.
This allows the user callback to access URL query parameters and HTTP headers. The main motivation behind this is to allow for authentication via the headers before the application decides whether to accept or reject the websocket connection, but it could also be used to provide any other context needed on opening the connection (e.g.
Sec-WebSocket-Protocolheader).