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