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