PlainApp
API 參考

WebSocket 加密

GraphQL 訂閱透過加密二進位訊框傳送。

用戶端
wss://<host>:<port>/graphql?cid=706c6169-3b80-8f42-9a61-4e312e54d001
伺服器

用戶端傳送 Init

initFrame

伺服器驗證 Init,讀取 clientNonce。

防重放

WebSocket 連線…/graphql?cid=<clientId>
↓
每次連線使用新的 Init / Ackbinding = SHA256(fields(initFrame, ackFrame))
↓
兩個方向獨立計數client → server: seq 1, 2, 3…server → client: seq 1, 2, 3…
↓
驗證並解密seq = lastReceived + 1
✓ ↓接受lastReceived ← seq
✕ ↓拒絕close

重新連線:新 binding,序號歸零

將游標移至欄位或點按
1 / 5

其他 WebSocket 路由

用戶端
wss://<host>:<port>/screen?cid=<clientId>
伺服器

Init · clientNonce

Init

伺服器驗證 Init,讀取 clientNonce。

XChaCha20-Poly1305 · 將游標移至欄位或點按
1 / 5

操作

websocket

1. 建立連線

連線開啟後傳送 Init。cid 為用戶端 ID。

typescript
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 = 0n
protocol

2. 用戶端 Init

10 秒內傳送。clientNonce:32 個隨機位元組,編碼為 64 個十六進位字元。AEAD nonce:每個訊框獨立產生的 24 個隨機位元組。

typescript
// 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.
protocol

3. 伺服器 Ack

驗證 Ack 並計算 binding,接著立即傳送用戶端序號 1 的加密空白確認。

typescript
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 })
protocol

4. 傳送加密訊息

使用 direction client 與新的 nonce。空白確認使用 sequence 1;業務訊息從 sequence 2 開始,之後嚴格遞增。

typescript
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))
protocol

5. 接收加密訊息

驗證序號為 lastReceived + 1,首個為 1,方向為 server;驗證解密成功後才推進計數器。

typescript
// 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))
protocol

6. 訊息類型

應用層 JSON 訊息(包括 ping/pong)會加密。WebSocket 原生 Ping/Pong 控制訊框不使用這層加密,但仍可由 TLS 保護。subscriptionReady 表示訂閱已就緒。

typescript
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: '...' }] }
protocol

7. 限制與失敗處理

驗證或序號檢查失敗時關閉連線。重新連線後重新交握。

text
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