#ifndef _PROJECT_H
#define _PROJECT_H
-#define PROJECT_H_VERSION "$Id: project.h,v 1.10 2001/05/31 21:33:53 jongfoster Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.19 2001/06/29 13:33:36 oes Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.19 2001/06/29 13:33:36 oes
+ * - Improved comments
+ * - Introduced http_request.host_ip_addr_str
+ * - Introduced http_response.head_length
+ * - Introduced config.my_ip_addr_str, config.my_hostname,
+ * config.admin_address and config.proxy_info_url
+ * - Removed config.proxy_args_header and config.proxy_args_trailer,
+ * renamed config.proxy_args_invocation to config.proxy_args
+ * - Removed HTML snipplets and GIFs
+ * - Removed logentry from cancelled commit
+ *
+ * Revision 1.18 2001/06/09 10:57:39 jongfoster
+ * Adding definition of BUFFER_SIZE.
+ * Changing struct cgi_dispatcher to use "const" strings.
+ *
+ * Revision 1.17 2001/06/07 23:15:09 jongfoster
+ * Merging ACL and forward files into config file.
+ * Moving struct gateway members into struct forward_spec
+ * Removing config->proxy_args_gateways
+ * Cosmetic: Adding a few comments
+ *
+ * Revision 1.16 2001/06/04 18:31:58 swa
+ * files are now prefixed with either `confdir' or `logdir'.
+ * `make redhat-dist' replaces both entries confdir and logdir
+ * with redhat values
+ *
+ * Revision 1.15 2001/06/04 11:28:53 swa
+ * redirect did not work due to missing /
+ *
+ * Revision 1.14 2001/06/03 11:03:48 oes
+ * Added struct map,
+ * added struct http_response,
+ * changed struct interceptors to struct cgi_dispatcher,
+ * moved HTML stuff to cgi.h
+ *
+ * Revision 1.13 2001/06/01 20:05:36 jongfoster
+ * Support for +image-blocker{}: added ACTION_IMAGE_BLOCKER
+ * constant, and removed csp->tinygif.
+ *
+ * Revision 1.12 2001/06/01 18:49:17 jongfoster
+ * Replaced "list_share" with "list" - the tiny memory gain was not
+ * worth the extra complexity.
+ *
+ * Revision 1.11 2001/06/01 10:32:47 oes
+ * Added constants for anchoring selection bitmap
+ *
* Revision 1.10 2001/05/31 21:33:53 jongfoster
* Changes for new actions file, replacing permissionsfile
* and parts of the config file. Also added support for
extern "C" {
#endif
+#define BUFFER_SIZE 5000
+
#define FOREVER 1
/* Default IP and port to listen on */
#define HADDR_PORT 8000
-/* Need this for struct gateway */
-struct client_state;
-
/* Need this for struct client_state */
struct configuration_spec;
+/* Generic linked list of strings */
+struct list /* FIXME: Why not separate entries and header? */
+{
+ char * str; /* valid in an entry */
+ struct list *last; /* valid in header */
+ struct list *next;
+};
+
+struct map
+{
+ char *name;
+ char *value;
+ struct map *next;
+};
struct http_request
{
char *cmd;
char *gpc;
char *host;
+ char *host_ip_addr_str; /* NULL before connect_to() */
int port;
char *path;
char *ver;
int ssl;
};
-struct gateway
+/* Response generated by CGI, blocker, or error handler */
+struct http_response
{
- /* generic attributes */
- char *name;
- int (*conn)(const struct gateway *, struct http_request *, struct client_state *);
- int type;
-
- /* domain specific attributes */
- char *gateway_host;
- int gateway_port;
-
- char *forward_host;
- int forward_port;
+ char *status; /* HTTP status (string)*/
+ struct list headers[1]; /* List of header lines */
+ char *head; /* Formatted http response head */
+ int head_length; /* Length of http response head */
+ char *body; /* HTTP document body */
+ int content_length; /* Length of body, REQUIRED if binary body*/
};
-
-/* Generic linked list of strings */
-struct list /* FIXME: Why not separate entries and header? */
-{
- char * str; /* valid in an entry */
- struct list *last; /* valid in header */
- struct list *next;
-};
-
-
-/* Generic linked list of strings */
-struct list_share /* FIXME: Why not separate entries and header? */
-{
- const char * str; /* valid in an entry */
- struct list_share *last; /* valid in header */
- struct list_share *next;
-};
-
-
/* A URL pattern */
struct url_spec
{
- char *spec;
- char *domain; /* fqdn */
- char *dbuf;
- char **dvec; /* Domain ptr vector */
- int dcnt; /* How many domains in fqdn? */
- int unanchored; /* bitmap 0: left, 1: right */
-
- char *path;
- int pathlen;
- int port;
+ char *spec; /* The string which was parsed to produce this */
+ /* url_spec. Used for debugging or display only. */
+
+ /* Hostname matching: */
+ char *domain; /* Fully qalified domain name (FQDN) pattern. */
+ /* May contain "*". */
+ char *dbuf; /* Buffer with '\0'-delimited fqdn */
+ char **dvec; /* Domain ptr vector into dbuf */
+ int dcnt; /* How many domains in fqdn? */
+ int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT */
+
+ /* Port matching: */
+ int port; /* The port number, or 0 to match all ports. */
+
+ /* Path matching: */
+ char *path; /* The path prefix (if not using regex), or source */
+ /* for the regex. */
+ int pathlen; /* ==strlen(path). Needed for prefix matching. */
#ifdef REGEX
- regex_t *preg;
+ regex_t *preg; /* Regex for matching path part */
#endif
};
#define ANCHOR_RIGHT 2
+
/* An I/O buffer */
struct iob
{
#define ACTION_MASK_ALL (~0U)
-#define ACTION_MOST_COMPATIBLE 0U
+#define ACTION_MOST_COMPATIBLE 0x0000U
#define ACTION_BLOCK 0x0001U
#define ACTION_FAST_REDIRECTS 0x0002U
#define ACTION_HIDE_REFERER 0x0020U /* sic - follow HTTP, not English */
#define ACTION_HIDE_USER_AGENT 0x0040U
#define ACTION_IMAGE 0x0080U
-#define ACTION_NO_COOKIE_READ 0x0100U
-#define ACTION_NO_COOKIE_SET 0x0200U
-#define ACTION_NO_POPUPS 0x0400U
-#define ACTION_VANILLA_WAFER 0x0800U
-
-#define ACTION_STRING_FROM 0
-#define ACTION_STRING_REFERER 1
-#define ACTION_STRING_USER_AGENT 2
-#define ACTION_STRING_COUNT 3
-
-#define ACTION_MULTI_ADD_HEADER 0
-#define ACTION_MULTI_WAFER 1
-#define ACTION_MULTI_COUNT 2
-
+#define ACTION_IMAGE_BLOCKER 0x0100U
+#define ACTION_NO_COOKIE_READ 0x0200U
+#define ACTION_NO_COOKIE_SET 0x0400U
+#define ACTION_NO_POPUPS 0x0800U
+#define ACTION_VANILLA_WAFER 0x1000U
+
+#define ACTION_STRING_FROM 0
+#define ACTION_STRING_IMAGE_BLOCKER 1
+#define ACTION_STRING_REFERER 2
+#define ACTION_STRING_USER_AGENT 3
+#define ACTION_STRING_COUNT 4
+
+#define ACTION_MULTI_ADD_HEADER 0
+#define ACTION_MULTI_WAFER 1
+#define ACTION_MULTI_COUNT 2
+/*
+ * This structure contains a list of actions to apply to a URL.
+ * It only contains positive instructions - no "-" options.
+ * It is not used to store the actions list itself, only for
+ * url_actions() to return the current values.
+ */
struct current_action_spec
{
unsigned flags; /* a bit set to "1" = add action */
char * string[ACTION_STRING_COUNT];
/* Strings to add */
- struct list_share multi[ACTION_MULTI_COUNT][1];
+ struct list multi[ACTION_MULTI_COUNT][1];
};
+
+/*
+ * This structure contains a set of changes to actions.
+ * It can contain both positive and negative instructions.
+ * It is used to store an entry in the actions list.
+ */
struct action_spec
{
unsigned mask; /* a bit set to "0" = remove action */
struct list multi_add[ACTION_MULTI_COUNT][1];
};
+/*
+ * This structure is used to store the actions list.
+ *
+ * It contains a URL pattern, and the chages to the actions.
+ * It is a linked list.
+ */
struct url_actions
{
struct url_spec url[1];
/* The proxy's configuration */
struct configuration_spec * config;
-
/* The actions to perform on the current request */
struct current_action_spec action[1];
-
/* socket to talk to client (web browser) */
int cfd;
char *ip_addr_str;
long ip_addr_long;
+
+ /* Our IP address and hostname, i.e. the IP address that
+ the client used to reach us, and the associated hostname,
+ both as strings
+ */
+ char *my_ip_addr_str;
+ char *my_hostname;
+
#ifdef TRUST_FILES
/* The referer in this request, if one was specified. */
char *referrer;
int active;
/* files associated with this client */
- struct file_list *flist; /* forwardfile */
struct file_list *actions_list;
-
-#ifdef ACL_FILES
- struct file_list *alist; /* aclfile */
-#endif /* def ACL_FILES */
-
#ifdef PCRS
struct file_list *rlist; /* Perl re_filterfile */
size_t content_length; /* Length after processing */
char *(*parser)(const struct parsers *, char *, struct client_state *);
};
-
-struct interceptors
+struct cgi_dispatcher
{
- char *str;
- char len;
- char *(*interceptor)(struct http_request *http, struct client_state *csp);
+ const char *name;
+ int name_length;
+ int (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters);
+ const char *description;
};
-
struct file_list
{
/*
#endif /* def TRUST_FILES */
+#define SOCKS_NONE 0 /* Don't use a SOCKS server */
+#define SOCKS_4 40 /* original SOCKS 4 protocol */
+#define SOCKS_4A 41 /* as modified for hosts w/o external DNS */
+
struct forward_spec
{
struct url_spec url[1];
- struct gateway gw[1];
+
+ /* Connection type - must be a SOCKS_xxx constant */
+ int type;
+
+ /* SOCKS server */
+ char *gateway_host;
+ int gateway_port;
+
+ /* Parent HTTP proxy */
+ char *forward_host;
+ int forward_port;
+
+ /* For the linked list */
struct forward_spec *next;
};
struct re_filterfile_spec
{
struct list patterns[1];
- /* See README.re_filter */
pcrs_job *joblist;
};
#endif /* def PCRS */
#endif /* def ACL_FILES */
-/* Maximum number of loaders (actions, block, forward, acl...) */
+/* Maximum number of loaders (actions, re_filter, ...) */
#define NLOADERS 8
/*
int debug;
int multi_threaded;
-#ifdef IMAGE_BLOCKING
- int tinygif; /* FIXME Should be an action */
- const char *tinygifurl; /* FIXME Should be an action */
-#endif /* def IMAGE_BLOCKING */
-
const char *logfile;
+ const char *confdir;
+ const char *logdir;
const char *actions_file;
- const char *forwardfile;
-#ifdef ACL_FILES
- const char *aclfile;
-#endif /* def ACL_FILES */
+ /* The administrator's email address */
+ char *admin_address;
+
+ /* A URL with info on this proxy */
+ char *proxy_info_url;
#ifdef PCRS
const char *re_filterfile;
struct url_spec *trust_list[64];
#endif /* def TRUST_FILES */
- /* Various strings for show-proxy-args */
- char *proxy_args_header;
- char *proxy_args_invocation;
- char *proxy_args_gateways;
- char *proxy_args_trailer;
+#ifdef ACL_FILES
+ struct access_control_list *acl;
+#endif /* def ACL_FILES */
+
+ struct forward_spec *forward;
+
+ /* All options from the config file, HTML-formatted */
+ char *proxy_args;
/* the configuration file object. */
struct file_list *config_file_list;
#define SZ(X) (sizeof(X) / sizeof(*X))
-#define WHITEBG "<body bgcolor=\"#ffffff\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
-#define BODY "<body bgcolor=\"#f8f8f0\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
-#define BANNER "<strong>Internet J<small>UNK<i><font color=\"red\">BUSTER</font></i></small></strong>"
-
#ifdef FORCE_LOAD
#define FORCE_PREFIX "/IJB-FORCE-LOAD"
#endif /* def FORCE_LOAD */
-#define HOME_PAGE_URL "http://ijbswa.sourceforge.net/"
-#define REDIRECT_URL HOME_PAGE_URL "redirect.php?v=" VERSION "&to="
-
-static const char CFAIL[] =
- "HTTP/1.0 503 Connect failed\n"
- "Content-Type: text/html\n\n"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Connect failed</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</center></h1>"
- "TCP connection to '%s' failed: %s.\n<br>"
- "</body>\n"
- "</html>\n";
-
-static const char CNXDOM[] =
- "HTTP/1.0 404 Non-existent domain\n"
- "Content-Type: text/html\n\n"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: Non-existent domain</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</center></h1>"
- "No such domain: %s\n"
- "</body>\n"
- "</html>\n";
-
-static const char CNOBANNER[] =
- "HTTP/1.0 200 No Banner\n"
- "Content-Type: text/html\n\n"
- "<html>\n"
- "<head>\n"
- "<title>Internet Junkbuster: No Banner</title>\n"
- "</head>\n"
- BODY
- "<h1><center>"
- BANNER
- "</h1>"
- "You asked for a banner that this proxy can't produce because either configuration does not permit.\n<br>"
- "or the URL didn't end with .gif\n"
- "</center></body>\n"
- "</html>\n";
+/* Hardwired URLs */
+#define HOME_PAGE_URL "http://ijbswa.sourceforge.net"
+#define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to="
+#define CGI_PREFIX_HOST "i.j.b"
+/* HTTP snipplets */
static const char CSUCCEED[] =
"HTTP/1.0 200 Connection established\n"
"Proxy-Agent: IJ/" VERSION "\n\n";
static const char CHEADER[] =
"HTTP/1.0 400 Invalid header received from browser\n\n";
-static const char SHEADER[] =
- "HTTP/1.0 502 Invalid header received from server\n\n";
-
-#ifdef IMAGE_BLOCKING
-
-/*
- * Hint: You can encode your own GIFs like that:
- * perl -e 'while (read STDIN, $c, 1) { printf("\\%.3o,", unpack("C", $c)); }'
- */
-
-static const char BLANKGIF[] =
- "HTTP/1.0 200 OK\r\n"
- "Pragma: no-cache\r\n"
- "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\r\n"
- "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\r\n"
- "Content-type: image/gif\r\n\r\n"
- "GIF89a\001\000\001\000\200\000\000\377\377\377\000\000"
- "\000!\371\004\001\000\000\000\000,\000\000\000\000\001"
- "\000\001\000\000\002\002D\001\000;";
-
-static const char JBGIF[] =
- "HTTP/1.0 200 OK\r\n"
- "Pragma: no-cache\r\n"
- "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\r\n"
- "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\r\n"
- "Content-type: image/gif\r\n\r\n"
- "GIF89aD\000\013\000\360\000\000\000\000\000\377\377\377!"
- "\371\004\001\000\000\001\000,\000\000\000\000D\000\013\000"
- "\000\002a\214\217\251\313\355\277\000\200G&K\025\316hC\037"
- "\200\234\230Y\2309\235S\230\266\206\372J\253<\3131\253\271"
- "\270\215\342\254\013\203\371\202\264\334P\207\332\020o\266"
- "N\215I\332=\211\312\3513\266:\026AK)\364\370\365aobr\305"
- "\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
- "\037Q\000\000;";
-
-#endif /* def IMAGE_BLOCKING */
-
-#if defined(FAST_REDIRECTS) || defined(IMAGE_BLOCKING)
-
-static const char HTTP_REDIRECT_TEMPLATE[] =
- "HTTP/1.0 302 Local Redirect from Junkbuster\r\n"
- "Pragma: no-cache\r\n"
- "Last-Modified: Thu Jul 31, 1997 07:42:22 pm GMT\r\n"
- "Expires: Thu Jul 31, 1997 07:42:22 pm GMT\r\n"
- "Location: %s\r\n\r\n";
-
-#endif /* defined(FAST_REDIRECTS) || defined(IMAGE_BLOCKING) */
-
#ifdef __cplusplus
} /* extern "C" */
#endif