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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file http_request.h
19 * @brief Apache Request library
21 * @defgroup APACHE_CORE_REQ Apache Request Processing
22 * @ingroup APACHE_CORE
27 * request.c is the code which handles the main line of request
28 * processing, once a request has been read in (finding the right per-
29 * directory configuration, building it if necessary, and calling all
30 * the module dispatch functions in the right order).
32 * The pieces here which are public to the modules, allow them to learn
33 * how the server would handle some other file or URI, or perhaps even
34 * direct the server to serve that other file instead of the one the
35 * client requested directly.
37 * There are two ways to do that. The first is the sub_request mechanism,
38 * which handles looking up files and URIs as adjuncts to some other
39 * request (e.g., directory entries for multiviews and directory listings);
40 * the lookup functions stop short of actually running the request, but
41 * (e.g., for includes), a module may call for the request to be run
42 * by calling run_sub_req. The space allocated to create sub_reqs can be
43 * reclaimed by calling destroy_sub_req --- be sure to copy anything you care
44 * about which was allocated in its apr_pool_t elsewhere before doing this.
47 #ifndef APACHE_HTTP_REQUEST_H
48 #define APACHE_HTTP_REQUEST_H
50 #include "apr_optional.h"
51 #include "util_filter.h"
57 #define AP_SUBREQ_NO_ARGS 0
58 #define AP_SUBREQ_MERGE_ARGS 1
61 * An internal handler used by the ap_process_request, all subrequest mechanisms
62 * and the redirect mechanism.
63 * @param r The request, subrequest or internal redirect to pre-process
64 * @return The return code for the request
66 AP_DECLARE(int) ap_process_request_internal(request_rec *r);
69 * Create a subrequest from the given URI. This subrequest can be
70 * inspected to find information about the requested URI
71 * @param new_uri The URI to lookup
72 * @param r The current request
73 * @param next_filter The first filter the sub_request should use. If this is
74 * NULL, it defaults to the first filter for the main request
75 * @return The new request record
77 AP_DECLARE(request_rec *) ap_sub_req_lookup_uri(const char *new_uri,
79 ap_filter_t *next_filter);
82 * Create a subrequest for the given file. This subrequest can be
83 * inspected to find information about the requested file
84 * @param new_file The file to lookup
85 * @param r The current request
86 * @param next_filter The first filter the sub_request should use. If this is
87 * NULL, it defaults to the first filter for the main request
88 * @return The new request record
90 AP_DECLARE(request_rec *) ap_sub_req_lookup_file(const char *new_file,
92 ap_filter_t *next_filter);
94 * Create a subrequest for the given apr_dir_read result. This subrequest
95 * can be inspected to find information about the requested file
96 * @param finfo The apr_dir_read result to lookup
97 * @param r The current request
98 * @param subtype What type of subrequest to perform, one of;
100 * AP_SUBREQ_NO_ARGS ignore r->args and r->path_info
101 * AP_SUBREQ_MERGE_ARGS merge r->args and r->path_info
103 * @param next_filter The first filter the sub_request should use. If this is
104 * NULL, it defaults to the first filter for the main request
105 * @return The new request record
106 * @note The apr_dir_read flags value APR_FINFO_MIN|APR_FINFO_NAME flag is the
107 * minimum recommended query if the results will be passed to apr_dir_read.
108 * The file info passed must include the name, and must have the same relative
109 * directory as the current request.
111 AP_DECLARE(request_rec *) ap_sub_req_lookup_dirent(const apr_finfo_t *finfo,
112 const request_rec *r,
114 ap_filter_t *next_filter);
116 * Create a subrequest for the given URI using a specific method. This
117 * subrequest can be inspected to find information about the requested URI
118 * @param method The method to use in the new subrequest
119 * @param new_uri The URI to lookup
120 * @param r The current request
121 * @param next_filter The first filter the sub_request should use. If this is
122 * NULL, it defaults to the first filter for the main request
123 * @return The new request record
125 AP_DECLARE(request_rec *) ap_sub_req_method_uri(const char *method,
127 const request_rec *r,
128 ap_filter_t *next_filter);
130 * An output filter to strip EOS buckets from sub-requests. This always
131 * has to be inserted at the end of a sub-requests filter stack.
132 * @param f The current filter
133 * @param bb The brigade to filter
134 * @return status code
136 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_sub_req_output_filter(ap_filter_t *f,
137 apr_bucket_brigade *bb);
140 * Run the handler for the subrequest
141 * @param r The subrequest to run
142 * @return The return code for the subrequest
144 AP_DECLARE(int) ap_run_sub_req(request_rec *r);
147 * Free the memory associated with a subrequest
148 * @param r The subrequest to finish
150 AP_DECLARE(void) ap_destroy_sub_req(request_rec *r);
153 * Then there's the case that you want some other request to be served
154 * as the top-level request INSTEAD of what the client requested directly.
155 * If so, call this from a handler, and then immediately return OK.
159 * Redirect the current request to some other uri
160 * @param new_uri The URI to replace the current request with
161 * @param r The current request
163 AP_DECLARE(void) ap_internal_redirect(const char *new_uri, request_rec *r);
166 * This function is designed for things like actions or CGI scripts, when
167 * using AddHandler, and you want to preserve the content type across
168 * an internal redirect.
169 * @param new_uri The URI to replace the current request with.
170 * @param r The current request
172 AP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r);
175 * Redirect the current request to a sub_req, merging the pools
176 * @param sub_req A subrequest created from this request
177 * @param r The current request
178 * @note the sub_req's pool will be merged into r's pool, be very careful
179 * not to destroy this subrequest, it will be destroyed with the main request!
181 AP_DECLARE(void) ap_internal_fast_redirect(request_rec *sub_req, request_rec *r);
184 * Can be used within any handler to determine if any authentication
185 * is required for the current request
186 * @param r The current request
187 * @return 1 if authentication is required, 0 otherwise
188 * @bug Behavior changed in 2.4.x refactoring, API no longer usable
189 * @deprecated @see ap_some_authn_required()
191 AP_DECLARE(int) ap_some_auth_required(request_rec *r);
194 * @defgroup APACHE_CORE_REQ_AUTH Access Control for Sub-Requests and
196 * @ingroup APACHE_CORE_REQ
200 #define AP_AUTH_INTERNAL_PER_URI 0 /**< Run access control hooks on all
201 internal requests with URIs
202 distinct from that of initial
204 #define AP_AUTH_INTERNAL_PER_CONF 1 /**< Run access control hooks only on
205 internal requests with
206 configurations distinct from
207 that of initial request */
208 #define AP_AUTH_INTERNAL_MASK 0x000F /**< mask to extract internal request
212 * Clear flag which determines when access control hooks will be run for
215 AP_DECLARE(void) ap_clear_auth_internal(void);
218 * Determine whether access control hooks will be run for all internal
219 * requests with URIs distinct from that of the initial request, or only
220 * those for which different configurations apply than those which applied
221 * to the initial request. To accommodate legacy external modules which
222 * may expect access control hooks to be run for all internal requests
223 * with distinct URIs, this is the default behaviour unless all access
224 * control hooks and authentication and authorization providers are
225 * registered with AP_AUTH_INTERNAL_PER_CONF.
226 * @param ptemp Pool used for temporary allocations
228 AP_DECLARE(void) ap_setup_auth_internal(apr_pool_t *ptemp);
231 * Register an authentication or authorization provider with the global
233 * @param pool The pool to create any storage from
234 * @param provider_group The group to store the provider in
235 * @param provider_name The name for this provider
236 * @param provider_version The version for this provider
237 * @param provider Opaque structure for this provider
238 * @param type Internal request processing mode, either
239 * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
240 * @return APR_SUCCESS if all went well
242 AP_DECLARE(apr_status_t) ap_register_auth_provider(apr_pool_t *pool,
243 const char *provider_group,
244 const char *provider_name,
245 const char *provider_version,
246 const void *provider,
251 /* Optional functions coming from mod_authn_core and mod_authz_core
252 * that list all registered authn/z providers.
254 APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, authn_ap_list_provider_names,
255 (apr_pool_t *ptemp));
256 APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, authz_ap_list_provider_names,
257 (apr_pool_t *ptemp));
260 * Determine if the current request is the main request or a subrequest
261 * @param r The current request
262 * @return 1 if this is the main request, 0 otherwise
264 AP_DECLARE(int) ap_is_initial_req(request_rec *r);
267 * Function to set the r->mtime field to the specified value if it's later
268 * than what's already there.
269 * @param r The current request
270 * @param dependency_mtime Time to set the mtime to
272 AP_DECLARE(void) ap_update_mtime(request_rec *r, apr_time_t dependency_mtime);
275 * Add one or more methods to the list permitted to access the resource.
276 * Usually executed by the content handler before the response header is
277 * sent, but sometimes invoked at an earlier phase if a module knows it
278 * can set the list authoritatively. Note that the methods are ADDED
279 * to any already permitted unless the reset flag is non-zero. The
280 * list is used to generate the Allow response header field when it
282 * @param r The pointer to the request identifying the resource.
283 * @param reset Boolean flag indicating whether this list should
284 * completely replace any current settings.
285 * @param ... A NULL-terminated list of strings, each identifying a
286 * method name to add.
289 AP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...)
293 * Add one or more methods to the list permitted to access the resource.
294 * Usually executed by the content handler before the response header is
295 * sent, but sometimes invoked at an earlier phase if a module knows it
296 * can set the list authoritatively. Note that the methods are ADDED
297 * to any already permitted unless the reset flag is non-zero. The
298 * list is used to generate the Allow response header field when it
300 * @param r The pointer to the request identifying the resource.
301 * @param reset Boolean flag indicating whether this list should
302 * completely replace any current settings.
303 * @param ... A list of method identifiers, from the "M_" series
304 * defined in httpd.h, terminated with a value of -1
305 * (e.g., "M_GET, M_POST, M_OPTIONS, -1")
308 AP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...);
310 #define MERGE_ALLOW 0
311 #define REPLACE_ALLOW 1
314 * Process a top-level request from a client, and synchronously write
315 * the response to the client
316 * @param r The current request
318 AP_DECLARE(void) ap_process_request(request_rec *r);
320 /* For post-processing after a handler has finished with a request.
321 * (Commonly used after it was suspended)
323 AP_DECLARE(void) ap_process_request_after_handler(request_rec *r);
326 * Process a top-level request from a client, allowing some or all of
327 * the response to remain buffered in the core output filter for later,
328 * asynchronous write completion
329 * @param r The current request
331 void ap_process_async_request(request_rec *r);
334 * Kill the current request
335 * @param type Why the request is dieing
336 * @param r The current request
338 AP_DECLARE(void) ap_die(int type, request_rec *r);
341 * Check whether a connection is still established and has data available,
342 * optionnaly consuming blank lines ([CR]LF).
343 * @param c The current connection
344 * @param bb The brigade to filter
345 * @param max_blank_lines Max number of blank lines to consume, or zero
346 * to consider them as data (single read).
347 * @return APR_SUCCESS: connection established with data available,
348 * APR_EAGAIN: connection established and empty,
349 * APR_NOTFOUND: too much blank lines,
350 * APR_E*: connection/general error.
352 AP_DECLARE(apr_status_t) ap_check_pipeline(conn_rec *c, apr_bucket_brigade *bb,
353 unsigned int max_blank_lines);
358 * Gives modules a chance to create their request_config entry when the
359 * request is created.
360 * @param r The current request
363 AP_DECLARE_HOOK(int,create_request,(request_rec *r))
366 * This hook allow modules an opportunity to translate the URI into an
367 * actual filename. If no modules do anything special, the server's default
368 * rules will be followed.
369 * @param r The current request
370 * @return OK, DECLINED, or HTTP_...
373 AP_DECLARE_HOOK(int,translate_name,(request_rec *r))
376 * This hook allow modules to set the per_dir_config based on their own
377 * context (such as "<Proxy>" sections) and responds to contextless requests
378 * such as TRACE that need no security or filesystem mapping.
379 * based on the filesystem.
380 * @param r The current request
381 * @return DONE (or HTTP_) if this contextless request was just fulfilled
382 * (such as TRACE), OK if this is not a file, and DECLINED if this is a file.
383 * The core map_to_storage (HOOK_RUN_REALLY_LAST) will directory_walk
384 * and file_walk the r->filename.
388 AP_DECLARE_HOOK(int,map_to_storage,(request_rec *r))
391 * This hook is used to analyze the request headers, authenticate the user,
392 * and set the user information in the request record (r->user and
393 * r->ap_auth_type). This hook is only run when Apache determines that
394 * authentication/authorization is required for this resource (as determined
395 * by the 'Require' directive). It runs after the access_checker hook, and
396 * before the auth_checker hook. This hook should be registered with
397 * ap_hook_check_authn().
399 * @param r The current request
400 * @return OK, DECLINED, or HTTP_...
402 * @see ap_hook_check_authn
404 AP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
407 * Allows modules to perform module-specific fixing of header fields. This
408 * is invoked just before any content-handler
409 * @param r The current request
410 * @return OK, DECLINED, or HTTP_...
413 AP_DECLARE_HOOK(int,fixups,(request_rec *r))
416 * This routine is called to determine and/or set the various document type
417 * information bits, like Content-type (via r->content_type), language, et
419 * @param r the current request
420 * @return OK, DECLINED, or HTTP_...
423 AP_DECLARE_HOOK(int,type_checker,(request_rec *r))
426 * This hook is used to apply additional access control to this resource.
427 * It runs *before* a user is authenticated, so this hook is really to
428 * apply additional restrictions independent of a user. It also runs
429 * independent of 'Require' directive usage. This hook should be registered
430 * with ap_hook_check_access().
432 * @param r the current request
433 * @return OK, DECLINED, or HTTP_...
435 * @see ap_hook_check_access
437 AP_DECLARE_HOOK(int,access_checker,(request_rec *r))
440 * This hook is used to apply additional access control and/or bypass
441 * authentication for this resource. It runs *before* a user is authenticated,
442 * but after the auth_checker hook.
443 * This hook should be registered with ap_hook_check_access_ex().
445 * @param r the current request
446 * @return OK (allow acces), DECLINED (let later modules decide),
447 * or HTTP_... (deny access)
449 * @see ap_hook_check_access_ex
451 AP_DECLARE_HOOK(int,access_checker_ex,(request_rec *r))
454 * This hook is used to check to see if the resource being requested
455 * is available for the authenticated user (r->user and r->ap_auth_type).
456 * It runs after the access_checker and check_user_id hooks. Note that
457 * it will *only* be called if Apache determines that access control has
458 * been applied to this resource (through a 'Require' directive). This
459 * hook should be registered with ap_hook_check_authz().
461 * @param r the current request
462 * @return OK, DECLINED, or HTTP_...
464 * @see ap_hook_check_authz
466 AP_DECLARE_HOOK(int,auth_checker,(request_rec *r))
469 * Register a hook function that will apply additional access control to
470 * the current request.
471 * @param pf An access_checker hook function
472 * @param aszPre A NULL-terminated array of strings that name modules whose
473 * hooks should precede this one
474 * @param aszSucc A NULL-terminated array of strings that name modules whose
475 * hooks should succeed this one
476 * @param nOrder An integer determining order before honouring aszPre and
477 * aszSucc (for example, HOOK_MIDDLE)
478 * @param type Internal request processing mode, either
479 * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
481 AP_DECLARE(void) ap_hook_check_access(ap_HOOK_access_checker_t *pf,
482 const char * const *aszPre,
483 const char * const *aszSucc,
484 int nOrder, int type);
487 * Register a hook function that will apply additional access control
488 * and/or bypass authentication for the current request.
489 * @param pf An access_checker_ex hook function
490 * @param aszPre A NULL-terminated array of strings that name modules whose
491 * hooks should precede this one
492 * @param aszSucc A NULL-terminated array of strings that name modules whose
493 * hooks should succeed this one
494 * @param nOrder An integer determining order before honouring aszPre and
495 * aszSucc (for example, HOOK_MIDDLE)
496 * @param type Internal request processing mode, either
497 * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
499 AP_DECLARE(void) ap_hook_check_access_ex(ap_HOOK_access_checker_ex_t *pf,
500 const char * const *aszPre,
501 const char * const *aszSucc,
502 int nOrder, int type);
506 * Register a hook function that will analyze the request headers,
507 * authenticate the user, and set the user information in the request record.
508 * @param pf A check_user_id hook function
509 * @param aszPre A NULL-terminated array of strings that name modules whose
510 * hooks should precede this one
511 * @param aszSucc A NULL-terminated array of strings that name modules whose
512 * hooks should succeed this one
513 * @param nOrder An integer determining order before honouring aszPre and
514 * aszSucc (for example, HOOK_MIDDLE)
515 * @param type Internal request processing mode, either
516 * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
518 AP_DECLARE(void) ap_hook_check_authn(ap_HOOK_check_user_id_t *pf,
519 const char * const *aszPre,
520 const char * const *aszSucc,
521 int nOrder, int type);
524 * Register a hook function that determine if the resource being requested
525 * is available for the currently authenticated user.
526 * @param pf An auth_checker hook function
527 * @param aszPre A NULL-terminated array of strings that name modules whose
528 * hooks should precede this one
529 * @param aszSucc A NULL-terminated array of strings that name modules whose
530 * hooks should succeed this one
531 * @param nOrder An integer determining order before honouring aszPre and
532 * aszSucc (for example, HOOK_MIDDLE)
533 * @param type Internal request processing mode, either
534 * AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
536 AP_DECLARE(void) ap_hook_check_authz(ap_HOOK_auth_checker_t *pf,
537 const char * const *aszPre,
538 const char * const *aszSucc,
539 int nOrder, int type);
542 * This hook allows modules to insert filters for the current request
543 * @param r the current request
546 AP_DECLARE_HOOK(void,insert_filter,(request_rec *r))
549 * This hook allows modules to affect the request immediately after the
550 * per-directory configuration for the request has been generated.
551 * @param r The current request
552 * @return OK (allow acces), DECLINED (let later modules decide),
553 * or HTTP_... (deny access)
556 AP_DECLARE_HOOK(int,post_perdir_config,(request_rec *r))
559 * This hook allows a module to force authn to be required when
560 * processing a request.
561 * This hook should be registered with ap_hook_force_authn().
562 * @param r The current request
563 * @return OK (force authn), DECLINED (let later modules decide)
566 AP_DECLARE_HOOK(int,force_authn,(request_rec *r))
569 * This hook allows modules to handle/emulate the apr_stat() calls
570 * needed for directory walk.
571 * @param finfo where to put the stat data
572 * @param r The current request
573 * @param wanted APR_FINFO_* flags to pass to apr_stat()
574 * @return apr_status_t or AP_DECLINED (let later modules decide)
577 AP_DECLARE_HOOK(apr_status_t,dirwalk_stat,(apr_finfo_t *finfo, request_rec *r, apr_int32_t wanted))
579 AP_DECLARE(int) ap_location_walk(request_rec *r);
580 AP_DECLARE(int) ap_directory_walk(request_rec *r);
581 AP_DECLARE(int) ap_file_walk(request_rec *r);
582 AP_DECLARE(int) ap_if_walk(request_rec *r);
584 /** End Of REQUEST (EOR) bucket */
585 AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_eor;
588 * Determine if a bucket is an End Of REQUEST (EOR) bucket
589 * @param e The bucket to inspect
590 * @return true or false
592 #define AP_BUCKET_IS_EOR(e) (e->type == &ap_bucket_type_eor)
595 * Make the bucket passed in an End Of REQUEST (EOR) bucket
596 * @param b The bucket to make into an EOR bucket
597 * @param r The request to destroy when this bucket is destroyed
598 * @return The new bucket, or NULL if allocation failed
600 AP_DECLARE(apr_bucket *) ap_bucket_eor_make(apr_bucket *b, request_rec *r);
603 * Create a bucket referring to an End Of REQUEST (EOR). This bucket
604 * holds a pointer to the request_rec, so that the request can be
605 * destroyed right after all of the output has been sent to the client.
607 * @param list The freelist from which this bucket should be allocated
608 * @param r The request to destroy when this bucket is destroyed
609 * @return The new bucket, or NULL if allocation failed
611 AP_DECLARE(apr_bucket *) ap_bucket_eor_create(apr_bucket_alloc_t *list,
615 * Can be used within any handler to determine if any authentication
616 * is required for the current request. Note that if used with an
617 * access_checker hook, an access_checker_ex hook or an authz provider; the
618 * caller should take steps to avoid a loop since this function is
619 * implemented by calling these hooks.
620 * @param r The current request
621 * @return TRUE if authentication is required, FALSE otherwise
623 AP_DECLARE(int) ap_some_authn_required(request_rec *r);
629 #endif /* !APACHE_HTTP_REQUEST_H */