server_fcgi.c revision 1.35
1/* $OpenBSD: server_fcgi.c,v 1.35 2014/08/29 13:01:46 reyk Exp $ */ 2 3/* 4 * Copyright (c) 2014 Florian Obser <florian@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17 */ 18 19#include <sys/types.h> 20#include <sys/queue.h> 21#include <sys/time.h> 22#include <sys/stat.h> 23#include <sys/socket.h> 24#include <sys/un.h> 25#include <sys/tree.h> 26#include <sys/hash.h> 27 28#include <net/if.h> 29#include <netinet/in_systm.h> 30#include <netinet/in.h> 31#include <netinet/ip.h> 32#include <netinet/tcp.h> 33#include <arpa/inet.h> 34 35#include <errno.h> 36#include <fcntl.h> 37#include <stdlib.h> 38#include <string.h> 39#include <unistd.h> 40#include <stdio.h> 41#include <ctype.h> 42#include <err.h> 43#include <event.h> 44 45#include "httpd.h" 46#include "http.h" 47 48#define FCGI_PADDING_SIZE 255 49#define FCGI_RECORD_SIZE \ 50 (sizeof(struct fcgi_record_header) + FCGI_CONTENT_SIZE + FCGI_PADDING_SIZE) 51 52#define FCGI_BEGIN_REQUEST 1 53#define FCGI_ABORT_REQUEST 2 54#define FCGI_END_REQUEST 3 55#define FCGI_PARAMS 4 56#define FCGI_STDIN 5 57#define FCGI_STDOUT 6 58#define FCGI_STDERR 7 59#define FCGI_DATA 8 60#define FCGI_GET_VALUES 9 61#define FCGI_GET_VALUES_RESULT 10 62#define FCGI_UNKNOWN_TYPE 11 63#define FCGI_MAXTYPE (FCGI_UNKNOWN_TYPE) 64 65#define FCGI_RESPONDER 1 66 67struct fcgi_record_header { 68 uint8_t version; 69 uint8_t type; 70 uint16_t id; 71 uint16_t content_len; 72 uint8_t padding_len; 73 uint8_t reserved; 74} __packed; 75 76struct fcgi_begin_request_body { 77 uint16_t role; 78 uint8_t flags; 79 uint8_t reserved[5]; 80} __packed; 81 82struct server_fcgi_param { 83 int total_len; 84 uint8_t buf[FCGI_RECORD_SIZE]; 85}; 86 87int server_fcgi_header(struct client *, u_int); 88void server_fcgi_read(struct bufferevent *, void *); 89int server_fcgi_writeheader(struct client *, struct kv *, void *); 90int fcgi_add_param(struct server_fcgi_param *, const char *, const char *, 91 struct client *); 92int get_status(struct evbuffer *); 93 94int 95server_fcgi(struct httpd *env, struct client *clt) 96{ 97 struct server_fcgi_param param; 98 struct server_config *srv_conf = clt->clt_srv_conf; 99 struct http_descriptor *desc = clt->clt_descreq; 100 struct fcgi_record_header *h; 101 struct fcgi_begin_request_body *begin; 102 char hbuf[MAXHOSTNAMELEN]; 103 size_t scriptlen; 104 int pathlen; 105 int fd = -1, ret; 106 const char *errstr = NULL; 107 char *str, *p, *script = NULL; 108 109 if (srv_conf->socket[0] == ':') { 110 struct sockaddr_storage ss; 111 in_port_t port; 112 113 p = srv_conf->socket + 1; 114 115 port = strtonum(p, 0, 0xffff, &errstr); 116 if (errstr != NULL) { 117 log_warn("%s: strtonum %s, %s", __func__, p, errstr); 118 goto fail; 119 } 120 memset(&ss, 0, sizeof(ss)); 121 ss.ss_family = AF_INET; 122 ((struct sockaddr_in *) 123 &ss)->sin_addr.s_addr = htonl(INADDR_LOOPBACK); 124 port = htons(port); 125 126 if ((fd = server_socket_connect(&ss, port, srv_conf)) == -1) 127 goto fail; 128 } else { 129 struct sockaddr_un sun; 130 size_t len; 131 132 if ((fd = socket(AF_UNIX, SOCK_STREAM, 0)) == -1) 133 goto fail; 134 135 memset(&sun, 0, sizeof(sun)); 136 sun.sun_family = AF_UNIX; 137 len = strlcpy(sun.sun_path, 138 srv_conf->socket, sizeof(sun.sun_path)); 139 if (len >= sizeof(sun.sun_path)) { 140 errstr = "socket path to long"; 141 goto fail; 142 } 143 sun.sun_len = len; 144 145 if (connect(fd, (struct sockaddr *)&sun, sizeof(sun)) == -1) 146 goto fail; 147 } 148 149 socket_set_blockmode(fd, BM_NONBLOCK); 150 151 memset(hbuf, 0, sizeof(hbuf)); 152 clt->clt_fcgi_state = FCGI_READ_HEADER; 153 clt->clt_fcgi_toread = sizeof(struct fcgi_record_header); 154 155 if (clt->clt_srvevb != NULL) 156 evbuffer_free(clt->clt_srvevb); 157 158 clt->clt_srvevb = evbuffer_new(); 159 if (clt->clt_srvevb == NULL) { 160 errstr = "failed to allocate evbuffer"; 161 goto fail; 162 } 163 164 clt->clt_fd = fd; 165 if (clt->clt_srvbev != NULL) 166 bufferevent_free(clt->clt_srvbev); 167 168 clt->clt_srvbev = bufferevent_new(fd, server_fcgi_read, 169 NULL, server_file_error, clt); 170 if (clt->clt_srvbev == NULL) { 171 errstr = "failed to allocate fcgi buffer event"; 172 goto fail; 173 } 174 175 memset(¶m, 0, sizeof(param)); 176 177 h = (struct fcgi_record_header *)¶m.buf; 178 h->version = 1; 179 h->type = FCGI_BEGIN_REQUEST; 180 h->id = htons(1); 181 h->content_len = htons(sizeof(struct fcgi_begin_request_body)); 182 h->padding_len = 0; 183 184 begin = (struct fcgi_begin_request_body *)¶m.buf[sizeof(struct 185 fcgi_record_header)]; 186 begin->role = htons(FCGI_RESPONDER); 187 188 bufferevent_write(clt->clt_srvbev, ¶m.buf, 189 sizeof(struct fcgi_record_header) + 190 sizeof(struct fcgi_begin_request_body)); 191 192 h->type = FCGI_PARAMS; 193 h->content_len = param.total_len = 0; 194 195 if ((pathlen = asprintf(&script, "%s%s", srv_conf->root, 196 desc->http_path_alias != NULL ? 197 desc->http_path_alias : desc->http_path)) == -1) { 198 errstr = "failed to get script name"; 199 goto fail; 200 } 201 202 scriptlen = path_info(script); 203 /* 204 * no part of root should show up in PATH_INFO. 205 * therefore scriptlen should be >= strlen(root) 206 */ 207 if (scriptlen < strlen(srv_conf->root)) 208 scriptlen = strlen(srv_conf->root); 209 if ((int)scriptlen < pathlen) { 210 if (fcgi_add_param(¶m, "PATH_INFO", 211 script + scriptlen, clt) == -1) { 212 errstr = "failed to encode param"; 213 goto fail; 214 } 215 script[scriptlen] = '\0'; 216 } 217 218 if (fcgi_add_param(¶m, "SCRIPT_NAME", 219 script + strlen(srv_conf->root), clt) == -1) { 220 errstr = "failed to encode param"; 221 goto fail; 222 } 223 if (fcgi_add_param(¶m, "SCRIPT_FILENAME", script, clt) == -1) { 224 errstr = "failed to encode param"; 225 goto fail; 226 } 227 228 if (desc->http_query) 229 if (fcgi_add_param(¶m, "QUERY_STRING", desc->http_query, 230 clt) == -1) { 231 errstr = "failed to encode param"; 232 goto fail; 233 } 234 235 if (fcgi_add_param(¶m, "DOCUMENT_ROOT", srv_conf->root, 236 clt) == -1) { 237 errstr = "failed to encode param"; 238 goto fail; 239 } 240 if (fcgi_add_param(¶m, "DOCUMENT_URI", desc->http_path, 241 clt) == -1) { 242 errstr = "failed to encode param"; 243 goto fail; 244 } 245 if (fcgi_add_param(¶m, "GATEWAY_INTERFACE", "CGI/1.1", 246 clt) == -1) { 247 errstr = "failed to encode param"; 248 goto fail; 249 } 250 251 /* Add HTTP_* headers */ 252 if (server_headers(clt, desc, server_fcgi_writeheader, ¶m) == -1) { 253 errstr = "failed to encode param"; 254 goto fail; 255 } 256 257 if (srv_conf->flags & SRVFLAG_SSL) 258 if (fcgi_add_param(¶m, "HTTPS", "on", clt) == -1) { 259 errstr = "failed to encode param"; 260 goto fail; 261 } 262 263 (void)print_host(&clt->clt_ss, hbuf, sizeof(hbuf)); 264 if (fcgi_add_param(¶m, "REMOTE_ADDR", hbuf, clt) == -1) { 265 errstr = "failed to encode param"; 266 goto fail; 267 } 268 269 (void)snprintf(hbuf, sizeof(hbuf), "%d", ntohs(clt->clt_port)); 270 if (fcgi_add_param(¶m, "REMOTE_PORT", hbuf, clt) == -1) { 271 errstr = "failed to encode param"; 272 goto fail; 273 } 274 275 if (fcgi_add_param(¶m, "REQUEST_METHOD", 276 server_httpmethod_byid(desc->http_method), clt) == -1) { 277 errstr = "failed to encode param"; 278 goto fail; 279 } 280 281 if (!desc->http_query) { 282 if (fcgi_add_param(¶m, "REQUEST_URI", desc->http_path, 283 clt) == -1) { 284 errstr = "failed to encode param"; 285 goto fail; 286 } 287 } else if (asprintf(&str, "%s?%s", desc->http_path, 288 desc->http_query) != -1) { 289 ret = fcgi_add_param(¶m, "REQUEST_URI", str, clt); 290 free(str); 291 if (ret == -1) { 292 errstr = "failed to encode param"; 293 goto fail; 294 } 295 } 296 297 (void)print_host(&clt->clt_srv_ss, hbuf, sizeof(hbuf)); 298 if (fcgi_add_param(¶m, "SERVER_ADDR", hbuf, clt) == -1) { 299 errstr = "failed to encode param"; 300 goto fail; 301 } 302 303 (void)snprintf(hbuf, sizeof(hbuf), "%d", 304 ntohs(server_socket_getport(&clt->clt_srv_ss))); 305 if (fcgi_add_param(¶m, "SERVER_PORT", hbuf, clt) == -1) { 306 errstr = "failed to encode param"; 307 goto fail; 308 } 309 310 if (fcgi_add_param(¶m, "SERVER_NAME", srv_conf->name, 311 clt) == -1) { 312 errstr = "failed to encode param"; 313 goto fail; 314 } 315 316 if (fcgi_add_param(¶m, "SERVER_PROTOCOL", desc->http_version, 317 clt) == -1) { 318 errstr = "failed to encode param"; 319 goto fail; 320 } 321 322 if (fcgi_add_param(¶m, "SERVER_SOFTWARE", HTTPD_SERVERNAME, 323 clt) == -1) { 324 errstr = "failed to encode param"; 325 goto fail; 326 } 327 328 if (param.total_len != 0) { /* send last params record */ 329 bufferevent_write(clt->clt_srvbev, ¶m.buf, 330 sizeof(struct fcgi_record_header) + 331 ntohs(h->content_len)); 332 } 333 334 /* send "no more params" message */ 335 h->content_len = 0; 336 bufferevent_write(clt->clt_srvbev, ¶m.buf, 337 sizeof(struct fcgi_record_header)); 338 339 bufferevent_settimeout(clt->clt_srvbev, 340 srv_conf->timeout.tv_sec, srv_conf->timeout.tv_sec); 341 bufferevent_enable(clt->clt_srvbev, EV_READ|EV_WRITE); 342 if (clt->clt_toread != 0) { 343 server_read_httpcontent(clt->clt_bev, clt); 344 bufferevent_enable(clt->clt_bev, EV_READ); 345 } else { 346 bufferevent_disable(clt->clt_bev, EV_READ); 347 fcgi_add_stdin(clt, NULL); 348 } 349 350 /* 351 * persist is not supported yet because we don't get the 352 * Content-Length from slowcgi and don't support chunked encoding. 353 */ 354 clt->clt_persist = 0; 355 clt->clt_done = 0; 356 357 free(script); 358 return (0); 359 fail: 360 free(script); 361 if (errstr == NULL) 362 errstr = strerror(errno); 363 server_abort_http(clt, 500, errstr); 364 return (-1); 365} 366 367int 368fcgi_add_stdin(struct client *clt, struct evbuffer *evbuf) 369{ 370 struct fcgi_record_header h; 371 372 memset(&h, 0, sizeof(h)); 373 h.version = 1; 374 h.type = FCGI_STDIN; 375 h.id = htons(1); 376 h.padding_len = 0; 377 378 if (evbuf == NULL) { 379 h.content_len = 0; 380 return bufferevent_write(clt->clt_srvbev, &h, 381 sizeof(struct fcgi_record_header)); 382 } else { 383 h.content_len = htons(EVBUFFER_LENGTH(evbuf)); 384 if (bufferevent_write(clt->clt_srvbev, &h, 385 sizeof(struct fcgi_record_header)) == -1) 386 return -1; 387 return bufferevent_write_buffer(clt->clt_srvbev, evbuf); 388 } 389 return (0); 390} 391 392int 393fcgi_add_param(struct server_fcgi_param *p, const char *key, 394 const char *val, struct client *clt) 395{ 396 struct fcgi_record_header *h; 397 int len = 0; 398 int key_len = strlen(key); 399 int val_len = strlen(val); 400 uint8_t *param; 401 402 len += key_len + val_len; 403 len += key_len > 127 ? 4 : 1; 404 len += val_len > 127 ? 4 : 1; 405 406 DPRINTF("%s: %s[%d] => %s[%d], total_len: %d", __func__, key, key_len, 407 val, val_len, p->total_len); 408 409 if (len > FCGI_CONTENT_SIZE) 410 return (-1); 411 412 if (p->total_len + len > FCGI_CONTENT_SIZE) { 413 bufferevent_write(clt->clt_srvbev, p->buf, 414 sizeof(struct fcgi_record_header) + p->total_len); 415 p->total_len = 0; 416 } 417 418 h = (struct fcgi_record_header *)p->buf; 419 param = p->buf + sizeof(*h) + p->total_len; 420 421 if (key_len > 127) { 422 *param++ = ((key_len >> 24) & 0xff) | 0x80; 423 *param++ = ((key_len >> 16) & 0xff); 424 *param++ = ((key_len >> 8) & 0xff); 425 *param++ = (key_len & 0xff); 426 } else 427 *param++ = key_len; 428 429 if (val_len > 127) { 430 *param++ = ((val_len >> 24) & 0xff) | 0x80; 431 *param++ = ((val_len >> 16) & 0xff); 432 *param++ = ((val_len >> 8) & 0xff); 433 *param++ = (val_len & 0xff); 434 } else 435 *param++ = val_len; 436 437 memcpy(param, key, key_len); 438 param += key_len; 439 memcpy(param, val, val_len); 440 441 p->total_len += len; 442 443 h->content_len = htons(p->total_len); 444 return (0); 445} 446 447void 448server_fcgi_read(struct bufferevent *bev, void *arg) 449{ 450 uint8_t buf[FCGI_RECORD_SIZE]; 451 struct client *clt = (struct client *) arg; 452 struct fcgi_record_header *h; 453 size_t len; 454 char *ptr; 455 456 do { 457 len = bufferevent_read(bev, &buf, clt->clt_fcgi_toread); 458 /* XXX error handling */ 459 evbuffer_add(clt->clt_srvevb, &buf, len); 460 clt->clt_fcgi_toread -= len; 461 DPRINTF("%s: len: %lu toread: %d state: %d", __func__, len, 462 clt->clt_fcgi_toread, clt->clt_fcgi_state); 463 464 if (clt->clt_fcgi_toread != 0) 465 return; 466 467 switch (clt->clt_fcgi_state) { 468 case FCGI_READ_HEADER: 469 clt->clt_fcgi_state = FCGI_READ_CONTENT; 470 h = (struct fcgi_record_header *) 471 EVBUFFER_DATA(clt->clt_srvevb); 472 DPRINTF("%s: record header: version %d type %d id %d " 473 "content len %d padding %d", __func__, 474 h->version, h->type, ntohs(h->id), 475 ntohs(h->content_len), h->padding_len); 476 clt->clt_fcgi_type = h->type; 477 clt->clt_fcgi_toread = ntohs(h->content_len); 478 clt->clt_fcgi_padding_len = h->padding_len; 479 evbuffer_drain(clt->clt_srvevb, 480 EVBUFFER_LENGTH(clt->clt_srvevb)); 481 if (clt->clt_fcgi_toread != 0) 482 break; 483 else if (clt->clt_fcgi_type == FCGI_STDOUT && 484 !clt->clt_chunk) { 485 server_abort_http(clt, 500, "empty stdout"); 486 return; 487 } 488 489 /* fallthrough if content_len == 0 */ 490 case FCGI_READ_CONTENT: 491 if (clt->clt_fcgi_type == FCGI_STDERR && 492 EVBUFFER_LENGTH(clt->clt_srvevb) > 0) { 493 if ((ptr = get_string( 494 EVBUFFER_DATA(clt->clt_srvevb), 495 EVBUFFER_LENGTH(clt->clt_srvevb))) 496 != NULL) { 497 server_sendlog(clt->clt_srv_conf, 498 IMSG_LOG_ERROR, "%s", ptr); 499 free(ptr); 500 } 501 } 502 if (clt->clt_fcgi_type == FCGI_STDOUT && 503 EVBUFFER_LENGTH(clt->clt_srvevb) > 0) { 504 if (++clt->clt_chunk == 1) 505 server_fcgi_header(clt, 506 get_status(clt->clt_srvevb)); 507 server_bufferevent_write_buffer(clt, 508 clt->clt_srvevb); 509 } 510 evbuffer_drain(clt->clt_srvevb, 511 EVBUFFER_LENGTH(clt->clt_srvevb)); 512 if (!clt->clt_fcgi_padding_len) { 513 clt->clt_fcgi_state = FCGI_READ_HEADER; 514 clt->clt_fcgi_toread = 515 sizeof(struct fcgi_record_header); 516 } else { 517 clt->clt_fcgi_state = FCGI_READ_PADDING; 518 clt->clt_fcgi_toread = 519 clt->clt_fcgi_padding_len; 520 } 521 break; 522 case FCGI_READ_PADDING: 523 evbuffer_drain(clt->clt_srvevb, 524 EVBUFFER_LENGTH(clt->clt_srvevb)); 525 clt->clt_fcgi_state = FCGI_READ_HEADER; 526 clt->clt_fcgi_toread = 527 sizeof(struct fcgi_record_header); 528 break; 529 } 530 } while (len > 0); 531} 532 533int 534server_fcgi_header(struct client *clt, u_int code) 535{ 536 struct http_descriptor *desc = clt->clt_descreq; 537 struct http_descriptor *resp = clt->clt_descresp; 538 const char *error; 539 char tmbuf[32]; 540 541 if (desc == NULL || (error = server_httperror_byid(code)) == NULL) 542 return (-1); 543 544 if (server_log_http(clt, code, 0) == -1) 545 return (-1); 546 547 /* Add error codes */ 548 if (kv_setkey(&resp->http_pathquery, "%lu", code) == -1 || 549 kv_set(&resp->http_pathquery, "%s", error) == -1) 550 return (-1); 551 552 /* Add headers */ 553 if (kv_add(&resp->http_headers, "Server", HTTPD_SERVERNAME) == NULL) 554 return (-1); 555 556 /* Is it a persistent connection? */ 557 if (clt->clt_persist) { 558 if (kv_add(&resp->http_headers, 559 "Connection", "keep-alive") == NULL) 560 return (-1); 561 } else if (kv_add(&resp->http_headers, "Connection", "close") == NULL) 562 return (-1); 563 564 /* Date header is mandatory and should be added as late as possible */ 565 if (server_http_time(time(NULL), tmbuf, sizeof(tmbuf)) <= 0 || 566 kv_add(&resp->http_headers, "Date", tmbuf) == NULL) 567 return (-1); 568 569 /* Write initial header (fcgi might append more) */ 570 if (server_writeresponse_http(clt) == -1 || 571 server_bufferevent_print(clt, "\r\n") == -1 || 572 server_headers(clt, resp, server_writeheader_http, NULL) == -1) 573 return (-1); 574 575 return (0); 576} 577 578int 579server_fcgi_writeheader(struct client *clt, struct kv *hdr, void *arg) 580{ 581 struct server_fcgi_param *param = arg; 582 char *val, *name, *p; 583 const char *key; 584 int ret; 585 586 if (hdr->kv_flags & KV_FLAG_INVALID) 587 return (0); 588 589 /* The key might have been updated in the parent */ 590 if (hdr->kv_parent != NULL && hdr->kv_parent->kv_key != NULL) 591 key = hdr->kv_parent->kv_key; 592 else 593 key = hdr->kv_key; 594 595 val = hdr->kv_value; 596 597 if (strcasecmp(key, "Content-Length") == 0 || 598 strcasecmp(key, "Content-Type") == 0) { 599 if ((name = strdup(key)) == NULL) 600 return (-1); 601 } else { 602 if (asprintf(&name, "HTTP_%s", key) == -1) 603 return (-1); 604 } 605 606 for (p = name; *p != '\0'; p++) { 607 if (isalpha((unsigned char)*p)) 608 *p = toupper((unsigned char)*p); 609 else 610 *p = '_'; 611 } 612 613 ret = fcgi_add_param(param, name, val, clt); 614 free(name); 615 616 return (ret); 617} 618 619int 620get_status(struct evbuffer *bev) 621{ 622 int code; 623 char *statusline, *tok; 624 const char *errstr; 625 626 /* XXX This is a hack. We need to parse the response header. */ 627 code = 200; 628 if (strncmp(EVBUFFER_DATA(bev), "Status: ", strlen("Status: ")) == 0) { 629 statusline = get_string(EVBUFFER_DATA(bev), 630 EVBUFFER_LENGTH(bev)); 631 if (strtok(statusline, " ") != NULL) { 632 if ((tok = strtok(NULL, " ")) != NULL) { 633 code = (int) strtonum(tok, 100, 600, &errstr); 634 if (errstr != NULL || server_httperror_byid( 635 code) == NULL) 636 code = 200; 637 } 638 } 639 free(statusline); 640 } 641 return code; 642} 643