1/*
2 * QEMU VNC display driver
3 *
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26
27#ifndef __QEMU_VNC_H
28#define __QEMU_VNC_H
29
30#include "qemu-common.h"
31#include "console.h"
32#include "monitor.h"
33#include "audio/audio.h"
34#include <zlib.h>
35
36#include "keymaps.h"
37
38// #define _VNC_DEBUG 1
39
40#ifdef _VNC_DEBUG
41#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
42#else
43#define VNC_DEBUG(fmt, ...) do { } while (0)
44#endif
45
46/*****************************************************************************
47 *
48 * Core data structures
49 *
50 *****************************************************************************/
51
52typedef struct Buffer
53{
54    size_t capacity;
55    size_t offset;
56    uint8_t *buffer;
57} Buffer;
58
59typedef struct VncState VncState;
60
61typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
62
63typedef void VncWritePixels(VncState *vs, void *data, int size);
64
65typedef void VncSendHextileTile(VncState *vs,
66                                int x, int y, int w, int h,
67                                void *last_bg,
68                                void *last_fg,
69                                int *has_bg, int *has_fg);
70
71#define VNC_MAX_WIDTH 2048
72#define VNC_MAX_HEIGHT 2048
73#define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
74
75#define VNC_AUTH_CHALLENGE_SIZE 16
76
77typedef struct VncDisplay VncDisplay;
78
79#ifdef CONFIG_VNC_TLS
80#include "vnc-tls.h"
81#include "vnc-auth-vencrypt.h"
82#endif
83#ifdef CONFIG_VNC_SASL
84#include "vnc-auth-sasl.h"
85#endif
86
87
88struct VncDisplay
89{
90    int lsock;
91    DisplayState *ds;
92    VncState *clients;
93    kbd_layout_t *kbd_layout;
94
95    char *display;
96    char *password;
97    int auth;
98#ifdef CONFIG_VNC_TLS
99    int subauth; /* Used by VeNCrypt */
100    VncDisplayTLS tls;
101#endif
102#ifdef CONFIG_VNC_SASL
103    VncDisplaySASL sasl;
104#endif
105};
106
107struct VncSurface
108{
109    uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
110    DisplaySurface *ds;
111};
112
113struct VncState
114{
115    QEMUTimer *timer;
116    int csock;
117
118    DisplayState *ds;
119    struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
120    struct VncSurface server;  /* vnc server surface */
121
122    VncDisplay *vd;
123    int need_update;
124    int force_update;
125    uint32_t features;
126    int absolute;
127    int last_x;
128    int last_y;
129
130    uint32_t vnc_encoding;
131    uint8_t tight_quality;
132    uint8_t tight_compression;
133
134    int major;
135    int minor;
136
137    char challenge[VNC_AUTH_CHALLENGE_SIZE];
138#ifdef CONFIG_VNC_TLS
139    VncStateTLS tls;
140#endif
141#ifdef CONFIG_VNC_SASL
142    VncStateSASL sasl;
143#endif
144
145    Buffer output;
146    Buffer input;
147    /* current output mode information */
148    VncWritePixels *write_pixels;
149    VncSendHextileTile *send_hextile_tile;
150    DisplaySurface clientds;
151
152    CaptureVoiceOut *audio_cap;
153    struct audsettings as;
154
155    VncReadEvent *read_handler;
156    size_t read_handler_expect;
157    /* input */
158    uint8_t modifiers_state[256];
159
160    Buffer zlib;
161    Buffer zlib_tmp;
162    z_stream zlib_stream[4];
163
164    VncState *next;
165};
166
167
168/*****************************************************************************
169 *
170 * Authentication modes
171 *
172 *****************************************************************************/
173
174enum {
175    VNC_AUTH_INVALID = 0,
176    VNC_AUTH_NONE = 1,
177    VNC_AUTH_VNC = 2,
178    VNC_AUTH_RA2 = 5,
179    VNC_AUTH_RA2NE = 6,
180    VNC_AUTH_TIGHT = 16,
181    VNC_AUTH_ULTRA = 17,
182    VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
183    VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
184    VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
185};
186
187enum {
188    VNC_AUTH_VENCRYPT_PLAIN = 256,
189    VNC_AUTH_VENCRYPT_TLSNONE = 257,
190    VNC_AUTH_VENCRYPT_TLSVNC = 258,
191    VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
192    VNC_AUTH_VENCRYPT_X509NONE = 260,
193    VNC_AUTH_VENCRYPT_X509VNC = 261,
194    VNC_AUTH_VENCRYPT_X509PLAIN = 262,
195    VNC_AUTH_VENCRYPT_X509SASL = 263,
196    VNC_AUTH_VENCRYPT_TLSSASL = 264,
197};
198
199
200/*****************************************************************************
201 *
202 * Encoding types
203 *
204 *****************************************************************************/
205
206#define VNC_ENCODING_RAW                  0x00000000
207#define VNC_ENCODING_COPYRECT             0x00000001
208#define VNC_ENCODING_RRE                  0x00000002
209#define VNC_ENCODING_CORRE                0x00000004
210#define VNC_ENCODING_HEXTILE              0x00000005
211#define VNC_ENCODING_ZLIB                 0x00000006
212#define VNC_ENCODING_TIGHT                0x00000007
213#define VNC_ENCODING_ZLIBHEX              0x00000008
214#define VNC_ENCODING_TRLE                 0x0000000f
215#define VNC_ENCODING_ZRLE                 0x00000010
216#define VNC_ENCODING_ZYWRLE               0x00000011
217#define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
218#define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
219#define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
220#define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
221#define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
222#define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
223#define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
224#define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
225#define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
226#define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
227#define VNC_ENCODING_WMVi                 0x574D5669
228
229/*****************************************************************************
230 *
231 * Other tight constants
232 *
233 *****************************************************************************/
234
235/*
236 * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
237 */
238
239#define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
240#define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
241#define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
242#define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
243#define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
244#define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
245#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
246
247/*****************************************************************************
248 *
249 * Features
250 *
251 *****************************************************************************/
252
253#define VNC_FEATURE_RESIZE                   0
254#define VNC_FEATURE_HEXTILE                  1
255#define VNC_FEATURE_POINTER_TYPE_CHANGE      2
256#define VNC_FEATURE_WMVI                     3
257#define VNC_FEATURE_TIGHT                    4
258#define VNC_FEATURE_ZLIB                     5
259#define VNC_FEATURE_COPYRECT                 6
260
261#define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
262#define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
263#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
264#define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
265#define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
266#define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
267#define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
268
269
270/*****************************************************************************
271 *
272 * Internal APIs
273 *
274 *****************************************************************************/
275
276/* Event loop functions */
277void vnc_client_read(void *opaque);
278void vnc_client_write(void *opaque);
279
280long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
281long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
282
283/* Protocol I/O functions */
284void vnc_write(VncState *vs, const void *data, size_t len);
285void vnc_write_u32(VncState *vs, uint32_t value);
286void vnc_write_s32(VncState *vs, int32_t value);
287void vnc_write_u16(VncState *vs, uint16_t value);
288void vnc_write_u8(VncState *vs, uint8_t value);
289void vnc_flush(VncState *vs);
290void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
291
292
293/* Buffer I/O functions */
294uint8_t read_u8(uint8_t *data, size_t offset);
295uint16_t read_u16(uint8_t *data, size_t offset);
296int32_t read_s32(uint8_t *data, size_t offset);
297uint32_t read_u32(uint8_t *data, size_t offset);
298
299/* Protocol stage functions */
300void vnc_client_error(VncState *vs);
301int vnc_client_io_error(VncState *vs, int ret, int last_errno);
302
303void start_client_init(VncState *vs);
304void start_auth_vnc(VncState *vs);
305
306/* Buffer management */
307void buffer_reserve(Buffer *buffer, size_t len);
308int buffer_empty(Buffer *buffer);
309uint8_t *buffer_end(Buffer *buffer);
310void buffer_reset(Buffer *buffer);
311void buffer_append(Buffer *buffer, const void *data, size_t len);
312
313
314/* Misc helpers */
315
316char *vnc_socket_local_addr(const char *format, int fd);
317char *vnc_socket_remote_addr(const char *format, int fd);
318
319#endif /* __QEMU_VNC_H */
320