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