| 1 | /* |
| 2 | * QEMU I/O channels driver websockets |
| 3 | * |
| 4 | * Copyright (c) 2015 Red Hat, Inc. |
| 5 | * |
| 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.1 of the License, or (at your option) any later version. |
| 10 | * |
| 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. |
| 15 | * |
| 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/>. |
| 18 | * |
| 19 | */ |
| 20 | |
| 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" |
| 26 | #include "trace.h" |
| 27 | #include "qemu/iov.h" |
| 28 | #include "qemu/module.h" |
| 29 | |
| 30 | /* Max amount to allow in rawinput/encoutput buffers */ |
| 31 | #define QIO_CHANNEL_WEBSOCK_MAX_BUFFER 8192 |
| 32 | |
| 33 | #define QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN 24 |
| 34 | #define QIO_CHANNEL_WEBSOCK_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11" |
| 35 | #define QIO_CHANNEL_WEBSOCK_GUID_LEN (sizeof(QIO_CHANNEL_WEBSOCK_GUID) - 1) |
| 36 | |
| 37 | #define QIO_CHANNEL_WEBSOCK_HEADER_PROTOCOL "sec-websocket-protocol" |
| 38 | #define QIO_CHANNEL_WEBSOCK_HEADER_VERSION "sec-websocket-version" |
| 39 | #define QIO_CHANNEL_WEBSOCK_HEADER_KEY "sec-websocket-key" |
| 40 | #define QIO_CHANNEL_WEBSOCK_HEADER_UPGRADE "upgrade" |
| 41 | #define QIO_CHANNEL_WEBSOCK_HEADER_HOST "host" |
| 42 | #define QIO_CHANNEL_WEBSOCK_HEADER_CONNECTION "connection" |
| 43 | |
| 44 | #define QIO_CHANNEL_WEBSOCK_PROTOCOL_BINARY "binary" |
| 45 | #define QIO_CHANNEL_WEBSOCK_CONNECTION_UPGRADE "Upgrade" |
| 46 | #define QIO_CHANNEL_WEBSOCK_UPGRADE_WEBSOCKET "websocket" |
| 47 | |
| 48 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 49 | "Server: QEMU VNC\r\n" \ |
| 50 | "Date: %s\r\n" |
| 51 | |
| 52 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_WITH_PROTO_RES_OK \ |
| 53 | "HTTP/1.1 101 Switching Protocols\r\n" \ |
| 54 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 55 | "Upgrade: websocket\r\n" \ |
| 56 | "Connection: Upgrade\r\n" \ |
| 57 | "Sec-WebSocket-Accept: %s\r\n" \ |
| 58 | "Sec-WebSocket-Protocol: binary\r\n" \ |
| 59 | "\r\n" |
| 60 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_OK \ |
| 61 | "HTTP/1.1 101 Switching Protocols\r\n" \ |
| 62 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 63 | "Upgrade: websocket\r\n" \ |
| 64 | "Connection: Upgrade\r\n" \ |
| 65 | "Sec-WebSocket-Accept: %s\r\n" \ |
| 66 | "\r\n" |
| 67 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_NOT_FOUND \ |
| 68 | "HTTP/1.1 404 Not Found\r\n" \ |
| 69 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 70 | "Connection: close\r\n" \ |
| 71 | "\r\n" |
| 72 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_BAD_REQUEST \ |
| 73 | "HTTP/1.1 400 Bad Request\r\n" \ |
| 74 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 75 | "Connection: close\r\n" \ |
| 76 | "Sec-WebSocket-Version: " \ |
| 77 | QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION \ |
| 78 | "\r\n" |
| 79 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_SERVER_ERR \ |
| 80 | "HTTP/1.1 500 Internal Server Error\r\n" \ |
| 81 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 82 | "Connection: close\r\n" \ |
| 83 | "\r\n" |
| 84 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_TOO_LARGE \ |
| 85 | "HTTP/1.1 403 Request Entity Too Large\r\n" \ |
| 86 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_COMMON \ |
| 87 | "Connection: close\r\n" \ |
| 88 | "\r\n" |
| 89 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM "\r\n" |
| 90 | #define QIO_CHANNEL_WEBSOCK_HANDSHAKE_END "\r\n\r\n" |
| 91 | #define QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION "13" |
| 92 | #define QIO_CHANNEL_WEBSOCK_HTTP_METHOD "GET" |
| 93 | #define QIO_CHANNEL_WEBSOCK_HTTP_PATH "/" |
| 94 | #define QIO_CHANNEL_WEBSOCK_HTTP_VERSION "HTTP/1.1" |
| 95 | |
| 96 | /* The websockets packet header is variable length |
| 97 | * depending on the size of the payload... */ |
| 98 | |
| 99 | /* ...length when using 7-bit payload length */ |
| 100 | #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT 6 |
| 101 | /* ...length when using 16-bit payload length */ |
| 102 | #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT 8 |
| 103 | /* ...length when using 64-bit payload length */ |
| 104 | #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT 14 |
| 105 | |
| 106 | /* Length of the optional data mask field in header */ |
| 107 | #define QIO_CHANNEL_WEBSOCK_HEADER_LEN_MASK 4 |
| 108 | |
| 109 | /* Maximum length that can fit in 7-bit payload size */ |
| 110 | #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_7_BIT 126 |
| 111 | /* Maximum length that can fit in 16-bit payload size */ |
| 112 | #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_16_BIT 65536 |
| 113 | |
| 114 | /* Magic 7-bit length to indicate use of 16-bit payload length */ |
| 115 | #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT 126 |
| 116 | /* Magic 7-bit length to indicate use of 64-bit payload length */ |
| 117 | #define QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_64_BIT 127 |
| 118 | |
| 119 | /* Bitmasks for accessing header fields */ |
| 120 | #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_FIN 0x80 |
| 121 | #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_OPCODE 0x0f |
| 122 | #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_HAS_MASK 0x80 |
| 123 | #define QIO_CHANNEL_WEBSOCK_HEADER_FIELD_PAYLOAD_LEN 0x7f |
| 124 | #define QIO_CHANNEL_WEBSOCK_CONTROL_OPCODE_MASK 0x8 |
| 125 | |
| 126 | typedef struct QIOChannelWebsockHeader QIOChannelWebsockHeader; |
| 127 | |
| 128 | struct QEMU_PACKED QIOChannelWebsockHeader { |
| 129 | unsigned char b0; |
| 130 | unsigned char b1; |
| 131 | union { |
| 132 | struct QEMU_PACKED { |
| 133 | uint16_t l16; |
| 134 | QIOChannelWebsockMask m16; |
| 135 | } s16; |
| 136 | struct QEMU_PACKED { |
| 137 | uint64_t l64; |
| 138 | QIOChannelWebsockMask m64; |
| 139 | } s64; |
| 140 | QIOChannelWebsockMask m; |
| 141 | } u; |
| 142 | }; |
| 143 | |
| 144 | typedef struct QIOChannelWebsockHTTPHeader QIOChannelWebsockHTTPHeader; |
| 145 | |
| 146 | struct QIOChannelWebsockHTTPHeader { |
| 147 | char *name; |
| 148 | char *value; |
| 149 | }; |
| 150 | |
| 151 | enum { |
| 152 | QIO_CHANNEL_WEBSOCK_OPCODE_CONTINUATION = 0x0, |
| 153 | QIO_CHANNEL_WEBSOCK_OPCODE_TEXT_FRAME = 0x1, |
| 154 | QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME = 0x2, |
| 155 | QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE = 0x8, |
| 156 | QIO_CHANNEL_WEBSOCK_OPCODE_PING = 0x9, |
| 157 | QIO_CHANNEL_WEBSOCK_OPCODE_PONG = 0xA |
| 158 | }; |
| 159 | |
| 160 | static void G_GNUC_PRINTF(2, 3) |
| 161 | qio_channel_websock_handshake_send_res(QIOChannelWebsock *ioc, |
| 162 | const char *resmsg, |
| 163 | ...) |
| 164 | { |
| 165 | va_list vargs; |
| 166 | char *response; |
| 167 | size_t responselen; |
| 168 | |
| 169 | va_start(vargs, resmsg); |
| 170 | response = g_strdup_vprintf(resmsg, vargs); |
| 171 | responselen = strlen(response); |
| 172 | buffer_reserve(&ioc->encoutput, responselen); |
| 173 | buffer_append(&ioc->encoutput, response, responselen); |
| 174 | g_free(response); |
| 175 | va_end(vargs); |
| 176 | } |
| 177 | |
| 178 | static gchar *qio_channel_websock_date_str(void) |
| 179 | { |
| 180 | g_autoptr(GDateTime) now = g_date_time_new_now_utc(); |
| 181 | |
| 182 | return g_date_time_format(now, "%a, %d %b %Y %H:%M:%S GMT"); |
| 183 | } |
| 184 | |
| 185 | static void qio_channel_websock_handshake_send_res_err(QIOChannelWebsock *ioc, |
| 186 | const char *resdata) |
| 187 | { |
| 188 | char *date = qio_channel_websock_date_str(); |
| 189 | qio_channel_websock_handshake_send_res(ioc, resdata, date); |
| 190 | g_free(date); |
| 191 | } |
| 192 | |
| 193 | enum { |
| 194 | QIO_CHANNEL_WEBSOCK_STATUS_NORMAL = 1000, |
| 195 | QIO_CHANNEL_WEBSOCK_STATUS_PROTOCOL_ERR = 1002, |
| 196 | QIO_CHANNEL_WEBSOCK_STATUS_INVALID_DATA = 1003, |
| 197 | QIO_CHANNEL_WEBSOCK_STATUS_POLICY = 1008, |
| 198 | QIO_CHANNEL_WEBSOCK_STATUS_TOO_LARGE = 1009, |
| 199 | QIO_CHANNEL_WEBSOCK_STATUS_SERVER_ERR = 1011, |
| 200 | }; |
| 201 | |
| 202 | static size_t |
| 203 | qio_channel_websock_extract_headers(QIOChannelWebsock *ioc, |
| 204 | char *buffer, |
| 205 | QIOChannelWebsockHTTPHeader *hdrs, |
| 206 | size_t nhdrsalloc, |
| 207 | Error **errp) |
| 208 | { |
| 209 | char *nl, *sep, *tmp; |
| 210 | size_t nhdrs = 0; |
| 211 | |
| 212 | /* |
| 213 | * First parse the HTTP protocol greeting of format: |
| 214 | * |
| 215 | * $METHOD $PATH $VERSION |
| 216 | * |
| 217 | * e.g. |
| 218 | * |
| 219 | * GET / HTTP/1.1 |
| 220 | */ |
| 221 | |
| 222 | nl = strstr(buffer, QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM); |
| 223 | if (!nl) { |
| 224 | error_setg(errp, "Missing HTTP header delimiter"); |
| 225 | goto bad_request; |
| 226 | } |
| 227 | *nl = '\0'; |
| 228 | trace_qio_channel_websock_http_greeting(ioc, buffer); |
| 229 | |
| 230 | tmp = strchr(buffer, ' '); |
| 231 | if (!tmp) { |
| 232 | error_setg(errp, "Missing HTTP path delimiter"); |
| 233 | return 0; |
| 234 | } |
| 235 | *tmp = '\0'; |
| 236 | |
| 237 | if (!g_str_equal(buffer, QIO_CHANNEL_WEBSOCK_HTTP_METHOD)) { |
| 238 | error_setg(errp, "Unsupported HTTP method %s", buffer); |
| 239 | goto bad_request; |
| 240 | } |
| 241 | |
| 242 | buffer = tmp + 1; |
| 243 | tmp = strchr(buffer, ' '); |
| 244 | if (!tmp) { |
| 245 | error_setg(errp, "Missing HTTP version delimiter"); |
| 246 | goto bad_request; |
| 247 | } |
| 248 | *tmp = '\0'; |
| 249 | |
| 250 | if (!g_str_equal(buffer, QIO_CHANNEL_WEBSOCK_HTTP_PATH)) { |
| 251 | qio_channel_websock_handshake_send_res_err( |
| 252 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_NOT_FOUND); |
| 253 | error_setg(errp, "Unexpected HTTP path %s", buffer); |
| 254 | return 0; |
| 255 | } |
| 256 | |
| 257 | buffer = tmp + 1; |
| 258 | |
| 259 | if (!g_str_equal(buffer, QIO_CHANNEL_WEBSOCK_HTTP_VERSION)) { |
| 260 | error_setg(errp, "Unsupported HTTP version %s", buffer); |
| 261 | goto bad_request; |
| 262 | } |
| 263 | |
| 264 | buffer = nl + strlen(QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM); |
| 265 | |
| 266 | /* |
| 267 | * Now parse all the header fields of format |
| 268 | * |
| 269 | * $NAME: $VALUE |
| 270 | * |
| 271 | * e.g. |
| 272 | * |
| 273 | * Cache-control: no-cache |
| 274 | */ |
| 275 | do { |
| 276 | QIOChannelWebsockHTTPHeader *hdr; |
| 277 | |
| 278 | nl = strstr(buffer, QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM); |
| 279 | if (nl) { |
| 280 | *nl = '\0'; |
| 281 | } |
| 282 | |
| 283 | sep = strchr(buffer, ':'); |
| 284 | if (!sep) { |
| 285 | error_setg(errp, "Malformed HTTP header"); |
| 286 | goto bad_request; |
| 287 | } |
| 288 | *sep = '\0'; |
| 289 | sep++; |
| 290 | while (*sep == ' ') { |
| 291 | sep++; |
| 292 | } |
| 293 | |
| 294 | if (nhdrs >= nhdrsalloc) { |
| 295 | error_setg(errp, "Too many HTTP headers"); |
| 296 | goto bad_request; |
| 297 | } |
| 298 | |
| 299 | hdr = &hdrs[nhdrs++]; |
| 300 | hdr->name = buffer; |
| 301 | hdr->value = sep; |
| 302 | |
| 303 | /* Canonicalize header name for easier identification later */ |
| 304 | for (tmp = hdr->name; *tmp; tmp++) { |
| 305 | *tmp = g_ascii_tolower(*tmp); |
| 306 | } |
| 307 | |
| 308 | if (nl) { |
| 309 | buffer = nl + strlen(QIO_CHANNEL_WEBSOCK_HANDSHAKE_DELIM); |
| 310 | } |
| 311 | } while (nl != NULL); |
| 312 | |
| 313 | return nhdrs; |
| 314 | |
| 315 | bad_request: |
| 316 | qio_channel_websock_handshake_send_res_err( |
| 317 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_BAD_REQUEST); |
| 318 | return 0; |
| 319 | } |
| 320 | |
| 321 | static const char * |
| 322 | qio_channel_websock_find_header(QIOChannelWebsockHTTPHeader *hdrs, |
| 323 | size_t nhdrs, |
| 324 | const char *name) |
| 325 | { |
| 326 | size_t i; |
| 327 | |
| 328 | for (i = 0; i < nhdrs; i++) { |
| 329 | if (g_str_equal(hdrs[i].name, name)) { |
| 330 | return hdrs[i].value; |
| 331 | } |
| 332 | } |
| 333 | |
| 334 | return NULL; |
| 335 | } |
| 336 | |
| 337 | |
| 338 | static void qio_channel_websock_handshake_send_res_ok(QIOChannelWebsock *ioc, |
| 339 | const char *key, |
| 340 | const bool use_protocols, |
| 341 | Error **errp) |
| 342 | { |
| 343 | char combined_key[QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN + |
| 344 | QIO_CHANNEL_WEBSOCK_GUID_LEN + 1]; |
| 345 | char *accept = NULL; |
| 346 | char *date = NULL; |
| 347 | |
| 348 | g_strlcpy(combined_key, key, QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN + 1); |
| 349 | g_strlcat(combined_key, QIO_CHANNEL_WEBSOCK_GUID, |
| 350 | QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN + |
| 351 | QIO_CHANNEL_WEBSOCK_GUID_LEN + 1); |
| 352 | |
| 353 | /* hash and encode it */ |
| 354 | if (qcrypto_hash_base64(QCRYPTO_HASH_ALGO_SHA1, |
| 355 | combined_key, |
| 356 | QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN + |
| 357 | QIO_CHANNEL_WEBSOCK_GUID_LEN, |
| 358 | &accept, |
| 359 | errp) < 0) { |
| 360 | qio_channel_websock_handshake_send_res_err( |
| 361 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_SERVER_ERR); |
| 362 | return; |
| 363 | } |
| 364 | |
| 365 | date = qio_channel_websock_date_str(); |
| 366 | if (use_protocols) { |
| 367 | qio_channel_websock_handshake_send_res( |
| 368 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_WITH_PROTO_RES_OK, |
| 369 | date, accept); |
| 370 | } else { |
| 371 | qio_channel_websock_handshake_send_res( |
| 372 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_OK, date, accept); |
| 373 | } |
| 374 | |
| 375 | g_free(date); |
| 376 | g_free(accept); |
| 377 | } |
| 378 | |
| 379 | static void qio_channel_websock_handshake_process(QIOChannelWebsock *ioc, |
| 380 | char *buffer, |
| 381 | Error **errp) |
| 382 | { |
| 383 | QIOChannelWebsockHTTPHeader hdrs[32]; |
| 384 | size_t nhdrs = G_N_ELEMENTS(hdrs); |
| 385 | const char *protocols = NULL, *version = NULL, *key = NULL, |
| 386 | *host = NULL, *connection = NULL, *upgrade = NULL; |
| 387 | char **connectionv; |
| 388 | bool upgraded = false; |
| 389 | size_t i; |
| 390 | |
| 391 | nhdrs = qio_channel_websock_extract_headers(ioc, buffer, hdrs, nhdrs, errp); |
| 392 | if (!nhdrs) { |
| 393 | return; |
| 394 | } |
| 395 | |
| 396 | protocols = qio_channel_websock_find_header( |
| 397 | hdrs, nhdrs, QIO_CHANNEL_WEBSOCK_HEADER_PROTOCOL); |
| 398 | |
| 399 | version = qio_channel_websock_find_header( |
| 400 | hdrs, nhdrs, QIO_CHANNEL_WEBSOCK_HEADER_VERSION); |
| 401 | if (!version) { |
| 402 | error_setg(errp, "Missing websocket version header data"); |
| 403 | goto bad_request; |
| 404 | } |
| 405 | |
| 406 | key = qio_channel_websock_find_header( |
| 407 | hdrs, nhdrs, QIO_CHANNEL_WEBSOCK_HEADER_KEY); |
| 408 | if (!key) { |
| 409 | error_setg(errp, "Missing websocket key header data"); |
| 410 | goto bad_request; |
| 411 | } |
| 412 | |
| 413 | host = qio_channel_websock_find_header( |
| 414 | hdrs, nhdrs, QIO_CHANNEL_WEBSOCK_HEADER_HOST); |
| 415 | if (!host) { |
| 416 | error_setg(errp, "Missing websocket host header data"); |
| 417 | goto bad_request; |
| 418 | } |
| 419 | |
| 420 | connection = qio_channel_websock_find_header( |
| 421 | hdrs, nhdrs, QIO_CHANNEL_WEBSOCK_HEADER_CONNECTION); |
| 422 | if (!connection) { |
| 423 | error_setg(errp, "Missing websocket connection header data"); |
| 424 | goto bad_request; |
| 425 | } |
| 426 | |
| 427 | upgrade = qio_channel_websock_find_header( |
| 428 | hdrs, nhdrs, QIO_CHANNEL_WEBSOCK_HEADER_UPGRADE); |
| 429 | if (!upgrade) { |
| 430 | error_setg(errp, "Missing websocket upgrade header data"); |
| 431 | goto bad_request; |
| 432 | } |
| 433 | |
| 434 | trace_qio_channel_websock_http_request(ioc, protocols, version, |
| 435 | host, connection, upgrade, key); |
| 436 | |
| 437 | if (protocols) { |
| 438 | if (!g_strrstr(protocols, QIO_CHANNEL_WEBSOCK_PROTOCOL_BINARY)) { |
| 439 | error_setg(errp, "No '%s' protocol is supported by client '%s'", |
| 440 | QIO_CHANNEL_WEBSOCK_PROTOCOL_BINARY, protocols); |
| 441 | goto bad_request; |
| 442 | } |
| 443 | } |
| 444 | |
| 445 | if (!g_str_equal(version, QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION)) { |
| 446 | error_setg(errp, "Version '%s' is not supported by client '%s'", |
| 447 | QIO_CHANNEL_WEBSOCK_SUPPORTED_VERSION, version); |
| 448 | goto bad_request; |
| 449 | } |
| 450 | |
| 451 | if (strlen(key) != QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN) { |
| 452 | error_setg(errp, "Key length '%zu' was not as expected '%d'", |
| 453 | strlen(key), QIO_CHANNEL_WEBSOCK_CLIENT_KEY_LEN); |
| 454 | goto bad_request; |
| 455 | } |
| 456 | |
| 457 | connectionv = g_strsplit(connection, ",", 0); |
| 458 | for (i = 0; connectionv != NULL && connectionv[i] != NULL; i++) { |
| 459 | g_strstrip(connectionv[i]); |
| 460 | if (g_ascii_strcasecmp(connectionv[i], |
| 461 | QIO_CHANNEL_WEBSOCK_CONNECTION_UPGRADE) == 0) { |
| 462 | upgraded = true; |
| 463 | } |
| 464 | } |
| 465 | g_strfreev(connectionv); |
| 466 | if (!upgraded) { |
| 467 | error_setg(errp, "No connection upgrade requested '%s'", connection); |
| 468 | goto bad_request; |
| 469 | } |
| 470 | |
| 471 | if (g_ascii_strcasecmp(upgrade, QIO_CHANNEL_WEBSOCK_UPGRADE_WEBSOCKET) != 0) { |
| 472 | error_setg(errp, "Incorrect upgrade method '%s'", upgrade); |
| 473 | goto bad_request; |
| 474 | } |
| 475 | |
| 476 | qio_channel_websock_handshake_send_res_ok(ioc, key, !!protocols, errp); |
| 477 | return; |
| 478 | |
| 479 | bad_request: |
| 480 | qio_channel_websock_handshake_send_res_err( |
| 481 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_BAD_REQUEST); |
| 482 | } |
| 483 | |
| 484 | static int qio_channel_websock_handshake_read(QIOChannelWebsock *ioc, |
| 485 | Error **errp) |
| 486 | { |
| 487 | char *handshake_end; |
| 488 | ssize_t ret; |
| 489 | /* Typical HTTP headers from novnc are 512 bytes, so limiting |
| 490 | * total header size to 4096 is easily enough. */ |
| 491 | size_t want = 4096 - ioc->encinput.offset; |
| 492 | buffer_reserve(&ioc->encinput, want); |
| 493 | ret = qio_channel_read(ioc->master, |
| 494 | (char *)buffer_end(&ioc->encinput), want, errp); |
| 495 | if (ret < 0) { |
| 496 | return -1; |
| 497 | } |
| 498 | ioc->encinput.offset += ret; |
| 499 | |
| 500 | handshake_end = g_strstr_len((char *)ioc->encinput.buffer, |
| 501 | ioc->encinput.offset, |
| 502 | QIO_CHANNEL_WEBSOCK_HANDSHAKE_END); |
| 503 | if (!handshake_end) { |
| 504 | if (ioc->encinput.offset >= 4096) { |
| 505 | qio_channel_websock_handshake_send_res_err( |
| 506 | ioc, QIO_CHANNEL_WEBSOCK_HANDSHAKE_RES_TOO_LARGE); |
| 507 | error_setg(errp, |
| 508 | "End of headers not found in first 4096 bytes"); |
| 509 | return 1; |
| 510 | } else if (ret == 0) { |
| 511 | error_setg(errp, |
| 512 | "End of headers not found before connection closed"); |
| 513 | return -1; |
| 514 | } |
| 515 | return 0; |
| 516 | } |
| 517 | *handshake_end = '\0'; |
| 518 | |
| 519 | qio_channel_websock_handshake_process(ioc, |
| 520 | (char *)ioc->encinput.buffer, |
| 521 | errp); |
| 522 | |
| 523 | buffer_advance(&ioc->encinput, |
| 524 | handshake_end - (char *)ioc->encinput.buffer + |
| 525 | strlen(QIO_CHANNEL_WEBSOCK_HANDSHAKE_END)); |
| 526 | return 1; |
| 527 | } |
| 528 | |
| 529 | typedef struct QIOChannelWebsockData { |
| 530 | QIOTask *task; |
| 531 | } QIOChannelWebsockData; |
| 532 | |
| 533 | static void qio_channel_websock_data_free(gpointer user_data) |
| 534 | { |
| 535 | QIOChannelWebsockData *data = user_data; |
| 536 | /* |
| 537 | * Usually 'task' will be NULL since the GSource |
| 538 | * callback will either complete the task or pass |
| 539 | * it on to a new GSource. We'll see a non-NULL |
| 540 | * task here only if the GSource was released before |
| 541 | * its callback triggers |
| 542 | */ |
| 543 | if (data->task) { |
| 544 | qio_task_free(data->task); |
| 545 | } |
| 546 | g_free(data); |
| 547 | } |
| 548 | |
| 549 | static gboolean qio_channel_websock_handshake_send(QIOChannel *ioc, |
| 550 | GIOCondition condition, |
| 551 | gpointer user_data) |
| 552 | { |
| 553 | QIOChannelWebsockData *data = user_data; |
| 554 | QIOTask *task = data->task; |
| 555 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK( |
| 556 | qio_task_get_source(task)); |
| 557 | Error *err = NULL; |
| 558 | ssize_t ret; |
| 559 | |
| 560 | ret = qio_channel_write(wioc->master, |
| 561 | (char *)wioc->encoutput.buffer, |
| 562 | wioc->encoutput.offset, |
| 563 | &err); |
| 564 | |
| 565 | if (ret < 0) { |
| 566 | trace_qio_channel_websock_handshake_fail(ioc, error_get_pretty(err)); |
| 567 | qio_task_set_error(task, err); |
| 568 | qio_task_complete(task); |
| 569 | wioc->hs_io_tag = 0; |
| 570 | return FALSE; |
| 571 | } |
| 572 | |
| 573 | buffer_advance(&wioc->encoutput, ret); |
| 574 | if (wioc->encoutput.offset == 0) { |
| 575 | if (wioc->io_err) { |
| 576 | trace_qio_channel_websock_handshake_fail( |
| 577 | ioc, error_get_pretty(wioc->io_err)); |
| 578 | qio_task_set_error(task, wioc->io_err); |
| 579 | wioc->io_err = NULL; |
| 580 | qio_task_complete(task); |
| 581 | } else { |
| 582 | trace_qio_channel_websock_handshake_complete(ioc); |
| 583 | qio_task_complete(task); |
| 584 | } |
| 585 | wioc->hs_io_tag = 0; |
| 586 | return FALSE; |
| 587 | } |
| 588 | trace_qio_channel_websock_handshake_pending(ioc, G_IO_OUT); |
| 589 | return TRUE; |
| 590 | } |
| 591 | |
| 592 | static gboolean qio_channel_websock_handshake_io(QIOChannel *ioc, |
| 593 | GIOCondition condition, |
| 594 | gpointer user_data) |
| 595 | { |
| 596 | QIOChannelWebsockData *data = user_data, *newdata = NULL; |
| 597 | QIOTask *task = data->task; |
| 598 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK( |
| 599 | qio_task_get_source(task)); |
| 600 | Error *err = NULL; |
| 601 | int ret; |
| 602 | |
| 603 | ret = qio_channel_websock_handshake_read(wioc, &err); |
| 604 | if (ret < 0) { |
| 605 | /* |
| 606 | * We only take this path on a fatal I/O error reading from |
| 607 | * client connection, as most of the time we have an |
| 608 | * HTTP 4xx err response to send instead |
| 609 | */ |
| 610 | trace_qio_channel_websock_handshake_fail(ioc, error_get_pretty(err)); |
| 611 | qio_task_set_error(task, err); |
| 612 | qio_task_complete(task); |
| 613 | wioc->hs_io_tag = 0; |
| 614 | return FALSE; |
| 615 | } |
| 616 | if (ret == 0) { |
| 617 | trace_qio_channel_websock_handshake_pending(ioc, G_IO_IN); |
| 618 | /* need more data still */ |
| 619 | return TRUE; |
| 620 | } |
| 621 | |
| 622 | error_propagate(&wioc->io_err, err); |
| 623 | |
| 624 | trace_qio_channel_websock_handshake_reply(ioc); |
| 625 | newdata = g_new0(QIOChannelWebsockData, 1); |
| 626 | newdata->task = g_steal_pointer(&data->task); |
| 627 | wioc->hs_io_tag = qio_channel_add_watch( |
| 628 | wioc->master, |
| 629 | G_IO_OUT, |
| 630 | qio_channel_websock_handshake_send, |
| 631 | newdata, |
| 632 | qio_channel_websock_data_free); |
| 633 | return FALSE; |
| 634 | } |
| 635 | |
| 636 | |
| 637 | static void qio_channel_websock_encode(QIOChannelWebsock *ioc, |
| 638 | uint8_t opcode, |
| 639 | const struct iovec *iov, |
| 640 | size_t niov, |
| 641 | size_t size) |
| 642 | { |
| 643 | size_t header_size; |
| 644 | size_t i; |
| 645 | union { |
| 646 | char buf[QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT]; |
| 647 | QIOChannelWebsockHeader ws; |
| 648 | } header; |
| 649 | |
| 650 | assert(size <= iov_size(iov, niov)); |
| 651 | |
| 652 | header.ws.b0 = QIO_CHANNEL_WEBSOCK_HEADER_FIELD_FIN | |
| 653 | (opcode & QIO_CHANNEL_WEBSOCK_HEADER_FIELD_OPCODE); |
| 654 | if (size < QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_7_BIT) { |
| 655 | header.ws.b1 = (uint8_t)size; |
| 656 | header_size = QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT; |
| 657 | } else if (size < QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_THRESHOLD_16_BIT) { |
| 658 | header.ws.b1 = QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT; |
| 659 | header.ws.u.s16.l16 = cpu_to_be16((uint16_t)size); |
| 660 | header_size = QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT; |
| 661 | } else { |
| 662 | header.ws.b1 = QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_64_BIT; |
| 663 | header.ws.u.s64.l64 = cpu_to_be64(size); |
| 664 | header_size = QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT; |
| 665 | } |
| 666 | header_size -= QIO_CHANNEL_WEBSOCK_HEADER_LEN_MASK; |
| 667 | |
| 668 | trace_qio_channel_websock_encode(ioc, opcode, header_size, size); |
| 669 | buffer_reserve(&ioc->encoutput, header_size + size); |
| 670 | buffer_append(&ioc->encoutput, header.buf, header_size); |
| 671 | for (i = 0; i < niov && size != 0; i++) { |
| 672 | size_t want = iov[i].iov_len; |
| 673 | if (want > size) { |
| 674 | want = size; |
| 675 | } |
| 676 | buffer_append(&ioc->encoutput, iov[i].iov_base, want); |
| 677 | size -= want; |
| 678 | } |
| 679 | } |
| 680 | |
| 681 | |
| 682 | static ssize_t qio_channel_websock_write_wire(QIOChannelWebsock *, Error **); |
| 683 | |
| 684 | |
| 685 | static void qio_channel_websock_write_close(QIOChannelWebsock *ioc, |
| 686 | uint16_t code, const char *reason) |
| 687 | { |
| 688 | struct iovec iov[2] = { |
| 689 | { .iov_base = &code, .iov_len = sizeof(code) }, |
| 690 | }; |
| 691 | size_t niov = 1; |
| 692 | size_t size = iov[0].iov_len; |
| 693 | |
| 694 | cpu_to_be16s(&code); |
| 695 | |
| 696 | if (reason) { |
| 697 | iov[1].iov_base = (void *)reason; |
| 698 | iov[1].iov_len = strlen(reason); |
| 699 | size += iov[1].iov_len; |
| 700 | niov++; |
| 701 | } |
| 702 | qio_channel_websock_encode(ioc, QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE, |
| 703 | iov, niov, size); |
| 704 | qio_channel_websock_write_wire(ioc, NULL); |
| 705 | qio_channel_shutdown(ioc->master, QIO_CHANNEL_SHUTDOWN_BOTH, NULL); |
| 706 | } |
| 707 | |
| 708 | |
| 709 | static int qio_channel_websock_decode_header(QIOChannelWebsock *ioc, |
| 710 | Error **errp) |
| 711 | { |
| 712 | unsigned char opcode, fin, has_mask; |
| 713 | size_t header_size; |
| 714 | size_t payload_len; |
| 715 | QIOChannelWebsockHeader *header = |
| 716 | (QIOChannelWebsockHeader *)ioc->encinput.buffer; |
| 717 | |
| 718 | if (ioc->payload_remain) { |
| 719 | error_setg(errp, |
| 720 | "Decoding header but %zu bytes of payload remain", |
| 721 | ioc->payload_remain); |
| 722 | qio_channel_websock_write_close( |
| 723 | ioc, QIO_CHANNEL_WEBSOCK_STATUS_SERVER_ERR, |
| 724 | "internal server error"); |
| 725 | return -1; |
| 726 | } |
| 727 | if (ioc->encinput.offset < QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT) { |
| 728 | /* header not complete */ |
| 729 | return QIO_CHANNEL_ERR_BLOCK; |
| 730 | } |
| 731 | |
| 732 | fin = header->b0 & QIO_CHANNEL_WEBSOCK_HEADER_FIELD_FIN; |
| 733 | opcode = header->b0 & QIO_CHANNEL_WEBSOCK_HEADER_FIELD_OPCODE; |
| 734 | has_mask = header->b1 & QIO_CHANNEL_WEBSOCK_HEADER_FIELD_HAS_MASK; |
| 735 | payload_len = header->b1 & QIO_CHANNEL_WEBSOCK_HEADER_FIELD_PAYLOAD_LEN; |
| 736 | |
| 737 | /* Save or restore opcode. */ |
| 738 | if (opcode) { |
| 739 | ioc->opcode = opcode; |
| 740 | } else { |
| 741 | opcode = ioc->opcode; |
| 742 | } |
| 743 | |
| 744 | trace_qio_channel_websock_header_partial_decode(ioc, payload_len, |
| 745 | fin, opcode, (int)has_mask); |
| 746 | |
| 747 | if (opcode == QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE) { |
| 748 | /* disconnect */ |
| 749 | return 0; |
| 750 | } |
| 751 | |
| 752 | /* Websocket frame sanity check: |
| 753 | * * Fragmentation is only supported for binary frames. |
| 754 | * * All frames sent by a client MUST be masked. |
| 755 | * * Only binary and ping/pong encoding is supported. |
| 756 | */ |
| 757 | if (!fin) { |
| 758 | if (opcode != QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME) { |
| 759 | error_setg(errp, "only binary websocket frames may be fragmented"); |
| 760 | qio_channel_websock_write_close( |
| 761 | ioc, QIO_CHANNEL_WEBSOCK_STATUS_POLICY , |
| 762 | "only binary frames may be fragmented"); |
| 763 | return -1; |
| 764 | } |
| 765 | } else { |
| 766 | if (opcode != QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME && |
| 767 | opcode != QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE && |
| 768 | opcode != QIO_CHANNEL_WEBSOCK_OPCODE_PING && |
| 769 | opcode != QIO_CHANNEL_WEBSOCK_OPCODE_PONG) { |
| 770 | error_setg(errp, "unsupported opcode: 0x%04x; only binary, close, " |
| 771 | "ping, and pong websocket frames are supported", opcode); |
| 772 | qio_channel_websock_write_close( |
| 773 | ioc, QIO_CHANNEL_WEBSOCK_STATUS_INVALID_DATA , |
| 774 | "only binary, close, ping, and pong frames are supported"); |
| 775 | return -1; |
| 776 | } |
| 777 | } |
| 778 | if (!has_mask) { |
| 779 | error_setg(errp, "client websocket frames must be masked"); |
| 780 | qio_channel_websock_write_close( |
| 781 | ioc, QIO_CHANNEL_WEBSOCK_STATUS_PROTOCOL_ERR, |
| 782 | "client frames must be masked"); |
| 783 | return -1; |
| 784 | } |
| 785 | |
| 786 | if (payload_len < QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT) { |
| 787 | ioc->payload_remain = payload_len; |
| 788 | header_size = QIO_CHANNEL_WEBSOCK_HEADER_LEN_7_BIT; |
| 789 | ioc->mask = header->u.m; |
| 790 | } else if (opcode & QIO_CHANNEL_WEBSOCK_CONTROL_OPCODE_MASK) { |
| 791 | error_setg(errp, "websocket control frame is too large"); |
| 792 | qio_channel_websock_write_close( |
| 793 | ioc, QIO_CHANNEL_WEBSOCK_STATUS_PROTOCOL_ERR, |
| 794 | "control frame is too large"); |
| 795 | return -1; |
| 796 | } else if (payload_len == QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_16_BIT && |
| 797 | ioc->encinput.offset >= QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT) { |
| 798 | ioc->payload_remain = be16_to_cpu(header->u.s16.l16); |
| 799 | header_size = QIO_CHANNEL_WEBSOCK_HEADER_LEN_16_BIT; |
| 800 | ioc->mask = header->u.s16.m16; |
| 801 | } else if (payload_len == QIO_CHANNEL_WEBSOCK_PAYLOAD_LEN_MAGIC_64_BIT && |
| 802 | ioc->encinput.offset >= QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT) { |
| 803 | ioc->payload_remain = be64_to_cpu(header->u.s64.l64); |
| 804 | header_size = QIO_CHANNEL_WEBSOCK_HEADER_LEN_64_BIT; |
| 805 | ioc->mask = header->u.s64.m64; |
| 806 | } else { |
| 807 | /* header not complete */ |
| 808 | return QIO_CHANNEL_ERR_BLOCK; |
| 809 | } |
| 810 | |
| 811 | trace_qio_channel_websock_header_full_decode( |
| 812 | ioc, header_size, ioc->payload_remain, ioc->mask.u); |
| 813 | buffer_advance(&ioc->encinput, header_size); |
| 814 | return 0; |
| 815 | } |
| 816 | |
| 817 | |
| 818 | static int qio_channel_websock_decode_payload(QIOChannelWebsock *ioc, |
| 819 | Error **errp) |
| 820 | { |
| 821 | size_t i; |
| 822 | size_t payload_len = 0; |
| 823 | uint32_t *payload32; |
| 824 | |
| 825 | if (ioc->payload_remain) { |
| 826 | /* If we aren't at the end of the payload, then drop |
| 827 | * off the last bytes, so we're always multiple of 4 |
| 828 | * for purpose of unmasking, except at end of payload |
| 829 | */ |
| 830 | if (ioc->encinput.offset < ioc->payload_remain) { |
| 831 | /* Wait for the entire payload before processing control frames |
| 832 | * because the payload will most likely be echoed back. */ |
| 833 | if (ioc->opcode & QIO_CHANNEL_WEBSOCK_CONTROL_OPCODE_MASK) { |
| 834 | return QIO_CHANNEL_ERR_BLOCK; |
| 835 | } |
| 836 | payload_len = ioc->encinput.offset - (ioc->encinput.offset % 4); |
| 837 | } else { |
| 838 | payload_len = ioc->payload_remain; |
| 839 | } |
| 840 | if (payload_len == 0) { |
| 841 | return QIO_CHANNEL_ERR_BLOCK; |
| 842 | } |
| 843 | |
| 844 | ioc->payload_remain -= payload_len; |
| 845 | |
| 846 | /* unmask frame */ |
| 847 | /* process 1 frame (32 bit op) */ |
| 848 | payload32 = (uint32_t *)ioc->encinput.buffer; |
| 849 | for (i = 0; i < payload_len / 4; i++) { |
| 850 | payload32[i] ^= ioc->mask.u; |
| 851 | } |
| 852 | /* process the remaining bytes (if any) */ |
| 853 | for (i *= 4; i < payload_len; i++) { |
| 854 | ioc->encinput.buffer[i] ^= ioc->mask.c[i % 4]; |
| 855 | } |
| 856 | } |
| 857 | |
| 858 | trace_qio_channel_websock_payload_decode( |
| 859 | ioc, ioc->opcode, ioc->payload_remain); |
| 860 | |
| 861 | if (ioc->opcode == QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME) { |
| 862 | if (payload_len) { |
| 863 | /* binary frames are passed on */ |
| 864 | buffer_reserve(&ioc->rawinput, payload_len); |
| 865 | buffer_append(&ioc->rawinput, ioc->encinput.buffer, payload_len); |
| 866 | } |
| 867 | } else if (ioc->opcode == QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE) { |
| 868 | /* close frames are echoed back */ |
| 869 | error_setg(errp, "websocket closed by peer"); |
| 870 | if (payload_len) { |
| 871 | /* echo client status */ |
| 872 | struct iovec iov = { .iov_base = ioc->encinput.buffer, |
| 873 | .iov_len = ioc->encinput.offset }; |
| 874 | qio_channel_websock_encode(ioc, QIO_CHANNEL_WEBSOCK_OPCODE_CLOSE, |
| 875 | &iov, 1, iov.iov_len); |
| 876 | qio_channel_websock_write_wire(ioc, NULL); |
| 877 | qio_channel_shutdown(ioc->master, QIO_CHANNEL_SHUTDOWN_BOTH, NULL); |
| 878 | } else { |
| 879 | /* send our own status */ |
| 880 | qio_channel_websock_write_close( |
| 881 | ioc, QIO_CHANNEL_WEBSOCK_STATUS_NORMAL, "peer requested close"); |
| 882 | } |
| 883 | return -1; |
| 884 | } else if (ioc->opcode == QIO_CHANNEL_WEBSOCK_OPCODE_PING) { |
| 885 | /* ping frames produce an immediate reply, as long as we've not still |
| 886 | * got a previous pong queued, in which case we drop the new pong */ |
| 887 | if (ioc->pong_remain == 0) { |
| 888 | struct iovec iov = { .iov_base = ioc->encinput.buffer, |
| 889 | .iov_len = ioc->encinput.offset }; |
| 890 | qio_channel_websock_encode(ioc, QIO_CHANNEL_WEBSOCK_OPCODE_PONG, |
| 891 | &iov, 1, iov.iov_len); |
| 892 | ioc->pong_remain = ioc->encoutput.offset; |
| 893 | } |
| 894 | } /* pong frames are ignored */ |
| 895 | |
| 896 | if (payload_len) { |
| 897 | buffer_advance(&ioc->encinput, payload_len); |
| 898 | } |
| 899 | return 0; |
| 900 | } |
| 901 | |
| 902 | |
| 903 | QIOChannelWebsock * |
| 904 | qio_channel_websock_new_server(QIOChannel *master) |
| 905 | { |
| 906 | QIOChannelWebsock *wioc; |
| 907 | QIOChannel *ioc; |
| 908 | |
| 909 | wioc = QIO_CHANNEL_WEBSOCK(object_new(TYPE_QIO_CHANNEL_WEBSOCK)); |
| 910 | ioc = QIO_CHANNEL(wioc); |
| 911 | |
| 912 | wioc->master = master; |
| 913 | ioc->follow_coroutine_ctx = master->follow_coroutine_ctx; |
| 914 | if (qio_channel_has_feature(master, QIO_CHANNEL_FEATURE_SHUTDOWN)) { |
| 915 | qio_channel_set_feature(ioc, QIO_CHANNEL_FEATURE_SHUTDOWN); |
| 916 | } |
| 917 | object_ref(OBJECT(master)); |
| 918 | |
| 919 | trace_qio_channel_websock_new_server(wioc, master); |
| 920 | return wioc; |
| 921 | } |
| 922 | |
| 923 | void qio_channel_websock_handshake(QIOChannelWebsock *ioc, |
| 924 | QIOTaskFunc func, |
| 925 | gpointer opaque, |
| 926 | GDestroyNotify destroy) |
| 927 | { |
| 928 | QIOChannelWebsockData *data = g_new0(QIOChannelWebsockData, 1); |
| 929 | |
| 930 | data->task = qio_task_new(OBJECT(ioc), |
| 931 | func, |
| 932 | opaque, |
| 933 | destroy); |
| 934 | |
| 935 | trace_qio_channel_websock_handshake_start(ioc); |
| 936 | trace_qio_channel_websock_handshake_pending(ioc, G_IO_IN); |
| 937 | ioc->hs_io_tag = qio_channel_add_watch( |
| 938 | ioc->master, |
| 939 | G_IO_IN, |
| 940 | qio_channel_websock_handshake_io, |
| 941 | data, |
| 942 | qio_channel_websock_data_free); |
| 943 | } |
| 944 | |
| 945 | |
| 946 | static void qio_channel_websock_finalize(Object *obj) |
| 947 | { |
| 948 | QIOChannelWebsock *ioc = QIO_CHANNEL_WEBSOCK(obj); |
| 949 | |
| 950 | buffer_free(&ioc->encinput); |
| 951 | buffer_free(&ioc->encoutput); |
| 952 | buffer_free(&ioc->rawinput); |
| 953 | g_clear_handle_id(&ioc->hs_io_tag, g_source_remove); |
| 954 | g_clear_handle_id(&ioc->io_tag, g_source_remove); |
| 955 | error_free(ioc->io_err); |
| 956 | object_unref(OBJECT(ioc->master)); |
| 957 | } |
| 958 | |
| 959 | |
| 960 | static ssize_t qio_channel_websock_read_wire(QIOChannelWebsock *ioc, |
| 961 | Error **errp) |
| 962 | { |
| 963 | ssize_t ret; |
| 964 | |
| 965 | if (ioc->encinput.offset < 4096) { |
| 966 | size_t want = 4096 - ioc->encinput.offset; |
| 967 | |
| 968 | buffer_reserve(&ioc->encinput, want); |
| 969 | ret = qio_channel_read(ioc->master, |
| 970 | (char *)ioc->encinput.buffer + |
| 971 | ioc->encinput.offset, |
| 972 | want, |
| 973 | errp); |
| 974 | if (ret < 0) { |
| 975 | return ret; |
| 976 | } |
| 977 | if (ret == 0 && ioc->encinput.offset == 0) { |
| 978 | ioc->io_eof = TRUE; |
| 979 | return 0; |
| 980 | } |
| 981 | ioc->encinput.offset += ret; |
| 982 | } |
| 983 | |
| 984 | while (ioc->encinput.offset != 0) { |
| 985 | if (ioc->payload_remain == 0) { |
| 986 | ret = qio_channel_websock_decode_header(ioc, errp); |
| 987 | if (ret < 0) { |
| 988 | return ret; |
| 989 | } |
| 990 | } |
| 991 | |
| 992 | ret = qio_channel_websock_decode_payload(ioc, errp); |
| 993 | if (ret < 0) { |
| 994 | return ret; |
| 995 | } |
| 996 | } |
| 997 | return 1; |
| 998 | } |
| 999 | |
| 1000 | |
| 1001 | static ssize_t qio_channel_websock_write_wire(QIOChannelWebsock *ioc, |
| 1002 | Error **errp) |
| 1003 | { |
| 1004 | ssize_t ret; |
| 1005 | ssize_t done = 0; |
| 1006 | |
| 1007 | while (ioc->encoutput.offset > 0) { |
| 1008 | ret = qio_channel_write(ioc->master, |
| 1009 | (char *)ioc->encoutput.buffer, |
| 1010 | ioc->encoutput.offset, |
| 1011 | errp); |
| 1012 | if (ret < 0) { |
| 1013 | if (ret == QIO_CHANNEL_ERR_BLOCK && |
| 1014 | done > 0) { |
| 1015 | return done; |
| 1016 | } else { |
| 1017 | return ret; |
| 1018 | } |
| 1019 | } |
| 1020 | buffer_advance(&ioc->encoutput, ret); |
| 1021 | done += ret; |
| 1022 | if (ioc->pong_remain < ret) { |
| 1023 | ioc->pong_remain = 0; |
| 1024 | } else { |
| 1025 | ioc->pong_remain -= ret; |
| 1026 | } |
| 1027 | } |
| 1028 | return done; |
| 1029 | } |
| 1030 | |
| 1031 | |
| 1032 | static void qio_channel_websock_flush_free(gpointer user_data) |
| 1033 | { |
| 1034 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(user_data); |
| 1035 | object_unref(OBJECT(wioc)); |
| 1036 | } |
| 1037 | |
| 1038 | static void qio_channel_websock_set_watch(QIOChannelWebsock *ioc); |
| 1039 | |
| 1040 | static gboolean qio_channel_websock_flush(QIOChannel *ioc, |
| 1041 | GIOCondition condition, |
| 1042 | gpointer user_data) |
| 1043 | { |
| 1044 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(user_data); |
| 1045 | ssize_t ret; |
| 1046 | |
| 1047 | if (condition & G_IO_OUT) { |
| 1048 | ret = qio_channel_websock_write_wire(wioc, &wioc->io_err); |
| 1049 | if (ret < 0) { |
| 1050 | goto cleanup; |
| 1051 | } |
| 1052 | } |
| 1053 | |
| 1054 | if (condition & G_IO_IN) { |
| 1055 | ret = qio_channel_websock_read_wire(wioc, &wioc->io_err); |
| 1056 | if (ret < 0) { |
| 1057 | goto cleanup; |
| 1058 | } |
| 1059 | } |
| 1060 | |
| 1061 | cleanup: |
| 1062 | qio_channel_websock_set_watch(wioc); |
| 1063 | return FALSE; |
| 1064 | } |
| 1065 | |
| 1066 | |
| 1067 | static void qio_channel_websock_unset_watch(QIOChannelWebsock *ioc) |
| 1068 | { |
| 1069 | g_clear_handle_id(&ioc->io_tag, g_source_remove); |
| 1070 | } |
| 1071 | |
| 1072 | static void qio_channel_websock_set_watch(QIOChannelWebsock *ioc) |
| 1073 | { |
| 1074 | GIOCondition cond = 0; |
| 1075 | |
| 1076 | qio_channel_websock_unset_watch(ioc); |
| 1077 | |
| 1078 | if (ioc->io_err) { |
| 1079 | return; |
| 1080 | } |
| 1081 | |
| 1082 | if (ioc->encoutput.offset) { |
| 1083 | cond |= G_IO_OUT; |
| 1084 | } |
| 1085 | if (ioc->encinput.offset < QIO_CHANNEL_WEBSOCK_MAX_BUFFER && |
| 1086 | !ioc->io_eof) { |
| 1087 | cond |= G_IO_IN; |
| 1088 | } |
| 1089 | |
| 1090 | if (cond) { |
| 1091 | object_ref(OBJECT(ioc)); |
| 1092 | ioc->io_tag = |
| 1093 | qio_channel_add_watch(ioc->master, |
| 1094 | cond, |
| 1095 | qio_channel_websock_flush, |
| 1096 | ioc, |
| 1097 | qio_channel_websock_flush_free); |
| 1098 | } |
| 1099 | } |
| 1100 | |
| 1101 | |
| 1102 | static ssize_t qio_channel_websock_readv(QIOChannel *ioc, |
| 1103 | const struct iovec *iov, |
| 1104 | size_t niov, |
| 1105 | int **fds, |
| 1106 | size_t *nfds, |
| 1107 | int flags, |
| 1108 | Error **errp) |
| 1109 | { |
| 1110 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1111 | size_t i; |
| 1112 | ssize_t got = 0; |
| 1113 | ssize_t ret; |
| 1114 | |
| 1115 | if (wioc->io_err) { |
| 1116 | error_propagate(errp, error_copy(wioc->io_err)); |
| 1117 | return -1; |
| 1118 | } |
| 1119 | |
| 1120 | if (!wioc->rawinput.offset) { |
| 1121 | ret = qio_channel_websock_read_wire(QIO_CHANNEL_WEBSOCK(ioc), errp); |
| 1122 | if (ret < 0) { |
| 1123 | return ret; |
| 1124 | } |
| 1125 | } |
| 1126 | |
| 1127 | for (i = 0 ; i < niov ; i++) { |
| 1128 | size_t want = iov[i].iov_len; |
| 1129 | if (want > (wioc->rawinput.offset - got)) { |
| 1130 | want = (wioc->rawinput.offset - got); |
| 1131 | } |
| 1132 | |
| 1133 | memcpy(iov[i].iov_base, |
| 1134 | wioc->rawinput.buffer + got, |
| 1135 | want); |
| 1136 | got += want; |
| 1137 | |
| 1138 | if (want < iov[i].iov_len) { |
| 1139 | break; |
| 1140 | } |
| 1141 | } |
| 1142 | |
| 1143 | buffer_advance(&wioc->rawinput, got); |
| 1144 | qio_channel_websock_set_watch(wioc); |
| 1145 | return got; |
| 1146 | } |
| 1147 | |
| 1148 | |
| 1149 | static ssize_t qio_channel_websock_writev(QIOChannel *ioc, |
| 1150 | const struct iovec *iov, |
| 1151 | size_t niov, |
| 1152 | int *fds, |
| 1153 | size_t nfds, |
| 1154 | int flags, |
| 1155 | Error **errp) |
| 1156 | { |
| 1157 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1158 | ssize_t want = iov_size(iov, niov); |
| 1159 | ssize_t avail; |
| 1160 | ssize_t ret; |
| 1161 | |
| 1162 | if (wioc->io_err) { |
| 1163 | error_propagate(errp, error_copy(wioc->io_err)); |
| 1164 | return -1; |
| 1165 | } |
| 1166 | |
| 1167 | if (wioc->io_eof) { |
| 1168 | error_setg(errp, "%s", "Broken pipe"); |
| 1169 | return -1; |
| 1170 | } |
| 1171 | |
| 1172 | avail = wioc->encoutput.offset >= QIO_CHANNEL_WEBSOCK_MAX_BUFFER ? |
| 1173 | 0 : (QIO_CHANNEL_WEBSOCK_MAX_BUFFER - wioc->encoutput.offset); |
| 1174 | if (want > avail) { |
| 1175 | want = avail; |
| 1176 | } |
| 1177 | |
| 1178 | if (want) { |
| 1179 | qio_channel_websock_encode(wioc, |
| 1180 | QIO_CHANNEL_WEBSOCK_OPCODE_BINARY_FRAME, |
| 1181 | iov, niov, want); |
| 1182 | } |
| 1183 | |
| 1184 | /* Even if want == 0, we'll try write_wire in case there's |
| 1185 | * pending data we could usefully flush out |
| 1186 | */ |
| 1187 | ret = qio_channel_websock_write_wire(wioc, errp); |
| 1188 | if (ret < 0 && |
| 1189 | ret != QIO_CHANNEL_ERR_BLOCK) { |
| 1190 | qio_channel_websock_unset_watch(wioc); |
| 1191 | return -1; |
| 1192 | } |
| 1193 | |
| 1194 | qio_channel_websock_set_watch(wioc); |
| 1195 | |
| 1196 | if (want == 0) { |
| 1197 | return QIO_CHANNEL_ERR_BLOCK; |
| 1198 | } |
| 1199 | |
| 1200 | return want; |
| 1201 | } |
| 1202 | |
| 1203 | static int qio_channel_websock_set_blocking(QIOChannel *ioc, |
| 1204 | bool enabled, |
| 1205 | Error **errp) |
| 1206 | { |
| 1207 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1208 | |
| 1209 | return qio_channel_set_blocking(wioc->master, enabled, errp) ? 0 : -1; |
| 1210 | } |
| 1211 | |
| 1212 | static void qio_channel_websock_set_delay(QIOChannel *ioc, |
| 1213 | bool enabled) |
| 1214 | { |
| 1215 | QIOChannelWebsock *tioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1216 | |
| 1217 | qio_channel_set_delay(tioc->master, enabled); |
| 1218 | } |
| 1219 | |
| 1220 | static void qio_channel_websock_set_cork(QIOChannel *ioc, |
| 1221 | bool enabled) |
| 1222 | { |
| 1223 | QIOChannelWebsock *tioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1224 | |
| 1225 | qio_channel_set_cork(tioc->master, enabled); |
| 1226 | } |
| 1227 | |
| 1228 | static int qio_channel_websock_shutdown(QIOChannel *ioc, |
| 1229 | QIOChannelShutdown how, |
| 1230 | Error **errp) |
| 1231 | { |
| 1232 | QIOChannelWebsock *tioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1233 | |
| 1234 | return qio_channel_shutdown(tioc->master, how, errp); |
| 1235 | } |
| 1236 | |
| 1237 | static int qio_channel_websock_close(QIOChannel *ioc, |
| 1238 | Error **errp) |
| 1239 | { |
| 1240 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1241 | |
| 1242 | trace_qio_channel_websock_close(ioc); |
| 1243 | buffer_free(&wioc->encinput); |
| 1244 | buffer_free(&wioc->encoutput); |
| 1245 | buffer_free(&wioc->rawinput); |
| 1246 | g_clear_handle_id(&wioc->hs_io_tag, g_source_remove); |
| 1247 | g_clear_handle_id(&wioc->io_tag, g_source_remove); |
| 1248 | if (wioc->io_err) { |
| 1249 | g_clear_pointer(&wioc->io_err, error_free); |
| 1250 | } |
| 1251 | return qio_channel_close(wioc->master, errp); |
| 1252 | } |
| 1253 | |
| 1254 | typedef struct QIOChannelWebsockSource QIOChannelWebsockSource; |
| 1255 | struct QIOChannelWebsockSource { |
| 1256 | GSource parent; |
| 1257 | QIOChannelWebsock *wioc; |
| 1258 | GIOCondition condition; |
| 1259 | }; |
| 1260 | |
| 1261 | static gboolean |
| 1262 | qio_channel_websock_source_check(GSource *source) |
| 1263 | { |
| 1264 | QIOChannelWebsockSource *wsource = (QIOChannelWebsockSource *)source; |
| 1265 | GIOCondition cond = 0; |
| 1266 | |
| 1267 | if (wsource->wioc->rawinput.offset) { |
| 1268 | cond |= G_IO_IN; |
| 1269 | } |
| 1270 | if (wsource->wioc->encoutput.offset < QIO_CHANNEL_WEBSOCK_MAX_BUFFER) { |
| 1271 | cond |= G_IO_OUT; |
| 1272 | } |
| 1273 | if (wsource->wioc->io_eof) { |
| 1274 | cond |= G_IO_HUP; |
| 1275 | } |
| 1276 | if (wsource->wioc->io_err) { |
| 1277 | cond |= G_IO_ERR; |
| 1278 | } |
| 1279 | |
| 1280 | return cond & wsource->condition; |
| 1281 | } |
| 1282 | |
| 1283 | static gboolean |
| 1284 | qio_channel_websock_source_prepare(GSource *source, |
| 1285 | gint *timeout) |
| 1286 | { |
| 1287 | *timeout = -1; |
| 1288 | return qio_channel_websock_source_check(source); |
| 1289 | } |
| 1290 | |
| 1291 | static gboolean |
| 1292 | qio_channel_websock_source_dispatch(GSource *source, |
| 1293 | GSourceFunc callback, |
| 1294 | gpointer user_data) |
| 1295 | { |
| 1296 | QIOChannelFunc func = (QIOChannelFunc)callback; |
| 1297 | QIOChannelWebsockSource *wsource = (QIOChannelWebsockSource *)source; |
| 1298 | |
| 1299 | return (*func)(QIO_CHANNEL(wsource->wioc), |
| 1300 | qio_channel_websock_source_check(source), |
| 1301 | user_data); |
| 1302 | } |
| 1303 | |
| 1304 | static void |
| 1305 | qio_channel_websock_source_finalize(GSource *source) |
| 1306 | { |
| 1307 | QIOChannelWebsockSource *ssource = (QIOChannelWebsockSource *)source; |
| 1308 | |
| 1309 | object_unref(OBJECT(ssource->wioc)); |
| 1310 | } |
| 1311 | |
| 1312 | GSourceFuncs qio_channel_websock_source_funcs = { |
| 1313 | qio_channel_websock_source_prepare, |
| 1314 | qio_channel_websock_source_check, |
| 1315 | qio_channel_websock_source_dispatch, |
| 1316 | qio_channel_websock_source_finalize |
| 1317 | }; |
| 1318 | |
| 1319 | static GSource *qio_channel_websock_create_watch(QIOChannel *ioc, |
| 1320 | GIOCondition condition) |
| 1321 | { |
| 1322 | QIOChannelWebsock *wioc = QIO_CHANNEL_WEBSOCK(ioc); |
| 1323 | QIOChannelWebsockSource *ssource; |
| 1324 | GSource *source; |
| 1325 | |
| 1326 | source = g_source_new(&qio_channel_websock_source_funcs, |
| 1327 | sizeof(QIOChannelWebsockSource)); |
| 1328 | ssource = (QIOChannelWebsockSource *)source; |
| 1329 | |
| 1330 | ssource->wioc = wioc; |
| 1331 | object_ref(OBJECT(wioc)); |
| 1332 | |
| 1333 | ssource->condition = condition; |
| 1334 | |
| 1335 | qio_channel_websock_set_watch(wioc); |
| 1336 | return source; |
| 1337 | } |
| 1338 | |
| 1339 | static void qio_channel_websock_class_init(ObjectClass *klass, |
| 1340 | const void *class_data G_GNUC_UNUSED) |
| 1341 | { |
| 1342 | QIOChannelClass *ioc_klass = QIO_CHANNEL_CLASS(klass); |
| 1343 | |
| 1344 | ioc_klass->io_writev = qio_channel_websock_writev; |
| 1345 | ioc_klass->io_readv = qio_channel_websock_readv; |
| 1346 | ioc_klass->io_set_blocking = qio_channel_websock_set_blocking; |
| 1347 | ioc_klass->io_set_cork = qio_channel_websock_set_cork; |
| 1348 | ioc_klass->io_set_delay = qio_channel_websock_set_delay; |
| 1349 | ioc_klass->io_close = qio_channel_websock_close; |
| 1350 | ioc_klass->io_shutdown = qio_channel_websock_shutdown; |
| 1351 | ioc_klass->io_create_watch = qio_channel_websock_create_watch; |
| 1352 | } |
| 1353 | |
| 1354 | static const TypeInfo qio_channel_websock_info = { |
| 1355 | .parent = TYPE_QIO_CHANNEL, |
| 1356 | .name = TYPE_QIO_CHANNEL_WEBSOCK, |
| 1357 | .instance_size = sizeof(QIOChannelWebsock), |
| 1358 | .instance_finalize = qio_channel_websock_finalize, |
| 1359 | .class_init = qio_channel_websock_class_init, |
| 1360 | }; |
| 1361 | |
| 1362 | static void qio_channel_websock_register_types(void) |
| 1363 | { |
| 1364 | type_register_static(&qio_channel_websock_info); |
| 1365 | } |
| 1366 | |
| 1367 | type_init(qio_channel_websock_register_types); |