?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
ui: convert VNC server to use QIOChannelTLS
[qemu/ar7.git] / ui / vnc.c
blob8b8361e371bef6d5fd14f4034a64748355d0e405
1 /*
2 * QEMU VNC display driver
3 *
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26
27 #include "vnc.h"
28 #include "vnc-jobs.h"
29 #include "trace.h"
30 #include "hw/qdev.h"
31 #include "sysemu/sysemu.h"
32 #include "qemu/error-report.h"
33 #include "qemu/sockets.h"
34 #include "qemu/timer.h"
35 #include "qemu/acl.h"
36 #include "qemu/config-file.h"
37 #include "qapi/qmp/qerror.h"
38 #include "qapi/qmp/types.h"
39 #include "qmp-commands.h"
40 #include "qemu/osdep.h"
41 #include "ui/input.h"
42 #include "qapi-event.h"
43 #include "crypto/hash.h"
44 #include "crypto/tlscredsanon.h"
45 #include "crypto/tlscredsx509.h"
46 #include "qom/object_interfaces.h"
47
48 #define VNC_REFRESH_INTERVAL_BASE GUI_REFRESH_INTERVAL_DEFAULT
49 #define VNC_REFRESH_INTERVAL_INC 50
50 #define VNC_REFRESH_INTERVAL_MAX GUI_REFRESH_INTERVAL_IDLE
51 static const struct timeval VNC_REFRESH_STATS = { 0, 500000 };
52 static const struct timeval VNC_REFRESH_LOSSY = { 2, 0 };
53
54 #include "vnc_keysym.h"
55 #include "crypto/cipher.h"
56
57 static QTAILQ_HEAD(, VncDisplay) vnc_displays =
58 QTAILQ_HEAD_INITIALIZER(vnc_displays);
59
60 static int vnc_cursor_define(VncState *vs);
61 static void vnc_release_modifiers(VncState *vs);
62
63 static void vnc_set_share_mode(VncState *vs, VncShareMode mode)
64 {
65 #ifdef _VNC_DEBUG
66 static const char *mn[] = {
67 [0] = "undefined",
68 [VNC_SHARE_MODE_CONNECTING] = "connecting",
69 [VNC_SHARE_MODE_SHARED] = "shared",
70 [VNC_SHARE_MODE_EXCLUSIVE] = "exclusive",
71 [VNC_SHARE_MODE_DISCONNECTED] = "disconnected",
72 };
73 fprintf(stderr, "%s/%p: %s -> %s\n", __func__,
74 vs->ioc, mn[vs->share_mode], mn[mode]);
75 #endif
76
77 switch (vs->share_mode) {
78 case VNC_SHARE_MODE_CONNECTING:
79 vs->vd->num_connecting--;
80 break;
81 case VNC_SHARE_MODE_SHARED:
82 vs->vd->num_shared--;
83 break;
84 case VNC_SHARE_MODE_EXCLUSIVE:
85 vs->vd->num_exclusive--;
86 break;
87 default:
88 break;
89 }
90
91 vs->share_mode = mode;
92
93 switch (vs->share_mode) {
94 case VNC_SHARE_MODE_CONNECTING:
95 vs->vd->num_connecting++;
96 break;
97 case VNC_SHARE_MODE_SHARED:
98 vs->vd->num_shared++;
99 break;
100 case VNC_SHARE_MODE_EXCLUSIVE:
101 vs->vd->num_exclusive++;
102 break;
103 default:
104 break;
105 }
106 }
107
108
109 static void vnc_init_basic_info(SocketAddress *addr,
110 VncBasicInfo *info,
111 Error **errp)
112 {
113 switch (addr->type) {
114 case SOCKET_ADDRESS_KIND_INET:
115 info->host = g_strdup(addr->u.inet->host);
116 info->service = g_strdup(addr->u.inet->port);
117 if (addr->u.inet->ipv6) {
118 info->family = NETWORK_ADDRESS_FAMILY_IPV6;
119 } else {
120 info->family = NETWORK_ADDRESS_FAMILY_IPV4;
121 }
122 break;
123
124 case SOCKET_ADDRESS_KIND_UNIX:
125 info->host = g_strdup("");
126 info->service = g_strdup(addr->u.q_unix->path);
127 info->family = NETWORK_ADDRESS_FAMILY_UNIX;
128 break;
129
130 default:
131 error_setg(errp, "Unsupported socket kind %d",
132 addr->type);
133 break;
134 }
135
136 return;
137 }
138
139 static void vnc_init_basic_info_from_server_addr(QIOChannelSocket *ioc,
140 VncBasicInfo *info,
141 Error **errp)
142 {
143 SocketAddress *addr = NULL;
144
145 addr = qio_channel_socket_get_local_address(ioc, errp);
146 if (!addr) {
147 return;
148 }
149
150 vnc_init_basic_info(addr, info, errp);
151 qapi_free_SocketAddress(addr);
152 }
153
154 static void vnc_init_basic_info_from_remote_addr(QIOChannelSocket *ioc,
155 VncBasicInfo *info,
156 Error **errp)
157 {
158 SocketAddress *addr = NULL;
159
160 addr = qio_channel_socket_get_remote_address(ioc, errp);
161 if (!addr) {
162 return;
163 }
164
165 vnc_init_basic_info(addr, info, errp);
166 qapi_free_SocketAddress(addr);
167 }
168
169 static const char *vnc_auth_name(VncDisplay *vd) {
170 switch (vd->auth) {
171 case VNC_AUTH_INVALID:
172 return "invalid";
173 case VNC_AUTH_NONE:
174 return "none";
175 case VNC_AUTH_VNC:
176 return "vnc";
177 case VNC_AUTH_RA2:
178 return "ra2";
179 case VNC_AUTH_RA2NE:
180 return "ra2ne";
181 case VNC_AUTH_TIGHT:
182 return "tight";
183 case VNC_AUTH_ULTRA:
184 return "ultra";
185 case VNC_AUTH_TLS:
186 return "tls";
187 case VNC_AUTH_VENCRYPT:
188 switch (vd->subauth) {
189 case VNC_AUTH_VENCRYPT_PLAIN:
190 return "vencrypt+plain";
191 case VNC_AUTH_VENCRYPT_TLSNONE:
192 return "vencrypt+tls+none";
193 case VNC_AUTH_VENCRYPT_TLSVNC:
194 return "vencrypt+tls+vnc";
195 case VNC_AUTH_VENCRYPT_TLSPLAIN:
196 return "vencrypt+tls+plain";
197 case VNC_AUTH_VENCRYPT_X509NONE:
198 return "vencrypt+x509+none";
199 case VNC_AUTH_VENCRYPT_X509VNC:
200 return "vencrypt+x509+vnc";
201 case VNC_AUTH_VENCRYPT_X509PLAIN:
202 return "vencrypt+x509+plain";
203 case VNC_AUTH_VENCRYPT_TLSSASL:
204 return "vencrypt+tls+sasl";
205 case VNC_AUTH_VENCRYPT_X509SASL:
206 return "vencrypt+x509+sasl";
207 default:
208 return "vencrypt";
209 }
210 case VNC_AUTH_SASL:
211 return "sasl";
212 }
213 return "unknown";
214 }
215
216 static VncServerInfo *vnc_server_info_get(VncDisplay *vd)
217 {
218 VncServerInfo *info;
219 Error *err = NULL;
220
221 info = g_malloc(sizeof(*info));
222 vnc_init_basic_info_from_server_addr(vd->lsock,
223 qapi_VncServerInfo_base(info), &err);
224 info->has_auth = true;
225 info->auth = g_strdup(vnc_auth_name(vd));
226 if (err) {
227 qapi_free_VncServerInfo(info);
228 info = NULL;
229 error_free(err);
230 }
231 return info;
232 }
233
234 static void vnc_client_cache_auth(VncState *client)
235 {
236 if (!client->info) {
237 return;
238 }
239
240 if (client->tls) {
241 client->info->x509_dname =
242 qcrypto_tls_session_get_peer_name(client->tls);
243 client->info->has_x509_dname =
244 client->info->x509_dname != NULL;
245 }
246 #ifdef CONFIG_VNC_SASL
247 if (client->sasl.conn &&
248 client->sasl.username) {
249 client->info->has_sasl_username = true;
250 client->info->sasl_username = g_strdup(client->sasl.username);
251 }
252 #endif
253 }
254
255 static void vnc_client_cache_addr(VncState *client)
256 {
257 Error *err = NULL;
258
259 client->info = g_malloc0(sizeof(*client->info));
260 vnc_init_basic_info_from_remote_addr(client->sioc,
261 qapi_VncClientInfo_base(client->info),
262 &err);
263 if (err) {
264 qapi_free_VncClientInfo(client->info);
265 client->info = NULL;
266 error_free(err);
267 }
268 }
269
270 static void vnc_qmp_event(VncState *vs, QAPIEvent event)
271 {
272 VncServerInfo *si;
273
274 if (!vs->info) {
275 return;
276 }
277
278 si = vnc_server_info_get(vs->vd);
279 if (!si) {
280 return;
281 }
282
283 switch (event) {
284 case QAPI_EVENT_VNC_CONNECTED:
285 qapi_event_send_vnc_connected(si, qapi_VncClientInfo_base(vs->info),
286 &error_abort);
287 break;
288 case QAPI_EVENT_VNC_INITIALIZED:
289 qapi_event_send_vnc_initialized(si, vs->info, &error_abort);
290 break;
291 case QAPI_EVENT_VNC_DISCONNECTED:
292 qapi_event_send_vnc_disconnected(si, vs->info, &error_abort);
293 break;
294 default:
295 break;
296 }
297
298 qapi_free_VncServerInfo(si);
299 }
300
301 static VncClientInfo *qmp_query_vnc_client(const VncState *client)
302 {
303 VncClientInfo *info;
304 Error *err = NULL;
305
306 info = g_malloc0(sizeof(*info));
307
308 vnc_init_basic_info_from_remote_addr(client->sioc,
309 qapi_VncClientInfo_base(info),
310 &err);
311 if (err) {
312 error_free(err);
313 qapi_free_VncClientInfo(info);
314 return NULL;
315 }
316
317 info->websocket = client->websocket;
318
319 if (client->tls) {
320 info->x509_dname = qcrypto_tls_session_get_peer_name(client->tls);
321 info->has_x509_dname = info->x509_dname != NULL;
322 }
323 #ifdef CONFIG_VNC_SASL
324 if (client->sasl.conn && client->sasl.username) {
325 info->has_sasl_username = true;
326 info->sasl_username = g_strdup(client->sasl.username);
327 }
328 #endif
329
330 return info;
331 }
332
333 static VncDisplay *vnc_display_find(const char *id)
334 {
335 VncDisplay *vd;
336
337 if (id == NULL) {
338 return QTAILQ_FIRST(&vnc_displays);
339 }
340 QTAILQ_FOREACH(vd, &vnc_displays, next) {
341 if (strcmp(id, vd->id) == 0) {
342 return vd;
343 }
344 }
345 return NULL;
346 }
347
348 static VncClientInfoList *qmp_query_client_list(VncDisplay *vd)
349 {
350 VncClientInfoList *cinfo, *prev = NULL;
351 VncState *client;
352
353 QTAILQ_FOREACH(client, &vd->clients, next) {
354 cinfo = g_new0(VncClientInfoList, 1);
355 cinfo->value = qmp_query_vnc_client(client);
356 cinfo->next = prev;
357 prev = cinfo;
358 }
359 return prev;
360 }
361
362 VncInfo *qmp_query_vnc(Error **errp)
363 {
364 VncInfo *info = g_malloc0(sizeof(*info));
365 VncDisplay *vd = vnc_display_find(NULL);
366 SocketAddress *addr = NULL;
367
368 if (vd == NULL || !vd->enabled) {
369 info->enabled = false;
370 } else {
371 info->enabled = true;
372
373 /* for compatibility with the original command */
374 info->has_clients = true;
375 info->clients = qmp_query_client_list(vd);
376
377 if (vd->lsock == NULL) {
378 return info;
379 }
380
381 addr = qio_channel_socket_get_local_address(vd->lsock, errp);
382 if (!addr) {
383 goto out_error;
384 }
385
386 switch (addr->type) {
387 case SOCKET_ADDRESS_KIND_INET:
388 info->host = g_strdup(addr->u.inet->host);
389 info->service = g_strdup(addr->u.inet->port);
390 if (addr->u.inet->ipv6) {
391 info->family = NETWORK_ADDRESS_FAMILY_IPV6;
392 } else {
393 info->family = NETWORK_ADDRESS_FAMILY_IPV4;
394 }
395 break;
396
397 case SOCKET_ADDRESS_KIND_UNIX:
398 info->host = g_strdup("");
399 info->service = g_strdup(addr->u.q_unix->path);
400 info->family = NETWORK_ADDRESS_FAMILY_UNIX;
401 break;
402
403 default:
404 error_setg(errp, "Unsupported socket kind %d",
405 addr->type);
406 goto out_error;
407 }
408
409 info->has_host = true;
410 info->has_service = true;
411 info->has_family = true;
412
413 info->has_auth = true;
414 info->auth = g_strdup(vnc_auth_name(vd));
415 }
416
417 qapi_free_SocketAddress(addr);
418 return info;
419
420 out_error:
421 qapi_free_SocketAddress(addr);
422 qapi_free_VncInfo(info);
423 return NULL;
424 }
425
426 static VncBasicInfoList *qmp_query_server_entry(QIOChannelSocket *ioc,
427 bool websocket,
428 VncBasicInfoList *prev)
429 {
430 VncBasicInfoList *list;
431 VncBasicInfo *info;
432 Error *err = NULL;
433 SocketAddress *addr;
434
435 addr = qio_channel_socket_get_local_address(ioc, &err);
436 if (!addr) {
437 error_free(err);
438 return prev;
439 }
440
441 info = g_new0(VncBasicInfo, 1);
442 vnc_init_basic_info(addr, info, &err);
443 qapi_free_SocketAddress(addr);
444 if (err) {
445 qapi_free_VncBasicInfo(info);
446 error_free(err);
447 return prev;
448 }
449 info->websocket = websocket;
450
451 list = g_new0(VncBasicInfoList, 1);
452 list->value = info;
453 list->next = prev;
454 return list;
455 }
456
457 static void qmp_query_auth(VncDisplay *vd, VncInfo2 *info)
458 {
459 switch (vd->auth) {
460 case VNC_AUTH_VNC:
461 info->auth = VNC_PRIMARY_AUTH_VNC;
462 break;
463 case VNC_AUTH_RA2:
464 info->auth = VNC_PRIMARY_AUTH_RA2;
465 break;
466 case VNC_AUTH_RA2NE:
467 info->auth = VNC_PRIMARY_AUTH_RA2NE;
468 break;
469 case VNC_AUTH_TIGHT:
470 info->auth = VNC_PRIMARY_AUTH_TIGHT;
471 break;
472 case VNC_AUTH_ULTRA:
473 info->auth = VNC_PRIMARY_AUTH_ULTRA;
474 break;
475 case VNC_AUTH_TLS:
476 info->auth = VNC_PRIMARY_AUTH_TLS;
477 break;
478 case VNC_AUTH_VENCRYPT:
479 info->auth = VNC_PRIMARY_AUTH_VENCRYPT;
480 info->has_vencrypt = true;
481 switch (vd->subauth) {
482 case VNC_AUTH_VENCRYPT_PLAIN:
483 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_PLAIN;
484 break;
485 case VNC_AUTH_VENCRYPT_TLSNONE:
486 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_TLS_NONE;
487 break;
488 case VNC_AUTH_VENCRYPT_TLSVNC:
489 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_TLS_VNC;
490 break;
491 case VNC_AUTH_VENCRYPT_TLSPLAIN:
492 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_TLS_PLAIN;
493 break;
494 case VNC_AUTH_VENCRYPT_X509NONE:
495 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_X509_NONE;
496 break;
497 case VNC_AUTH_VENCRYPT_X509VNC:
498 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_X509_VNC;
499 break;
500 case VNC_AUTH_VENCRYPT_X509PLAIN:
501 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_X509_PLAIN;
502 break;
503 case VNC_AUTH_VENCRYPT_TLSSASL:
504 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_TLS_SASL;
505 break;
506 case VNC_AUTH_VENCRYPT_X509SASL:
507 info->vencrypt = VNC_VENCRYPT_SUB_AUTH_X509_SASL;
508 break;
509 default:
510 info->has_vencrypt = false;
511 break;
512 }
513 break;
514 case VNC_AUTH_SASL:
515 info->auth = VNC_PRIMARY_AUTH_SASL;
516 break;
517 case VNC_AUTH_NONE:
518 default:
519 info->auth = VNC_PRIMARY_AUTH_NONE;
520 break;
521 }
522 }
523
524 VncInfo2List *qmp_query_vnc_servers(Error **errp)
525 {
526 VncInfo2List *item, *prev = NULL;
527 VncInfo2 *info;
528 VncDisplay *vd;
529 DeviceState *dev;
530
531 QTAILQ_FOREACH(vd, &vnc_displays, next) {
532 info = g_new0(VncInfo2, 1);
533 info->id = g_strdup(vd->id);
534 info->clients = qmp_query_client_list(vd);
535 qmp_query_auth(vd, info);
536 if (vd->dcl.con) {
537 dev = DEVICE(object_property_get_link(OBJECT(vd->dcl.con),
538 "device", NULL));
539 info->has_display = true;
540 info->display = g_strdup(dev->id);
541 }
542 if (vd->lsock != NULL) {
543 info->server = qmp_query_server_entry(
544 vd->lsock, false, info->server);
545 }
546 if (vd->lwebsock != NULL) {
547 info->server = qmp_query_server_entry(
548 vd->lwebsock, true, info->server);
549 }
550
551 item = g_new0(VncInfo2List, 1);
552 item->value = info;
553 item->next = prev;
554 prev = item;
555 }
556 return prev;
557 }
558
559 /* TODO
560 1) Get the queue working for IO.
561 2) there is some weirdness when using the -S option (the screen is grey
562 and not totally invalidated
563 3) resolutions > 1024
564 */
565
566 static int vnc_update_client(VncState *vs, int has_dirty, bool sync);
567 static void vnc_disconnect_start(VncState *vs);
568
569 static void vnc_colordepth(VncState *vs);
570 static void framebuffer_update_request(VncState *vs, int incremental,
571 int x_position, int y_position,
572 int w, int h);
573 static void vnc_refresh(DisplayChangeListener *dcl);
574 static int vnc_refresh_server_surface(VncDisplay *vd);
575
576 static int vnc_width(VncDisplay *vd)
577 {
578 return MIN(VNC_MAX_WIDTH, ROUND_UP(surface_width(vd->ds),
579 VNC_DIRTY_PIXELS_PER_BIT));
580 }
581
582 static int vnc_height(VncDisplay *vd)
583 {
584 return MIN(VNC_MAX_HEIGHT, surface_height(vd->ds));
585 }
586
587 static void vnc_set_area_dirty(DECLARE_BITMAP(dirty[VNC_MAX_HEIGHT],
588 VNC_MAX_WIDTH / VNC_DIRTY_PIXELS_PER_BIT),
589 VncDisplay *vd,
590 int x, int y, int w, int h)
591 {
592 int width = vnc_width(vd);
593 int height = vnc_height(vd);
594
595 /* this is needed this to ensure we updated all affected
596 * blocks if x % VNC_DIRTY_PIXELS_PER_BIT != 0 */
597 w += (x % VNC_DIRTY_PIXELS_PER_BIT);
598 x -= (x % VNC_DIRTY_PIXELS_PER_BIT);
599
600 x = MIN(x, width);
601 y = MIN(y, height);
602 w = MIN(x + w, width) - x;
603 h = MIN(y + h, height);
604
605 for (; y < h; y++) {
606 bitmap_set(dirty[y], x / VNC_DIRTY_PIXELS_PER_BIT,
607 DIV_ROUND_UP(w, VNC_DIRTY_PIXELS_PER_BIT));
608 }
609 }
610
611 static void vnc_dpy_update(DisplayChangeListener *dcl,
612 int x, int y, int w, int h)
613 {
614 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
615 struct VncSurface *s = &vd->guest;
616
617 vnc_set_area_dirty(s->dirty, vd, x, y, w, h);
618 }
619
620 void vnc_framebuffer_update(VncState *vs, int x, int y, int w, int h,
621 int32_t encoding)
622 {
623 vnc_write_u16(vs, x);
624 vnc_write_u16(vs, y);
625 vnc_write_u16(vs, w);
626 vnc_write_u16(vs, h);
627
628 vnc_write_s32(vs, encoding);
629 }
630
631
632 static void vnc_desktop_resize(VncState *vs)
633 {
634 if (vs->ioc == NULL || !vnc_has_feature(vs, VNC_FEATURE_RESIZE)) {
635 return;
636 }
637 if (vs->client_width == pixman_image_get_width(vs->vd->server) &&
638 vs->client_height == pixman_image_get_height(vs->vd->server)) {
639 return;
640 }
641 vs->client_width = pixman_image_get_width(vs->vd->server);
642 vs->client_height = pixman_image_get_height(vs->vd->server);
643 vnc_lock_output(vs);
644 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
645 vnc_write_u8(vs, 0);
646 vnc_write_u16(vs, 1); /* number of rects */
647 vnc_framebuffer_update(vs, 0, 0, vs->client_width, vs->client_height,
648 VNC_ENCODING_DESKTOPRESIZE);
649 vnc_unlock_output(vs);
650 vnc_flush(vs);
651 }
652
653 static void vnc_abort_display_jobs(VncDisplay *vd)
654 {
655 VncState *vs;
656
657 QTAILQ_FOREACH(vs, &vd->clients, next) {
658 vnc_lock_output(vs);
659 vs->abort = true;
660 vnc_unlock_output(vs);
661 }
662 QTAILQ_FOREACH(vs, &vd->clients, next) {
663 vnc_jobs_join(vs);
664 }
665 QTAILQ_FOREACH(vs, &vd->clients, next) {
666 vnc_lock_output(vs);
667 vs->abort = false;
668 vnc_unlock_output(vs);
669 }
670 }
671
672 int vnc_server_fb_stride(VncDisplay *vd)
673 {
674 return pixman_image_get_stride(vd->server);
675 }
676
677 void *vnc_server_fb_ptr(VncDisplay *vd, int x, int y)
678 {
679 uint8_t *ptr;
680
681 ptr = (uint8_t *)pixman_image_get_data(vd->server);
682 ptr += y * vnc_server_fb_stride(vd);
683 ptr += x * VNC_SERVER_FB_BYTES;
684 return ptr;
685 }
686
687 static void vnc_update_server_surface(VncDisplay *vd)
688 {
689 qemu_pixman_image_unref(vd->server);
690 vd->server = NULL;
691
692 if (QTAILQ_EMPTY(&vd->clients)) {
693 return;
694 }
695
696 vd->server = pixman_image_create_bits(VNC_SERVER_FB_FORMAT,
697 vnc_width(vd),
698 vnc_height(vd),
699 NULL, 0);
700 }
701
702 static void vnc_dpy_switch(DisplayChangeListener *dcl,
703 DisplaySurface *surface)
704 {
705 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
706 VncState *vs;
707 int width, height;
708
709 vnc_abort_display_jobs(vd);
710 vd->ds = surface;
711
712 /* server surface */
713 vnc_update_server_surface(vd);
714
715 /* guest surface */
716 qemu_pixman_image_unref(vd->guest.fb);
717 vd->guest.fb = pixman_image_ref(surface->image);
718 vd->guest.format = surface->format;
719 width = vnc_width(vd);
720 height = vnc_height(vd);
721 memset(vd->guest.dirty, 0x00, sizeof(vd->guest.dirty));
722 vnc_set_area_dirty(vd->guest.dirty, vd, 0, 0,
723 width, height);
724
725 QTAILQ_FOREACH(vs, &vd->clients, next) {
726 vnc_colordepth(vs);
727 vnc_desktop_resize(vs);
728 if (vs->vd->cursor) {
729 vnc_cursor_define(vs);
730 }
731 memset(vs->dirty, 0x00, sizeof(vs->dirty));
732 vnc_set_area_dirty(vs->dirty, vd, 0, 0,
733 width, height);
734 }
735 }
736
737 /* fastest code */
738 static void vnc_write_pixels_copy(VncState *vs,
739 void *pixels, int size)
740 {
741 vnc_write(vs, pixels, size);
742 }
743
744 /* slowest but generic code. */
745 void vnc_convert_pixel(VncState *vs, uint8_t *buf, uint32_t v)
746 {
747 uint8_t r, g, b;
748
749 #if VNC_SERVER_FB_FORMAT == PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
750 r = (((v & 0x00ff0000) >> 16) << vs->client_pf.rbits) >> 8;
751 g = (((v & 0x0000ff00) >> 8) << vs->client_pf.gbits) >> 8;
752 b = (((v & 0x000000ff) >> 0) << vs->client_pf.bbits) >> 8;
753 #else
754 # error need some bits here if you change VNC_SERVER_FB_FORMAT
755 #endif
756 v = (r << vs->client_pf.rshift) |
757 (g << vs->client_pf.gshift) |
758 (b << vs->client_pf.bshift);
759 switch (vs->client_pf.bytes_per_pixel) {
760 case 1:
761 buf[0] = v;
762 break;
763 case 2:
764 if (vs->client_be) {
765 buf[0] = v >> 8;
766 buf[1] = v;
767 } else {
768 buf[1] = v >> 8;
769 buf[0] = v;
770 }
771 break;
772 default:
773 case 4:
774 if (vs->client_be) {
775 buf[0] = v >> 24;
776 buf[1] = v >> 16;
777 buf[2] = v >> 8;
778 buf[3] = v;
779 } else {
780 buf[3] = v >> 24;
781 buf[2] = v >> 16;
782 buf[1] = v >> 8;
783 buf[0] = v;
784 }
785 break;
786 }
787 }
788
789 static void vnc_write_pixels_generic(VncState *vs,
790 void *pixels1, int size)
791 {
792 uint8_t buf[4];
793
794 if (VNC_SERVER_FB_BYTES == 4) {
795 uint32_t *pixels = pixels1;
796 int n, i;
797 n = size >> 2;
798 for (i = 0; i < n; i++) {
799 vnc_convert_pixel(vs, buf, pixels[i]);
800 vnc_write(vs, buf, vs->client_pf.bytes_per_pixel);
801 }
802 }
803 }
804
805 int vnc_raw_send_framebuffer_update(VncState *vs, int x, int y, int w, int h)
806 {
807 int i;
808 uint8_t *row;
809 VncDisplay *vd = vs->vd;
810
811 row = vnc_server_fb_ptr(vd, x, y);
812 for (i = 0; i < h; i++) {
813 vs->write_pixels(vs, row, w * VNC_SERVER_FB_BYTES);
814 row += vnc_server_fb_stride(vd);
815 }
816 return 1;
817 }
818
819 int vnc_send_framebuffer_update(VncState *vs, int x, int y, int w, int h)
820 {
821 int n = 0;
822 bool encode_raw = false;
823 size_t saved_offs = vs->output.offset;
824
825 switch(vs->vnc_encoding) {
826 case VNC_ENCODING_ZLIB:
827 n = vnc_zlib_send_framebuffer_update(vs, x, y, w, h);
828 break;
829 case VNC_ENCODING_HEXTILE:
830 vnc_framebuffer_update(vs, x, y, w, h, VNC_ENCODING_HEXTILE);
831 n = vnc_hextile_send_framebuffer_update(vs, x, y, w, h);
832 break;
833 case VNC_ENCODING_TIGHT:
834 n = vnc_tight_send_framebuffer_update(vs, x, y, w, h);
835 break;
836 case VNC_ENCODING_TIGHT_PNG:
837 n = vnc_tight_png_send_framebuffer_update(vs, x, y, w, h);
838 break;
839 case VNC_ENCODING_ZRLE:
840 n = vnc_zrle_send_framebuffer_update(vs, x, y, w, h);
841 break;
842 case VNC_ENCODING_ZYWRLE:
843 n = vnc_zywrle_send_framebuffer_update(vs, x, y, w, h);
844 break;
845 default:
846 encode_raw = true;
847 break;
848 }
849
850 /* If the client has the same pixel format as our internal buffer and
851 * a RAW encoding would need less space fall back to RAW encoding to
852 * save bandwidth and processing power in the client. */
853 if (!encode_raw && vs->write_pixels == vnc_write_pixels_copy &&
854 12 + h * w * VNC_SERVER_FB_BYTES <= (vs->output.offset - saved_offs)) {
855 vs->output.offset = saved_offs;
856 encode_raw = true;
857 }
858
859 if (encode_raw) {
860 vnc_framebuffer_update(vs, x, y, w, h, VNC_ENCODING_RAW);
861 n = vnc_raw_send_framebuffer_update(vs, x, y, w, h);
862 }
863
864 return n;
865 }
866
867 static void vnc_copy(VncState *vs, int src_x, int src_y, int dst_x, int dst_y, int w, int h)
868 {
869 /* send bitblit op to the vnc client */
870 vnc_lock_output(vs);
871 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
872 vnc_write_u8(vs, 0);
873 vnc_write_u16(vs, 1); /* number of rects */
874 vnc_framebuffer_update(vs, dst_x, dst_y, w, h, VNC_ENCODING_COPYRECT);
875 vnc_write_u16(vs, src_x);
876 vnc_write_u16(vs, src_y);
877 vnc_unlock_output(vs);
878 vnc_flush(vs);
879 }
880
881 static void vnc_dpy_copy(DisplayChangeListener *dcl,
882 int src_x, int src_y,
883 int dst_x, int dst_y, int w, int h)
884 {
885 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
886 VncState *vs, *vn;
887 uint8_t *src_row;
888 uint8_t *dst_row;
889 int i, x, y, pitch, inc, w_lim, s;
890 int cmp_bytes;
891
892 if (!vd->server) {
893 /* no client connected */
894 return;
895 }
896
897 vnc_refresh_server_surface(vd);
898 QTAILQ_FOREACH_SAFE(vs, &vd->clients, next, vn) {
899 if (vnc_has_feature(vs, VNC_FEATURE_COPYRECT)) {
900 vs->force_update = 1;
901 vnc_update_client(vs, 1, true);
902 /* vs might be free()ed here */
903 }
904 }
905
906 /* do bitblit op on the local surface too */
907 pitch = vnc_server_fb_stride(vd);
908 src_row = vnc_server_fb_ptr(vd, src_x, src_y);
909 dst_row = vnc_server_fb_ptr(vd, dst_x, dst_y);
910 y = dst_y;
911 inc = 1;
912 if (dst_y > src_y) {
913 /* copy backwards */
914 src_row += pitch * (h-1);
915 dst_row += pitch * (h-1);
916 pitch = -pitch;
917 y = dst_y + h - 1;
918 inc = -1;
919 }
920 w_lim = w - (VNC_DIRTY_PIXELS_PER_BIT - (dst_x % VNC_DIRTY_PIXELS_PER_BIT));
921 if (w_lim < 0) {
922 w_lim = w;
923 } else {
924 w_lim = w - (w_lim % VNC_DIRTY_PIXELS_PER_BIT);
925 }
926 for (i = 0; i < h; i++) {
927 for (x = 0; x <= w_lim;
928 x += s, src_row += cmp_bytes, dst_row += cmp_bytes) {
929 if (x == w_lim) {
930 if ((s = w - w_lim) == 0)
931 break;
932 } else if (!x) {
933 s = (VNC_DIRTY_PIXELS_PER_BIT -
934 (dst_x % VNC_DIRTY_PIXELS_PER_BIT));
935 s = MIN(s, w_lim);
936 } else {
937 s = VNC_DIRTY_PIXELS_PER_BIT;
938 }
939 cmp_bytes = s * VNC_SERVER_FB_BYTES;
940 if (memcmp(src_row, dst_row, cmp_bytes) == 0)
941 continue;
942 memmove(dst_row, src_row, cmp_bytes);
943 QTAILQ_FOREACH(vs, &vd->clients, next) {
944 if (!vnc_has_feature(vs, VNC_FEATURE_COPYRECT)) {
945 set_bit(((x + dst_x) / VNC_DIRTY_PIXELS_PER_BIT),
946 vs->dirty[y]);
947 }
948 }
949 }
950 src_row += pitch - w * VNC_SERVER_FB_BYTES;
951 dst_row += pitch - w * VNC_SERVER_FB_BYTES;
952 y += inc;
953 }
954
955 QTAILQ_FOREACH(vs, &vd->clients, next) {
956 if (vnc_has_feature(vs, VNC_FEATURE_COPYRECT)) {
957 vnc_copy(vs, src_x, src_y, dst_x, dst_y, w, h);
958 }
959 }
960 }
961
962 static void vnc_mouse_set(DisplayChangeListener *dcl,
963 int x, int y, int visible)
964 {
965 /* can we ask the client(s) to move the pointer ??? */
966 }
967
968 static int vnc_cursor_define(VncState *vs)
969 {
970 QEMUCursor *c = vs->vd->cursor;
971 int isize;
972
973 if (vnc_has_feature(vs, VNC_FEATURE_RICH_CURSOR)) {
974 vnc_lock_output(vs);
975 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
976 vnc_write_u8(vs, 0); /* padding */
977 vnc_write_u16(vs, 1); /* # of rects */
978 vnc_framebuffer_update(vs, c->hot_x, c->hot_y, c->width, c->height,
979 VNC_ENCODING_RICH_CURSOR);
980 isize = c->width * c->height * vs->client_pf.bytes_per_pixel;
981 vnc_write_pixels_generic(vs, c->data, isize);
982 vnc_write(vs, vs->vd->cursor_mask, vs->vd->cursor_msize);
983 vnc_unlock_output(vs);
984 return 0;
985 }
986 return -1;
987 }
988
989 static void vnc_dpy_cursor_define(DisplayChangeListener *dcl,
990 QEMUCursor *c)
991 {
992 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
993 VncState *vs;
994
995 cursor_put(vd->cursor);
996 g_free(vd->cursor_mask);
997
998 vd->cursor = c;
999 cursor_get(vd->cursor);
1000 vd->cursor_msize = cursor_get_mono_bpl(c) * c->height;
1001 vd->cursor_mask = g_malloc0(vd->cursor_msize);
1002 cursor_get_mono_mask(c, 0, vd->cursor_mask);
1003
1004 QTAILQ_FOREACH(vs, &vd->clients, next) {
1005 vnc_cursor_define(vs);
1006 }
1007 }
1008
1009 static int find_and_clear_dirty_height(VncState *vs,
1010 int y, int last_x, int x, int height)
1011 {
1012 int h;
1013
1014 for (h = 1; h < (height - y); h++) {
1015 if (!test_bit(last_x, vs->dirty[y + h])) {
1016 break;
1017 }
1018 bitmap_clear(vs->dirty[y + h], last_x, x - last_x);
1019 }
1020
1021 return h;
1022 }
1023
1024 static int vnc_update_client(VncState *vs, int has_dirty, bool sync)
1025 {
1026 vs->has_dirty += has_dirty;
1027 if (vs->need_update && vs->ioc != NULL) {
1028 VncDisplay *vd = vs->vd;
1029 VncJob *job;
1030 int y;
1031 int height, width;
1032 int n = 0;
1033
1034 if (vs->output.offset && !vs->audio_cap && !vs->force_update)
1035 /* kernel send buffers are full -> drop frames to throttle */
1036 return 0;
1037
1038 if (!vs->has_dirty && !vs->audio_cap && !vs->force_update)
1039 return 0;
1040
1041 /*
1042 * Send screen updates to the vnc client using the server
1043 * surface and server dirty map. guest surface updates
1044 * happening in parallel don't disturb us, the next pass will
1045 * send them to the client.
1046 */
1047 job = vnc_job_new(vs);
1048
1049 height = pixman_image_get_height(vd->server);
1050 width = pixman_image_get_width(vd->server);
1051
1052 y = 0;
1053 for (;;) {
1054 int x, h;
1055 unsigned long x2;
1056 unsigned long offset = find_next_bit((unsigned long *) &vs->dirty,
1057 height * VNC_DIRTY_BPL(vs),
1058 y * VNC_DIRTY_BPL(vs));
1059 if (offset == height * VNC_DIRTY_BPL(vs)) {
1060 /* no more dirty bits */
1061 break;
1062 }
1063 y = offset / VNC_DIRTY_BPL(vs);
1064 x = offset % VNC_DIRTY_BPL(vs);
1065 x2 = find_next_zero_bit((unsigned long *) &vs->dirty[y],
1066 VNC_DIRTY_BPL(vs), x);
1067 bitmap_clear(vs->dirty[y], x, x2 - x);
1068 h = find_and_clear_dirty_height(vs, y, x, x2, height);
1069 x2 = MIN(x2, width / VNC_DIRTY_PIXELS_PER_BIT);
1070 if (x2 > x) {
1071 n += vnc_job_add_rect(job, x * VNC_DIRTY_PIXELS_PER_BIT, y,
1072 (x2 - x) * VNC_DIRTY_PIXELS_PER_BIT, h);
1073 }
1074 if (!x && x2 == width / VNC_DIRTY_PIXELS_PER_BIT) {
1075 y += h;
1076 if (y == height) {
1077 break;
1078 }
1079 }
1080 }
1081
1082 vnc_job_push(job);
1083 if (sync) {
1084 vnc_jobs_join(vs);
1085 }
1086 vs->force_update = 0;
1087 vs->has_dirty = 0;
1088 return n;
1089 }
1090
1091 if (vs->disconnecting) {
1092 vnc_disconnect_finish(vs);
1093 } else if (sync) {
1094 vnc_jobs_join(vs);
1095 }
1096
1097 return 0;
1098 }
1099
1100 /* audio */
1101 static void audio_capture_notify(void *opaque, audcnotification_e cmd)
1102 {
1103 VncState *vs = opaque;
1104
1105 switch (cmd) {
1106 case AUD_CNOTIFY_DISABLE:
1107 vnc_lock_output(vs);
1108 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU);
1109 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU_AUDIO);
1110 vnc_write_u16(vs, VNC_MSG_SERVER_QEMU_AUDIO_END);
1111 vnc_unlock_output(vs);
1112 vnc_flush(vs);
1113 break;
1114
1115 case AUD_CNOTIFY_ENABLE:
1116 vnc_lock_output(vs);
1117 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU);
1118 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU_AUDIO);
1119 vnc_write_u16(vs, VNC_MSG_SERVER_QEMU_AUDIO_BEGIN);
1120 vnc_unlock_output(vs);
1121 vnc_flush(vs);
1122 break;
1123 }
1124 }
1125
1126 static void audio_capture_destroy(void *opaque)
1127 {
1128 }
1129
1130 static void audio_capture(void *opaque, void *buf, int size)
1131 {
1132 VncState *vs = opaque;
1133
1134 vnc_lock_output(vs);
1135 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU);
1136 vnc_write_u8(vs, VNC_MSG_SERVER_QEMU_AUDIO);
1137 vnc_write_u16(vs, VNC_MSG_SERVER_QEMU_AUDIO_DATA);
1138 vnc_write_u32(vs, size);
1139 vnc_write(vs, buf, size);
1140 vnc_unlock_output(vs);
1141 vnc_flush(vs);
1142 }
1143
1144 static void audio_add(VncState *vs)
1145 {
1146 struct audio_capture_ops ops;
1147
1148 if (vs->audio_cap) {
1149 error_report("audio already running");
1150 return;
1151 }
1152
1153 ops.notify = audio_capture_notify;
1154 ops.destroy = audio_capture_destroy;
1155 ops.capture = audio_capture;
1156
1157 vs->audio_cap = AUD_add_capture(&vs->as, &ops, vs);
1158 if (!vs->audio_cap) {
1159 error_report("Failed to add audio capture");
1160 }
1161 }
1162
1163 static void audio_del(VncState *vs)
1164 {
1165 if (vs->audio_cap) {
1166 AUD_del_capture(vs->audio_cap, vs);
1167 vs->audio_cap = NULL;
1168 }
1169 }
1170
1171 static void vnc_disconnect_start(VncState *vs)
1172 {
1173 if (vs->disconnecting) {
1174 return;
1175 }
1176 vnc_set_share_mode(vs, VNC_SHARE_MODE_DISCONNECTED);
1177 if (vs->ioc_tag) {
1178 g_source_remove(vs->ioc_tag);
1179 }
1180 qio_channel_close(vs->ioc, NULL);
1181 vs->disconnecting = TRUE;
1182 }
1183
1184 void vnc_disconnect_finish(VncState *vs)
1185 {
1186 int i;
1187
1188 vnc_jobs_join(vs); /* Wait encoding jobs */
1189
1190 vnc_lock_output(vs);
1191 vnc_qmp_event(vs, QAPI_EVENT_VNC_DISCONNECTED);
1192
1193 buffer_free(&vs->input);
1194 buffer_free(&vs->output);
1195 buffer_free(&vs->ws_input);
1196 buffer_free(&vs->ws_output);
1197
1198 qapi_free_VncClientInfo(vs->info);
1199
1200 vnc_zlib_clear(vs);
1201 vnc_tight_clear(vs);
1202 vnc_zrle_clear(vs);
1203
1204 #ifdef CONFIG_VNC_SASL
1205 vnc_sasl_client_cleanup(vs);
1206 #endif /* CONFIG_VNC_SASL */
1207 audio_del(vs);
1208 vnc_release_modifiers(vs);
1209
1210 if (vs->initialized) {
1211 QTAILQ_REMOVE(&vs->vd->clients, vs, next);
1212 qemu_remove_mouse_mode_change_notifier(&vs->mouse_mode_notifier);
1213 if (QTAILQ_EMPTY(&vs->vd->clients)) {
1214 /* last client gone */
1215 vnc_update_server_surface(vs->vd);
1216 }
1217 }
1218
1219 if (vs->vd->lock_key_sync)
1220 qemu_remove_led_event_handler(vs->led);
1221 vnc_unlock_output(vs);
1222
1223 qemu_mutex_destroy(&vs->output_mutex);
1224 if (vs->bh != NULL) {
1225 qemu_bh_delete(vs->bh);
1226 }
1227 buffer_free(&vs->jobs_buffer);
1228
1229 for (i = 0; i < VNC_STAT_ROWS; ++i) {
1230 g_free(vs->lossy_rect[i]);
1231 }
1232 g_free(vs->lossy_rect);
1233
1234 object_unref(OBJECT(vs->ioc));
1235 vs->ioc = NULL;
1236 object_unref(OBJECT(vs->sioc));
1237 vs->sioc = NULL;
1238 g_free(vs);
1239 }
1240
1241 ssize_t vnc_client_io_error(VncState *vs, ssize_t ret, Error **errp)
1242 {
1243 if (ret <= 0) {
1244 if (ret == 0) {
1245 VNC_DEBUG("Closing down client sock: EOF\n");
1246 } else if (ret != QIO_CHANNEL_ERR_BLOCK) {
1247 VNC_DEBUG("Closing down client sock: ret %d (%s)\n",
1248 ret, errp ? error_get_pretty(*errp) : "Unknown");
1249 }
1250
1251 vnc_disconnect_start(vs);
1252 if (errp) {
1253 error_free(*errp);
1254 *errp = NULL;
1255 }
1256 return 0;
1257 }
1258 return ret;
1259 }
1260
1261
1262 void vnc_client_error(VncState *vs)
1263 {
1264 VNC_DEBUG("Closing down client sock: protocol error\n");
1265 vnc_disconnect_start(vs);
1266 }
1267
1268
1269 /*
1270 * Called to write a chunk of data to the client socket. The data may
1271 * be the raw data, or may have already been encoded by SASL.
1272 * The data will be written either straight onto the socket, or
1273 * written via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1274 *
1275 * NB, it is theoretically possible to have 2 layers of encryption,
1276 * both SASL, and this TLS layer. It is highly unlikely in practice
1277 * though, since SASL encryption will typically be a no-op if TLS
1278 * is active
1279 *
1280 * Returns the number of bytes written, which may be less than
1281 * the requested 'datalen' if the socket would block. Returns
1282 * -1 on error, and disconnects the client socket.
1283 */
1284 ssize_t vnc_client_write_buf(VncState *vs, const uint8_t *data, size_t datalen)
1285 {
1286 Error *err = NULL;
1287 ssize_t ret;
1288 ret = qio_channel_write(
1289 vs->ioc, (const char *)data, datalen, &err);
1290 VNC_DEBUG("Wrote wire %p %zd -> %ld\n", data, datalen, ret);
1291 return vnc_client_io_error(vs, ret, &err);
1292 }
1293
1294
1295 /*
1296 * Called to write buffered data to the client socket, when not
1297 * using any SASL SSF encryption layers. Will write as much data
1298 * as possible without blocking. If all buffered data is written,
1299 * will switch the FD poll() handler back to read monitoring.
1300 *
1301 * Returns the number of bytes written, which may be less than
1302 * the buffered output data if the socket would block. Returns
1303 * -1 on error, and disconnects the client socket.
1304 */
1305 static ssize_t vnc_client_write_plain(VncState *vs)
1306 {
1307 ssize_t ret;
1308
1309 #ifdef CONFIG_VNC_SASL
1310 VNC_DEBUG("Write Plain: Pending output %p size %zd offset %zd. Wait SSF %d\n",
1311 vs->output.buffer, vs->output.capacity, vs->output.offset,
1312 vs->sasl.waitWriteSSF);
1313
1314 if (vs->sasl.conn &&
1315 vs->sasl.runSSF &&
1316 vs->sasl.waitWriteSSF) {
1317 ret = vnc_client_write_buf(vs, vs->output.buffer, vs->sasl.waitWriteSSF);
1318 if (ret)
1319 vs->sasl.waitWriteSSF -= ret;
1320 } else
1321 #endif /* CONFIG_VNC_SASL */
1322 ret = vnc_client_write_buf(vs, vs->output.buffer, vs->output.offset);
1323 if (!ret)
1324 return 0;
1325
1326 buffer_advance(&vs->output, ret);
1327
1328 if (vs->output.offset == 0) {
1329 if (vs->ioc_tag) {
1330 g_source_remove(vs->ioc_tag);
1331 }
1332 vs->ioc_tag = qio_channel_add_watch(
1333 vs->ioc, G_IO_IN, vnc_client_io, vs, NULL);
1334 }
1335
1336 return ret;
1337 }
1338
1339
1340 /*
1341 * First function called whenever there is data to be written to
1342 * the client socket. Will delegate actual work according to whether
1343 * SASL SSF layers are enabled (thus requiring encryption calls)
1344 */
1345 static void vnc_client_write_locked(VncState *vs)
1346 {
1347 #ifdef CONFIG_VNC_SASL
1348 if (vs->sasl.conn &&
1349 vs->sasl.runSSF &&
1350 !vs->sasl.waitWriteSSF) {
1351 vnc_client_write_sasl(vs);
1352 } else
1353 #endif /* CONFIG_VNC_SASL */
1354 {
1355 if (vs->encode_ws) {
1356 vnc_client_write_ws(vs);
1357 } else {
1358 vnc_client_write_plain(vs);
1359 }
1360 }
1361 }
1362
1363 static void vnc_client_write(VncState *vs)
1364 {
1365
1366 vnc_lock_output(vs);
1367 if (vs->output.offset || vs->ws_output.offset) {
1368 vnc_client_write_locked(vs);
1369 } else if (vs->ioc != NULL) {
1370 if (vs->ioc_tag) {
1371 g_source_remove(vs->ioc_tag);
1372 }
1373 vs->ioc_tag = qio_channel_add_watch(
1374 vs->ioc, G_IO_IN, vnc_client_io, vs, NULL);
1375 }
1376 vnc_unlock_output(vs);
1377 }
1378
1379 void vnc_read_when(VncState *vs, VncReadEvent *func, size_t expecting)
1380 {
1381 vs->read_handler = func;
1382 vs->read_handler_expect = expecting;
1383 }
1384
1385
1386 /*
1387 * Called to read a chunk of data from the client socket. The data may
1388 * be the raw data, or may need to be further decoded by SASL.
1389 * The data will be read either straight from to the socket, or
1390 * read via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1391 *
1392 * NB, it is theoretically possible to have 2 layers of encryption,
1393 * both SASL, and this TLS layer. It is highly unlikely in practice
1394 * though, since SASL encryption will typically be a no-op if TLS
1395 * is active
1396 *
1397 * Returns the number of bytes read, which may be less than
1398 * the requested 'datalen' if the socket would block. Returns
1399 * -1 on error, and disconnects the client socket.
1400 */
1401 ssize_t vnc_client_read_buf(VncState *vs, uint8_t *data, size_t datalen)
1402 {
1403 ssize_t ret;
1404 Error *err = NULL;
1405 ret = qio_channel_read(
1406 vs->ioc, (char *)data, datalen, &err);
1407 VNC_DEBUG("Read wire %p %zd -> %ld\n", data, datalen, ret);
1408 return vnc_client_io_error(vs, ret, &err);
1409 }
1410
1411
1412 /*
1413 * Called to read data from the client socket to the input buffer,
1414 * when not using any SASL SSF encryption layers. Will read as much
1415 * data as possible without blocking.
1416 *
1417 * Returns the number of bytes read. Returns -1 on error, and
1418 * disconnects the client socket.
1419 */
1420 static ssize_t vnc_client_read_plain(VncState *vs)
1421 {
1422 ssize_t ret;
1423 VNC_DEBUG("Read plain %p size %zd offset %zd\n",
1424 vs->input.buffer, vs->input.capacity, vs->input.offset);
1425 buffer_reserve(&vs->input, 4096);
1426 ret = vnc_client_read_buf(vs, buffer_end(&vs->input), 4096);
1427 if (!ret)
1428 return 0;
1429 vs->input.offset += ret;
1430 return ret;
1431 }
1432
1433 static void vnc_jobs_bh(void *opaque)
1434 {
1435 VncState *vs = opaque;
1436
1437 vnc_jobs_consume_buffer(vs);
1438 }
1439
1440 /*
1441 * First function called whenever there is more data to be read from
1442 * the client socket. Will delegate actual work according to whether
1443 * SASL SSF layers are enabled (thus requiring decryption calls)
1444 */
1445 static void vnc_client_read(VncState *vs)
1446 {
1447 ssize_t ret;
1448
1449 #ifdef CONFIG_VNC_SASL
1450 if (vs->sasl.conn && vs->sasl.runSSF)
1451 ret = vnc_client_read_sasl(vs);
1452 else
1453 #endif /* CONFIG_VNC_SASL */
1454 if (vs->encode_ws) {
1455 ret = vnc_client_read_ws(vs);
1456 if (ret == -1) {
1457 vnc_disconnect_start(vs);
1458 return;
1459 } else if (ret == -2) {
1460 vnc_client_error(vs);
1461 return;
1462 }
1463 } else {
1464 ret = vnc_client_read_plain(vs);
1465 }
1466 if (!ret) {
1467 if (vs->disconnecting) {
1468 vnc_disconnect_finish(vs);
1469 }
1470 return;
1471 }
1472
1473 while (vs->read_handler && vs->input.offset >= vs->read_handler_expect) {
1474 size_t len = vs->read_handler_expect;
1475 int ret;
1476
1477 ret = vs->read_handler(vs, vs->input.buffer, len);
1478 if (vs->disconnecting) {
1479 vnc_disconnect_finish(vs);
1480 return;
1481 }
1482
1483 if (!ret) {
1484 buffer_advance(&vs->input, len);
1485 } else {
1486 vs->read_handler_expect = ret;
1487 }
1488 }
1489 }
1490
1491 gboolean vnc_client_io(QIOChannel *ioc G_GNUC_UNUSED,
1492 GIOCondition condition, void *opaque)
1493 {
1494 VncState *vs = opaque;
1495 if (condition & G_IO_IN) {
1496 vnc_client_read(vs);
1497 }
1498 if (condition & G_IO_OUT) {
1499 vnc_client_write(vs);
1500 }
1501 return TRUE;
1502 }
1503
1504
1505 void vnc_write(VncState *vs, const void *data, size_t len)
1506 {
1507 buffer_reserve(&vs->output, len);
1508
1509 if (vs->ioc != NULL && buffer_empty(&vs->output)) {
1510 if (vs->ioc_tag) {
1511 g_source_remove(vs->ioc_tag);
1512 }
1513 vs->ioc_tag = qio_channel_add_watch(
1514 vs->ioc, G_IO_IN | G_IO_OUT, vnc_client_io, vs, NULL);
1515 }
1516
1517 buffer_append(&vs->output, data, len);
1518 }
1519
1520 void vnc_write_s32(VncState *vs, int32_t value)
1521 {
1522 vnc_write_u32(vs, *(uint32_t *)&value);
1523 }
1524
1525 void vnc_write_u32(VncState *vs, uint32_t value)
1526 {
1527 uint8_t buf[4];
1528
1529 buf[0] = (value >> 24) & 0xFF;
1530 buf[1] = (value >> 16) & 0xFF;
1531 buf[2] = (value >> 8) & 0xFF;
1532 buf[3] = value & 0xFF;
1533
1534 vnc_write(vs, buf, 4);
1535 }
1536
1537 void vnc_write_u16(VncState *vs, uint16_t value)
1538 {
1539 uint8_t buf[2];
1540
1541 buf[0] = (value >> 8) & 0xFF;
1542 buf[1] = value & 0xFF;
1543
1544 vnc_write(vs, buf, 2);
1545 }
1546
1547 void vnc_write_u8(VncState *vs, uint8_t value)
1548 {
1549 vnc_write(vs, (char *)&value, 1);
1550 }
1551
1552 void vnc_flush(VncState *vs)
1553 {
1554 vnc_lock_output(vs);
1555 if (vs->ioc != NULL && (vs->output.offset || vs->ws_output.offset)) {
1556 vnc_client_write_locked(vs);
1557 }
1558 vnc_unlock_output(vs);
1559 }
1560
1561 static uint8_t read_u8(uint8_t *data, size_t offset)
1562 {
1563 return data[offset];
1564 }
1565
1566 static uint16_t read_u16(uint8_t *data, size_t offset)
1567 {
1568 return ((data[offset] & 0xFF) << 8) | (data[offset + 1] & 0xFF);
1569 }
1570
1571 static int32_t read_s32(uint8_t *data, size_t offset)
1572 {
1573 return (int32_t)((data[offset] << 24) | (data[offset + 1] << 16) |
1574 (data[offset + 2] << 8) | data[offset + 3]);
1575 }
1576
1577 uint32_t read_u32(uint8_t *data, size_t offset)
1578 {
1579 return ((data[offset] << 24) | (data[offset + 1] << 16) |
1580 (data[offset + 2] << 8) | data[offset + 3]);
1581 }
1582
1583 static void client_cut_text(VncState *vs, size_t len, uint8_t *text)
1584 {
1585 }
1586
1587 static void check_pointer_type_change(Notifier *notifier, void *data)
1588 {
1589 VncState *vs = container_of(notifier, VncState, mouse_mode_notifier);
1590 int absolute = qemu_input_is_absolute();
1591
1592 if (vnc_has_feature(vs, VNC_FEATURE_POINTER_TYPE_CHANGE) && vs->absolute != absolute) {
1593 vnc_lock_output(vs);
1594 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
1595 vnc_write_u8(vs, 0);
1596 vnc_write_u16(vs, 1);
1597 vnc_framebuffer_update(vs, absolute, 0,
1598 pixman_image_get_width(vs->vd->server),
1599 pixman_image_get_height(vs->vd->server),
1600 VNC_ENCODING_POINTER_TYPE_CHANGE);
1601 vnc_unlock_output(vs);
1602 vnc_flush(vs);
1603 }
1604 vs->absolute = absolute;
1605 }
1606
1607 static void pointer_event(VncState *vs, int button_mask, int x, int y)
1608 {
1609 static uint32_t bmap[INPUT_BUTTON__MAX] = {
1610 [INPUT_BUTTON_LEFT] = 0x01,
1611 [INPUT_BUTTON_MIDDLE] = 0x02,
1612 [INPUT_BUTTON_RIGHT] = 0x04,
1613 [INPUT_BUTTON_WHEELUP] = 0x08,
1614 [INPUT_BUTTON_WHEELDOWN] = 0x10,
1615 };
1616 QemuConsole *con = vs->vd->dcl.con;
1617 int width = pixman_image_get_width(vs->vd->server);
1618 int height = pixman_image_get_height(vs->vd->server);
1619
1620 if (vs->last_bmask != button_mask) {
1621 qemu_input_update_buttons(con, bmap, vs->last_bmask, button_mask);
1622 vs->last_bmask = button_mask;
1623 }
1624
1625 if (vs->absolute) {
1626 qemu_input_queue_abs(con, INPUT_AXIS_X, x, width);
1627 qemu_input_queue_abs(con, INPUT_AXIS_Y, y, height);
1628 } else if (vnc_has_feature(vs, VNC_FEATURE_POINTER_TYPE_CHANGE)) {
1629 qemu_input_queue_rel(con, INPUT_AXIS_X, x - 0x7FFF);
1630 qemu_input_queue_rel(con, INPUT_AXIS_Y, y - 0x7FFF);
1631 } else {
1632 if (vs->last_x != -1) {
1633 qemu_input_queue_rel(con, INPUT_AXIS_X, x - vs->last_x);
1634 qemu_input_queue_rel(con, INPUT_AXIS_Y, y - vs->last_y);
1635 }
1636 vs->last_x = x;
1637 vs->last_y = y;
1638 }
1639 qemu_input_event_sync();
1640 }
1641
1642 static void reset_keys(VncState *vs)
1643 {
1644 int i;
1645 for(i = 0; i < 256; i++) {
1646 if (vs->modifiers_state[i]) {
1647 qemu_input_event_send_key_number(vs->vd->dcl.con, i, false);
1648 vs->modifiers_state[i] = 0;
1649 }
1650 }
1651 }
1652
1653 static void press_key(VncState *vs, int keysym)
1654 {
1655 int keycode = keysym2scancode(vs->vd->kbd_layout, keysym) & SCANCODE_KEYMASK;
1656 qemu_input_event_send_key_number(vs->vd->dcl.con, keycode, true);
1657 qemu_input_event_send_key_delay(0);
1658 qemu_input_event_send_key_number(vs->vd->dcl.con, keycode, false);
1659 qemu_input_event_send_key_delay(0);
1660 }
1661
1662 static int current_led_state(VncState *vs)
1663 {
1664 int ledstate = 0;
1665
1666 if (vs->modifiers_state[0x46]) {
1667 ledstate |= QEMU_SCROLL_LOCK_LED;
1668 }
1669 if (vs->modifiers_state[0x45]) {
1670 ledstate |= QEMU_NUM_LOCK_LED;
1671 }
1672 if (vs->modifiers_state[0x3a]) {
1673 ledstate |= QEMU_CAPS_LOCK_LED;
1674 }
1675
1676 return ledstate;
1677 }
1678
1679 static void vnc_led_state_change(VncState *vs)
1680 {
1681 int ledstate = 0;
1682
1683 if (!vnc_has_feature(vs, VNC_FEATURE_LED_STATE)) {
1684 return;
1685 }
1686
1687 ledstate = current_led_state(vs);
1688 vnc_lock_output(vs);
1689 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
1690 vnc_write_u8(vs, 0);
1691 vnc_write_u16(vs, 1);
1692 vnc_framebuffer_update(vs, 0, 0, 1, 1, VNC_ENCODING_LED_STATE);
1693 vnc_write_u8(vs, ledstate);
1694 vnc_unlock_output(vs);
1695 vnc_flush(vs);
1696 }
1697
1698 static void kbd_leds(void *opaque, int ledstate)
1699 {
1700 VncState *vs = opaque;
1701 int caps, num, scr;
1702 bool has_changed = (ledstate != current_led_state(vs));
1703
1704 trace_vnc_key_guest_leds((ledstate & QEMU_CAPS_LOCK_LED),
1705 (ledstate & QEMU_NUM_LOCK_LED),
1706 (ledstate & QEMU_SCROLL_LOCK_LED));
1707
1708 caps = ledstate & QEMU_CAPS_LOCK_LED ? 1 : 0;
1709 num = ledstate & QEMU_NUM_LOCK_LED ? 1 : 0;
1710 scr = ledstate & QEMU_SCROLL_LOCK_LED ? 1 : 0;
1711
1712 if (vs->modifiers_state[0x3a] != caps) {
1713 vs->modifiers_state[0x3a] = caps;
1714 }
1715 if (vs->modifiers_state[0x45] != num) {
1716 vs->modifiers_state[0x45] = num;
1717 }
1718 if (vs->modifiers_state[0x46] != scr) {
1719 vs->modifiers_state[0x46] = scr;
1720 }
1721
1722 /* Sending the current led state message to the client */
1723 if (has_changed) {
1724 vnc_led_state_change(vs);
1725 }
1726 }
1727
1728 static void do_key_event(VncState *vs, int down, int keycode, int sym)
1729 {
1730 /* QEMU console switch */
1731 switch(keycode) {
1732 case 0x2a: /* Left Shift */
1733 case 0x36: /* Right Shift */
1734 case 0x1d: /* Left CTRL */
1735 case 0x9d: /* Right CTRL */
1736 case 0x38: /* Left ALT */
1737 case 0xb8: /* Right ALT */
1738 if (down)
1739 vs->modifiers_state[keycode] = 1;
1740 else
1741 vs->modifiers_state[keycode] = 0;
1742 break;
1743 case 0x02 ... 0x0a: /* '1' to '9' keys */
1744 if (vs->vd->dcl.con == NULL &&
1745 down && vs->modifiers_state[0x1d] && vs->modifiers_state[0x38]) {
1746 /* Reset the modifiers sent to the current console */
1747 reset_keys(vs);
1748 console_select(keycode - 0x02);
1749 return;
1750 }
1751 break;
1752 case 0x3a: /* CapsLock */
1753 case 0x45: /* NumLock */
1754 if (down)
1755 vs->modifiers_state[keycode] ^= 1;
1756 break;
1757 }
1758
1759 /* Turn off the lock state sync logic if the client support the led
1760 state extension.
1761 */
1762 if (down && vs->vd->lock_key_sync &&
1763 !vnc_has_feature(vs, VNC_FEATURE_LED_STATE) &&
1764 keycode_is_keypad(vs->vd->kbd_layout, keycode)) {
1765 /* If the numlock state needs to change then simulate an additional
1766 keypress before sending this one. This will happen if the user
1767 toggles numlock away from the VNC window.
1768 */
1769 if (keysym_is_numlock(vs->vd->kbd_layout, sym & 0xFFFF)) {
1770 if (!vs->modifiers_state[0x45]) {
1771 trace_vnc_key_sync_numlock(true);
1772 vs->modifiers_state[0x45] = 1;
1773 press_key(vs, 0xff7f);
1774 }
1775 } else {
1776 if (vs->modifiers_state[0x45]) {
1777 trace_vnc_key_sync_numlock(false);
1778 vs->modifiers_state[0x45] = 0;
1779 press_key(vs, 0xff7f);
1780 }
1781 }
1782 }
1783
1784 if (down && vs->vd->lock_key_sync &&
1785 !vnc_has_feature(vs, VNC_FEATURE_LED_STATE) &&
1786 ((sym >= 'A' && sym <= 'Z') || (sym >= 'a' && sym <= 'z'))) {
1787 /* If the capslock state needs to change then simulate an additional
1788 keypress before sending this one. This will happen if the user
1789 toggles capslock away from the VNC window.
1790 */
1791 int uppercase = !!(sym >= 'A' && sym <= 'Z');
1792 int shift = !!(vs->modifiers_state[0x2a] | vs->modifiers_state[0x36]);
1793 int capslock = !!(vs->modifiers_state[0x3a]);
1794 if (capslock) {
1795 if (uppercase == shift) {
1796 trace_vnc_key_sync_capslock(false);
1797 vs->modifiers_state[0x3a] = 0;
1798 press_key(vs, 0xffe5);
1799 }
1800 } else {
1801 if (uppercase != shift) {
1802 trace_vnc_key_sync_capslock(true);
1803 vs->modifiers_state[0x3a] = 1;
1804 press_key(vs, 0xffe5);
1805 }
1806 }
1807 }
1808
1809 if (qemu_console_is_graphic(NULL)) {
1810 qemu_input_event_send_key_number(vs->vd->dcl.con, keycode, down);
1811 } else {
1812 bool numlock = vs->modifiers_state[0x45];
1813 bool control = (vs->modifiers_state[0x1d] ||
1814 vs->modifiers_state[0x9d]);
1815 /* QEMU console emulation */
1816 if (down) {
1817 switch (keycode) {
1818 case 0x2a: /* Left Shift */
1819 case 0x36: /* Right Shift */
1820 case 0x1d: /* Left CTRL */
1821 case 0x9d: /* Right CTRL */
1822 case 0x38: /* Left ALT */
1823 case 0xb8: /* Right ALT */
1824 break;
1825 case 0xc8:
1826 kbd_put_keysym(QEMU_KEY_UP);
1827 break;
1828 case 0xd0:
1829 kbd_put_keysym(QEMU_KEY_DOWN);
1830 break;
1831 case 0xcb:
1832 kbd_put_keysym(QEMU_KEY_LEFT);
1833 break;
1834 case 0xcd:
1835 kbd_put_keysym(QEMU_KEY_RIGHT);
1836 break;
1837 case 0xd3:
1838 kbd_put_keysym(QEMU_KEY_DELETE);
1839 break;
1840 case 0xc7:
1841 kbd_put_keysym(QEMU_KEY_HOME);
1842 break;
1843 case 0xcf:
1844 kbd_put_keysym(QEMU_KEY_END);
1845 break;
1846 case 0xc9:
1847 kbd_put_keysym(QEMU_KEY_PAGEUP);
1848 break;
1849 case 0xd1:
1850 kbd_put_keysym(QEMU_KEY_PAGEDOWN);
1851 break;
1852
1853 case 0x47:
1854 kbd_put_keysym(numlock ? '7' : QEMU_KEY_HOME);
1855 break;
1856 case 0x48:
1857 kbd_put_keysym(numlock ? '8' : QEMU_KEY_UP);
1858 break;
1859 case 0x49:
1860 kbd_put_keysym(numlock ? '9' : QEMU_KEY_PAGEUP);
1861 break;
1862 case 0x4b:
1863 kbd_put_keysym(numlock ? '4' : QEMU_KEY_LEFT);
1864 break;
1865 case 0x4c:
1866 kbd_put_keysym('5');
1867 break;
1868 case 0x4d:
1869 kbd_put_keysym(numlock ? '6' : QEMU_KEY_RIGHT);
1870 break;
1871 case 0x4f:
1872 kbd_put_keysym(numlock ? '1' : QEMU_KEY_END);
1873 break;
1874 case 0x50:
1875 kbd_put_keysym(numlock ? '2' : QEMU_KEY_DOWN);
1876 break;
1877 case 0x51:
1878 kbd_put_keysym(numlock ? '3' : QEMU_KEY_PAGEDOWN);
1879 break;
1880 case 0x52:
1881 kbd_put_keysym('0');
1882 break;
1883 case 0x53:
1884 kbd_put_keysym(numlock ? '.' : QEMU_KEY_DELETE);
1885 break;
1886
1887 case 0xb5:
1888 kbd_put_keysym('/');
1889 break;
1890 case 0x37:
1891 kbd_put_keysym('*');
1892 break;
1893 case 0x4a:
1894 kbd_put_keysym('-');
1895 break;
1896 case 0x4e:
1897 kbd_put_keysym('+');
1898 break;
1899 case 0x9c:
1900 kbd_put_keysym('\n');
1901 break;
1902
1903 default:
1904 if (control) {
1905 kbd_put_keysym(sym & 0x1f);
1906 } else {
1907 kbd_put_keysym(sym);
1908 }
1909 break;
1910 }
1911 }
1912 }
1913 }
1914
1915 static void vnc_release_modifiers(VncState *vs)
1916 {
1917 static const int keycodes[] = {
1918 /* shift, control, alt keys, both left & right */
1919 0x2a, 0x36, 0x1d, 0x9d, 0x38, 0xb8,
1920 };
1921 int i, keycode;
1922
1923 if (!qemu_console_is_graphic(NULL)) {
1924 return;
1925 }
1926 for (i = 0; i < ARRAY_SIZE(keycodes); i++) {
1927 keycode = keycodes[i];
1928 if (!vs->modifiers_state[keycode]) {
1929 continue;
1930 }
1931 qemu_input_event_send_key_number(vs->vd->dcl.con, keycode, false);
1932 }
1933 }
1934
1935 static const char *code2name(int keycode)
1936 {
1937 return QKeyCode_lookup[qemu_input_key_number_to_qcode(keycode)];
1938 }
1939
1940 static void key_event(VncState *vs, int down, uint32_t sym)
1941 {
1942 int keycode;
1943 int lsym = sym;
1944
1945 if (lsym >= 'A' && lsym <= 'Z' && qemu_console_is_graphic(NULL)) {
1946 lsym = lsym - 'A' + 'a';
1947 }
1948
1949 keycode = keysym2scancode(vs->vd->kbd_layout, lsym & 0xFFFF) & SCANCODE_KEYMASK;
1950 trace_vnc_key_event_map(down, sym, keycode, code2name(keycode));
1951 do_key_event(vs, down, keycode, sym);
1952 }
1953
1954 static void ext_key_event(VncState *vs, int down,
1955 uint32_t sym, uint16_t keycode)
1956 {
1957 /* if the user specifies a keyboard layout, always use it */
1958 if (keyboard_layout) {
1959 key_event(vs, down, sym);
1960 } else {
1961 trace_vnc_key_event_ext(down, sym, keycode, code2name(keycode));
1962 do_key_event(vs, down, keycode, sym);
1963 }
1964 }
1965
1966 static void framebuffer_update_request(VncState *vs, int incremental,
1967 int x, int y, int w, int h)
1968 {
1969 vs->need_update = 1;
1970
1971 if (incremental) {
1972 return;
1973 }
1974
1975 vs->force_update = 1;
1976 vnc_set_area_dirty(vs->dirty, vs->vd, x, y, w, h);
1977 }
1978
1979 static void send_ext_key_event_ack(VncState *vs)
1980 {
1981 vnc_lock_output(vs);
1982 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
1983 vnc_write_u8(vs, 0);
1984 vnc_write_u16(vs, 1);
1985 vnc_framebuffer_update(vs, 0, 0,
1986 pixman_image_get_width(vs->vd->server),
1987 pixman_image_get_height(vs->vd->server),
1988 VNC_ENCODING_EXT_KEY_EVENT);
1989 vnc_unlock_output(vs);
1990 vnc_flush(vs);
1991 }
1992
1993 static void send_ext_audio_ack(VncState *vs)
1994 {
1995 vnc_lock_output(vs);
1996 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
1997 vnc_write_u8(vs, 0);
1998 vnc_write_u16(vs, 1);
1999 vnc_framebuffer_update(vs, 0, 0,
2000 pixman_image_get_width(vs->vd->server),
2001 pixman_image_get_height(vs->vd->server),
2002 VNC_ENCODING_AUDIO);
2003 vnc_unlock_output(vs);
2004 vnc_flush(vs);
2005 }
2006
2007 static void set_encodings(VncState *vs, int32_t *encodings, size_t n_encodings)
2008 {
2009 int i;
2010 unsigned int enc = 0;
2011
2012 vs->features = 0;
2013 vs->vnc_encoding = 0;
2014 vs->tight.compression = 9;
2015 vs->tight.quality = -1; /* Lossless by default */
2016 vs->absolute = -1;
2017
2018 /*
2019 * Start from the end because the encodings are sent in order of preference.
2020 * This way the preferred encoding (first encoding defined in the array)
2021 * will be set at the end of the loop.
2022 */
2023 for (i = n_encodings - 1; i >= 0; i--) {
2024 enc = encodings[i];
2025 switch (enc) {
2026 case VNC_ENCODING_RAW:
2027 vs->vnc_encoding = enc;
2028 break;
2029 case VNC_ENCODING_COPYRECT:
2030 vs->features |= VNC_FEATURE_COPYRECT_MASK;
2031 break;
2032 case VNC_ENCODING_HEXTILE:
2033 vs->features |= VNC_FEATURE_HEXTILE_MASK;
2034 vs->vnc_encoding = enc;
2035 break;
2036 case VNC_ENCODING_TIGHT:
2037 vs->features |= VNC_FEATURE_TIGHT_MASK;
2038 vs->vnc_encoding = enc;
2039 break;
2040 #ifdef CONFIG_VNC_PNG
2041 case VNC_ENCODING_TIGHT_PNG:
2042 vs->features |= VNC_FEATURE_TIGHT_PNG_MASK;
2043 vs->vnc_encoding = enc;
2044 break;
2045 #endif
2046 case VNC_ENCODING_ZLIB:
2047 vs->features |= VNC_FEATURE_ZLIB_MASK;
2048 vs->vnc_encoding = enc;
2049 break;
2050 case VNC_ENCODING_ZRLE:
2051 vs->features |= VNC_FEATURE_ZRLE_MASK;
2052 vs->vnc_encoding = enc;
2053 break;
2054 case VNC_ENCODING_ZYWRLE:
2055 vs->features |= VNC_FEATURE_ZYWRLE_MASK;
2056 vs->vnc_encoding = enc;
2057 break;
2058 case VNC_ENCODING_DESKTOPRESIZE:
2059 vs->features |= VNC_FEATURE_RESIZE_MASK;
2060 break;
2061 case VNC_ENCODING_POINTER_TYPE_CHANGE:
2062 vs->features |= VNC_FEATURE_POINTER_TYPE_CHANGE_MASK;
2063 break;
2064 case VNC_ENCODING_RICH_CURSOR:
2065 vs->features |= VNC_FEATURE_RICH_CURSOR_MASK;
2066 break;
2067 case VNC_ENCODING_EXT_KEY_EVENT:
2068 send_ext_key_event_ack(vs);
2069 break;
2070 case VNC_ENCODING_AUDIO:
2071 send_ext_audio_ack(vs);
2072 break;
2073 case VNC_ENCODING_WMVi:
2074 vs->features |= VNC_FEATURE_WMVI_MASK;
2075 break;
2076 case VNC_ENCODING_LED_STATE:
2077 vs->features |= VNC_FEATURE_LED_STATE_MASK;
2078 break;
2079 case VNC_ENCODING_COMPRESSLEVEL0 ... VNC_ENCODING_COMPRESSLEVEL0 + 9:
2080 vs->tight.compression = (enc & 0x0F);
2081 break;
2082 case VNC_ENCODING_QUALITYLEVEL0 ... VNC_ENCODING_QUALITYLEVEL0 + 9:
2083 if (vs->vd->lossy) {
2084 vs->tight.quality = (enc & 0x0F);
2085 }
2086 break;
2087 default:
2088 VNC_DEBUG("Unknown encoding: %d (0x%.8x): %d\n", i, enc, enc);
2089 break;
2090 }
2091 }
2092 vnc_desktop_resize(vs);
2093 check_pointer_type_change(&vs->mouse_mode_notifier, NULL);
2094 vnc_led_state_change(vs);
2095 }
2096
2097 static void set_pixel_conversion(VncState *vs)
2098 {
2099 pixman_format_code_t fmt = qemu_pixman_get_format(&vs->client_pf);
2100
2101 if (fmt == VNC_SERVER_FB_FORMAT) {
2102 vs->write_pixels = vnc_write_pixels_copy;
2103 vnc_hextile_set_pixel_conversion(vs, 0);
2104 } else {
2105 vs->write_pixels = vnc_write_pixels_generic;
2106 vnc_hextile_set_pixel_conversion(vs, 1);
2107 }
2108 }
2109
2110 static void set_pixel_format(VncState *vs,
2111 int bits_per_pixel, int depth,
2112 int big_endian_flag, int true_color_flag,
2113 int red_max, int green_max, int blue_max,
2114 int red_shift, int green_shift, int blue_shift)
2115 {
2116 if (!true_color_flag) {
2117 vnc_client_error(vs);
2118 return;
2119 }
2120
2121 switch (bits_per_pixel) {
2122 case 8:
2123 case 16:
2124 case 32:
2125 break;
2126 default:
2127 vnc_client_error(vs);
2128 return;
2129 }
2130
2131 vs->client_pf.rmax = red_max ? red_max : 0xFF;
2132 vs->client_pf.rbits = hweight_long(red_max);
2133 vs->client_pf.rshift = red_shift;
2134 vs->client_pf.rmask = red_max << red_shift;
2135 vs->client_pf.gmax = green_max ? green_max : 0xFF;
2136 vs->client_pf.gbits = hweight_long(green_max);
2137 vs->client_pf.gshift = green_shift;
2138 vs->client_pf.gmask = green_max << green_shift;
2139 vs->client_pf.bmax = blue_max ? blue_max : 0xFF;
2140 vs->client_pf.bbits = hweight_long(blue_max);
2141 vs->client_pf.bshift = blue_shift;
2142 vs->client_pf.bmask = blue_max << blue_shift;
2143 vs->client_pf.bits_per_pixel = bits_per_pixel;
2144 vs->client_pf.bytes_per_pixel = bits_per_pixel / 8;
2145 vs->client_pf.depth = bits_per_pixel == 32 ? 24 : bits_per_pixel;
2146 vs->client_be = big_endian_flag;
2147
2148 set_pixel_conversion(vs);
2149
2150 graphic_hw_invalidate(vs->vd->dcl.con);
2151 graphic_hw_update(vs->vd->dcl.con);
2152 }
2153
2154 static void pixel_format_message (VncState *vs) {
2155 char pad[3] = { 0, 0, 0 };
2156
2157 vs->client_pf = qemu_default_pixelformat(32);
2158
2159 vnc_write_u8(vs, vs->client_pf.bits_per_pixel); /* bits-per-pixel */
2160 vnc_write_u8(vs, vs->client_pf.depth); /* depth */
2161
2162 #ifdef HOST_WORDS_BIGENDIAN
2163 vnc_write_u8(vs, 1); /* big-endian-flag */
2164 #else
2165 vnc_write_u8(vs, 0); /* big-endian-flag */
2166 #endif
2167 vnc_write_u8(vs, 1); /* true-color-flag */
2168 vnc_write_u16(vs, vs->client_pf.rmax); /* red-max */
2169 vnc_write_u16(vs, vs->client_pf.gmax); /* green-max */
2170 vnc_write_u16(vs, vs->client_pf.bmax); /* blue-max */
2171 vnc_write_u8(vs, vs->client_pf.rshift); /* red-shift */
2172 vnc_write_u8(vs, vs->client_pf.gshift); /* green-shift */
2173 vnc_write_u8(vs, vs->client_pf.bshift); /* blue-shift */
2174 vnc_write(vs, pad, 3); /* padding */
2175
2176 vnc_hextile_set_pixel_conversion(vs, 0);
2177 vs->write_pixels = vnc_write_pixels_copy;
2178 }
2179
2180 static void vnc_colordepth(VncState *vs)
2181 {
2182 if (vnc_has_feature(vs, VNC_FEATURE_WMVI)) {
2183 /* Sending a WMVi message to notify the client*/
2184 vnc_lock_output(vs);
2185 vnc_write_u8(vs, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE);
2186 vnc_write_u8(vs, 0);
2187 vnc_write_u16(vs, 1); /* number of rects */
2188 vnc_framebuffer_update(vs, 0, 0,
2189 pixman_image_get_width(vs->vd->server),
2190 pixman_image_get_height(vs->vd->server),
2191 VNC_ENCODING_WMVi);
2192 pixel_format_message(vs);
2193 vnc_unlock_output(vs);
2194 vnc_flush(vs);
2195 } else {
2196 set_pixel_conversion(vs);
2197 }
2198 }
2199
2200 static int protocol_client_msg(VncState *vs, uint8_t *data, size_t len)
2201 {
2202 int i;
2203 uint16_t limit;
2204 VncDisplay *vd = vs->vd;
2205
2206 if (data[0] > 3) {
2207 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);
2208 }
2209
2210 switch (data[0]) {
2211 case VNC_MSG_CLIENT_SET_PIXEL_FORMAT:
2212 if (len == 1)
2213 return 20;
2214
2215 set_pixel_format(vs, read_u8(data, 4), read_u8(data, 5),
2216 read_u8(data, 6), read_u8(data, 7),
2217 read_u16(data, 8), read_u16(data, 10),
2218 read_u16(data, 12), read_u8(data, 14),
2219 read_u8(data, 15), read_u8(data, 16));
2220 break;
2221 case VNC_MSG_CLIENT_SET_ENCODINGS:
2222 if (len == 1)
2223 return 4;
2224
2225 if (len == 4) {
2226 limit = read_u16(data, 2);
2227 if (limit > 0)
2228 return 4 + (limit * 4);
2229 } else
2230 limit = read_u16(data, 2);
2231
2232 for (i = 0; i < limit; i++) {
2233 int32_t val = read_s32(data, 4 + (i * 4));
2234 memcpy(data + 4 + (i * 4), &val, sizeof(val));
2235 }
2236
2237 set_encodings(vs, (int32_t *)(data + 4), limit);
2238 break;
2239 case VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST:
2240 if (len == 1)
2241 return 10;
2242
2243 framebuffer_update_request(vs,
2244 read_u8(data, 1), read_u16(data, 2), read_u16(data, 4),
2245 read_u16(data, 6), read_u16(data, 8));
2246 break;
2247 case VNC_MSG_CLIENT_KEY_EVENT:
2248 if (len == 1)
2249 return 8;
2250
2251 key_event(vs, read_u8(data, 1), read_u32(data, 4));
2252 break;
2253 case VNC_MSG_CLIENT_POINTER_EVENT:
2254 if (len == 1)
2255 return 6;
2256
2257 pointer_event(vs, read_u8(data, 1), read_u16(data, 2), read_u16(data, 4));
2258 break;
2259 case VNC_MSG_CLIENT_CUT_TEXT:
2260 if (len == 1) {
2261 return 8;
2262 }
2263 if (len == 8) {
2264 uint32_t dlen = read_u32(data, 4);
2265 if (dlen > (1 << 20)) {
2266 error_report("vnc: client_cut_text msg payload has %u bytes"
2267 " which exceeds our limit of 1MB.", dlen);
2268 vnc_client_error(vs);
2269 break;
2270 }
2271 if (dlen > 0) {
2272 return 8 + dlen;
2273 }
2274 }
2275
2276 client_cut_text(vs, read_u32(data, 4), data + 8);
2277 break;
2278 case VNC_MSG_CLIENT_QEMU:
2279 if (len == 1)
2280 return 2;
2281
2282 switch (read_u8(data, 1)) {
2283 case VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT:
2284 if (len == 2)
2285 return 12;
2286
2287 ext_key_event(vs, read_u16(data, 2),
2288 read_u32(data, 4), read_u32(data, 8));
2289 break;
2290 case VNC_MSG_CLIENT_QEMU_AUDIO:
2291 if (len == 2)
2292 return 4;
2293
2294 switch (read_u16 (data, 2)) {
2295 case VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE:
2296 audio_add(vs);
2297 break;
2298 case VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE:
2299 audio_del(vs);
2300 break;
2301 case VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT:
2302 if (len == 4)
2303 return 10;
2304 switch (read_u8(data, 4)) {
2305 case 0: vs->as.fmt = AUD_FMT_U8; break;
2306 case 1: vs->as.fmt = AUD_FMT_S8; break;
2307 case 2: vs->as.fmt = AUD_FMT_U16; break;
2308 case 3: vs->as.fmt = AUD_FMT_S16; break;
2309 case 4: vs->as.fmt = AUD_FMT_U32; break;
2310 case 5: vs->as.fmt = AUD_FMT_S32; break;
2311 default:
2312 VNC_DEBUG("Invalid audio format %d\n", read_u8(data, 4));
2313 vnc_client_error(vs);
2314 break;
2315 }
2316 vs->as.nchannels = read_u8(data, 5);
2317 if (vs->as.nchannels != 1 && vs->as.nchannels != 2) {
2318 VNC_DEBUG("Invalid audio channel coount %d\n",
2319 read_u8(data, 5));
2320 vnc_client_error(vs);
2321 break;
2322 }
2323 vs->as.freq = read_u32(data, 6);
2324 break;
2325 default:
2326 VNC_DEBUG("Invalid audio message %d\n", read_u8(data, 4));
2327 vnc_client_error(vs);
2328 break;
2329 }
2330 break;
2331
2332 default:
2333 VNC_DEBUG("Msg: %d\n", read_u16(data, 0));
2334 vnc_client_error(vs);
2335 break;
2336 }
2337 break;
2338 default:
2339 VNC_DEBUG("Msg: %d\n", data[0]);
2340 vnc_client_error(vs);
2341 break;
2342 }
2343
2344 vnc_read_when(vs, protocol_client_msg, 1);
2345 return 0;
2346 }
2347
2348 static int protocol_client_init(VncState *vs, uint8_t *data, size_t len)
2349 {
2350 char buf[1024];
2351 VncShareMode mode;
2352 int size;
2353
2354 mode = data[0] ? VNC_SHARE_MODE_SHARED : VNC_SHARE_MODE_EXCLUSIVE;
2355 switch (vs->vd->share_policy) {
2356 case VNC_SHARE_POLICY_IGNORE:
2357 /*
2358 * Ignore the shared flag. Nothing to do here.
2359 *
2360 * Doesn't conform to the rfb spec but is traditional qemu
2361 * behavior, thus left here as option for compatibility
2362 * reasons.
2363 */
2364 break;
2365 case VNC_SHARE_POLICY_ALLOW_EXCLUSIVE:
2366 /*
2367 * Policy: Allow clients ask for exclusive access.
2368 *
2369 * Implementation: When a client asks for exclusive access,
2370 * disconnect all others. Shared connects are allowed as long
2371 * as no exclusive connection exists.
2372 *
2373 * This is how the rfb spec suggests to handle the shared flag.
2374 */
2375 if (mode == VNC_SHARE_MODE_EXCLUSIVE) {
2376 VncState *client;
2377 QTAILQ_FOREACH(client, &vs->vd->clients, next) {
2378 if (vs == client) {
2379 continue;
2380 }
2381 if (client->share_mode != VNC_SHARE_MODE_EXCLUSIVE &&
2382 client->share_mode != VNC_SHARE_MODE_SHARED) {
2383 continue;
2384 }
2385 vnc_disconnect_start(client);
2386 }
2387 }
2388 if (mode == VNC_SHARE_MODE_SHARED) {
2389 if (vs->vd->num_exclusive > 0) {
2390 vnc_disconnect_start(vs);
2391 return 0;
2392 }
2393 }
2394 break;
2395 case VNC_SHARE_POLICY_FORCE_SHARED:
2396 /*
2397 * Policy: Shared connects only.
2398 * Implementation: Disallow clients asking for exclusive access.
2399 *
2400 * Useful for shared desktop sessions where you don't want
2401 * someone forgetting to say -shared when running the vnc
2402 * client disconnect everybody else.
2403 */
2404 if (mode == VNC_SHARE_MODE_EXCLUSIVE) {
2405 vnc_disconnect_start(vs);
2406 return 0;
2407 }
2408 break;
2409 }
2410 vnc_set_share_mode(vs, mode);
2411
2412 if (vs->vd->num_shared > vs->vd->connections_limit) {
2413 vnc_disconnect_start(vs);
2414 return 0;
2415 }
2416
2417 vs->client_width = pixman_image_get_width(vs->vd->server);
2418 vs->client_height = pixman_image_get_height(vs->vd->server);
2419 vnc_write_u16(vs, vs->client_width);
2420 vnc_write_u16(vs, vs->client_height);
2421
2422 pixel_format_message(vs);
2423
2424 if (qemu_name)
2425 size = snprintf(buf, sizeof(buf), "QEMU (%s)", qemu_name);
2426 else
2427 size = snprintf(buf, sizeof(buf), "QEMU");
2428
2429 vnc_write_u32(vs, size);
2430 vnc_write(vs, buf, size);
2431 vnc_flush(vs);
2432
2433 vnc_client_cache_auth(vs);
2434 vnc_qmp_event(vs, QAPI_EVENT_VNC_INITIALIZED);
2435
2436 vnc_read_when(vs, protocol_client_msg, 1);
2437
2438 return 0;
2439 }
2440
2441 void start_client_init(VncState *vs)
2442 {
2443 vnc_read_when(vs, protocol_client_init, 1);
2444 }
2445
2446 static void make_challenge(VncState *vs)
2447 {
2448 int i;
2449
2450 srand(time(NULL)+getpid()+getpid()*987654+rand());
2451
2452 for (i = 0 ; i < sizeof(vs->challenge) ; i++)
2453 vs->challenge[i] = (int) (256.0*rand()/(RAND_MAX+1.0));
2454 }
2455
2456 static int protocol_client_auth_vnc(VncState *vs, uint8_t *data, size_t len)
2457 {
2458 unsigned char response[VNC_AUTH_CHALLENGE_SIZE];
2459 size_t i, pwlen;
2460 unsigned char key[8];
2461 time_t now = time(NULL);
2462 QCryptoCipher *cipher = NULL;
2463 Error *err = NULL;
2464
2465 if (!vs->vd->password) {
2466 VNC_DEBUG("No password configured on server");
2467 goto reject;
2468 }
2469 if (vs->vd->expires < now) {
2470 VNC_DEBUG("Password is expired");
2471 goto reject;
2472 }
2473
2474 memcpy(response, vs->challenge, VNC_AUTH_CHALLENGE_SIZE);
2475
2476 /* Calculate the expected challenge response */
2477 pwlen = strlen(vs->vd->password);
2478 for (i=0; i<sizeof(key); i++)
2479 key[i] = i<pwlen ? vs->vd->password[i] : 0;
2480
2481 cipher = qcrypto_cipher_new(
2482 QCRYPTO_CIPHER_ALG_DES_RFB,
2483 QCRYPTO_CIPHER_MODE_ECB,
2484 key, G_N_ELEMENTS(key),
2485 &err);
2486 if (!cipher) {
2487 VNC_DEBUG("Cannot initialize cipher %s",
2488 error_get_pretty(err));
2489 error_free(err);
2490 goto reject;
2491 }
2492
2493 if (qcrypto_cipher_encrypt(cipher,
2494 vs->challenge,
2495 response,
2496 VNC_AUTH_CHALLENGE_SIZE,
2497 &err) < 0) {
2498 VNC_DEBUG("Cannot encrypt challenge %s",
2499 error_get_pretty(err));
2500 error_free(err);
2501 goto reject;
2502 }
2503
2504 /* Compare expected vs actual challenge response */
2505 if (memcmp(response, data, VNC_AUTH_CHALLENGE_SIZE) != 0) {
2506 VNC_DEBUG("Client challenge response did not match\n");
2507 goto reject;
2508 } else {
2509 VNC_DEBUG("Accepting VNC challenge response\n");
2510 vnc_write_u32(vs, 0); /* Accept auth */
2511 vnc_flush(vs);
2512
2513 start_client_init(vs);
2514 }
2515
2516 qcrypto_cipher_free(cipher);
2517 return 0;
2518
2519 reject:
2520 vnc_write_u32(vs, 1); /* Reject auth */
2521 if (vs->minor >= 8) {
2522 static const char err[] = "Authentication failed";
2523 vnc_write_u32(vs, sizeof(err));
2524 vnc_write(vs, err, sizeof(err));
2525 }
2526 vnc_flush(vs);
2527 vnc_client_error(vs);
2528 qcrypto_cipher_free(cipher);
2529 return 0;
2530 }
2531
2532 void start_auth_vnc(VncState *vs)
2533 {
2534 make_challenge(vs);
2535 /* Send client a 'random' challenge */
2536 vnc_write(vs, vs->challenge, sizeof(vs->challenge));
2537 vnc_flush(vs);
2538
2539 vnc_read_when(vs, protocol_client_auth_vnc, sizeof(vs->challenge));
2540 }
2541
2542
2543 static int protocol_client_auth(VncState *vs, uint8_t *data, size_t len)
2544 {
2545 /* We only advertise 1 auth scheme at a time, so client
2546 * must pick the one we sent. Verify this */
2547 if (data[0] != vs->auth) { /* Reject auth */
2548 VNC_DEBUG("Reject auth %d because it didn't match advertized\n", (int)data[0]);
2549 vnc_write_u32(vs, 1);
2550 if (vs->minor >= 8) {
2551 static const char err[] = "Authentication failed";
2552 vnc_write_u32(vs, sizeof(err));
2553 vnc_write(vs, err, sizeof(err));
2554 }
2555 vnc_client_error(vs);
2556 } else { /* Accept requested auth */
2557 VNC_DEBUG("Client requested auth %d\n", (int)data[0]);
2558 switch (vs->auth) {
2559 case VNC_AUTH_NONE:
2560 VNC_DEBUG("Accept auth none\n");
2561 if (vs->minor >= 8) {
2562 vnc_write_u32(vs, 0); /* Accept auth completion */
2563 vnc_flush(vs);
2564 }
2565 start_client_init(vs);
2566 break;
2567
2568 case VNC_AUTH_VNC:
2569 VNC_DEBUG("Start VNC auth\n");
2570 start_auth_vnc(vs);
2571 break;
2572
2573 case VNC_AUTH_VENCRYPT:
2574 VNC_DEBUG("Accept VeNCrypt auth\n");
2575 start_auth_vencrypt(vs);
2576 break;
2577
2578 #ifdef CONFIG_VNC_SASL
2579 case VNC_AUTH_SASL:
2580 VNC_DEBUG("Accept SASL auth\n");
2581 start_auth_sasl(vs);
2582 break;
2583 #endif /* CONFIG_VNC_SASL */
2584
2585 default: /* Should not be possible, but just in case */
2586 VNC_DEBUG("Reject auth %d server code bug\n", vs->auth);
2587 vnc_write_u8(vs, 1);
2588 if (vs->minor >= 8) {
2589 static const char err[] = "Authentication failed";
2590 vnc_write_u32(vs, sizeof(err));
2591 vnc_write(vs, err, sizeof(err));
2592 }
2593 vnc_client_error(vs);
2594 }
2595 }
2596 return 0;
2597 }
2598
2599 static int protocol_version(VncState *vs, uint8_t *version, size_t len)
2600 {
2601 char local[13];
2602
2603 memcpy(local, version, 12);
2604 local[12] = 0;
2605
2606 if (sscanf(local, "RFB %03d.%03d\n", &vs->major, &vs->minor) != 2) {
2607 VNC_DEBUG("Malformed protocol version %s\n", local);
2608 vnc_client_error(vs);
2609 return 0;
2610 }
2611 VNC_DEBUG("Client request protocol version %d.%d\n", vs->major, vs->minor);
2612 if (vs->major != 3 ||
2613 (vs->minor != 3 &&
2614 vs->minor != 4 &&
2615 vs->minor != 5 &&
2616 vs->minor != 7 &&
2617 vs->minor != 8)) {
2618 VNC_DEBUG("Unsupported client version\n");
2619 vnc_write_u32(vs, VNC_AUTH_INVALID);
2620 vnc_flush(vs);
2621 vnc_client_error(vs);
2622 return 0;
2623 }
2624 /* Some broken clients report v3.4 or v3.5, which spec requires to be treated
2625 * as equivalent to v3.3 by servers
2626 */
2627 if (vs->minor == 4 || vs->minor == 5)
2628 vs->minor = 3;
2629
2630 if (vs->minor == 3) {
2631 if (vs->auth == VNC_AUTH_NONE) {
2632 VNC_DEBUG("Tell client auth none\n");
2633 vnc_write_u32(vs, vs->auth);
2634 vnc_flush(vs);
2635 start_client_init(vs);
2636 } else if (vs->auth == VNC_AUTH_VNC) {
2637 VNC_DEBUG("Tell client VNC auth\n");
2638 vnc_write_u32(vs, vs->auth);
2639 vnc_flush(vs);
2640 start_auth_vnc(vs);
2641 } else {
2642 VNC_DEBUG("Unsupported auth %d for protocol 3.3\n", vs->auth);
2643 vnc_write_u32(vs, VNC_AUTH_INVALID);
2644 vnc_flush(vs);
2645 vnc_client_error(vs);
2646 }
2647 } else {
2648 VNC_DEBUG("Telling client we support auth %d\n", vs->auth);
2649 vnc_write_u8(vs, 1); /* num auth */
2650 vnc_write_u8(vs, vs->auth);
2651 vnc_read_when(vs, protocol_client_auth, 1);
2652 vnc_flush(vs);
2653 }
2654
2655 return 0;
2656 }
2657
2658 static VncRectStat *vnc_stat_rect(VncDisplay *vd, int x, int y)
2659 {
2660 struct VncSurface *vs = &vd->guest;
2661
2662 return &vs->stats[y / VNC_STAT_RECT][x / VNC_STAT_RECT];
2663 }
2664
2665 void vnc_sent_lossy_rect(VncState *vs, int x, int y, int w, int h)
2666 {
2667 int i, j;
2668
2669 w = (x + w) / VNC_STAT_RECT;
2670 h = (y + h) / VNC_STAT_RECT;
2671 x /= VNC_STAT_RECT;
2672 y /= VNC_STAT_RECT;
2673
2674 for (j = y; j <= h; j++) {
2675 for (i = x; i <= w; i++) {
2676 vs->lossy_rect[j][i] = 1;
2677 }
2678 }
2679 }
2680
2681 static int vnc_refresh_lossy_rect(VncDisplay *vd, int x, int y)
2682 {
2683 VncState *vs;
2684 int sty = y / VNC_STAT_RECT;
2685 int stx = x / VNC_STAT_RECT;
2686 int has_dirty = 0;
2687
2688 y = y / VNC_STAT_RECT * VNC_STAT_RECT;
2689 x = x / VNC_STAT_RECT * VNC_STAT_RECT;
2690
2691 QTAILQ_FOREACH(vs, &vd->clients, next) {
2692 int j;
2693
2694 /* kernel send buffers are full -> refresh later */
2695 if (vs->output.offset) {
2696 continue;
2697 }
2698
2699 if (!vs->lossy_rect[sty][stx]) {
2700 continue;
2701 }
2702
2703 vs->lossy_rect[sty][stx] = 0;
2704 for (j = 0; j < VNC_STAT_RECT; ++j) {
2705 bitmap_set(vs->dirty[y + j],
2706 x / VNC_DIRTY_PIXELS_PER_BIT,
2707 VNC_STAT_RECT / VNC_DIRTY_PIXELS_PER_BIT);
2708 }
2709 has_dirty++;
2710 }
2711
2712 return has_dirty;
2713 }
2714
2715 static int vnc_update_stats(VncDisplay *vd, struct timeval * tv)
2716 {
2717 int width = pixman_image_get_width(vd->guest.fb);
2718 int height = pixman_image_get_height(vd->guest.fb);
2719 int x, y;
2720 struct timeval res;
2721 int has_dirty = 0;
2722
2723 for (y = 0; y < height; y += VNC_STAT_RECT) {
2724 for (x = 0; x < width; x += VNC_STAT_RECT) {
2725 VncRectStat *rect = vnc_stat_rect(vd, x, y);
2726
2727 rect->updated = false;
2728 }
2729 }
2730
2731 qemu_timersub(tv, &VNC_REFRESH_STATS, &res);
2732
2733 if (timercmp(&vd->guest.last_freq_check, &res, >)) {
2734 return has_dirty;
2735 }
2736 vd->guest.last_freq_check = *tv;
2737
2738 for (y = 0; y < height; y += VNC_STAT_RECT) {
2739 for (x = 0; x < width; x += VNC_STAT_RECT) {
2740 VncRectStat *rect= vnc_stat_rect(vd, x, y);
2741 int count = ARRAY_SIZE(rect->times);
2742 struct timeval min, max;
2743
2744 if (!timerisset(&rect->times[count - 1])) {
2745 continue ;
2746 }
2747
2748 max = rect->times[(rect->idx + count - 1) % count];
2749 qemu_timersub(tv, &max, &res);
2750
2751 if (timercmp(&res, &VNC_REFRESH_LOSSY, >)) {
2752 rect->freq = 0;
2753 has_dirty += vnc_refresh_lossy_rect(vd, x, y);
2754 memset(rect->times, 0, sizeof (rect->times));
2755 continue ;
2756 }
2757
2758 min = rect->times[rect->idx];
2759 max = rect->times[(rect->idx + count - 1) % count];
2760 qemu_timersub(&max, &min, &res);
2761
2762 rect->freq = res.tv_sec + res.tv_usec / 1000000.;
2763 rect->freq /= count;
2764 rect->freq = 1. / rect->freq;
2765 }
2766 }
2767 return has_dirty;
2768 }
2769
2770 double vnc_update_freq(VncState *vs, int x, int y, int w, int h)
2771 {
2772 int i, j;
2773 double total = 0;
2774 int num = 0;
2775
2776 x = (x / VNC_STAT_RECT) * VNC_STAT_RECT;
2777 y = (y / VNC_STAT_RECT) * VNC_STAT_RECT;
2778
2779 for (j = y; j <= y + h; j += VNC_STAT_RECT) {
2780 for (i = x; i <= x + w; i += VNC_STAT_RECT) {
2781 total += vnc_stat_rect(vs->vd, i, j)->freq;
2782 num++;
2783 }
2784 }
2785
2786 if (num) {
2787 return total / num;
2788 } else {
2789 return 0;
2790 }
2791 }
2792
2793 static void vnc_rect_updated(VncDisplay *vd, int x, int y, struct timeval * tv)
2794 {
2795 VncRectStat *rect;
2796
2797 rect = vnc_stat_rect(vd, x, y);
2798 if (rect->updated) {
2799 return ;
2800 }
2801 rect->times[rect->idx] = *tv;
2802 rect->idx = (rect->idx + 1) % ARRAY_SIZE(rect->times);
2803 rect->updated = true;
2804 }
2805
2806 static int vnc_refresh_server_surface(VncDisplay *vd)
2807 {
2808 int width = MIN(pixman_image_get_width(vd->guest.fb),
2809 pixman_image_get_width(vd->server));
2810 int height = MIN(pixman_image_get_height(vd->guest.fb),
2811 pixman_image_get_height(vd->server));
2812 int cmp_bytes, server_stride, line_bytes, guest_ll, guest_stride, y = 0;
2813 uint8_t *guest_row0 = NULL, *server_row0;
2814 VncState *vs;
2815 int has_dirty = 0;
2816 pixman_image_t *tmpbuf = NULL;
2817
2818 struct timeval tv = { 0, 0 };
2819
2820 if (!vd->non_adaptive) {
2821 gettimeofday(&tv, NULL);
2822 has_dirty = vnc_update_stats(vd, &tv);
2823 }
2824
2825 /*
2826 * Walk through the guest dirty map.
2827 * Check and copy modified bits from guest to server surface.
2828 * Update server dirty map.
2829 */
2830 server_row0 = (uint8_t *)pixman_image_get_data(vd->server);
2831 server_stride = guest_stride = guest_ll =
2832 pixman_image_get_stride(vd->server);
2833 cmp_bytes = MIN(VNC_DIRTY_PIXELS_PER_BIT * VNC_SERVER_FB_BYTES,
2834 server_stride);
2835 if (vd->guest.format != VNC_SERVER_FB_FORMAT) {
2836 int width = pixman_image_get_width(vd->server);
2837 tmpbuf = qemu_pixman_linebuf_create(VNC_SERVER_FB_FORMAT, width);
2838 } else {
2839 int guest_bpp =
2840 PIXMAN_FORMAT_BPP(pixman_image_get_format(vd->guest.fb));
2841 guest_row0 = (uint8_t *)pixman_image_get_data(vd->guest.fb);
2842 guest_stride = pixman_image_get_stride(vd->guest.fb);
2843 guest_ll = pixman_image_get_width(vd->guest.fb) * ((guest_bpp + 7) / 8);
2844 }
2845 line_bytes = MIN(server_stride, guest_ll);
2846
2847 for (;;) {
2848 int x;
2849 uint8_t *guest_ptr, *server_ptr;
2850 unsigned long offset = find_next_bit((unsigned long *) &vd->guest.dirty,
2851 height * VNC_DIRTY_BPL(&vd->guest),
2852 y * VNC_DIRTY_BPL(&vd->guest));
2853 if (offset == height * VNC_DIRTY_BPL(&vd->guest)) {
2854 /* no more dirty bits */
2855 break;
2856 }
2857 y = offset / VNC_DIRTY_BPL(&vd->guest);
2858 x = offset % VNC_DIRTY_BPL(&vd->guest);
2859
2860 server_ptr = server_row0 + y * server_stride + x * cmp_bytes;
2861
2862 if (vd->guest.format != VNC_SERVER_FB_FORMAT) {
2863 qemu_pixman_linebuf_fill(tmpbuf, vd->guest.fb, width, 0, y);
2864 guest_ptr = (uint8_t *)pixman_image_get_data(tmpbuf);
2865 } else {
2866 guest_ptr = guest_row0 + y * guest_stride;
2867 }
2868 guest_ptr += x * cmp_bytes;
2869
2870 for (; x < DIV_ROUND_UP(width, VNC_DIRTY_PIXELS_PER_BIT);
2871 x++, guest_ptr += cmp_bytes, server_ptr += cmp_bytes) {
2872 int _cmp_bytes = cmp_bytes;
2873 if (!test_and_clear_bit(x, vd->guest.dirty[y])) {
2874 continue;
2875 }
2876 if ((x + 1) * cmp_bytes > line_bytes) {
2877 _cmp_bytes = line_bytes - x * cmp_bytes;
2878 }
2879 assert(_cmp_bytes >= 0);
2880 if (memcmp(server_ptr, guest_ptr, _cmp_bytes) == 0) {
2881 continue;
2882 }
2883 memcpy(server_ptr, guest_ptr, _cmp_bytes);
2884 if (!vd->non_adaptive) {
2885 vnc_rect_updated(vd, x * VNC_DIRTY_PIXELS_PER_BIT,
2886 y, &tv);
2887 }
2888 QTAILQ_FOREACH(vs, &vd->clients, next) {
2889 set_bit(x, vs->dirty[y]);
2890 }
2891 has_dirty++;
2892 }
2893
2894 y++;
2895 }
2896 qemu_pixman_image_unref(tmpbuf);
2897 return has_dirty;
2898 }
2899
2900 static void vnc_refresh(DisplayChangeListener *dcl)
2901 {
2902 VncDisplay *vd = container_of(dcl, VncDisplay, dcl);
2903 VncState *vs, *vn;
2904 int has_dirty, rects = 0;
2905
2906 if (QTAILQ_EMPTY(&vd->clients)) {
2907 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_MAX);
2908 return;
2909 }
2910
2911 graphic_hw_update(vd->dcl.con);
2912
2913 if (vnc_trylock_display(vd)) {
2914 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);
2915 return;
2916 }
2917
2918 has_dirty = vnc_refresh_server_surface(vd);
2919 vnc_unlock_display(vd);
2920
2921 QTAILQ_FOREACH_SAFE(vs, &vd->clients, next, vn) {
2922 rects += vnc_update_client(vs, has_dirty, false);
2923 /* vs might be free()ed here */
2924 }
2925
2926 if (has_dirty && rects) {
2927 vd->dcl.update_interval /= 2;
2928 if (vd->dcl.update_interval < VNC_REFRESH_INTERVAL_BASE) {
2929 vd->dcl.update_interval = VNC_REFRESH_INTERVAL_BASE;
2930 }
2931 } else {
2932 vd->dcl.update_interval += VNC_REFRESH_INTERVAL_INC;
2933 if (vd->dcl.update_interval > VNC_REFRESH_INTERVAL_MAX) {
2934 vd->dcl.update_interval = VNC_REFRESH_INTERVAL_MAX;
2935 }
2936 }
2937 }
2938
2939 static void vnc_connect(VncDisplay *vd, QIOChannelSocket *sioc,
2940 bool skipauth, bool websocket)
2941 {
2942 VncState *vs = g_new0(VncState, 1);
2943 int i;
2944
2945 vs->sioc = sioc;
2946 object_ref(OBJECT(vs->sioc));
2947 vs->ioc = QIO_CHANNEL(sioc);
2948 object_ref(OBJECT(vs->ioc));
2949 vs->vd = vd;
2950
2951 buffer_init(&vs->input, "vnc-input/%p", sioc);
2952 buffer_init(&vs->output, "vnc-output/%p", sioc);
2953 buffer_init(&vs->ws_input, "vnc-ws_input/%p", sioc);
2954 buffer_init(&vs->ws_output, "vnc-ws_output/%p", sioc);
2955 buffer_init(&vs->jobs_buffer, "vnc-jobs_buffer/%p", sioc);
2956
2957 buffer_init(&vs->tight.tight, "vnc-tight/%p", sioc);
2958 buffer_init(&vs->tight.zlib, "vnc-tight-zlib/%p", sioc);
2959 buffer_init(&vs->tight.gradient, "vnc-tight-gradient/%p", sioc);
2960 #ifdef CONFIG_VNC_JPEG
2961 buffer_init(&vs->tight.jpeg, "vnc-tight-jpeg/%p", sioc);
2962 #endif
2963 #ifdef CONFIG_VNC_PNG
2964 buffer_init(&vs->tight.png, "vnc-tight-png/%p", sioc);
2965 #endif
2966 buffer_init(&vs->zlib.zlib, "vnc-zlib/%p", sioc);
2967 buffer_init(&vs->zrle.zrle, "vnc-zrle/%p", sioc);
2968 buffer_init(&vs->zrle.fb, "vnc-zrle-fb/%p", sioc);
2969 buffer_init(&vs->zrle.zlib, "vnc-zrle-zlib/%p", sioc);
2970
2971 if (skipauth) {
2972 vs->auth = VNC_AUTH_NONE;
2973 vs->subauth = VNC_AUTH_INVALID;
2974 } else {
2975 if (websocket) {
2976 vs->auth = vd->ws_auth;
2977 vs->subauth = VNC_AUTH_INVALID;
2978 } else {
2979 vs->auth = vd->auth;
2980 vs->subauth = vd->subauth;
2981 }
2982 }
2983 VNC_DEBUG("Client sioc=%p ws=%d auth=%d subauth=%d\n",
2984 sioc, websocket, vs->auth, vs->subauth);
2985
2986 vs->lossy_rect = g_malloc0(VNC_STAT_ROWS * sizeof (*vs->lossy_rect));
2987 for (i = 0; i < VNC_STAT_ROWS; ++i) {
2988 vs->lossy_rect[i] = g_new0(uint8_t, VNC_STAT_COLS);
2989 }
2990
2991 VNC_DEBUG("New client on socket %p\n", vs->sioc);
2992 update_displaychangelistener(&vd->dcl, VNC_REFRESH_INTERVAL_BASE);
2993 qio_channel_set_blocking(vs->ioc, false, NULL);
2994 if (websocket) {
2995 vs->websocket = 1;
2996 if (vd->ws_tls) {
2997 vs->ioc_tag = qio_channel_add_watch(
2998 vs->ioc, G_IO_IN, vncws_tls_handshake_io, vs, NULL);
2999 } else {
3000 vs->ioc_tag = qio_channel_add_watch(
3001 vs->ioc, G_IO_IN, vncws_handshake_io, vs, NULL);
3002 }
3003 } else {
3004 vs->ioc_tag = qio_channel_add_watch(
3005 vs->ioc, G_IO_IN, vnc_client_io, vs, NULL);
3006 }
3007
3008 vnc_client_cache_addr(vs);
3009 vnc_qmp_event(vs, QAPI_EVENT_VNC_CONNECTED);
3010 vnc_set_share_mode(vs, VNC_SHARE_MODE_CONNECTING);
3011
3012 if (!vs->websocket) {
3013 vnc_init_state(vs);
3014 }
3015
3016 if (vd->num_connecting > vd->connections_limit) {
3017 QTAILQ_FOREACH(vs, &vd->clients, next) {
3018 if (vs->share_mode == VNC_SHARE_MODE_CONNECTING) {
3019 vnc_disconnect_start(vs);
3020 return;
3021 }
3022 }
3023 }
3024 }
3025
3026 void vnc_init_state(VncState *vs)
3027 {
3028 vs->initialized = true;
3029 VncDisplay *vd = vs->vd;
3030 bool first_client = QTAILQ_EMPTY(&vd->clients);
3031
3032 vs->last_x = -1;
3033 vs->last_y = -1;
3034
3035 vs->as.freq = 44100;
3036 vs->as.nchannels = 2;
3037 vs->as.fmt = AUD_FMT_S16;
3038 vs->as.endianness = 0;
3039
3040 qemu_mutex_init(&vs->output_mutex);
3041 vs->bh = qemu_bh_new(vnc_jobs_bh, vs);
3042
3043 QTAILQ_INSERT_TAIL(&vd->clients, vs, next);
3044 if (first_client) {
3045 vnc_update_server_surface(vd);
3046 }
3047
3048 graphic_hw_update(vd->dcl.con);
3049
3050 vnc_write(vs, "RFB 003.008\n", 12);
3051 vnc_flush(vs);
3052 vnc_read_when(vs, protocol_version, 12);
3053 reset_keys(vs);
3054 if (vs->vd->lock_key_sync)
3055 vs->led = qemu_add_led_event_handler(kbd_leds, vs);
3056
3057 vs->mouse_mode_notifier.notify = check_pointer_type_change;
3058 qemu_add_mouse_mode_change_notifier(&vs->mouse_mode_notifier);
3059
3060 /* vs might be free()ed here */
3061 }
3062
3063 static gboolean vnc_listen_io(QIOChannel *ioc,
3064 GIOCondition condition,
3065 void *opaque)
3066 {
3067 VncDisplay *vs = opaque;
3068 QIOChannelSocket *sioc = NULL;
3069 Error *err = NULL;
3070
3071 /* Catch-up */
3072 graphic_hw_update(vs->dcl.con);
3073 sioc = qio_channel_socket_accept(QIO_CHANNEL_SOCKET(ioc), &err);
3074 if (sioc != NULL) {
3075 qio_channel_set_delay(QIO_CHANNEL(sioc), false);
3076 vnc_connect(vs, sioc, false,
3077 ioc != QIO_CHANNEL(vs->lsock));
3078 object_unref(OBJECT(sioc));
3079 } else {
3080 /* client probably closed connection before we got there */
3081 error_free(err);
3082 }
3083
3084 return TRUE;
3085 }
3086
3087 static const DisplayChangeListenerOps dcl_ops = {
3088 .dpy_name = "vnc",
3089 .dpy_refresh = vnc_refresh,
3090 .dpy_gfx_copy = vnc_dpy_copy,
3091 .dpy_gfx_update = vnc_dpy_update,
3092 .dpy_gfx_switch = vnc_dpy_switch,
3093 .dpy_gfx_check_format = qemu_pixman_check_format,
3094 .dpy_mouse_set = vnc_mouse_set,
3095 .dpy_cursor_define = vnc_dpy_cursor_define,
3096 };
3097
3098 void vnc_display_init(const char *id)
3099 {
3100 VncDisplay *vs;
3101
3102 if (vnc_display_find(id) != NULL) {
3103 return;
3104 }
3105 vs = g_malloc0(sizeof(*vs));
3106
3107 vs->id = strdup(id);
3108 QTAILQ_INSERT_TAIL(&vnc_displays, vs, next);
3109
3110 QTAILQ_INIT(&vs->clients);
3111 vs->expires = TIME_MAX;
3112
3113 if (keyboard_layout) {
3114 trace_vnc_key_map_init(keyboard_layout);
3115 vs->kbd_layout = init_keyboard_layout(name2keysym, keyboard_layout);
3116 } else {
3117 vs->kbd_layout = init_keyboard_layout(name2keysym, "en-us");
3118 }
3119
3120 if (!vs->kbd_layout)
3121 exit(1);
3122
3123 qemu_mutex_init(&vs->mutex);
3124 vnc_start_worker_thread();
3125
3126 vs->dcl.ops = &dcl_ops;
3127 register_displaychangelistener(&vs->dcl);
3128 }
3129
3130
3131 static void vnc_display_close(VncDisplay *vs)
3132 {
3133 if (!vs)
3134 return;
3135 vs->enabled = false;
3136 vs->is_unix = false;
3137 if (vs->lsock != NULL) {
3138 if (vs->lsock_tag) {
3139 g_source_remove(vs->lsock_tag);
3140 }
3141 object_unref(OBJECT(vs->lsock));
3142 vs->lsock = NULL;
3143 }
3144 vs->ws_enabled = false;
3145 if (vs->lwebsock != NULL) {
3146 if (vs->lwebsock_tag) {
3147 g_source_remove(vs->lwebsock_tag);
3148 }
3149 object_unref(OBJECT(vs->lwebsock));
3150 vs->lwebsock = NULL;
3151 }
3152 vs->auth = VNC_AUTH_INVALID;
3153 vs->subauth = VNC_AUTH_INVALID;
3154 if (vs->tlscreds) {
3155 object_unparent(OBJECT(vs->tlscreds));
3156 }
3157 g_free(vs->tlsaclname);
3158 vs->tlsaclname = NULL;
3159 }
3160
3161 int vnc_display_password(const char *id, const char *password)
3162 {
3163 VncDisplay *vs = vnc_display_find(id);
3164
3165 if (!vs) {
3166 return -EINVAL;
3167 }
3168 if (vs->auth == VNC_AUTH_NONE) {
3169 error_printf_unless_qmp("If you want use passwords please enable "
3170 "password auth using '-vnc ${dpy},password'.");
3171 return -EINVAL;
3172 }
3173
3174 g_free(vs->password);
3175 vs->password = g_strdup(password);
3176
3177 return 0;
3178 }
3179
3180 int vnc_display_pw_expire(const char *id, time_t expires)
3181 {
3182 VncDisplay *vs = vnc_display_find(id);
3183
3184 if (!vs) {
3185 return -EINVAL;
3186 }
3187
3188 vs->expires = expires;
3189 return 0;
3190 }
3191
3192 char *vnc_display_local_addr(const char *id)
3193 {
3194 VncDisplay *vs = vnc_display_find(id);
3195 SocketAddress *addr;
3196 char *ret;
3197 Error *err = NULL;
3198
3199 assert(vs);
3200
3201 addr = qio_channel_socket_get_local_address(vs->lsock, &err);
3202 if (!addr) {
3203 return NULL;
3204 }
3205
3206 if (addr->type != SOCKET_ADDRESS_KIND_INET) {
3207 qapi_free_SocketAddress(addr);
3208 return NULL;
3209 }
3210 ret = g_strdup_printf("%s;%s", addr->u.inet->host, addr->u.inet->port);
3211 qapi_free_SocketAddress(addr);
3212
3213 return ret;
3214 }
3215
3216 static QemuOptsList qemu_vnc_opts = {
3217 .name = "vnc",
3218 .head = QTAILQ_HEAD_INITIALIZER(qemu_vnc_opts.head),
3219 .implied_opt_name = "vnc",
3220 .desc = {
3221 {
3222 .name = "vnc",
3223 .type = QEMU_OPT_STRING,
3224 },{
3225 .name = "websocket",
3226 .type = QEMU_OPT_STRING,
3227 },{
3228 .name = "tls-creds",
3229 .type = QEMU_OPT_STRING,
3230 },{
3231 /* Deprecated in favour of tls-creds */
3232 .name = "x509",
3233 .type = QEMU_OPT_STRING,
3234 },{
3235 .name = "share",
3236 .type = QEMU_OPT_STRING,
3237 },{
3238 .name = "display",
3239 .type = QEMU_OPT_STRING,
3240 },{
3241 .name = "head",
3242 .type = QEMU_OPT_NUMBER,
3243 },{
3244 .name = "connections",
3245 .type = QEMU_OPT_NUMBER,
3246 },{
3247 .name = "to",
3248 .type = QEMU_OPT_NUMBER,
3249 },{
3250 .name = "ipv4",
3251 .type = QEMU_OPT_BOOL,
3252 },{
3253 .name = "ipv6",
3254 .type = QEMU_OPT_BOOL,
3255 },{
3256 .name = "password",
3257 .type = QEMU_OPT_BOOL,
3258 },{
3259 .name = "reverse",
3260 .type = QEMU_OPT_BOOL,
3261 },{
3262 .name = "lock-key-sync",
3263 .type = QEMU_OPT_BOOL,
3264 },{
3265 .name = "sasl",
3266 .type = QEMU_OPT_BOOL,
3267 },{
3268 /* Deprecated in favour of tls-creds */
3269 .name = "tls",
3270 .type = QEMU_OPT_BOOL,
3271 },{
3272 /* Deprecated in favour of tls-creds */
3273 .name = "x509verify",
3274 .type = QEMU_OPT_STRING,
3275 },{
3276 .name = "acl",
3277 .type = QEMU_OPT_BOOL,
3278 },{
3279 .name = "lossy",
3280 .type = QEMU_OPT_BOOL,
3281 },{
3282 .name = "non-adaptive",
3283 .type = QEMU_OPT_BOOL,
3284 },
3285 { /* end of list */ }
3286 },
3287 };
3288
3289
3290 static int
3291 vnc_display_setup_auth(VncDisplay *vs,
3292 bool password,
3293 bool sasl,
3294 bool websocket,
3295 Error **errp)
3296 {
3297 /*
3298 * We have a choice of 3 authentication options
3299 *
3300 * 1. none
3301 * 2. vnc
3302 * 3. sasl
3303 *
3304 * The channel can be run in 2 modes
3305 *
3306 * 1. clear
3307 * 2. tls
3308 *
3309 * And TLS can use 2 types of credentials
3310 *
3311 * 1. anon
3312 * 2. x509
3313 *
3314 * We thus have 9 possible logical combinations
3315 *
3316 * 1. clear + none
3317 * 2. clear + vnc
3318 * 3. clear + sasl
3319 * 4. tls + anon + none
3320 * 5. tls + anon + vnc
3321 * 6. tls + anon + sasl
3322 * 7. tls + x509 + none
3323 * 8. tls + x509 + vnc
3324 * 9. tls + x509 + sasl
3325 *
3326 * These need to be mapped into the VNC auth schemes
3327 * in an appropriate manner. In regular VNC, all the
3328 * TLS options get mapped into VNC_AUTH_VENCRYPT
3329 * sub-auth types.
3330 *
3331 * In websockets, the https:// protocol already provides
3332 * TLS support, so there is no need to make use of the
3333 * VeNCrypt extension. Furthermore, websockets browser
3334 * clients could not use VeNCrypt even if they wanted to,
3335 * as they cannot control when the TLS handshake takes
3336 * place. Thus there is no option but to rely on https://,
3337 * meaning combinations 4->6 and 7->9 will be mapped to
3338 * VNC auth schemes in the same way as combos 1->3.
3339 *
3340 * Regardless of fact that we have a different mapping to
3341 * VNC auth mechs for plain VNC vs websockets VNC, the end
3342 * result has the same security characteristics.
3343 */
3344 if (password) {
3345 if (vs->tlscreds) {
3346 vs->auth = VNC_AUTH_VENCRYPT;
3347 if (websocket) {
3348 vs->ws_tls = true;
3349 }
3350 if (object_dynamic_cast(OBJECT(vs->tlscreds),
3351 TYPE_QCRYPTO_TLS_CREDS_X509)) {
3352 VNC_DEBUG("Initializing VNC server with x509 password auth\n");
3353 vs->subauth = VNC_AUTH_VENCRYPT_X509VNC;
3354 } else if (object_dynamic_cast(OBJECT(vs->tlscreds),
3355 TYPE_QCRYPTO_TLS_CREDS_ANON)) {
3356 VNC_DEBUG("Initializing VNC server with TLS password auth\n");
3357 vs->subauth = VNC_AUTH_VENCRYPT_TLSVNC;
3358 } else {
3359 error_setg(errp,
3360 "Unsupported TLS cred type %s",
3361 object_get_typename(OBJECT(vs->tlscreds)));
3362 return -1;
3363 }
3364 } else {
3365 VNC_DEBUG("Initializing VNC server with password auth\n");
3366 vs->auth = VNC_AUTH_VNC;
3367 vs->subauth = VNC_AUTH_INVALID;
3368 }
3369 if (websocket) {
3370 vs->ws_auth = VNC_AUTH_VNC;
3371 } else {
3372 vs->ws_auth = VNC_AUTH_INVALID;
3373 }
3374 } else if (sasl) {
3375 if (vs->tlscreds) {
3376 vs->auth = VNC_AUTH_VENCRYPT;
3377 if (websocket) {
3378 vs->ws_tls = true;
3379 }
3380 if (object_dynamic_cast(OBJECT(vs->tlscreds),
3381 TYPE_QCRYPTO_TLS_CREDS_X509)) {
3382 VNC_DEBUG("Initializing VNC server with x509 SASL auth\n");
3383 vs->subauth = VNC_AUTH_VENCRYPT_X509SASL;
3384 } else if (object_dynamic_cast(OBJECT(vs->tlscreds),
3385 TYPE_QCRYPTO_TLS_CREDS_ANON)) {
3386 VNC_DEBUG("Initializing VNC server with TLS SASL auth\n");
3387 vs->subauth = VNC_AUTH_VENCRYPT_TLSSASL;
3388 } else {
3389 error_setg(errp,
3390 "Unsupported TLS cred type %s",
3391 object_get_typename(OBJECT(vs->tlscreds)));
3392 return -1;
3393 }
3394 } else {
3395 VNC_DEBUG("Initializing VNC server with SASL auth\n");
3396 vs->auth = VNC_AUTH_SASL;
3397 vs->subauth = VNC_AUTH_INVALID;
3398 }
3399 if (websocket) {
3400 vs->ws_auth = VNC_AUTH_SASL;
3401 } else {
3402 vs->ws_auth = VNC_AUTH_INVALID;
3403 }
3404 } else {
3405 if (vs->tlscreds) {
3406 vs->auth = VNC_AUTH_VENCRYPT;
3407 if (websocket) {
3408 vs->ws_tls = true;
3409 }
3410 if (object_dynamic_cast(OBJECT(vs->tlscreds),
3411 TYPE_QCRYPTO_TLS_CREDS_X509)) {
3412 VNC_DEBUG("Initializing VNC server with x509 no auth\n");
3413 vs->subauth = VNC_AUTH_VENCRYPT_X509NONE;
3414 } else if (object_dynamic_cast(OBJECT(vs->tlscreds),
3415 TYPE_QCRYPTO_TLS_CREDS_ANON)) {
3416 VNC_DEBUG("Initializing VNC server with TLS no auth\n");
3417 vs->subauth = VNC_AUTH_VENCRYPT_TLSNONE;
3418 } else {
3419 error_setg(errp,
3420 "Unsupported TLS cred type %s",
3421 object_get_typename(OBJECT(vs->tlscreds)));
3422 return -1;
3423 }
3424 } else {
3425 VNC_DEBUG("Initializing VNC server with no auth\n");
3426 vs->auth = VNC_AUTH_NONE;
3427 vs->subauth = VNC_AUTH_INVALID;
3428 }
3429 if (websocket) {
3430 vs->ws_auth = VNC_AUTH_NONE;
3431 } else {
3432 vs->ws_auth = VNC_AUTH_INVALID;
3433 }
3434 }
3435 return 0;
3436 }
3437
3438
3439 /*
3440 * Handle back compat with old CLI syntax by creating some
3441 * suitable QCryptoTLSCreds objects
3442 */
3443 static QCryptoTLSCreds *
3444 vnc_display_create_creds(bool x509,
3445 bool x509verify,
3446 const char *dir,
3447 const char *id,
3448 Error **errp)
3449 {
3450 gchar *credsid = g_strdup_printf("tlsvnc%s", id);
3451 Object *parent = object_get_objects_root();
3452 Object *creds;
3453 Error *err = NULL;
3454
3455 if (x509) {
3456 creds = object_new_with_props(TYPE_QCRYPTO_TLS_CREDS_X509,
3457 parent,
3458 credsid,
3459 &err,
3460 "endpoint", "server",
3461 "dir", dir,
3462 "verify-peer", x509verify ? "yes" : "no",
3463 NULL);
3464 } else {
3465 creds = object_new_with_props(TYPE_QCRYPTO_TLS_CREDS_ANON,
3466 parent,
3467 credsid,
3468 &err,
3469 "endpoint", "server",
3470 NULL);
3471 }
3472
3473 g_free(credsid);
3474
3475 if (err) {
3476 error_propagate(errp, err);
3477 return NULL;
3478 }
3479
3480 return QCRYPTO_TLS_CREDS(creds);
3481 }
3482
3483
3484 void vnc_display_open(const char *id, Error **errp)
3485 {
3486 VncDisplay *vs = vnc_display_find(id);
3487 QemuOpts *opts = qemu_opts_find(&qemu_vnc_opts, id);
3488 SocketAddress *saddr = NULL, *wsaddr = NULL;
3489 const char *share, *device_id;
3490 QemuConsole *con;
3491 bool password = false;
3492 bool reverse = false;
3493 const char *vnc;
3494 char *h;
3495 const char *credid;
3496 bool sasl = false;
3497 #ifdef CONFIG_VNC_SASL
3498 int saslErr;
3499 #endif
3500 int acl = 0;
3501 int lock_key_sync = 1;
3502
3503 if (!vs) {
3504 error_setg(errp, "VNC display not active");
3505 return;
3506 }
3507 vnc_display_close(vs);
3508
3509 if (!opts) {
3510 return;
3511 }
3512 vnc = qemu_opt_get(opts, "vnc");
3513 if (!vnc || strcmp(vnc, "none") == 0) {
3514 return;
3515 }
3516
3517 h = strrchr(vnc, ':');
3518 if (h) {
3519 size_t hlen = h - vnc;
3520
3521 const char *websocket = qemu_opt_get(opts, "websocket");
3522 int to = qemu_opt_get_number(opts, "to", 0);
3523 bool has_ipv4 = qemu_opt_get_bool(opts, "ipv4", false);
3524 bool has_ipv6 = qemu_opt_get_bool(opts, "ipv6", false);
3525
3526 saddr = g_new0(SocketAddress, 1);
3527 if (websocket) {
3528 if (!qcrypto_hash_supports(QCRYPTO_HASH_ALG_SHA1)) {
3529 error_setg(errp,
3530 "SHA1 hash support is required for websockets");
3531 goto fail;
3532 }
3533
3534 wsaddr = g_new0(SocketAddress, 1);
3535 vs->ws_enabled = true;
3536 }
3537
3538 if (strncmp(vnc, "unix:", 5) == 0) {
3539 saddr->type = SOCKET_ADDRESS_KIND_UNIX;
3540 saddr->u.q_unix = g_new0(UnixSocketAddress, 1);
3541 saddr->u.q_unix->path = g_strdup(vnc + 5);
3542
3543 if (vs->ws_enabled) {
3544 error_setg(errp, "UNIX sockets not supported with websock");
3545 goto fail;
3546 }
3547 } else {
3548 unsigned long long baseport;
3549 saddr->type = SOCKET_ADDRESS_KIND_INET;
3550 saddr->u.inet = g_new0(InetSocketAddress, 1);
3551 if (vnc[0] == '[' && vnc[hlen - 1] == ']') {
3552 saddr->u.inet->host = g_strndup(vnc + 1, hlen - 2);
3553 } else {
3554 saddr->u.inet->host = g_strndup(vnc, hlen);
3555 }
3556 if (parse_uint_full(h + 1, &baseport, 10) < 0) {
3557 error_setg(errp, "can't convert to a number: %s", h + 1);
3558 goto fail;
3559 }
3560 if (baseport > 65535 ||
3561 baseport + 5900 > 65535) {
3562 error_setg(errp, "port %s out of range", h + 1);
3563 goto fail;
3564 }
3565 saddr->u.inet->port = g_strdup_printf(
3566 "%d", (int)baseport + 5900);
3567
3568 if (to) {
3569 saddr->u.inet->has_to = true;
3570 saddr->u.inet->to = to + 5900;
3571 }
3572 saddr->u.inet->ipv4 = saddr->u.inet->has_ipv4 = has_ipv4;
3573 saddr->u.inet->ipv6 = saddr->u.inet->has_ipv6 = has_ipv6;
3574
3575 if (vs->ws_enabled) {
3576 wsaddr->type = SOCKET_ADDRESS_KIND_INET;
3577 wsaddr->u.inet = g_new0(InetSocketAddress, 1);
3578 wsaddr->u.inet->host = g_strdup(saddr->u.inet->host);
3579 wsaddr->u.inet->port = g_strdup(websocket);
3580
3581 if (to) {
3582 wsaddr->u.inet->has_to = true;
3583 wsaddr->u.inet->to = to;
3584 }
3585 wsaddr->u.inet->ipv4 = wsaddr->u.inet->has_ipv4 = has_ipv4;
3586 wsaddr->u.inet->ipv6 = wsaddr->u.inet->has_ipv6 = has_ipv6;
3587 }
3588 }
3589 } else {
3590 error_setg(errp, "no vnc port specified");
3591 goto fail;
3592 }
3593
3594 password = qemu_opt_get_bool(opts, "password", false);
3595 if (password) {
3596 if (fips_get_state()) {
3597 error_setg(errp,
3598 "VNC password auth disabled due to FIPS mode, "
3599 "consider using the VeNCrypt or SASL authentication "
3600 "methods as an alternative");
3601 goto fail;
3602 }
3603 if (!qcrypto_cipher_supports(
3604 QCRYPTO_CIPHER_ALG_DES_RFB)) {
3605 error_setg(errp,
3606 "Cipher backend does not support DES RFB algorithm");
3607 goto fail;
3608 }
3609 }
3610
3611 reverse = qemu_opt_get_bool(opts, "reverse", false);
3612 lock_key_sync = qemu_opt_get_bool(opts, "lock-key-sync", true);
3613 sasl = qemu_opt_get_bool(opts, "sasl", false);
3614 #ifndef CONFIG_VNC_SASL
3615 if (sasl) {
3616 error_setg(errp, "VNC SASL auth requires cyrus-sasl support");
3617 goto fail;
3618 }
3619 #endif /* CONFIG_VNC_SASL */
3620 credid = qemu_opt_get(opts, "tls-creds");
3621 if (credid) {
3622 Object *creds;
3623 if (qemu_opt_get(opts, "tls") ||
3624 qemu_opt_get(opts, "x509") ||
3625 qemu_opt_get(opts, "x509verify")) {
3626 error_setg(errp,
3627 "'credid' parameter is mutually exclusive with "
3628 "'tls', 'x509' and 'x509verify' parameters");
3629 goto fail;
3630 }
3631
3632 creds = object_resolve_path_component(
3633 object_get_objects_root(), credid);
3634 if (!creds) {
3635 error_setg(errp, "No TLS credentials with id '%s'",
3636 credid);
3637 goto fail;
3638 }
3639 vs->tlscreds = (QCryptoTLSCreds *)
3640 object_dynamic_cast(creds,
3641 TYPE_QCRYPTO_TLS_CREDS);
3642 if (!vs->tlscreds) {
3643 error_setg(errp, "Object with id '%s' is not TLS credentials",
3644 credid);
3645 goto fail;
3646 }
3647 object_ref(OBJECT(vs->tlscreds));
3648
3649 if (vs->tlscreds->endpoint != QCRYPTO_TLS_CREDS_ENDPOINT_SERVER) {
3650 error_setg(errp,
3651 "Expecting TLS credentials with a server endpoint");
3652 goto fail;
3653 }
3654 } else {
3655 const char *path;
3656 bool tls = false, x509 = false, x509verify = false;
3657 tls = qemu_opt_get_bool(opts, "tls", false);
3658 if (tls) {
3659 path = qemu_opt_get(opts, "x509");
3660
3661 if (path) {
3662 x509 = true;
3663 } else {
3664 path = qemu_opt_get(opts, "x509verify");
3665 if (path) {
3666 x509 = true;
3667 x509verify = true;
3668 }
3669 }
3670 vs->tlscreds = vnc_display_create_creds(x509,
3671 x509verify,
3672 path,
3673 vs->id,
3674 errp);
3675 if (!vs->tlscreds) {
3676 goto fail;
3677 }
3678 }
3679 }
3680 acl = qemu_opt_get_bool(opts, "acl", false);
3681
3682 share = qemu_opt_get(opts, "share");
3683 if (share) {
3684 if (strcmp(share, "ignore") == 0) {
3685 vs->share_policy = VNC_SHARE_POLICY_IGNORE;
3686 } else if (strcmp(share, "allow-exclusive") == 0) {
3687 vs->share_policy = VNC_SHARE_POLICY_ALLOW_EXCLUSIVE;
3688 } else if (strcmp(share, "force-shared") == 0) {
3689 vs->share_policy = VNC_SHARE_POLICY_FORCE_SHARED;
3690 } else {
3691 error_setg(errp, "unknown vnc share= option");
3692 goto fail;
3693 }
3694 } else {
3695 vs->share_policy = VNC_SHARE_POLICY_ALLOW_EXCLUSIVE;
3696 }
3697 vs->connections_limit = qemu_opt_get_number(opts, "connections", 32);
3698
3699 #ifdef CONFIG_VNC_JPEG
3700 vs->lossy = qemu_opt_get_bool(opts, "lossy", false);
3701 #endif
3702 vs->non_adaptive = qemu_opt_get_bool(opts, "non-adaptive", false);
3703 /* adaptive updates are only used with tight encoding and
3704 * if lossy updates are enabled so we can disable all the
3705 * calculations otherwise */
3706 if (!vs->lossy) {
3707 vs->non_adaptive = true;
3708 }
3709
3710 if (acl) {
3711 if (strcmp(vs->id, "default") == 0) {
3712 vs->tlsaclname = g_strdup("vnc.x509dname");
3713 } else {
3714 vs->tlsaclname = g_strdup_printf("vnc.%s.x509dname", vs->id);
3715 }
3716 qemu_acl_init(vs->tlsaclname);
3717 }
3718 #ifdef CONFIG_VNC_SASL
3719 if (acl && sasl) {
3720 char *aclname;
3721
3722 if (strcmp(vs->id, "default") == 0) {
3723 aclname = g_strdup("vnc.username");
3724 } else {
3725 aclname = g_strdup_printf("vnc.%s.username", vs->id);
3726 }
3727 vs->sasl.acl = qemu_acl_init(aclname);
3728 g_free(aclname);
3729 }
3730 #endif
3731
3732 if (vnc_display_setup_auth(vs, password, sasl, vs->ws_enabled, errp) < 0) {
3733 goto fail;
3734 }
3735
3736 #ifdef CONFIG_VNC_SASL
3737 if ((saslErr = sasl_server_init(NULL, "qemu")) != SASL_OK) {
3738 error_setg(errp, "Failed to initialize SASL auth: %s",
3739 sasl_errstring(saslErr, NULL, NULL));
3740 goto fail;
3741 }
3742 #endif
3743 vs->lock_key_sync = lock_key_sync;
3744
3745 device_id = qemu_opt_get(opts, "display");
3746 if (device_id) {
3747 DeviceState *dev;
3748 int head = qemu_opt_get_number(opts, "head", 0);
3749
3750 dev = qdev_find_recursive(sysbus_get_default(), device_id);
3751 if (dev == NULL) {
3752 error_setg(errp, "Device '%s' not found", device_id);
3753 goto fail;
3754 }
3755
3756 con = qemu_console_lookup_by_device(dev, head);
3757 if (con == NULL) {
3758 error_setg(errp, "Device %s is not bound to a QemuConsole",
3759 device_id);
3760 goto fail;
3761 }
3762 } else {
3763 con = NULL;
3764 }
3765
3766 if (con != vs->dcl.con) {
3767 unregister_displaychangelistener(&vs->dcl);
3768 vs->dcl.con = con;
3769 register_displaychangelistener(&vs->dcl);
3770 }
3771
3772 if (reverse) {
3773 /* connect to viewer */
3774 QIOChannelSocket *sioc = NULL;
3775 vs->lsock = NULL;
3776 vs->lwebsock = NULL;
3777 if (vs->ws_enabled) {
3778 error_setg(errp, "Cannot use websockets in reverse mode");
3779 goto fail;
3780 }
3781 vs->is_unix = saddr->type == SOCKET_ADDRESS_KIND_UNIX;
3782 sioc = qio_channel_socket_new();
3783 if (qio_channel_socket_connect_sync(sioc, saddr, errp) < 0) {
3784 goto fail;
3785 }
3786 vnc_connect(vs, sioc, false, false);
3787 object_unref(OBJECT(sioc));
3788 } else {
3789 vs->lsock = qio_channel_socket_new();
3790 if (qio_channel_socket_listen_sync(vs->lsock, saddr, errp) < 0) {
3791 goto fail;
3792 }
3793 vs->is_unix = saddr->type == SOCKET_ADDRESS_KIND_UNIX;
3794 vs->enabled = true;
3795
3796 if (vs->ws_enabled) {
3797 vs->lwebsock = qio_channel_socket_new();
3798 if (qio_channel_socket_listen_sync(vs->lwebsock,
3799 wsaddr, errp) < 0) {
3800 object_unref(OBJECT(vs->lsock));
3801 vs->lsock = NULL;
3802 goto fail;
3803 }
3804 }
3805
3806 vs->lsock_tag = qio_channel_add_watch(
3807 QIO_CHANNEL(vs->lsock),
3808 G_IO_IN, vnc_listen_io, vs, NULL);
3809 if (vs->ws_enabled) {
3810 vs->lwebsock_tag = qio_channel_add_watch(
3811 QIO_CHANNEL(vs->lwebsock),
3812 G_IO_IN, vnc_listen_io, vs, NULL);
3813 }
3814 }
3815
3816 qapi_free_SocketAddress(saddr);
3817 qapi_free_SocketAddress(wsaddr);
3818 return;
3819
3820 fail:
3821 qapi_free_SocketAddress(saddr);
3822 qapi_free_SocketAddress(wsaddr);
3823 vs->enabled = false;
3824 vs->ws_enabled = false;
3825 }
3826
3827 void vnc_display_add_client(const char *id, int csock, bool skipauth)
3828 {
3829 VncDisplay *vs = vnc_display_find(id);
3830 QIOChannelSocket *sioc;
3831
3832 if (!vs) {
3833 return;
3834 }
3835
3836 sioc = qio_channel_socket_new_fd(csock, NULL);
3837 if (sioc) {
3838 vnc_connect(vs, sioc, skipauth, false);
3839 object_unref(OBJECT(sioc));
3840 }
3841 }
3842
3843 static void vnc_auto_assign_id(QemuOptsList *olist, QemuOpts *opts)
3844 {
3845 int i = 2;
3846 char *id;
3847
3848 id = g_strdup("default");
3849 while (qemu_opts_find(olist, id)) {
3850 g_free(id);
3851 id = g_strdup_printf("vnc%d", i++);
3852 }
3853 qemu_opts_set_id(opts, id);
3854 }
3855
3856 QemuOpts *vnc_parse(const char *str, Error **errp)
3857 {
3858 QemuOptsList *olist = qemu_find_opts("vnc");
3859 QemuOpts *opts = qemu_opts_parse(olist, str, true, errp);
3860 const char *id;
3861
3862 if (!opts) {
3863 return NULL;
3864 }
3865
3866 id = qemu_opts_id(opts);
3867 if (!id) {
3868 /* auto-assign id if not present */
3869 vnc_auto_assign_id(olist, opts);
3870 }
3871 return opts;
3872 }
3873
3874 int vnc_init_func(void *opaque, QemuOpts *opts, Error **errp)
3875 {
3876 Error *local_err = NULL;
3877 char *id = (char *)qemu_opts_id(opts);
3878
3879 assert(id);
3880 vnc_display_init(id);
3881 vnc_display_open(id, &local_err);
3882 if (local_err != NULL) {
3883 error_report("Failed to start VNC server: %s",
3884 error_get_pretty(local_err));
3885 error_free(local_err);
3886 exit(1);
3887 }
3888 return 0;
3889 }
3890
3891 static void vnc_register_config(void)
3892 {
3893 qemu_add_opts(&qemu_vnc_opts);
3894 }
3895 machine_init(vnc_register_config);
AR7 emulation for QEMU