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 #ifdef CONFIG_VNC_TLS
  37 #include <gnutls/gnutls.h>
  38 #include <gnutls/x509.h>
  39 #endif /* CONFIG_VNC_TLS */
  40
  41 #include "keymaps.h"
  42
  43 /*****************************************************************************
  44  *
  45  * Core data structures
  46  *
  47  *****************************************************************************/
  48
  49 typedef struct Buffer
  50 {
  51     size_t capacity;
  52     size_t offset;
  53     uint8_t *buffer;
  54 } Buffer;
  55
  56 typedef struct VncState VncState;
  57
  58 typedef int VncReadEvent(VncState *vs, uint8_t *data, size_t len);
  59
  60 typedef void VncWritePixels(VncState *vs, void *data, int size);
  61
  62 typedef void VncSendHextileTile(VncState *vs,
  63                                 int x, int y, int w, int h,
  64                                 void *last_bg,
  65                                 void *last_fg,
  66                                 int *has_bg, int *has_fg);
  67
  68 #define VNC_MAX_WIDTH 2048
  69 #define VNC_MAX_HEIGHT 2048
  70 #define VNC_DIRTY_WORDS (VNC_MAX_WIDTH / (16 * 32))
  71
  72 #define VNC_AUTH_CHALLENGE_SIZE 16
  73
  74 typedef struct VncDisplay VncDisplay;
  75
  76 struct VncDisplay
  77 {
  78     int lsock;
  79     DisplayState *ds;
  80     VncState *clients;
  81     kbd_layout_t *kbd_layout;
  82
  83     char *display;
  84     char *password;
  85     int auth;
  86 #ifdef CONFIG_VNC_TLS
  87     int subauth;
  88     int x509verify;
  89
  90     char *x509cacert;
  91     char *x509cacrl;
  92     char *x509cert;
  93     char *x509key;
  94 #endif
  95 };
  96
  97 struct VncState
  98 {
  99     QEMUTimer *timer;
 100     int csock;
 101     DisplayState *ds;
 102     VncDisplay *vd;
 103     int need_update;
 104     uint32_t dirty_row[VNC_MAX_HEIGHT][VNC_DIRTY_WORDS];
 105     char *old_data;
 106     uint32_t features;
 107     int absolute;
 108     int last_x;
 109     int last_y;
 110
 111     uint32_t vnc_encoding;
 112     uint8_t tight_quality;
 113     uint8_t tight_compression;
 114
 115     int major;
 116     int minor;
 117
 118     char challenge[VNC_AUTH_CHALLENGE_SIZE];
 119
 120 #ifdef CONFIG_VNC_TLS
 121     int wiremode;
 122     gnutls_session_t tls_session;
 123 #endif
 124
 125     Buffer output;
 126     Buffer input;
 127     /* current output mode information */
 128     VncWritePixels *write_pixels;
 129     VncSendHextileTile *send_hextile_tile;
 130     DisplaySurface clientds, serverds;
 131
 132     CaptureVoiceOut *audio_cap;
 133     struct audsettings as;
 134
 135     VncReadEvent *read_handler;
 136     size_t read_handler_expect;
 137     /* input */
 138     uint8_t modifiers_state[256];
 139
 140     Buffer zlib;
 141     Buffer zlib_tmp;
 142     z_stream zlib_stream[4];
 143
 144     VncState *next;
 145 };
 146
 147
 148 /*****************************************************************************
 149  *
 150  * Authentication modes
 151  *
 152  *****************************************************************************/
 153
 154 enum {
 155     VNC_AUTH_INVALID = 0,
 156     VNC_AUTH_NONE = 1,
 157     VNC_AUTH_VNC = 2,
 158     VNC_AUTH_RA2 = 5,
 159     VNC_AUTH_RA2NE = 6,
 160     VNC_AUTH_TIGHT = 16,
 161     VNC_AUTH_ULTRA = 17,
 162     VNC_AUTH_TLS = 18,
 163     VNC_AUTH_VENCRYPT = 19
 164 };
 165
 166 #ifdef CONFIG_VNC_TLS
 167 enum {
 168     VNC_WIREMODE_CLEAR,
 169     VNC_WIREMODE_TLS,
 170 };
 171
 172 enum {
 173     VNC_AUTH_VENCRYPT_PLAIN = 256,
 174     VNC_AUTH_VENCRYPT_TLSNONE = 257,
 175     VNC_AUTH_VENCRYPT_TLSVNC = 258,
 176     VNC_AUTH_VENCRYPT_TLSPLAIN = 259,
 177     VNC_AUTH_VENCRYPT_X509NONE = 260,
 178     VNC_AUTH_VENCRYPT_X509VNC = 261,
 179     VNC_AUTH_VENCRYPT_X509PLAIN = 262,
 180 };
 181
 182 #define X509_CA_CERT_FILE "ca-cert.pem"
 183 #define X509_CA_CRL_FILE "ca-crl.pem"
 184 #define X509_SERVER_KEY_FILE "server-key.pem"
 185 #define X509_SERVER_CERT_FILE "server-cert.pem"
 186
 187 #endif /* CONFIG_VNC_TLS */
 188
 189 /*****************************************************************************
 190  *
 191  * Encoding types
 192  *
 193  *****************************************************************************/
 194
 195 #define VNC_ENCODING_RAW                  0x00000000
 196 #define VNC_ENCODING_COPYRECT             0x00000001
 197 #define VNC_ENCODING_RRE                  0x00000002
 198 #define VNC_ENCODING_CORRE                0x00000004
 199 #define VNC_ENCODING_HEXTILE              0x00000005
 200 #define VNC_ENCODING_ZLIB                 0x00000006
 201 #define VNC_ENCODING_TIGHT                0x00000007
 202 #define VNC_ENCODING_ZLIBHEX              0x00000008
 203 #define VNC_ENCODING_TRLE                 0x0000000f
 204 #define VNC_ENCODING_ZRLE                 0x00000010
 205 #define VNC_ENCODING_ZYWRLE               0x00000011
 206 #define VNC_ENCODING_COMPRESSLEVEL0       0xFFFFFF00 /* -256 */
 207 #define VNC_ENCODING_QUALITYLEVEL0        0xFFFFFFE0 /* -32  */
 208 #define VNC_ENCODING_XCURSOR              0xFFFFFF10 /* -240 */
 209 #define VNC_ENCODING_RICH_CURSOR          0xFFFFFF11 /* -239 */
 210 #define VNC_ENCODING_POINTER_POS          0xFFFFFF18 /* -232 */
 211 #define VNC_ENCODING_LASTRECT             0xFFFFFF20 /* -224 */
 212 #define VNC_ENCODING_DESKTOPRESIZE        0xFFFFFF21 /* -223 */
 213 #define VNC_ENCODING_POINTER_TYPE_CHANGE  0XFFFFFEFF /* -257 */
 214 #define VNC_ENCODING_EXT_KEY_EVENT        0XFFFFFEFE /* -258 */
 215 #define VNC_ENCODING_AUDIO                0XFFFFFEFD /* -259 */
 216 #define VNC_ENCODING_WMVi                 0x574D5669
 217
 218 /*****************************************************************************
 219  *
 220  * Other tight constants
 221  *
 222  *****************************************************************************/
 223
 224 /*
 225  * Vendors known by TightVNC: standard VNC/RealVNC, TridiaVNC, and TightVNC.
 226  */
 227
 228 #define VNC_TIGHT_CCB_RESET_MASK   (0x0f)
 229 #define VNC_TIGHT_CCB_TYPE_MASK    (0x0f << 4)
 230 #define VNC_TIGHT_CCB_TYPE_FILL    (0x08 << 4)
 231 #define VNC_TIGHT_CCB_TYPE_JPEG    (0x09 << 4)
 232 #define VNC_TIGHT_CCB_BASIC_MAX    (0x07 << 4)
 233 #define VNC_TIGHT_CCB_BASIC_ZLIB   (0x03 << 4)
 234 #define VNC_TIGHT_CCB_BASIC_FILTER (0x04 << 4)
 235
 236 /*****************************************************************************
 237  *
 238  * Features
 239  *
 240  *****************************************************************************/
 241
 242 #define VNC_FEATURE_RESIZE                   0
 243 #define VNC_FEATURE_HEXTILE                  1
 244 #define VNC_FEATURE_POINTER_TYPE_CHANGE      2
 245 #define VNC_FEATURE_WMVI                     3
 246 #define VNC_FEATURE_TIGHT                    4
 247 #define VNC_FEATURE_ZLIB                     5
 248 #define VNC_FEATURE_COPYRECT                 6
 249
 250 #define VNC_FEATURE_RESIZE_MASK              (1 << VNC_FEATURE_RESIZE)
 251 #define VNC_FEATURE_HEXTILE_MASK             (1 << VNC_FEATURE_HEXTILE)
 252 #define VNC_FEATURE_POINTER_TYPE_CHANGE_MASK (1 << VNC_FEATURE_POINTER_TYPE_CHANGE)
 253 #define VNC_FEATURE_WMVI_MASK                (1 << VNC_FEATURE_WMVI)
 254 #define VNC_FEATURE_TIGHT_MASK               (1 << VNC_FEATURE_TIGHT)
 255 #define VNC_FEATURE_ZLIB_MASK                (1 << VNC_FEATURE_ZLIB)
 256 #define VNC_FEATURE_COPYRECT_MASK            (1 << VNC_FEATURE_COPYRECT)
 257
 258 #endif /* __QEMU_VNC_H */