1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27#ifndef QEMU_VNC_H
28#define QEMU_VNC_H
29
30#include "qemu/queue.h"
31#include "qemu/thread.h"
32#include "ui/clipboard.h"
33#include "ui/console.h"
34#include "audio/audio.h"
35#include "qemu/bitmap.h"
36#include "crypto/tlssession.h"
37#include "qemu/buffer.h"
38#include "io/channel-socket.h"
39#include "io/channel-tls.h"
40#include "io/net-listener.h"
41#include "authz/base.h"
42#include <zlib.h>
43
44#include "keymaps.h"
45#include "vnc-palette.h"
46#include "vnc-enc-zrle.h"
47#include "ui/kbd-state.h"
48
49
50
51#ifdef _VNC_DEBUG
52#define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
53#else
54#define VNC_DEBUG(fmt, ...) do { } while (0)
55#endif
56
57
58
59
60
61
62
63typedef struct VncState VncState;
64typedef struct VncJob VncJob;
65typedef struct VncRect VncRect;
66typedef struct VncRectEntry VncRectEntry;
67
68typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
69
70typedef void VncWritePixels(VncState *vs, void *data, int size);
71
72typedef void VncSendHextileTile(VncState *vs,
73 int x, int y, int w, int h,
74 void *last_bg,
75 void *last_fg,
76 int *has_bg, int *has_fg);
77
78
79
80#define VNC_DIRTY_PIXELS_PER_BIT 16
81
82
83
84#define VNC_MAX_WIDTH ROUND_UP(2560, VNC_DIRTY_PIXELS_PER_BIT)
85#define VNC_MAX_HEIGHT 2048
86
87
88#define VNC_DIRTY_BITS (VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT)
89
90
91
92#define VNC_DIRTY_BPL(x) (sizeof((x)->dirty) / VNC_MAX_HEIGHT * BITS_PER_BYTE)
93
94#define VNC_STAT_RECT 64
95#define VNC_STAT_COLS (VNC_MAX_WIDTH / VNC_STAT_RECT)
96#define VNC_STAT_ROWS (VNC_MAX_HEIGHT / VNC_STAT_RECT)
97
98#define VNC_AUTH_CHALLENGE_SIZE 16
99
100typedef struct VncDisplay VncDisplay;
101
102#include "vnc-auth-vencrypt.h"
103#ifdef CONFIG_VNC_SASL
104#include "vnc-auth-sasl.h"
105#endif
106#include "vnc-ws.h"
107
108struct VncRectStat
109{
110
111 struct timeval times[10];
112 int idx;
113
114 double freq;
115 bool updated;
116};
117
118typedef struct VncRectStat VncRectStat;
119
120struct VncSurface
121{
122 struct timeval last_freq_check;
123 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
124 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT);
125 VncRectStat stats[VNC_STAT_ROWS][VNC_STAT_COLS];
126 pixman_image_t *fb;
127 pixman_format_code_t format;
128};
129
130typedef enum VncShareMode {
131 VNC_SHARE_MODE_CONNECTING = 1,
132 VNC_SHARE_MODE_SHARED,
133 VNC_SHARE_MODE_EXCLUSIVE,
134 VNC_SHARE_MODE_DISCONNECTED,
135} VncShareMode;
136
137typedef enum VncSharePolicy {
138 VNC_SHARE_POLICY_IGNORE = 1,
139 VNC_SHARE_POLICY_ALLOW_EXCLUSIVE,
140 VNC_SHARE_POLICY_FORCE_SHARED,
141} VncSharePolicy;
142
143struct VncDisplay
144{
145 QTAILQ_HEAD(, VncState) clients;
146 int num_connecting;
147 int num_shared;
148 int num_exclusive;
149 int connections_limit;
150 VncSharePolicy share_policy;
151 QIONetListener *listener;
152 QIONetListener *wslistener;
153 DisplaySurface *ds;
154 DisplayChangeListener dcl;
155 kbd_layout_t *kbd_layout;
156 int lock_key_sync;
157 QEMUPutLEDEntry *led;
158 int ledstate;
159 QKbdState *kbd;
160 QemuMutex mutex;
161
162 QEMUCursor *cursor;
163 int cursor_msize;
164 uint8_t *cursor_mask;
165
166 struct VncSurface guest;
167 pixman_image_t *server;
168 int true_width;
169
170 const char *id;
171 QTAILQ_ENTRY(VncDisplay) next;
172 bool is_unix;
173 char *password;
174 time_t expires;
175 int auth;
176 int subauth;
177 int ws_auth;
178 int ws_subauth;
179 bool lossy;
180 bool non_adaptive;
181 bool power_control;
182 QCryptoTLSCreds *tlscreds;
183 QAuthZ *tlsauthz;
184 char *tlsauthzid;
185#ifdef CONFIG_VNC_SASL
186 VncDisplaySASL sasl;
187#endif
188
189 AudioState *audio_state;
190};
191
192typedef struct VncTight {
193 int type;
194 uint8_t quality;
195 uint8_t compression;
196 uint8_t pixel24;
197 Buffer tight;
198 Buffer tmp;
199 Buffer zlib;
200 Buffer gradient;
201#ifdef CONFIG_VNC_JPEG
202 Buffer jpeg;
203#endif
204#ifdef CONFIG_PNG
205 Buffer png;
206#endif
207 int levels[4];
208 z_stream stream[4];
209} VncTight;
210
211typedef struct VncHextile {
212 VncSendHextileTile *send_tile;
213} VncHextile;
214
215typedef struct VncZlib {
216 Buffer zlib;
217 Buffer tmp;
218 z_stream stream;
219 int level;
220} VncZlib;
221
222typedef struct VncZrle {
223 int type;
224 Buffer fb;
225 Buffer zrle;
226 Buffer tmp;
227 Buffer zlib;
228 z_stream stream;
229 VncPalette palette;
230} VncZrle;
231
232typedef struct VncZywrle {
233 int buf[VNC_ZRLE_TILE_WIDTH * VNC_ZRLE_TILE_HEIGHT];
234} VncZywrle;
235
236struct VncRect
237{
238 int x;
239 int y;
240 int w;
241 int h;
242};
243
244struct VncRectEntry
245{
246 struct VncRect rect;
247 QLIST_ENTRY(VncRectEntry) next;
248};
249
250struct VncJob
251{
252 VncState *vs;
253
254 QLIST_HEAD(, VncRectEntry) rectangles;
255 QTAILQ_ENTRY(VncJob) next;
256};
257
258typedef enum {
259 VNC_STATE_UPDATE_NONE,
260 VNC_STATE_UPDATE_INCREMENTAL,
261 VNC_STATE_UPDATE_FORCE,
262} VncStateUpdate;
263
264#define VNC_MAGIC ((uint64_t)0x05b3f069b3d204bb)
265
266struct VncState
267{
268 uint64_t magic;
269 QIOChannelSocket *sioc;
270 QIOChannel *ioc;
271 guint ioc_tag;
272 gboolean disconnecting;
273
274 DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT], VNC_DIRTY_BITS);
275 uint8_t **lossy_rect;
276
277
278 VncDisplay *vd;
279 VncStateUpdate update;
280 VncStateUpdate job_update;
281 int has_dirty;
282 uint32_t features;
283 int absolute;
284 int last_x;
285 int last_y;
286 uint32_t last_bmask;
287 size_t client_width;
288 size_t client_height;
289 VncShareMode share_mode;
290
291 uint32_t vnc_encoding;
292
293 int major;
294 int minor;
295
296 int auth;
297 int subauth;
298 char challenge[VNC_AUTH_CHALLENGE_SIZE];
299 QCryptoTLSSession *tls;
300#ifdef CONFIG_VNC_SASL
301 VncStateSASL sasl;
302#endif
303 bool encode_ws;
304 bool websocket;
305
306#ifdef CONFIG_VNC
307 VncClientInfo *info;
308#endif
309
310
311
312
313
314
315 size_t force_update_offset;
316
317
318
319
320
321 size_t throttle_output_offset;
322 Buffer output;
323 Buffer input;
324
325 VncWritePixels *write_pixels;
326 PixelFormat client_pf;
327 pixman_format_code_t client_format;
328 bool client_be;
329
330 CaptureVoiceOut *audio_cap;
331 struct audsettings as;
332
333 VncReadEvent *read_handler;
334 size_t read_handler_expect;
335
336 bool abort;
337 QemuMutex output_mutex;
338 QEMUBH *bh;
339 Buffer jobs_buffer;
340
341
342
343
344 VncTight *tight;
345 VncZlib zlib;
346 VncHextile hextile;
347 VncZrle *zrle;
348 VncZywrle zywrle;
349
350 Notifier mouse_mode_notifier;
351
352 QemuClipboardPeer cbpeer;
353 QemuClipboardInfo *cbinfo;
354 uint32_t cbpending;
355
356 QTAILQ_ENTRY(VncState) next;
357};
358
359
360
361
362
363
364
365
366enum {
367 VNC_AUTH_INVALID = 0,
368 VNC_AUTH_NONE = 1,
369 VNC_AUTH_VNC = 2,
370 VNC_AUTH_RA2 = 5,
371 VNC_AUTH_RA2NE = 6,
372 VNC_AUTH_TIGHT = 16,
373 VNC_AUTH_ULTRA = 17,
374 VNC_AUTH_TLS = 18,
375 VNC_AUTH_VENCRYPT = 19,
376 VNC_AUTH_SASL = 20,
377};
378
379enum {
380 VNC_AUTH_VENCRYPT_PLAIN = 256,
381 VNC_AUTH_VENCRYPT_TLSNONE = 257,
382 VNC_AUTH_VENCRYPT_TLSVNC = 258,
383 VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
384 VNC_AUTH_VENCRYPT_X509NONE = 260,
385 VNC_AUTH_VENCRYPT_X509VNC = 261,
386 VNC_AUTH_VENCRYPT_X509PLAIN = 262,
387 VNC_AUTH_VENCRYPT_X509SASL = 263,
388 VNC_AUTH_VENCRYPT_TLSSASL = 264,
389};
390
391
392
393
394
395
396
397
398#define VNC_ENCODING_RAW 0x00000000
399#define VNC_ENCODING_COPYRECT 0x00000001
400#define VNC_ENCODING_RRE 0x00000002
401#define VNC_ENCODING_CORRE 0x00000004
402#define VNC_ENCODING_HEXTILE 0x00000005
403#define VNC_ENCODING_ZLIB 0x00000006
404#define VNC_ENCODING_TIGHT 0x00000007
405#define VNC_ENCODING_ZLIBHEX 0x00000008
406#define VNC_ENCODING_TRLE 0x0000000f
407#define VNC_ENCODING_ZRLE 0x00000010
408#define VNC_ENCODING_ZYWRLE 0x00000011
409#define VNC_ENCODING_COMPRESSLEVEL0 0xFFFFFF00
410#define VNC_ENCODING_QUALITYLEVEL0 0xFFFFFFE0
411#define VNC_ENCODING_XCURSOR 0xFFFFFF10
412#define VNC_ENCODING_RICH_CURSOR 0xFFFFFF11
413#define VNC_ENCODING_POINTER_POS 0xFFFFFF18
414#define VNC_ENCODING_LASTRECT 0xFFFFFF20
415#define VNC_ENCODING_DESKTOPRESIZE 0xFFFFFF21
416#define VNC_ENCODING_POINTER_TYPE_CHANGE 0XFFFFFEFF
417#define VNC_ENCODING_EXT_KEY_EVENT 0XFFFFFEFE
418#define VNC_ENCODING_AUDIO 0XFFFFFEFD
419#define VNC_ENCODING_TIGHT_PNG 0xFFFFFEFC
420#define VNC_ENCODING_LED_STATE 0XFFFFFEFB
421#define VNC_ENCODING_DESKTOP_RESIZE_EXT 0XFFFFFECC
422#define VNC_ENCODING_XVP 0XFFFFFECB
423#define VNC_ENCODING_ALPHA_CURSOR 0XFFFFFEC6
424#define VNC_ENCODING_WMVi 0x574D5669
425#define VNC_ENCODING_CLIPBOARD_EXT 0xc0a1e5ce
426
427
428
429
430
431
432
433
434
435
436
437#define VNC_TIGHT_CCB_RESET_MASK (0x0f)
438#define VNC_TIGHT_CCB_TYPE_MASK (0x0f << 4)
439#define VNC_TIGHT_CCB_TYPE_FILL (0x08 << 4)
440#define VNC_TIGHT_CCB_TYPE_JPEG (0x09 << 4)
441#define VNC_TIGHT_CCB_TYPE_PNG (0x0A << 4)
442#define VNC_TIGHT_CCB_BASIC_MAX (0x07 << 4)
443#define VNC_TIGHT_CCB_BASIC_ZLIB (0x03 << 4)
444#define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
445
446
447
448
449
450
451
452enum VncFeatures {
453 VNC_FEATURE_RESIZE,
454 VNC_FEATURE_RESIZE_EXT,
455 VNC_FEATURE_HEXTILE,
456 VNC_FEATURE_POINTER_TYPE_CHANGE,
457 VNC_FEATURE_WMVI,
458 VNC_FEATURE_TIGHT,
459 VNC_FEATURE_ZLIB,
460 VNC_FEATURE_RICH_CURSOR,
461 VNC_FEATURE_ALPHA_CURSOR,
462 VNC_FEATURE_TIGHT_PNG,
463 VNC_FEATURE_ZRLE,
464 VNC_FEATURE_ZYWRLE,
465 VNC_FEATURE_LED_STATE,
466 VNC_FEATURE_XVP,
467 VNC_FEATURE_CLIPBOARD_EXT,
468};
469
470#define VNC_FEATURE_RESIZE_MASK (1 << VNC_FEATURE_RESIZE)
471#define VNC_FEATURE_RESIZE_EXT_MASK (1 << VNC_FEATURE_RESIZE_EXT)
472#define VNC_FEATURE_HEXTILE_MASK (1 << VNC_FEATURE_HEXTILE)
473#define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
474#define VNC_FEATURE_WMVI_MASK (1 << VNC_FEATURE_WMVI)
475#define VNC_FEATURE_TIGHT_MASK (1 << VNC_FEATURE_TIGHT)
476#define VNC_FEATURE_ZLIB_MASK (1 << VNC_FEATURE_ZLIB)
477#define VNC_FEATURE_RICH_CURSOR_MASK (1 << VNC_FEATURE_RICH_CURSOR)
478#define VNC_FEATURE_ALPHA_CURSOR_MASK (1 << VNC_FEATURE_ALPHA_CURSOR)
479#define VNC_FEATURE_TIGHT_PNG_MASK (1 << VNC_FEATURE_TIGHT_PNG)
480#define VNC_FEATURE_ZRLE_MASK (1 << VNC_FEATURE_ZRLE)
481#define VNC_FEATURE_ZYWRLE_MASK (1 << VNC_FEATURE_ZYWRLE)
482#define VNC_FEATURE_LED_STATE_MASK (1 << VNC_FEATURE_LED_STATE)
483#define VNC_FEATURE_XVP_MASK (1 << VNC_FEATURE_XVP)
484#define VNC_FEATURE_CLIPBOARD_EXT_MASK (1 << VNC_FEATURE_CLIPBOARD_EXT)
485
486
487
488#define VNC_MSG_CLIENT_SET_PIXEL_FORMAT 0
489#define VNC_MSG_CLIENT_SET_ENCODINGS 2
490#define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
491#define VNC_MSG_CLIENT_KEY_EVENT 4
492#define VNC_MSG_CLIENT_POINTER_EVENT 5
493#define VNC_MSG_CLIENT_CUT_TEXT 6
494#define VNC_MSG_CLIENT_VMWARE_0 127
495#define VNC_MSG_CLIENT_CALL_CONTROL 249
496#define VNC_MSG_CLIENT_XVP 250
497#define VNC_MSG_CLIENT_SET_DESKTOP_SIZE 251
498#define VNC_MSG_CLIENT_TIGHT 252
499#define VNC_MSG_CLIENT_GII 253
500#define VNC_MSG_CLIENT_VMWARE_1 254
501#define VNC_MSG_CLIENT_QEMU 255
502
503
504#define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE 0
505#define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES 1
506#define VNC_MSG_SERVER_BELL 2
507#define VNC_MSG_SERVER_CUT_TEXT 3
508#define VNC_MSG_SERVER_VMWARE_0 127
509#define VNC_MSG_SERVER_CALL_CONTROL 249
510#define VNC_MSG_SERVER_XVP 250
511#define VNC_MSG_SERVER_TIGHT 252
512#define VNC_MSG_SERVER_GII 253
513#define VNC_MSG_SERVER_VMWARE_1 254
514#define VNC_MSG_SERVER_QEMU 255
515
516
517
518
519#define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT 0
520#define VNC_MSG_CLIENT_QEMU_AUDIO 1
521
522
523#define VNC_MSG_SERVER_QEMU_AUDIO 1
524
525
526
527
528#define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE 0
529#define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE 1
530#define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT 2
531
532
533#define VNC_MSG_SERVER_QEMU_AUDIO_END 0
534#define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN 1
535#define VNC_MSG_SERVER_QEMU_AUDIO_DATA 2
536
537
538#define VNC_XVP_CODE_FAIL 0
539#define VNC_XVP_CODE_INIT 1
540
541
542#define VNC_XVP_ACTION_SHUTDOWN 2
543#define VNC_XVP_ACTION_REBOOT 3
544#define VNC_XVP_ACTION_RESET 4
545
546
547#define VNC_CLIPBOARD_TEXT (1 << 0)
548#define VNC_CLIPBOARD_RTF (1 << 1)
549#define VNC_CLIPBOARD_HTML (1 << 2)
550#define VNC_CLIPBOARD_DIB (1 << 3)
551#define VNC_CLIPBOARD_FILES (1 << 4)
552#define VNC_CLIPBOARD_CAPS (1 << 24)
553#define VNC_CLIPBOARD_REQUEST (1 << 25)
554#define VNC_CLIPBOARD_PEEK (1 << 26)
555#define VNC_CLIPBOARD_NOTIFY (1 << 27)
556#define VNC_CLIPBOARD_PROVIDE (1 << 28)
557
558
559
560
561
562
563
564
565gboolean vnc_client_io(QIOChannel *ioc,
566 GIOCondition condition,
567 void *opaque);
568
569size_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
570size_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
571
572
573void vnc_write(VncState *vs, const void *data, size_t len);
574void vnc_write_u32(VncState *vs, uint32_t value);
575void vnc_write_s32(VncState *vs, int32_t value);
576void vnc_write_u16(VncState *vs, uint16_t value);
577void vnc_write_u8(VncState *vs, uint8_t value);
578void vnc_flush(VncState *vs);
579void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
580void vnc_disconnect_finish(VncState *vs);
581void vnc_start_protocol(VncState *vs);
582
583
584
585uint32_t read_u32(uint8_t *data, size_t offset);
586
587
588void vnc_client_error(VncState *vs);
589size_t vnc_client_io_error(VncState *vs, ssize_t ret, Error *err);
590
591void start_client_init(VncState *vs);
592void start_auth_vnc(VncState *vs);
593
594
595
596
597static inline uint32_t vnc_has_feature(VncState *vs, int feature) {
598 return (vs->features & (1 << feature));
599}
600
601
602void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
603 int32_t encoding);
604
605
606#define VNC_SERVER_FB_FORMAT PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
607#define VNC_SERVER_FB_BITS (PIXMAN_FORMAT_BPP(VNC_SERVER_FB_FORMAT))
608#define VNC_SERVER_FB_BYTES ((VNC_SERVER_FB_BITS+7)/8)
609
610void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y);
611int vnc_server_fb_stride(VncDisplay *vd);
612
613void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
614double vnc_update_freq(VncState *vs, int x, int y, int w, int h);
615void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h);
616
617
618int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
619
620int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
621
622int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
623 int y, int w, int h);
624void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
625
626void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
627void vnc_zlib_zfree(void *x, void *addr);
628int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
629void vnc_zlib_clear(VncState *vs);
630
631int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
632int vnc_tight_png_send_framebuffer_update(VncState *vs, int x, int y,
633 int w, int h);
634void vnc_tight_clear(VncState *vs);
635
636int vnc_zrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
637int vnc_zywrle_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
638void vnc_zrle_clear(VncState *vs);
639
640
641void vnc_server_cut_text_caps(VncState *vs);
642void vnc_client_cut_text(VncState *vs, size_t len, uint8_t *text);
643void vnc_client_cut_text_ext(VncState *vs, int32_t len, uint32_t flags, uint8_t *data);
644
645#endif
646