res/res_pjsip/pjsip_options.c: Eliminate excessive RAII_VAR usage.
[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 = 0;
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, sizeof(*frame));
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                 return -1;
311         }
312
313         if (ast_careful_fwrite(session->f, session->fd, payload, actual_length, session->timeout)) {
314                 ao2_unlock(session);
315                 return -1;
316         }
317         fflush(session->f);
318         ao2_unlock(session);
319
320         return 0;
321 }
322
323 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_enable)(struct ast_websocket *session, size_t bytes)
324 {
325         session->reconstruct = MIN(bytes, MAXIMUM_RECONSTRUCTION_CEILING);
326 }
327
328 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_disable)(struct ast_websocket *session)
329 {
330         session->reconstruct = 0;
331 }
332
333 void AST_OPTIONAL_API_NAME(ast_websocket_ref)(struct ast_websocket *session)
334 {
335         ao2_ref(session, +1);
336 }
337
338 void AST_OPTIONAL_API_NAME(ast_websocket_unref)(struct ast_websocket *session)
339 {
340         ao2_cleanup(session);
341 }
342
343 int AST_OPTIONAL_API_NAME(ast_websocket_fd)(struct ast_websocket *session)
344 {
345         return session->closing ? -1 : session->fd;
346 }
347
348 struct ast_sockaddr * AST_OPTIONAL_API_NAME(ast_websocket_remote_address)(struct ast_websocket *session)
349 {
350         return &session->address;
351 }
352
353 int AST_OPTIONAL_API_NAME(ast_websocket_is_secure)(struct ast_websocket *session)
354 {
355         return session->secure;
356 }
357
358 int AST_OPTIONAL_API_NAME(ast_websocket_set_nonblock)(struct ast_websocket *session)
359 {
360         int flags;
361
362         if ((flags = fcntl(session->fd, F_GETFL)) == -1) {
363                 return -1;
364         }
365
366         flags |= O_NONBLOCK;
367
368         if ((flags = fcntl(session->fd, F_SETFL, flags)) == -1) {
369                 return -1;
370         }
371
372         return 0;
373 }
374
375 int AST_OPTIONAL_API_NAME(ast_websocket_set_timeout)(struct ast_websocket *session, int timeout)
376 {
377         session->timeout = timeout;
378
379         return 0;
380 }
381
382 /* MAINTENANCE WARNING on ast_websocket_read()!
383  *
384  * We have to keep in mind during this function that the fact that session->fd seems ready
385  * (via poll) does not necessarily mean we have application data ready, because in the case
386  * of an SSL socket, there is some encryption data overhead that needs to be read from the
387  * TCP socket, so poll() may say there are bytes to be read, but whether it is just 1 byte
388  * or N bytes we do not know that, and we do not know how many of those bytes (if any) are
389  * for application data (for us) and not just for the SSL protocol consumption
390  *
391  * There used to be a couple of nasty bugs here that were fixed in last refactoring but I
392  * want to document them so the constraints are clear and we do not re-introduce them:
393  *
394  * - This function would incorrectly assume that fread() would necessarily return more than
395  *   1 byte of data, just because a websocket frame is always >= 2 bytes, but the thing
396  *   is we're dealing with a TCP bitstream here, we could read just one byte and that's normal.
397  *   The problem before was that if just one byte was read, the function bailed out and returned
398  *   an error, effectively dropping the first byte of a websocket frame header!
399  *
400  * - Another subtle bug was that it would just read up to MAX_WS_HDR_SZ (14 bytes) via fread()
401  *   then assume that executing poll() would tell you if there is more to read, but since
402  *   we're dealing with a buffered stream (session->f is a FILE*), poll would say there is
403  *   nothing else to read (in the real tcp socket session->fd) and we would get stuck here
404  *   without processing the rest of the data in session->f internal buffers until another packet
405  *   came on the network to unblock us!
406  *
407  * Note during the header parsing stage we try to read in small chunks just what we need, this
408  * is buffered data anyways, no expensive syscall required most of the time ...
409  */
410 static inline int ws_safe_read(struct ast_websocket *session, char *buf, int len, enum ast_websocket_opcode *opcode)
411 {
412         int sanity;
413         size_t rlen;
414         int xlen = len;
415         char *rbuf = buf;
416         for (sanity = 10; sanity; sanity--) {
417                 clearerr(session->f);
418                 rlen = fread(rbuf, 1, xlen, session->f);
419                 if (0 == rlen && ferror(session->f) && errno != EAGAIN) {
420                         ast_log(LOG_ERROR, "Error reading from web socket: %s\n", strerror(errno));
421                         (*opcode) = AST_WEBSOCKET_OPCODE_CLOSE;
422                         session->closing = 1;
423                         return -1;
424                 }
425                 xlen = (xlen - rlen);
426                 rbuf = rbuf + rlen;
427                 if (0 == xlen) {
428                         break;
429                 }
430                 if (ast_wait_for_input(session->fd, 1000) < 0) {
431                         ast_log(LOG_ERROR, "ast_wait_for_input returned err: %s\n", strerror(errno));
432                         (*opcode) = AST_WEBSOCKET_OPCODE_CLOSE;
433                         session->closing = 1;
434                         return -1;
435                 }
436         }
437         if (!sanity) {
438                 ast_log(LOG_WARNING, "Websocket seems unresponsive, disconnecting ...\n");
439                 (*opcode) = AST_WEBSOCKET_OPCODE_CLOSE;
440                 session->closing = 1;
441                 return -1;
442         }
443         return 0;
444 }
445
446 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)
447 {
448         char buf[MAXIMUM_FRAME_SIZE] = "";
449         int fin = 0;
450         int mask_present = 0;
451         char *mask = NULL, *new_payload = NULL;
452         size_t options_len = 0, frame_size = 0;
453
454         *payload = NULL;
455         *payload_len = 0;
456         *fragmented = 0;
457
458         if (ws_safe_read(session, &buf[0], MIN_WS_HDR_SZ, opcode)) {
459                 return 0;
460         }
461         frame_size += MIN_WS_HDR_SZ;
462
463         /* 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) */
464         *opcode = buf[0] & 0xf;
465         *payload_len = buf[1] & 0x7f;
466         if (*opcode == AST_WEBSOCKET_OPCODE_TEXT || *opcode == AST_WEBSOCKET_OPCODE_BINARY || *opcode == AST_WEBSOCKET_OPCODE_CONTINUATION ||
467             *opcode == AST_WEBSOCKET_OPCODE_PING || *opcode == AST_WEBSOCKET_OPCODE_PONG) {
468                 fin = (buf[0] >> 7) & 1;
469                 mask_present = (buf[1] >> 7) & 1;
470
471                 /* Based on the mask flag and payload length, determine how much more we need to read before start parsing the rest of the header */
472                 options_len += mask_present ? 4 : 0;
473                 options_len += (*payload_len == 126) ? 2 : (*payload_len == 127) ? 8 : 0;
474                 if (options_len) {
475                         /* read the rest of the header options */
476                         if (ws_safe_read(session, &buf[frame_size], options_len, opcode)) {
477                                 return 0;
478                         }
479                         frame_size += options_len;
480                 }
481
482                 if (*payload_len == 126) {
483                         /* Grab the 2-byte payload length  */
484                         *payload_len = ntohs(get_unaligned_uint16(&buf[2]));
485                         mask = &buf[4];
486                 } else if (*payload_len == 127) {
487                         /* Grab the 8-byte payload length  */
488                         *payload_len = ntohl(get_unaligned_uint64(&buf[2]));
489                         mask = &buf[10];
490                 } else {
491                         /* Just set the mask after the small 2-byte header */
492                         mask = &buf[2];
493                 }
494
495                 /* Now read the rest of the payload */
496                 *payload = &buf[frame_size]; /* payload will start here, at the end of the options, if any */
497                 frame_size = frame_size + (*payload_len); /* final frame size is header + optional headers + payload data */
498                 if (frame_size > MAXIMUM_FRAME_SIZE) {
499                         ast_log(LOG_WARNING, "Cannot fit huge websocket frame of %zu bytes\n", frame_size);
500                         /* The frame won't fit :-( */
501                         ast_websocket_close(session, 1009);
502                         return -1;
503                 }
504
505                 if (ws_safe_read(session, (*payload), (*payload_len), opcode)) {
506                         return 0;
507                 }
508                 /* If a mask is present unmask the payload */
509                 if (mask_present) {
510                         unsigned int pos;
511                         for (pos = 0; pos < *payload_len; pos++) {
512                                 (*payload)[pos] ^= mask[pos % 4];
513                         }
514                 }
515
516                 if (!(new_payload = ast_realloc(session->payload, (session->payload_len + *payload_len)))) {
517                         ast_log(LOG_WARNING, "Failed allocation: %p, %zu, %"PRIu64"\n",
518                                 session->payload, session->payload_len, *payload_len);
519                         *payload_len = 0;
520                         ast_websocket_close(session, 1009);
521                         return 0;
522                 }
523
524                 /* Per the RFC for PING we need to send back an opcode with the application data as received */
525                 if ((*opcode == AST_WEBSOCKET_OPCODE_PING) && (ast_websocket_write(session, AST_WEBSOCKET_OPCODE_PONG, *payload, *payload_len))) {
526                         *payload_len = 0;
527                         ast_websocket_close(session, 1009);
528                         return 0;
529                 }
530
531                 session->payload = new_payload;
532                 memcpy((session->payload + session->payload_len), (*payload), (*payload_len));
533                 session->payload_len += *payload_len;
534
535                 if (!fin && session->reconstruct && (session->payload_len < session->reconstruct)) {
536                         /* If this is not a final message we need to defer returning it until later */
537                         if (*opcode != AST_WEBSOCKET_OPCODE_CONTINUATION) {
538                                 session->opcode = *opcode;
539                         }
540                         *opcode = AST_WEBSOCKET_OPCODE_CONTINUATION;
541                         *payload_len = 0;
542                         *payload = NULL;
543                 } else {
544                         if (*opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
545                                 if (!fin) {
546                                         /* If this was not actually the final message tell the user it is fragmented so they can deal with it accordingly */
547                                         *fragmented = 1;
548                                 } else {
549                                         /* Final frame in multi-frame so push up the actual opcode */
550                                         *opcode = session->opcode;
551                                 }
552                         }
553                         *payload_len = session->payload_len;
554                         *payload = session->payload;
555                         session->payload_len = 0;
556                 }
557         } else if (*opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
558                 /* Make the payload available so the user can look at the reason code if they so desire */
559                 if ((*payload_len) && (new_payload = ast_realloc(session->payload, *payload_len))) {
560                         if (ws_safe_read(session, &buf[frame_size], (*payload_len), opcode)) {
561                                 return 0;
562                         }
563                         session->payload = new_payload;
564                         memcpy(session->payload, &buf[frame_size], *payload_len);
565                         *payload = session->payload;
566                         frame_size += (*payload_len);
567                 }
568
569                 session->closing = 1;
570         } else {
571                 ast_log(LOG_WARNING, "WebSocket unknown opcode %u\n", *opcode);
572                 /* 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
573                  * fit that, I think. */
574                 ast_websocket_close(session, 1003);
575         }
576
577         return 0;
578 }
579
580 /*!
581  * \brief If the server has exactly one configured protocol, return it.
582  */
583 static struct websocket_protocol *one_protocol(
584         struct ast_websocket_server *server)
585 {
586         SCOPED_AO2LOCK(lock, server->protocols);
587
588         if (ao2_container_count(server->protocols) != 1) {
589                 return NULL;
590         }
591
592         return ao2_callback(server->protocols, OBJ_NOLOCK, NULL, NULL);
593 }
594
595 static char *websocket_combine_key(const char *key, char *res, int res_size)
596 {
597         char *combined;
598         unsigned combined_length = strlen(key) + strlen(WEBSOCKET_GUID) + 1;
599         uint8_t sha[20];
600
601         combined = ast_alloca(combined_length);
602         snprintf(combined, combined_length, "%s%s", key, WEBSOCKET_GUID);
603         ast_sha1_hash_uint(sha, combined);
604         ast_base64encode(res, (const unsigned char*)sha, 20, res_size);
605         return res;
606 }
607
608 static void websocket_bad_request(struct ast_tcptls_session_instance *ser)
609 {
610         struct ast_str *http_header = ast_str_create(64);
611
612         if (!http_header) {
613                 ast_http_request_close_on_completion(ser);
614                 ast_http_error(ser, 500, "Server Error", "Out of memory");
615                 return;
616         }
617         ast_str_set(&http_header, 0, "Sec-WebSocket-Version: 7, 8, 13\r\n");
618         ast_http_send(ser, AST_HTTP_UNKNOWN, 400, "Bad Request", http_header, NULL, 0, 0);
619 }
620
621 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)
622 {
623         struct ast_variable *v;
624         char *upgrade = NULL, *key = NULL, *key1 = NULL, *key2 = NULL, *protos = NULL, *requested_protocols = NULL, *protocol = NULL;
625         int version = 0, flags = 1;
626         struct websocket_protocol *protocol_handler = NULL;
627         struct ast_websocket *session;
628         struct ast_websocket_server *server;
629
630         SCOPED_MODULE_USE(ast_module_info->self);
631
632         /* Upgrade requests are only permitted on GET methods */
633         if (method != AST_HTTP_GET) {
634                 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
635                 return 0;
636         }
637
638         server = urih->data;
639
640         /* Get the minimum headers required to satisfy our needs */
641         for (v = headers; v; v = v->next) {
642                 if (!strcasecmp(v->name, "Upgrade")) {
643                         upgrade = ast_strip(ast_strdupa(v->value));
644                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key")) {
645                         key = ast_strip(ast_strdupa(v->value));
646                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key1")) {
647                         key1 = ast_strip(ast_strdupa(v->value));
648                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key2")) {
649                         key2 = ast_strip(ast_strdupa(v->value));
650                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Protocol")) {
651                         requested_protocols = ast_strip(ast_strdupa(v->value));
652                         protos = ast_strdupa(requested_protocols);
653                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Version")) {
654                         if (sscanf(v->value, "%30d", &version) != 1) {
655                                 version = 0;
656                         }
657                 }
658         }
659
660         /* If this is not a websocket upgrade abort */
661         if (!upgrade || strcasecmp(upgrade, "websocket")) {
662                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - did not request WebSocket\n",
663                         ast_sockaddr_stringify(&ser->remote_address));
664                 ast_http_error(ser, 426, "Upgrade Required", NULL);
665                 return 0;
666         } else if (ast_strlen_zero(requested_protocols)) {
667                 /* If there's only a single protocol registered, and the
668                  * client doesn't specify what protocol it's using, go ahead
669                  * and accept the connection */
670                 protocol_handler = one_protocol(server);
671                 if (!protocol_handler) {
672                         /* Multiple registered subprotocols; client must specify */
673                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols requested\n",
674                                 ast_sockaddr_stringify(&ser->remote_address));
675                         websocket_bad_request(ser);
676                         return 0;
677                 }
678         } else if (key1 && key2) {
679                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 and
680                  * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00 -- not currently supported*/
681                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '00/76' chosen\n",
682                         ast_sockaddr_stringify(&ser->remote_address));
683                 websocket_bad_request(ser);
684                 return 0;
685         }
686
687         /* Iterate through the requested protocols trying to find one that we have a handler for */
688         while (!protocol_handler && (protocol = strsep(&requested_protocols, ","))) {
689                 protocol_handler = ao2_find(server->protocols, ast_strip(protocol), OBJ_KEY);
690         }
691
692         /* If no protocol handler exists bump this back to the requester */
693         if (!protocol_handler) {
694                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols out of '%s' supported\n",
695                         ast_sockaddr_stringify(&ser->remote_address), protos);
696                 websocket_bad_request(ser);
697                 return 0;
698         }
699
700         /* Determine how to respond depending on the version */
701         if (version == 7 || version == 8 || version == 13) {
702                 char base64[64];
703
704                 if (!key || strlen(key) + strlen(WEBSOCKET_GUID) + 1 > 8192) { /* no stack overflows please */
705                         websocket_bad_request(ser);
706                         ao2_ref(protocol_handler, -1);
707                         return 0;
708                 }
709
710                 if (ast_http_body_discard(ser)) {
711                         websocket_bad_request(ser);
712                         ao2_ref(protocol_handler, -1);
713                         return 0;
714                 }
715
716                 if (!(session = ao2_alloc(sizeof(*session), session_destroy_fn))) {
717                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted\n",
718                                 ast_sockaddr_stringify(&ser->remote_address));
719                         websocket_bad_request(ser);
720                         ao2_ref(protocol_handler, -1);
721                         return 0;
722                 }
723                 session->timeout =  AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT;
724
725                 fprintf(ser->f, "HTTP/1.1 101 Switching Protocols\r\n"
726                         "Upgrade: %s\r\n"
727                         "Connection: Upgrade\r\n"
728                         "Sec-WebSocket-Accept: %s\r\n",
729                         upgrade,
730                         websocket_combine_key(key, base64, sizeof(base64)));
731
732                 /* RFC 6455, Section 4.1:
733                  *
734                  * 6. If the response includes a |Sec-WebSocket-Protocol| header
735                  *    field and this header field indicates the use of a
736                  *    subprotocol that was not present in the client's handshake
737                  *    (the server has indicated a subprotocol not requested by
738                  *    the client), the client MUST _Fail the WebSocket
739                  *    Connection_.
740                  */
741                 if (protocol) {
742                         fprintf(ser->f, "Sec-WebSocket-Protocol: %s\r\n",
743                                 protocol);
744                 }
745
746                 fprintf(ser->f, "\r\n");
747                 fflush(ser->f);
748         } else {
749
750                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 or completely unknown */
751                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '%d' chosen\n",
752                         ast_sockaddr_stringify(&ser->remote_address), version ? version : 75);
753                 websocket_bad_request(ser);
754                 ao2_ref(protocol_handler, -1);
755                 return 0;
756         }
757
758         /* Enable keepalive on all sessions so the underlying user does not have to */
759         if (setsockopt(ser->fd, SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
760                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - failed to enable keepalive\n",
761                         ast_sockaddr_stringify(&ser->remote_address));
762                 websocket_bad_request(ser);
763                 ao2_ref(session, -1);
764                 ao2_ref(protocol_handler, -1);
765                 return 0;
766         }
767
768         ast_verb(2, "WebSocket connection from '%s' for protocol '%s' accepted using version '%d'\n", ast_sockaddr_stringify(&ser->remote_address), protocol ? : "", version);
769
770         /* Populate the session with all the needed details */
771         session->f = ser->f;
772         session->fd = ser->fd;
773         ast_sockaddr_copy(&session->address, &ser->remote_address);
774         session->opcode = -1;
775         session->reconstruct = DEFAULT_RECONSTRUCTION_CEILING;
776         session->secure = ser->ssl ? 1 : 0;
777
778         /* Give up ownership of the socket and pass it to the protocol handler */
779         ast_tcptls_stream_set_exclusive_input(ser->stream_cookie, 0);
780         protocol_handler->callback(session, get_vars, headers);
781         ao2_ref(protocol_handler, -1);
782
783         /*
784          * By dropping the FILE* and fd from the session the connection
785          * won't get closed when the HTTP server cleans up because we
786          * passed the connection to the protocol handler.
787          */
788         ser->f = NULL;
789         ser->fd = -1;
790
791         return 0;
792 }
793
794 static struct ast_http_uri websocketuri = {
795         .callback = AST_OPTIONAL_API_NAME(ast_websocket_uri_cb),
796         .description = "Asterisk HTTP WebSocket",
797         .uri = "ws",
798         .has_subtree = 0,
799         .data = NULL,
800         .key = __FILE__,
801 };
802
803 /*! \brief Simple echo implementation which echoes received text and binary frames */
804 static void websocket_echo_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
805 {
806         int flags, res;
807
808         ast_debug(1, "Entering WebSocket echo loop\n");
809
810         if ((flags = fcntl(ast_websocket_fd(session), F_GETFL)) == -1) {
811                 goto end;
812         }
813
814         flags |= O_NONBLOCK;
815
816         if (fcntl(ast_websocket_fd(session), F_SETFL, flags) == -1) {
817                 goto end;
818         }
819
820         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
821                 char *payload;
822                 uint64_t payload_len;
823                 enum ast_websocket_opcode opcode;
824                 int fragmented;
825
826                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
827                         /* We err on the side of caution and terminate the session if any error occurs */
828                         ast_log(LOG_WARNING, "Read failure during WebSocket echo loop\n");
829                         break;
830                 }
831
832                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
833                         ast_websocket_write(session, opcode, payload, payload_len);
834                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
835                         break;
836                 } else {
837                         ast_debug(1, "Ignored WebSocket opcode %u\n", opcode);
838                 }
839         }
840
841 end:
842         ast_debug(1, "Exitting WebSocket echo loop\n");
843         ast_websocket_unref(session);
844 }
845
846 static int websocket_add_protocol_internal(const char *name, ast_websocket_callback callback)
847 {
848         struct ast_websocket_server *ws_server = websocketuri.data;
849         if (!ws_server) {
850                 return -1;
851         }
852         return ast_websocket_server_add_protocol(ws_server, name, callback);
853 }
854
855 int AST_OPTIONAL_API_NAME(ast_websocket_add_protocol)(const char *name, ast_websocket_callback callback)
856 {
857         int res = websocket_add_protocol_internal(name, callback);
858         if (res == 0) {
859                 ast_module_ref(ast_module_info->self);
860         }
861         return res;
862 }
863
864 static int websocket_remove_protocol_internal(const char *name, ast_websocket_callback callback)
865 {
866         struct ast_websocket_server *ws_server = websocketuri.data;
867         if (!ws_server) {
868                 return -1;
869         }
870         return ast_websocket_server_remove_protocol(ws_server, name, callback);
871 }
872
873 int AST_OPTIONAL_API_NAME(ast_websocket_remove_protocol)(const char *name, ast_websocket_callback callback)
874 {
875         int res = websocket_remove_protocol_internal(name, callback);
876         if (res == 0) {
877                 ast_module_unref(ast_module_info->self);
878         }
879         return res;
880 }
881
882 /*! \brief Parse the given uri into a path and remote address.
883  *
884  * Expected uri form: [ws[s]]://<host>[:port][/<path>]
885  *
886  * The returned host will contain the address and optional port while
887  * path will contain everything after the address/port if included.
888  */
889 static int websocket_client_parse_uri(const char *uri, char **host, struct ast_str **path)
890 {
891         struct ast_uri *parsed_uri = ast_uri_parse_websocket(uri);
892
893         if (!parsed_uri) {
894                 return -1;
895         }
896
897         *host = ast_uri_make_host_with_port(parsed_uri);
898
899         if (ast_uri_path(parsed_uri) || ast_uri_query(parsed_uri)) {
900                 *path = ast_str_create(64);
901                 if (!*path) {
902                         ao2_ref(parsed_uri, -1);
903                         return -1;
904                 }
905
906                 if (ast_uri_path(parsed_uri)) {
907                         ast_str_set(path, 0, "%s", ast_uri_path(parsed_uri));
908                 }
909
910                 if (ast_uri_query(parsed_uri)) {
911                         ast_str_append(path, 0, "?%s", ast_uri_query(parsed_uri));
912                 }
913         }
914
915         ao2_ref(parsed_uri, -1);
916         return 0;
917 }
918
919 static void websocket_client_args_destroy(void *obj)
920 {
921         struct ast_tcptls_session_args *args = obj;
922
923         if (args->tls_cfg) {
924                 ast_free(args->tls_cfg->certfile);
925                 ast_free(args->tls_cfg->pvtfile);
926                 ast_free(args->tls_cfg->cipher);
927                 ast_free(args->tls_cfg->cafile);
928                 ast_free(args->tls_cfg->capath);
929
930                 ast_ssl_teardown(args->tls_cfg);
931         }
932         ast_free(args->tls_cfg);
933 }
934
935 static struct ast_tcptls_session_args *websocket_client_args_create(
936         const char *host, struct ast_tls_config *tls_cfg,
937         enum ast_websocket_result *result)
938 {
939         struct ast_sockaddr *addr;
940         struct ast_tcptls_session_args *args = ao2_alloc(
941                 sizeof(*args), websocket_client_args_destroy);
942
943         if (!args) {
944                 *result = WS_ALLOCATE_ERROR;
945                 return NULL;
946         }
947
948         args->accept_fd = -1;
949         args->tls_cfg = tls_cfg;
950         args->name = "websocket client";
951
952         if (!ast_sockaddr_resolve(&addr, host, 0, 0)) {
953                 ast_log(LOG_ERROR, "Unable to resolve address %s\n",
954                         host);
955                 ao2_ref(args, -1);
956                 *result = WS_URI_RESOLVE_ERROR;
957                 return NULL;
958         }
959         ast_sockaddr_copy(&args->remote_address, addr);
960         ast_free(addr);
961         return args;
962 }
963
964 static char *websocket_client_create_key(void)
965 {
966         static int encoded_size = CLIENT_KEY_SIZE * 2 * sizeof(char) + 1;
967         /* key is randomly selected 16-byte base64 encoded value */
968         unsigned char key[CLIENT_KEY_SIZE + sizeof(long) - 1];
969         char *encoded = ast_malloc(encoded_size);
970         long i = 0;
971
972         if (!encoded) {
973                 ast_log(LOG_ERROR, "Unable to allocate client websocket key\n");
974                 return NULL;
975         }
976
977         while (i < CLIENT_KEY_SIZE) {
978                 long num = ast_random();
979                 memcpy(key + i, &num, sizeof(long));
980                 i += sizeof(long);
981         }
982
983         ast_base64encode(encoded, key, CLIENT_KEY_SIZE, encoded_size);
984         return encoded;
985 }
986
987 struct websocket_client {
988         /*! host portion of client uri */
989         char *host;
990         /*! path for logical websocket connection */
991         struct ast_str *resource_name;
992         /*! unique key used during server handshaking */
993         char *key;
994         /*! container for registered protocols */
995         char *protocols;
996         /*! the protocol accepted by the server */
997         char *accept_protocol;
998         /*! websocket protocol version */
999         int version;
1000         /*! tcptls connection arguments */
1001         struct ast_tcptls_session_args *args;
1002         /*! tcptls connection instance */
1003         struct ast_tcptls_session_instance *ser;
1004 };
1005
1006 static void websocket_client_destroy(void *obj)
1007 {
1008         struct websocket_client *client = obj;
1009
1010         ao2_cleanup(client->ser);
1011         ao2_cleanup(client->args);
1012
1013         ast_free(client->accept_protocol);
1014         ast_free(client->protocols);
1015         ast_free(client->key);
1016         ast_free(client->resource_name);
1017         ast_free(client->host);
1018 }
1019
1020 static struct ast_websocket * websocket_client_create(
1021         const char *uri, const char *protocols, struct ast_tls_config *tls_cfg,
1022         enum ast_websocket_result *result)
1023 {
1024         struct ast_websocket *ws = ao2_alloc(sizeof(*ws), session_destroy_fn);
1025
1026         if (!ws) {
1027                 ast_log(LOG_ERROR, "Unable to allocate websocket\n");
1028                 *result = WS_ALLOCATE_ERROR;
1029                 return NULL;
1030         }
1031
1032         if (!(ws->client = ao2_alloc(
1033                       sizeof(*ws->client), websocket_client_destroy))) {
1034                 ast_log(LOG_ERROR, "Unable to allocate websocket client\n");
1035                 *result = WS_ALLOCATE_ERROR;
1036                 return NULL;
1037         }
1038
1039         if (!(ws->client->key = websocket_client_create_key())) {
1040                 ao2_ref(ws, -1);
1041                 *result = WS_KEY_ERROR;
1042                 return NULL;
1043         }
1044
1045         if (websocket_client_parse_uri(
1046                     uri, &ws->client->host, &ws->client->resource_name)) {
1047                 ao2_ref(ws, -1);
1048                 *result = WS_URI_PARSE_ERROR;
1049                 return NULL;
1050         }
1051
1052         if (!(ws->client->args = websocket_client_args_create(
1053                       ws->client->host, tls_cfg, result))) {
1054                 ao2_ref(ws, -1);
1055                 return NULL;
1056         }
1057         ws->client->protocols = ast_strdup(protocols);
1058
1059         ws->client->version = 13;
1060         ws->opcode = -1;
1061         ws->reconstruct = DEFAULT_RECONSTRUCTION_CEILING;
1062         return ws;
1063 }
1064
1065 const char * AST_OPTIONAL_API_NAME(
1066         ast_websocket_client_accept_protocol)(struct ast_websocket *ws)
1067 {
1068         return ws->client->accept_protocol;
1069 }
1070
1071 static enum ast_websocket_result websocket_client_handle_response_code(
1072         struct websocket_client *client, int response_code)
1073 {
1074         if (response_code <= 0) {
1075                 return WS_INVALID_RESPONSE;
1076         }
1077
1078         switch (response_code) {
1079         case 101:
1080                 return 0;
1081         case 400:
1082                 ast_log(LOG_ERROR, "Received response 400 - Bad Request "
1083                         "- from %s\n", client->host);
1084                 return WS_BAD_REQUEST;
1085         case 404:
1086                 ast_log(LOG_ERROR, "Received response 404 - Request URL not "
1087                         "found - from %s\n", client->host);
1088                 return WS_URL_NOT_FOUND;
1089         }
1090
1091         ast_log(LOG_ERROR, "Invalid HTTP response code %d from %s\n",
1092                 response_code, client->host);
1093         return WS_INVALID_RESPONSE;
1094 }
1095
1096 static enum ast_websocket_result websocket_client_handshake_get_response(
1097         struct websocket_client *client)
1098 {
1099         enum ast_websocket_result res;
1100         char buf[4096];
1101         char base64[64];
1102         int has_upgrade = 0;
1103         int has_connection = 0;
1104         int has_accept = 0;
1105         int has_protocol = 0;
1106
1107         if (!fgets(buf, sizeof(buf), client->ser->f)) {
1108                 ast_log(LOG_ERROR, "Unable to retrieve HTTP status line.");
1109                 return WS_BAD_STATUS;
1110         }
1111
1112         if ((res = websocket_client_handle_response_code(client,
1113                     ast_http_response_status_line(
1114                             buf, "HTTP/1.1", 101))) != WS_OK) {
1115                 return res;
1116         }
1117
1118         /* Ignoring line folding - assuming header field values are contained
1119            within a single line */
1120         while (fgets(buf, sizeof(buf), client->ser->f)) {
1121                 char *name, *value;
1122                 int parsed = ast_http_header_parse(buf, &name, &value);
1123
1124                 if (parsed < 0) {
1125                         break;
1126                 }
1127
1128                 if (parsed > 0) {
1129                         continue;
1130                 }
1131
1132                 if (!has_upgrade &&
1133                     (has_upgrade = ast_http_header_match(
1134                             name, "upgrade", value, "websocket")) < 0) {
1135                         return WS_HEADER_MISMATCH;
1136                 } else if (!has_connection &&
1137                            (has_connection = ast_http_header_match(
1138                                    name, "connection", value, "upgrade")) < 0) {
1139                         return WS_HEADER_MISMATCH;
1140                 } else if (!has_accept &&
1141                            (has_accept = ast_http_header_match(
1142                                    name, "sec-websocket-accept", value,
1143                             websocket_combine_key(
1144                                     client->key, base64, sizeof(base64)))) < 0) {
1145                         return WS_HEADER_MISMATCH;
1146                 } else if (!has_protocol &&
1147                            (has_protocol = ast_http_header_match_in(
1148                                    name, "sec-websocket-protocol", value, client->protocols))) {
1149                         if (has_protocol < 0) {
1150                                 return WS_HEADER_MISMATCH;
1151                         }
1152                         client->accept_protocol = ast_strdup(value);
1153                 } else if (!strcasecmp(name, "sec-websocket-extensions")) {
1154                         ast_log(LOG_ERROR, "Extensions received, but not "
1155                                 "supported by client\n");
1156                         return WS_NOT_SUPPORTED;
1157                 }
1158         }
1159         return has_upgrade && has_connection && has_accept ?
1160                 WS_OK : WS_HEADER_MISSING;
1161 }
1162
1163 static enum ast_websocket_result websocket_client_handshake(
1164         struct websocket_client *client)
1165 {
1166         char protocols[100] = "";
1167
1168         if (!ast_strlen_zero(client->protocols)) {
1169                 sprintf(protocols, "Sec-WebSocket-Protocol: %s\r\n",
1170                         client->protocols);
1171         }
1172
1173         if (fprintf(client->ser->f,
1174                     "GET /%s HTTP/1.1\r\n"
1175                     "Sec-WebSocket-Version: %d\r\n"
1176                     "Upgrade: websocket\r\n"
1177                     "Connection: Upgrade\r\n"
1178                     "Host: %s\r\n"
1179                     "Sec-WebSocket-Key: %s\r\n"
1180                     "%s\r\n",
1181                     client->resource_name ? ast_str_buffer(client->resource_name) : "",
1182                     client->version,
1183                     client->host,
1184                     client->key,
1185                     protocols) < 0) {
1186                 ast_log(LOG_ERROR, "Failed to send handshake.\n");
1187                 return WS_WRITE_ERROR;
1188         }
1189         /* wait for a response before doing anything else */
1190         return websocket_client_handshake_get_response(client);
1191 }
1192
1193 static enum ast_websocket_result websocket_client_connect(struct ast_websocket *ws)
1194 {
1195         enum ast_websocket_result res;
1196         /* create and connect the client - note client_start
1197            releases the session instance on failure */
1198         if (!(ws->client->ser = ast_tcptls_client_start(
1199                       ast_tcptls_client_create(ws->client->args)))) {
1200                 return WS_CLIENT_START_ERROR;
1201         }
1202
1203         if ((res = websocket_client_handshake(ws->client)) != WS_OK) {
1204                 ao2_ref(ws->client->ser, -1);
1205                 ws->client->ser = NULL;
1206                 return res;
1207         }
1208
1209         ws->f = ws->client->ser->f;
1210         ws->fd = ws->client->ser->fd;
1211         ws->secure = ws->client->ser->ssl ? 1 : 0;
1212         ast_sockaddr_copy(&ws->address, &ws->client->ser->remote_address);
1213         return WS_OK;
1214 }
1215
1216 struct ast_websocket *AST_OPTIONAL_API_NAME(ast_websocket_client_create)
1217         (const char *uri, const char *protocols, struct ast_tls_config *tls_cfg,
1218          enum ast_websocket_result *result)
1219 {
1220         struct ast_websocket *ws = websocket_client_create(
1221                 uri, protocols, tls_cfg, result);
1222
1223         if (!ws) {
1224                 return NULL;
1225         }
1226
1227         if ((*result = websocket_client_connect(ws)) != WS_OK) {
1228                 ao2_ref(ws, -1);
1229                 return NULL;
1230         }
1231
1232         return ws;
1233 }
1234
1235 int AST_OPTIONAL_API_NAME(ast_websocket_read_string)
1236         (struct ast_websocket *ws, char **buf)
1237 {
1238         char *payload;
1239         uint64_t payload_len;
1240         enum ast_websocket_opcode opcode;
1241         int fragmented = 1;
1242
1243         while (fragmented) {
1244                 if (ast_websocket_read(ws, &payload, &payload_len,
1245                                        &opcode, &fragmented)) {
1246                         ast_log(LOG_ERROR, "Client WebSocket string read - "
1247                                 "error reading string data\n");
1248                         return -1;
1249                 }
1250
1251                 if (opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
1252                         continue;
1253                 }
1254
1255                 if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
1256                         return -1;
1257                 }
1258
1259                 if (opcode != AST_WEBSOCKET_OPCODE_TEXT) {
1260                         ast_log(LOG_ERROR, "Client WebSocket string read - "
1261                                 "non string data received\n");
1262                         return -1;
1263                 }
1264         }
1265
1266         if (!(*buf = ast_malloc(payload_len + 1))) {
1267                 return -1;
1268         }
1269
1270         ast_copy_string(*buf, payload, payload_len + 1);
1271         return payload_len + 1;
1272 }
1273
1274 int AST_OPTIONAL_API_NAME(ast_websocket_write_string)
1275         (struct ast_websocket *ws, const char *buf)
1276 {
1277         return ast_websocket_write(ws, AST_WEBSOCKET_OPCODE_TEXT,
1278                                    (char *)buf, strlen(buf));
1279 }
1280
1281 static int load_module(void)
1282 {
1283         websocketuri.data = websocket_server_internal_create();
1284         if (!websocketuri.data) {
1285                 return AST_MODULE_LOAD_FAILURE;
1286         }
1287         ast_http_uri_link(&websocketuri);
1288         websocket_add_protocol_internal("echo", websocket_echo_callback);
1289
1290         return 0;
1291 }
1292
1293 static int unload_module(void)
1294 {
1295         ast_websocket_remove_protocol("echo", websocket_echo_callback);
1296         ast_http_uri_unlink(&websocketuri);
1297         ao2_ref(websocketuri.data, -1);
1298         websocketuri.data = NULL;
1299
1300         return 0;
1301 }
1302
1303 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "HTTP WebSocket Support",
1304                 .support_level = AST_MODULE_SUPPORT_EXTENDED,
1305                 .load = load_module,
1306                 .unload = unload_module,
1307                 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
1308         );