Mirrored_Repos/obs-websocket
1
0
Fork 0
mirror of https://github.com/Palakis/obs-websocket.git synced 2024-08-30 18:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Finish authentication stuff

Browse Source
This commit is contained in:
tt2468 2021-04-26 17:59:13 -07:00
parent 8d26465bb0
commit cfb66fdf14
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/partials/introduction.md
View File

@ -57,7 +57,9 @@ These steps should be followed precisely. Failure to connect to the server as in
- The client will begin receiving events from obs-websocket and may now make requests to obs-websocket.
#### Notes
- At any time after a client has been identified, it may send a `Reidentify` message to update certain allowed session parameters. The server will respond in the same way it does during initial identification.
#### Connection Notes
- The obs-websocket server listens for any messages containing a `request-type` field in the first level JSON from unidentified clients. If a message matches, the connection is dropped with `WebsocketCloseCode::UnsupportedProtocolVersion`.
- If a message with a `messageType` is not recognized to the obs-websocket server, the connection is dropped with `WebsocketCloseCode::UnknownMessageType`.
- At no point may the client send any message other than a single `Identify` before it has received an `Identified`. Breaking this rule will result in the connection being dropped by the server with `WebsocketCloseCode::NotIdentified`.
@ -79,6 +81,14 @@ The `authentication` object in `Hello` looks like this (example):
}
```
To generate the authentication string, follow these steps:
- Concatenate the websocket password with the `salt` provided by the server (`password + salt`)
- Generate an SHA256 binary hash of the result and encode it with base64, known as a base64 secret.
- Concatenate the base64 secret with the `challenge` sent by the server (`base64_secret + challenge`)
- Generate a binary SHA256 hash of that result and encode it to base64. You now have your `authentication` string.
For more info on how to create the `authentication` string, refer to the obs-websocket client libraries listed on the [README](README.md).
## Message Types
The following message types are the base message types which may be sent to and from obs-websocket.