Sec-WebSocket-Key header

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since July 2015.

Der HTTP Sec-WebSocket-Key Request-Header wird im WebSocket-Öffnungshandshake verwendet, um einem Client (Benutzeragenten) zu ermöglichen zu bestätigen, dass er "wirklich möchte", dass ein HTTP-Client auf einen WebSocket aktualisiert wird.

Der Wert des Schlüssels wird mit einem Algorithmus berechnet, der in der WebSocket-Spezifikation definiert ist, daher bietet er keine Sicherheit. Stattdessen hilft er zu verhindern, dass Nicht-WebSocket-Clients versehentlich oder durch Missbrauch eine WebSocket-Verbindung anfordern.

Dieser Header wird automatisch von Benutzeragenten hinzugefügt, wenn ein Skript einen WebSocket öffnet; er kann nicht mit den Methoden fetch() oder XMLHttpRequest.setRequestHeader() hinzugefügt werden.

Der Sec-WebSocket-Accept Response-Header des Servers sollte einen Wert enthalten, der auf dem angegebenen Schlüsselwert basiert. Der Benutzeragent kann dies dann validieren, bevor er die Verbindung bestätigt.

Header-Typ Request-Header
Verbotener Request-Header Ja (Sec- Präfix)

Syntax

http
Sec-WebSocket-Key: <key>

Direktiven

<key>

Der Schlüssel für diese Upgrade-Anforderung. Dies ist ein zufällig ausgewählter, 16-Byte großer, Base64-kodierter und isomorph kodierter "nonce". Der Benutzeragent fügt dies hinzu, wenn die WebSocket-Verbindung initiiert wird.

Beispiele

WebSocket-Öffnungshandshake

Der Client wird ein WebSocket-Handshake mit einer Anforderung wie der folgenden initiieren. Beachten Sie, dass dies als HTTP GET-Anforderung (HTTP/1.1 oder höher) beginnt; zusätzlich zu Sec-WebSocket-Key enthält die Anforderung den Upgrade-Header, der die Absicht angibt, von HTTP zu einer WebSocket-Verbindung zu wechseln.

http
GET /chat HTTP/1.1
Host: example.com:8000
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Version: 13

Die Antwort vom Server sollte den Sec-WebSocket-Accept-Header mit einem Wert enthalten, der aus dem Sec-WebSocket-Key-Header in der Anfrage berechnet wurde, und die Absicht bestätigen, die Verbindung zu einer WebSocket-Verbindung zu aktualisieren:

http
HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=

Spezifikationen

Specification
The WebSocket Protocol
# section-11.3.1

Browser-Kompatibilität

Siehe auch