xref: /openbmc/qemu/ui/vnc-ws.h (revision 4f4f6976)
1 /*
2  * QEMU VNC display driver: Websockets support
3  *
4  * Copyright (C) 2010 Joel Martin
5  * Copyright (C) 2012 Tim Hardeck
6  *
7  * This is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * This software is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this software; if not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __QEMU_UI_VNC_WS_H
22 #define __QEMU_UI_VNC_WS_H
23 
24 #define B64LEN(__x) (((__x + 2) / 3) * 12 / 3)
25 #define SHA1_DIGEST_LEN 20
26 
27 #define WS_ACCEPT_LEN (B64LEN(SHA1_DIGEST_LEN) + 1)
28 #define WS_CLIENT_KEY_LEN 24
29 #define WS_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
30 #define WS_GUID_LEN strlen(WS_GUID)
31 
32 #define WS_HANDSHAKE "HTTP/1.1 101 Switching Protocols\r\n\
33 Upgrade: websocket\r\n\
34 Connection: Upgrade\r\n\
35 Sec-WebSocket-Accept: %s\r\n\
36 Sec-WebSocket-Protocol: binary\r\n\
37 \r\n"
38 #define WS_HANDSHAKE_DELIM "\r\n"
39 #define WS_HANDSHAKE_END "\r\n\r\n"
40 #define WS_SUPPORTED_VERSION "13"
41 
42 #define WS_HEAD_MIN_LEN sizeof(uint16_t)
43 #define WS_HEAD_MAX_LEN (WS_HEAD_MIN_LEN + sizeof(uint64_t) + sizeof(uint32_t))
44 
45 typedef union WsMask {
46     char c[4];
47     uint32_t u;
48 } WsMask;
49 
50 typedef struct QEMU_PACKED WsHeader {
51     unsigned char b0;
52     unsigned char b1;
53     union {
54         struct QEMU_PACKED {
55             uint16_t l16;
56             WsMask m16;
57         } s16;
58         struct QEMU_PACKED {
59             uint64_t l64;
60             WsMask m64;
61         } s64;
62         WsMask m;
63     } u;
64 } WsHeader;
65 
66 enum {
67     WS_OPCODE_CONTINUATION = 0x0,
68     WS_OPCODE_TEXT_FRAME = 0x1,
69     WS_OPCODE_BINARY_FRAME = 0x2,
70     WS_OPCODE_CLOSE = 0x8,
71     WS_OPCODE_PING = 0x9,
72     WS_OPCODE_PONG = 0xA
73 };
74 
75 #ifdef CONFIG_VNC_TLS
76 void vncws_tls_handshake_io(void *opaque);
77 #endif /* CONFIG_VNC_TLS */
78 void vncws_handshake_read(void *opaque);
79 long vnc_client_write_ws(VncState *vs);
80 long vnc_client_read_ws(VncState *vs);
81 void vncws_process_handshake(VncState *vs, uint8_t *line, size_t size);
82 void vncws_encode_frame(Buffer *output, const void *payload,
83             const size_t payload_size);
84 int vncws_decode_frame_header(Buffer *input,
85                               size_t *header_size,
86                               size_t *payload_remain,
87                               WsMask *payload_mask);
88 int vncws_decode_frame_payload(Buffer *input,
89                                size_t *payload_remain, WsMask *payload_mask,
90                                uint8_t **payload, size_t *payload_size);
91 
92 #endif /* __QEMU_UI_VNC_WS_H */
93