mod_proxy.h revision 6a875743d0b73682a5cedf952b4016a3513dea87
5548N/A/* ====================================================================
5548N/A * The Apache Software License, Version 1.1
5548N/A *
5548N/A * Copyright (c) 2000 The Apache Software Foundation. All rights
5548N/A * reserved.
5548N/A *
5548N/A * Redistribution and use in source and binary forms, with or without
5548N/A * modification, are permitted provided that the following conditions
5548N/A * are met:
5548N/A *
5548N/A * 1. Redistributions of source code must retain the above copyright
5548N/A * notice, this list of conditions and the following disclaimer.
5548N/A *
5548N/A * 2. Redistributions in binary form must reproduce the above copyright
5548N/A * notice, this list of conditions and the following disclaimer in
5548N/A * the documentation and/or other materials provided with the
5548N/A * distribution.
5548N/A *
5548N/A * 3. The end-user documentation included with the redistribution,
5548N/A * if any, must include the following acknowledgment:
5548N/A * "This product includes software developed by the
5548N/A * Apache Software Foundation (http://www.apache.org/)."
5548N/A * Alternately, this acknowledgment may appear in the software itself,
5548N/A * if and wherever such third-party acknowledgments normally appear.
5548N/A *
5548N/A * 4. The names "Apache" and "Apache Software Foundation" must
5548N/A * not be used to endorse or promote products derived from this
5548N/A * software without prior written permission. For written
5548N/A * permission, please contact apache@apache.org.
5548N/A *
5548N/A * 5. Products derived from this software may not be called "Apache",
5548N/A * nor may "Apache" appear in their name, without prior written
5548N/A * permission of the Apache Software Foundation.
5548N/A *
5548N/A * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
5548N/A * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
5548N/A * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
5548N/A * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
5548N/A * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
5548N/A * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
5548N/A * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
5548N/A * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
5548N/A * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
5548N/A * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
5548N/A * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
5548N/A * SUCH DAMAGE.
5548N/A * ====================================================================
5548N/A *
5548N/A * This software consists of voluntary contributions made by many
5548N/A * individuals on behalf of the Apache Software Foundation. For more
5548N/A * information on the Apache Software Foundation, please see
5548N/A * <http://www.apache.org/>.
5548N/A *
5548N/A * Portions of this software are based upon public domain software
5548N/A * originally written at the National Center for Supercomputing Applications,
5548N/A * University of Illinois, Urbana-Champaign.
5548N/A */
5548N/A
5548N/A#ifndef MOD_PROXY_H
5548N/A#define MOD_PROXY_H
5548N/A
5548N/A/*
5548N/A * Main include file for the Apache proxy
5548N/A */
5548N/A
5548N/A/*
5548N/A
5548N/A Note that the Explain() stuff is not yet complete.
5548N/A Also note numerous FIXMEs and CHECKMEs which should be eliminated.
5548N/A
5548N/A If TESTING is set, then garbage collection doesn't delete ... probably a good
5548N/A idea when hacking.
5548N/A
5548N/A This code is still experimental!
5548N/A
5548N/A Things to do:
5548N/A
5548N/A 1. Make it garbage collect in the background, not while someone is waiting for
5548N/A a response!
5548N/A
5548N/A 2. Check the logic thoroughly.
5548N/A
5548N/A 3. Empty directories are only removed the next time round (but this does avoid
5548N/A two passes). Consider doing them the first time round.
5548N/A
5548N/A Ben Laurie <ben@algroup.co.uk> 30 Mar 96
5548N/A
5548N/A More things to do:
5548N/A
5548N/A 0. Code cleanup (ongoing)
5548N/A
5548N/A 1. add 230 response output for ftp now that it works
5548N/A
5548N/A 2. Make the ftp proxy transparent, also same with (future) gopher & wais
5548N/A
5548N/A 3. Use protocol handler struct a la Apache module handlers (Dirk van Gulik)
5548N/A
5548N/A 4. Use a cache expiry database for more efficient GC (Jeremy Wohl)
5548N/A
5548N/A 5. Bulletproof GC against SIGALRM
5548N/A
5548N/A Chuck Murcko <chuck@topsail.org> 15 April 1997
5548N/A
5548N/A */
5548N/A
5548N/A#define TESTING 0
5548N/A#undef EXPLAIN
5548N/A
5548N/A#include "httpd.h"
5548N/A#include "http_config.h"
5548N/A#include "http_protocol.h"
5548N/A#include "ap_cache.h"
5548N/A
5548N/A#include "explain.h"
5548N/A
5548N/A#ifdef HAVE_NETDB_H
5548N/A#include <netdb.h>
5548N/A#endif
5548N/A
5548N/A#ifdef HAVE_SYS_SOCKET_H
5548N/A#include <sys/socket.h>
5548N/A#endif
5548N/A
5548N/A#ifdef HAVE_NETINET_IN_H
5548N/A#include <netinet/in.h>
5548N/A#endif
5548N/A
5548N/A#ifdef HAVE_ARPA_INET_H
5548N/A#include <arpa/inet.h>
5548N/A#endif
5548N/A
5548N/Aextern module MODULE_VAR_EXPORT proxy_module;
5548N/A
5548N/A
5548N/A/* for proxy_canonenc() */
5548N/Aenum enctype {
5548N/A enc_path, enc_search, enc_user, enc_fpath, enc_parm
5548N/A};
5548N/A
5548N/A#define HDR_APP (0) /* append header, for proxy_add_header() */
5548N/A#define HDR_REP (1) /* replace header, for proxy_add_header() */
5548N/A
5548N/A#ifdef CHARSET_EBCDIC
5548N/A#define CRLF "\r\n"
5548N/A#else /*CHARSET_EBCDIC*/
5548N/A#define CRLF "\015\012"
5548N/A#endif /*CHARSET_EBCDIC*/
5548N/A
5548N/A#define DEFAULT_FTP_DATA_PORT 20
5548N/A#define DEFAULT_FTP_PORT 21
5548N/A#define DEFAULT_GOPHER_PORT 70
5548N/A#define DEFAULT_NNTP_PORT 119
5548N/A#define DEFAULT_WAIS_PORT 210
5548N/A#define DEFAULT_HTTPS_PORT 443
5548N/A#define DEFAULT_SNEWS_PORT 563
5548N/A#define DEFAULT_PROSPERO_PORT 1525 /* WARNING: conflict w/Oracle */
5548N/A
5548N/A#define DEFAULT_CACHE_COMPLETION (0.9)
5548N/A/* Some WWW schemes and their default ports; this is basically /etc/services */
5548N/Astruct proxy_services {
5548N/A const char *scheme;
5548N/A int port;
5548N/A};
5548N/A
5548N/A/* static information about a remote proxy */
5548N/Astruct proxy_remote {
5548N/A const char *scheme; /* the schemes handled by this proxy, or '*' */
5548N/A const char *protocol; /* the scheme used to talk to this proxy */
5548N/A const char *hostname; /* the hostname of this proxy */
5548N/A int port; /* the port for this proxy */
5548N/A};
5548N/A
5548N/Astruct proxy_alias {
5548N/A char *real;
5548N/A char *fake;
5548N/A};
5548N/A
5548N/Astruct dirconn_entry {
5548N/A char *name;
5548N/A struct in_addr addr, mask;
5548N/A struct hostent *hostentry;
5548N/A int (*matcher) (struct dirconn_entry * This, request_rec *r);
5548N/A};
5548N/A
5548N/Astruct noproxy_entry {
5548N/A char *name;
5548N/A struct in_addr addr;
5548N/A};
5548N/A
5548N/Astruct nocache_entry {
5548N/A char *name;
5548N/A struct in_addr addr;
5548N/A};
5548N/A
5548N/Atypedef struct {
5548N/A ap_array_header_t *proxies;
5548N/A ap_array_header_t *aliases;
5548N/A ap_array_header_t *raliases;
5548N/A ap_array_header_t *noproxies;
5548N/A ap_array_header_t *dirconn;
5548N/A ap_array_header_t *nocaches;
5548N/A ap_array_header_t *allowed_connect_ports;
5548N/A char *domain; /* domain name to use in absence of a domain name in the request */
5548N/A int req; /* true if proxy requests are enabled */
5548N/A float cache_completion; /* Force cache completion after this point */
5548N/A enum {
via_off,
via_on,
via_block,
via_full
} viaopt; /* how to deal with proxy Via: headers */
size_t recv_buffer_size;
ap_cache_handle_t *cache;
} proxy_server_conf;
typedef struct {
float cache_completion; /* completion percentage */
int content_length; /* length of the content */
} proxy_completion;
/* Function prototypes */
/* proxy_connect.c */
int ap_proxy_connect_handler(request_rec *r, ap_cache_el *c, char *url,
const char *proxyhost, int proxyport);
/* proxy_ftp.c */
int ap_proxy_ftp_canon(request_rec *r, char *url);
int ap_proxy_ftp_handler(request_rec *r, ap_cache_el *c, char *url);
/* proxy_http.c */
int ap_proxy_http_canon(request_rec *r, char *url, const char *scheme,
int def_port);
int ap_proxy_http_handler(request_rec *r, ap_cache_el *c, char *url,
const char *proxyhost, int proxyport);
/* proxy_util.c */
int ap_proxy_hex2c(const char *x);
void ap_proxy_c2hex(int ch, char *x);
char *ap_proxy_canonenc(ap_pool_t *p, const char *x, int len, enum enctype t,
int isenc);
char *ap_proxy_canon_netloc(ap_pool_t *p, char **const urlp, char **userp,
char **passwordp, char **hostp, int *port);
const char *ap_proxy_date_canon(ap_pool_t *p, const char *x);
ap_table_t *ap_proxy_read_headers(request_rec *r, char *buffer, int size, BUFF *f);
long int ap_proxy_send_fb(proxy_completion *, BUFF *f, request_rec *r, ap_cache_el *c);
void ap_proxy_send_headers(request_rec *r, const char *respline, ap_table_t *hdrs);
int ap_proxy_liststr(const char *list, const char *val);
void ap_proxy_hash(const char *it, char *val, int ndepth, int nlength);
int ap_proxy_hex2sec(const char *x);
void ap_proxy_sec2hex(int t, char *y);
const char *ap_proxy_host2addr(const char *host, struct hostent *reqhp);
int ap_proxy_cache_send(request_rec *r, ap_cache_el *c);
int ap_proxy_cache_should_cache(request_rec *r, ap_table_t *resp_hdrs,
const int is_HTTP1);
int ap_proxy_cache_update(ap_cache_el *c);
void ap_proxy_cache_error(ap_cache_el **r);
int ap_proxyerror(request_rec *r, int statuscode, const char *message);
int ap_proxy_is_ipaddr(struct dirconn_entry *This, ap_pool_t *p);
int ap_proxy_is_domainname(struct dirconn_entry *This, ap_pool_t *p);
int ap_proxy_is_hostname(struct dirconn_entry *This, ap_pool_t *p);
int ap_proxy_is_word(struct dirconn_entry *This, ap_pool_t *p);
int ap_proxy_doconnect(ap_socket_t *sock, char *host, ap_uint32_t port, request_rec *r);
int ap_proxy_garbage_init(server_rec *, ap_pool_t *);
/* This function is called by ap_table_do() for all header lines */
int ap_proxy_send_hdr_line(void *p, const char *key, const char *value);
unsigned ap_proxy_bputs2(const char *data, BUFF *client, ap_cache_el *cache);
#endif /*MOD_PROXY_H*/