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