proxy_util.c revision a8e2723cc0f2000dcc6bb4b6e8ef4e569e9b6681
/* Copyright 1999-2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* Utility routines for Apache proxy */
#include "mod_proxy.h"
#include "ap_mpm.h"
#include "apr_version.h"
#if (APR_MAJOR_VERSION < 1)
#endif
/* already called in the knowledge that the characters are hex digits */
PROXY_DECLARE(int) ap_proxy_hex2c(const char *x)
{
int i, ch;
#if !APR_CHARSET_EBCDIC
ch = x[0];
if (apr_isdigit(ch))
i = ch - '0';
else if (apr_isupper(ch))
else
i <<= 4;
ch = x[1];
if (apr_isdigit(ch))
i += ch - '0';
else if (apr_isupper(ch))
else
return i;
#else /*APR_CHARSET_EBCDIC*/
/* we assume that the hex value refers to an ASCII character
* so convert to EBCDIC so that it makes sense locally;
*
* example:
*
* client specifies %20 in URL to refer to a space char;
* at this point we're called with EBCDIC "20"; after turning
* EBCDIC "20" into binary 0x20, we then need to assume that 0x20
* represents an ASCII char and convert 0x20 to EBCDIC, yielding
* 0x40
*/
char buf[1];
buf[0] = i & 0xFF;
return buf[0];
}
else {
return 0;
}
#endif /*APR_CHARSET_EBCDIC*/
}
{
#if !APR_CHARSET_EBCDIC
int i;
x[0] = '%';
if (i >= 10)
x[1] = ('A' - 10) + i;
else
x[1] = '0' + i;
i = ch & 0x0F;
if (i >= 10)
x[2] = ('A' - 10) + i;
else
x[2] = '0' + i;
#else /*APR_CHARSET_EBCDIC*/
static const char ntoa[] = { "0123456789ABCDEF" };
char buf[1];
ch &= 0xFF;
x[0] = '%';
x[3] = '\0';
#endif /*APR_CHARSET_EBCDIC*/
}
/*
* canonicalise a URL-encoded string
*/
/*
* Convert a URL-encoded string to canonical form.
* It decodes characters which need not be encoded,
* and encodes those which must be encoded, and does not touch
* those which must not be touched.
*/
int isenc)
{
int i, j, ch;
char *y;
char *allowed; /* characters which should not be encoded */
/* N.B. in addition to :@&=, this allows ';' in an http path
* and '?' in an ftp path -- this may be revised
*
* Also, it makes a '+' character in a search string reserved, as
* it may be form-encoded. (Although RFC 1738 doesn't allow this -
* it only permits ; / ? : @ = & as reserved chars.)
*/
if (t == enc_path)
allowed = "$-_.+!*'(),;:@&=";
else if (t == enc_search)
allowed = "$-_.!*'(),;:@&=";
else if (t == enc_user)
allowed = "$-_.+!*'(),;@&=";
else if (t == enc_fpath)
allowed = "$-_.+!*'(),?:@&=";
else /* if (t == enc_parm) */
allowed = "$-_.+!*'(),?/:@&=";
if (t == enc_path)
reserved = "/";
else if (t == enc_search)
reserved = "+";
else
reserved = "";
for (i = 0, j = 0; i < len; i++, j++) {
/* always handle '/' first */
ch = x[i];
y[j] = ch;
continue;
}
/* decode it if not already done */
return NULL;
i += 2;
ap_proxy_c2hex(ch, &y[j]);
j += 2;
continue;
}
}
/* recode it, if necessary */
ap_proxy_c2hex(ch, &y[j]);
j += 2;
}
else
y[j] = ch;
}
y[j] = '\0';
return y;
}
/*
* Parses network-location.
* urlp on input the URL; on output the path, after the leading /
* password holder for password
* host holder for host
* port port number; only set if one is supplied.
*
* Returns an error string.
*/
PROXY_DECLARE(char *)
{
return "Malformed URL";
url = "";
else
*strp = '\0';
/* find password */
*strp = '\0';
return "Bad %-escape in URL (password)";
}
return "Bad %-escape in URL (username)";
}
}
}
/* Parse the host string to separate host portion from optional port.
* Perform range checking on port.
*/
}
if (tmp_port != 0) { /* only update caller's port if port was specified */
}
return NULL;
}
static const char * const lwday[7] =
{"Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"};
/*
* If the date is a valid RFC 850 date or asctime() date, then it
* is converted to the RFC 1123 format, otherwise it is not modified.
* This routine is not very fast at doing conversions, as it uses
* sscanf and sprintf. However, if the date is already correctly
* formatted, then it exits very quickly.
*/
PROXY_DECLARE(const char *)
{
char *x = apr_pstrdup(p, x1);
q = strchr(x, ',');
/* check for RFC 850 date */
*q = '\0';
break;
*q = ',';
if (wk == 7)
return x; /* not a valid date */
if (q[4] != '-' || q[8] != '-' || q[11] != ' ' || q[14] != ':' ||
return x;
return x;
if (year < 70)
year += 2000;
else
year += 1900;
}
else {
/* check for acstime() date */
if (x[3] != ' ' || x[7] != ' ' || x[10] != ' ' || x[13] != ':' ||
x[16] != ':' || x[19] != ' ' || x[24] != '\0')
return x;
return x;
break;
if (wk == 7)
return x;
}
/* check date */
break;
if (mon == 12)
return x;
q = apr_palloc(p, 30);
return q;
}
{
rp->connection = c;
proxy_run_create_req(r, rp);
return rp;
}
/*
* list is a comma-separated list of case-insensitive tokens, with
* optional whitespace around the tokens.
* The return returns 1 if the token val is found in the list, or 0
* otherwise.
*/
{
int len, i;
const char *p;
if (p != NULL) {
i = p - list;
do
p++;
while (apr_isspace(*p));
}
else
i--;
return 1;
list = p;
}
return 0;
}
/*
* list is a comma-separated list of case-insensitive tokens, with
* optional whitespace around the tokens.
* if val appears on the list of tokens, it is removed from the list,
* and the new list is returned.
*/
{
int len, i;
const char *p;
if (p != NULL) {
i = p - list;
do
p++;
while (apr_isspace(*p));
}
else
i--;
/* do nothing */
}
else {
if (new)
else
}
list = p;
}
return new;
}
/*
* Converts 8 hex digits to a time integer
*/
PROXY_DECLARE(int) ap_proxy_hex2sec(const char *x)
{
int i, ch;
unsigned int j;
for (i = 0, j = 0; i < 8; i++) {
ch = x[i];
j <<= 4;
if (apr_isdigit(ch))
j |= ch - '0';
else if (apr_isupper(ch))
else
}
if (j == 0xffffffff)
return -1; /* so that it works with 8-byte ints */
else
return j;
}
/*
* Converts a time integer to 8 hex digits
*/
PROXY_DECLARE(void) ap_proxy_sec2hex(int t, char *y)
{
int i, ch;
unsigned int j = t;
for (i = 7; i >= 0; i--) {
ch = j & 0xF;
j >>= 4;
if (ch >= 10)
else
y[i] = ch + '0';
}
y[8] = '\0';
}
{
apr_pstrcat(r->pool,
"The proxy server could not handle the request "
" ",
"Reason: <strong>",
"</strong></p>", NULL));
/* Allow "error-notes" string to be printed by ap_send_error_response() */
return statuscode;
}
static const char *
{
return r->hostname;
/* Set url to the first char after "scheme://" */
return NULL;
url = apr_pstrdup(r->pool, &url[1]); /* make it point to "//", which is what proxy_canon_netloc expects */
"%s", err);
return host; /* ought to return the port, too */
}
/* Return TRUE if addr represents an IP address (or an IP network address) */
{
long ip_addr[4];
int i, quads;
long bits;
/* if the address is given with an explicit netmask, use that */
/* Due to a deficiency in apr_inet_addr(), it is impossible to parse */
/* "partial" addresses (with less than 4 quads) correctly, i.e. */
/* 192.168.123 is parsed as 192.168.0.123, which is not what I want. */
/* I therefore have to parse the IP address manually: */
/* addr and mask were set by proxy_readmask() */
/*return 1; */
/* Parse IP addr manually, optionally allowing */
/* abbreviated net addresses like 192.168. */
/* Iterate over up to 4 (dotted) quads. */
char *tmp;
break;
if (!apr_isdigit(*addr))
return 0; /* no digit at start of quad */
return 0;
/* invalid octet */
return 0;
}
++addr; /* after the 4th quad, a dot would be illegal */
}
char *tmp;
++addr;
return 0;
return 0;
}
else {
/* Determine (i.e., "guess") netmask by counting the */
/* number of trailing .0's; reduce #quads appropriately */
/* (so that 192.168.0.0 is equivalent to 192.168.) */
--quads;
/* "IP Address should be given in dotted-quad form, optionally followed by a netmask (e.g., 192.168.111.0/24)"; */
if (quads < 1)
return 0;
/* every zero-byte counts as 8 zero-bits */
"Warning: NetMask not supplied with IP-Addr; guessing: %s/%ld\n",
}
"Warning: NetMask and IP-Addr disagree in %s/%ld\n",
" Set to %s/%ld\n",
}
if (*addr == '\0') {
return 1;
}
else
}
/* Return TRUE if addr represents an IP address (or an IP network address) */
{
int i, ip_addr[4];
const char *host = proxy_get_host_of_request(r);
return 0;
#if DEBUGGING
#endif
return 1;
}
#if DEBUGGING
else {
}
#endif
}
else {
struct apr_sockaddr_t *reqaddr;
!= APR_SUCCESS) {
#if DEBUGGING
"2)IP-NoMatch: hostname=%s msg=Host not found",
host);
#endif
return 0;
}
/* Try to deal with multiple IP addr's for a host */
/* FIXME: This needs to be able to deal with IPv6 */
while (reqaddr) {
#if DEBUGGING
"3)IP-Match: %s[%s] <-> ", host,
#endif
return 1;
}
#if DEBUGGING
else {
"3)IP-NoMatch: %s[%s] <-> ", host,
}
#endif
}
}
return 0;
}
/* Return TRUE if addr represents a domain name */
{
int i;
/* Domain name must start with a '.' */
if (addr[0] != '.')
return 0;
/* rfc1035 says DNS names must consist of "[-a-zA-Z0-9]" and '.' */
continue;
#if 0
if (addr[i] == ':') {
"@@@@ handle optional port in proxy_is_domainname()");
/* @@@@ handle optional port */
}
#endif
if (addr[i] != '\0')
return 0;
/* Strip trailing dots */
addr[i] = '\0';
return 1;
}
/* Return TRUE if host "host" is in domain "domain" */
{
const char *host = proxy_get_host_of_request(r);
return 0;
/* @@@ do this within the setup? */
/* Ignore trailing dots in domain comparison: */
--d_len;
--h_len;
}
/* Return TRUE if host represents a host name */
{
struct apr_sockaddr_t *addr;
int i;
/* Host names must not start with a '.' */
if (host[0] == '.')
return 0;
/* rfc1035 says DNS names must consist of "[-a-zA-Z0-9]" and '.' */
return 0;
/* Strip trailing dots */
host[i] = '\0';
return 1;
}
/* Return TRUE if host "host" is equal to host2 "host2" */
{
const char *host2 = proxy_get_host_of_request(r);
int h2_len;
int h1_len;
return 0; /* oops! */
#if 0
/* Try to deal with multiple IP addr's for a host */
while (addr) {
if (addr->ipaddr_ptr == ? ? ? ? ? ? ? ? ? ? ? ? ?)
return 1;
}
#endif
/* Ignore trailing dots in host2 comparison: */
--h2_len;
--h1_len;
}
/* Return TRUE if addr is to be matched as a word */
{
return 1;
}
/* Return TRUE if string "str2" occurs literally in "str1" */
{
const char *host = proxy_get_host_of_request(r);
}
/* checks whether a host in uri_addr matches proxyblock */
{
int j;
/* XXX FIXME: conf->noproxies->elts is part of an opaque structure */
return HTTP_FORBIDDEN;
}
while (conf_addr) {
while (uri_addr) {
char *conf_ip;
char *uri_ip;
return HTTP_FORBIDDEN;
}
}
}
}
return OK;
}
/* set up the minimal filter set */
{
return OK;
}
/* converts a series of buckets into a string
* XXX: BillS says this function performs essentially the same function as
* ap_rgetline() in protocol.c. Deprecate this function and use ap_rgetline()
* instead? I think ap_proxy_string_read() will not work properly on non ASCII
* (EBCDIC) machines either.
*/
{
apr_bucket *e;
char *response;
int found = 0;
/* start with an empty string */
buff[0] = 0;
*eos = 0;
/* loop through each brigade */
while (!found) {
/* get brigade from network one line at a time */
0))) {
return rv;
}
/* loop through each bucket */
while (!found) {
/* The connection aborted or timed out */
return APR_ECONNABORTED;
}
e = APR_BRIGADE_FIRST(bb);
if (APR_BUCKET_IS_EOS(e)) {
*eos = 1;
}
else {
return rv;
}
/* is string LF terminated?
* XXX: This check can be made more efficient by simply checking
* if the last character in the 'response' buffer is an ASCII_LF.
* See ap_rgetline() for an example.
*/
found = 1;
}
/* concat strings until buff is full - then throw the data away */
}
if (len > 0) {
}
}
}
}
return APR_SUCCESS;
}
/* unmerge an element in the table */
{
/* get the value to unmerge */
if (!initial) {
return;
}
/* remove the value from the headers */
apr_table_unset(t, key);
/* find each comma */
}
count++;
}
}
const char *url)
{
int i;
return NULL;
/* remove path from uri */
*c = '\0';
return balancer;
balancer++;
}
return NULL;
}
apr_pool_t *p,
const char *url)
{
apr_status_t rc = 0;
return "Bad syntax for a balancer name";
/* remove path from uri */
*q = '\0';
/* XXX Is this a right place to create mutex */
#if APR_HAS_THREADS
APR_THREAD_MUTEX_DEFAULT, p)) != APR_SUCCESS) {
/* XXX: Do we need to log something here */
return "can not create thread mutex";
}
#endif
return NULL;
}
const char *url)
{
int i;
return NULL;
/* remove path from uri */
*c = '\0';
return worker;
}
worker++;
}
return NULL;
}
{
/* Close the socket */
return APR_SUCCESS;
}
{
/* Create a connection pool's subpool.
* This pool is used for connection recycling.
* Once the worker is added it is never removed but
* it can be disabled.
*/
apr_pool_create(&pool, p);
/* Alloc from the same pool as worker.
* proxy_conn_pool is permanently attached to the worker.
*/
apr_pool_cleanup_register(p, (void *)cp,
}
apr_pool_t *p,
const char *url)
{
int port;
return "Bad syntax for a remote proxy server";
/* remove path from uri */
*q = '\0';
if (q != NULL) {
return "Bad syntax for a remote proxy server (bad port number)";
}
}
else
port = -1;
*c = '\0';
if (port == -1)
init_conn_pool(p, *worker);
return NULL;
}
PROXY_DECLARE(void)
{
int i;
/* Recalculate lbfactors */
/* Set to the original configuration */
}
if (ffactor < 100.0) {
int z = 0;
++z;
}
if (z) {
}
}
else {
}
}
else if (ffactor > 100.0) {
}
}
/* Update the status entires */
}
}
request_rec *r,
{
int access_status;
if (*worker) {
access_status = OK;
}
else
}
/* All the workers are busy */
}
return access_status;
}
request_rec *r,
{
int access_status;
if (balancer)
else {
access_status = OK;
}
return access_status;
}
/* DEPRECATED */
const char *proxy_function,
const char *backend_name,
server_rec *s,
apr_pool_t *p)
{
int connected = 0;
int loglevel;
while (backend_addr && !connected) {
SOCK_STREAM, 0, p)) != APR_SUCCESS) {
"proxy: %s: error creating fam %d socket for target %s",
/* this could be an IPv6 address from the DNS but the
* local machine won't give us an IPv6 socket; hopefully the
* DNS returned an additional address to try
*/
continue;
}
if (conf->recv_buffer_size > 0 &&
conf->recv_buffer_size))) {
"apr_socket_opt_set(SO_RCVBUF): Failed to set "
"ProxyReceiveBufferSize, using default");
}
#endif
/* Set a timeout on the socket */
}
else {
}
"proxy: %s: fam %d socket created to connect to %s",
/* make the connection out of the socket */
/* if an error occurred, loop round and try again */
if (rv != APR_SUCCESS) {
"proxy: %s: attempt to connect to %pI (%s) failed",
continue;
}
connected = 1;
}
return connected ? 0 : 1;
}
{
/* Close the socket */
return APR_SUCCESS;
}
{
/* deterimine if the connection need to be closed */
if (conn->close_on_recycle) {
}
#if APR_HAS_THREADS
}
else
#endif
{
}
/* Allways return the SUCCESS */
return APR_SUCCESS;
}
/* reslist constructor */
{
/* Create the subpool for each connection
* This keeps the memory consumption constant
* when disconnecting from backend.
*/
/* register the pool cleanup */
"proxy: socket is constructed");
return APR_SUCCESS;
}
/* reslist destructor */
{
#if 0
#endif
#if 0
if (s != NULL)
"proxy: socket is destructed");
#endif
return APR_SUCCESS;
}
/* Close the connection
* The proxy_conn_rec from now on can not be used
*/
{
}
{
#if APR_HAS_THREADS
int mpm_threads;
if (mpm_threads > 1) {
/* Set hard max to no more then mpm_threads */
/* Set min to be lower then smax */
}
else {
/* This will supress the apr_reslist creation */
}
#if (APR_MAJOR_VERSION > 0)
/* Set the acquire timeout */
#endif
}
else
#endif
{
rv = APR_SUCCESS;
}
return rv;
}
server_rec *s)
{
"proxy: %s: failed to initialize worker for (%s)",
return DECLINED;
}
}
#if APR_HAS_THREADS
}
else
#endif
{
/* create the new connection if the previous was destroyed */
else {
}
rv = APR_SUCCESS;
}
if (rv != APR_SUCCESS) {
"proxy: %s: failed to acquire connection for (%s)",
return DECLINED;
}
return OK;
}
server_rec *s)
{
/* If there is a connection kill it's cleanup */
if (conn->connection)
return OK;
}
PROXY_DECLARE(int)
char **url,
const char *proxyname,
char *server_portstr,
int server_portstr_size)
{
int server_port;
/*
* Break up the URL to determine the host to connect to
*/
/* we break the URL into host, port, uri */
return ap_proxyerror(r, HTTP_BAD_REQUEST,
NULL));
}
}
/* allocate these out of the specified connection pool
* The scheme handler decides if this is permanent or
* short living pool.
*/
/* are we connecting directly, or via a proxy? */
if (proxyname) {
} else {
}
/* Worker can have the single constant backend adress.
* The single DNS lookup is used once per worker.
* If dynamic change is needed then set the addr to NULL
* inside dynamic config to force the lookup.
*/
if (err != APR_SUCCESS) {
return ap_proxyerror(r, HTTP_BAD_GATEWAY,
apr_pstrcat(p, "DNS lookup failure for: ",
}
/* Get the server port for the Via headers */
{
if (ap_is_default_port(server_port, r)) {
} else {
}
}
/* check if ProxyBlock directive on this host */
return ap_proxyerror(r, HTTP_FORBIDDEN,
"Connect to remote machine blocked");
}
return OK;
}
{
char test_buffer[1];
/* save timeout */
/* set no timeout */
/* put back old timeout */
return 0;
else
return 1;
}
server_rec *s)
{
int connected = 0;
int loglevel;
/* This increases the connection pool size
* but the number of dropped connections is
* relatively small compared to connection lifetime
*/
}
}
while (backend_addr && !connected) {
"proxy: %s: error creating fam %d socket for target %s",
/* this could be an IPv6 address from the DNS but the
* local machine won't give us an IPv6 socket; hopefully the
* DNS returned an additional address to try
*/
continue;
}
if (worker->recv_buffer_size > 0 &&
worker->recv_buffer_size))) {
"apr_socket_opt_set(SO_RCVBUF): Failed to set "
"ProxyReceiveBufferSize, using default");
}
#endif
/* Set a timeout on the socket */
}
else {
}
/* Set a keepalive option */
"apr_socket_opt_set(SO_KEEPALIVE): Failed to set"
" Keepalive");
}
}
"proxy: %s: fam %d socket created to connect to %s",
/* make the connection out of the socket */
/* if an error occurred, loop round and try again */
if (rv != APR_SUCCESS) {
"proxy: %s: attempt to connect to %pI (%s) failed",
continue;
}
connected = 1;
}
}
conn_rec *c,
server_rec *s)
{
/* The socket is now open, create a new backend server connection
*
*/
c->bucket_alloc);
if (!conn->connection) {
/* the peer reset the connection already; ap_run_create_connection()
* closed the socket
*/
s, "proxy: %s: an error occurred creating a "
"new connection to %pI (%s)", proxy_function,
/* XXX: Will be closed when proxy_conn is closed */
return HTTP_INTERNAL_SERVER_ERROR;
}
/* register the connection cleanup to client connection
* so that the connection can be closed or reused
*/
/* For ssl connection to backend */
s, "proxy: %s: failed to enable ssl support "
"for %pI (%s)", proxy_function,
return HTTP_INTERNAL_SERVER_ERROR;
}
}
else {
/* TODO: See if this will break FTP */
}
"proxy: %s: connection complete to %pI (%s)",
/* set up the connection filters */
return OK;
}