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