res_http_websocket: websocket write timeout fails to fully disconnect
[asterisk/asterisk.git] / res / res_http_websocket.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief WebSocket support for the Asterisk internal HTTP server
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>extended</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/module.h"
35 #include "asterisk/http.h"
36 #include "asterisk/astobj2.h"
37 #include "asterisk/strings.h"
38 #include "asterisk/file.h"
39 #include "asterisk/unaligned.h"
40 #include "asterisk/uri.h"
41
42 #define AST_API_MODULE
43 #include "asterisk/http_websocket.h"
44
45 /*! \brief GUID used to compute the accept key, defined in the specifications */
46 #define WEBSOCKET_GUID "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
47
48 /*! \brief Length of a websocket's client key */
49 #define CLIENT_KEY_SIZE 16
50
51 /*! \brief Number of buckets for registered protocols */
52 #define MAX_PROTOCOL_BUCKETS 7
53
54 /*! \brief Size of the pre-determined buffer for WebSocket frames */
55 #define MAXIMUM_FRAME_SIZE 8192
56
57 /*! \brief Default reconstruction size for multi-frame payload reconstruction. If exceeded the next frame will start a
58  *         payload.
59  */
60 #define DEFAULT_RECONSTRUCTION_CEILING 16384
61
62 /*! \brief Maximum reconstruction size for multi-frame payload reconstruction. */
63 #define MAXIMUM_RECONSTRUCTION_CEILING 16384
64
65 /*! \brief Maximum size of a websocket frame header
66  * 1 byte flags and opcode
67  * 1 byte mask flag + payload len
68  * 8 bytes max extended length
69  * 4 bytes optional masking key
70  * ... payload follows ...
71  * */
72 #define MAX_WS_HDR_SZ 14
73 #define MIN_WS_HDR_SZ 2
74
75 /*! \brief Structure definition for session */
76 struct ast_websocket {
77         FILE *f;                          /*!< Pointer to the file instance used for writing and reading */
78         int fd;                           /*!< File descriptor for the session, only used for polling */
79         struct ast_sockaddr address;      /*!< Address of the remote client */
80         enum ast_websocket_opcode opcode; /*!< Cached opcode for multi-frame messages */
81         size_t payload_len;               /*!< Length of the payload */
82         char *payload;                    /*!< Pointer to the payload */
83         size_t reconstruct;               /*!< Number of bytes before a reconstructed payload will be returned and a new one started */
84         int timeout;                      /*!< The timeout for operations on the socket */
85         unsigned int secure:1;            /*!< Bit to indicate that the transport is secure */
86         unsigned int closing:1;           /*!< Bit to indicate that the session is in the process of being closed */
87         unsigned int close_sent:1;        /*!< Bit to indicate that the session close opcode has been sent and no further data will be sent */
88         struct websocket_client *client;  /*!< Client object when connected as a client websocket */
89 };
90
91 /*! \brief Structure definition for protocols */
92 struct websocket_protocol {
93         char *name;                      /*!< Name of the protocol */
94         ast_websocket_callback callback; /*!< Callback called when a new session is established */
95 };
96
97 /*! \brief Hashing function for protocols */
98 static int protocol_hash_fn(const void *obj, const int flags)
99 {
100         const struct websocket_protocol *protocol = obj;
101         const char *name = obj;
102
103         return ast_str_case_hash(flags & OBJ_KEY ? name : protocol->name);
104 }
105
106 /*! \brief Comparison function for protocols */
107 static int protocol_cmp_fn(void *obj, void *arg, int flags)
108 {
109         const struct websocket_protocol *protocol1 = obj, *protocol2 = arg;
110         const char *protocol = arg;
111
112         return !strcasecmp(protocol1->name, flags & OBJ_KEY ? protocol : protocol2->name) ? CMP_MATCH | CMP_STOP : 0;
113 }
114
115 /*! \brief Destructor function for protocols */
116 static void protocol_destroy_fn(void *obj)
117 {
118         struct websocket_protocol *protocol = obj;
119         ast_free(protocol->name);
120 }
121
122 /*! \brief Structure for a WebSocket server */
123 struct ast_websocket_server {
124         struct ao2_container *protocols; /*!< Container for registered protocols */
125 };
126
127 static void websocket_server_internal_dtor(void *obj)
128 {
129         struct ast_websocket_server *server = obj;
130         ao2_cleanup(server->protocols);
131         server->protocols = NULL;
132 }
133
134 static void websocket_server_dtor(void *obj)
135 {
136         websocket_server_internal_dtor(obj);
137         ast_module_unref(ast_module_info->self);
138 }
139
140 static struct ast_websocket_server *websocket_server_create_impl(void (*dtor)(void *))
141 {
142         RAII_VAR(struct ast_websocket_server *, server, NULL, ao2_cleanup);
143
144         server = ao2_alloc(sizeof(*server), dtor);
145         if (!server) {
146                 return NULL;
147         }
148
149         server->protocols = ao2_container_alloc(MAX_PROTOCOL_BUCKETS, protocol_hash_fn, protocol_cmp_fn);
150         if (!server->protocols) {
151                 return NULL;
152         }
153
154         ao2_ref(server, +1);
155         return server;
156 }
157
158 static struct ast_websocket_server *websocket_server_internal_create(void)
159 {
160         return websocket_server_create_impl(websocket_server_internal_dtor);
161 }
162
163 struct ast_websocket_server *AST_OPTIONAL_API_NAME(ast_websocket_server_create)(void)
164 {
165         ast_module_ref(ast_module_info->self);
166         return websocket_server_create_impl(websocket_server_dtor);
167 }
168
169 /*! \brief Destructor function for sessions */
170 static void session_destroy_fn(void *obj)
171 {
172         struct ast_websocket *session = obj;
173
174         if (session->f) {
175                 ast_websocket_close(session, 0);
176                 fclose(session->f);
177                 ast_verb(2, "WebSocket connection %s '%s' closed\n", session->client ? "to" : "from",
178                         ast_sockaddr_stringify(&session->address));
179         }
180
181         ao2_cleanup(session->client);
182         ast_free(session->payload);
183 }
184
185 int AST_OPTIONAL_API_NAME(ast_websocket_server_add_protocol)(struct ast_websocket_server *server, const char *name, ast_websocket_callback callback)
186 {
187         struct websocket_protocol *protocol;
188
189         if (!server->protocols) {
190                 return -1;
191         }
192
193         ao2_lock(server->protocols);
194
195         /* Ensure a second protocol handler is not registered for the same protocol */
196         if ((protocol = ao2_find(server->protocols, name, OBJ_KEY | OBJ_NOLOCK))) {
197                 ao2_ref(protocol, -1);
198                 ao2_unlock(server->protocols);
199                 return -1;
200         }
201
202         if (!(protocol = ao2_alloc(sizeof(*protocol), protocol_destroy_fn))) {
203                 ao2_unlock(server->protocols);
204                 return -1;
205         }
206
207         if (!(protocol->name = ast_strdup(name))) {
208                 ao2_ref(protocol, -1);
209                 ao2_unlock(server->protocols);
210                 return -1;
211         }
212
213         protocol->callback = callback;
214
215         ao2_link_flags(server->protocols, protocol, OBJ_NOLOCK);
216         ao2_unlock(server->protocols);
217         ao2_ref(protocol, -1);
218
219         ast_verb(2, "WebSocket registered sub-protocol '%s'\n", name);
220
221         return 0;
222 }
223
224 int AST_OPTIONAL_API_NAME(ast_websocket_server_remove_protocol)(struct ast_websocket_server *server, const char *name, ast_websocket_callback callback)
225 {
226         struct websocket_protocol *protocol;
227
228         if (!(protocol = ao2_find(server->protocols, name, OBJ_KEY))) {
229                 return -1;
230         }
231
232         if (protocol->callback != callback) {
233                 ao2_ref(protocol, -1);
234                 return -1;
235         }
236
237         ao2_unlink(server->protocols, protocol);
238         ao2_ref(protocol, -1);
239
240         ast_verb(2, "WebSocket unregistered sub-protocol '%s'\n", name);
241
242         return 0;
243 }
244
245 /*! \brief Close function for websocket session */
246 int AST_OPTIONAL_API_NAME(ast_websocket_close)(struct ast_websocket *session, uint16_t reason)
247 {
248         char frame[4] = { 0, }; /* The header is 2 bytes and the reason code takes up another 2 bytes */
249         int res;
250
251         if (session->close_sent) {
252                 return 0;
253         }
254
255         frame[0] = AST_WEBSOCKET_OPCODE_CLOSE | 0x80;
256         frame[1] = 2; /* The reason code is always 2 bytes */
257
258         /* If no reason has been specified assume 1000 which is normal closure */
259         put_unaligned_uint16(&frame[2], htons(reason ? reason : 1000));
260
261         session->closing = 1;
262         session->close_sent = 1;
263
264         ao2_lock(session);
265         res = ast_careful_fwrite(session->f, session->fd, frame, 4, session->timeout);
266         ao2_unlock(session);
267         return res;
268 }
269
270
271 /*! \brief Write function for websocket traffic */
272 int AST_OPTIONAL_API_NAME(ast_websocket_write)(struct ast_websocket *session, enum ast_websocket_opcode opcode, char *payload, uint64_t actual_length)
273 {
274         size_t header_size = 2; /* The minimum size of a websocket frame is 2 bytes */
275         char *frame;
276         uint64_t length;
277
278         if (actual_length < 126) {
279                 length = actual_length;
280         } else if (actual_length < (1 << 16)) {
281                 length = 126;
282                 /* We need an additional 2 bytes to store the extended length */
283                 header_size += 2;
284         } else {
285                 length = 127;
286                 /* We need an additional 8 bytes to store the really really extended length */
287                 header_size += 8;
288         }
289
290         frame = ast_alloca(header_size);
291         memset(frame, 0, header_size);
292
293         frame[0] = opcode | 0x80;
294         frame[1] = length;
295
296         /* Use the additional available bytes to store the length */
297         if (length == 126) {
298                 put_unaligned_uint16(&frame[2], htons(actual_length));
299         } else if (length == 127) {
300                 put_unaligned_uint64(&frame[2], htonl(actual_length));
301         }
302
303         ao2_lock(session);
304         if (session->closing) {
305                 ao2_unlock(session);
306                 return -1;
307         }
308         if (ast_careful_fwrite(session->f, session->fd, frame, header_size, session->timeout)) {
309                 ao2_unlock(session);
310                 /* 1011 - server terminating connection due to not being able to fulfill the request */
311                 ast_websocket_close(session, 1011);
312                 return -1;
313         }
314
315         if (ast_careful_fwrite(session->f, session->fd, payload, actual_length, session->timeout)) {
316                 ao2_unlock(session);
317                 /* 1011 - server terminating connection due to not being able to fulfill the request */
318                 ast_websocket_close(session, 1011);
319                 return -1;
320         }
321         fflush(session->f);
322         ao2_unlock(session);
323
324         return 0;
325 }
326
327 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_enable)(struct ast_websocket *session, size_t bytes)
328 {
329         session->reconstruct = MIN(bytes, MAXIMUM_RECONSTRUCTION_CEILING);
330 }
331
332 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_disable)(struct ast_websocket *session)
333 {
334         session->reconstruct = 0;
335 }
336
337 void AST_OPTIONAL_API_NAME(ast_websocket_ref)(struct ast_websocket *session)
338 {
339         ao2_ref(session, +1);
340 }
341
342 void AST_OPTIONAL_API_NAME(ast_websocket_unref)(struct ast_websocket *session)
343 {
344         ao2_cleanup(session);
345 }
346
347 int AST_OPTIONAL_API_NAME(ast_websocket_fd)(struct ast_websocket *session)
348 {
349         return session->closing ? -1 : session->fd;
350 }
351
352 struct ast_sockaddr * AST_OPTIONAL_API_NAME(ast_websocket_remote_address)(struct ast_websocket *session)
353 {
354         return &session->address;
355 }
356
357 int AST_OPTIONAL_API_NAME(ast_websocket_is_secure)(struct ast_websocket *session)
358 {
359         return session->secure;
360 }
361
362 int AST_OPTIONAL_API_NAME(ast_websocket_set_nonblock)(struct ast_websocket *session)
363 {
364         int flags;
365
366         if ((flags = fcntl(session->fd, F_GETFL)) == -1) {
367                 return -1;
368         }
369
370         flags |= O_NONBLOCK;
371
372         if ((flags = fcntl(session->fd, F_SETFL, flags)) == -1) {
373                 return -1;
374         }
375
376         return 0;
377 }
378
379 int AST_OPTIONAL_API_NAME(ast_websocket_set_timeout)(struct ast_websocket *session, int timeout)
380 {
381         session->timeout = timeout;
382
383         return 0;
384 }
385
386 /* MAINTENANCE WARNING on ast_websocket_read()!
387  *
388  * We have to keep in mind during this function that the fact that session->fd seems ready
389  * (via poll) does not necessarily mean we have application data ready, because in the case
390  * of an SSL socket, there is some encryption data overhead that needs to be read from the
391  * TCP socket, so poll() may say there are bytes to be read, but whether it is just 1 byte
392  * or N bytes we do not know that, and we do not know how many of those bytes (if any) are
393  * for application data (for us) and not just for the SSL protocol consumption
394  *
395  * There used to be a couple of nasty bugs here that were fixed in last refactoring but I
396  * want to document them so the constraints are clear and we do not re-introduce them:
397  *
398  * - This function would incorrectly assume that fread() would necessarily return more than
399  *   1 byte of data, just because a websocket frame is always >= 2 bytes, but the thing
400  *   is we're dealing with a TCP bitstream here, we could read just one byte and that's normal.
401  *   The problem before was that if just one byte was read, the function bailed out and returned
402  *   an error, effectively dropping the first byte of a websocket frame header!
403  *
404  * - Another subtle bug was that it would just read up to MAX_WS_HDR_SZ (14 bytes) via fread()
405  *   then assume that executing poll() would tell you if there is more to read, but since
406  *   we're dealing with a buffered stream (session->f is a FILE*), poll would say there is
407  *   nothing else to read (in the real tcp socket session->fd) and we would get stuck here
408  *   without processing the rest of the data in session->f internal buffers until another packet
409  *   came on the network to unblock us!
410  *
411  * Note during the header parsing stage we try to read in small chunks just what we need, this
412  * is buffered data anyways, no expensive syscall required most of the time ...
413  */
414 static inline int ws_safe_read(struct ast_websocket *session, char *buf, int len, enum ast_websocket_opcode *opcode)
415 {
416         int sanity;
417         size_t rlen;
418         int xlen = len;
419         char *rbuf = buf;
420         for (sanity = 10; sanity; sanity--) {
421                 clearerr(session->f);
422                 rlen = fread(rbuf, 1, xlen, session->f);
423                 if (!rlen && ferror(session->f) && errno != EAGAIN) {
424                         ast_log(LOG_ERROR, "Error reading from web socket: %s\n", strerror(errno));
425                         *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
426                         session->closing = 1;
427                         return -1;
428                 }
429                 xlen = xlen - rlen;
430                 rbuf = rbuf + rlen;
431                 if (!xlen) {
432                         break;
433                 }
434                 if (ast_wait_for_input(session->fd, 1000) < 0) {
435                         ast_log(LOG_ERROR, "ast_wait_for_input returned err: %s\n", strerror(errno));
436                         *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
437                         session->closing = 1;
438                         return -1;
439                 }
440         }
441         if (!sanity) {
442                 ast_log(LOG_WARNING, "Websocket seems unresponsive, disconnecting ...\n");
443                 *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
444                 session->closing = 1;
445                 return -1;
446         }
447         return 0;
448 }
449
450 int AST_OPTIONAL_API_NAME(ast_websocket_read)(struct ast_websocket *session, char **payload, uint64_t *payload_len, enum ast_websocket_opcode *opcode, int *fragmented)
451 {
452         char buf[MAXIMUM_FRAME_SIZE] = "";
453         int fin = 0;
454         int mask_present = 0;
455         char *mask = NULL, *new_payload = NULL;
456         size_t options_len = 0, frame_size = 0;
457
458         *payload = NULL;
459         *payload_len = 0;
460         *fragmented = 0;
461
462         if (ws_safe_read(session, &buf[0], MIN_WS_HDR_SZ, opcode)) {
463                 return 0;
464         }
465         frame_size += MIN_WS_HDR_SZ;
466
467         /* ok, now we have the first 2 bytes, so we know some flags, opcode and payload length (or whether payload length extension will be required) */
468         *opcode = buf[0] & 0xf;
469         *payload_len = buf[1] & 0x7f;
470         if (*opcode == AST_WEBSOCKET_OPCODE_TEXT || *opcode == AST_WEBSOCKET_OPCODE_BINARY || *opcode == AST_WEBSOCKET_OPCODE_CONTINUATION ||
471             *opcode == AST_WEBSOCKET_OPCODE_PING || *opcode == AST_WEBSOCKET_OPCODE_PONG) {
472                 fin = (buf[0] >> 7) & 1;
473                 mask_present = (buf[1] >> 7) & 1;
474
475                 /* Based on the mask flag and payload length, determine how much more we need to read before start parsing the rest of the header */
476                 options_len += mask_present ? 4 : 0;
477                 options_len += (*payload_len == 126) ? 2 : (*payload_len == 127) ? 8 : 0;
478                 if (options_len) {
479                         /* read the rest of the header options */
480                         if (ws_safe_read(session, &buf[frame_size], options_len, opcode)) {
481                                 return 0;
482                         }
483                         frame_size += options_len;
484                 }
485
486                 if (*payload_len == 126) {
487                         /* Grab the 2-byte payload length  */
488                         *payload_len = ntohs(get_unaligned_uint16(&buf[2]));
489                         mask = &buf[4];
490                 } else if (*payload_len == 127) {
491                         /* Grab the 8-byte payload length  */
492                         *payload_len = ntohl(get_unaligned_uint64(&buf[2]));
493                         mask = &buf[10];
494                 } else {
495                         /* Just set the mask after the small 2-byte header */
496                         mask = &buf[2];
497                 }
498
499                 /* Now read the rest of the payload */
500                 *payload = &buf[frame_size]; /* payload will start here, at the end of the options, if any */
501                 frame_size = frame_size + (*payload_len); /* final frame size is header + optional headers + payload data */
502                 if (frame_size > MAXIMUM_FRAME_SIZE) {
503                         ast_log(LOG_WARNING, "Cannot fit huge websocket frame of %zu bytes\n", frame_size);
504                         /* The frame won't fit :-( */
505                         ast_websocket_close(session, 1009);
506                         return -1;
507                 }
508
509                 if (ws_safe_read(session, *payload, *payload_len, opcode)) {
510                         return 0;
511                 }
512                 /* If a mask is present unmask the payload */
513                 if (mask_present) {
514                         unsigned int pos;
515                         for (pos = 0; pos < *payload_len; pos++) {
516                                 (*payload)[pos] ^= mask[pos % 4];
517                         }
518                 }
519
520                 /* Per the RFC for PING we need to send back an opcode with the application data as received */
521                 if ((*opcode == AST_WEBSOCKET_OPCODE_PING) && (ast_websocket_write(session, AST_WEBSOCKET_OPCODE_PONG, *payload, *payload_len))) {
522                         *payload_len = 0;
523                         ast_websocket_close(session, 1009);
524                         return 0;
525                 }
526
527                 if (*payload_len) {
528                         if (!(new_payload = ast_realloc(session->payload, (session->payload_len + *payload_len)))) {
529                                 ast_log(LOG_WARNING, "Failed allocation: %p, %zu, %"PRIu64"\n",
530                                         session->payload, session->payload_len, *payload_len);
531                                 *payload_len = 0;
532                                 ast_websocket_close(session, 1009);
533                                 return 0;
534                         }
535
536                         session->payload = new_payload;
537                         memcpy((session->payload + session->payload_len), (*payload), (*payload_len));
538                         session->payload_len += *payload_len;
539                 } else if (!session->payload_len && session->payload) {
540                         ast_free(session->payload);
541                         session->payload = NULL;
542                 }
543
544                 if (!fin && session->reconstruct && (session->payload_len < session->reconstruct)) {
545                         /* If this is not a final message we need to defer returning it until later */
546                         if (*opcode != AST_WEBSOCKET_OPCODE_CONTINUATION) {
547                                 session->opcode = *opcode;
548                         }
549                         *opcode = AST_WEBSOCKET_OPCODE_CONTINUATION;
550                         *payload_len = 0;
551                         *payload = NULL;
552                 } else {
553                         if (*opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
554                                 if (!fin) {
555                                         /* If this was not actually the final message tell the user it is fragmented so they can deal with it accordingly */
556                                         *fragmented = 1;
557                                 } else {
558                                         /* Final frame in multi-frame so push up the actual opcode */
559                                         *opcode = session->opcode;
560                                 }
561                         }
562                         *payload_len = session->payload_len;
563                         *payload = session->payload;
564                         session->payload_len = 0;
565                 }
566         } else if (*opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
567                 /* Make the payload available so the user can look at the reason code if they so desire */
568                 if ((*payload_len) && (new_payload = ast_realloc(session->payload, *payload_len))) {
569                         if (ws_safe_read(session, &buf[frame_size], (*payload_len), opcode)) {
570                                 return 0;
571                         }
572                         session->payload = new_payload;
573                         memcpy(session->payload, &buf[frame_size], *payload_len);
574                         *payload = session->payload;
575                         frame_size += (*payload_len);
576                 }
577
578                 session->closing = 1;
579         } else {
580                 ast_log(LOG_WARNING, "WebSocket unknown opcode %u\n", *opcode);
581                 /* We received an opcode that we don't understand, the RFC states that 1003 is for a type of data that can't be accepted... opcodes
582                  * fit that, I think. */
583                 ast_websocket_close(session, 1003);
584         }
585
586         return 0;
587 }
588
589 /*!
590  * \brief If the server has exactly one configured protocol, return it.
591  */
592 static struct websocket_protocol *one_protocol(
593         struct ast_websocket_server *server)
594 {
595         SCOPED_AO2LOCK(lock, server->protocols);
596
597         if (ao2_container_count(server->protocols) != 1) {
598                 return NULL;
599         }
600
601         return ao2_callback(server->protocols, OBJ_NOLOCK, NULL, NULL);
602 }
603
604 static char *websocket_combine_key(const char *key, char *res, int res_size)
605 {
606         char *combined;
607         unsigned combined_length = strlen(key) + strlen(WEBSOCKET_GUID) + 1;
608         uint8_t sha[20];
609
610         combined = ast_alloca(combined_length);
611         snprintf(combined, combined_length, "%s%s", key, WEBSOCKET_GUID);
612         ast_sha1_hash_uint(sha, combined);
613         ast_base64encode(res, (const unsigned char*)sha, 20, res_size);
614         return res;
615 }
616
617 static void websocket_bad_request(struct ast_tcptls_session_instance *ser)
618 {
619         struct ast_str *http_header = ast_str_create(64);
620
621         if (!http_header) {
622                 ast_http_request_close_on_completion(ser);
623                 ast_http_error(ser, 500, "Server Error", "Out of memory");
624                 return;
625         }
626         ast_str_set(&http_header, 0, "Sec-WebSocket-Version: 7, 8, 13\r\n");
627         ast_http_send(ser, AST_HTTP_UNKNOWN, 400, "Bad Request", http_header, NULL, 0, 0);
628 }
629
630 int AST_OPTIONAL_API_NAME(ast_websocket_uri_cb)(struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_vars, struct ast_variable *headers)
631 {
632         struct ast_variable *v;
633         char *upgrade = NULL, *key = NULL, *key1 = NULL, *key2 = NULL, *protos = NULL, *requested_protocols = NULL, *protocol = NULL;
634         int version = 0, flags = 1;
635         struct websocket_protocol *protocol_handler = NULL;
636         struct ast_websocket *session;
637         struct ast_websocket_server *server;
638
639         SCOPED_MODULE_USE(ast_module_info->self);
640
641         /* Upgrade requests are only permitted on GET methods */
642         if (method != AST_HTTP_GET) {
643                 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
644                 return 0;
645         }
646
647         server = urih->data;
648
649         /* Get the minimum headers required to satisfy our needs */
650         for (v = headers; v; v = v->next) {
651                 if (!strcasecmp(v->name, "Upgrade")) {
652                         upgrade = ast_strip(ast_strdupa(v->value));
653                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key")) {
654                         key = ast_strip(ast_strdupa(v->value));
655                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key1")) {
656                         key1 = ast_strip(ast_strdupa(v->value));
657                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key2")) {
658                         key2 = ast_strip(ast_strdupa(v->value));
659                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Protocol")) {
660                         requested_protocols = ast_strip(ast_strdupa(v->value));
661                         protos = ast_strdupa(requested_protocols);
662                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Version")) {
663                         if (sscanf(v->value, "%30d", &version) != 1) {
664                                 version = 0;
665                         }
666                 }
667         }
668
669         /* If this is not a websocket upgrade abort */
670         if (!upgrade || strcasecmp(upgrade, "websocket")) {
671                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - did not request WebSocket\n",
672                         ast_sockaddr_stringify(&ser->remote_address));
673                 ast_http_error(ser, 426, "Upgrade Required", NULL);
674                 return 0;
675         } else if (ast_strlen_zero(requested_protocols)) {
676                 /* If there's only a single protocol registered, and the
677                  * client doesn't specify what protocol it's using, go ahead
678                  * and accept the connection */
679                 protocol_handler = one_protocol(server);
680                 if (!protocol_handler) {
681                         /* Multiple registered subprotocols; client must specify */
682                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols requested\n",
683                                 ast_sockaddr_stringify(&ser->remote_address));
684                         websocket_bad_request(ser);
685                         return 0;
686                 }
687         } else if (key1 && key2) {
688                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 and
689                  * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00 -- not currently supported*/
690                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '00/76' chosen\n",
691                         ast_sockaddr_stringify(&ser->remote_address));
692                 websocket_bad_request(ser);
693                 return 0;
694         }
695
696         /* Iterate through the requested protocols trying to find one that we have a handler for */
697         while (!protocol_handler && (protocol = strsep(&requested_protocols, ","))) {
698                 protocol_handler = ao2_find(server->protocols, ast_strip(protocol), OBJ_KEY);
699         }
700
701         /* If no protocol handler exists bump this back to the requester */
702         if (!protocol_handler) {
703                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols out of '%s' supported\n",
704                         ast_sockaddr_stringify(&ser->remote_address), protos);
705                 websocket_bad_request(ser);
706                 return 0;
707         }
708
709         /* Determine how to respond depending on the version */
710         if (version == 7 || version == 8 || version == 13) {
711                 char base64[64];
712
713                 if (!key || strlen(key) + strlen(WEBSOCKET_GUID) + 1 > 8192) { /* no stack overflows please */
714                         websocket_bad_request(ser);
715                         ao2_ref(protocol_handler, -1);
716                         return 0;
717                 }
718
719                 if (ast_http_body_discard(ser)) {
720                         websocket_bad_request(ser);
721                         ao2_ref(protocol_handler, -1);
722                         return 0;
723                 }
724
725                 if (!(session = ao2_alloc(sizeof(*session), session_destroy_fn))) {
726                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted\n",
727                                 ast_sockaddr_stringify(&ser->remote_address));
728                         websocket_bad_request(ser);
729                         ao2_ref(protocol_handler, -1);
730                         return 0;
731                 }
732                 session->timeout =  AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT;
733
734                 fprintf(ser->f, "HTTP/1.1 101 Switching Protocols\r\n"
735                         "Upgrade: %s\r\n"
736                         "Connection: Upgrade\r\n"
737                         "Sec-WebSocket-Accept: %s\r\n",
738                         upgrade,
739                         websocket_combine_key(key, base64, sizeof(base64)));
740
741                 /* RFC 6455, Section 4.1:
742                  *
743                  * 6. If the response includes a |Sec-WebSocket-Protocol| header
744                  *    field and this header field indicates the use of a
745                  *    subprotocol that was not present in the client's handshake
746                  *    (the server has indicated a subprotocol not requested by
747                  *    the client), the client MUST _Fail the WebSocket
748                  *    Connection_.
749                  */
750                 if (protocol) {
751                         fprintf(ser->f, "Sec-WebSocket-Protocol: %s\r\n",
752                                 protocol);
753                 }
754
755                 fprintf(ser->f, "\r\n");
756                 fflush(ser->f);
757         } else {
758
759                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 or completely unknown */
760                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '%d' chosen\n",
761                         ast_sockaddr_stringify(&ser->remote_address), version ? version : 75);
762                 websocket_bad_request(ser);
763                 ao2_ref(protocol_handler, -1);
764                 return 0;
765         }
766
767         /* Enable keepalive on all sessions so the underlying user does not have to */
768         if (setsockopt(ser->fd, SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
769                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - failed to enable keepalive\n",
770                         ast_sockaddr_stringify(&ser->remote_address));
771                 websocket_bad_request(ser);
772                 ao2_ref(session, -1);
773                 ao2_ref(protocol_handler, -1);
774                 return 0;
775         }
776
777         ast_verb(2, "WebSocket connection from '%s' for protocol '%s' accepted using version '%d'\n", ast_sockaddr_stringify(&ser->remote_address), protocol ? : "", version);
778
779         /* Populate the session with all the needed details */
780         session->f = ser->f;
781         session->fd = ser->fd;
782         ast_sockaddr_copy(&session->address, &ser->remote_address);
783         session->opcode = -1;
784         session->reconstruct = DEFAULT_RECONSTRUCTION_CEILING;
785         session->secure = ser->ssl ? 1 : 0;
786
787         /* Give up ownership of the socket and pass it to the protocol handler */
788         ast_tcptls_stream_set_exclusive_input(ser->stream_cookie, 0);
789         protocol_handler->callback(session, get_vars, headers);
790         ao2_ref(protocol_handler, -1);
791
792         /*
793          * By dropping the FILE* and fd from the session the connection
794          * won't get closed when the HTTP server cleans up because we
795          * passed the connection to the protocol handler.
796          */
797         ser->f = NULL;
798         ser->fd = -1;
799
800         return 0;
801 }
802
803 static struct ast_http_uri websocketuri = {
804         .callback = AST_OPTIONAL_API_NAME(ast_websocket_uri_cb),
805         .description = "Asterisk HTTP WebSocket",
806         .uri = "ws",
807         .has_subtree = 0,
808         .data = NULL,
809         .key = __FILE__,
810 };
811
812 /*! \brief Simple echo implementation which echoes received text and binary frames */
813 static void websocket_echo_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
814 {
815         int flags, res;
816
817         ast_debug(1, "Entering WebSocket echo loop\n");
818
819         if ((flags = fcntl(ast_websocket_fd(session), F_GETFL)) == -1) {
820                 goto end;
821         }
822
823         flags |= O_NONBLOCK;
824
825         if (fcntl(ast_websocket_fd(session), F_SETFL, flags) == -1) {
826                 goto end;
827         }
828
829         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
830                 char *payload;
831                 uint64_t payload_len;
832                 enum ast_websocket_opcode opcode;
833                 int fragmented;
834
835                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
836                         /* We err on the side of caution and terminate the session if any error occurs */
837                         ast_log(LOG_WARNING, "Read failure during WebSocket echo loop\n");
838                         break;
839                 }
840
841                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
842                         ast_websocket_write(session, opcode, payload, payload_len);
843                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
844                         break;
845                 } else {
846                         ast_debug(1, "Ignored WebSocket opcode %u\n", opcode);
847                 }
848         }
849
850 end:
851         ast_debug(1, "Exiting WebSocket echo loop\n");
852         ast_websocket_unref(session);
853 }
854
855 static int websocket_add_protocol_internal(const char *name, ast_websocket_callback callback)
856 {
857         struct ast_websocket_server *ws_server = websocketuri.data;
858         if (!ws_server) {
859                 return -1;
860         }
861         return ast_websocket_server_add_protocol(ws_server, name, callback);
862 }
863
864 int AST_OPTIONAL_API_NAME(ast_websocket_add_protocol)(const char *name, ast_websocket_callback callback)
865 {
866         int res = websocket_add_protocol_internal(name, callback);
867         if (res == 0) {
868                 ast_module_ref(ast_module_info->self);
869         }
870         return res;
871 }
872
873 static int websocket_remove_protocol_internal(const char *name, ast_websocket_callback callback)
874 {
875         struct ast_websocket_server *ws_server = websocketuri.data;
876         if (!ws_server) {
877                 return -1;
878         }
879         return ast_websocket_server_remove_protocol(ws_server, name, callback);
880 }
881
882 int AST_OPTIONAL_API_NAME(ast_websocket_remove_protocol)(const char *name, ast_websocket_callback callback)
883 {
884         int res = websocket_remove_protocol_internal(name, callback);
885         if (res == 0) {
886                 ast_module_unref(ast_module_info->self);
887         }
888         return res;
889 }
890
891 /*! \brief Parse the given uri into a path and remote address.
892  *
893  * Expected uri form: [ws[s]]://<host>[:port][/<path>]
894  *
895  * The returned host will contain the address and optional port while
896  * path will contain everything after the address/port if included.
897  */
898 static int websocket_client_parse_uri(const char *uri, char **host, struct ast_str **path)
899 {
900         struct ast_uri *parsed_uri = ast_uri_parse_websocket(uri);
901
902         if (!parsed_uri) {
903                 return -1;
904         }
905
906         *host = ast_uri_make_host_with_port(parsed_uri);
907
908         if (ast_uri_path(parsed_uri) || ast_uri_query(parsed_uri)) {
909                 *path = ast_str_create(64);
910                 if (!*path) {
911                         ao2_ref(parsed_uri, -1);
912                         return -1;
913                 }
914
915                 if (ast_uri_path(parsed_uri)) {
916                         ast_str_set(path, 0, "%s", ast_uri_path(parsed_uri));
917                 }
918
919                 if (ast_uri_query(parsed_uri)) {
920                         ast_str_append(path, 0, "?%s", ast_uri_query(parsed_uri));
921                 }
922         }
923
924         ao2_ref(parsed_uri, -1);
925         return 0;
926 }
927
928 static void websocket_client_args_destroy(void *obj)
929 {
930         struct ast_tcptls_session_args *args = obj;
931
932         if (args->tls_cfg) {
933                 ast_free(args->tls_cfg->certfile);
934                 ast_free(args->tls_cfg->pvtfile);
935                 ast_free(args->tls_cfg->cipher);
936                 ast_free(args->tls_cfg->cafile);
937                 ast_free(args->tls_cfg->capath);
938
939                 ast_ssl_teardown(args->tls_cfg);
940         }
941         ast_free(args->tls_cfg);
942 }
943
944 static struct ast_tcptls_session_args *websocket_client_args_create(
945         const char *host, struct ast_tls_config *tls_cfg,
946         enum ast_websocket_result *result)
947 {
948         struct ast_sockaddr *addr;
949         struct ast_tcptls_session_args *args = ao2_alloc(
950                 sizeof(*args), websocket_client_args_destroy);
951
952         if (!args) {
953                 *result = WS_ALLOCATE_ERROR;
954                 return NULL;
955         }
956
957         args->accept_fd = -1;
958         args->tls_cfg = tls_cfg;
959         args->name = "websocket client";
960
961         if (!ast_sockaddr_resolve(&addr, host, 0, 0)) {
962                 ast_log(LOG_ERROR, "Unable to resolve address %s\n",
963                         host);
964                 ao2_ref(args, -1);
965                 *result = WS_URI_RESOLVE_ERROR;
966                 return NULL;
967         }
968         ast_sockaddr_copy(&args->remote_address, addr);
969         ast_free(addr);
970         return args;
971 }
972
973 static char *websocket_client_create_key(void)
974 {
975         static int encoded_size = CLIENT_KEY_SIZE * 2 * sizeof(char) + 1;
976         /* key is randomly selected 16-byte base64 encoded value */
977         unsigned char key[CLIENT_KEY_SIZE + sizeof(long) - 1];
978         char *encoded = ast_malloc(encoded_size);
979         long i = 0;
980
981         if (!encoded) {
982                 ast_log(LOG_ERROR, "Unable to allocate client websocket key\n");
983                 return NULL;
984         }
985
986         while (i < CLIENT_KEY_SIZE) {
987                 long num = ast_random();
988                 memcpy(key + i, &num, sizeof(long));
989                 i += sizeof(long);
990         }
991
992         ast_base64encode(encoded, key, CLIENT_KEY_SIZE, encoded_size);
993         return encoded;
994 }
995
996 struct websocket_client {
997         /*! host portion of client uri */
998         char *host;
999         /*! path for logical websocket connection */
1000         struct ast_str *resource_name;
1001         /*! unique key used during server handshaking */
1002         char *key;
1003         /*! container for registered protocols */
1004         char *protocols;
1005         /*! the protocol accepted by the server */
1006         char *accept_protocol;
1007         /*! websocket protocol version */
1008         int version;
1009         /*! tcptls connection arguments */
1010         struct ast_tcptls_session_args *args;
1011         /*! tcptls connection instance */
1012         struct ast_tcptls_session_instance *ser;
1013 };
1014
1015 static void websocket_client_destroy(void *obj)
1016 {
1017         struct websocket_client *client = obj;
1018
1019         ao2_cleanup(client->ser);
1020         ao2_cleanup(client->args);
1021
1022         ast_free(client->accept_protocol);
1023         ast_free(client->protocols);
1024         ast_free(client->key);
1025         ast_free(client->resource_name);
1026         ast_free(client->host);
1027 }
1028
1029 static struct ast_websocket * websocket_client_create(
1030         const char *uri, const char *protocols, struct ast_tls_config *tls_cfg,
1031         enum ast_websocket_result *result)
1032 {
1033         struct ast_websocket *ws = ao2_alloc(sizeof(*ws), session_destroy_fn);
1034
1035         if (!ws) {
1036                 ast_log(LOG_ERROR, "Unable to allocate websocket\n");
1037                 *result = WS_ALLOCATE_ERROR;
1038                 return NULL;
1039         }
1040
1041         if (!(ws->client = ao2_alloc(
1042                       sizeof(*ws->client), websocket_client_destroy))) {
1043                 ast_log(LOG_ERROR, "Unable to allocate websocket client\n");
1044                 *result = WS_ALLOCATE_ERROR;
1045                 return NULL;
1046         }
1047
1048         if (!(ws->client->key = websocket_client_create_key())) {
1049                 ao2_ref(ws, -1);
1050                 *result = WS_KEY_ERROR;
1051                 return NULL;
1052         }
1053
1054         if (websocket_client_parse_uri(
1055                     uri, &ws->client->host, &ws->client->resource_name)) {
1056                 ao2_ref(ws, -1);
1057                 *result = WS_URI_PARSE_ERROR;
1058                 return NULL;
1059         }
1060
1061         if (!(ws->client->args = websocket_client_args_create(
1062                       ws->client->host, tls_cfg, result))) {
1063                 ao2_ref(ws, -1);
1064                 return NULL;
1065         }
1066         ws->client->protocols = ast_strdup(protocols);
1067
1068         ws->client->version = 13;
1069         ws->opcode = -1;
1070         ws->reconstruct = DEFAULT_RECONSTRUCTION_CEILING;
1071         return ws;
1072 }
1073
1074 const char * AST_OPTIONAL_API_NAME(
1075         ast_websocket_client_accept_protocol)(struct ast_websocket *ws)
1076 {
1077         return ws->client->accept_protocol;
1078 }
1079
1080 static enum ast_websocket_result websocket_client_handle_response_code(
1081         struct websocket_client *client, int response_code)
1082 {
1083         if (response_code <= 0) {
1084                 return WS_INVALID_RESPONSE;
1085         }
1086
1087         switch (response_code) {
1088         case 101:
1089                 return 0;
1090         case 400:
1091                 ast_log(LOG_ERROR, "Received response 400 - Bad Request "
1092                         "- from %s\n", client->host);
1093                 return WS_BAD_REQUEST;
1094         case 404:
1095                 ast_log(LOG_ERROR, "Received response 404 - Request URL not "
1096                         "found - from %s\n", client->host);
1097                 return WS_URL_NOT_FOUND;
1098         }
1099
1100         ast_log(LOG_ERROR, "Invalid HTTP response code %d from %s\n",
1101                 response_code, client->host);
1102         return WS_INVALID_RESPONSE;
1103 }
1104
1105 static enum ast_websocket_result websocket_client_handshake_get_response(
1106         struct websocket_client *client)
1107 {
1108         enum ast_websocket_result res;
1109         char buf[4096];
1110         char base64[64];
1111         int has_upgrade = 0;
1112         int has_connection = 0;
1113         int has_accept = 0;
1114         int has_protocol = 0;
1115
1116         if (!fgets(buf, sizeof(buf), client->ser->f)) {
1117                 ast_log(LOG_ERROR, "Unable to retrieve HTTP status line.");
1118                 return WS_BAD_STATUS;
1119         }
1120
1121         if ((res = websocket_client_handle_response_code(client,
1122                     ast_http_response_status_line(
1123                             buf, "HTTP/1.1", 101))) != WS_OK) {
1124                 return res;
1125         }
1126
1127         /* Ignoring line folding - assuming header field values are contained
1128            within a single line */
1129         while (fgets(buf, sizeof(buf), client->ser->f)) {
1130                 char *name, *value;
1131                 int parsed = ast_http_header_parse(buf, &name, &value);
1132
1133                 if (parsed < 0) {
1134                         break;
1135                 }
1136
1137                 if (parsed > 0) {
1138                         continue;
1139                 }
1140
1141                 if (!has_upgrade &&
1142                     (has_upgrade = ast_http_header_match(
1143                             name, "upgrade", value, "websocket")) < 0) {
1144                         return WS_HEADER_MISMATCH;
1145                 } else if (!has_connection &&
1146                            (has_connection = ast_http_header_match(
1147                                    name, "connection", value, "upgrade")) < 0) {
1148                         return WS_HEADER_MISMATCH;
1149                 } else if (!has_accept &&
1150                            (has_accept = ast_http_header_match(
1151                                    name, "sec-websocket-accept", value,
1152                             websocket_combine_key(
1153                                     client->key, base64, sizeof(base64)))) < 0) {
1154                         return WS_HEADER_MISMATCH;
1155                 } else if (!has_protocol &&
1156                            (has_protocol = ast_http_header_match_in(
1157                                    name, "sec-websocket-protocol", value, client->protocols))) {
1158                         if (has_protocol < 0) {
1159                                 return WS_HEADER_MISMATCH;
1160                         }
1161                         client->accept_protocol = ast_strdup(value);
1162                 } else if (!strcasecmp(name, "sec-websocket-extensions")) {
1163                         ast_log(LOG_ERROR, "Extensions received, but not "
1164                                 "supported by client\n");
1165                         return WS_NOT_SUPPORTED;
1166                 }
1167         }
1168         return has_upgrade && has_connection && has_accept ?
1169                 WS_OK : WS_HEADER_MISSING;
1170 }
1171
1172 static enum ast_websocket_result websocket_client_handshake(
1173         struct websocket_client *client)
1174 {
1175         char protocols[100] = "";
1176
1177         if (!ast_strlen_zero(client->protocols)) {
1178                 sprintf(protocols, "Sec-WebSocket-Protocol: %s\r\n",
1179                         client->protocols);
1180         }
1181
1182         if (fprintf(client->ser->f,
1183                     "GET /%s HTTP/1.1\r\n"
1184                     "Sec-WebSocket-Version: %d\r\n"
1185                     "Upgrade: websocket\r\n"
1186                     "Connection: Upgrade\r\n"
1187                     "Host: %s\r\n"
1188                     "Sec-WebSocket-Key: %s\r\n"
1189                     "%s\r\n",
1190                     client->resource_name ? ast_str_buffer(client->resource_name) : "",
1191                     client->version,
1192                     client->host,
1193                     client->key,
1194                     protocols) < 0) {
1195                 ast_log(LOG_ERROR, "Failed to send handshake.\n");
1196                 return WS_WRITE_ERROR;
1197         }
1198         /* wait for a response before doing anything else */
1199         return websocket_client_handshake_get_response(client);
1200 }
1201
1202 static enum ast_websocket_result websocket_client_connect(struct ast_websocket *ws)
1203 {
1204         enum ast_websocket_result res;
1205         /* create and connect the client - note client_start
1206            releases the session instance on failure */
1207         if (!(ws->client->ser = ast_tcptls_client_start(
1208                       ast_tcptls_client_create(ws->client->args)))) {
1209                 return WS_CLIENT_START_ERROR;
1210         }
1211
1212         if ((res = websocket_client_handshake(ws->client)) != WS_OK) {
1213                 ao2_ref(ws->client->ser, -1);
1214                 ws->client->ser = NULL;
1215                 return res;
1216         }
1217
1218         ws->f = ws->client->ser->f;
1219         ws->fd = ws->client->ser->fd;
1220         ws->secure = ws->client->ser->ssl ? 1 : 0;
1221         ast_sockaddr_copy(&ws->address, &ws->client->ser->remote_address);
1222         return WS_OK;
1223 }
1224
1225 struct ast_websocket *AST_OPTIONAL_API_NAME(ast_websocket_client_create)
1226         (const char *uri, const char *protocols, struct ast_tls_config *tls_cfg,
1227          enum ast_websocket_result *result)
1228 {
1229         struct ast_websocket *ws = websocket_client_create(
1230                 uri, protocols, tls_cfg, result);
1231
1232         if (!ws) {
1233                 return NULL;
1234         }
1235
1236         if ((*result = websocket_client_connect(ws)) != WS_OK) {
1237                 ao2_ref(ws, -1);
1238                 return NULL;
1239         }
1240
1241         return ws;
1242 }
1243
1244 int AST_OPTIONAL_API_NAME(ast_websocket_read_string)
1245         (struct ast_websocket *ws, char **buf)
1246 {
1247         char *payload;
1248         uint64_t payload_len;
1249         enum ast_websocket_opcode opcode;
1250         int fragmented = 1;
1251
1252         while (fragmented) {
1253                 if (ast_websocket_read(ws, &payload, &payload_len,
1254                                        &opcode, &fragmented)) {
1255                         ast_log(LOG_ERROR, "Client WebSocket string read - "
1256                                 "error reading string data\n");
1257                         return -1;
1258                 }
1259
1260                 if (opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
1261                         continue;
1262                 }
1263
1264                 if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
1265                         return -1;
1266                 }
1267
1268                 if (opcode != AST_WEBSOCKET_OPCODE_TEXT) {
1269                         ast_log(LOG_ERROR, "Client WebSocket string read - "
1270                                 "non string data received\n");
1271                         return -1;
1272                 }
1273         }
1274
1275         if (!(*buf = ast_malloc(payload_len + 1))) {
1276                 return -1;
1277         }
1278
1279         ast_copy_string(*buf, payload, payload_len + 1);
1280         return payload_len + 1;
1281 }
1282
1283 int AST_OPTIONAL_API_NAME(ast_websocket_write_string)
1284         (struct ast_websocket *ws, const char *buf)
1285 {
1286         return ast_websocket_write(ws, AST_WEBSOCKET_OPCODE_TEXT,
1287                                    (char *)buf, strlen(buf));
1288 }
1289
1290 static int load_module(void)
1291 {
1292         websocketuri.data = websocket_server_internal_create();
1293         if (!websocketuri.data) {
1294                 return AST_MODULE_LOAD_FAILURE;
1295         }
1296         ast_http_uri_link(&websocketuri);
1297         websocket_add_protocol_internal("echo", websocket_echo_callback);
1298
1299         return 0;
1300 }
1301
1302 static int unload_module(void)
1303 {
1304         websocket_remove_protocol_internal("echo", websocket_echo_callback);
1305         ast_http_uri_unlink(&websocketuri);
1306         ao2_ref(websocketuri.data, -1);
1307         websocketuri.data = NULL;
1308
1309         return 0;
1310 }
1311
1312 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "HTTP WebSocket Support",
1313                 .support_level = AST_MODULE_SUPPORT_EXTENDED,
1314                 .load = load_module,
1315                 .unload = unload_module,
1316                 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
1317         );