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 "console.h"
  32 #include "audio/audio.h"
  33 #include <zlib.h>
  34
  35 #include "keymaps.h"
  36
  37 // #define _VNC_DEBUG 1
  38
  39 #ifdef _VNC_DEBUG
  40 #define VNC_DEBUG(fmt, ...) do { fprintf(stderr, fmt, ## __VA_ARGS__); } while (0)
  41 #else
  42 #define VNC_DEBUG(fmt, ...) do { } while (0)
  43 #endif
  44
  45 /*****************************************************************************
  46  *
  47  * Core data structures
  48  *
  49  *****************************************************************************/
  50
  51 typedef struct Buffer
  52 {
  53     size_t capacity;
  54     size_t offset;
  55     uint8_t *buffer;
  56 } Buffer;
  57
  58 typedef struct VncState VncState;
  59
  60 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
  61
  62 typedef void VncWritePixels(VncState *vs, void *data, int size);
  63
  64 typedef void VncSendHextileTile(VncState *vs,
  65                                 int x, int y, int w, int h,
  66                                 void *last_bg,
  67                                 void *last_fg,
  68                                 int *has_bg, int *has_fg);
  69
  70 #define VNC_MAX_WIDTH 2048
  71 #define VNC_MAX_HEIGHT 2048
  72 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
  73
  74 #define VNC_AUTH_CHALLENGE_SIZE 16
  75
  76 typedef struct VncDisplay VncDisplay;
  77
  78 #ifdef CONFIG_VNC_TLS
  79 #include "vnc-tls.h"
  80 #include "vnc-auth-vencrypt.h"
  81 #endif
  82 #ifdef CONFIG_VNC_SASL
  83 #include "vnc-auth-sasl.h"
  84 #endif
  85
  86
  87 struct VncDisplay
  88 {
  89     int lsock;
  90     DisplayState *ds;
  91     VncState *clients;
  92     kbd_layout_t *kbd_layout;
  93
  94     char *display;
  95     char *password;
  96     int auth;
  97 #ifdef CONFIG_VNC_TLS
  98     int subauth; /* Used by VeNCrypt */
  99     VncDisplayTLS tls;
 100 #endif
 101 #ifdef CONFIG_VNC_SASL
 102     VncDisplaySASL sasl;
 103 #endif
 104 };
 105
 106 struct VncState
 107 {
 108     QEMUTimer *timer;
 109     int csock;
 110     DisplayState *ds;
 111     VncDisplay *vd;
 112     int need_update;
 113     uint32_t dirty_row[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
 114     char *old_data;
 115     uint32_t features;
 116     int absolute;
 117     int last_x;
 118     int last_y;
 119
 120     uint32_t vnc_encoding;
 121     uint8_t tight_quality;
 122     uint8_t tight_compression;
 123
 124     int major;
 125     int minor;
 126
 127     char challenge[VNC_AUTH_CHALLENGE_SIZE];
 128 #ifdef CONFIG_VNC_TLS
 129     VncStateTLS tls;
 130 #endif
 131 #ifdef CONFIG_VNC_SASL
 132     VncStateSASL sasl;
 133 #endif
 134
 135     Buffer output;
 136     Buffer input;
 137     /* current output mode information */
 138     VncWritePixels *write_pixels;
 139     VncSendHextileTile *send_hextile_tile;
 140     DisplaySurface clientds, serverds;
 141
 142     CaptureVoiceOut *audio_cap;
 143     struct audsettings as;
 144
 145     VncReadEvent *read_handler;
 146     size_t read_handler_expect;
 147     /* input */
 148     uint8_t modifiers_state[256];
 149
 150     Buffer zlib;
 151     Buffer zlib_tmp;
 152     z_stream zlib_stream[4];
 153
 154     VncState *next;
 155 };
 156
 157
 158 /*****************************************************************************
 159  *
 160  * Authentication modes
 161  *
 162  *****************************************************************************/
 163
 164 enum {
 165     VNC_AUTH_INVALID = 0,
 166     VNC_AUTH_NONE = 1,
 167     VNC_AUTH_VNC = 2,
 168     VNC_AUTH_RA2 = 5,
 169     VNC_AUTH_RA2NE = 6,
 170     VNC_AUTH_TIGHT = 16,
 171     VNC_AUTH_ULTRA = 17,
 172     VNC_AUTH_TLS = 18,      /* Supported in GTK-VNC & VINO */
 173     VNC_AUTH_VENCRYPT = 19, /* Supported in GTK-VNC & VeNCrypt */
 174     VNC_AUTH_SASL = 20,     /* Supported in GTK-VNC & VINO */
 175 };
 176
 177 enum {
 178     VNC_AUTH_VENCRYPT_PLAIN = 256,
 179     VNC_AUTH_VENCRYPT_TLSNONE = 257,
 180     VNC_AUTH_VENCRYPT_TLSVNC = 258,
 181     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
 182     VNC_AUTH_VENCRYPT_X509NONE = 260,
 183     VNC_AUTH_VENCRYPT_X509VNC = 261,
 184     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
 185     VNC_AUTH_VENCRYPT_X509SASL = 263,
 186     VNC_AUTH_VENCRYPT_TLSSASL = 264,
 187 };
 188
 189
 190 /*****************************************************************************
 191  *
 192  * Encoding types
 193  *
 194  *****************************************************************************/
 195
 196 #define VNC_ENCODING_RAW                  0x00000000
 197 #define VNC_ENCODING_COPYRECT             0x00000001
 198 #define VNC_ENCODING_RRE                  0x00000002
 199 #define VNC_ENCODING_CORRE                0x00000004
 200 #define VNC_ENCODING_HEXTILE              0x00000005
 201 #define VNC_ENCODING_ZLIB                 0x00000006
 202 #define VNC_ENCODING_TIGHT                0x00000007
 203 #define VNC_ENCODING_ZLIBHEX              0x00000008
 204 #define VNC_ENCODING_TRLE                 0x0000000f
 205 #define VNC_ENCODING_ZRLE                 0x00000010
 206 #define VNC_ENCODING_ZYWRLE               0x00000011
 207 #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
 208 #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
 209 #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
 210 #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
 211 #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
 212 #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
 213 #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
 214 #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
 215 #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
 216 #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
 217 #define VNC_ENCODING_WMVi                 0x574D5669
 218
 219 /*****************************************************************************
 220  *
 221  * Other tight constants
 222  *
 223  *****************************************************************************/
 224
 225 /*
 226  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
 227  */
 228
 229 #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
 230 #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
 231 #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
 232 #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
 233 #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
 234 #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
 235 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
 236
 237 /*****************************************************************************
 238  *
 239  * Features
 240  *
 241  *****************************************************************************/
 242
 243 #define VNC_FEATURE_RESIZE                   0
 244 #define VNC_FEATURE_HEXTILE                  1
 245 #define VNC_FEATURE_POINTER_TYPE_CHANGE      2
 246 #define VNC_FEATURE_WMVI                     3
 247 #define VNC_FEATURE_TIGHT                    4
 248 #define VNC_FEATURE_ZLIB                     5
 249 #define VNC_FEATURE_COPYRECT                 6
 250
 251 #define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
 252 #define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
 253 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
 254 #define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
 255 #define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
 256 #define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
 257 #define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
 258
 259
 260 /*****************************************************************************
 261  *
 262  * Internal APIs
 263  *
 264  *****************************************************************************/
 265
 266 /* Event loop functions */
 267 void vnc_client_read(void *opaque);
 268 void vnc_client_write(void *opaque);
 269
 270 long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen);
 271 long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen);
 272
 273 /* Protocol I/O functions */
 274 void vnc_write(VncState *vs, const void *data, size_t len);
 275 void vnc_write_u32(VncState *vs, uint32_t value);
 276 void vnc_write_s32(VncState *vs, int32_t value);
 277 void vnc_write_u16(VncState *vs, uint16_t value);
 278 void vnc_write_u8(VncState *vs, uint8_t value);
 279 void vnc_flush(VncState *vs);
 280 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting);
 281
 282
 283 /* Buffer I/O functions */
 284 uint8_t read_u8(uint8_t *data, size_t offset);
 285 uint16_t read_u16(uint8_t *data, size_t offset);
 286 int32_t read_s32(uint8_t *data, size_t offset);
 287 uint32_t read_u32(uint8_t *data, size_t offset);
 288
 289 /* Protocol stage functions */
 290 void vnc_client_error(VncState *vs);
 291 int vnc_client_io_error(VncState *vs, int ret, int last_errno);
 292
 293 void start_client_init(VncState *vs);
 294 void start_auth_vnc(VncState *vs);
 295
 296 /* Buffer management */
 297 void buffer_reserve(Buffer *buffer, size_t len);
 298 int buffer_empty(Buffer *buffer);
 299 uint8_t *buffer_end(Buffer *buffer);
 300 void buffer_reset(Buffer *buffer);
 301 void buffer_append(Buffer *buffer, const void *data, size_t len);
 302
 303
 304 /* Misc helpers */
 305
 306 char *vnc_socket_local_addr(const char *format, int fd);
 307 char *vnc_socket_remote_addr(const char *format, int fd);
 308
 309 #endif /* __QEMU_VNC_H */