1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
|
/*
* Copyright (C) Internet Systems Consortium, Inc. ("ISC")
*
* SPDX-License-Identifier: MPL-2.0
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, you can obtain one at https://mozilla.org/MPL/2.0/.
*
* See the COPYRIGHT file distributed with this work for additional
* information regarding copyright ownership.
*/
/*! \file */
#include <ctype.h>
#include <inttypes.h>
#include <stdbool.h>
#include <string.h>
#include <isc/buffer.h>
#include <isc/httpd.h>
#include <isc/list.h>
#include <isc/mem.h>
#include <isc/netmgr.h>
#include <isc/refcount.h>
#include <isc/sockaddr.h>
#include <isc/string.h>
#include <isc/time.h>
#include <isc/url.h>
#include <isc/util.h>
#include "netmgr/netmgr-int.h"
#include "picohttpparser.h"
#ifdef HAVE_ZLIB
#include <zlib.h>
#endif /* ifdef HAVE_ZLIB */
/*
* Size the recv buffer to hold at maximum two full buffers from isc_nm_read(),
* so we don't have to handle the truncation.
*/
#define HTTP_RECVLEN ISC_NETMGR_TCP_RECVBUF_SIZE * 2
#define HTTP_SENDLEN ISC_NETMGR_TCP_RECVBUF_SIZE
#define HTTP_HEADERS_NUM 100
#define HTTP_MAX_REQUEST_LEN 4096
typedef enum httpd_flags {
CONNECTION_CLOSE = 1 << 0, /* connection must close */
CONNECTION_KEEP_ALIVE = 1 << 1, /* response needs a keep-alive header */
ACCEPT_DEFLATE = 1 << 2, /* response can be compressed */
} httpd_flags_t;
#define HTTPD_MAGIC ISC_MAGIC('H', 't', 'p', 'd')
#define VALID_HTTPD(m) ISC_MAGIC_VALID(m, HTTPD_MAGIC)
#define HTTPDMGR_MAGIC ISC_MAGIC('H', 'p', 'd', 'm')
#define VALID_HTTPDMGR(m) ISC_MAGIC_VALID(m, HTTPDMGR_MAGIC)
/*%
* HTTP methods.
*/
typedef enum { METHOD_UNKNOWN = 0, METHOD_GET = 1, METHOD_POST = 2 } method_t;
/*%
* HTTP urls. These are the URLs we manage, and the function to call to
* provide the data for it. We pass in the base url (so the same function
* can handle multiple requests), and a structure to fill in to return a
* result to the client. We also pass in a pointer to be filled in for
* the data cleanup function.
*/
struct isc_httpdurl {
char *url;
isc_httpdaction_t *action;
void *action_arg;
bool isstatic;
isc_time_t loadtime;
ISC_LINK(isc_httpdurl_t) link;
};
/*% http client */
struct isc_httpd {
unsigned int magic; /* HTTPD_MAGIC */
isc_refcount_t references;
isc_httpdmgr_t *mgr; /*%< our parent */
ISC_LINK(isc_httpd_t) link;
isc_nmhandle_t *handle; /* Permanent pointer to handle */
/*%
* Received data state.
*/
char recvbuf[HTTP_RECVLEN]; /*%< receive buffer */
size_t recvlen; /*%< length recv'd */
size_t consume; /*%< length of last command */
method_t method;
int minor_version;
httpd_flags_t flags;
const char *path;
isc_url_parser_t up;
isc_time_t if_modified_since;
};
#if ISC_HTTPD_TRACE
#define isc_httpd_ref(ptr) isc_httpd__ref(ptr, __func__, __FILE__, __LINE__)
#define isc_httpd_unref(ptr) isc_httpd__unref(ptr, __func__, __FILE__, __LINE__)
#define isc_httpd_attach(ptr, ptrp) \
isc_httpd__attach(ptr, ptrp, __func__, __FILE__, __LINE__)
#define isc_httpd_detach(ptrp) \
isc_httpd__detach(ptrp, __func__, __FILE__, __LINE__)
ISC_REFCOUNT_TRACE_DECL(isc_httpd);
#else
ISC_REFCOUNT_DECL(isc_httpd);
#endif
struct isc_httpdmgr {
unsigned int magic; /* HTTPDMGR_MAGIC */
isc_refcount_t references;
isc_mem_t *mctx;
isc_nmsocket_t *sock;
isc_httpdclientok_t *client_ok; /*%< client validator */
isc_httpdondestroy_t *ondestroy; /*%< cleanup callback */
void *cb_arg; /*%< argument for the above */
unsigned int flags;
ISC_LIST(isc_httpd_t) running; /*%< running clients */
isc_mutex_t lock;
ISC_LIST(isc_httpdurl_t) urls; /*%< urls we manage */
isc_httpdaction_t *render_404;
isc_httpdaction_t *render_500;
};
#if ISC_HTTPD_TRACE
#define isc_httpdmgr_ref(ptr) \
isc_httpdmgr__ref(ptr, __func__, __FILE__, __LINE__)
#define isc_httpdmgr_unref(ptr) \
isc_httpdmgr__unref(ptr, __func__, __FILE__, __LINE__)
#define isc_httpdmgr_attach(ptr, ptrp) \
isc_httpdmgr__attach(ptr, ptrp, __func__, __FILE__, __LINE__)
#define isc_httpdmgr_detach(ptrp) \
isc_httpdmgr__detach(ptrp, __func__, __FILE__, __LINE__)
ISC_REFCOUNT_TRACE_DECL(isc_httpdmgr);
#else
ISC_REFCOUNT_DECL(isc_httpdmgr);
#endif
typedef struct isc_httpd_sendreq {
isc_mem_t *mctx;
isc_httpd_t *httpd;
/*%
* Transmit data state.
*
* This is the data buffer we will transmit.
*
* This free function pointer is filled in by the rendering function
* we call. The free function is called after the data is transmitted
* to the client.
*
* We currently use three buffers total:
*
* sendbuffer - gets filled as we gather the data
*
* bodybuffer - for the client to fill in (which it manages, it provides
* the space for it, etc) -- we will pass that buffer structure back to
* the caller, who is responsible for managing the space it may have
* allocated as backing store for it. we only allocate the buffer
* itself, not the backing store.
*
* compbuffer - managed by us, that contains the compressed HTTP data,
* if compression is used.
*/
isc_buffer_t *sendbuffer;
isc_buffer_t *compbuffer;
isc_buffer_t bodybuffer;
const char *mimetype;
unsigned int retcode;
const char *retmsg;
isc_httpdfree_t *freecb;
void *freecb_arg;
} isc_httpd_sendreq_t;
static isc_result_t
httpd_newconn(isc_nmhandle_t *, isc_result_t, void *);
static void
httpd_request(isc_nmhandle_t *, isc_result_t, isc_region_t *, void *);
static void
httpd_senddone(isc_nmhandle_t *, isc_result_t, void *);
static void
httpd_free(isc_httpd_t *httpd);
static void
httpd_addheader(isc_httpd_sendreq_t *, const char *, const char *);
static void
httpd_addheaderuint(isc_httpd_sendreq_t *, const char *, int);
static void
httpd_endheaders(isc_httpd_sendreq_t *);
static void
httpd_response(isc_httpd_t *, isc_httpd_sendreq_t *);
static isc_result_t
process_request(isc_httpd_t *, size_t);
static isc_httpdaction_t render_404;
static isc_httpdaction_t render_500;
#if ENABLE_AFL
static void (*finishhook)(void) = NULL;
#endif /* ENABLE_AFL */
isc_result_t
isc_httpdmgr_create(isc_mem_t *mctx, isc_sockaddr_t *addr,
isc_httpdclientok_t *client_ok,
isc_httpdondestroy_t *ondestroy, void *cb_arg,
isc_httpdmgr_t **httpdmgrp) {
isc_result_t result;
isc_httpdmgr_t *httpdmgr = NULL;
REQUIRE(mctx != NULL);
REQUIRE(httpdmgrp != NULL && *httpdmgrp == NULL);
httpdmgr = isc_mem_get(mctx, sizeof(isc_httpdmgr_t));
*httpdmgr = (isc_httpdmgr_t){ .client_ok = client_ok,
.ondestroy = ondestroy,
.cb_arg = cb_arg,
.render_404 = render_404,
.render_500 = render_500 };
isc_mutex_init(&httpdmgr->lock);
isc_mem_attach(mctx, &httpdmgr->mctx);
ISC_LIST_INIT(httpdmgr->running);
ISC_LIST_INIT(httpdmgr->urls);
isc_refcount_init(&httpdmgr->references, 1);
CHECK(isc_nm_listentcp(ISC_NM_LISTEN_ONE, addr, httpd_newconn, httpdmgr,
5, NULL, &httpdmgr->sock));
httpdmgr->magic = HTTPDMGR_MAGIC;
*httpdmgrp = httpdmgr;
return ISC_R_SUCCESS;
cleanup:
httpdmgr->magic = 0;
isc_refcount_decrementz(&httpdmgr->references);
isc_refcount_destroy(&httpdmgr->references);
isc_mem_detach(&httpdmgr->mctx);
isc_mutex_destroy(&httpdmgr->lock);
isc_mem_put(mctx, httpdmgr, sizeof(isc_httpdmgr_t));
return result;
}
static void
destroy_httpdmgr(isc_httpdmgr_t *httpdmgr) {
isc_refcount_destroy(&httpdmgr->references);
LOCK(&httpdmgr->lock);
REQUIRE((httpdmgr->flags & ISC_HTTPDMGR_SHUTTINGDOWN) != 0);
REQUIRE(ISC_LIST_EMPTY(httpdmgr->running));
httpdmgr->magic = 0;
if (httpdmgr->sock != NULL) {
isc_nmsocket_close(&httpdmgr->sock);
}
/*
* Clear out the list of all actions we know about. Just free the
* memory.
*/
ISC_LIST_FOREACH(httpdmgr->urls, url, link) {
isc_mem_free(httpdmgr->mctx, url->url);
ISC_LIST_UNLINK(httpdmgr->urls, url, link);
isc_mem_put(httpdmgr->mctx, url, sizeof(isc_httpdurl_t));
}
UNLOCK(&httpdmgr->lock);
isc_mutex_destroy(&httpdmgr->lock);
if (httpdmgr->ondestroy != NULL) {
(httpdmgr->ondestroy)(httpdmgr->cb_arg);
}
isc_mem_putanddetach(&httpdmgr->mctx, httpdmgr, sizeof(isc_httpdmgr_t));
}
#if ISC_HTTPD_TRACE
ISC_REFCOUNT_TRACE_IMPL(isc_httpdmgr, destroy_httpdmgr)
#else
ISC_REFCOUNT_IMPL(isc_httpdmgr, destroy_httpdmgr);
#endif
static bool
name_match(const struct phr_header *header, const char *match) {
size_t match_len = strlen(match);
if (match_len != header->name_len) {
return false;
}
return strncasecmp(header->name, match, match_len) == 0;
}
static bool
value_match(const struct phr_header *header, const char *match) {
size_t match_len = strlen(match);
size_t limit;
if (match_len > header->value_len) {
return false;
}
limit = header->value_len - match_len + 1;
for (size_t i = 0; i < limit; i++) {
if (isspace((unsigned char)header->value[i])) {
while (i < limit &&
isspace((unsigned char)header->value[i]))
{
i++;
}
continue;
}
if (strncasecmp(&header->value[i], match, match_len) == 0) {
i += match_len;
/*
* Sanity check; f.e. for 'deflate' match only
* 'deflate[,;]', but not 'deflateyou'
*/
if (i == header->value_len || header->value[i] == ',' ||
header->value[i] == ';')
{
return true;
}
}
while (i < limit && header->value[i] != ',') {
i++;
}
}
return false;
}
static isc_result_t
process_request(isc_httpd_t *httpd, size_t last_len) {
int pret;
const char *method = NULL;
size_t method_len = 0;
const char *path;
size_t path_len = 0;
struct phr_header headers[HTTP_HEADERS_NUM];
size_t num_headers;
num_headers = ARRAY_SIZE(headers);
pret = phr_parse_request(httpd->recvbuf, httpd->recvlen, &method,
&method_len, &path, &path_len,
&httpd->minor_version, headers, &num_headers,
last_len);
if (pret == -1) {
/* Parse Error */
return ISC_R_UNEXPECTED;
} else if (pret == -2) {
/* Need more data */
return ISC_R_NOMORE;
}
INSIST(pret > 0);
if (pret > HTTP_MAX_REQUEST_LEN) {
return ISC_R_RANGE;
}
httpd->consume = pret;
/*
* Determine if this is a POST or GET method. Any other values will
* cause an error to be returned.
*/
if (strncmp(method, "GET ", method_len) == 0) {
httpd->method = METHOD_GET;
} else if (strncmp(method, "POST ", method_len) == 0) {
httpd->method = METHOD_POST;
} else {
return ISC_R_RANGE;
}
/*
* Parse the URL
*/
RETERR(isc_url_parse(path, path_len, 0, &httpd->up));
httpd->path = path;
/*
* Examine headers that can affect this request's response
*/
httpd->flags = 0;
size_t content_len = 0;
bool keep_alive = false;
bool host_header = false;
isc_time_set(&httpd->if_modified_since, 0, 0);
for (size_t i = 0; i < num_headers; i++) {
struct phr_header *header = &headers[i];
if (name_match(header, "Content-Length")) {
char *endptr;
long val = strtol(header->value, &endptr, 10);
errno = 0;
/* ensure we consumed all digits */
if ((header->value + header->value_len) != endptr) {
return ISC_R_BADNUMBER;
}
/* ensure there was no minus sign */
if (val < 0) {
return ISC_R_BADNUMBER;
}
/* ensure it did not overflow */
if (errno != 0) {
return ISC_R_RANGE;
}
content_len = val;
} else if (name_match(header, "Connection")) {
/* multiple fields in a connection header are allowed */
if (value_match(header, "close")) {
httpd->flags |= CONNECTION_CLOSE;
}
if (value_match(header, "keep-alive")) {
keep_alive = true;
}
} else if (name_match(header, "Host")) {
host_header = true;
} else if (name_match(header, "Accept-Encoding")) {
if (value_match(header, "deflate")) {
httpd->flags |= ACCEPT_DEFLATE;
}
} else if (name_match(header, "If-Modified-Since") &&
header->value_len < ISC_FORMATHTTPTIMESTAMP_SIZE)
{
char timestamp[ISC_FORMATHTTPTIMESTAMP_SIZE + 1];
memmove(timestamp, header->value, header->value_len);
timestamp[header->value_len] = 0;
/* Ignore the value if it can't be parsed */
(void)isc_time_parsehttptimestamp(
timestamp, &httpd->if_modified_since);
}
}
/*
* The Content-Length is optional in an HTTP request.
* For a GET the length must be zero.
*/
if (httpd->method == METHOD_GET && content_len != 0) {
return ISC_R_BADNUMBER;
}
if (content_len >= HTTP_MAX_REQUEST_LEN) {
return ISC_R_RANGE;
}
size_t consume = httpd->consume + content_len;
if (consume > httpd->recvlen) {
/* The request data isn't complete yet. */
return ISC_R_NOMORE;
}
/* Consume the request's data, which we do not use. */
httpd->consume = consume;
switch (httpd->minor_version) {
case 0:
/*
* RFC 9112 section 9.3 says close takes priority if
* keep-alive is also present
*/
if ((httpd->flags & CONNECTION_CLOSE) == 0 && keep_alive) {
httpd->flags |= CONNECTION_KEEP_ALIVE;
} else {
httpd->flags |= CONNECTION_CLOSE;
}
break;
case 1:
if (!host_header) {
return ISC_R_RANGE;
}
break;
default:
return ISC_R_UNEXPECTED;
}
/*
* Looks like a a valid request, so now we know we won't have
* to process this buffer again. We can NULL-terminate the
* URL for the caller's benefit, and set recvlen to 0 so
* the next read will overwrite this one instead of appending
* to the buffer.
*/
return ISC_R_SUCCESS;
}
static void
httpd_free(isc_httpd_t *httpd) {
isc_httpdmgr_t *httpdmgr = NULL;
REQUIRE(VALID_HTTPD(httpd));
httpdmgr = httpd->mgr;
REQUIRE(VALID_HTTPDMGR(httpdmgr));
LOCK(&httpdmgr->lock);
ISC_LIST_UNLINK(httpdmgr->running, httpd, link);
UNLOCK(&httpdmgr->lock);
httpd->recvbuf[0] = 0;
httpd->recvlen = 0;
httpd->consume = 0;
httpd->method = METHOD_UNKNOWN;
httpd->flags = 0;
httpd->minor_version = -1;
httpd->path = NULL;
httpd->up = (isc_url_parser_t){ 0 };
isc_time_set(&httpd->if_modified_since, 0, 0);
httpd->magic = 0;
httpd->mgr = NULL;
isc_mem_put(httpdmgr->mctx, httpd, sizeof(*httpd));
isc_httpdmgr_detach(&httpdmgr);
#if ENABLE_AFL
if (finishhook != NULL) {
finishhook();
}
#endif /* ENABLE_AFL */
}
#if ISC_HTTPD_TRACE
ISC_REFCOUNT_TRACE_IMPL(isc_httpd, httpd_free)
#else
ISC_REFCOUNT_IMPL(isc_httpd, httpd_free);
#endif
static void
isc__httpd_sendreq_free(isc_httpd_sendreq_t *req) {
/* Clean up buffers */
isc_buffer_free(&req->sendbuffer);
isc_mem_putanddetach(&req->mctx, req, sizeof(*req));
}
static isc_httpd_sendreq_t *
isc__httpd_sendreq_new(isc_httpd_t *httpd) {
isc_httpdmgr_t *httpdmgr = httpd->mgr;
isc_httpd_sendreq_t *req;
REQUIRE(VALID_HTTPDMGR(httpdmgr));
req = isc_mem_get(httpdmgr->mctx, sizeof(*req));
*req = (isc_httpd_sendreq_t){ 0 };
isc_mem_attach(httpdmgr->mctx, &req->mctx);
/*
* Initialize the buffer for our headers.
*/
isc_buffer_allocate(req->mctx, &req->sendbuffer, HTTP_SENDLEN);
isc_buffer_clear(req->sendbuffer);
isc_buffer_initnull(&req->bodybuffer);
isc_httpd_attach(httpd, &req->httpd);
return req;
}
static void
new_httpd(isc_httpdmgr_t *httpdmgr, isc_nmhandle_t *handle) {
isc_httpd_t *httpd = NULL;
REQUIRE(VALID_HTTPDMGR(httpdmgr));
httpd = isc_mem_get(httpdmgr->mctx, sizeof(*httpd));
*httpd = (isc_httpd_t){
.magic = HTTPD_MAGIC,
.link = ISC_LINK_INITIALIZER,
.references = ISC_REFCOUNT_INITIALIZER(1),
};
isc_nmhandle_attach(handle, &httpd->handle);
isc_httpdmgr_attach(httpdmgr, &httpd->mgr);
LOCK(&httpdmgr->lock);
ISC_LIST_APPEND(httpdmgr->running, httpd, link);
UNLOCK(&httpdmgr->lock);
isc_nm_read(handle, httpd_request, httpd);
}
static isc_result_t
httpd_newconn(isc_nmhandle_t *handle, isc_result_t result, void *arg) {
isc_httpdmgr_t *httpdmgr = (isc_httpdmgr_t *)arg;
isc_sockaddr_t peeraddr;
REQUIRE(VALID_HTTPDMGR(httpdmgr));
if ((httpdmgr->flags & ISC_HTTPDMGR_SHUTTINGDOWN) != 0) {
return ISC_R_CANCELED;
} else if (result == ISC_R_CANCELED) {
isc_httpdmgr_shutdown(&httpdmgr);
return result;
} else if (result != ISC_R_SUCCESS) {
return result;
}
peeraddr = isc_nmhandle_peeraddr(handle);
if (httpdmgr->client_ok != NULL &&
!(httpdmgr->client_ok)(&peeraddr, httpdmgr->cb_arg))
{
return ISC_R_FAILURE;
}
new_httpd(httpdmgr, handle);
return ISC_R_SUCCESS;
}
static isc_result_t
render_404(const isc_httpd_t *httpd, const isc_httpdurl_t *urlinfo, void *arg,
unsigned int *retcode, const char **retmsg, const char **mimetype,
isc_buffer_t *b, isc_httpdfree_t **freecb, void **freecb_args) {
static char msg[] = "No such URL.\r\n";
UNUSED(httpd);
UNUSED(urlinfo);
UNUSED(arg);
*retcode = 404;
*retmsg = "No such URL";
*mimetype = "text/plain";
isc_buffer_reinit(b, msg, strlen(msg));
isc_buffer_add(b, strlen(msg));
*freecb = NULL;
*freecb_args = NULL;
return ISC_R_SUCCESS;
}
static isc_result_t
render_500(const isc_httpd_t *httpd, const isc_httpdurl_t *urlinfo, void *arg,
unsigned int *retcode, const char **retmsg, const char **mimetype,
isc_buffer_t *b, isc_httpdfree_t **freecb, void **freecb_args) {
static char msg[] = "Internal server failure.\r\n";
UNUSED(httpd);
UNUSED(urlinfo);
UNUSED(arg);
*retcode = 500;
*retmsg = "Internal server failure";
*mimetype = "text/plain";
isc_buffer_reinit(b, msg, strlen(msg));
isc_buffer_add(b, strlen(msg));
*freecb = NULL;
*freecb_args = NULL;
return ISC_R_SUCCESS;
}
#ifdef HAVE_ZLIB
/*%<
* Tries to compress httpd->bodybuffer to httpd->compbuffer, extending it
* if necessary.
*
* Requires:
*\li httpd a valid isc_httpd_t object
*
* Returns:
*\li #ISC_R_SUCCESS -- all is well.
*\li #ISC_R_FAILURE -- error during compression or compressed
* data would be larger than input data
*/
static isc_result_t
httpd_compress(isc_httpd_sendreq_t *req) {
z_stream zstr;
int ret, inputlen;
/*
* We're setting output buffer size to input size so it fails if the
* compressed data size would be bigger than the input size.
*/
inputlen = isc_buffer_usedlength(&req->bodybuffer);
if (inputlen == 0) {
return ISC_R_FAILURE;
}
isc_buffer_allocate(req->mctx, &req->compbuffer, inputlen);
isc_buffer_clear(req->compbuffer);
zstr = (z_stream){
.total_in = inputlen,
.avail_out = inputlen,
.avail_in = inputlen,
.next_in = isc_buffer_base(&req->bodybuffer),
.next_out = isc_buffer_base(req->compbuffer),
};
ret = deflateInit(&zstr, Z_DEFAULT_COMPRESSION);
if (ret == Z_OK) {
ret = deflate(&zstr, Z_FINISH);
}
deflateEnd(&zstr);
if (ret == Z_STREAM_END) {
isc_buffer_add(req->compbuffer, zstr.total_out);
return ISC_R_SUCCESS;
} else {
isc_buffer_free(&req->compbuffer);
return ISC_R_FAILURE;
}
}
#endif /* ifdef HAVE_ZLIB */
static void
prepare_response(void *arg) {
isc_httpd_sendreq_t *req = arg;
isc_httpd_t *httpd = req->httpd;
isc_httpdmgr_t *mgr = httpd->mgr;
isc_time_t now = isc_time_now();
char datebuf[ISC_FORMATHTTPTIMESTAMP_SIZE];
const char *path = "/";
size_t path_len = 1;
bool is_compressed = false;
isc_httpdurl_t *url = NULL;
isc_result_t result;
REQUIRE(VALID_HTTPD(httpd));
REQUIRE(req != NULL);
isc_time_formathttptimestamp(&now, datebuf, sizeof(datebuf));
if (httpd->up.field_set & (1 << ISC_UF_PATH)) {
path = &httpd->path[httpd->up.field_data[ISC_UF_PATH].off];
path_len = httpd->up.field_data[ISC_UF_PATH].len;
}
LOCK(&mgr->lock);
ISC_LIST_FOREACH(mgr->urls, u, link) {
if (strncmp(path, u->url, path_len) == 0) {
url = u;
break;
}
}
UNLOCK(&mgr->lock);
if (url == NULL) {
result = mgr->render_404(httpd, NULL, NULL, &req->retcode,
&req->retmsg, &req->mimetype,
&req->bodybuffer, &req->freecb,
&req->freecb_arg);
} else {
result = url->action(httpd, url, url->action_arg, &req->retcode,
&req->retmsg, &req->mimetype,
&req->bodybuffer, &req->freecb,
&req->freecb_arg);
}
if (result != ISC_R_SUCCESS) {
result = mgr->render_500(httpd, url, NULL, &req->retcode,
&req->retmsg, &req->mimetype,
&req->bodybuffer, &req->freecb,
&req->freecb_arg);
RUNTIME_CHECK(result == ISC_R_SUCCESS);
}
#ifdef HAVE_ZLIB
if ((httpd->flags & ACCEPT_DEFLATE) != 0) {
result = httpd_compress(req);
if (result == ISC_R_SUCCESS) {
is_compressed = true;
}
}
#endif /* ifdef HAVE_ZLIB */
httpd_response(httpd, req);
/* RFC 9112 ยง 9.6: SHOULD send Connection: close in last response */
if ((httpd->flags & CONNECTION_CLOSE) != 0) {
httpd_addheader(req, "Connection", "close");
} else if ((httpd->flags & CONNECTION_KEEP_ALIVE) != 0) {
httpd_addheader(req, "Connection", "Keep-Alive");
}
httpd_addheader(req, "Content-Type", req->mimetype);
httpd_addheader(req, "Date", datebuf);
httpd_addheader(req, "Expires", datebuf);
if (url != NULL && url->isstatic) {
char loadbuf[ISC_FORMATHTTPTIMESTAMP_SIZE];
isc_time_formathttptimestamp(&url->loadtime, loadbuf,
sizeof(loadbuf));
httpd_addheader(req, "Last-Modified", loadbuf);
httpd_addheader(req, "Cache-Control: public", NULL);
} else {
httpd_addheader(req, "Last-Modified", datebuf);
httpd_addheader(req, "Pragma: no-cache", NULL);
httpd_addheader(req, "Cache-Control: no-cache", NULL);
}
httpd_addheader(req, "Server: libisc", NULL);
if (is_compressed) {
httpd_addheader(req, "Content-Encoding", "deflate");
httpd_addheaderuint(req, "Content-Length",
isc_buffer_usedlength(req->compbuffer));
} else {
httpd_addheaderuint(req, "Content-Length",
isc_buffer_usedlength(&req->bodybuffer));
}
httpd_endheaders(req); /* done */
/*
* Append either the compressed or the non-compressed response body to
* the response headers and store the result in httpd->sendbuffer.
*/
if (is_compressed) {
isc_buffer_putmem(req->sendbuffer,
isc_buffer_base(req->compbuffer),
isc_buffer_usedlength(req->compbuffer));
isc_buffer_free(&req->compbuffer);
} else {
isc_buffer_putmem(req->sendbuffer,
isc_buffer_base(&req->bodybuffer),
isc_buffer_usedlength(&req->bodybuffer));
}
/* Free the bodybuffer */
if (req->freecb != NULL && isc_buffer_length(&req->bodybuffer) > 0) {
req->freecb(&req->bodybuffer, req->freecb_arg);
}
/* Consume the request from the recv buffer. */
INSIST(httpd->consume != 0);
INSIST(httpd->consume <= httpd->recvlen);
if (httpd->consume < httpd->recvlen) {
memmove(httpd->recvbuf, httpd->recvbuf + httpd->consume,
httpd->recvlen - httpd->consume);
}
httpd->recvlen -= httpd->consume;
httpd->consume = 0;
}
static void
prepare_response_done(void *arg) {
isc_region_t r;
isc_httpd_sendreq_t *req = arg;
isc_httpd_t *httpd = req->httpd;
/*
* Determine total response size.
*/
isc_buffer_usedregion(req->sendbuffer, &r);
isc_nm_send(httpd->handle, &r, httpd_senddone, req);
}
static void
httpd_request(isc_nmhandle_t *handle, isc_result_t eresult,
isc_region_t *region, void *arg) {
isc_httpd_t *httpd = arg;
isc_httpdmgr_t *mgr = httpd->mgr;
size_t last_len = 0;
isc_result_t result;
REQUIRE(VALID_HTTPD(httpd));
REQUIRE(httpd->handle == handle);
if (eresult != ISC_R_SUCCESS) {
goto close_readhandle;
}
REQUIRE((mgr->flags & ISC_HTTPDMGR_SHUTTINGDOWN) == 0);
isc_nm_read_stop(handle);
/*
* If we are being called from httpd_senddone(), the last HTTP request
* was processed successfully, reset the last_len to 0, even if there's
* data in the httpd->recvbuf.
*/
last_len = (region == NULL) ? 0 : httpd->recvlen;
/* Store the received data into the recvbuf */
if (region != NULL) {
if (httpd->recvlen + region->length > sizeof(httpd->recvbuf)) {
goto close_readhandle;
}
memmove(httpd->recvbuf + httpd->recvlen, region->base,
region->length);
httpd->recvlen += region->length;
}
result = process_request(httpd, last_len);
if (result == ISC_R_NOMORE) {
if (httpd->recvlen > HTTP_MAX_REQUEST_LEN) {
goto close_readhandle;
}
/* Wait for more data, the handle is still attached */
isc_nm_read(handle, httpd_request, arg);
return;
}
/* XXXFANF it would be more polite to reply 400 bad request */
if (result != ISC_R_SUCCESS) {
goto close_readhandle;
}
isc_httpd_sendreq_t *req = isc__httpd_sendreq_new(httpd);
isc_nmhandle_ref(handle);
isc_work_enqueue(isc_loop(), prepare_response, prepare_response_done,
req);
return;
close_readhandle:
isc_nmhandle_close(httpd->handle);
isc_nmhandle_detach(&httpd->handle);
isc_httpd_detach(&httpd);
}
void
isc_httpdmgr_shutdown(isc_httpdmgr_t **httpdmgrp) {
isc_httpdmgr_t *httpdmgr = NULL;
REQUIRE(httpdmgrp != NULL);
REQUIRE(VALID_HTTPDMGR(*httpdmgrp));
httpdmgr = *httpdmgrp;
*httpdmgrp = NULL;
isc_nm_stoplistening(httpdmgr->sock);
LOCK(&httpdmgr->lock);
ISC_LIST_FOREACH(httpdmgr->running, httpd, link) {
if (httpd->handle != NULL) {
httpd_request(httpd->handle, ISC_R_SUCCESS, NULL,
httpd);
}
}
httpdmgr->flags |= ISC_HTTPDMGR_SHUTTINGDOWN;
UNLOCK(&httpdmgr->lock);
isc_nmsocket_close(&httpdmgr->sock);
isc_httpdmgr_detach(&httpdmgr);
}
static void
httpd_response(isc_httpd_t *httpd, isc_httpd_sendreq_t *req) {
isc_result_t result;
result = isc_buffer_printf(req->sendbuffer, "HTTP/1.%u %03u %s\r\n",
httpd->minor_version, req->retcode,
req->retmsg);
RUNTIME_CHECK(result == ISC_R_SUCCESS);
}
static void
httpd_addheader(isc_httpd_sendreq_t *req, const char *name, const char *val) {
isc_result_t result;
if (val != NULL) {
result = isc_buffer_printf(req->sendbuffer, "%s: %s\r\n", name,
val);
} else {
result = isc_buffer_printf(req->sendbuffer, "%s\r\n", name);
}
RUNTIME_CHECK(result == ISC_R_SUCCESS);
}
static void
httpd_endheaders(isc_httpd_sendreq_t *req) {
isc_result_t result;
result = isc_buffer_printf(req->sendbuffer, "\r\n");
RUNTIME_CHECK(result == ISC_R_SUCCESS);
}
static void
httpd_addheaderuint(isc_httpd_sendreq_t *req, const char *name, int val) {
isc_result_t result;
result = isc_buffer_printf(req->sendbuffer, "%s: %d\r\n", name, val);
RUNTIME_CHECK(result == ISC_R_SUCCESS);
}
static void
httpd_senddone(isc_nmhandle_t *handle, isc_result_t eresult, void *arg) {
isc_httpd_sendreq_t *req = (isc_httpd_sendreq_t *)arg;
isc_httpd_t *httpd = req->httpd;
REQUIRE(VALID_HTTPD(httpd));
if ((httpd->mgr->flags & ISC_HTTPDMGR_SHUTTINGDOWN) != 0) {
goto detach;
}
if (eresult == ISC_R_SUCCESS && (httpd->flags & CONNECTION_CLOSE) != 0)
{
eresult = ISC_R_EOF;
}
/*
* Calling httpd_request() with region NULL restarts reading.
*/
httpd_request(handle, eresult, NULL, httpd);
detach:
isc_nmhandle_detach(&handle);
isc__httpd_sendreq_free(req);
isc_httpd_detach(&httpd);
}
isc_result_t
isc_httpdmgr_addurl(isc_httpdmgr_t *httpdmgr, const char *url, bool isstatic,
isc_httpdaction_t *func, void *arg) {
isc_httpdurl_t *item;
REQUIRE(VALID_HTTPDMGR(httpdmgr));
if (url == NULL) {
httpdmgr->render_404 = func;
return ISC_R_SUCCESS;
}
item = isc_mem_get(httpdmgr->mctx, sizeof(isc_httpdurl_t));
item->url = isc_mem_strdup(httpdmgr->mctx, url);
item->action = func;
item->action_arg = arg;
item->isstatic = isstatic;
item->loadtime = isc_time_now();
ISC_LINK_INIT(item, link);
LOCK(&httpdmgr->lock);
ISC_LIST_APPEND(httpdmgr->urls, item, link);
UNLOCK(&httpdmgr->lock);
return ISC_R_SUCCESS;
}
void
isc_httpd_setfinishhook(void (*fn)(void)) {
#if ENABLE_AFL
finishhook = fn;
#else /* ENABLE_AFL */
UNUSED(fn);
#endif /* ENABLE_AFL */
}
bool
isc_httpdurl_isstatic(const isc_httpdurl_t *url) {
return url->isstatic;
}
const isc_time_t *
isc_httpdurl_loadtime(const isc_httpdurl_t *url) {
return &url->loadtime;
}
const isc_time_t *
isc_httpd_if_modified_since(const isc_httpd_t *httpd) {
return (const isc_time_t *)&httpd->if_modified_since;
}
|