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