src/base.h

   1 #ifndef _BASE_H_
   2 #define _BASE_H_
   3 #include "first.h"
   4
   5 #include "settings.h"
   6
   7 #include <sys/types.h>
   8 #include <sys/time.h>
   9 #include <sys/stat.h>
  10
  11 #include <limits.h>
  12
  13 #ifdef HAVE_STDINT_H
  14 # include <stdint.h>
  15 #endif
  16
  17 #ifdef HAVE_INTTYPES_H
  18 # include <inttypes.h>
  19 #endif
  20
  21 #include "buffer.h"
  22 #include "array.h"
  23 #include "chunk.h"
  24 #include "keyvalue.h"
  25 #include "fdevent.h"
  26 #include "sys-socket.h"
  27 #include "splaytree.h"
  28 #include "etag.h"
  29
  30
  31 #if defined HAVE_LIBSSL && defined HAVE_OPENSSL_SSL_H
  32 # define USE_OPENSSL
  33 # include <openssl/opensslconf.h>
  34 #  ifndef USE_OPENSSL_KERBEROS
  35 #   ifndef OPENSSL_NO_KRB5
  36 #   define OPENSSL_NO_KRB5
  37 #   endif
  38 #  endif
  39 # include <openssl/ssl.h>
  40 # if ! defined OPENSSL_NO_TLSEXT && ! defined SSL_CTRL_SET_TLSEXT_HOSTNAME
  41 #  define OPENSSL_NO_TLSEXT
  42 # endif
  43 #endif
  44
  45 #ifdef HAVE_FAM_H
  46 # include <fam.h>
  47 #endif
  48
  49 #ifndef O_BINARY
  50 # define O_BINARY 0
  51 #endif
  52
  53 #ifndef O_LARGEFILE
  54 # define O_LARGEFILE 0
  55 #endif
  56
  57 #ifndef SIZE_MAX
  58 # ifdef SIZE_T_MAX
  59 #  define SIZE_MAX SIZE_T_MAX
  60 # else
  61 #  define SIZE_MAX ((size_t)~0)
  62 # endif
  63 #endif
  64
  65 #ifndef SSIZE_MAX
  66 # define SSIZE_MAX ((size_t)~0 >> 1)
  67 #endif
  68
  69 #ifdef __APPLE__
  70 #include <crt_externs.h>
  71 #define environ (* _NSGetEnviron())
  72 #else
  73 extern char **environ;
  74 #endif
  75
  76 /* for solaris 2.5 and NetBSD 1.3.x */
  77 #ifndef HAVE_SOCKLEN_T
  78 typedef int socklen_t;
  79 #endif
  80
  81 /* solaris and NetBSD 1.3.x again */
  82 #if (!defined(HAVE_STDINT_H)) && (!defined(HAVE_INTTYPES_H)) && (!defined(uint32_t))
  83 # define uint32_t u_int32_t
  84 #endif
  85
  86
  87 #ifndef SHUT_WR
  88 # define SHUT_WR 1
  89 #endif
  90
  91 typedef enum { T_CONFIG_UNSET,
  92                 T_CONFIG_STRING,
  93                 T_CONFIG_SHORT,
  94                 T_CONFIG_INT,
  95                 T_CONFIG_BOOLEAN,
  96                 T_CONFIG_ARRAY,
  97                 T_CONFIG_LOCAL,
  98                 T_CONFIG_DEPRECATED,
  99                 T_CONFIG_UNSUPPORTED
 100 } config_values_type_t;
 101
 102 typedef enum { T_CONFIG_SCOPE_UNSET,
 103                 T_CONFIG_SCOPE_SERVER,
 104                 T_CONFIG_SCOPE_CONNECTION
 105 } config_scope_type_t;
 106
 107 typedef struct {
 108         const char *key;
 109         void *destination;
 110
 111         config_values_type_t type;
 112         config_scope_type_t scope;
 113 } config_values_t;
 114
 115 typedef enum { DIRECT, EXTERNAL } connection_type;
 116
 117 typedef struct {
 118         char *key;
 119         connection_type type;
 120         char *value;
 121 } request_handler;
 122
 123 typedef struct {
 124         char *key;
 125         char *host;
 126         unsigned short port;
 127         int used;
 128         short factor;
 129 } fcgi_connections;
 130
 131
 132 typedef union {
 133 #ifdef HAVE_IPV6
 134         struct sockaddr_in6 ipv6;
 135 #endif
 136         struct sockaddr_in ipv4;
 137 #ifdef HAVE_SYS_UN_H
 138         struct sockaddr_un un;
 139 #endif
 140         struct sockaddr plain;
 141 } sock_addr;
 142
 143 /* fcgi_response_header contains ... */
 144 #define HTTP_STATUS         BV(0)
 145 #define HTTP_CONNECTION     BV(1)
 146 #define HTTP_CONTENT_LENGTH BV(2)
 147 #define HTTP_DATE           BV(3)
 148 #define HTTP_LOCATION       BV(4)
 149
 150 typedef struct {
 151         /** HEADER */
 152         /* the request-line */
 153         buffer *request;
 154         buffer *uri;
 155
 156         buffer *orig_uri;
 157
 158         http_method_t  http_method;
 159         http_version_t http_version;
 160
 161         buffer *request_line;
 162
 163         /* strings to the header */
 164         buffer *http_host; /* not alloced */
 165         const char   *http_range;
 166         const char   *http_content_type;
 167         const char   *http_if_modified_since;
 168         const char   *http_if_none_match;
 169
 170         array  *headers;
 171
 172         /* CONTENT */
 173         size_t content_length; /* returned by strtoul() */
 174
 175         /* internal representation */
 176         int     accept_encoding;
 177
 178         /* internal */
 179         buffer *pathinfo;
 180 } request;
 181
 182 typedef struct {
 183         off_t   content_length;
 184         int     keep_alive;               /* used by  the subrequests in proxy, cgi and fcgi to say the subrequest was keep-alive or not */
 185
 186         array  *headers;
 187
 188         enum {
 189                 HTTP_TRANSFER_ENCODING_IDENTITY, HTTP_TRANSFER_ENCODING_CHUNKED
 190         } transfer_encoding;
 191 } response;
 192
 193 typedef struct {
 194         buffer *scheme; /* scheme without colon or slashes ( "http" or "https" ) */
 195
 196         /* authority with optional portnumber ("site.name" or "site.name:8080" ) NOTE: without "username:password@" */
 197         buffer *authority;
 198
 199         /* path including leading slash ("/" or "/index.html") - urldecoded, and sanitized  ( buffer_path_simplify() && buffer_urldecode_path() ) */
 200         buffer *path;
 201         buffer *path_raw; /* raw path, as sent from client. no urldecoding or path simplifying */
 202         buffer *query; /* querystring ( everything after "?", ie: in "/index.php?foo=1", query is "foo=1" ) */
 203 } request_uri;
 204
 205 typedef struct {
 206         buffer *path;
 207         buffer *basedir; /* path = "(basedir)(.*)" */
 208
 209         buffer *doc_root; /* path = doc_root + rel_path */
 210         buffer *rel_path;
 211
 212         buffer *etag;
 213 } physical;
 214
 215 typedef struct {
 216         buffer *name;
 217         buffer *etag;
 218
 219         struct stat st;
 220
 221         time_t stat_ts;
 222
 223 #ifdef HAVE_LSTAT
 224         char is_symlink;
 225 #endif
 226
 227 #ifdef HAVE_FAM_H
 228         int    dir_version;
 229 #endif
 230
 231         buffer *content_type;
 232 } stat_cache_entry;
 233
 234 typedef struct {
 235         splay_tree *files; /* the nodes of the tree are stat_cache_entry's */
 236
 237         buffer *dir_name; /* for building the dirname from the filename */
 238 #ifdef HAVE_FAM_H
 239         splay_tree *dirs; /* the nodes of the tree are fam_dir_entry */
 240
 241         FAMConnection fam;
 242         int    fam_fcce_ndx;
 243 #endif
 244         buffer *hash_key;  /* temp-store for the hash-key */
 245 } stat_cache;
 246
 247 typedef struct {
 248         array *mimetypes;
 249
 250         /* virtual-servers */
 251         buffer *document_root;
 252         buffer *server_name;
 253         buffer *error_handler;
 254         buffer *error_handler_404;
 255         buffer *server_tag;
 256         buffer *dirlist_encoding;
 257         buffer *errorfile_prefix;
 258
 259         unsigned short max_keep_alive_requests;
 260         unsigned short max_keep_alive_idle;
 261         unsigned short max_read_idle;
 262         unsigned short max_write_idle;
 263         unsigned short use_xattr;
 264         unsigned short follow_symlink;
 265         unsigned short range_requests;
 266
 267         /* debug */
 268
 269         unsigned short log_file_not_found;
 270         unsigned short log_request_header;
 271         unsigned short log_request_handling;
 272         unsigned short log_response_header;
 273         unsigned short log_condition_handling;
 274         unsigned short log_ssl_noise;
 275         unsigned short log_timeouts;
 276
 277
 278         /* server wide */
 279         buffer *ssl_pemfile;
 280         buffer *ssl_ca_file;
 281         buffer *ssl_cipher_list;
 282         buffer *ssl_dh_file;
 283         buffer *ssl_ec_curve;
 284         unsigned short ssl_honor_cipher_order; /* determine SSL cipher in server-preferred order, not client-order */
 285         unsigned short ssl_empty_fragments; /* whether to not set SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS */
 286         unsigned short ssl_use_sslv2;
 287         unsigned short ssl_use_sslv3;
 288         unsigned short ssl_verifyclient;
 289         unsigned short ssl_verifyclient_enforce;
 290         unsigned short ssl_verifyclient_depth;
 291         buffer *ssl_verifyclient_username;
 292         unsigned short ssl_verifyclient_export_cert;
 293         unsigned short ssl_disable_client_renegotiation;
 294
 295         unsigned short use_ipv6, set_v6only; /* set_v6only is only a temporary option */
 296         unsigned short defer_accept;
 297         unsigned short ssl_enabled; /* only interesting for setting up listening sockets. don't use at runtime */
 298         unsigned short allow_http11;
 299         unsigned short etag_use_inode;
 300         unsigned short etag_use_mtime;
 301         unsigned short etag_use_size;
 302         unsigned short force_lowercase_filenames; /* if the FS is case-insensitive, force all files to lower-case */
 303         unsigned int http_parseopts;
 304         unsigned int max_request_size;
 305         int listen_backlog;
 306
 307         unsigned short kbytes_per_second; /* connection kb/s limit */
 308
 309         /* configside */
 310         unsigned short global_kbytes_per_second; /*  */
 311
 312         off_t  global_bytes_per_second_cnt;
 313         /* server-wide traffic-shaper
 314          *
 315          * each context has the counter which is inited once
 316          * a second by the global_kbytes_per_second config-var
 317          *
 318          * as soon as global_kbytes_per_second gets below 0
 319          * the connected conns are "offline" a little bit
 320          *
 321          * the problem:
 322          * we somehow have to loose our "we are writable" signal
 323          * on the way.
 324          *
 325          */
 326         off_t *global_bytes_per_second_cnt_ptr; /*  */
 327
 328 #if defined(__FreeBSD__) || defined(__NetBSD__) \
 329  || defined(__OpenBSD__) || defined(__DragonflyBSD__)
 330         buffer *bsd_accept_filter;
 331 #endif
 332
 333 #ifdef USE_OPENSSL
 334         SSL_CTX *ssl_ctx; /* not patched */
 335         /* SNI per host: with COMP_SERVER_SOCKET, COMP_HTTP_SCHEME, COMP_HTTP_HOST */
 336         EVP_PKEY *ssl_pemfile_pkey;
 337         X509 *ssl_pemfile_x509;
 338         STACK_OF(X509_NAME) *ssl_ca_file_cert_names;
 339 #endif
 340 } specific_config;
 341
 342 /* the order of the items should be the same as they are processed
 343  * read before write as we use this later */
 344 typedef enum {
 345         CON_STATE_CONNECT,
 346         CON_STATE_REQUEST_START,
 347         CON_STATE_READ,
 348         CON_STATE_REQUEST_END,
 349         CON_STATE_READ_POST,
 350         CON_STATE_HANDLE_REQUEST,
 351         CON_STATE_RESPONSE_START,
 352         CON_STATE_WRITE,
 353         CON_STATE_RESPONSE_END,
 354         CON_STATE_ERROR,
 355         CON_STATE_CLOSE
 356 } connection_state_t;
 357
 358 typedef enum {
 359         /* condition not active at the moment because itself or some
 360          * pre-condition depends on data not available yet
 361          */
 362         COND_RESULT_UNSET,
 363
 364         /* special "unset" for branches not selected due to pre-conditions
 365          * not met (but pre-conditions are not "unset" anymore)
 366          */
 367         COND_RESULT_SKIP,
 368
 369         /* actually evaluated the condition itself */
 370         COND_RESULT_FALSE, /* not active */
 371         COND_RESULT_TRUE, /* active */
 372 } cond_result_t;
 373
 374 typedef struct {
 375         /* current result (with preconditions) */
 376         cond_result_t result;
 377         /* result without preconditions (must never be "skip") */
 378         cond_result_t local_result;
 379         int patterncount;
 380         int matches[3 * 10];
 381         buffer *comp_value; /* just a pointer */
 382 } cond_cache_t;
 383
 384 typedef struct {
 385         connection_state_t state;
 386
 387         /* timestamps */
 388         time_t read_idle_ts;
 389         time_t close_timeout_ts;
 390         time_t write_request_ts;
 391
 392         time_t connection_start;
 393         time_t request_start;
 394
 395         struct timeval start_tv;
 396
 397         size_t request_count;        /* number of requests handled in this connection */
 398         size_t loops_per_request;    /* to catch endless loops in a single request
 399                                       *
 400                                       * used by mod_rewrite, mod_fastcgi, ... and others
 401                                       * this is self-protection
 402                                       */
 403
 404         int fd;                      /* the FD for this connection */
 405         int fde_ndx;                 /* index for the fdevent-handler */
 406         int ndx;                     /* reverse mapping to server->connection[ndx] */
 407
 408         /* fd states */
 409         int is_readable;
 410         int is_writable;
 411
 412         int keep_alive;              /* only request.c can enable it, all other just disable */
 413         int keep_alive_idle;         /* remember max_keep_alive_idle from config */
 414
 415         int file_started;
 416         int file_finished;
 417
 418         chunkqueue *write_queue;      /* a large queue for low-level write ( HTTP response ) [ file, mem ] */
 419         chunkqueue *read_queue;       /* a small queue for low-level read ( HTTP request ) [ mem ] */
 420         chunkqueue *request_content_queue; /* takes request-content into tempfile if necessary [ tempfile, mem ]*/
 421
 422         int traffic_limit_reached;
 423
 424         off_t bytes_written;          /* used by mod_accesslog, mod_rrd */
 425         off_t bytes_written_cur_second; /* used by mod_accesslog, mod_rrd */
 426         off_t bytes_read;             /* used by mod_accesslog, mod_rrd */
 427         off_t bytes_header;
 428
 429         int http_status;
 430
 431         sock_addr dst_addr;
 432         buffer *dst_addr_buf;
 433
 434         /* request */
 435         buffer *parse_request;
 436         unsigned int parsed_response; /* bitfield which contains the important header-fields of the parsed response header */
 437
 438         request  request;
 439         request_uri uri;
 440         physical physical;
 441         response response;
 442
 443         size_t header_len;
 444
 445         array  *environment; /* used to pass lighttpd internal stuff to the FastCGI/CGI apps, setenv does that */
 446
 447         /* response */
 448         int    got_response;
 449
 450         int    in_joblist;
 451
 452         connection_type mode;
 453
 454         void **plugin_ctx;           /* plugin connection specific config */
 455
 456         specific_config conf;        /* global connection specific config */
 457         cond_cache_t *cond_cache;
 458
 459         buffer *server_name;
 460
 461         /* error-handler */
 462         int error_handler_saved_status;
 463         http_method_t error_handler_saved_method;
 464
 465         struct server_socket *srv_socket;   /* reference to the server-socket */
 466
 467 #ifdef USE_OPENSSL
 468         SSL *ssl;
 469 # ifndef OPENSSL_NO_TLSEXT
 470         buffer *tlsext_server_name;
 471 # endif
 472         unsigned int renegotiations; /* count of SSL_CB_HANDSHAKE_START */
 473 #endif
 474         /* etag handling */
 475         etag_flags_t etag_flags;
 476
 477         int conditional_is_valid[COMP_LAST_ELEMENT];
 478 } connection;
 479
 480 typedef struct {
 481         connection **ptr;
 482         size_t size;
 483         size_t used;
 484 } connections;
 485
 486
 487 #ifdef HAVE_IPV6
 488 typedef struct {
 489         int family;
 490         union {
 491                 struct in6_addr ipv6;
 492                 struct in_addr  ipv4;
 493         } addr;
 494         char b2[INET6_ADDRSTRLEN + 1];
 495         time_t ts;
 496 } inet_ntop_cache_type;
 497 #endif
 498
 499
 500 typedef struct {
 501         buffer *uri;
 502         time_t mtime;
 503         int http_status;
 504 } realpath_cache_type;
 505
 506 typedef struct {
 507         time_t  mtime;  /* the key */
 508         buffer *str;    /* a buffer for the string represenation */
 509 } mtime_cache_type;
 510
 511 typedef struct {
 512         void  *ptr;
 513         size_t used;
 514         size_t size;
 515 } buffer_plugin;
 516
 517 typedef struct {
 518         unsigned short port;
 519         buffer *bindhost;
 520
 521         buffer *errorlog_file;
 522         unsigned short errorlog_use_syslog;
 523         buffer *breakagelog_file;
 524
 525         unsigned short dont_daemonize;
 526         unsigned short preflight_check;
 527         buffer *changeroot;
 528         buffer *username;
 529         buffer *groupname;
 530
 531         buffer *pid_file;
 532
 533         buffer *event_handler;
 534
 535         buffer *modules_dir;
 536         buffer *network_backend;
 537         array *modules;
 538         array *upload_tempdirs;
 539         unsigned int upload_temp_file_size;
 540
 541         unsigned short max_worker;
 542         unsigned short max_fds;
 543         unsigned short max_conns;
 544         unsigned int max_request_size;
 545
 546         unsigned short log_request_header_on_error;
 547         unsigned short log_state_handling;
 548
 549         enum { STAT_CACHE_ENGINE_UNSET,
 550                         STAT_CACHE_ENGINE_NONE,
 551                         STAT_CACHE_ENGINE_SIMPLE
 552 #ifdef HAVE_FAM_H
 553                         , STAT_CACHE_ENGINE_FAM
 554 #endif
 555         } stat_cache_engine;
 556         unsigned short enable_cores;
 557         unsigned short reject_expect_100_with_417;
 558         buffer *xattr_name;
 559
 560         unsigned short http_header_strict;
 561         unsigned short http_host_strict;
 562         unsigned short http_host_normalize;
 563 } server_config;
 564
 565 typedef struct server_socket {
 566         sock_addr addr;
 567         int       fd;
 568         int       fde_ndx;
 569
 570         unsigned short is_ssl;
 571
 572         buffer *srv_token;
 573
 574 #ifdef USE_OPENSSL
 575         SSL_CTX *ssl_ctx;
 576 #endif
 577 } server_socket;
 578
 579 typedef struct {
 580         server_socket **ptr;
 581
 582         size_t size;
 583         size_t used;
 584 } server_socket_array;
 585
 586 typedef struct server {
 587         server_socket_array srv_sockets;
 588
 589         /* the errorlog */
 590         int errorlog_fd;
 591         enum { ERRORLOG_FILE, ERRORLOG_FD, ERRORLOG_SYSLOG, ERRORLOG_PIPE } errorlog_mode;
 592         buffer *errorlog_buf;
 593
 594         fdevents *ev, *ev_ins;
 595
 596         buffer_plugin plugins;
 597         void *plugin_slots;
 598
 599         /* counters */
 600         int con_opened;
 601         int con_read;
 602         int con_written;
 603         int con_closed;
 604
 605         int ssl_is_init;
 606
 607         int max_fds;    /* max possible fds */
 608         int cur_fds;    /* currently used fds */
 609         int want_fds;   /* waiting fds */
 610         int sockets_disabled;
 611
 612         size_t max_conns;
 613
 614         /* buffers */
 615         buffer *parse_full_path;
 616         buffer *response_header;
 617         buffer *response_range;
 618         buffer *tmp_buf;
 619
 620         buffer *tmp_chunk_len;
 621
 622         buffer *empty_string; /* is necessary for cond_match */
 623
 624         buffer *cond_check_buf;
 625
 626         /* caches */
 627 #ifdef HAVE_IPV6
 628         inet_ntop_cache_type inet_ntop_cache[INET_NTOP_CACHE_MAX];
 629 #endif
 630         mtime_cache_type mtime_cache[FILE_CACHE_MAX];
 631
 632         array *split_vals;
 633
 634         /* Timestamps */
 635         time_t cur_ts;
 636         time_t last_generated_date_ts;
 637         time_t last_generated_debug_ts;
 638         time_t startup_ts;
 639
 640         char entropy[8]; /* from /dev/[u]random if possible, otherwise rand() */
 641         char is_real_entropy; /* whether entropy is from /dev/[u]random */
 642
 643         buffer *ts_debug_str;
 644         buffer *ts_date_str;
 645
 646         /* config-file */
 647         array *config_touched;
 648
 649         array *config_context;
 650         specific_config **config_storage;
 651
 652         server_config  srvconf;
 653
 654         short int config_deprecated;
 655         short int config_unsupported;
 656
 657         connections *conns;
 658         connections *joblist;
 659         connections *fdwaitqueue;
 660
 661         stat_cache  *stat_cache;
 662
 663         /**
 664          * The status array can carry all the status information you want
 665          * the key to the array is <module-prefix>.<name>
 666          * and the values are counters
 667          *
 668          * example:
 669          *   fastcgi.backends        = 10
 670          *   fastcgi.active-backends = 6
 671          *   fastcgi.backend.<key>.load = 24
 672          *   fastcgi.backend.<key>....
 673          *
 674          *   fastcgi.backend.<key>.disconnects = ...
 675          */
 676         array *status;
 677
 678         fdevent_handler_t event_handler;
 679
 680         int (* network_backend_write)(struct server *srv, connection *con, int fd, chunkqueue *cq, off_t max_bytes);
 681 #ifdef USE_OPENSSL
 682         int (* network_ssl_backend_write)(struct server *srv, connection *con, SSL *ssl, chunkqueue *cq, off_t max_bytes);
 683 #endif
 684
 685         uid_t uid;
 686         gid_t gid;
 687 } server;
 688
 689
 690 #endif