WebSocket Encryption
GraphQL subscriptions use encrypted binary frames.
This page shows WSS /graphql: the session key authenticates init, ack and message frames with XChaCha20-Poly1305 tags. These frames do not contain an Ed25519 signature or SignaturePurpose. Passwordless login signs ServerHello on WSS /auth; see Authentication.
wss://<host>:<port>/graphql?cid=706c6169-3b80-8f42-9a61-4e312e54d001Send Init
Server verifies Init and reads clientNonce.
Replay protection
…/graphql?cid=<clientId>binding = SHA256(fields(initFrame, ackFrame))client → server: seq 1, 2, 3…server → client: seq 1, 2, 3…seq = lastReceived + 1lastReceived ← seqcloseReconnect: new binding, counters reset
Other WebSocket routes
key: Existing session token
wss://<host>:<port>/screen?cid=<clientId>Init · clientNonce
Server verifies Init and reads clientNonce.
Operations
1. Connect
Send Init after the socket opens. cid identifies the client.
const cid = '706c6169-3b80-8f42-9a61-4e312e54d001' // Your existing session's client ID
const socket = new WebSocket(
'wss://<device-host>:<https-port>/graphql?cid=' + encodeURIComponent(cid)
)
socket.binaryType = 'arraybuffer'
let binding: Uint8Array
let lastSent = 0n
let lastReceived = 0n2. Client Init
Send within 10 seconds. clientNonce: 32 random bytes as 64 hex characters. AEAD nonce: 24 random bytes per frame.
// Run immediately on socket.open.
const init = {
clientNonce: Array.from(randomBytes(32), n => n.toString(16).padStart(2, '0')).join(''),
}
const aad = fields([utf8.encode('WS_INIT'), utf8.encode('/graphql'), utf8.encode(cid)])
const initFrame = seal(key, utf8.encode(JSON.stringify(init)), aad)
socket.send(initFrame) // Retain these exact bytes for Ack.3. Server Ack
Verify Ack and compute binding, then immediately send an encrypted empty confirmation at client sequence 1.
socket.addEventListener('message', event => {
const ackFrame = new Uint8Array(event.data)
if (ackFrame.length < 40) throw new Error('Invalid Ack')
const aad = fields([utf8.encode('WS_ACK'), utf8.encode('/graphql'), utf8.encode(cid), sha256(initFrame)])
const ack: { serverNonce: string } = JSON.parse(decoder.decode(open(key, ackFrame, aad)))
if (!/^[0-9a-f]{64}$/.test(ack.serverNonce)) throw new Error('Invalid serverNonce')
binding = sha256(fields([initFrame, ackFrame]))
lastSent = lastReceived = 0n
const counter = uint64be(1n)
const confirmationAad = fields([utf8.encode('WS_FRAME'), utf8.encode('/graphql'), utf8.encode(cid), binding, utf8.encode('client'), counter])
const encrypted = seal(key, new Uint8Array(), confirmationAad)
lastSent = 1n
socket.send(concatBytes(counter, encrypted))
}, { once: true })4. Send an encrypted message
Use direction client and a fresh nonce. Empty confirmation uses sequence 1; business starts at sequence 2 and increases strictly.
const message = {
type: 'subscribe', id: 'prefs',
payload: { query: 'subscription { prefsChanged }' },
}
const next = lastSent + 1n
const counter = uint64be(next) // Reject overflow; never wrap.
const aad = fields([utf8.encode('WS_FRAME'), utf8.encode('/graphql'), utf8.encode(cid), binding, utf8.encode('client'), counter])
const encrypted = seal(key, utf8.encode(JSON.stringify(message)), aad)
lastSent = next // Advance only after successful encryption.
socket.send(concatBytes(counter, encrypted))5. Receive an encrypted message
Require lastReceived + 1 (first: 1) and direction server. Advance only after authenticated decryption.
// For each binary message after Ack, in arrival order:
const frame = new Uint8Array(event.data)
if (frame.length < 48) throw new Error('Invalid frame')
const sequence = new DataView(frame.buffer).getBigUint64(0, false)
if (sequence !== lastReceived + 1n) throw new Error('Invalid sequence')
const aad = fields([utf8.encode('WS_FRAME'), utf8.encode('/graphql'), utf8.encode(cid), binding, utf8.encode('server'), frame.subarray(0, 8)])
const plaintext = open(key, frame.subarray(8), aad) // Throws on invalid tag.
lastReceived = sequence // Advance only after authentication.
const message = JSON.parse(decoder.decode(plaintext))6. Message types
JSON application messages, including ping/pong, are encrypted. Native WebSocket Ping/Pong control frames are not wrapped by this encryption; TLS can still protect them. subscriptionReady confirms readiness.
const subscribe = {
type: 'subscribe', id: 'prefs',
payload: { query: 'subscription { prefsChanged }' },
}
const ready = {
type: 'next', id: 'prefs',
payload: { data: null, extensions: { subscriptionReady: true } },
}
const event = {
type: 'next', id: 'prefs',
payload: { data: { prefsChanged: true } },
}
const complete = { type: 'complete', id: 'prefs' }
const ping = { type: 'ping', payload: null }
const pong = { type: 'pong', payload: null }
const error = { type: 'error', id: 'prefs', payload: [{ message: '...' }] }7. Limits and failures
Close on authentication or sequence failure. Reconnect with a new handshake.
Server Init wait: timeout(10 seconds, socket.next()), after upgrade and session-key lookup
Server confirmation: timeout(10 seconds, socket.next()), after Ack send completes
Confirmation: send encrypted empty payload immediately after Ack, client sequence 1
Business messages: client starts at sequence 2; server starts at sequence 1
Init replay: may receive a fresh Ack; old bound frames fail
Replay state: connection counters, no timestamp or global cache
Message sequence: last + 1, independently in each direction
Sequence overflow: u64 max once; next frame fails, never wrap to 0
Frame size: <= 1,048,576 bytes
Timeout/auth failure: close 1008, reason "invalid_subscription"
Reconnect: fresh Init / Ack, new binding, last counters reset to 0; no legacy fallback