Commit 2d1d0e70 authored by Daniel P. Berrangé's avatar Daniel P. Berrangé
Browse files

io: add QIOChannelWebsock class 



Add a QIOChannel subclass that can run the websocket protocol over
the top of another QIOChannel instance. This initial implementation
is only capable of acting as a websockets server. There is no support
for acting as a websockets client yet.

Signed-off-by: default avatarDaniel P. Berrange <berrange@redhat.com>
parent ed8ee42c

include/io/channel-websock.h

0 → 100644
+108 −0
Original line number Diff line number Diff line 
/*

 * QEMU I/O channels driver websockets

 *

 * Copyright (c) 2015 Red Hat, Inc.

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, see <http://www.gnu.org/licenses/>.

 *

 */



#ifndef QIO_CHANNEL_WEBSOCK_H__

#define QIO_CHANNEL_WEBSOCK_H__



#include "io/channel.h"

#include "qemu/buffer.h"

#include "io/task.h"



#define TYPE_QIO_CHANNEL_WEBSOCK "qio-channel-websock"

#define QIO_CHANNEL_WEBSOCK(obj)                                     \

    OBJECT_CHECK(QIOChannelWebsock, (obj), TYPE_QIO_CHANNEL_WEBSOCK)



typedef struct QIOChannelWebsock QIOChannelWebsock;

typedef union QIOChannelWebsockMask QIOChannelWebsockMask;



union QIOChannelWebsockMask {

    char c[4];

    uint32_t u;

};



/**

 * QIOChannelWebsock

 *

 * The QIOChannelWebsock class provides a channel wrapper which

 * can transparently run the HTTP websockets protocol. This is

 * usually used over a TCP socket, but there is actually no

 * technical restriction on which type of master channel is

 * used as the transport.

 *

 * This channel object is currently only capable of running as

 * a websocket server and is a pretty crude implementation

 * of it, not supporting the full websockets protocol feature

 * set. It is sufficient to use with a simple websockets

 * client for encapsulating VNC for noVNC in-browser client.

 */



struct QIOChannelWebsock {

    QIOChannel parent;

    QIOChannel *master;

    Buffer encinput;

    Buffer encoutput;

    Buffer rawinput;

    Buffer rawoutput;

    size_t payload_remain;

    QIOChannelWebsockMask mask;

    guint io_tag;

    Error *io_err;

    gboolean io_eof;

};



/**

 * qio_channel_websock_new_server:

 * @master: the underlying channel object

 *

 * Create a new websockets channel that runs the server

 * side of the protocol.

 *

 * After creating the channel, it is mandatory to call

 * the qio_channel_websock_handshake() method before attempting

 * todo any I/O on the channel.

 *

 * Once the handshake has completed, all I/O should be done

 * via the new websocket channel object and not the original

 * master channel

 *

 * Returns: the new websockets channel object

 */

QIOChannelWebsock *

qio_channel_websock_new_server(QIOChannel *master);



/**

 * qio_channel_websock_handshake:

 * @ioc: the websocket channel object

 * @func: the callback to invoke when completed

 * @opaque: opaque data to pass to @func

 * @destroy: optional callback to free @opaque

 *

 * Perform the websocket handshake. This method

 * will return immediately and the handshake will

 * continue in the background, provided the main

 * loop is running. When the handshake is complete,

 * or fails, the @func callback will be invoked.

 */

void qio_channel_websock_handshake(QIOChannelWebsock *ioc,

                                   QIOTaskFunc func,

                                   gpointer opaque,

                                   GDestroyNotify destroy);



#endif /* QIO_CHANNEL_WEBSOCK_H__ */

io/Makefile.objs

+1 −0
Original line number Diff line number Diff line
@@ -3,4 +3,5 @@ io-obj-y += channel-file.o 
io-obj-y += channel-socket.o

io-obj-y += channel-tls.o

io-obj-y += channel-watch.o

io-obj-y += channel-websock.o

io-obj-y += task.o

io/channel-websock.c

0 → 100644
+962 −0

File added.

Preview size limit exceeded, changes collapsed.

trace-events

+8 −0
Original line number Diff line number Diff line
@@ -1850,3 +1850,11 @@ qio_channel_tls_handshake_fail(void *ioc) "TLS handshake fail ioc=%p" 
qio_channel_tls_handshake_complete(void *ioc) "TLS handshake complete ioc=%p"

qio_channel_tls_credentials_allow(void *ioc) "TLS credentials allow ioc=%p"

qio_channel_tls_credentials_deny(void *ioc) "TLS credentials deny ioc=%p"



# io/channel-websock.c

qio_channel_websock_new_server(void *ioc, void *master) "Websock new client ioc=%p master=%p"

qio_channel_websock_handshake_start(void *ioc) "Websock handshake start ioc=%p"

qio_channel_websock_handshake_pending(void *ioc, int status) "Websock handshake pending ioc=%p status=%d"

qio_channel_websock_handshake_reply(void *ioc) "Websock handshake reply ioc=%p"

qio_channel_websock_handshake_fail(void *ioc) "Websock handshake fail ioc=%p"

qio_channel_websock_handshake_complete(void *ioc) "Websock handshake complete ioc=%p"