vnc.h

   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 "qemu-queue.h"
  32 #include "console.h"
  33 #include "monitor.h"
  34 #include "audio/audio.h"
  35 #include <zlib.h>
  36
  37 #include "keymaps.h"
  38
  39 // #define _VNC_DEBUG 1
  40
  41 #ifdef _VNC_DEBUG
  42 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
  43 #else
  44 #define VNC_DEBUG(fmt, ...) do { } while (0)
  45 #endif
  46
  47 /*****************************************************************************
  48  *
  49  * Core data structures
  50  *
  51  *****************************************************************************/
  52
  53 typedef struct Buffer
  54 {
  55     size_t capacity;
  56     size_t offset;
  57     uint8_t *buffer;
  58 } Buffer;
  59
  60 typedef struct VncState VncState;
  61
  62 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
  63
  64 typedef void VncWritePixels(VncState *vs, struct PixelFormat *pf, void *data, int size);
  65
  66 typedef void VncSendHextileTile(VncState *vs,
  67                                 int x, int y, int w, int h,
  68                                 void *last_bg,
  69                                 void *last_fg,
  70                                 int *has_bg, int *has_fg);
  71
  72 #define VNC_MAX_WIDTH 2560
  73 #define VNC_MAX_HEIGHT 2048
  74 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
  75
  76 #define VNC_AUTH_CHALLENGE_SIZE 16
  77
  78 typedef struct VncDisplay VncDisplay;
  79
  80 #ifdef CONFIG_VNC_TLS
  81 #include "vnc-tls.h"
  82 #include "vnc-auth-vencrypt.h"
  83 #endif
  84 #ifdef CONFIG_VNC_SASL
  85 #include "vnc-auth-sasl.h"
  86 #endif
  87
  88 struct VncSurface
  89 {
  90     uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
  91     DisplaySurface *ds;
  92 };
  93
  94 struct VncDisplay
  95 {
  96     QTAILQ_HEAD(, VncState) clients;
  97     QEMUTimer *timer;
  98     int timer_interval;
  99     int lsock;
 100     DisplayState *ds;
 101     kbd_layout_t *kbd_layout;
 102     int lock_key_sync;
 103
 104     QEMUCursor *cursor;
 105     int cursor_msize;
 106     uint8_t *cursor_mask;
 107
 108     struct VncSurface guest;   /* guest visible surface (aka ds->surface) */
 109     DisplaySurface *server;  /* vnc server surface */
 110
 111     char *display;
 112     char *password;
 113     int auth;
 114 #ifdef CONFIG_VNC_TLS
 115     int subauth; /* Used by VeNCrypt */
 116     VncDisplayTLS tls;
 117 #endif
 118 #ifdef CONFIG_VNC_SASL
 119     VncDisplaySASL sasl;
 120 #endif
 121 };
 122
 123 struct VncState
 124 {
 125     int csock;
 126
 127     DisplayState *ds;
 128     uint32_t dirty[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
 129
 130     VncDisplay *vd;
 131     int need_update;
 132     int force_update;
 133     uint32_t features;
 134     int absolute;
 135     int last_x;
 136     int last_y;
 137     int client_width;
 138     int client_height;
 139
 140     uint32_t vnc_encoding;
 141
 142     int major;
 143     int minor;
 144
 145     char challenge[VNC_AUTH_CHALLENGE_SIZE];
 146 #ifdef CONFIG_VNC_TLS
 147     VncStateTLS tls;
 148 #endif
 149 #ifdef CONFIG_VNC_SASL
 150     VncStateSASL sasl;
 151 #endif
 152
 153     QObject *info;
 154
 155     Buffer output;
 156     Buffer input;
 157     /* current output mode information */
 158     VncWritePixels *write_pixels;
 159     DisplaySurface clientds;
 160
 161     CaptureVoiceOut *audio_cap;
 162     struct audsettings as;
 163
 164     VncReadEvent *read_handler;
 165     size_t read_handler_expect;
 166     /* input */
 167     uint8_t modifiers_state[256];
 168     QEMUPutLEDEntry *led;
 169
 170     /* Encoding specific */
 171
 172     /* Tight */
 173     uint8_t tight_quality;
 174     uint8_t tight_compression;
 175     uint8_t tight_pixel24;
 176     Buffer tight;
 177     Buffer tight_tmp;
 178     Buffer tight_zlib;
 179     int tight_levels[4];
 180     z_stream tight_stream[4];
 181
 182     /* Hextile */
 183     VncSendHextileTile *send_hextile_tile;
 184
 185     /* Zlib */
 186     Buffer zlib;
 187     Buffer zlib_tmp;
 188     z_stream zlib_stream;
 189     int zlib_level;
 190
 191     Notifier mouse_mode_notifier;
 192
 193     QTAILQ_ENTRY(VncState) next;
 194 };
 195
 196
 197 /*****************************************************************************
 198  *
 199  * Authentication modes
 200  *
 201  *****************************************************************************/
 202
 203 enum {
 204     VNC_AUTH_INVALID = 0,
 205     VNC_AUTH_NONE = 1,
 206     VNC_AUTH_VNC = 2,
 207     VNC_AUTH_RA2 = 5,
 208     VNC_AUTH_RA2NE = 6,
 209     VNC_AUTH_TIGHT = 16,
 210     VNC_AUTH_ULTRA = 17,
 211     VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
 212     VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
 213     VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
 214 };
 215
 216 enum {
 217     VNC_AUTH_VENCRYPT_PLAIN = 256,
 218     VNC_AUTH_VENCRYPT_TLSNONE = 257,
 219     VNC_AUTH_VENCRYPT_TLSVNC = 258,
 220     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
 221     VNC_AUTH_VENCRYPT_X509NONE = 260,
 222     VNC_AUTH_VENCRYPT_X509VNC = 261,
 223     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
 224     VNC_AUTH_VENCRYPT_X509SASL = 263,
 225     VNC_AUTH_VENCRYPT_TLSSASL = 264,
 226 };
 227
 228
 229 /*****************************************************************************
 230  *
 231  * Encoding types
 232  *
 233  *****************************************************************************/
 234
 235 #define VNC_ENCODING_RAW                  0x00000000
 236 #define VNC_ENCODING_COPYRECT             0x00000001
 237 #define VNC_ENCODING_RRE                  0x00000002
 238 #define VNC_ENCODING_CORRE                0x00000004
 239 #define VNC_ENCODING_HEXTILE              0x00000005
 240 #define VNC_ENCODING_ZLIB                 0x00000006
 241 #define VNC_ENCODING_TIGHT                0x00000007
 242 #define VNC_ENCODING_ZLIBHEX              0x00000008
 243 #define VNC_ENCODING_TRLE                 0x0000000f
 244 #define VNC_ENCODING_ZRLE                 0x00000010
 245 #define VNC_ENCODING_ZYWRLE               0x00000011
 246 #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
 247 #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
 248 #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
 249 #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
 250 #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
 251 #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
 252 #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
 253 #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
 254 #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
 255 #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
 256 #define VNC_ENCODING_WMVi                 0x574D5669
 257
 258 /*****************************************************************************
 259  *
 260  * Other tight constants
 261  *
 262  *****************************************************************************/
 263
 264 /*
 265  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
 266  */
 267
 268 #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
 269 #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
 270 #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
 271 #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
 272 #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
 273 #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
 274 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
 275
 276 /*****************************************************************************
 277  *
 278  * Features
 279  *
 280  *****************************************************************************/
 281
 282 #define VNC_FEATURE_RESIZE                   0
 283 #define VNC_FEATURE_HEXTILE                  1
 284 #define VNC_FEATURE_POINTER_TYPE_CHANGE      2
 285 #define VNC_FEATURE_WMVI                     3
 286 #define VNC_FEATURE_TIGHT                    4
 287 #define VNC_FEATURE_ZLIB                     5
 288 #define VNC_FEATURE_COPYRECT                 6
 289 #define VNC_FEATURE_RICH_CURSOR              7
 290
 291 #define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
 292 #define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
 293 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
 294 #define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
 295 #define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
 296 #define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
 297 #define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
 298 #define VNC_FEATURE_RICH_CURSOR_MASK         (1 << VNC_FEATURE_RICH_CURSOR)
 299
 300
 301 /* Client -> Server message IDs */
 302 #define VNC_MSG_CLIENT_SET_PIXEL_FORMAT           0
 303 #define VNC_MSG_CLIENT_SET_ENCODINGS              2
 304 #define VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST 3
 305 #define VNC_MSG_CLIENT_KEY_EVENT                  4
 306 #define VNC_MSG_CLIENT_POINTER_EVENT              5
 307 #define VNC_MSG_CLIENT_CUT_TEXT                   6
 308 #define VNC_MSG_CLIENT_VMWARE_0                   127
 309 #define VNC_MSG_CLIENT_CALL_CONTROL               249
 310 #define VNC_MSG_CLIENT_XVP                        250
 311 #define VNC_MSG_CLIENT_SET_DESKTOP_SIZE           251
 312 #define VNC_MSG_CLIENT_TIGHT                      252
 313 #define VNC_MSG_CLIENT_GII                        253
 314 #define VNC_MSG_CLIENT_VMWARE_1                   254
 315 #define VNC_MSG_CLIENT_QEMU                       255
 316
 317 /* Server -> Client message IDs */
 318 #define VNC_MSG_SERVER_FRAMEBUFFER_UPDATE         0
 319 #define VNC_MSG_SERVER_SET_COLOUR_MAP_ENTRIES     1
 320 #define VNC_MSG_SERVER_BELL                       2
 321 #define VNC_MSG_SERVER_CUT_TEXT                   3
 322 #define VNC_MSG_SERVER_VMWARE_0                   127
 323 #define VNC_MSG_SERVER_CALL_CONTROL               249
 324 #define VNC_MSG_SERVER_XVP                        250
 325 #define VNC_MSG_SERVER_TIGHT                      252
 326 #define VNC_MSG_SERVER_GII                        253
 327 #define VNC_MSG_SERVER_VMWARE_1                   254
 328 #define VNC_MSG_SERVER_QEMU                       255
 329
 330
 331
 332 /* QEMU client -> server message IDs */
 333 #define VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT         0
 334 #define VNC_MSG_CLIENT_QEMU_AUDIO                 1
 335
 336 /* QEMU server -> client message IDs */
 337 #define VNC_MSG_SERVER_QEMU_AUDIO                 1
 338
 339
 340
 341 /* QEMU client -> server audio message IDs */
 342 #define VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE          0
 343 #define VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE         1
 344 #define VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT      2
 345
 346 /* QEMU server -> client audio message IDs */
 347 #define VNC_MSG_SERVER_QEMU_AUDIO_END             0
 348 #define VNC_MSG_SERVER_QEMU_AUDIO_BEGIN           1
 349 #define VNC_MSG_SERVER_QEMU_AUDIO_DATA            2
 350
 351
 352 /*****************************************************************************
 353  *
 354  * Internal APIs
 355  *
 356  *****************************************************************************/
 357
 358 /* Event loop functions */
 359 void vnc_client_read(void *opaque);
 360 void vnc_client_write(void *opaque);
 361
 362 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
 363 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
 364
 365 /* Protocol I/O functions */
 366 void vnc_write(VncState *vs, const void *data, size_t len);
 367 void vnc_write_u32(VncState *vs, uint32_t value);
 368 void vnc_write_s32(VncState *vs, int32_t value);
 369 void vnc_write_u16(VncState *vs, uint16_t value);
 370 void vnc_write_u8(VncState *vs, uint8_t value);
 371 void vnc_flush(VncState *vs);
 372 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
 373
 374
 375 /* Buffer I/O functions */
 376 uint8_t read_u8(uint8_t *data, size_t offset);
 377 uint16_t read_u16(uint8_t *data, size_t offset);
 378 int32_t read_s32(uint8_t *data, size_t offset);
 379 uint32_t read_u32(uint8_t *data, size_t offset);
 380
 381 /* Protocol stage functions */
 382 void vnc_client_error(VncState *vs);
 383 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
 384
 385 void start_client_init(VncState *vs);
 386 void start_auth_vnc(VncState *vs);
 387
 388 /* Buffer management */
 389 void buffer_reserve(Buffer *buffer, size_t len);
 390 int buffer_empty(Buffer *buffer);
 391 uint8_t *buffer_end(Buffer *buffer);
 392 void buffer_reset(Buffer *buffer);
 393 void buffer_free(Buffer *buffer);
 394 void buffer_append(Buffer *buffer, const void *data, size_t len);
 395
 396
 397 /* Misc helpers */
 398
 399 char *vnc_socket_local_addr(const char *format, int fd);
 400 char *vnc_socket_remote_addr(const char *format, int fd);
 401
 402 /* Framebuffer */
 403 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
 404                             int32_t encoding);
 405
 406 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v);
 407
 408 /* Encodings */
 409 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
 410
 411 int vnc_hextile_send_framebuffer_update(VncState *vs, int x,
 412                                          int y, int w, int h);
 413 void vnc_hextile_set_pixel_conversion(VncState *vs, int generic);
 414
 415 void *vnc_zlib_zalloc(void *x, unsigned items, unsigned size);
 416 void vnc_zlib_zfree(void *x, void *addr);
 417 int vnc_zlib_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
 418 void vnc_zlib_clear(VncState *vs);
 419
 420
 421 int vnc_tight_send_framebuffer_update(VncState *vs, int x, int y, int w, int h);
 422 void vnc_tight_clear(VncState *vs);
 423
 424 #endif /* __QEMU_VNC_H */