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