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 vs
->force_update
= 1;
661 vnc_update_client(vs
);
663 vnc_write_u8(vs
, 0); /* msg id */
665 vnc_write_u16(vs
, 1); /* number of rects */
666 vnc_framebuffer_update(vs
, dst_x
, dst_y
, w
, h
, VNC_ENCODING_COPYRECT
);
667 vnc_write_u16(vs
, src_x
);
668 vnc_write_u16(vs
, src_y
);
672 static void vnc_dpy_copy(DisplayState
*ds
, int src_x
, int src_y
, int dst_x
, int dst_y
, int w
, int h
)
674 VncDisplay
*vd
= ds
->opaque
;
675 VncState
*vs
= vd
->clients
;
677 if (vnc_has_feature(vs
, VNC_FEATURE_COPYRECT
))
678 vnc_copy(vs
, src_x
, src_y
, dst_x
, dst_y
, w
, h
);
680 vnc_update(vs
, dst_x
, dst_y
, w
, h
);
685 static int find_and_clear_dirty_height(struct VncSurface
*s
,
686 int y
, int last_x
, int x
)
690 for (h
= 1; h
< (s
->ds
->height
- y
) && h
< 1; h
++) {
692 if (!vnc_get_bit(s
->dirty
[y
+ h
], last_x
))
694 for (tmp_x
= last_x
; tmp_x
< x
; tmp_x
++)
695 vnc_clear_bit(s
->dirty
[y
+ h
], tmp_x
);
701 static void vnc_update_client(void *opaque
)
703 VncState
*vs
= opaque
;
704 if (vs
->need_update
&& vs
->csock
!= -1) {
709 uint32_t width_mask
[VNC_DIRTY_WORDS
];
714 if (vs
->output
.offset
&& !vs
->audio_cap
&& !vs
->force_update
) {
715 /* kernel send buffers are full -> drop frames to throttle */
716 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
723 * Walk through the guest dirty map.
724 * Check and copy modified bits from guest to server surface.
725 * Update server dirty map.
727 vnc_set_bits(width_mask
, (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
728 cmp_bytes
= 16 * ds_get_bytes_per_pixel(vs
->ds
);
729 guest_row
= vs
->guest
.ds
->data
;
730 server_row
= vs
->server
.ds
->data
;
731 for (y
= 0; y
< vs
->guest
.ds
->height
; y
++) {
732 if (vnc_and_bits(vs
->guest
.dirty
[y
], width_mask
, VNC_DIRTY_WORDS
)) {
737 guest_ptr
= guest_row
;
738 server_ptr
= server_row
;
740 for (x
= 0; x
< vs
->guest
.ds
->width
;
741 x
+= 16, guest_ptr
+= cmp_bytes
, server_ptr
+= cmp_bytes
) {
742 if (!vnc_get_bit(vs
->guest
.dirty
[y
], (x
/ 16)))
744 vnc_clear_bit(vs
->guest
.dirty
[y
], (x
/ 16));
745 if (memcmp(server_ptr
, guest_ptr
, cmp_bytes
) == 0)
747 memcpy(server_ptr
, guest_ptr
, cmp_bytes
);
748 vnc_set_bit(vs
->server
.dirty
[y
], (x
/ 16));
752 guest_row
+= ds_get_linesize(vs
->ds
);
753 server_row
+= ds_get_linesize(vs
->ds
);
756 if (!has_dirty
&& !vs
->audio_cap
&& !vs
->force_update
) {
757 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
762 * Send screen updates to the vnc client using the server
763 * surface and server dirty map. guest surface updates
764 * happening in parallel don't disturb us, the next pass will
765 * send them to the client.
768 vnc_write_u8(vs
, 0); /* msg id */
770 saved_offset
= vs
->output
.offset
;
771 vnc_write_u16(vs
, 0);
773 for (y
= 0; y
< vs
->server
.ds
->height
; y
++) {
776 for (x
= 0; x
< vs
->server
.ds
->width
/ 16; x
++) {
777 if (vnc_get_bit(vs
->server
.dirty
[y
], x
)) {
781 vnc_clear_bit(vs
->server
.dirty
[y
], x
);
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
);
792 int h
= find_and_clear_dirty_height(&vs
->server
, y
, last_x
, x
);
793 send_framebuffer_update(vs
, last_x
* 16, y
, (x
- last_x
) * 16, h
);
797 vs
->output
.buffer
[saved_offset
] = (n_rectangles
>> 8) & 0xFF;
798 vs
->output
.buffer
[saved_offset
+ 1] = n_rectangles
& 0xFF;
800 vs
->force_update
= 0;
804 if (vs
->csock
!= -1) {
805 qemu_mod_timer(vs
->timer
, qemu_get_clock(rt_clock
) + VNC_REFRESH_INTERVAL
);
811 static void audio_capture_notify(void *opaque
, audcnotification_e cmd
)
813 VncState
*vs
= opaque
;
816 case AUD_CNOTIFY_DISABLE
:
817 vnc_write_u8(vs
, 255);
819 vnc_write_u16(vs
, 0);
823 case AUD_CNOTIFY_ENABLE
:
824 vnc_write_u8(vs
, 255);
826 vnc_write_u16(vs
, 1);
832 static void audio_capture_destroy(void *opaque
)
836 static void audio_capture(void *opaque
, void *buf
, int size
)
838 VncState
*vs
= opaque
;
840 vnc_write_u8(vs
, 255);
842 vnc_write_u16(vs
, 2);
843 vnc_write_u32(vs
, size
);
844 vnc_write(vs
, buf
, size
);
848 static void audio_add(VncState
*vs
)
850 Monitor
*mon
= cur_mon
;
851 struct audio_capture_ops ops
;
854 monitor_printf(mon
, "audio already running\n");
858 ops
.notify
= audio_capture_notify
;
859 ops
.destroy
= audio_capture_destroy
;
860 ops
.capture
= audio_capture
;
862 vs
->audio_cap
= AUD_add_capture(NULL
, &vs
->as
, &ops
, vs
);
863 if (!vs
->audio_cap
) {
864 monitor_printf(mon
, "Failed to add audio capture\n");
868 static void audio_del(VncState
*vs
)
871 AUD_del_capture(vs
->audio_cap
, vs
);
872 vs
->audio_cap
= NULL
;
877 int vnc_client_io_error(VncState
*vs
, int ret
, int last_errno
)
879 if (ret
== 0 || ret
== -1) {
881 switch (last_errno
) {
893 VNC_DEBUG("Closing down client sock %d %d\n", ret
, ret
< 0 ? last_errno
: 0);
894 qemu_set_fd_handler2(vs
->csock
, NULL
, NULL
, NULL
, NULL
);
895 closesocket(vs
->csock
);
896 qemu_del_timer(vs
->timer
);
897 qemu_free_timer(vs
->timer
);
898 if (vs
->input
.buffer
) qemu_free(vs
->input
.buffer
);
899 if (vs
->output
.buffer
) qemu_free(vs
->output
.buffer
);
900 #ifdef CONFIG_VNC_TLS
901 vnc_tls_client_cleanup(vs
);
902 #endif /* CONFIG_VNC_TLS */
903 #ifdef CONFIG_VNC_SASL
904 vnc_sasl_client_cleanup(vs
);
905 #endif /* CONFIG_VNC_SASL */
908 VncState
*p
, *parent
= NULL
;
909 for (p
= vs
->vd
->clients
; p
!= NULL
; p
= p
->next
) {
912 parent
->next
= p
->next
;
914 vs
->vd
->clients
= p
->next
;
919 if (!vs
->vd
->clients
)
922 default_allocator
.free_displaysurface(vs
->server
.ds
);
923 qemu_free(vs
->guest
.ds
);
932 void vnc_client_error(VncState
*vs
)
934 vnc_client_io_error(vs
, -1, EINVAL
);
939 * Called to write a chunk of data to the client socket. The data may
940 * be the raw data, or may have already been encoded by SASL.
941 * The data will be written either straight onto the socket, or
942 * written via the GNUTLS wrappers, if TLS/SSL encryption is enabled
944 * NB, it is theoretically possible to have 2 layers of encryption,
945 * both SASL, and this TLS layer. It is highly unlikely in practice
946 * though, since SASL encryption will typically be a no-op if TLS
949 * Returns the number of bytes written, which may be less than
950 * the requested 'datalen' if the socket would block. Returns
951 * -1 on error, and disconnects the client socket.
953 long vnc_client_write_buf(VncState
*vs
, const uint8_t *data
, size_t datalen
)
956 #ifdef CONFIG_VNC_TLS
957 if (vs
->tls
.session
) {
958 ret
= gnutls_write(vs
->tls
.session
, data
, datalen
);
960 if (ret
== GNUTLS_E_AGAIN
)
967 #endif /* CONFIG_VNC_TLS */
968 ret
= send(vs
->csock
, data
, datalen
, 0);
969 VNC_DEBUG("Wrote wire %p %zd -> %ld\n", data
, datalen
, ret
);
970 return vnc_client_io_error(vs
, ret
, socket_error());
975 * Called to write buffered data to the client socket, when not
976 * using any SASL SSF encryption layers. Will write as much data
977 * as possible without blocking. If all buffered data is written,
978 * will switch the FD poll() handler back to read monitoring.
980 * Returns the number of bytes written, which may be less than
981 * the buffered output data if the socket would block. Returns
982 * -1 on error, and disconnects the client socket.
984 static long vnc_client_write_plain(VncState
*vs
)
988 #ifdef CONFIG_VNC_SASL
989 VNC_DEBUG("Write Plain: Pending output %p size %zd offset %zd. Wait SSF %d\n",
990 vs
->output
.buffer
, vs
->output
.capacity
, vs
->output
.offset
,
991 vs
->sasl
.waitWriteSSF
);
995 vs
->sasl
.waitWriteSSF
) {
996 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->sasl
.waitWriteSSF
);
998 vs
->sasl
.waitWriteSSF
-= ret
;
1000 #endif /* CONFIG_VNC_SASL */
1001 ret
= vnc_client_write_buf(vs
, vs
->output
.buffer
, vs
->output
.offset
);
1005 memmove(vs
->output
.buffer
, vs
->output
.buffer
+ ret
, (vs
->output
.offset
- ret
));
1006 vs
->output
.offset
-= ret
;
1008 if (vs
->output
.offset
== 0) {
1009 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
1017 * First function called whenever there is data to be written to
1018 * the client socket. Will delegate actual work according to whether
1019 * SASL SSF layers are enabled (thus requiring encryption calls)
1021 void vnc_client_write(void *opaque
)
1024 VncState
*vs
= opaque
;
1026 #ifdef CONFIG_VNC_SASL
1027 if (vs
->sasl
.conn
&&
1029 !vs
->sasl
.waitWriteSSF
)
1030 ret
= vnc_client_write_sasl(vs
);
1032 #endif /* CONFIG_VNC_SASL */
1033 ret
= vnc_client_write_plain(vs
);
1036 void vnc_read_when(VncState
*vs
, VncReadEvent
*func
, size_t expecting
)
1038 vs
->read_handler
= func
;
1039 vs
->read_handler_expect
= expecting
;
1044 * Called to read a chunk of data from the client socket. The data may
1045 * be the raw data, or may need to be further decoded by SASL.
1046 * The data will be read either straight from to the socket, or
1047 * read via the GNUTLS wrappers, if TLS/SSL encryption is enabled
1049 * NB, it is theoretically possible to have 2 layers of encryption,
1050 * both SASL, and this TLS layer. It is highly unlikely in practice
1051 * though, since SASL encryption will typically be a no-op if TLS
1054 * Returns the number of bytes read, which may be less than
1055 * the requested 'datalen' if the socket would block. Returns
1056 * -1 on error, and disconnects the client socket.
1058 long vnc_client_read_buf(VncState
*vs
, uint8_t *data
, size_t datalen
)
1061 #ifdef CONFIG_VNC_TLS
1062 if (vs
->tls
.session
) {
1063 ret
= gnutls_read(vs
->tls
.session
, data
, datalen
);
1065 if (ret
== GNUTLS_E_AGAIN
)
1072 #endif /* CONFIG_VNC_TLS */
1073 ret
= recv(vs
->csock
, data
, datalen
, 0);
1074 VNC_DEBUG("Read wire %p %zd -> %ld\n", data
, datalen
, ret
);
1075 return vnc_client_io_error(vs
, ret
, socket_error());
1080 * Called to read data from the client socket to the input buffer,
1081 * when not using any SASL SSF encryption layers. Will read as much
1082 * data as possible without blocking.
1084 * Returns the number of bytes read. Returns -1 on error, and
1085 * disconnects the client socket.
1087 static long vnc_client_read_plain(VncState
*vs
)
1090 VNC_DEBUG("Read plain %p size %zd offset %zd\n",
1091 vs
->input
.buffer
, vs
->input
.capacity
, vs
->input
.offset
);
1092 buffer_reserve(&vs
->input
, 4096);
1093 ret
= vnc_client_read_buf(vs
, buffer_end(&vs
->input
), 4096);
1096 vs
->input
.offset
+= ret
;
1102 * First function called whenever there is more data to be read from
1103 * the client socket. Will delegate actual work according to whether
1104 * SASL SSF layers are enabled (thus requiring decryption calls)
1106 void vnc_client_read(void *opaque
)
1108 VncState
*vs
= opaque
;
1111 #ifdef CONFIG_VNC_SASL
1112 if (vs
->sasl
.conn
&& vs
->sasl
.runSSF
)
1113 ret
= vnc_client_read_sasl(vs
);
1115 #endif /* CONFIG_VNC_SASL */
1116 ret
= vnc_client_read_plain(vs
);
1120 while (vs
->read_handler
&& vs
->input
.offset
>= vs
->read_handler_expect
) {
1121 size_t len
= vs
->read_handler_expect
;
1124 ret
= vs
->read_handler(vs
, vs
->input
.buffer
, len
);
1125 if (vs
->csock
== -1)
1129 memmove(vs
->input
.buffer
, vs
->input
.buffer
+ len
, (vs
->input
.offset
- len
));
1130 vs
->input
.offset
-= len
;
1132 vs
->read_handler_expect
= ret
;
1137 void vnc_write(VncState
*vs
, const void *data
, size_t len
)
1139 buffer_reserve(&vs
->output
, len
);
1141 if (buffer_empty(&vs
->output
)) {
1142 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, vnc_client_write
, vs
);
1145 buffer_append(&vs
->output
, data
, len
);
1148 void vnc_write_s32(VncState
*vs
, int32_t value
)
1150 vnc_write_u32(vs
, *(uint32_t *)&value
);
1153 void vnc_write_u32(VncState
*vs
, uint32_t value
)
1157 buf
[0] = (value
>> 24) & 0xFF;
1158 buf
[1] = (value
>> 16) & 0xFF;
1159 buf
[2] = (value
>> 8) & 0xFF;
1160 buf
[3] = value
& 0xFF;
1162 vnc_write(vs
, buf
, 4);
1165 void vnc_write_u16(VncState
*vs
, uint16_t value
)
1169 buf
[0] = (value
>> 8) & 0xFF;
1170 buf
[1] = value
& 0xFF;
1172 vnc_write(vs
, buf
, 2);
1175 void vnc_write_u8(VncState
*vs
, uint8_t value
)
1177 vnc_write(vs
, (char *)&value
, 1);
1180 void vnc_flush(VncState
*vs
)
1182 if (vs
->output
.offset
)
1183 vnc_client_write(vs
);
1186 uint8_t read_u8(uint8_t *data
, size_t offset
)
1188 return data
[offset
];
1191 uint16_t read_u16(uint8_t *data
, size_t offset
)
1193 return ((data
[offset
] & 0xFF) << 8) | (data
[offset
+ 1] & 0xFF);
1196 int32_t read_s32(uint8_t *data
, size_t offset
)
1198 return (int32_t)((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1199 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1202 uint32_t read_u32(uint8_t *data
, size_t offset
)
1204 return ((data
[offset
] << 24) | (data
[offset
+ 1] << 16) |
1205 (data
[offset
+ 2] << 8) | data
[offset
+ 3]);
1208 static void client_cut_text(VncState
*vs
, size_t len
, uint8_t *text
)
1212 static void check_pointer_type_change(VncState
*vs
, int absolute
)
1214 if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
) && vs
->absolute
!= absolute
) {
1215 vnc_write_u8(vs
, 0);
1216 vnc_write_u8(vs
, 0);
1217 vnc_write_u16(vs
, 1);
1218 vnc_framebuffer_update(vs
, absolute
, 0,
1219 ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1220 VNC_ENCODING_POINTER_TYPE_CHANGE
);
1223 vs
->absolute
= absolute
;
1226 static void pointer_event(VncState
*vs
, int button_mask
, int x
, int y
)
1231 if (button_mask
& 0x01)
1232 buttons
|= MOUSE_EVENT_LBUTTON
;
1233 if (button_mask
& 0x02)
1234 buttons
|= MOUSE_EVENT_MBUTTON
;
1235 if (button_mask
& 0x04)
1236 buttons
|= MOUSE_EVENT_RBUTTON
;
1237 if (button_mask
& 0x08)
1239 if (button_mask
& 0x10)
1243 kbd_mouse_event(x
* 0x7FFF / (ds_get_width(vs
->ds
) - 1),
1244 y
* 0x7FFF / (ds_get_height(vs
->ds
) - 1),
1246 } else if (vnc_has_feature(vs
, VNC_FEATURE_POINTER_TYPE_CHANGE
)) {
1250 kbd_mouse_event(x
, y
, dz
, buttons
);
1252 if (vs
->last_x
!= -1)
1253 kbd_mouse_event(x
- vs
->last_x
,
1260 check_pointer_type_change(vs
, kbd_mouse_is_absolute());
1263 static void reset_keys(VncState
*vs
)
1266 for(i
= 0; i
< 256; i
++) {
1267 if (vs
->modifiers_state
[i
]) {
1269 kbd_put_keycode(0xe0);
1270 kbd_put_keycode(i
| 0x80);
1271 vs
->modifiers_state
[i
] = 0;
1276 static void press_key(VncState
*vs
, int keysym
)
1278 kbd_put_keycode(keysym2scancode(vs
->vd
->kbd_layout
, keysym
) & 0x7f);
1279 kbd_put_keycode(keysym2scancode(vs
->vd
->kbd_layout
, keysym
) | 0x80);
1282 static void do_key_event(VncState
*vs
, int down
, int keycode
, int sym
)
1284 /* QEMU console switch */
1286 case 0x2a: /* Left Shift */
1287 case 0x36: /* Right Shift */
1288 case 0x1d: /* Left CTRL */
1289 case 0x9d: /* Right CTRL */
1290 case 0x38: /* Left ALT */
1291 case 0xb8: /* Right ALT */
1293 vs
->modifiers_state
[keycode
] = 1;
1295 vs
->modifiers_state
[keycode
] = 0;
1297 case 0x02 ... 0x0a: /* '1' to '9' keys */
1298 if (down
&& vs
->modifiers_state
[0x1d] && vs
->modifiers_state
[0x38]) {
1299 /* Reset the modifiers sent to the current console */
1301 console_select(keycode
- 0x02);
1305 case 0x3a: /* CapsLock */
1306 case 0x45: /* NumLock */
1308 vs
->modifiers_state
[keycode
] ^= 1;
1312 if (keycode_is_keypad(vs
->vd
->kbd_layout
, keycode
)) {
1313 /* If the numlock state needs to change then simulate an additional
1314 keypress before sending this one. This will happen if the user
1315 toggles numlock away from the VNC window.
1317 if (keysym_is_numlock(vs
->vd
->kbd_layout
, sym
& 0xFFFF)) {
1318 if (!vs
->modifiers_state
[0x45]) {
1319 vs
->modifiers_state
[0x45] = 1;
1320 press_key(vs
, 0xff7f);
1323 if (vs
->modifiers_state
[0x45]) {
1324 vs
->modifiers_state
[0x45] = 0;
1325 press_key(vs
, 0xff7f);
1330 if (is_graphic_console()) {
1332 kbd_put_keycode(0xe0);
1334 kbd_put_keycode(keycode
& 0x7f);
1336 kbd_put_keycode(keycode
| 0x80);
1338 /* QEMU console emulation */
1341 case 0x2a: /* Left Shift */
1342 case 0x36: /* Right Shift */
1343 case 0x1d: /* Left CTRL */
1344 case 0x9d: /* Right CTRL */
1345 case 0x38: /* Left ALT */
1346 case 0xb8: /* Right ALT */
1350 kbd_put_keysym(QEMU_KEY_UP
);
1354 kbd_put_keysym(QEMU_KEY_DOWN
);
1358 kbd_put_keysym(QEMU_KEY_LEFT
);
1362 kbd_put_keysym(QEMU_KEY_RIGHT
);
1366 kbd_put_keysym(QEMU_KEY_DELETE
);
1370 kbd_put_keysym(QEMU_KEY_HOME
);
1374 kbd_put_keysym(QEMU_KEY_END
);
1378 kbd_put_keysym(QEMU_KEY_PAGEUP
);
1382 kbd_put_keysym(QEMU_KEY_PAGEDOWN
);
1385 kbd_put_keysym(sym
);
1392 static void key_event(VncState
*vs
, int down
, uint32_t sym
)
1396 if (sym
>= 'A' && sym
<= 'Z' && is_graphic_console())
1397 sym
= sym
- 'A' + 'a';
1399 keycode
= keysym2scancode(vs
->vd
->kbd_layout
, sym
& 0xFFFF);
1400 do_key_event(vs
, down
, keycode
, sym
);
1403 static void ext_key_event(VncState
*vs
, int down
,
1404 uint32_t sym
, uint16_t keycode
)
1406 /* if the user specifies a keyboard layout, always use it */
1407 if (keyboard_layout
)
1408 key_event(vs
, down
, sym
);
1410 do_key_event(vs
, down
, keycode
, sym
);
1413 static void framebuffer_update_request(VncState
*vs
, int incremental
,
1414 int x_position
, int y_position
,
1417 if (x_position
> ds_get_width(vs
->ds
))
1418 x_position
= ds_get_width(vs
->ds
);
1419 if (y_position
> ds_get_height(vs
->ds
))
1420 y_position
= ds_get_height(vs
->ds
);
1421 if (x_position
+ w
>= ds_get_width(vs
->ds
))
1422 w
= ds_get_width(vs
->ds
) - x_position
;
1423 if (y_position
+ h
>= ds_get_height(vs
->ds
))
1424 h
= ds_get_height(vs
->ds
) - y_position
;
1427 vs
->need_update
= 1;
1428 vs
->force_update
= 1;
1430 for (i
= 0; i
< h
; i
++) {
1431 vnc_set_bits(vs
->guest
.dirty
[y_position
+ i
],
1432 (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
1433 vnc_set_bits(vs
->server
.dirty
[y_position
+ i
],
1434 (ds_get_width(vs
->ds
) / 16), VNC_DIRTY_WORDS
);
1439 static void send_ext_key_event_ack(VncState
*vs
)
1441 vnc_write_u8(vs
, 0);
1442 vnc_write_u8(vs
, 0);
1443 vnc_write_u16(vs
, 1);
1444 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1445 VNC_ENCODING_EXT_KEY_EVENT
);
1449 static void send_ext_audio_ack(VncState
*vs
)
1451 vnc_write_u8(vs
, 0);
1452 vnc_write_u8(vs
, 0);
1453 vnc_write_u16(vs
, 1);
1454 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
), ds_get_height(vs
->ds
),
1455 VNC_ENCODING_AUDIO
);
1459 static void set_encodings(VncState
*vs
, int32_t *encodings
, size_t n_encodings
)
1462 unsigned int enc
= 0;
1466 vs
->vnc_encoding
= 0;
1467 vs
->tight_compression
= 9;
1468 vs
->tight_quality
= 9;
1471 for (i
= n_encodings
- 1; i
>= 0; i
--) {
1474 case VNC_ENCODING_RAW
:
1475 vs
->vnc_encoding
= enc
;
1477 case VNC_ENCODING_COPYRECT
:
1478 vs
->features
|= VNC_FEATURE_COPYRECT_MASK
;
1480 case VNC_ENCODING_HEXTILE
:
1481 vs
->features
|= VNC_FEATURE_HEXTILE_MASK
;
1482 vs
->vnc_encoding
= enc
;
1484 case VNC_ENCODING_ZLIB
:
1485 vs
->features
|= VNC_FEATURE_ZLIB_MASK
;
1486 vs
->vnc_encoding
= enc
;
1488 case VNC_ENCODING_DESKTOPRESIZE
:
1489 vs
->features
|= VNC_FEATURE_RESIZE_MASK
;
1491 case VNC_ENCODING_POINTER_TYPE_CHANGE
:
1492 vs
->features
|= VNC_FEATURE_POINTER_TYPE_CHANGE_MASK
;
1494 case VNC_ENCODING_EXT_KEY_EVENT
:
1495 send_ext_key_event_ack(vs
);
1497 case VNC_ENCODING_AUDIO
:
1498 send_ext_audio_ack(vs
);
1500 case VNC_ENCODING_WMVi
:
1501 vs
->features
|= VNC_FEATURE_WMVI_MASK
;
1503 case VNC_ENCODING_COMPRESSLEVEL0
... VNC_ENCODING_COMPRESSLEVEL0
+ 9:
1504 vs
->tight_compression
= (enc
& 0x0F);
1506 case VNC_ENCODING_QUALITYLEVEL0
... VNC_ENCODING_QUALITYLEVEL0
+ 9:
1507 vs
->tight_quality
= (enc
& 0x0F);
1510 VNC_DEBUG("Unknown encoding: %d (0x%.8x): %d\n", i
, enc
, enc
);
1515 check_pointer_type_change(vs
, kbd_mouse_is_absolute());
1518 static void set_pixel_conversion(VncState
*vs
)
1520 if ((vs
->clientds
.flags
& QEMU_BIG_ENDIAN_FLAG
) ==
1521 (vs
->ds
->surface
->flags
& QEMU_BIG_ENDIAN_FLAG
) &&
1522 !memcmp(&(vs
->clientds
.pf
), &(vs
->ds
->surface
->pf
), sizeof(PixelFormat
))) {
1523 vs
->write_pixels
= vnc_write_pixels_copy
;
1524 switch (vs
->ds
->surface
->pf
.bits_per_pixel
) {
1526 vs
->send_hextile_tile
= send_hextile_tile_8
;
1529 vs
->send_hextile_tile
= send_hextile_tile_16
;
1532 vs
->send_hextile_tile
= send_hextile_tile_32
;
1536 vs
->write_pixels
= vnc_write_pixels_generic
;
1537 switch (vs
->ds
->surface
->pf
.bits_per_pixel
) {
1539 vs
->send_hextile_tile
= send_hextile_tile_generic_8
;
1542 vs
->send_hextile_tile
= send_hextile_tile_generic_16
;
1545 vs
->send_hextile_tile
= send_hextile_tile_generic_32
;
1551 static void set_pixel_format(VncState
*vs
,
1552 int bits_per_pixel
, int depth
,
1553 int big_endian_flag
, int true_color_flag
,
1554 int red_max
, int green_max
, int blue_max
,
1555 int red_shift
, int green_shift
, int blue_shift
)
1557 if (!true_color_flag
) {
1558 vnc_client_error(vs
);
1562 vs
->clientds
= *(vs
->guest
.ds
);
1563 vs
->clientds
.pf
.rmax
= red_max
;
1564 count_bits(vs
->clientds
.pf
.rbits
, red_max
);
1565 vs
->clientds
.pf
.rshift
= red_shift
;
1566 vs
->clientds
.pf
.rmask
= red_max
<< red_shift
;
1567 vs
->clientds
.pf
.gmax
= green_max
;
1568 count_bits(vs
->clientds
.pf
.gbits
, green_max
);
1569 vs
->clientds
.pf
.gshift
= green_shift
;
1570 vs
->clientds
.pf
.gmask
= green_max
<< green_shift
;
1571 vs
->clientds
.pf
.bmax
= blue_max
;
1572 count_bits(vs
->clientds
.pf
.bbits
, blue_max
);
1573 vs
->clientds
.pf
.bshift
= blue_shift
;
1574 vs
->clientds
.pf
.bmask
= blue_max
<< blue_shift
;
1575 vs
->clientds
.pf
.bits_per_pixel
= bits_per_pixel
;
1576 vs
->clientds
.pf
.bytes_per_pixel
= bits_per_pixel
/ 8;
1577 vs
->clientds
.pf
.depth
= bits_per_pixel
== 32 ? 24 : bits_per_pixel
;
1578 vs
->clientds
.flags
= big_endian_flag
? QEMU_BIG_ENDIAN_FLAG
: 0x00;
1580 set_pixel_conversion(vs
);
1582 vga_hw_invalidate();
1586 static void pixel_format_message (VncState
*vs
) {
1587 char pad
[3] = { 0, 0, 0 };
1589 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.bits_per_pixel
); /* bits-per-pixel */
1590 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.depth
); /* depth */
1592 #ifdef WORDS_BIGENDIAN
1593 vnc_write_u8(vs
, 1); /* big-endian-flag */
1595 vnc_write_u8(vs
, 0); /* big-endian-flag */
1597 vnc_write_u8(vs
, 1); /* true-color-flag */
1598 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.rmax
); /* red-max */
1599 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.gmax
); /* green-max */
1600 vnc_write_u16(vs
, vs
->ds
->surface
->pf
.bmax
); /* blue-max */
1601 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.rshift
); /* red-shift */
1602 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.gshift
); /* green-shift */
1603 vnc_write_u8(vs
, vs
->ds
->surface
->pf
.bshift
); /* blue-shift */
1604 if (vs
->ds
->surface
->pf
.bits_per_pixel
== 32)
1605 vs
->send_hextile_tile
= send_hextile_tile_32
;
1606 else if (vs
->ds
->surface
->pf
.bits_per_pixel
== 16)
1607 vs
->send_hextile_tile
= send_hextile_tile_16
;
1608 else if (vs
->ds
->surface
->pf
.bits_per_pixel
== 8)
1609 vs
->send_hextile_tile
= send_hextile_tile_8
;
1610 vs
->clientds
= *(vs
->ds
->surface
);
1611 vs
->clientds
.flags
&= ~QEMU_ALLOCATED_FLAG
;
1612 vs
->write_pixels
= vnc_write_pixels_copy
;
1614 vnc_write(vs
, pad
, 3); /* padding */
1617 static void vnc_dpy_setdata(DisplayState
*ds
)
1619 /* We don't have to do anything */
1622 static void vnc_colordepth(VncState
*vs
)
1624 if (vnc_has_feature(vs
, VNC_FEATURE_WMVI
)) {
1625 /* Sending a WMVi message to notify the client*/
1626 vnc_write_u8(vs
, 0); /* msg id */
1627 vnc_write_u8(vs
, 0);
1628 vnc_write_u16(vs
, 1); /* number of rects */
1629 vnc_framebuffer_update(vs
, 0, 0, ds_get_width(vs
->ds
),
1630 ds_get_height(vs
->ds
), VNC_ENCODING_WMVi
);
1631 pixel_format_message(vs
);
1634 set_pixel_conversion(vs
);
1638 static int protocol_client_msg(VncState
*vs
, uint8_t *data
, size_t len
)
1648 set_pixel_format(vs
, read_u8(data
, 4), read_u8(data
, 5),
1649 read_u8(data
, 6), read_u8(data
, 7),
1650 read_u16(data
, 8), read_u16(data
, 10),
1651 read_u16(data
, 12), read_u8(data
, 14),
1652 read_u8(data
, 15), read_u8(data
, 16));
1659 limit
= read_u16(data
, 2);
1661 return 4 + (limit
* 4);
1663 limit
= read_u16(data
, 2);
1665 for (i
= 0; i
< limit
; i
++) {
1666 int32_t val
= read_s32(data
, 4 + (i
* 4));
1667 memcpy(data
+ 4 + (i
* 4), &val
, sizeof(val
));
1670 set_encodings(vs
, (int32_t *)(data
+ 4), limit
);
1676 framebuffer_update_request(vs
,
1677 read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4),
1678 read_u16(data
, 6), read_u16(data
, 8));
1684 key_event(vs
, read_u8(data
, 1), read_u32(data
, 4));
1690 pointer_event(vs
, read_u8(data
, 1), read_u16(data
, 2), read_u16(data
, 4));
1697 uint32_t dlen
= read_u32(data
, 4);
1702 client_cut_text(vs
, read_u32(data
, 4), data
+ 8);
1708 switch (read_u8(data
, 1)) {
1713 ext_key_event(vs
, read_u16(data
, 2),
1714 read_u32(data
, 4), read_u32(data
, 8));
1720 switch (read_u16 (data
, 2)) {
1730 switch (read_u8(data
, 4)) {
1731 case 0: vs
->as
.fmt
= AUD_FMT_U8
; break;
1732 case 1: vs
->as
.fmt
= AUD_FMT_S8
; break;
1733 case 2: vs
->as
.fmt
= AUD_FMT_U16
; break;
1734 case 3: vs
->as
.fmt
= AUD_FMT_S16
; break;
1735 case 4: vs
->as
.fmt
= AUD_FMT_U32
; break;
1736 case 5: vs
->as
.fmt
= AUD_FMT_S32
; break;
1738 printf("Invalid audio format %d\n", read_u8(data
, 4));
1739 vnc_client_error(vs
);
1742 vs
->as
.nchannels
= read_u8(data
, 5);
1743 if (vs
->as
.nchannels
!= 1 && vs
->as
.nchannels
!= 2) {
1744 printf("Invalid audio channel coount %d\n",
1746 vnc_client_error(vs
);
1749 vs
->as
.freq
= read_u32(data
, 6);
1752 printf ("Invalid audio message %d\n", read_u8(data
, 4));
1753 vnc_client_error(vs
);
1759 printf("Msg: %d\n", read_u16(data
, 0));
1760 vnc_client_error(vs
);
1765 printf("Msg: %d\n", data
[0]);
1766 vnc_client_error(vs
);
1770 vnc_read_when(vs
, protocol_client_msg
, 1);
1774 static int protocol_client_init(VncState
*vs
, uint8_t *data
, size_t len
)
1779 vnc_write_u16(vs
, ds_get_width(vs
->ds
));
1780 vnc_write_u16(vs
, ds_get_height(vs
->ds
));
1782 pixel_format_message(vs
);
1785 size
= snprintf(buf
, sizeof(buf
), "QEMU (%s)", qemu_name
);
1787 size
= snprintf(buf
, sizeof(buf
), "QEMU");
1789 vnc_write_u32(vs
, size
);
1790 vnc_write(vs
, buf
, size
);
1793 vnc_read_when(vs
, protocol_client_msg
, 1);
1798 void start_client_init(VncState
*vs
)
1800 vnc_read_when(vs
, protocol_client_init
, 1);
1803 static void make_challenge(VncState
*vs
)
1807 srand(time(NULL
)+getpid()+getpid()*987654+rand());
1809 for (i
= 0 ; i
< sizeof(vs
->challenge
) ; i
++)
1810 vs
->challenge
[i
] = (int) (256.0*rand()/(RAND_MAX
+1.0));
1813 static int protocol_client_auth_vnc(VncState
*vs
, uint8_t *data
, size_t len
)
1815 unsigned char response
[VNC_AUTH_CHALLENGE_SIZE
];
1817 unsigned char key
[8];
1819 if (!vs
->vd
->password
|| !vs
->vd
->password
[0]) {
1820 VNC_DEBUG("No password configured on server");
1821 vnc_write_u32(vs
, 1); /* Reject auth */
1822 if (vs
->minor
>= 8) {
1823 static const char err
[] = "Authentication failed";
1824 vnc_write_u32(vs
, sizeof(err
));
1825 vnc_write(vs
, err
, sizeof(err
));
1828 vnc_client_error(vs
);
1832 memcpy(response
, vs
->challenge
, VNC_AUTH_CHALLENGE_SIZE
);
1834 /* Calculate the expected challenge response */
1835 pwlen
= strlen(vs
->vd
->password
);
1836 for (i
=0; i
<sizeof(key
); i
++)
1837 key
[i
] = i
<pwlen
? vs
->vd
->password
[i
] : 0;
1839 for (j
= 0; j
< VNC_AUTH_CHALLENGE_SIZE
; j
+= 8)
1840 des(response
+j
, response
+j
);
1842 /* Compare expected vs actual challenge response */
1843 if (memcmp(response
, data
, VNC_AUTH_CHALLENGE_SIZE
) != 0) {
1844 VNC_DEBUG("Client challenge reponse did not match\n");
1845 vnc_write_u32(vs
, 1); /* Reject auth */
1846 if (vs
->minor
>= 8) {
1847 static const char err
[] = "Authentication failed";
1848 vnc_write_u32(vs
, sizeof(err
));
1849 vnc_write(vs
, err
, sizeof(err
));
1852 vnc_client_error(vs
);
1854 VNC_DEBUG("Accepting VNC challenge response\n");
1855 vnc_write_u32(vs
, 0); /* Accept auth */
1858 start_client_init(vs
);
1863 void start_auth_vnc(VncState
*vs
)
1866 /* Send client a 'random' challenge */
1867 vnc_write(vs
, vs
->challenge
, sizeof(vs
->challenge
));
1870 vnc_read_when(vs
, protocol_client_auth_vnc
, sizeof(vs
->challenge
));
1874 static int protocol_client_auth(VncState
*vs
, uint8_t *data
, size_t len
)
1876 /* We only advertise 1 auth scheme at a time, so client
1877 * must pick the one we sent. Verify this */
1878 if (data
[0] != vs
->vd
->auth
) { /* Reject auth */
1879 VNC_DEBUG("Reject auth %d because it didn't match advertized\n", (int)data
[0]);
1880 vnc_write_u32(vs
, 1);
1881 if (vs
->minor
>= 8) {
1882 static const char err
[] = "Authentication failed";
1883 vnc_write_u32(vs
, sizeof(err
));
1884 vnc_write(vs
, err
, sizeof(err
));
1886 vnc_client_error(vs
);
1887 } else { /* Accept requested auth */
1888 VNC_DEBUG("Client requested auth %d\n", (int)data
[0]);
1889 switch (vs
->vd
->auth
) {
1891 VNC_DEBUG("Accept auth none\n");
1892 if (vs
->minor
>= 8) {
1893 vnc_write_u32(vs
, 0); /* Accept auth completion */
1896 start_client_init(vs
);
1900 VNC_DEBUG("Start VNC auth\n");
1904 #ifdef CONFIG_VNC_TLS
1905 case VNC_AUTH_VENCRYPT
:
1906 VNC_DEBUG("Accept VeNCrypt auth\n");;
1907 start_auth_vencrypt(vs
);
1909 #endif /* CONFIG_VNC_TLS */
1911 #ifdef CONFIG_VNC_SASL
1913 VNC_DEBUG("Accept SASL auth\n");
1914 start_auth_sasl(vs
);
1916 #endif /* CONFIG_VNC_SASL */
1918 default: /* Should not be possible, but just in case */
1919 VNC_DEBUG("Reject auth %d server code bug\n", vs
->vd
->auth
);
1920 vnc_write_u8(vs
, 1);
1921 if (vs
->minor
>= 8) {
1922 static const char err
[] = "Authentication failed";
1923 vnc_write_u32(vs
, sizeof(err
));
1924 vnc_write(vs
, err
, sizeof(err
));
1926 vnc_client_error(vs
);
1932 static int protocol_version(VncState
*vs
, uint8_t *version
, size_t len
)
1936 memcpy(local
, version
, 12);
1939 if (sscanf(local
, "RFB %03d.%03d\n", &vs
->major
, &vs
->minor
) != 2) {
1940 VNC_DEBUG("Malformed protocol version %s\n", local
);
1941 vnc_client_error(vs
);
1944 VNC_DEBUG("Client request protocol version %d.%d\n", vs
->major
, vs
->minor
);
1945 if (vs
->major
!= 3 ||
1951 VNC_DEBUG("Unsupported client version\n");
1952 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
1954 vnc_client_error(vs
);
1957 /* Some broken clients report v3.4 or v3.5, which spec requires to be treated
1958 * as equivalent to v3.3 by servers
1960 if (vs
->minor
== 4 || vs
->minor
== 5)
1963 if (vs
->minor
== 3) {
1964 if (vs
->vd
->auth
== VNC_AUTH_NONE
) {
1965 VNC_DEBUG("Tell client auth none\n");
1966 vnc_write_u32(vs
, vs
->vd
->auth
);
1968 start_client_init(vs
);
1969 } else if (vs
->vd
->auth
== VNC_AUTH_VNC
) {
1970 VNC_DEBUG("Tell client VNC auth\n");
1971 vnc_write_u32(vs
, vs
->vd
->auth
);
1975 VNC_DEBUG("Unsupported auth %d for protocol 3.3\n", vs
->vd
->auth
);
1976 vnc_write_u32(vs
, VNC_AUTH_INVALID
);
1978 vnc_client_error(vs
);
1981 VNC_DEBUG("Telling client we support auth %d\n", vs
->vd
->auth
);
1982 vnc_write_u8(vs
, 1); /* num auth */
1983 vnc_write_u8(vs
, vs
->vd
->auth
);
1984 vnc_read_when(vs
, protocol_client_auth
, 1);
1991 static void vnc_connect(VncDisplay
*vd
, int csock
)
1993 VncState
*vs
= qemu_mallocz(sizeof(VncState
));
1996 VNC_DEBUG("New client on socket %d\n", csock
);
1998 socket_set_nonblock(vs
->csock
);
1999 qemu_set_fd_handler2(vs
->csock
, NULL
, vnc_client_read
, NULL
, vs
);
2003 vs
->timer
= qemu_new_timer(rt_clock
, vnc_update_client
, vs
);
2007 vs
->as
.freq
= 44100;
2008 vs
->as
.nchannels
= 2;
2009 vs
->as
.fmt
= AUD_FMT_S16
;
2010 vs
->as
.endianness
= 0;
2013 vnc_write(vs
, "RFB 003.008\n", 12);
2015 vnc_read_when(vs
, protocol_version
, 12);
2016 vnc_update_client(vs
);
2019 vs
->next
= vd
->clients
;
2023 static void vnc_listen_read(void *opaque
)
2025 VncDisplay
*vs
= opaque
;
2026 struct sockaddr_in addr
;
2027 socklen_t addrlen
= sizeof(addr
);
2032 int csock
= accept(vs
->lsock
, (struct sockaddr
*)&addr
, &addrlen
);
2034 vnc_connect(vs
, csock
);
2038 void vnc_display_init(DisplayState
*ds
)
2042 vs
= qemu_mallocz(sizeof(VncState
));
2043 dcl
= qemu_mallocz(sizeof(DisplayChangeListener
));
2053 if (keyboard_layout
)
2054 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, keyboard_layout
);
2056 vs
->kbd_layout
= init_keyboard_layout(name2keysym
, "en-us");
2058 if (!vs
->kbd_layout
)
2061 dcl
->dpy_copy
= vnc_dpy_copy
;
2062 dcl
->dpy_update
= vnc_dpy_update
;
2063 dcl
->dpy_resize
= vnc_dpy_resize
;
2064 dcl
->dpy_setdata
= vnc_dpy_setdata
;
2065 register_displaychangelistener(ds
, dcl
);
2069 void vnc_display_close(DisplayState
*ds
)
2071 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2076 qemu_free(vs
->display
);
2079 if (vs
->lsock
!= -1) {
2080 qemu_set_fd_handler2(vs
->lsock
, NULL
, NULL
, NULL
, NULL
);
2084 vs
->auth
= VNC_AUTH_INVALID
;
2085 #ifdef CONFIG_VNC_TLS
2086 vs
->subauth
= VNC_AUTH_INVALID
;
2087 vs
->tls
.x509verify
= 0;
2091 int vnc_display_password(DisplayState
*ds
, const char *password
)
2093 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2096 qemu_free(vs
->password
);
2097 vs
->password
= NULL
;
2099 if (password
&& password
[0]) {
2100 if (!(vs
->password
= qemu_strdup(password
)))
2107 int vnc_display_open(DisplayState
*ds
, const char *display
)
2109 VncDisplay
*vs
= ds
? (VncDisplay
*)ds
->opaque
: vnc_display
;
2110 const char *options
;
2114 #ifdef CONFIG_VNC_TLS
2115 int tls
= 0, x509
= 0;
2117 #ifdef CONFIG_VNC_SASL
2125 vnc_display_close(ds
);
2126 if (strcmp(display
, "none") == 0)
2129 if (!(vs
->display
= strdup(display
)))
2133 while ((options
= strchr(options
, ','))) {
2135 if (strncmp(options
, "password", 8) == 0) {
2136 password
= 1; /* Require password auth */
2137 } else if (strncmp(options
, "reverse", 7) == 0) {
2139 } else if (strncmp(options
, "to=", 3) == 0) {
2140 to_port
= atoi(options
+3) + 5900;
2141 #ifdef CONFIG_VNC_SASL
2142 } else if (strncmp(options
, "sasl", 4) == 0) {
2143 sasl
= 1; /* Require SASL auth */
2145 #ifdef CONFIG_VNC_TLS
2146 } else if (strncmp(options
, "tls", 3) == 0) {
2147 tls
= 1; /* Require TLS */
2148 } else if (strncmp(options
, "x509", 4) == 0) {
2150 x509
= 1; /* Require x509 certificates */
2151 if (strncmp(options
, "x509verify", 10) == 0)
2152 vs
->tls
.x509verify
= 1; /* ...and verify client certs */
2154 /* Now check for 'x509=/some/path' postfix
2155 * and use that to setup x509 certificate/key paths */
2156 start
= strchr(options
, '=');
2157 end
= strchr(options
, ',');
2158 if (start
&& (!end
|| (start
< end
))) {
2159 int len
= end
? end
-(start
+1) : strlen(start
+1);
2160 char *path
= qemu_strndup(start
+ 1, len
);
2162 VNC_DEBUG("Trying certificate path '%s'\n", path
);
2163 if (vnc_tls_set_x509_creds_dir(vs
, path
) < 0) {
2164 fprintf(stderr
, "Failed to find x509 certificates/keys in %s\n", path
);
2166 qemu_free(vs
->display
);
2172 fprintf(stderr
, "No certificate path provided\n");
2173 qemu_free(vs
->display
);
2178 } else if (strncmp(options
, "acl", 3) == 0) {
2183 #ifdef CONFIG_VNC_TLS
2184 if (acl
&& x509
&& vs
->tls
.x509verify
) {
2185 if (!(vs
->tls
.acl
= qemu_acl_init("vnc.x509dname"))) {
2186 fprintf(stderr
, "Failed to create x509 dname ACL\n");
2191 #ifdef CONFIG_VNC_SASL
2193 if (!(vs
->sasl
.acl
= qemu_acl_init("vnc.username"))) {
2194 fprintf(stderr
, "Failed to create username ACL\n");
2201 * Combinations we support here:
2203 * - no-auth (clear text, no auth)
2204 * - password (clear text, weak auth)
2205 * - sasl (encrypt, good auth *IF* using Kerberos via GSSAPI)
2206 * - tls (encrypt, weak anonymous creds, no auth)
2207 * - tls + password (encrypt, weak anonymous creds, weak auth)
2208 * - tls + sasl (encrypt, weak anonymous creds, good auth)
2209 * - tls + x509 (encrypt, good x509 creds, no auth)
2210 * - tls + x509 + password (encrypt, good x509 creds, weak auth)
2211 * - tls + x509 + sasl (encrypt, good x509 creds, good auth)
2213 * NB1. TLS is a stackable auth scheme.
2214 * NB2. the x509 schemes have option to validate a client cert dname
2217 #ifdef CONFIG_VNC_TLS
2219 vs
->auth
= VNC_AUTH_VENCRYPT
;
2221 VNC_DEBUG("Initializing VNC server with x509 password auth\n");
2222 vs
->subauth
= VNC_AUTH_VENCRYPT_X509VNC
;
2224 VNC_DEBUG("Initializing VNC server with TLS password auth\n");
2225 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSVNC
;
2228 #endif /* CONFIG_VNC_TLS */
2229 VNC_DEBUG("Initializing VNC server with password auth\n");
2230 vs
->auth
= VNC_AUTH_VNC
;
2231 #ifdef CONFIG_VNC_TLS
2232 vs
->subauth
= VNC_AUTH_INVALID
;
2234 #endif /* CONFIG_VNC_TLS */
2235 #ifdef CONFIG_VNC_SASL
2237 #ifdef CONFIG_VNC_TLS
2239 vs
->auth
= VNC_AUTH_VENCRYPT
;
2241 VNC_DEBUG("Initializing VNC server with x509 SASL auth\n");
2242 vs
->subauth
= VNC_AUTH_VENCRYPT_X509SASL
;
2244 VNC_DEBUG("Initializing VNC server with TLS SASL auth\n");
2245 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSSASL
;
2248 #endif /* CONFIG_VNC_TLS */
2249 VNC_DEBUG("Initializing VNC server with SASL auth\n");
2250 vs
->auth
= VNC_AUTH_SASL
;
2251 #ifdef CONFIG_VNC_TLS
2252 vs
->subauth
= VNC_AUTH_INVALID
;
2254 #endif /* CONFIG_VNC_TLS */
2255 #endif /* CONFIG_VNC_SASL */
2257 #ifdef CONFIG_VNC_TLS
2259 vs
->auth
= VNC_AUTH_VENCRYPT
;
2261 VNC_DEBUG("Initializing VNC server with x509 no auth\n");
2262 vs
->subauth
= VNC_AUTH_VENCRYPT_X509NONE
;
2264 VNC_DEBUG("Initializing VNC server with TLS no auth\n");
2265 vs
->subauth
= VNC_AUTH_VENCRYPT_TLSNONE
;
2269 VNC_DEBUG("Initializing VNC server with no auth\n");
2270 vs
->auth
= VNC_AUTH_NONE
;
2271 #ifdef CONFIG_VNC_TLS
2272 vs
->subauth
= VNC_AUTH_INVALID
;
2277 #ifdef CONFIG_VNC_SASL
2278 if ((saslErr
= sasl_server_init(NULL
, "qemu")) != SASL_OK
) {
2279 fprintf(stderr
, "Failed to initialize SASL auth %s",
2280 sasl_errstring(saslErr
, NULL
, NULL
));
2288 /* connect to viewer */
2289 if (strncmp(display
, "unix:", 5) == 0)
2290 vs
->lsock
= unix_connect(display
+5);
2292 vs
->lsock
= inet_connect(display
, SOCK_STREAM
);
2293 if (-1 == vs
->lsock
) {
2298 int csock
= vs
->lsock
;
2300 vnc_connect(vs
, csock
);
2305 /* listen for connects */
2307 dpy
= qemu_malloc(256);
2308 if (strncmp(display
, "unix:", 5) == 0) {
2309 pstrcpy(dpy
, 256, "unix:");
2310 vs
->lsock
= unix_listen(display
+5, dpy
+5, 256-5);
2312 vs
->lsock
= inet_listen(display
, dpy
, 256, SOCK_STREAM
, 5900);
2314 if (-1 == vs
->lsock
) {
2322 return qemu_set_fd_handler2(vs
->lsock
, NULL
, vnc_listen_read
, NULL
, vs
);