mod_proxy.h revision 2f3894b2edb7f246e7f40af52a2012399b462af9
842ae4bd224140319ae7feec1872b93dfd491143fielding/* ====================================================================
842ae4bd224140319ae7feec1872b93dfd491143fielding * The Apache Software License, Version 1.1
842ae4bd224140319ae7feec1872b93dfd491143fielding *
842ae4bd224140319ae7feec1872b93dfd491143fielding * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
842ae4bd224140319ae7feec1872b93dfd491143fielding * reserved.
842ae4bd224140319ae7feec1872b93dfd491143fielding *
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * Redistribution and use in source and binary forms, with or without
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * modification, are permitted provided that the following conditions
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * are met:
b8d55029467b9f139d081cf38c6d06ff45e742a9nd *
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * 1. Redistributions of source code must retain the above copyright
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * notice, this list of conditions and the following disclaimer.
b8d55029467b9f139d081cf38c6d06ff45e742a9nd *
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * 2. Redistributions in binary form must reproduce the above copyright
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * notice, this list of conditions and the following disclaimer in
b8d55029467b9f139d081cf38c6d06ff45e742a9nd * the documentation and/or other materials provided with the
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * distribution.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding *
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * 3. The end-user documentation included with the redistribution,
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * if any, must include the following acknowledgment:
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * "This product includes software developed by the
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * Apache Software Foundation (http://www.apache.org/)."
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * Alternately, this acknowledgment may appear in the software itself,
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * if and wherever such third-party acknowledgments normally appear.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding *
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * 4. The names "Apache" and "Apache Software Foundation" must
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * not be used to endorse or promote products derived from this
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * software without prior written permission. For written
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * permission, please contact apache@apache.org.
e8f95a682820a599fe41b22977010636be5c2717jim *
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * 5. Products derived from this software may not be called "Apache",
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * nor may "Apache" appear in their name, without prior written
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * permission of the Apache Software Foundation.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding *
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * SUCH DAMAGE.
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * ====================================================================
43c3e6a4b559b76b750c245ee95e2782c15b4296jim *
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * This software consists of voluntary contributions made by many
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * individuals on behalf of the Apache Software Foundation. For more
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * information on the Apache Software Foundation, please see
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * <http://www.apache.org/>.
43c3e6a4b559b76b750c245ee95e2782c15b4296jim *
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * Portions of this software are based upon public domain software
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * originally written at the National Center for Supercomputing Applications,
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * University of Illinois, Urbana-Champaign.
43c3e6a4b559b76b750c245ee95e2782c15b4296jim */
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#ifndef MOD_PROXY_H
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#define MOD_PROXY_H
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding/*
43c3e6a4b559b76b750c245ee95e2782c15b4296jim * Main include file for the Apache proxy
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding */
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding/*
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding Also note numerous FIXMEs and CHECKMEs which should be eliminated.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding This code is once again experimental!
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding Things to do:
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding 1. Make it completely work (for FTP too)
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim 2. HTTP/1.1
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim Chuck Murcko <chuck@topsail.org> 02-06-01
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#define CORE_PRIVATE
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_hooks.h"
f05787953018140838ad51456c86c965d6a86267jim#include "apr.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_compat.h"
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#include "apr_lib.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_strings.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_buckets.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_md5.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_network_io.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_pools.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_strings.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_uri.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_date.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "apr_fnmatch.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "httpd.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "http_config.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "ap_config.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "http_core.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "http_protocol.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "http_request.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "http_vhost.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "http_main.h"
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#include "http_log.h"
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#include "http_connection.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include "util_filter.h"
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#if APR_HAVE_NETINET_IN_H
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include <netinet/in.h>
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#endif
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#if APR_HAVE_ARPA_INET_H
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#include <arpa/inet.h>
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding#endif
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding
43c3e6a4b559b76b750c245ee95e2782c15b4296jim/* for proxy_canonenc() */
43c3e6a4b559b76b750c245ee95e2782c15b4296jimenum enctype {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim enc_path, enc_search, enc_user, enc_fpath, enc_parm
43c3e6a4b559b76b750c245ee95e2782c15b4296jim};
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#if APR_CHARSET_EBCDIC
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#define CRLF "\r\n"
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#else /*APR_CHARSET_EBCDIC*/
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#define CRLF "\015\012"
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#endif /*APR_CHARSET_EBCDIC*/
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim/* default Max-Forwards header setting */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim#define DEFAULT_MAX_FORWARDS 10
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jim/* static information about a remote proxy */
43c3e6a4b559b76b750c245ee95e2782c15b4296jimstruct proxy_remote {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *scheme; /* the schemes handled by this proxy, or '*' */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *protocol; /* the scheme used to talk to this proxy */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *hostname; /* the hostname of this proxy */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_port_t port; /* the port for this proxy */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim};
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jimstruct proxy_alias {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *real;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *fake;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim};
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jimstruct dirconn_entry {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim char *name;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim struct in_addr addr, mask;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim struct apr_sockaddr_t *hostaddr;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim int (*matcher) (struct dirconn_entry * This, request_rec *r);
43c3e6a4b559b76b750c245ee95e2782c15b4296jim};
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jimstruct noproxy_entry {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *name;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim struct apr_sockaddr_t *addr;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim};
43c3e6a4b559b76b750c245ee95e2782c15b4296jim
43c3e6a4b559b76b750c245ee95e2782c15b4296jimtypedef struct {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_array_header_t *proxies;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_array_header_t *sec_proxy;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_array_header_t *aliases;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_array_header_t *raliases;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_array_header_t *noproxies;
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding apr_array_header_t *dirconn;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim apr_array_header_t *allowed_connect_ports;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim const char *domain; /* domain name to use in absence of a domain name in the request */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim int req; /* true if proxy requests are enabled */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim char req_set;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim enum {
43c3e6a4b559b76b750c245ee95e2782c15b4296jim via_off,
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding via_on,
43c3e6a4b559b76b750c245ee95e2782c15b4296jim via_block,
43c3e6a4b559b76b750c245ee95e2782c15b4296jim via_full
43c3e6a4b559b76b750c245ee95e2782c15b4296jim } viaopt; /* how to deal with proxy Via: headers */
43c3e6a4b559b76b750c245ee95e2782c15b4296jim char viaopt_set;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim size_t recv_buffer_size;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim char recv_buffer_size_set;
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding long maxfwd;
43c3e6a4b559b76b750c245ee95e2782c15b4296jim char maxfwd_set;
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding /**
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * the following setting masks the error page
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * returned from the 'proxied server' and just
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * forwards the status code upwards.
09fe0b69d3d1e8c8041c9ce99ee77b8b44b5e3b1fielding * 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;
} proxy_server_conf;
typedef struct {
const char *p; /* The path */
int p_is_fnmatch; /* Is this path an fnmatch candidate? */
regex_t *r; /* Is this a regex? */
} proxy_dir_conf;
typedef struct {
conn_rec *connection;
char *hostname;
apr_port_t port;
} proxy_conn_rec;
typedef struct {
float cache_completion; /* completion percentage */
int content_length; /* length of the content */
} proxy_completion;
/* 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
APR_DECLARE_EXTERNAL_HOOK(proxy, PROXY, int, scheme_handler, (request_rec *r,
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))
/* 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 isenc);
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(apr_table_t *)ap_proxy_read_headers(request_rec *r, request_rec *rp, char *buffer, int size, conn_rec *c);
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_connection(conn_rec *c);
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_reset_output_filters(conn_rec *c);
#endif /*MOD_PROXY_H*/