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