granicus.if.org Git - apache/blob - include/http_core.h

   1 /* Licensed to the Apache Software Foundation (ASF) under one or more
   2  * contributor license agreements.  See the NOTICE file distributed with
   3  * this work for additional information regarding copyright ownership.
   4  * The ASF licenses this file to You under the Apache License, Version 2.0
   5  * (the "License"); you may not use this file except in compliance with
   6  * the License.  You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file  http_core.h
  19  * @brief CORE HTTP Daemon
  20  *
  21  * @defgroup APACHE_CORE_HTTPD Core HTTP Daemon
  22  * @ingroup  APACHE_CORE
  23  * @{
  24  */
  25
  26 #ifndef APACHE_HTTP_CORE_H
  27 #define APACHE_HTTP_CORE_H
  28
  29 #include "apr.h"
  30 #include "apr_hash.h"
  31 #include "apr_optional.h"
  32 #include "util_filter.h"
  33 #include "ap_expr.h"
  34 #include "apr_tables.h"
  35
  36 #include "http_config.h"
  37
  38 #if APR_HAVE_STRUCT_RLIMIT
  39 #include <sys/time.h>
  40 #include <sys/resource.h>
  41 #endif
  42
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48 /* ****************************************************************
  49  *
  50  * The most basic server code is encapsulated in a single module
  51  * known as the core, which is just *barely* functional enough to
  52  * serve documents, though not terribly well.
  53  *
  54  * Largely for NCSA back-compatibility reasons, the core needs to
  55  * make pieces of its config structures available to other modules.
  56  * The accessors are declared here, along with the interpretation
  57  * of one of them (allow_options).
  58  */
  59
  60 /**
  61  * @defgroup APACHE_CORE_HTTPD_ACESSORS Acessors
  62  *
  63  * @brief File/Directory Accessor directives
  64  *
  65  * @{
  66  */
  67
  68 /** No directives */
  69 #define OPT_NONE 0
  70 /** Indexes directive */
  71 #define OPT_INDEXES 1
  72 /** SSI is enabled without exec= permission  */
  73 #define OPT_INCLUDES 2
  74 /**  FollowSymLinks directive */
  75 #define OPT_SYM_LINKS 4
  76 /**  ExecCGI directive */
  77 #define OPT_EXECCGI 8
  78 /**  directive unset */
  79 #define OPT_UNSET 16
  80 /**  SSI exec= permission is permitted, iff OPT_INCLUDES is also set */
  81 #define OPT_INC_WITH_EXEC 32
  82 /** SymLinksIfOwnerMatch directive */
  83 #define OPT_SYM_OWNER 64
  84 /** MultiViews directive */
  85 #define OPT_MULTI 128
  86 /**  All directives */
  87 #define OPT_ALL (OPT_INDEXES|OPT_INCLUDES|OPT_INC_WITH_EXEC|OPT_SYM_LINKS|OPT_EXECCGI)
  88 /** @} */
  89
  90 /**
  91  * @defgroup get_remote_host Remote Host Resolution
  92  * @ingroup APACHE_CORE_HTTPD
  93  * @{
  94  */
  95 /** REMOTE_HOST returns the hostname, or NULL if the hostname
  96  * lookup fails.  It will force a DNS lookup according to the
  97  * HostnameLookups setting.
  98  */
  99 #define REMOTE_HOST (0)
 100
 101 /** REMOTE_NAME returns the hostname, or the dotted quad if the
 102  * hostname lookup fails.  It will force a DNS lookup according
 103  * to the HostnameLookups setting.
 104  */
 105 #define REMOTE_NAME (1)
 106
 107 /** REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is
 108  * never forced.
 109  */
 110 #define REMOTE_NOLOOKUP (2)
 111
 112 /** REMOTE_DOUBLE_REV will always force a DNS lookup, and also force
 113  * a double reverse lookup, regardless of the HostnameLookups
 114  * setting.  The result is the (double reverse checked) hostname,
 115  * or NULL if any of the lookups fail.
 116  */
 117 #define REMOTE_DOUBLE_REV (3)
 118
 119 /** @} // get_remote_host */
 120
 121 /** all of the requirements must be met */
 122 #define SATISFY_ALL 0
 123 /**  any of the requirements must be met */
 124 #define SATISFY_ANY 1
 125 /** There are no applicable satisfy lines */
 126 #define SATISFY_NOSPEC 2
 127
 128 /** Make sure we don't write less than 8000 bytes at any one time.
 129  */
 130 #define AP_MIN_BYTES_TO_WRITE  8000
 131
 132 /** default maximum of internal redirects */
 133 # define AP_DEFAULT_MAX_INTERNAL_REDIRECTS 10
 134
 135 /** default maximum subrequest nesting level */
 136 # define AP_DEFAULT_MAX_SUBREQ_DEPTH 10
 137
 138 /**
 139  * Retrieve the value of Options for this request
 140  * @param r The current request
 141  * @return the Options bitmask
 142  */
 143 AP_DECLARE(int) ap_allow_options(request_rec *r);
 144
 145 /**
 146  * Retrieve the value of the AllowOverride for this request
 147  * @param r The current request
 148  * @return the overrides bitmask
 149  */
 150 AP_DECLARE(int) ap_allow_overrides(request_rec *r);
 151
 152 /**
 153  * Retrieve the document root for this server
 154  * @param r The current request
 155  * @warning Don't use this!  If your request went through a Userdir, or
 156  * something like that, it'll screw you.  But it's back-compatible...
 157  * @return The document root
 158  */
 159 AP_DECLARE(const char *) ap_document_root(request_rec *r);
 160
 161 /**
 162  * Lookup the remote user agent's DNS name or IP address
 163  * @ingroup get_remote_host
 164  * @param req The current request
 165  * @param type The type of lookup to perform.  One of:
 166  * <pre>
 167  *     REMOTE_HOST returns the hostname, or NULL if the hostname
 168  *                 lookup fails.  It will force a DNS lookup according to the
 169  *                 HostnameLookups setting.
 170  *     REMOTE_NAME returns the hostname, or the dotted quad if the
 171  *                 hostname lookup fails.  It will force a DNS lookup according
 172  *                 to the HostnameLookups setting.
 173  *     REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is
 174  *                     never forced.
 175  *     REMOTE_DOUBLE_REV will always force a DNS lookup, and also force
 176  *                   a double reverse lookup, regardless of the HostnameLookups
 177  *                   setting.  The result is the (double reverse checked)
 178  *                   hostname, or NULL if any of the lookups fail.
 179  * </pre>
 180  * @param str_is_ip unless NULL is passed, this will be set to non-zero on
 181  *        output when an IP address string is returned
 182  * @return The remote hostname (based on the request useragent_ip)
 183  */
 184 AP_DECLARE(const char *) ap_get_useragent_host(request_rec *req, int type,
 185                                                int *str_is_ip);
 186
 187 /**
 188  * Lookup the remote client's DNS name or IP address
 189  * @ingroup get_remote_host
 190  * @param conn The current connection
 191  * @param dir_config The directory config vector from the request
 192  * @param type The type of lookup to perform.  One of:
 193  * <pre>
 194  *     REMOTE_HOST returns the hostname, or NULL if the hostname
 195  *                 lookup fails.  It will force a DNS lookup according to the
 196  *                 HostnameLookups setting.
 197  *     REMOTE_NAME returns the hostname, or the dotted quad if the
 198  *                 hostname lookup fails.  It will force a DNS lookup according
 199  *                 to the HostnameLookups setting.
 200  *     REMOTE_NOLOOKUP is like REMOTE_NAME except that a DNS lookup is
 201  *                     never forced.
 202  *     REMOTE_DOUBLE_REV will always force a DNS lookup, and also force
 203  *                   a double reverse lookup, regardless of the HostnameLookups
 204  *                   setting.  The result is the (double reverse checked)
 205  *                   hostname, or NULL if any of the lookups fail.
 206  * </pre>
 207  * @param str_is_ip unless NULL is passed, this will be set to non-zero on output when an IP address
 208  *        string is returned
 209  * @return The remote hostname (based on the connection client_ip)
 210  */
 211 AP_DECLARE(const char *) ap_get_remote_host(conn_rec *conn, void *dir_config, int type, int *str_is_ip);
 212
 213 /**
 214  * Retrieve the login name of the remote user.  Undef if it could not be
 215  * determined
 216  * @param r The current request
 217  * @return The user logged in to the client machine
 218  */
 219 AP_DECLARE(const char *) ap_get_remote_logname(request_rec *r);
 220
 221 /* Used for constructing self-referencing URLs, and things like SERVER_PORT,
 222  * and SERVER_NAME.
 223  */
 224 /**
 225  * build a fully qualified URL from the uri and information in the request rec
 226  * @param p The pool to allocate the URL from
 227  * @param uri The path to the requested file
 228  * @param r The current request
 229  * @return A fully qualified URL
 230  */
 231 AP_DECLARE(char *) ap_construct_url(apr_pool_t *p, const char *uri, request_rec *r);
 232
 233 /**
 234  * Get the current server name from the request
 235  * @param r The current request
 236  * @return the server name
 237  */
 238 AP_DECLARE(const char *) ap_get_server_name(request_rec *r);
 239
 240 /**
 241  * Get the current server name from the request for the purposes
 242  * of using in a URL.  If the server name is an IPv6 literal
 243  * address, it will be returned in URL format (e.g., "[fe80::1]").
 244  * @param r The current request
 245  * @return the server name
 246  */
 247 AP_DECLARE(const char *) ap_get_server_name_for_url(request_rec *r);
 248
 249 /**
 250  * Get the current server port
 251  * @param r The current request
 252  * @return The server's port
 253  */
 254 AP_DECLARE(apr_port_t) ap_get_server_port(const request_rec *r);
 255
 256 /**
 257  * Get the size of read buffers
 258  * @param r The current request
 259  * @return The read buffers size
 260  */
 261 AP_DECLARE(apr_size_t) ap_get_read_buf_size(const request_rec *r);
 262
 263 /**
 264  * Return the limit on bytes in request msg body
 265  * @param r The current request
 266  * @return the maximum number of bytes in the request msg body
 267  */
 268 AP_DECLARE(apr_off_t) ap_get_limit_req_body(const request_rec *r);
 269
 270 /**
 271  * Return the limit on bytes in XML request msg body
 272  * @param r The current request
 273  * @return the maximum number of bytes in XML request msg body
 274  */
 275 AP_DECLARE(apr_size_t) ap_get_limit_xml_body(const request_rec *r);
 276
 277 /**
 278  * Install a custom response handler for a given status
 279  * @param r The current request
 280  * @param status The status for which the custom response should be used
 281  * @param string The custom response.  This can be a static string, a file
 282  *               or a URL
 283  */
 284 AP_DECLARE(void) ap_custom_response(request_rec *r, int status, const char *string);
 285
 286 /**
 287  * Check if the current request is beyond the configured max. number of redirects or subrequests
 288  * @param r The current request
 289  * @return true (is exceeded) or false
 290  */
 291 AP_DECLARE(int) ap_is_recursion_limit_exceeded(const request_rec *r);
 292
 293 /**
 294  * Check for a definition from the server command line
 295  * @param name The define to check for
 296  * @return 1 if defined, 0 otherwise
 297  */
 298 AP_DECLARE(int) ap_exists_config_define(const char *name);
 299 /* FIXME! See STATUS about how */
 300 AP_DECLARE_NONSTD(int) ap_core_translate(request_rec *r);
 301
 302 /* Authentication stuff.  This is one of the places where compatibility
 303  * with the old config files *really* hurts; they don't discriminate at
 304  * all between different authentication schemes, meaning that we need
 305  * to maintain common state for all of them in the core, and make it
 306  * available to the other modules through interfaces.
 307  */
 308
 309 /** @see require_line */
 310 typedef struct require_line require_line;
 311
 312 /**
 313  * @brief A structure to keep track of authorization requirements
 314 */
 315 struct require_line {
 316     /** Where the require line is in the config file. */
 317     apr_int64_t method_mask;
 318     /** The complete string from the command line */
 319     char *requirement;
 320 };
 321
 322 /**
 323  * Return the type of authorization required for this request
 324  * @param r The current request
 325  * @return The authorization required
 326  */
 327 AP_DECLARE(const char *) ap_auth_type(request_rec *r);
 328
 329 /**
 330  * Return the current Authorization realm
 331  * @param r The current request
 332  * @return The current authorization realm
 333  */
 334 AP_DECLARE(const char *) ap_auth_name(request_rec *r);
 335
 336 /**
 337  * How the requires lines must be met.
 338  * @param r The current request
 339  * @return How the requirements must be met.  One of:
 340  * <pre>
 341  *      SATISFY_ANY    -- any of the requirements must be met.
 342  *      SATISFY_ALL    -- all of the requirements must be met.
 343  *      SATISFY_NOSPEC -- There are no applicable satisfy lines
 344  * </pre>
 345  */
 346 AP_DECLARE(int) ap_satisfies(request_rec *r);
 347
 348 /**
 349  * Core is also unlike other modules in being implemented in more than
 350  * one file... so, data structures are declared here, even though most of
 351  * the code that cares really is in http_core.c.  Also, another accessor.
 352  */
 353 AP_DECLARE_DATA extern module core_module;
 354
 355 /**
 356  * Accessor for core_module's specific data. Equivalent to
 357  * ap_get_module_config(cv, &core_module) but more efficient.
 358  * @param cv The vector in which the modules configuration is stored.
 359  *        usually r->per_dir_config or s->module_config
 360  * @return The module-specific data
 361  */
 362 AP_DECLARE(void *) ap_get_core_module_config(const ap_conf_vector_t *cv);
 363
 364 /**
 365  * Accessor to set core_module's specific data. Equivalent to
 366  * ap_set_module_config(cv, &core_module, val) but more efficient.
 367  * @param cv The vector in which the modules configuration is stored.
 368  *        usually r->per_dir_config or s->module_config
 369  * @param val The module-specific data to set
 370  */
 371 AP_DECLARE(void) ap_set_core_module_config(ap_conf_vector_t *cv, void *val);
 372
 373 /** Get the socket from the core network filter. This should be used instead of
 374  * accessing the core connection config directly.
 375  * @param c The connection record
 376  * @return The socket
 377  */
 378 AP_DECLARE(apr_socket_t *) ap_get_conn_socket(conn_rec *c);
 379
 380 #ifndef AP_DEBUG
 381 #define AP_CORE_MODULE_INDEX  0
 382 #define ap_get_core_module_config(v) \
 383     (((void **)(v))[AP_CORE_MODULE_INDEX])
 384 #define ap_set_core_module_config(v, val) \
 385     ((((void **)(v))[AP_CORE_MODULE_INDEX]) = (val))
 386 #else
 387 #define AP_CORE_MODULE_INDEX  (AP_DEBUG_ASSERT(core_module.module_index == 0), 0)
 388 #endif
 389
 390 /**
 391  * @brief  Per-request configuration
 392 */
 393 typedef struct {
 394     /** bucket brigade used by getline for look-ahead and
 395      * ap_get_client_block for holding left-over request body */
 396     struct apr_bucket_brigade *bb;
 397
 398     /** an array of per-request working data elements, accessed
 399      * by ID using ap_get_request_note()
 400      * (Use ap_register_request_note() during initialization
 401      * to add elements)
 402      */
 403     void **notes;
 404
 405     /** Custom response strings registered via ap_custom_response(),
 406      * or NULL; check per-dir config if nothing found here
 407      */
 408     char **response_code_strings; /* from ap_custom_response(), not from
 409                                    * ErrorDocument
 410                                    */
 411
 412     /** per-request document root of the server. This allows mass vhosting
 413      * modules better compatibility with some scripts. Normally the
 414      * context_* info should be used instead */
 415     const char *document_root;
 416
 417     /*
 418      * more fine-grained context information which is set by modules like
 419      * mod_alias and mod_userdir
 420      */
 421     /** the context root directory on disk for the current resource,
 422      *  without trailing slash
 423      */
 424     const char *context_document_root;
 425     /** the URI prefix that corresponds to the context_document_root directory,
 426      *  without trailing slash
 427      */
 428     const char *context_prefix;
 429
 430     /** There is a script processor installed on the output filter chain,
 431      * so it needs the default_handler to deliver a (script) file into
 432      * the chain so it can process it. Normally, default_handler only
 433      * serves files on a GET request (assuming the file is actual content),
 434      * since other methods are not content-retrieval. This flag overrides
 435      * that behavior, stating that the "content" is actually a script and
 436      * won't actually be delivered as the response for the non-GET method.
 437      */
 438     int deliver_script;
 439
 440     /** Should addition of charset= be suppressed for this request?
 441      */
 442     int suppress_charset;
 443 } core_request_config;
 444
 445 /* Standard entries that are guaranteed to be accessible via
 446  * ap_get_request_note() for each request (additional entries
 447  * can be added with ap_register_request_note())
 448  */
 449 #define AP_NOTE_DIRECTORY_WALK 0
 450 #define AP_NOTE_LOCATION_WALK  1
 451 #define AP_NOTE_FILE_WALK      2
 452 #define AP_NOTE_IF_WALK        3
 453 #define AP_NUM_STD_NOTES       4
 454
 455 /**
 456  * Reserve an element in the core_request_config->notes array
 457  * for some application-specific data
 458  * @return An integer key that can be passed to ap_get_request_note()
 459  *         during request processing to access this element for the
 460  *         current request.
 461  */
 462 AP_DECLARE(apr_size_t) ap_register_request_note(void);
 463
 464 /**
 465  * Retrieve a pointer to an element in the core_request_config->notes array
 466  * @param r The request
 467  * @param note_num  A key for the element: either a value obtained from
 468  *        ap_register_request_note() or one of the predefined AP_NOTE_*
 469  *        values.
 470  * @return NULL if the note_num is invalid, otherwise a pointer to the
 471  *         requested note element.
 472  * @remark At the start of a request, each note element is NULL.  The
 473  *         handle provided by ap_get_request_note() is a pointer-to-pointer
 474  *         so that the caller can point the element to some app-specific
 475  *         data structure.  The caller should guarantee that any such
 476  *         structure will last as long as the request itself.
 477  */
 478 AP_DECLARE(void **) ap_get_request_note(request_rec *r, apr_size_t note_num);
 479
 480
 481 typedef unsigned char allow_options_t;
 482 typedef unsigned int overrides_t;
 483
 484 /*
 485  * Bits of info that go into making an ETag for a file
 486  * document.  Why a long?  Because char historically
 487  * proved too short for Options, and int can be different
 488  * sizes on different platforms.
 489  */
 490 typedef unsigned long etag_components_t;
 491
 492 #define ETAG_UNSET 0
 493 #define ETAG_NONE  (1 << 0)
 494 #define ETAG_MTIME (1 << 1)
 495 #define ETAG_INODE (1 << 2)
 496 #define ETAG_SIZE  (1 << 3)
 497 #define ETAG_ALL   (ETAG_MTIME | ETAG_INODE | ETAG_SIZE)
 498 /* This is the default value used */
 499 #define ETAG_BACKWARD (ETAG_MTIME | ETAG_SIZE)
 500
 501 /* Generic ON/OFF/UNSET for unsigned int foo :2 */
 502 #define AP_CORE_CONFIG_OFF   (0)
 503 #define AP_CORE_CONFIG_ON    (1)
 504 #define AP_CORE_CONFIG_UNSET (2)
 505
 506 /* Generic merge of flag */
 507 #define AP_CORE_MERGE_FLAG(field, to, base, over) to->field = \
 508                over->field != AP_CORE_CONFIG_UNSET            \
 509                ? over->field                                  \
 510                : base->field
 511
 512 /**
 513  * @brief Server Signature Enumeration
 514  */
 515 typedef enum {
 516     srv_sig_unset,
 517     srv_sig_off,
 518     srv_sig_on,
 519     srv_sig_withmail
 520 } server_signature_e;
 521
 522 /**
 523  * @brief Per-directory configuration
 524  */
 525 typedef struct {
 526     /** path of the directory/regex/etc. see also d_is_fnmatch/absolute below */
 527     char *d;
 528     /** the number of slashes in d */
 529     unsigned d_components;
 530
 531     /** If (opts & OPT_UNSET) then no absolute assignment to options has
 532      * been made.
 533      * invariant: (opts_add & opts_remove) == 0
 534      * Which said another way means that the last relative (options + or -)
 535      * assignment made to each bit is recorded in exactly one of opts_add
 536      * or opts_remove.
 537      */
 538     allow_options_t opts;
 539     allow_options_t opts_add;
 540     allow_options_t opts_remove;
 541     overrides_t override;
 542     allow_options_t override_opts;
 543
 544     /* Used to be the custom response config. No longer used. */
 545     char **response_code_strings; /* from ErrorDocument, not from
 546                                    * ap_custom_response() */
 547
 548     /* Hostname resolution etc */
 549 #define HOSTNAME_LOOKUP_OFF     0
 550 #define HOSTNAME_LOOKUP_ON      1
 551 #define HOSTNAME_LOOKUP_DOUBLE  2
 552 #define HOSTNAME_LOOKUP_UNSET   3
 553     unsigned int hostname_lookups : 4;
 554
 555     unsigned int content_md5 : 2;  /* calculate Content-MD5? */
 556
 557 #define USE_CANONICAL_NAME_OFF   (0)
 558 #define USE_CANONICAL_NAME_ON    (1)
 559 #define USE_CANONICAL_NAME_DNS   (2)
 560 #define USE_CANONICAL_NAME_UNSET (3)
 561     unsigned use_canonical_name : 2;
 562
 563     /* since is_fnmatch(conf->d) was being called so frequently in
 564      * directory_walk() and its relatives, this field was created and
 565      * is set to the result of that call.
 566      */
 567     unsigned d_is_fnmatch : 1;
 568
 569     /* should we force a charset on any outgoing parameterless content-type?
 570      * if so, which charset?
 571      */
 572 #define ADD_DEFAULT_CHARSET_OFF   (0)
 573 #define ADD_DEFAULT_CHARSET_ON    (1)
 574 #define ADD_DEFAULT_CHARSET_UNSET (2)
 575     unsigned add_default_charset : 2;
 576     const char *add_default_charset_name;
 577
 578     /* System Resource Control */
 579 #ifdef RLIMIT_CPU
 580     struct rlimit *limit_cpu;
 581 #endif
 582 #if defined (RLIMIT_DATA) || defined (RLIMIT_VMEM) || defined(RLIMIT_AS)
 583     struct rlimit *limit_mem;
 584 #endif
 585 #ifdef RLIMIT_NPROC
 586     struct rlimit *limit_nproc;
 587 #endif
 588     apr_off_t limit_req_body;      /* limit on bytes in request msg body */
 589     long limit_xml_body;           /* limit on bytes in XML request msg body */
 590
 591     /* logging options */
 592
 593     server_signature_e server_signature;
 594
 595     /* Access control */
 596     apr_array_header_t *sec_file;
 597     apr_array_header_t *sec_if;
 598     ap_regex_t *r;
 599
 600     const char *mime_type;       /* forced with ForceType  */
 601     const char *handler;         /* forced by something other than SetHandler */
 602     const char *output_filters;  /* forced with SetOutputFilters */
 603     const char *input_filters;   /* forced with SetInputFilters */
 604     int accept_path_info;        /* forced with AcceptPathInfo */
 605
 606     /*
 607      * What attributes/data should be included in ETag generation?
 608      */
 609     etag_components_t etag_bits;
 610     etag_components_t etag_add;
 611     etag_components_t etag_remove;
 612
 613     /*
 614      * Run-time performance tuning
 615      */
 616 #define ENABLE_MMAP_OFF    (0)
 617 #define ENABLE_MMAP_ON     (1)
 618 #define ENABLE_MMAP_UNSET  (2)
 619     unsigned int enable_mmap : 2;  /* whether files in this dir can be mmap'ed */
 620
 621 #define ENABLE_SENDFILE_OFF    (0)
 622 #define ENABLE_SENDFILE_ON     (1)
 623 #define ENABLE_SENDFILE_UNSET  (2)
 624     unsigned int enable_sendfile : 2;  /* files in this dir can be sendfile'ed */
 625
 626 #define USE_CANONICAL_PHYS_PORT_OFF   (0)
 627 #define USE_CANONICAL_PHYS_PORT_ON    (1)
 628 #define USE_CANONICAL_PHYS_PORT_UNSET (2)
 629     unsigned int use_canonical_phys_port : 2;
 630
 631     unsigned int allow_encoded_slashes : 1; /* URLs may contain %2f w/o being
 632                                              * pitched indiscriminately */
 633     unsigned int decode_encoded_slashes : 1; /* whether to decode encoded slashes in URLs */
 634
 635 #define AP_CONDITION_IF        1
 636 #define AP_CONDITION_ELSE      2
 637 #define AP_CONDITION_ELSEIF    (AP_CONDITION_ELSE|AP_CONDITION_IF)
 638     unsigned int condition_ifelse : 2; /* is this an <If>, <ElseIf>, or <Else> */
 639
 640     ap_expr_info_t *condition;   /* Conditionally merge <If> sections */
 641
 642     /** per-dir log config */
 643     struct ap_logconf *log;
 644
 645     /** Table of directives allowed per AllowOverrideList */
 646     apr_table_t *override_list;
 647
 648 #define AP_MAXRANGES_UNSET     -1
 649 #define AP_MAXRANGES_DEFAULT   -2
 650 #define AP_MAXRANGES_UNLIMITED -3
 651 #define AP_MAXRANGES_NORANGES   0
 652     /** Number of Ranges before returning HTTP_OK. **/
 653     int max_ranges;
 654     /** Max number of Range overlaps (merges) allowed **/
 655     int max_overlaps;
 656     /** Max number of Range reversals (eg: 200-300, 100-125) allowed **/
 657     int max_reversals;
 658
 659     unsigned int allow_encoded_slashes_set : 1;
 660     unsigned int decode_encoded_slashes_set : 1;
 661
 662     /** Named back references */
 663     apr_array_header_t *refs;
 664
 665 #define AP_CGI_PASS_AUTH_OFF     (0)
 666 #define AP_CGI_PASS_AUTH_ON      (1)
 667 #define AP_CGI_PASS_AUTH_UNSET   (2)
 668     /** CGIPassAuth: Whether HTTP authorization headers will be passed to
 669      * scripts as CGI variables; affects all modules calling
 670      * ap_add_common_vars(), as well as any others using this field as
 671      * advice
 672      */
 673     unsigned int cgi_pass_auth : 2;
 674
 675     /** Custom response config with expression support. The hash table
 676      * contains compiled expressions keyed against the custom response
 677      * code.
 678      */
 679     apr_hash_t *response_code_exprs;
 680
 681     unsigned int qualify_redirect_url :2;
 682     ap_expr_info_t  *expr_handler;         /* forced with SetHandler */
 683
 684     /** Table of rules for building CGI variables, NULL if none configured */
 685     apr_hash_t *cgi_var_rules;
 686
 687     apr_size_t read_buf_size;
 688 } core_dir_config;
 689
 690 /* macro to implement off by default behaviour */
 691 #define AP_SENDFILE_ENABLED(x) \
 692     ((x) == ENABLE_SENDFILE_ON ? APR_SENDFILE_ENABLED : 0)
 693
 694 /* Per-server core configuration */
 695
 696 typedef struct {
 697
 698     char *gprof_dir;
 699
 700     /* Name translations --- we want the core to be able to do *something*
 701      * so it's at least a minimally functional web server on its own (and
 702      * can be tested that way).  But let's keep it to the bare minimum:
 703      */
 704     const char *ap_document_root;
 705
 706     /* Access control */
 707
 708     char *access_name;
 709     apr_array_header_t *sec_dir;
 710     apr_array_header_t *sec_url;
 711
 712     /* recursion backstopper */
 713     int redirect_limit; /* maximum number of internal redirects */
 714     int subreq_limit;   /* maximum nesting level of subrequests */
 715
 716     const char *protocol;
 717     apr_table_t *accf_map;
 718
 719     /* array of ap_errorlog_format_item for error log format string */
 720     apr_array_header_t *error_log_format;
 721     /*
 722      * two arrays of arrays of ap_errorlog_format_item for additional information
 723      * logged to the error log once per connection/request
 724      */
 725     apr_array_header_t *error_log_conn;
 726     apr_array_header_t *error_log_req;
 727
 728     /* TRACE control */
 729 #define AP_TRACE_UNSET    -1
 730 #define AP_TRACE_DISABLE   0
 731 #define AP_TRACE_ENABLE    1
 732 #define AP_TRACE_EXTENDED  2
 733     int trace_enable;
 734 #define AP_MERGE_TRAILERS_UNSET    0
 735 #define AP_MERGE_TRAILERS_ENABLE   1
 736 #define AP_MERGE_TRAILERS_DISABLE  2
 737     int merge_trailers;
 738
 739     apr_array_header_t *conn_log_level;
 740
 741 #define AP_HTTP09_UNSET   0
 742 #define AP_HTTP09_ENABLE  1
 743 #define AP_HTTP09_DISABLE 2
 744     char http09_enable;
 745
 746 #define AP_HTTP_CONFORMANCE_UNSET     0
 747 #define AP_HTTP_CONFORMANCE_UNSAFE    1
 748 #define AP_HTTP_CONFORMANCE_STRICT    2
 749     char http_conformance;
 750
 751 #define AP_HTTP_METHODS_UNSET         0
 752 #define AP_HTTP_METHODS_LENIENT       1
 753 #define AP_HTTP_METHODS_REGISTERED    2
 754     char http_methods;
 755
 756 #define AP_HTTP_CL_HEAD_ZERO_UNSET    0
 757 #define AP_HTTP_CL_HEAD_ZERO_ENABLE   1
 758 #define AP_HTTP_CL_HEAD_ZERO_DISABLE  2
 759     int http_cl_head_zero;
 760
 761 #define AP_HTTP_EXPECT_STRICT_UNSET    0
 762 #define AP_HTTP_EXPECT_STRICT_ENABLE   1
 763 #define AP_HTTP_EXPECT_STRICT_DISABLE  2
 764     int http_expect_strict;
 765
 766     apr_array_header_t *protocols;
 767     int protocols_honor_order;
 768     int async_filter;
 769     unsigned int async_filter_set:1;
 770
 771     apr_size_t   flush_max_threshold;
 772     apr_int32_t  flush_max_pipelined;
 773     unsigned int strict_host_check;
 774 } core_server_config;
 775
 776 /* for AddOutputFiltersByType in core.c */
 777 void ap_add_output_filters_by_type(request_rec *r);
 778
 779 /* for http_config.c */
 780 void ap_core_reorder_directories(apr_pool_t *, server_rec *);
 781
 782 /* for mod_perl */
 783 AP_CORE_DECLARE(void) ap_add_per_dir_conf(server_rec *s, void *dir_config);
 784 AP_CORE_DECLARE(void) ap_add_per_url_conf(server_rec *s, void *url_config);
 785 AP_CORE_DECLARE(void) ap_add_file_conf(apr_pool_t *p, core_dir_config *conf, void *url_config);
 786 AP_CORE_DECLARE(const char *) ap_add_if_conf(apr_pool_t *p, core_dir_config *conf, void *url_config);
 787 AP_CORE_DECLARE_NONSTD(const char *) ap_limit_section(cmd_parms *cmd, void *dummy, const char *arg);
 788
 789 /* Core filters; not exported. */
 790 apr_status_t ap_core_input_filter(ap_filter_t *f, apr_bucket_brigade *b,
 791                                   ap_input_mode_t mode, apr_read_type_e block,
 792                                   apr_off_t readbytes);
 793 apr_status_t ap_core_output_filter(ap_filter_t *f, apr_bucket_brigade *b);
 794
 795
 796 AP_DECLARE(const char*) ap_get_server_protocol(server_rec* s);
 797 AP_DECLARE(void) ap_set_server_protocol(server_rec* s, const char* proto);
 798
 799 typedef struct core_output_filter_ctx core_output_filter_ctx_t;
 800 typedef struct core_filter_ctx        core_ctx_t;
 801
 802 typedef struct core_net_rec {
 803     /** Connection to the client */
 804     apr_socket_t *client_socket;
 805
 806     /** connection record */
 807     conn_rec *c;
 808
 809     core_output_filter_ctx_t *out_ctx;
 810     core_ctx_t *in_ctx;
 811 } core_net_rec;
 812
 813 /**
 814  * Insert the network bucket into the core input filter's input brigade.
 815  * This hook is intended for MPMs or protocol modules that need to do special
 816  * socket setup.
 817  * @param c The connection
 818  * @param bb The brigade to insert the bucket into
 819  * @param socket The socket to put into a bucket
 820  * @return AP_DECLINED if the current function does not handle this connection,
 821  *         APR_SUCCESS or an error otherwise.
 822  */
 823 AP_DECLARE_HOOK(apr_status_t, insert_network_bucket,
 824                 (conn_rec *c, apr_bucket_brigade *bb, apr_socket_t *socket))
 825
 826 /* ----------------------------------------------------------------------
 827  *
 828  * Runtime status/management
 829  */
 830
 831 typedef enum {
 832     ap_mgmt_type_string,
 833     ap_mgmt_type_long,
 834     ap_mgmt_type_hash
 835 } ap_mgmt_type_e;
 836
 837 typedef union {
 838     const char *s_value;
 839     long i_value;
 840     apr_hash_t *h_value;
 841 } ap_mgmt_value;
 842
 843 typedef struct {
 844     const char *description;
 845     const char *name;
 846     ap_mgmt_type_e vtype;
 847     ap_mgmt_value v;
 848 } ap_mgmt_item_t;
 849
 850 /* Handles for core filters */
 851 AP_DECLARE_DATA extern ap_filter_rec_t *ap_subreq_core_filter_handle;
 852 AP_DECLARE_DATA extern ap_filter_rec_t *ap_core_output_filter_handle;
 853 AP_DECLARE_DATA extern ap_filter_rec_t *ap_content_length_filter_handle;
 854 AP_DECLARE_DATA extern ap_filter_rec_t *ap_core_input_filter_handle;
 855 AP_DECLARE_DATA extern ap_filter_rec_t *ap_request_core_filter_handle;
 856
 857 /**
 858  * This hook provdes a way for modules to provide metrics/statistics about
 859  * their operational status.
 860  *
 861  * @param p A pool to use to create entries in the hash table
 862  * @param val The name of the parameter(s) that is wanted. This is
 863  *            tree-structured would be in the form ('*' is all the tree,
 864  *            'module.*' all of the module , 'module.foo.*', or
 865  *            'module.foo.bar' )
 866  * @param ht The hash table to store the results. Keys are item names, and
 867  *           the values point to ap_mgmt_item_t structures.
 868  * @ingroup hooks
 869  */
 870 AP_DECLARE_HOOK(int, get_mgmt_items,
 871                 (apr_pool_t *p, const char * val, apr_hash_t *ht))
 872
 873 /* ---------------------------------------------------------------------- */
 874
 875 /* ----------------------------------------------------------------------
 876  *
 877  * I/O logging with mod_logio
 878  */
 879
 880 APR_DECLARE_OPTIONAL_FN(void, ap_logio_add_bytes_out,
 881                         (conn_rec *c, apr_off_t bytes));
 882
 883 APR_DECLARE_OPTIONAL_FN(void, ap_logio_add_bytes_in,
 884                         (conn_rec *c, apr_off_t bytes));
 885
 886 APR_DECLARE_OPTIONAL_FN(apr_off_t, ap_logio_get_last_bytes, (conn_rec *c));
 887
 888 /* ----------------------------------------------------------------------
 889  *
 890  * Error log formats
 891  */
 892
 893 /**
 894  * The info structure passed to callback functions of errorlog handlers.
 895  * Not all information is available in all contexts. In particular, all
 896  * pointers may be NULL.
 897  */
 898 typedef struct ap_errorlog_info {
 899     /** current server_rec.
 900      *  Should be preferred over c->base_server and r->server
 901      */
 902     const server_rec *s;
 903
 904     /** current conn_rec.
 905      *  Should be preferred over r->connection
 906      */
 907     const conn_rec *c;
 908
 909     /** current request_rec. */
 910     const request_rec *r;
 911     /** r->main if r is a subrequest, otherwise equal to r */
 912     const request_rec *rmain;
 913
 914     /** pool passed to ap_log_perror, NULL otherwise */
 915     apr_pool_t *pool;
 916
 917     /** name of source file where the log message was produced, NULL if N/A. */
 918     const char *file;
 919     /** line number in the source file, 0 if N/A */
 920     int line;
 921
 922     /** module index of module that produced the log message, APLOG_NO_MODULE if N/A. */
 923     int module_index;
 924     /** log level of error message (flags like APLOG_STARTUP have been removed), -1 if N/A */
 925     int level;
 926
 927     /** apr error status related to the log message, 0 if no error */
 928     apr_status_t status;
 929
 930     /** 1 if logging using provider, 0 otherwise */
 931     int using_provider;
 932     /** 1 if APLOG_STARTUP was set for the log message, 0 otherwise */
 933     int startup;
 934
 935     /** message format */
 936     const char *format;
 937 } ap_errorlog_info;
 938
 939 #define AP_ERRORLOG_PROVIDER_GROUP "error_log_writer"
 940 #define AP_ERRORLOG_PROVIDER_VERSION "0"
 941 #define AP_ERRORLOG_DEFAULT_PROVIDER "file"
 942
 943 /** add APR_EOL_STR to the end of log message */
 944 #define AP_ERRORLOG_PROVIDER_ADD_EOL_STR       1
 945
 946 typedef struct ap_errorlog_provider ap_errorlog_provider;
 947
 948 struct ap_errorlog_provider {
 949     /** Initializes the error log writer.
 950      * @param p The pool to create any storage from
 951      * @param s Server for which the logger is initialized
 952      * @return Pointer to handle passed later to writer() function
 953      * @note On success, the provider must return non-NULL, even if
 954      * the handle is not necessary when the writer() function is
 955      * called.  On failure, the provider should log a startup error
 956      * message and return NULL to abort httpd startup.
 957      */
 958     void * (*init)(apr_pool_t *p, server_rec *s);
 959
 960     /** Logs the error message to external error log.
 961      * @param info Context of the error message
 962      * @param handle Handle created by init() function
 963      * @param errstr Error message
 964      * @param len Length of the error message
 965      */
 966     apr_status_t (*writer)(const ap_errorlog_info *info, void *handle,
 967                            const char *errstr, apr_size_t len);
 968
 969     /** Checks syntax of ErrorLog directive argument.
 970      * @param cmd The config directive
 971      * @param arg ErrorLog directive argument (or the empty string if
 972      * no argument was provided)
 973      * @return Error message or NULL on success
 974      * @remark The argument will be stored in the error_fname field
 975      * of server_rec for access later.
 976      */
 977     const char * (*parse_errorlog_arg)(cmd_parms *cmd, const char *arg);
 978
 979     /** a combination of the AP_ERRORLOG_PROVIDER_* flags */
 980     unsigned int flags;
 981 };
 982
 983 /**
 984  * callback function prototype for a external errorlog handler
 985  * @note To avoid unbounded memory usage, these functions must not allocate
 986  * memory from the server, connection, or request pools. If an errorlog
 987  * handler absolutely needs a pool to pass to other functions, it must create
 988  * and destroy a sub-pool.
 989  */
 990 typedef int ap_errorlog_handler_fn_t(const ap_errorlog_info *info,
 991                                      const char *arg, char *buf, int buflen);
 992
 993 /**
 994  * Register external errorlog handler
 995  * @param p config pool to use
 996  * @param tag the new format specifier (i.e. the letter after the %)
 997  * @param handler the handler function
 998  * @param flags flags (reserved, set to 0)
 999  */
1000 AP_DECLARE(void) ap_register_errorlog_handler(apr_pool_t *p, char *tag,
1001                                               ap_errorlog_handler_fn_t *handler,
1002                                               int flags);
1003
1004 typedef struct ap_errorlog_handler {
1005     ap_errorlog_handler_fn_t *func;
1006     int flags; /* for future extensions */
1007 } ap_errorlog_handler;
1008
1009   /** item starts a new field */
1010 #define AP_ERRORLOG_FLAG_FIELD_SEP       1
1011   /** item is the actual error message */
1012 #define AP_ERRORLOG_FLAG_MESSAGE         2
1013   /** skip whole line if item is zero-length */
1014 #define AP_ERRORLOG_FLAG_REQUIRED        4
1015   /** log zero-length item as '-' */
1016 #define AP_ERRORLOG_FLAG_NULL_AS_HYPHEN  8
1017
1018 typedef struct {
1019     /** ap_errorlog_handler function */
1020     ap_errorlog_handler_fn_t *func;
1021     /** argument passed to item in {} */
1022     const char *arg;
1023     /** a combination of the AP_ERRORLOG_* flags */
1024     unsigned int flags;
1025     /** only log item if the message's log level is higher than this */
1026     unsigned int min_loglevel;
1027 } ap_errorlog_format_item;
1028
1029 /**
1030  * hook method to log error messages
1031  * @ingroup hooks
1032  * @param info pointer to ap_errorlog_info struct which contains all
1033  *        the details
1034  * @param errstr the (unformatted) message to log
1035  * @warning Allocating from the usual pools (pool, info->c->pool, info->p->pool)
1036  *          must be avoided because it can cause memory leaks.
1037  *          Use a subpool if necessary.
1038  */
1039 AP_DECLARE_HOOK(void, error_log, (const ap_errorlog_info *info,
1040                                   const char *errstr))
1041
1042 AP_CORE_DECLARE(void) ap_register_log_hooks(apr_pool_t *p);
1043 AP_CORE_DECLARE(void) ap_register_config_hooks(apr_pool_t *p);
1044
1045 /* ----------------------------------------------------------------------
1046  *
1047  * ident lookups with mod_ident
1048  */
1049
1050 APR_DECLARE_OPTIONAL_FN(const char *, ap_ident_lookup,
1051                         (request_rec *r));
1052
1053 /* ----------------------------------------------------------------------
1054  *
1055  * authorization values with mod_authz_core
1056  */
1057
1058 APR_DECLARE_OPTIONAL_FN(int, authz_some_auth_required, (request_rec *r));
1059 APR_DECLARE_OPTIONAL_FN(const char *, authn_ap_auth_type, (request_rec *r));
1060 APR_DECLARE_OPTIONAL_FN(const char *, authn_ap_auth_name, (request_rec *r));
1061
1062 /* ----------------------------------------------------------------------
1063  *
1064  * authorization values with mod_access_compat
1065  */
1066
1067 APR_DECLARE_OPTIONAL_FN(int, access_compat_ap_satisfies, (request_rec *r));
1068
1069 /* ---------------------------------------------------------------------- */
1070
1071 /** Query the server for some state information
1072  * @param query_code Which information is requested
1073  * @return the requested state information
1074  */
1075 AP_DECLARE(int) ap_state_query(int query_code);
1076
1077 /*
1078  * possible values for query_code in ap_state_query()
1079  */
1080
1081   /** current status of the server */
1082 #define AP_SQ_MAIN_STATE        0
1083   /** are we going to serve requests or are we just testing/dumping config */
1084 #define AP_SQ_RUN_MODE          1
1085     /** generation of the top-level apache parent */
1086 #define AP_SQ_CONFIG_GEN        2
1087
1088 /*
1089  * return values for ap_state_query()
1090  */
1091
1092   /** return value for unknown query_code */
1093 #define AP_SQ_NOT_SUPPORTED       -1
1094
1095 /* values returned for AP_SQ_MAIN_STATE */
1096   /** before the config preflight */
1097 #define AP_SQ_MS_INITIAL_STARTUP   1
1098   /** initial configuration run for setting up log config, etc. */
1099 #define AP_SQ_MS_CREATE_PRE_CONFIG 2
1100   /** tearing down configuration */
1101 #define AP_SQ_MS_DESTROY_CONFIG    3
1102   /** normal configuration run */
1103 #define AP_SQ_MS_CREATE_CONFIG     4
1104   /** running the MPM */
1105 #define AP_SQ_MS_RUN_MPM           5
1106   /** cleaning up for exit */
1107 #define AP_SQ_MS_EXITING           6
1108
1109 /* values returned for AP_SQ_RUN_MODE */
1110   /** command line not yet parsed */
1111 #define AP_SQ_RM_UNKNOWN           1
1112   /** normal operation (server requests or signal server) */
1113 #define AP_SQ_RM_NORMAL            2
1114   /** config test only */
1115 #define AP_SQ_RM_CONFIG_TEST       3
1116   /** only dump some parts of the config */
1117 #define AP_SQ_RM_CONFIG_DUMP       4
1118
1119
1120 /* ---------------------------------------------------------------------- */
1121
1122 /** Create a slave connection
1123  * @param c The connection to create the slave connection from/for
1124  * @return The slave connection
1125  */
1126 AP_CORE_DECLARE(conn_rec *) ap_create_slave_connection(conn_rec *c);
1127
1128
1129 /** Macro to provide a default value if the pointer is not yet initialised
1130  */
1131 #define AP_CORE_DEFAULT(X, Y, Z)    (X ? X->Y : Z)
1132
1133 #ifdef __cplusplus
1134 }
1135 #endif
1136
1137 #endif  /* !APACHE_HTTP_CORE_H */
1138 /** @} */