Skip to main content

Module handshake

Module handshake 

Source
Expand description

Authenticates the first WebSocket envelope before room admission.

Room selection precedes JWT verification for legacy Odoo tokens. Decoded claims select only a candidate room and become trusted after verification with that room’s key.

StructsΒ§

AuthenticatedJoin πŸ”’
RoomScopedConnectClaims πŸ”’
Legacy Odoo claims use AuthPayload::channel instead of a room-id claim.
WebSocketAuth πŸ”’
Proves the selected room authenticated this WebSocket join.

EnumsΒ§

HandshakeError πŸ”’

FunctionsΒ§

authenticate πŸ”’
returns the authenticated room join intent without admitting the user
authenticate_room_scoped_claims πŸ”’
decode_auth_payload_text
Decodes the single auth envelope required as the first WebSocket frame.
parse_auth_payload πŸ”’
receive_auth πŸ”’
reject πŸ”’
resolve_handshake_room πŸ”’
Selects the candidate room without trusting decoded claims.
resolve_room_by_id πŸ”’
verify_auth_payload πŸ”’