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