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