Added missing newlines to websocket ast_logs.
[asterisk/asterisk.git] / res / res_http_websocket.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief WebSocket support for the Asterisk internal HTTP server
22  *
23  * \author Joshua Colp <jcolp@digium.com>
24  */
25
26 /*** MODULEINFO
27         <support_level>extended</support_level>
28  ***/
29
30 #include "asterisk.h"
31
32 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
33
34 #include "asterisk/module.h"
35 #include "asterisk/http.h"
36 #include "asterisk/astobj2.h"
37 #include "asterisk/strings.h"
38 #include "asterisk/file.h"
39 #include "asterisk/unaligned.h"
40
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 Number of buckets for registered protocols */
48 #define MAX_PROTOCOL_BUCKETS 7
49
50 /*! \brief Size of the pre-determined buffer for WebSocket frames */
51 #define MAXIMUM_FRAME_SIZE 8192
52
53 /*! \brief Default reconstruction size for multi-frame payload reconstruction. If exceeded the next frame will start a
54  *         payload.
55  */
56 #define DEFAULT_RECONSTRUCTION_CEILING 16384
57
58 /*! \brief Maximum reconstruction size for multi-frame payload reconstruction. */
59 #define MAXIMUM_RECONSTRUCTION_CEILING 16384
60
61 /*! \brief Structure definition for session */
62 struct ast_websocket {
63         FILE *f;                          /*!< Pointer to the file instance used for writing and reading */
64         int fd;                           /*!< File descriptor for the session, only used for polling */
65         struct ast_sockaddr address;      /*!< Address of the remote client */
66         enum ast_websocket_opcode opcode; /*!< Cached opcode for multi-frame messages */
67         size_t payload_len;               /*!< Length of the payload */
68         char *payload;                    /*!< Pointer to the payload */
69         size_t reconstruct;               /*!< Number of bytes before a reconstructed payload will be returned and a new one started */
70         unsigned int secure:1;            /*!< Bit to indicate that the transport is secure */
71         unsigned int closing:1;           /*!< Bit to indicate that the session is in the process of being closed */
72 };
73
74 /*! \brief Structure definition for protocols */
75 struct websocket_protocol {
76         char *name;                      /*!< Name of the protocol */
77         ast_websocket_callback callback; /*!< Callback called when a new session is established */
78 };
79
80 /*! \brief Container for registered protocols */
81 static struct ao2_container *protocols;
82
83 /*! \brief Hashing function for protocols */
84 static int protocol_hash_fn(const void *obj, const int flags)
85 {
86         const struct websocket_protocol *protocol = obj;
87         const char *name = obj;
88
89         return ast_str_case_hash(flags & OBJ_KEY ? name : protocol->name);
90 }
91
92 /*! \brief Comparison function for protocols */
93 static int protocol_cmp_fn(void *obj, void *arg, int flags)
94 {
95         const struct websocket_protocol *protocol1 = obj, *protocol2 = arg;
96         const char *protocol = arg;
97
98         return !strcasecmp(protocol1->name, flags & OBJ_KEY ? protocol : protocol2->name) ? CMP_MATCH | CMP_STOP : 0;
99 }
100
101 /*! \brief Destructor function for protocols */
102 static void protocol_destroy_fn(void *obj)
103 {
104         struct websocket_protocol *protocol = obj;
105         ast_free(protocol->name);
106 }
107
108 /*! \brief Destructor function for sessions */
109 static void session_destroy_fn(void *obj)
110 {
111         struct ast_websocket *session = obj;
112
113         if (session->f) {
114                 fclose(session->f);
115                 ast_verb(2, "WebSocket connection from '%s' closed\n", ast_sockaddr_stringify(&session->address));
116         }
117
118         ast_free(session->payload);
119 }
120
121 int AST_OPTIONAL_API_NAME(ast_websocket_add_protocol)(const char *name, ast_websocket_callback callback)
122 {
123         struct websocket_protocol *protocol;
124
125         ao2_lock(protocols);
126
127         /* Ensure a second protocol handler is not registered for the same protocol */
128         if ((protocol = ao2_find(protocols, name, OBJ_KEY | OBJ_NOLOCK))) {
129                 ao2_ref(protocol, -1);
130                 ao2_unlock(protocols);
131                 return -1;
132         }
133
134         if (!(protocol = ao2_alloc(sizeof(*protocol), protocol_destroy_fn))) {
135                 ao2_unlock(protocols);
136                 return -1;
137         }
138
139         if (!(protocol->name = ast_strdup(name))) {
140                 ao2_ref(protocol, -1);
141                 ao2_unlock(protocols);
142                 return -1;
143         }
144
145         protocol->callback = callback;
146
147         ao2_link_flags(protocols, protocol, OBJ_NOLOCK);
148         ao2_unlock(protocols);
149         ao2_ref(protocol, -1);
150
151         ast_verb(2, "WebSocket registered sub-protocol '%s'\n", name);
152
153         return 0;
154 }
155
156 int AST_OPTIONAL_API_NAME(ast_websocket_remove_protocol)(const char *name, ast_websocket_callback callback)
157 {
158         struct websocket_protocol *protocol;
159
160         if (!(protocol = ao2_find(protocols, name, OBJ_KEY))) {
161                 return -1;
162         }
163
164         if (protocol->callback != callback) {
165                 ao2_ref(protocol, -1);
166                 return -1;
167         }
168
169         ao2_unlink(protocols, protocol);
170         ao2_ref(protocol, -1);
171
172         ast_verb(2, "WebSocket unregistered sub-protocol '%s'\n", name);
173
174         return 0;
175 }
176
177 /*! \brief Close function for websocket session */
178 int AST_OPTIONAL_API_NAME(ast_websocket_close)(struct ast_websocket *session, uint16_t reason)
179 {
180         char frame[4] = { 0, }; /* The header is 2 bytes and the reason code takes up another 2 bytes */
181
182         frame[0] = AST_WEBSOCKET_OPCODE_CLOSE | 0x80;
183         frame[1] = 2; /* The reason code is always 2 bytes */
184
185         /* If no reason has been specified assume 1000 which is normal closure */
186         put_unaligned_uint16(&frame[2], htons(reason ? reason : 1000));
187
188         session->closing = 1;
189
190         return (fwrite(frame, 1, 4, session->f) == 4) ? 0 : -1;
191 }
192
193
194 /*! \brief Write function for websocket traffic */
195 int AST_OPTIONAL_API_NAME(ast_websocket_write)(struct ast_websocket *session, enum ast_websocket_opcode opcode, char *payload, uint64_t actual_length)
196 {
197         size_t header_size = 2; /* The minimum size of a websocket frame is 2 bytes */
198         char *frame;
199         uint64_t length = 0;
200
201         if (actual_length < 126) {
202                 length = actual_length;
203         } else if (actual_length < (1 << 16)) {
204                 length = 126;
205                 /* We need an additional 2 bytes to store the extended length */
206                 header_size += 2;
207         } else {
208                 length = 127;
209                 /* We need an additional 8 bytes to store the really really extended length */
210                 header_size += 8;
211         }
212
213         frame = ast_alloca(header_size);
214         memset(frame, 0, sizeof(*frame));
215
216         frame[0] = opcode | 0x80;
217         frame[1] = length;
218
219         /* Use the additional available bytes to store the length */
220         if (length == 126) {
221                 put_unaligned_uint16(&frame[2], htons(actual_length));
222         } else if (length == 127) {
223                 put_unaligned_uint64(&frame[2], htonl(actual_length));
224         }
225
226         if (fwrite(frame, 1, header_size, session->f) != header_size) {
227                 return -1;
228         }
229
230         if (fwrite(payload, 1, actual_length, session->f) != actual_length) {
231                 return -1;
232         }
233
234         return 0;
235 }
236
237 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_enable)(struct ast_websocket *session, size_t bytes)
238 {
239         session->reconstruct = MIN(bytes, MAXIMUM_RECONSTRUCTION_CEILING);
240 }
241
242 void AST_OPTIONAL_API_NAME(ast_websocket_reconstruct_disable)(struct ast_websocket *session)
243 {
244         session->reconstruct = 0;
245 }
246
247 void AST_OPTIONAL_API_NAME(ast_websocket_ref)(struct ast_websocket *session)
248 {
249         ao2_ref(session, +1);
250 }
251
252 void AST_OPTIONAL_API_NAME(ast_websocket_unref)(struct ast_websocket *session)
253 {
254         ao2_ref(session, -1);
255 }
256
257 int AST_OPTIONAL_API_NAME(ast_websocket_fd)(struct ast_websocket *session)
258 {
259         return session->closing ? -1 : session->fd;
260 }
261
262 struct ast_sockaddr * AST_OPTIONAL_API_NAME(ast_websocket_remote_address)(struct ast_websocket *session)
263 {
264         return &session->address;
265 }
266
267 int AST_OPTIONAL_API_NAME(ast_websocket_is_secure)(struct ast_websocket *session)
268 {
269         return session->secure;
270 }
271
272 int AST_OPTIONAL_API_NAME(ast_websocket_set_nonblock)(struct ast_websocket *session)
273 {
274         int flags;
275
276         if ((flags = fcntl(session->fd, F_GETFL)) == -1) {
277                 return -1;
278         }
279
280         flags |= O_NONBLOCK;
281
282         if ((flags = fcntl(session->fd, F_SETFL, flags)) == -1) {
283                 return -1;
284         }
285
286         return 0;
287 }
288
289 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)
290 {
291         char buf[MAXIMUM_FRAME_SIZE] = "";
292         size_t frame_size, expected = 2;
293
294         *payload = NULL;
295         *payload_len = 0;
296         *fragmented = 0;
297
298         /* We try to read in 14 bytes, which is the largest possible WebSocket header */
299         if ((frame_size = fread(&buf, 1, 14, session->f)) < 1) {
300                 return -1;
301         }
302
303         /* The minimum size for a WebSocket frame is 2 bytes */
304         if (frame_size < expected) {
305                 return -1;
306         }
307
308         *opcode = buf[0] & 0xf;
309
310         if (*opcode == AST_WEBSOCKET_OPCODE_TEXT || *opcode == AST_WEBSOCKET_OPCODE_BINARY || *opcode == AST_WEBSOCKET_OPCODE_CONTINUATION ||
311             *opcode == AST_WEBSOCKET_OPCODE_PING || *opcode == AST_WEBSOCKET_OPCODE_PONG) {
312                 int fin = (buf[0] >> 7) & 1;
313                 int mask_present = (buf[1] >> 7) & 1;
314                 char *mask = NULL, *new_payload;
315                 size_t remaining;
316
317                 if (mask_present) {
318                         /* The mask should take up 4 bytes */
319                         expected += 4;
320
321                         if (frame_size < expected) {
322                                 /* Per the RFC 1009 means we received a message that was too large for us to process */
323                                 ast_websocket_close(session, 1009);
324                                 return 0;
325                         }
326                 }
327
328                 /* Assume no extended length and no masking at the beginning */
329                 *payload_len = buf[1] & 0x7f;
330                 *payload = &buf[2];
331
332                 /* Determine if extended length is being used */
333                 if (*payload_len == 126) {
334                         /* Use the next 2 bytes to get a uint16_t */
335                         expected += 2;
336                         *payload += 2;
337
338                         if (frame_size < expected) {
339                                 ast_websocket_close(session, 1009);
340                                 return 0;
341                         }
342
343                         *payload_len = ntohs(get_unaligned_uint16(&buf[2]));
344                 } else if (*payload_len == 127) {
345                         /* Use the next 8 bytes to get a uint64_t */
346                         expected += 8;
347                         *payload += 8;
348
349                         if (frame_size < expected) {
350                                 ast_websocket_close(session, 1009);
351                                 return 0;
352                         }
353
354                         *payload_len = ntohl(get_unaligned_uint64(&buf[2]));
355                 }
356
357                 /* If masking is present the payload currently points to the mask, so move it over 4 bytes to the actual payload */
358                 if (mask_present) {
359                         mask = *payload;
360                         *payload += 4;
361                 }
362
363                 /* Determine how much payload we need to read in as we may have already read some in */
364                 remaining = *payload_len - (frame_size - expected);
365
366                 /* If how much payload they want us to read in exceeds what we are capable of close the session, things
367                  * will fail no matter what most likely */
368                 if (remaining > (MAXIMUM_FRAME_SIZE - frame_size)) {
369                         ast_websocket_close(session, 1009);
370                         return 0;
371                 }
372
373                 new_payload = *payload + (frame_size - expected);
374
375                 /* Read in the remaining payload */
376                 while (remaining > 0) {
377                         size_t payload_read;
378
379                         /* Wait for data to come in */
380                         if (ast_wait_for_input(session->fd, -1) <= 0) {
381                                 *opcode = AST_WEBSOCKET_OPCODE_CLOSE;
382                                 *payload = NULL;
383                                 session->closing = 1;
384                                 return 0;
385                         }
386
387                         /* If some sort of failure occurs notify the caller */
388                         if ((payload_read = fread(new_payload, 1, remaining, session->f)) < 1) {
389                                 return -1;
390                         }
391
392                         remaining -= payload_read;
393                         new_payload += payload_read;
394                 }
395
396                 /* If a mask is present unmask the payload */
397                 if (mask_present) {
398                         unsigned int pos;
399                         for (pos = 0; pos < *payload_len; pos++) {
400                                 (*payload)[pos] ^= mask[pos % 4];
401                         }
402                 }
403
404                 if (!(new_payload = ast_realloc(session->payload, session->payload_len + *payload_len))) {
405                         *payload_len = 0;
406                         ast_websocket_close(session, 1009);
407                         return 0;
408                 }
409
410                 /* Per the RFC for PING we need to send back an opcode with the application data as received */
411                 if (*opcode == AST_WEBSOCKET_OPCODE_PING) {
412                         ast_websocket_write(session, AST_WEBSOCKET_OPCODE_PONG, *payload, *payload_len);
413                 }
414
415                 session->payload = new_payload;
416                 memcpy(session->payload + session->payload_len, *payload, *payload_len);
417                 session->payload_len += *payload_len;
418
419                 if (!fin && session->reconstruct && (session->payload_len < session->reconstruct)) {
420                         /* If this is not a final message we need to defer returning it until later */
421                         if (*opcode != AST_WEBSOCKET_OPCODE_CONTINUATION) {
422                                 session->opcode = *opcode;
423                         }
424                         *opcode = AST_WEBSOCKET_OPCODE_CONTINUATION;
425                         *payload_len = 0;
426                         *payload = NULL;
427                 } else {
428                         if (*opcode == AST_WEBSOCKET_OPCODE_CONTINUATION) {
429                                 if (!fin) {
430                                         /* If this was not actually the final message tell the user it is fragmented so they can deal with it accordingly */
431                                         *fragmented = 1;
432                                 } else {
433                                         /* Final frame in multi-frame so push up the actual opcode */
434                                         *opcode = session->opcode;
435                                 }
436                         }
437                         *payload_len = session->payload_len;
438                         *payload = session->payload;
439                         session->payload_len = 0;
440                 }
441         } else if (*opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
442                 char *new_payload;
443
444                 *payload_len = buf[1] & 0x7f;
445
446                 /* Make the payload available so the user can look at the reason code if they so desire */
447                 if ((*payload_len) && (new_payload = ast_realloc(session->payload, *payload_len))) {
448                         session->payload = new_payload;
449                         memcpy(session->payload, &buf[2], *payload_len);
450                         *payload = session->payload;
451                 }
452
453                 if (!session->closing) {
454                         ast_websocket_close(session, 0);
455                 }
456
457                 fclose(session->f);
458                 session->f = NULL;
459                 ast_verb(2, "WebSocket connection from '%s' closed\n", ast_sockaddr_stringify(&session->address));
460         } else {
461                 /* 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
462                  * fit that, I think. */
463                 ast_websocket_close(session, 1003);
464         }
465
466         return 0;
467 }
468
469 /*! \brief Callback that is executed everytime an HTTP request is received by this module */
470 static int websocket_callback(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)
471 {
472         struct ast_variable *v;
473         char *upgrade = NULL, *key = NULL, *key1 = NULL, *key2 = NULL, *protos = NULL, *requested_protocols = NULL, *protocol = NULL;
474         int version = 0, flags = 1;
475         struct websocket_protocol *protocol_handler = NULL;
476         struct ast_websocket *session;
477
478         /* Upgrade requests are only permitted on GET methods */
479         if (method != AST_HTTP_GET) {
480                 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
481                 return -1;
482         }
483
484         /* Get the minimum headers required to satisfy our needs */
485         for (v = headers; v; v = v->next) {
486                 if (!strcasecmp(v->name, "Upgrade")) {
487                         upgrade = ast_strip(ast_strdupa(v->value));
488                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key")) {
489                         key = ast_strip(ast_strdupa(v->value));
490                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key1")) {
491                         key1 = ast_strip(ast_strdupa(v->value));
492                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Key2")) {
493                         key2 = ast_strip(ast_strdupa(v->value));
494                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Protocol")) {
495                         requested_protocols = ast_strip(ast_strdupa(v->value));
496                         protos = ast_strdupa(requested_protocols);
497                 } else if (!strcasecmp(v->name, "Sec-WebSocket-Version")) {
498                         if (sscanf(v->value, "%30d", &version) != 1) {
499                                 version = 0;
500                         }
501                 }
502         }
503
504         /* If this is not a websocket upgrade abort */
505         if (!upgrade || strcasecmp(upgrade, "websocket")) {
506                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - did not request WebSocket\n",
507                         ast_sockaddr_stringify(&ser->remote_address));
508                 ast_http_error(ser, 426, "Upgrade Required", NULL);
509                 return -1;
510         } else if (ast_strlen_zero(requested_protocols)) {
511                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols requested\n",
512                         ast_sockaddr_stringify(&ser->remote_address));
513                 fputs("HTTP/1.1 400 Bad Request\r\n"
514                       "Sec-WebSocket-Version: 7, 8, 13\r\n\r\n", ser->f);
515                 return -1;
516         } else if (key1 && key2) {
517                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-76 and
518                  * http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-00 -- not currently supported*/
519                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '00/76' chosen\n",
520                         ast_sockaddr_stringify(&ser->remote_address));
521                 fputs("HTTP/1.1 400 Bad Request\r\n"
522                       "Sec-WebSocket-Version: 7, 8, 13\r\n\r\n", ser->f);
523                 return 0;
524         }
525
526         /* Iterate through the requested protocols trying to find one that we have a handler for */
527         while ((protocol = strsep(&requested_protocols, ","))) {
528                 if ((protocol_handler = ao2_find(protocols, ast_strip(protocol), OBJ_KEY))) {
529                         break;
530                 }
531         }
532
533         /* If no protocol handler exists bump this back to the requester */
534         if (!protocol_handler) {
535                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - no protocols out of '%s' supported\n",
536                         ast_sockaddr_stringify(&ser->remote_address), protos);
537                 fputs("HTTP/1.1 400 Bad Request\r\n"
538                       "Sec-WebSocket-Version: 7, 8, 13\r\n\r\n", ser->f);
539                 return 0;
540         }
541
542         /* Determine how to respond depending on the version */
543         if (version == 7 || version == 8 || version == 13) {
544                 /* Version 7 defined in specification http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-07 */
545                 /* Version 8 defined in specification http://tools.ietf.org/html/draft-ietf-hybi-thewebsocketprotocol-10 */
546                 /* Version 13 defined in specification http://tools.ietf.org/html/rfc6455 */
547                 char combined[strlen(key) + strlen(WEBSOCKET_GUID) + 1], base64[64];
548                 uint8_t sha[20];
549
550                 if (!(session = ao2_alloc(sizeof(*session), session_destroy_fn))) {
551                         ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted\n",
552                                 ast_sockaddr_stringify(&ser->remote_address));
553                         fputs("HTTP/1.1 400 Bad Request\r\n"
554                               "Sec-WebSocket-Version: 7, 8, 13\r\n\r\n", ser->f);
555                         ao2_ref(protocol_handler, -1);
556                         return 0;
557                 }
558
559                 snprintf(combined, sizeof(combined), "%s%s", key, WEBSOCKET_GUID);
560                 ast_sha1_hash_uint(sha, combined);
561                 ast_base64encode(base64, (const unsigned char*)sha, 20, sizeof(base64));
562
563                 fprintf(ser->f, "HTTP/1.1 101 Switching Protocols\r\n"
564                         "Upgrade: %s\r\n"
565                         "Connection: Upgrade\r\n"
566                         "Sec-WebSocket-Accept: %s\r\n"
567                         "Sec-WebSocket-Protocol: %s\r\n\r\n",
568                         upgrade,
569                         base64,
570                         protocol);
571         } else {
572
573                 /* Specification defined in http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 or completely unknown */
574                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - unsupported version '%d' chosen\n",
575                         ast_sockaddr_stringify(&ser->remote_address), version ? version : 75);
576                 fputs("HTTP/1.1 400 Bad Request\r\n"
577                       "Sec-WebSocket-Version: 7, 8, 13\r\n\r\n", ser->f);
578                 ao2_ref(protocol_handler, -1);
579                 return 0;
580         }
581
582         /* Enable keepalive on all sessions so the underlying user does not have to */
583         if (setsockopt(ser->fd, SOL_SOCKET, SO_KEEPALIVE, &flags, sizeof(flags))) {
584                 ast_log(LOG_WARNING, "WebSocket connection from '%s' could not be accepted - failed to enable keepalive\n",
585                         ast_sockaddr_stringify(&ser->remote_address));
586                 fputs("HTTP/1.1 400 Bad Request\r\n"
587                       "Sec-WebSocket-Version: 7, 8, 13\r\n\r\n", ser->f);
588                 ao2_ref(session, -1);
589                 ao2_ref(protocol_handler, -1);
590                 return 0;
591         }
592
593         ast_verb(2, "WebSocket connection from '%s' for protocol '%s' accepted using version '%d'\n", ast_sockaddr_stringify(&ser->remote_address), protocol, version);
594
595         /* Populate the session with all the needed details */
596         session->f = ser->f;
597         session->fd = ser->fd;
598         ast_sockaddr_copy(&session->address, &ser->remote_address);
599         session->opcode = -1;
600         session->reconstruct = DEFAULT_RECONSTRUCTION_CEILING;
601         session->secure = ser->ssl ? 1 : 0;
602
603         /* Give up ownership of the socket and pass it to the protocol handler */
604         protocol_handler->callback(session, get_vars, headers);
605         ao2_ref(protocol_handler, -1);
606
607         /* By dropping the FILE* from the session it won't get closed when the HTTP server cleans up */
608         ser->f = NULL;
609
610         return 0;
611 }
612
613 static struct ast_http_uri websocketuri = {
614         .callback = websocket_callback,
615         .description = "Asterisk HTTP WebSocket",
616         .uri = "ws",
617         .has_subtree = 0,
618         .data = NULL,
619         .key = __FILE__,
620 };
621
622 /*! \brief Simple echo implementation which echoes received text and binary frames */
623 static void websocket_echo_callback(struct ast_websocket *session, struct ast_variable *parameters, struct ast_variable *headers)
624 {
625         int flags, res;
626
627         if ((flags = fcntl(ast_websocket_fd(session), F_GETFL)) == -1) {
628                 goto end;
629         }
630
631         flags |= O_NONBLOCK;
632
633         if (fcntl(ast_websocket_fd(session), F_SETFL, flags) == -1) {
634                 goto end;
635         }
636
637         while ((res = ast_wait_for_input(ast_websocket_fd(session), -1)) > 0) {
638                 char *payload;
639                 uint64_t payload_len;
640                 enum ast_websocket_opcode opcode;
641                 int fragmented;
642
643                 if (ast_websocket_read(session, &payload, &payload_len, &opcode, &fragmented)) {
644                         /* We err on the side of caution and terminate the session if any error occurs */
645                         break;
646                 }
647
648                 if (opcode == AST_WEBSOCKET_OPCODE_TEXT || opcode == AST_WEBSOCKET_OPCODE_BINARY) {
649                         ast_websocket_write(session, opcode, payload, payload_len);
650                 } else if (opcode == AST_WEBSOCKET_OPCODE_CLOSE) {
651                         break;
652                 }
653         }
654
655 end:
656         ast_websocket_unref(session);
657 }
658
659 static int load_module(void)
660 {
661         protocols = ao2_container_alloc(MAX_PROTOCOL_BUCKETS, protocol_hash_fn, protocol_cmp_fn);
662         ast_http_uri_link(&websocketuri);
663         ast_websocket_add_protocol("echo", websocket_echo_callback);
664
665         return 0;
666 }
667
668 static int unload_module(void)
669 {
670         ast_websocket_remove_protocol("echo", websocket_echo_callback);
671         ast_http_uri_unlink(&websocketuri);
672         ao2_ref(protocols, -1);
673
674         return 0;
675 }
676
677 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "HTTP WebSocket Support",
678                 .load = load_module,
679                 .unload = unload_module,
680                 .load_pri = AST_MODPRI_CHANNEL_DEPEND,
681         );