2 * QEMU I/O channels driver websockets
4 * Copyright (c) 2015 Red Hat, Inc.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
21 #include "qemu/osdep.h"
22 #include "qapi/error.h"
23 #include "qemu/bswap.h"
24 #include "io/channel-websock.h"
25 #include "crypto/hash.h"
29 /* Max amount to allow in rawinput/encoutput buffers */
30 #define QIO_CHANNEL_WEBSOCK_MAX_BUFFER 8192
32 #define QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN 24
33 #define QIO_CHANNEL_WEBSOCK_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
34 #define QIO_CHANNEL_WEBSOCK_GUID_LEN strlen(QIO_CHANNEL_WEBSOCK_GUID)
36 #define QIO_CHANNEL_WEBSOCK_HEADER_PROTOCOL "sec-websocket-protocol"
37 #define QIO_CHANNEL_WEBSOCK_HEADER_VERSION "sec-websocket-version"
38 #define QIO_CHANNEL_WEBSOCK_HEADER_KEY "sec-websocket-key"
39 #define QIO_CHANNEL_WEBSOCK_HEADER_UPGRADE "upgrade"
40 #define QIO_CHANNEL_WEBSOCK_HEADER_HOST "host"
41 #define QIO_CHANNEL_WEBSOCK_HEADER_CONNECTION "connection"
43 #define QIO_CHANNEL_WEBSOCK_PROTOCOL_BINARY "binary"
44 #define QIO_CHANNEL_WEBSOCK_CONNECTION_UPGRADE "Upgrade"
45 #define QIO_CHANNEL_WEBSOCK_UPGRADE_WEBSOCKET "websocket"
47 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \
48 "Server: QEMU VNC\r\n" \
51 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_OK \
52 "HTTP/1.1 101 Switching Protocols\r\n" \
53 QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \
54 "Upgrade: websocket\r\n" \
55 "Connection: Upgrade\r\n" \
56 "Sec-WebSocket-Accept: %s\r\n" \
57 "Sec-WebSocket-Protocol: binary\r\n" \
59 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_NOT_FOUND \
60 "HTTP/1.1 404 Not Found\r\n" \
61 QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \
62 "Connection: close\r\n" \
64 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_BAD_REQUEST \
65 "HTTP/1.1 400 Bad Request\r\n" \
66 QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \
67 "Connection: close\r\n" \
68 "Sec-WebSocket-Version: " \
69 QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION \
71 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_SERVER_ERR \
72 "HTTP/1.1 500 Internal Server Error\r\n" \
73 QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \
74 "Connection: close\r\n" \
76 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_TOO_LARGE \
77 "HTTP/1.1 403 Request Entity Too Large\r\n" \
78 QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \
79 "Connection: close\r\n" \
81 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM "\r\n"
82 #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_END "\r\n\r\n"
83 #define QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION "13"
84 #define QIO_CHANNEL_WEBSOCK_HTTP_METHOD "GET"
85 #define QIO_CHANNEL_WEBSOCK_HTTP_PATH "/"
86 #define QIO_CHANNEL_WEBSOCK_HTTP_VERSION "HTTP/1.1"
88 /* The websockets packet header is variable length
89 * depending on the size of the payload... */
91 /* ...length when using 7-bit payload length */
92 #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT 6
93 /* ...length when using 16-bit payload length */
94 #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT 8
95 /* ...length when using 64-bit payload length */
96 #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT 14
98 /* Length of the optional data mask field in header */
99 #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_MASK 4
101 /* Maximum length that can fit in 7-bit payload size */
102 #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_7_BIT 126
103 /* Maximum length that can fit in 16-bit payload size */
104 #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_16_BIT 65536
106 /* Magic 7-bit length to indicate use of 16-bit payload length */
107 #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT 126
108 /* Magic 7-bit length to indicate use of 64-bit payload length */
109 #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_64_BIT 127
111 /* Bitmasks for accessing header fields */
112 #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_FIN 0x80
113 #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_OPCODE 0x0f
114 #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_HAS_MASK 0x80
115 #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_PAYLOAD_LEN 0x7f
116 #define QIO_CHANNEL_WEBSOCK_CONTROL_OPCODE_MASK 0x8
118 typedef struct QIOChannelWebsockHeader QIOChannelWebsockHeader
;
120 struct QEMU_PACKED QIOChannelWebsockHeader
{
126 QIOChannelWebsockMask m16
;
130 QIOChannelWebsockMask m64
;
132 QIOChannelWebsockMask m
;
136 typedef struct QIOChannelWebsockHTTPHeader QIOChannelWebsockHTTPHeader
;
138 struct QIOChannelWebsockHTTPHeader
{
144 QIO_CHANNEL_WEBSOCK_OPCODE_CONTINUATION
= 0x0,
145 QIO_CHANNEL_WEBSOCK_OPCODE_TEXT_FRAME
= 0x1,
146 QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME
= 0x2,
147 QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE
= 0x8,
148 QIO_CHANNEL_WEBSOCK_OPCODE_PING
= 0x9,
149 QIO_CHANNEL_WEBSOCK_OPCODE_PONG
= 0xA
152 static void GCC_FMT_ATTR(2, 3)
153 qio_channel_websock_handshake_send_res(QIOChannelWebsock
*ioc
,
161 va_start(vargs
, resmsg
);
162 response
= g_strdup_vprintf(resmsg
, vargs
);
163 responselen
= strlen(response
);
164 buffer_reserve(&ioc
->encoutput
, responselen
);
165 buffer_append(&ioc
->encoutput
, response
, responselen
);
170 static gchar
*qio_channel_websock_date_str(void)
173 time_t now
= time(NULL
);
178 strftime(datebuf
, sizeof(datebuf
), "%a, %d %b %Y %H:%M:%S GMT", &tm
);
180 return g_strdup(datebuf
);
183 static void qio_channel_websock_handshake_send_res_err(QIOChannelWebsock
*ioc
,
186 char *date
= qio_channel_websock_date_str();
187 qio_channel_websock_handshake_send_res(ioc
, resdata
, date
);
192 QIO_CHANNEL_WEBSOCK_STATUS_NORMAL
= 1000,
193 QIO_CHANNEL_WEBSOCK_STATUS_PROTOCOL_ERR
= 1002,
194 QIO_CHANNEL_WEBSOCK_STATUS_INVALID_DATA
= 1003,
195 QIO_CHANNEL_WEBSOCK_STATUS_POLICY
= 1008,
196 QIO_CHANNEL_WEBSOCK_STATUS_TOO_LARGE
= 1009,
197 QIO_CHANNEL_WEBSOCK_STATUS_SERVER_ERR
= 1011,
201 qio_channel_websock_extract_headers(QIOChannelWebsock
*ioc
,
203 QIOChannelWebsockHTTPHeader
*hdrs
,
207 char *nl
, *sep
, *tmp
;
211 * First parse the HTTP protocol greeting of format:
213 * $METHOD $PATH $VERSION
220 nl
= strstr(buffer
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM
);
222 error_setg(errp
, "Missing HTTP header delimiter");
226 trace_qio_channel_websock_http_greeting(ioc
, buffer
);
228 tmp
= strchr(buffer
, ' ');
230 error_setg(errp
, "Missing HTTP path delimiter");
235 if (!g_str_equal(buffer
, QIO_CHANNEL_WEBSOCK_HTTP_METHOD
)) {
236 error_setg(errp
, "Unsupported HTTP method %s", buffer
);
241 tmp
= strchr(buffer
, ' ');
243 error_setg(errp
, "Missing HTTP version delimiter");
248 if (!g_str_equal(buffer
, QIO_CHANNEL_WEBSOCK_HTTP_PATH
)) {
249 qio_channel_websock_handshake_send_res_err(
250 ioc
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_NOT_FOUND
);
251 error_setg(errp
, "Unexpected HTTP path %s", buffer
);
257 if (!g_str_equal(buffer
, QIO_CHANNEL_WEBSOCK_HTTP_VERSION
)) {
258 error_setg(errp
, "Unsupported HTTP version %s", buffer
);
262 buffer
= nl
+ strlen(QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM
);
265 * Now parse all the header fields of format
271 * Cache-control: no-cache
274 QIOChannelWebsockHTTPHeader
*hdr
;
276 nl
= strstr(buffer
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM
);
281 sep
= strchr(buffer
, ':');
283 error_setg(errp
, "Malformed HTTP header");
288 while (*sep
== ' ') {
292 if (nhdrs
>= nhdrsalloc
) {
293 error_setg(errp
, "Too many HTTP headers");
297 hdr
= &hdrs
[nhdrs
++];
301 /* Canonicalize header name for easier identification later */
302 for (tmp
= hdr
->name
; *tmp
; tmp
++) {
303 *tmp
= g_ascii_tolower(*tmp
);
307 buffer
= nl
+ strlen(QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM
);
309 } while (nl
!= NULL
);
314 qio_channel_websock_handshake_send_res_err(
315 ioc
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_BAD_REQUEST
);
320 qio_channel_websock_find_header(QIOChannelWebsockHTTPHeader
*hdrs
,
326 for (i
= 0; i
< nhdrs
; i
++) {
327 if (g_str_equal(hdrs
[i
].name
, name
)) {
328 return hdrs
[i
].value
;
336 static void qio_channel_websock_handshake_send_res_ok(QIOChannelWebsock
*ioc
,
340 char combined_key
[QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN
+
341 QIO_CHANNEL_WEBSOCK_GUID_LEN
+ 1];
345 g_strlcpy(combined_key
, key
, QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN
+ 1);
346 g_strlcat(combined_key
, QIO_CHANNEL_WEBSOCK_GUID
,
347 QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN
+
348 QIO_CHANNEL_WEBSOCK_GUID_LEN
+ 1);
350 /* hash and encode it */
351 if (qcrypto_hash_base64(QCRYPTO_HASH_ALG_SHA1
,
353 QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN
+
354 QIO_CHANNEL_WEBSOCK_GUID_LEN
,
357 qio_channel_websock_handshake_send_res_err(
358 ioc
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_SERVER_ERR
);
362 date
= qio_channel_websock_date_str();
363 qio_channel_websock_handshake_send_res(
364 ioc
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_OK
, date
, accept
);
370 static void qio_channel_websock_handshake_process(QIOChannelWebsock
*ioc
,
374 QIOChannelWebsockHTTPHeader hdrs
[32];
375 size_t nhdrs
= G_N_ELEMENTS(hdrs
);
376 const char *protocols
= NULL
, *version
= NULL
, *key
= NULL
,
377 *host
= NULL
, *connection
= NULL
, *upgrade
= NULL
;
379 bool upgraded
= false;
382 nhdrs
= qio_channel_websock_extract_headers(ioc
, buffer
, hdrs
, nhdrs
, errp
);
387 protocols
= qio_channel_websock_find_header(
388 hdrs
, nhdrs
, QIO_CHANNEL_WEBSOCK_HEADER_PROTOCOL
);
390 error_setg(errp
, "Missing websocket protocol header data");
394 version
= qio_channel_websock_find_header(
395 hdrs
, nhdrs
, QIO_CHANNEL_WEBSOCK_HEADER_VERSION
);
397 error_setg(errp
, "Missing websocket version header data");
401 key
= qio_channel_websock_find_header(
402 hdrs
, nhdrs
, QIO_CHANNEL_WEBSOCK_HEADER_KEY
);
404 error_setg(errp
, "Missing websocket key header data");
408 host
= qio_channel_websock_find_header(
409 hdrs
, nhdrs
, QIO_CHANNEL_WEBSOCK_HEADER_HOST
);
411 error_setg(errp
, "Missing websocket host header data");
415 connection
= qio_channel_websock_find_header(
416 hdrs
, nhdrs
, QIO_CHANNEL_WEBSOCK_HEADER_CONNECTION
);
418 error_setg(errp
, "Missing websocket connection header data");
422 upgrade
= qio_channel_websock_find_header(
423 hdrs
, nhdrs
, QIO_CHANNEL_WEBSOCK_HEADER_UPGRADE
);
425 error_setg(errp
, "Missing websocket upgrade header data");
429 trace_qio_channel_websock_http_request(ioc
, protocols
, version
,
430 host
, connection
, upgrade
, key
);
432 if (!g_strrstr(protocols
, QIO_CHANNEL_WEBSOCK_PROTOCOL_BINARY
)) {
433 error_setg(errp
, "No '%s' protocol is supported by client '%s'",
434 QIO_CHANNEL_WEBSOCK_PROTOCOL_BINARY
, protocols
);
438 if (!g_str_equal(version
, QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION
)) {
439 error_setg(errp
, "Version '%s' is not supported by client '%s'",
440 QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION
, version
);
444 if (strlen(key
) != QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN
) {
445 error_setg(errp
, "Key length '%zu' was not as expected '%d'",
446 strlen(key
), QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN
);
450 connectionv
= g_strsplit(connection
, ",", 0);
451 for (i
= 0; connectionv
!= NULL
&& connectionv
[i
] != NULL
; i
++) {
452 g_strstrip(connectionv
[i
]);
453 if (strcasecmp(connectionv
[i
],
454 QIO_CHANNEL_WEBSOCK_CONNECTION_UPGRADE
) == 0) {
458 g_strfreev(connectionv
);
460 error_setg(errp
, "No connection upgrade requested '%s'", connection
);
464 if (strcasecmp(upgrade
, QIO_CHANNEL_WEBSOCK_UPGRADE_WEBSOCKET
) != 0) {
465 error_setg(errp
, "Incorrect upgrade method '%s'", upgrade
);
469 qio_channel_websock_handshake_send_res_ok(ioc
, key
, errp
);
473 qio_channel_websock_handshake_send_res_err(
474 ioc
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_BAD_REQUEST
);
477 static int qio_channel_websock_handshake_read(QIOChannelWebsock
*ioc
,
482 /* Typical HTTP headers from novnc are 512 bytes, so limiting
483 * total header size to 4096 is easily enough. */
484 size_t want
= 4096 - ioc
->encinput
.offset
;
485 buffer_reserve(&ioc
->encinput
, want
);
486 ret
= qio_channel_read(ioc
->master
,
487 (char *)buffer_end(&ioc
->encinput
), want
, errp
);
491 ioc
->encinput
.offset
+= ret
;
493 handshake_end
= g_strstr_len((char *)ioc
->encinput
.buffer
,
494 ioc
->encinput
.offset
,
495 QIO_CHANNEL_WEBSOCK_HANDSHAKE_END
);
496 if (!handshake_end
) {
497 if (ioc
->encinput
.offset
>= 4096) {
498 qio_channel_websock_handshake_send_res_err(
499 ioc
, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_TOO_LARGE
);
501 "End of headers not found in first 4096 bytes");
503 } else if (ret
== 0) {
505 "End of headers not found before connection closed");
510 *handshake_end
= '\0';
512 qio_channel_websock_handshake_process(ioc
,
513 (char *)ioc
->encinput
.buffer
,
516 buffer_advance(&ioc
->encinput
,
517 handshake_end
- (char *)ioc
->encinput
.buffer
+
518 strlen(QIO_CHANNEL_WEBSOCK_HANDSHAKE_END
));
522 static gboolean
qio_channel_websock_handshake_send(QIOChannel
*ioc
,
523 GIOCondition condition
,
526 QIOTask
*task
= user_data
;
527 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(
528 qio_task_get_source(task
));
532 ret
= qio_channel_write(wioc
->master
,
533 (char *)wioc
->encoutput
.buffer
,
534 wioc
->encoutput
.offset
,
538 trace_qio_channel_websock_handshake_fail(ioc
, error_get_pretty(err
));
539 qio_task_set_error(task
, err
);
540 qio_task_complete(task
);
544 buffer_advance(&wioc
->encoutput
, ret
);
545 if (wioc
->encoutput
.offset
== 0) {
547 trace_qio_channel_websock_handshake_fail(
548 ioc
, error_get_pretty(wioc
->io_err
));
549 qio_task_set_error(task
, wioc
->io_err
);
551 qio_task_complete(task
);
553 trace_qio_channel_websock_handshake_complete(ioc
);
554 qio_task_complete(task
);
558 trace_qio_channel_websock_handshake_pending(ioc
, G_IO_OUT
);
562 static gboolean
qio_channel_websock_handshake_io(QIOChannel
*ioc
,
563 GIOCondition condition
,
566 QIOTask
*task
= user_data
;
567 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(
568 qio_task_get_source(task
));
572 ret
= qio_channel_websock_handshake_read(wioc
, &err
);
575 * We only take this path on a fatal I/O error reading from
576 * client connection, as most of the time we have an
577 * HTTP 4xx err response to send instead
579 trace_qio_channel_websock_handshake_fail(ioc
, error_get_pretty(err
));
580 qio_task_set_error(task
, err
);
581 qio_task_complete(task
);
585 trace_qio_channel_websock_handshake_pending(ioc
, G_IO_IN
);
586 /* need more data still */
590 error_propagate(&wioc
->io_err
, err
);
592 trace_qio_channel_websock_handshake_reply(ioc
);
593 qio_channel_add_watch(
596 qio_channel_websock_handshake_send
,
603 static void qio_channel_websock_encode(QIOChannelWebsock
*ioc
,
605 const struct iovec
*iov
,
612 char buf
[QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT
];
613 QIOChannelWebsockHeader ws
;
616 assert(size
<= iov_size(iov
, niov
));
618 header
.ws
.b0
= QIO_CHANNEL_WEBSOCK_HEADER_FIELD_FIN
|
619 (opcode
& QIO_CHANNEL_WEBSOCK_HEADER_FIELD_OPCODE
);
620 if (size
< QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_7_BIT
) {
621 header
.ws
.b1
= (uint8_t)size
;
622 header_size
= QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT
;
623 } else if (size
< QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_16_BIT
) {
624 header
.ws
.b1
= QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT
;
625 header
.ws
.u
.s16
.l16
= cpu_to_be16((uint16_t)size
);
626 header_size
= QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT
;
628 header
.ws
.b1
= QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_64_BIT
;
629 header
.ws
.u
.s64
.l64
= cpu_to_be64(size
);
630 header_size
= QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT
;
632 header_size
-= QIO_CHANNEL_WEBSOCK_HEADER_LEN_MASK
;
634 trace_qio_channel_websock_encode(ioc
, opcode
, header_size
, size
);
635 buffer_reserve(&ioc
->encoutput
, header_size
+ size
);
636 buffer_append(&ioc
->encoutput
, header
.buf
, header_size
);
637 for (i
= 0; i
< niov
&& size
!= 0; i
++) {
638 size_t want
= iov
[i
].iov_len
;
642 buffer_append(&ioc
->encoutput
, iov
[i
].iov_base
, want
);
648 static ssize_t
qio_channel_websock_write_wire(QIOChannelWebsock
*, Error
**);
651 static void qio_channel_websock_write_close(QIOChannelWebsock
*ioc
,
652 uint16_t code
, const char *reason
)
654 struct iovec iov
[2] = {
655 { .iov_base
= &code
, .iov_len
= sizeof(code
) },
658 size_t size
= iov
[0].iov_len
;
663 iov
[1].iov_base
= (void *)reason
;
664 iov
[1].iov_len
= strlen(reason
);
665 size
+= iov
[1].iov_len
;
668 qio_channel_websock_encode(ioc
, QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE
,
670 qio_channel_websock_write_wire(ioc
, NULL
);
671 qio_channel_shutdown(ioc
->master
, QIO_CHANNEL_SHUTDOWN_BOTH
, NULL
);
675 static int qio_channel_websock_decode_header(QIOChannelWebsock
*ioc
,
678 unsigned char opcode
, fin
, has_mask
;
681 QIOChannelWebsockHeader
*header
=
682 (QIOChannelWebsockHeader
*)ioc
->encinput
.buffer
;
684 if (ioc
->payload_remain
) {
686 "Decoding header but %zu bytes of payload remain",
687 ioc
->payload_remain
);
688 qio_channel_websock_write_close(
689 ioc
, QIO_CHANNEL_WEBSOCK_STATUS_SERVER_ERR
,
690 "internal server error");
693 if (ioc
->encinput
.offset
< QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT
) {
694 /* header not complete */
695 return QIO_CHANNEL_ERR_BLOCK
;
698 fin
= header
->b0
& QIO_CHANNEL_WEBSOCK_HEADER_FIELD_FIN
;
699 opcode
= header
->b0
& QIO_CHANNEL_WEBSOCK_HEADER_FIELD_OPCODE
;
700 has_mask
= header
->b1
& QIO_CHANNEL_WEBSOCK_HEADER_FIELD_HAS_MASK
;
701 payload_len
= header
->b1
& QIO_CHANNEL_WEBSOCK_HEADER_FIELD_PAYLOAD_LEN
;
703 /* Save or restore opcode. */
705 ioc
->opcode
= opcode
;
707 opcode
= ioc
->opcode
;
710 trace_qio_channel_websock_header_partial_decode(ioc
, payload_len
,
711 fin
, opcode
, (int)has_mask
);
713 if (opcode
== QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE
) {
718 /* Websocket frame sanity check:
719 * * Fragmentation is only supported for binary frames.
720 * * All frames sent by a client MUST be masked.
721 * * Only binary and ping/pong encoding is supported.
724 if (opcode
!= QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME
) {
725 error_setg(errp
, "only binary websocket frames may be fragmented");
726 qio_channel_websock_write_close(
727 ioc
, QIO_CHANNEL_WEBSOCK_STATUS_POLICY
,
728 "only binary frames may be fragmented");
732 if (opcode
!= QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME
&&
733 opcode
!= QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE
&&
734 opcode
!= QIO_CHANNEL_WEBSOCK_OPCODE_PING
&&
735 opcode
!= QIO_CHANNEL_WEBSOCK_OPCODE_PONG
) {
736 error_setg(errp
, "unsupported opcode: %#04x; only binary, close, "
737 "ping, and pong websocket frames are supported", opcode
);
738 qio_channel_websock_write_close(
739 ioc
, QIO_CHANNEL_WEBSOCK_STATUS_INVALID_DATA
,
740 "only binary, close, ping, and pong frames are supported");
745 error_setg(errp
, "client websocket frames must be masked");
746 qio_channel_websock_write_close(
747 ioc
, QIO_CHANNEL_WEBSOCK_STATUS_PROTOCOL_ERR
,
748 "client frames must be masked");
752 if (payload_len
< QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT
) {
753 ioc
->payload_remain
= payload_len
;
754 header_size
= QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT
;
755 ioc
->mask
= header
->u
.m
;
756 } else if (opcode
& QIO_CHANNEL_WEBSOCK_CONTROL_OPCODE_MASK
) {
757 error_setg(errp
, "websocket control frame is too large");
758 qio_channel_websock_write_close(
759 ioc
, QIO_CHANNEL_WEBSOCK_STATUS_PROTOCOL_ERR
,
760 "control frame is too large");
762 } else if (payload_len
== QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT
&&
763 ioc
->encinput
.offset
>= QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT
) {
764 ioc
->payload_remain
= be16_to_cpu(header
->u
.s16
.l16
);
765 header_size
= QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT
;
766 ioc
->mask
= header
->u
.s16
.m16
;
767 } else if (payload_len
== QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_64_BIT
&&
768 ioc
->encinput
.offset
>= QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT
) {
769 ioc
->payload_remain
= be64_to_cpu(header
->u
.s64
.l64
);
770 header_size
= QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT
;
771 ioc
->mask
= header
->u
.s64
.m64
;
773 /* header not complete */
774 return QIO_CHANNEL_ERR_BLOCK
;
777 trace_qio_channel_websock_header_full_decode(
778 ioc
, header_size
, ioc
->payload_remain
, ioc
->mask
.u
);
779 buffer_advance(&ioc
->encinput
, header_size
);
784 static int qio_channel_websock_decode_payload(QIOChannelWebsock
*ioc
,
788 size_t payload_len
= 0;
791 if (ioc
->payload_remain
) {
792 /* If we aren't at the end of the payload, then drop
793 * off the last bytes, so we're always multiple of 4
794 * for purpose of unmasking, except at end of payload
796 if (ioc
->encinput
.offset
< ioc
->payload_remain
) {
797 /* Wait for the entire payload before processing control frames
798 * because the payload will most likely be echoed back. */
799 if (ioc
->opcode
& QIO_CHANNEL_WEBSOCK_CONTROL_OPCODE_MASK
) {
800 return QIO_CHANNEL_ERR_BLOCK
;
802 payload_len
= ioc
->encinput
.offset
- (ioc
->encinput
.offset
% 4);
804 payload_len
= ioc
->payload_remain
;
806 if (payload_len
== 0) {
807 return QIO_CHANNEL_ERR_BLOCK
;
810 ioc
->payload_remain
-= payload_len
;
813 /* process 1 frame (32 bit op) */
814 payload32
= (uint32_t *)ioc
->encinput
.buffer
;
815 for (i
= 0; i
< payload_len
/ 4; i
++) {
816 payload32
[i
] ^= ioc
->mask
.u
;
818 /* process the remaining bytes (if any) */
819 for (i
*= 4; i
< payload_len
; i
++) {
820 ioc
->encinput
.buffer
[i
] ^= ioc
->mask
.c
[i
% 4];
824 trace_qio_channel_websock_payload_decode(
825 ioc
, ioc
->opcode
, ioc
->payload_remain
);
827 if (ioc
->opcode
== QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME
) {
829 /* binary frames are passed on */
830 buffer_reserve(&ioc
->rawinput
, payload_len
);
831 buffer_append(&ioc
->rawinput
, ioc
->encinput
.buffer
, payload_len
);
833 } else if (ioc
->opcode
== QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE
) {
834 /* close frames are echoed back */
835 error_setg(errp
, "websocket closed by peer");
837 /* echo client status */
838 struct iovec iov
= { .iov_base
= ioc
->encinput
.buffer
,
839 .iov_len
= ioc
->encinput
.offset
};
840 qio_channel_websock_encode(ioc
, QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE
,
841 &iov
, 1, iov
.iov_len
);
842 qio_channel_websock_write_wire(ioc
, NULL
);
843 qio_channel_shutdown(ioc
->master
, QIO_CHANNEL_SHUTDOWN_BOTH
, NULL
);
845 /* send our own status */
846 qio_channel_websock_write_close(
847 ioc
, QIO_CHANNEL_WEBSOCK_STATUS_NORMAL
, "peer requested close");
850 } else if (ioc
->opcode
== QIO_CHANNEL_WEBSOCK_OPCODE_PING
) {
851 /* ping frames produce an immediate reply, as long as we've not still
852 * got a previous pong queued, in which case we drop the new pong */
853 if (ioc
->pong_remain
== 0) {
854 struct iovec iov
= { .iov_base
= ioc
->encinput
.buffer
,
855 .iov_len
= ioc
->encinput
.offset
};
856 qio_channel_websock_encode(ioc
, QIO_CHANNEL_WEBSOCK_OPCODE_PONG
,
857 &iov
, 1, iov
.iov_len
);
858 ioc
->pong_remain
= ioc
->encoutput
.offset
;
860 } /* pong frames are ignored */
863 buffer_advance(&ioc
->encinput
, payload_len
);
870 qio_channel_websock_new_server(QIOChannel
*master
)
872 QIOChannelWebsock
*wioc
;
875 wioc
= QIO_CHANNEL_WEBSOCK(object_new(TYPE_QIO_CHANNEL_WEBSOCK
));
876 ioc
= QIO_CHANNEL(wioc
);
878 wioc
->master
= master
;
879 if (qio_channel_has_feature(master
, QIO_CHANNEL_FEATURE_SHUTDOWN
)) {
880 qio_channel_set_feature(ioc
, QIO_CHANNEL_FEATURE_SHUTDOWN
);
882 object_ref(OBJECT(master
));
884 trace_qio_channel_websock_new_server(wioc
, master
);
888 void qio_channel_websock_handshake(QIOChannelWebsock
*ioc
,
891 GDestroyNotify destroy
)
895 task
= qio_task_new(OBJECT(ioc
),
900 trace_qio_channel_websock_handshake_start(ioc
);
901 trace_qio_channel_websock_handshake_pending(ioc
, G_IO_IN
);
902 qio_channel_add_watch(ioc
->master
,
904 qio_channel_websock_handshake_io
,
910 static void qio_channel_websock_finalize(Object
*obj
)
912 QIOChannelWebsock
*ioc
= QIO_CHANNEL_WEBSOCK(obj
);
914 buffer_free(&ioc
->encinput
);
915 buffer_free(&ioc
->encoutput
);
916 buffer_free(&ioc
->rawinput
);
917 object_unref(OBJECT(ioc
->master
));
919 g_source_remove(ioc
->io_tag
);
922 error_free(ioc
->io_err
);
927 static ssize_t
qio_channel_websock_read_wire(QIOChannelWebsock
*ioc
,
932 if (ioc
->encinput
.offset
< 4096) {
933 size_t want
= 4096 - ioc
->encinput
.offset
;
935 buffer_reserve(&ioc
->encinput
, want
);
936 ret
= qio_channel_read(ioc
->master
,
937 (char *)ioc
->encinput
.buffer
+
938 ioc
->encinput
.offset
,
944 if (ret
== 0 && ioc
->encinput
.offset
== 0) {
948 ioc
->encinput
.offset
+= ret
;
951 while (ioc
->encinput
.offset
!= 0) {
952 if (ioc
->payload_remain
== 0) {
953 ret
= qio_channel_websock_decode_header(ioc
, errp
);
959 ret
= qio_channel_websock_decode_payload(ioc
, errp
);
968 static ssize_t
qio_channel_websock_write_wire(QIOChannelWebsock
*ioc
,
974 while (ioc
->encoutput
.offset
> 0) {
975 ret
= qio_channel_write(ioc
->master
,
976 (char *)ioc
->encoutput
.buffer
,
977 ioc
->encoutput
.offset
,
980 if (ret
== QIO_CHANNEL_ERR_BLOCK
&&
987 buffer_advance(&ioc
->encoutput
, ret
);
989 if (ioc
->pong_remain
< ret
) {
990 ioc
->pong_remain
= 0;
992 ioc
->pong_remain
-= ret
;
999 static void qio_channel_websock_flush_free(gpointer user_data
)
1001 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(user_data
);
1002 object_unref(OBJECT(wioc
));
1005 static void qio_channel_websock_set_watch(QIOChannelWebsock
*ioc
);
1007 static gboolean
qio_channel_websock_flush(QIOChannel
*ioc
,
1008 GIOCondition condition
,
1011 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(user_data
);
1014 if (condition
& G_IO_OUT
) {
1015 ret
= qio_channel_websock_write_wire(wioc
, &wioc
->io_err
);
1021 if (condition
& G_IO_IN
) {
1022 ret
= qio_channel_websock_read_wire(wioc
, &wioc
->io_err
);
1029 qio_channel_websock_set_watch(wioc
);
1034 static void qio_channel_websock_unset_watch(QIOChannelWebsock
*ioc
)
1037 g_source_remove(ioc
->io_tag
);
1042 static void qio_channel_websock_set_watch(QIOChannelWebsock
*ioc
)
1044 GIOCondition cond
= 0;
1046 qio_channel_websock_unset_watch(ioc
);
1052 if (ioc
->encoutput
.offset
) {
1055 if (ioc
->encinput
.offset
< QIO_CHANNEL_WEBSOCK_MAX_BUFFER
&&
1061 object_ref(OBJECT(ioc
));
1063 qio_channel_add_watch(ioc
->master
,
1065 qio_channel_websock_flush
,
1067 qio_channel_websock_flush_free
);
1072 static ssize_t
qio_channel_websock_readv(QIOChannel
*ioc
,
1073 const struct iovec
*iov
,
1079 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1085 error_propagate(errp
, error_copy(wioc
->io_err
));
1089 if (!wioc
->rawinput
.offset
) {
1090 ret
= qio_channel_websock_read_wire(QIO_CHANNEL_WEBSOCK(ioc
), errp
);
1096 for (i
= 0 ; i
< niov
; i
++) {
1097 size_t want
= iov
[i
].iov_len
;
1098 if (want
> (wioc
->rawinput
.offset
- got
)) {
1099 want
= (wioc
->rawinput
.offset
- got
);
1102 memcpy(iov
[i
].iov_base
,
1103 wioc
->rawinput
.buffer
+ got
,
1107 if (want
< iov
[i
].iov_len
) {
1112 buffer_advance(&wioc
->rawinput
, got
);
1113 qio_channel_websock_set_watch(wioc
);
1118 static ssize_t
qio_channel_websock_writev(QIOChannel
*ioc
,
1119 const struct iovec
*iov
,
1125 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1126 ssize_t want
= iov_size(iov
, niov
);
1131 error_propagate(errp
, error_copy(wioc
->io_err
));
1136 error_setg(errp
, "%s", "Broken pipe");
1140 avail
= wioc
->encoutput
.offset
>= QIO_CHANNEL_WEBSOCK_MAX_BUFFER
?
1141 0 : (QIO_CHANNEL_WEBSOCK_MAX_BUFFER
- wioc
->encoutput
.offset
);
1147 qio_channel_websock_encode(wioc
,
1148 QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME
,
1152 /* Even if want == 0, we'll try write_wire in case there's
1153 * pending data we could usefully flush out
1155 ret
= qio_channel_websock_write_wire(wioc
, errp
);
1157 ret
!= QIO_CHANNEL_ERR_BLOCK
) {
1158 qio_channel_websock_unset_watch(wioc
);
1162 qio_channel_websock_set_watch(wioc
);
1165 return QIO_CHANNEL_ERR_BLOCK
;
1171 static int qio_channel_websock_set_blocking(QIOChannel
*ioc
,
1175 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1177 qio_channel_set_blocking(wioc
->master
, enabled
, errp
);
1181 static void qio_channel_websock_set_delay(QIOChannel
*ioc
,
1184 QIOChannelWebsock
*tioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1186 qio_channel_set_delay(tioc
->master
, enabled
);
1189 static void qio_channel_websock_set_cork(QIOChannel
*ioc
,
1192 QIOChannelWebsock
*tioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1194 qio_channel_set_cork(tioc
->master
, enabled
);
1197 static int qio_channel_websock_shutdown(QIOChannel
*ioc
,
1198 QIOChannelShutdown how
,
1201 QIOChannelWebsock
*tioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1203 return qio_channel_shutdown(tioc
->master
, how
, errp
);
1206 static int qio_channel_websock_close(QIOChannel
*ioc
,
1209 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1211 trace_qio_channel_websock_close(ioc
);
1212 return qio_channel_close(wioc
->master
, errp
);
1215 typedef struct QIOChannelWebsockSource QIOChannelWebsockSource
;
1216 struct QIOChannelWebsockSource
{
1218 QIOChannelWebsock
*wioc
;
1219 GIOCondition condition
;
1223 qio_channel_websock_source_check(GSource
*source
)
1225 QIOChannelWebsockSource
*wsource
= (QIOChannelWebsockSource
*)source
;
1226 GIOCondition cond
= 0;
1228 if (wsource
->wioc
->rawinput
.offset
|| wsource
->wioc
->io_eof
) {
1231 if (wsource
->wioc
->encoutput
.offset
< QIO_CHANNEL_WEBSOCK_MAX_BUFFER
) {
1235 return cond
& wsource
->condition
;
1239 qio_channel_websock_source_prepare(GSource
*source
,
1243 return qio_channel_websock_source_check(source
);
1247 qio_channel_websock_source_dispatch(GSource
*source
,
1248 GSourceFunc callback
,
1251 QIOChannelFunc func
= (QIOChannelFunc
)callback
;
1252 QIOChannelWebsockSource
*wsource
= (QIOChannelWebsockSource
*)source
;
1254 return (*func
)(QIO_CHANNEL(wsource
->wioc
),
1255 qio_channel_websock_source_check(source
),
1260 qio_channel_websock_source_finalize(GSource
*source
)
1262 QIOChannelWebsockSource
*ssource
= (QIOChannelWebsockSource
*)source
;
1264 object_unref(OBJECT(ssource
->wioc
));
1267 GSourceFuncs qio_channel_websock_source_funcs
= {
1268 qio_channel_websock_source_prepare
,
1269 qio_channel_websock_source_check
,
1270 qio_channel_websock_source_dispatch
,
1271 qio_channel_websock_source_finalize
1274 static GSource
*qio_channel_websock_create_watch(QIOChannel
*ioc
,
1275 GIOCondition condition
)
1277 QIOChannelWebsock
*wioc
= QIO_CHANNEL_WEBSOCK(ioc
);
1278 QIOChannelWebsockSource
*ssource
;
1281 source
= g_source_new(&qio_channel_websock_source_funcs
,
1282 sizeof(QIOChannelWebsockSource
));
1283 ssource
= (QIOChannelWebsockSource
*)source
;
1285 ssource
->wioc
= wioc
;
1286 object_ref(OBJECT(wioc
));
1288 ssource
->condition
= condition
;
1290 qio_channel_websock_set_watch(wioc
);
1294 static void qio_channel_websock_class_init(ObjectClass
*klass
,
1295 void *class_data G_GNUC_UNUSED
)
1297 QIOChannelClass
*ioc_klass
= QIO_CHANNEL_CLASS(klass
);
1299 ioc_klass
->io_writev
= qio_channel_websock_writev
;
1300 ioc_klass
->io_readv
= qio_channel_websock_readv
;
1301 ioc_klass
->io_set_blocking
= qio_channel_websock_set_blocking
;
1302 ioc_klass
->io_set_cork
= qio_channel_websock_set_cork
;
1303 ioc_klass
->io_set_delay
= qio_channel_websock_set_delay
;
1304 ioc_klass
->io_close
= qio_channel_websock_close
;
1305 ioc_klass
->io_shutdown
= qio_channel_websock_shutdown
;
1306 ioc_klass
->io_create_watch
= qio_channel_websock_create_watch
;
1309 static const TypeInfo qio_channel_websock_info
= {
1310 .parent
= TYPE_QIO_CHANNEL
,
1311 .name
= TYPE_QIO_CHANNEL_WEBSOCK
,
1312 .instance_size
= sizeof(QIOChannelWebsock
),
1313 .instance_finalize
= qio_channel_websock_finalize
,
1314 .class_init
= qio_channel_websock_class_init
,
1317 static void qio_channel_websock_register_types(void)
1319 type_register_static(&qio_channel_websock_info
);
1322 type_init(qio_channel_websock_register_types
);