X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=a308e1afcca171590f785eb8b625fdae09c0beb2;hp=afdc173d40e3789fe5f904d693211ac31fe923ec;hb=f0826b74e18fc04dd820dec381b50c33475400b3;hpb=1806b665d35568d25f7d90fa17551881d21ca441 diff --git a/project.h b/project.h index afdc173d..a308e1af 100644 --- a/project.h +++ b/project.h @@ -1,6 +1,6 @@ #ifndef PROJECT_H_INCLUDED #define PROJECT_H_INCLUDED -#define PROJECT_H_VERSION "$Id: project.h,v 1.30 2001/09/13 23:52:00 jongfoster Exp $" +#define PROJECT_H_VERSION "$Id: project.h,v 1.50 2002/03/04 19:32:07 oes Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -13,10 +13,10 @@ * IJBSWA team. http://ijbswa.sourceforge.net * * Based on the Internet Junkbuster originally written - * by and Copyright (C) 1997 Anonymous Coders and + * by and Copyright (C) 1997 Anonymous Coders and * Junkbusters Corporation. http://www.junkbusters.com * - * This program is free software; you can redistribute it + * This program is free software; you can redistribute it * and/or modify it under the terms of the GNU General * Public License as published by the Free Software * Foundation; either version 2 of the License, or (at @@ -36,6 +36,106 @@ * * Revisions : * $Log: project.h,v $ + * Revision 1.50 2002/03/04 19:32:07 oes + * Changed default port to 8118 + * + * Revision 1.49 2002/03/04 18:28:55 oes + * Deleted PID_FILE_NAME + * + * Revision 1.48 2002/03/03 14:50:40 oes + * Fixed CLF logging: Added ocmd member for client's request to struct http_request + * + * Revision 1.47 2002/02/20 23:15:13 jongfoster + * Parsing functions now handle out-of-memory gracefully by returning + * an error code. + * + * Revision 1.46 2002/01/17 21:06:09 jongfoster + * Now #defining the URLs of the config interface + * + * Minor changes to struct http_request and struct url_spec due to + * standardizing that struct http_request is used to represent a URL, and + * struct url_spec is used to represent a URL pattern. (Before, URLs were + * represented as seperate variables and a partially-filled-in url_spec). + * + * Revision 1.45 2002/01/09 14:33:27 oes + * Added HOSTENT_BUFFER_SIZE + * + * Revision 1.44 2001/12/30 14:07:32 steudten + * - Add signal handling (unix) + * - Add SIGHUP handler (unix) + * - Add creation of pidfile (unix) + * - Add action 'top' in rc file (RH) + * - Add entry 'SIGNALS' to manpage + * - Add exit message to logfile (unix) + * + * Revision 1.43 2001/11/22 21:57:51 jongfoster + * Making action_spec->flags into an unsigned long rather than just an + * unsigned int. + * Adding ACTION_NO_COOKIE_KEEP + * + * Revision 1.42 2001/11/05 21:42:41 steudten + * Include DBG() macro. + * + * Revision 1.41 2001/10/28 19:12:06 jongfoster + * Adding ijb_toupper() + * + * Revision 1.40 2001/10/26 17:40:47 oes + * Moved ijb_isspace and ijb_tolower to project.h + * Removed http->user_agent, csp->referrer and csp->accept_types + * + * Revision 1.39 2001/10/25 03:45:02 david__schmidt + * Adding a (void*) cast to freez() because Visual Age C++ won't expand the + * macro when called with a cast; so moving the cast to the macro def'n + * seems to both eliminate compiler warnings (on darwin and OS/2, anyway) and + * doesn't make macro expansion complain. Hope this works for everyone else + * too... + * + * Revision 1.38 2001/10/23 21:19:04 jongfoster + * New error-handling support: jb_err type and JB_ERR_xxx constants + * CGI functions now return a jb_err, and their parameters map is const. + * Support for RUNTIME_FEATUREs to enable/disable config editor + * Adding a few comments + * + * Revision 1.37 2001/10/14 22:14:01 jongfoster + * Removing name_length field from struct cgi_dispatcher, as this is + * now calculated at runtime from the "name" field. + * + * Revision 1.36 2001/10/10 16:45:15 oes + * Added LIMIT_CONNECT action and string + * Fixed HTTP message line termination + * Added CFORBIDDEN HTTP message + * + * Revision 1.35 2001/10/07 18:06:43 oes + * Added status member to struct http_request + * + * Revision 1.34 2001/10/07 15:45:25 oes + * Added url member to struct http_request and commented all + * members + * + * Added CT_TABOO + * + * Added ACTION_DOWNGRADE and ACTION_NO_COMPRESSION + * + * Replaced struct client_state members rejected, + * force, active and toggled_on with "flags" bitmap. + * + * Added CSP_FLAG_MODIFIED and CSP_FLAG_CHUNKED + * + * Added buffer_limit to struct configuration_spec + * + * Revision 1.33 2001/09/20 13:30:08 steudten + * + * Make freez() more secure in case of: if (exp) { free(z) ; a=*z } + * Last case will set z to NULL in free(z) and thats bad.. + * + * Revision 1.32 2001/09/16 23:02:51 jongfoster + * Fixing warning + * + * Revision 1.31 2001/09/16 13:20:29 jongfoster + * Rewrite of list library. Now has seperate header and list_entry + * structures. Also added a large sprinking of assert()s to the list + * code. + * * Revision 1.30 2001/09/13 23:52:00 jongfoster * Support for both static and dynamically generated CGI pages * @@ -274,9 +374,9 @@ #endif #ifdef STATIC_PCRS -# include "pcrs.h" +# include "pcrs.h" #else -# include +# include #endif #if defined(REGEX_PCRE) @@ -291,24 +391,72 @@ # include "gnu_regex.h" #endif -#ifdef AMIGA -#include "amiga.h" +#ifdef AMIGA +#include "amiga.h" #endif /* def AMIGA */ #ifdef __cplusplus extern "C" { #endif -#define freez(X) if(X) free(X); X = NULL +/* + * Error codes. Functions returning these should return a jb_err + */ +#define JB_ERR_OK 0 /* Success, no error */ +#define JB_ERR_MEMORY 1 /* Out of memory */ +#define JB_ERR_CGI_PARAMS 2 /* Missing or corrupt CGI parameters */ +#define JB_ERR_FILE 3 /* Error opening, reading or writing a file */ +#define JB_ERR_PARSE 4 /* Error parsing file */ +#define JB_ERR_MODIFIED 5 /* File has been modified outside of the */ + /* CGI actions editor. */ +typedef int jb_err; + + +/* + * This macro is used to free a pointer that may be NULL + */ +#define freez(X) { if(X) { free((void*)X); X = NULL ; } } + + +/* Fix a problem with Solaris. There should be no effect on other + * platforms. + * Solaris's isspace() is a macro which uses it's argument directly + * as an array index. Therefore we need to make sure that high-bit + * characters generate +ve values, and ideally we also want to make + * the argument match the declared parameter type of "int". + * + * Note: Remember to #include if you use these macros. + */ +#define ijb_toupper(__X) toupper((int)(unsigned char)(__X)) +#define ijb_tolower(__X) tolower((int)(unsigned char)(__X)) +#define ijb_isspace(__X) isspace((int)(unsigned char)(__X)) + +/* + * Use for statically allocated buffers if you have no other choice. + * Remember to check the length of what you write into the buffer + * - we don't want any buffer overflows! + */ #define BUFFER_SIZE 5000 +/* + * Buffer size for capturing struct hostent data in the + * gethostby(name|addr)_r library calls. Since we don't + * loop over gethostbyname_r, the buffer must be sufficient + * to accomodate multiple IN A RRs, as used in DNS round robin + * load balancing. W3C's wwwlib uses 1K, so that should be + * good enough for us, too. + */ +#define HOSTENT_BUFFER_SIZE 1024 + +/* + * So you can say "while (FOREVER) { ...do something... }" + */ #define FOREVER 1 /* Default IP and port to listen on */ #define HADDR_DEFAULT "127.0.0.1" -#define HADDR_PORT 8000 - +#define HADDR_PORT 8118 /* Forward defs for various structures */ @@ -349,16 +497,25 @@ struct map struct http_request { - char *cmd; - char *gpc; - char *host; - char *host_ip_addr_str; /* NULL before connect_to() */ - int port; - char *path; - char *ver; - char *hostport; /* "host[:port]" */ - int ssl; - char *user_agent; /* Client's User-Agent: header value */ + char *cmd; /* Whole command line: method, URL, Version */ + char *ocmd; /* Backup of original cmd for CLF logging */ + char *gpc; /* HTTP method: GET, POST, .. */ + char *url; /* The URL */ + char *ver; /* Protocol version */ + int status; /* HTTP Status */ + + char *host; /* Host part of URL */ + int port; /* Port of URL or 80 (default) */ + char *path; /* Path of URL */ + char *hostport; /* host[:port] */ + int ssl; /* Flag if protocol is https */ + + char *host_ip_addr_str; /* String with dotted decimal representation + * of host's IP. NULL before connect_to() */ + + char *dbuffer; /* Buffer with '\0'-delimited domain name. */ + char **dvec; /* List of pointers to the strings in dbuffer. */ + int dcount; /* How many parts to this domain? (length of dvec) */ }; /* Response generated by CGI, blocker, or error handler */ @@ -380,13 +537,11 @@ struct url_spec 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 */ + /* Hostname matching, or dbuffer == NULL to match all hosts */ + char *dbuffer; /* Buffer with '\0'-delimited domain name. */ + char **dvec; /* List of pointers to the strings in dbuffer. */ + int dcount; /* How many parts to this domain? (length of dvec) */ + int unanchored; /* Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */ /* Port matching: */ int port; /* The port number, or 0 to match all ports. */ @@ -400,9 +555,9 @@ struct url_spec #endif }; #ifdef REGEX -#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL } +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL } #else /* ifndef REGEX */ -#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, 0, 0, 0, NULL, 0 } +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0 } #endif /* ndef REGEX */ /* Constants for host part matching in URLs */ @@ -423,35 +578,40 @@ struct iob #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob)); /* Keys for csp->content_type */ -#define CT_TEXT 0x01U -#define CT_GIF 0x02U +#define CT_TEXT 1 /* Suitable for pcrs filtering */ +#define CT_GIF 2 /* Suitable for GIF filtering */ +#define CT_TABOO 3 /* DONT filter */ #define ACTION_MASK_ALL (~0U) -#define ACTION_MOST_COMPATIBLE 0x0000U - -#define ACTION_BLOCK 0x0001U -#define ACTION_DEANIMATE 0x2000U -#define ACTION_FAST_REDIRECTS 0x0002U -#define ACTION_FILTER 0x0004U -#define ACTION_HIDE_FORWARDED 0x0008U -#define ACTION_HIDE_FROM 0x0010U -#define ACTION_HIDE_REFERER 0x0020U /* sic - follow HTTP, not English */ -#define ACTION_HIDE_USER_AGENT 0x0040U -#define ACTION_IMAGE 0x0080U -#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_MOST_COMPATIBLE 0x00000000UL + +#define ACTION_BLOCK 0x00000001UL +#define ACTION_DEANIMATE 0x00000002UL +#define ACTION_DOWNGRADE 0x00000004UL +#define ACTION_FAST_REDIRECTS 0x00000008UL +#define ACTION_FILTER 0x00000010UL +#define ACTION_HIDE_FORWARDED 0x00000020UL +#define ACTION_HIDE_FROM 0x00000040UL +#define ACTION_HIDE_REFERER 0x00000080UL /* sic - follow HTTP, not English */ +#define ACTION_HIDE_USER_AGENT 0x00000100UL +#define ACTION_IMAGE 0x00000200UL +#define ACTION_IMAGE_BLOCKER 0x00000400UL +#define ACTION_NO_COMPRESSION 0x00000800UL +#define ACTION_NO_COOKIE_KEEP 0x00001000UL +#define ACTION_NO_COOKIE_READ 0x00002000UL +#define ACTION_NO_COOKIE_SET 0x00004000UL +#define ACTION_NO_POPUPS 0x00008000UL +#define ACTION_VANILLA_WAFER 0x00010000UL +#define ACTION_LIMIT_CONNECT 0x00020000UL #define ACTION_STRING_DEANIMATE 0 #define ACTION_STRING_FROM 1 #define ACTION_STRING_IMAGE_BLOCKER 2 #define ACTION_STRING_REFERER 3 #define ACTION_STRING_USER_AGENT 4 -#define ACTION_STRING_COUNT 5 - +#define ACTION_STRING_LIMIT_CONNECT 5 +#define ACTION_STRING_COUNT 6 #define ACTION_MULTI_ADD_HEADER 0 #define ACTION_MULTI_WAFER 1 @@ -465,7 +625,7 @@ struct iob */ struct current_action_spec { - unsigned flags; /* a bit set to "1" = add action */ + unsigned long flags; /* a bit set to "1" = add action */ /* For those actions that require parameters: */ @@ -484,8 +644,8 @@ struct current_action_spec */ struct action_spec { - unsigned mask; /* a bit set to "0" = remove action */ - unsigned add; /* a bit set to "1" = add action */ + unsigned long mask; /* a bit set to "0" = remove action */ + unsigned long add; /* a bit set to "1" = add action */ /* For those actions that require parameters: */ @@ -518,29 +678,23 @@ struct url_actions }; -/* Constants defining bitmask for csp->accept_types */ - -#ifdef FEATURE_IMAGE_DETECT_MSIE - -/* MSIE detected by user-agent string */ -#define ACCEPT_TYPE_IS_MSIE 0x0001 - /* - * *If* this is MSIE, it wants an image. (Or this is a shift-reload, or - * it's got an image from this URL before... yuck!) - * Only meaningful if ACCEPT_TYPE_IS_MSIE set + * Flags for use in csp->flags */ -#define ACCEPT_TYPE_MSIE_IMAGE 0x0002 +#define CSP_FLAG_ACTIVE 0x01 /* Set if this client is processing data. + * Cleared when the thread associated with + * this structure dies. */ +#define CSP_FLAG_CHUNKED 0x02 /* Set if the server's reply is in "chunked" + * transfer encoding */ +#define CSP_FLAG_FORCED 0x04 /* Set if this request was enforced, although + * it would normally have been blocked. */ +#define CSP_FLAG_MODIFIED 0x08 /* Set if any modification to the body was done */ +#define CSP_FLAG_REJECTED 0x10 /* Set if request was blocked. */ +#define CSP_FLAG_TOGGLED_ON 0x20 /* Set if we are toggled on (FEATURE_TOGGLE) */ /* - * *If* this is MSIE, it wants a HTML document. - * Only meaningful if ACCEPT_TYPE_IS_MSIE set + * The state of a JunkBuster processing thread. */ -#define ACCEPT_TYPE_MSIE_HTML 0x0004 - -#endif /* def FEATURE_IMAGE_DETECT_MSIE */ - - struct client_state { /* The proxy's configuration */ @@ -555,21 +709,8 @@ struct client_state /* socket to talk to server (web server or proxy) */ int sfd; - -#ifdef FEATURE_STATISTICS - /* 1 if this URL was rejected, 0 otherwise. Allows actual stats inc to - * occur in main thread only for thread-safety. - */ - int rejected; -#endif /* def FEATURE_STATISTICS */ - -#ifdef FEATURE_FORCE_LOAD - int force; -#endif /* def FEATURE_FORCE_LOAD */ - -#ifdef FEATURE_TOGGLE - int toggled_on; -#endif /* def FEATURE_TOGGLE */ + /* Multi-purpose flag container, see CSP_FLAG_* above */ + unsigned short int flags; /* * Client PC's IP address, as reported by the accept()_ function. @@ -586,18 +727,6 @@ struct client_state char *my_ip_addr_str; char *my_hostname; -#ifdef FEATURE_TRUST - /* The referer in this request, if one was specified. */ - char *referrer; -#endif /* def FEATURE_TRUST */ - -#if defined(FEATURE_IMAGE_DETECT_MSIE) - /* Types the client will accept. - * Bitmask - see ACCEPT_TYPE_XXX constants. - */ - int accept_types; -#endif /* defined(FEATURE_IMAGE_DETECT_MSIE) */ - /* The URL that was requested */ struct http_request http[1]; @@ -610,23 +739,17 @@ struct client_state /* List of all cookies for this request */ struct list cookie_list[1]; - /* MIME-Type bitmap, see CT_* above */ - unsigned char content_type; + /* MIME-Type key, see CT_* above */ + unsigned short int content_type; /* 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 *actions_list; struct file_list *rlist; /* pcrs job file */ - size_t content_length; /* Length after content modification */ + size_t content_length; /* Length after content modification */ #ifdef FEATURE_TRUST struct file_list *tlist; /* trustfile */ @@ -636,21 +759,41 @@ struct client_state }; +/* + * A function to add a header + */ +typedef jb_err (*add_header_func_ptr)(struct client_state *); + +/* + * A function to process a header + */ +typedef jb_err (*parser_func_ptr )(struct client_state *, char **); + +/* + * List of functions to run on a list of headers + */ struct parsers { char *str; char len; - char *(*parser)(const struct parsers *, const char *, struct client_state *); + parser_func_ptr parser; }; + +/* + * List of available CGI functions. + */ struct cgi_dispatcher { - const char *name; - int name_length; - int (*handler)(struct client_state *csp, struct http_response *rsp, struct map *parameters); - const char *description; + const char * const name; + jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters); + const char * const description; }; + +/* + * A data file used by JunkBuster. Kept in a linked list. + */ struct file_list { /* @@ -658,11 +801,11 @@ struct file_list * Read-only once the structure has been created. */ void *f; - + /* Normally NULL. When we are finished with file (i.e. when we have * loaded a new one), set to a pointer to an unloader function. * Unloader will be called by sweep() (called from main loop) when - * all clients using this file are done. This prevents threading + * all clients using this file are done. This prevents threading * problems. */ void (*unloader)(void *); @@ -718,7 +861,7 @@ struct forward_spec /* For the linked list */ struct forward_spec *next; }; -#define FORWARD_SPEC_INITIALIZER { URL_SPEC_INITIALIZER, 0, NULL, 0, NULL, 0, NULL } +#define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL } struct re_filterfile_spec @@ -754,6 +897,11 @@ struct access_control_list /* Maximum number of loaders (actions, re_filter, ...) */ #define NLOADERS 8 + +#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1 +#define RUNTIME_FEATURE_CGI_TOGGLE 2 + + /* * Data loaded from the configuration file. * @@ -764,6 +912,9 @@ struct configuration_spec int debug; int multi_threaded; + /* Features that can be enabled/disabled throuigh the config file */ + unsigned feature_flags; + const char *logfile; const char *confdir; @@ -785,11 +936,14 @@ struct configuration_spec /* * Port and IP to bind to. - * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8000 + * Defaults to HADDR_DEFAULT:HADDR_PORT == 127.0.0.1:8118 */ const char *haddr; int hport; + /* Size limit for IOB */ + size_t buffer_limit; + #ifdef FEATURE_TRUST const char * trustfile; @@ -824,17 +978,39 @@ struct configuration_spec #endif /* def FEATURE_FORCE_LOAD */ /* 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" +#define HOME_PAGE_URL "http://ijbswa.sourceforge.net" +#define REDIRECT_URL HOME_PAGE_URL "/redirect.php?v=" VERSION "&to=" + +/* + * The "hosts" to intercept and display CGI pages. + * First one is a hostname only, second one can specify host and path. + * + * Notes: + * 1) Do not specify the http: prefix + * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically. + * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string. + */ +#define CGI_SITE_1_HOST "i.j.b" +#define CGI_SITE_2_HOST "ijbswa.sourceforge.net" +#define CGI_SITE_2_PATH "/config" + +/* + * The prefix for CGI pages. Written out in generated HTML. + * INCLUDES the trailing slash. + */ +#define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/" + /* HTTP snipplets */ static const char CSUCCEED[] = "HTTP/1.0 200 Connection established\n" - "Proxy-Agent: IJ/" VERSION "\n\n"; + "Proxy-Agent: IJ/" VERSION "\r\n\r\n"; static const char CHEADER[] = - "HTTP/1.0 400 Invalid header received from browser\n\n"; + "HTTP/1.0 400 Invalid header received from browser\r\n\r\n"; + +static const char CFORBIDDEN[] = + "HTTP/1.0 403 Connection not allowable\r\nX-Hint: If you read this message interactively, then you know why this happens ,-)\r\n\r\n"; #ifdef __cplusplus } /* extern "C" */