Asterisk - The Open Source Telephony Project GIT-master-4f2b068
Loading...
Searching...
No Matches
http.c
Go to the documentation of this file.
1/*
2 * Asterisk -- An open source telephony toolkit.
3 *
4 * Copyright (C) 1999 - 2006, Digium, Inc.
5 *
6 * Mark Spencer <markster@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/*!
20 * \file
21 * \brief http server for AMI access
22 *
23 * \author Mark Spencer <markster@digium.com>
24 *
25 * This program implements a tiny http server
26 * and was inspired by micro-httpd by Jef Poskanzer
27 *
28 * GMime http://spruce.sourceforge.net/gmime/
29 *
30 * \ref AstHTTP - AMI over the http protocol
31 */
32
33/*! \li \ref http.c uses the configuration file \ref http.conf
34 * \addtogroup configuration_file
35 */
36
37/*! \page http.conf http.conf
38 * \verbinclude http.conf.sample
39 */
40
41/*** MODULEINFO
42 <support_level>core</support_level>
43 ***/
44
45#include "asterisk.h"
46
47#include <time.h>
48#include <sys/time.h>
49#include <sys/stat.h>
50#include <signal.h>
51#include <fcntl.h>
52
53#include "asterisk/paths.h" /* use ast_config_AST_DATA_DIR */
54#include "asterisk/cli.h"
55#include "asterisk/tcptls.h"
56#include "asterisk/http.h"
57#include "asterisk/utils.h"
58#include "asterisk/strings.h"
59#include "asterisk/config.h"
62#include "asterisk/manager.h"
63#include "asterisk/module.h"
64#include "asterisk/astobj2.h"
65#include "asterisk/netsock2.h"
66#include "asterisk/json.h"
67
68#define MAX_PREFIX 80
69#define DEFAULT_PORT 8088
70#define DEFAULT_TLS_PORT 8089
71#define DEFAULT_SESSION_LIMIT 100
72/*! (ms) Idle time waiting for data. */
73#define DEFAULT_SESSION_INACTIVITY 30000
74/*! (ms) Min timeout for initial HTTP request to start coming in. */
75#define MIN_INITIAL_REQUEST_TIMEOUT 10000
76/*! (ms) Idle time between HTTP requests */
77#define DEFAULT_SESSION_KEEP_ALIVE 15000
78/*! Max size for the http server name */
79#define MAX_SERVER_NAME_LENGTH 128
80/*! Max size for the http response header */
81#define DEFAULT_RESPONSE_HEADER_LENGTH 512
82
83/*! Maximum application/json or application/x-www-form-urlencoded body content length. */
84#if !defined(LOW_MEMORY)
85#define MAX_CONTENT_LENGTH 40960
86#else
87#define MAX_CONTENT_LENGTH 1024
88#endif /* !defined(LOW_MEMORY) */
89
90/*! Initial response body length. */
91#if !defined(LOW_MEMORY)
92#define INITIAL_RESPONSE_BODY_BUFFER 1024
93#else
94#define INITIAL_RESPONSE_BODY_BUFFER 512
95#endif /* !defined(LOW_MEMORY) */
96
97/*! Maximum line length for HTTP requests. */
98#if !defined(LOW_MEMORY)
99#define MAX_HTTP_LINE_LENGTH 4096
100#else
101#define MAX_HTTP_LINE_LENGTH 1024
102#endif /* !defined(LOW_MEMORY) */
103
105
109static int session_count = 0;
110
112
113static void *httpd_helper_thread(void *arg);
114
115/*!
116 * For standard configuration we have up to two accepting threads,
117 * one for http, one for https. If TEST_FRAMEWORK is enabled it's
118 * possible to have more than one running http server.
119 */
125
126/*!
127 * The default configured HTTP server
128 */
130
132 .accept_fd = -1,
133 .master = AST_PTHREADT_NULL,
134 .tls_cfg = &http_tls_cfg,
135 .poll_timeout = -1,
136 .name = "https server",
137 .accept_fn = ast_tcptls_server_root,
138 .worker_fn = httpd_helper_thread,
139};
140
141static AST_RWLIST_HEAD_STATIC(uris, ast_http_uri); /*!< list of supported handlers */
142
143/* all valid URIs must be prepended by the string in prefix. */
144static char prefix[MAX_PREFIX];
147
148/*! \brief Limit the kinds of files we're willing to serve up */
149static struct {
150 const char *ext;
151 const char *mtype;
152} mimetypes[] = {
153 { "png", "image/png" },
154 { "xml", "text/xml" },
155 { "jpg", "image/jpeg" },
156 { "js", "application/x-javascript" },
157 { "wav", "audio/x-wav" },
158 { "mp3", "audio/mpeg" },
159 { "svg", "image/svg+xml" },
160 { "svgz", "image/svg+xml" },
161 { "gif", "image/gif" },
162 { "html", "text/html" },
163 { "htm", "text/html" },
164 { "css", "text/css" },
165 { "cnf", "text/plain" },
166 { "cfg", "text/plain" },
167 { "bin", "application/octet-stream" },
168 { "sbn", "application/octet-stream" },
169 { "ld", "application/octet-stream" },
171
177
179
180static const struct ast_cfhttp_methods_text {
182 const char *text;
184 { AST_HTTP_UNKNOWN, "UNKNOWN" },
185 { AST_HTTP_GET, "GET" },
186 { AST_HTTP_POST, "POST" },
187 { AST_HTTP_HEAD, "HEAD" },
188 { AST_HTTP_PUT, "PUT" },
189 { AST_HTTP_DELETE, "DELETE" },
190 { AST_HTTP_OPTIONS, "OPTIONS" },
192
194{
195 int x;
196
197 for (x = 0; x < ARRAY_LEN(ast_http_methods_text); x++) {
199 return ast_http_methods_text[x].text;
200 }
201 }
202
203 return NULL;
204}
205
207{
208 int x;
209
210 for (x = 0; x < ARRAY_LEN(ast_http_methods_text); x++) {
213 }
214 }
215
216 return AST_HTTP_UNKNOWN;
217}
218
219const char *ast_http_ftype2mtype(const char *ftype)
220{
221 int x;
222
223 if (ftype) {
224 for (x = 0; x < ARRAY_LEN(mimetypes); x++) {
225 if (!strcasecmp(ftype, mimetypes[x].ext)) {
226 return mimetypes[x].mtype;
227 }
228 }
229 }
230 return NULL;
231}
232
233uint32_t ast_http_manid_from_vars(struct ast_variable *headers)
234{
235 uint32_t mngid = 0;
236 struct ast_variable *v, *cookies;
237
238 cookies = ast_http_get_cookies(headers);
239 for (v = cookies; v; v = v->next) {
240 if (!strcasecmp(v->name, "mansession_id")) {
241 sscanf(v->value, "%30x", &mngid);
242 break;
243 }
244 }
245 ast_variables_destroy(cookies);
246 return mngid;
247}
248
249void ast_http_prefix(char *buf, int len)
250{
251 if (buf) {
253 }
254}
255
257 const struct ast_http_uri *urih, const char *uri,
258 enum ast_http_method method, struct ast_variable *get_vars,
259 struct ast_variable *headers)
260{
261 char *path;
262 const char *ftype;
263 const char *mtype;
264 char wkspace[80];
265 struct stat st;
266 int len;
267 int fd;
268 struct ast_str *http_header;
269 struct timeval tv;
270 struct ast_tm tm;
271 char timebuf[80], etag[23];
272 struct ast_variable *v;
273 int not_modified = 0;
274
276 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
277 return 0;
278 }
279
280 /* Yuck. I'm not really sold on this, but if you don't deliver static content it
281 * makes your configuration substantially more challenging, but this seems like a
282 * rather irritating feature creep on Asterisk.
283 *
284 * XXX: It is not clear to me what this comment means or if it is any longer
285 * relevant. */
286 if (ast_strlen_zero(uri)) {
287 goto out403;
288 }
289
290 /* Disallow any funny filenames at all (checking first character only??) */
291 if ((uri[0] < 33) || strchr("./|~@#$%^&*() \t", uri[0])) {
292 goto out403;
293 }
294
295 if (strstr(uri, "/..")) {
296 goto out403;
297 }
298
299 if ((ftype = strrchr(uri, '.'))) {
300 ftype++;
301 }
302
303 if (!(mtype = ast_http_ftype2mtype(ftype))) {
304 snprintf(wkspace, sizeof(wkspace), "text/%s", S_OR(ftype, "plain"));
305 mtype = wkspace;
306 }
307
308 /* Cap maximum length */
309 if ((len = strlen(uri) + strlen(ast_config_AST_DATA_DIR) + strlen("/static-http/") + 5) > 1024) {
310 goto out403;
311 }
312
313 path = ast_alloca(len);
314 sprintf(path, "%s/static-http/%s", ast_config_AST_DATA_DIR, uri);
315 if (stat(path, &st)) {
316 goto out404;
317 }
318
319 if (S_ISDIR(st.st_mode)) {
320 goto out404;
321 }
322
323 if (strstr(path, "/private/") && !astman_is_authed(ast_http_manid_from_vars(headers))) {
324 goto out403;
325 }
326
327 fd = open(path, O_RDONLY);
328 if (fd < 0) {
329 goto out403;
330 }
331
332 /* make "Etag:" http header value */
333 snprintf(etag, sizeof(etag), "\"%ld\"", (long)st.st_mtime);
334
335 /* make "Last-Modified:" http header value */
336 tv.tv_sec = st.st_mtime;
337 tv.tv_usec = 0;
338 ast_strftime(timebuf, sizeof(timebuf), "%a, %d %b %Y %H:%M:%S GMT", ast_localtime(&tv, &tm, "GMT"));
339
340 /* check received "If-None-Match" request header and Etag value for file */
341 for (v = headers; v; v = v->next) {
342 if (!strcasecmp(v->name, "If-None-Match")) {
343 if (!strcasecmp(v->value, etag)) {
344 not_modified = 1;
345 }
346 break;
347 }
348 }
349
350 http_header = ast_str_create(255);
351 if (!http_header) {
353 ast_http_error(ser, 500, "Server Error", "Out of memory");
354 close(fd);
355 return 0;
356 }
357
358 ast_str_set(&http_header, 0, "Content-type: %s\r\n"
359 "ETag: %s\r\n"
360 "Last-Modified: %s\r\n",
361 mtype,
362 etag,
363 timebuf);
364
365 /* ast_http_send() frees http_header, so we don't need to do it before returning */
366 if (not_modified) {
367 ast_http_send(ser, method, 304, "Not Modified", http_header, NULL, 0, 1);
368 } else {
369 ast_http_send(ser, method, 200, NULL, http_header, NULL, fd, 1); /* static content flag is set */
370 }
371 close(fd);
372 return 0;
373
374out404:
375 ast_http_error(ser, 404, "Not Found", "The requested URL was not found on this server.");
376 return 0;
377
378out403:
380 ast_http_error(ser, 403, "Access Denied", "You do not have permission to access the requested URL.");
381 return 0;
382}
383
385 const struct ast_http_uri *urih, const char *uri,
386 enum ast_http_method method, struct ast_variable *get_vars,
387 struct ast_variable *headers)
388{
389 struct ast_str *out;
390 struct ast_variable *v, *cookies = NULL;
391
393 ast_http_error(ser, 501, "Not Implemented", "Attempt to use unimplemented / unsupported method");
394 return 0;
395 }
396
397 out = ast_str_create(512);
398 if (!out) {
400 ast_http_error(ser, 500, "Server Error", "Out of memory");
401 return 0;
402 }
403
405 "<html><title>Asterisk HTTP Status</title>\r\n"
406 "<body bgcolor=\"#ffffff\">\r\n"
407 "<table bgcolor=\"#f1f1f1\" align=\"center\"><tr><td bgcolor=\"#e0e0ff\" colspan=\"2\" width=\"500\">\r\n"
408 "<h2>&nbsp;&nbsp;Asterisk&trade; HTTP Status</h2></td></tr>\r\n");
409
410 ast_str_append(&out, 0, "<tr><td><i>Server</i></td><td><b>%s</b></td></tr>\r\n", http_server_name);
411 ast_str_append(&out, 0, "<tr><td><i>Prefix</i></td><td><b>%s</b></td></tr>\r\n", prefix);
412 if (global_http_server) {
413 ast_str_append(&out, 0, "<tr><td><i>Bind Address</i></td><td><b>%s</b></td></tr>\r\n",
415 }
416 if (http_tls_cfg.enabled) {
417 ast_str_append(&out, 0, "<tr><td><i>TLS Bind Address</i></td><td><b>%s</b></td></tr>\r\n",
419 }
420 ast_str_append(&out, 0, "<tr><td colspan=\"2\"><hr></td></tr>\r\n");
421 for (v = get_vars; v; v = v->next) {
422 ast_str_append(&out, 0, "<tr><td><i>Submitted GET Variable '%s'</i></td><td>%s</td></tr>\r\n", v->name, v->value);
423 }
424 ast_str_append(&out, 0, "<tr><td colspan=\"2\"><hr></td></tr>\r\n");
425
426 cookies = ast_http_get_cookies(headers);
427 for (v = cookies; v; v = v->next) {
428 ast_str_append(&out, 0, "<tr><td><i>Cookie '%s'</i></td><td>%s</td></tr>\r\n", v->name, v->value);
429 }
430 ast_variables_destroy(cookies);
431
432 ast_str_append(&out, 0, "</table><center><font size=\"-1\"><i>Asterisk and Digium are registered trademarks of Digium, Inc.</i></font></center></body></html>\r\n");
433 ast_http_send(ser, method, 200, NULL, NULL, out, 0, 0);
434 return 0;
435}
436
437static struct ast_http_uri status_uri = {
439 .description = "Asterisk HTTP General Status",
440 .uri = "httpstatus",
441 .has_subtree = 0,
442 .data = NULL,
443 .key = __FILE__,
444};
445
446static struct ast_http_uri static_uri = {
448 .description = "Asterisk HTTP Static Delivery",
449 .uri = "static",
450 .has_subtree = 1,
451 .data = NULL,
452 .key= __FILE__,
453};
454
456 /*! TRUE if the HTTP request has a body. */
458 /*! TRUE if the HTTP request body has been read. */
460 /*! TRUE if the HTTP request must close when completed. */
462};
463
464/*! HTTP tcptls worker_fn private data. */
466 /*! Body length or -1 if chunked. Valid if HTTP_FLAG_HAS_BODY is TRUE. */
468 /*! HTTP body tracking flags */
470};
471
473 enum ast_http_method method, int status_code, const char *status_title,
474 struct ast_str *http_header, struct ast_str *out, int fd,
475 unsigned int static_content)
476{
477 struct timeval now = ast_tvnow();
478 struct ast_tm tm;
479 char timebuf[80];
480 char buf[256];
481 int len;
482 int content_length = 0;
483 int close_connection;
484 struct ast_str *server_header_field = ast_str_create(MAX_SERVER_NAME_LENGTH);
485 int send_content;
486
487 if (!ser || !server_header_field) {
488 /* The connection is not open. */
489 ast_free(http_header);
490 ast_free(out);
491 ast_free(server_header_field);
492 return;
493 }
494
496 ast_str_set(&server_header_field,
497 0,
498 "Server: %s\r\n",
500 }
501
502 /*
503 * We shouldn't be sending non-final status codes to this
504 * function because we may close the connection before
505 * returning.
506 */
507 ast_assert(200 <= status_code);
508
509 if (session_keep_alive <= 0) {
510 close_connection = 1;
511 } else {
513
514 request = ser->private_data;
515 if (!request
517 || ast_http_body_discard(ser)) {
518 close_connection = 1;
519 } else {
520 close_connection = 0;
521 }
522 }
523
524 ast_strftime(timebuf, sizeof(timebuf), "%a, %d %b %Y %H:%M:%S GMT", ast_localtime(&now, &tm, "GMT"));
525
526 /* calc content length */
527 if (out) {
528 content_length += ast_str_strlen(out);
529 }
530
531 if (fd) {
532 content_length += lseek(fd, 0, SEEK_END);
533 lseek(fd, 0, SEEK_SET);
534 }
535
536 send_content = method != AST_HTTP_HEAD || status_code >= 400;
537
538 /* send http header */
540 "HTTP/1.1 %d %s\r\n"
541 "%s"
542 "Date: %s\r\n"
543 "%s"
544 "%s"
545 "%s"
546 "Content-Length: %d\r\n"
547 "\r\n"
548 "%s",
549 status_code, status_title ? status_title : "OK",
550 ast_str_buffer(server_header_field),
551 timebuf,
552 close_connection ? "Connection: close\r\n" : "",
553 static_content ? "" : "Cache-Control: no-cache, no-store\r\n",
554 http_header ? ast_str_buffer(http_header) : "",
555 content_length,
556 send_content && out && ast_str_strlen(out) ? ast_str_buffer(out) : ""
557 ) <= 0) {
558 ast_debug(1, "ast_iostream_printf() failed: %s\n", strerror(errno));
559 close_connection = 1;
560 } else if (send_content && fd) {
561 /* send file content */
562 while ((len = read(fd, buf, sizeof(buf))) > 0) {
563 if (ast_iostream_write(ser->stream, buf, len) != len) {
564 ast_debug(1, "ast_iostream_write() failed: %s\n", strerror(errno));
565 close_connection = 1;
566 break;
567 }
568 }
569 }
570
571 ast_free(http_header);
572 ast_free(out);
573 ast_free(server_header_field);
574
575 if (close_connection) {
576 ast_debug(1, "HTTP closing session. status_code:%d\n", status_code);
578 } else {
579 ast_debug(1, "HTTP keeping session open. status_code:%d\n", status_code);
580 }
581}
582
584 const char *status_title, struct ast_str *http_header_data, const char *text)
585{
586 char server_name[MAX_SERVER_NAME_LENGTH];
587 struct ast_str *server_address = ast_str_create(MAX_SERVER_NAME_LENGTH);
589
590 if (!http_header_data || !server_address || !out) {
591 ast_free(http_header_data);
592 ast_free(server_address);
593 ast_free(out);
594 if (ser) {
595 ast_debug(1, "HTTP closing session. OOM.\n");
597 }
598 return;
599 }
600
602 ast_xml_escape(http_server_name, server_name, sizeof(server_name));
603 ast_str_set(&server_address,
604 0,
605 "<address>%s</address>\r\n",
606 server_name);
607 }
608
610 0,
611 "<!DOCTYPE HTML PUBLIC \"-//IETF//DTD HTML 2.0//EN\">\r\n"
612 "<html><head>\r\n"
613 "<title>%d %s</title>\r\n"
614 "</head><body>\r\n"
615 "<h1>%s</h1>\r\n"
616 "<p>%s</p>\r\n"
617 "<hr />\r\n"
618 "%s"
619 "</body></html>\r\n",
620 status_code,
621 status_title,
622 status_title,
623 text ? text : "",
624 ast_str_buffer(server_address));
625
626 ast_free(server_address);
627
628 ast_http_send(ser,
630 status_code,
631 status_title,
632 http_header_data,
633 out,
634 0,
635 0);
636}
637
638void ast_http_auth(struct ast_tcptls_session_instance *ser, const char *realm,
639 const unsigned long nonce, const unsigned long opaque, int stale,
640 const char *text)
641{
642 int status_code = 401;
643 char *status_title = "Unauthorized";
644 struct ast_str *http_header_data = ast_str_create(DEFAULT_RESPONSE_HEADER_LENGTH);
645
646 if (http_header_data) {
647 ast_str_set(&http_header_data,
648 0,
649 "WWW-authenticate: Digest algorithm=MD5, realm=\"%s\", nonce=\"%08lx\", qop=\"auth\", opaque=\"%08lx\"%s\r\n"
650 "Content-type: text/html\r\n",
651 realm ? realm : "Asterisk",
652 nonce,
653 opaque,
654 stale ? ", stale=true" : "");
655 }
656
658 status_code,
659 status_title,
660 http_header_data,
661 text);
662}
663
664void ast_http_error(struct ast_tcptls_session_instance *ser, int status_code,
665 const char *status_title, const char *text)
666{
667 struct ast_str *http_header_data = ast_str_create(DEFAULT_RESPONSE_HEADER_LENGTH);
668
669 if (http_header_data) {
670 ast_str_set(&http_header_data, 0, "Content-type: text/html\r\n");
671 }
672
674 status_code,
675 status_title,
676 http_header_data,
677 text);
678}
679
680/*!
681 * \brief Link the new uri into the list.
682 *
683 * They are sorted by length of
684 * the string, not alphabetically. Duplicate entries are not replaced,
685 * but the insertion order (using <= and not just <) makes sure that
686 * more recent insertions hide older ones.
687 * On a lookup, we just scan the list and stop at the first matching entry.
688 */
690{
691 struct ast_http_uri *uri;
692 int len = strlen(urih->uri);
693
695
696 urih->prefix = prefix;
697
698 if ( AST_RWLIST_EMPTY(&uris) || strlen(AST_RWLIST_FIRST(&uris)->uri) <= len ) {
701 return 0;
702 }
703
705 if (AST_RWLIST_NEXT(uri, entry) &&
706 strlen(AST_RWLIST_NEXT(uri, entry)->uri) <= len) {
709
710 return 0;
711 }
712 }
713
715
717
718 return 0;
719}
720
727
729{
730 struct ast_http_uri *urih;
733 if (!strcmp(urih->key, key)) {
735 if (urih->dmallocd) {
736 ast_free(urih->data);
737 }
738 if (urih->mallocd) {
739 ast_free(urih);
740 }
741 }
742 }
745}
746
747/*!
748 * \brief Retrieves the header with the given field name.
749 *
750 * \param headers Headers to search.
751 * \param field_name Name of the header to find.
752 * \return Associated header value.
753 * \retval NULL if header is not present.
754 */
755static const char *get_header(struct ast_variable *headers, const char *field_name)
756{
757 struct ast_variable *v;
758
759 for (v = headers; v; v = v->next) {
760 if (!strcasecmp(v->name, field_name)) {
761 return v->value;
762 }
763 }
764 return NULL;
765}
766
767/*!
768 * \brief Retrieves the content type specified in the "Content-Type" header.
769 *
770 * This function only returns the "type/subtype" and any trailing parameter is
771 * not included.
772 *
773 * \note the return value is an allocated string that needs to be freed.
774 *
775 * \return the content type/subtype
776 * \retval NULL if the header is not found.
777 */
778static char *get_content_type(struct ast_variable *headers)
779{
780 const char *content_type = get_header(headers, "Content-Type");
781 const char *param;
782 size_t size;
783
784 if (!content_type) {
785 return NULL;
786 }
787
788 param = strchr(content_type, ';');
789 size = param ? param - content_type : strlen(content_type);
790
791 return ast_strndup(content_type, size);
792}
793
794/*!
795 * \brief Returns the value of the Content-Length header.
796 *
797 * \param headers HTTP headers.
798 *
799 * \return length Value of the Content-Length header.
800 * \retval 0 if header is not present.
801 * \retval -1 if header is invalid.
802 */
803static int get_content_length(struct ast_variable *headers)
804{
805 const char *content_length = get_header(headers, "Content-Length");
806 int length;
807
808 if (!content_length) {
809 /* Missing content length; assume zero */
810 return 0;
811 }
812
813 length = 0;
814 if (sscanf(content_length, "%30d", &length) != 1) {
815 /* Invalid Content-Length value */
816 length = -1;
817 }
818 return length;
819}
820
821/*!
822 * \brief Returns the value of the Transfer-Encoding header.
823 *
824 * \param headers HTTP headers.
825 * \return string Value of the Transfer-Encoding header.
826 * \retval NULL if header is not present.
827 */
828static const char *get_transfer_encoding(struct ast_variable *headers)
829{
830 return get_header(headers, "Transfer-Encoding");
831}
832
833/*!
834 * \internal
835 * \brief Determine if the HTTP peer wants the connection closed.
836 *
837 * \param headers List of HTTP headers
838 *
839 * \retval 0 keep connection open.
840 * \retval -1 close connection.
841 */
842static int http_check_connection_close(struct ast_variable *headers)
843{
844 const char *connection = get_header(headers, "Connection");
845 int close_connection = 0;
846
847 if (connection && !strcasecmp(connection, "close")) {
848 close_connection = -1;
849 }
850 return close_connection;
851}
852
859
860/*!
861 * \internal
862 * \brief Initialize the request tracking information in case of early failure.
863 * \since 12.4.0
864 *
865 * \param request Request tracking information.
866 */
874
875/*!
876 * \internal
877 * \brief Setup the HTTP request tracking information.
878 * \since 12.4.0
879 *
880 * \param ser HTTP TCP/TLS session object.
881 * \param headers List of HTTP headers.
882 *
883 * \retval 0 on success.
884 * \retval -1 on error.
885 */
887{
889 const char *transfer_encoding;
890
894
895 transfer_encoding = get_transfer_encoding(headers);
896 if (transfer_encoding && !strcasecmp(transfer_encoding, "chunked")) {
897 request->body_length = -1;
899 return 0;
900 }
901
902 request->body_length = get_content_length(headers);
903 if (0 < request->body_length) {
905 } else if (request->body_length < 0) {
906 /* Invalid Content-Length */
908 ast_http_error(ser, 400, "Bad Request", "Invalid Content-Length in request!");
909 return -1;
910 }
911 return 0;
912}
913
915{
917
918 request = ser->private_data;
921 /* No body to read. */
922 return;
923 }
925 if (!read_success) {
927 }
928}
929
930/*!
931 * \internal
932 * \brief Read the next length bytes from the HTTP body.
933 * \since 12.4.0
934 *
935 * \param ser HTTP TCP/TLS session object.
936 * \param buf Where to put the contents reading.
937 * \param length How much contents to read.
938 * \param what_getting Name of the contents reading.
939 *
940 * \retval 0 on success.
941 * \retval -1 on error.
942 */
943static int http_body_read_contents(struct ast_tcptls_session_instance *ser, char *buf, int length, const char *what_getting)
944{
945 int res;
946 int total = 0;
947
948 /* Stream is in exclusive mode so we get it all if possible. */
949 while (total != length) {
950 res = ast_iostream_read(ser->stream, buf + total, length - total);
951 if (res <= 0) {
952 break;
953 }
954
955 total += res;
956 }
957
958 if (total != length) {
959 ast_log(LOG_WARNING, "Wrong HTTP content read. Request %s (Wanted %d, Read %d)\n",
960 what_getting, length, res);
961 return -1;
962 }
963
964 return 0;
965}
966
967/*!
968 * \internal
969 * \brief Read and discard the next length bytes from the HTTP body.
970 * \since 12.4.0
971 *
972 * \param ser HTTP TCP/TLS session object.
973 * \param length How much contents to discard
974 * \param what_getting Name of the contents discarding.
975 *
976 * \retval 0 on success.
977 * \retval -1 on error.
978 */
979static int http_body_discard_contents(struct ast_tcptls_session_instance *ser, int length, const char *what_getting)
980{
981 ssize_t res;
982
983 res = ast_iostream_discard(ser->stream, length);
984 if (res < length) {
985 ast_log(LOG_WARNING, "Short HTTP request %s (Wanted %d but got %zd)\n",
986 what_getting, length, res);
987 return -1;
988 }
989 return 0;
990}
991
992/*!
993 * \internal
994 * \brief decode chunked mode hexadecimal value
995 *
996 * \param s string to decode
997 * \param len length of string
998 *
999 * \return length on success.
1000 * \retval -1 on error.
1001 */
1002static int chunked_atoh(const char *s, int len)
1003{
1004 int value = 0;
1005 char c;
1006
1007 if (*s < '0') {
1008 /* zero value must be 0\n not just \n */
1009 return -1;
1010 }
1011
1012 while (len--) {
1013 c = *s++;
1014 if (c == '\x0D') {
1015 return value;
1016 }
1017 if (c == ';') {
1018 /* We have a chunk-extension that we don't care about. */
1019 while (len--) {
1020 if (*s++ == '\x0D') {
1021 return value;
1022 }
1023 }
1024 break;
1025 }
1026 value <<= 4;
1027 if (c >= '0' && c <= '9') {
1028 value += c - '0';
1029 continue;
1030 }
1031 if (c >= 'a' && c <= 'f') {
1032 value += 10 + c - 'a';
1033 continue;
1034 }
1035 if (c >= 'A' && c <= 'F') {
1036 value += 10 + c - 'A';
1037 continue;
1038 }
1039 /* invalid character */
1040 return -1;
1041 }
1042 /* end of string */
1043 return -1;
1044}
1045
1046/*!
1047 * \internal
1048 * \brief Read and convert the chunked body header length.
1049 * \since 12.4.0
1050 *
1051 * \param ser HTTP TCP/TLS session object.
1052 *
1053 * \return length Size of chunk to expect.
1054 * \retval -1 on error.
1055 */
1057{
1058 int length;
1059 char header_line[MAX_HTTP_LINE_LENGTH];
1060
1061 /* get the line of hexadecimal giving chunk-size w/ optional chunk-extension */
1062 if (ast_iostream_gets(ser->stream, header_line, sizeof(header_line)) <= 0) {
1063 ast_log(LOG_WARNING, "Short HTTP read of chunked header\n");
1064 return -1;
1065 }
1066 length = chunked_atoh(header_line, strlen(header_line));
1067 if (length < 0) {
1068 ast_log(LOG_WARNING, "Invalid HTTP chunk size\n");
1069 return -1;
1070 }
1071 return length;
1072}
1073
1074/*!
1075 * \internal
1076 * \brief Read and check the chunk contents line termination.
1077 * \since 12.4.0
1078 *
1079 * \param ser HTTP TCP/TLS session object.
1080 *
1081 * \retval 0 on success.
1082 * \retval -1 on error.
1083 */
1085{
1086 int res;
1087 char chunk_sync[2];
1088
1089 /* Stay in fread until get the expected CRLF or timeout. */
1090 res = ast_iostream_read(ser->stream, chunk_sync, sizeof(chunk_sync));
1091 if (res < sizeof(chunk_sync)) {
1092 ast_log(LOG_WARNING, "Short HTTP chunk sync read (Wanted %zu)\n",
1093 sizeof(chunk_sync));
1094 return -1;
1095 }
1096 if (chunk_sync[0] != 0x0D || chunk_sync[1] != 0x0A) {
1097 ast_log(LOG_WARNING, "HTTP chunk sync bytes wrong (0x%02hhX, 0x%02hhX)\n",
1098 (unsigned char) chunk_sync[0], (unsigned char) chunk_sync[1]);
1099 return -1;
1100 }
1101
1102 return 0;
1103}
1104
1105/*!
1106 * \internal
1107 * \brief Read and discard any chunked trailer entity-header lines.
1108 * \since 12.4.0
1109 *
1110 * \param ser HTTP TCP/TLS session object.
1111 *
1112 * \retval 0 on success.
1113 * \retval -1 on error.
1114 */
1116{
1117 char header_line[MAX_HTTP_LINE_LENGTH];
1118
1119 for (;;) {
1120 if (ast_iostream_gets(ser->stream, header_line, sizeof(header_line)) <= 0) {
1121 ast_log(LOG_WARNING, "Short HTTP read of chunked trailer header\n");
1122 return -1;
1123 }
1124
1125 /* Trim trailing whitespace */
1126 ast_trim_blanks(header_line);
1127 if (ast_strlen_zero(header_line)) {
1128 /* A blank line ends the chunked-body */
1129 break;
1130 }
1131 }
1132 return 0;
1133}
1134
1136{
1138
1139 request = ser->private_data;
1142 /* No body to read or it has already been read. */
1143 return 0;
1144 }
1146
1147 ast_debug(1, "HTTP discarding unused request body\n");
1148
1149 ast_assert(request->body_length != 0);
1150 if (0 < request->body_length) {
1151 if (http_body_discard_contents(ser, request->body_length, "body")) {
1153 return -1;
1154 }
1155 return 0;
1156 }
1157
1158 /* parse chunked-body */
1159 for (;;) {
1160 int length;
1161
1162 length = http_body_get_chunk_length(ser);
1163 if (length < 0) {
1165 return -1;
1166 }
1167 if (length == 0) {
1168 /* parsed last-chunk */
1169 break;
1170 }
1171
1172 if (http_body_discard_contents(ser, length, "chunk-data")
1175 return -1;
1176 }
1177 }
1178
1179 /* Read and discard any trailer entity-header lines. */
1182 return -1;
1183 }
1184 return 0;
1185}
1186
1187/*!
1188 * \brief Returns the contents (body) of the HTTP request
1189 *
1190 * \param return_length ptr to int that returns content length
1191 * \param ser HTTP TCP/TLS session object
1192 * \param headers List of HTTP headers
1193 * \return ptr to content (zero terminated)
1194 * \retval NULL on failure
1195 * \note Since returned ptr is malloc'd, it should be free'd by caller
1196 */
1197static char *ast_http_get_contents(int *return_length,
1198 struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
1199{
1201 int content_length;
1202 int bufsize;
1203 char *buf;
1204
1205 request = ser->private_data;
1206 if (!ast_test_flag(&request->flags, HTTP_FLAG_HAS_BODY)) {
1207 /* no content - not an error */
1208 return NULL;
1209 }
1211 /* Already read the body. Cannot read again. Assume no content. */
1212 ast_assert(0);
1213 return NULL;
1214 }
1216
1217 ast_debug(2, "HTTP consuming request body\n");
1218
1219 ast_assert(request->body_length != 0);
1220 if (0 < request->body_length) {
1221 /* handle regular non-chunked content */
1222 content_length = request->body_length;
1223 if (content_length > MAX_CONTENT_LENGTH) {
1224 ast_log(LOG_WARNING, "Excessively long HTTP content. (%d > %d)\n",
1225 content_length, MAX_CONTENT_LENGTH);
1227 errno = EFBIG;
1228 return NULL;
1229 }
1230 buf = ast_malloc(content_length + 1);
1231 if (!buf) {
1232 /* Malloc sets ENOMEM */
1234 return NULL;
1235 }
1236
1237 if (http_body_read_contents(ser, buf, content_length, "body")) {
1239 errno = EIO;
1240 ast_free(buf);
1241 return NULL;
1242 }
1243
1244 buf[content_length] = 0;
1245 *return_length = content_length;
1246 return buf;
1247 }
1248
1249 /* pre-allocate buffer */
1250 bufsize = 250;
1251 buf = ast_malloc(bufsize);
1252 if (!buf) {
1254 return NULL;
1255 }
1256
1257 /* parse chunked-body */
1258 content_length = 0;
1259 for (;;) {
1260 int chunk_length;
1261
1262 chunk_length = http_body_get_chunk_length(ser);
1263 if (chunk_length < 0) {
1265 errno = EIO;
1266 ast_free(buf);
1267 return NULL;
1268 }
1269 if (chunk_length == 0) {
1270 /* parsed last-chunk */
1271 break;
1272 }
1273 if (content_length + chunk_length > MAX_CONTENT_LENGTH) {
1275 "Excessively long HTTP accumulated chunked body. (%d + %d > %d)\n",
1276 content_length, chunk_length, MAX_CONTENT_LENGTH);
1278 errno = EFBIG;
1279 ast_free(buf);
1280 return NULL;
1281 }
1282
1283 /* insure buffer is large enough +1 */
1284 if (content_length + chunk_length >= bufsize) {
1285 char *new_buf;
1286
1287 /* Increase bufsize until it can handle the expected data. */
1288 do {
1289 bufsize *= 2;
1290 } while (content_length + chunk_length >= bufsize);
1291
1292 new_buf = ast_realloc(buf, bufsize);
1293 if (!new_buf) {
1295 ast_free(buf);
1296 return NULL;
1297 }
1298 buf = new_buf;
1299 }
1300
1301 if (http_body_read_contents(ser, buf + content_length, chunk_length, "chunk-data")
1304 errno = EIO;
1305 ast_free(buf);
1306 return NULL;
1307 }
1308 content_length += chunk_length;
1309 }
1310
1311 /*
1312 * Read and discard any trailer entity-header lines
1313 * which we don't care about.
1314 *
1315 * XXX In the future we may need to add the trailer headers
1316 * to the passed in headers list rather than discarding them.
1317 */
1320 errno = EIO;
1321 ast_free(buf);
1322 return NULL;
1323 }
1324
1325 buf[content_length] = 0;
1326 *return_length = content_length;
1327 return buf;
1328}
1329
1331 struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
1332{
1333 int content_length = 0;
1334 struct ast_json *body;
1335 RAII_VAR(char *, buf, NULL, ast_free);
1336 RAII_VAR(char *, type, get_content_type(headers), ast_free);
1337
1338 /* Use errno to distinguish errors from no body */
1339 errno = 0;
1340
1341 if (ast_strlen_zero(type) || strcasecmp(type, "application/json")) {
1342 /* Content type is not JSON. Don't read the body. */
1343 return NULL;
1344 }
1345
1346 buf = ast_http_get_contents(&content_length, ser, headers);
1347 if (!buf || !content_length) {
1348 /*
1349 * errno already set
1350 * or it is not an error to have zero content
1351 */
1352 return NULL;
1353 }
1354
1355 body = ast_json_load_buf(buf, content_length, NULL);
1356 if (!body) {
1357 /* Failed to parse JSON; treat as an I/O error */
1358 errno = EIO;
1359 return NULL;
1360 }
1361
1362 return body;
1363}
1364
1365/*
1366 * get post variables from client Request Entity-Body, if content type is
1367 * application/x-www-form-urlencoded
1368 */
1369struct ast_variable *ast_http_parse_post_form(char *buf, int content_length,
1370 const char *content_type)
1371{
1372 struct ast_variable *v, *post_vars=NULL, *prev = NULL;
1373 char *var, *val;
1374
1375 /* Use errno to distinguish errors from no params */
1376 errno = 0;
1377
1378 if (ast_strlen_zero(content_type) ||
1379 strcasecmp(content_type, "application/x-www-form-urlencoded") != 0) {
1380 /* Content type is not form data. Don't read the body. */
1381 return NULL;
1382 }
1383
1384 while ((val = strsep(&buf, "&"))) {
1385 var = strsep(&val, "=");
1386 if (val) {
1388 } else {
1389 val = "";
1390 }
1392 if ((v = ast_variable_new(var, val, ""))) {
1393 if (post_vars) {
1394 prev->next = v;
1395 } else {
1396 post_vars = v;
1397 }
1398 prev = v;
1399 }
1400 }
1401
1402 return post_vars;
1403}
1404
1406 struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
1407{
1408 int content_length = 0;
1409 RAII_VAR(char *, buf, NULL, ast_free);
1410 RAII_VAR(char *, type, get_content_type(headers), ast_free);
1411
1412 /* Use errno to distinguish errors from no params */
1413 errno = 0;
1414
1415 if (ast_strlen_zero(type) ||
1416 strcasecmp(type, "application/x-www-form-urlencoded")) {
1417 /* Content type is not form data. Don't read the body. */
1418 return NULL;
1419 }
1420
1421 buf = ast_http_get_contents(&content_length, ser, headers);
1422 if (!buf || !content_length) {
1423 /*
1424 * errno already set
1425 * or it is not an error to have zero content
1426 */
1427 return NULL;
1428 }
1429
1430 return ast_http_parse_post_form(buf, content_length, type);
1431}
1432
1433static int handle_uri(struct ast_tcptls_session_instance *ser, char *uri,
1434 enum ast_http_method method, struct ast_variable *headers)
1435{
1436 char *c;
1437 int res = 0;
1438 char *params = uri;
1439 struct ast_http_uri *urih = NULL;
1440 int l;
1441 struct ast_variable *get_vars = NULL, *v, *prev = NULL;
1442 struct http_uri_redirect *redirect;
1443
1444 ast_debug(2, "HTTP Request URI is %s \n", uri);
1445
1446 strsep(&params, "?");
1447 /* Extract arguments from the request and store them in variables. */
1448 if (params) {
1449 char *var, *val;
1450
1451 while ((val = strsep(&params, "&"))) {
1452 var = strsep(&val, "=");
1453 if (val) {
1455 } else {
1456 val = "";
1457 }
1459 if ((v = ast_variable_new(var, val, ""))) {
1460 if (get_vars) {
1461 prev->next = v;
1462 } else {
1463 get_vars = v;
1464 }
1465 prev = v;
1466 }
1467 }
1468 }
1469
1472 if (!strcasecmp(uri, redirect->target)) {
1473 struct ast_str *http_header = ast_str_create(128);
1474
1475 if (!http_header) {
1477 ast_http_error(ser, 500, "Server Error", "Out of memory");
1478 break;
1479 }
1480 ast_str_set(&http_header, 0, "Location: %s\r\n", redirect->dest);
1481 ast_http_send(ser, method, 302, "Moved Temporarily", http_header, NULL, 0, 0);
1482 break;
1483 }
1484 }
1486 if (redirect) {
1487 goto cleanup;
1488 }
1489
1490 /* We want requests to start with the (optional) prefix and '/' */
1491 l = strlen(prefix);
1492 if (!strncasecmp(uri, prefix, l) && uri[l] == '/') {
1493 uri += l + 1;
1494 /* scan registered uris to see if we match one. */
1496 AST_RWLIST_TRAVERSE(&uris, urih, entry) {
1497 l = strlen(urih->uri);
1498 c = uri + l; /* candidate */
1499 ast_debug(2, "match request [%s] with handler [%s] len %d\n", uri, urih->uri, l);
1500 if (strncasecmp(urih->uri, uri, l) /* no match */
1501 || (*c && *c != '/')) { /* substring */
1502 continue;
1503 }
1504 if (*c == '/') {
1505 c++;
1506 }
1507 if (!*c || urih->has_subtree) {
1508 uri = c;
1509 break;
1510 }
1511 }
1513 }
1514 if (urih) {
1515 ast_debug(1, "Match made with [%s]\n", urih->uri);
1516 if (!urih->no_decode_uri) {
1518 }
1519 res = urih->callback(ser, urih, uri, method, get_vars, headers);
1520 } else {
1521 ast_debug(1, "Request from %s for URI [%s] has no registered handler\n",
1523 ast_http_error(ser, 404, "Not Found", "The requested URL was not found on this server.");
1524 }
1525
1526cleanup:
1527 ast_variables_destroy(get_vars);
1528 return res;
1529}
1530
1531static struct ast_variable *parse_cookies(const char *cookies)
1532{
1533 char *parse = ast_strdupa(cookies);
1534 char *cur;
1535 struct ast_variable *vars = NULL, *var;
1536
1537 while ((cur = strsep(&parse, ";"))) {
1538 char *name, *val;
1539
1540 name = val = cur;
1541 strsep(&val, "=");
1542
1544 continue;
1545 }
1546
1547 name = ast_strip(name);
1548 val = ast_strip_quoted(val, "\"", "\"");
1549
1551 continue;
1552 }
1553
1554 ast_debug(1, "HTTP Cookie, Name: '%s' Value: '%s'\n", name, val);
1555
1556 var = ast_variable_new(name, val, __FILE__);
1557 var->next = vars;
1558 vars = var;
1559 }
1560
1561 return vars;
1562}
1563
1564/* get cookie from Request headers */
1566{
1567 struct ast_variable *v, *cookies = NULL;
1568
1569 for (v = headers; v; v = v->next) {
1570 if (!strcasecmp(v->name, "Cookie")) {
1571 ast_variables_destroy(cookies);
1572 cookies = parse_cookies(v->value);
1573 }
1574 }
1575 return cookies;
1576}
1577
1578static struct ast_http_auth *auth_create(const char *userid, const char *password)
1579{
1580 struct ast_http_auth *auth;
1581 size_t userid_len;
1582 size_t password_len;
1583
1584 if (!userid || !password) {
1585 ast_log(LOG_ERROR, "Invalid userid/password\n");
1586 return NULL;
1587 }
1588
1589 userid_len = strlen(userid) + 1;
1590 password_len = strlen(password) + 1;
1591
1592 /* Allocate enough room to store everything in one memory block */
1593 auth = ao2_alloc(sizeof(*auth) + userid_len + password_len, NULL);
1594 if (!auth) {
1595 return NULL;
1596 }
1597
1598 /* Put the userid right after the struct */
1599 auth->userid = (char *)(auth + 1);
1600 strcpy(auth->userid, userid);
1601
1602 /* Put the password right after the userid */
1603 auth->password = auth->userid + userid_len;
1604 strcpy(auth->password, password);
1605
1606 return auth;
1607}
1608
1609#define BASIC_PREFIX "Basic "
1610#define BASIC_LEN 6 /*!< strlen(BASIC_PREFIX) */
1611
1613{
1614 struct ast_variable *v;
1615
1616 for (v = headers; v; v = v->next) {
1617 const char *base64;
1618 char decoded[256] = {};
1619 char *username;
1620 char *password;
1621#ifdef AST_DEVMODE
1622 int cnt;
1623#endif /* AST_DEVMODE */
1624
1625 if (strcasecmp("Authorization", v->name) != 0) {
1626 continue;
1627 }
1628
1631 "Unsupported Authorization scheme\n");
1632 continue;
1633 }
1634
1635 /* Basic auth header parsing. RFC 2617, section 2.
1636 * credentials = "Basic" basic-credentials
1637 * basic-credentials = base64-user-pass
1638 * base64-user-pass = <base64 encoding of user-pass,
1639 * except not limited to 76 char/line>
1640 * user-pass = userid ":" password
1641 */
1642
1643 base64 = v->value + BASIC_LEN;
1644
1645 /* This will truncate "userid:password" lines to
1646 * sizeof(decoded). The array is long enough that this shouldn't
1647 * be a problem */
1648#ifdef AST_DEVMODE
1649 cnt =
1650#endif /* AST_DEVMODE */
1651 ast_base64decode((unsigned char*)decoded, base64,
1652 sizeof(decoded) - 1);
1653 ast_assert(cnt < sizeof(decoded));
1654
1655 /* Split the string at the colon */
1656 password = decoded;
1657 username = strsep(&password, ":");
1658 if (!password) {
1659 ast_log(LOG_WARNING, "Invalid Authorization header\n");
1660 return NULL;
1661 }
1662
1663 return auth_create(username, password);
1664 }
1665
1666 return NULL;
1667}
1668
1670 const char *password)
1671{
1672 int encoded_size = 0;
1673 int userinfo_len = 0;
1674 RAII_VAR(char *, userinfo, NULL, ast_free);
1675 char *encoded_userinfo = NULL;
1676 struct ast_variable *auth_header = NULL;
1677
1678 if (ast_strlen_zero(userid)) {
1679 return NULL;
1680 }
1681
1682 if (strchr(userid, ':')) {
1683 userinfo = ast_strdup(userid);
1684 userinfo_len = strlen(userinfo);
1685 } else {
1686 if (ast_strlen_zero(password)) {
1687 return NULL;
1688 }
1689 userinfo_len = ast_asprintf(&userinfo, "%s:%s", userid, password);
1690 }
1691 if (!userinfo) {
1692 return NULL;
1693 }
1694
1695 /*
1696 * The header value is "Basic " + base64(userinfo).
1697 * Doubling the userinfo length then adding the length
1698 * of the "Basic " prefix is a conservative estimate of the
1699 * final encoded size.
1700 */
1701 encoded_size = userinfo_len * 2 * sizeof(char) + 1 + BASIC_LEN;
1702 encoded_userinfo = ast_alloca(encoded_size);
1703 strcpy(encoded_userinfo, BASIC_PREFIX); /* Safe */
1704 ast_base64encode(encoded_userinfo + BASIC_LEN, (unsigned char *)userinfo,
1705 userinfo_len, encoded_size - BASIC_LEN);
1706
1707 auth_header = ast_variable_new("Authorization",
1708 encoded_userinfo, "");
1709
1710 return auth_header;
1711}
1712
1713int ast_http_response_status_line(const char *buf, const char *version, int code)
1714{
1715 int status_code;
1716 size_t size = strlen(version);
1717
1718 if (strncmp(buf, version, size) || buf[size] != ' ') {
1719 ast_log(LOG_ERROR, "HTTP version not supported - "
1720 "expected %s\n", version);
1721 return -1;
1722 }
1723
1724 /* skip to status code (version + space) */
1725 buf += size + 1;
1726
1727 if (sscanf(buf, "%d", &status_code) != 1) {
1728 ast_log(LOG_ERROR, "Could not read HTTP status code - "
1729 "%s\n", buf);
1730 return -1;
1731 }
1732
1733 return status_code;
1734}
1735
1736static void remove_excess_lws(char *s)
1737{
1738 char *p, *res = s;
1739 char *buf = ast_malloc(strlen(s) + 1);
1740 char *buf_end;
1741
1742 if (!buf) {
1743 return;
1744 }
1745
1746 buf_end = buf;
1747
1748 while (*s && *(s = ast_skip_blanks(s))) {
1749 p = s;
1750 s = ast_skip_nonblanks(s);
1751
1752 if (buf_end != buf) {
1753 *buf_end++ = ' ';
1754 }
1755
1756 memcpy(buf_end, p, s - p);
1757 buf_end += s - p;
1758 }
1759 *buf_end = '\0';
1760 /* safe since buf will always be less than or equal to res */
1761 strcpy(res, buf);
1762 ast_free(buf);
1763}
1764
1765int ast_http_header_parse(char *buf, char **name, char **value)
1766{
1768 if (ast_strlen_zero(buf)) {
1769 return -1;
1770 }
1771
1772 *value = buf;
1773 *name = strsep(value, ":");
1774 if (!*value) {
1775 return 1;
1776 }
1777
1780 return 1;
1781 }
1782
1784 return 0;
1785}
1786
1787int ast_http_header_match(const char *name, const char *expected_name,
1788 const char *value, const char *expected_value)
1789{
1790 if (strcasecmp(name, expected_name)) {
1791 /* no value to validate if names don't match */
1792 return 0;
1793 }
1794
1795 if (strcasecmp(value, expected_value)) {
1796 ast_log(LOG_ERROR, "Invalid header value - expected %s "
1797 "received %s", value, expected_value);
1798 return -1;
1799 }
1800 return 1;
1801}
1802
1803int ast_http_header_match_in(const char *name, const char *expected_name,
1804 const char *value, const char *expected_value)
1805{
1806 if (strcasecmp(name, expected_name)) {
1807 /* no value to validate if names don't match */
1808 return 0;
1809 }
1810
1811 if (!strcasestr(expected_value, value)) {
1812 ast_log(LOG_ERROR, "Header '%s' - could not locate '%s' "
1813 "in '%s'\n", name, value, expected_value);
1814 return -1;
1815
1816 }
1817 return 1;
1818}
1819
1820/*! Limit the number of request headers in case the sender is being ridiculous. */
1821#define MAX_HTTP_REQUEST_HEADERS 100
1822
1823/*!
1824 * \internal
1825 * \brief Read the request headers.
1826 * \since 12.4.0
1827 *
1828 * \param ser HTTP TCP/TLS session object.
1829 * \param headers Where to put the request headers list pointer.
1830 *
1831 * \retval 0 on success.
1832 * \retval -1 on error.
1833 */
1835{
1836 struct ast_variable *tail = *headers;
1837 int remaining_headers;
1838 char header_line[MAX_HTTP_LINE_LENGTH];
1839
1840 remaining_headers = MAX_HTTP_REQUEST_HEADERS;
1841 for (;;) {
1842 ssize_t len;
1843 char *name;
1844 char *value;
1845
1846 len = ast_iostream_gets(ser->stream, header_line, sizeof(header_line));
1847 if (len <= 0) {
1848 ast_http_error(ser, 400, "Bad Request", "Timeout");
1849 return -1;
1850 }
1851 if (header_line[len - 1] != '\n') {
1852 /* We didn't get a full line */
1853 ast_http_error(ser, 400, "Bad Request",
1854 (len == sizeof(header_line) - 1) ? "Header line too long" : "Timeout");
1855 return -1;
1856 }
1857
1858 /* Trim trailing characters */
1859 ast_trim_blanks(header_line);
1860 if (ast_strlen_zero(header_line)) {
1861 /* A blank line ends the request header section. */
1862 break;
1863 }
1864
1865 value = header_line;
1866 name = strsep(&value, ":");
1867 if (!value) {
1868 continue;
1869 }
1870
1873 continue;
1874 }
1875
1877
1878 if (!remaining_headers--) {
1879 /* Too many headers. */
1880 ast_http_error(ser, 413, "Request Entity Too Large", "Too many headers");
1881 return -1;
1882 }
1883 if (!*headers) {
1884 *headers = ast_variable_new(name, value, __FILE__);
1885 tail = *headers;
1886 } else {
1887 tail->next = ast_variable_new(name, value, __FILE__);
1888 tail = tail->next;
1889 }
1890 if (!tail) {
1891 /*
1892 * Variable allocation failure.
1893 * Try to make some room.
1894 */
1895 ast_variables_destroy(*headers);
1896 *headers = NULL;
1897
1898 ast_http_error(ser, 500, "Server Error", "Out of memory");
1899 return -1;
1900 }
1901 }
1902
1903 return 0;
1904}
1905
1906/*!
1907 * \internal
1908 * \brief Process a HTTP request.
1909 * \since 12.4.0
1910 *
1911 * \param ser HTTP TCP/TLS session object.
1912 *
1913 * \retval 0 Continue and process the next HTTP request.
1914 * \retval -1 Fatal HTTP connection error. Force the HTTP connection closed.
1915 */
1917{
1918 RAII_VAR(struct ast_variable *, headers, NULL, ast_variables_destroy);
1919 char *uri;
1920 char *method;
1921 const char *transfer_encoding;
1923 enum ast_http_method http_method = AST_HTTP_UNKNOWN;
1924 int res;
1925 ssize_t len;
1926 char request_line[MAX_HTTP_LINE_LENGTH];
1927
1928 len = ast_iostream_gets(ser->stream, request_line, sizeof(request_line));
1929 if (len <= 0) {
1930 return -1;
1931 }
1932
1933 /* Re-initialize the request body tracking data. */
1934 request = ser->private_data;
1936
1937 if (request_line[len - 1] != '\n') {
1938 /* We didn't get a full line */
1939 ast_http_error(ser, 400, "Bad Request",
1940 (len == sizeof(request_line) - 1) ? "Request line too long" : "Timeout");
1941 return -1;
1942 }
1943
1944 /* Get method */
1945 method = ast_skip_blanks(request_line);
1947 if (*uri) {
1948 *uri++ = '\0';
1949 }
1950
1951 if (!strcasecmp(method,"GET")) {
1952 http_method = AST_HTTP_GET;
1953 } else if (!strcasecmp(method,"POST")) {
1954 http_method = AST_HTTP_POST;
1955 } else if (!strcasecmp(method,"HEAD")) {
1956 http_method = AST_HTTP_HEAD;
1957 } else if (!strcasecmp(method,"PUT")) {
1958 http_method = AST_HTTP_PUT;
1959 } else if (!strcasecmp(method,"DELETE")) {
1960 http_method = AST_HTTP_DELETE;
1961 } else if (!strcasecmp(method,"OPTIONS")) {
1962 http_method = AST_HTTP_OPTIONS;
1963 }
1964
1965 uri = ast_skip_blanks(uri); /* Skip white space */
1966 if (*uri) { /* terminate at the first blank */
1967 char *c = ast_skip_nonblanks(uri);
1968
1969 if (*c) {
1970 *c = '\0';
1971 }
1972 } else {
1973 ast_http_error(ser, 400, "Bad Request", "Invalid Request");
1974 return -1;
1975 }
1976
1977 if (ast_shutdown_final()) {
1978 ast_http_error(ser, 503, "Service Unavailable", "Shutdown in progress");
1979 return -1;
1980 }
1981
1982 /* process "Request Headers" lines */
1983 if (http_request_headers_get(ser, &headers)) {
1984 return -1;
1985 }
1986
1987 transfer_encoding = get_transfer_encoding(headers);
1988 /* Transfer encoding defaults to identity */
1989 if (!transfer_encoding) {
1990 transfer_encoding = "identity";
1991 }
1992
1993 /*
1994 * RFC 2616, section 3.6, we should respond with a 501 for any transfer-
1995 * codings we don't understand.
1996 */
1997 if (strcasecmp(transfer_encoding, "identity") != 0 &&
1998 strcasecmp(transfer_encoding, "chunked") != 0) {
1999 /* Transfer encodings not supported */
2000 ast_http_error(ser, 501, "Unimplemented", "Unsupported Transfer-Encoding.");
2001 return -1;
2002 }
2003
2004 if (http_request_tracking_setup(ser, headers)
2005 || handle_uri(ser, uri, http_method, headers)
2007 res = -1;
2008 } else {
2009 res = 0;
2010 }
2011 return res;
2012}
2013
2014static void *httpd_helper_thread(void *data)
2015{
2016 struct ast_tcptls_session_instance *ser = data;
2017 int timeout;
2018 int arg = 1;
2019
2020 if (!ser) {
2021 ao2_cleanup(ser);
2022 return NULL;
2023 }
2024
2026 ast_log(LOG_WARNING, "HTTP session count exceeded %d sessions.\n",
2028 goto done;
2029 }
2030 ast_debug(1, "HTTP opening session. Top level\n");
2031
2032 /*
2033 * Here we set TCP_NODELAY on the socket to disable Nagle's algorithm.
2034 * This is necessary to prevent delays (caused by buffering) as we
2035 * write to the socket in bits and pieces.
2036 */
2037 if (setsockopt(ast_iostream_get_fd(ser->stream), IPPROTO_TCP, TCP_NODELAY, (char *) &arg, sizeof(arg)) < 0) {
2038 ast_log(LOG_WARNING, "Failed to set TCP_NODELAY on HTTP connection: %s\n", strerror(errno));
2039 }
2041
2042 /* Setup HTTP worker private data to keep track of request body reading. */
2046 if (!ser->private_data) {
2047 ast_http_error(ser, 500, "Server Error", "Out of memory");
2048 goto done;
2049 }
2051
2052 /* Determine initial HTTP request wait timeout. */
2053 timeout = session_keep_alive;
2054 if (timeout <= 0) {
2055 /* Persistent connections not enabled. */
2056 timeout = session_inactivity;
2057 }
2058 if (timeout < MIN_INITIAL_REQUEST_TIMEOUT) {
2060 }
2061
2062 /* We can let the stream wait for data to arrive. */
2064
2065 for (;;) {
2066 /* Wait for next potential HTTP request message. */
2068 if (httpd_process_request(ser)) {
2069 /* Break the connection or the connection closed */
2070 break;
2071 }
2072 if (!ser->stream) {
2073 /* Web-socket or similar that took the connection */
2074 break;
2075 }
2076
2077 timeout = session_keep_alive;
2078 if (timeout <= 0) {
2079 /* Persistent connections not enabled. */
2080 break;
2081 }
2082 }
2083
2084done:
2086
2087 ast_debug(1, "HTTP closing session. Top level\n");
2089
2090 ao2_ref(ser, -1);
2091 return NULL;
2092}
2093
2094/*!
2095 * \brief Add a new URI redirect
2096 * The entries in the redirect list are sorted by length, just like the list
2097 * of URI handlers.
2098 */
2099static void add_redirect(const char *value)
2100{
2101 char *target, *dest;
2102 struct http_uri_redirect *redirect, *cur;
2103 unsigned int target_len;
2104 unsigned int total_len;
2105 size_t dest_len;
2106
2109 target = strsep(&dest, " ");
2111 target = strsep(&target, " "); /* trim trailing whitespace */
2112
2113 if (!dest) {
2114 ast_log(LOG_WARNING, "Invalid redirect '%s'\n", value);
2115 return;
2116 }
2117
2118 target_len = strlen(target) + 1;
2119 dest_len = strlen(dest) + 1;
2120 total_len = sizeof(*redirect) + target_len + dest_len;
2121
2122 if (!(redirect = ast_calloc(1, total_len))) {
2123 return;
2124 }
2125 redirect->dest = redirect->target + target_len;
2126 strcpy(redirect->target, target);
2127 ast_copy_string(redirect->dest, dest, dest_len);
2128
2130
2131 target_len--; /* So we can compare directly with strlen() */
2133 || strlen(AST_RWLIST_FIRST(&uri_redirects)->target) <= target_len ) {
2136
2137 return;
2138 }
2139
2141 if (AST_RWLIST_NEXT(cur, entry)
2142 && strlen(AST_RWLIST_NEXT(cur, entry)->target) <= target_len ) {
2145 return;
2146 }
2147 }
2148
2150
2152}
2153
2154/*! \brief Number of HTTP server buckets */
2155#define HTTP_SERVER_BUCKETS 5
2156
2158
2161
2162static void http_server_destroy(void *obj)
2163{
2164 struct ast_http_server *server = obj;
2165
2166 ast_tcptls_server_stop(&server->args);
2167
2168 ast_verb(1, "Stopped http server '%s' listening at '%s'\n", server->name, server->address);
2169
2170 ast_free(server->name);
2171 ast_free(server->address);
2172}
2173
2174static struct ast_http_server *http_server_create(const char *name, const char *address,
2175 const struct ast_sockaddr *addr)
2176{
2177 struct ast_http_server *server;
2178
2179 server = ao2_alloc(sizeof(*server), http_server_destroy);
2180 if (!server) {
2181 ast_log(LOG_ERROR, "Unable to allocate HTTP server '%s' at address '%s'\n",
2182 name, address);
2183 return NULL;
2184 }
2185
2186 if (!(server->address = ast_strdup(address)) || !(server->name = ast_strdup(name))) {
2187 ast_log(LOG_ERROR, "Unable to complete setup for HTTP server '%s' at address '%s'\n",
2188 name, address);
2189 ao2_ref(server, -1);
2190 return NULL;
2191 }
2192
2193 server->args.accept_fd = -1;
2194 server->args.master = AST_PTHREADT_NULL;
2195 server->args.tls_cfg = NULL;
2196 server->args.poll_timeout = -1;
2197 server->args.name = server->name;
2200
2201 ast_sockaddr_copy(&server->args.local_address, addr);
2202
2203 return server;
2204}
2205
2206static int http_server_start(struct ast_http_server *server)
2207{
2208 if (server->args.accept_fd != -1) {
2209 /* Already running */
2210 return 0;
2211 }
2212
2213 ast_tcptls_server_start(&server->args);
2214 if (server->args.accept_fd == -1) {
2215 ast_log(LOG_WARNING, "Failed to start HTTP server '%s' at address '%s'\n",
2216 server->name, server->address);
2217 return -1;
2218 }
2219
2220 if (!ao2_link_flags(http_servers, server, OBJ_NOLOCK)) {
2221 ast_log(LOG_WARNING, "Failed to link HTTP server '%s' at address '%s'\n",
2222 server->name, server->address);
2223 return -1;
2224 }
2225
2226 ast_verb(1, "Bound HTTP server '%s' to address %s\n", server->name, server->address);
2227
2228 return 0;
2229}
2230
2231/*!
2232 * \brief Discard/Drop a HTTP server
2233 *
2234 * Decrements the reference to the given object, and unlinks it from the servers
2235 * container if it's the last reference.
2236 *
2237 * After a server object has been added to the container this method should always
2238 * be called to decrement the object's reference instead of the regular ao2 methods.
2239 *
2240 * \note NULL tolerant
2241 *
2242 * \param server The server object
2243 */
2244static void http_server_discard(struct ast_http_server *server)
2245{
2246 if (!server) {
2247 return;
2248 }
2249
2250 /*
2251 * If only two references were on the object then the last one is from
2252 * the servers container, so remove from container now.
2253 */
2254 if (ao2_ref(server, -1) == 2) {
2255 ao2_unlink(http_servers, server);
2256 }
2257}
2258
2259/*!
2260 * \brief Retrieve, or create a HTTP server object by sock address
2261 *
2262 * Look for, and return a matching server object by addr. If an object is not found
2263 * then create a new one.
2264 *
2265 * \note This method should be called with the http_servers container already locked.
2266 *
2267 * \param name The name of the server
2268 * \param addr The address to match on, or create a new object with
2269 *
2270 * \return a HTTP server object, or NULL on error
2271 */
2273 const char *name, const struct ast_sockaddr *addr)
2274{
2275 struct ast_http_server *server;
2276 const char *address;
2277
2279 if (ast_strlen_zero(address)) {
2280 return NULL;
2281 }
2282
2284
2285 return server ?: http_server_create(name, address, addr);
2286}
2287
2288/*!
2289 * \brief Retrieve, or create a HTTP server object by host
2290 *
2291 * Resolve the given host, and then look for, and return a matching server object.
2292 * If an object is not found then create a new one.
2293 *
2294 * \note This method should be called with the http_servers container already locked.
2295 *
2296 * \param name The name of the server
2297 * \param host The host to resolve, and match on or create a new object with
2298 * \param port Optional port used if one is not specified with the host (default 8088)
2299 *
2300 * \return a HTTP server object, or NULL on error
2301 */
2302static struct ast_http_server *http_server_get_by_host(const char *name, const char *host,
2303 uint32_t port)
2304{
2305 struct ast_sockaddr *addrs = NULL;
2306 int num_addrs;
2307 int i;
2308
2309 if (!(num_addrs = ast_sockaddr_resolve(&addrs, host, 0, AST_AF_UNSPEC))) {
2310 ast_log(LOG_WARNING, "Unable to resolve host '%s'\n", host);
2311 return NULL;
2312 }
2313
2314 if (port == 0) {
2315 port = DEFAULT_PORT;
2316 }
2317
2318 for (i = 0; i < num_addrs; ++i) {
2319 struct ast_http_server *server;
2320
2321 /* Use the given port if one was not specified already */
2322 if (!ast_sockaddr_port(&addrs[i])) {
2323 ast_sockaddr_set_port(&addrs[i], port);
2324 }
2325
2326 server = http_server_get_by_addr(name, &addrs[i]);
2327 if (server) {
2328 ast_free(addrs);
2329 return server;
2330 }
2331 }
2332
2333 ast_free(addrs);
2334 return NULL;
2335}
2336
2337/*!
2338 * \brief Retrieve, or create and start a HTTP server
2339 *
2340 * Resolve the given host, and retrieve a listening server object. If the server is
2341 * not already listening then start it. If a replace_me parameter is given, and it
2342 * points to a non-NULL value then that server is discarded and replaced.
2343 *
2344 * \param name The name of the server
2345 * \param host The host to resolve, and match on or create a new object with
2346 * \param port Optional port used if one is not specified with the host (default 8088)
2347 * \param[out] replace_me Optional server to be replaced
2348 *
2349 * \note If replace_me is specified the returned value is always the same as what's
2350 * passed back out in the variable.
2351 *
2352 * \return a HTTP server object, or NULL on error
2353 */
2354static struct ast_http_server *http_server_get(const char *name, const char *host,
2355 uint32_t port, struct ast_http_server **replace_me)
2356{
2357 struct ast_http_server *server;
2358
2360
2361 server = http_server_get_by_host(name, host, port);
2362
2363 if (replace_me) {
2364 /* Only replace if different */
2365 if (*replace_me == server) {
2366 ao2_cleanup(server);
2368 return *replace_me;
2369 }
2370
2371 if (*replace_me) {
2372 http_server_discard(*replace_me);
2373 }
2374
2375 *replace_me = server;
2376 }
2377
2378 if (server && http_server_start(server)) {
2379 if (replace_me) {
2380 *replace_me = NULL;
2381 }
2382
2383 ao2_ref(server, -1);
2384 server = NULL;
2385 }
2386
2388 return server;
2389}
2390
2391#ifdef TEST_FRAMEWORK
2392
2393struct ast_http_server *ast_http_test_server_get(const char *name, const char *host)
2394{
2395 struct ast_http_server *server;
2396
2397 /*
2398 * Currently multiple HTTP servers are only allowed when the TEST_FRAMEWORK
2399 * is enabled, leaving the follow 'todos' if they become a problem or if this
2400 * ability moves outside the TEST_FRAMEWORK.
2401 *
2402 * TODO: Add locking around global_http_server use. If this module is reloading
2403 * it's possible for the global_http_server to exist here, and then become
2404 * NULL between the check and return.
2405 *
2406 * TODO: Make it so 'localhost' and 'any' addresses equate.
2407 */
2408
2409 if (ast_strlen_zero(host)) {
2410 /* Use configured server if one available */
2411 if (global_http_server) {
2414 }
2415
2416 host = "localhost:8088";
2417 }
2418
2419 if (!name) {
2420 name = "http test server";
2421 }
2422
2423 server = http_server_get(name, host, 0, NULL);
2424 if (server) {
2426 }
2427
2428 return server;
2429}
2430
2431void ast_http_test_server_discard(struct ast_http_server *server)
2432{
2433 if (server) {
2434 http_server_discard(server);
2436 }
2437}
2438
2439#endif
2440
2442{
2443 struct ast_config *cfg;
2444 struct ast_variable *v;
2445 int enabled = 0;
2446 int new_static_uri_enabled = 0;
2447 int new_status_uri_enabled = 1; /* Default to enabled for BC */
2448 char newprefix[MAX_PREFIX] = "";
2449 char server_name[MAX_SERVER_NAME_LENGTH];
2450 struct http_uri_redirect *redirect;
2451 struct ast_flags config_flags = { reload ? CONFIG_FLAG_FILEUNCHANGED : 0 };
2452 uint32_t bindport = DEFAULT_PORT;
2453 int http_tls_was_enabled = 0;
2454 char *bindaddr = NULL;
2455
2456 cfg = ast_config_load2("http.conf", "http", config_flags);
2457 if (!cfg || cfg == CONFIG_STATUS_FILEINVALID) {
2458 return 0;
2459 }
2460
2461 /* Even if the http.conf hasn't been updated, the TLS certs/keys may have been */
2462 if (cfg == CONFIG_STATUS_FILEUNCHANGED) {
2465 }
2466 return 0;
2467 }
2468
2469 http_tls_was_enabled = (reload && http_tls_cfg.enabled);
2470
2472
2475
2478
2481
2482 /* Apply modern intermediate settings according to the Mozilla OpSec team as of July 30th, 2015 but disable TLSv1 */
2484
2486 http_tls_cfg.cipher = ast_strdup("ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:DHE-DSS-AES128-GCM-SHA256:kEDH+AESGCM:ECDHE-RSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-ECDSA-AES256-SHA:DHE-RSA-AES128-SHA256:DHE-RSA-AES128-SHA:DHE-DSS-AES128-SHA256:DHE-RSA-AES256-SHA256:DHE-DSS-AES256-SHA:DHE-RSA-AES256-SHA:AES128-GCM-SHA256:AES256-GCM-SHA384:AES128-SHA256:AES256-SHA256:AES128-SHA:AES256-SHA:AES:CAMELLIA:DES-CBC3-SHA:!aNULL:!eNULL:!EXPORT:!DES:!RC4:!MD5:!PSK:!aECDH:!EDH-DSS-DES-CBC3-SHA:!EDH-RSA-DES-CBC3-SHA:!KRB5-DES-CBC3-SHA");
2487
2489 while ((redirect = AST_RWLIST_REMOVE_HEAD(&uri_redirects, entry))) {
2490 ast_free(redirect);
2491 }
2493
2495
2499
2500 snprintf(server_name, sizeof(server_name), "Asterisk/%s", ast_get_version());
2501
2502 v = ast_variable_browse(cfg, "general");
2503 for (; v; v = v->next) {
2504 /* read tls config options while preventing unsupported options from being set */
2505 if (strcasecmp(v->name, "tlscafile")
2506 && strcasecmp(v->name, "tlscapath")
2507 && strcasecmp(v->name, "tlscadir")
2508 && strcasecmp(v->name, "tlsverifyclient")
2509 && strcasecmp(v->name, "tlsdontverifyserver")
2510 && strcasecmp(v->name, "tlsclientmethod")
2511 && strcasecmp(v->name, "sslclientmethod")
2513 continue;
2514 }
2515
2516 if (!strcasecmp(v->name, "servername")) {
2517 if (!ast_strlen_zero(v->value)) {
2518 ast_copy_string(server_name, v->value, sizeof(server_name));
2519 } else {
2520 server_name[0] = '\0';
2521 }
2522 } else if (!strcasecmp(v->name, "enabled")) {
2523 enabled = ast_true(v->value);
2524 } else if (!strcasecmp(v->name, "enablestatic") || !strcasecmp(v->name, "enable_static")) {
2525 new_static_uri_enabled = ast_true(v->value);
2526 } else if (!strcasecmp(v->name, "enable_status")) {
2527 new_status_uri_enabled = ast_true(v->value);
2528 } else if (!strcasecmp(v->name, "bindport")) {
2530 &bindport, DEFAULT_PORT, 0, 65535)) {
2531 ast_log(LOG_WARNING, "Invalid port %s specified. Using default port %" PRId32 "\n",
2532 v->value, DEFAULT_PORT);
2533 }
2534 } else if (!strcasecmp(v->name, "bindaddr")) {
2536 } else if (!strcasecmp(v->name, "prefix")) {
2537 if (!ast_strlen_zero(v->value)) {
2538 newprefix[0] = '/';
2539 ast_copy_string(newprefix + 1, v->value, sizeof(newprefix) - 1);
2540 } else {
2541 newprefix[0] = '\0';
2542 }
2543 } else if (!strcasecmp(v->name, "redirect")) {
2544 add_redirect(v->value);
2545 } else if (!strcasecmp(v->name, "sessionlimit")) {
2547 &session_limit, DEFAULT_SESSION_LIMIT, 1, INT_MAX)) {
2548 ast_log(LOG_WARNING, "Invalid %s '%s' at line %d of http.conf\n",
2549 v->name, v->value, v->lineno);
2550 }
2551 } else if (!strcasecmp(v->name, "session_inactivity")) {
2554 ast_log(LOG_WARNING, "Invalid %s '%s' at line %d of http.conf\n",
2555 v->name, v->value, v->lineno);
2556 }
2557 } else if (!strcasecmp(v->name, "session_keep_alive")) {
2558 if (sscanf(v->value, "%30d", &session_keep_alive) != 1
2559 || session_keep_alive < 0) {
2561 ast_log(LOG_WARNING, "Invalid %s '%s' at line %d of http.conf\n",
2562 v->name, v->value, v->lineno);
2563 }
2564 } else {
2565 ast_log(LOG_WARNING, "Ignoring unknown option '%s' in http.conf\n", v->name);
2566 }
2567 }
2568
2569 ast_config_destroy(cfg);
2570
2571 if (strcmp(prefix, newprefix)) {
2572 ast_copy_string(prefix, newprefix, sizeof(prefix));
2573 }
2574
2575 ast_copy_string(http_server_name, server_name, sizeof(http_server_name));
2576
2577 if (enabled) {
2578 http_server_get("http server", bindaddr, bindport, &global_http_server);
2579 } else if (global_http_server) {
2582 }
2583
2584 /* When no specific TLS bindaddr is specified, we just use
2585 * the non-TLS bindaddress here.
2586 */
2589
2591 /* Of course, we can't use the same port though.
2592 * Since no bind address was specified, we just use the
2593 * default TLS port
2594 */
2596 }
2597
2598 if (http_tls_was_enabled && !http_tls_cfg.enabled) {
2601 /* We can get here either because a TLS-specific address was specified
2602 * or because we copied the non-TLS address here. In the case where
2603 * we read an explicit address from the config, there may have been
2604 * no port specified, so we'll just use the default TLS port.
2605 */
2608 }
2611 }
2612 }
2613
2614 if (static_uri_enabled && !new_static_uri_enabled) {
2616 } else if (!static_uri_enabled && new_static_uri_enabled) {
2618 }
2619
2620 static_uri_enabled = new_static_uri_enabled;
2621
2622 if (status_uri_enabled && !new_status_uri_enabled) {
2624 } else if (!status_uri_enabled && new_status_uri_enabled) {
2626 }
2627
2628 status_uri_enabled = new_status_uri_enabled;
2629
2630 return 0;
2631}
2632
2633static char *handle_show_http(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
2634{
2635 struct ast_http_uri *urih;
2636 struct http_uri_redirect *redirect;
2637
2638 switch (cmd) {
2639 case CLI_INIT:
2640 e->command = "http show status";
2641 e->usage =
2642 "Usage: http show status\n"
2643 " Lists status of internal HTTP engine\n";
2644 return NULL;
2645 case CLI_GENERATE:
2646 return NULL;
2647 }
2648
2649 if (a->argc != 3) {
2650 return CLI_SHOWUSAGE;
2651 }
2652 ast_cli(a->fd, "HTTP Server Status:\n");
2653 ast_cli(a->fd, "Prefix: %s\n", prefix);
2654 ast_cli(a->fd, "Server: %s\n", http_server_name);
2655 if (!global_http_server) {
2656 ast_cli(a->fd, "Server Disabled\n\n");
2657 } else {
2658 ast_cli(a->fd, "Server Enabled and Bound to %s\n\n",
2660 if (http_tls_cfg.enabled) {
2661 ast_cli(a->fd, "HTTPS Server Enabled and Bound to %s\n\n",
2663 }
2664 }
2665
2666 ast_cli(a->fd, "Enabled URI's:\n");
2668 if (AST_RWLIST_EMPTY(&uris)) {
2669 ast_cli(a->fd, "None.\n");
2670 } else {
2672 ast_cli(a->fd, "%s/%s%s => %s\n", prefix, urih->uri, (urih->has_subtree ? "/..." : "" ), urih->description);
2673 }
2675
2676 ast_cli(a->fd, "\nEnabled Redirects:\n");
2679 ast_cli(a->fd, " %s => %s\n", redirect->target, redirect->dest);
2681 ast_cli(a->fd, " None.\n");
2682 }
2684
2685 return CLI_SUCCESS;
2686}
2687
2688static int reload_module(void)
2689{
2690 return __ast_http_load(1);
2691}
2692
2693static struct ast_cli_entry cli_http[] = {
2694 AST_CLI_DEFINE(handle_show_http, "Display HTTP server status"),
2695};
2696
2697static int unload_module(void)
2698{
2699 struct http_uri_redirect *redirect;
2701
2704
2705 if (http_tls_cfg.enabled) {
2707 }
2712
2713 if (status_uri_enabled) {
2715 }
2716
2717 if (static_uri_enabled) {
2719 }
2720
2722 while ((redirect = AST_RWLIST_REMOVE_HEAD(&uri_redirects, entry))) {
2723 ast_free(redirect);
2724 }
2726
2727 return 0;
2728}
2729
2730static int load_module(void)
2731{
2733
2735 HTTP_SERVER_BUCKETS, ast_http_server_hash_fn, NULL, ast_http_server_cmp_fn);
2736 if (!http_servers) {
2738 }
2739
2740 if (__ast_http_load(0)) {
2744 }
2745
2747}
2748
2750 .support_level = AST_MODULE_SUPPORT_CORE,
2751 .load = load_module,
2752 .unload = unload_module,
2754 .load_pri = AST_MODPRI_CORE,
2755 .requires = "extconfig",
void ast_cli_unregister_multiple(void)
Definition ael_main.c:408
char * text
Definition app_queue.c:1791
#define var
Definition ast_expr2f.c:605
Asterisk version information.
const char * ast_get_version(void)
Retrieve the Asterisk version string.
char * strsep(char **str, const char *delims)
char * strcasestr(const char *, const char *)
Asterisk main include file. File version handling, generic pbx functions.
int ast_shutdown_final(void)
Definition asterisk.c:1884
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition astmm.h:288
#define ast_free(a)
Definition astmm.h:180
#define ast_strndup(str, len)
A wrapper for strndup()
Definition astmm.h:256
#define ast_realloc(p, len)
A wrapper for realloc()
Definition astmm.h:226
#define ast_strdup(str)
A wrapper for strdup()
Definition astmm.h:241
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
#define ast_asprintf(ret, fmt,...)
A wrapper for asprintf()
Definition astmm.h:267
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
#define ast_malloc(len)
A wrapper for malloc()
Definition astmm.h:191
#define ast_log
Definition astobj2.c:42
#define OBJ_KEY
Definition astobj2.h:1151
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition astobj2.h:367
@ AO2_ALLOC_OPT_LOCK_MUTEX
Definition astobj2.h:363
#define AO2_STRING_FIELD_CMP_FN(stype, field)
Creates a compare function for a structure string field.
Definition astobj2.h:2048
#define ao2_cleanup(obj)
Definition astobj2.h:1934
#define ao2_unlink(container, obj)
Remove an object from a container.
Definition astobj2.h:1578
#define ao2_link_flags(container, obj, flags)
Add an object to a container.
Definition astobj2.h:1554
#define ao2_find(container, arg, flags)
Definition astobj2.h:1736
#define ao2_unlock(a)
Definition astobj2.h:729
#define ao2_lock(a)
Definition astobj2.h:717
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition astobj2.h:459
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition astobj2.h:404
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition astobj2.h:480
#define AO2_STRING_FIELD_HASH_FN(stype, field)
Creates a hash function for a structure string field.
Definition astobj2.h:2032
@ OBJ_NOLOCK
Assume that the ao2_container is already locked.
Definition astobj2.h:1063
#define ao2_alloc(data_size, destructor_fn)
Definition astobj2.h:409
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Allocate and initialize a hash container with the desired number of buckets.
Definition astobj2.h:1303
static const char type[]
struct ast_sockaddr bindaddr
static char version[AST_MAX_EXTENSION]
static int request(void *obj)
Standard Command Line Interface.
#define CLI_SHOWUSAGE
Definition cli.h:45
#define CLI_SUCCESS
Definition cli.h:44
#define AST_CLI_DEFINE(fn, txt,...)
Definition cli.h:197
void ast_cli(int fd, const char *fmt,...)
Definition clicompat.c:6
@ CLI_INIT
Definition cli.h:152
@ CLI_GENERATE
Definition cli.h:153
#define ast_cli_register_multiple(e, len)
Register multiple commands.
Definition cli.h:265
static int enabled
Definition dnsmgr.c:91
char buf[BUFSIZE]
Definition eagi_proxy.c:66
char * address
Definition f2c.h:59
static const char name[]
Definition format_mp3.c:68
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
void ast_http_prefix(char *buf, int len)
Return the current prefix.
Definition http.c:249
static int http_body_discard_chunk_trailer_headers(struct ast_tcptls_session_instance *ser)
Definition http.c:1115
void ast_http_send(struct ast_tcptls_session_instance *ser, enum ast_http_method method, int status_code, const char *status_title, struct ast_str *http_header, struct ast_str *out, int fd, unsigned int static_content)
Generic function for sending HTTP/1.1 response.
Definition http.c:472
static void * httpd_helper_thread(void *arg)
Definition http.c:2014
struct ast_variable * ast_http_get_post_vars(struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
Get post variables from client Request Entity-Body, if content type is application/x-www-form-urlenco...
Definition http.c:1405
static int http_check_connection_close(struct ast_variable *headers)
Definition http.c:842
struct ast_json * ast_http_get_json(struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
Get JSON from client Request Entity-Body, if content type is application/json.
Definition http.c:1330
#define DEFAULT_PORT
Definition http.c:69
static int httpstatus_callback(struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_vars, struct ast_variable *headers)
Definition http.c:384
int ast_http_header_parse(char *buf, char **name, char **value)
Parse a header into the given name/value strings.
Definition http.c:1765
static struct ast_tls_config http_tls_cfg
Definition http.c:111
const char * ast_get_http_method(enum ast_http_method method)
Return http method name string.
Definition http.c:193
struct ast_variable * ast_http_get_cookies(struct ast_variable *headers)
Get cookie from Request headers.
Definition http.c:1565
int ast_http_header_match_in(const char *name, const char *expected_name, const char *value, const char *expected_value)
Check if the header name matches the expected header name. If so, then check to see if the value can ...
Definition http.c:1803
#define MIN_INITIAL_REQUEST_TIMEOUT
Definition http.c:75
const char * mtype
Definition http.c:151
#define INITIAL_RESPONSE_BODY_BUFFER
Definition http.c:92
static int __ast_http_load(int reload)
Definition http.c:2441
static int http_request_headers_get(struct ast_tcptls_session_instance *ser, struct ast_variable **headers)
Definition http.c:1834
static void http_server_destroy(void *obj)
Definition http.c:2162
struct ao2_container * http_servers
Definition http.c:2157
static int http_request_tracking_setup(struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
Definition http.c:886
static void http_request_tracking_init(struct http_worker_private_data *request)
Definition http.c:867
#define BASIC_PREFIX
Definition http.c:1609
static int static_callback(struct ast_tcptls_session_instance *ser, const struct ast_http_uri *urih, const char *uri, enum ast_http_method method, struct ast_variable *get_vars, struct ast_variable *headers)
Definition http.c:256
static char http_server_name[MAX_SERVER_NAME_LENGTH]
Definition http.c:104
static void add_redirect(const char *value)
Add a new URI redirect The entries in the redirect list are sorted by length, just like the list of U...
Definition http.c:2099
static const char * get_header(struct ast_variable *headers, const char *field_name)
Retrieves the header with the given field name.
Definition http.c:755
#define MAX_HTTP_REQUEST_HEADERS
Definition http.c:1821
int ast_http_uri_link(struct ast_http_uri *urih)
Link the new uri into the list.
Definition http.c:689
static int status_uri_enabled
Definition http.c:146
int ast_http_body_discard(struct ast_tcptls_session_instance *ser)
Read and discard any unread HTTP request body.
Definition http.c:1135
static struct ast_cli_entry cli_http[]
Definition http.c:2693
enum ast_http_method ast_get_http_method_from_string(const char *method)
Return http method from string.
Definition http.c:206
static int http_server_start(struct ast_http_server *server)
Definition http.c:2206
http_private_flags
Definition http.c:455
@ HTTP_FLAG_BODY_READ
Definition http.c:459
@ HTTP_FLAG_CLOSE_ON_COMPLETION
Definition http.c:461
@ HTTP_FLAG_HAS_BODY
Definition http.c:457
static struct @386 mimetypes[]
Limit the kinds of files we're willing to serve up.
void ast_http_error(struct ast_tcptls_session_instance *ser, int status_code, const char *status_title, const char *text)
Send HTTP error message and close socket.
Definition http.c:664
static char prefix[MAX_PREFIX]
Definition http.c:144
static int http_body_discard_contents(struct ast_tcptls_session_instance *ser, int length, const char *what_getting)
Definition http.c:979
struct ast_variable * ast_http_parse_post_form(char *buf, int content_length, const char *content_type)
Get post variables from an application/x-www-form-urlencoded buffer.
Definition http.c:1369
static char * get_content_type(struct ast_variable *headers)
Retrieves the content type specified in the "Content-Type" header.
Definition http.c:778
static int session_count
Definition http.c:109
static int reload_module(void)
Definition http.c:2688
static int session_inactivity
Definition http.c:107
struct ast_variable * ast_http_create_basic_auth_header(const char *userid, const char *password)
Create an HTTP authorization header.
Definition http.c:1669
#define DEFAULT_SESSION_INACTIVITY
Definition http.c:73
static struct ast_http_server * http_server_create(const char *name, const char *address, const struct ast_sockaddr *addr)
Definition http.c:2174
static struct ast_http_uri status_uri
Definition http.c:437
static int http_body_check_chunk_sync(struct ast_tcptls_session_instance *ser)
Definition http.c:1084
struct ast_http_auth * ast_http_get_auth(struct ast_variable *headers)
Get HTTP authentication information from headers.
Definition http.c:1612
int ast_http_header_match(const char *name, const char *expected_name, const char *value, const char *expected_value)
Check if the header and value match (case insensitive) their associated expected values.
Definition http.c:1787
const char * ast_http_ftype2mtype(const char *ftype)
Return mime type based on extension.
Definition http.c:219
static void remove_excess_lws(char *s)
Definition http.c:1736
static void http_server_discard(struct ast_http_server *server)
Discard/Drop a HTTP server.
Definition http.c:2244
static struct ast_http_server * http_server_get_by_host(const char *name, const char *host, uint32_t port)
Retrieve, or create a HTTP server object by host.
Definition http.c:2302
#define DEFAULT_SESSION_KEEP_ALIVE
Definition http.c:77
static char * ast_http_get_contents(int *return_length, struct ast_tcptls_session_instance *ser, struct ast_variable *headers)
Returns the contents (body) of the HTTP request.
Definition http.c:1197
int ast_http_response_status_line(const char *buf, const char *version, int code)
Parse the http response status line.
Definition http.c:1713
#define MAX_CONTENT_LENGTH
Definition http.c:85
static int chunked_atoh(const char *s, int len)
Definition http.c:1002
void ast_http_request_close_on_completion(struct ast_tcptls_session_instance *ser)
Request the HTTP connection be closed after this HTTP request.
Definition http.c:853
static int http_body_read_contents(struct ast_tcptls_session_instance *ser, char *buf, int length, const char *what_getting)
Definition http.c:943
#define DEFAULT_TLS_PORT
Definition http.c:70
void ast_http_uri_unlink(struct ast_http_uri *urih)
Unregister a URI handler.
Definition http.c:721
static int load_module(void)
Definition http.c:2730
static const char * get_transfer_encoding(struct ast_variable *headers)
Returns the value of the Transfer-Encoding header.
Definition http.c:828
static struct ast_http_server * http_server_get_by_addr(const char *name, const struct ast_sockaddr *addr)
Retrieve, or create a HTTP server object by sock address.
Definition http.c:2272
static struct ast_http_uri static_uri
Definition http.c:446
static struct ast_http_server * http_server_get(const char *name, const char *host, uint32_t port, struct ast_http_server **replace_me)
Retrieve, or create and start a HTTP server.
Definition http.c:2354
void ast_http_create_response(struct ast_tcptls_session_instance *ser, int status_code, const char *status_title, struct ast_str *http_header_data, const char *text)
Creates and sends a formatted http response message.
Definition http.c:583
static struct ast_tcptls_session_args https_desc
Definition http.c:131
static int unload_module(void)
Definition http.c:2697
static int static_uri_enabled
Definition http.c:145
static int session_keep_alive
Definition http.c:108
#define BASIC_LEN
Definition http.c:1610
static int httpd_process_request(struct ast_tcptls_session_instance *ser)
Definition http.c:1916
static int handle_uri(struct ast_tcptls_session_instance *ser, char *uri, enum ast_http_method method, struct ast_variable *headers)
Definition http.c:1433
uint32_t ast_http_manid_from_vars(struct ast_variable *headers)
Return manager id, if exist, from request headers.
Definition http.c:233
static struct ast_http_auth * auth_create(const char *userid, const char *password)
Definition http.c:1578
void ast_http_uri_unlink_all_with_key(const char *key)
Unregister all handlers with matching key.
Definition http.c:728
static const struct ast_cfhttp_methods_text ast_http_methods_text[]
static struct ast_variable * parse_cookies(const char *cookies)
Definition http.c:1531
static char * handle_show_http(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
Definition http.c:2633
#define MAX_PREFIX
Definition http.c:68
#define MAX_HTTP_LINE_LENGTH
Definition http.c:99
void ast_http_body_read_status(struct ast_tcptls_session_instance *ser, int read_success)
Update the body read success status.
Definition http.c:914
struct ast_http_server * global_http_server
Definition http.c:129
#define DEFAULT_RESPONSE_HEADER_LENGTH
Definition http.c:81
#define MAX_SERVER_NAME_LENGTH
Definition http.c:79
static int http_body_get_chunk_length(struct ast_tcptls_session_instance *ser)
Definition http.c:1056
#define HTTP_SERVER_BUCKETS
Number of HTTP server buckets.
Definition http.c:2155
const char * ext
Definition http.c:150
static int session_limit
Definition http.c:106
static int get_content_length(struct ast_variable *headers)
Returns the value of the Content-Length header.
Definition http.c:803
#define DEFAULT_SESSION_LIMIT
Definition http.c:71
Support for Private Asterisk HTTP Servers.
ast_http_method
HTTP Request methods known by Asterisk.
Definition http.h:58
@ AST_HTTP_PUT
Definition http.h:63
@ AST_HTTP_DELETE
Definition http.h:64
@ AST_HTTP_POST
Definition http.h:61
@ AST_HTTP_GET
Definition http.h:60
@ AST_HTTP_UNKNOWN
Definition http.h:59
@ AST_HTTP_OPTIONS
Definition http.h:65
@ AST_HTTP_HEAD
Definition http.h:62
Configuration File Parser.
struct ast_config * ast_config_load2(const char *filename, const char *who_asked, struct ast_flags flags)
Load a config file.
#define ast_variable_new(name, value, filename)
#define CONFIG_STATUS_FILEUNCHANGED
#define CONFIG_STATUS_FILEINVALID
int ast_parse_arg(const char *arg, enum ast_parse_flags flags, void *p_result,...)
The argument parsing routine.
void ast_config_destroy(struct ast_config *cfg)
Destroys a config.
Definition extconf.c:1287
@ CONFIG_FLAG_FILEUNCHANGED
void ast_variables_destroy(struct ast_variable *var)
Free variable list.
Definition extconf.c:1260
struct ast_variable * ast_variable_browse(const struct ast_config *config, const char *category_name)
Definition extconf.c:1213
#define ast_debug(level,...)
Log a DEBUG message.
#define LOG_DEBUG
#define LOG_ERROR
#define ast_verb(level,...)
#define LOG_WARNING
ssize_t ast_iostream_printf(struct ast_iostream *stream, const char *format,...)
Write a formatted string to an iostream.
Definition iostream.c:502
ssize_t ast_iostream_gets(struct ast_iostream *stream, char *buffer, size_t size)
Read a LF-terminated string from an iostream.
Definition iostream.c:311
void ast_iostream_set_timeout_idle_inactivity(struct ast_iostream *stream, int timeout, int timeout_reset)
Set the iostream inactivity & idle timeout timers.
Definition iostream.c:131
ssize_t ast_iostream_write(struct ast_iostream *stream, const void *buffer, size_t count)
Write data to an iostream.
Definition iostream.c:385
int ast_iostream_get_fd(struct ast_iostream *stream)
Get an iostream's file descriptor.
Definition iostream.c:85
void ast_iostream_set_exclusive_input(struct ast_iostream *stream, int exclusive_input)
Set the iostream if it can exclusively depend upon the set timeouts.
Definition iostream.c:149
ssize_t ast_iostream_read(struct ast_iostream *stream, void *buffer, size_t count)
Read data from an iostream.
Definition iostream.c:284
void ast_iostream_nonblock(struct ast_iostream *stream)
Make an iostream non-blocking.
Definition iostream.c:104
ssize_t ast_iostream_discard(struct ast_iostream *stream, size_t count)
Discard the specified number of bytes from an iostream.
Definition iostream.c:368
Asterisk JSON abstraction layer.
struct ast_json * ast_json_load_buf(const char *buffer, size_t buflen, struct ast_json_error *error)
Parse buffer with known length into a JSON object or array.
Definition json.c:585
#define AST_RWLIST_EMPTY
#define AST_RWLIST_REMOVE_CURRENT
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition linkedlists.h:78
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
#define AST_RWLIST_HEAD_STATIC(name, type)
Defines a structure to be used to hold a read/write list of specified type, statically initialized.
#define AST_RWLIST_REMOVE_HEAD
#define AST_RWLIST_INSERT_AFTER
#define AST_RWLIST_NEXT
#define AST_RWLIST_REMOVE
#define AST_RWLIST_FIRST
#define AST_LIST_ENTRY(type)
Declare a forward link structure inside a list entry.
#define AST_RWLIST_TRAVERSE_SAFE_END
#define AST_RWLIST_TRAVERSE
#define AST_RWLIST_INSERT_HEAD
#define AST_RWLIST_INSERT_TAIL
struct ast_tm * ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone)
Timezone-independent version of localtime_r(3).
Definition localtime.c:1739
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm)
Special version of strftime(3) that handles fractions of a second. Takes the same arguments as strfti...
Definition localtime.c:2524
#define AST_PTHREADT_NULL
Definition lock.h:73
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition lock.h:764
int errno
The AMI - Asterisk Manager Interface - is a TCP protocol created to manage Asterisk with third-party ...
int astman_is_authed(uint32_t ident)
Determine if a manager session ident is authenticated.
Definition manager.c:7999
Asterisk module definitions.
@ AST_MODFLAG_LOAD_ORDER
Definition module.h:331
@ AST_MODFLAG_GLOBAL_SYMBOLS
Definition module.h:330
#define ast_module_unref(mod)
Release a reference to the module.
Definition module.h:483
#define ast_module_ref(mod)
Hold a reference to the module.
Definition module.h:457
#define AST_MODULE_INFO(keystr, flags_to_set, desc, fields...)
Definition module.h:557
@ AST_MODPRI_CORE
Definition module.h:338
@ AST_MODULE_SUPPORT_CORE
Definition module.h:121
#define ASTERISK_GPL_KEY
The text the key() function should return.
Definition module.h:46
@ AST_MODULE_LOAD_FAILURE
Module could not be loaded properly.
Definition module.h:102
@ AST_MODULE_LOAD_SUCCESS
Definition module.h:70
Network socket handling.
@ AST_AF_UNSPEC
Definition netsock2.h:54
static char * ast_sockaddr_stringify(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() with default format.
Definition netsock2.h:256
#define ast_sockaddr_port(addr)
Get the port number of a socket address.
Definition netsock2.h:517
static void ast_sockaddr_copy(struct ast_sockaddr *dst, const struct ast_sockaddr *src)
Copies the data from one ast_sockaddr to another.
Definition netsock2.h:167
int ast_sockaddr_resolve(struct ast_sockaddr **addrs, const char *str, int flags, int family)
Parses a string with an IPv4 or IPv6 address and place results into an array.
Definition netsock2.c:280
static int ast_sockaddr_isnull(const struct ast_sockaddr *addr)
Checks if the ast_sockaddr is null. "null" in this sense essentially means uninitialized,...
Definition netsock2.h:127
#define ast_sockaddr_set_port(addr, port)
Sets the port number of a socket address.
Definition netsock2.h:532
static char * ast_sockaddr_stringify_addr(const struct ast_sockaddr *addr)
Wrapper around ast_sockaddr_stringify_fmt() to return an address only.
Definition netsock2.h:286
static void ast_sockaddr_setnull(struct ast_sockaddr *addr)
Sets address addr to null.
Definition netsock2.h:138
Asterisk file paths, configured in asterisk.conf.
const char * ast_config_AST_DATA_DIR
Definition options.c:159
static int total
Definition res_adsi.c:970
static int reload(void)
const char * method
Definition res_pjsip.c:1273
static void cleanup(void)
Clean up any old apps that we don't need any more.
Definition res_stasis.c:327
#define NULL
Definition resample.c:96
String manipulation functions.
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition strings.h:1139
int ast_strings_equal(const char *str1, const char *str2)
Compare strings for equality checking for NULL.
Definition strings.c:238
size_t attribute_pure ast_str_strlen(const struct ast_str *buf)
Returns the current length of the string stored within buf.
Definition strings.h:730
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80
int attribute_pure ast_true(const char *val)
Make sure something is true. Determine if a string containing a boolean value is "true"....
Definition utils.c:2235
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
char *attribute_pure ast_skip_nonblanks(const char *str)
Gets a pointer to first whitespace character in a string.
Definition strings.h:204
char * ast_strip_quoted(char *s, const char *beg_quotes, const char *end_quotes)
Strip leading/trailing whitespace and quotes from a string.
Definition utils.c:1854
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition strings.h:659
int ast_str_set(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Set a dynamic string using variable arguments.
Definition strings.h:1113
char * ast_trim_blanks(char *str)
Trims trailing whitespace characters from a string.
Definition strings.h:186
char *attribute_pure ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition strings.h:761
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition strings.h:425
static int force_inline attribute_pure ast_begins_with(const char *str, const char *prefix)
Checks whether a string begins with another.
Definition strings.h:97
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition strings.h:223
char *attribute_pure ast_skip_blanks(const char *str)
Gets a pointer to the first non-whitespace character in a string.
Definition strings.h:161
Generic container type.
const char * text
Definition http.c:182
enum ast_http_method method
Definition http.c:181
descriptor for a cli entry.
Definition cli.h:171
char * command
Definition cli.h:186
const char * usage
Definition cli.h:177
Structure used to handle boolean flags.
Definition utils.h:220
HTTP authentication information.
Definition http.h:125
char * password
Definition http.h:129
char * userid
Definition http.h:127
struct ast_tcptls_session_args args
Definition http.c:121
char * name
Definition http.c:122
char * address
Definition http.c:123
Definition of a URI handler.
Definition http.h:102
unsigned int has_subtree
Definition http.h:108
unsigned int no_decode_uri
Definition http.h:114
ast_http_callback callback
Definition http.h:107
unsigned int dmallocd
Definition http.h:112
const char * prefix
Definition http.h:106
const char * description
Definition http.h:104
const char * uri
Definition http.h:105
void * data
Definition http.h:116
const char * key
Definition http.h:118
struct ast_http_uri::@241 entry
unsigned int mallocd
Definition http.h:110
Abstract JSON element (object, array, string, int, ...).
struct ast_module * self
Definition module.h:356
Socket address structure.
Definition netsock2.h:97
Support for dynamic strings.
Definition strings.h:623
arguments for the accepting thread
Definition tcptls.h:130
void *(* accept_fn)(void *)
Definition tcptls.h:140
struct ast_sockaddr local_address
Definition tcptls.h:131
const char * name
Definition tcptls.h:143
void *(* worker_fn)(void *)
Definition tcptls.h:142
struct ast_sockaddr old_address
Definition tcptls.h:132
struct ast_tls_config * tls_cfg
Definition tcptls.h:135
describes a server instance
Definition tcptls.h:151
struct ast_iostream * stream
Definition tcptls.h:162
struct ast_sockaddr remote_address
Definition tcptls.h:153
char * certfile
Definition tcptls.h:90
char * cipher
Definition tcptls.h:92
char * pvtfile
Definition tcptls.h:91
char * capath
Definition tcptls.h:94
struct ast_flags flags
Definition tcptls.h:95
Structure for variables, used for configurations and for channel variables.
struct ast_variable * next
char * dest
Definition http.c:174
struct http_uri_redirect::@387 entry
char target[0]
Definition http.c:175
struct ast_flags flags
Definition http.c:469
Definition http.c:141
int value
Definition syslog.c:37
Generic support for tcp/tls servers in Asterisk.
void * ast_tcptls_server_root(void *)
Definition tcptls.c:280
#define AST_CERTFILE
Definition tcptls.h:63
void ast_tcptls_server_stop(struct ast_tcptls_session_args *desc)
Shutdown a running server if there is one.
Definition tcptls.c:933
int ast_ssl_setup(struct ast_tls_config *cfg)
Set up an SSL server.
Definition tcptls.c:577
void ast_tcptls_server_start(struct ast_tcptls_session_args *desc)
This is a generic (re)start routine for a TCP server, which does the socket/bind/listen and starts a ...
Definition tcptls.c:768
@ AST_SSL_SERVER_CIPHER_ORDER
Definition tcptls.h:79
@ AST_SSL_DISABLE_TLSV1
Definition tcptls.h:81
int ast_tls_read_conf(struct ast_tls_config *tls_cfg, struct ast_tcptls_session_args *tls_desc, const char *varname, const char *value)
Used to parse conf files containing tls/ssl options.
Definition tcptls.c:959
void ast_tcptls_close_session_file(struct ast_tcptls_session_instance *tcptls_session)
Closes a tcptls session instance's file and/or file descriptor. The tcptls_session will be set to NUL...
Definition tcptls.c:923
int done
static struct test_val a
static struct test_val c
Time-related functions and macros.
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition time.h:159
FILE * out
Definition utils/frame.c:33
static char base64[64]
Definition utils.c:80
Utility functions.
#define ast_test_flag(p, flag)
Definition utils.h:64
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981
int ast_base64decode(unsigned char *dst, const char *src, int max)
Decode data from base64.
Definition utils.c:296
#define ast_assert(a)
Definition utils.h:779
int ast_base64encode(char *dst, const unsigned char *src, int srclen, int max)
Encode data in base64.
Definition utils.c:406
int ast_xml_escape(const char *string, char *outbuf, size_t buflen)
Escape reserved characters for use in XML.
Definition utils.c:900
#define ast_set_flag(p, flag)
Definition utils.h:71
#define ARRAY_LEN(a)
Definition utils.h:706
void ast_uri_decode(char *s, struct ast_flags spec)
Decode URI, URN, URL (overwrite string)
Definition utils.c:762
#define ast_set_flags_to(p, flag, value)
Definition utils.h:105
const struct ast_flags ast_uri_http_legacy
Definition utils.c:720