[websocket] Support token authentication through header #4515
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.
Closes #4490.
Browser clients do not have the ability to set an
Authorization
header programatically on websocket requests. All they have control over is the URL and the websocket subprotocols sent (see https://developer.mozilla.org/en-US/docs/Web/API/WebSocket)This PR adds support for specifying a bearer token via a websocket subprotocol, with the format
org.openhab.ws.accessToken.base64.<encoded-token>
.The browser must specify at least one other subprotocol since the server must echo a selected subprotocol back.
For this,
org.openhab.ws.protocol.default
is used.<encoded-token>
must be base64-encoded without padding, since bearer tokens can contain characters a websocket protocol may not (/
and=
).