res_srtp: Add support for libsrtp2.1.
[asterisk/asterisk.git] / res / res_ari.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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 HTTP binding for the Stasis API
22  * \author David M. Lee, II <dlee@digium.com>
23  *
24  * The API itself is documented using <a
25  * href="https://developers.helloreverb.com/swagger/">Swagger</a>, a lightweight
26  * mechanism for documenting RESTful API's using JSON. This allows us to use <a
27  * href="https://github.com/wordnik/swagger-ui">swagger-ui</a> to provide
28  * executable documentation for the API, generate client bindings in different
29  * <a href="https://github.com/asterisk/asterisk_rest_libraries">languages</a>,
30  * and generate a lot of the boilerplate code for implementing the RESTful
31  * bindings. The API docs live in the \c rest-api/ directory.
32  *
33  * The RESTful bindings are generated from the Swagger API docs using a set of
34  * <a href="http://mustache.github.io/mustache.5.html">Mustache</a> templates.
35  * The code generator is written in Python, and uses the Python implementation
36  * <a href="https://github.com/defunkt/pystache">pystache</a>. Pystache has no
37  * dependencies, and be installed easily using \c pip. Code generation code
38  * lives in \c rest-api-templates/.
39  *
40  * The generated code reduces a lot of boilerplate when it comes to handling
41  * HTTP requests. It also helps us have greater consistency in the REST API.
42  *
43  * The structure of the generated code is:
44  *
45  *  - res/ari/resource_{resource}.h
46  *    - For each operation in the resouce, a generated argument structure
47  *      (holding the parsed arguments from the request) and function
48  *      declarations (to implement in res/ari/resource_{resource}.c)
49  *  - res_ari_{resource}.c
50  *    - A set of \ref stasis_rest_callback functions, which glue the two
51  *      together. They parse out path variables and request parameters to
52  *      populate a specific \c *_args which is passed to the specific request
53  *      handler (in res/ari/resource_{resource}.c)
54  *    - A tree of \ref stasis_rest_handlers for routing requests to its
55  *      \ref stasis_rest_callback
56  *
57  * The basic flow of an HTTP request is:
58  *
59  *  - ast_ari_callback()
60  *    1. Initial request validation
61  *    2. Routes as either a doc request (ast_ari_get_docs) or API
62  *       request (ast_ari_invoke)
63  *       - ast_ari_invoke()
64  *         1. Further request validation
65  *         2. Routes the request through the tree of generated
66  *            \ref stasis_rest_handlers.
67  *         3. Dispatch to the generated callback
68  *            - \c ast_ari_*_cb
69  *              1. Populate \c *_args struct with path and get params
70  *              2. Invoke the request handler
71  *    3. Validates and sends response
72  */
73
74 /*** MODULEINFO
75         <depend type="module">res_http_websocket</depend>
76         <support_level>core</support_level>
77  ***/
78
79 /*** DOCUMENTATION
80         <configInfo name="res_ari" language="en_US">
81                 <synopsis>HTTP binding for the Stasis API</synopsis>
82                 <configFile name="ari.conf">
83                         <configObject name="general">
84                                 <synopsis>General configuration settings</synopsis>
85                                 <configOption name="enabled">
86                                         <synopsis>Enable/disable the ARI module</synopsis>
87                                         <description>
88                                                 <para>This option enables or disables the ARI module.</para>
89                                                 <note>
90                                                         <para>ARI uses Asterisk's HTTP server, which must also be enabled in <filename>http.conf</filename>.</para>
91                                                 </note>
92                                         </description>
93                                         <see-also>
94                                                 <ref type="filename">http.conf</ref>
95                                                 <ref type="link">https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server</ref>
96                                         </see-also>
97                                 </configOption>
98                                 <configOption name="websocket_write_timeout">
99                                         <synopsis>The timeout (in milliseconds) to set on WebSocket connections.</synopsis>
100                                         <description>
101                                                 <para>If a websocket connection accepts input slowly, the timeout
102                                                 for writes to it can be increased to keep it from being disconnected.
103                                                 Value is in milliseconds; default is 100 ms.</para>
104                                         </description>
105                                 </configOption>
106                                 <configOption name="pretty">
107                                         <synopsis>Responses from ARI are formatted to be human readable</synopsis>
108                                 </configOption>
109                                 <configOption name="auth_realm">
110                                         <synopsis>Realm to use for authentication. Defaults to Asterisk REST Interface.</synopsis>
111                                 </configOption>
112                                 <configOption name="allowed_origins">
113                                         <synopsis>Comma separated list of allowed origins, for Cross-Origin Resource Sharing. May be set to * to allow all origins.</synopsis>
114                                 </configOption>
115                                 <configOption name="channelvars">
116                                         <synopsis>Comma separated list of channel variables to display in channel json.</synopsis>
117                                 </configOption>
118                         </configObject>
119
120                         <configObject name="user">
121                                 <synopsis>Per-user configuration settings</synopsis>
122                                 <configOption name="type">
123                                         <synopsis>Define this configuration section as a user.</synopsis>
124                                         <description>
125                                                 <enumlist>
126                                                         <enum name="user"><para>Configure this section as a <replaceable>user</replaceable></para></enum>
127                                                 </enumlist>
128                                         </description>
129                                 </configOption>
130                                 <configOption name="read_only">
131                                         <synopsis>When set to yes, user is only authorized for read-only requests</synopsis>
132                                 </configOption>
133                                 <configOption name="password">
134                                         <synopsis>Crypted or plaintext password (see password_format)</synopsis>
135                                 </configOption>
136                                 <configOption name="password_format">
137                                         <synopsis>password_format may be set to plain (the default) or crypt. When set to crypt, crypt(3) is used to validate the password. A crypted password can be generated using mkpasswd -m sha-512. When set to plain, the password is in plaintext</synopsis>
138                                 </configOption>
139                         </configObject>
140                 </configFile>
141         </configInfo>
142 ***/
143
144 #include "asterisk.h"
145
146 #include "ari/internal.h"
147 #include "asterisk/ari.h"
148 #include "asterisk/astobj2.h"
149 #include "asterisk/module.h"
150 #include "asterisk/paths.h"
151 #include "asterisk/stasis_app.h"
152
153 #include <string.h>
154 #include <sys/stat.h>
155 #include <unistd.h>
156
157 /*! \brief Helper function to check if module is enabled. */
158 static int is_enabled(void)
159 {
160         RAII_VAR(struct ast_ari_conf *, cfg, ast_ari_config_get(), ao2_cleanup);
161         return cfg && cfg->general && cfg->general->enabled;
162 }
163
164 /*! Lock for \ref root_handler */
165 static ast_mutex_t root_handler_lock;
166
167 /*! Handler for root RESTful resource. */
168 static struct stasis_rest_handlers *root_handler;
169
170 /*! Pre-defined message for allocation failures. */
171 static struct ast_json *oom_json;
172
173 struct ast_json *ast_ari_oom_json(void)
174 {
175         return oom_json;
176 }
177
178 int ast_ari_add_handler(struct stasis_rest_handlers *handler)
179 {
180         RAII_VAR(struct stasis_rest_handlers *, new_handler, NULL, ao2_cleanup);
181         size_t old_size, new_size;
182
183         SCOPED_MUTEX(lock, &root_handler_lock);
184
185         old_size = sizeof(*new_handler) + root_handler->num_children * sizeof(handler);
186         new_size = old_size + sizeof(handler);
187
188         new_handler = ao2_alloc(new_size, NULL);
189         if (!new_handler) {
190                 return -1;
191         }
192         memcpy(new_handler, root_handler, old_size);
193         new_handler->children[new_handler->num_children++] = handler;
194
195         ao2_cleanup(root_handler);
196         ao2_ref(new_handler, +1);
197         root_handler = new_handler;
198         ast_module_ref(ast_module_info->self);
199         return 0;
200 }
201
202 int ast_ari_remove_handler(struct stasis_rest_handlers *handler)
203 {
204         struct stasis_rest_handlers *new_handler;
205         size_t size;
206         size_t i;
207         size_t j;
208
209         ast_assert(root_handler != NULL);
210
211         ast_mutex_lock(&root_handler_lock);
212         size = sizeof(*new_handler) + root_handler->num_children * sizeof(handler);
213
214         new_handler = ao2_alloc(size, NULL);
215         if (!new_handler) {
216                 ast_mutex_unlock(&root_handler_lock);
217                 return -1;
218         }
219
220         /* Create replacement root_handler less the handler to remove. */
221         memcpy(new_handler, root_handler, sizeof(*new_handler));
222         for (i = 0, j = 0; i < root_handler->num_children; ++i) {
223                 if (root_handler->children[i] == handler) {
224                         ast_module_unref(ast_module_info->self);
225                         continue;
226                 }
227                 new_handler->children[j++] = root_handler->children[i];
228         }
229         new_handler->num_children = j;
230
231         /* Replace the old root_handler with the new. */
232         ao2_cleanup(root_handler);
233         root_handler = new_handler;
234
235         ast_mutex_unlock(&root_handler_lock);
236         return 0;
237 }
238
239 static struct stasis_rest_handlers *get_root_handler(void)
240 {
241         SCOPED_MUTEX(lock, &root_handler_lock);
242         ao2_ref(root_handler, +1);
243         return root_handler;
244 }
245
246 static struct stasis_rest_handlers *root_handler_create(void)
247 {
248         RAII_VAR(struct stasis_rest_handlers *, handler, NULL, ao2_cleanup);
249
250         handler = ao2_alloc(sizeof(*handler), NULL);
251         if (!handler) {
252                 return NULL;
253         }
254         handler->path_segment = "ari";
255
256         ao2_ref(handler, +1);
257         return handler;
258 }
259
260 void ast_ari_response_error(struct ast_ari_response *response,
261                                 int response_code,
262                                 const char *response_text,
263                                 const char *message_fmt, ...)
264 {
265         RAII_VAR(struct ast_json *, message, NULL, ast_json_unref);
266         va_list ap;
267
268         va_start(ap, message_fmt);
269         message = ast_json_vstringf(message_fmt, ap);
270         va_end(ap);
271         response->message = ast_json_pack("{s: o}",
272                                           "message", ast_json_ref(message));
273         response->response_code = response_code;
274         response->response_text = response_text;
275 }
276
277 void ast_ari_response_ok(struct ast_ari_response *response,
278                              struct ast_json *message)
279 {
280         response->message = message;
281         response->response_code = 200;
282         response->response_text = "OK";
283 }
284
285 void ast_ari_response_no_content(struct ast_ari_response *response)
286 {
287         response->message = ast_json_null();
288         response->response_code = 204;
289         response->response_text = "No Content";
290 }
291
292 void ast_ari_response_accepted(struct ast_ari_response *response)
293 {
294         response->message = ast_json_null();
295         response->response_code = 202;
296         response->response_text = "Accepted";
297 }
298
299 void ast_ari_response_alloc_failed(struct ast_ari_response *response)
300 {
301         response->message = ast_json_ref(oom_json);
302         response->response_code = 500;
303         response->response_text = "Internal Server Error";
304 }
305
306 void ast_ari_response_created(struct ast_ari_response *response,
307         const char *url, struct ast_json *message)
308 {
309         RAII_VAR(struct stasis_rest_handlers *, root, get_root_handler(), ao2_cleanup);
310         response->message = message;
311         response->response_code = 201;
312         response->response_text = "Created";
313         ast_str_append(&response->headers, 0, "Location: /%s%s\r\n", root->path_segment, url);
314 }
315
316 static void add_allow_header(struct stasis_rest_handlers *handler,
317                              struct ast_ari_response *response)
318 {
319         enum ast_http_method m;
320         ast_str_append(&response->headers, 0,
321                        "Allow: OPTIONS");
322         for (m = 0; m < AST_HTTP_MAX_METHOD; ++m) {
323                 if (handler->callbacks[m] != NULL) {
324                         ast_str_append(&response->headers, 0,
325                                        ",%s", ast_get_http_method(m));
326                 }
327         }
328         ast_str_append(&response->headers, 0, "\r\n");
329 }
330
331 static int origin_allowed(const char *origin)
332 {
333         RAII_VAR(struct ast_ari_conf *, cfg, ast_ari_config_get(), ao2_cleanup);
334
335         char *allowed = ast_strdupa(cfg->general->allowed_origins);
336         char *current;
337
338         while ((current = strsep(&allowed, ","))) {
339                 if (!strcmp(current, "*")) {
340                         return 1;
341                 }
342
343                 if (!strcmp(current, origin)) {
344                         return 1;
345                 }
346         }
347
348         return 0;
349 }
350
351 #define ACR_METHOD "Access-Control-Request-Method"
352 #define ACR_HEADERS "Access-Control-Request-Headers"
353 #define ACA_METHODS "Access-Control-Allow-Methods"
354 #define ACA_HEADERS "Access-Control-Allow-Headers"
355
356 /*!
357  * \brief Handle OPTIONS request, mainly for CORS preflight requests.
358  *
359  * Some browsers will send this prior to non-simple methods (i.e. DELETE).
360  * See http://www.w3.org/TR/cors/ for the spec. Especially section 6.2.
361  */
362 static void handle_options(struct stasis_rest_handlers *handler,
363                            struct ast_variable *headers,
364                            struct ast_ari_response *response)
365 {
366         struct ast_variable *header;
367         char const *acr_method = NULL;
368         char const *acr_headers = NULL;
369         char const *origin = NULL;
370
371         RAII_VAR(struct ast_str *, allow, NULL, ast_free);
372         enum ast_http_method m;
373         int allowed = 0;
374
375         /* Regular OPTIONS response */
376         add_allow_header(handler, response);
377         ast_ari_response_no_content(response);
378
379         /* Parse CORS headers */
380         for (header = headers; header != NULL; header = header->next) {
381                 if (strcmp(ACR_METHOD, header->name) == 0) {
382                         acr_method = header->value;
383                 } else if (strcmp(ACR_HEADERS, header->name) == 0) {
384                         acr_headers = header->value;
385                 } else if (strcmp("Origin", header->name) == 0) {
386                         origin = header->value;
387                 }
388         }
389
390         /* CORS 6.2, #1 - "If the Origin header is not present terminate this
391          * set of steps."
392          */
393         if (origin == NULL) {
394                 return;
395         }
396
397         /* CORS 6.2, #2 - "If the value of the Origin header is not a
398          * case-sensitive match for any of the values in list of origins do not
399          * set any additional headers and terminate this set of steps.
400          *
401          * Always matching is acceptable since the list of origins can be
402          * unbounded.
403          *
404          * The Origin header can only contain a single origin as the user agent
405          * will not follow redirects."
406          */
407         if (!origin_allowed(origin)) {
408                 ast_log(LOG_NOTICE, "Origin header '%s' does not match an allowed origin.\n", origin);
409                 return;
410         }
411
412         /* CORS 6.2, #3 - "If there is no Access-Control-Request-Method header
413          * or if parsing failed, do not set any additional headers and terminate
414          * this set of steps."
415          */
416         if (acr_method == NULL) {
417                 return;
418         }
419
420         /* CORS 6.2, #4 - "If there are no Access-Control-Request-Headers
421          * headers let header field-names be the empty list."
422          */
423         if (acr_headers == NULL) {
424                 acr_headers = "";
425         }
426
427         /* CORS 6.2, #5 - "If method is not a case-sensitive match for any of
428          * the values in list of methods do not set any additional headers and
429          * terminate this set of steps."
430          */
431         allow = ast_str_create(20);
432
433         if (!allow) {
434                 ast_ari_response_alloc_failed(response);
435                 return;
436         }
437
438         /* Go ahead and build the ACA_METHODS header at the same time */
439         for (m = 0; m < AST_HTTP_MAX_METHOD; ++m) {
440                 if (handler->callbacks[m] != NULL) {
441                         char const *m_str = ast_get_http_method(m);
442                         if (strcmp(m_str, acr_method) == 0) {
443                                 allowed = 1;
444                         }
445                         ast_str_append(&allow, 0, ",%s", m_str);
446                 }
447         }
448
449         if (!allowed) {
450                 return;
451         }
452
453         /* CORS 6.2 #6 - "If any of the header field-names is not a ASCII
454          * case-insensitive match for any of the values in list of headers do
455          * not set any additional headers and terminate this set of steps.
456          *
457          * Note: Always matching is acceptable since the list of headers can be
458          * unbounded."
459          */
460
461         /* CORS 6.2 #7 - "If the resource supports credentials add a single
462          * Access-Control-Allow-Origin header, with the value of the Origin
463          * header as value, and add a single Access-Control-Allow-Credentials
464          * header with the case-sensitive string "true" as value."
465          *
466          * Added by process_cors_request() earlier in the request.
467          */
468
469         /* CORS 6.2 #8 - "Optionally add a single Access-Control-Max-Age
470          * header..."
471          */
472
473         /* CORS 6.2 #9 - "Add one or more Access-Control-Allow-Methods headers
474          * consisting of (a subset of) the list of methods."
475          */
476         ast_str_append(&response->headers, 0, "%s: OPTIONS%s\r\n",
477                        ACA_METHODS, ast_str_buffer(allow));
478
479
480         /* CORS 6.2, #10 - "Add one or more Access-Control-Allow-Headers headers
481          * consisting of (a subset of) the list of headers.
482          *
483          * Since the list of headers can be unbounded simply returning headers
484          * can be enough."
485          */
486         if (!ast_strlen_zero(acr_headers)) {
487                 ast_str_append(&response->headers, 0, "%s: %s\r\n",
488                                ACA_HEADERS, acr_headers);
489         }
490 }
491
492 void ast_ari_invoke(struct ast_tcptls_session_instance *ser,
493         const char *uri, enum ast_http_method method,
494         struct ast_variable *get_params, struct ast_variable *headers,
495         struct ast_json *body, struct ast_ari_response *response)
496 {
497         RAII_VAR(struct stasis_rest_handlers *, root, NULL, ao2_cleanup);
498         struct stasis_rest_handlers *handler;
499         RAII_VAR(struct ast_variable *, path_vars, NULL, ast_variables_destroy);
500         char *path = ast_strdupa(uri);
501         char *path_segment;
502         stasis_rest_callback callback;
503
504         root = handler = get_root_handler();
505         ast_assert(root != NULL);
506
507         while ((path_segment = strsep(&path, "/")) && (strlen(path_segment) > 0)) {
508                 struct stasis_rest_handlers *found_handler = NULL;
509                 int i;
510
511                 ast_uri_decode(path_segment, ast_uri_http_legacy);
512                 ast_debug(3, "Finding handler for %s\n", path_segment);
513
514                 for (i = 0; found_handler == NULL && i < handler->num_children; ++i) {
515                         struct stasis_rest_handlers *child = handler->children[i];
516
517                         ast_debug(3, "  Checking %s\n", child->path_segment);
518                         if (child->is_wildcard) {
519                                 /* Record the path variable */
520                                 struct ast_variable *path_var = ast_variable_new(child->path_segment, path_segment, __FILE__);
521                                 path_var->next = path_vars;
522                                 path_vars = path_var;
523                                 found_handler = child;
524                         } else if (strcmp(child->path_segment, path_segment) == 0) {
525                                 found_handler = child;
526                         }
527                 }
528
529                 if (found_handler == NULL) {
530                         /* resource not found */
531                         ast_debug(3, "  Handler not found\n");
532                         ast_ari_response_error(
533                                 response, 404, "Not Found",
534                                 "Resource not found");
535                         return;
536                 } else {
537                         ast_debug(3, "  Got it!\n");
538                         handler = found_handler;
539                 }
540         }
541
542         ast_assert(handler != NULL);
543         if (method == AST_HTTP_OPTIONS) {
544                 handle_options(handler, headers, response);
545                 return;
546         }
547
548         if (method < 0 || method >= AST_HTTP_MAX_METHOD) {
549                 add_allow_header(handler, response);
550                 ast_ari_response_error(
551                         response, 405, "Method Not Allowed",
552                         "Invalid method");
553                 return;
554         }
555
556         if (handler->ws_server && method == AST_HTTP_GET) {
557                 /* WebSocket! */
558                 ari_handle_websocket(handler->ws_server, ser, uri, method,
559                         get_params, headers);
560                 /* Since the WebSocket code handles the connection, we shouldn't
561                  * do anything else; setting no_response */
562                 response->no_response = 1;
563                 return;
564         }
565
566         callback = handler->callbacks[method];
567         if (callback == NULL) {
568                 add_allow_header(handler, response);
569                 ast_ari_response_error(
570                         response, 405, "Method Not Allowed",
571                         "Invalid method");
572                 return;
573         }
574
575         callback(ser, get_params, path_vars, headers, body, response);
576         if (response->message == NULL && response->response_code == 0) {
577                 /* Really should not happen */
578                 ast_log(LOG_ERROR, "ARI %s %s not implemented\n",
579                         ast_get_http_method(method), uri);
580                 ast_ari_response_error(
581                         response, 501, "Not Implemented",
582                         "Method not implemented");
583         }
584 }
585
586 void ast_ari_get_docs(const char *uri, const char *prefix, struct ast_variable *headers,
587                           struct ast_ari_response *response)
588 {
589         RAII_VAR(struct ast_str *, absolute_path_builder, NULL, ast_free);
590         RAII_VAR(char *, absolute_api_dirname, NULL, ast_std_free);
591         RAII_VAR(char *, absolute_filename, NULL, ast_std_free);
592         struct ast_json *obj = NULL;
593         struct ast_variable *host = NULL;
594         struct ast_json_error error = {};
595         struct stat file_stat;
596
597         ast_debug(3, "%s(%s)\n", __func__, uri);
598
599         absolute_path_builder = ast_str_create(80);
600         if (absolute_path_builder == NULL) {
601                 ast_ari_response_alloc_failed(response);
602                 return;
603         }
604
605         /* absolute path to the rest-api directory */
606         ast_str_append(&absolute_path_builder, 0, "%s", ast_config_AST_DATA_DIR);
607         ast_str_append(&absolute_path_builder, 0, "/rest-api/");
608         absolute_api_dirname = realpath(ast_str_buffer(absolute_path_builder), NULL);
609         if (absolute_api_dirname == NULL) {
610                 ast_log(LOG_ERROR, "Error determining real directory for rest-api\n");
611                 ast_ari_response_error(
612                         response, 500, "Internal Server Error",
613                         "Cannot find rest-api directory");
614                 return;
615         }
616
617         /* absolute path to the requested file */
618         ast_str_append(&absolute_path_builder, 0, "%s", uri);
619         absolute_filename = realpath(ast_str_buffer(absolute_path_builder), NULL);
620         if (absolute_filename == NULL) {
621                 switch (errno) {
622                 case ENAMETOOLONG:
623                 case ENOENT:
624                 case ENOTDIR:
625                         ast_ari_response_error(
626                                 response, 404, "Not Found",
627                                 "Resource not found");
628                         break;
629                 case EACCES:
630                         ast_ari_response_error(
631                                 response, 403, "Forbidden",
632                                 "Permission denied");
633                         break;
634                 default:
635                         ast_log(LOG_ERROR,
636                                 "Error determining real path for uri '%s': %s\n",
637                                 uri, strerror(errno));
638                         ast_ari_response_error(
639                                 response, 500, "Internal Server Error",
640                                 "Cannot find file");
641                         break;
642                 }
643                 return;
644         }
645
646         if (!ast_begins_with(absolute_filename, absolute_api_dirname)) {
647                 /* HACKERZ! */
648                 ast_log(LOG_ERROR,
649                         "Invalid attempt to access '%s' (not in %s)\n",
650                         absolute_filename, absolute_api_dirname);
651                 ast_ari_response_error(
652                         response, 404, "Not Found",
653                         "Resource not found");
654                 return;
655         }
656
657         if (stat(absolute_filename, &file_stat) == 0) {
658                 if (!(file_stat.st_mode & S_IFREG)) {
659                         /* Not a file */
660                         ast_ari_response_error(
661                                 response, 403, "Forbidden",
662                                 "Invalid access");
663                         return;
664                 }
665         } else {
666                 /* Does not exist */
667                 ast_ari_response_error(
668                         response, 404, "Not Found",
669                         "Resource not found");
670                 return;
671         }
672
673         /* Load resource object from file */
674         obj = ast_json_load_new_file(absolute_filename, &error);
675         if (obj == NULL) {
676                 ast_log(LOG_ERROR, "Error parsing resource file: %s:%d(%d) %s\n",
677                         error.source, error.line, error.column, error.text);
678                 ast_ari_response_error(
679                         response, 500, "Internal Server Error",
680                         "Yikes! Cannot parse resource");
681                 return;
682         }
683
684         /* Update the basePath properly */
685         if (ast_json_object_get(obj, "basePath") != NULL) {
686                 for (host = headers; host; host = host->next) {
687                         if (strcasecmp(host->name, "Host") == 0) {
688                                 break;
689                         }
690                 }
691                 if (host != NULL) {
692                         if (prefix != NULL && strlen(prefix) > 0) {
693                                 ast_json_object_set(
694                                         obj, "basePath",
695                                         ast_json_stringf("http://%s%s/ari", host->value,prefix));
696                         } else {
697                                 ast_json_object_set(
698                                         obj, "basePath",
699                                         ast_json_stringf("http://%s/ari", host->value));
700                         }
701                 } else {
702                         /* Without the host, we don't have the basePath */
703                         ast_json_object_del(obj, "basePath");
704                 }
705         }
706
707         ast_ari_response_ok(response, obj);
708 }
709
710 static void remove_trailing_slash(const char *uri,
711                                   struct ast_ari_response *response)
712 {
713         char *slashless = ast_strdupa(uri);
714         slashless[strlen(slashless) - 1] = '\0';
715
716         /* While it's tempting to redirect the client to the slashless URL,
717          * that is problematic. A 302 Found is the most appropriate response,
718          * but most clients issue a GET on the location you give them,
719          * regardless of the method of the original request.
720          *
721          * While there are some ways around this, it gets into a lot of client
722          * specific behavior and corner cases in the HTTP standard. There's also
723          * very little practical benefit of redirecting; only GET and HEAD can
724          * be redirected automagically; all other requests "MUST NOT
725          * automatically redirect the request unless it can be confirmed by the
726          * user, since this might change the conditions under which the request
727          * was issued."
728          *
729          * Given all of that, a 404 with a nice message telling them what to do
730          * is probably our best bet.
731          */
732         ast_ari_response_error(response, 404, "Not Found",
733                 "ARI URLs do not end with a slash. Try /ari/%s", slashless);
734 }
735
736 /*!
737  * \brief Handle CORS headers for simple requests.
738  *
739  * See http://www.w3.org/TR/cors/ for the spec. Especially section 6.1.
740  */
741 static void process_cors_request(struct ast_variable *headers,
742                                  struct ast_ari_response *response)
743 {
744         char const *origin = NULL;
745         struct ast_variable *header;
746
747         /* Parse CORS headers */
748         for (header = headers; header != NULL; header = header->next) {
749                 if (strcmp("Origin", header->name) == 0) {
750                         origin = header->value;
751                 }
752         }
753
754         /* CORS 6.1, #1 - "If the Origin header is not present terminate this
755          * set of steps."
756          */
757         if (origin == NULL) {
758                 return;
759         }
760
761         /* CORS 6.1, #2 - "If the value of the Origin header is not a
762          * case-sensitive match for any of the values in list of origins, do not
763          * set any additional headers and terminate this set of steps.
764          *
765          * Note: Always matching is acceptable since the list of origins can be
766          * unbounded."
767          */
768         if (!origin_allowed(origin)) {
769                 ast_log(LOG_NOTICE, "Origin header '%s' does not match an allowed origin.\n", origin);
770                 return;
771         }
772
773         /* CORS 6.1, #3 - "If the resource supports credentials add a single
774          * Access-Control-Allow-Origin header, with the value of the Origin
775          * header as value, and add a single Access-Control-Allow-Credentials
776          * header with the case-sensitive string "true" as value.
777          *
778          * Otherwise, add a single Access-Control-Allow-Origin header, with
779          * either the value of the Origin header or the string "*" as value."
780          */
781         ast_str_append(&response->headers, 0,
782                        "Access-Control-Allow-Origin: %s\r\n", origin);
783         ast_str_append(&response->headers, 0,
784                        "Access-Control-Allow-Credentials: true\r\n");
785
786         /* CORS 6.1, #4 - "If the list of exposed headers is not empty add one
787          * or more Access-Control-Expose-Headers headers, with as values the
788          * header field names given in the list of exposed headers."
789          *
790          * No exposed headers; skipping
791          */
792 }
793
794 enum ast_json_encoding_format ast_ari_json_format(void)
795 {
796         RAII_VAR(struct ast_ari_conf *, cfg, NULL, ao2_cleanup);
797         cfg = ast_ari_config_get();
798         return cfg->general->format;
799 }
800
801 /*!
802  * \brief Authenticate a <code>?api_key=userid:password</code>
803  *
804  * \param api_key API key query parameter
805  * \return User object for the authenticated user.
806  * \return \c NULL if authentication failed.
807  */
808 static struct ast_ari_conf_user *authenticate_api_key(const char *api_key)
809 {
810         RAII_VAR(char *, copy, NULL, ast_free);
811         char *username;
812         char *password;
813
814         password = copy = ast_strdup(api_key);
815         if (!copy) {
816                 return NULL;
817         }
818
819         username = strsep(&password, ":");
820         if (!password) {
821                 ast_log(LOG_WARNING, "Invalid api_key\n");
822                 return NULL;
823         }
824
825         return ast_ari_config_validate_user(username, password);
826 }
827
828 /*!
829  * \brief Authenticate an HTTP request.
830  *
831  * \param get_params GET parameters of the request.
832  * \param header HTTP headers.
833  * \return User object for the authenticated user.
834  * \return \c NULL if authentication failed.
835  */
836 static struct ast_ari_conf_user *authenticate_user(struct ast_variable *get_params,
837         struct ast_variable *headers)
838 {
839         RAII_VAR(struct ast_http_auth *, http_auth, NULL, ao2_cleanup);
840         struct ast_variable *v;
841
842         /* HTTP Basic authentication */
843         http_auth = ast_http_get_auth(headers);
844         if (http_auth) {
845                 return ast_ari_config_validate_user(http_auth->userid,
846                         http_auth->password);
847         }
848
849         /* ?api_key authentication */
850         for (v = get_params; v; v = v->next) {
851                 if (strcasecmp("api_key", v->name) == 0) {
852                         return authenticate_api_key(v->value);
853                 }
854         }
855
856         return NULL;
857 }
858
859 /*!
860  * \internal
861  * \brief ARI HTTP handler.
862  *
863  * This handler takes the HTTP request and turns it into the appropriate
864  * RESTful request (conversion to JSON, routing, etc.)
865  *
866  * \param ser TCP session.
867  * \param urih URI handler.
868  * \param uri URI requested.
869  * \param method HTTP method.
870  * \param get_params HTTP \c GET params.
871  * \param headers HTTP headers.
872  */
873 static int ast_ari_callback(struct ast_tcptls_session_instance *ser,
874                                 const struct ast_http_uri *urih,
875                                 const char *uri,
876                                 enum ast_http_method method,
877                                 struct ast_variable *get_params,
878                                 struct ast_variable *headers)
879 {
880         RAII_VAR(struct ast_ari_conf *, conf, NULL, ao2_cleanup);
881         RAII_VAR(struct ast_str *, response_body, ast_str_create(256), ast_free);
882         RAII_VAR(struct ast_ari_conf_user *, user, NULL, ao2_cleanup);
883         struct ast_ari_response response = { .fd = -1, 0 };
884         RAII_VAR(struct ast_variable *, post_vars, NULL, ast_variables_destroy);
885         struct ast_variable *var;
886         const char *app_name = NULL;
887         RAII_VAR(struct ast_json *, body, ast_json_null(), ast_json_free);
888         int debug_app = 0;
889
890         if (!response_body) {
891                 ast_http_request_close_on_completion(ser);
892                 ast_http_error(ser, 500, "Server Error", "Out of memory");
893                 return 0;
894         }
895
896         response.headers = ast_str_create(40);
897         if (!response.headers) {
898                 ast_http_request_close_on_completion(ser);
899                 ast_http_error(ser, 500, "Server Error", "Out of memory");
900                 return 0;
901         }
902
903         conf = ast_ari_config_get();
904         if (!conf || !conf->general) {
905                 ast_free(response.headers);
906                 ast_http_request_close_on_completion(ser);
907                 ast_http_error(ser, 500, "Server Error", "URI handler config missing");
908                 return 0;
909         }
910
911         process_cors_request(headers, &response);
912
913         /* Process form data from a POST. It could be mixed with query
914          * parameters, which seems a bit odd. But it's allowed, so that's okay
915          * with us.
916          */
917         post_vars = ast_http_get_post_vars(ser, headers);
918         if (!post_vars) {
919                 switch (errno) {
920                 case EFBIG:
921                         ast_ari_response_error(&response, 413,
922                                 "Request Entity Too Large",
923                                 "Request body too large");
924                         goto request_failed;
925                 case ENOMEM:
926                         ast_http_request_close_on_completion(ser);
927                         ast_ari_response_error(&response, 500,
928                                 "Internal Server Error",
929                                 "Out of memory");
930                         goto request_failed;
931                 case EIO:
932                         ast_ari_response_error(&response, 400,
933                                 "Bad Request", "Error parsing request body");
934                         goto request_failed;
935                 }
936
937                 /* Look for a JSON request entity only if there were no post_vars.
938                  * If there were post_vars, then the request body would already have
939                  * been consumed and can not be read again.
940                  */
941                 body = ast_http_get_json(ser, headers);
942                 if (!body) {
943                         switch (errno) {
944                         case EFBIG:
945                                 ast_ari_response_error(&response, 413, "Request Entity Too Large", "Request body too large");
946                                 goto request_failed;
947                         case ENOMEM:
948                                 ast_ari_response_error(&response, 500, "Internal Server Error", "Error processing request");
949                                 goto request_failed;
950                         case EIO:
951                                 ast_ari_response_error(&response, 400, "Bad Request", "Error parsing request body");
952                                 goto request_failed;
953                         }
954                 }
955         }
956         if (get_params == NULL) {
957                 get_params = post_vars;
958         } else if (get_params && post_vars) {
959                 /* Has both post_vars and get_params */
960                 struct ast_variable *last_var = post_vars;
961                 while (last_var->next) {
962                         last_var = last_var->next;
963                 }
964                 /* The duped get_params will get freed when post_vars gets
965                  * ast_variables_destroyed.
966                  */
967                 last_var->next = ast_variables_dup(get_params);
968                 get_params = post_vars;
969         }
970
971         /* At this point, get_params will contain post_vars (if any) */
972         app_name = ast_variable_find_in_list(get_params, "app");
973         if (!app_name) {
974                 struct ast_json *app = ast_json_object_get(body, "app");
975
976                 app_name = (app ? ast_json_string_get(app) : NULL);
977         }
978
979         /* stasis_app_get_debug_by_name returns an "||" of the app's debug flag
980          * and the global debug flag.
981          */
982         debug_app = stasis_app_get_debug_by_name(app_name);
983         if (debug_app) {
984                 struct ast_str *buf = ast_str_create(512);
985                 char *str = ast_json_dump_string_format(body, ast_ari_json_format());
986
987                 if (!buf) {
988                         ast_http_request_close_on_completion(ser);
989                         ast_http_error(ser, 500, "Server Error", "Out of memory");
990                         goto request_failed;
991                 }
992
993                 ast_str_append(&buf, 0, "<--- ARI request received from: %s --->\n",
994                         ast_sockaddr_stringify(&ser->remote_address));
995                 for (var = headers; var; var = var->next) {
996                         ast_str_append(&buf, 0, "%s: %s\n", var->name, var->value);
997                 }
998                 for (var = get_params; var; var = var->next) {
999                         ast_str_append(&buf, 0, "%s: %s\n", var->name, var->value);
1000                 }
1001                 ast_verbose("%sbody:\n%s\n\n", ast_str_buffer(buf), str);
1002                 ast_json_free(str);
1003                 ast_free(buf);
1004         }
1005
1006         user = authenticate_user(get_params, headers);
1007         if (response.response_code > 0) {
1008                 /* POST parameter processing error. Do nothing. */
1009         } else if (!user) {
1010                 /* Per RFC 2617, section 1.2: The 401 (Unauthorized) response
1011                  * message is used by an origin server to challenge the
1012                  * authorization of a user agent. This response MUST include a
1013                  * WWW-Authenticate header field containing at least one
1014                  * challenge applicable to the requested resource.
1015                  */
1016                 ast_ari_response_error(&response, 401, "Unauthorized", "Authentication required");
1017
1018                 /* Section 1.2:
1019                  *   realm       = "realm" "=" realm-value
1020                  *   realm-value = quoted-string
1021                  * Section 2:
1022                  *   challenge   = "Basic" realm
1023                  */
1024                 ast_str_append(&response.headers, 0,
1025                         "WWW-Authenticate: Basic realm=\"%s\"\r\n",
1026                         conf->general->auth_realm);
1027         } else if (!ast_fully_booted) {
1028                 ast_http_request_close_on_completion(ser);
1029                 ast_ari_response_error(&response, 503, "Service Unavailable", "Asterisk not booted");
1030         } else if (user->read_only && method != AST_HTTP_GET && method != AST_HTTP_OPTIONS) {
1031                 ast_ari_response_error(&response, 403, "Forbidden", "Write access denied");
1032         } else if (ast_ends_with(uri, "/")) {
1033                 remove_trailing_slash(uri, &response);
1034         } else if (ast_begins_with(uri, "api-docs/")) {
1035                 /* Serving up API docs */
1036                 if (method != AST_HTTP_GET) {
1037                         ast_ari_response_error(&response, 405, "Method Not Allowed", "Unsupported method");
1038                 } else {
1039                         /* Skip the api-docs prefix */
1040                         ast_ari_get_docs(strchr(uri, '/') + 1, urih->prefix, headers, &response);
1041                 }
1042         } else {
1043                 /* Other RESTful resources */
1044                 ast_ari_invoke(ser, uri, method, get_params, headers, body,
1045                         &response);
1046         }
1047
1048         if (response.no_response) {
1049                 /* The handler indicates no further response is necessary.
1050                  * Probably because it already handled it */
1051                 ast_free(response.headers);
1052                 return 0;
1053         }
1054
1055 request_failed:
1056
1057         /* If you explicitly want to have no content, set message to
1058          * ast_json_null().
1059          */
1060         ast_assert(response.message != NULL);
1061         ast_assert(response.response_code > 0);
1062
1063         /* response.message could be NULL, in which case the empty response_body
1064          * is correct
1065          */
1066         if (response.message && !ast_json_is_null(response.message)) {
1067                 ast_str_append(&response.headers, 0,
1068                                "Content-type: application/json\r\n");
1069                 if (ast_json_dump_str_format(response.message, &response_body,
1070                                 conf->general->format) != 0) {
1071                         /* Error encoding response */
1072                         response.response_code = 500;
1073                         response.response_text = "Internal Server Error";
1074                         ast_str_set(&response_body, 0, "%s", "");
1075                         ast_str_set(&response.headers, 0, "%s", "");
1076                 }
1077         }
1078
1079         if (debug_app) {
1080                 ast_verbose("<--- Sending ARI response to %s --->\n%d %s\n%s%s\n\n",
1081                         ast_sockaddr_stringify(&ser->remote_address), response.response_code,
1082                         response.response_text, ast_str_buffer(response.headers),
1083                         ast_str_buffer(response_body));
1084         }
1085
1086         ast_http_send(ser, method, response.response_code,
1087                       response.response_text, response.headers, response_body,
1088                       response.fd != -1 ? response.fd : 0, 0);
1089         /* ast_http_send takes ownership, so we don't have to free them */
1090         response_body = NULL;
1091
1092         ast_json_unref(response.message);
1093         if (response.fd >= 0) {
1094                 close(response.fd);
1095         }
1096         return 0;
1097 }
1098
1099 static struct ast_http_uri http_uri = {
1100         .callback = ast_ari_callback,
1101         .description = "Asterisk RESTful API",
1102         .uri = "ari",
1103         .has_subtree = 1,
1104         .data = NULL,
1105         .key = __FILE__,
1106         .no_decode_uri = 1,
1107 };
1108
1109 static int unload_module(void)
1110 {
1111         ast_ari_cli_unregister();
1112
1113         if (is_enabled()) {
1114                 ast_debug(3, "Disabling ARI\n");
1115                 ast_http_uri_unlink(&http_uri);
1116         }
1117
1118         ast_ari_config_destroy();
1119
1120         ao2_cleanup(root_handler);
1121         root_handler = NULL;
1122         ast_mutex_destroy(&root_handler_lock);
1123
1124         ast_json_unref(oom_json);
1125         oom_json = NULL;
1126
1127         return 0;
1128 }
1129
1130 static int load_module(void)
1131 {
1132         ast_mutex_init(&root_handler_lock);
1133
1134         /* root_handler may have been built during a declined load */
1135         if (!root_handler) {
1136                 root_handler = root_handler_create();
1137         }
1138         if (!root_handler) {
1139                 return AST_MODULE_LOAD_DECLINE;
1140         }
1141
1142         /* oom_json may have been built during a declined load */
1143         if (!oom_json) {
1144                 oom_json = ast_json_pack(
1145                         "{s: s}", "error", "Allocation failed");
1146         }
1147         if (!oom_json) {
1148                 /* Ironic */
1149                 unload_module();
1150                 return AST_MODULE_LOAD_DECLINE;
1151         }
1152
1153         if (ast_ari_config_init() != 0) {
1154                 unload_module();
1155                 return AST_MODULE_LOAD_DECLINE;
1156         }
1157
1158         if (is_enabled()) {
1159                 ast_debug(3, "ARI enabled\n");
1160                 ast_http_uri_link(&http_uri);
1161         } else {
1162                 ast_debug(3, "ARI disabled\n");
1163         }
1164
1165         if (ast_ari_cli_register() != 0) {
1166                 unload_module();
1167                 return AST_MODULE_LOAD_DECLINE;
1168         }
1169
1170         return AST_MODULE_LOAD_SUCCESS;
1171 }
1172
1173 static int reload_module(void)
1174 {
1175         char was_enabled = is_enabled();
1176
1177         if (ast_ari_config_reload() != 0) {
1178                 return AST_MODULE_LOAD_DECLINE;
1179         }
1180
1181         if (was_enabled && !is_enabled()) {
1182                 ast_debug(3, "Disabling ARI\n");
1183                 ast_http_uri_unlink(&http_uri);
1184         } else if (!was_enabled && is_enabled()) {
1185                 ast_debug(3, "Enabling ARI\n");
1186                 ast_http_uri_link(&http_uri);
1187         }
1188
1189         return AST_MODULE_LOAD_SUCCESS;
1190 }
1191
1192 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER, "Asterisk RESTful Interface",
1193         .support_level = AST_MODULE_SUPPORT_CORE,
1194         .load = load_module,
1195         .unload = unload_module,
1196         .reload = reload_module,
1197         .nonoptreq = "res_http_websocket",
1198         .load_pri = AST_MODPRI_APP_DEPEND,
1199 );