mod_proxy.h revision 50ebf0554e0878bf4e9ee9a3cb574f29323e9692
55cf6e01272ec475edea32aa9b7923de2d36cb42Christian Maeder/* Copyright 1999-2005 The Apache Software Foundation or its licensors, as
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * applicable.
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova *
b43458b4d81f7451112cecbd757f3a05216e7088Kristina Sojakova * Licensed under the Apache License, Version 2.0 (the "License");
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * you may not use this file except in compliance with the License.
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * You may obtain a copy of the License at
98890889ffb2e8f6f722b00e265a211f13b5a861Corneliu-Claudiu Prodescu *
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * http://www.apache.org/licenses/LICENSE-2.0
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova *
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * Unless required by applicable law or agreed to in writing, software
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * distributed under the License is distributed on an "AS IS" BASIS,
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * See the License for the specific language governing permissions and
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * limitations under the License.
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova */
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#ifndef MOD_PROXY_H
b2e01ef1b5d4c7a62260eb792291e8e1b10e545bIulia Ignatov#define MOD_PROXY_H
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova/**
9f85afecbd79b3df5a0bb17bd28cd0b288dc3213Kristina Sojakova * @file mod_proxy.h
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova * @brief Proxy Extension Module for Apache
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova *
b2e01ef1b5d4c7a62260eb792291e8e1b10e545bIulia Ignatov * @defgroup MOD_PROXY mod_proxy
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova * @ingroup APACHE_MODS
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova * @{
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova */
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova
d71bb9deea089887b4fd829c5b766e7e4de9f204Kristina Sojakova/*
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova Also note numerous FIXMEs and CHECKMEs which should be eliminated.
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova This code is once again experimental!
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova Things to do:
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova
b43458b4d81f7451112cecbd757f3a05216e7088Kristina Sojakova 1. Make it completely work (for FTP too)
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova 2. HTTP/1.1
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova Chuck Murcko <chuck@topsail.org> 02-06-01
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova */
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#define CORE_PRIVATE
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "apr_hooks.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "apr.h"
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova#include "apr_lib.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_strings.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_buckets.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_md5.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_network_io.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_pools.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_strings.h"
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder#include "apr_uri.h"
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#include "apr_date.h"
b43458b4d81f7451112cecbd757f3a05216e7088Kristina Sojakova#include "apr_strmatch.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "apr_fnmatch.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "apr_reslist.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#define APR_WANT_STRFUNC
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "apr_want.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "httpd.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "http_config.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "ap_config.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "http_core.h"
abd5fc85dc7e19b1614890182436940e922963a4Kristina Sojakova#include "http_protocol.h"
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova#include "http_request.h"
14650c9e129d8dc51ed55b2edc6ec27d9f0f6d00Kristina Sojakova#include "http_vhost.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "http_main.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "http_log.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "http_connection.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "util_filter.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include "util_ebcdic.h"
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#if APR_HAVE_NETINET_IN_H
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#include <netinet/in.h>
abd5fc85dc7e19b1614890182436940e922963a4Kristina Sojakova#endif
ccaa75089b23c0f043cdbd4001cba4e076ca4fd3Kristina Sojakova#if APR_HAVE_ARPA_INET_H
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder#include <arpa/inet.h>
80d2ec8f37d5ddec13c14b17b1bab01e9c94630aChristian Maeder#endif
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder
d71bb9deea089887b4fd829c5b766e7e4de9f204Kristina Sojakova/* for proxy_canonenc() */
168d206b4e5fd436c98239a1b6629c651f54c8eeKristina Sojakovaenum enctype {
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder enc_path, enc_search, enc_user, enc_fpath, enc_parm
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder};
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#if APR_CHARSET_EBCDIC
d2786879b4733fd4886a5b654f7c6de1d234f638Kristina Sojakova#define CRLF "\r\n"
abd5fc85dc7e19b1614890182436940e922963a4Kristina Sojakova#else /*APR_CHARSET_EBCDIC*/
b3bacd257ffcdd346b70ab690f03b28ad5f33fdcKristina Sojakova#define CRLF "\015\012"
b3bacd257ffcdd346b70ab690f03b28ad5f33fdcKristina Sojakova#endif /*APR_CHARSET_EBCDIC*/
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder
b3bacd257ffcdd346b70ab690f03b28ad5f33fdcKristina Sojakova/* default Max-Forwards header setting */
b3bacd257ffcdd346b70ab690f03b28ad5f33fdcKristina Sojakova#define DEFAULT_MAX_FORWARDS 10
a669e4685b32ff5ca1bca785eacc5e30a545b010Christian Maeder
b3bacd257ffcdd346b70ab690f03b28ad5f33fdcKristina Sojakova/* static information about a remote proxy */
d71bb9deea089887b4fd829c5b766e7e4de9f204Kristina Sojakovastruct proxy_remote {
abd5fc85dc7e19b1614890182436940e922963a4Kristina Sojakova const char *scheme; /* the schemes handled by this proxy, or '*' */
168d206b4e5fd436c98239a1b6629c651f54c8eeKristina Sojakova const char *protocol; /* the scheme used to talk to this proxy */
80d2ec8f37d5ddec13c14b17b1bab01e9c94630aChristian Maeder const char *hostname; /* the hostname of this proxy */
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova apr_port_t port; /* the port for this proxy */
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova ap_regex_t *regexp; /* compiled regex (if any) for the remote */
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova int use_regex; /* simple boolean. True if we have a regex pattern */
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova};
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakovastruct proxy_alias {
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova const char *real;
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova const char *fake;
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova};
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova
abd5fc85dc7e19b1614890182436940e922963a4Kristina Sojakovastruct dirconn_entry {
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova char *name;
e8dd447a2aa5fbac10668749dfe4142c05ec3d7dKristina Sojakova struct in_addr addr, mask;
5e35940c3516ccea02caa0450d2b075de0106fa5Kristina Sojakova struct apr_sockaddr_t *hostaddr;
5e35940c3516ccea02caa0450d2b075de0106fa5Kristina Sojakova int (*matcher) (struct dirconn_entry * This, request_rec *r);
5e35940c3516ccea02caa0450d2b075de0106fa5Kristina Sojakova};
2cb6df4f21c52732336579a79f7e5d28299b3500Iulia Ignatov
2cb6df4f21c52732336579a79f7e5d28299b3500Iulia Ignatovstruct noproxy_entry {
b2e01ef1b5d4c7a62260eb792291e8e1b10e545bIulia Ignatov const char *name;
b2e01ef1b5d4c7a62260eb792291e8e1b10e545bIulia Ignatov struct apr_sockaddr_t *addr;
};
typedef struct proxy_balancer proxy_balancer;
typedef struct proxy_worker proxy_worker;
typedef struct proxy_conn_pool proxy_conn_pool;
typedef struct proxy_balancer_method proxy_balancer_method;
typedef struct {
apr_array_header_t *proxies;
apr_array_header_t *sec_proxy;
apr_array_header_t *aliases;
apr_array_header_t *noproxies;
apr_array_header_t *dirconn;
apr_array_header_t *allowed_connect_ports;
apr_array_header_t *workers;
apr_array_header_t *balancers;
proxy_worker *forward; /* forward proxy worker */
proxy_worker *reverse; /* reverse "module-driven" proxy worker */
const char *domain; /* domain name to use in absence of a domain name in the request */
int req; /* true if proxy requests are enabled */
char req_set;
enum {
via_off,
via_on,
via_block,
via_full
} viaopt; /* how to deal with proxy Via: headers */
char viaopt_set;
apr_size_t recv_buffer_size;
char recv_buffer_size_set;
apr_size_t io_buffer_size;
char io_buffer_size_set;
long maxfwd;
char maxfwd_set;
/**
* the following setting masks the error page
* returned from the 'proxied server' and just
* forwards the status code upwards.
* This allows the main server (us) to generate
* the error page, (so it will look like a error
* returned from the rest of the system
*/
int error_override;
int error_override_set;
int preserve_host;
int preserve_host_set;
apr_interval_time_t timeout;
char timeout_set;
enum {
bad_error,
bad_ignore,
bad_body
} badopt; /* how to deal with bad headers */
char badopt_set;
/* putting new stuff on the end maximises binary back-compatibility.
* the strmatch_patterns are really a const just to have a
* case-independent strstr.
*/
enum {
status_off,
status_on,
status_full
} proxy_status; /* Status display options */
char proxy_status_set;
apr_pool_t *pool; /* Pool used for allocating this struct */
apr_array_header_t *lbmethods;
} proxy_server_conf;
typedef struct {
const char *p; /* The path */
int p_is_fnmatch; /* Is this path an fnmatch candidate? */
ap_regex_t *r; /* Is this a regex? */
/* ProxyPassReverse and friends are documented as working inside
* <Location>. But in fact they never have done in the case of
* more than one <Location>, because the server_conf can't see it.
* We need to move them to the per-dir config.
* Discussed in February:
* http://marc.theaimsgroup.com/?l=apache-httpd-dev&m=110726027118798&w=2
*/
apr_array_header_t *raliases;
apr_array_header_t* cookie_paths;
apr_array_header_t* cookie_domains;
const apr_strmatch_pattern* cookie_path_str;
const apr_strmatch_pattern* cookie_domain_str;
} proxy_dir_conf;
typedef struct {
conn_rec *connection;
const char *hostname;
apr_port_t port;
int is_ssl;
apr_pool_t *pool; /* Subpool used for creating socket */
apr_socket_t *sock; /* Connection socket */
apr_sockaddr_t *addr; /* Preparsed remote address info */
apr_uint32_t flags; /* Conection flags */
int close; /* Close 'this' connection */
int close_on_recycle; /* Close the connection when returning to pool */
proxy_worker *worker; /* Connection pool this connection belogns to */
void *data; /* per scheme connection data */
} proxy_conn_rec;
typedef struct {
float cache_completion; /* completion percentage */
int content_length; /* length of the content */
} proxy_completion;
/* Connection pool */
struct proxy_conn_pool {
apr_pool_t *pool; /* The pool used in constructor and destructor calls */
apr_sockaddr_t *addr; /* Preparsed remote address info */
#if APR_HAS_THREADS
apr_reslist_t *res; /* Connection resource list */
#endif
proxy_conn_rec *conn; /* Single connection for prefork mpm's */
};
/* woker status flags */
#define PROXY_WORKER_INITIALIZED 0x0001
#define PROXY_WORKER_IGNORE_ERRORS 0x0002
#define PROXY_WORKER_IN_SHUTDOWN 0x0010
#define PROXY_WORKER_DISABLED 0x0020
#define PROXY_WORKER_STOPPED 0x0040
#define PROXY_WORKER_IN_ERROR 0x0080
#define PROXY_WORKER_IS_USABLE(f) (!((f)->s->status & 0x00F0))
/* default worker retry timeout in seconds */
#define PROXY_WORKER_DEFAULT_RETRY 60
#define PROXY_WORKER_MAX_ROUTE_SIZ 63
/* Runtime worker status informations. Shared in scoreboard */
typedef struct {
int status;
apr_time_t error_time; /* time of the last error */
int retries; /* number of retries on this worker */
int lbstatus; /* Current lbstatus */
int lbfactor; /* dynamic lbfactor */
apr_off_t transferred;/* Number of bytes transferred to remote */
apr_off_t read; /* Number of bytes read from remote */
apr_size_t elected; /* Number of times the worker was elected */
char route[PROXY_WORKER_MAX_ROUTE_SIZ+1];
char redirect[PROXY_WORKER_MAX_ROUTE_SIZ+1];
void *context; /* general purpose storage */
} proxy_worker_stat;
/* Worker configuration */
struct proxy_worker {
int id; /* scoreboard id */
apr_interval_time_t retry; /* retry interval */
int lbfactor; /* initial load balancing factor */
const char *name;
const char *scheme; /* scheme to use ajp|http|https */
const char *hostname; /* remote backend address */
const char *route; /* balancing route */
const char *redirect; /* temporary balancing redirection route */
int status; /* temporary worker status */
apr_port_t port;
int min; /* Desired minimum number of available connections */
int smax; /* Soft maximum on the total number of connections */
int hmax; /* Hard maximum on the total number of connections */
apr_interval_time_t ttl; /* maximum amount of time in seconds a connection
* may be available while exceeding the soft limit */
apr_interval_time_t timeout; /* connection timeout */
char timeout_set;
apr_interval_time_t acquire; /* acquire timeout when the maximum number of connections is exceeded */
char acquire_set;
apr_size_t recv_buffer_size;
char recv_buffer_size_set;
apr_size_t io_buffer_size;
char io_buffer_size_set;
char keepalive;
char keepalive_set;
proxy_conn_pool *cp; /* Connection pool to use */
proxy_worker_stat *s; /* Shared data */
void *opaque; /* per scheme worker data */
int is_address_reusable;
#if APR_HAS_THREADS
apr_thread_mutex_t *mutex; /* Thread lock for updating address cache */
#endif
void *context; /* general purpose storage */
};
struct proxy_balancer {
apr_array_header_t *workers; /* array of proxy_workers */
const char *name; /* name of the load balancer */
const char *sticky; /* sticky session identifier */
int sticky_force; /* Disable failover for sticky sessions */
apr_interval_time_t timeout; /* Timeout for waiting on free connection */
int max_attempts; /* Number of attempts before failing */
char max_attempts_set;
proxy_balancer_method *lbmethod;
/* XXX: Perhaps we will need the proc mutex too.
* Altrough we are only using arithmetic operations
* it may lead to a incorrect calculations.
* For now use only the thread mutex.
*/
#if APR_HAS_THREADS
apr_thread_mutex_t *mutex; /* Thread lock for updating lb params */
#endif
void *context; /* general purpose storage */
};
struct proxy_balancer_method {
const char *name; /* name of the load balancer method*/
proxy_worker *(*finder)(proxy_balancer *balancer,
request_rec *r);
void *context; /* general purpose storage */
};
#if APR_HAS_THREADS
#define PROXY_THREAD_LOCK(x) apr_thread_mutex_lock((x)->mutex)
#define PROXY_THREAD_UNLOCK(x) apr_thread_mutex_unlock((x)->mutex)
#else
#define PROXY_THREAD_LOCK(x) APR_SUCCESS
#define PROXY_THREAD_UNLOCK(x) APR_SUCCESS
#endif
/* hooks */
/* Create a set of PROXY_DECLARE(type), PROXY_DECLARE_NONSTD(type) and
* PROXY_DECLARE_DATA with appropriate export and import tags for the platform
*/
#if !defined(WIN32)
#define PROXY_DECLARE(type) type
#define PROXY_DECLARE_NONSTD(type) type
#define PROXY_DECLARE_DATA
#elif defined(PROXY_DECLARE_STATIC)
#define PROXY_DECLARE(type) type __stdcall
#define PROXY_DECLARE_NONSTD(type) type
#define PROXY_DECLARE_DATA
#elif defined(PROXY_DECLARE_EXPORT)
#define PROXY_DECLARE(type) __declspec(dllexport) type __stdcall
#define PROXY_DECLARE_NONSTD(type) __declspec(dllexport) type
#define PROXY_DECLARE_DATA __declspec(dllexport)
#else
#define PROXY_DECLARE(type) __declspec(dllimport) type __stdcall
#define PROXY_DECLARE_NONSTD(type) __declspec(dllimport) type
#define PROXY_DECLARE_DATA __declspec(dllimport)
#endif
/**
* Hook an optional proxy hook. Unlike static hooks, this uses a macro
* instead of a function.
*/
#define PROXY_OPTIONAL_HOOK(name,fn,pre,succ,order) \
APR_OPTIONAL_HOOK(proxy,name,fn,pre,succ,order)
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, scheme_handler, (request_rec *r,
proxy_worker *worker, proxy_server_conf *conf, char *url,
const char *proxyhost, apr_port_t proxyport))
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, canon_handler, (request_rec *r,
char *url))
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, create_req, (request_rec *r, request_rec *pr))
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, fixups, (request_rec *r))
/**
* pre request hook.
* It will return the most suitable worker at the moment
* and coresponding balancer.
* The url is rewritten from balancer://cluster/uri to scheme://host:port/uri
* and then the scheme_handler is called.
*
*/
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, pre_request, (proxy_worker **worker,
proxy_balancer **balancer,
request_rec *r,
proxy_server_conf *conf, char **url))
/**
* post request hook.
* It is called after request for updating runtime balancer status.
*/
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, post_request, (proxy_worker *worker,
proxy_balancer *balancer, request_rec *r,
proxy_server_conf *conf))
/**
* request status hook
* It is called after all proxy processing has been done. This gives other
* modules a chance to create default content on failure, for example
*/
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, request_status,
(int *status, request_rec *r))
/* proxy_util.c */
PROXY_DECLARE(request_rec *)ap_proxy_make_fake_req(conn_rec *c, request_rec *r);
PROXY_DECLARE(int) ap_proxy_hex2c(const char *x);
PROXY_DECLARE(void) ap_proxy_c2hex(int ch, char *x);
PROXY_DECLARE(char *)ap_proxy_canonenc(apr_pool_t *p, const char *x, int len, enum enctype t,
int forcedec, int proxyreq);
PROXY_DECLARE(char *)ap_proxy_canon_netloc(apr_pool_t *p, char **const urlp, char **userp,
char **passwordp, char **hostp, apr_port_t *port);
PROXY_DECLARE(const char *)ap_proxy_date_canon(apr_pool_t *p, const char *x);
PROXY_DECLARE(int) ap_proxy_liststr(const char *list, const char *val);
PROXY_DECLARE(char *)ap_proxy_removestr(apr_pool_t *pool, const char *list, const char *val);
PROXY_DECLARE(int) ap_proxy_hex2sec(const char *x);
PROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y);
PROXY_DECLARE(int) ap_proxyerror(request_rec *r, int statuscode, const char *message);
PROXY_DECLARE(int) ap_proxy_is_ipaddr(struct dirconn_entry *This, apr_pool_t *p);
PROXY_DECLARE(int) ap_proxy_is_domainname(struct dirconn_entry *This, apr_pool_t *p);
PROXY_DECLARE(int) ap_proxy_is_hostname(struct dirconn_entry *This, apr_pool_t *p);
PROXY_DECLARE(int) ap_proxy_is_word(struct dirconn_entry *This, apr_pool_t *p);
PROXY_DECLARE(int) ap_proxy_checkproxyblock(request_rec *r, proxy_server_conf *conf, apr_sockaddr_t *uri_addr);
PROXY_DECLARE(int) ap_proxy_pre_http_request(conn_rec *c, request_rec *r);
PROXY_DECLARE(apr_status_t) ap_proxy_string_read(conn_rec *c, apr_bucket_brigade *bb, char *buff, size_t bufflen, int *eos);
PROXY_DECLARE(void) ap_proxy_table_unmerge(apr_pool_t *p, apr_table_t *t, char *key);
/* DEPRECATED (will be replaced with ap_proxy_connect_backend */
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 *);
PROXY_DECLARE(int) ap_proxy_ssl_enable(conn_rec *c);
PROXY_DECLARE(int) ap_proxy_ssl_disable(conn_rec *c);
PROXY_DECLARE(int) ap_proxy_conn_is_https(conn_rec *c);
PROXY_DECLARE(const char *) ap_proxy_ssl_val(apr_pool_t *p, server_rec *s, conn_rec *c, request_rec *r, const char *var);
/* Header mapping functions, and a typedef of their signature */
PROXY_DECLARE(const char *) ap_proxy_location_reverse_map(request_rec *r, proxy_dir_conf *conf, const char *url);
PROXY_DECLARE(const char *) ap_proxy_cookie_reverse_map(request_rec *r, proxy_dir_conf *conf, const char *str);
#if !defined(WIN32)
typedef const char *(*ap_proxy_header_reverse_map_fn)(request_rec *,
proxy_dir_conf *, const char *);
#elif defined(PROXY_DECLARE_STATIC)
typedef const char *(__stdcall *ap_proxy_header_reverse_map_fn)(request_rec *,
proxy_dir_conf *, const char *);
#elif defined(PROXY_DECLARE_EXPORT)
typedef __declspec(dllexport) const char *
(__stdcall *ap_proxy_header_reverse_map_fn)(request_rec *,
proxy_dir_conf *, const char *);
#else
typedef __declspec(dllimport) const char *
(__stdcall *ap_proxy_header_reverse_map_fn)(request_rec *,
proxy_dir_conf *, const char *);
#endif
/* Connection pool API */
/**
* Get the worker from proxy configuration
* @param p memory pool used for finding worker
* @param conf current proxy server configuration
* @param url url to find the worker from
* @return proxy_worker or NULL if not found
*/
PROXY_DECLARE(proxy_worker *) ap_proxy_get_worker(apr_pool_t *p,
proxy_server_conf *conf,
const char *url);
/**
* Add the worker to proxy configuration
* @param worker the new worker
* @param p memory pool to allocate worker from
* @param conf current proxy server configuration
* @param url url containing worker name
* @return error message or NULL if successfull
*/
PROXY_DECLARE(const char *) ap_proxy_add_worker(proxy_worker **worker,
apr_pool_t *p,
proxy_server_conf *conf,
const char *url);
/**
* Create new worker
* @param p memory pool to allocate worker from
* @return new worker
*/
PROXY_DECLARE(proxy_worker *) ap_proxy_create_worker(apr_pool_t *p);
/**
* Initize the worker's shared data
* @param conf current proxy server configuration
* @param worker worker to initialize
* @param s current server record
* @param worker worker to initialize
*/
PROXY_DECLARE(void) ap_proxy_initialize_worker_share(proxy_server_conf *conf,
proxy_worker *worker,
server_rec *s);
/**
* Initize the worker
* @param worker worker to initialize
* @param s current server record
* @return APR_SUCCESS or error code
*/
PROXY_DECLARE(apr_status_t) ap_proxy_initialize_worker(proxy_worker *worker,
server_rec *s);
/**
* Get the balancer from proxy configuration
* @param p memory pool used for finding balancer
* @param conf current proxy server configuration
* @param url url to find the worker from. Has to have balancer:// prefix
* @return proxy_balancer or NULL if not found
*/
PROXY_DECLARE(proxy_balancer *) ap_proxy_get_balancer(apr_pool_t *p,
proxy_server_conf *conf,
const char *url);
/**
* Add the balancer to proxy configuration
* @param balancer the new balancer
* @param p memory pool to allocate balancer from
* @param conf current proxy server configuration
* @param url url containing balancer name
* @return error message or NULL if successfull
*/
PROXY_DECLARE(const char *) ap_proxy_add_balancer(proxy_balancer **balancer,
apr_pool_t *p,
proxy_server_conf *conf,
const char *url);
/**
* Add the worker to the balancer
* @param pool memory pool for adding worker
* @param balancer balancer to add to
* @param balancer worker to add
* @note Single worker can be added to multiple balancers.
*/
PROXY_DECLARE(void) ap_proxy_add_worker_to_balancer(apr_pool_t *pool,
proxy_balancer *balancer,
proxy_worker *worker);
/**
* Get the most suitable worker and(or) balancer for the request
* @param worker worker used for processing request
* @param balancer balancer used for processing request
* @param r current request
* @param conf current proxy server configuration
* @param url request url that balancer can rewrite.
* @return OK or HTTP_XXX error
* @note It calls balancer pre_request hook if the url starts with balancer://
* The balancer then rewrites the url to particular worker, like http://host:port
*/
PROXY_DECLARE(int) ap_proxy_pre_request(proxy_worker **worker,
proxy_balancer **balancer,
request_rec *r,
proxy_server_conf *conf,
char **url);
/**
* Post request worker and balancer cleanup
* @param worker worker used for processing request
* @param balancer balancer used for processing request
* @param r current request
* @param conf current proxy server configuration
* @return OK or HTTP_XXX error
* @note When ever the pre_request is called, the post_request has to be
* called too.
*/
PROXY_DECLARE(int) ap_proxy_post_request(proxy_worker *worker,
proxy_balancer *balancer,
request_rec *r,
proxy_server_conf *conf);
/**
* Request status function
* @param status status of proxy request
* @return OK or DECLINED
*/
PROXY_DECLARE(int) ap_proxy_request_status(int *status, request_rec *r);
/**
* Deternime backend hostname and port
* @param p memory pool used for processing
* @param r current request
* @param conf current proxy server configuration
* @param worker worker used for processing request
* @param conn proxy connection struct
* @param uri processed uri
* @param url request url
* @param proxyname are we connecting directly or via s proxy
* @param proxyport proxy host port
* @param server_portstr Via headers server port
* @param server_portstr_size size of the server_portstr buffer
* @return OK or HTTP_XXX error
*/
PROXY_DECLARE(int) ap_proxy_determine_connection(apr_pool_t *p, request_rec *r,
proxy_server_conf *conf,
proxy_worker *worker,
proxy_conn_rec *conn,
apr_uri_t *uri,
char **url,
const char *proxyname,
apr_port_t proxyport,
char *server_portstr,
int server_portstr_size);
/**
* Mark a worker for retry
* @param proxy_function calling proxy scheme (http, ajp, ...)
* @param conf current proxy server configuration
* @param worker worker used for retrying
* @param s current server record
* @return OK if marked for retry, DECLINED otherwise
* @note Worker will be marker for retry if the time of the last retry
* has been ellapsed. In case there is no retry option set, defaults to
* number_of_retries seconds.
*/
PROXY_DECLARE(int) ap_proxy_retry_worker(const char *proxy_function,
proxy_worker *worker,
server_rec *s);
/**
* Acquire a connection from workers connection pool
* @param proxy_function calling proxy scheme (http, ajp, ...)
* @param conn acquired connection
* @param worker worker used for obtaining connection
* @param s current server record
* @return OK or HTTP_XXX error
* @note If the number of connections is exhaused the function will
* block untill the timeout is reached.
*/
PROXY_DECLARE(int) ap_proxy_acquire_connection(const char *proxy_function,
proxy_conn_rec **conn,
proxy_worker *worker,
server_rec *s);
/**
* Release a connection back to worker connection pool
* @param proxy_function calling proxy scheme (http, ajp, ...)
* @param conn acquired connection
* @param s current server record
* @return OK or HTTP_XXX error
* @note The connection will be closed if conn->close_on_release is set
*/
PROXY_DECLARE(int) ap_proxy_release_connection(const char *proxy_function,
proxy_conn_rec *conn,
server_rec *s);
/**
* Make a connection to the backend
* @param proxy_function calling proxy scheme (http, ajp, ...)
* @param conn acquired connection
* @param worker connection worker
* @param s current server record
* @return OK or HTTP_XXX error
* @note In case the socket already exists for conn, just check the link
* status.
*/
PROXY_DECLARE(int) ap_proxy_connect_backend(const char *proxy_function,
proxy_conn_rec *conn,
proxy_worker *worker,
server_rec *s);
/**
* Make a connection record for backend connection
* @param proxy_function calling proxy scheme (http, ajp, ...)
* @param conn acquired connection
* @param c client connection record
* @param s current server record
* @return OK or HTTP_XXX error
*/
PROXY_DECLARE(int) ap_proxy_connection_create(const char *proxy_function,
proxy_conn_rec *conn,
conn_rec *c, server_rec *s);
/**
* Load in available lb methods
* @param conf server conf
* @return OK or HTTP_XXX error
*/
PROXY_DECLARE(int) ap_proxy_add_lbmethods(proxy_server_conf *conf);
/* Scoreboard */
#if MODULE_MAGIC_NUMBER_MAJOR > 20020903
#define PROXY_HAS_SCOREBOARD 1
#else
#define PROXY_HAS_SCOREBOARD 0
#endif
/* The number of dynamic workers that can be added when reconfiguring.
* If this limit is reached you must stop and restart the server.
*/
#define PROXY_DYNAMIC_BALANCER_LIMIT 16
/**
* Calculate number of maximum number of workers in scoreboard.
* @return number of workers to allocate in the scoreboard
*/
int ap_proxy_lb_workers(void);
/* For proxy_util */
extern module PROXY_DECLARE_DATA proxy_module;
extern int PROXY_DECLARE_DATA proxy_lb_workers;
#endif /*MOD_PROXY_H*/
/** @} */