]> granicus.if.org Git - apache/blob - include/http_request.h
Allow SetHandler+UDS+fcgi to take advantage of dedicated workers including
[apache] / include / http_request.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_request.h
19  * @brief Apache Request library
20  *
21  * @defgroup APACHE_CORE_REQ Apache Request Processing
22  * @ingroup  APACHE_CORE
23  * @{
24  */
25
26 /*
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).
31  *
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.
36  *
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.
45  */
46
47 #ifndef APACHE_HTTP_REQUEST_H
48 #define APACHE_HTTP_REQUEST_H
49
50 #include "apr_optional.h"
51 #include "util_filter.h"
52
53 #ifdef __cplusplus
54 extern "C" {
55 #endif
56
57 #define AP_SUBREQ_NO_ARGS 0
58 #define AP_SUBREQ_MERGE_ARGS 1
59
60 /**
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
65  */
66 AP_DECLARE(int) ap_process_request_internal(request_rec *r);
67
68 /**
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
76  */
77 AP_DECLARE(request_rec *) ap_sub_req_lookup_uri(const char *new_uri,
78                                                 const request_rec *r,
79                                                 ap_filter_t *next_filter);
80
81 /**
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
89  */
90 AP_DECLARE(request_rec *) ap_sub_req_lookup_file(const char *new_file,
91                                               const request_rec *r,
92                                               ap_filter_t *next_filter);
93 /**
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;
99  * <PRE>
100  *      AP_SUBREQ_NO_ARGS     ignore r->args and r->path_info
101  *      AP_SUBREQ_MERGE_ARGS  merge r->args and r->path_info
102  * </PRE>
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.
110  */
111 AP_DECLARE(request_rec *) ap_sub_req_lookup_dirent(const apr_finfo_t *finfo,
112                                                    const request_rec *r,
113                                                    int subtype,
114                                                    ap_filter_t *next_filter);
115 /**
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
124  */
125 AP_DECLARE(request_rec *) ap_sub_req_method_uri(const char *method,
126                                                 const char *new_uri,
127                                                 const request_rec *r,
128                                                 ap_filter_t *next_filter);
129 /**
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
135  */
136 AP_CORE_DECLARE_NONSTD(apr_status_t) ap_sub_req_output_filter(ap_filter_t *f,
137                                                         apr_bucket_brigade *bb);
138
139 /**
140  * Run the handler for the subrequest
141  * @param r The subrequest to run
142  * @return The return code for the subrequest
143  */
144 AP_DECLARE(int) ap_run_sub_req(request_rec *r);
145
146 /**
147  * Free the memory associated with a subrequest
148  * @param r The subrequest to finish
149  */
150 AP_DECLARE(void) ap_destroy_sub_req(request_rec *r);
151
152 /*
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.
156  */
157
158 /**
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
162  */
163 AP_DECLARE(void) ap_internal_redirect(const char *new_uri, request_rec *r);
164
165 /**
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
171  */
172 AP_DECLARE(void) ap_internal_redirect_handler(const char *new_uri, request_rec *r);
173
174 /**
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!
180  */
181 AP_DECLARE(void) ap_internal_fast_redirect(request_rec *sub_req, request_rec *r);
182
183 /**
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  */
189 AP_DECLARE(int) ap_some_auth_required(request_rec *r);
190
191 /**
192  * @defgroup APACHE_CORE_REQ_AUTH Access Control for Sub-Requests and
193  *                                Internal Redirects
194  * @ingroup  APACHE_CORE_REQ
195  * @{
196  */
197
198 #define AP_AUTH_INTERNAL_PER_URI  0  /**< Run access control hooks on all
199                                           internal requests with URIs
200                                           distinct from that of initial
201                                           request */
202 #define AP_AUTH_INTERNAL_PER_CONF 1  /**< Run access control hooks only on
203                                           internal requests with
204                                           configurations distinct from
205                                           that of initial request */
206 #define AP_AUTH_INTERNAL_MASK     0x000F  /**< mask to extract internal request
207                                                processing mode */
208
209 /**
210  * Clear flag which determines when access control hooks will be run for
211  * internal requests.
212  */
213 AP_DECLARE(void) ap_clear_auth_internal(void);
214
215 /**
216  * Determine whether access control hooks will be run for all internal
217  * requests with URIs distinct from that of the initial request, or only
218  * those for which different configurations apply than those which applied
219  * to the initial request.  To accomodate legacy external modules which
220  * may expect access control hooks to be run for all internal requests
221  * with distinct URIs, this is the default behaviour unless all access
222  * control hooks and authentication and authorization providers are
223  * registered with AP_AUTH_INTERNAL_PER_CONF.
224  * @param ptemp Pool used for temporary allocations
225  */
226 AP_DECLARE(void) ap_setup_auth_internal(apr_pool_t *ptemp);
227
228 /**
229  * Register an authentication or authorization provider with the global
230  * provider pool.
231  * @param pool The pool to create any storage from
232  * @param provider_group The group to store the provider in
233  * @param provider_name The name for this provider
234  * @param provider_version The version for this provider
235  * @param provider Opaque structure for this provider
236  * @param type Internal request processing mode, either
237  *             AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
238  * @return APR_SUCCESS if all went well
239  */
240 AP_DECLARE(apr_status_t) ap_register_auth_provider(apr_pool_t *pool,
241                                                    const char *provider_group,
242                                                    const char *provider_name,
243                                                    const char *provider_version,
244                                                    const void *provider,
245                                                    int type);
246
247 /** @} */
248
249 /* Optional functions coming from mod_authn_core and mod_authz_core
250  * that list all registered authn/z providers.
251  */
252 APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, authn_ap_list_provider_names,
253                         (apr_pool_t *ptemp));
254 APR_DECLARE_OPTIONAL_FN(apr_array_header_t *, authz_ap_list_provider_names,
255                         (apr_pool_t *ptemp));
256
257 /**
258  * Determine if the current request is the main request or a subrequest
259  * @param r The current request
260  * @return 1 if this is the main request, 0 otherwise
261  */
262 AP_DECLARE(int) ap_is_initial_req(request_rec *r);
263
264 /**
265  * Function to set the r->mtime field to the specified value if it's later
266  * than what's already there.
267  * @param r The current request
268  * @param dependency_mtime Time to set the mtime to
269  */
270 AP_DECLARE(void) ap_update_mtime(request_rec *r, apr_time_t dependency_mtime);
271
272 /**
273  * Add one or more methods to the list permitted to access the resource.
274  * Usually executed by the content handler before the response header is
275  * sent, but sometimes invoked at an earlier phase if a module knows it
276  * can set the list authoritatively.  Note that the methods are ADDED
277  * to any already permitted unless the reset flag is non-zero.  The
278  * list is used to generate the Allow response header field when it
279  * is needed.
280  * @param   r     The pointer to the request identifying the resource.
281  * @param   reset Boolean flag indicating whether this list should
282  *                completely replace any current settings.
283  * @param   ...   A NULL-terminated list of strings, each identifying a
284  *                method name to add.
285  * @return  None.
286  */
287 AP_DECLARE(void) ap_allow_methods(request_rec *r, int reset, ...)
288                  AP_FN_ATTR_SENTINEL;
289
290 /**
291  * Add one or more methods to the list permitted to access the resource.
292  * Usually executed by the content handler before the response header is
293  * sent, but sometimes invoked at an earlier phase if a module knows it
294  * can set the list authoritatively.  Note that the methods are ADDED
295  * to any already permitted unless the reset flag is non-zero.  The
296  * list is used to generate the Allow response header field when it
297  * is needed.
298  * @param   r     The pointer to the request identifying the resource.
299  * @param   reset Boolean flag indicating whether this list should
300  *                completely replace any current settings.
301  * @param   ...   A list of method identifiers, from the "M_" series
302  *                defined in httpd.h, terminated with a value of -1
303  *                (e.g., "M_GET, M_POST, M_OPTIONS, -1")
304  * @return  None.
305  */
306 AP_DECLARE(void) ap_allow_standard_methods(request_rec *r, int reset, ...);
307
308 #define MERGE_ALLOW 0
309 #define REPLACE_ALLOW 1
310
311 /**
312  * Process a top-level request from a client, and synchronously write
313  * the response to the client
314  * @param r The current request
315  */
316 void ap_process_request(request_rec *r);
317
318 /* For post-processing after a handler has finished with a request.
319  * (Commonly used after it was suspended)
320  */
321 AP_DECLARE(void) ap_process_request_after_handler(request_rec *r);
322
323 /**
324  * Process a top-level request from a client, allowing some or all of
325  * the response to remain buffered in the core output filter for later,
326  * asynchronous write completion
327  * @param r The current request
328  */
329 void ap_process_async_request(request_rec *r);
330
331 /**
332  * Kill the current request
333  * @param type Why the request is dieing
334  * @param r The current request
335  */
336 AP_DECLARE(void) ap_die(int type, request_rec *r);
337
338 /* Hooks */
339
340 /**
341  * Gives modules a chance to create their request_config entry when the
342  * request is created.
343  * @param r The current request
344  * @ingroup hooks
345  */
346 AP_DECLARE_HOOK(int,create_request,(request_rec *r))
347
348 /**
349  * This hook allow modules an opportunity to translate the URI into an
350  * actual filename.  If no modules do anything special, the server's default
351  * rules will be followed.
352  * @param r The current request
353  * @return OK, DECLINED, or HTTP_...
354  * @ingroup hooks
355  */
356 AP_DECLARE_HOOK(int,translate_name,(request_rec *r))
357
358 /**
359  * This hook allow modules to set the per_dir_config based on their own
360  * context (such as "<Proxy>" sections) and responds to contextless requests
361  * such as TRACE that need no security or filesystem mapping.
362  * based on the filesystem.
363  * @param r The current request
364  * @return DONE (or HTTP_) if this contextless request was just fulfilled
365  * (such as TRACE), OK if this is not a file, and DECLINED if this is a file.
366  * The core map_to_storage (HOOK_RUN_REALLY_LAST) will directory_walk
367  * and file_walk the r->filename.
368  *
369  * @ingroup hooks
370  */
371 AP_DECLARE_HOOK(int,map_to_storage,(request_rec *r))
372
373 /**
374  * This hook is used to analyze the request headers, authenticate the user,
375  * and set the user information in the request record (r->user and
376  * r->ap_auth_type). This hook is only run when Apache determines that
377  * authentication/authorization is required for this resource (as determined
378  * by the 'Require' directive). It runs after the access_checker hook, and
379  * before the auth_checker hook. This hook should be registered with
380  * ap_hook_check_authn().
381  * If "Satisfy any" is in effect, this hook may be skipped.
382  *
383  * @param r The current request
384  * @return OK, DECLINED, or HTTP_...
385  * @ingroup hooks
386  * @see ap_hook_check_authn
387  */
388 AP_DECLARE_HOOK(int,check_user_id,(request_rec *r))
389
390 /**
391  * Allows modules to perform module-specific fixing of header fields.  This
392  * is invoked just before any content-handler
393  * @param r The current request
394  * @return OK, DECLINED, or HTTP_...
395  * @ingroup hooks
396  */
397 AP_DECLARE_HOOK(int,fixups,(request_rec *r))
398
399 /**
400  * This routine is called to determine and/or set the various document type
401  * information bits, like Content-type (via r->content_type), language, et
402  * cetera.
403  * @param r the current request
404  * @return OK, DECLINED, or HTTP_...
405  * @ingroup hooks
406  */
407 AP_DECLARE_HOOK(int,type_checker,(request_rec *r))
408
409 /**
410  * This hook is used to apply additional access control to this resource.
411  * It runs *before* a user is authenticated, so this hook is really to
412  * apply additional restrictions independent of a user. It also runs
413  * independent of 'Require' directive usage. This hook should be registered
414  * with ap_hook_check_access().
415  *
416  * @param r the current request
417  * @return OK, DECLINED, or HTTP_...
418  * @ingroup hooks
419  * @see ap_hook_check_access
420  */
421 AP_DECLARE_HOOK(int,access_checker,(request_rec *r))
422
423 /**
424  * This hook is used to apply additional access control and/or bypass
425  * authentication for this resource. It runs *before* a user is authenticated,
426  * but after the access_checker hook.
427  * This hook should be registered with ap_hook_check_access_ex().
428  * If "Satisfy any" is in effect, this hook may be skipped.
429  *
430  * @param r the current request
431  * @return OK (allow acces), DECLINED (let later modules decide),
432  *         or HTTP_... (deny access)
433  * @ingroup hooks
434  * @see ap_hook_check_access_ex
435  */
436 AP_DECLARE_HOOK(int,access_checker_ex,(request_rec *r))
437
438 /**
439  * This hook is used to check to see if the resource being requested
440  * is available for the authenticated user (r->user and r->ap_auth_type).
441  * It runs after the access_checker and check_user_id hooks. Note that
442  * it will *only* be called if Apache determines that access control has
443  * been applied to this resource (through a 'Require' directive). This
444  * hook should be registered with ap_hook_check_authz().
445  * If "Satisfy any" is in effect, this hook may be skipped.
446  *
447  * @param r the current request
448  * @return OK, DECLINED, or HTTP_...
449  * @ingroup hooks
450  * @see ap_hook_check_authz
451  */
452 AP_DECLARE_HOOK(int,auth_checker,(request_rec *r))
453
454 /**
455  * Register a hook function that will apply additional access control to
456  * the current request.
457  * @param pf An access_checker hook function
458  * @param aszPre A NULL-terminated array of strings that name modules whose
459  *               hooks should precede this one
460  * @param aszSucc A NULL-terminated array of strings that name modules whose
461  *                hooks should succeed this one
462  * @param nOrder An integer determining order before honouring aszPre and
463  *               aszSucc (for example, HOOK_MIDDLE)
464  * @param type Internal request processing mode, either
465  *             AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
466  */
467 AP_DECLARE(void) ap_hook_check_access(ap_HOOK_access_checker_t *pf,
468                                       const char * const *aszPre,
469                                       const char * const *aszSucc,
470                                       int nOrder, int type);
471
472 /**
473  * Register a hook function that will apply additional access control
474  * and/or bypass authentication for the current request.
475  * @param pf An access_checker_ex hook function
476  * @param aszPre A NULL-terminated array of strings that name modules whose
477  *               hooks should precede this one
478  * @param aszSucc A NULL-terminated array of strings that name modules whose
479  *                hooks should succeed this one
480  * @param nOrder An integer determining order before honouring aszPre and
481  *               aszSucc (for example, HOOK_MIDDLE)
482  * @param type Internal request processing mode, either
483  *             AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
484  */
485 AP_DECLARE(void) ap_hook_check_access_ex(ap_HOOK_access_checker_ex_t *pf,
486                                          const char * const *aszPre,
487                                          const char * const *aszSucc,
488                                          int nOrder, int type);
489
490
491 /**
492  * Register a hook function that will analyze the request headers,
493  * authenticate the user, and set the user information in the request record.
494  * @param pf A check_user_id hook function
495  * @param aszPre A NULL-terminated array of strings that name modules whose
496  *               hooks should precede this one
497  * @param aszSucc A NULL-terminated array of strings that name modules whose
498  *                hooks should succeed this one
499  * @param nOrder An integer determining order before honouring aszPre and
500  *               aszSucc (for example, HOOK_MIDDLE)
501  * @param type Internal request processing mode, either
502  *             AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
503  */
504 AP_DECLARE(void) ap_hook_check_authn(ap_HOOK_check_user_id_t *pf,
505                                      const char * const *aszPre,
506                                      const char * const *aszSucc,
507                                      int nOrder, int type);
508
509 /**
510  * Register a hook function that determine if the resource being requested
511  * is available for the currently authenticated user.
512  * @param pf An auth_checker hook function
513  * @param aszPre A NULL-terminated array of strings that name modules whose
514  *               hooks should precede this one
515  * @param aszSucc A NULL-terminated array of strings that name modules whose
516  *                hooks should succeed this one
517  * @param nOrder An integer determining order before honouring aszPre and
518  *               aszSucc (for example, HOOK_MIDDLE)
519  * @param type Internal request processing mode, either
520  *             AP_AUTH_INTERNAL_PER_URI or AP_AUTH_INTERNAL_PER_CONF
521  */
522 AP_DECLARE(void) ap_hook_check_authz(ap_HOOK_auth_checker_t *pf,
523                                      const char * const *aszPre,
524                                      const char * const *aszSucc,
525                                      int nOrder, int type);
526
527 /**
528  * This hook allows modules to insert filters for the current request
529  * @param r the current request
530  * @ingroup hooks
531  */
532 AP_DECLARE_HOOK(void,insert_filter,(request_rec *r))
533
534 /**
535  * This hook allows modules to affect the request immediately after the
536  * per-directory configuration for the request has been generated.
537  * @param r The current request
538  * @return OK (allow acces), DECLINED (let later modules decide),
539  *         or HTTP_... (deny access)
540  * @ingroup hooks
541  */
542 AP_DECLARE_HOOK(int,post_perdir_config,(request_rec *r))
543
544 /**
545  * This hook allows modules to handle/emulate the apr_stat() calls
546  * needed for directory walk.
547  * @param finfo where to put the stat data
548  * @param r The current request
549  * @param wanted APR_FINFO_* flags to pass to apr_stat()
550  * @return apr_status_t or AP_DECLINED (let later modules decide)
551  * @ingroup hooks
552  */
553 AP_DECLARE_HOOK(apr_status_t,dirwalk_stat,(apr_finfo_t *finfo, request_rec *r, apr_int32_t wanted))
554
555 AP_DECLARE(int) ap_location_walk(request_rec *r);
556 AP_DECLARE(int) ap_directory_walk(request_rec *r);
557 AP_DECLARE(int) ap_file_walk(request_rec *r);
558 AP_DECLARE(int) ap_if_walk(request_rec *r);
559
560 /** End Of REQUEST (EOR) bucket */
561 AP_DECLARE_DATA extern const apr_bucket_type_t ap_bucket_type_eor;
562
563 /**
564  * Determine if a bucket is an End Of REQUEST (EOR) bucket
565  * @param e The bucket to inspect
566  * @return true or false
567  */
568 #define AP_BUCKET_IS_EOR(e)         (e->type == &ap_bucket_type_eor)
569
570 /**
571  * Make the bucket passed in an End Of REQUEST (EOR) bucket
572  * @param b The bucket to make into an EOR bucket
573  * @param r The request to destroy when this bucket is destroyed
574  * @return The new bucket, or NULL if allocation failed
575  */
576 AP_DECLARE(apr_bucket *) ap_bucket_eor_make(apr_bucket *b, request_rec *r);
577
578 /**
579  * Create a bucket referring to an End Of REQUEST (EOR). This bucket
580  * holds a pointer to the request_rec, so that the request can be
581  * destroyed right after all of the output has been sent to the client.
582  *
583  * @param list The freelist from which this bucket should be allocated
584  * @param r The request to destroy when this bucket is destroyed
585  * @return The new bucket, or NULL if allocation failed
586  */
587 AP_DECLARE(apr_bucket *) ap_bucket_eor_create(apr_bucket_alloc_t *list,
588                                               request_rec *r);
589
590 #ifdef __cplusplus
591 }
592 #endif
593
594 #endif  /* !APACHE_HTTP_REQUEST_H */
595 /** @} */