]> git.proxmox.com Git - qemu.git/blame - ui/vnc.c
vnc: Make ledstate comparison before modifiers updated
[qemu.git] / ui / vnc.c
CommitLineData
7d510b8c
FB
1/*
2 * QEMU VNC display driver
5fafdf24 3 *
7d510b8c
FB
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
19a490bf 6 * Copyright (C) 2009 Red Hat, Inc
5fafdf24 7 *
7d510b8c
FB
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
19a490bf 27#include "vnc.h"
bd023f95 28#include "vnc-jobs.h"
9c17d615 29#include "sysemu/sysemu.h"
1de7afc9
PB
30#include "qemu/sockets.h"
31#include "qemu/timer.h"
32#include "qemu/acl.h"
7b1b5d19 33#include "qapi/qmp/types.h"
2b54aa87 34#include "qmp-commands.h"
1de7afc9 35#include "qemu/osdep.h"
24236869 36
0f7b2864 37#define VNC_REFRESH_INTERVAL_BASE GUI_REFRESH_INTERVAL_DEFAULT
2430ffe4 38#define VNC_REFRESH_INTERVAL_INC 50
0f7b2864 39#define VNC_REFRESH_INTERVAL_MAX GUI_REFRESH_INTERVAL_IDLE
999342a0
CC
40static const struct timeval VNC_REFRESH_STATS = { 0, 500000 };
41static const struct timeval VNC_REFRESH_LOSSY = { 2, 0 };
24236869
FB
42
43#include "vnc_keysym.h"
70848515
TS
44#include "d3des.h"
45
753b4053 46static VncDisplay *vnc_display; /* needed for info vnc */
a9ce8590 47
d467b679 48static int vnc_cursor_define(VncState *vs);
7bc9318b 49static void vnc_release_modifiers(VncState *vs);
d467b679 50
8cf36489
GH
51static void vnc_set_share_mode(VncState *vs, VncShareMode mode)
52{
53#ifdef _VNC_DEBUG
54 static const char *mn[] = {
55 [0] = "undefined",
56 [VNC_SHARE_MODE_CONNECTING] = "connecting",
57 [VNC_SHARE_MODE_SHARED] = "shared",
58 [VNC_SHARE_MODE_EXCLUSIVE] = "exclusive",
59 [VNC_SHARE_MODE_DISCONNECTED] = "disconnected",
60 };
61 fprintf(stderr, "%s/%d: %s -> %s\n", __func__,
62 vs->csock, mn[vs->share_mode], mn[mode]);
63#endif
64
65 if (vs->share_mode == VNC_SHARE_MODE_EXCLUSIVE) {
66 vs->vd->num_exclusive--;
67 }
68 vs->share_mode = mode;
69 if (vs->share_mode == VNC_SHARE_MODE_EXCLUSIVE) {
70 vs->vd->num_exclusive++;
71 }
72}
73
1ff7df1a
AL
74static char *addr_to_string(const char *format,
75 struct sockaddr_storage *sa,
76 socklen_t salen) {
77 char *addr;
78 char host[NI_MAXHOST];
79 char serv[NI_MAXSERV];
80 int err;
457772e6 81 size_t addrlen;
1ff7df1a
AL
82
83 if ((err = getnameinfo((struct sockaddr *)sa, salen,
84 host, sizeof(host),
85 serv, sizeof(serv),
86 NI_NUMERICHOST | NI_NUMERICSERV)) != 0) {
87 VNC_DEBUG("Cannot resolve address %d: %s\n",
88 err, gai_strerror(err));
89 return NULL;
90 }
91
457772e6 92 /* Enough for the existing format + the 2 vars we're
f425c278 93 * substituting in. */
457772e6 94 addrlen = strlen(format) + strlen(host) + strlen(serv);
7267c094 95 addr = g_malloc(addrlen + 1);
457772e6
AL
96 snprintf(addr, addrlen, format, host, serv);
97 addr[addrlen] = '\0';
1ff7df1a
AL
98
99 return addr;
100}
101
2f9606b3
AL
102
103char *vnc_socket_local_addr(const char *format, int fd) {
1ff7df1a
AL
104 struct sockaddr_storage sa;
105 socklen_t salen;
106
107 salen = sizeof(sa);
108 if (getsockname(fd, (struct sockaddr*)&sa, &salen) < 0)
109 return NULL;
110
111 return addr_to_string(format, &sa, salen);
112}
113
2f9606b3 114char *vnc_socket_remote_addr(const char *format, int fd) {
1ff7df1a
AL
115 struct sockaddr_storage sa;
116 socklen_t salen;
117
118 salen = sizeof(sa);
119 if (getpeername(fd, (struct sockaddr*)&sa, &salen) < 0)
120 return NULL;
121
122 return addr_to_string(format, &sa, salen);
123}
124
d96fd29c
LC
125static int put_addr_qdict(QDict *qdict, struct sockaddr_storage *sa,
126 socklen_t salen)
127{
128 char host[NI_MAXHOST];
129 char serv[NI_MAXSERV];
130 int err;
131
132 if ((err = getnameinfo((struct sockaddr *)sa, salen,
133 host, sizeof(host),
134 serv, sizeof(serv),
135 NI_NUMERICHOST | NI_NUMERICSERV)) != 0) {
136 VNC_DEBUG("Cannot resolve address %d: %s\n",
137 err, gai_strerror(err));
138 return -1;
139 }
140
141 qdict_put(qdict, "host", qstring_from_str(host));
142 qdict_put(qdict, "service", qstring_from_str(serv));
dc0d4efc 143 qdict_put(qdict, "family",qstring_from_str(inet_strfamily(sa->ss_family)));
d96fd29c
LC
144
145 return 0;
146}
147
a7789382 148static int vnc_server_addr_put(QDict *qdict, int fd)
d96fd29c
LC
149{
150 struct sockaddr_storage sa;
151 socklen_t salen;
152
153 salen = sizeof(sa);
154 if (getsockname(fd, (struct sockaddr*)&sa, &salen) < 0) {
155 return -1;
156 }
157
158 return put_addr_qdict(qdict, &sa, salen);
159}
160
161static int vnc_qdict_remote_addr(QDict *qdict, int fd)
162{
163 struct sockaddr_storage sa;
164 socklen_t salen;
165
166 salen = sizeof(sa);
167 if (getpeername(fd, (struct sockaddr*)&sa, &salen) < 0) {
168 return -1;
169 }
170
171 return put_addr_qdict(qdict, &sa, salen);
172}
173
1ff7df1a
AL
174static const char *vnc_auth_name(VncDisplay *vd) {
175 switch (vd->auth) {
176 case VNC_AUTH_INVALID:
177 return "invalid";
178 case VNC_AUTH_NONE:
179 return "none";
180 case VNC_AUTH_VNC:
181 return "vnc";
182 case VNC_AUTH_RA2:
183 return "ra2";
184 case VNC_AUTH_RA2NE:
185 return "ra2ne";
186 case VNC_AUTH_TIGHT:
187 return "tight";
188 case VNC_AUTH_ULTRA:
189 return "ultra";
190 case VNC_AUTH_TLS:
191 return "tls";
192 case VNC_AUTH_VENCRYPT:
193#ifdef CONFIG_VNC_TLS
194 switch (vd->subauth) {
195 case VNC_AUTH_VENCRYPT_PLAIN:
196 return "vencrypt+plain";
197 case VNC_AUTH_VENCRYPT_TLSNONE:
198 return "vencrypt+tls+none";
199 case VNC_AUTH_VENCRYPT_TLSVNC:
200 return "vencrypt+tls+vnc";
201 case VNC_AUTH_VENCRYPT_TLSPLAIN:
202 return "vencrypt+tls+plain";
203 case VNC_AUTH_VENCRYPT_X509NONE:
204 return "vencrypt+x509+none";
205 case VNC_AUTH_VENCRYPT_X509VNC:
206 return "vencrypt+x509+vnc";
207 case VNC_AUTH_VENCRYPT_X509PLAIN:
208 return "vencrypt+x509+plain";
28a76be8
AL
209 case VNC_AUTH_VENCRYPT_TLSSASL:
210 return "vencrypt+tls+sasl";
211 case VNC_AUTH_VENCRYPT_X509SASL:
212 return "vencrypt+x509+sasl";
1ff7df1a
AL
213 default:
214 return "vencrypt";
215 }
216#else
217 return "vencrypt";
218#endif
2f9606b3 219 case VNC_AUTH_SASL:
28a76be8 220 return "sasl";
1ff7df1a
AL
221 }
222 return "unknown";
223}
224
a7789382
LC
225static int vnc_server_info_put(QDict *qdict)
226{
227 if (vnc_server_addr_put(qdict, vnc_display->lsock) < 0) {
228 return -1;
229 }
230
231 qdict_put(qdict, "auth", qstring_from_str(vnc_auth_name(vnc_display)));
232 return 0;
233}
234
4a80dba3 235static void vnc_client_cache_auth(VncState *client)
1ff7df1a 236{
2ded6ad7 237#if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
d96fd29c 238 QDict *qdict;
2ded6ad7 239#endif
1ff7df1a 240
4a80dba3
LC
241 if (!client->info) {
242 return;
d96fd29c 243 }
1263b7d6 244
2ded6ad7 245#if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
4a80dba3 246 qdict = qobject_to_qdict(client->info);
2ded6ad7 247#endif
4a80dba3 248
1263b7d6
AL
249#ifdef CONFIG_VNC_TLS
250 if (client->tls.session &&
d96fd29c
LC
251 client->tls.dname) {
252 qdict_put(qdict, "x509_dname", qstring_from_str(client->tls.dname));
253 }
1263b7d6
AL
254#endif
255#ifdef CONFIG_VNC_SASL
256 if (client->sasl.conn &&
d96fd29c 257 client->sasl.username) {
76825067
LC
258 qdict_put(qdict, "sasl_username",
259 qstring_from_str(client->sasl.username));
d96fd29c 260 }
1263b7d6 261#endif
4a80dba3 262}
d96fd29c 263
4a80dba3
LC
264static void vnc_client_cache_addr(VncState *client)
265{
266 QDict *qdict;
267
268 qdict = qdict_new();
269 if (vnc_qdict_remote_addr(qdict, client->csock) < 0) {
270 QDECREF(qdict);
271 /* XXX: how to report the error? */
272 return;
273 }
274
275 client->info = QOBJECT(qdict);
1ff7df1a
AL
276}
277
586153d9
LC
278static void vnc_qmp_event(VncState *vs, MonitorEvent event)
279{
280 QDict *server;
281 QObject *data;
282
283 if (!vs->info) {
284 return;
285 }
286
287 server = qdict_new();
288 if (vnc_server_info_put(server) < 0) {
289 QDECREF(server);
290 return;
291 }
292
293 data = qobject_from_jsonf("{ 'client': %p, 'server': %p }",
294 vs->info, QOBJECT(server));
295
296 monitor_protocol_event(event, data);
297
298 qobject_incref(vs->info);
299 qobject_decref(data);
300}
301
2b54aa87 302static VncClientInfo *qmp_query_vnc_client(const VncState *client)
a9ce8590 303{
2b54aa87
LC
304 struct sockaddr_storage sa;
305 socklen_t salen = sizeof(sa);
306 char host[NI_MAXHOST];
307 char serv[NI_MAXSERV];
308 VncClientInfo *info;
309
310 if (getpeername(client->csock, (struct sockaddr *)&sa, &salen) < 0) {
311 return NULL;
312 }
313
314 if (getnameinfo((struct sockaddr *)&sa, salen,
315 host, sizeof(host),
316 serv, sizeof(serv),
317 NI_NUMERICHOST | NI_NUMERICSERV) < 0) {
318 return NULL;
319 }
d96fd29c 320
2b54aa87
LC
321 info = g_malloc0(sizeof(*info));
322 info->host = g_strdup(host);
323 info->service = g_strdup(serv);
324 info->family = g_strdup(inet_strfamily(sa.ss_family));
d96fd29c
LC
325
326#ifdef CONFIG_VNC_TLS
2b54aa87
LC
327 if (client->tls.session && client->tls.dname) {
328 info->has_x509_dname = true;
329 info->x509_dname = g_strdup(client->tls.dname);
330 }
d96fd29c
LC
331#endif
332#ifdef CONFIG_VNC_SASL
2b54aa87
LC
333 if (client->sasl.conn && client->sasl.username) {
334 info->has_sasl_username = true;
335 info->sasl_username = g_strdup(client->sasl.username);
d96fd29c 336 }
2b54aa87 337#endif
1ff7df1a 338
2b54aa87 339 return info;
d96fd29c 340}
1ff7df1a 341
2b54aa87 342VncInfo *qmp_query_vnc(Error **errp)
d96fd29c 343{
2b54aa87
LC
344 VncInfo *info = g_malloc0(sizeof(*info));
345
d96fd29c 346 if (vnc_display == NULL || vnc_display->display == NULL) {
2b54aa87 347 info->enabled = false;
d96fd29c 348 } else {
2b54aa87
LC
349 VncClientInfoList *cur_item = NULL;
350 struct sockaddr_storage sa;
351 socklen_t salen = sizeof(sa);
352 char host[NI_MAXHOST];
353 char serv[NI_MAXSERV];
41b4bef6 354 VncState *client;
1ff7df1a 355
2b54aa87
LC
356 info->enabled = true;
357
358 /* for compatibility with the original command */
359 info->has_clients = true;
360
41b4bef6 361 QTAILQ_FOREACH(client, &vnc_display->clients, next) {
2b54aa87
LC
362 VncClientInfoList *cinfo = g_malloc0(sizeof(*info));
363 cinfo->value = qmp_query_vnc_client(client);
364
365 /* XXX: waiting for the qapi to support GSList */
366 if (!cur_item) {
367 info->clients = cur_item = cinfo;
368 } else {
369 cur_item->next = cinfo;
370 cur_item = cinfo;
1ff7df1a 371 }
d96fd29c
LC
372 }
373
417b0b88
PB
374 if (vnc_display->lsock == -1) {
375 return info;
376 }
377
2b54aa87
LC
378 if (getsockname(vnc_display->lsock, (struct sockaddr *)&sa,
379 &salen) == -1) {
380 error_set(errp, QERR_UNDEFINED_ERROR);
381 goto out_error;
382 }
d96fd29c 383
2b54aa87
LC
384 if (getnameinfo((struct sockaddr *)&sa, salen,
385 host, sizeof(host),
386 serv, sizeof(serv),
387 NI_NUMERICHOST | NI_NUMERICSERV) < 0) {
388 error_set(errp, QERR_UNDEFINED_ERROR);
389 goto out_error;
1ff7df1a 390 }
2b54aa87
LC
391
392 info->has_host = true;
393 info->host = g_strdup(host);
394
395 info->has_service = true;
396 info->service = g_strdup(serv);
397
398 info->has_family = true;
399 info->family = g_strdup(inet_strfamily(sa.ss_family));
400
401 info->has_auth = true;
402 info->auth = g_strdup(vnc_auth_name(vnc_display));
a9ce8590 403 }
2b54aa87
LC
404
405 return info;
406
407out_error:
408 qapi_free_VncInfo(info);
409 return NULL;
a9ce8590
FB
410}
411
24236869
FB
412/* TODO
413 1) Get the queue working for IO.
414 2) there is some weirdness when using the -S option (the screen is grey
415 and not totally invalidated
416 3) resolutions > 1024
417*/
418
2430ffe4 419static int vnc_update_client(VncState *vs, int has_dirty);
bd023f95 420static int vnc_update_client_sync(VncState *vs, int has_dirty);
198a0039 421static void vnc_disconnect_start(VncState *vs);
24236869 422
753b4053 423static void vnc_colordepth(VncState *vs);
1fc62412
SS
424static void framebuffer_update_request(VncState *vs, int incremental,
425 int x_position, int y_position,
426 int w, int h);
0f7b2864 427static void vnc_refresh(DisplayChangeListener *dcl);
1fc62412 428static int vnc_refresh_server_surface(VncDisplay *vd);
7eac3a87 429
7c20b4a3 430static void vnc_dpy_update(DisplayChangeListener *dcl,
7c20b4a3 431 int x, int y, int w, int h)
24236869 432{
24236869 433 int i;
21ef45d7 434 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
1fc62412 435 struct VncSurface *s = &vd->guest;
d39fa6d8
GH
436 int width = surface_width(vd->ds);
437 int height = surface_height(vd->ds);
24236869
FB
438
439 h += y;
440
0486e8a7
AZ
441 /* round x down to ensure the loop only spans one 16-pixel block per,
442 iteration. otherwise, if (x % 16) != 0, the last iteration may span
443 two 16-pixel blocks but we only mark the first as dirty
444 */
445 w += (x % 16);
446 x -= (x % 16);
447
9f64916d
GH
448 x = MIN(x, width);
449 y = MIN(y, height);
450 w = MIN(x + w, width) - x;
451 h = MIN(h, height);
788abf8e 452
24236869 453 for (; y < h; y++)
28a76be8 454 for (i = 0; i < w; i += 16)
bc2429b9 455 set_bit((x + i) / 16, s->dirty[y]);
24236869
FB
456}
457
70a4568f
CC
458void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
459 int32_t encoding)
24236869
FB
460{
461 vnc_write_u16(vs, x);
462 vnc_write_u16(vs, y);
463 vnc_write_u16(vs, w);
464 vnc_write_u16(vs, h);
465
466 vnc_write_s32(vs, encoding);
467}
468
2f9606b3 469void buffer_reserve(Buffer *buffer, size_t len)
89064286
AL
470{
471 if ((buffer->capacity - buffer->offset) < len) {
28a76be8 472 buffer->capacity += (len + 1024);
7267c094 473 buffer->buffer = g_realloc(buffer->buffer, buffer->capacity);
28a76be8
AL
474 if (buffer->buffer == NULL) {
475 fprintf(stderr, "vnc: out of memory\n");
476 exit(1);
477 }
89064286
AL
478 }
479}
480
71a8cdec 481static int buffer_empty(Buffer *buffer)
89064286
AL
482{
483 return buffer->offset == 0;
484}
485
7536ee4b 486uint8_t *buffer_end(Buffer *buffer)
89064286
AL
487{
488 return buffer->buffer + buffer->offset;
489}
490
2f9606b3 491void buffer_reset(Buffer *buffer)
89064286 492{
28a76be8 493 buffer->offset = 0;
89064286
AL
494}
495
5d418e3b
CC
496void buffer_free(Buffer *buffer)
497{
7267c094 498 g_free(buffer->buffer);
5d418e3b
CC
499 buffer->offset = 0;
500 buffer->capacity = 0;
501 buffer->buffer = NULL;
502}
503
2f9606b3 504void buffer_append(Buffer *buffer, const void *data, size_t len)
89064286
AL
505{
506 memcpy(buffer->buffer + buffer->offset, data, len);
507 buffer->offset += len;
508}
509
32ed2680
TH
510void buffer_advance(Buffer *buf, size_t len)
511{
512 memmove(buf->buffer, buf->buffer + len,
513 (buf->offset - len));
514 buf->offset -= len;
515}
516
621aaeb9
GH
517static void vnc_desktop_resize(VncState *vs)
518{
d39fa6d8 519 DisplaySurface *ds = vs->vd->ds;
621aaeb9
GH
520
521 if (vs->csock == -1 || !vnc_has_feature(vs, VNC_FEATURE_RESIZE)) {
522 return;
523 }
d39fa6d8
GH
524 if (vs->client_width == surface_width(ds) &&
525 vs->client_height == surface_height(ds)) {
1d4b638a
GH
526 return;
527 }
d39fa6d8
GH
528 vs->client_width = surface_width(ds);
529 vs->client_height = surface_height(ds);
bd023f95 530 vnc_lock_output(vs);
621aaeb9
GH
531 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
532 vnc_write_u8(vs, 0);
533 vnc_write_u16(vs, 1); /* number of rects */
5862d195 534 vnc_framebuffer_update(vs, 0, 0, vs->client_width, vs->client_height,
621aaeb9 535 VNC_ENCODING_DESKTOPRESIZE);
bd023f95 536 vnc_unlock_output(vs);
621aaeb9
GH
537 vnc_flush(vs);
538}
539
bd023f95
CC
540static void vnc_abort_display_jobs(VncDisplay *vd)
541{
542 VncState *vs;
543
544 QTAILQ_FOREACH(vs, &vd->clients, next) {
545 vnc_lock_output(vs);
546 vs->abort = true;
547 vnc_unlock_output(vs);
548 }
549 QTAILQ_FOREACH(vs, &vd->clients, next) {
550 vnc_jobs_join(vs);
551 }
552 QTAILQ_FOREACH(vs, &vd->clients, next) {
553 vnc_lock_output(vs);
554 vs->abort = false;
555 vnc_unlock_output(vs);
556 }
557}
bd023f95 558
9f64916d
GH
559int vnc_server_fb_stride(VncDisplay *vd)
560{
561 return pixman_image_get_stride(vd->server);
562}
563
564void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y)
565{
566 uint8_t *ptr;
567
568 ptr = (uint8_t *)pixman_image_get_data(vd->server);
569 ptr += y * vnc_server_fb_stride(vd);
570 ptr += x * VNC_SERVER_FB_BYTES;
571 return ptr;
572}
573
c12aeb86 574static void vnc_dpy_switch(DisplayChangeListener *dcl,
c12aeb86 575 DisplaySurface *surface)
24236869 576{
21ef45d7 577 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
41b4bef6 578 VncState *vs;
1fc62412 579
bd023f95
CC
580 vnc_abort_display_jobs(vd);
581
1fc62412 582 /* server surface */
9f64916d 583 qemu_pixman_image_unref(vd->server);
d39fa6d8 584 vd->ds = surface;
9f64916d 585 vd->server = pixman_image_create_bits(VNC_SERVER_FB_FORMAT,
d39fa6d8
GH
586 surface_width(vd->ds),
587 surface_height(vd->ds),
9f64916d 588 NULL, 0);
24236869 589
6baebed7 590 /* guest surface */
9f64916d 591#if 0 /* FIXME */
1fc62412 592 if (ds_get_bytes_per_pixel(ds) != vd->guest.ds->pf.bytes_per_pixel)
a528b80c 593 console_color_init(ds);
9f64916d
GH
594#endif
595 qemu_pixman_image_unref(vd->guest.fb);
d39fa6d8
GH
596 vd->guest.fb = pixman_image_ref(surface->image);
597 vd->guest.format = surface->format;
1fc62412 598 memset(vd->guest.dirty, 0xFF, sizeof(vd->guest.dirty));
24236869 599
41b4bef6 600 QTAILQ_FOREACH(vs, &vd->clients, next) {
1fc62412 601 vnc_colordepth(vs);
1d4b638a 602 vnc_desktop_resize(vs);
d467b679
GH
603 if (vs->vd->cursor) {
604 vnc_cursor_define(vs);
605 }
1fc62412 606 memset(vs->dirty, 0xFF, sizeof(vs->dirty));
753b4053
AL
607 }
608}
609
3512779a 610/* fastest code */
9f64916d 611static void vnc_write_pixels_copy(VncState *vs,
d467b679 612 void *pixels, int size)
3512779a
FB
613{
614 vnc_write(vs, pixels, size);
615}
616
617/* slowest but generic code. */
70a4568f 618void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v)
3512779a 619{
7eac3a87 620 uint8_t r, g, b;
1fc62412 621
9f64916d
GH
622#if VNC_SERVER_FB_FORMAT == PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
623 r = (((v & 0x00ff0000) >> 16) << vs->client_pf.rbits) >> 8;
624 g = (((v & 0x0000ff00) >> 8) << vs->client_pf.gbits) >> 8;
625 b = (((v & 0x000000ff) >> 0) << vs->client_pf.bbits) >> 8;
626#else
627# error need some bits here if you change VNC_SERVER_FB_FORMAT
628#endif
629 v = (r << vs->client_pf.rshift) |
630 (g << vs->client_pf.gshift) |
631 (b << vs->client_pf.bshift);
632 switch (vs->client_pf.bytes_per_pixel) {
3512779a
FB
633 case 1:
634 buf[0] = v;
635 break;
636 case 2:
9f64916d 637 if (vs->client_be) {
3512779a
FB
638 buf[0] = v >> 8;
639 buf[1] = v;
640 } else {
641 buf[1] = v >> 8;
642 buf[0] = v;
643 }
644 break;
645 default:
646 case 4:
9f64916d 647 if (vs->client_be) {
3512779a
FB
648 buf[0] = v >> 24;
649 buf[1] = v >> 16;
650 buf[2] = v >> 8;
651 buf[3] = v;
652 } else {
653 buf[3] = v >> 24;
654 buf[2] = v >> 16;
655 buf[1] = v >> 8;
656 buf[0] = v;
657 }
658 break;
659 }
660}
661
9f64916d 662static void vnc_write_pixels_generic(VncState *vs,
d467b679 663 void *pixels1, int size)
3512779a 664{
3512779a 665 uint8_t buf[4];
3512779a 666
9f64916d 667 if (VNC_SERVER_FB_BYTES == 4) {
7eac3a87
AL
668 uint32_t *pixels = pixels1;
669 int n, i;
670 n = size >> 2;
9f64916d 671 for (i = 0; i < n; i++) {
7eac3a87 672 vnc_convert_pixel(vs, buf, pixels[i]);
9f64916d 673 vnc_write(vs, buf, vs->client_pf.bytes_per_pixel);
7eac3a87 674 }
3512779a
FB
675 }
676}
677
a885211e 678int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h)
24236869
FB
679{
680 int i;
60fe76f3 681 uint8_t *row;
1fc62412 682 VncDisplay *vd = vs->vd;
24236869 683
9f64916d 684 row = vnc_server_fb_ptr(vd, x, y);
24236869 685 for (i = 0; i < h; i++) {
9f64916d
GH
686 vs->write_pixels(vs, row, w * VNC_SERVER_FB_BYTES);
687 row += vnc_server_fb_stride(vd);
24236869 688 }
a885211e 689 return 1;
24236869
FB
690}
691
bd023f95 692int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h)
24236869 693{
a885211e
CC
694 int n = 0;
695
fb437313 696 switch(vs->vnc_encoding) {
28a76be8 697 case VNC_ENCODING_ZLIB:
a885211e 698 n = vnc_zlib_send_framebuffer_update(vs, x, y, w, h);
28a76be8
AL
699 break;
700 case VNC_ENCODING_HEXTILE:
701 vnc_framebuffer_update(vs, x, y, w, h, VNC_ENCODING_HEXTILE);
a885211e 702 n = vnc_hextile_send_framebuffer_update(vs, x, y, w, h);
28a76be8 703 break;
380282b0
CC
704 case VNC_ENCODING_TIGHT:
705 n = vnc_tight_send_framebuffer_update(vs, x, y, w, h);
706 break;
efe556ad
CC
707 case VNC_ENCODING_TIGHT_PNG:
708 n = vnc_tight_png_send_framebuffer_update(vs, x, y, w, h);
709 break;
148954fa
CC
710 case VNC_ENCODING_ZRLE:
711 n = vnc_zrle_send_framebuffer_update(vs, x, y, w, h);
712 break;
713 case VNC_ENCODING_ZYWRLE:
714 n = vnc_zywrle_send_framebuffer_update(vs, x, y, w, h);
715 break;
28a76be8
AL
716 default:
717 vnc_framebuffer_update(vs, x, y, w, h, VNC_ENCODING_RAW);
a885211e 718 n = vnc_raw_send_framebuffer_update(vs, x, y, w, h);
28a76be8 719 break;
fb437313 720 }
a885211e 721 return n;
24236869
FB
722}
723
753b4053 724static void vnc_copy(VncState *vs, int src_x, int src_y, int dst_x, int dst_y, int w, int h)
24236869 725{
3e28c9ad 726 /* send bitblit op to the vnc client */
bd023f95 727 vnc_lock_output(vs);
46a183da 728 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
24236869
FB
729 vnc_write_u8(vs, 0);
730 vnc_write_u16(vs, 1); /* number of rects */
29fa4ed9 731 vnc_framebuffer_update(vs, dst_x, dst_y, w, h, VNC_ENCODING_COPYRECT);
24236869
FB
732 vnc_write_u16(vs, src_x);
733 vnc_write_u16(vs, src_y);
bd023f95 734 vnc_unlock_output(vs);
24236869
FB
735 vnc_flush(vs);
736}
737
7c20b4a3 738static void vnc_dpy_copy(DisplayChangeListener *dcl,
7c20b4a3
GH
739 int src_x, int src_y,
740 int dst_x, int dst_y, int w, int h)
753b4053 741{
21ef45d7 742 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
198a0039 743 VncState *vs, *vn;
1fc62412
SS
744 uint8_t *src_row;
745 uint8_t *dst_row;
9f64916d 746 int i, x, y, pitch, inc, w_lim, s;
1fc62412 747 int cmp_bytes;
198a0039 748
1fc62412 749 vnc_refresh_server_surface(vd);
41b4bef6 750 QTAILQ_FOREACH_SAFE(vs, &vd->clients, next, vn) {
198a0039
GH
751 if (vnc_has_feature(vs, VNC_FEATURE_COPYRECT)) {
752 vs->force_update = 1;
bd023f95 753 vnc_update_client_sync(vs, 1);
198a0039
GH
754 /* vs might be free()ed here */
755 }
756 }
757
1fc62412 758 /* do bitblit op on the local surface too */
9f64916d
GH
759 pitch = vnc_server_fb_stride(vd);
760 src_row = vnc_server_fb_ptr(vd, src_x, src_y);
761 dst_row = vnc_server_fb_ptr(vd, dst_x, dst_y);
1fc62412
SS
762 y = dst_y;
763 inc = 1;
764 if (dst_y > src_y) {
765 /* copy backwards */
766 src_row += pitch * (h-1);
767 dst_row += pitch * (h-1);
768 pitch = -pitch;
769 y = dst_y + h - 1;
770 inc = -1;
771 }
772 w_lim = w - (16 - (dst_x % 16));
773 if (w_lim < 0)
774 w_lim = w;
775 else
776 w_lim = w - (w_lim % 16);
777 for (i = 0; i < h; i++) {
778 for (x = 0; x <= w_lim;
779 x += s, src_row += cmp_bytes, dst_row += cmp_bytes) {
780 if (x == w_lim) {
781 if ((s = w - w_lim) == 0)
782 break;
783 } else if (!x) {
784 s = (16 - (dst_x % 16));
785 s = MIN(s, w_lim);
786 } else {
787 s = 16;
788 }
9f64916d 789 cmp_bytes = s * VNC_SERVER_FB_BYTES;
1fc62412
SS
790 if (memcmp(src_row, dst_row, cmp_bytes) == 0)
791 continue;
792 memmove(dst_row, src_row, cmp_bytes);
41b4bef6
AS
793 QTAILQ_FOREACH(vs, &vd->clients, next) {
794 if (!vnc_has_feature(vs, VNC_FEATURE_COPYRECT)) {
bc2429b9 795 set_bit(((x + dst_x) / 16), vs->dirty[y]);
41b4bef6 796 }
1fc62412
SS
797 }
798 }
9f64916d
GH
799 src_row += pitch - w * VNC_SERVER_FB_BYTES;
800 dst_row += pitch - w * VNC_SERVER_FB_BYTES;
1fc62412
SS
801 y += inc;
802 }
803
41b4bef6
AS
804 QTAILQ_FOREACH(vs, &vd->clients, next) {
805 if (vnc_has_feature(vs, VNC_FEATURE_COPYRECT)) {
753b4053 806 vnc_copy(vs, src_x, src_y, dst_x, dst_y, w, h);
41b4bef6 807 }
753b4053
AL
808 }
809}
810
7c20b4a3 811static void vnc_mouse_set(DisplayChangeListener *dcl,
7c20b4a3 812 int x, int y, int visible)
d467b679
GH
813{
814 /* can we ask the client(s) to move the pointer ??? */
815}
816
817static int vnc_cursor_define(VncState *vs)
818{
819 QEMUCursor *c = vs->vd->cursor;
d467b679
GH
820 int isize;
821
822 if (vnc_has_feature(vs, VNC_FEATURE_RICH_CURSOR)) {
d01f9595 823 vnc_lock_output(vs);
d467b679
GH
824 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
825 vnc_write_u8(vs, 0); /* padding */
826 vnc_write_u16(vs, 1); /* # of rects */
827 vnc_framebuffer_update(vs, c->hot_x, c->hot_y, c->width, c->height,
828 VNC_ENCODING_RICH_CURSOR);
9f64916d
GH
829 isize = c->width * c->height * vs->client_pf.bytes_per_pixel;
830 vnc_write_pixels_generic(vs, c->data, isize);
d467b679 831 vnc_write(vs, vs->vd->cursor_mask, vs->vd->cursor_msize);
d01f9595 832 vnc_unlock_output(vs);
d467b679
GH
833 return 0;
834 }
835 return -1;
836}
837
7c20b4a3 838static void vnc_dpy_cursor_define(DisplayChangeListener *dcl,
7c20b4a3 839 QEMUCursor *c)
d467b679
GH
840{
841 VncDisplay *vd = vnc_display;
842 VncState *vs;
843
844 cursor_put(vd->cursor);
7267c094 845 g_free(vd->cursor_mask);
d467b679
GH
846
847 vd->cursor = c;
848 cursor_get(vd->cursor);
849 vd->cursor_msize = cursor_get_mono_bpl(c) * c->height;
7267c094 850 vd->cursor_mask = g_malloc0(vd->cursor_msize);
d467b679
GH
851 cursor_get_mono_mask(c, 0, vd->cursor_mask);
852
853 QTAILQ_FOREACH(vs, &vd->clients, next) {
854 vnc_cursor_define(vs);
855 }
856}
857
1fc62412 858static int find_and_clear_dirty_height(struct VncState *vs,
6c71a539 859 int y, int last_x, int x, int height)
24236869
FB
860{
861 int h;
862
6c71a539 863 for (h = 1; h < (height - y); h++) {
28a76be8 864 int tmp_x;
bc2429b9 865 if (!test_bit(last_x, vs->dirty[y + h])) {
28a76be8 866 break;
bc2429b9
CC
867 }
868 for (tmp_x = last_x; tmp_x < x; tmp_x++) {
869 clear_bit(tmp_x, vs->dirty[y + h]);
870 }
24236869
FB
871 }
872
873 return h;
874}
875
bd023f95
CC
876static int vnc_update_client_sync(VncState *vs, int has_dirty)
877{
878 int ret = vnc_update_client(vs, has_dirty);
879 vnc_jobs_join(vs);
880 return ret;
881}
bd023f95 882
2430ffe4 883static int vnc_update_client(VncState *vs, int has_dirty)
24236869 884{
24236869 885 if (vs->need_update && vs->csock != -1) {
1fc62412 886 VncDisplay *vd = vs->vd;
bd023f95 887 VncJob *job;
28a76be8 888 int y;
847ce6a1 889 int width, height;
bd023f95
CC
890 int n = 0;
891
24236869 892
703bc68f 893 if (vs->output.offset && !vs->audio_cap && !vs->force_update)
c522d0e2 894 /* kernel send buffers are full -> drop frames to throttle */
2430ffe4 895 return 0;
a0ecfb73 896
703bc68f 897 if (!has_dirty && !vs->audio_cap && !vs->force_update)
2430ffe4 898 return 0;
28a76be8 899
6baebed7
AL
900 /*
901 * Send screen updates to the vnc client using the server
902 * surface and server dirty map. guest surface updates
903 * happening in parallel don't disturb us, the next pass will
904 * send them to the client.
905 */
bd023f95 906 job = vnc_job_new(vs);
28a76be8 907
9f64916d
GH
908 width = MIN(pixman_image_get_width(vd->server), vs->client_width);
909 height = MIN(pixman_image_get_height(vd->server), vs->client_height);
847ce6a1
GH
910
911 for (y = 0; y < height; y++) {
28a76be8
AL
912 int x;
913 int last_x = -1;
847ce6a1 914 for (x = 0; x < width / 16; x++) {
bc2429b9 915 if (test_and_clear_bit(x, vs->dirty[y])) {
28a76be8
AL
916 if (last_x == -1) {
917 last_x = x;
918 }
28a76be8
AL
919 } else {
920 if (last_x != -1) {
6c71a539
CC
921 int h = find_and_clear_dirty_height(vs, y, last_x, x,
922 height);
bd023f95
CC
923
924 n += vnc_job_add_rect(job, last_x * 16, y,
925 (x - last_x) * 16, h);
28a76be8
AL
926 }
927 last_x = -1;
928 }
929 }
930 if (last_x != -1) {
6c71a539 931 int h = find_and_clear_dirty_height(vs, y, last_x, x, height);
bd023f95
CC
932 n += vnc_job_add_rect(job, last_x * 16, y,
933 (x - last_x) * 16, h);
28a76be8
AL
934 }
935 }
bd023f95
CC
936
937 vnc_job_push(job);
c522d0e2 938 vs->force_update = 0;
bd023f95 939 return n;
24236869 940 }
24236869 941
703bc68f 942 if (vs->csock == -1)
198a0039 943 vnc_disconnect_finish(vs);
2430ffe4
SS
944
945 return 0;
24236869
FB
946}
947
429a8ed3 948/* audio */
949static void audio_capture_notify(void *opaque, audcnotification_e cmd)
950{
951 VncState *vs = opaque;
952
953 switch (cmd) {
954 case AUD_CNOTIFY_DISABLE:
bd023f95 955 vnc_lock_output(vs);
46a183da
DB
956 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU);
957 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU_AUDIO);
958 vnc_write_u16(vs, VNC_MSG_SERVER_QEMU_AUDIO_END);
bd023f95 959 vnc_unlock_output(vs);
429a8ed3 960 vnc_flush(vs);
961 break;
962
963 case AUD_CNOTIFY_ENABLE:
bd023f95 964 vnc_lock_output(vs);
46a183da
DB
965 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU);
966 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU_AUDIO);
967 vnc_write_u16(vs, VNC_MSG_SERVER_QEMU_AUDIO_BEGIN);
bd023f95 968 vnc_unlock_output(vs);
429a8ed3 969 vnc_flush(vs);
970 break;
971 }
972}
973
974static void audio_capture_destroy(void *opaque)
975{
976}
977
978static void audio_capture(void *opaque, void *buf, int size)
979{
980 VncState *vs = opaque;
981
bd023f95 982 vnc_lock_output(vs);
46a183da
DB
983 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU);
984 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU_AUDIO);
985 vnc_write_u16(vs, VNC_MSG_SERVER_QEMU_AUDIO_DATA);
429a8ed3 986 vnc_write_u32(vs, size);
987 vnc_write(vs, buf, size);
bd023f95 988 vnc_unlock_output(vs);
429a8ed3 989 vnc_flush(vs);
990}
991
992static void audio_add(VncState *vs)
993{
994 struct audio_capture_ops ops;
995
996 if (vs->audio_cap) {
8631b608 997 monitor_printf(default_mon, "audio already running\n");
429a8ed3 998 return;
999 }
1000
1001 ops.notify = audio_capture_notify;
1002 ops.destroy = audio_capture_destroy;
1003 ops.capture = audio_capture;
1004
1a7dafce 1005 vs->audio_cap = AUD_add_capture(&vs->as, &ops, vs);
429a8ed3 1006 if (!vs->audio_cap) {
8631b608 1007 monitor_printf(default_mon, "Failed to add audio capture\n");
429a8ed3 1008 }
1009}
1010
1011static void audio_del(VncState *vs)
1012{
1013 if (vs->audio_cap) {
1014 AUD_del_capture(vs->audio_cap, vs);
1015 vs->audio_cap = NULL;
1016 }
1017}
1018
198a0039
GH
1019static void vnc_disconnect_start(VncState *vs)
1020{
1021 if (vs->csock == -1)
1022 return;
8cf36489 1023 vnc_set_share_mode(vs, VNC_SHARE_MODE_DISCONNECTED);
198a0039
GH
1024 qemu_set_fd_handler2(vs->csock, NULL, NULL, NULL, NULL);
1025 closesocket(vs->csock);
1026 vs->csock = -1;
1027}
1028
7536ee4b 1029void vnc_disconnect_finish(VncState *vs)
198a0039 1030{
7d964c9d
CC
1031 int i;
1032
bd023f95
CC
1033 vnc_jobs_join(vs); /* Wait encoding jobs */
1034
1035 vnc_lock_output(vs);
0d72f3d3
LC
1036 vnc_qmp_event(vs, QEVENT_VNC_DISCONNECTED);
1037
5d418e3b
CC
1038 buffer_free(&vs->input);
1039 buffer_free(&vs->output);
7536ee4b
TH
1040#ifdef CONFIG_VNC_WS
1041 buffer_free(&vs->ws_input);
1042 buffer_free(&vs->ws_output);
1043#endif /* CONFIG_VNC_WS */
4a80dba3
LC
1044
1045 qobject_decref(vs->info);
1046
161c4f20 1047 vnc_zlib_clear(vs);
380282b0 1048 vnc_tight_clear(vs);
148954fa 1049 vnc_zrle_clear(vs);
161c4f20 1050
198a0039
GH
1051#ifdef CONFIG_VNC_TLS
1052 vnc_tls_client_cleanup(vs);
1053#endif /* CONFIG_VNC_TLS */
1054#ifdef CONFIG_VNC_SASL
1055 vnc_sasl_client_cleanup(vs);
1056#endif /* CONFIG_VNC_SASL */
1057 audio_del(vs);
7bc9318b 1058 vnc_release_modifiers(vs);
198a0039 1059
6fd8e79a
TH
1060 if (vs->initialized) {
1061 QTAILQ_REMOVE(&vs->vd->clients, vs, next);
1062 qemu_remove_mouse_mode_change_notifier(&vs->mouse_mode_notifier);
1063 }
41b4bef6 1064
3a0558b5
GH
1065 if (vs->vd->lock_key_sync)
1066 qemu_remove_led_event_handler(vs->led);
bd023f95
CC
1067 vnc_unlock_output(vs);
1068
bd023f95 1069 qemu_mutex_destroy(&vs->output_mutex);
6fd8e79a
TH
1070 if (vs->bh != NULL) {
1071 qemu_bh_delete(vs->bh);
1072 }
175b2a6e 1073 buffer_free(&vs->jobs_buffer);
175b2a6e 1074
7d964c9d 1075 for (i = 0; i < VNC_STAT_ROWS; ++i) {
7267c094 1076 g_free(vs->lossy_rect[i]);
7d964c9d 1077 }
7267c094
AL
1078 g_free(vs->lossy_rect);
1079 g_free(vs);
198a0039 1080}
2f9606b3
AL
1081
1082int vnc_client_io_error(VncState *vs, int ret, int last_errno)
24236869
FB
1083{
1084 if (ret == 0 || ret == -1) {
ea01e5fd
AZ
1085 if (ret == -1) {
1086 switch (last_errno) {
1087 case EINTR:
1088 case EAGAIN:
1089#ifdef _WIN32
1090 case WSAEWOULDBLOCK:
1091#endif
1092 return 0;
1093 default:
1094 break;
1095 }
1096 }
24236869 1097
198a0039
GH
1098 VNC_DEBUG("Closing down client sock: ret %d, errno %d\n",
1099 ret, ret < 0 ? last_errno : 0);
1100 vnc_disconnect_start(vs);
6baebed7 1101
28a76be8 1102 return 0;
24236869
FB
1103 }
1104 return ret;
1105}
1106
5fb6c7a8
AL
1107
1108void vnc_client_error(VncState *vs)
24236869 1109{
198a0039
GH
1110 VNC_DEBUG("Closing down client sock: protocol error\n");
1111 vnc_disconnect_start(vs);
24236869
FB
1112}
1113
0057a0d5
TH
1114#ifdef CONFIG_VNC_TLS
1115static long vnc_client_write_tls(gnutls_session_t *session,
1116 const uint8_t *data,
1117 size_t datalen)
1118{
1119 long ret = gnutls_write(*session, data, datalen);
1120 if (ret < 0) {
1121 if (ret == GNUTLS_E_AGAIN) {
1122 errno = EAGAIN;
1123 } else {
1124 errno = EIO;
1125 }
1126 ret = -1;
1127 }
1128 return ret;
1129}
1130#endif /* CONFIG_VNC_TLS */
2f9606b3
AL
1131
1132/*
1133 * Called to write a chunk of data to the client socket. The data may
1134 * be the raw data, or may have already been encoded by SASL.
1135 * The data will be written either straight onto the socket, or
1136 * written via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1137 *
1138 * NB, it is theoretically possible to have 2 layers of encryption,
1139 * both SASL, and this TLS layer. It is highly unlikely in practice
1140 * though, since SASL encryption will typically be a no-op if TLS
1141 * is active
1142 *
1143 * Returns the number of bytes written, which may be less than
1144 * the requested 'datalen' if the socket would block. Returns
1145 * -1 on error, and disconnects the client socket.
1146 */
1147long vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen)
24236869 1148{
ceb5caaf 1149 long ret;
eb38c52c 1150#ifdef CONFIG_VNC_TLS
5fb6c7a8 1151 if (vs->tls.session) {
0057a0d5
TH
1152 ret = vnc_client_write_tls(&vs->tls.session, data, datalen);
1153 } else {
1154#ifdef CONFIG_VNC_WS
1155 if (vs->ws_tls.session) {
1156 ret = vnc_client_write_tls(&vs->ws_tls.session, data, datalen);
1157 } else
1158#endif /* CONFIG_VNC_WS */
1159#endif /* CONFIG_VNC_TLS */
1160 {
1161 ret = send(vs->csock, (const void *)data, datalen, 0);
28a76be8 1162 }
0057a0d5
TH
1163#ifdef CONFIG_VNC_TLS
1164 }
8d5d2d4c 1165#endif /* CONFIG_VNC_TLS */
23decc87 1166 VNC_DEBUG("Wrote wire %p %zd -> %ld\n", data, datalen, ret);
2f9606b3
AL
1167 return vnc_client_io_error(vs, ret, socket_error());
1168}
1169
1170
1171/*
1172 * Called to write buffered data to the client socket, when not
1173 * using any SASL SSF encryption layers. Will write as much data
1174 * as possible without blocking. If all buffered data is written,
1175 * will switch the FD poll() handler back to read monitoring.
1176 *
1177 * Returns the number of bytes written, which may be less than
1178 * the buffered output data if the socket would block. Returns
1179 * -1 on error, and disconnects the client socket.
1180 */
1181static long vnc_client_write_plain(VncState *vs)
1182{
1183 long ret;
1184
1185#ifdef CONFIG_VNC_SASL
23decc87 1186 VNC_DEBUG("Write Plain: Pending output %p size %zd offset %zd. Wait SSF %d\n",
2f9606b3
AL
1187 vs->output.buffer, vs->output.capacity, vs->output.offset,
1188 vs->sasl.waitWriteSSF);
1189
1190 if (vs->sasl.conn &&
1191 vs->sasl.runSSF &&
1192 vs->sasl.waitWriteSSF) {
1193 ret = vnc_client_write_buf(vs, vs->output.buffer, vs->sasl.waitWriteSSF);
1194 if (ret)
1195 vs->sasl.waitWriteSSF -= ret;
1196 } else
1197#endif /* CONFIG_VNC_SASL */
1198 ret = vnc_client_write_buf(vs, vs->output.buffer, vs->output.offset);
24236869 1199 if (!ret)
2f9606b3 1200 return 0;
24236869 1201
32ed2680 1202 buffer_advance(&vs->output, ret);
24236869
FB
1203
1204 if (vs->output.offset == 0) {
28a76be8 1205 qemu_set_fd_handler2(vs->csock, NULL, vnc_client_read, NULL, vs);
24236869 1206 }
2f9606b3
AL
1207
1208 return ret;
1209}
1210
1211
1212/*
1213 * First function called whenever there is data to be written to
1214 * the client socket. Will delegate actual work according to whether
1215 * SASL SSF layers are enabled (thus requiring encryption calls)
1216 */
bd023f95 1217static void vnc_client_write_locked(void *opaque)
2f9606b3 1218{
2f9606b3
AL
1219 VncState *vs = opaque;
1220
1221#ifdef CONFIG_VNC_SASL
1222 if (vs->sasl.conn &&
1223 vs->sasl.runSSF &&
9678d950
BS
1224 !vs->sasl.waitWriteSSF) {
1225 vnc_client_write_sasl(vs);
1226 } else
2f9606b3 1227#endif /* CONFIG_VNC_SASL */
7536ee4b
TH
1228 {
1229#ifdef CONFIG_VNC_WS
1230 if (vs->encode_ws) {
1231 vnc_client_write_ws(vs);
1232 } else
1233#endif /* CONFIG_VNC_WS */
1234 {
1235 vnc_client_write_plain(vs);
1236 }
1237 }
24236869
FB
1238}
1239
bd023f95
CC
1240void vnc_client_write(void *opaque)
1241{
1242 VncState *vs = opaque;
1243
1244 vnc_lock_output(vs);
7536ee4b
TH
1245 if (vs->output.offset
1246#ifdef CONFIG_VNC_WS
1247 || vs->ws_output.offset
1248#endif
1249 ) {
bd023f95 1250 vnc_client_write_locked(opaque);
ac71103d 1251 } else if (vs->csock != -1) {
bd023f95
CC
1252 qemu_set_fd_handler2(vs->csock, NULL, vnc_client_read, NULL, vs);
1253 }
1254 vnc_unlock_output(vs);
1255}
1256
5fb6c7a8 1257void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting)
24236869
FB
1258{
1259 vs->read_handler = func;
1260 vs->read_handler_expect = expecting;
1261}
1262
0057a0d5
TH
1263#ifdef CONFIG_VNC_TLS
1264static long vnc_client_read_tls(gnutls_session_t *session, uint8_t *data,
1265 size_t datalen)
1266{
1267 long ret = gnutls_read(*session, data, datalen);
1268 if (ret < 0) {
1269 if (ret == GNUTLS_E_AGAIN) {
1270 errno = EAGAIN;
1271 } else {
1272 errno = EIO;
1273 }
1274 ret = -1;
1275 }
1276 return ret;
1277}
1278#endif /* CONFIG_VNC_TLS */
2f9606b3
AL
1279
1280/*
1281 * Called to read a chunk of data from the client socket. The data may
1282 * be the raw data, or may need to be further decoded by SASL.
1283 * The data will be read either straight from to the socket, or
1284 * read via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1285 *
1286 * NB, it is theoretically possible to have 2 layers of encryption,
1287 * both SASL, and this TLS layer. It is highly unlikely in practice
1288 * though, since SASL encryption will typically be a no-op if TLS
1289 * is active
1290 *
1291 * Returns the number of bytes read, which may be less than
1292 * the requested 'datalen' if the socket would block. Returns
1293 * -1 on error, and disconnects the client socket.
1294 */
1295long vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen)
24236869 1296{
ceb5caaf 1297 long ret;
eb38c52c 1298#ifdef CONFIG_VNC_TLS
5fb6c7a8 1299 if (vs->tls.session) {
0057a0d5
TH
1300 ret = vnc_client_read_tls(&vs->tls.session, data, datalen);
1301 } else {
1302#ifdef CONFIG_VNC_WS
1303 if (vs->ws_tls.session) {
1304 ret = vnc_client_read_tls(&vs->ws_tls.session, data, datalen);
1305 } else
1306#endif /* CONFIG_VNC_WS */
1307#endif /* CONFIG_VNC_TLS */
1308 {
1309 ret = qemu_recv(vs->csock, data, datalen, 0);
28a76be8 1310 }
0057a0d5
TH
1311#ifdef CONFIG_VNC_TLS
1312 }
8d5d2d4c 1313#endif /* CONFIG_VNC_TLS */
23decc87 1314 VNC_DEBUG("Read wire %p %zd -> %ld\n", data, datalen, ret);
2f9606b3
AL
1315 return vnc_client_io_error(vs, ret, socket_error());
1316}
24236869 1317
2f9606b3
AL
1318
1319/*
1320 * Called to read data from the client socket to the input buffer,
1321 * when not using any SASL SSF encryption layers. Will read as much
1322 * data as possible without blocking.
1323 *
1324 * Returns the number of bytes read. Returns -1 on error, and
1325 * disconnects the client socket.
1326 */
1327static long vnc_client_read_plain(VncState *vs)
1328{
1329 int ret;
23decc87 1330 VNC_DEBUG("Read plain %p size %zd offset %zd\n",
2f9606b3
AL
1331 vs->input.buffer, vs->input.capacity, vs->input.offset);
1332 buffer_reserve(&vs->input, 4096);
1333 ret = vnc_client_read_buf(vs, buffer_end(&vs->input), 4096);
1334 if (!ret)
1335 return 0;
24236869 1336 vs->input.offset += ret;
2f9606b3
AL
1337 return ret;
1338}
1339
175b2a6e
CC
1340static void vnc_jobs_bh(void *opaque)
1341{
1342 VncState *vs = opaque;
1343
1344 vnc_jobs_consume_buffer(vs);
1345}
2f9606b3
AL
1346
1347/*
1348 * First function called whenever there is more data to be read from
1349 * the client socket. Will delegate actual work according to whether
1350 * SASL SSF layers are enabled (thus requiring decryption calls)
1351 */
1352void vnc_client_read(void *opaque)
1353{
1354 VncState *vs = opaque;
1355 long ret;
1356
1357#ifdef CONFIG_VNC_SASL
1358 if (vs->sasl.conn && vs->sasl.runSSF)
1359 ret = vnc_client_read_sasl(vs);
1360 else
1361#endif /* CONFIG_VNC_SASL */
7536ee4b
TH
1362#ifdef CONFIG_VNC_WS
1363 if (vs->encode_ws) {
1364 ret = vnc_client_read_ws(vs);
1365 if (ret == -1) {
1366 vnc_disconnect_start(vs);
1367 return;
1368 } else if (ret == -2) {
1369 vnc_client_error(vs);
1370 return;
1371 }
1372 } else
1373#endif /* CONFIG_VNC_WS */
1374 {
2f9606b3 1375 ret = vnc_client_read_plain(vs);
7536ee4b 1376 }
198a0039
GH
1377 if (!ret) {
1378 if (vs->csock == -1)
1379 vnc_disconnect_finish(vs);
28a76be8 1380 return;
198a0039 1381 }
24236869
FB
1382
1383 while (vs->read_handler && vs->input.offset >= vs->read_handler_expect) {
28a76be8
AL
1384 size_t len = vs->read_handler_expect;
1385 int ret;
1386
1387 ret = vs->read_handler(vs, vs->input.buffer, len);
198a0039
GH
1388 if (vs->csock == -1) {
1389 vnc_disconnect_finish(vs);
28a76be8 1390 return;
198a0039 1391 }
28a76be8
AL
1392
1393 if (!ret) {
32ed2680 1394 buffer_advance(&vs->input, len);
28a76be8
AL
1395 } else {
1396 vs->read_handler_expect = ret;
1397 }
24236869
FB
1398 }
1399}
1400
5fb6c7a8 1401void vnc_write(VncState *vs, const void *data, size_t len)
24236869
FB
1402{
1403 buffer_reserve(&vs->output, len);
1404
198a0039 1405 if (vs->csock != -1 && buffer_empty(&vs->output)) {
28a76be8 1406 qemu_set_fd_handler2(vs->csock, NULL, vnc_client_read, vnc_client_write, vs);
24236869
FB
1407 }
1408
1409 buffer_append(&vs->output, data, len);
1410}
1411
5fb6c7a8 1412void vnc_write_s32(VncState *vs, int32_t value)
24236869
FB
1413{
1414 vnc_write_u32(vs, *(uint32_t *)&value);
1415}
1416
5fb6c7a8 1417void vnc_write_u32(VncState *vs, uint32_t value)
24236869
FB
1418{
1419 uint8_t buf[4];
1420
1421 buf[0] = (value >> 24) & 0xFF;
1422 buf[1] = (value >> 16) & 0xFF;
1423 buf[2] = (value >> 8) & 0xFF;
1424 buf[3] = value & 0xFF;
1425
1426 vnc_write(vs, buf, 4);
1427}
1428
5fb6c7a8 1429void vnc_write_u16(VncState *vs, uint16_t value)
24236869 1430{
64f5a135 1431 uint8_t buf[2];
24236869
FB
1432
1433 buf[0] = (value >> 8) & 0xFF;
1434 buf[1] = value & 0xFF;
1435
1436 vnc_write(vs, buf, 2);
1437}
1438
5fb6c7a8 1439void vnc_write_u8(VncState *vs, uint8_t value)
24236869
FB
1440{
1441 vnc_write(vs, (char *)&value, 1);
1442}
1443
5fb6c7a8 1444void vnc_flush(VncState *vs)
24236869 1445{
bd023f95 1446 vnc_lock_output(vs);
7536ee4b
TH
1447 if (vs->csock != -1 && (vs->output.offset
1448#ifdef CONFIG_VNC_WS
1449 || vs->ws_output.offset
1450#endif
1451 )) {
bd023f95
CC
1452 vnc_client_write_locked(vs);
1453 }
1454 vnc_unlock_output(vs);
24236869
FB
1455}
1456
71a8cdec 1457static uint8_t read_u8(uint8_t *data, size_t offset)
24236869
FB
1458{
1459 return data[offset];
1460}
1461
71a8cdec 1462static uint16_t read_u16(uint8_t *data, size_t offset)
24236869
FB
1463{
1464 return ((data[offset] & 0xFF) << 8) | (data[offset + 1] & 0xFF);
1465}
1466
71a8cdec 1467static int32_t read_s32(uint8_t *data, size_t offset)
24236869
FB
1468{
1469 return (int32_t)((data[offset] << 24) | (data[offset + 1] << 16) |
28a76be8 1470 (data[offset + 2] << 8) | data[offset + 3]);
24236869
FB
1471}
1472
5fb6c7a8 1473uint32_t read_u32(uint8_t *data, size_t offset)
24236869
FB
1474{
1475 return ((data[offset] << 24) | (data[offset + 1] << 16) |
28a76be8 1476 (data[offset + 2] << 8) | data[offset + 3]);
24236869
FB
1477}
1478
60fe76f3 1479static void client_cut_text(VncState *vs, size_t len, uint8_t *text)
24236869
FB
1480{
1481}
1482
9e8dd451 1483static void check_pointer_type_change(Notifier *notifier, void *data)
564c337e 1484{
37c34d9d
AL
1485 VncState *vs = container_of(notifier, VncState, mouse_mode_notifier);
1486 int absolute = kbd_mouse_is_absolute();
1487
29fa4ed9 1488 if (vnc_has_feature(vs, VNC_FEATURE_POINTER_TYPE_CHANGE) && vs->absolute != absolute) {
bd023f95 1489 vnc_lock_output(vs);
46a183da 1490 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
28a76be8
AL
1491 vnc_write_u8(vs, 0);
1492 vnc_write_u16(vs, 1);
1493 vnc_framebuffer_update(vs, absolute, 0,
d39fa6d8
GH
1494 surface_width(vs->vd->ds),
1495 surface_height(vs->vd->ds),
29fa4ed9 1496 VNC_ENCODING_POINTER_TYPE_CHANGE);
bd023f95 1497 vnc_unlock_output(vs);
28a76be8 1498 vnc_flush(vs);
564c337e
FB
1499 }
1500 vs->absolute = absolute;
1501}
1502
24236869
FB
1503static void pointer_event(VncState *vs, int button_mask, int x, int y)
1504{
1505 int buttons = 0;
1506 int dz = 0;
d39fa6d8
GH
1507 int width = surface_width(vs->vd->ds);
1508 int height = surface_height(vs->vd->ds);
24236869
FB
1509
1510 if (button_mask & 0x01)
28a76be8 1511 buttons |= MOUSE_EVENT_LBUTTON;
24236869 1512 if (button_mask & 0x02)
28a76be8 1513 buttons |= MOUSE_EVENT_MBUTTON;
24236869 1514 if (button_mask & 0x04)
28a76be8 1515 buttons |= MOUSE_EVENT_RBUTTON;
24236869 1516 if (button_mask & 0x08)
28a76be8 1517 dz = -1;
24236869 1518 if (button_mask & 0x10)
28a76be8 1519 dz = 1;
564c337e
FB
1520
1521 if (vs->absolute) {
d39fa6d8
GH
1522 kbd_mouse_event(width > 1 ? x * 0x7FFF / (width - 1) : 0x4000,
1523 height > 1 ? y * 0x7FFF / (height - 1) : 0x4000,
28a76be8 1524 dz, buttons);
29fa4ed9 1525 } else if (vnc_has_feature(vs, VNC_FEATURE_POINTER_TYPE_CHANGE)) {
28a76be8
AL
1526 x -= 0x7FFF;
1527 y -= 0x7FFF;
24236869 1528
28a76be8 1529 kbd_mouse_event(x, y, dz, buttons);
564c337e 1530 } else {
28a76be8
AL
1531 if (vs->last_x != -1)
1532 kbd_mouse_event(x - vs->last_x,
1533 y - vs->last_y,
1534 dz, buttons);
1535 vs->last_x = x;
1536 vs->last_y = y;
24236869
FB
1537 }
1538}
1539
64f5a135
FB
1540static void reset_keys(VncState *vs)
1541{
1542 int i;
1543 for(i = 0; i < 256; i++) {
1544 if (vs->modifiers_state[i]) {
44bb61c8
ST
1545 if (i & SCANCODE_GREY)
1546 kbd_put_keycode(SCANCODE_EMUL0);
1547 kbd_put_keycode(i | SCANCODE_UP);
64f5a135
FB
1548 vs->modifiers_state[i] = 0;
1549 }
1550 }
1551}
1552
a528b80c
AZ
1553static void press_key(VncState *vs, int keysym)
1554{
44bb61c8
ST
1555 int keycode = keysym2scancode(vs->vd->kbd_layout, keysym) & SCANCODE_KEYMASK;
1556 if (keycode & SCANCODE_GREY)
1557 kbd_put_keycode(SCANCODE_EMUL0);
1558 kbd_put_keycode(keycode & SCANCODE_KEYCODEMASK);
1559 if (keycode & SCANCODE_GREY)
1560 kbd_put_keycode(SCANCODE_EMUL0);
1561 kbd_put_keycode(keycode | SCANCODE_UP);
a528b80c
AZ
1562}
1563
ab99e5c1
LL
1564static int current_led_state(VncState *vs)
1565{
1566 int ledstate = 0;
1567
1568 if (vs->modifiers_state[0x46]) {
1569 ledstate |= QEMU_SCROLL_LOCK_LED;
1570 }
1571 if (vs->modifiers_state[0x45]) {
1572 ledstate |= QEMU_NUM_LOCK_LED;
1573 }
1574 if (vs->modifiers_state[0x3a]) {
1575 ledstate |= QEMU_CAPS_LOCK_LED;
1576 }
1577
1578 return ledstate;
1579}
1580
1581static void vnc_led_state_change(VncState *vs)
1582{
1583 int ledstate = 0;
1584
1585 if (!vnc_has_feature(vs, VNC_FEATURE_LED_STATE)) {
1586 return;
1587 }
1588
1589 ledstate = current_led_state(vs);
1590 vnc_lock_output(vs);
1591 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
1592 vnc_write_u8(vs, 0);
1593 vnc_write_u16(vs, 1);
1594 vnc_framebuffer_update(vs, 0, 0, 1, 1, VNC_ENCODING_LED_STATE);
1595 vnc_write_u8(vs, ledstate);
1596 vnc_unlock_output(vs);
1597 vnc_flush(vs);
1598}
1599
7ffb82ca
GH
1600static void kbd_leds(void *opaque, int ledstate)
1601{
1602 VncState *vs = opaque;
96f3d174 1603 int caps, num, scr;
1483adcf 1604 bool has_changed = (ledstate != current_led_state(vs));
7ffb82ca
GH
1605
1606 caps = ledstate & QEMU_CAPS_LOCK_LED ? 1 : 0;
1607 num = ledstate & QEMU_NUM_LOCK_LED ? 1 : 0;
96f3d174 1608 scr = ledstate & QEMU_SCROLL_LOCK_LED ? 1 : 0;
7ffb82ca
GH
1609
1610 if (vs->modifiers_state[0x3a] != caps) {
1611 vs->modifiers_state[0x3a] = caps;
1612 }
1613 if (vs->modifiers_state[0x45] != num) {
1614 vs->modifiers_state[0x45] = num;
1615 }
96f3d174
LL
1616 if (vs->modifiers_state[0x46] != scr) {
1617 vs->modifiers_state[0x46] = scr;
1618 }
ab99e5c1
LL
1619
1620 /* Sending the current led state message to the client */
1483adcf 1621 if (has_changed) {
ab99e5c1
LL
1622 vnc_led_state_change(vs);
1623 }
7ffb82ca
GH
1624}
1625
9ca313aa 1626static void do_key_event(VncState *vs, int down, int keycode, int sym)
24236869 1627{
64f5a135
FB
1628 /* QEMU console switch */
1629 switch(keycode) {
1630 case 0x2a: /* Left Shift */
1631 case 0x36: /* Right Shift */
1632 case 0x1d: /* Left CTRL */
1633 case 0x9d: /* Right CTRL */
1634 case 0x38: /* Left ALT */
1635 case 0xb8: /* Right ALT */
1636 if (down)
1637 vs->modifiers_state[keycode] = 1;
1638 else
1639 vs->modifiers_state[keycode] = 0;
1640 break;
5fafdf24 1641 case 0x02 ... 0x0a: /* '1' to '9' keys */
64f5a135
FB
1642 if (down && vs->modifiers_state[0x1d] && vs->modifiers_state[0x38]) {
1643 /* Reset the modifiers sent to the current console */
1644 reset_keys(vs);
1645 console_select(keycode - 0x02);
1646 return;
1647 }
1648 break;
28a76be8
AL
1649 case 0x3a: /* CapsLock */
1650 case 0x45: /* NumLock */
7ffb82ca 1651 if (down)
a528b80c
AZ
1652 vs->modifiers_state[keycode] ^= 1;
1653 break;
1654 }
1655
e7b2aacc
LL
1656 /* Turn off the lock state sync logic if the client support the led
1657 state extension.
1658 */
9892088b 1659 if (down && vs->vd->lock_key_sync &&
e7b2aacc 1660 !vnc_has_feature(vs, VNC_FEATURE_LED_STATE) &&
3a0558b5 1661 keycode_is_keypad(vs->vd->kbd_layout, keycode)) {
a528b80c
AZ
1662 /* If the numlock state needs to change then simulate an additional
1663 keypress before sending this one. This will happen if the user
1664 toggles numlock away from the VNC window.
1665 */
753b4053 1666 if (keysym_is_numlock(vs->vd->kbd_layout, sym & 0xFFFF)) {
a528b80c
AZ
1667 if (!vs->modifiers_state[0x45]) {
1668 vs->modifiers_state[0x45] = 1;
1669 press_key(vs, 0xff7f);
1670 }
1671 } else {
1672 if (vs->modifiers_state[0x45]) {
1673 vs->modifiers_state[0x45] = 0;
1674 press_key(vs, 0xff7f);
1675 }
1676 }
64f5a135 1677 }
24236869 1678
9892088b 1679 if (down && vs->vd->lock_key_sync &&
e7b2aacc 1680 !vnc_has_feature(vs, VNC_FEATURE_LED_STATE) &&
3a0558b5 1681 ((sym >= 'A' && sym <= 'Z') || (sym >= 'a' && sym <= 'z'))) {
6b132502
GH
1682 /* If the capslock state needs to change then simulate an additional
1683 keypress before sending this one. This will happen if the user
1684 toggles capslock away from the VNC window.
1685 */
1686 int uppercase = !!(sym >= 'A' && sym <= 'Z');
1687 int shift = !!(vs->modifiers_state[0x2a] | vs->modifiers_state[0x36]);
1688 int capslock = !!(vs->modifiers_state[0x3a]);
1689 if (capslock) {
1690 if (uppercase == shift) {
1691 vs->modifiers_state[0x3a] = 0;
1692 press_key(vs, 0xffe5);
1693 }
1694 } else {
1695 if (uppercase != shift) {
1696 vs->modifiers_state[0x3a] = 1;
1697 press_key(vs, 0xffe5);
1698 }
1699 }
1700 }
1701
81c0d5a6 1702 if (qemu_console_is_graphic(NULL)) {
44bb61c8
ST
1703 if (keycode & SCANCODE_GREY)
1704 kbd_put_keycode(SCANCODE_EMUL0);
64f5a135 1705 if (down)
44bb61c8 1706 kbd_put_keycode(keycode & SCANCODE_KEYCODEMASK);
64f5a135 1707 else
44bb61c8 1708 kbd_put_keycode(keycode | SCANCODE_UP);
64f5a135 1709 } else {
e26437c2
GH
1710 bool numlock = vs->modifiers_state[0x45];
1711 bool control = (vs->modifiers_state[0x1d] ||
1712 vs->modifiers_state[0x9d]);
64f5a135
FB
1713 /* QEMU console emulation */
1714 if (down) {
1715 switch (keycode) {
1716 case 0x2a: /* Left Shift */
1717 case 0x36: /* Right Shift */
1718 case 0x1d: /* Left CTRL */
1719 case 0x9d: /* Right CTRL */
1720 case 0x38: /* Left ALT */
1721 case 0xb8: /* Right ALT */
1722 break;
1723 case 0xc8:
1724 kbd_put_keysym(QEMU_KEY_UP);
1725 break;
1726 case 0xd0:
1727 kbd_put_keysym(QEMU_KEY_DOWN);
1728 break;
1729 case 0xcb:
1730 kbd_put_keysym(QEMU_KEY_LEFT);
1731 break;
1732 case 0xcd:
1733 kbd_put_keysym(QEMU_KEY_RIGHT);
1734 break;
1735 case 0xd3:
1736 kbd_put_keysym(QEMU_KEY_DELETE);
1737 break;
1738 case 0xc7:
1739 kbd_put_keysym(QEMU_KEY_HOME);
1740 break;
1741 case 0xcf:
1742 kbd_put_keysym(QEMU_KEY_END);
1743 break;
1744 case 0xc9:
1745 kbd_put_keysym(QEMU_KEY_PAGEUP);
1746 break;
1747 case 0xd1:
1748 kbd_put_keysym(QEMU_KEY_PAGEDOWN);
1749 break;
bb0a18e1
GH
1750
1751 case 0x47:
1752 kbd_put_keysym(numlock ? '7' : QEMU_KEY_HOME);
1753 break;
1754 case 0x48:
1755 kbd_put_keysym(numlock ? '8' : QEMU_KEY_UP);
1756 break;
1757 case 0x49:
1758 kbd_put_keysym(numlock ? '9' : QEMU_KEY_PAGEUP);
1759 break;
1760 case 0x4b:
1761 kbd_put_keysym(numlock ? '4' : QEMU_KEY_LEFT);
1762 break;
1763 case 0x4c:
1764 kbd_put_keysym('5');
1765 break;
1766 case 0x4d:
1767 kbd_put_keysym(numlock ? '6' : QEMU_KEY_RIGHT);
1768 break;
1769 case 0x4f:
1770 kbd_put_keysym(numlock ? '1' : QEMU_KEY_END);
1771 break;
1772 case 0x50:
1773 kbd_put_keysym(numlock ? '2' : QEMU_KEY_DOWN);
1774 break;
1775 case 0x51:
1776 kbd_put_keysym(numlock ? '3' : QEMU_KEY_PAGEDOWN);
1777 break;
1778 case 0x52:
1779 kbd_put_keysym('0');
1780 break;
1781 case 0x53:
1782 kbd_put_keysym(numlock ? '.' : QEMU_KEY_DELETE);
1783 break;
1784
1785 case 0xb5:
1786 kbd_put_keysym('/');
1787 break;
1788 case 0x37:
1789 kbd_put_keysym('*');
1790 break;
1791 case 0x4a:
1792 kbd_put_keysym('-');
1793 break;
1794 case 0x4e:
1795 kbd_put_keysym('+');
1796 break;
1797 case 0x9c:
1798 kbd_put_keysym('\n');
1799 break;
1800
64f5a135 1801 default:
e26437c2
GH
1802 if (control) {
1803 kbd_put_keysym(sym & 0x1f);
1804 } else {
1805 kbd_put_keysym(sym);
1806 }
64f5a135
FB
1807 break;
1808 }
1809 }
1810 }
24236869
FB
1811}
1812
7bc9318b
GH
1813static void vnc_release_modifiers(VncState *vs)
1814{
1815 static const int keycodes[] = {
1816 /* shift, control, alt keys, both left & right */
1817 0x2a, 0x36, 0x1d, 0x9d, 0x38, 0xb8,
1818 };
1819 int i, keycode;
1820
81c0d5a6 1821 if (!qemu_console_is_graphic(NULL)) {
7bc9318b
GH
1822 return;
1823 }
1824 for (i = 0; i < ARRAY_SIZE(keycodes); i++) {
1825 keycode = keycodes[i];
1826 if (!vs->modifiers_state[keycode]) {
1827 continue;
1828 }
1829 if (keycode & SCANCODE_GREY) {
1830 kbd_put_keycode(SCANCODE_EMUL0);
1831 }
1832 kbd_put_keycode(keycode | SCANCODE_UP);
1833 }
1834}
1835
bdbd7676
FB
1836static void key_event(VncState *vs, int down, uint32_t sym)
1837{
9ca313aa 1838 int keycode;
4a93fe17 1839 int lsym = sym;
9ca313aa 1840
81c0d5a6 1841 if (lsym >= 'A' && lsym <= 'Z' && qemu_console_is_graphic(NULL)) {
4a93fe17
GH
1842 lsym = lsym - 'A' + 'a';
1843 }
9ca313aa 1844
44bb61c8 1845 keycode = keysym2scancode(vs->vd->kbd_layout, lsym & 0xFFFF) & SCANCODE_KEYMASK;
9ca313aa
AL
1846 do_key_event(vs, down, keycode, sym);
1847}
1848
1849static void ext_key_event(VncState *vs, int down,
1850 uint32_t sym, uint16_t keycode)
1851{
1852 /* if the user specifies a keyboard layout, always use it */
1853 if (keyboard_layout)
1854 key_event(vs, down, sym);
1855 else
1856 do_key_event(vs, down, keycode, sym);
bdbd7676
FB
1857}
1858
24236869 1859static void framebuffer_update_request(VncState *vs, int incremental,
28a76be8
AL
1860 int x_position, int y_position,
1861 int w, int h)
24236869 1862{
6ed391bf 1863 int i;
d39fa6d8
GH
1864 const size_t width = surface_width(vs->vd->ds) / 16;
1865 const size_t height = surface_height(vs->vd->ds);
6ed391bf 1866
d39fa6d8
GH
1867 if (y_position > height) {
1868 y_position = height;
1869 }
1870 if (y_position + h >= height) {
1871 h = height - y_position;
1872 }
cf2d385c 1873
24236869
FB
1874 vs->need_update = 1;
1875 if (!incremental) {
24cf0a6e 1876 vs->force_update = 1;
28a76be8 1877 for (i = 0; i < h; i++) {
6ed391bf
WC
1878 bitmap_set(vs->dirty[y_position + i], 0, width);
1879 bitmap_clear(vs->dirty[y_position + i], width,
a0843a68 1880 VNC_DIRTY_BITS - width);
28a76be8 1881 }
24236869
FB
1882 }
1883}
1884
9ca313aa
AL
1885static void send_ext_key_event_ack(VncState *vs)
1886{
bd023f95 1887 vnc_lock_output(vs);
46a183da 1888 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
9ca313aa
AL
1889 vnc_write_u8(vs, 0);
1890 vnc_write_u16(vs, 1);
d39fa6d8
GH
1891 vnc_framebuffer_update(vs, 0, 0,
1892 surface_width(vs->vd->ds),
1893 surface_height(vs->vd->ds),
29fa4ed9 1894 VNC_ENCODING_EXT_KEY_EVENT);
bd023f95 1895 vnc_unlock_output(vs);
9ca313aa
AL
1896 vnc_flush(vs);
1897}
1898
429a8ed3 1899static void send_ext_audio_ack(VncState *vs)
1900{
bd023f95 1901 vnc_lock_output(vs);
46a183da 1902 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
429a8ed3 1903 vnc_write_u8(vs, 0);
1904 vnc_write_u16(vs, 1);
d39fa6d8
GH
1905 vnc_framebuffer_update(vs, 0, 0,
1906 surface_width(vs->vd->ds),
1907 surface_height(vs->vd->ds),
29fa4ed9 1908 VNC_ENCODING_AUDIO);
bd023f95 1909 vnc_unlock_output(vs);
429a8ed3 1910 vnc_flush(vs);
1911}
1912
24236869
FB
1913static void set_encodings(VncState *vs, int32_t *encodings, size_t n_encodings)
1914{
1915 int i;
29fa4ed9 1916 unsigned int enc = 0;
24236869 1917
29fa4ed9 1918 vs->features = 0;
a9f20d31 1919 vs->vnc_encoding = 0;
d1af0e05
CC
1920 vs->tight.compression = 9;
1921 vs->tight.quality = -1; /* Lossless by default */
564c337e 1922 vs->absolute = -1;
24236869 1923
8a0f0d0c
CC
1924 /*
1925 * Start from the end because the encodings are sent in order of preference.
e5bed759 1926 * This way the preferred encoding (first encoding defined in the array)
8a0f0d0c
CC
1927 * will be set at the end of the loop.
1928 */
24236869 1929 for (i = n_encodings - 1; i >= 0; i--) {
29fa4ed9
AL
1930 enc = encodings[i];
1931 switch (enc) {
1932 case VNC_ENCODING_RAW:
a9f20d31 1933 vs->vnc_encoding = enc;
29fa4ed9
AL
1934 break;
1935 case VNC_ENCODING_COPYRECT:
753b4053 1936 vs->features |= VNC_FEATURE_COPYRECT_MASK;
29fa4ed9
AL
1937 break;
1938 case VNC_ENCODING_HEXTILE:
1939 vs->features |= VNC_FEATURE_HEXTILE_MASK;
a9f20d31 1940 vs->vnc_encoding = enc;
29fa4ed9 1941 break;
380282b0
CC
1942 case VNC_ENCODING_TIGHT:
1943 vs->features |= VNC_FEATURE_TIGHT_MASK;
1944 vs->vnc_encoding = enc;
1945 break;
fe3e7f2d 1946#ifdef CONFIG_VNC_PNG
efe556ad
CC
1947 case VNC_ENCODING_TIGHT_PNG:
1948 vs->features |= VNC_FEATURE_TIGHT_PNG_MASK;
1949 vs->vnc_encoding = enc;
1950 break;
fe3e7f2d 1951#endif
059cef40
AL
1952 case VNC_ENCODING_ZLIB:
1953 vs->features |= VNC_FEATURE_ZLIB_MASK;
a9f20d31 1954 vs->vnc_encoding = enc;
059cef40 1955 break;
148954fa
CC
1956 case VNC_ENCODING_ZRLE:
1957 vs->features |= VNC_FEATURE_ZRLE_MASK;
1958 vs->vnc_encoding = enc;
1959 break;
1960 case VNC_ENCODING_ZYWRLE:
1961 vs->features |= VNC_FEATURE_ZYWRLE_MASK;
1962 vs->vnc_encoding = enc;
1963 break;
29fa4ed9
AL
1964 case VNC_ENCODING_DESKTOPRESIZE:
1965 vs->features |= VNC_FEATURE_RESIZE_MASK;
1966 break;
1967 case VNC_ENCODING_POINTER_TYPE_CHANGE:
1968 vs->features |= VNC_FEATURE_POINTER_TYPE_CHANGE_MASK;
1969 break;
d467b679
GH
1970 case VNC_ENCODING_RICH_CURSOR:
1971 vs->features |= VNC_FEATURE_RICH_CURSOR_MASK;
1972 break;
29fa4ed9 1973 case VNC_ENCODING_EXT_KEY_EVENT:
9ca313aa
AL
1974 send_ext_key_event_ack(vs);
1975 break;
29fa4ed9 1976 case VNC_ENCODING_AUDIO:
429a8ed3 1977 send_ext_audio_ack(vs);
1978 break;
29fa4ed9
AL
1979 case VNC_ENCODING_WMVi:
1980 vs->features |= VNC_FEATURE_WMVI_MASK;
ca4cca4d 1981 break;
ab99e5c1
LL
1982 case VNC_ENCODING_LED_STATE:
1983 vs->features |= VNC_FEATURE_LED_STATE_MASK;
1984 break;
fb437313 1985 case VNC_ENCODING_COMPRESSLEVEL0 ... VNC_ENCODING_COMPRESSLEVEL0 + 9:
d1af0e05 1986 vs->tight.compression = (enc & 0x0F);
fb437313
AL
1987 break;
1988 case VNC_ENCODING_QUALITYLEVEL0 ... VNC_ENCODING_QUALITYLEVEL0 + 9:
b31f519e
CC
1989 if (vs->vd->lossy) {
1990 vs->tight.quality = (enc & 0x0F);
1991 }
fb437313 1992 break;
29fa4ed9
AL
1993 default:
1994 VNC_DEBUG("Unknown encoding: %d (0x%.8x): %d\n", i, enc, enc);
1995 break;
1996 }
24236869 1997 }
6356e472 1998 vnc_desktop_resize(vs);
9e8dd451 1999 check_pointer_type_change(&vs->mouse_mode_notifier, NULL);
ab99e5c1 2000 vnc_led_state_change(vs);
24236869
FB
2001}
2002
6cec5487
AL
2003static void set_pixel_conversion(VncState *vs)
2004{
9f64916d
GH
2005 pixman_format_code_t fmt = qemu_pixman_get_format(&vs->client_pf);
2006
2007 if (fmt == VNC_SERVER_FB_FORMAT) {
6cec5487 2008 vs->write_pixels = vnc_write_pixels_copy;
70a4568f 2009 vnc_hextile_set_pixel_conversion(vs, 0);
6cec5487
AL
2010 } else {
2011 vs->write_pixels = vnc_write_pixels_generic;
70a4568f 2012 vnc_hextile_set_pixel_conversion(vs, 1);
6cec5487
AL
2013 }
2014}
2015
24236869 2016static void set_pixel_format(VncState *vs,
28a76be8
AL
2017 int bits_per_pixel, int depth,
2018 int big_endian_flag, int true_color_flag,
2019 int red_max, int green_max, int blue_max,
2020 int red_shift, int green_shift, int blue_shift)
24236869 2021{
3512779a 2022 if (!true_color_flag) {
28a76be8 2023 vnc_client_error(vs);
3512779a
FB
2024 return;
2025 }
24236869 2026
9f64916d
GH
2027 vs->client_pf.rmax = red_max;
2028 vs->client_pf.rbits = hweight_long(red_max);
2029 vs->client_pf.rshift = red_shift;
2030 vs->client_pf.rmask = red_max << red_shift;
2031 vs->client_pf.gmax = green_max;
2032 vs->client_pf.gbits = hweight_long(green_max);
2033 vs->client_pf.gshift = green_shift;
2034 vs->client_pf.gmask = green_max << green_shift;
2035 vs->client_pf.bmax = blue_max;
2036 vs->client_pf.bbits = hweight_long(blue_max);
2037 vs->client_pf.bshift = blue_shift;
2038 vs->client_pf.bmask = blue_max << blue_shift;
2039 vs->client_pf.bits_per_pixel = bits_per_pixel;
2040 vs->client_pf.bytes_per_pixel = bits_per_pixel / 8;
2041 vs->client_pf.depth = bits_per_pixel == 32 ? 24 : bits_per_pixel;
2042 vs->client_be = big_endian_flag;
6cec5487
AL
2043
2044 set_pixel_conversion(vs);
24236869 2045
1dbfa005
GH
2046 graphic_hw_invalidate(NULL);
2047 graphic_hw_update(NULL);
24236869
FB
2048}
2049
ca4cca4d
AL
2050static void pixel_format_message (VncState *vs) {
2051 char pad[3] = { 0, 0, 0 };
2052
9f64916d
GH
2053 vs->client_pf = qemu_default_pixelformat(32);
2054
2055 vnc_write_u8(vs, vs->client_pf.bits_per_pixel); /* bits-per-pixel */
2056 vnc_write_u8(vs, vs->client_pf.depth); /* depth */
ca4cca4d 2057
e2542fe2 2058#ifdef HOST_WORDS_BIGENDIAN
ca4cca4d
AL
2059 vnc_write_u8(vs, 1); /* big-endian-flag */
2060#else
2061 vnc_write_u8(vs, 0); /* big-endian-flag */
2062#endif
2063 vnc_write_u8(vs, 1); /* true-color-flag */
9f64916d
GH
2064 vnc_write_u16(vs, vs->client_pf.rmax); /* red-max */
2065 vnc_write_u16(vs, vs->client_pf.gmax); /* green-max */
2066 vnc_write_u16(vs, vs->client_pf.bmax); /* blue-max */
2067 vnc_write_u8(vs, vs->client_pf.rshift); /* red-shift */
2068 vnc_write_u8(vs, vs->client_pf.gshift); /* green-shift */
2069 vnc_write_u8(vs, vs->client_pf.bshift); /* blue-shift */
2070 vnc_write(vs, pad, 3); /* padding */
70a4568f
CC
2071
2072 vnc_hextile_set_pixel_conversion(vs, 0);
ca4cca4d 2073 vs->write_pixels = vnc_write_pixels_copy;
ca4cca4d
AL
2074}
2075
753b4053 2076static void vnc_colordepth(VncState *vs)
7eac3a87 2077{
753b4053 2078 if (vnc_has_feature(vs, VNC_FEATURE_WMVI)) {
ca4cca4d 2079 /* Sending a WMVi message to notify the client*/
bd023f95 2080 vnc_lock_output(vs);
46a183da 2081 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
ca4cca4d
AL
2082 vnc_write_u8(vs, 0);
2083 vnc_write_u16(vs, 1); /* number of rects */
d39fa6d8
GH
2084 vnc_framebuffer_update(vs, 0, 0,
2085 surface_width(vs->vd->ds),
2086 surface_height(vs->vd->ds),
2087 VNC_ENCODING_WMVi);
ca4cca4d 2088 pixel_format_message(vs);
bd023f95 2089 vnc_unlock_output(vs);
ca4cca4d 2090 vnc_flush(vs);
7eac3a87 2091 } else {
6cec5487 2092 set_pixel_conversion(vs);
7eac3a87
AL
2093 }
2094}
2095
60fe76f3 2096static int protocol_client_msg(VncState *vs, uint8_t *data, size_t len)
24236869
FB
2097{
2098 int i;
2099 uint16_t limit;
2430ffe4
SS
2100 VncDisplay *vd = vs->vd;
2101
2102 if (data[0] > 3) {
0f7b2864 2103 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);
2430ffe4 2104 }
24236869
FB
2105
2106 switch (data[0]) {
46a183da 2107 case VNC_MSG_CLIENT_SET_PIXEL_FORMAT:
28a76be8
AL
2108 if (len == 1)
2109 return 20;
2110
2111 set_pixel_format(vs, read_u8(data, 4), read_u8(data, 5),
2112 read_u8(data, 6), read_u8(data, 7),
2113 read_u16(data, 8), read_u16(data, 10),
2114 read_u16(data, 12), read_u8(data, 14),
2115 read_u8(data, 15), read_u8(data, 16));
2116 break;
46a183da 2117 case VNC_MSG_CLIENT_SET_ENCODINGS:
28a76be8
AL
2118 if (len == 1)
2119 return 4;
24236869 2120
28a76be8 2121 if (len == 4) {
69dd5c9f
AL
2122 limit = read_u16(data, 2);
2123 if (limit > 0)
2124 return 4 + (limit * 4);
2125 } else
2126 limit = read_u16(data, 2);
24236869 2127
28a76be8
AL
2128 for (i = 0; i < limit; i++) {
2129 int32_t val = read_s32(data, 4 + (i * 4));
2130 memcpy(data + 4 + (i * 4), &val, sizeof(val));
2131 }
24236869 2132
28a76be8
AL
2133 set_encodings(vs, (int32_t *)(data + 4), limit);
2134 break;
46a183da 2135 case VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST:
28a76be8
AL
2136 if (len == 1)
2137 return 10;
24236869 2138
28a76be8
AL
2139 framebuffer_update_request(vs,
2140 read_u8(data, 1), read_u16(data, 2), read_u16(data, 4),
2141 read_u16(data, 6), read_u16(data, 8));
2142 break;
46a183da 2143 case VNC_MSG_CLIENT_KEY_EVENT:
28a76be8
AL
2144 if (len == 1)
2145 return 8;
24236869 2146
28a76be8
AL
2147 key_event(vs, read_u8(data, 1), read_u32(data, 4));
2148 break;
46a183da 2149 case VNC_MSG_CLIENT_POINTER_EVENT:
28a76be8
AL
2150 if (len == 1)
2151 return 6;
24236869 2152
28a76be8
AL
2153 pointer_event(vs, read_u8(data, 1), read_u16(data, 2), read_u16(data, 4));
2154 break;
46a183da 2155 case VNC_MSG_CLIENT_CUT_TEXT:
28a76be8
AL
2156 if (len == 1)
2157 return 8;
24236869 2158
28a76be8 2159 if (len == 8) {
baa7666c
TS
2160 uint32_t dlen = read_u32(data, 4);
2161 if (dlen > 0)
2162 return 8 + dlen;
2163 }
24236869 2164
28a76be8
AL
2165 client_cut_text(vs, read_u32(data, 4), data + 8);
2166 break;
46a183da 2167 case VNC_MSG_CLIENT_QEMU:
9ca313aa
AL
2168 if (len == 1)
2169 return 2;
2170
2171 switch (read_u8(data, 1)) {
46a183da 2172 case VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT:
9ca313aa
AL
2173 if (len == 2)
2174 return 12;
2175
2176 ext_key_event(vs, read_u16(data, 2),
2177 read_u32(data, 4), read_u32(data, 8));
2178 break;
46a183da 2179 case VNC_MSG_CLIENT_QEMU_AUDIO:
429a8ed3 2180 if (len == 2)
2181 return 4;
2182
2183 switch (read_u16 (data, 2)) {
46a183da 2184 case VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE:
429a8ed3 2185 audio_add(vs);
2186 break;
46a183da 2187 case VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE:
429a8ed3 2188 audio_del(vs);
2189 break;
46a183da 2190 case VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT:
429a8ed3 2191 if (len == 4)
2192 return 10;
2193 switch (read_u8(data, 4)) {
2194 case 0: vs->as.fmt = AUD_FMT_U8; break;
2195 case 1: vs->as.fmt = AUD_FMT_S8; break;
2196 case 2: vs->as.fmt = AUD_FMT_U16; break;
2197 case 3: vs->as.fmt = AUD_FMT_S16; break;
2198 case 4: vs->as.fmt = AUD_FMT_U32; break;
2199 case 5: vs->as.fmt = AUD_FMT_S32; break;
2200 default:
2201 printf("Invalid audio format %d\n", read_u8(data, 4));
2202 vnc_client_error(vs);
2203 break;
2204 }
2205 vs->as.nchannels = read_u8(data, 5);
2206 if (vs->as.nchannels != 1 && vs->as.nchannels != 2) {
2207 printf("Invalid audio channel coount %d\n",
2208 read_u8(data, 5));
2209 vnc_client_error(vs);
2210 break;
2211 }
2212 vs->as.freq = read_u32(data, 6);
2213 break;
2214 default:
2215 printf ("Invalid audio message %d\n", read_u8(data, 4));
2216 vnc_client_error(vs);
2217 break;
2218 }
2219 break;
2220
9ca313aa
AL
2221 default:
2222 printf("Msg: %d\n", read_u16(data, 0));
2223 vnc_client_error(vs);
2224 break;
2225 }
2226 break;
24236869 2227 default:
28a76be8
AL
2228 printf("Msg: %d\n", data[0]);
2229 vnc_client_error(vs);
2230 break;
24236869 2231 }
5fafdf24 2232
24236869
FB
2233 vnc_read_when(vs, protocol_client_msg, 1);
2234 return 0;
2235}
2236
60fe76f3 2237static int protocol_client_init(VncState *vs, uint8_t *data, size_t len)
24236869 2238{
c35734b2 2239 char buf[1024];
8cf36489 2240 VncShareMode mode;
c35734b2 2241 int size;
24236869 2242
8cf36489
GH
2243 mode = data[0] ? VNC_SHARE_MODE_SHARED : VNC_SHARE_MODE_EXCLUSIVE;
2244 switch (vs->vd->share_policy) {
2245 case VNC_SHARE_POLICY_IGNORE:
2246 /*
2247 * Ignore the shared flag. Nothing to do here.
2248 *
2249 * Doesn't conform to the rfb spec but is traditional qemu
2250 * behavior, thus left here as option for compatibility
2251 * reasons.
2252 */
2253 break;
2254 case VNC_SHARE_POLICY_ALLOW_EXCLUSIVE:
2255 /*
2256 * Policy: Allow clients ask for exclusive access.
2257 *
2258 * Implementation: When a client asks for exclusive access,
2259 * disconnect all others. Shared connects are allowed as long
2260 * as no exclusive connection exists.
2261 *
2262 * This is how the rfb spec suggests to handle the shared flag.
2263 */
2264 if (mode == VNC_SHARE_MODE_EXCLUSIVE) {
2265 VncState *client;
2266 QTAILQ_FOREACH(client, &vs->vd->clients, next) {
2267 if (vs == client) {
2268 continue;
2269 }
2270 if (client->share_mode != VNC_SHARE_MODE_EXCLUSIVE &&
2271 client->share_mode != VNC_SHARE_MODE_SHARED) {
2272 continue;
2273 }
2274 vnc_disconnect_start(client);
2275 }
2276 }
2277 if (mode == VNC_SHARE_MODE_SHARED) {
2278 if (vs->vd->num_exclusive > 0) {
2279 vnc_disconnect_start(vs);
2280 return 0;
2281 }
2282 }
2283 break;
2284 case VNC_SHARE_POLICY_FORCE_SHARED:
2285 /*
2286 * Policy: Shared connects only.
2287 * Implementation: Disallow clients asking for exclusive access.
2288 *
2289 * Useful for shared desktop sessions where you don't want
2290 * someone forgetting to say -shared when running the vnc
2291 * client disconnect everybody else.
2292 */
2293 if (mode == VNC_SHARE_MODE_EXCLUSIVE) {
2294 vnc_disconnect_start(vs);
2295 return 0;
2296 }
2297 break;
2298 }
2299 vnc_set_share_mode(vs, mode);
2300
d39fa6d8
GH
2301 vs->client_width = surface_width(vs->vd->ds);
2302 vs->client_height = surface_height(vs->vd->ds);
5862d195
GH
2303 vnc_write_u16(vs, vs->client_width);
2304 vnc_write_u16(vs, vs->client_height);
24236869 2305
ca4cca4d 2306 pixel_format_message(vs);
24236869 2307
c35734b2
TS
2308 if (qemu_name)
2309 size = snprintf(buf, sizeof(buf), "QEMU (%s)", qemu_name);
2310 else
2311 size = snprintf(buf, sizeof(buf), "QEMU");
2312
2313 vnc_write_u32(vs, size);
2314 vnc_write(vs, buf, size);
24236869
FB
2315 vnc_flush(vs);
2316
4a80dba3 2317 vnc_client_cache_auth(vs);
0d2ed46a 2318 vnc_qmp_event(vs, QEVENT_VNC_INITIALIZED);
4a80dba3 2319
24236869
FB
2320 vnc_read_when(vs, protocol_client_msg, 1);
2321
2322 return 0;
2323}
2324
5fb6c7a8
AL
2325void start_client_init(VncState *vs)
2326{
2327 vnc_read_when(vs, protocol_client_init, 1);
2328}
2329
70848515
TS
2330static void make_challenge(VncState *vs)
2331{
2332 int i;
2333
2334 srand(time(NULL)+getpid()+getpid()*987654+rand());
2335
2336 for (i = 0 ; i < sizeof(vs->challenge) ; i++)
2337 vs->challenge[i] = (int) (256.0*rand()/(RAND_MAX+1.0));
2338}
2339
60fe76f3 2340static int protocol_client_auth_vnc(VncState *vs, uint8_t *data, size_t len)
70848515 2341{
60fe76f3 2342 unsigned char response[VNC_AUTH_CHALLENGE_SIZE];
70848515 2343 int i, j, pwlen;
60fe76f3 2344 unsigned char key[8];
3c9405a0 2345 time_t now = time(NULL);
70848515 2346
1cd20f8b 2347 if (!vs->vd->password) {
28a76be8 2348 VNC_DEBUG("No password configured on server");
6bffdf0f 2349 goto reject;
70848515 2350 }
3c9405a0
GH
2351 if (vs->vd->expires < now) {
2352 VNC_DEBUG("Password is expired");
2353 goto reject;
2354 }
70848515
TS
2355
2356 memcpy(response, vs->challenge, VNC_AUTH_CHALLENGE_SIZE);
2357
2358 /* Calculate the expected challenge response */
753b4053 2359 pwlen = strlen(vs->vd->password);
70848515 2360 for (i=0; i<sizeof(key); i++)
753b4053 2361 key[i] = i<pwlen ? vs->vd->password[i] : 0;
70848515
TS
2362 deskey(key, EN0);
2363 for (j = 0; j < VNC_AUTH_CHALLENGE_SIZE; j += 8)
2364 des(response+j, response+j);
2365
2366 /* Compare expected vs actual challenge response */
2367 if (memcmp(response, data, VNC_AUTH_CHALLENGE_SIZE) != 0) {
e5bed759 2368 VNC_DEBUG("Client challenge response did not match\n");
6bffdf0f 2369 goto reject;
70848515 2370 } else {
28a76be8
AL
2371 VNC_DEBUG("Accepting VNC challenge response\n");
2372 vnc_write_u32(vs, 0); /* Accept auth */
2373 vnc_flush(vs);
70848515 2374
5fb6c7a8 2375 start_client_init(vs);
70848515
TS
2376 }
2377 return 0;
6bffdf0f
GH
2378
2379reject:
2380 vnc_write_u32(vs, 1); /* Reject auth */
2381 if (vs->minor >= 8) {
2382 static const char err[] = "Authentication failed";
2383 vnc_write_u32(vs, sizeof(err));
2384 vnc_write(vs, err, sizeof(err));
2385 }
2386 vnc_flush(vs);
2387 vnc_client_error(vs);
2388 return 0;
70848515
TS
2389}
2390
5fb6c7a8 2391void start_auth_vnc(VncState *vs)
70848515
TS
2392{
2393 make_challenge(vs);
2394 /* Send client a 'random' challenge */
2395 vnc_write(vs, vs->challenge, sizeof(vs->challenge));
2396 vnc_flush(vs);
2397
2398 vnc_read_when(vs, protocol_client_auth_vnc, sizeof(vs->challenge));
469b15c6
TS
2399}
2400
2401
60fe76f3 2402static int protocol_client_auth(VncState *vs, uint8_t *data, size_t len)
70848515
TS
2403{
2404 /* We only advertise 1 auth scheme at a time, so client
2405 * must pick the one we sent. Verify this */
7e7e2ebc 2406 if (data[0] != vs->auth) { /* Reject auth */
1263b7d6 2407 VNC_DEBUG("Reject auth %d because it didn't match advertized\n", (int)data[0]);
70848515
TS
2408 vnc_write_u32(vs, 1);
2409 if (vs->minor >= 8) {
2410 static const char err[] = "Authentication failed";
2411 vnc_write_u32(vs, sizeof(err));
2412 vnc_write(vs, err, sizeof(err));
2413 }
2414 vnc_client_error(vs);
2415 } else { /* Accept requested auth */
2416 VNC_DEBUG("Client requested auth %d\n", (int)data[0]);
7e7e2ebc 2417 switch (vs->auth) {
70848515
TS
2418 case VNC_AUTH_NONE:
2419 VNC_DEBUG("Accept auth none\n");
a26c97ad
AZ
2420 if (vs->minor >= 8) {
2421 vnc_write_u32(vs, 0); /* Accept auth completion */
2422 vnc_flush(vs);
2423 }
5fb6c7a8 2424 start_client_init(vs);
70848515
TS
2425 break;
2426
2427 case VNC_AUTH_VNC:
2428 VNC_DEBUG("Start VNC auth\n");
5fb6c7a8
AL
2429 start_auth_vnc(vs);
2430 break;
70848515 2431
eb38c52c 2432#ifdef CONFIG_VNC_TLS
8d5d2d4c 2433 case VNC_AUTH_VENCRYPT:
3a93113a 2434 VNC_DEBUG("Accept VeNCrypt auth\n");
5fb6c7a8
AL
2435 start_auth_vencrypt(vs);
2436 break;
8d5d2d4c
TS
2437#endif /* CONFIG_VNC_TLS */
2438
2f9606b3
AL
2439#ifdef CONFIG_VNC_SASL
2440 case VNC_AUTH_SASL:
2441 VNC_DEBUG("Accept SASL auth\n");
2442 start_auth_sasl(vs);
2443 break;
2444#endif /* CONFIG_VNC_SASL */
2445
70848515 2446 default: /* Should not be possible, but just in case */
7e7e2ebc 2447 VNC_DEBUG("Reject auth %d server code bug\n", vs->auth);
70848515
TS
2448 vnc_write_u8(vs, 1);
2449 if (vs->minor >= 8) {
2450 static const char err[] = "Authentication failed";
2451 vnc_write_u32(vs, sizeof(err));
2452 vnc_write(vs, err, sizeof(err));
2453 }
2454 vnc_client_error(vs);
2455 }
2456 }
2457 return 0;
2458}
2459
60fe76f3 2460static int protocol_version(VncState *vs, uint8_t *version, size_t len)
24236869
FB
2461{
2462 char local[13];
24236869
FB
2463
2464 memcpy(local, version, 12);
2465 local[12] = 0;
2466
70848515 2467 if (sscanf(local, "RFB %03d.%03d\n", &vs->major, &vs->minor) != 2) {
28a76be8
AL
2468 VNC_DEBUG("Malformed protocol version %s\n", local);
2469 vnc_client_error(vs);
2470 return 0;
24236869 2471 }
70848515
TS
2472 VNC_DEBUG("Client request protocol version %d.%d\n", vs->major, vs->minor);
2473 if (vs->major != 3 ||
28a76be8
AL
2474 (vs->minor != 3 &&
2475 vs->minor != 4 &&
2476 vs->minor != 5 &&
2477 vs->minor != 7 &&
2478 vs->minor != 8)) {
2479 VNC_DEBUG("Unsupported client version\n");
2480 vnc_write_u32(vs, VNC_AUTH_INVALID);
2481 vnc_flush(vs);
2482 vnc_client_error(vs);
2483 return 0;
70848515 2484 }
b0566f4f 2485 /* Some broken clients report v3.4 or v3.5, which spec requires to be treated
70848515
TS
2486 * as equivalent to v3.3 by servers
2487 */
b0566f4f 2488 if (vs->minor == 4 || vs->minor == 5)
28a76be8 2489 vs->minor = 3;
70848515
TS
2490
2491 if (vs->minor == 3) {
7e7e2ebc 2492 if (vs->auth == VNC_AUTH_NONE) {
70848515 2493 VNC_DEBUG("Tell client auth none\n");
7e7e2ebc 2494 vnc_write_u32(vs, vs->auth);
70848515 2495 vnc_flush(vs);
28a76be8 2496 start_client_init(vs);
7e7e2ebc 2497 } else if (vs->auth == VNC_AUTH_VNC) {
70848515 2498 VNC_DEBUG("Tell client VNC auth\n");
7e7e2ebc 2499 vnc_write_u32(vs, vs->auth);
70848515
TS
2500 vnc_flush(vs);
2501 start_auth_vnc(vs);
2502 } else {
7e7e2ebc 2503 VNC_DEBUG("Unsupported auth %d for protocol 3.3\n", vs->auth);
70848515
TS
2504 vnc_write_u32(vs, VNC_AUTH_INVALID);
2505 vnc_flush(vs);
2506 vnc_client_error(vs);
2507 }
2508 } else {
7e7e2ebc 2509 VNC_DEBUG("Telling client we support auth %d\n", vs->auth);
28a76be8 2510 vnc_write_u8(vs, 1); /* num auth */
7e7e2ebc 2511 vnc_write_u8(vs, vs->auth);
28a76be8
AL
2512 vnc_read_when(vs, protocol_client_auth, 1);
2513 vnc_flush(vs);
70848515 2514 }
24236869
FB
2515
2516 return 0;
2517}
2518
999342a0
CC
2519static VncRectStat *vnc_stat_rect(VncDisplay *vd, int x, int y)
2520{
2521 struct VncSurface *vs = &vd->guest;
2522
2523 return &vs->stats[y / VNC_STAT_RECT][x / VNC_STAT_RECT];
2524}
2525
7d964c9d
CC
2526void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h)
2527{
2528 int i, j;
2529
2530 w = (x + w) / VNC_STAT_RECT;
2531 h = (y + h) / VNC_STAT_RECT;
2532 x /= VNC_STAT_RECT;
2533 y /= VNC_STAT_RECT;
2534
207f328a
CC
2535 for (j = y; j <= h; j++) {
2536 for (i = x; i <= w; i++) {
7d964c9d
CC
2537 vs->lossy_rect[j][i] = 1;
2538 }
2539 }
2540}
2541
2542static int vnc_refresh_lossy_rect(VncDisplay *vd, int x, int y)
2543{
2544 VncState *vs;
2545 int sty = y / VNC_STAT_RECT;
2546 int stx = x / VNC_STAT_RECT;
2547 int has_dirty = 0;
2548
2549 y = y / VNC_STAT_RECT * VNC_STAT_RECT;
2550 x = x / VNC_STAT_RECT * VNC_STAT_RECT;
2551
2552 QTAILQ_FOREACH(vs, &vd->clients, next) {
bc2429b9 2553 int j;
7d964c9d
CC
2554
2555 /* kernel send buffers are full -> refresh later */
2556 if (vs->output.offset) {
2557 continue;
2558 }
2559
2560 if (!vs->lossy_rect[sty][stx]) {
2561 continue;
2562 }
207f328a 2563
7d964c9d
CC
2564 vs->lossy_rect[sty][stx] = 0;
2565 for (j = 0; j < VNC_STAT_RECT; ++j) {
bc2429b9 2566 bitmap_set(vs->dirty[y + j], x / 16, VNC_STAT_RECT / 16);
7d964c9d
CC
2567 }
2568 has_dirty++;
2569 }
207f328a 2570
7d964c9d
CC
2571 return has_dirty;
2572}
2573
2574static int vnc_update_stats(VncDisplay *vd, struct timeval * tv)
999342a0 2575{
9f64916d
GH
2576 int width = pixman_image_get_width(vd->guest.fb);
2577 int height = pixman_image_get_height(vd->guest.fb);
999342a0
CC
2578 int x, y;
2579 struct timeval res;
7d964c9d 2580 int has_dirty = 0;
999342a0 2581
9f64916d
GH
2582 for (y = 0; y < height; y += VNC_STAT_RECT) {
2583 for (x = 0; x < width; x += VNC_STAT_RECT) {
999342a0
CC
2584 VncRectStat *rect = vnc_stat_rect(vd, x, y);
2585
2586 rect->updated = false;
2587 }
2588 }
2589
ad620c29 2590 qemu_timersub(tv, &VNC_REFRESH_STATS, &res);
999342a0
CC
2591
2592 if (timercmp(&vd->guest.last_freq_check, &res, >)) {
7d964c9d 2593 return has_dirty;
999342a0
CC
2594 }
2595 vd->guest.last_freq_check = *tv;
2596
9f64916d
GH
2597 for (y = 0; y < height; y += VNC_STAT_RECT) {
2598 for (x = 0; x < width; x += VNC_STAT_RECT) {
999342a0
CC
2599 VncRectStat *rect= vnc_stat_rect(vd, x, y);
2600 int count = ARRAY_SIZE(rect->times);
2601 struct timeval min, max;
2602
2603 if (!timerisset(&rect->times[count - 1])) {
2604 continue ;
2605 }
2606
2607 max = rect->times[(rect->idx + count - 1) % count];
ad620c29 2608 qemu_timersub(tv, &max, &res);
999342a0
CC
2609
2610 if (timercmp(&res, &VNC_REFRESH_LOSSY, >)) {
2611 rect->freq = 0;
7d964c9d 2612 has_dirty += vnc_refresh_lossy_rect(vd, x, y);
999342a0
CC
2613 memset(rect->times, 0, sizeof (rect->times));
2614 continue ;
2615 }
2616
2617 min = rect->times[rect->idx];
2618 max = rect->times[(rect->idx + count - 1) % count];
ad620c29 2619 qemu_timersub(&max, &min, &res);
999342a0
CC
2620
2621 rect->freq = res.tv_sec + res.tv_usec / 1000000.;
2622 rect->freq /= count;
2623 rect->freq = 1. / rect->freq;
2624 }
2625 }
7d964c9d 2626 return has_dirty;
999342a0
CC
2627}
2628
2629double vnc_update_freq(VncState *vs, int x, int y, int w, int h)
2630{
2631 int i, j;
2632 double total = 0;
2633 int num = 0;
2634
2635 x = (x / VNC_STAT_RECT) * VNC_STAT_RECT;
2636 y = (y / VNC_STAT_RECT) * VNC_STAT_RECT;
2637
2638 for (j = y; j <= y + h; j += VNC_STAT_RECT) {
2639 for (i = x; i <= x + w; i += VNC_STAT_RECT) {
2640 total += vnc_stat_rect(vs->vd, i, j)->freq;
2641 num++;
2642 }
2643 }
2644
2645 if (num) {
2646 return total / num;
2647 } else {
2648 return 0;
2649 }
2650}
2651
2652static void vnc_rect_updated(VncDisplay *vd, int x, int y, struct timeval * tv)
2653{
2654 VncRectStat *rect;
2655
2656 rect = vnc_stat_rect(vd, x, y);
2657 if (rect->updated) {
2658 return ;
2659 }
2660 rect->times[rect->idx] = *tv;
2661 rect->idx = (rect->idx + 1) % ARRAY_SIZE(rect->times);
2662 rect->updated = true;
2663}
2664
1fc62412
SS
2665static int vnc_refresh_server_surface(VncDisplay *vd)
2666{
9f64916d
GH
2667 int width = pixman_image_get_width(vd->guest.fb);
2668 int height = pixman_image_get_height(vd->guest.fb);
1fc62412
SS
2669 int y;
2670 uint8_t *guest_row;
2671 uint8_t *server_row;
2672 int cmp_bytes;
41b4bef6 2673 VncState *vs;
1fc62412 2674 int has_dirty = 0;
9f64916d 2675 pixman_image_t *tmpbuf = NULL;
1fc62412 2676
80e0c8c3 2677 struct timeval tv = { 0, 0 };
999342a0 2678
80e0c8c3
CC
2679 if (!vd->non_adaptive) {
2680 gettimeofday(&tv, NULL);
2681 has_dirty = vnc_update_stats(vd, &tv);
2682 }
999342a0 2683
1fc62412
SS
2684 /*
2685 * Walk through the guest dirty map.
2686 * Check and copy modified bits from guest to server surface.
2687 * Update server dirty map.
2688 */
9f64916d
GH
2689 cmp_bytes = 64;
2690 if (cmp_bytes > vnc_server_fb_stride(vd)) {
2691 cmp_bytes = vnc_server_fb_stride(vd);
2692 }
2693 if (vd->guest.format != VNC_SERVER_FB_FORMAT) {
2694 int width = pixman_image_get_width(vd->server);
2695 tmpbuf = qemu_pixman_linebuf_create(VNC_SERVER_FB_FORMAT, width);
9e4dd565 2696 }
9f64916d
GH
2697 guest_row = (uint8_t *)pixman_image_get_data(vd->guest.fb);
2698 server_row = (uint8_t *)pixman_image_get_data(vd->server);
2699 for (y = 0; y < height; y++) {
23bfe28f 2700 if (!bitmap_empty(vd->guest.dirty[y], VNC_DIRTY_BITS)) {
1fc62412
SS
2701 int x;
2702 uint8_t *guest_ptr;
2703 uint8_t *server_ptr;
2704
9f64916d 2705 if (vd->guest.format != VNC_SERVER_FB_FORMAT) {
bc210eb1 2706 qemu_pixman_linebuf_fill(tmpbuf, vd->guest.fb, width, 0, y);
9f64916d
GH
2707 guest_ptr = (uint8_t *)pixman_image_get_data(tmpbuf);
2708 } else {
2709 guest_ptr = guest_row;
2710 }
1fc62412
SS
2711 server_ptr = server_row;
2712
9f64916d 2713 for (x = 0; x + 15 < width;
1fc62412 2714 x += 16, guest_ptr += cmp_bytes, server_ptr += cmp_bytes) {
bc2429b9 2715 if (!test_and_clear_bit((x / 16), vd->guest.dirty[y]))
1fc62412 2716 continue;
1fc62412
SS
2717 if (memcmp(server_ptr, guest_ptr, cmp_bytes) == 0)
2718 continue;
2719 memcpy(server_ptr, guest_ptr, cmp_bytes);
80e0c8c3
CC
2720 if (!vd->non_adaptive)
2721 vnc_rect_updated(vd, x, y, &tv);
41b4bef6 2722 QTAILQ_FOREACH(vs, &vd->clients, next) {
bc2429b9 2723 set_bit((x / 16), vs->dirty[y]);
1fc62412
SS
2724 }
2725 has_dirty++;
2726 }
2727 }
9f64916d
GH
2728 guest_row += pixman_image_get_stride(vd->guest.fb);
2729 server_row += pixman_image_get_stride(vd->server);
1fc62412 2730 }
9f64916d 2731 qemu_pixman_image_unref(tmpbuf);
1fc62412
SS
2732 return has_dirty;
2733}
2734
0f7b2864 2735static void vnc_refresh(DisplayChangeListener *dcl)
703bc68f 2736{
0f7b2864 2737 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
41b4bef6
AS
2738 VncState *vs, *vn;
2739 int has_dirty, rects = 0;
703bc68f 2740
1dbfa005 2741 graphic_hw_update(NULL);
703bc68f 2742
bd023f95 2743 if (vnc_trylock_display(vd)) {
0f7b2864 2744 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);
bd023f95
CC
2745 return;
2746 }
2747
1fc62412 2748 has_dirty = vnc_refresh_server_surface(vd);
bd023f95 2749 vnc_unlock_display(vd);
1fc62412 2750
41b4bef6 2751 QTAILQ_FOREACH_SAFE(vs, &vd->clients, next, vn) {
2430ffe4 2752 rects += vnc_update_client(vs, has_dirty);
6185c578 2753 /* vs might be free()ed here */
703bc68f 2754 }
bd023f95 2755
0f7b2864
GH
2756 if (QTAILQ_EMPTY(&vd->clients)) {
2757 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_MAX);
83755c17 2758 return;
0f7b2864 2759 }
703bc68f 2760
2430ffe4 2761 if (has_dirty && rects) {
0f7b2864
GH
2762 vd->dcl.update_interval /= 2;
2763 if (vd->dcl.update_interval < VNC_REFRESH_INTERVAL_BASE) {
2764 vd->dcl.update_interval = VNC_REFRESH_INTERVAL_BASE;
2765 }
2430ffe4 2766 } else {
0f7b2864
GH
2767 vd->dcl.update_interval += VNC_REFRESH_INTERVAL_INC;
2768 if (vd->dcl.update_interval > VNC_REFRESH_INTERVAL_MAX) {
2769 vd->dcl.update_interval = VNC_REFRESH_INTERVAL_MAX;
2770 }
703bc68f
SS
2771 }
2772}
2773
7536ee4b 2774static void vnc_connect(VncDisplay *vd, int csock, int skipauth, bool websocket)
3aa3eea3 2775{
7267c094 2776 VncState *vs = g_malloc0(sizeof(VncState));
7d964c9d
CC
2777 int i;
2778
753b4053 2779 vs->csock = csock;
7e7e2ebc
DB
2780
2781 if (skipauth) {
2782 vs->auth = VNC_AUTH_NONE;
2783#ifdef CONFIG_VNC_TLS
2784 vs->subauth = VNC_AUTH_INVALID;
2785#endif
2786 } else {
2787 vs->auth = vd->auth;
2788#ifdef CONFIG_VNC_TLS
2789 vs->subauth = vd->subauth;
2790#endif
2791 }
2792
7267c094 2793 vs->lossy_rect = g_malloc0(VNC_STAT_ROWS * sizeof (*vs->lossy_rect));
7d964c9d 2794 for (i = 0; i < VNC_STAT_ROWS; ++i) {
7267c094 2795 vs->lossy_rect[i] = g_malloc0(VNC_STAT_COLS * sizeof (uint8_t));
7d964c9d 2796 }
753b4053
AL
2797
2798 VNC_DEBUG("New client on socket %d\n", csock);
0f7b2864 2799 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);
f9e8cacc 2800 qemu_set_nonblock(vs->csock);
7536ee4b
TH
2801#ifdef CONFIG_VNC_WS
2802 if (websocket) {
2803 vs->websocket = 1;
0057a0d5
TH
2804#ifdef CONFIG_VNC_TLS
2805 if (vd->tls.x509cert) {
2806 qemu_set_fd_handler2(vs->csock, NULL, vncws_tls_handshake_peek,
2807 NULL, vs);
2808 } else
2809#endif /* CONFIG_VNC_TLS */
2810 {
2811 qemu_set_fd_handler2(vs->csock, NULL, vncws_handshake_read,
2812 NULL, vs);
2813 }
7536ee4b
TH
2814 } else
2815#endif /* CONFIG_VNC_WS */
2816 {
2817 qemu_set_fd_handler2(vs->csock, NULL, vnc_client_read, NULL, vs);
2818 }
753b4053 2819
4a80dba3 2820 vnc_client_cache_addr(vs);
586153d9 2821 vnc_qmp_event(vs, QEVENT_VNC_CONNECTED);
8cf36489 2822 vnc_set_share_mode(vs, VNC_SHARE_MODE_CONNECTING);
4a80dba3 2823
753b4053 2824 vs->vd = vd;
7536ee4b
TH
2825
2826#ifdef CONFIG_VNC_WS
2827 if (!vs->websocket)
2828#endif
2829 {
2830 vnc_init_state(vs);
2831 }
2832}
2833
2834void vnc_init_state(VncState *vs)
2835{
6fd8e79a 2836 vs->initialized = true;
7536ee4b
TH
2837 VncDisplay *vd = vs->vd;
2838
753b4053
AL
2839 vs->last_x = -1;
2840 vs->last_y = -1;
2841
2842 vs->as.freq = 44100;
2843 vs->as.nchannels = 2;
2844 vs->as.fmt = AUD_FMT_S16;
2845 vs->as.endianness = 0;
2846
bd023f95 2847 qemu_mutex_init(&vs->output_mutex);
175b2a6e 2848 vs->bh = qemu_bh_new(vnc_jobs_bh, vs);
bd023f95 2849
41b4bef6 2850 QTAILQ_INSERT_HEAD(&vd->clients, vs, next);
1fc62412 2851
1dbfa005 2852 graphic_hw_update(NULL);
1fc62412 2853
3aa3eea3
AZ
2854 vnc_write(vs, "RFB 003.008\n", 12);
2855 vnc_flush(vs);
2856 vnc_read_when(vs, protocol_version, 12);
53762ddb 2857 reset_keys(vs);
3a0558b5
GH
2858 if (vs->vd->lock_key_sync)
2859 vs->led = qemu_add_led_event_handler(kbd_leds, vs);
753b4053 2860
37c34d9d
AL
2861 vs->mouse_mode_notifier.notify = check_pointer_type_change;
2862 qemu_add_mouse_mode_change_notifier(&vs->mouse_mode_notifier);
2863
198a0039 2864 /* vs might be free()ed here */
3aa3eea3
AZ
2865}
2866
7536ee4b 2867static void vnc_listen_read(void *opaque, bool websocket)
24236869 2868{
753b4053 2869 VncDisplay *vs = opaque;
24236869
FB
2870 struct sockaddr_in addr;
2871 socklen_t addrlen = sizeof(addr);
7536ee4b 2872 int csock;
24236869 2873
9f60ad50 2874 /* Catch-up */
1dbfa005 2875 graphic_hw_update(NULL);
7536ee4b
TH
2876#ifdef CONFIG_VNC_WS
2877 if (websocket) {
2878 csock = qemu_accept(vs->lwebsock, (struct sockaddr *)&addr, &addrlen);
2879 } else
2880#endif /* CONFIG_VNC_WS */
2881 {
2882 csock = qemu_accept(vs->lsock, (struct sockaddr *)&addr, &addrlen);
2883 }
9f60ad50 2884
753b4053 2885 if (csock != -1) {
7536ee4b 2886 vnc_connect(vs, csock, 0, websocket);
24236869
FB
2887 }
2888}
2889
7536ee4b
TH
2890static void vnc_listen_regular_read(void *opaque)
2891{
2892 vnc_listen_read(opaque, 0);
2893}
2894
2895#ifdef CONFIG_VNC_WS
2896static void vnc_listen_websocket_read(void *opaque)
2897{
2898 vnc_listen_read(opaque, 1);
2899}
2900#endif /* CONFIG_VNC_WS */
2901
7c20b4a3
GH
2902static const DisplayChangeListenerOps dcl_ops = {
2903 .dpy_name = "vnc",
0f7b2864 2904 .dpy_refresh = vnc_refresh,
7c20b4a3
GH
2905 .dpy_gfx_copy = vnc_dpy_copy,
2906 .dpy_gfx_update = vnc_dpy_update,
c12aeb86 2907 .dpy_gfx_switch = vnc_dpy_switch,
7c20b4a3
GH
2908 .dpy_mouse_set = vnc_mouse_set,
2909 .dpy_cursor_define = vnc_dpy_cursor_define,
2910};
2911
71cab5ca 2912void vnc_display_init(DisplayState *ds)
24236869 2913{
7267c094 2914 VncDisplay *vs = g_malloc0(sizeof(*vs));
24236869 2915
753b4053 2916 vnc_display = vs;
24236869
FB
2917
2918 vs->lsock = -1;
7536ee4b
TH
2919#ifdef CONFIG_VNC_WS
2920 vs->lwebsock = -1;
2921#endif
24236869 2922
41b4bef6 2923 QTAILQ_INIT(&vs->clients);
3c9405a0 2924 vs->expires = TIME_MAX;
24236869 2925
9ca313aa 2926 if (keyboard_layout)
0483755a 2927 vs->kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout);
9ca313aa 2928 else
0483755a 2929 vs->kbd_layout = init_keyboard_layout(name2keysym, "en-us");
24236869 2930
24236869 2931 if (!vs->kbd_layout)
28a76be8 2932 exit(1);
24236869 2933
bd023f95
CC
2934 qemu_mutex_init(&vs->mutex);
2935 vnc_start_worker_thread();
bd023f95 2936
21ef45d7 2937 vs->dcl.ops = &dcl_ops;
5209089f 2938 register_displaychangelistener(&vs->dcl);
71cab5ca
TS
2939}
2940
6f43024c 2941
71a8cdec 2942static void vnc_display_close(DisplayState *ds)
71cab5ca 2943{
21ef45d7 2944 VncDisplay *vs = vnc_display;
71cab5ca 2945
452b4d88
AL
2946 if (!vs)
2947 return;
71cab5ca 2948 if (vs->display) {
7267c094 2949 g_free(vs->display);
28a76be8 2950 vs->display = NULL;
71cab5ca
TS
2951 }
2952 if (vs->lsock != -1) {
28a76be8
AL
2953 qemu_set_fd_handler2(vs->lsock, NULL, NULL, NULL, NULL);
2954 close(vs->lsock);
2955 vs->lsock = -1;
71cab5ca 2956 }
7536ee4b
TH
2957#ifdef CONFIG_VNC_WS
2958 g_free(vs->ws_display);
2959 vs->ws_display = NULL;
2960 if (vs->lwebsock != -1) {
2961 qemu_set_fd_handler2(vs->lwebsock, NULL, NULL, NULL, NULL);
2962 close(vs->lwebsock);
2963 vs->lwebsock = -1;
2964 }
2965#endif /* CONFIG_VNC_WS */
70848515 2966 vs->auth = VNC_AUTH_INVALID;
eb38c52c 2967#ifdef CONFIG_VNC_TLS
8d5d2d4c 2968 vs->subauth = VNC_AUTH_INVALID;
5fb6c7a8 2969 vs->tls.x509verify = 0;
8d5d2d4c 2970#endif
70848515
TS
2971}
2972
71a8cdec 2973static int vnc_display_disable_login(DisplayState *ds)
1cd20f8b 2974{
21ef45d7 2975 VncDisplay *vs = vnc_display;
1cd20f8b
AL
2976
2977 if (!vs) {
2978 return -1;
2979 }
2980
2981 if (vs->password) {
7267c094 2982 g_free(vs->password);
1cd20f8b
AL
2983 }
2984
2985 vs->password = NULL;
7dfbfc79
DB
2986 if (vs->auth == VNC_AUTH_NONE) {
2987 vs->auth = VNC_AUTH_VNC;
2988 }
1cd20f8b
AL
2989
2990 return 0;
2991}
2992
70848515
TS
2993int vnc_display_password(DisplayState *ds, const char *password)
2994{
21ef45d7 2995 VncDisplay *vs = vnc_display;
70848515 2996
7ef92331 2997 if (!vs) {
a6aa9d3e 2998 return -EINVAL;
7ef92331
ZA
2999 }
3000
1cd20f8b
AL
3001 if (!password) {
3002 /* This is not the intention of this interface but err on the side
3003 of being safe */
a6aa9d3e 3004 return vnc_display_disable_login(ds);
1cd20f8b
AL
3005 }
3006
70848515 3007 if (vs->password) {
7267c094 3008 g_free(vs->password);
28a76be8 3009 vs->password = NULL;
70848515 3010 }
7267c094 3011 vs->password = g_strdup(password);
7dfbfc79
DB
3012 if (vs->auth == VNC_AUTH_NONE) {
3013 vs->auth = VNC_AUTH_VNC;
3014 }
a6aa9d3e
LC
3015
3016 return 0;
71cab5ca
TS
3017}
3018
3c9405a0
GH
3019int vnc_display_pw_expire(DisplayState *ds, time_t expires)
3020{
21ef45d7 3021 VncDisplay *vs = vnc_display;
3c9405a0 3022
1643f2b2
GH
3023 if (!vs) {
3024 return -EINVAL;
3025 }
3026
3c9405a0
GH
3027 vs->expires = expires;
3028 return 0;
3029}
3030
f92f8afe
AL
3031char *vnc_display_local_addr(DisplayState *ds)
3032{
21ef45d7 3033 VncDisplay *vs = vnc_display;
f92f8afe
AL
3034
3035 return vnc_socket_local_addr("%s:%s", vs->lsock);
3036}
3037
2d55f0e8 3038void vnc_display_open(DisplayState *ds, const char *display, Error **errp)
71cab5ca 3039{
21ef45d7 3040 VncDisplay *vs = vnc_display;
70848515
TS
3041 const char *options;
3042 int password = 0;
3aa3eea3 3043 int reverse = 0;
eb38c52c 3044#ifdef CONFIG_VNC_TLS
3a702699 3045 int tls = 0, x509 = 0;
8d5d2d4c 3046#endif
2f9606b3
AL
3047#ifdef CONFIG_VNC_SASL
3048 int sasl = 0;
3049 int saslErr;
3050#endif
2ded6ad7 3051#if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
76655d6d 3052 int acl = 0;
2ded6ad7 3053#endif
3a0558b5 3054 int lock_key_sync = 1;
71cab5ca 3055
2d55f0e8
PB
3056 if (!vnc_display) {
3057 error_setg(errp, "VNC display not active");
3058 return;
3059 }
71cab5ca 3060 vnc_display_close(ds);
70848515 3061 if (strcmp(display, "none") == 0)
2d55f0e8 3062 return;
24236869 3063
1ce52c78 3064 vs->display = g_strdup(display);
8cf36489 3065 vs->share_policy = VNC_SHARE_POLICY_ALLOW_EXCLUSIVE;
70848515
TS
3066
3067 options = display;
3068 while ((options = strchr(options, ','))) {
28a76be8
AL
3069 options++;
3070 if (strncmp(options, "password", 8) == 0) {
0f66998f 3071 if (fips_get_state()) {
2d55f0e8
PB
3072 error_setg(errp,
3073 "VNC password auth disabled due to FIPS mode, "
3074 "consider using the VeNCrypt or SASL authentication "
3075 "methods as an alternative");
1ce52c78 3076 goto fail;
0f66998f 3077 }
28a76be8
AL
3078 password = 1; /* Require password auth */
3079 } else if (strncmp(options, "reverse", 7) == 0) {
3080 reverse = 1;
cee8e6ad 3081 } else if (strncmp(options, "no-lock-key-sync", 16) == 0) {
3a0558b5 3082 lock_key_sync = 0;
2f9606b3 3083#ifdef CONFIG_VNC_SASL
28a76be8
AL
3084 } else if (strncmp(options, "sasl", 4) == 0) {
3085 sasl = 1; /* Require SASL auth */
2f9606b3 3086#endif
7536ee4b
TH
3087#ifdef CONFIG_VNC_WS
3088 } else if (strncmp(options, "websocket", 9) == 0) {
3089 char *start, *end;
3090 vs->websocket = 1;
3091
3092 /* Check for 'websocket=<port>' */
3093 start = strchr(options, '=');
3094 end = strchr(options, ',');
3095 if (start && (!end || (start < end))) {
3096 int len = end ? end-(start+1) : strlen(start+1);
3097 if (len < 6) {
3098 /* extract the host specification from display */
3099 char *host = NULL, *port = NULL, *host_end = NULL;
3100 port = g_strndup(start + 1, len);
3101
3102 /* ipv6 hosts have colons */
3103 end = strchr(display, ',');
3104 host_end = g_strrstr_len(display, end - display, ":");
3105
3106 if (host_end) {
3107 host = g_strndup(display, host_end - display + 1);
3108 } else {
3109 host = g_strndup(":", 1);
3110 }
3111 vs->ws_display = g_strconcat(host, port, NULL);
3112 g_free(host);
3113 g_free(port);
3114 }
3115 }
3116#endif /* CONFIG_VNC_WS */
eb38c52c 3117#ifdef CONFIG_VNC_TLS
28a76be8
AL
3118 } else if (strncmp(options, "tls", 3) == 0) {
3119 tls = 1; /* Require TLS */
3120 } else if (strncmp(options, "x509", 4) == 0) {
3121 char *start, *end;
3122 x509 = 1; /* Require x509 certificates */
3123 if (strncmp(options, "x509verify", 10) == 0)
3124 vs->tls.x509verify = 1; /* ...and verify client certs */
3125
3126 /* Now check for 'x509=/some/path' postfix
3127 * and use that to setup x509 certificate/key paths */
3128 start = strchr(options, '=');
3129 end = strchr(options, ',');
3130 if (start && (!end || (start < end))) {
3131 int len = end ? end-(start+1) : strlen(start+1);
7267c094 3132 char *path = g_strndup(start + 1, len);
28a76be8
AL
3133
3134 VNC_DEBUG("Trying certificate path '%s'\n", path);
3135 if (vnc_tls_set_x509_creds_dir(vs, path) < 0) {
2d55f0e8 3136 error_setg(errp, "Failed to find x509 certificates/keys in %s", path);
7267c094 3137 g_free(path);
1ce52c78 3138 goto fail;
28a76be8 3139 }
7267c094 3140 g_free(path);
28a76be8 3141 } else {
2d55f0e8 3142 error_setg(errp, "No certificate path provided");
1ce52c78 3143 goto fail;
28a76be8 3144 }
8d5d2d4c 3145#endif
2ded6ad7 3146#if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
28a76be8
AL
3147 } else if (strncmp(options, "acl", 3) == 0) {
3148 acl = 1;
2ded6ad7 3149#endif
6f9c78c1
CC
3150 } else if (strncmp(options, "lossy", 5) == 0) {
3151 vs->lossy = true;
7eff5742 3152 } else if (strncmp(options, "non-adaptive", 12) == 0) {
80e0c8c3 3153 vs->non_adaptive = true;
8cf36489
GH
3154 } else if (strncmp(options, "share=", 6) == 0) {
3155 if (strncmp(options+6, "ignore", 6) == 0) {
3156 vs->share_policy = VNC_SHARE_POLICY_IGNORE;
3157 } else if (strncmp(options+6, "allow-exclusive", 15) == 0) {
3158 vs->share_policy = VNC_SHARE_POLICY_ALLOW_EXCLUSIVE;
3159 } else if (strncmp(options+6, "force-shared", 12) == 0) {
3160 vs->share_policy = VNC_SHARE_POLICY_FORCE_SHARED;
3161 } else {
2d55f0e8 3162 error_setg(errp, "unknown vnc share= option");
1ce52c78 3163 goto fail;
8cf36489 3164 }
28a76be8 3165 }
70848515
TS
3166 }
3167
76655d6d
AL
3168#ifdef CONFIG_VNC_TLS
3169 if (acl && x509 && vs->tls.x509verify) {
28a76be8
AL
3170 if (!(vs->tls.acl = qemu_acl_init("vnc.x509dname"))) {
3171 fprintf(stderr, "Failed to create x509 dname ACL\n");
3172 exit(1);
3173 }
76655d6d
AL
3174 }
3175#endif
3176#ifdef CONFIG_VNC_SASL
3177 if (acl && sasl) {
28a76be8
AL
3178 if (!(vs->sasl.acl = qemu_acl_init("vnc.username"))) {
3179 fprintf(stderr, "Failed to create username ACL\n");
3180 exit(1);
3181 }
76655d6d
AL
3182 }
3183#endif
3184
2f9606b3
AL
3185 /*
3186 * Combinations we support here:
3187 *
3188 * - no-auth (clear text, no auth)
3189 * - password (clear text, weak auth)
3190 * - sasl (encrypt, good auth *IF* using Kerberos via GSSAPI)
3191 * - tls (encrypt, weak anonymous creds, no auth)
3192 * - tls + password (encrypt, weak anonymous creds, weak auth)
3193 * - tls + sasl (encrypt, weak anonymous creds, good auth)
3194 * - tls + x509 (encrypt, good x509 creds, no auth)
3195 * - tls + x509 + password (encrypt, good x509 creds, weak auth)
3196 * - tls + x509 + sasl (encrypt, good x509 creds, good auth)
3197 *
3198 * NB1. TLS is a stackable auth scheme.
3199 * NB2. the x509 schemes have option to validate a client cert dname
3200 */
70848515 3201 if (password) {
eb38c52c 3202#ifdef CONFIG_VNC_TLS
28a76be8
AL
3203 if (tls) {
3204 vs->auth = VNC_AUTH_VENCRYPT;
3205 if (x509) {
3206 VNC_DEBUG("Initializing VNC server with x509 password auth\n");
3207 vs->subauth = VNC_AUTH_VENCRYPT_X509VNC;
3208 } else {
3209 VNC_DEBUG("Initializing VNC server with TLS password auth\n");
3210 vs->subauth = VNC_AUTH_VENCRYPT_TLSVNC;
3211 }
3212 } else {
2f9606b3 3213#endif /* CONFIG_VNC_TLS */
28a76be8
AL
3214 VNC_DEBUG("Initializing VNC server with password auth\n");
3215 vs->auth = VNC_AUTH_VNC;
eb38c52c 3216#ifdef CONFIG_VNC_TLS
28a76be8
AL
3217 vs->subauth = VNC_AUTH_INVALID;
3218 }
2f9606b3
AL
3219#endif /* CONFIG_VNC_TLS */
3220#ifdef CONFIG_VNC_SASL
3221 } else if (sasl) {
3222#ifdef CONFIG_VNC_TLS
3223 if (tls) {
3224 vs->auth = VNC_AUTH_VENCRYPT;
3225 if (x509) {
28a76be8 3226 VNC_DEBUG("Initializing VNC server with x509 SASL auth\n");
2f9606b3
AL
3227 vs->subauth = VNC_AUTH_VENCRYPT_X509SASL;
3228 } else {
28a76be8 3229 VNC_DEBUG("Initializing VNC server with TLS SASL auth\n");
2f9606b3
AL
3230 vs->subauth = VNC_AUTH_VENCRYPT_TLSSASL;
3231 }
3232 } else {
3233#endif /* CONFIG_VNC_TLS */
28a76be8 3234 VNC_DEBUG("Initializing VNC server with SASL auth\n");
2f9606b3
AL
3235 vs->auth = VNC_AUTH_SASL;
3236#ifdef CONFIG_VNC_TLS
3237 vs->subauth = VNC_AUTH_INVALID;
3238 }
3239#endif /* CONFIG_VNC_TLS */
3240#endif /* CONFIG_VNC_SASL */
70848515 3241 } else {
eb38c52c 3242#ifdef CONFIG_VNC_TLS
28a76be8
AL
3243 if (tls) {
3244 vs->auth = VNC_AUTH_VENCRYPT;
3245 if (x509) {
3246 VNC_DEBUG("Initializing VNC server with x509 no auth\n");
3247 vs->subauth = VNC_AUTH_VENCRYPT_X509NONE;
3248 } else {
3249 VNC_DEBUG("Initializing VNC server with TLS no auth\n");
3250 vs->subauth = VNC_AUTH_VENCRYPT_TLSNONE;
3251 }
3252 } else {
8d5d2d4c 3253#endif
28a76be8
AL
3254 VNC_DEBUG("Initializing VNC server with no auth\n");
3255 vs->auth = VNC_AUTH_NONE;
eb38c52c 3256#ifdef CONFIG_VNC_TLS
28a76be8
AL
3257 vs->subauth = VNC_AUTH_INVALID;
3258 }
8d5d2d4c 3259#endif
70848515 3260 }
24236869 3261
2f9606b3
AL
3262#ifdef CONFIG_VNC_SASL
3263 if ((saslErr = sasl_server_init(NULL, "qemu")) != SASL_OK) {
2d55f0e8
PB
3264 error_setg(errp, "Failed to initialize SASL auth: %s",
3265 sasl_errstring(saslErr, NULL, NULL));
1ce52c78 3266 goto fail;
2f9606b3
AL
3267 }
3268#endif
3a0558b5 3269 vs->lock_key_sync = lock_key_sync;
2f9606b3 3270
3aa3eea3 3271 if (reverse) {
9712ecaf 3272 /* connect to viewer */
007fcd3e
PB
3273 int csock;
3274 vs->lsock = -1;
7536ee4b
TH
3275#ifdef CONFIG_VNC_WS
3276 vs->lwebsock = -1;
3277#endif
007fcd3e 3278 if (strncmp(display, "unix:", 5) == 0) {
2d55f0e8 3279 csock = unix_connect(display+5, errp);
3aa3eea3 3280 } else {
2d55f0e8 3281 csock = inet_connect(display, errp);
3aa3eea3 3282 }
007fcd3e
PB
3283 if (csock < 0) {
3284 goto fail;
3285 }
7536ee4b 3286 vnc_connect(vs, csock, 0, 0);
9712ecaf
AL
3287 } else {
3288 /* listen for connects */
3289 char *dpy;
7267c094 3290 dpy = g_malloc(256);
9712ecaf 3291 if (strncmp(display, "unix:", 5) == 0) {
bc575e95 3292 pstrcpy(dpy, 256, "unix:");
2d55f0e8 3293 vs->lsock = unix_listen(display+5, dpy+5, 256-5, errp);
9712ecaf 3294 } else {
029409e5 3295 vs->lsock = inet_listen(display, dpy, 256,
2d55f0e8 3296 SOCK_STREAM, 5900, errp);
7536ee4b
TH
3297 if (vs->lsock < 0) {
3298 g_free(dpy);
3299 goto fail;
3300 }
3301#ifdef CONFIG_VNC_WS
3302 if (vs->websocket) {
3303 if (vs->ws_display) {
3304 vs->lwebsock = inet_listen(vs->ws_display, NULL, 256,
3305 SOCK_STREAM, 0, errp);
3306 } else {
3307 vs->lwebsock = inet_listen(vs->display, NULL, 256,
3308 SOCK_STREAM, 5700, errp);
3309 }
3310
3311 if (vs->lwebsock < 0) {
3312 if (vs->lsock) {
3313 close(vs->lsock);
3314 vs->lsock = -1;
3315 }
3316 g_free(dpy);
3317 goto fail;
3318 }
3319 }
3320#endif /* CONFIG_VNC_WS */
9712ecaf 3321 }
1ce52c78
PB
3322 g_free(vs->display);
3323 vs->display = dpy;
7536ee4b
TH
3324 qemu_set_fd_handler2(vs->lsock, NULL,
3325 vnc_listen_regular_read, NULL, vs);
3326#ifdef CONFIG_VNC_WS
3327 if (vs->websocket) {
3328 qemu_set_fd_handler2(vs->lwebsock, NULL,
3329 vnc_listen_websocket_read, NULL, vs);
3330 }
3331#endif /* CONFIG_VNC_WS */
24236869 3332 }
2d55f0e8 3333 return;
1ce52c78
PB
3334
3335fail:
3336 g_free(vs->display);
3337 vs->display = NULL;
7536ee4b
TH
3338#ifdef CONFIG_VNC_WS
3339 g_free(vs->ws_display);
3340 vs->ws_display = NULL;
3341#endif /* CONFIG_VNC_WS */
24236869 3342}
13661089
DB
3343
3344void vnc_display_add_client(DisplayState *ds, int csock, int skipauth)
3345{
21ef45d7 3346 VncDisplay *vs = vnc_display;
13661089 3347
7536ee4b 3348 vnc_connect(vs, csock, skipauth, 0);
13661089 3349}