#ifndef _PROJECT_H
#define _PROJECT_H
-#define PROJECT_H_VERSION "$Id: project.h,v 1.3 2001/05/20 01:21:20 jongfoster Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.7 2001/05/29 09:50:24 jongfoster Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.7 2001/05/29 09:50:24 jongfoster
+ * Unified blocklist/imagelist/permissionslist.
+ * File format is still under discussion, but the internal changes
+ * are (mostly) done.
+ *
+ * Also modified interceptor behaviour:
+ * - We now intercept all URLs beginning with one of the following
+ * prefixes (and *only* these prefixes):
+ * * http://i.j.b/
+ * * http://ijbswa.sf.net/config/
+ * * http://ijbswa.sourceforge.net/config/
+ * - New interceptors "home page" - go to http://i.j.b/ to see it.
+ * - Internal changes so that intercepted and fast redirect pages
+ * are not replaced with an image.
+ * - Interceptors now have the option to send a binary page direct
+ * to the client. (i.e. ijb-send-banner uses this)
+ * - Implemented show-url-info interceptor. (Which is why I needed
+ * the above interceptors changes - a typical URL is
+ * "http://i.j.b/show-url-info?url=www.somesite.com/banner.gif".
+ * The previous mechanism would not have intercepted that, and
+ * if it had been intercepted then it then it would have replaced
+ * it with an image.)
+ *
+ * Revision 1.6 2001/05/27 22:17:04 oes
+ *
+ * - re_process_buffer no longer writes the modified buffer
+ * to the client, which was very ugly. It now returns the
+ * buffer, which it is then written by chat.
+ *
+ * - content_length now adjusts the Content-Length: header
+ * for modified documents rather than crunch()ing it.
+ * (Length info in csp->content_length, which is 0 for
+ * unmodified documents)
+ *
+ * - For this to work, sed() is called twice when filtering.
+ *
+ * Revision 1.5 2001/05/26 00:28:36 jongfoster
+ * Automatic reloading of config file.
+ * Removed obsolete SIGHUP support (Unix) and Reload menu option (Win32).
+ * Most of the global variables have been moved to a new
+ * struct configuration_spec, accessed through csp->config->globalname
+ * Most of the globals remaining are used by the Win32 GUI.
+ *
+ * Revision 1.4 2001/05/22 18:46:04 oes
+ *
+ * - Enabled filtering banners by size rather than URL
+ * by adding patterns that replace all standard banner
+ * sizes with the "Junkbuster" gif to the re_filterfile
+ *
+ * - Enabled filtering WebBugs by providing a pattern
+ * which kills all 1x1 images
+ *
+ * - Added support for PCRE_UNGREEDY behaviour to pcrs,
+ * which is selected by the (nonstandard and therefore
+ * capital) letter 'U' in the option string.
+ * It causes the quantifiers to be ungreedy by default.
+ * Appending a ? turns back to greedy (!).
+ *
+ * - Added a new interceptor ijb-send-banner, which
+ * sends back the "Junkbuster" gif. Without imagelist or
+ * MSIE detection support, or if tinygif = 1, or the
+ * URL isn't recognized as an imageurl, a lame HTML
+ * explanation is sent instead.
+ *
+ * - Added new feature, which permits blocking remote
+ * script redirects and firing back a local redirect
+ * to the browser.
+ * The feature is conditionally compiled, i.e. it
+ * can be disabled with --disable-fast-redirects,
+ * plus it must be activated by a "fast-redirects"
+ * line in the config file, has its own log level
+ * and of course wants to be displayed by show-proxy-args
+ * Note: Boy, all the #ifdefs in 1001 locations and
+ * all the fumbling with configure.in and acconfig.h
+ * were *way* more work than the feature itself :-(
+ *
+ * - Because a generic redirect template was needed for
+ * this, tinygif = 3 now uses the same.
+ *
+ * - Moved GIFs, and other static HTTP response templates
+ * to project.h
+ *
+ * - Some minor fixes
+ *
+ * - Removed some >400 CRs again (Jon, you really worked
+ * a lot! ;-)
+ *
* Revision 1.3 2001/05/20 01:21:20 jongfoster
* Version 2.9.4 checkin.
* - Merged popupfile and cookiefile, and added control over PCRS
/* Need this for struct gateway */
struct client_state;
+/* Need this for struct client_state */
+struct configuration_spec;
+
struct http_request
{
};
-struct proxy_args
+/* Generic linked list of strings */
+struct list
{
- char *header;
- char *invocation;
- char *gateways;
- char *trailer;
+ char *str;
+ struct list *last;
+ struct list *next;
};
+/* An I/O buffer */
struct iob
{
char *buf;
};
-struct list
-{
- char *str;
- struct list *last;
- struct list *next;
-};
-
#define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
struct client_state
{
+ /* The proxy's configuration */
+ struct configuration_spec * config;
+
+
+ /* The permissions that the current URL has */
int permissions;
-
+
+
+ /* socket to talk to client (web browser) */
int cfd;
+
+ /* socket to talk to server (web server or proxy) */
int sfd;
+
#ifdef STATISTICS
/* 1 if this URL was rejected, 0 otherwise. Allows actual stats inc to
* occur in main thread only for thread-safety.
#endif /* def FORCE_LOAD */
#ifdef TOGGLE
- /*
- * by haroon - most of credit to srt19170
- * We add an "on/off" toggle here that is used to effectively toggle
- * the Junkbuster off or on
- */
int toggled_on;
-#endif
+#endif /* def TOGGLE */
+ /*
+ * Client PC's IP address, as reported by the accept()_ function.
+ * Both as string and number
+ */
char *ip_addr_str;
long ip_addr_long;
+
+#ifdef TRUST_FILES
+ /* The referer in this request, if one was specified. */
char *referrer;
+#endif /* def TRUST_FILES */
#if defined(DETECT_MSIE_IMAGES)
/* Types the client will accept.
int accept_types;
#endif /* defined(DETECT_MSIE_IMAGES) */
- const struct gateway *gw;
+ /* The URL that was requested */
struct http_request http[1];
+ /* An I/O buffer used for buffering data read from the client */
struct iob iob[1];
+ /* List of all headers for this request */
struct list headers[1];
+
+ /* List of all cookies for this request */
struct list cookie_list[1];
+
#if defined(PCRS) || defined(KILLPOPUPS)
+ /* Nonzero if this has a text MIME type */
int is_text;
#endif /* defined(PCRS) || defined(KILLPOPUPS) */
+ /* The "X-Forwarded-For:" header sent by the client */
char *x_forwarded;
+ /*
+ * Nonzero if this client is processing data.
+ * Set to zero when the thread associated with this structure dies.
+ */
int active;
/* files associated with this client */
- struct file_list *blist; /* blockfile */
struct file_list *flist; /* forwardfile */
struct file_list *permissions_list;
struct file_list *alist; /* aclfile */
#endif /* def ACL_FILES */
-#ifdef USE_IMAGE_LIST
- struct file_list *ilist; /* imagefile */
-#endif /* def USE_IMAGE_LIST */
-
#ifdef PCRS
struct file_list *rlist; /* Perl re_filterfile */
+ size_t content_length; /* Length after processing */
#endif /* def PCRS */
#ifdef TRUST_FILES
};
-/* this allows the proxy to permit/block access to any host and/or path */
-
+/* A URL pattern */
struct url_spec
{
char *spec;
};
+#ifdef TRUST_FILES
struct block_spec
{
struct url_spec url[1];
int reject;
struct block_spec *next;
};
+#endif /* def TRUST_FILES */
+
+
+#define PERMIT_COOKIE_SET 0x0001U
+#define PERMIT_COOKIE_READ 0x0002U
+#define PERMIT_RE_FILTER 0x0004U
+#define PERMIT_POPUPS 0x0008U
+#define PERMIT_REFERER 0x0010U /* sic - follow HTTP, not English */
+#define PERMIT_FAST_REDIRECTS 0x0020U
+#define PERMIT_BLOCK 0x0040U
+#define PERMIT_IMAGE 0x0080U
+#define PERMIT_USER_AGENT PERMIT_COOKIE_SET /* FIXME Alias this for now */
-#define PERMIT_COOKIE_SET 0x0001
-#define PERMIT_COOKIE_READ 0x0002
-#define PERMIT_RE_FILTER 0x0004
-#define PERMIT_POPUPS 0x0008
+#define PERMIT_MASK_ALL (~0U)
+
+#define PERMIT_MOST_COMPATIBLE (PERMIT_COOKIE_SET | PERMIT_COOKIE_READ | \
+ PERMIT_REFERER | PERMIT_POPUPS | PERMIT_USER_AGENT)
struct permissions_spec
{
- struct url_spec url[1];
- int permissions;
+ struct url_spec url[1];
+ unsigned mask; /* a bit set to "0" = remove permission */
+ unsigned add; /* a bit set to "1" = add permission */
struct permissions_spec * next;
};
+
struct forward_spec
{
struct url_spec url[1];
- int reject;
struct gateway gw[1];
struct forward_spec *next;
};
};
#endif /* def ACL_FILES */
+
+/* Maximum number of loaders (permissions, block, forward, acl...) */
+#define NLOADERS 8
+
+/*
+ * Data loaded from the configuration file.
+ *
+ * (Anomaly: toggle is still handled through a global, not this structure)
+ */
+struct configuration_spec
+{
+ int debug;
+ int multi_threaded;
+
+#ifdef IMAGE_BLOCKING
+ int tinygif;
+ const char *tinygifurl;
+#endif /* def IMAGE_BLOCKING */
+
+ const char *logfile;
+
+ const char *permissions_file;
+ const char *forwardfile;
+
+#ifdef ACL_FILES
+ const char *aclfile;
+#endif /* def ACL_FILES */
+
+#ifdef PCRS
+ const char *re_filterfile;
+#endif /* def PCRS */
+
+ /*
+ * Permissions to use for URLs not in the permissions list.
+ */
+ int default_permissions;
+
+#ifdef JAR_FILES
+ const char * jarfile;
+ FILE * jar;
+#endif /* def JAR_FILES */
+
+ const char *referrer;
+ const char *uagent;
+ const char *from;
+
+ int add_forwarded;
+
+ struct list wafer_list[1];
+ struct list xtra_list[1];
+
+ /*
+ * Port and IP to bind to.
+ * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8000
+ */
+ const char *haddr;
+ int hport;
+
+#ifndef SPLIT_PROXY_ARGS
+ const char *suppress_message;
+#endif /* ndef SPLIT_PROXY_ARGS */
+
+#ifndef SPLIT_PROXY_ARGS
+ /* suppress listing config files */
+ int suppress_blocklists;
+#endif /* ndef SPLIT_PROXY_ARGS */
+
+#ifdef TRUST_FILES
+ const char * trustfile;
+
+ struct list trust_info[1];
+ 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;
+
+ /* the configuration file object. */
+ struct file_list *config_file_list;
+
+ /* List of loaders */
+ int (*loaders[NLOADERS])(struct client_state *);
+
+ /* bool, nonzero if we need to bind() to the new port */
+ int need_bind;
+};
+
+
#define SZ(X) (sizeof(X) / sizeof(*X))
#define WHITEBG "<body bgcolor=\"#ffffff\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
static const char SHEADER[] =
"HTTP/1.0 502 Invalid header received from server\n\n";
-#if defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST)
+#ifdef IMAGE_BLOCKING
/*
* Hint: You can encode your own GIFs like that:
"\372\003S\275\274k2\354\254z\347?\335\274x\306^9\374\276"
"\037Q\000\000;";
-#endif /* defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST) */
+#endif /* def IMAGE_BLOCKING */
-#if defined(FAST_REDIRECTS) || defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST)
+#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";
+ "Location: %s\r\n\r\n";
-#endif /* defined(DETECT_MSIE_IMAGES) || defined(USE_IMAGE_LIST) */
+#endif /* defined(FAST_REDIRECTS) || defined(IMAGE_BLOCKING) */
#ifdef __cplusplus
} /* extern "C" */