LXR qemu/ui/vnc-ws.h

   1/*
   2 * QEMU VNC display driver: Websockets support
   3 *
   4 * Copyright (C) 2010 Joel Martin
   5 * Copyright (C) 2012 Tim Hardeck
   6 *
   7 * This is free software; you can redistribute it and/or modify
   8 * it under the terms of the GNU General Public License as published by
   9 * the Free Software Foundation; either version 2 of the License, or
  10 * (at your option) any later version.
  11 *
  12 * This software is distributed in the hope that it will be useful,
  13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 * GNU General Public License for more details.
  16 *
  17 * You should have received a copy of the GNU General Public License
  18 * along with this software; if not, see <http://www.gnu.org/licenses/>.
  19 */
  20
  21#ifndef __QEMU_UI_VNC_WS_H
  22#define __QEMU_UI_VNC_WS_H
  23
  24#include <gnutls/gnutls.h>
  25
  26#define B64LEN(__x) (((__x + 2) / 3) * 12 / 3)
  27#define SHA1_DIGEST_LEN 20
  28
  29#define WS_ACCEPT_LEN (B64LEN(SHA1_DIGEST_LEN) + 1)
  30#define WS_CLIENT_KEY_LEN 24
  31#define WS_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
  32#define WS_GUID_LEN strlen(WS_GUID)
  33
  34#define WS_HANDSHAKE "HTTP/1.1 101 Switching Protocols\r\n\
  35Upgrade: websocket\r\n\
  36Connection: Upgrade\r\n\
  37Sec-WebSocket-Accept: %s\r\n\
  38Sec-WebSocket-Protocol: binary\r\n\
  39\r\n"
  40#define WS_HANDSHAKE_DELIM "\r\n"
  41#define WS_HANDSHAKE_END "\r\n\r\n"
  42#define WS_SUPPORTED_VERSION "13"
  43
  44#define WS_HEAD_MIN_LEN sizeof(uint16_t)
  45#define WS_HEAD_MAX_LEN (WS_HEAD_MIN_LEN + sizeof(uint64_t) + sizeof(uint32_t))
  46
  47typedef union WsMask {
  48    char c[4];
  49    uint32_t u;
  50} WsMask;
  51
  52typedef struct QEMU_PACKED WsHeader {
  53    unsigned char b0;
  54    unsigned char b1;
  55    union {
  56        struct QEMU_PACKED {
  57            uint16_t l16;
  58            WsMask m16;
  59        } s16;
  60        struct QEMU_PACKED {
  61            uint64_t l64;
  62            WsMask m64;
  63        } s64;
  64        WsMask m;
  65    } u;
  66} WsHeader;
  67
  68enum {
  69    WS_OPCODE_CONTINUATION = 0x0,
  70    WS_OPCODE_TEXT_FRAME = 0x1,
  71    WS_OPCODE_BINARY_FRAME = 0x2,
  72    WS_OPCODE_CLOSE = 0x8,
  73    WS_OPCODE_PING = 0x9,
  74    WS_OPCODE_PONG = 0xA
  75};
  76
  77#ifdef CONFIG_VNC_TLS
  78void vncws_tls_handshake_peek(void *opaque);
  79#endif /* CONFIG_VNC_TLS */
  80void vncws_handshake_read(void *opaque);
  81long vnc_client_write_ws(VncState *vs);
  82long vnc_client_read_ws(VncState *vs);
  83void vncws_process_handshake(VncState *vs, uint8_t *line, size_t size);
  84void vncws_encode_frame(Buffer *output, const void *payload,
  85            const size_t payload_size);
  86int vncws_decode_frame(Buffer *input, uint8_t **payload,
  87                               size_t *payload_size, size_t *frame_size);
  88
  89#endif /* __QEMU_UI_VNC_WS_H */
  90