pjsip / hep: Provide correct local address for Websockets.
[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 };
103
104 /*! \brief Hashing function for protocols */
105 static int protocol_hash_fn(const void *obj, const int flags)
106 {
107         const struct ast_websocket_protocol *protocol = obj;
108         const char *name = obj;
109
110         return ast_str_case_hash(flags & OBJ_KEY ? name : protocol->name);
111 }
112
113 /*! \brief Comparison function for protocols */
114 static int protocol_cmp_fn(void *obj, void *arg, int flags)
115 {
116         const struct ast_websocket_protocol *protocol1 = obj, *protocol2 = arg;
117         const char *protocol = arg;
118
119         return !strcasecmp(protocol1->name, flags & OBJ_KEY ? protocol : protocol2->name) ? CMP_MATCH | CMP_STOP : 0;
120 }
121
122 /*! \brief Destructor function for protocols */
123 static void protocol_destroy_fn(void *obj)
124 {
125         struct ast_websocket_protocol *protocol = obj;
126         ast_free(protocol->name);
127 }
128
129 /*! \brief Structure for a WebSocket server */
130 struct ast_websocket_server {
131         struct ao2_container *protocols; /*!< Container for registered protocols */
132 };
133
134 static void websocket_server_internal_dtor(void *obj)
135 {
136         struct ast_websocket_server *server = obj;
137         ao2_cleanup(server->protocols);
138         server->protocols = NULL;
139 }
140
141 static void websocket_server_dtor(void *obj)
142 {
143         websocket_server_internal_dtor(obj);
144         ast_module_unref(ast_module_info->self);
145 }
146
147 static struct ast_websocket_server *websocket_server_create_impl(void (*dtor)(void *))
148 {
149         RAII_VAR(struct ast_websocket_server *, server, NULL, ao2_cleanup);
150
151         server = ao2_alloc(sizeof(*server), dtor);
152         if (!server) {
153                 return NULL;
154         }
155
156         server->protocols = ao2_container_alloc(MAX_PROTOCOL_BUCKETS, protocol_hash_fn, protocol_cmp_fn);
157         if (!server->protocols) {
158                 return NULL;
159         }
160
161         ao2_ref(server, +1);
162         return server;
163 }
164
165 static struct ast_websocket_server *websocket_server_internal_create(void)
166 {
167         return websocket_server_create_impl(websocket_server_internal_dtor);
168 }
169
170 struct ast_websocket_server *AST_OPTIONAL_API_NAME(ast_websocket_server_create)(void)
171 {
172         ast_module_ref(ast_module_info->self);
173         return websocket_server_create_impl(websocket_server_dtor);
174 }
175
176 /*! \brief Destructor function for sessions */
177 static void session_destroy_fn(void *obj)
178 {
179         struct ast_websocket *session = obj;
180
181         if (session->stream) {
182                 ast_websocket_close(session, 0);
183                 if (session->stream) {
184                         ast_iostream_close(session->stream);
185                         session->stream = NULL;
186                         ast_verb(2, "WebSocket connection %s '%s' closed\n", session->client ? "to" : "from",
187                                 ast_sockaddr_stringify(&session->remote_address));
188                 }
189         }
190
191         ao2_cleanup(session->client);
192         ast_free(session->payload);
193 }
194
195 struct ast_websocket_protocol *AST_OPTIONAL_API_NAME(ast_websocket_sub_protocol_alloc)(const char *name)
196 {
197         struct ast_websocket_protocol *protocol;
198
199         protocol = ao2_alloc(sizeof(*protocol), protocol_destroy_fn);
200         if (!protocol) {
201                 return NULL;
202         }
203
204         protocol->name = ast_strdup(name);
205         if (!protocol->name) {
206                 ao2_ref(protocol, -1);
207                 return NULL;
208         }
209         protocol->version = AST_WEBSOCKET_PROTOCOL_VERSION;
210
211         return protocol;
212 }
213
214 int AST_OPTIONAL_API_NAME(ast_websocket_server_add_protocol)(struct ast_websocket_server *server, const char *name, ast_websocket_callback callback)
215 {
216         struct ast_websocket_protocol *protocol;
217
218         if (!server->protocols) {
219                 return -1;
220         }
221
222         protocol = ast_websocket_sub_protocol_alloc(name);
223         if (!protocol) {
224                 return -1;
225         }
226         protocol->session_established = callback;
227
228         if (ast_websocket_server_add_protocol2(server, protocol)) {
229                 ao2_ref(protocol, -1);
230                 return -1;
231         }
232
233         return 0;
234 }
235
236 int AST_OPTIONAL_API_NAME(ast_websocket_server_add_protocol2)(struct ast_websocket_server *server, struct ast_websocket_protocol *protocol)
237 {
238         struct ast_websocket_protocol *existing;
239
240         if (!server->protocols) {
241                 return -1;
242         }
243
244         if (protocol->version != AST_WEBSOCKET_PROTOCOL_VERSION) {
245                 ast_log(LOG_WARNING, "WebSocket could not register sub-protocol '%s': "
246                         "expected version '%u', got version '%u'\n",
247                         protocol->name, AST_WEBSOCKET_PROTOCOL_VERSION, protocol->version);
248                 return -1;
249         }
250
251         ao2_lock(server->protocols);
252
253         /* Ensure a second protocol handler is not registered for the same protocol */
254         existing = ao2_find(server->protocols, protocol->name, OBJ_KEY | OBJ_NOLOCK);
255         if (existing) {
256                 ao2_ref(existing, -1);
257                 ao2_unlock(server->protocols);
258                 return -1;
259         }
260
261         ao2_link_flags(server->protocols, protocol, OBJ_NOLOCK);
262         ao2_unlock(server->protocols);
263
264         ast_verb(2, "WebSocket registered sub-protocol '%s'\n", protocol->name);
265         ao2_ref(protocol, -1);
266
267         return 0;
268 }
269
270 int AST_OPTIONAL_API_NAME(ast_websocket_server_remove_protocol)(struct ast_websocket_server *server, const char *name, ast_websocket_callback callback)
271 {
272         struct ast_websocket_protocol *protocol;
273
274         if (!(protocol = ao2_find(server->protocols, name, OBJ_KEY))) {
275                 return -1;
276         }
277
278         if (protocol->session_established != callback) {
279                 ao2_ref(protocol, -1);
280                 return -1;
281         }
282
283         ao2_unlink(server->protocols, protocol);
284         ao2_ref(protocol, -1);
285
286         ast_verb(2, "WebSocket unregistered sub-protocol '%s'\n", name);
287
288         return 0;
289 }
290
291 /*! \brief Close function for websocket session */
292 int AST_OPTIONAL_API_NAME(ast_websocket_close)(struct ast_websocket *session, uint16_t reason)
293 {
294         char frame[4] = { 0, }; /* The header is 2 bytes and the reason code takes up another 2 bytes */
295         int res;
296
297         if (session->close_sent) {
298                 return 0;
299         }
300
301         frame[0] = AST_WEBSOCKET_OPCODE_CLOSE | 0x80;
302         frame[1] = 2; /* The reason code is always 2 bytes */
303
304         /* If no reason has been specified assume 1000 which is normal closure */
305         put_unaligned_uint16(&frame[2], htons(reason ? reason : 1000));
306
307         session->closing = 1;
308         session->close_sent = 1;
309
310         ao2_lock(session);
311         ast_iostream_set_timeout_inactivity(session->stream, session->timeout);
312         res = ast_iostream_write(session->stream, frame, sizeof(frame));
313         ast_iostream_set_timeout_disable(session->stream);
314
315         /* If an error occurred when trying to close this connection explicitly terminate it now.
316          * Doing so will cause the thread polling on it to wake up and terminate.
317          */
318         if (res != sizeof(frame)) {
319                 ast_iostream_close(session->stream);
320                 session->stream = NULL;
321                 ast_verb(2, "WebSocket connection %s '%s' forcefully closed due to fatal write error\n",
322                         session->client ? "to" : "from", ast_sockaddr_stringify(&session->remote_address));
323         }
324
325         ao2_unlock(session);
326         return res == sizeof(frame);
327 }
328
329 static const char *opcode_map[] = {
330         [AST_WEBSOCKET_OPCODE_CONTINUATION] = "continuation",
331         [AST_WEBSOCKET_OPCODE_TEXT] = "text",
332         [AST_WEBSOCKET_OPCODE_BINARY] = "binary",
333         [AST_WEBSOCKET_OPCODE_CLOSE] = "close",
334         [AST_WEBSOCKET_OPCODE_PING] = "ping",
335         [AST_WEBSOCKET_OPCODE_PONG] = "pong",
336 };
337
338 static const char *websocket_opcode2str(enum ast_websocket_opcode opcode)
339 {
340         if (opcode < AST_WEBSOCKET_OPCODE_CONTINUATION ||
341                         opcode > AST_WEBSOCKET_OPCODE_PONG) {
342                 return "<unknown>";
343         } else {
344                 return opcode_map[opcode];
345         }
346 }
347
348 /*! \brief Write function for websocket traffic */
349 int AST_OPTIONAL_API_NAME(ast_websocket_write)(struct ast_websocket *session, enum ast_websocket_opcode opcode, char *payload, uint64_t payload_size)
350 {
351         size_t header_size = 2; /* The minimum size of a websocket frame is 2 bytes */
352         char *frame;
353         uint64_t length;
354         uint64_t frame_size;
355
356         ast_debug(3, "Writing websocket %s frame, length %" PRIu64 "\n",
357                         websocket_opcode2str(opcode), payload_size);
358
359         if (payload_size < 126) {
360                 length = payload_size;
361         } else if (payload_size < (1 << 16)) {
362                 length = 126;
363                 /* We need an additional 2 bytes to store the extended length */
364                 header_size += 2;
365         } else {
366                 length = 127;
367                 /* We need an additional 8 bytes to store the really really extended length */
368                 header_size += 8;
369         }
370
371         frame_size = header_size + payload_size;
372
373         frame = ast_alloca(frame_size + 1);
374         memset(frame, 0, frame_size + 1);
375
376         frame[0] = opcode | 0x80;
377         frame[1] = length;
378
379         /* Use the additional available bytes to store the length */
380         if (length == 126) {
381                 put_unaligned_uint16(&frame[2], htons(payload_size));
382         } else if (length == 127) {
383                 put_unaligned_uint64(&frame[2], htonll(payload_size));
384         }
385
386         memcpy(&frame[header_size], payload, payload_size);
387
388         ao2_lock(session);
389         if (session->closing) {
390                 ao2_unlock(session);
391                 return -1;
392         }
393
394         ast_iostream_set_timeout_sequence(session->stream, ast_tvnow(), session->timeout);
395         if (ast_iostream_write(session->stream, frame, frame_size) != frame_size) {
396                 ao2_unlock(session);
397                 /* 1011 - server terminating connection due to not being able to fulfill the request */
398                 ast_debug(1, "Closing WS with 1011 because we can't fulfill a write request\n");
399                 ast_websocket_close(session, 1011);
400                 return -1;
401         }
402
403         ast_iostream_set_timeout_disable(session->stream);
404         ao2_unlock(session);
405
406         return 0;
407 }
408
409 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_enable)(struct ast_websocket *session, size_t bytes)
410 {
411         session->reconstruct = MIN(bytes, MAXIMUM_RECONSTRUCTION_CEILING);
412 }
413
414 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_disable)(struct ast_websocket *session)
415 {
416         session->reconstruct = 0;
417 }
418
419 void AST_OPTIONAL_API_NAME(ast_websocket_ref)(struct ast_websocket *session)
420 {
421         ao2_ref(session, +1);
422 }
423
424 void AST_OPTIONAL_API_NAME(ast_websocket_unref)(struct ast_websocket *session)
425 {
426         ao2_cleanup(session);
427 }
428
429 int AST_OPTIONAL_API_NAME(ast_websocket_fd)(struct ast_websocket *session)
430 {
431         return session->closing ? -1 : ast_iostream_get_fd(session->stream);
432 }
433
434 struct ast_sockaddr * AST_OPTIONAL_API_NAME(ast_websocket_remote_address)(struct ast_websocket *session)
435 {
436         return &session->remote_address;
437 }
438
439 struct ast_sockaddr * AST_OPTIONAL_API_NAME(ast_websocket_local_address)(struct ast_websocket *session)
440 {
441         return &session->local_address;
442 }
443
444 int AST_OPTIONAL_API_NAME(ast_websocket_is_secure)(struct ast_websocket *session)
445 {
446         return session->secure;
447 }
448
449 int AST_OPTIONAL_API_NAME(ast_websocket_set_nonblock)(struct ast_websocket *session)
450 {
451         ast_iostream_nonblock(session->stream);
452         ast_iostream_set_exclusive_input(session->stream, 0);
453         return 0;
454 }
455
456 int AST_OPTIONAL_API_NAME(ast_websocket_set_timeout)(struct ast_websocket *session, int timeout)
457 {
458         session->timeout = timeout;
459
460         return 0;
461 }
462
463 const char * AST_OPTIONAL_API_NAME(ast_websocket_session_id)(struct ast_websocket *session)
464 {
465         return session->session_id;
466 }
467
468
469 /* MAINTENANCE WARNING on ast_websocket_read()!
470  *
471  * We have to keep in mind during this function that the fact that session->fd seems ready
472  * (via poll) does not necessarily mean we have application data ready, because in the case
473  * of an SSL socket, there is some encryption data overhead that needs to be read from the
474  * TCP socket, so poll() may say there are bytes to be read, but whether it is just 1 byte
475  * or N bytes we do not know that, and we do not know how many of those bytes (if any) are
476  * for application data (for us) and not just for the SSL protocol consumption
477  *
478  * There used to be a couple of nasty bugs here that were fixed in last refactoring but I
479  * want to document them so the constraints are clear and we do not re-introduce them:
480  *
481  * - This function would incorrectly assume that fread() would necessarily return more than
482  *   1 byte of data, just because a websocket frame is always >= 2 bytes, but the thing
483  *   is we're dealing with a TCP bitstream here, we could read just one byte and that's normal.
484  *   The problem before was that if just one byte was read, the function bailed out and returned
485  *   an error, effectively dropping the first byte of a websocket frame header!
486  *
487  * - Another subtle bug was that it would just read up to MAX_WS_HDR_SZ (14 bytes) via fread()
488  *   then assume that executing poll() would tell you if there is more to read, but since
489  *   we're dealing with a buffered stream (session->f is a FILE*), poll would say there is
490  *   nothing else to read (in the real tcp socket session->fd) and we would get stuck here
491  *   without processing the rest of the data in session->f internal buffers until another packet
492  *   came on the network to unblock us!
493  *
494  * Note during the header parsing stage we try to read in small chunks just what we need, this
495  * is buffered data anyways, no expensive syscall required most of the time ...
496  */
497 static inline int ws_safe_read(struct ast_websocket *session, char *buf, int len, enum ast_websocket_opcode *opcode)
498 {
499         ssize_t rlen;
500         int xlen = len;
501         char *rbuf = buf;
502         int sanity = 10;
503
504         ao2_lock(session);
505         if (!session->stream) {
506                 ao2_unlock(session);
507                 errno = ECONNABORTED;
508                 return -1;
509         }
510
511         for (;;) {
512                 rlen = ast_iostream_read(session->stream, rbuf, xlen);
513                 if (rlen != xlen) {
514                         if (rlen == 0) {
515                                 ast_log(LOG_WARNING, "Web socket closed abruptly\n");
516                                 *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
517                                 session->closing = 1;
518                                 ao2_unlock(session);
519                                 return -1;
520                         }
521
522                         if (rlen < 0 && errno != EAGAIN) {
523                                 ast_log(LOG_ERROR, "Error reading from web socket: %s\n", strerror(errno));
524                                 *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
525                                 session->closing = 1;
526                                 ao2_unlock(session);
527                                 return -1;
528                         }
529
530                         if (!--sanity) {
531                                 ast_log(LOG_WARNING, "Websocket seems unresponsive, disconnecting ...\n");
532                                 *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
533                                 session->closing = 1;
534                                 ao2_unlock(session);
535                                 return -1;
536                         }
537                 }
538                 if (rlen > 0) {
539                         xlen = xlen - rlen;
540                         rbuf = rbuf + rlen;
541                         if (!xlen) {
542                                 break;
543                         }
544                 }
545                 if (ast_wait_for_input(ast_iostream_get_fd(session->stream), 1000) < 0) {
546                         ast_log(LOG_ERROR, "ast_wait_for_input returned err: %s\n", strerror(errno));
547                         *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
548                         session->closing = 1;
549                         ao2_unlock(session);
550                         return -1;
551                 }
552         }
553
554         ao2_unlock(session);
555         return 0;
556 }
557
558 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)
559 {
560         char buf[MAXIMUM_FRAME_SIZE] = "";
561         int fin = 0;
562         int mask_present = 0;
563         char *mask = NULL, *new_payload = NULL;
564         size_t options_len = 0, frame_size = 0;
565
566         *payload = NULL;
567         *payload_len = 0;
568         *fragmented = 0;
569
570         if (ws_safe_read(session, &buf[0], MIN_WS_HDR_SZ, opcode)) {
571                 return -1;
572         }
573         frame_size += MIN_WS_HDR_SZ;
574
575         /* 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) */
576         *opcode = buf[0] & 0xf;
577         *payload_len = buf[1] & 0x7f;
578         if (*opcode == AST_WEBSOCKET_OPCODE_TEXT || *opcode == AST_WEBSOCKET_OPCODE_BINARY || *opcode == AST_WEBSOCKET_OPCODE_CONTINUATION ||
579             *opcode == AST_WEBSOCKET_OPCODE_PING || *opcode == AST_WEBSOCKET_OPCODE_PONG) {
580                 fin = (buf[0] >> 7) & 1;
581                 mask_present = (buf[1] >> 7) & 1;
582
583                 /* Based on the mask flag and payload length, determine how much more we need to read before start parsing the rest of the header */
584                 options_len += mask_present ? 4 : 0;
585                 options_len += (*payload_len == 126) ? 2 : (*payload_len == 127) ? 8 : 0;
586                 if (options_len) {
587                         /* read the rest of the header options */
588                         if (ws_safe_read(session, &buf[frame_size], options_len, opcode)) {
589                                 return -1;
590                         }
591                         frame_size += options_len;
592                 }
593
594                 if (*payload_len == 126) {
595                         /* Grab the 2-byte payload length  */
596                         *payload_len = ntohs(get_unaligned_uint16(&buf[2]));
597                         mask = &buf[4];
598                 } else if (*payload_len == 127) {
599                         /* Grab the 8-byte payload length  */
600                         *payload_len = ntohl(get_unaligned_uint64(&buf[2]));
601                         mask = &buf[10];
602                 } else {
603                         /* Just set the mask after the small 2-byte header */
604                         mask = &buf[2];
605                 }
606
607                 /* Now read the rest of the payload */
608                 *payload = &buf[frame_size]; /* payload will start here, at the end of the options, if any */
609                 frame_size = frame_size + (*payload_len); /* final frame size is header + optional headers + payload data */
610                 if (frame_size > MAXIMUM_FRAME_SIZE) {
611                         ast_log(LOG_WARNING, "Cannot fit huge websocket frame of %zu bytes\n", frame_size);
612                         /* The frame won't fit :-( */
613                         ast_websocket_close(session, 1009);
614                         return -1;
615                 }
616
617                 if (ws_safe_read(session, *payload, *payload_len, opcode)) {
618                         return -1;
619                 }
620                 /* If a mask is present unmask the payload */
621                 if (mask_present) {
622                         unsigned int pos;
623                         for (pos = 0; pos < *payload_len; pos++) {
624                                 (*payload)[pos] ^= mask[pos % 4];
625                         }
626                 }
627
628                 /* Per the RFC for PING we need to send back an opcode with the application data as received */
629                 if ((*opcode == AST_WEBSOCKET_OPCODE_PING) && (ast_websocket_write(session, AST_WEBSOCKET_OPCODE_PONG, *payload, *payload_len))) {
630                         *payload_len = 0;
631                         ast_websocket_close(session, 1009);
632                         return 0;
633                 }
634
635                 if (*payload_len) {
636                         if (!(new_payload = ast_realloc(session->payload, (session->payload_len + *payload_len)))) {
637                                 ast_log(LOG_WARNING, "Failed allocation: %p, %zu, %"PRIu64"\n",
638                                         session->payload, session->payload_len, *payload_len);
639                                 *payload_len = 0;
640                                 ast_websocket_close(session, 1009);
641                                 return -1;
642                         }
643
644                         session->payload = new_payload;
645                         memcpy((session->payload + session->payload_len), (*payload), (*payload_len));
646                         session->payload_len += *payload_len;
647                 } else if (!session->payload_len && session->payload) {
648                         ast_free(session->payload);
649                         session->payload = NULL;
650                 }
651
652                 if (!fin && session->reconstruct && (session->payload_len < session->reconstruct)) {
653                         /* If this is not a final message we need to defer returning it until later */
654                         if (*opcode != AST_WEBSOCKET_OPCODE_CONTINUATION) {
655                                 session->opcode = *opcode;
656                         }
657                         *opcode = AST_WEBSOCKET_OPCODE_CONTINUATION;
658                         *payload_len = 0;
659                         *payload = NULL;
660                 } else {
661                         if (*opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
662                                 if (!fin) {
663                                         /* If this was not actually the final message tell the user it is fragmented so they can deal with it accordingly */
664                                         *fragmented = 1;
665                                 } else {
666                                         /* Final frame in multi-frame so push up the actual opcode */
667                                         *opcode = session->opcode;
668                                 }
669                         }
670                         *payload_len = session->payload_len;
671                         *payload = session->payload;
672                         session->payload_len = 0;
673                 }
674         } else if (*opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
675                 /* Make the payload available so the user can look at the reason code if they so desire */
676                 if ((*payload_len) && (new_payload = ast_realloc(session->payload, *payload_len))) {
677                         if (ws_safe_read(session, &buf[frame_size], (*payload_len), opcode)) {
678                                 return -1;
679                         }
680                         session->payload = new_payload;
681                         memcpy(session->payload, &buf[frame_size], *payload_len);
682                         *payload = session->payload;
683                         frame_size += (*payload_len);
684                 }
685
686                 session->closing = 1;
687         } else {
688                 ast_log(LOG_WARNING, "WebSocket unknown opcode %u\n", *opcode);
689                 /* 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
690                  * fit that, I think. */
691                 ast_websocket_close(session, 1003);
692         }
693
694         return 0;
695 }
696
697 /*!
698  * \brief If the server has exactly one configured protocol, return it.
699  */
700 static struct ast_websocket_protocol *one_protocol(
701         struct ast_websocket_server *server)
702 {
703         SCOPED_AO2LOCK(lock, server->protocols);
704
705         if (ao2_container_count(server->protocols) != 1) {
706                 return NULL;
707         }
708
709         return ao2_callback(server->protocols, OBJ_NOLOCK, NULL, NULL);
710 }
711
712 static char *websocket_combine_key(const char *key, char *res, int res_size)
713 {
714         char *combined;
715         unsigned combined_length = strlen(key) + strlen(WEBSOCKET_GUID) + 1;
716         uint8_t sha[20];
717
718         combined = ast_alloca(combined_length);
719         snprintf(combined, combined_length, "%s%s", key, WEBSOCKET_GUID);
720         ast_sha1_hash_uint(sha, combined);
721         ast_base64encode(res, (const unsigned char*)sha, 20, res_size);
722         return res;
723 }
724
725 static void websocket_bad_request(struct ast_tcptls_session_instance *ser)
726 {
727         struct ast_str *http_header = ast_str_create(64);
728
729         if (!http_header) {
730                 ast_http_request_close_on_completion(ser);
731                 ast_http_error(ser, 500, "Server Error", "Out of memory");
732                 return;
733         }
734         ast_str_set(&http_header, 0, "Sec-WebSocket-Version: 7, 8, 13\r\n");
735         ast_http_send(ser, AST_HTTP_UNKNOWN, 400, "Bad Request", http_header, NULL, 0, 0);
736 }
737
738 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)
739 {
740         struct ast_variable *v;
741         char *upgrade = NULL, *key = NULL, *key1 = NULL, *key2 = NULL, *protos = NULL, *requested_protocols = NULL, *protocol = NULL;
742         int version = 0, flags = 1;
743         struct ast_websocket_protocol *protocol_handler = NULL;
744         struct ast_websocket *session;
745         struct ast_websocket_server *server;
746
747         SCOPED_MODULE_USE(ast_module_info->self);
748
749         /* Upgrade requests are only permitted on GET methods */
750         if (method != AST_HTTP_GET) {
751                 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
752                 return 0;
753         }
754
755         server = urih->data;
756
757         /* Get the minimum headers required to satisfy our needs */
758         for (v = headers; v; v = v->next) {
759                 if (!strcasecmp(v->name, "Upgrade")) {
760                         upgrade = ast_strip(ast_strdupa(v->value));
761                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key")) {
762                         key = ast_strip(ast_strdupa(v->value));
763                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key1")) {
764                         key1 = ast_strip(ast_strdupa(v->value));
765                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key2")) {
766                         key2 = ast_strip(ast_strdupa(v->value));
767                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Protocol")) {
768                         requested_protocols = ast_strip(ast_strdupa(v->value));
769                         protos = ast_strdupa(requested_protocols);
770                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Version")) {
771                         if (sscanf(v->value, "%30d", &version) != 1) {
772                                 version = 0;
773                         }
774                 }
775         }
776
777         /* If this is not a websocket upgrade abort */
778         if (!upgrade || strcasecmp(upgrade, "websocket")) {
779                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - did not request WebSocket\n",
780                         ast_sockaddr_stringify(&ser->remote_address));
781                 ast_http_error(ser, 426, "Upgrade Required", NULL);
782                 return 0;
783         } else if (ast_strlen_zero(requested_protocols)) {
784                 /* If there's only a single protocol registered, and the
785                  * client doesn't specify what protocol it's using, go ahead
786                  * and accept the connection */
787                 protocol_handler = one_protocol(server);
788                 if (!protocol_handler) {
789                         /* Multiple registered subprotocols; client must specify */
790                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols requested\n",
791                                 ast_sockaddr_stringify(&ser->remote_address));
792                         websocket_bad_request(ser);
793                         return 0;
794                 }
795         } else if (key1 && key2) {
796                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 and
797                  * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00 -- not currently supported*/
798                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '00/76' chosen\n",
799                         ast_sockaddr_stringify(&ser->remote_address));
800                 websocket_bad_request(ser);
801                 return 0;
802         }
803
804         /* Iterate through the requested protocols trying to find one that we have a handler for */
805         while (!protocol_handler && (protocol = strsep(&requested_protocols, ","))) {
806                 protocol_handler = ao2_find(server->protocols, ast_strip(protocol), OBJ_KEY);
807         }
808
809         /* If no protocol handler exists bump this back to the requester */
810         if (!protocol_handler) {
811                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols out of '%s' supported\n",
812                         ast_sockaddr_stringify(&ser->remote_address), protos);
813                 websocket_bad_request(ser);
814                 return 0;
815         }
816
817         /* Determine how to respond depending on the version */
818         if (version == 7 || version == 8 || version == 13) {
819                 char base64[64];
820
821                 if (!key || strlen(key) + strlen(WEBSOCKET_GUID) + 1 > 8192) { /* no stack overflows please */
822                         websocket_bad_request(ser);
823                         ao2_ref(protocol_handler, -1);
824                         return 0;
825                 }
826
827                 if (ast_http_body_discard(ser)) {
828                         websocket_bad_request(ser);
829                         ao2_ref(protocol_handler, -1);
830                         return 0;
831                 }
832
833                 if (!(session = ao2_alloc(sizeof(*session) + AST_UUID_STR_LEN + 1, session_destroy_fn))) {
834                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted\n",
835                                 ast_sockaddr_stringify(&ser->remote_address));
836                         websocket_bad_request(ser);
837                         ao2_ref(protocol_handler, -1);
838                         return 0;
839                 }
840                 session->timeout = AST_DEFAULT_WEBSOCKET_WRITE_TIMEOUT;
841
842                 /* Generate the session id */
843                 if (!ast_uuid_generate_str(session->session_id, sizeof(session->session_id))) {
844                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - failed to generate a session id\n",
845                                 ast_sockaddr_stringify(&ser->remote_address));
846                         ast_http_error(ser, 500, "Internal Server Error", "Allocation failed");
847                         ao2_ref(protocol_handler, -1);
848                         return 0;
849                 }
850
851                 if (protocol_handler->session_attempted
852                     && protocol_handler->session_attempted(ser, get_vars, headers, session->session_id)) {
853                         ast_debug(3, "WebSocket connection from '%s' rejected by protocol handler '%s'\n",
854                                 ast_sockaddr_stringify(&ser->remote_address), protocol_handler->name);
855                         websocket_bad_request(ser);
856                         ao2_ref(protocol_handler, -1);
857                         return 0;
858                 }
859
860                 /* RFC 6455, Section 4.1:
861                  *
862                  * 6. If the response includes a |Sec-WebSocket-Protocol| header
863                  *    field and this header field indicates the use of a
864                  *    subprotocol that was not present in the client's handshake
865                  *    (the server has indicated a subprotocol not requested by
866                  *    the client), the client MUST _Fail the WebSocket
867                  *    Connection_.
868                  */
869                 if (protocol) {
870                         ast_iostream_printf(ser->stream,
871                                 "HTTP/1.1 101 Switching Protocols\r\n"
872                                 "Upgrade: %s\r\n"
873                                 "Connection: Upgrade\r\n"
874                                 "Sec-WebSocket-Accept: %s\r\n"
875                                 "Sec-WebSocket-Protocol: %s\r\n\r\n",
876                                 upgrade,
877                                 websocket_combine_key(key, base64, sizeof(base64)),
878                                 protocol);
879                 } else {
880                         ast_iostream_printf(ser->stream,
881                                 "HTTP/1.1 101 Switching Protocols\r\n"
882                                 "Upgrade: %s\r\n"
883                                 "Connection: Upgrade\r\n"
884                                 "Sec-WebSocket-Accept: %s\r\n\r\n",
885                                 upgrade,
886                                 websocket_combine_key(key, base64, sizeof(base64)));
887                 }
888         } else {
889
890                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 or completely unknown */
891                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '%d' chosen\n",
892                         ast_sockaddr_stringify(&ser->remote_address), version ? version : 75);
893                 websocket_bad_request(ser);
894                 ao2_ref(protocol_handler, -1);
895                 return 0;
896         }
897
898         /* Enable keepalive on all sessions so the underlying user does not have to */
899         if (setsockopt(ast_iostream_get_fd(ser->stream), SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
900                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - failed to enable keepalive\n",
901                         ast_sockaddr_stringify(&ser->remote_address));
902                 websocket_bad_request(ser);
903                 ao2_ref(session, -1);
904                 ao2_ref(protocol_handler, -1);
905                 return 0;
906         }
907
908         /* Get our local address for the connected socket */
909         if (ast_getsockname(ast_iostream_get_fd(ser->stream), &session->local_address)) {
910                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - failed to get local address\n",
911                         ast_sockaddr_stringify(&ser->remote_address));
912                 websocket_bad_request(ser);
913                 ao2_ref(session, -1);
914                 ao2_ref(protocol_handler, -1);
915                 return 0;
916         }
917
918         ast_verb(2, "WebSocket connection from '%s' for protocol '%s' accepted using version '%d'\n", ast_sockaddr_stringify(&ser->remote_address), protocol ? : "", version);
919
920         /* Populate the session with all the needed details */
921         session->stream = ser->stream;
922         ast_sockaddr_copy(&session->remote_address, &ser->remote_address);
923         session->opcode = -1;
924         session->reconstruct = DEFAULT_RECONSTRUCTION_CEILING;
925         session->secure = ast_iostream_get_ssl(ser->stream) ? 1 : 0;
926
927         /* Give up ownership of the socket and pass it to the protocol handler */
928         ast_iostream_set_exclusive_input(session->stream, 0);
929         protocol_handler->session_established(session, get_vars, headers);
930         ao2_ref(protocol_handler, -1);
931
932         /*
933          * By dropping the stream from the session the connection
934          * won't get closed when the HTTP server cleans up because we
935          * passed the connection to the protocol handler.
936          */
937         ser->stream = NULL;
938
939         return 0;
940 }
941
942 static struct ast_http_uri websocketuri = {
943         .callback = AST_OPTIONAL_API_NAME(ast_websocket_uri_cb),
944         .description = "Asterisk HTTP WebSocket",
945         .uri = "ws",
946         .has_subtree = 0,
947         .data = NULL,
948         .key = __FILE__,
949 };
950
951 /*! \brief Simple echo implementation which echoes received text and binary frames */
952 static void websocket_echo_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
953 {
954         int flags, res;
955
956         ast_debug(1, "Entering WebSocket echo loop\n");
957
958         if ((flags = fcntl(ast_websocket_fd(session), F_GETFL)) == -1) {
959                 goto end;
960         }
961
962         flags |= O_NONBLOCK;
963
964         if (fcntl(ast_websocket_fd(session), F_SETFL, flags) == -1) {
965                 goto end;
966         }
967
968         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
969                 char *payload;
970                 uint64_t payload_len;
971                 enum ast_websocket_opcode opcode;
972                 int fragmented;
973
974                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
975                         /* We err on the side of caution and terminate the session if any error occurs */
976                         ast_log(LOG_WARNING, "Read failure during WebSocket echo loop\n");
977                         break;
978                 }
979
980                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
981                         ast_websocket_write(session, opcode, payload, payload_len);
982                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
983                         break;
984                 } else {
985                         ast_debug(1, "Ignored WebSocket opcode %u\n", opcode);
986                 }
987         }
988
989 end:
990         ast_debug(1, "Exiting WebSocket echo loop\n");
991         ast_websocket_unref(session);
992 }
993
994 static int websocket_add_protocol_internal(const char *name, ast_websocket_callback callback)
995 {
996         struct ast_websocket_server *ws_server = websocketuri.data;
997         if (!ws_server) {
998                 return -1;
999         }
1000         return ast_websocket_server_add_protocol(ws_server, name, callback);
1001 }
1002
1003 int AST_OPTIONAL_API_NAME(ast_websocket_add_protocol)(const char *name, ast_websocket_callback callback)
1004 {
1005         int res = websocket_add_protocol_internal(name, callback);
1006         if (res == 0) {
1007                 ast_module_ref(ast_module_info->self);
1008         }
1009         return res;
1010 }
1011
1012 int AST_OPTIONAL_API_NAME(ast_websocket_add_protocol2)(struct ast_websocket_protocol *protocol)
1013 {
1014         struct ast_websocket_server *ws_server = websocketuri.data;
1015
1016         if (!ws_server) {
1017                 return -1;
1018         }
1019
1020         if (ast_websocket_server_add_protocol2(ws_server, protocol)) {
1021                 return -1;
1022         }
1023
1024         ast_module_ref(ast_module_info->self);
1025         return 0;
1026 }
1027
1028 static int websocket_remove_protocol_internal(const char *name, ast_websocket_callback callback)
1029 {
1030         struct ast_websocket_server *ws_server = websocketuri.data;
1031         if (!ws_server) {
1032                 return -1;
1033         }
1034         return ast_websocket_server_remove_protocol(ws_server, name, callback);
1035 }
1036
1037 int AST_OPTIONAL_API_NAME(ast_websocket_remove_protocol)(const char *name, ast_websocket_callback callback)
1038 {
1039         int res = websocket_remove_protocol_internal(name, callback);
1040         if (res == 0) {
1041                 ast_module_unref(ast_module_info->self);
1042         }
1043         return res;
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         /* For Optional API. */
1466         ast_module_shutdown_ref(AST_MODULE_SELF);
1467
1468         return 0;
1469 }
1470
1471 static int unload_module(void)
1472 {
1473         websocket_remove_protocol_internal("echo", websocket_echo_callback);
1474         ast_http_uri_unlink(&websocketuri);
1475         ao2_ref(websocketuri.data, -1);
1476         websocketuri.data = NULL;
1477
1478         return 0;
1479 }
1480
1481 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "HTTP WebSocket Support",
1482         .support_level = AST_MODULE_SUPPORT_EXTENDED,
1483         .load = load_module,
1484         .unload = unload_module,
1485         .load_pri = AST_MODPRI_CHANNEL_DEPEND,
1486 );