2 * QEMU VNC display driver
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
29 #include "sysemu/sysemu.h"
30 #include "qemu/sockets.h"
31 #include "qemu/timer.h"
33 #include "qapi/qmp/types.h"
34 #include "qmp-commands.h"
35 #include "qemu/osdep.h"
37 #define VNC_REFRESH_INTERVAL_BASE GUI_REFRESH_INTERVAL_DEFAULT
38 #define VNC_REFRESH_INTERVAL_INC 50
39 #define VNC_REFRESH_INTERVAL_MAX GUI_REFRESH_INTERVAL_IDLE
40 static const struct timeval VNC_REFRESH_STATS
= { 0, 500000 };
41 static const struct timeval VNC_REFRESH_LOSSY
= { 2, 0 };
43 #include "vnc_keysym.h"
46 static VncDisplay
*vnc_display
; /* needed for info vnc */
48 static int vnc_cursor_define(VncState
*vs
);
49 static void vnc_release_modifiers(VncState
*vs
);
51 static void vnc_set_share_mode(VncState
*vs
, VncShareMode mode
)
54 static const char *mn
[] = {
56 [VNC_SHARE_MODE_CONNECTING
] = "connecting",
57 [VNC_SHARE_MODE_SHARED
] = "shared",
58 [VNC_SHARE_MODE_EXCLUSIVE
] = "exclusive",
59 [VNC_SHARE_MODE_DISCONNECTED
] = "disconnected",
61 fprintf(stderr
, "%s/%d: %s -> %s\n", __func__
,
62 vs
->csock
, mn
[vs
->share_mode
], mn
[mode
]);
65 if (vs
->share_mode
== VNC_SHARE_MODE_EXCLUSIVE
) {
66 vs
->vd
->num_exclusive
--;
68 vs
->share_mode
= mode
;
69 if (vs
->share_mode
== VNC_SHARE_MODE_EXCLUSIVE
) {
70 vs
->vd
->num_exclusive
++;
74 static char *addr_to_string(const char *format
,
75 struct sockaddr_storage
*sa
,
78 char host
[NI_MAXHOST
];
79 char serv
[NI_MAXSERV
];
83 if ((err
= getnameinfo((struct sockaddr
*)sa
, salen
,
86 NI_NUMERICHOST
| NI_NUMERICSERV
)) != 0) {
87 VNC_DEBUG("Cannot resolve address %d: %s\n",
88 err
, gai_strerror(err
));
92 /* Enough for the existing format + the 2 vars we're
94 addrlen
= strlen(format
) + strlen(host
) + strlen(serv
);
95 addr
= g_malloc(addrlen
+ 1);
96 snprintf(addr
, addrlen
, format
, host
, serv
);
103 char *vnc_socket_local_addr(const char *format
, int fd
) {
104 struct sockaddr_storage sa
;
108 if (getsockname(fd
, (struct sockaddr
*)&sa
, &salen
) < 0)
111 return addr_to_string(format
, &sa
, salen
);
114 char *vnc_socket_remote_addr(const char *format
, int fd
) {
115 struct sockaddr_storage sa
;
119 if (getpeername(fd
, (struct sockaddr
*)&sa
, &salen
) < 0)
122 return addr_to_string(format
, &sa
, salen
);
125 static int put_addr_qdict(QDict
*qdict
, struct sockaddr_storage
*sa
,
128 char host
[NI_MAXHOST
];
129 char serv
[NI_MAXSERV
];
132 if ((err
= getnameinfo((struct sockaddr
*)sa
, salen
,
135 NI_NUMERICHOST
| NI_NUMERICSERV
)) != 0) {
136 VNC_DEBUG("Cannot resolve address %d: %s\n",
137 err
, gai_strerror(err
));
141 qdict_put(qdict
, "host", qstring_from_str(host
));
142 qdict_put(qdict
, "service", qstring_from_str(serv
));
143 qdict_put(qdict
, "family",qstring_from_str(inet_strfamily(sa
->ss_family
)));
148 static int vnc_server_addr_put(QDict
*qdict
, int fd
)
150 struct sockaddr_storage sa
;
154 if (getsockname(fd
, (struct sockaddr
*)&sa
, &salen
) < 0) {
158 return put_addr_qdict(qdict
, &sa
, salen
);
161 static int vnc_qdict_remote_addr(QDict
*qdict
, int fd
)
163 struct sockaddr_storage sa
;
167 if (getpeername(fd
, (struct sockaddr
*)&sa
, &salen
) < 0) {
171 return put_addr_qdict(qdict
, &sa
, salen
);
174 static const char *vnc_auth_name(VncDisplay
*vd
) {
176 case VNC_AUTH_INVALID
:
192 case VNC_AUTH_VENCRYPT
:
193 #ifdef CONFIG_VNC_TLS
194 switch (vd
->subauth
) {
195 case VNC_AUTH_VENCRYPT_PLAIN
:
196 return "vencrypt+plain";
197 case VNC_AUTH_VENCRYPT_TLSNONE
:
198 return "vencrypt+tls+none";
199 case VNC_AUTH_VENCRYPT_TLSVNC
:
200 return "vencrypt+tls+vnc";
201 case VNC_AUTH_VENCRYPT_TLSPLAIN
:
202 return "vencrypt+tls+plain";
203 case VNC_AUTH_VENCRYPT_X509NONE
:
204 return "vencrypt+x509+none";
205 case VNC_AUTH_VENCRYPT_X509VNC
:
206 return "vencrypt+x509+vnc";
207 case VNC_AUTH_VENCRYPT_X509PLAIN
:
208 return "vencrypt+x509+plain";
209 case VNC_AUTH_VENCRYPT_TLSSASL
:
210 return "vencrypt+tls+sasl";
211 case VNC_AUTH_VENCRYPT_X509SASL
:
212 return "vencrypt+x509+sasl";
225 static int vnc_server_info_put(QDict
*qdict
)
227 if (vnc_server_addr_put(qdict
, vnc_display
->lsock
) < 0) {
231 qdict_put(qdict
, "auth", qstring_from_str(vnc_auth_name(vnc_display
)));
235 static void vnc_client_cache_auth(VncState
*client
)
237 #if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
245 #if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
246 qdict
= qobject_to_qdict(client
->info
);
249 #ifdef CONFIG_VNC_TLS
250 if (client
->tls
.session
&&
252 qdict_put(qdict
, "x509_dname", qstring_from_str(client
->tls
.dname
));
255 #ifdef CONFIG_VNC_SASL
256 if (client
->sasl
.conn
&&
257 client
->sasl
.username
) {
258 qdict_put(qdict
, "sasl_username",
259 qstring_from_str(client
->sasl
.username
));
264 static void vnc_client_cache_addr(VncState
*client
)
269 if (vnc_qdict_remote_addr(qdict
, client
->csock
) < 0) {
271 /* XXX: how to report the error? */
275 client
->info
= QOBJECT(qdict
);
278 static void vnc_qmp_event(VncState
*vs
, MonitorEvent event
)
287 server
= qdict_new();
288 if (vnc_server_info_put(server
) < 0) {
293 data
= qobject_from_jsonf("{ 'client': %p, 'server': %p }",
294 vs
->info
, QOBJECT(server
));
296 monitor_protocol_event(event
, data
);
298 qobject_incref(vs
->info
);
299 qobject_decref(data
);
302 static VncClientInfo
*qmp_query_vnc_client(const VncState
*client
)
304 struct sockaddr_storage sa
;
305 socklen_t salen
= sizeof(sa
);
306 char host
[NI_MAXHOST
];
307 char serv
[NI_MAXSERV
];
310 if (getpeername(client
->csock
, (struct sockaddr
*)&sa
, &salen
) < 0) {
314 if (getnameinfo((struct sockaddr
*)&sa
, salen
,
317 NI_NUMERICHOST
| NI_NUMERICSERV
) < 0) {
321 info
= g_malloc0(sizeof(*info
));
322 info
->host
= g_strdup(host
);
323 info
->service
= g_strdup(serv
);
324 info
->family
= g_strdup(inet_strfamily(sa
.ss_family
));
326 #ifdef CONFIG_VNC_TLS
327 if (client
->tls
.session
&& client
->tls
.dname
) {
328 info
->has_x509_dname
= true;
329 info
->x509_dname
= g_strdup(client
->tls
.dname
);
332 #ifdef CONFIG_VNC_SASL
333 if (client
->sasl
.conn
&& client
->sasl
.username
) {
334 info
->has_sasl_username
= true;
335 info
->sasl_username
= g_strdup(client
->sasl
.username
);
342 VncInfo
*qmp_query_vnc(Error
**errp
)
344 VncInfo
*info
= g_malloc0(sizeof(*info
));
346 if (vnc_display
== NULL
|| vnc_display
->display
== NULL
) {
347 info
->enabled
= false;
349 VncClientInfoList
*cur_item
= NULL
;
350 struct sockaddr_storage sa
;
351 socklen_t salen
= sizeof(sa
);
352 char host
[NI_MAXHOST
];
353 char serv
[NI_MAXSERV
];
356 info
->enabled
= true;
358 /* for compatibility with the original command */
359 info
->has_clients
= true;
361 QTAILQ_FOREACH(client
, &vnc_display
->clients
, next
) {
362 VncClientInfoList
*cinfo
= g_malloc0(sizeof(*info
));
363 cinfo
->value
= qmp_query_vnc_client(client
);
365 /* XXX: waiting for the qapi to support GSList */
367 info
->clients
= cur_item
= cinfo
;
369 cur_item
->next
= cinfo
;
374 if (vnc_display
->lsock
== -1) {
378 if (getsockname(vnc_display
->lsock
, (struct sockaddr
*)&sa
,
380 error_set(errp
, QERR_UNDEFINED_ERROR
);
384 if (getnameinfo((struct sockaddr
*)&sa
, salen
,
387 NI_NUMERICHOST
| NI_NUMERICSERV
) < 0) {
388 error_set(errp
, QERR_UNDEFINED_ERROR
);
392 info
->has_host
= true;
393 info
->host
= g_strdup(host
);
395 info
->has_service
= true;
396 info
->service
= g_strdup(serv
);
398 info
->has_family
= true;
399 info
->family
= g_strdup(inet_strfamily(sa
.ss_family
));
401 info
->has_auth
= true;
402 info
->auth
= g_strdup(vnc_auth_name(vnc_display
));
408 qapi_free_VncInfo(info
);
413 1) Get the queue working for IO.
414 2) there is some weirdness when using the -S option (the screen is grey
415 and not totally invalidated
416 3) resolutions > 1024
419 static int vnc_update_client(VncState
*vs
, int has_dirty
);
420 static int vnc_update_client_sync(VncState
*vs
, int has_dirty
);
421 static void vnc_disconnect_start(VncState
*vs
);
423 static void vnc_colordepth(VncState
*vs
);
424 static void framebuffer_update_request(VncState
*vs
, int incremental
,
425 int x_position
, int y_position
,
427 static void vnc_refresh(DisplayChangeListener
*dcl
);
428 static int vnc_refresh_server_surface(VncDisplay
*vd
);
430 static void vnc_dpy_update(DisplayChangeListener
*dcl
,
431 int x
, int y
, int w
, int h
)
434 VncDisplay
*vd
= container_of(dcl
, VncDisplay
, dcl
);
435 struct VncSurface
*s
= &vd
->guest
;
436 int width
= surface_width(vd
->ds
);
437 int height
= surface_height(vd
->ds
);
441 /* round x down to ensure the loop only spans one 16-pixel block per,
442 iteration. otherwise, if (x % 16) != 0, the last iteration may span
443 two 16-pixel blocks but we only mark the first as dirty
450 w
= MIN(x
+ w
, width
) - x
;
454 for (i
= 0; i
< w
; i
+= 16)
455 set_bit((x
+ i
) / 16, s
->dirty
[y
]);
458 void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
461 vnc_write_u16(vs
, x
);
462 vnc_write_u16(vs
, y
);
463 vnc_write_u16(vs
, w
);
464 vnc_write_u16(vs
, h
);
466 vnc_write_s32(vs
, encoding
);
469 void buffer_reserve(Buffer
*buffer
, size_t len
)
471 if ((buffer
->capacity
- buffer
->offset
) < len
) {
472 buffer
->capacity
+= (len
+ 1024);
473 buffer
->buffer
= g_realloc(buffer
->buffer
, buffer
->capacity
);
474 if (buffer
->buffer
== NULL
) {
475 fprintf(stderr
, "vnc: out of memory\n");
481 static int buffer_empty(Buffer
*buffer
)
483 return buffer
->offset
== 0;
486 uint8_t *buffer_end(Buffer
*buffer
)
488 return buffer
->buffer
+ buffer
->offset
;
491 void buffer_reset(Buffer
*buffer
)
496 void buffer_free(Buffer
*buffer
)
498 g_free(buffer
->buffer
);
500 buffer
->capacity
= 0;
501 buffer
->buffer
= NULL
;
504 void buffer_append(Buffer
*buffer
, const void *data
, size_t len
)
506 memcpy(buffer
->buffer
+ buffer
->offset
, data
, len
);
507 buffer
->offset
+= len
;
510 void buffer_advance(Buffer
*buf
, size_t len
)
512 memmove(buf
->buffer
, buf
->buffer
+ len
,
513 (buf
->offset
- len
));
517 static void vnc_desktop_resize(VncState
*vs
)
519 DisplaySurface
*ds
= vs
->vd
->ds
;
521 if (vs
->csock
== -1 || !vnc_has_feature(vs
, VNC_FEATURE_RESIZE
)) {
524 if (vs
->client_width
== surface_width(ds
) &&
525 vs
->client_height
== surface_height(ds
)) {
528 vs
->client_width
= surface_width(ds
);
529 vs
->client_height
= surface_height(ds
);
531 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
533 vnc_write_u16(vs
, 1); /* number of rects */
534 vnc_framebuffer_update(vs
, 0, 0, vs
->client_width
, vs
->client_height
,
535 VNC_ENCODING_DESKTOPRESIZE
);
536 vnc_unlock_output(vs
);
540 static void vnc_abort_display_jobs(VncDisplay
*vd
)
544 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
547 vnc_unlock_output(vs
);
549 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
552 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
555 vnc_unlock_output(vs
);
559 int vnc_server_fb_stride(VncDisplay
*vd
)
561 return pixman_image_get_stride(vd
->server
);
564 void *vnc_server_fb_ptr(VncDisplay
*vd
, int x
, int y
)
568 ptr
= (uint8_t *)pixman_image_get_data(vd
->server
);
569 ptr
+= y
* vnc_server_fb_stride(vd
);
570 ptr
+= x
* VNC_SERVER_FB_BYTES
;
574 static void vnc_dpy_switch(DisplayChangeListener
*dcl
,
575 DisplaySurface
*surface
)
577 VncDisplay
*vd
= container_of(dcl
, VncDisplay
, dcl
);
580 vnc_abort_display_jobs(vd
);
583 qemu_pixman_image_unref(vd
->server
);
585 vd
->server
= pixman_image_create_bits(VNC_SERVER_FB_FORMAT
,
586 surface_width(vd
->ds
),
587 surface_height(vd
->ds
),
592 if (ds_get_bytes_per_pixel(ds
) != vd
->guest
.ds
->pf
.bytes_per_pixel
)
593 console_color_init(ds
);
595 qemu_pixman_image_unref(vd
->guest
.fb
);
596 vd
->guest
.fb
= pixman_image_ref(surface
->image
);
597 vd
->guest
.format
= surface
->format
;
598 memset(vd
->guest
.dirty
, 0xFF, sizeof(vd
->guest
.dirty
));
600 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
602 vnc_desktop_resize(vs
);
603 if (vs
->vd
->cursor
) {
604 vnc_cursor_define(vs
);
606 memset(vs
->dirty
, 0xFF, sizeof(vs
->dirty
));
611 static void vnc_write_pixels_copy(VncState
*vs
,
612 void *pixels
, int size
)
614 vnc_write(vs
, pixels
, size
);
617 /* slowest but generic code. */
618 void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
)
622 #if VNC_SERVER_FB_FORMAT == PIXMAN_FORMAT(32, PIXMAN_TYPE_ARGB, 0, 8, 8, 8)
623 r
= (((v
& 0x00ff0000) >> 16) << vs
->client_pf
.rbits
) >> 8;
624 g
= (((v
& 0x0000ff00) >> 8) << vs
->client_pf
.gbits
) >> 8;
625 b
= (((v
& 0x000000ff) >> 0) << vs
->client_pf
.bbits
) >> 8;
627 # error need some bits here if you change VNC_SERVER_FB_FORMAT
629 v
= (r
<< vs
->client_pf
.rshift
) |
630 (g
<< vs
->client_pf
.gshift
) |
631 (b
<< vs
->client_pf
.bshift
);
632 switch (vs
->client_pf
.bytes_per_pixel
) {
662 static void vnc_write_pixels_generic(VncState
*vs
,
663 void *pixels1
, int size
)
667 if (VNC_SERVER_FB_BYTES
== 4) {
668 uint32_t *pixels
= pixels1
;
671 for (i
= 0; i
< n
; i
++) {
672 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
673 vnc_write(vs
, buf
, vs
->client_pf
.bytes_per_pixel
);
678 int vnc_raw_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
)
682 VncDisplay
*vd
= vs
->vd
;
684 row
= vnc_server_fb_ptr(vd
, x
, y
);
685 for (i
= 0; i
< h
; i
++) {
686 vs
->write_pixels(vs
, row
, w
* VNC_SERVER_FB_BYTES
);
687 row
+= vnc_server_fb_stride(vd
);
692 int vnc_send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
)
696 switch(vs
->vnc_encoding
) {
697 case VNC_ENCODING_ZLIB
:
698 n
= vnc_zlib_send_framebuffer_update(vs
, x
, y
, w
, h
);
700 case VNC_ENCODING_HEXTILE
:
701 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_HEXTILE
);
702 n
= vnc_hextile_send_framebuffer_update(vs
, x
, y
, w
, h
);
704 case VNC_ENCODING_TIGHT
:
705 n
= vnc_tight_send_framebuffer_update(vs
, x
, y
, w
, h
);
707 case VNC_ENCODING_TIGHT_PNG
:
708 n
= vnc_tight_png_send_framebuffer_update(vs
, x
, y
, w
, h
);
710 case VNC_ENCODING_ZRLE
:
711 n
= vnc_zrle_send_framebuffer_update(vs
, x
, y
, w
, h
);
713 case VNC_ENCODING_ZYWRLE
:
714 n
= vnc_zywrle_send_framebuffer_update(vs
, x
, y
, w
, h
);
717 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_RAW
);
718 n
= vnc_raw_send_framebuffer_update(vs
, x
, y
, w
, h
);
724 static void vnc_copy(VncState
*vs
, int src_x
, int src_y
, int dst_x
, int dst_y
, int w
, int h
)
726 /* send bitblit op to the vnc client */
728 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
730 vnc_write_u16(vs
, 1); /* number of rects */
731 vnc_framebuffer_update(vs
, dst_x
, dst_y
, w
, h
, VNC_ENCODING_COPYRECT
);
732 vnc_write_u16(vs
, src_x
);
733 vnc_write_u16(vs
, src_y
);
734 vnc_unlock_output(vs
);
738 static void vnc_dpy_copy(DisplayChangeListener
*dcl
,
739 int src_x
, int src_y
,
740 int dst_x
, int dst_y
, int w
, int h
)
742 VncDisplay
*vd
= container_of(dcl
, VncDisplay
, dcl
);
746 int i
, x
, y
, pitch
, inc
, w_lim
, s
;
749 vnc_refresh_server_surface(vd
);
750 QTAILQ_FOREACH_SAFE(vs
, &vd
->clients
, next
, vn
) {
751 if (vnc_has_feature(vs
, VNC_FEATURE_COPYRECT
)) {
752 vs
->force_update
= 1;
753 vnc_update_client_sync(vs
, 1);
754 /* vs might be free()ed here */
758 /* do bitblit op on the local surface too */
759 pitch
= vnc_server_fb_stride(vd
);
760 src_row
= vnc_server_fb_ptr(vd
, src_x
, src_y
);
761 dst_row
= vnc_server_fb_ptr(vd
, dst_x
, dst_y
);
766 src_row
+= pitch
* (h
-1);
767 dst_row
+= pitch
* (h
-1);
772 w_lim
= w
- (16 - (dst_x
% 16));
776 w_lim
= w
- (w_lim
% 16);
777 for (i
= 0; i
< h
; i
++) {
778 for (x
= 0; x
<= w_lim
;
779 x
+= s
, src_row
+= cmp_bytes
, dst_row
+= cmp_bytes
) {
781 if ((s
= w
- w_lim
) == 0)
784 s
= (16 - (dst_x
% 16));
789 cmp_bytes
= s
* VNC_SERVER_FB_BYTES
;
790 if (memcmp(src_row
, dst_row
, cmp_bytes
) == 0)
792 memmove(dst_row
, src_row
, cmp_bytes
);
793 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
794 if (!vnc_has_feature(vs
, VNC_FEATURE_COPYRECT
)) {
795 set_bit(((x
+ dst_x
) / 16), vs
->dirty
[y
]);
799 src_row
+= pitch
- w
* VNC_SERVER_FB_BYTES
;
800 dst_row
+= pitch
- w
* VNC_SERVER_FB_BYTES
;
804 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
805 if (vnc_has_feature(vs
, VNC_FEATURE_COPYRECT
)) {
806 vnc_copy(vs
, src_x
, src_y
, dst_x
, dst_y
, w
, h
);
811 static void vnc_mouse_set(DisplayChangeListener
*dcl
,
812 int x
, int y
, int visible
)
814 /* can we ask the client(s) to move the pointer ??? */
817 static int vnc_cursor_define(VncState
*vs
)
819 QEMUCursor
*c
= vs
->vd
->cursor
;
822 if (vnc_has_feature(vs
, VNC_FEATURE_RICH_CURSOR
)) {
824 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
825 vnc_write_u8(vs
, 0); /* padding */
826 vnc_write_u16(vs
, 1); /* # of rects */
827 vnc_framebuffer_update(vs
, c
->hot_x
, c
->hot_y
, c
->width
, c
->height
,
828 VNC_ENCODING_RICH_CURSOR
);
829 isize
= c
->width
* c
->height
* vs
->client_pf
.bytes_per_pixel
;
830 vnc_write_pixels_generic(vs
, c
->data
, isize
);
831 vnc_write(vs
, vs
->vd
->cursor_mask
, vs
->vd
->cursor_msize
);
832 vnc_unlock_output(vs
);
838 static void vnc_dpy_cursor_define(DisplayChangeListener
*dcl
,
841 VncDisplay
*vd
= vnc_display
;
844 cursor_put(vd
->cursor
);
845 g_free(vd
->cursor_mask
);
848 cursor_get(vd
->cursor
);
849 vd
->cursor_msize
= cursor_get_mono_bpl(c
) * c
->height
;
850 vd
->cursor_mask
= g_malloc0(vd
->cursor_msize
);
851 cursor_get_mono_mask(c
, 0, vd
->cursor_mask
);
853 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
854 vnc_cursor_define(vs
);
858 static int find_and_clear_dirty_height(struct VncState
*vs
,
859 int y
, int last_x
, int x
, int height
)
863 for (h
= 1; h
< (height
- y
); h
++) {
865 if (!test_bit(last_x
, vs
->dirty
[y
+ h
])) {
868 for (tmp_x
= last_x
; tmp_x
< x
; tmp_x
++) {
869 clear_bit(tmp_x
, vs
->dirty
[y
+ h
]);
876 static int vnc_update_client_sync(VncState
*vs
, int has_dirty
)
878 int ret
= vnc_update_client(vs
, has_dirty
);
883 static int vnc_update_client(VncState
*vs
, int has_dirty
)
885 if (vs
->need_update
&& vs
->csock
!= -1) {
886 VncDisplay
*vd
= vs
->vd
;
893 if (vs
->output
.offset
&& !vs
->audio_cap
&& !vs
->force_update
)
894 /* kernel send buffers are full -> drop frames to throttle */
897 if (!has_dirty
&& !vs
->audio_cap
&& !vs
->force_update
)
901 * Send screen updates to the vnc client using the server
902 * surface and server dirty map. guest surface updates
903 * happening in parallel don't disturb us, the next pass will
904 * send them to the client.
906 job
= vnc_job_new(vs
);
908 width
= MIN(pixman_image_get_width(vd
->server
), vs
->client_width
);
909 height
= MIN(pixman_image_get_height(vd
->server
), vs
->client_height
);
911 for (y
= 0; y
< height
; y
++) {
914 for (x
= 0; x
< width
/ 16; x
++) {
915 if (test_and_clear_bit(x
, vs
->dirty
[y
])) {
921 int h
= find_and_clear_dirty_height(vs
, y
, last_x
, x
,
924 n
+= vnc_job_add_rect(job
, last_x
* 16, y
,
925 (x
- last_x
) * 16, h
);
931 int h
= find_and_clear_dirty_height(vs
, y
, last_x
, x
, height
);
932 n
+= vnc_job_add_rect(job
, last_x
* 16, y
,
933 (x
- last_x
) * 16, h
);
938 vs
->force_update
= 0;
943 vnc_disconnect_finish(vs
);
949 static void audio_capture_notify(void *opaque
, audcnotification_e cmd
)
951 VncState
*vs
= opaque
;
954 case AUD_CNOTIFY_DISABLE
:
956 vnc_write_u8(vs
, VNC_MSG_SERVER_QEMU
);
957 vnc_write_u8(vs
, VNC_MSG_SERVER_QEMU_AUDIO
);
958 vnc_write_u16(vs
, VNC_MSG_SERVER_QEMU_AUDIO_END
);
959 vnc_unlock_output(vs
);
963 case AUD_CNOTIFY_ENABLE
:
965 vnc_write_u8(vs
, VNC_MSG_SERVER_QEMU
);
966 vnc_write_u8(vs
, VNC_MSG_SERVER_QEMU_AUDIO
);
967 vnc_write_u16(vs
, VNC_MSG_SERVER_QEMU_AUDIO_BEGIN
);
968 vnc_unlock_output(vs
);
974 static void audio_capture_destroy(void *opaque
)
978 static void audio_capture(void *opaque
, void *buf
, int size
)
980 VncState
*vs
= opaque
;
983 vnc_write_u8(vs
, VNC_MSG_SERVER_QEMU
);
984 vnc_write_u8(vs
, VNC_MSG_SERVER_QEMU_AUDIO
);
985 vnc_write_u16(vs
, VNC_MSG_SERVER_QEMU_AUDIO_DATA
);
986 vnc_write_u32(vs
, size
);
987 vnc_write(vs
, buf
, size
);
988 vnc_unlock_output(vs
);
992 static void audio_add(VncState
*vs
)
994 struct audio_capture_ops ops
;
997 monitor_printf(default_mon
, "audio already running\n");
1001 ops
.notify
= audio_capture_notify
;
1002 ops
.destroy
= audio_capture_destroy
;
1003 ops
.capture
= audio_capture
;
1005 vs
->audio_cap
= AUD_add_capture(&vs
->as
, &ops
, vs
);
1006 if (!vs
->audio_cap
) {
1007 monitor_printf(default_mon
, "Failed to add audio capture\n");
1011 static void audio_del(VncState
*vs
)
1013 if (vs
->audio_cap
) {
1014 AUD_del_capture(vs
->audio_cap
, vs
);
1015 vs
->audio_cap
= NULL
;
1019 static void vnc_disconnect_start(VncState
*vs
)
1021 if (vs
->csock
== -1)
1023 vnc_set_share_mode(vs
, VNC_SHARE_MODE_DISCONNECTED
);
1024 qemu_set_fd_handler2(vs
->csock
, NULL
, NULL
, NULL
, NULL
);
1025 closesocket(vs
->csock
);
1029 void vnc_disconnect_finish(VncState
*vs
)
1033 vnc_jobs_join(vs
); /* Wait encoding jobs */
1035 vnc_lock_output(vs
);
1036 vnc_qmp_event(vs
, QEVENT_VNC_DISCONNECTED
);
1038 buffer_free(&vs
->input
);
1039 buffer_free(&vs
->output
);
1040 #ifdef CONFIG_VNC_WS
1041 buffer_free(&vs
->ws_input
);
1042 buffer_free(&vs
->ws_output
);
1043 #endif /* CONFIG_VNC_WS */
1045 qobject_decref(vs
->info
);
1048 vnc_tight_clear(vs
);
1051 #ifdef CONFIG_VNC_TLS
1052 vnc_tls_client_cleanup(vs
);
1053 #endif /* CONFIG_VNC_TLS */
1054 #ifdef CONFIG_VNC_SASL
1055 vnc_sasl_client_cleanup(vs
);
1056 #endif /* CONFIG_VNC_SASL */
1058 vnc_release_modifiers(vs
);
1060 if (vs
->initialized
) {
1061 QTAILQ_REMOVE(&vs
->vd
->clients
, vs
, next
);
1062 qemu_remove_mouse_mode_change_notifier(&vs
->mouse_mode_notifier
);
1065 if (vs
->vd
->lock_key_sync
)
1066 qemu_remove_led_event_handler(vs
->led
);
1067 vnc_unlock_output(vs
);
1069 qemu_mutex_destroy(&vs
->output_mutex
);
1070 if (vs
->bh
!= NULL
) {
1071 qemu_bh_delete(vs
->bh
);
1073 buffer_free(&vs
->jobs_buffer
);
1075 for (i
= 0; i
< VNC_STAT_ROWS
; ++i
) {
1076 g_free(vs
->lossy_rect
[i
]);
1078 g_free(vs
->lossy_rect
);
1082 int vnc_client_io_error(VncState
*vs
, int ret
, int last_errno
)
1084 if (ret
== 0 || ret
== -1) {
1086 switch (last_errno
) {
1090 case WSAEWOULDBLOCK
:
1098 VNC_DEBUG("Closing down client sock: ret %d, errno %d\n",
1099 ret
, ret
< 0 ? last_errno
: 0);
1100 vnc_disconnect_start(vs
);
1108 void vnc_client_error(VncState
*vs
)
1110 VNC_DEBUG("Closing down client sock: protocol error\n");
1111 vnc_disconnect_start(vs
);
1114 #ifdef CONFIG_VNC_TLS
1115 static long vnc_client_write_tls(gnutls_session_t
*session
,
1116 const uint8_t *data
,
1119 long ret
= gnutls_write(*session
, data
, datalen
);
1121 if (ret
== GNUTLS_E_AGAIN
) {
1130 #endif /* CONFIG_VNC_TLS */
1133 * Called to write a chunk of data to the client socket. The data may
1134 * be the raw data, or may have already been encoded by SASL.
1135 * The data will be written either straight onto the socket, or
1136 * written via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1138 * NB, it is theoretically possible to have 2 layers of encryption,
1139 * both SASL, and this TLS layer. It is highly unlikely in practice
1140 * though, since SASL encryption will typically be a no-op if TLS
1143 * Returns the number of bytes written, which may be less than
1144 * the requested 'datalen' if the socket would block. Returns
1145 * -1 on error, and disconnects the client socket.
1147 long vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
)
1150 #ifdef CONFIG_VNC_TLS
1151 if (vs
->tls
.session
) {
1152 ret
= vnc_client_write_tls(&vs
->tls
.session
, data
, datalen
);
1154 #ifdef CONFIG_VNC_WS
1155 if (vs
->ws_tls
.session
) {
1156 ret
= vnc_client_write_tls(&vs
->ws_tls
.session
, data
, datalen
);
1158 #endif /* CONFIG_VNC_WS */
1159 #endif /* CONFIG_VNC_TLS */
1161 ret
= send(vs
->csock
, (const void *)data
, datalen
, 0);
1163 #ifdef CONFIG_VNC_TLS
1165 #endif /* CONFIG_VNC_TLS */
1166 VNC_DEBUG("Wrote wire %p %zd -> %ld\n", data
, datalen
, ret
);
1167 return vnc_client_io_error(vs
, ret
, socket_error());
1172 * Called to write buffered data to the client socket, when not
1173 * using any SASL SSF encryption layers. Will write as much data
1174 * as possible without blocking. If all buffered data is written,
1175 * will switch the FD poll() handler back to read monitoring.
1177 * Returns the number of bytes written, which may be less than
1178 * the buffered output data if the socket would block. Returns
1179 * -1 on error, and disconnects the client socket.
1181 static long vnc_client_write_plain(VncState
*vs
)
1185 #ifdef CONFIG_VNC_SASL
1186 VNC_DEBUG("Write Plain: Pending output %p size %zd offset %zd. Wait SSF %d\n",
1187 vs
->output
.buffer
, vs
->output
.capacity
, vs
->output
.offset
,
1188 vs
->sasl
.waitWriteSSF
);
1190 if (vs
->sasl
.conn
&&
1192 vs
->sasl
.waitWriteSSF
) {
1193 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->sasl
.waitWriteSSF
);
1195 vs
->sasl
.waitWriteSSF
-= ret
;
1197 #endif /* CONFIG_VNC_SASL */
1198 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->output
.offset
);
1202 buffer_advance(&vs
->output
, ret
);
1204 if (vs
->output
.offset
== 0) {
1205 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
1213 * First function called whenever there is data to be written to
1214 * the client socket. Will delegate actual work according to whether
1215 * SASL SSF layers are enabled (thus requiring encryption calls)
1217 static void vnc_client_write_locked(void *opaque
)
1219 VncState
*vs
= opaque
;
1221 #ifdef CONFIG_VNC_SASL
1222 if (vs
->sasl
.conn
&&
1224 !vs
->sasl
.waitWriteSSF
) {
1225 vnc_client_write_sasl(vs
);
1227 #endif /* CONFIG_VNC_SASL */
1229 #ifdef CONFIG_VNC_WS
1230 if (vs
->encode_ws
) {
1231 vnc_client_write_ws(vs
);
1233 #endif /* CONFIG_VNC_WS */
1235 vnc_client_write_plain(vs
);
1240 void vnc_client_write(void *opaque
)
1242 VncState
*vs
= opaque
;
1244 vnc_lock_output(vs
);
1245 if (vs
->output
.offset
1246 #ifdef CONFIG_VNC_WS
1247 || vs
->ws_output
.offset
1250 vnc_client_write_locked(opaque
);
1251 } else if (vs
->csock
!= -1) {
1252 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
1254 vnc_unlock_output(vs
);
1257 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
)
1259 vs
->read_handler
= func
;
1260 vs
->read_handler_expect
= expecting
;
1263 #ifdef CONFIG_VNC_TLS
1264 static long vnc_client_read_tls(gnutls_session_t
*session
, uint8_t *data
,
1267 long ret
= gnutls_read(*session
, data
, datalen
);
1269 if (ret
== GNUTLS_E_AGAIN
) {
1278 #endif /* CONFIG_VNC_TLS */
1281 * Called to read a chunk of data from the client socket. The data may
1282 * be the raw data, or may need to be further decoded by SASL.
1283 * The data will be read either straight from to the socket, or
1284 * read via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1286 * NB, it is theoretically possible to have 2 layers of encryption,
1287 * both SASL, and this TLS layer. It is highly unlikely in practice
1288 * though, since SASL encryption will typically be a no-op if TLS
1291 * Returns the number of bytes read, which may be less than
1292 * the requested 'datalen' if the socket would block. Returns
1293 * -1 on error, and disconnects the client socket.
1295 long vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
)
1298 #ifdef CONFIG_VNC_TLS
1299 if (vs
->tls
.session
) {
1300 ret
= vnc_client_read_tls(&vs
->tls
.session
, data
, datalen
);
1302 #ifdef CONFIG_VNC_WS
1303 if (vs
->ws_tls
.session
) {
1304 ret
= vnc_client_read_tls(&vs
->ws_tls
.session
, data
, datalen
);
1306 #endif /* CONFIG_VNC_WS */
1307 #endif /* CONFIG_VNC_TLS */
1309 ret
= qemu_recv(vs
->csock
, data
, datalen
, 0);
1311 #ifdef CONFIG_VNC_TLS
1313 #endif /* CONFIG_VNC_TLS */
1314 VNC_DEBUG("Read wire %p %zd -> %ld\n", data
, datalen
, ret
);
1315 return vnc_client_io_error(vs
, ret
, socket_error());
1320 * Called to read data from the client socket to the input buffer,
1321 * when not using any SASL SSF encryption layers. Will read as much
1322 * data as possible without blocking.
1324 * Returns the number of bytes read. Returns -1 on error, and
1325 * disconnects the client socket.
1327 static long vnc_client_read_plain(VncState
*vs
)
1330 VNC_DEBUG("Read plain %p size %zd offset %zd\n",
1331 vs
->input
.buffer
, vs
->input
.capacity
, vs
->input
.offset
);
1332 buffer_reserve(&vs
->input
, 4096);
1333 ret
= vnc_client_read_buf(vs
, buffer_end(&vs
->input
), 4096);
1336 vs
->input
.offset
+= ret
;
1340 static void vnc_jobs_bh(void *opaque
)
1342 VncState
*vs
= opaque
;
1344 vnc_jobs_consume_buffer(vs
);
1348 * First function called whenever there is more data to be read from
1349 * the client socket. Will delegate actual work according to whether
1350 * SASL SSF layers are enabled (thus requiring decryption calls)
1352 void vnc_client_read(void *opaque
)
1354 VncState
*vs
= opaque
;
1357 #ifdef CONFIG_VNC_SASL
1358 if (vs
->sasl
.conn
&& vs
->sasl
.runSSF
)
1359 ret
= vnc_client_read_sasl(vs
);
1361 #endif /* CONFIG_VNC_SASL */
1362 #ifdef CONFIG_VNC_WS
1363 if (vs
->encode_ws
) {
1364 ret
= vnc_client_read_ws(vs
);
1366 vnc_disconnect_start(vs
);
1368 } else if (ret
== -2) {
1369 vnc_client_error(vs
);
1373 #endif /* CONFIG_VNC_WS */
1375 ret
= vnc_client_read_plain(vs
);
1378 if (vs
->csock
== -1)
1379 vnc_disconnect_finish(vs
);
1383 while (vs
->read_handler
&& vs
->input
.offset
>= vs
->read_handler_expect
) {
1384 size_t len
= vs
->read_handler_expect
;
1387 ret
= vs
->read_handler(vs
, vs
->input
.buffer
, len
);
1388 if (vs
->csock
== -1) {
1389 vnc_disconnect_finish(vs
);
1394 buffer_advance(&vs
->input
, len
);
1396 vs
->read_handler_expect
= ret
;
1401 void vnc_write(VncState
*vs
, const void *data
, size_t len
)
1403 buffer_reserve(&vs
->output
, len
);
1405 if (vs
->csock
!= -1 && buffer_empty(&vs
->output
)) {
1406 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, vnc_client_write
, vs
);
1409 buffer_append(&vs
->output
, data
, len
);
1412 void vnc_write_s32(VncState
*vs
, int32_t value
)
1414 vnc_write_u32(vs
, *(uint32_t *)&value
);
1417 void vnc_write_u32(VncState
*vs
, uint32_t value
)
1421 buf
[0] = (value
>> 24) & 0xFF;
1422 buf
[1] = (value
>> 16) & 0xFF;
1423 buf
[2] = (value
>> 8) & 0xFF;
1424 buf
[3] = value
& 0xFF;
1426 vnc_write(vs
, buf
, 4);
1429 void vnc_write_u16(VncState
*vs
, uint16_t value
)
1433 buf
[0] = (value
>> 8) & 0xFF;
1434 buf
[1] = value
& 0xFF;
1436 vnc_write(vs
, buf
, 2);
1439 void vnc_write_u8(VncState
*vs
, uint8_t value
)
1441 vnc_write(vs
, (char *)&value
, 1);
1444 void vnc_flush(VncState
*vs
)
1446 vnc_lock_output(vs
);
1447 if (vs
->csock
!= -1 && (vs
->output
.offset
1448 #ifdef CONFIG_VNC_WS
1449 || vs
->ws_output
.offset
1452 vnc_client_write_locked(vs
);
1454 vnc_unlock_output(vs
);
1457 static uint8_t read_u8(uint8_t *data
, size_t offset
)
1459 return data
[offset
];
1462 static uint16_t read_u16(uint8_t *data
, size_t offset
)
1464 return ((data
[offset
] & 0xFF) << 8) | (data
[offset
+ 1] & 0xFF);
1467 static int32_t read_s32(uint8_t *data
, size_t offset
)
1469 return (int32_t)((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1470 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1473 uint32_t read_u32(uint8_t *data
, size_t offset
)
1475 return ((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1476 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1479 static void client_cut_text(VncState
*vs
, size_t len
, uint8_t *text
)
1483 static void check_pointer_type_change(Notifier
*notifier
, void *data
)
1485 VncState
*vs
= container_of(notifier
, VncState
, mouse_mode_notifier
);
1486 int absolute
= kbd_mouse_is_absolute();
1488 if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
) && vs
->absolute
!= absolute
) {
1489 vnc_lock_output(vs
);
1490 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
1491 vnc_write_u8(vs
, 0);
1492 vnc_write_u16(vs
, 1);
1493 vnc_framebuffer_update(vs
, absolute
, 0,
1494 surface_width(vs
->vd
->ds
),
1495 surface_height(vs
->vd
->ds
),
1496 VNC_ENCODING_POINTER_TYPE_CHANGE
);
1497 vnc_unlock_output(vs
);
1500 vs
->absolute
= absolute
;
1503 static void pointer_event(VncState
*vs
, int button_mask
, int x
, int y
)
1507 int width
= surface_width(vs
->vd
->ds
);
1508 int height
= surface_height(vs
->vd
->ds
);
1510 if (button_mask
& 0x01)
1511 buttons
|= MOUSE_EVENT_LBUTTON
;
1512 if (button_mask
& 0x02)
1513 buttons
|= MOUSE_EVENT_MBUTTON
;
1514 if (button_mask
& 0x04)
1515 buttons
|= MOUSE_EVENT_RBUTTON
;
1516 if (button_mask
& 0x08)
1518 if (button_mask
& 0x10)
1522 kbd_mouse_event(width
> 1 ? x
* 0x7FFF / (width
- 1) : 0x4000,
1523 height
> 1 ? y
* 0x7FFF / (height
- 1) : 0x4000,
1525 } else if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
)) {
1529 kbd_mouse_event(x
, y
, dz
, buttons
);
1531 if (vs
->last_x
!= -1)
1532 kbd_mouse_event(x
- vs
->last_x
,
1540 static void reset_keys(VncState
*vs
)
1543 for(i
= 0; i
< 256; i
++) {
1544 if (vs
->modifiers_state
[i
]) {
1545 if (i
& SCANCODE_GREY
)
1546 kbd_put_keycode(SCANCODE_EMUL0
);
1547 kbd_put_keycode(i
| SCANCODE_UP
);
1548 vs
->modifiers_state
[i
] = 0;
1553 static void press_key(VncState
*vs
, int keysym
)
1555 int keycode
= keysym2scancode(vs
->vd
->kbd_layout
, keysym
) & SCANCODE_KEYMASK
;
1556 if (keycode
& SCANCODE_GREY
)
1557 kbd_put_keycode(SCANCODE_EMUL0
);
1558 kbd_put_keycode(keycode
& SCANCODE_KEYCODEMASK
);
1559 if (keycode
& SCANCODE_GREY
)
1560 kbd_put_keycode(SCANCODE_EMUL0
);
1561 kbd_put_keycode(keycode
| SCANCODE_UP
);
1564 static int current_led_state(VncState
*vs
)
1568 if (vs
->modifiers_state
[0x46]) {
1569 ledstate
|= QEMU_SCROLL_LOCK_LED
;
1571 if (vs
->modifiers_state
[0x45]) {
1572 ledstate
|= QEMU_NUM_LOCK_LED
;
1574 if (vs
->modifiers_state
[0x3a]) {
1575 ledstate
|= QEMU_CAPS_LOCK_LED
;
1581 static void vnc_led_state_change(VncState
*vs
)
1585 if (!vnc_has_feature(vs
, VNC_FEATURE_LED_STATE
)) {
1589 ledstate
= current_led_state(vs
);
1590 vnc_lock_output(vs
);
1591 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
1592 vnc_write_u8(vs
, 0);
1593 vnc_write_u16(vs
, 1);
1594 vnc_framebuffer_update(vs
, 0, 0, 1, 1, VNC_ENCODING_LED_STATE
);
1595 vnc_write_u8(vs
, ledstate
);
1596 vnc_unlock_output(vs
);
1600 static void kbd_leds(void *opaque
, int ledstate
)
1602 VncState
*vs
= opaque
;
1604 bool has_changed
= (ledstate
!= current_led_state(vs
));
1606 caps
= ledstate
& QEMU_CAPS_LOCK_LED
? 1 : 0;
1607 num
= ledstate
& QEMU_NUM_LOCK_LED
? 1 : 0;
1608 scr
= ledstate
& QEMU_SCROLL_LOCK_LED
? 1 : 0;
1610 if (vs
->modifiers_state
[0x3a] != caps
) {
1611 vs
->modifiers_state
[0x3a] = caps
;
1613 if (vs
->modifiers_state
[0x45] != num
) {
1614 vs
->modifiers_state
[0x45] = num
;
1616 if (vs
->modifiers_state
[0x46] != scr
) {
1617 vs
->modifiers_state
[0x46] = scr
;
1620 /* Sending the current led state message to the client */
1622 vnc_led_state_change(vs
);
1626 static void do_key_event(VncState
*vs
, int down
, int keycode
, int sym
)
1628 /* QEMU console switch */
1630 case 0x2a: /* Left Shift */
1631 case 0x36: /* Right Shift */
1632 case 0x1d: /* Left CTRL */
1633 case 0x9d: /* Right CTRL */
1634 case 0x38: /* Left ALT */
1635 case 0xb8: /* Right ALT */
1637 vs
->modifiers_state
[keycode
] = 1;
1639 vs
->modifiers_state
[keycode
] = 0;
1641 case 0x02 ... 0x0a: /* '1' to '9' keys */
1642 if (down
&& vs
->modifiers_state
[0x1d] && vs
->modifiers_state
[0x38]) {
1643 /* Reset the modifiers sent to the current console */
1645 console_select(keycode
- 0x02);
1649 case 0x3a: /* CapsLock */
1650 case 0x45: /* NumLock */
1652 vs
->modifiers_state
[keycode
] ^= 1;
1656 /* Turn off the lock state sync logic if the client support the led
1659 if (down
&& vs
->vd
->lock_key_sync
&&
1660 !vnc_has_feature(vs
, VNC_FEATURE_LED_STATE
) &&
1661 keycode_is_keypad(vs
->vd
->kbd_layout
, keycode
)) {
1662 /* If the numlock state needs to change then simulate an additional
1663 keypress before sending this one. This will happen if the user
1664 toggles numlock away from the VNC window.
1666 if (keysym_is_numlock(vs
->vd
->kbd_layout
, sym
& 0xFFFF)) {
1667 if (!vs
->modifiers_state
[0x45]) {
1668 vs
->modifiers_state
[0x45] = 1;
1669 press_key(vs
, 0xff7f);
1672 if (vs
->modifiers_state
[0x45]) {
1673 vs
->modifiers_state
[0x45] = 0;
1674 press_key(vs
, 0xff7f);
1679 if (down
&& vs
->vd
->lock_key_sync
&&
1680 !vnc_has_feature(vs
, VNC_FEATURE_LED_STATE
) &&
1681 ((sym
>= 'A' && sym
<= 'Z') || (sym
>= 'a' && sym
<= 'z'))) {
1682 /* If the capslock state needs to change then simulate an additional
1683 keypress before sending this one. This will happen if the user
1684 toggles capslock away from the VNC window.
1686 int uppercase
= !!(sym
>= 'A' && sym
<= 'Z');
1687 int shift
= !!(vs
->modifiers_state
[0x2a] | vs
->modifiers_state
[0x36]);
1688 int capslock
= !!(vs
->modifiers_state
[0x3a]);
1690 if (uppercase
== shift
) {
1691 vs
->modifiers_state
[0x3a] = 0;
1692 press_key(vs
, 0xffe5);
1695 if (uppercase
!= shift
) {
1696 vs
->modifiers_state
[0x3a] = 1;
1697 press_key(vs
, 0xffe5);
1702 if (qemu_console_is_graphic(NULL
)) {
1703 if (keycode
& SCANCODE_GREY
)
1704 kbd_put_keycode(SCANCODE_EMUL0
);
1706 kbd_put_keycode(keycode
& SCANCODE_KEYCODEMASK
);
1708 kbd_put_keycode(keycode
| SCANCODE_UP
);
1710 bool numlock
= vs
->modifiers_state
[0x45];
1711 bool control
= (vs
->modifiers_state
[0x1d] ||
1712 vs
->modifiers_state
[0x9d]);
1713 /* QEMU console emulation */
1716 case 0x2a: /* Left Shift */
1717 case 0x36: /* Right Shift */
1718 case 0x1d: /* Left CTRL */
1719 case 0x9d: /* Right CTRL */
1720 case 0x38: /* Left ALT */
1721 case 0xb8: /* Right ALT */
1724 kbd_put_keysym(QEMU_KEY_UP
);
1727 kbd_put_keysym(QEMU_KEY_DOWN
);
1730 kbd_put_keysym(QEMU_KEY_LEFT
);
1733 kbd_put_keysym(QEMU_KEY_RIGHT
);
1736 kbd_put_keysym(QEMU_KEY_DELETE
);
1739 kbd_put_keysym(QEMU_KEY_HOME
);
1742 kbd_put_keysym(QEMU_KEY_END
);
1745 kbd_put_keysym(QEMU_KEY_PAGEUP
);
1748 kbd_put_keysym(QEMU_KEY_PAGEDOWN
);
1752 kbd_put_keysym(numlock
? '7' : QEMU_KEY_HOME
);
1755 kbd_put_keysym(numlock
? '8' : QEMU_KEY_UP
);
1758 kbd_put_keysym(numlock
? '9' : QEMU_KEY_PAGEUP
);
1761 kbd_put_keysym(numlock
? '4' : QEMU_KEY_LEFT
);
1764 kbd_put_keysym('5');
1767 kbd_put_keysym(numlock
? '6' : QEMU_KEY_RIGHT
);
1770 kbd_put_keysym(numlock
? '1' : QEMU_KEY_END
);
1773 kbd_put_keysym(numlock
? '2' : QEMU_KEY_DOWN
);
1776 kbd_put_keysym(numlock
? '3' : QEMU_KEY_PAGEDOWN
);
1779 kbd_put_keysym('0');
1782 kbd_put_keysym(numlock
? '.' : QEMU_KEY_DELETE
);
1786 kbd_put_keysym('/');
1789 kbd_put_keysym('*');
1792 kbd_put_keysym('-');
1795 kbd_put_keysym('+');
1798 kbd_put_keysym('\n');
1803 kbd_put_keysym(sym
& 0x1f);
1805 kbd_put_keysym(sym
);
1813 static void vnc_release_modifiers(VncState
*vs
)
1815 static const int keycodes
[] = {
1816 /* shift, control, alt keys, both left & right */
1817 0x2a, 0x36, 0x1d, 0x9d, 0x38, 0xb8,
1821 if (!qemu_console_is_graphic(NULL
)) {
1824 for (i
= 0; i
< ARRAY_SIZE(keycodes
); i
++) {
1825 keycode
= keycodes
[i
];
1826 if (!vs
->modifiers_state
[keycode
]) {
1829 if (keycode
& SCANCODE_GREY
) {
1830 kbd_put_keycode(SCANCODE_EMUL0
);
1832 kbd_put_keycode(keycode
| SCANCODE_UP
);
1836 static void key_event(VncState
*vs
, int down
, uint32_t sym
)
1841 if (lsym
>= 'A' && lsym
<= 'Z' && qemu_console_is_graphic(NULL
)) {
1842 lsym
= lsym
- 'A' + 'a';
1845 keycode
= keysym2scancode(vs
->vd
->kbd_layout
, lsym
& 0xFFFF) & SCANCODE_KEYMASK
;
1846 do_key_event(vs
, down
, keycode
, sym
);
1849 static void ext_key_event(VncState
*vs
, int down
,
1850 uint32_t sym
, uint16_t keycode
)
1852 /* if the user specifies a keyboard layout, always use it */
1853 if (keyboard_layout
)
1854 key_event(vs
, down
, sym
);
1856 do_key_event(vs
, down
, keycode
, sym
);
1859 static void framebuffer_update_request(VncState
*vs
, int incremental
,
1860 int x_position
, int y_position
,
1864 const size_t width
= surface_width(vs
->vd
->ds
) / 16;
1865 const size_t height
= surface_height(vs
->vd
->ds
);
1867 if (y_position
> height
) {
1868 y_position
= height
;
1870 if (y_position
+ h
>= height
) {
1871 h
= height
- y_position
;
1874 vs
->need_update
= 1;
1876 vs
->force_update
= 1;
1877 for (i
= 0; i
< h
; i
++) {
1878 bitmap_set(vs
->dirty
[y_position
+ i
], 0, width
);
1879 bitmap_clear(vs
->dirty
[y_position
+ i
], width
,
1880 VNC_DIRTY_BITS
- width
);
1885 static void send_ext_key_event_ack(VncState
*vs
)
1887 vnc_lock_output(vs
);
1888 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
1889 vnc_write_u8(vs
, 0);
1890 vnc_write_u16(vs
, 1);
1891 vnc_framebuffer_update(vs
, 0, 0,
1892 surface_width(vs
->vd
->ds
),
1893 surface_height(vs
->vd
->ds
),
1894 VNC_ENCODING_EXT_KEY_EVENT
);
1895 vnc_unlock_output(vs
);
1899 static void send_ext_audio_ack(VncState
*vs
)
1901 vnc_lock_output(vs
);
1902 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
1903 vnc_write_u8(vs
, 0);
1904 vnc_write_u16(vs
, 1);
1905 vnc_framebuffer_update(vs
, 0, 0,
1906 surface_width(vs
->vd
->ds
),
1907 surface_height(vs
->vd
->ds
),
1908 VNC_ENCODING_AUDIO
);
1909 vnc_unlock_output(vs
);
1913 static void set_encodings(VncState
*vs
, int32_t *encodings
, size_t n_encodings
)
1916 unsigned int enc
= 0;
1919 vs
->vnc_encoding
= 0;
1920 vs
->tight
.compression
= 9;
1921 vs
->tight
.quality
= -1; /* Lossless by default */
1925 * Start from the end because the encodings are sent in order of preference.
1926 * This way the preferred encoding (first encoding defined in the array)
1927 * will be set at the end of the loop.
1929 for (i
= n_encodings
- 1; i
>= 0; i
--) {
1932 case VNC_ENCODING_RAW
:
1933 vs
->vnc_encoding
= enc
;
1935 case VNC_ENCODING_COPYRECT
:
1936 vs
->features
|= VNC_FEATURE_COPYRECT_MASK
;
1938 case VNC_ENCODING_HEXTILE
:
1939 vs
->features
|= VNC_FEATURE_HEXTILE_MASK
;
1940 vs
->vnc_encoding
= enc
;
1942 case VNC_ENCODING_TIGHT
:
1943 vs
->features
|= VNC_FEATURE_TIGHT_MASK
;
1944 vs
->vnc_encoding
= enc
;
1946 #ifdef CONFIG_VNC_PNG
1947 case VNC_ENCODING_TIGHT_PNG
:
1948 vs
->features
|= VNC_FEATURE_TIGHT_PNG_MASK
;
1949 vs
->vnc_encoding
= enc
;
1952 case VNC_ENCODING_ZLIB
:
1953 vs
->features
|= VNC_FEATURE_ZLIB_MASK
;
1954 vs
->vnc_encoding
= enc
;
1956 case VNC_ENCODING_ZRLE
:
1957 vs
->features
|= VNC_FEATURE_ZRLE_MASK
;
1958 vs
->vnc_encoding
= enc
;
1960 case VNC_ENCODING_ZYWRLE
:
1961 vs
->features
|= VNC_FEATURE_ZYWRLE_MASK
;
1962 vs
->vnc_encoding
= enc
;
1964 case VNC_ENCODING_DESKTOPRESIZE
:
1965 vs
->features
|= VNC_FEATURE_RESIZE_MASK
;
1967 case VNC_ENCODING_POINTER_TYPE_CHANGE
:
1968 vs
->features
|= VNC_FEATURE_POINTER_TYPE_CHANGE_MASK
;
1970 case VNC_ENCODING_RICH_CURSOR
:
1971 vs
->features
|= VNC_FEATURE_RICH_CURSOR_MASK
;
1973 case VNC_ENCODING_EXT_KEY_EVENT
:
1974 send_ext_key_event_ack(vs
);
1976 case VNC_ENCODING_AUDIO
:
1977 send_ext_audio_ack(vs
);
1979 case VNC_ENCODING_WMVi
:
1980 vs
->features
|= VNC_FEATURE_WMVI_MASK
;
1982 case VNC_ENCODING_LED_STATE
:
1983 vs
->features
|= VNC_FEATURE_LED_STATE_MASK
;
1985 case VNC_ENCODING_COMPRESSLEVEL0
... VNC_ENCODING_COMPRESSLEVEL0
+ 9:
1986 vs
->tight
.compression
= (enc
& 0x0F);
1988 case VNC_ENCODING_QUALITYLEVEL0
... VNC_ENCODING_QUALITYLEVEL0
+ 9:
1989 if (vs
->vd
->lossy
) {
1990 vs
->tight
.quality
= (enc
& 0x0F);
1994 VNC_DEBUG("Unknown encoding: %d (0x%.8x): %d\n", i
, enc
, enc
);
1998 vnc_desktop_resize(vs
);
1999 check_pointer_type_change(&vs
->mouse_mode_notifier
, NULL
);
2000 vnc_led_state_change(vs
);
2003 static void set_pixel_conversion(VncState
*vs
)
2005 pixman_format_code_t fmt
= qemu_pixman_get_format(&vs
->client_pf
);
2007 if (fmt
== VNC_SERVER_FB_FORMAT
) {
2008 vs
->write_pixels
= vnc_write_pixels_copy
;
2009 vnc_hextile_set_pixel_conversion(vs
, 0);
2011 vs
->write_pixels
= vnc_write_pixels_generic
;
2012 vnc_hextile_set_pixel_conversion(vs
, 1);
2016 static void set_pixel_format(VncState
*vs
,
2017 int bits_per_pixel
, int depth
,
2018 int big_endian_flag
, int true_color_flag
,
2019 int red_max
, int green_max
, int blue_max
,
2020 int red_shift
, int green_shift
, int blue_shift
)
2022 if (!true_color_flag
) {
2023 vnc_client_error(vs
);
2027 vs
->client_pf
.rmax
= red_max
;
2028 vs
->client_pf
.rbits
= hweight_long(red_max
);
2029 vs
->client_pf
.rshift
= red_shift
;
2030 vs
->client_pf
.rmask
= red_max
<< red_shift
;
2031 vs
->client_pf
.gmax
= green_max
;
2032 vs
->client_pf
.gbits
= hweight_long(green_max
);
2033 vs
->client_pf
.gshift
= green_shift
;
2034 vs
->client_pf
.gmask
= green_max
<< green_shift
;
2035 vs
->client_pf
.bmax
= blue_max
;
2036 vs
->client_pf
.bbits
= hweight_long(blue_max
);
2037 vs
->client_pf
.bshift
= blue_shift
;
2038 vs
->client_pf
.bmask
= blue_max
<< blue_shift
;
2039 vs
->client_pf
.bits_per_pixel
= bits_per_pixel
;
2040 vs
->client_pf
.bytes_per_pixel
= bits_per_pixel
/ 8;
2041 vs
->client_pf
.depth
= bits_per_pixel
== 32 ? 24 : bits_per_pixel
;
2042 vs
->client_be
= big_endian_flag
;
2044 set_pixel_conversion(vs
);
2046 graphic_hw_invalidate(NULL
);
2047 graphic_hw_update(NULL
);
2050 static void pixel_format_message (VncState
*vs
) {
2051 char pad
[3] = { 0, 0, 0 };
2053 vs
->client_pf
= qemu_default_pixelformat(32);
2055 vnc_write_u8(vs
, vs
->client_pf
.bits_per_pixel
); /* bits-per-pixel */
2056 vnc_write_u8(vs
, vs
->client_pf
.depth
); /* depth */
2058 #ifdef HOST_WORDS_BIGENDIAN
2059 vnc_write_u8(vs
, 1); /* big-endian-flag */
2061 vnc_write_u8(vs
, 0); /* big-endian-flag */
2063 vnc_write_u8(vs
, 1); /* true-color-flag */
2064 vnc_write_u16(vs
, vs
->client_pf
.rmax
); /* red-max */
2065 vnc_write_u16(vs
, vs
->client_pf
.gmax
); /* green-max */
2066 vnc_write_u16(vs
, vs
->client_pf
.bmax
); /* blue-max */
2067 vnc_write_u8(vs
, vs
->client_pf
.rshift
); /* red-shift */
2068 vnc_write_u8(vs
, vs
->client_pf
.gshift
); /* green-shift */
2069 vnc_write_u8(vs
, vs
->client_pf
.bshift
); /* blue-shift */
2070 vnc_write(vs
, pad
, 3); /* padding */
2072 vnc_hextile_set_pixel_conversion(vs
, 0);
2073 vs
->write_pixels
= vnc_write_pixels_copy
;
2076 static void vnc_colordepth(VncState
*vs
)
2078 if (vnc_has_feature(vs
, VNC_FEATURE_WMVI
)) {
2079 /* Sending a WMVi message to notify the client*/
2080 vnc_lock_output(vs
);
2081 vnc_write_u8(vs
, VNC_MSG_SERVER_FRAMEBUFFER_UPDATE
);
2082 vnc_write_u8(vs
, 0);
2083 vnc_write_u16(vs
, 1); /* number of rects */
2084 vnc_framebuffer_update(vs
, 0, 0,
2085 surface_width(vs
->vd
->ds
),
2086 surface_height(vs
->vd
->ds
),
2088 pixel_format_message(vs
);
2089 vnc_unlock_output(vs
);
2092 set_pixel_conversion(vs
);
2096 static int protocol_client_msg(VncState
*vs
, uint8_t *data
, size_t len
)
2100 VncDisplay
*vd
= vs
->vd
;
2103 update_displaychangelistener(&vd
->dcl
, VNC_REFRESH_INTERVAL_BASE
);
2107 case VNC_MSG_CLIENT_SET_PIXEL_FORMAT
:
2111 set_pixel_format(vs
, read_u8(data
, 4), read_u8(data
, 5),
2112 read_u8(data
, 6), read_u8(data
, 7),
2113 read_u16(data
, 8), read_u16(data
, 10),
2114 read_u16(data
, 12), read_u8(data
, 14),
2115 read_u8(data
, 15), read_u8(data
, 16));
2117 case VNC_MSG_CLIENT_SET_ENCODINGS
:
2122 limit
= read_u16(data
, 2);
2124 return 4 + (limit
* 4);
2126 limit
= read_u16(data
, 2);
2128 for (i
= 0; i
< limit
; i
++) {
2129 int32_t val
= read_s32(data
, 4 + (i
* 4));
2130 memcpy(data
+ 4 + (i
* 4), &val
, sizeof(val
));
2133 set_encodings(vs
, (int32_t *)(data
+ 4), limit
);
2135 case VNC_MSG_CLIENT_FRAMEBUFFER_UPDATE_REQUEST
:
2139 framebuffer_update_request(vs
,
2140 read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4),
2141 read_u16(data
, 6), read_u16(data
, 8));
2143 case VNC_MSG_CLIENT_KEY_EVENT
:
2147 key_event(vs
, read_u8(data
, 1), read_u32(data
, 4));
2149 case VNC_MSG_CLIENT_POINTER_EVENT
:
2153 pointer_event(vs
, read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4));
2155 case VNC_MSG_CLIENT_CUT_TEXT
:
2160 uint32_t dlen
= read_u32(data
, 4);
2165 client_cut_text(vs
, read_u32(data
, 4), data
+ 8);
2167 case VNC_MSG_CLIENT_QEMU
:
2171 switch (read_u8(data
, 1)) {
2172 case VNC_MSG_CLIENT_QEMU_EXT_KEY_EVENT
:
2176 ext_key_event(vs
, read_u16(data
, 2),
2177 read_u32(data
, 4), read_u32(data
, 8));
2179 case VNC_MSG_CLIENT_QEMU_AUDIO
:
2183 switch (read_u16 (data
, 2)) {
2184 case VNC_MSG_CLIENT_QEMU_AUDIO_ENABLE
:
2187 case VNC_MSG_CLIENT_QEMU_AUDIO_DISABLE
:
2190 case VNC_MSG_CLIENT_QEMU_AUDIO_SET_FORMAT
:
2193 switch (read_u8(data
, 4)) {
2194 case 0: vs
->as
.fmt
= AUD_FMT_U8
; break;
2195 case 1: vs
->as
.fmt
= AUD_FMT_S8
; break;
2196 case 2: vs
->as
.fmt
= AUD_FMT_U16
; break;
2197 case 3: vs
->as
.fmt
= AUD_FMT_S16
; break;
2198 case 4: vs
->as
.fmt
= AUD_FMT_U32
; break;
2199 case 5: vs
->as
.fmt
= AUD_FMT_S32
; break;
2201 printf("Invalid audio format %d\n", read_u8(data
, 4));
2202 vnc_client_error(vs
);
2205 vs
->as
.nchannels
= read_u8(data
, 5);
2206 if (vs
->as
.nchannels
!= 1 && vs
->as
.nchannels
!= 2) {
2207 printf("Invalid audio channel coount %d\n",
2209 vnc_client_error(vs
);
2212 vs
->as
.freq
= read_u32(data
, 6);
2215 printf ("Invalid audio message %d\n", read_u8(data
, 4));
2216 vnc_client_error(vs
);
2222 printf("Msg: %d\n", read_u16(data
, 0));
2223 vnc_client_error(vs
);
2228 printf("Msg: %d\n", data
[0]);
2229 vnc_client_error(vs
);
2233 vnc_read_when(vs
, protocol_client_msg
, 1);
2237 static int protocol_client_init(VncState
*vs
, uint8_t *data
, size_t len
)
2243 mode
= data
[0] ? VNC_SHARE_MODE_SHARED
: VNC_SHARE_MODE_EXCLUSIVE
;
2244 switch (vs
->vd
->share_policy
) {
2245 case VNC_SHARE_POLICY_IGNORE
:
2247 * Ignore the shared flag. Nothing to do here.
2249 * Doesn't conform to the rfb spec but is traditional qemu
2250 * behavior, thus left here as option for compatibility
2254 case VNC_SHARE_POLICY_ALLOW_EXCLUSIVE
:
2256 * Policy: Allow clients ask for exclusive access.
2258 * Implementation: When a client asks for exclusive access,
2259 * disconnect all others. Shared connects are allowed as long
2260 * as no exclusive connection exists.
2262 * This is how the rfb spec suggests to handle the shared flag.
2264 if (mode
== VNC_SHARE_MODE_EXCLUSIVE
) {
2266 QTAILQ_FOREACH(client
, &vs
->vd
->clients
, next
) {
2270 if (client
->share_mode
!= VNC_SHARE_MODE_EXCLUSIVE
&&
2271 client
->share_mode
!= VNC_SHARE_MODE_SHARED
) {
2274 vnc_disconnect_start(client
);
2277 if (mode
== VNC_SHARE_MODE_SHARED
) {
2278 if (vs
->vd
->num_exclusive
> 0) {
2279 vnc_disconnect_start(vs
);
2284 case VNC_SHARE_POLICY_FORCE_SHARED
:
2286 * Policy: Shared connects only.
2287 * Implementation: Disallow clients asking for exclusive access.
2289 * Useful for shared desktop sessions where you don't want
2290 * someone forgetting to say -shared when running the vnc
2291 * client disconnect everybody else.
2293 if (mode
== VNC_SHARE_MODE_EXCLUSIVE
) {
2294 vnc_disconnect_start(vs
);
2299 vnc_set_share_mode(vs
, mode
);
2301 vs
->client_width
= surface_width(vs
->vd
->ds
);
2302 vs
->client_height
= surface_height(vs
->vd
->ds
);
2303 vnc_write_u16(vs
, vs
->client_width
);
2304 vnc_write_u16(vs
, vs
->client_height
);
2306 pixel_format_message(vs
);
2309 size
= snprintf(buf
, sizeof(buf
), "QEMU (%s)", qemu_name
);
2311 size
= snprintf(buf
, sizeof(buf
), "QEMU");
2313 vnc_write_u32(vs
, size
);
2314 vnc_write(vs
, buf
, size
);
2317 vnc_client_cache_auth(vs
);
2318 vnc_qmp_event(vs
, QEVENT_VNC_INITIALIZED
);
2320 vnc_read_when(vs
, protocol_client_msg
, 1);
2325 void start_client_init(VncState
*vs
)
2327 vnc_read_when(vs
, protocol_client_init
, 1);
2330 static void make_challenge(VncState
*vs
)
2334 srand(time(NULL
)+getpid()+getpid()*987654+rand());
2336 for (i
= 0 ; i
< sizeof(vs
->challenge
) ; i
++)
2337 vs
->challenge
[i
] = (int) (256.0*rand()/(RAND_MAX
+1.0));
2340 static int protocol_client_auth_vnc(VncState
*vs
, uint8_t *data
, size_t len
)
2342 unsigned char response
[VNC_AUTH_CHALLENGE_SIZE
];
2344 unsigned char key
[8];
2345 time_t now
= time(NULL
);
2347 if (!vs
->vd
->password
) {
2348 VNC_DEBUG("No password configured on server");
2351 if (vs
->vd
->expires
< now
) {
2352 VNC_DEBUG("Password is expired");
2356 memcpy(response
, vs
->challenge
, VNC_AUTH_CHALLENGE_SIZE
);
2358 /* Calculate the expected challenge response */
2359 pwlen
= strlen(vs
->vd
->password
);
2360 for (i
=0; i
<sizeof(key
); i
++)
2361 key
[i
] = i
<pwlen
? vs
->vd
->password
[i
] : 0;
2363 for (j
= 0; j
< VNC_AUTH_CHALLENGE_SIZE
; j
+= 8)
2364 des(response
+j
, response
+j
);
2366 /* Compare expected vs actual challenge response */
2367 if (memcmp(response
, data
, VNC_AUTH_CHALLENGE_SIZE
) != 0) {
2368 VNC_DEBUG("Client challenge response did not match\n");
2371 VNC_DEBUG("Accepting VNC challenge response\n");
2372 vnc_write_u32(vs
, 0); /* Accept auth */
2375 start_client_init(vs
);
2380 vnc_write_u32(vs
, 1); /* Reject auth */
2381 if (vs
->minor
>= 8) {
2382 static const char err
[] = "Authentication failed";
2383 vnc_write_u32(vs
, sizeof(err
));
2384 vnc_write(vs
, err
, sizeof(err
));
2387 vnc_client_error(vs
);
2391 void start_auth_vnc(VncState
*vs
)
2394 /* Send client a 'random' challenge */
2395 vnc_write(vs
, vs
->challenge
, sizeof(vs
->challenge
));
2398 vnc_read_when(vs
, protocol_client_auth_vnc
, sizeof(vs
->challenge
));
2402 static int protocol_client_auth(VncState
*vs
, uint8_t *data
, size_t len
)
2404 /* We only advertise 1 auth scheme at a time, so client
2405 * must pick the one we sent. Verify this */
2406 if (data
[0] != vs
->auth
) { /* Reject auth */
2407 VNC_DEBUG("Reject auth %d because it didn't match advertized\n", (int)data
[0]);
2408 vnc_write_u32(vs
, 1);
2409 if (vs
->minor
>= 8) {
2410 static const char err
[] = "Authentication failed";
2411 vnc_write_u32(vs
, sizeof(err
));
2412 vnc_write(vs
, err
, sizeof(err
));
2414 vnc_client_error(vs
);
2415 } else { /* Accept requested auth */
2416 VNC_DEBUG("Client requested auth %d\n", (int)data
[0]);
2419 VNC_DEBUG("Accept auth none\n");
2420 if (vs
->minor
>= 8) {
2421 vnc_write_u32(vs
, 0); /* Accept auth completion */
2424 start_client_init(vs
);
2428 VNC_DEBUG("Start VNC auth\n");
2432 #ifdef CONFIG_VNC_TLS
2433 case VNC_AUTH_VENCRYPT
:
2434 VNC_DEBUG("Accept VeNCrypt auth\n");
2435 start_auth_vencrypt(vs
);
2437 #endif /* CONFIG_VNC_TLS */
2439 #ifdef CONFIG_VNC_SASL
2441 VNC_DEBUG("Accept SASL auth\n");
2442 start_auth_sasl(vs
);
2444 #endif /* CONFIG_VNC_SASL */
2446 default: /* Should not be possible, but just in case */
2447 VNC_DEBUG("Reject auth %d server code bug\n", vs
->auth
);
2448 vnc_write_u8(vs
, 1);
2449 if (vs
->minor
>= 8) {
2450 static const char err
[] = "Authentication failed";
2451 vnc_write_u32(vs
, sizeof(err
));
2452 vnc_write(vs
, err
, sizeof(err
));
2454 vnc_client_error(vs
);
2460 static int protocol_version(VncState
*vs
, uint8_t *version
, size_t len
)
2464 memcpy(local
, version
, 12);
2467 if (sscanf(local
, "RFB %03d.%03d\n", &vs
->major
, &vs
->minor
) != 2) {
2468 VNC_DEBUG("Malformed protocol version %s\n", local
);
2469 vnc_client_error(vs
);
2472 VNC_DEBUG("Client request protocol version %d.%d\n", vs
->major
, vs
->minor
);
2473 if (vs
->major
!= 3 ||
2479 VNC_DEBUG("Unsupported client version\n");
2480 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
2482 vnc_client_error(vs
);
2485 /* Some broken clients report v3.4 or v3.5, which spec requires to be treated
2486 * as equivalent to v3.3 by servers
2488 if (vs
->minor
== 4 || vs
->minor
== 5)
2491 if (vs
->minor
== 3) {
2492 if (vs
->auth
== VNC_AUTH_NONE
) {
2493 VNC_DEBUG("Tell client auth none\n");
2494 vnc_write_u32(vs
, vs
->auth
);
2496 start_client_init(vs
);
2497 } else if (vs
->auth
== VNC_AUTH_VNC
) {
2498 VNC_DEBUG("Tell client VNC auth\n");
2499 vnc_write_u32(vs
, vs
->auth
);
2503 VNC_DEBUG("Unsupported auth %d for protocol 3.3\n", vs
->auth
);
2504 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
2506 vnc_client_error(vs
);
2509 VNC_DEBUG("Telling client we support auth %d\n", vs
->auth
);
2510 vnc_write_u8(vs
, 1); /* num auth */
2511 vnc_write_u8(vs
, vs
->auth
);
2512 vnc_read_when(vs
, protocol_client_auth
, 1);
2519 static VncRectStat
*vnc_stat_rect(VncDisplay
*vd
, int x
, int y
)
2521 struct VncSurface
*vs
= &vd
->guest
;
2523 return &vs
->stats
[y
/ VNC_STAT_RECT
][x
/ VNC_STAT_RECT
];
2526 void vnc_sent_lossy_rect(VncState
*vs
, int x
, int y
, int w
, int h
)
2530 w
= (x
+ w
) / VNC_STAT_RECT
;
2531 h
= (y
+ h
) / VNC_STAT_RECT
;
2535 for (j
= y
; j
<= h
; j
++) {
2536 for (i
= x
; i
<= w
; i
++) {
2537 vs
->lossy_rect
[j
][i
] = 1;
2542 static int vnc_refresh_lossy_rect(VncDisplay
*vd
, int x
, int y
)
2545 int sty
= y
/ VNC_STAT_RECT
;
2546 int stx
= x
/ VNC_STAT_RECT
;
2549 y
= y
/ VNC_STAT_RECT
* VNC_STAT_RECT
;
2550 x
= x
/ VNC_STAT_RECT
* VNC_STAT_RECT
;
2552 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
2555 /* kernel send buffers are full -> refresh later */
2556 if (vs
->output
.offset
) {
2560 if (!vs
->lossy_rect
[sty
][stx
]) {
2564 vs
->lossy_rect
[sty
][stx
] = 0;
2565 for (j
= 0; j
< VNC_STAT_RECT
; ++j
) {
2566 bitmap_set(vs
->dirty
[y
+ j
], x
/ 16, VNC_STAT_RECT
/ 16);
2574 static int vnc_update_stats(VncDisplay
*vd
, struct timeval
* tv
)
2576 int width
= pixman_image_get_width(vd
->guest
.fb
);
2577 int height
= pixman_image_get_height(vd
->guest
.fb
);
2582 for (y
= 0; y
< height
; y
+= VNC_STAT_RECT
) {
2583 for (x
= 0; x
< width
; x
+= VNC_STAT_RECT
) {
2584 VncRectStat
*rect
= vnc_stat_rect(vd
, x
, y
);
2586 rect
->updated
= false;
2590 qemu_timersub(tv
, &VNC_REFRESH_STATS
, &res
);
2592 if (timercmp(&vd
->guest
.last_freq_check
, &res
, >)) {
2595 vd
->guest
.last_freq_check
= *tv
;
2597 for (y
= 0; y
< height
; y
+= VNC_STAT_RECT
) {
2598 for (x
= 0; x
< width
; x
+= VNC_STAT_RECT
) {
2599 VncRectStat
*rect
= vnc_stat_rect(vd
, x
, y
);
2600 int count
= ARRAY_SIZE(rect
->times
);
2601 struct timeval min
, max
;
2603 if (!timerisset(&rect
->times
[count
- 1])) {
2607 max
= rect
->times
[(rect
->idx
+ count
- 1) % count
];
2608 qemu_timersub(tv
, &max
, &res
);
2610 if (timercmp(&res
, &VNC_REFRESH_LOSSY
, >)) {
2612 has_dirty
+= vnc_refresh_lossy_rect(vd
, x
, y
);
2613 memset(rect
->times
, 0, sizeof (rect
->times
));
2617 min
= rect
->times
[rect
->idx
];
2618 max
= rect
->times
[(rect
->idx
+ count
- 1) % count
];
2619 qemu_timersub(&max
, &min
, &res
);
2621 rect
->freq
= res
.tv_sec
+ res
.tv_usec
/ 1000000.;
2622 rect
->freq
/= count
;
2623 rect
->freq
= 1. / rect
->freq
;
2629 double vnc_update_freq(VncState
*vs
, int x
, int y
, int w
, int h
)
2635 x
= (x
/ VNC_STAT_RECT
) * VNC_STAT_RECT
;
2636 y
= (y
/ VNC_STAT_RECT
) * VNC_STAT_RECT
;
2638 for (j
= y
; j
<= y
+ h
; j
+= VNC_STAT_RECT
) {
2639 for (i
= x
; i
<= x
+ w
; i
+= VNC_STAT_RECT
) {
2640 total
+= vnc_stat_rect(vs
->vd
, i
, j
)->freq
;
2652 static void vnc_rect_updated(VncDisplay
*vd
, int x
, int y
, struct timeval
* tv
)
2656 rect
= vnc_stat_rect(vd
, x
, y
);
2657 if (rect
->updated
) {
2660 rect
->times
[rect
->idx
] = *tv
;
2661 rect
->idx
= (rect
->idx
+ 1) % ARRAY_SIZE(rect
->times
);
2662 rect
->updated
= true;
2665 static int vnc_refresh_server_surface(VncDisplay
*vd
)
2667 int width
= pixman_image_get_width(vd
->guest
.fb
);
2668 int height
= pixman_image_get_height(vd
->guest
.fb
);
2671 uint8_t *server_row
;
2675 pixman_image_t
*tmpbuf
= NULL
;
2677 struct timeval tv
= { 0, 0 };
2679 if (!vd
->non_adaptive
) {
2680 gettimeofday(&tv
, NULL
);
2681 has_dirty
= vnc_update_stats(vd
, &tv
);
2685 * Walk through the guest dirty map.
2686 * Check and copy modified bits from guest to server surface.
2687 * Update server dirty map.
2690 if (cmp_bytes
> vnc_server_fb_stride(vd
)) {
2691 cmp_bytes
= vnc_server_fb_stride(vd
);
2693 if (vd
->guest
.format
!= VNC_SERVER_FB_FORMAT
) {
2694 int width
= pixman_image_get_width(vd
->server
);
2695 tmpbuf
= qemu_pixman_linebuf_create(VNC_SERVER_FB_FORMAT
, width
);
2697 guest_row
= (uint8_t *)pixman_image_get_data(vd
->guest
.fb
);
2698 server_row
= (uint8_t *)pixman_image_get_data(vd
->server
);
2699 for (y
= 0; y
< height
; y
++) {
2700 if (!bitmap_empty(vd
->guest
.dirty
[y
], VNC_DIRTY_BITS
)) {
2703 uint8_t *server_ptr
;
2705 if (vd
->guest
.format
!= VNC_SERVER_FB_FORMAT
) {
2706 qemu_pixman_linebuf_fill(tmpbuf
, vd
->guest
.fb
, width
, 0, y
);
2707 guest_ptr
= (uint8_t *)pixman_image_get_data(tmpbuf
);
2709 guest_ptr
= guest_row
;
2711 server_ptr
= server_row
;
2713 for (x
= 0; x
+ 15 < width
;
2714 x
+= 16, guest_ptr
+= cmp_bytes
, server_ptr
+= cmp_bytes
) {
2715 if (!test_and_clear_bit((x
/ 16), vd
->guest
.dirty
[y
]))
2717 if (memcmp(server_ptr
, guest_ptr
, cmp_bytes
) == 0)
2719 memcpy(server_ptr
, guest_ptr
, cmp_bytes
);
2720 if (!vd
->non_adaptive
)
2721 vnc_rect_updated(vd
, x
, y
, &tv
);
2722 QTAILQ_FOREACH(vs
, &vd
->clients
, next
) {
2723 set_bit((x
/ 16), vs
->dirty
[y
]);
2728 guest_row
+= pixman_image_get_stride(vd
->guest
.fb
);
2729 server_row
+= pixman_image_get_stride(vd
->server
);
2731 qemu_pixman_image_unref(tmpbuf
);
2735 static void vnc_refresh(DisplayChangeListener
*dcl
)
2737 VncDisplay
*vd
= container_of(dcl
, VncDisplay
, dcl
);
2739 int has_dirty
, rects
= 0;
2741 graphic_hw_update(NULL
);
2743 if (vnc_trylock_display(vd
)) {
2744 update_displaychangelistener(&vd
->dcl
, VNC_REFRESH_INTERVAL_BASE
);
2748 has_dirty
= vnc_refresh_server_surface(vd
);
2749 vnc_unlock_display(vd
);
2751 QTAILQ_FOREACH_SAFE(vs
, &vd
->clients
, next
, vn
) {
2752 rects
+= vnc_update_client(vs
, has_dirty
);
2753 /* vs might be free()ed here */
2756 if (QTAILQ_EMPTY(&vd
->clients
)) {
2757 update_displaychangelistener(&vd
->dcl
, VNC_REFRESH_INTERVAL_MAX
);
2761 if (has_dirty
&& rects
) {
2762 vd
->dcl
.update_interval
/= 2;
2763 if (vd
->dcl
.update_interval
< VNC_REFRESH_INTERVAL_BASE
) {
2764 vd
->dcl
.update_interval
= VNC_REFRESH_INTERVAL_BASE
;
2767 vd
->dcl
.update_interval
+= VNC_REFRESH_INTERVAL_INC
;
2768 if (vd
->dcl
.update_interval
> VNC_REFRESH_INTERVAL_MAX
) {
2769 vd
->dcl
.update_interval
= VNC_REFRESH_INTERVAL_MAX
;
2774 static void vnc_connect(VncDisplay
*vd
, int csock
, int skipauth
, bool websocket
)
2776 VncState
*vs
= g_malloc0(sizeof(VncState
));
2782 vs
->auth
= VNC_AUTH_NONE
;
2783 #ifdef CONFIG_VNC_TLS
2784 vs
->subauth
= VNC_AUTH_INVALID
;
2787 vs
->auth
= vd
->auth
;
2788 #ifdef CONFIG_VNC_TLS
2789 vs
->subauth
= vd
->subauth
;
2793 vs
->lossy_rect
= g_malloc0(VNC_STAT_ROWS
* sizeof (*vs
->lossy_rect
));
2794 for (i
= 0; i
< VNC_STAT_ROWS
; ++i
) {
2795 vs
->lossy_rect
[i
] = g_malloc0(VNC_STAT_COLS
* sizeof (uint8_t));
2798 VNC_DEBUG("New client on socket %d\n", csock
);
2799 update_displaychangelistener(&vd
->dcl
, VNC_REFRESH_INTERVAL_BASE
);
2800 qemu_set_nonblock(vs
->csock
);
2801 #ifdef CONFIG_VNC_WS
2804 #ifdef CONFIG_VNC_TLS
2805 if (vd
->tls
.x509cert
) {
2806 qemu_set_fd_handler2(vs
->csock
, NULL
, vncws_tls_handshake_peek
,
2809 #endif /* CONFIG_VNC_TLS */
2811 qemu_set_fd_handler2(vs
->csock
, NULL
, vncws_handshake_read
,
2815 #endif /* CONFIG_VNC_WS */
2817 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
2820 vnc_client_cache_addr(vs
);
2821 vnc_qmp_event(vs
, QEVENT_VNC_CONNECTED
);
2822 vnc_set_share_mode(vs
, VNC_SHARE_MODE_CONNECTING
);
2826 #ifdef CONFIG_VNC_WS
2834 void vnc_init_state(VncState
*vs
)
2836 vs
->initialized
= true;
2837 VncDisplay
*vd
= vs
->vd
;
2842 vs
->as
.freq
= 44100;
2843 vs
->as
.nchannels
= 2;
2844 vs
->as
.fmt
= AUD_FMT_S16
;
2845 vs
->as
.endianness
= 0;
2847 qemu_mutex_init(&vs
->output_mutex
);
2848 vs
->bh
= qemu_bh_new(vnc_jobs_bh
, vs
);
2850 QTAILQ_INSERT_HEAD(&vd
->clients
, vs
, next
);
2852 graphic_hw_update(NULL
);
2854 vnc_write(vs
, "RFB 003.008\n", 12);
2856 vnc_read_when(vs
, protocol_version
, 12);
2858 if (vs
->vd
->lock_key_sync
)
2859 vs
->led
= qemu_add_led_event_handler(kbd_leds
, vs
);
2861 vs
->mouse_mode_notifier
.notify
= check_pointer_type_change
;
2862 qemu_add_mouse_mode_change_notifier(&vs
->mouse_mode_notifier
);
2864 /* vs might be free()ed here */
2867 static void vnc_listen_read(void *opaque
, bool websocket
)
2869 VncDisplay
*vs
= opaque
;
2870 struct sockaddr_in addr
;
2871 socklen_t addrlen
= sizeof(addr
);
2875 graphic_hw_update(NULL
);
2876 #ifdef CONFIG_VNC_WS
2878 csock
= qemu_accept(vs
->lwebsock
, (struct sockaddr
*)&addr
, &addrlen
);
2880 #endif /* CONFIG_VNC_WS */
2882 csock
= qemu_accept(vs
->lsock
, (struct sockaddr
*)&addr
, &addrlen
);
2886 vnc_connect(vs
, csock
, 0, websocket
);
2890 static void vnc_listen_regular_read(void *opaque
)
2892 vnc_listen_read(opaque
, 0);
2895 #ifdef CONFIG_VNC_WS
2896 static void vnc_listen_websocket_read(void *opaque
)
2898 vnc_listen_read(opaque
, 1);
2900 #endif /* CONFIG_VNC_WS */
2902 static const DisplayChangeListenerOps dcl_ops
= {
2904 .dpy_refresh
= vnc_refresh
,
2905 .dpy_gfx_copy
= vnc_dpy_copy
,
2906 .dpy_gfx_update
= vnc_dpy_update
,
2907 .dpy_gfx_switch
= vnc_dpy_switch
,
2908 .dpy_mouse_set
= vnc_mouse_set
,
2909 .dpy_cursor_define
= vnc_dpy_cursor_define
,
2912 void vnc_display_init(DisplayState
*ds
)
2914 VncDisplay
*vs
= g_malloc0(sizeof(*vs
));
2919 #ifdef CONFIG_VNC_WS
2923 QTAILQ_INIT(&vs
->clients
);
2924 vs
->expires
= TIME_MAX
;
2926 if (keyboard_layout
)
2927 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, keyboard_layout
);
2929 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, "en-us");
2931 if (!vs
->kbd_layout
)
2934 qemu_mutex_init(&vs
->mutex
);
2935 vnc_start_worker_thread();
2937 vs
->dcl
.ops
= &dcl_ops
;
2938 register_displaychangelistener(&vs
->dcl
);
2942 static void vnc_display_close(DisplayState
*ds
)
2944 VncDisplay
*vs
= vnc_display
;
2949 g_free(vs
->display
);
2952 if (vs
->lsock
!= -1) {
2953 qemu_set_fd_handler2(vs
->lsock
, NULL
, NULL
, NULL
, NULL
);
2957 #ifdef CONFIG_VNC_WS
2958 g_free(vs
->ws_display
);
2959 vs
->ws_display
= NULL
;
2960 if (vs
->lwebsock
!= -1) {
2961 qemu_set_fd_handler2(vs
->lwebsock
, NULL
, NULL
, NULL
, NULL
);
2962 close(vs
->lwebsock
);
2965 #endif /* CONFIG_VNC_WS */
2966 vs
->auth
= VNC_AUTH_INVALID
;
2967 #ifdef CONFIG_VNC_TLS
2968 vs
->subauth
= VNC_AUTH_INVALID
;
2969 vs
->tls
.x509verify
= 0;
2973 static int vnc_display_disable_login(DisplayState
*ds
)
2975 VncDisplay
*vs
= vnc_display
;
2982 g_free(vs
->password
);
2985 vs
->password
= NULL
;
2986 if (vs
->auth
== VNC_AUTH_NONE
) {
2987 vs
->auth
= VNC_AUTH_VNC
;
2993 int vnc_display_password(DisplayState
*ds
, const char *password
)
2995 VncDisplay
*vs
= vnc_display
;
3002 /* This is not the intention of this interface but err on the side
3004 return vnc_display_disable_login(ds
);
3008 g_free(vs
->password
);
3009 vs
->password
= NULL
;
3011 vs
->password
= g_strdup(password
);
3012 if (vs
->auth
== VNC_AUTH_NONE
) {
3013 vs
->auth
= VNC_AUTH_VNC
;
3019 int vnc_display_pw_expire(DisplayState
*ds
, time_t expires
)
3021 VncDisplay
*vs
= vnc_display
;
3027 vs
->expires
= expires
;
3031 char *vnc_display_local_addr(DisplayState
*ds
)
3033 VncDisplay
*vs
= vnc_display
;
3035 return vnc_socket_local_addr("%s:%s", vs
->lsock
);
3038 void vnc_display_open(DisplayState
*ds
, const char *display
, Error
**errp
)
3040 VncDisplay
*vs
= vnc_display
;
3041 const char *options
;
3044 #ifdef CONFIG_VNC_TLS
3045 int tls
= 0, x509
= 0;
3047 #ifdef CONFIG_VNC_SASL
3051 #if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
3054 int lock_key_sync
= 1;
3057 error_setg(errp
, "VNC display not active");
3060 vnc_display_close(ds
);
3061 if (strcmp(display
, "none") == 0)
3064 vs
->display
= g_strdup(display
);
3065 vs
->share_policy
= VNC_SHARE_POLICY_ALLOW_EXCLUSIVE
;
3068 while ((options
= strchr(options
, ','))) {
3070 if (strncmp(options
, "password", 8) == 0) {
3071 if (fips_get_state()) {
3073 "VNC password auth disabled due to FIPS mode, "
3074 "consider using the VeNCrypt or SASL authentication "
3075 "methods as an alternative");
3078 password
= 1; /* Require password auth */
3079 } else if (strncmp(options
, "reverse", 7) == 0) {
3081 } else if (strncmp(options
, "no-lock-key-sync", 16) == 0) {
3083 #ifdef CONFIG_VNC_SASL
3084 } else if (strncmp(options
, "sasl", 4) == 0) {
3085 sasl
= 1; /* Require SASL auth */
3087 #ifdef CONFIG_VNC_WS
3088 } else if (strncmp(options
, "websocket", 9) == 0) {
3092 /* Check for 'websocket=<port>' */
3093 start
= strchr(options
, '=');
3094 end
= strchr(options
, ',');
3095 if (start
&& (!end
|| (start
< end
))) {
3096 int len
= end
? end
-(start
+1) : strlen(start
+1);
3098 /* extract the host specification from display */
3099 char *host
= NULL
, *port
= NULL
, *host_end
= NULL
;
3100 port
= g_strndup(start
+ 1, len
);
3102 /* ipv6 hosts have colons */
3103 end
= strchr(display
, ',');
3104 host_end
= g_strrstr_len(display
, end
- display
, ":");
3107 host
= g_strndup(display
, host_end
- display
+ 1);
3109 host
= g_strndup(":", 1);
3111 vs
->ws_display
= g_strconcat(host
, port
, NULL
);
3116 #endif /* CONFIG_VNC_WS */
3117 #ifdef CONFIG_VNC_TLS
3118 } else if (strncmp(options
, "tls", 3) == 0) {
3119 tls
= 1; /* Require TLS */
3120 } else if (strncmp(options
, "x509", 4) == 0) {
3122 x509
= 1; /* Require x509 certificates */
3123 if (strncmp(options
, "x509verify", 10) == 0)
3124 vs
->tls
.x509verify
= 1; /* ...and verify client certs */
3126 /* Now check for 'x509=/some/path' postfix
3127 * and use that to setup x509 certificate/key paths */
3128 start
= strchr(options
, '=');
3129 end
= strchr(options
, ',');
3130 if (start
&& (!end
|| (start
< end
))) {
3131 int len
= end
? end
-(start
+1) : strlen(start
+1);
3132 char *path
= g_strndup(start
+ 1, len
);
3134 VNC_DEBUG("Trying certificate path '%s'\n", path
);
3135 if (vnc_tls_set_x509_creds_dir(vs
, path
) < 0) {
3136 error_setg(errp
, "Failed to find x509 certificates/keys in %s", path
);
3142 error_setg(errp
, "No certificate path provided");
3146 #if defined(CONFIG_VNC_TLS) || defined(CONFIG_VNC_SASL)
3147 } else if (strncmp(options
, "acl", 3) == 0) {
3150 } else if (strncmp(options
, "lossy", 5) == 0) {
3152 } else if (strncmp(options
, "non-adaptive", 12) == 0) {
3153 vs
->non_adaptive
= true;
3154 } else if (strncmp(options
, "share=", 6) == 0) {
3155 if (strncmp(options
+6, "ignore", 6) == 0) {
3156 vs
->share_policy
= VNC_SHARE_POLICY_IGNORE
;
3157 } else if (strncmp(options
+6, "allow-exclusive", 15) == 0) {
3158 vs
->share_policy
= VNC_SHARE_POLICY_ALLOW_EXCLUSIVE
;
3159 } else if (strncmp(options
+6, "force-shared", 12) == 0) {
3160 vs
->share_policy
= VNC_SHARE_POLICY_FORCE_SHARED
;
3162 error_setg(errp
, "unknown vnc share= option");
3168 #ifdef CONFIG_VNC_TLS
3169 if (acl
&& x509
&& vs
->tls
.x509verify
) {
3170 if (!(vs
->tls
.acl
= qemu_acl_init("vnc.x509dname"))) {
3171 fprintf(stderr
, "Failed to create x509 dname ACL\n");
3176 #ifdef CONFIG_VNC_SASL
3178 if (!(vs
->sasl
.acl
= qemu_acl_init("vnc.username"))) {
3179 fprintf(stderr
, "Failed to create username ACL\n");
3186 * Combinations we support here:
3188 * - no-auth (clear text, no auth)
3189 * - password (clear text, weak auth)
3190 * - sasl (encrypt, good auth *IF* using Kerberos via GSSAPI)
3191 * - tls (encrypt, weak anonymous creds, no auth)
3192 * - tls + password (encrypt, weak anonymous creds, weak auth)
3193 * - tls + sasl (encrypt, weak anonymous creds, good auth)
3194 * - tls + x509 (encrypt, good x509 creds, no auth)
3195 * - tls + x509 + password (encrypt, good x509 creds, weak auth)
3196 * - tls + x509 + sasl (encrypt, good x509 creds, good auth)
3198 * NB1. TLS is a stackable auth scheme.
3199 * NB2. the x509 schemes have option to validate a client cert dname
3202 #ifdef CONFIG_VNC_TLS
3204 vs
->auth
= VNC_AUTH_VENCRYPT
;
3206 VNC_DEBUG("Initializing VNC server with x509 password auth\n");
3207 vs
->subauth
= VNC_AUTH_VENCRYPT_X509VNC
;
3209 VNC_DEBUG("Initializing VNC server with TLS password auth\n");
3210 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSVNC
;
3213 #endif /* CONFIG_VNC_TLS */
3214 VNC_DEBUG("Initializing VNC server with password auth\n");
3215 vs
->auth
= VNC_AUTH_VNC
;
3216 #ifdef CONFIG_VNC_TLS
3217 vs
->subauth
= VNC_AUTH_INVALID
;
3219 #endif /* CONFIG_VNC_TLS */
3220 #ifdef CONFIG_VNC_SASL
3222 #ifdef CONFIG_VNC_TLS
3224 vs
->auth
= VNC_AUTH_VENCRYPT
;
3226 VNC_DEBUG("Initializing VNC server with x509 SASL auth\n");
3227 vs
->subauth
= VNC_AUTH_VENCRYPT_X509SASL
;
3229 VNC_DEBUG("Initializing VNC server with TLS SASL auth\n");
3230 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSSASL
;
3233 #endif /* CONFIG_VNC_TLS */
3234 VNC_DEBUG("Initializing VNC server with SASL auth\n");
3235 vs
->auth
= VNC_AUTH_SASL
;
3236 #ifdef CONFIG_VNC_TLS
3237 vs
->subauth
= VNC_AUTH_INVALID
;
3239 #endif /* CONFIG_VNC_TLS */
3240 #endif /* CONFIG_VNC_SASL */
3242 #ifdef CONFIG_VNC_TLS
3244 vs
->auth
= VNC_AUTH_VENCRYPT
;
3246 VNC_DEBUG("Initializing VNC server with x509 no auth\n");
3247 vs
->subauth
= VNC_AUTH_VENCRYPT_X509NONE
;
3249 VNC_DEBUG("Initializing VNC server with TLS no auth\n");
3250 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSNONE
;
3254 VNC_DEBUG("Initializing VNC server with no auth\n");
3255 vs
->auth
= VNC_AUTH_NONE
;
3256 #ifdef CONFIG_VNC_TLS
3257 vs
->subauth
= VNC_AUTH_INVALID
;
3262 #ifdef CONFIG_VNC_SASL
3263 if ((saslErr
= sasl_server_init(NULL
, "qemu")) != SASL_OK
) {
3264 error_setg(errp
, "Failed to initialize SASL auth: %s",
3265 sasl_errstring(saslErr
, NULL
, NULL
));
3269 vs
->lock_key_sync
= lock_key_sync
;
3272 /* connect to viewer */
3275 #ifdef CONFIG_VNC_WS
3278 if (strncmp(display
, "unix:", 5) == 0) {
3279 csock
= unix_connect(display
+5, errp
);
3281 csock
= inet_connect(display
, errp
);
3286 vnc_connect(vs
, csock
, 0, 0);
3288 /* listen for connects */
3290 dpy
= g_malloc(256);
3291 if (strncmp(display
, "unix:", 5) == 0) {
3292 pstrcpy(dpy
, 256, "unix:");
3293 vs
->lsock
= unix_listen(display
+5, dpy
+5, 256-5, errp
);
3295 vs
->lsock
= inet_listen(display
, dpy
, 256,
3296 SOCK_STREAM
, 5900, errp
);
3297 if (vs
->lsock
< 0) {
3301 #ifdef CONFIG_VNC_WS
3302 if (vs
->websocket
) {
3303 if (vs
->ws_display
) {
3304 vs
->lwebsock
= inet_listen(vs
->ws_display
, NULL
, 256,
3305 SOCK_STREAM
, 0, errp
);
3307 vs
->lwebsock
= inet_listen(vs
->display
, NULL
, 256,
3308 SOCK_STREAM
, 5700, errp
);
3311 if (vs
->lwebsock
< 0) {
3320 #endif /* CONFIG_VNC_WS */
3322 g_free(vs
->display
);
3324 qemu_set_fd_handler2(vs
->lsock
, NULL
,
3325 vnc_listen_regular_read
, NULL
, vs
);
3326 #ifdef CONFIG_VNC_WS
3327 if (vs
->websocket
) {
3328 qemu_set_fd_handler2(vs
->lwebsock
, NULL
,
3329 vnc_listen_websocket_read
, NULL
, vs
);
3331 #endif /* CONFIG_VNC_WS */
3336 g_free(vs
->display
);
3338 #ifdef CONFIG_VNC_WS
3339 g_free(vs
->ws_display
);
3340 vs
->ws_display
= NULL
;
3341 #endif /* CONFIG_VNC_WS */
3344 void vnc_display_add_client(DisplayState
*ds
, int csock
, int skipauth
)
3346 VncDisplay
*vs
= vnc_display
;
3348 vnc_connect(vs
, csock
, skipauth
, 0);