2 * QEMU VNC display driver
4 * Copyright (C) 2006 Anthony Liguori <anthony@codemonkey.ws>
5 * Copyright (C) 2006 Fabrice Bellard
6 * Copyright (C) 2009 Red Hat, Inc
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29 #include "qemu_socket.h"
30 #include "qemu-timer.h"
33 #define VNC_REFRESH_INTERVAL (1000 / 30)
35 #include "vnc_keysym.h"
38 #define count_bits(c, v) { \
39 for (c = 0; v; v >>= 1) \
46 static VncDisplay
*vnc_display
; /* needed for info vnc */
47 static DisplayChangeListener
*dcl
;
49 static char *addr_to_string(const char *format
,
50 struct sockaddr_storage
*sa
,
53 char host
[NI_MAXHOST
];
54 char serv
[NI_MAXSERV
];
58 if ((err
= getnameinfo((struct sockaddr
*)sa
, salen
,
61 NI_NUMERICHOST
| NI_NUMERICSERV
)) != 0) {
62 VNC_DEBUG("Cannot resolve address %d: %s\n",
63 err
, gai_strerror(err
));
67 /* Enough for the existing format + the 2 vars we're
69 addrlen
= strlen(format
) + strlen(host
) + strlen(serv
);
70 addr
= qemu_malloc(addrlen
+ 1);
71 snprintf(addr
, addrlen
, format
, host
, serv
);
78 char *vnc_socket_local_addr(const char *format
, int fd
) {
79 struct sockaddr_storage sa
;
83 if (getsockname(fd
, (struct sockaddr
*)&sa
, &salen
) < 0)
86 return addr_to_string(format
, &sa
, salen
);
90 char *vnc_socket_remote_addr(const char *format
, int fd
) {
91 struct sockaddr_storage sa
;
95 if (getpeername(fd
, (struct sockaddr
*)&sa
, &salen
) < 0)
98 return addr_to_string(format
, &sa
, salen
);
101 static const char *vnc_auth_name(VncDisplay
*vd
) {
103 case VNC_AUTH_INVALID
:
119 case VNC_AUTH_VENCRYPT
:
120 #ifdef CONFIG_VNC_TLS
121 switch (vd
->subauth
) {
122 case VNC_AUTH_VENCRYPT_PLAIN
:
123 return "vencrypt+plain";
124 case VNC_AUTH_VENCRYPT_TLSNONE
:
125 return "vencrypt+tls+none";
126 case VNC_AUTH_VENCRYPT_TLSVNC
:
127 return "vencrypt+tls+vnc";
128 case VNC_AUTH_VENCRYPT_TLSPLAIN
:
129 return "vencrypt+tls+plain";
130 case VNC_AUTH_VENCRYPT_X509NONE
:
131 return "vencrypt+x509+none";
132 case VNC_AUTH_VENCRYPT_X509VNC
:
133 return "vencrypt+x509+vnc";
134 case VNC_AUTH_VENCRYPT_X509PLAIN
:
135 return "vencrypt+x509+plain";
136 case VNC_AUTH_VENCRYPT_TLSSASL
:
137 return "vencrypt+tls+sasl";
138 case VNC_AUTH_VENCRYPT_X509SASL
:
139 return "vencrypt+x509+sasl";
152 static void do_info_vnc_client(Monitor
*mon
, VncState
*client
)
155 vnc_socket_remote_addr(" address: %s:%s\n",
160 monitor_printf(mon
, "Client:\n");
161 monitor_printf(mon
, "%s", clientAddr
);
164 #ifdef CONFIG_VNC_TLS
165 if (client
->tls
.session
&&
167 monitor_printf(mon
, " x509 dname: %s\n", client
->tls
.dname
);
169 monitor_printf(mon
, " x509 dname: none\n");
171 #ifdef CONFIG_VNC_SASL
172 if (client
->sasl
.conn
&&
173 client
->sasl
.username
)
174 monitor_printf(mon
, " username: %s\n", client
->sasl
.username
);
176 monitor_printf(mon
, " username: none\n");
180 void do_info_vnc(Monitor
*mon
)
182 if (vnc_display
== NULL
|| vnc_display
->display
== NULL
) {
183 monitor_printf(mon
, "Server: disabled\n");
185 char *serverAddr
= vnc_socket_local_addr(" address: %s:%s\n",
191 monitor_printf(mon
, "Server:\n");
192 monitor_printf(mon
, "%s", serverAddr
);
194 monitor_printf(mon
, " auth: %s\n", vnc_auth_name(vnc_display
));
196 if (vnc_display
->clients
) {
197 VncState
*client
= vnc_display
->clients
;
199 do_info_vnc_client(mon
, client
);
200 client
= client
->next
;
203 monitor_printf(mon
, "Client: none\n");
208 static inline uint32_t vnc_has_feature(VncState
*vs
, int feature
) {
209 return (vs
->features
& (1 << feature
));
213 1) Get the queue working for IO.
214 2) there is some weirdness when using the -S option (the screen is grey
215 and not totally invalidated
216 3) resolutions > 1024
219 static void vnc_update_client(void *opaque
);
221 static void vnc_colordepth(VncState
*vs
);
223 static inline void vnc_set_bit(uint32_t *d
, int k
)
225 d
[k
>> 5] |= 1 << (k
& 0x1f);
228 static inline void vnc_clear_bit(uint32_t *d
, int k
)
230 d
[k
>> 5] &= ~(1 << (k
& 0x1f));
233 static inline void vnc_set_bits(uint32_t *d
, int n
, int nb_words
)
243 d
[j
++] = (1 << n
) - 1;
248 static inline int vnc_get_bit(const uint32_t *d
, int k
)
250 return (d
[k
>> 5] >> (k
& 0x1f)) & 1;
253 static inline int vnc_and_bits(const uint32_t *d1
, const uint32_t *d2
,
257 for(i
= 0; i
< nb_words
; i
++) {
258 if ((d1
[i
] & d2
[i
]) != 0)
264 static void vnc_update(VncState
*vs
, int x
, int y
, int w
, int h
)
266 struct VncSurface
*s
= &vs
->guest
;
271 /* round x down to ensure the loop only spans one 16-pixel block per,
272 iteration. otherwise, if (x % 16) != 0, the last iteration may span
273 two 16-pixel blocks but we only mark the first as dirty
278 x
= MIN(x
, s
->ds
->width
);
279 y
= MIN(y
, s
->ds
->height
);
280 w
= MIN(x
+ w
, s
->ds
->width
) - x
;
281 h
= MIN(h
, s
->ds
->height
);
284 for (i
= 0; i
< w
; i
+= 16)
285 vnc_set_bit(s
->dirty
[y
], (x
+ i
) / 16);
288 static void vnc_dpy_update(DisplayState
*ds
, int x
, int y
, int w
, int h
)
290 VncDisplay
*vd
= ds
->opaque
;
291 VncState
*vs
= vd
->clients
;
293 vnc_update(vs
, x
, y
, w
, h
);
298 static void vnc_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
,
301 vnc_write_u16(vs
, x
);
302 vnc_write_u16(vs
, y
);
303 vnc_write_u16(vs
, w
);
304 vnc_write_u16(vs
, h
);
306 vnc_write_s32(vs
, encoding
);
309 void buffer_reserve(Buffer
*buffer
, size_t len
)
311 if ((buffer
->capacity
- buffer
->offset
) < len
) {
312 buffer
->capacity
+= (len
+ 1024);
313 buffer
->buffer
= qemu_realloc(buffer
->buffer
, buffer
->capacity
);
314 if (buffer
->buffer
== NULL
) {
315 fprintf(stderr
, "vnc: out of memory\n");
321 int buffer_empty(Buffer
*buffer
)
323 return buffer
->offset
== 0;
326 uint8_t *buffer_end(Buffer
*buffer
)
328 return buffer
->buffer
+ buffer
->offset
;
331 void buffer_reset(Buffer
*buffer
)
336 void buffer_append(Buffer
*buffer
, const void *data
, size_t len
)
338 memcpy(buffer
->buffer
+ buffer
->offset
, data
, len
);
339 buffer
->offset
+= len
;
342 static void vnc_resize(VncState
*vs
)
344 DisplayState
*ds
= vs
->ds
;
349 vs
->guest
.ds
= qemu_mallocz(sizeof(*vs
->guest
.ds
));
350 if (ds_get_bytes_per_pixel(ds
) != vs
->guest
.ds
->pf
.bytes_per_pixel
)
351 console_color_init(ds
);
353 size_changed
= ds_get_width(ds
) != vs
->guest
.ds
->width
||
354 ds_get_height(ds
) != vs
->guest
.ds
->height
;
355 *(vs
->guest
.ds
) = *(ds
->surface
);
357 if (vs
->csock
!= -1 && vnc_has_feature(vs
, VNC_FEATURE_RESIZE
)) {
358 vnc_write_u8(vs
, 0); /* msg id */
360 vnc_write_u16(vs
, 1); /* number of rects */
361 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(ds
), ds_get_height(ds
),
362 VNC_ENCODING_DESKTOPRESIZE
);
366 memset(vs
->guest
.dirty
, 0xFF, sizeof(vs
->guest
.dirty
));
369 if (!vs
->server
.ds
) {
370 vs
->server
.ds
= default_allocator
.create_displaysurface(ds_get_width(ds
),
373 default_allocator
.resize_displaysurface(vs
->server
.ds
,
374 ds_get_width(ds
), ds_get_height(ds
));
376 if (vs
->server
.ds
->data
== NULL
) {
377 fprintf(stderr
, "vnc: memory allocation failed\n");
380 memset(vs
->server
.dirty
, 0xFF, sizeof(vs
->guest
.dirty
));
383 static void vnc_dpy_resize(DisplayState
*ds
)
385 VncDisplay
*vd
= ds
->opaque
;
386 VncState
*vs
= vd
->clients
;
394 static void vnc_write_pixels_copy(VncState
*vs
, void *pixels
, int size
)
396 vnc_write(vs
, pixels
, size
);
399 /* slowest but generic code. */
400 static void vnc_convert_pixel(VncState
*vs
, uint8_t *buf
, uint32_t v
)
404 r
= ((((v
& vs
->server
.ds
->pf
.rmask
) >> vs
->server
.ds
->pf
.rshift
) << vs
->clientds
.pf
.rbits
) >>
405 vs
->server
.ds
->pf
.rbits
);
406 g
= ((((v
& vs
->server
.ds
->pf
.gmask
) >> vs
->server
.ds
->pf
.gshift
) << vs
->clientds
.pf
.gbits
) >>
407 vs
->server
.ds
->pf
.gbits
);
408 b
= ((((v
& vs
->server
.ds
->pf
.bmask
) >> vs
->server
.ds
->pf
.bshift
) << vs
->clientds
.pf
.bbits
) >>
409 vs
->server
.ds
->pf
.bbits
);
410 v
= (r
<< vs
->clientds
.pf
.rshift
) |
411 (g
<< vs
->clientds
.pf
.gshift
) |
412 (b
<< vs
->clientds
.pf
.bshift
);
413 switch(vs
->clientds
.pf
.bytes_per_pixel
) {
418 if (vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) {
428 if (vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) {
443 static void vnc_write_pixels_generic(VncState
*vs
, void *pixels1
, int size
)
447 if (vs
->server
.ds
->pf
.bytes_per_pixel
== 4) {
448 uint32_t *pixels
= pixels1
;
451 for(i
= 0; i
< n
; i
++) {
452 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
453 vnc_write(vs
, buf
, vs
->clientds
.pf
.bytes_per_pixel
);
455 } else if (vs
->server
.ds
->pf
.bytes_per_pixel
== 2) {
456 uint16_t *pixels
= pixels1
;
459 for(i
= 0; i
< n
; i
++) {
460 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
461 vnc_write(vs
, buf
, vs
->clientds
.pf
.bytes_per_pixel
);
463 } else if (vs
->server
.ds
->pf
.bytes_per_pixel
== 1) {
464 uint8_t *pixels
= pixels1
;
467 for(i
= 0; i
< n
; i
++) {
468 vnc_convert_pixel(vs
, buf
, pixels
[i
]);
469 vnc_write(vs
, buf
, vs
->clientds
.pf
.bytes_per_pixel
);
472 fprintf(stderr
, "vnc_write_pixels_generic: VncState color depth not supported\n");
476 static void send_framebuffer_update_raw(VncState
*vs
, int x
, int y
, int w
, int h
)
481 row
= vs
->server
.ds
->data
+ y
* ds_get_linesize(vs
->ds
) + x
* ds_get_bytes_per_pixel(vs
->ds
);
482 for (i
= 0; i
< h
; i
++) {
483 vs
->write_pixels(vs
, row
, w
* ds_get_bytes_per_pixel(vs
->ds
));
484 row
+= ds_get_linesize(vs
->ds
);
488 static void hextile_enc_cord(uint8_t *ptr
, int x
, int y
, int w
, int h
)
490 ptr
[0] = ((x
& 0x0F) << 4) | (y
& 0x0F);
491 ptr
[1] = (((w
- 1) & 0x0F) << 4) | ((h
- 1) & 0x0F);
495 #include "vnchextile.h"
499 #include "vnchextile.h"
503 #include "vnchextile.h"
508 #include "vnchextile.h"
514 #include "vnchextile.h"
520 #include "vnchextile.h"
524 static void send_framebuffer_update_hextile(VncState
*vs
, int x
, int y
, int w
, int h
)
528 uint8_t *last_fg
, *last_bg
;
530 last_fg
= (uint8_t *) qemu_malloc(vs
->server
.ds
->pf
.bytes_per_pixel
);
531 last_bg
= (uint8_t *) qemu_malloc(vs
->server
.ds
->pf
.bytes_per_pixel
);
533 for (j
= y
; j
< (y
+ h
); j
+= 16) {
534 for (i
= x
; i
< (x
+ w
); i
+= 16) {
535 vs
->send_hextile_tile(vs
, i
, j
,
536 MIN(16, x
+ w
- i
), MIN(16, y
+ h
- j
),
537 last_bg
, last_fg
, &has_bg
, &has_fg
);
545 static void vnc_zlib_init(VncState
*vs
)
548 for (i
=0; i
<(sizeof(vs
->zlib_stream
) / sizeof(z_stream
)); i
++)
549 vs
->zlib_stream
[i
].opaque
= NULL
;
552 static void vnc_zlib_start(VncState
*vs
)
554 buffer_reset(&vs
->zlib
);
556 // make the output buffer be the zlib buffer, so we can compress it later
557 vs
->zlib_tmp
= vs
->output
;
558 vs
->output
= vs
->zlib
;
561 static int vnc_zlib_stop(VncState
*vs
, int stream_id
)
563 z_streamp zstream
= &vs
->zlib_stream
[stream_id
];
566 // switch back to normal output/zlib buffers
567 vs
->zlib
= vs
->output
;
568 vs
->output
= vs
->zlib_tmp
;
570 // compress the zlib buffer
572 // initialize the stream
573 // XXX need one stream per session
574 if (zstream
->opaque
!= vs
) {
577 VNC_DEBUG("VNC: initializing zlib stream %d\n", stream_id
);
578 VNC_DEBUG("VNC: opaque = %p | vs = %p\n", zstream
->opaque
, vs
);
579 zstream
->zalloc
= Z_NULL
;
580 zstream
->zfree
= Z_NULL
;
582 err
= deflateInit2(zstream
, vs
->tight_compression
, Z_DEFLATED
, MAX_WBITS
,
583 MAX_MEM_LEVEL
, Z_DEFAULT_STRATEGY
);
586 fprintf(stderr
, "VNC: error initializing zlib\n");
590 zstream
->opaque
= vs
;
593 // XXX what to do if tight_compression changed in between?
595 // reserve memory in output buffer
596 buffer_reserve(&vs
->output
, vs
->zlib
.offset
+ 64);
599 zstream
->next_in
= vs
->zlib
.buffer
;
600 zstream
->avail_in
= vs
->zlib
.offset
;
601 zstream
->next_out
= vs
->output
.buffer
+ vs
->output
.offset
;
602 zstream
->avail_out
= vs
->output
.capacity
- vs
->output
.offset
;
603 zstream
->data_type
= Z_BINARY
;
604 previous_out
= zstream
->total_out
;
607 if (deflate(zstream
, Z_SYNC_FLUSH
) != Z_OK
) {
608 fprintf(stderr
, "VNC: error during zlib compression\n");
612 vs
->output
.offset
= vs
->output
.capacity
- zstream
->avail_out
;
613 return zstream
->total_out
- previous_out
;
616 static void send_framebuffer_update_zlib(VncState
*vs
, int x
, int y
, int w
, int h
)
618 int old_offset
, new_offset
, bytes_written
;
620 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_ZLIB
);
622 // remember where we put in the follow-up size
623 old_offset
= vs
->output
.offset
;
624 vnc_write_s32(vs
, 0);
626 // compress the stream
628 send_framebuffer_update_raw(vs
, x
, y
, w
, h
);
629 bytes_written
= vnc_zlib_stop(vs
, 0);
631 if (bytes_written
== -1)
635 new_offset
= vs
->output
.offset
;
636 vs
->output
.offset
= old_offset
;
637 vnc_write_u32(vs
, bytes_written
);
638 vs
->output
.offset
= new_offset
;
641 static void send_framebuffer_update(VncState
*vs
, int x
, int y
, int w
, int h
)
643 switch(vs
->vnc_encoding
) {
644 case VNC_ENCODING_ZLIB
:
645 send_framebuffer_update_zlib(vs
, x
, y
, w
, h
);
647 case VNC_ENCODING_HEXTILE
:
648 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_HEXTILE
);
649 send_framebuffer_update_hextile(vs
, x
, y
, w
, h
);
652 vnc_framebuffer_update(vs
, x
, y
, w
, h
, VNC_ENCODING_RAW
);
653 send_framebuffer_update_raw(vs
, x
, y
, w
, h
);
658 static void vnc_copy(VncState
*vs
, int src_x
, int src_y
, int dst_x
, int dst_y
, int w
, int h
)
660 vnc_update_client(vs
);
662 vnc_write_u8(vs
, 0); /* msg id */
664 vnc_write_u16(vs
, 1); /* number of rects */
665 vnc_framebuffer_update(vs
, dst_x
, dst_y
, w
, h
, VNC_ENCODING_COPYRECT
);
666 vnc_write_u16(vs
, src_x
);
667 vnc_write_u16(vs
, src_y
);
671 static void vnc_dpy_copy(DisplayState
*ds
, int src_x
, int src_y
, int dst_x
, int dst_y
, int w
, int h
)
673 VncDisplay
*vd
= ds
->opaque
;
674 VncState
*vs
= vd
->clients
;
676 if (vnc_has_feature(vs
, VNC_FEATURE_COPYRECT
))
677 vnc_copy(vs
, src_x
, src_y
, dst_x
, dst_y
, w
, h
);
679 vnc_update(vs
, dst_x
, dst_y
, w
, h
);
684 static int find_and_clear_dirty_height(struct VncSurface
*s
,
685 int y
, int last_x
, int x
)
689 for (h
= 1; h
< (s
->ds
->height
- y
) && h
< 1; h
++) {
691 if (!vnc_get_bit(s
->dirty
[y
+ h
], last_x
))
693 for (tmp_x
= last_x
; tmp_x
< x
; tmp_x
++)
694 vnc_clear_bit(s
->dirty
[y
+ h
], tmp_x
);
700 static void vnc_update_client(void *opaque
)
702 VncState
*vs
= opaque
;
703 if (vs
->need_update
&& vs
->csock
!= -1) {
707 int cmp_bytes
= 16 * ds_get_bytes_per_pixel(vs
->ds
);
708 uint32_t width_mask
[VNC_DIRTY_WORDS
];
716 * Walk through the guest dirty map.
717 * Check and copy modified bits from guest to server surface.
718 * Update server dirty map.
720 vnc_set_bits(width_mask
, (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
721 guest_row
= vs
->guest
.ds
->data
;
722 server_row
= vs
->server
.ds
->data
;
723 for (y
= 0; y
< vs
->guest
.ds
->height
; y
++) {
724 if (vnc_and_bits(vs
->guest
.dirty
[y
], width_mask
, VNC_DIRTY_WORDS
)) {
729 guest_ptr
= guest_row
;
730 server_ptr
= server_row
;
732 for (x
= 0; x
< vs
->guest
.ds
->width
;
733 x
+= 16, guest_ptr
+= cmp_bytes
, server_ptr
+= cmp_bytes
) {
734 if (!vnc_get_bit(vs
->guest
.dirty
[y
], (x
/ 16)))
736 vnc_clear_bit(vs
->guest
.dirty
[y
], (x
/ 16));
737 if (memcmp(server_ptr
, guest_ptr
, cmp_bytes
) == 0)
739 memcpy(server_ptr
, guest_ptr
, cmp_bytes
);
740 vnc_set_bit(vs
->server
.dirty
[y
], (x
/ 16));
744 guest_row
+= ds_get_linesize(vs
->ds
);
745 server_row
+= ds_get_linesize(vs
->ds
);
748 if (!has_dirty
&& !vs
->audio_cap
) {
749 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
754 * Send screen updates to the vnc client using the server
755 * surface and server dirty map. guest surface updates
756 * happening in parallel don't disturb us, the next pass will
757 * send them to the client.
760 vnc_write_u8(vs
, 0); /* msg id */
762 saved_offset
= vs
->output
.offset
;
763 vnc_write_u16(vs
, 0);
765 for (y
= 0; y
< vs
->server
.ds
->height
; y
++) {
768 for (x
= 0; x
< vs
->server
.ds
->width
/ 16; x
++) {
769 if (vnc_get_bit(vs
->server
.dirty
[y
], x
)) {
773 vnc_clear_bit(vs
->server
.dirty
[y
], x
);
776 int h
= find_and_clear_dirty_height(&vs
->server
, y
, last_x
, x
);
777 send_framebuffer_update(vs
, last_x
* 16, y
, (x
- last_x
) * 16, h
);
784 int h
= find_and_clear_dirty_height(&vs
->server
, y
, last_x
, x
);
785 send_framebuffer_update(vs
, last_x
* 16, y
, (x
- last_x
) * 16, h
);
789 vs
->output
.buffer
[saved_offset
] = (n_rectangles
>> 8) & 0xFF;
790 vs
->output
.buffer
[saved_offset
+ 1] = n_rectangles
& 0xFF;
795 if (vs
->csock
!= -1) {
796 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
802 static void audio_capture_notify(void *opaque
, audcnotification_e cmd
)
804 VncState
*vs
= opaque
;
807 case AUD_CNOTIFY_DISABLE
:
808 vnc_write_u8(vs
, 255);
810 vnc_write_u16(vs
, 0);
814 case AUD_CNOTIFY_ENABLE
:
815 vnc_write_u8(vs
, 255);
817 vnc_write_u16(vs
, 1);
823 static void audio_capture_destroy(void *opaque
)
827 static void audio_capture(void *opaque
, void *buf
, int size
)
829 VncState
*vs
= opaque
;
831 vnc_write_u8(vs
, 255);
833 vnc_write_u16(vs
, 2);
834 vnc_write_u32(vs
, size
);
835 vnc_write(vs
, buf
, size
);
839 static void audio_add(VncState
*vs
)
841 Monitor
*mon
= cur_mon
;
842 struct audio_capture_ops ops
;
845 monitor_printf(mon
, "audio already running\n");
849 ops
.notify
= audio_capture_notify
;
850 ops
.destroy
= audio_capture_destroy
;
851 ops
.capture
= audio_capture
;
853 vs
->audio_cap
= AUD_add_capture(NULL
, &vs
->as
, &ops
, vs
);
854 if (!vs
->audio_cap
) {
855 monitor_printf(mon
, "Failed to add audio capture\n");
859 static void audio_del(VncState
*vs
)
862 AUD_del_capture(vs
->audio_cap
, vs
);
863 vs
->audio_cap
= NULL
;
868 int vnc_client_io_error(VncState
*vs
, int ret
, int last_errno
)
870 if (ret
== 0 || ret
== -1) {
872 switch (last_errno
) {
884 VNC_DEBUG("Closing down client sock %d %d\n", ret
, ret
< 0 ? last_errno
: 0);
885 qemu_set_fd_handler2(vs
->csock
, NULL
, NULL
, NULL
, NULL
);
886 closesocket(vs
->csock
);
887 qemu_del_timer(vs
->timer
);
888 qemu_free_timer(vs
->timer
);
889 if (vs
->input
.buffer
) qemu_free(vs
->input
.buffer
);
890 if (vs
->output
.buffer
) qemu_free(vs
->output
.buffer
);
891 #ifdef CONFIG_VNC_TLS
892 vnc_tls_client_cleanup(vs
);
893 #endif /* CONFIG_VNC_TLS */
894 #ifdef CONFIG_VNC_SASL
895 vnc_sasl_client_cleanup(vs
);
896 #endif /* CONFIG_VNC_SASL */
899 VncState
*p
, *parent
= NULL
;
900 for (p
= vs
->vd
->clients
; p
!= NULL
; p
= p
->next
) {
903 parent
->next
= p
->next
;
905 vs
->vd
->clients
= p
->next
;
910 if (!vs
->vd
->clients
)
913 default_allocator
.free_displaysurface(vs
->server
.ds
);
914 qemu_free(vs
->guest
.ds
);
923 void vnc_client_error(VncState
*vs
)
925 vnc_client_io_error(vs
, -1, EINVAL
);
930 * Called to write a chunk of data to the client socket. The data may
931 * be the raw data, or may have already been encoded by SASL.
932 * The data will be written either straight onto the socket, or
933 * written via the GNUTLS wrappers, if TLS/SSL encryption is enabled
935 * NB, it is theoretically possible to have 2 layers of encryption,
936 * both SASL, and this TLS layer. It is highly unlikely in practice
937 * though, since SASL encryption will typically be a no-op if TLS
940 * Returns the number of bytes written, which may be less than
941 * the requested 'datalen' if the socket would block. Returns
942 * -1 on error, and disconnects the client socket.
944 long vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
)
947 #ifdef CONFIG_VNC_TLS
948 if (vs
->tls
.session
) {
949 ret
= gnutls_write(vs
->tls
.session
, data
, datalen
);
951 if (ret
== GNUTLS_E_AGAIN
)
958 #endif /* CONFIG_VNC_TLS */
959 ret
= send(vs
->csock
, data
, datalen
, 0);
960 VNC_DEBUG("Wrote wire %p %d -> %ld\n", data
, datalen
, ret
);
961 return vnc_client_io_error(vs
, ret
, socket_error());
966 * Called to write buffered data to the client socket, when not
967 * using any SASL SSF encryption layers. Will write as much data
968 * as possible without blocking. If all buffered data is written,
969 * will switch the FD poll() handler back to read monitoring.
971 * Returns the number of bytes written, which may be less than
972 * the buffered output data if the socket would block. Returns
973 * -1 on error, and disconnects the client socket.
975 static long vnc_client_write_plain(VncState
*vs
)
979 #ifdef CONFIG_VNC_SASL
980 VNC_DEBUG("Write Plain: Pending output %p size %d offset %d. Wait SSF %d\n",
981 vs
->output
.buffer
, vs
->output
.capacity
, vs
->output
.offset
,
982 vs
->sasl
.waitWriteSSF
);
986 vs
->sasl
.waitWriteSSF
) {
987 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->sasl
.waitWriteSSF
);
989 vs
->sasl
.waitWriteSSF
-= ret
;
991 #endif /* CONFIG_VNC_SASL */
992 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->output
.offset
);
996 memmove(vs
->output
.buffer
, vs
->output
.buffer
+ ret
, (vs
->output
.offset
- ret
));
997 vs
->output
.offset
-= ret
;
999 if (vs
->output
.offset
== 0) {
1000 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
1008 * First function called whenever there is data to be written to
1009 * the client socket. Will delegate actual work according to whether
1010 * SASL SSF layers are enabled (thus requiring encryption calls)
1012 void vnc_client_write(void *opaque
)
1015 VncState
*vs
= opaque
;
1017 #ifdef CONFIG_VNC_SASL
1018 if (vs
->sasl
.conn
&&
1020 !vs
->sasl
.waitWriteSSF
)
1021 ret
= vnc_client_write_sasl(vs
);
1023 #endif /* CONFIG_VNC_SASL */
1024 ret
= vnc_client_write_plain(vs
);
1027 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
)
1029 vs
->read_handler
= func
;
1030 vs
->read_handler_expect
= expecting
;
1035 * Called to read a chunk of data from the client socket. The data may
1036 * be the raw data, or may need to be further decoded by SASL.
1037 * The data will be read either straight from to the socket, or
1038 * read via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1040 * NB, it is theoretically possible to have 2 layers of encryption,
1041 * both SASL, and this TLS layer. It is highly unlikely in practice
1042 * though, since SASL encryption will typically be a no-op if TLS
1045 * Returns the number of bytes read, which may be less than
1046 * the requested 'datalen' if the socket would block. Returns
1047 * -1 on error, and disconnects the client socket.
1049 long vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
)
1052 #ifdef CONFIG_VNC_TLS
1053 if (vs
->tls
.session
) {
1054 ret
= gnutls_read(vs
->tls
.session
, data
, datalen
);
1056 if (ret
== GNUTLS_E_AGAIN
)
1063 #endif /* CONFIG_VNC_TLS */
1064 ret
= recv(vs
->csock
, data
, datalen
, 0);
1065 VNC_DEBUG("Read wire %p %d -> %ld\n", data
, datalen
, ret
);
1066 return vnc_client_io_error(vs
, ret
, socket_error());
1071 * Called to read data from the client socket to the input buffer,
1072 * when not using any SASL SSF encryption layers. Will read as much
1073 * data as possible without blocking.
1075 * Returns the number of bytes read. Returns -1 on error, and
1076 * disconnects the client socket.
1078 static long vnc_client_read_plain(VncState
*vs
)
1081 VNC_DEBUG("Read plain %p size %d offset %d\n",
1082 vs
->input
.buffer
, vs
->input
.capacity
, vs
->input
.offset
);
1083 buffer_reserve(&vs
->input
, 4096);
1084 ret
= vnc_client_read_buf(vs
, buffer_end(&vs
->input
), 4096);
1087 vs
->input
.offset
+= ret
;
1093 * First function called whenever there is more data to be read from
1094 * the client socket. Will delegate actual work according to whether
1095 * SASL SSF layers are enabled (thus requiring decryption calls)
1097 void vnc_client_read(void *opaque
)
1099 VncState
*vs
= opaque
;
1102 #ifdef CONFIG_VNC_SASL
1103 if (vs
->sasl
.conn
&& vs
->sasl
.runSSF
)
1104 ret
= vnc_client_read_sasl(vs
);
1106 #endif /* CONFIG_VNC_SASL */
1107 ret
= vnc_client_read_plain(vs
);
1111 while (vs
->read_handler
&& vs
->input
.offset
>= vs
->read_handler_expect
) {
1112 size_t len
= vs
->read_handler_expect
;
1115 ret
= vs
->read_handler(vs
, vs
->input
.buffer
, len
);
1116 if (vs
->csock
== -1)
1120 memmove(vs
->input
.buffer
, vs
->input
.buffer
+ len
, (vs
->input
.offset
- len
));
1121 vs
->input
.offset
-= len
;
1123 vs
->read_handler_expect
= ret
;
1128 void vnc_write(VncState
*vs
, const void *data
, size_t len
)
1130 buffer_reserve(&vs
->output
, len
);
1132 if (buffer_empty(&vs
->output
)) {
1133 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, vnc_client_write
, vs
);
1136 buffer_append(&vs
->output
, data
, len
);
1139 void vnc_write_s32(VncState
*vs
, int32_t value
)
1141 vnc_write_u32(vs
, *(uint32_t *)&value
);
1144 void vnc_write_u32(VncState
*vs
, uint32_t value
)
1148 buf
[0] = (value
>> 24) & 0xFF;
1149 buf
[1] = (value
>> 16) & 0xFF;
1150 buf
[2] = (value
>> 8) & 0xFF;
1151 buf
[3] = value
& 0xFF;
1153 vnc_write(vs
, buf
, 4);
1156 void vnc_write_u16(VncState
*vs
, uint16_t value
)
1160 buf
[0] = (value
>> 8) & 0xFF;
1161 buf
[1] = value
& 0xFF;
1163 vnc_write(vs
, buf
, 2);
1166 void vnc_write_u8(VncState
*vs
, uint8_t value
)
1168 vnc_write(vs
, (char *)&value
, 1);
1171 void vnc_flush(VncState
*vs
)
1173 if (vs
->output
.offset
)
1174 vnc_client_write(vs
);
1177 uint8_t read_u8(uint8_t *data
, size_t offset
)
1179 return data
[offset
];
1182 uint16_t read_u16(uint8_t *data
, size_t offset
)
1184 return ((data
[offset
] & 0xFF) << 8) | (data
[offset
+ 1] & 0xFF);
1187 int32_t read_s32(uint8_t *data
, size_t offset
)
1189 return (int32_t)((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1190 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1193 uint32_t read_u32(uint8_t *data
, size_t offset
)
1195 return ((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1196 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1199 static void client_cut_text(VncState
*vs
, size_t len
, uint8_t *text
)
1203 static void check_pointer_type_change(VncState
*vs
, int absolute
)
1205 if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
) && vs
->absolute
!= absolute
) {
1206 vnc_write_u8(vs
, 0);
1207 vnc_write_u8(vs
, 0);
1208 vnc_write_u16(vs
, 1);
1209 vnc_framebuffer_update(vs
, absolute
, 0,
1210 ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1211 VNC_ENCODING_POINTER_TYPE_CHANGE
);
1214 vs
->absolute
= absolute
;
1217 static void pointer_event(VncState
*vs
, int button_mask
, int x
, int y
)
1222 if (button_mask
& 0x01)
1223 buttons
|= MOUSE_EVENT_LBUTTON
;
1224 if (button_mask
& 0x02)
1225 buttons
|= MOUSE_EVENT_MBUTTON
;
1226 if (button_mask
& 0x04)
1227 buttons
|= MOUSE_EVENT_RBUTTON
;
1228 if (button_mask
& 0x08)
1230 if (button_mask
& 0x10)
1234 kbd_mouse_event(x
* 0x7FFF / (ds_get_width(vs
->ds
) - 1),
1235 y
* 0x7FFF / (ds_get_height(vs
->ds
) - 1),
1237 } else if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
)) {
1241 kbd_mouse_event(x
, y
, dz
, buttons
);
1243 if (vs
->last_x
!= -1)
1244 kbd_mouse_event(x
- vs
->last_x
,
1251 check_pointer_type_change(vs
, kbd_mouse_is_absolute());
1254 static void reset_keys(VncState
*vs
)
1257 for(i
= 0; i
< 256; i
++) {
1258 if (vs
->modifiers_state
[i
]) {
1260 kbd_put_keycode(0xe0);
1261 kbd_put_keycode(i
| 0x80);
1262 vs
->modifiers_state
[i
] = 0;
1267 static void press_key(VncState
*vs
, int keysym
)
1269 kbd_put_keycode(keysym2scancode(vs
->vd
->kbd_layout
, keysym
) & 0x7f);
1270 kbd_put_keycode(keysym2scancode(vs
->vd
->kbd_layout
, keysym
) | 0x80);
1273 static void do_key_event(VncState
*vs
, int down
, int keycode
, int sym
)
1275 /* QEMU console switch */
1277 case 0x2a: /* Left Shift */
1278 case 0x36: /* Right Shift */
1279 case 0x1d: /* Left CTRL */
1280 case 0x9d: /* Right CTRL */
1281 case 0x38: /* Left ALT */
1282 case 0xb8: /* Right ALT */
1284 vs
->modifiers_state
[keycode
] = 1;
1286 vs
->modifiers_state
[keycode
] = 0;
1288 case 0x02 ... 0x0a: /* '1' to '9' keys */
1289 if (down
&& vs
->modifiers_state
[0x1d] && vs
->modifiers_state
[0x38]) {
1290 /* Reset the modifiers sent to the current console */
1292 console_select(keycode
- 0x02);
1296 case 0x3a: /* CapsLock */
1297 case 0x45: /* NumLock */
1299 vs
->modifiers_state
[keycode
] ^= 1;
1303 if (keycode_is_keypad(vs
->vd
->kbd_layout
, keycode
)) {
1304 /* If the numlock state needs to change then simulate an additional
1305 keypress before sending this one. This will happen if the user
1306 toggles numlock away from the VNC window.
1308 if (keysym_is_numlock(vs
->vd
->kbd_layout
, sym
& 0xFFFF)) {
1309 if (!vs
->modifiers_state
[0x45]) {
1310 vs
->modifiers_state
[0x45] = 1;
1311 press_key(vs
, 0xff7f);
1314 if (vs
->modifiers_state
[0x45]) {
1315 vs
->modifiers_state
[0x45] = 0;
1316 press_key(vs
, 0xff7f);
1321 if (is_graphic_console()) {
1323 kbd_put_keycode(0xe0);
1325 kbd_put_keycode(keycode
& 0x7f);
1327 kbd_put_keycode(keycode
| 0x80);
1329 /* QEMU console emulation */
1332 case 0x2a: /* Left Shift */
1333 case 0x36: /* Right Shift */
1334 case 0x1d: /* Left CTRL */
1335 case 0x9d: /* Right CTRL */
1336 case 0x38: /* Left ALT */
1337 case 0xb8: /* Right ALT */
1340 kbd_put_keysym(QEMU_KEY_UP
);
1343 kbd_put_keysym(QEMU_KEY_DOWN
);
1346 kbd_put_keysym(QEMU_KEY_LEFT
);
1349 kbd_put_keysym(QEMU_KEY_RIGHT
);
1352 kbd_put_keysym(QEMU_KEY_DELETE
);
1355 kbd_put_keysym(QEMU_KEY_HOME
);
1358 kbd_put_keysym(QEMU_KEY_END
);
1361 kbd_put_keysym(QEMU_KEY_PAGEUP
);
1364 kbd_put_keysym(QEMU_KEY_PAGEDOWN
);
1367 kbd_put_keysym(sym
);
1374 static void key_event(VncState
*vs
, int down
, uint32_t sym
)
1378 if (sym
>= 'A' && sym
<= 'Z' && is_graphic_console())
1379 sym
= sym
- 'A' + 'a';
1381 keycode
= keysym2scancode(vs
->vd
->kbd_layout
, sym
& 0xFFFF);
1382 do_key_event(vs
, down
, keycode
, sym
);
1385 static void ext_key_event(VncState
*vs
, int down
,
1386 uint32_t sym
, uint16_t keycode
)
1388 /* if the user specifies a keyboard layout, always use it */
1389 if (keyboard_layout
)
1390 key_event(vs
, down
, sym
);
1392 do_key_event(vs
, down
, keycode
, sym
);
1395 static void framebuffer_update_request(VncState
*vs
, int incremental
,
1396 int x_position
, int y_position
,
1399 if (x_position
> ds_get_width(vs
->ds
))
1400 x_position
= ds_get_width(vs
->ds
);
1401 if (y_position
> ds_get_height(vs
->ds
))
1402 y_position
= ds_get_height(vs
->ds
);
1403 if (x_position
+ w
>= ds_get_width(vs
->ds
))
1404 w
= ds_get_width(vs
->ds
) - x_position
;
1405 if (y_position
+ h
>= ds_get_height(vs
->ds
))
1406 h
= ds_get_height(vs
->ds
) - y_position
;
1409 vs
->need_update
= 1;
1411 for (i
= 0; i
< h
; i
++) {
1412 vnc_set_bits(vs
->guest
.dirty
[y_position
+ i
],
1413 (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
1414 vnc_set_bits(vs
->server
.dirty
[y_position
+ i
],
1415 (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
1420 static void send_ext_key_event_ack(VncState
*vs
)
1422 vnc_write_u8(vs
, 0);
1423 vnc_write_u8(vs
, 0);
1424 vnc_write_u16(vs
, 1);
1425 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1426 VNC_ENCODING_EXT_KEY_EVENT
);
1430 static void send_ext_audio_ack(VncState
*vs
)
1432 vnc_write_u8(vs
, 0);
1433 vnc_write_u8(vs
, 0);
1434 vnc_write_u16(vs
, 1);
1435 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1436 VNC_ENCODING_AUDIO
);
1440 static void set_encodings(VncState
*vs
, int32_t *encodings
, size_t n_encodings
)
1443 unsigned int enc
= 0;
1447 vs
->vnc_encoding
= 0;
1448 vs
->tight_compression
= 9;
1449 vs
->tight_quality
= 9;
1452 for (i
= n_encodings
- 1; i
>= 0; i
--) {
1455 case VNC_ENCODING_RAW
:
1456 vs
->vnc_encoding
= enc
;
1458 case VNC_ENCODING_COPYRECT
:
1459 vs
->features
|= VNC_FEATURE_COPYRECT_MASK
;
1461 case VNC_ENCODING_HEXTILE
:
1462 vs
->features
|= VNC_FEATURE_HEXTILE_MASK
;
1463 vs
->vnc_encoding
= enc
;
1465 case VNC_ENCODING_ZLIB
:
1466 vs
->features
|= VNC_FEATURE_ZLIB_MASK
;
1467 vs
->vnc_encoding
= enc
;
1469 case VNC_ENCODING_DESKTOPRESIZE
:
1470 vs
->features
|= VNC_FEATURE_RESIZE_MASK
;
1472 case VNC_ENCODING_POINTER_TYPE_CHANGE
:
1473 vs
->features
|= VNC_FEATURE_POINTER_TYPE_CHANGE_MASK
;
1475 case VNC_ENCODING_EXT_KEY_EVENT
:
1476 send_ext_key_event_ack(vs
);
1478 case VNC_ENCODING_AUDIO
:
1479 send_ext_audio_ack(vs
);
1481 case VNC_ENCODING_WMVi
:
1482 vs
->features
|= VNC_FEATURE_WMVI_MASK
;
1484 case VNC_ENCODING_COMPRESSLEVEL0
... VNC_ENCODING_COMPRESSLEVEL0
+ 9:
1485 vs
->tight_compression
= (enc
& 0x0F);
1487 case VNC_ENCODING_QUALITYLEVEL0
... VNC_ENCODING_QUALITYLEVEL0
+ 9:
1488 vs
->tight_quality
= (enc
& 0x0F);
1491 VNC_DEBUG("Unknown encoding: %d (0x%.8x): %d\n", i
, enc
, enc
);
1496 check_pointer_type_change(vs
, kbd_mouse_is_absolute());
1499 static void set_pixel_conversion(VncState
*vs
)
1501 if ((vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) ==
1502 (vs
->ds
->surface
->flags
& QEMU_BIG_ENDIAN_FLAG
) &&
1503 !memcmp(&(vs
->clientds
.pf
), &(vs
->ds
->surface
->pf
), sizeof(PixelFormat
))) {
1504 vs
->write_pixels
= vnc_write_pixels_copy
;
1505 switch (vs
->ds
->surface
->pf
.bits_per_pixel
) {
1507 vs
->send_hextile_tile
= send_hextile_tile_8
;
1510 vs
->send_hextile_tile
= send_hextile_tile_16
;
1513 vs
->send_hextile_tile
= send_hextile_tile_32
;
1517 vs
->write_pixels
= vnc_write_pixels_generic
;
1518 switch (vs
->ds
->surface
->pf
.bits_per_pixel
) {
1520 vs
->send_hextile_tile
= send_hextile_tile_generic_8
;
1523 vs
->send_hextile_tile
= send_hextile_tile_generic_16
;
1526 vs
->send_hextile_tile
= send_hextile_tile_generic_32
;
1532 static void set_pixel_format(VncState
*vs
,
1533 int bits_per_pixel
, int depth
,
1534 int big_endian_flag
, int true_color_flag
,
1535 int red_max
, int green_max
, int blue_max
,
1536 int red_shift
, int green_shift
, int blue_shift
)
1538 if (!true_color_flag
) {
1539 vnc_client_error(vs
);
1543 vs
->clientds
= *(vs
->guest
.ds
);
1544 vs
->clientds
.pf
.rmax
= red_max
;
1545 count_bits(vs
->clientds
.pf
.rbits
, red_max
);
1546 vs
->clientds
.pf
.rshift
= red_shift
;
1547 vs
->clientds
.pf
.rmask
= red_max
<< red_shift
;
1548 vs
->clientds
.pf
.gmax
= green_max
;
1549 count_bits(vs
->clientds
.pf
.gbits
, green_max
);
1550 vs
->clientds
.pf
.gshift
= green_shift
;
1551 vs
->clientds
.pf
.gmask
= green_max
<< green_shift
;
1552 vs
->clientds
.pf
.bmax
= blue_max
;
1553 count_bits(vs
->clientds
.pf
.bbits
, blue_max
);
1554 vs
->clientds
.pf
.bshift
= blue_shift
;
1555 vs
->clientds
.pf
.bmask
= blue_max
<< blue_shift
;
1556 vs
->clientds
.pf
.bits_per_pixel
= bits_per_pixel
;
1557 vs
->clientds
.pf
.bytes_per_pixel
= bits_per_pixel
/ 8;
1558 vs
->clientds
.pf
.depth
= bits_per_pixel
== 32 ? 24 : bits_per_pixel
;
1559 vs
->clientds
.flags
= big_endian_flag
? QEMU_BIG_ENDIAN_FLAG
: 0x00;
1561 set_pixel_conversion(vs
);
1563 vga_hw_invalidate();
1567 static void pixel_format_message (VncState
*vs
) {
1568 char pad
[3] = { 0, 0, 0 };
1570 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.bits_per_pixel
); /* bits-per-pixel */
1571 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.depth
); /* depth */
1573 #ifdef WORDS_BIGENDIAN
1574 vnc_write_u8(vs
, 1); /* big-endian-flag */
1576 vnc_write_u8(vs
, 0); /* big-endian-flag */
1578 vnc_write_u8(vs
, 1); /* true-color-flag */
1579 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.rmax
); /* red-max */
1580 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.gmax
); /* green-max */
1581 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.bmax
); /* blue-max */
1582 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.rshift
); /* red-shift */
1583 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.gshift
); /* green-shift */
1584 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.bshift
); /* blue-shift */
1585 if (vs
->ds
->surface
->pf
.bits_per_pixel
== 32)
1586 vs
->send_hextile_tile
= send_hextile_tile_32
;
1587 else if (vs
->ds
->surface
->pf
.bits_per_pixel
== 16)
1588 vs
->send_hextile_tile
= send_hextile_tile_16
;
1589 else if (vs
->ds
->surface
->pf
.bits_per_pixel
== 8)
1590 vs
->send_hextile_tile
= send_hextile_tile_8
;
1591 vs
->clientds
= *(vs
->ds
->surface
);
1592 vs
->clientds
.flags
|= ~QEMU_ALLOCATED_FLAG
;
1593 vs
->write_pixels
= vnc_write_pixels_copy
;
1595 vnc_write(vs
, pad
, 3); /* padding */
1598 static void vnc_dpy_setdata(DisplayState
*ds
)
1600 /* We don't have to do anything */
1603 static void vnc_colordepth(VncState
*vs
)
1605 if (vnc_has_feature(vs
, VNC_FEATURE_WMVI
)) {
1606 /* Sending a WMVi message to notify the client*/
1607 vnc_write_u8(vs
, 0); /* msg id */
1608 vnc_write_u8(vs
, 0);
1609 vnc_write_u16(vs
, 1); /* number of rects */
1610 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
),
1611 ds_get_height(vs
->ds
), VNC_ENCODING_WMVi
);
1612 pixel_format_message(vs
);
1615 set_pixel_conversion(vs
);
1619 static int protocol_client_msg(VncState
*vs
, uint8_t *data
, size_t len
)
1629 set_pixel_format(vs
, read_u8(data
, 4), read_u8(data
, 5),
1630 read_u8(data
, 6), read_u8(data
, 7),
1631 read_u16(data
, 8), read_u16(data
, 10),
1632 read_u16(data
, 12), read_u8(data
, 14),
1633 read_u8(data
, 15), read_u8(data
, 16));
1640 limit
= read_u16(data
, 2);
1642 return 4 + (limit
* 4);
1644 limit
= read_u16(data
, 2);
1646 for (i
= 0; i
< limit
; i
++) {
1647 int32_t val
= read_s32(data
, 4 + (i
* 4));
1648 memcpy(data
+ 4 + (i
* 4), &val
, sizeof(val
));
1651 set_encodings(vs
, (int32_t *)(data
+ 4), limit
);
1657 framebuffer_update_request(vs
,
1658 read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4),
1659 read_u16(data
, 6), read_u16(data
, 8));
1665 key_event(vs
, read_u8(data
, 1), read_u32(data
, 4));
1671 pointer_event(vs
, read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4));
1678 uint32_t dlen
= read_u32(data
, 4);
1683 client_cut_text(vs
, read_u32(data
, 4), data
+ 8);
1689 switch (read_u8(data
, 1)) {
1694 ext_key_event(vs
, read_u16(data
, 2),
1695 read_u32(data
, 4), read_u32(data
, 8));
1701 switch (read_u16 (data
, 2)) {
1711 switch (read_u8(data
, 4)) {
1712 case 0: vs
->as
.fmt
= AUD_FMT_U8
; break;
1713 case 1: vs
->as
.fmt
= AUD_FMT_S8
; break;
1714 case 2: vs
->as
.fmt
= AUD_FMT_U16
; break;
1715 case 3: vs
->as
.fmt
= AUD_FMT_S16
; break;
1716 case 4: vs
->as
.fmt
= AUD_FMT_U32
; break;
1717 case 5: vs
->as
.fmt
= AUD_FMT_S32
; break;
1719 printf("Invalid audio format %d\n", read_u8(data
, 4));
1720 vnc_client_error(vs
);
1723 vs
->as
.nchannels
= read_u8(data
, 5);
1724 if (vs
->as
.nchannels
!= 1 && vs
->as
.nchannels
!= 2) {
1725 printf("Invalid audio channel coount %d\n",
1727 vnc_client_error(vs
);
1730 vs
->as
.freq
= read_u32(data
, 6);
1733 printf ("Invalid audio message %d\n", read_u8(data
, 4));
1734 vnc_client_error(vs
);
1740 printf("Msg: %d\n", read_u16(data
, 0));
1741 vnc_client_error(vs
);
1746 printf("Msg: %d\n", data
[0]);
1747 vnc_client_error(vs
);
1751 vnc_read_when(vs
, protocol_client_msg
, 1);
1755 static int protocol_client_init(VncState
*vs
, uint8_t *data
, size_t len
)
1760 vnc_write_u16(vs
, ds_get_width(vs
->ds
));
1761 vnc_write_u16(vs
, ds_get_height(vs
->ds
));
1763 pixel_format_message(vs
);
1766 size
= snprintf(buf
, sizeof(buf
), "QEMU (%s)", qemu_name
);
1768 size
= snprintf(buf
, sizeof(buf
), "QEMU");
1770 vnc_write_u32(vs
, size
);
1771 vnc_write(vs
, buf
, size
);
1774 vnc_read_when(vs
, protocol_client_msg
, 1);
1779 void start_client_init(VncState
*vs
)
1781 vnc_read_when(vs
, protocol_client_init
, 1);
1784 static void make_challenge(VncState
*vs
)
1788 srand(time(NULL
)+getpid()+getpid()*987654+rand());
1790 for (i
= 0 ; i
< sizeof(vs
->challenge
) ; i
++)
1791 vs
->challenge
[i
] = (int) (256.0*rand()/(RAND_MAX
+1.0));
1794 static int protocol_client_auth_vnc(VncState
*vs
, uint8_t *data
, size_t len
)
1796 unsigned char response
[VNC_AUTH_CHALLENGE_SIZE
];
1798 unsigned char key
[8];
1800 if (!vs
->vd
->password
|| !vs
->vd
->password
[0]) {
1801 VNC_DEBUG("No password configured on server");
1802 vnc_write_u32(vs
, 1); /* Reject auth */
1803 if (vs
->minor
>= 8) {
1804 static const char err
[] = "Authentication failed";
1805 vnc_write_u32(vs
, sizeof(err
));
1806 vnc_write(vs
, err
, sizeof(err
));
1809 vnc_client_error(vs
);
1813 memcpy(response
, vs
->challenge
, VNC_AUTH_CHALLENGE_SIZE
);
1815 /* Calculate the expected challenge response */
1816 pwlen
= strlen(vs
->vd
->password
);
1817 for (i
=0; i
<sizeof(key
); i
++)
1818 key
[i
] = i
<pwlen
? vs
->vd
->password
[i
] : 0;
1820 for (j
= 0; j
< VNC_AUTH_CHALLENGE_SIZE
; j
+= 8)
1821 des(response
+j
, response
+j
);
1823 /* Compare expected vs actual challenge response */
1824 if (memcmp(response
, data
, VNC_AUTH_CHALLENGE_SIZE
) != 0) {
1825 VNC_DEBUG("Client challenge reponse did not match\n");
1826 vnc_write_u32(vs
, 1); /* Reject auth */
1827 if (vs
->minor
>= 8) {
1828 static const char err
[] = "Authentication failed";
1829 vnc_write_u32(vs
, sizeof(err
));
1830 vnc_write(vs
, err
, sizeof(err
));
1833 vnc_client_error(vs
);
1835 VNC_DEBUG("Accepting VNC challenge response\n");
1836 vnc_write_u32(vs
, 0); /* Accept auth */
1839 start_client_init(vs
);
1844 void start_auth_vnc(VncState
*vs
)
1847 /* Send client a 'random' challenge */
1848 vnc_write(vs
, vs
->challenge
, sizeof(vs
->challenge
));
1851 vnc_read_when(vs
, protocol_client_auth_vnc
, sizeof(vs
->challenge
));
1855 static int protocol_client_auth(VncState
*vs
, uint8_t *data
, size_t len
)
1857 /* We only advertise 1 auth scheme at a time, so client
1858 * must pick the one we sent. Verify this */
1859 if (data
[0] != vs
->vd
->auth
) { /* Reject auth */
1860 VNC_DEBUG("Reject auth %d because it didn't match advertized\n", (int)data
[0]);
1861 vnc_write_u32(vs
, 1);
1862 if (vs
->minor
>= 8) {
1863 static const char err
[] = "Authentication failed";
1864 vnc_write_u32(vs
, sizeof(err
));
1865 vnc_write(vs
, err
, sizeof(err
));
1867 vnc_client_error(vs
);
1868 } else { /* Accept requested auth */
1869 VNC_DEBUG("Client requested auth %d\n", (int)data
[0]);
1870 switch (vs
->vd
->auth
) {
1872 VNC_DEBUG("Accept auth none\n");
1873 if (vs
->minor
>= 8) {
1874 vnc_write_u32(vs
, 0); /* Accept auth completion */
1877 start_client_init(vs
);
1881 VNC_DEBUG("Start VNC auth\n");
1885 #ifdef CONFIG_VNC_TLS
1886 case VNC_AUTH_VENCRYPT
:
1887 VNC_DEBUG("Accept VeNCrypt auth\n");;
1888 start_auth_vencrypt(vs
);
1890 #endif /* CONFIG_VNC_TLS */
1892 #ifdef CONFIG_VNC_SASL
1894 VNC_DEBUG("Accept SASL auth\n");
1895 start_auth_sasl(vs
);
1897 #endif /* CONFIG_VNC_SASL */
1899 default: /* Should not be possible, but just in case */
1900 VNC_DEBUG("Reject auth %d server code bug\n", vs
->vd
->auth
);
1901 vnc_write_u8(vs
, 1);
1902 if (vs
->minor
>= 8) {
1903 static const char err
[] = "Authentication failed";
1904 vnc_write_u32(vs
, sizeof(err
));
1905 vnc_write(vs
, err
, sizeof(err
));
1907 vnc_client_error(vs
);
1913 static int protocol_version(VncState
*vs
, uint8_t *version
, size_t len
)
1917 memcpy(local
, version
, 12);
1920 if (sscanf(local
, "RFB %03d.%03d\n", &vs
->major
, &vs
->minor
) != 2) {
1921 VNC_DEBUG("Malformed protocol version %s\n", local
);
1922 vnc_client_error(vs
);
1925 VNC_DEBUG("Client request protocol version %d.%d\n", vs
->major
, vs
->minor
);
1926 if (vs
->major
!= 3 ||
1932 VNC_DEBUG("Unsupported client version\n");
1933 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
1935 vnc_client_error(vs
);
1938 /* Some broken clients report v3.4 or v3.5, which spec requires to be treated
1939 * as equivalent to v3.3 by servers
1941 if (vs
->minor
== 4 || vs
->minor
== 5)
1944 if (vs
->minor
== 3) {
1945 if (vs
->vd
->auth
== VNC_AUTH_NONE
) {
1946 VNC_DEBUG("Tell client auth none\n");
1947 vnc_write_u32(vs
, vs
->vd
->auth
);
1949 start_client_init(vs
);
1950 } else if (vs
->vd
->auth
== VNC_AUTH_VNC
) {
1951 VNC_DEBUG("Tell client VNC auth\n");
1952 vnc_write_u32(vs
, vs
->vd
->auth
);
1956 VNC_DEBUG("Unsupported auth %d for protocol 3.3\n", vs
->vd
->auth
);
1957 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
1959 vnc_client_error(vs
);
1962 VNC_DEBUG("Telling client we support auth %d\n", vs
->vd
->auth
);
1963 vnc_write_u8(vs
, 1); /* num auth */
1964 vnc_write_u8(vs
, vs
->vd
->auth
);
1965 vnc_read_when(vs
, protocol_client_auth
, 1);
1972 static void vnc_connect(VncDisplay
*vd
, int csock
)
1974 VncState
*vs
= qemu_mallocz(sizeof(VncState
));
1977 VNC_DEBUG("New client on socket %d\n", csock
);
1979 socket_set_nonblock(vs
->csock
);
1980 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
1984 vs
->timer
= qemu_new_timer(rt_clock
, vnc_update_client
, vs
);
1988 vs
->as
.freq
= 44100;
1989 vs
->as
.nchannels
= 2;
1990 vs
->as
.fmt
= AUD_FMT_S16
;
1991 vs
->as
.endianness
= 0;
1994 vnc_write(vs
, "RFB 003.008\n", 12);
1996 vnc_read_when(vs
, protocol_version
, 12);
1997 vnc_update_client(vs
);
2000 vs
->next
= vd
->clients
;
2004 static void vnc_listen_read(void *opaque
)
2006 VncDisplay
*vs
= opaque
;
2007 struct sockaddr_in addr
;
2008 socklen_t addrlen
= sizeof(addr
);
2013 int csock
= accept(vs
->lsock
, (struct sockaddr
*)&addr
, &addrlen
);
2015 vnc_connect(vs
, csock
);
2019 void vnc_display_init(DisplayState
*ds
)
2023 vs
= qemu_mallocz(sizeof(VncState
));
2024 dcl
= qemu_mallocz(sizeof(DisplayChangeListener
));
2034 if (keyboard_layout
)
2035 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, keyboard_layout
);
2037 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, "en-us");
2039 if (!vs
->kbd_layout
)
2042 dcl
->dpy_copy
= vnc_dpy_copy
;
2043 dcl
->dpy_update
= vnc_dpy_update
;
2044 dcl
->dpy_resize
= vnc_dpy_resize
;
2045 dcl
->dpy_setdata
= vnc_dpy_setdata
;
2046 register_displaychangelistener(ds
, dcl
);
2050 void vnc_display_close(DisplayState
*ds
)
2052 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2057 qemu_free(vs
->display
);
2060 if (vs
->lsock
!= -1) {
2061 qemu_set_fd_handler2(vs
->lsock
, NULL
, NULL
, NULL
, NULL
);
2065 vs
->auth
= VNC_AUTH_INVALID
;
2066 #ifdef CONFIG_VNC_TLS
2067 vs
->subauth
= VNC_AUTH_INVALID
;
2068 vs
->tls
.x509verify
= 0;
2072 int vnc_display_password(DisplayState
*ds
, const char *password
)
2074 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2077 qemu_free(vs
->password
);
2078 vs
->password
= NULL
;
2080 if (password
&& password
[0]) {
2081 if (!(vs
->password
= qemu_strdup(password
)))
2088 int vnc_display_open(DisplayState
*ds
, const char *display
)
2090 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2091 const char *options
;
2095 #ifdef CONFIG_VNC_TLS
2096 int tls
= 0, x509
= 0;
2098 #ifdef CONFIG_VNC_SASL
2106 vnc_display_close(ds
);
2107 if (strcmp(display
, "none") == 0)
2110 if (!(vs
->display
= strdup(display
)))
2114 while ((options
= strchr(options
, ','))) {
2116 if (strncmp(options
, "password", 8) == 0) {
2117 password
= 1; /* Require password auth */
2118 } else if (strncmp(options
, "reverse", 7) == 0) {
2120 } else if (strncmp(options
, "to=", 3) == 0) {
2121 to_port
= atoi(options
+3) + 5900;
2122 #ifdef CONFIG_VNC_SASL
2123 } else if (strncmp(options
, "sasl", 4) == 0) {
2124 sasl
= 1; /* Require SASL auth */
2126 #ifdef CONFIG_VNC_TLS
2127 } else if (strncmp(options
, "tls", 3) == 0) {
2128 tls
= 1; /* Require TLS */
2129 } else if (strncmp(options
, "x509", 4) == 0) {
2131 x509
= 1; /* Require x509 certificates */
2132 if (strncmp(options
, "x509verify", 10) == 0)
2133 vs
->tls
.x509verify
= 1; /* ...and verify client certs */
2135 /* Now check for 'x509=/some/path' postfix
2136 * and use that to setup x509 certificate/key paths */
2137 start
= strchr(options
, '=');
2138 end
= strchr(options
, ',');
2139 if (start
&& (!end
|| (start
< end
))) {
2140 int len
= end
? end
-(start
+1) : strlen(start
+1);
2141 char *path
= qemu_strndup(start
+ 1, len
);
2143 VNC_DEBUG("Trying certificate path '%s'\n", path
);
2144 if (vnc_tls_set_x509_creds_dir(vs
, path
) < 0) {
2145 fprintf(stderr
, "Failed to find x509 certificates/keys in %s\n", path
);
2147 qemu_free(vs
->display
);
2153 fprintf(stderr
, "No certificate path provided\n");
2154 qemu_free(vs
->display
);
2159 } else if (strncmp(options
, "acl", 3) == 0) {
2164 #ifdef CONFIG_VNC_TLS
2165 if (acl
&& x509
&& vs
->tls
.x509verify
) {
2166 if (!(vs
->tls
.acl
= qemu_acl_init("vnc.x509dname"))) {
2167 fprintf(stderr
, "Failed to create x509 dname ACL\n");
2172 #ifdef CONFIG_VNC_SASL
2174 if (!(vs
->sasl
.acl
= qemu_acl_init("vnc.username"))) {
2175 fprintf(stderr
, "Failed to create username ACL\n");
2182 * Combinations we support here:
2184 * - no-auth (clear text, no auth)
2185 * - password (clear text, weak auth)
2186 * - sasl (encrypt, good auth *IF* using Kerberos via GSSAPI)
2187 * - tls (encrypt, weak anonymous creds, no auth)
2188 * - tls + password (encrypt, weak anonymous creds, weak auth)
2189 * - tls + sasl (encrypt, weak anonymous creds, good auth)
2190 * - tls + x509 (encrypt, good x509 creds, no auth)
2191 * - tls + x509 + password (encrypt, good x509 creds, weak auth)
2192 * - tls + x509 + sasl (encrypt, good x509 creds, good auth)
2194 * NB1. TLS is a stackable auth scheme.
2195 * NB2. the x509 schemes have option to validate a client cert dname
2198 #ifdef CONFIG_VNC_TLS
2200 vs
->auth
= VNC_AUTH_VENCRYPT
;
2202 VNC_DEBUG("Initializing VNC server with x509 password auth\n");
2203 vs
->subauth
= VNC_AUTH_VENCRYPT_X509VNC
;
2205 VNC_DEBUG("Initializing VNC server with TLS password auth\n");
2206 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSVNC
;
2209 #endif /* CONFIG_VNC_TLS */
2210 VNC_DEBUG("Initializing VNC server with password auth\n");
2211 vs
->auth
= VNC_AUTH_VNC
;
2212 #ifdef CONFIG_VNC_TLS
2213 vs
->subauth
= VNC_AUTH_INVALID
;
2215 #endif /* CONFIG_VNC_TLS */
2216 #ifdef CONFIG_VNC_SASL
2218 #ifdef CONFIG_VNC_TLS
2220 vs
->auth
= VNC_AUTH_VENCRYPT
;
2222 VNC_DEBUG("Initializing VNC server with x509 SASL auth\n");
2223 vs
->subauth
= VNC_AUTH_VENCRYPT_X509SASL
;
2225 VNC_DEBUG("Initializing VNC server with TLS SASL auth\n");
2226 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSSASL
;
2229 #endif /* CONFIG_VNC_TLS */
2230 VNC_DEBUG("Initializing VNC server with SASL auth\n");
2231 vs
->auth
= VNC_AUTH_SASL
;
2232 #ifdef CONFIG_VNC_TLS
2233 vs
->subauth
= VNC_AUTH_INVALID
;
2235 #endif /* CONFIG_VNC_TLS */
2236 #endif /* CONFIG_VNC_SASL */
2238 #ifdef CONFIG_VNC_TLS
2240 vs
->auth
= VNC_AUTH_VENCRYPT
;
2242 VNC_DEBUG("Initializing VNC server with x509 no auth\n");
2243 vs
->subauth
= VNC_AUTH_VENCRYPT_X509NONE
;
2245 VNC_DEBUG("Initializing VNC server with TLS no auth\n");
2246 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSNONE
;
2250 VNC_DEBUG("Initializing VNC server with no auth\n");
2251 vs
->auth
= VNC_AUTH_NONE
;
2252 #ifdef CONFIG_VNC_TLS
2253 vs
->subauth
= VNC_AUTH_INVALID
;
2258 #ifdef CONFIG_VNC_SASL
2259 if ((saslErr
= sasl_server_init(NULL
, "qemu")) != SASL_OK
) {
2260 fprintf(stderr
, "Failed to initialize SASL auth %s",
2261 sasl_errstring(saslErr
, NULL
, NULL
));
2269 /* connect to viewer */
2270 if (strncmp(display
, "unix:", 5) == 0)
2271 vs
->lsock
= unix_connect(display
+5);
2273 vs
->lsock
= inet_connect(display
, SOCK_STREAM
);
2274 if (-1 == vs
->lsock
) {
2279 int csock
= vs
->lsock
;
2281 vnc_connect(vs
, csock
);
2286 /* listen for connects */
2288 dpy
= qemu_malloc(256);
2289 if (strncmp(display
, "unix:", 5) == 0) {
2290 pstrcpy(dpy
, 256, "unix:");
2291 vs
->lsock
= unix_listen(display
+5, dpy
+5, 256-5);
2293 vs
->lsock
= inet_listen(display
, dpy
, 256, SOCK_STREAM
, 5900);
2295 if (-1 == vs
->lsock
) {
2303 return qemu_set_fd_handler2(vs
->lsock
, NULL
, vnc_listen_read
, NULL
, vs
);