1 /* Copyright 1999-2004 The Apache Software Foundation
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
20 * Main include file for the Apache proxy
25 Also note numerous FIXMEs and CHECKMEs which should be eliminated.
27 This code is once again experimental!
31 1. Make it completely work (for FTP too)
35 Chuck Murcko <chuck@topsail.org> 02-06-01
41 #include "apr_hooks.h"
44 #include "apr_strings.h"
45 #include "apr_buckets.h"
47 #include "apr_network_io.h"
48 #include "apr_pools.h"
49 #include "apr_strings.h"
52 #include "apr_strmatch.h"
53 #include "apr_fnmatch.h"
54 #include "apr_reslist.h"
55 #define APR_WANT_STRFUNC
59 #include "http_config.h"
60 #include "ap_config.h"
61 #include "http_core.h"
62 #include "http_protocol.h"
63 #include "http_request.h"
64 #include "http_vhost.h"
65 #include "http_main.h"
67 #include "http_connection.h"
68 #include "util_filter.h"
69 #include "util_ebcdic.h"
71 #if APR_HAVE_NETINET_IN_H
72 #include <netinet/in.h>
74 #if APR_HAVE_ARPA_INET_H
75 #include <arpa/inet.h>
78 /* for proxy_canonenc() */
80 enc_path, enc_search, enc_user, enc_fpath, enc_parm
83 #if APR_CHARSET_EBCDIC
85 #else /*APR_CHARSET_EBCDIC*/
86 #define CRLF "\015\012"
87 #endif /*APR_CHARSET_EBCDIC*/
89 /* default Max-Forwards header setting */
90 #define DEFAULT_MAX_FORWARDS 10
92 /* static information about a remote proxy */
94 const char *scheme; /* the schemes handled by this proxy, or '*' */
95 const char *protocol; /* the scheme used to talk to this proxy */
96 const char *hostname; /* the hostname of this proxy */
97 apr_port_t port; /* the port for this proxy */
98 regex_t *regexp; /* compiled regex (if any) for the remote */
99 int use_regex; /* simple boolean. True if we have a regex pattern */
107 struct dirconn_entry {
109 struct in_addr addr, mask;
110 struct apr_sockaddr_t *hostaddr;
111 int (*matcher) (struct dirconn_entry * This, request_rec *r);
114 struct noproxy_entry {
116 struct apr_sockaddr_t *addr;
119 typedef struct proxy_balancer proxy_balancer;
120 typedef struct proxy_worker proxy_worker;
121 typedef struct proxy_conn_pool proxy_conn_pool;
124 apr_array_header_t *proxies;
125 apr_array_header_t *sec_proxy;
126 apr_array_header_t *aliases;
127 apr_array_header_t *raliases;
128 apr_array_header_t *noproxies;
129 apr_array_header_t *dirconn;
130 apr_array_header_t *allowed_connect_ports;
131 apr_array_header_t *workers;
132 apr_array_header_t *balancers;
133 proxy_worker *forward; /* forward proxy worker */
134 const char *domain; /* domain name to use in absence of a domain name in the request */
135 int req; /* true if proxy requests are enabled */
142 } viaopt; /* how to deal with proxy Via: headers */
144 apr_size_t recv_buffer_size;
145 char recv_buffer_size_set;
146 apr_size_t io_buffer_size;
147 char io_buffer_size_set;
151 * the following setting masks the error page
152 * returned from the 'proxied server' and just
153 * forwards the status code upwards.
154 * This allows the main server (us) to generate
155 * the error page, (so it will look like a error
156 * returned from the rest of the system
159 int error_override_set;
161 int preserve_host_set;
162 apr_interval_time_t timeout;
168 } badopt; /* how to deal with bad headers */
170 /* putting new stuff on the end maximises binary back-compatibility.
171 * the strmatch_patterns are really a const just to have a
172 * case-independent strstr.
174 apr_array_header_t* cookie_paths;
175 apr_array_header_t* cookie_domains;
176 const apr_strmatch_pattern* cookie_path_str;
177 const apr_strmatch_pattern* cookie_domain_str;
182 } proxy_status; /* Status display options */
183 char proxy_status_set;
184 apr_pool_t *pool; /* Pool used for allocating this struct */
189 const char *p; /* The path */
190 int p_is_fnmatch; /* Is this path an fnmatch candidate? */
191 regex_t *r; /* Is this a regex? */
195 conn_rec *connection;
196 const char *hostname;
199 apr_pool_t *pool; /* Subpool used for creating socket */
200 apr_socket_t *sock; /* Connection socket */
201 apr_uint32_t flags; /* Conection flags */
202 int close; /* Close 'this' connection */
203 int close_on_recycle; /* Close the connection when returning to pool */
204 proxy_worker *worker; /* Connection pool this connection belogns to */
205 void *data; /* per scheme connection data */
209 float cache_completion; /* completion percentage */
210 int content_length; /* length of the content */
213 /* Connection pool */
214 struct proxy_conn_pool {
215 apr_pool_t *pool; /* The pool used in constructor and destructor calls */
216 apr_sockaddr_t *addr; /* Preparsed remote address info */
218 apr_reslist_t *res; /* Connection resource list */
220 int nfree; /* Balancer free count number */
221 proxy_conn_rec *conn; /* Single connection for prefork mpm's */
224 /* woker status flags */
225 #define PROXY_WORKER_INITIALIZED 0x0001
226 #define PROXY_WORKER_IN_SHUTDOWN 0x0010
227 #define PROXY_WORKER_DISABLED 0x0020
228 #define PROXY_WORKER_IN_ERROR 0x0040
230 #define PROXY_WORKER_IS_USABLE(f) (!((f)->status & 0x00F0))
233 /* Worker configuration */
234 struct proxy_worker {
236 apr_time_t error_time; /* time of the last error */
237 apr_interval_time_t retry; /* retry interval */
238 int retries; /* number of retries on this worker */
239 int lbfactor; /* initial load balancing factor */
241 const char *scheme; /* scheme to use ajp|http|https */
242 const char *hostname; /* remote backend address */
243 const char *route; /* balancing route */
244 const char *redirect; /* temporary balancing redirection route */
246 int min; /* Desired minimum number of available connections */
247 int smax; /* Soft maximum on the total number of connections */
248 int hmax; /* Hard maximum on the total number of connections */
249 apr_interval_time_t ttl; /* maximum amount of time in seconds a connection
250 * may be available while exceeding the soft limit */
251 apr_interval_time_t timeout; /* connection timeout */
253 apr_interval_time_t acquire; /* acquire timeout when the maximum number of connections is exceeded */
255 apr_size_t recv_buffer_size;
256 char recv_buffer_size_set;
257 apr_size_t io_buffer_size;
258 char io_buffer_size_set;
261 proxy_conn_pool *cp; /* Connection pool to use */
262 void *opaque; /* per scheme worker data */
265 /* Runtime worker status informations. Shared in scoreboard */
267 int id; /* scoreboard id */
268 double lbstatus; /* Current lbstatus */
269 double lbfactor; /* dynamic lbfactor */
270 apr_size_t transfered; /* Number of bytes transfered to remote */
271 apr_size_t readed; /* Number of bytes readed from remote */
272 apr_size_t elected; /* Number of times the worker was elected */
273 } proxy_runtime_stat;
275 /* Runtime worker. */
277 proxy_balancer *b; /* balancer containing this worker */
279 proxy_runtime_stat *s;
280 } proxy_runtime_worker;
282 struct proxy_balancer {
283 apr_array_header_t *workers; /* array of proxy_runtime_workers */
284 const char *name; /* name of the load balancer */
285 const char *sticky; /* sticky session identifier */
286 int sticky_force; /* Disable failover for sticky sessions */
287 apr_interval_time_t timeout; /* Timeout for waiting on free connection */
288 /* XXX: Perhaps we will need the proc mutex too.
289 * Altrough we are only using arithmetic operations
290 * it may lead to a incorrect calculations.
291 * For now use only the thread mutex.
294 apr_thread_mutex_t *mutex; /* Thread lock for updating lb params */
300 /* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
301 * PROXY_DECLARE_DATA with appropriate export and import tags for the platform
304 #define PROXY_DECLARE(type) type
305 #define PROXY_DECLARE_NONSTD(type) type
306 #define PROXY_DECLARE_DATA
307 #elif defined(PROXY_DECLARE_STATIC)
308 #define PROXY_DECLARE(type) type __stdcall
309 #define PROXY_DECLARE_NONSTD(type) type
310 #define PROXY_DECLARE_DATA
311 #elif defined(PROXY_DECLARE_EXPORT)
312 #define PROXY_DECLARE(type) __declspec(dllexport) type __stdcall
313 #define PROXY_DECLARE_NONSTD(type) __declspec(dllexport) type
314 #define PROXY_DECLARE_DATA __declspec(dllexport)
316 #define PROXY_DECLARE(type) __declspec(dllimport) type __stdcall
317 #define PROXY_DECLARE_NONSTD(type) __declspec(dllimport) type
318 #define PROXY_DECLARE_DATA __declspec(dllimport)
322 * Hook an optional proxy hook. Unlike static hooks, this uses a macro
323 * instead of a function.
325 #define PROXY_OPTIONAL_HOOK(name,fn,pre,succ,order) \
326 APR_OPTIONAL_HOOK(proxy,name,fn,pre,succ,order)
328 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, scheme_handler, (request_rec *r,
329 proxy_worker *worker, proxy_server_conf *conf, char *url,
330 const char *proxyhost, apr_port_t proxyport))
331 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, canon_handler, (request_rec *r,
334 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, create_req, (request_rec *r, request_rec *pr))
335 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, fixups, (request_rec *r))
339 * It will return the most suitable worker at the moment
340 * and coresponding balancer.
341 * The url is rewritten from balancer://cluster/uri to scheme://host:port/uri
342 * and then the scheme_handler is called.
345 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, pre_request, (proxy_worker **worker,
346 proxy_balancer **balancer,
348 proxy_server_conf *conf, char **url))
351 * It is called after request for updating runtime balancer status.
353 APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, post_request, (proxy_worker *worker,
354 proxy_balancer *balancer, request_rec *r,
355 proxy_server_conf *conf))
360 PROXY_DECLARE(request_rec *)ap_proxy_make_fake_req(conn_rec *c, request_rec *r);
361 PROXY_DECLARE(int) ap_proxy_hex2c(const char *x);
362 PROXY_DECLARE(void) ap_proxy_c2hex(int ch, char *x);
363 PROXY_DECLARE(char *)ap_proxy_canonenc(apr_pool_t *p, const char *x, int len, enum enctype t,
365 PROXY_DECLARE(char *)ap_proxy_canon_netloc(apr_pool_t *p, char **const urlp, char **userp,
366 char **passwordp, char **hostp, apr_port_t *port);
367 PROXY_DECLARE(const char *)ap_proxy_date_canon(apr_pool_t *p, const char *x);
368 PROXY_DECLARE(int) ap_proxy_liststr(const char *list, const char *val);
369 PROXY_DECLARE(char *)ap_proxy_removestr(apr_pool_t *pool, const char *list, const char *val);
370 PROXY_DECLARE(int) ap_proxy_hex2sec(const char *x);
371 PROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y);
372 PROXY_DECLARE(int) ap_proxyerror(request_rec *r, int statuscode, const char *message);
373 PROXY_DECLARE(int) ap_proxy_is_ipaddr(struct dirconn_entry *This, apr_pool_t *p);
374 PROXY_DECLARE(int) ap_proxy_is_domainname(struct dirconn_entry *This, apr_pool_t *p);
375 PROXY_DECLARE(int) ap_proxy_is_hostname(struct dirconn_entry *This, apr_pool_t *p);
376 PROXY_DECLARE(int) ap_proxy_is_word(struct dirconn_entry *This, apr_pool_t *p);
377 PROXY_DECLARE(int) ap_proxy_checkproxyblock(request_rec *r, proxy_server_conf *conf, apr_sockaddr_t *uri_addr);
378 PROXY_DECLARE(int) ap_proxy_pre_http_request(conn_rec *c, request_rec *r);
379 PROXY_DECLARE(apr_status_t) ap_proxy_string_read(conn_rec *c, apr_bucket_brigade *bb, char *buff, size_t bufflen, int *eos);
380 PROXY_DECLARE(void) ap_proxy_table_unmerge(apr_pool_t *p, apr_table_t *t, char *key);
381 /* DEPRECATED (will be replaced with ap_proxy_connect_backend */
382 PROXY_DECLARE(int) ap_proxy_connect_to_backend(apr_socket_t **, const char *, apr_sockaddr_t *, const char *, proxy_server_conf *, server_rec *, apr_pool_t *);
383 PROXY_DECLARE(int) ap_proxy_ssl_enable(conn_rec *c);
384 PROXY_DECLARE(int) ap_proxy_ssl_disable(conn_rec *c);
386 /* Connection pool API */
388 * Get the worker from proxy configuration
389 * @param p memory pool used for finding worker
390 * @param conf current proxy server configuration
391 * @param url url to find the worker from
392 * @return proxy_worker or NULL if not found
394 PROXY_DECLARE(proxy_worker *) ap_proxy_get_worker(apr_pool_t *p,
395 proxy_server_conf *conf,
398 * Add the worker to proxy configuration
399 * @param worker the new worker
400 * @param p memory pool to allocate worker from
401 * @param conf current proxy server configuration
402 * @param url url containing worker name
403 * @return error message or NULL if successfull
405 PROXY_DECLARE(const char *) ap_proxy_add_worker(proxy_worker **worker,
407 proxy_server_conf *conf,
410 * Get the balancer from proxy configuration
411 * @param p memory pool used for finding balancer
412 * @param conf current proxy server configuration
413 * @param url url to find the worker from. Has to have balancer:// prefix
414 * @return proxy_balancer or NULL if not found
416 PROXY_DECLARE(proxy_balancer *) ap_proxy_get_balancer(apr_pool_t *p,
417 proxy_server_conf *conf,
420 * Add the balancer to proxy configuration
421 * @param balancer the new balancer
422 * @param p memory pool to allocate balancer from
423 * @param conf current proxy server configuration
424 * @param url url containing balancer name
425 * @return error message or NULL if successfull
427 PROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer,
429 proxy_server_conf *conf,
433 * Add the worker to the balancer
434 * @param pool memory pool for adding worker
435 * @param balancer balancer to add to
436 * @param balancer worker to add
437 * @note Single worker can be added to multiple balancers.
439 PROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(apr_pool_t *pool,
440 proxy_balancer *balancer,
441 proxy_worker *worker);
443 * Get the most suitable worker and(or) balancer for the request
444 * @param worker worker used for processing request
445 * @param balancer balancer used for processing request
446 * @param r current request
447 * @param conf current proxy server configuration
448 * @param url request url that balancer can rewrite.
449 * @return OK or HTTP_XXX error
450 * @note It calls balancer pre_request hook if the url starts with balancer://
451 * The balancer then rewrites the url to particular worker, like http://host:port
453 PROXY_DECLARE(int) ap_proxy_pre_request(proxy_worker **worker,
454 proxy_balancer **balancer,
456 proxy_server_conf *conf,
459 * Post request worker and balancer cleanup
460 * @param worker worker used for processing request
461 * @param balancer balancer used for processing request
462 * @param r current request
463 * @param conf current proxy server configuration
464 * @return OK or HTTP_XXX error
465 * @note When ever the pre_request is called, the post_request has to be
468 PROXY_DECLARE(int) ap_proxy_post_request(proxy_worker *worker,
469 proxy_balancer *balancer,
471 proxy_server_conf *conf);
473 * Deternime backend hostname and port
474 * @param p memory pool used for processing
475 * @param r current request
476 * @param conf current proxy server configuration
477 * @param worker worker used for processing request
478 * @param conn proxy connection struct
479 * @param ppool long living memory pool
480 * @param uri processed uri
481 * @param url request url
482 * @param proxyname are we connecting directly or via s proxy
483 * @param proxyport proxy host port
484 * @param server_portstr Via headers server port
485 * @param server_portstr_size size of the server_portstr buffer
486 * @return OK or HTTP_XXX error
488 PROXY_DECLARE(int) ap_proxy_determine_connection(apr_pool_t *p, request_rec *r,
489 proxy_server_conf *conf,
490 proxy_worker *worker,
491 proxy_conn_rec *conn,
495 const char *proxyname,
496 apr_port_t proxyport,
497 char *server_portstr,
498 int server_portstr_size);
500 * Mark a worker for retry
501 * @param proxy_function calling proxy scheme (http, ajp, ...)
502 * @param conf current proxy server configuration
503 * @param worker worker used for retrying
504 * @param s current server record
505 * @return OK if marked for retry, DECLINED otherwise
506 * @note Worker will be marker for retry if the time of the last retry
507 * has been ellapsed. In case there is no retry option set, defaults to
508 * number_of_retries seconds.
510 PROXY_DECLARE(int) ap_proxy_retry_worker(const char *proxy_function,
511 proxy_worker *worker,
514 * Acquire a connection from workers connection pool
515 * @param proxy_function calling proxy scheme (http, ajp, ...)
516 * @param conn acquired connection
517 * @param worker worker used for obtaining connection
518 * @param s current server record
519 * @return OK or HTTP_XXX error
520 * @note If the number of connections is exhaused the function will
521 * block untill the timeout is reached.
523 PROXY_DECLARE(int) ap_proxy_acquire_connection(const char *proxy_function,
524 proxy_conn_rec **conn,
525 proxy_worker *worker,
528 * Release a connection back to worker connection pool
529 * @param proxy_function calling proxy scheme (http, ajp, ...)
530 * @param conn acquired connection
531 * @param s current server record
532 * @return OK or HTTP_XXX error
533 * @note The connection will be closed if conn->close_on_release is set
535 PROXY_DECLARE(int) ap_proxy_release_connection(const char *proxy_function,
536 proxy_conn_rec *conn,
539 * Close the connection
540 * @param conn connection to close
541 * @return APR_SUCCESS or error code
543 PROXY_DECLARE(apr_status_t) ap_proxy_close_connection(proxy_conn_rec *conn);
546 * Make a connection to the backend
547 * @param proxy_function calling proxy scheme (http, ajp, ...)
548 * @param conn acquired connection
549 * @param worker connection worker
550 * @param s current server record
551 * @return OK or HTTP_XXX error
552 * @note In case the socket already exists for conn, just check the link
555 PROXY_DECLARE(int) ap_proxy_connect_backend(const char *proxy_function,
556 proxy_conn_rec *conn,
557 proxy_worker *worker,
560 * Make a connection record for backend connection
561 * @param proxy_function calling proxy scheme (http, ajp, ...)
562 * @param conn acquired connection
563 * @param c client connection record
564 * @param s current server record
565 * @return OK or HTTP_XXX error
567 PROXY_DECLARE(int) ap_proxy_connection_create(const char *proxy_function,
568 proxy_conn_rec *conn,
569 conn_rec *c, server_rec *s);
572 #if MODULE_MAGIC_NUMBER_MAJOR > 20020903
573 #define PROXY_HAS_SCOREBOARD 1
575 #define PROXY_HAS_SCOREBOARD 0
577 /* The number of dynamic balancers that can be added */
578 #define PROXY_DYNAMIC_BALANCER_LIMIT 16
579 PROXY_DECLARE(int) ap_proxy_lb_workers(void);
582 extern module PROXY_DECLARE_DATA proxy_module;
584 #endif /*MOD_PROXY_H*/