]> granicus.if.org Git - apache/blob - include/ap_mmn.h
Introduce request taint-checking concept.
[apache] / include / ap_mmn.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  ap_mmn.h
19  * @brief Module Magic Number
20  *
21  * @defgroup APACHE_CORE_MMN Module Magic Number
22  * @ingroup  APACHE_CORE
23
24  * #MODULE_MAGIC_NUMBER_MAJOR\n
25  * Major API changes that could cause compatibility problems for older modules
26  * such as structure size changes.  No binary compatibility is possible across
27  * a change in the major version.
28  *
29  * #MODULE_MAGIC_NUMBER_MINOR\n
30  * Minor API changes that do not cause binary compatibility problems.
31  * Should be reset to 0 when upgrading MODULE_MAGIC_NUMBER_MAJOR.
32  *
33  * See the #AP_MODULE_MAGIC_AT_LEAST macro below for an example.
34  * @{
35  */
36
37 #ifndef APACHE_AP_MMN_H
38 #define APACHE_AP_MMN_H
39
40 /*
41  * 20010224   (2.0.13-dev) MODULE_MAGIC_COOKIE reset to "AP20"
42  * 20010523   (2.0.19-dev) bump for scoreboard structure reordering
43  * 20010627   (2.0.19-dev) more API changes than I can count
44  * 20010726   (2.0.22-dev) more big API changes
45  * 20010808   (2.0.23-dev) dir d_is_absolute bit introduced, bucket changes, etc
46  * 20010825   (2.0.25-dev) removed d_is_absolute, introduced map_to_storage hook
47  * 20011002   (2.0.26-dev) removed 1.3-deprecated request_rec.content_language
48  * 20011127   (2.0.29-dev) bump for postconfig hook change, and removal of
49  *                         socket from connection record
50  * 20011212   (2.0.30-dev) bump for new used_path_info member of request_rec
51  * 20011218   (2.0.30-dev) bump for new sbh member of conn_rec, different
52  *                         declarations for scoreboard, new parameter to
53  *                         create_connection hook
54  * 20020102   (2.0.30-dev) bump for changed type of limit_req_body in
55  *                         core_dir_config
56  * 20020109   (2.0.31-dev) bump for changed shm and scoreboard declarations
57  * 20020111   (2.0.31-dev) bump for ETag fields added at end of cor_dir_config
58  * 20020114   (2.0.31-dev) mod_dav changed how it asks its provider to fulfill
59  *                         a GET request
60  * 20020118   (2.0.31-dev) Input filtering split of blocking and mode
61  * 20020127   (2.0.31-dev) bump for pre_mpm hook change
62  * 20020128   (2.0.31-dev) bump for pre_config hook change
63  * 20020218   (2.0.33-dev) bump for AddOutputFilterByType directive
64  * 20020220   (2.0.33-dev) bump for scoreboard.h structure change
65  * 20020302   (2.0.33-dev) bump for protocol_filter additions.
66  * 20020306   (2.0.34-dev) bump for filter type renames.
67  * 20020318   (2.0.34-dev) mod_dav's API for REPORT generation changed
68  * 20020319   (2.0.34-dev) M_INVALID changed, plus new M_* methods for RFC 3253
69  * 20020327   (2.0.35-dev) Add parameter to quick_handler hook
70  * 20020329   (2.0.35-dev) bump for addition of freelists to bucket API
71  * 20020329.1 (2.0.36)     minor bump for new arg to opt fn ap_cgi_build_command
72  * 20020506   (2.0.37-dev) Removed r->boundary in request_rec.
73  * 20020529   (2.0.37-dev) Standardized the names of some apr_pool_*_set funcs
74  * 20020602   (2.0.37-dev) Bucket API change (metadata buckets)
75  * 20020612   (2.0.38-dev) Changed server_rec->[keep_alive_]timeout to apr time
76  * 20020625   (2.0.40-dev) Changed conn_rec->keepalive to an enumeration
77  * 20020628   (2.0.40-dev) Added filter_init to filter registration functions
78  * 20020903   (2.0.41-dev) APR's error constants changed
79  * 20020903.1 (2.1.0-dev)  allow_encoded_slashes added to core_dir_config
80  * 20020903.2 (2.0.46-dev) add ap_escape_logitem
81  * 20030213.1 (2.1.0-dev)  changed log_writer optional fn's to return previous
82  *                         handler
83  * 20030821   (2.1.0-dev)  bumped mod_include's entire API
84  * 20030821.1 (2.1.0-dev)  added XHTML doctypes
85  * 20030821.2 (2.1.0-dev)  added ap_escape_errorlog_item
86  * 20030821.3 (2.1.0-dev)  added ap_get_server_revision / ap_version_t
87  * 20040425   (2.1.0-dev)  removed ap_add_named_module API
88  *                         changed ap_add_module, ap_add_loaded_module,
89  *                         ap_setup_prelinked_modules,
90  *                         ap_process_resource_config
91  * 20040425.1 (2.1.0-dev)  Added ap_module_symbol_t and
92  *                         ap_prelinked_module_symbols
93  * 20050101.0 (2.1.2-dev)  Axed misnamed http_method for http_scheme
94  *                         (which it was!)
95  * 20050127.0 (2.1.3-dev)  renamed regex_t->ap_regex_t,
96  *                         regmatch_t->ap_regmatch_t, REG_*->AP_REG_*,
97  *                         removed reg* in place of ap_reg*; added ap_regex.h
98  * 20050217.0 (2.1.3-dev)  Axed find_child_by_pid, mpm_*_completion_context
99  *                         (winnt mpm) symbols from the public sector, and
100  *                         decorated real_exit_code with ap_ in the win32/os.h.
101  * 20050305.0 (2.1.4-dev)  added pid and generation fields to worker_score
102  * 20050305.1 (2.1.5-dev)  added ap_vhost_iterate_given_conn.
103  * 20050305.2 (2.1.5-dev)  added AP_INIT_TAKE_ARGV.
104  * 20050305.3 (2.1.5-dev)  added Protocol Framework.
105  * 20050701.0 (2.1.7-dev)  Bump MODULE_MAGIC_COOKIE to "AP21"!
106  * 20050701.1 (2.1.7-dev)  trace_enable member added to core server_config
107  * 20050708.0 (2.1.7-dev)  Bump MODULE_MAGIC_COOKIE to "AP22"!
108  * 20050708.1 (2.1.7-dev)  add proxy request_status hook (minor)
109  * 20050919.0 (2.1.8-dev)  mod_ssl ssl_ext_list optional function added
110  * 20051005.0 (2.1.8-dev)  NET_TIME filter eliminated
111  * 20051005.0 (2.3.0-dev)  Bump MODULE_MAGIC_COOKIE to "AP24"!
112  * 20051115.0 (2.3.0-dev)  Added use_canonical_phys_port to core_dir_config
113  * 20060110.0 (2.3.0-dev)  Conversion of Authz to be provider based
114  *                         addition of <SatisfyAll><SatisfyOne>
115  *                         removal of Satisfy, Allow, Deny, Order
116  * 20060110.1 (2.3.0-dev)  minex and minex_set members added to
117  *                         cache_server_conf (minor)
118  * 20060110.2 (2.3.0-dev)  flush_packets and flush_wait members added to
119  *                         proxy_server (minor)
120  * 20060110.3 (2.3.0-dev)  added inreslist member to proxy_conn_rec (minor)
121  * 20060110.4 (2.3.0-dev)  Added server_scheme member to server_rec (minor)
122  * 20060905.0 (2.3.0-dev)  Replaced ap_get_server_version() with
123  *                         ap_get_server_banner() and ap_get_server_description()
124  * 20060905.1 (2.3.0-dev)  Enable retry=0 for the worker (minor)
125  * 20060905.2 (2.3.0-dev)  Added ap_all_available_mutexes_string,
126  *                         ap_available_mutexes_string and
127  *                         ap_parse_mutex()
128  * 20060905.3 (2.3.0-dev)  Added conn_rec::clogging_input_filters.
129  * 20060905.4 (2.3.0-dev)  Added proxy_balancer::sticky_path.
130  * 20060905.5 (2.3.0-dev)  Added ap_mpm_safe_kill()
131  * 20070823.0 (2.3.0-dev)  Removed ap_all_available_mutexes_string,
132  *                         ap_available_mutexes_string for macros
133  * 20070823.1 (2.3.0-dev)  add ap_send_interim_response()
134  * 20071023.0 (2.3.0-dev)  add ap_get_scoreboard(sbh) split from the less
135  *                         conventional ap_get_scoreboard(proc, thread)
136  * 20071023.1 (2.3.0-dev)  Add flags field to struct proxy_alias
137  * 20071023.2 (2.3.0-dev)  Add ap_mod_status_reqtail
138  * 20071023.3 (2.3.0-dev)  Declare ap_time_process_request() as part of the
139  *                         public scoreboard API.
140  * 20071108.1 (2.3.0-dev)  Add the optional kept_body brigade to request_rec
141  * 20071108.2 (2.3.0-dev)  Add st and keep fields to struct util_ldap_connection_t
142  * 20071108.3 (2.3.0-dev)  Add API guarantee for adding connection filters
143  *                         with non-NULL request_rec pointer (ap_add_*_filter*)
144  * 20071108.4 (2.3.0-dev)  Add ap_proxy_ssl_connection_cleanup
145  * 20071108.5 (2.3.0-dev)  Add *scpool to proxy_conn_rec structure
146  * 20071108.6 (2.3.0-dev)  Add *r and need_flush to proxy_conn_rec structure
147  * 20071108.7 (2.3.0-dev)  Add *ftp_directory_charset to proxy_dir_conf
148  * 20071108.8 (2.3.0-dev)  Add optional function ap_logio_add_bytes_in() to mog_logio
149  * 20071108.9 (2.3.0-dev)  Add chroot support to unixd_config
150  * 20071108.10(2.3.0-dev)  Introduce new ap_expr API
151  * 20071108.11(2.3.0-dev)  Revise/Expand new ap_expr API
152  * 20071108.12(2.3.0-dev)  Remove ap_expr_clone from the API (same day it was added)
153  * 20080403.0 (2.3.0-dev)  Add condition field to core dir config
154  * 20080403.1 (2.3.0-dev)  Add authn/z hook and provider registration wrappers.
155  * 20080403.2 (2.3.0-dev)  Add ap_escape_path_segment_buffer() and ap_unescape_all().
156  * 20080407.0 (2.3.0-dev)  Remove ap_graceful_stop_signalled.
157  * 20080407.1              Deprecate ap_cache_cacheable_hdrs_out and add two
158  *                         generalized ap_cache_cacheable_headers_(in|out).
159  * 20080528.0 (2.3.0-dev)  Switch order of ftp_directory_charset and
160  *                         interpolate_env in proxy_dir_conf.
161  *                         Rationale: see r661069.
162  * 20080528.1 (2.3.0-dev)  add has_realm_hash() to authn_provider struct
163  * 20080722.0 (2.3.0-dev)  remove has_realm_hash() from authn_provider struct
164  * 20080722.1 (2.3.0-dev)  Add conn_timeout and conn_timeout_set to
165  *                         proxy_worker struct.
166  * 20080722.2 (2.3.0-dev)  Add scolonsep to proxy_balancer
167  * 20080829.0 (2.3.0-dev)  Add cookie attributes when removing cookies
168  * 20080830.0 (2.3.0-dev)  Cookies can be set on headers_out and err_headers_out
169  * 20080920.0 (2.3.0-dev)  Add ap_mpm_register_timed_callback.
170  * 20080920.1 (2.3.0-dev)  Export mod_rewrite.h in the public API.
171  * 20080920.2 (2.3.0-dev)  Added ap_timeout_parameter_parse to util.c / httpd.h
172  * 20081101.0 (2.3.0-dev)  Remove unused AUTHZ_GROUP_NOTE define.
173  * 20081102.0 (2.3.0-dev)  Remove authz_provider_list, authz_request_state,
174  *                         and AUTHZ_ACCESS_PASSED_NOTE.
175  * 20081104.0 (2.3.0-dev)  Remove r and need_flush fields from proxy_conn_rec
176  *                         as they are no longer used and add
177  *                         ap_proxy_buckets_lifetime_transform to mod_proxy.h
178  * 20081129.0 (2.3.0-dev)  Move AP_FILTER_ERROR and AP_NOBODY_READ|WROTE
179  *                         from util_filter.h to httpd.h and change their
180  *                         numeric values so they do not overlap with other
181  *                         potential status codes
182  * 20081201.0 (2.3.0-dev)  Rename several APIs to include ap_ prefix.
183  * 20081201.1 (2.3.0-dev)  Added ap_args_to_table and ap_body_to_table.
184  * 20081212.0 (2.3.0-dev)  Remove sb_type from process_score in scoreboard.h.
185  * 20081231.0 (2.3.0-dev)  Switch ap_escape_html API: add ap_escape_html2,
186  *                         and make ap_escape_html a macro for it.
187  * 20090130.0 (2.3.2-dev)  Add ap_ prefix to unixd_setup_child().
188  * 20090131.0 (2.3.2-dev)  Remove ap_default_type(), disable DefaultType
189  * 20090208.0 (2.3.2-dev)  Add conn_rec::current_thread.
190  * 20090208.1 (2.3.3-dev)  Add ap_retained_data_create()/ap_retained_data_get()
191  * 20090401.0 (2.3.3-dev)  Remove ap_threads_per_child, ap_max_daemons_limit,
192  *                         ap_my_generation, etc.  ap_mpm_query() can't be called
193  *                         until after the register-hooks phase.
194  * 20090401.1 (2.3.3-dev)  Protected log.c internals, http_log.h changes
195  * 20090401.2 (2.3.3-dev)  Added tmp_flush_bb to core_output_filter_ctx_t
196  * 20090401.3 (2.3.3-dev)  Added DAV options provider to mod_dav.h
197  * 20090925.0 (2.3.3-dev)  Added server_rec::context and added *server_rec
198  *                         param to ap_wait_or_timeout()
199  * 20090925.1 (2.3.3-dev)  Add optional function ap_logio_get_last_bytes() to
200  *                         mod_logio
201  * 20091011.0 (2.3.3-dev)  Move preserve_host{,_set} from proxy_server_conf to
202  *                         proxy_dir_conf
203  * 20091011.1 (2.3.3-dev)  add debug_level to util_ldap_state_t
204  * 20091031.0 (2.3.3-dev)  remove public LDAP referral-related macros
205  * 20091119.0 (2.3.4-dev)  dav_error interface uses apr_status_t parm, not errno
206  * 20091119.1 (2.3.4-dev)  ap_mutex_register(), ap_{proc,global}_mutex_create()
207  * 20091229.0 (2.3.5-dev)  Move allowed_connect_ports from proxy_server_conf
208  *                         to mod_proxy_connect
209  * 20091230.0 (2.3.5-dev)  Move ftp_directory_charset from proxy_dir_conf
210  *                         to proxy_ftp_dir_conf(mod_proxy_ftp)
211  * 20091230.1 (2.3.5-dev)  add util_ldap_state_t.opTimeout
212  * 20091230.2 (2.3.5-dev)  add ap_get_server_name_for_url()
213  * 20091230.3 (2.3.6-dev)  add ap_parse_log_level()
214  * 20091230.4 (2.3.6-dev)  export ap_process_request_after_handler() for mod_serf
215  * 20100208.0 (2.3.6-dev)  ap_socache_provider_t API changes to store and iterate
216  * 20100208.1 (2.3.6-dev)  Added forward member to proxy_conn_rec
217  * 20100208.2 (2.3.6-dev)  Added ap_log_command_line().
218  * 20100223.0 (2.3.6-dev)  LDAP client_certs per-server moved to per-dir
219  * 20100223.1 (2.3.6-dev)  Added ap_process_fnmatch_configs().
220  * 20100504.0 (2.3.6-dev)  Added name arg to ap_{proc,global}_mutex_create().
221  * 20100604.0 (2.3.6-dev)  Remove unused core_dir_config::loglevel
222  * 20100606.0 (2.3.6-dev)  Make ap_log_*error macro wrappers around
223  *                         ap_log_*error_ to save argument preparation and
224  *                         function call overhead.
225  *                         Introduce per-module loglevels, including new APIs
226  *                         APLOG_USE_MODULE() and AP_DECLARE_MODULE().
227  * 20100606.1 (2.3.6-dev)  Added extended timestamp formatting via
228  *                         ap_recent_ctime_ex().
229  * 20100609.0 (2.3.6-dev)  Dropped ap_body_to_table due to missing constraints.
230  * 20100609.1 (2.3.7-dev)  Introduce ap_log_cserror()
231  * 20100609.2 (2.3.7-dev)  Add deferred write pool to core_output_filter_ctx
232  * 20100625.0 (2.3.7-dev)  Add 'userctx' to socache iterator callback prototype
233  * 20100630.0 (2.3.7-dev)  make module_levels vector of char instead of int
234  * 20100701.0 (2.3.7-dev)  re-order struct members to improve alignment
235  * 20100701.1 (2.3.7-dev)  add note_auth_failure hook
236  * 20100701.2 (2.3.7-dev)  add ap_proxy_*_wid() functions
237  * 20100714.0 (2.3.7-dev)  add access_checker_ex hook, add AUTHZ_DENIED_NO_USER
238  *                         to authz_status, call authz providers twice to allow
239  *                         authz without authenticated user
240  * 20100719.0 (2.3.7-dev)  Add symbol name parameter to ap_add_module and
241  *                         ap_add_loaded_module. Add ap_find_module_short_name
242  * 20100723.0 (2.3.7-dev)  Remove ct_output_filters from core rec
243  * 20100723.1 (2.3.7-dev)  Added ap_proxy_hashfunc() and hash elements to
244  *                         proxy worker structs
245  * 20100723.2 (2.3.7-dev)  Add ap_request_has_body()
246  * 20100723.3 (2.3.8-dev)  Add ap_check_mpm()
247  * 20100905.0 (2.3.9-dev)  Add log_id to conn and req recs. Add error log
248  *                         format handlers. Support AP_CTIME_OPTION_COMPACT in
249  *                         ap_recent_ctime_ex().
250  * 20100905.1 (2.3.9-dev)  Add ap_cache_check_allowed()
251  * 20100912.0 (2.3.9-dev)  Add an additional "out" brigade parameter to the
252  *                         mod_cache store_body() provider function.
253  * 20100916.0 (2.3.9-dev)  Add commit_entity() to the mod_cache provider
254  *                         interface.
255  * 20100918.0 (2.3.9-dev)  Move the request_rec within mod_include to be
256  *                         exposed within include_ctx_t.
257  * 20100919.0 (2.3.9-dev)  Authz providers: Add parsed_require_line parameter
258  *                         to check_authorization() function. Add
259  *                         parse_require_line() function.
260  * 20100919.1 (2.3.9-dev)  Introduce ap_rxplus util/API
261  * 20100921.0 (2.3.9-dev)  Add an apr_bucket_brigade to the create_entity
262  *                         provider interface for mod_cache.h.
263  * 20100922.0 (2.3.9-dev)  Move cache_* functions from mod_cache.h to a
264  *                         private header file.
265  * 20100923.0 (2.3.9-dev)  Remove MOD_CACHE_REQUEST_REC, remove deprecated
266  *                         ap_cache_cacheable_hdrs_out, trim cache_object_t,
267  *                         make ap_cache_accept_headers, ap_cache_accept_headers
268  *                         ap_cache_try_lock, ap_cache_check_freshness,
269  *                         cache_server_conf, cache_enable, cache_disable,
270  *                         cache_request_rec and cache_provider_list private.
271  * 20100923.1 (2.3.9-dev)  Add cache_status hook.
272  * 20100923.2 (2.3.9-dev)  Add generate_log_id hook.
273  *                         Make root parameter of ap_expr_eval() const.
274  * 20100923.3 (2.3.9-dev)  Add "last" member to ap_directive_t
275  * 20101012.0 (2.3.9-dev)  Add header to cache_status hook.
276  * 20101016.0 (2.3.9-dev)  Remove ap_cache_check_allowed().
277  * 20101017.0 (2.3.9-dev)  Make ap_cache_control() public, add cache_control_t
278  *                         to mod_disk_cache format.
279  * 20101106.0 (2.3.9-dev)  Replace the ap_expr parser derived from
280  *                         mod_include's parser with one derived from
281  *                         mod_ssl's parser. Clean up ap_expr's public
282  *                         interface.
283  * 20101106.1 (2.3.9-dev)  Add ap_pool_cleanup_set_null() generic cleanup
284  * 20101106.2 (2.3.9-dev)  Add suexec_disabled_reason field to ap_unixd_config
285  * 20101113.0 (2.3.9-dev)  Add source address to mod_proxy.h
286  * 20101113.1 (2.3.9-dev)  Add ap_set_flag_slot_char()
287  * 20101113.2 (2.3.9-dev)  Add ap_expr_exec_re()
288  * 20101204.0 (2.3.10-dev) Add _t to ap_expr's typedef names
289  * 20101223.0 (2.3.11-dev) Remove cleaned from proxy_conn_rec.
290  * 20101223.1 (2.3.11-dev) Rework mod_proxy, et.al. Remove proxy_worker_stat
291  *                         and replace w/ proxy_worker_shared; remove worker
292  *                         info from scoreboard and use slotmem; Allow
293  *                         dynamic growth of balancer members; Remove
294  *                         BalancerNonce in favor of 'nonce' parameter.
295  * 20110117.0 (2.3.11-dev) Merge <If> sections in separate step (ap_if_walk).
296  *                         Add core_dir_config->sec_if. Add ap_add_if_conf().
297  *                         Add pool argument to ap_add_file_conf().
298  * 20110117.1 (2.3.11-dev) Add ap_pstr2_alnum() and ap_str2_alnum()
299  * 20110203.0 (2.3.11-dev) Raise DYNAMIC_MODULE_LIMIT to 256
300  * 20110203.1 (2.3.11-dev) Add ap_state_query()
301  * 20110203.2 (2.3.11-dev) Add ap_run_pre_read_request() hook and
302  *                         ap_parse_form_data() util
303  * 20110312.0 (2.3.12-dev) remove uldap_connection_cleanup and add
304                            util_ldap_state_t.connectionPoolTTL,
305                            util_ldap_connection_t.freed, and
306                            util_ldap_connection_t.rebind_pool.
307  * 20110312.1 (2.3.12-dev) Add core_dir_config.decode_encoded_slashes.
308  * 20110328.0 (2.3.12-dev) change type and name of connectionPoolTTL in util_ldap_state_t
309                            connectionPoolTTL (connection_pool_ttl, int->apr_interval_t)
310  * 20110329.0 (2.3.12-dev) Change single-bit signed fields to unsigned in
311  *                         proxy and cache interfaces.
312  *                         Change ap_configfile_t/ap_cfg_getline()/
313  *                         ap_cfg_getc() API, add ap_pcfg_strerror()
314  *                         Axe mpm_note_child_killed hook, change
315  *                         ap_reclaim_child_process and ap_recover_child_process
316  *                         interfaces.
317  * 20110329.1 (2.3.12-dev) Add ap_reserve_module_slots()/ap_reserve_module_slots_directive()
318  *                         change AP_CORE_DECLARE to AP_DECLARE: ap_create_request_config()
319  *                         change AP_DECLARE to AP_CORE_DECLARE: ap_register_log_hooks()
320  * 20110329.2 (2.3.12-dev) Add child_status and end_generation hooks.
321  * 20110329.3 (2.3.12-dev) Add format field to ap_errorlog_info.
322  * 20110329.4 (2.3.13-dev) bgrowth and max_balancers to proxy_server_conf.
323  * 20110329.5 (2.3.13-dev) Add ap_regexec_len()
324  * 20110329.6 (2.3.13-dev) Add AP_EXPR_FLAGS_RESTRICTED, ap_expr_eval_ctx_t->data,
325  *                         ap_expr_exec_ctx()
326  * 20110604.0 (2.3.13-dev) Make ap_rputs() inline
327  * 20110605.0 (2.3.13-dev) add core_dir_config->condition_ifelse, change return
328  *                         type of ap_add_if_conf().
329  *                         Add members of core_request_config: document_root,
330  *                         context_document_root, context_prefix.
331  *                         Add ap_context_*(), ap_set_context_info(), ap_set_document_root()
332  * 20110605.1 (2.3.13-dev) add ap_(get|set)_core_module_config()
333  * 20110605.2 (2.3.13-dev) add ap_get_conn_socket()
334  * 20110619.0 (2.3.13-dev) add async connection infos to process_score in scoreboard,
335  *                         add ap_start_lingering_close(),
336  *                         add conn_state_e:CONN_STATE_LINGER_NORMAL and CONN_STATE_LINGER_SHORT
337  * 20110619.1 (2.3.13-dev) add ap_str_toupper()
338  * 20110702.0 (2.3.14-dev) make ap_expr_parse_cmd() macro wrapper for new
339  *                         ap_expr_parse_cmd_mi() function, add ap_expr_str_*() functions,
340  *                         rename AP_EXPR_FLAGS_* -> AP_EXPR_FLAG_*
341  * 20110702.1 (2.3.14-dev) Add ap_scan_script_header_err*_ex functions
342  * 20110723.0 (2.3.14-dev) Revert addition of ap_ldap*
343  * 20110724.0 (2.3.14-dev) Add override_list as parameter to ap_parse_htaccess
344  *                         Add member override_list to cmd_parms_struct,
345  *                         core_dir_config and htaccess_result
346  * 20110724.1 (2.3.15-dev) add NOT_IN_HTACCESS
347  * 20110724.2 (2.3.15-dev) retries and retry_delay in util_ldap_state_t
348  * 20110724.3 (2.3.15-dev) add util_varbuf.h / ap_varbuf API
349  * 20110724.4 (2.3.15-dev) add max_ranges to core_dir_config
350  * 20110724.5 (2.3.15-dev) add ap_set_accept_ranges()
351  * 20110724.6 (2.3.15-dev) add max_overlaps and max_reversals to core_dir_config
352  * 20110724.7 (2.3.15-dev) add ap_random_insecure_bytes(), ap_random_pick()
353  * 20110724.8 (2.3.15-dev) add ap_abort_on_oom(), ap_malloc(), ap_calloc(),
354  *                         ap_realloc()
355  * 20110724.9 (2.3.15-dev) add ap_varbuf_pdup() and ap_varbuf_regsub()
356  * 20110724.10(2.3.15-dev) Export ap_max_mem_free
357  * 20111009.0 (2.3.15-dev) Remove ap_proxy_removestr(),
358  *                         add ap_unixd_config.group_name
359  * 20111014.0 (2.3.15-dev) Remove cookie_path_str and cookie_domain_str from
360  *                         proxy_dir_conf
361  * 20111025.0 (2.3.15-dev) Add return value and maxlen to ap_varbuf_regsub(),
362  *                         add ap_pregsub_ex()
363  * 20111025.1 (2.3.15-dev) Add ap_escape_urlencoded(), ap_escape_urlencoded_buffer()
364  *                         and ap_unescape_urlencoded().
365  * 20111025.2 (2.3.15-dev) Add ap_lua_ssl_val to mod_lua
366  * 20111118.0 (2.5.0-dev)  Add conn_rec to error_log hook
367  * 20111118.1 (2.5.0-dev)  Add reclvl to ap_expr_eval_ctx_t
368  * 20111120.0 (2.5.0-dev)  Remove parts of conn_state_t that are private to the MPM
369  * 20111121.0 (2.5.0-dev)  Pass ap_errorlog_info struct to error_log hook,
370  *                         add pool to ap_errorlog_info.
371  * 20111125.0 (2.5.0-dev)  c->remote_ip becomes c->peer_ip and r->client_ip,
372  *                         c->remote_addr becomes c->peer_addr and r->client_addr
373  * 20111201.0 (2.5.0-dev)  Add invalidate_entity() to the cache provider.
374  * 20111202.0 (2.5.0-dev)  Use apr_status_t across mod_session API.
375  * 20111202.1 (2.5.0-dev)  add APLOGNO()
376  * 20111203.0 (2.5.0-dev)  Optional ap_proxy_retry_worker(), remove
377  *                         ap_proxy_string_read(), ap_cache_liststr(),
378  *                         ap_proxy_buckets_lifetime_transform(),
379  *                         ap_proxy_date_canon(), ap_proxy_is_ipaddr(),
380  *                         ap_proxy_is_domainname(), ap_proxy_is_hostname(),
381  *                         ap_proxy_is_word(), ap_proxy_hex2sec(),
382  *                         ap_proxy_sec2hex(), ap_proxy_make_fake_req(),
383  *                         ap_proxy_strmatch_path, ap_proxy_strmatch_domain,
384  *                         ap_proxy_table_unmerge(), proxy_lb_workers.
385  * 20111203.1 (2.5.0-dev)  Add ap_list_provider_groups()
386  * 20120109.0 (2.5.0-dev)  Changes sizeof(overrides_t) in core config.
387  * 20120111.0 (2.5.0-dev)  Remove sb_type from global_score.
388  * 20120123.0 (2.5.0-dev)  Make core_output_filter_ctx_t and core_ctx_t
389  *                         private, add ap_create_core_ctx(),
390  *                         ap_core_ctx_get_bb(), move core_net rec definition
391  *                         to http_core.h
392  * 20120201.0 (2.5.0-dev)  Bump MODULE_MAGIC_COOKIE to "AP25"!
393  * 20120204.0 (2.5.0-dev)  Remove ap_create_core_ctx(), ap_core_ctx_get_bb();
394  *                         add insert_network_bucket hook, AP_DECLINED
395  * 20120211.0 (2.5.0-dev)  Change re_nsub in ap_regex_t from apr_size_t to int.
396  * 20120211.1 (2.5.0-dev)  Add ap_palloc_debug, ap_pcalloc_debug
397  * 20120211.2 (2.5.0-dev)  Add ap_runtime_dir_relative
398  * 20120211.3 (2.5.0-dev)  Add forcerecovery to proxy_balancer_shared struct
399  * 20120211.4 (2.5.0-dev)  Add missing HTTP status codes registered with IANA.
400  * 20120724.0 (2.5.0-dev)  Add hostname argument to ap_proxy_checkproxyblock.
401  * 20120724.1 (2.5.0-dev)  Add post_perdir_config hook.
402  * 20120724.2 (2.5.0-dev)  Add fgrab slotmem function to struct
403  * 20120724.3 (2.5.0-dev)  Add bal_persist, inherit to proxy_server_conf
404  * 20120724.4 (2.5.0-dev)  Add dirwalk_stat hook.
405  * 20120724.5 (2.5.0-dev)  Add ap_get_sload() and ap_get_loadavg().
406  * 20120724.6 (2.5.0-dev)  Add sticky_separator to proxy_balancer_shared struct.
407  * 20120724.7 (2.5.0-dev)  Add min_http_version/max_http_version to
408  *                         core_server_config
409  * 20120724.8 (2.5.0-dev)  Add conn_log_level to core_server_config
410  * 20120724.9 (2.5.0-dev)  Add ap_bin2hex()
411  * 20121222.0 (2.5.0-dev)  Remove min_http_version/max_http_version from
412  *                         core_server_config again, add http09_enable
413  * 20121222.1 (2.5.0-dev)  Add http_conformance to core_server_config,
414  *                         add ap_has_cntrl()
415  * 20121222.2 (2.5.0-dev)  Add ap_password_validate()
416  * 20121222.3 (2.5.0-dev)  Add ppinherit to proxy_server_conf
417  * 20121222.4 (2.5.0-dev)  Add uds_path to proxy_conn_rec
418  * 20121222.5 (2.5.0-dev)  Add "r" and "must_rebind" to util_ldap_connection_t
419  * 20121222.6 (2.5.0-dev)  Add ap_proxy_create_hdrbrgd() and
420  *                         ap_proxy_pass_brigade()
421  * 20121222.7 (2.5.0-dev)  Add ap_remove_input|output_filter_byhandle()
422  * 20121222.8 (2.5.0-dev)  Add dav_join_error()
423  * 20121222.9 (2.5.0-dev)  Add conn_sense_e
424  * 20121222.10 (2.5.0-dev) Add cache_control_t.invalidated
425  * 20121222.11 (2.5.0-dev) Add ap_find_etag_weak(), ap_find_etag_strong()
426  * 20121222.12 (2.5.0-dev) Add ap_condition_e, ap_condition_if_match(),
427  *                         ap_condition_if_unmodified_since(),
428  *                         ap_condition_if_none_match(),
429  *                         ap_condition_if_modified_since(),
430  *                         ap_condition_if_range()
431  * 20121222.13 (2.5.0-dev) Add ap_proxy_clear_connection()
432  * 20121222.14 (2.5.0-dev) Add ap_map_http_request_error()
433  * 20121222.15 (2.5.0-dev) Add allow/decode_encoded_slashes_set to core_dir_config
434  * 20121222.16 (2.5.0-dev) AP_DEFAULT_HANDLER_NAME/AP_IS_DEFAULT_HANDLER_NAME
435  * 20130702.0 (2.5.0-dev)  Remove pre_htaccess hook, add open_htaccess hook.
436  * 20130702.1 (2.5.0-dev)  Restore AUTH_HANDLED to mod_auth.h
437  * 20130702.2 (2.5.0-dev)  Add ap_log_data(), ap_log_rdata(), etc.
438  * 20130702.3 (2.5.0-dev)  Add util_fcgi.h, FastCGI protocol support
439  * 20130903.0 (2.5.0-dev)  Changes sizeof(worker_score) in scoreboard 
440  * 20130924.0 (2.5.0-dev)  Add ap_errorlog_provider
441  * 20130924.1 (2.5.0-dev)  Add ap_proxy_connection_reusable()
442  * 20131112.0 (2.5.0-dev)  Add parse_errorlog_arg to ap_errorlog_provider
443  * 20131112.1 (2.5.0-dev)  Add suspend_connection and resume_connection hooks
444  * 20131112.2 (2.5.0-dev)  Add ap_regname
445  * 20131230.0 (2.5.0-dev)  cl_head_zero & expect_strict added to server_config
446  * 20131230.1 (2.5.0-dev)  REWRITE_REDIRECT_HANDLER_NAME in mod_rewrite.h
447  * 20131230.2 (2.5.0-dev)  Prefix REWRITE_REDIRECT_HANDLER_NAME in mod_rewrite.h
448  * 20140207.0 (2.5.0-dev)  Support for slaved connections in core.c
449  * 20140207.1 (2.5.0-dev)  Add SSL reusable SNI to mod_proxy.h's proxy_conn_rec
450  * 20140207.2 (2.5.0-dev)  Add proxy detach_backend hook
451  * 20140207.3 (2.5.0-dev)  Add mod_ssl_openssl.h and OpenSSL-specific hooks
452  * 20140207.4 (2.5.0-dev)  add ap_mpm_register_socket_callback_timeout
453  * 20140207.5 (2.5.0-dev)  Add ap_mpm_resume_suspended(), AP_MPMQ_CAN_SUSPEND to
454  *                         ap_mpm_query(), and suspended_baton to conn_rec
455  * 20140207.6 (2.5.0-dev)  Added ap_log_mpm_common().
456  * 20140207.7 (2.5.0-dev)  Added ap_force_set_tz().
457  * 20140207.8 (2.5.0-dev)  Added ap_shutdown_conn().
458  * 20140611.0 (2.5.0-dev)  Add ap_mpm_socket_callback_fn_t.
459                            Changes 3rd argument's type of
460                            ap_mpm_register_socket_callback and 
461                            ap_mpm_register_socket_callback_timeout.
462  * 20140611.1 (2.5.0-dev)  Add ap_proxy_connect_uds().
463  * 20140627.0 (2.5.0-dev)  Revert 20140611.0 change.
464  * 20140627.1 (2.5.0-dev)  add last_backend_conn to util_ldap_connection_t
465  * 20140627.2 (2.5.0-dev)  Added is_name_matchable to proxy_worker_shared.
466                            Added ap_proxy_define_match_worker().
467  * 20140627.3 (2.5.0-dev)  Add ap_copy_scoreboard_worker()
468  * 20140627.4 (2.5.0-dev)  Added ap_parse_token_list_strict() to httpd.h.
469  * 20140627.5 (2.5.0-dev)  Add r->trailers_{in,out}
470  * 20140627.6 (2.5.0-dev)  Added ap_pcre_version_string(), AP_REG_PCRE_COMPILED
471  *                         and AP_REG_PCRE_LOADED to ap_regex.h.
472  * 20140627.7 (2.5.0-dev)  Add listener bucket in scoreboard.h's process_score.
473  * 20140627.8 (2.5.0-dev)  Add ap_set_listencbratio(), ap_close_listeners_ex(),
474  *                         ap_duplicate_listeners(), ap_num_listen_buckets and
475  *                         ap_have_so_reuseport to ap_listen.h.
476  * 20140627.9 (2.5.0-dev)  Add cgi_pass_auth and AP_CGI_PASS_AUTH_* to 
477  *                         core_dir_config
478  * 20140627.10 (2.5.0-dev) Add ap_proxy_de_socketfy to mod_proxy.h
479  * 20150121.0 (2.5.0-dev)  Revert field addition from core_dir_config; r1653666
480  * 20150121.1 (2.5.0-dev)  Add cmd_parms_struct.parent to http_config.h
481  * 20150121.2 (2.5.0-dev)  Add response_code_exprs to http_core.h
482  * 20150222.0 (2.5.0-dev)  ssl pre_handshake hook now indicates proxy|client
483  * 20150222.1 (2.5.0-dev)  Add keep_alive_timeout_set to server_rec
484  * 20150222.2 (2.5.0-dev)  Add response code 418 as per RFC2324/RFC7168
485  * 20150222.3 (2.5.0-dev)  Add ap_some_authn_required, ap_force_authn hook.
486  *                         Deprecate broken ap_some_auth_required.
487  * 20150222.4 (2.5.0-dev)  Add protocols and protocols_honor_order to
488  *                         core_server_config. Add hooks protocol_propose
489  *                         protocol_switch and protocol_get. Add
490  *                         ap_select_protocol(), ap_switch_protocol(),
491  *                         ap_get_protocol(). Add HTTP_MISDIRECTED_REQUEST.
492  * 20150222.5 (2.5.0-dev)  Add ap_request_core_filter(),
493  *                         ap_filter_setaside_brigade(),
494  *                         ap_filter_reinstate_brigade() and
495  *                         ap_filter_should_yield(). Add empty and filters to
496  *                         conn_rec.
497  * 20150222.6 (2.5.0-dev)  Add async_filter to conn_rec.
498  * 20150222.7 (2.5.0-dev)  Add ap_casecmpstr[n]();
499  * 20150222.8 (2.5.0-dev)  Add ap_getword_conf2[_nc]();
500  * 20150222.9 (2.5.0-dev)  Add expr_handler to core_dir_config.
501  * 20150222.10 (2.5.0-dev) Add new ap_update_child_status...() methods,
502  *                         add protocol to worker_score in scoreboard.h,
503  *                         Add pre_close connection hook and 
504  *                         ap_prep_lingering_close().
505  * 20150222.11 (2.5.0-dev) Split useragent_host from the conn_rec into
506  *                         the request_rec, with ap_get_useragent_host()
507  * 20150222.12 (2.5.0-dev) Add complete_connection hook,
508  *                         ap_filter_complete_connection().
509  * 20150222.13 (2.5.0-dev) Add ap_create_request().
510  * 20160312.0 (2.5.0-dev)  Rename complete_connection to output_pending,
511  *                         add ap_filter_input_pending(),
512  *                         ap_filter_prepare_brigade(), ap_filter_direction_e
513  * 20160312.1 (2.5.0-dev)  Add cgi_var_rules to core_dir_config.
514  * 20160315.0 (2.5.0-dev)  Rename ap_mpm_register_socket_callback,
515  *                         ap_mpm_register_socket_callback_timeout and
516  *                         ap_mpm_unregister_socket_callback to
517  *                         ap_mpm_register_poll_callback,
518  *                         ap_mpm_register_poll_callback_timeout and
519  *                         ap_mpm_unregister_poll_callback. Add
520  *                         AP_MPMQ_CAN_POLL.
521  * 20160315.1 (2.5.0-dev)  Add AP_IMPLEMENT_OPTIONAL_HOOK_RUN_FIRST.
522  * 20160315.2 (2.5.0-dev)  Add optional proxy_{hook,run}_section_post_config(),
523  *                         ap_proxy_connection_create_ex() and section_config
524  *                         to struct proxy_{worker,balancer} in mod_proxy.h,
525  *                         and optional ssl_engine_set() to mod_ssl.h.
526  * 20160315.3 (2.5.0-dev)  Add childtags to dav_error.
527  * 20160608.1 (2.5.0-dev)  Rename ap_casecmpstr[n]() to ap_cstr_casecmp[n]()
528  * 20160608.2 (2.5.0-dev)  Add dav_get_provider_name.
529  * 20160608.3 (2.5.0-dev)  Add dav_begin_multistatus, dav_send_one_response,
530  *                         dav_finish_multistatus, dav_send_multistatus,
531  *                         dav_handle_err, dav_failed_proppatch,
532  *                         dav_success_proppatch.
533  * 20160608.4 (2.5.0-dev)  Add dav_acl_provider, dav_acl_provider_register
534  *                         dav_get_acl_providers.
535  * 20160608.5 (2.5.0-dev)  Add ap_proxy_check_backend(), and tmp_bb to
536  *                         struct proxy_conn_rec.
537  * 20160608.6 (2.5.0-dev)  Add ap_scan_http_field_content, ap_scan_http_token
538  *                         and ap_get_http_token
539  * 20160608.7 (2.5.0-dev)  Add ap_check_pipeline().
540  * 20160608.8 (2.5.0-dev)  Rename ap_proxy_check_backend() to
541  *                         ap_proxy_check_connection().
542  * 20160608.9 (2.5.0-dev)  Renamed AP_HTTP_CONFORMANCE_LIBERAL to 
543  *                         AP_HTTP_CONFORMANCE_UNSAFE, and
544  *                         eliminated AP_HTTP_CONFORMANCE_LOGONLY
545  * 20160617.1 (2.5.0-dev)  Added http_whitespace and http_methods to
546  *                         core_server_config
547  * 20160629.1 (2.5.0-dev)  Dropped http_whitespace from core_server_config
548  * 20160629.2 (2.5.0-dev)  Replaced fold w/multiple flags for ap_[r]getline()
549  * 20161018.1 (2.5.0-dev)  Dropped ap_has_cntrls(), ap_scan_http_uri_safe(),
550  *                         ap_get_http_token() and http_stricturi conf member.
551  *                         Added ap_scan_vchar_obstext()
552  * 20161018.2 (2.5.0-dev)  add ap_set_conn_count()
553  * 20161018.3 (2.5.0-dev)  add ap_exists_directive()
554  * 20161018.4 (2.5.0-dev)  Add taint to request_rec and ap_request_tainted()
555  */
556
557 #define MODULE_MAGIC_COOKIE 0x41503235UL /* "AP25" */
558
559 #ifndef MODULE_MAGIC_NUMBER_MAJOR
560 #define MODULE_MAGIC_NUMBER_MAJOR 20161018
561 #endif
562 #define MODULE_MAGIC_NUMBER_MINOR 4                 /* 0...n */
563
564 /**
565  * Determine if the server's current MODULE_MAGIC_NUMBER is at least a
566  * specified value.
567  *
568  * Useful for testing for features.
569  * For example, suppose you wish to use the apr_table_overlap
570  *    function.  You can do this:
571  *
572  * \code
573  * #if AP_MODULE_MAGIC_AT_LEAST(19980812,2)
574  *     ... use apr_table_overlap()
575  * #else
576  *     ... alternative code which doesn't use apr_table_overlap()
577  * #endif
578  * \endcode
579  *
580  * @param   major   The major module magic number.
581  * @param   minor   The minor module magic number.
582  */
583 #define AP_MODULE_MAGIC_AT_LEAST(major,minor)           \
584     ((major) < MODULE_MAGIC_NUMBER_MAJOR                \
585      || ((major) == MODULE_MAGIC_NUMBER_MAJOR           \
586          && (minor) <= MODULE_MAGIC_NUMBER_MINOR))
587
588 /** @deprecated Present for backwards compatibility. */
589 #define MODULE_MAGIC_NUMBER MODULE_MAGIC_NUMBER_MAJOR
590 /** @deprecated Use AP_MODULE_MAGIC_AT_LEAST. */
591 #define MODULE_MAGIC_AT_LEAST old_broken_macro_we_hope_you_are_not_using
592
593 #endif /* !APACHE_AP_MMN_H */
594 /** @} */