#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
/** Version string. */
-#define PROJECT_H_VERSION "$Id: project.h,v 1.71 2002/05/12 21:39:36 jongfoster Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.83 2006/12/06 19:26:29 fabiankeil Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
* project. Does not define any variables or functions
* (though it does declare some macros).
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001 - 2004 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.83 2006/12/06 19:26:29 fabiankeil
+ * Moved HTTP snipplets into jcc.c. They aren't
+ * used anywhere else.
+ *
+ * Revision 1.82 2006/09/20 15:50:31 fabiankeil
+ * Doubled size of HOSTENT_BUFFER_SIZE to mask
+ * problems with gethostbyname_r and some
+ * /etc/hosts configurations. Only a workaround
+ * until we get the real fix ready.
+ * Thanks FĂ©lix Rauch for reporting.
+ *
+ * Increased value of MAX_TRUSTED_REFERRERS from 64 to 512.
+ *
+ * Revision 1.81 2006/09/06 13:03:04 fabiankeil
+ * Respond with 400 and a short text message
+ * if the client tries to use Privoxy as FTP proxy.
+ *
+ * Revision 1.80 2006/09/06 10:43:32 fabiankeil
+ * Added config option enable-remote-http-toggle
+ * to specify if Privoxy should recognize special
+ * headers (currently only X-Filter) to change its
+ * behaviour. Disabled by default.
+ *
+ * Revision 1.79 2006/09/06 09:23:37 fabiankeil
+ * Make number of retries in case of forwarded-connect problems
+ * a config file option (forwarded-connect-retries) and use 0 as
+ * default.
+ *
+ * Revision 1.78 2006/08/31 16:25:06 fabiankeil
+ * Work around a buffer overflow that caused Privoxy to
+ * segfault if too many trusted referrers were used. Good
+ * enough for now, but should be replaced with a real
+ * solution after the next release.
+ *
+ * Revision 1.77 2006/08/21 12:50:51 david__schmidt
+ * Formatting cleanup
+ *
+ * Revision 1.76 2006/08/14 08:25:19 fabiankeil
+ * Split filter-headers{} into filter-client-headers{}
+ * and filter-server-headers{}.
+ * Added parse_header_time() to share some code.
+ * Replaced timegm() with mktime().
+ *
+ * Revision 1.75 2006/08/03 02:46:41 david__schmidt
+ * Incorporate Fabian Keil's patch work:\r * http://www.fabiankeil.de/sourcecode/privoxy/
+ *
+ * Revision 1.74 2006/07/18 14:48:47 david__schmidt
+ * Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
+ * with what was really the latest development (the v_3_0_branch branch)
+ *
+ * Revision 1.72.2.7 2006/01/29 23:10:56 david__schmidt
+ * Multiple filter file support
+ *
+ * Revision 1.72.2.6 2004/10/03 12:53:46 david__schmidt
+ * Add the ability to check jpeg images for invalid
+ * lengths of comment blocks. Defensive strategy
+ * against the exploit:
+ * Microsoft Security Bulletin MS04-028
+ * Buffer Overrun in JPEG Processing (GDI+) Could
+ * Allow Code Execution (833987)
+ * Enabled with +inspect-jpegs in actions files.
+ *
+ * Revision 1.72.2.5 2004/01/30 15:29:29 oes
+ * Updated the copyright note
+ *
+ * Revision 1.72.2.4 2004/01/13 16:12:14 oes
+ * Fixed double slash in USER_MANUAL_URL. Closes BR #867088.
+ *
+ * Revision 1.72.2.3 2003/03/11 11:54:37 oes
+ * Introduced RC_FLAG_* flags for use in child process return code
+ *
+ * Revision 1.72.2.2 2002/11/28 18:15:44 oes
+ * Added flag to each cgi_dispatcher that allows or denies
+ * external linking and removed const qualifier from
+ * struct list_entry.str.
+ *
+ * Revision 1.72.2.1 2002/08/10 11:25:18 oes
+ * - Include config.h for access to config data
+ * - Include <pcre*.h> depending on where they are
+ *
+ * Revision 1.72 2002/05/14 21:35:49 oes
+ * Split HELP_LINK_PREFIX into ACTIONS_HELP_PREFIX and CONFIG_HELP_PREFIX
+ * because of split in user-manual
+ *
* Revision 1.71 2002/05/12 21:39:36 jongfoster
* - Adding Doxygen-style comments to structures and #defines.
*
* Revision 1.67 2002/04/24 02:12:43 oes
* - Jon's multiple AF patch:
* - Make csp->actions_list an array
- * - #define MAX_ACTION_FILES
+ * - #define MAX_AF_FILES
* - Moved CGI_PARAM_LEN_MAX (500) here
*
* Revision 1.66 2002/04/15 19:06:43 jongfoster
/* Need time_t for file_list */
#include <time.h>
+/* Needed for pcre choice */
+#include "config.h"
/*
* Include appropriate regular expression libraries.
#ifdef STATIC_PCRE
# include "pcre.h"
#else
-# include <pcre.h>
+# ifdef PCRE_H_IN_SUBDIR
+# include <pcre/pcre.h>
+# else
+# include <pcre.h>
+# endif
#endif
#ifdef STATIC_PCRS
#ifdef STATIC_PCRE
# include "pcreposix.h"
#else
-# include <pcreposix.h>
+# ifdef PCRE_H_IN_SUBDIR
+# include <pcre/pcreposix.h>
+# else
+# include <pcreposix.h>
+# endif
#endif
#ifdef AMIGA
* load balancing. W3C's wwwlib uses 1K, so that should be
* good enough for us, too.
*/
-#define HOSTENT_BUFFER_SIZE 1024
+/**
+ * XXX: Temporary doubled, for some configurations
+ * 1K is still too small and we didn't get the
+ * real fix ready for inclusion.
+ */
+#define HOSTENT_BUFFER_SIZE 2048
/**
* Do not use. Originally this was so that you can
struct list_entry
{
/**
- * The string. The "const" is only to discourage modification,
- * you can actually change it if you *really* want to.
- * You can even freez() it and replace it with another
- * malloc()d string. If you replace it with NULL, the list
- * functions will work, just be careful next time you iterate
- * through the list in your own code.
- *
- * FIXME: Should we remove the "const"?
+ * The string pointer. It must point to a dynamically malloc()ed
+ * string or be NULL for the list functions to work. In the latter
+ * case, just be careful next time you iterate through the list in
+ * your own code.
*/
- const char *str;
+ char *str;
/** Next entry in the linked list, or NULL if no more. */
struct list_entry *next;
Suitable for GIF filtering. */
#define CT_TABOO 4 /**< csp->content_type bitmask:
DO NOT filter, irrespective of other flags. */
+#define CT_JPEG 8 /**< csp->content_type bitmask:
+ Suitable for JPEG filtering. */
/**
* The mask which includes all actions.
/**
* The most compatible set of actions - i.e. none.
*/
-#define ACTION_MOST_COMPATIBLE 0x00000000UL
+#define ACTION_MOST_COMPATIBLE 0x00000000UL
/** Action bitmap: Block the request. */
-#define ACTION_BLOCK 0x00000001UL
+#define ACTION_BLOCK 0x00000001UL
/** Action bitmap: Deanimate if it's a GIF. */
-#define ACTION_DEANIMATE 0x00000002UL
+#define ACTION_DEANIMATE 0x00000002UL
/** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
-#define ACTION_DOWNGRADE 0x00000004UL
+#define ACTION_DOWNGRADE 0x00000004UL
/** Action bitmap: Fast redirects. */
-#define ACTION_FAST_REDIRECTS 0x00000008UL
+#define ACTION_FAST_REDIRECTS 0x00000008UL
/** Action bitmap: Remove existing "Forwarded" header, and do not add another. */
-#define ACTION_HIDE_FORWARDED 0x00000010UL
+#define ACTION_HIDE_FORWARDED 0x00000010UL
/** Action bitmap: Hide "From" header. */
-#define ACTION_HIDE_FROM 0x00000020UL
+#define ACTION_HIDE_FROM 0x00000020UL
/** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
-#define ACTION_HIDE_REFERER 0x00000040UL
+#define ACTION_HIDE_REFERER 0x00000040UL
/** Action bitmap: Hide "User-Agent" and similar headers. */
-#define ACTION_HIDE_USER_AGENT 0x00000080UL
+#define ACTION_HIDE_USER_AGENT 0x00000080UL
/** Action bitmap: This is an image. */
-#define ACTION_IMAGE 0x00000100UL
+#define ACTION_IMAGE 0x00000100UL
/** Action bitmap: Sets the image blocker. */
-#define ACTION_IMAGE_BLOCKER 0x00000200UL
+#define ACTION_IMAGE_BLOCKER 0x00000200UL
/** Action bitmap: Prevent compression. */
-#define ACTION_NO_COMPRESSION 0x00000400UL
+#define ACTION_NO_COMPRESSION 0x00000400UL
/** Action bitmap: Change cookies to session only cookies. */
-#define ACTION_NO_COOKIE_KEEP 0x00000800UL
+#define ACTION_NO_COOKIE_KEEP 0x00000800UL
/** Action bitmap: Block rending cookies. */
-#define ACTION_NO_COOKIE_READ 0x00001000UL
+#define ACTION_NO_COOKIE_READ 0x00001000UL
/** Action bitmap: Block setting cookies. */
-#define ACTION_NO_COOKIE_SET 0x00002000UL
+#define ACTION_NO_COOKIE_SET 0x00002000UL
/** Action bitmap: Filter out popups. */
-#define ACTION_NO_POPUPS 0x00004000UL
+#define ACTION_NO_POPUPS 0x00004000UL
/** Action bitmap: Send a vanilla wafer. */
-#define ACTION_VANILLA_WAFER 0x00008000UL
+#define ACTION_VANILLA_WAFER 0x00008000UL
/** Action bitmap: Limit CONNECT requests to safe ports. */
-#define ACTION_LIMIT_CONNECT 0x00010000UL
+#define ACTION_LIMIT_CONNECT 0x00010000UL
+/** Action bitmap: Inspect if it's a JPEG. */
+#define ACTION_JPEG_INSPECT 0x00020000UL
+/** Action bitmap: Crunch or modify "if-modified-since" header. */
+#define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
+/** Action bitmap: Overwrite Content-Type header. */
+#define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
+/** Action bitmap: Crunch specified server header. */
+#define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
+/** Action bitmap: Crunch specified client header */
+#define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
+/** Action bitmap: Enable text mode by force */
+#define ACTION_FORCE_TEXT_MODE 0x00400000UL
+/** Action bitmap: Enable text mode by force */
+#define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
+/** Action bitmap: Enable content-dispostion crunching */
+#define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
+/** Action bitmap: Replace or block Last-Modified header */
+#define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
+/** Action bitmap: Replace or block Accept-Language header */
+#define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
+/** Action bitmap: Block as empty document */
+#define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x08000000UL
+/** Action bitmap: Redirect request. */
+#define ACTION_REDIRECT 0x10000000UL
+/** Action bitmap: Answer blocked Connects verbosely */
+#define ACTION_TREAT_FORBIDDEN_CONNECTS_LIKE_BLOCKS 0x20000000UL
+/** Action bitmap: Filter server headers with pcre */
+#define ACTION_FILTER_SERVER_HEADERS 0x40000000UL
+/** Action bitmap: Filter client headers with pcre */
+#define ACTION_FILTER_CLIENT_HEADERS 0x80000000UL
+
/** Action string index: How to deanimate GIFs */
-#define ACTION_STRING_DEANIMATE 0
+#define ACTION_STRING_DEANIMATE 0
/** Action string index: Replacement for "From:" header */
-#define ACTION_STRING_FROM 1
+#define ACTION_STRING_FROM 1
/** Action string index: How to block images */
-#define ACTION_STRING_IMAGE_BLOCKER 2
+#define ACTION_STRING_IMAGE_BLOCKER 2
/** Action string index: Replacement for "Referer:" header */
-#define ACTION_STRING_REFERER 3
+#define ACTION_STRING_REFERER 3
/** Action string index: Replacement for "User-Agent:" header */
-#define ACTION_STRING_USER_AGENT 4
+#define ACTION_STRING_USER_AGENT 4
/** Action string index: Legal CONNECT ports. */
-#define ACTION_STRING_LIMIT_CONNECT 5
+#define ACTION_STRING_LIMIT_CONNECT 5
+/** Action string index: Server headers containing this pattern are crunched*/
+#define ACTION_STRING_SERVER_HEADER 6
+/** Action string index: Client headers containing this pattern are crunched*/
+#define ACTION_STRING_CLIENT_HEADER 7
+/** Action string index: Replacement for the "Accept-Language:" header*/
+#define ACTION_STRING_LANGUAGE 8
+/** Action string index: Replacement for the "Content-Type:" header*/
+#define ACTION_STRING_CONTENT_TYPE 9
+/** Action string index: Replacement for the "content-dispostion:" header*/
+#define ACTION_STRING_CONTENT_DISPOSITION 10
+/** Action string index: Replacement for the "If-Modified-Since:" header*/
+#define ACTION_STRING_IF_MODIFIED_SINCE 11
+/** Action string index: Replacement for the "Last-Modified:" header. */
+#define ACTION_STRING_LAST_MODIFIED 12
+/** Action string index: Redirect URL */
+#define ACTION_STRING_REDIRECT 13
+/** Action string index: Decode before redirect? */
+#define ACTION_STRING_FAST_REDIRECTS 14
/** Number of string actions. */
-#define ACTION_STRING_COUNT 6
+#define ACTION_STRING_COUNT 15
+
+
+/*To make the ugly hack in sed easier to understand*/
+#define CHECK_EVERY_HEADER_REMAINING 0
+
/** Index into current_action_spec::multi[] for headers to add. */
#define ACTION_MULTI_ADD_HEADER 0
#define CSP_FLAG_TOGGLED_ON 0x20
+/*
+ * Flags for use in return codes of child processes
+ */
+
+/**
+ * Flag for process return code: Set if exiting porcess has been toggled
+ * during its lifetime.
+ */
+#define RC_FLAG_TOGGLED 0x10
+
+/**
+ * Flag for process return code: Set if exiting porcess has blocked its
+ * request.
+ */
+#define RC_FLAG_BLOCKED 0x20
+
/**
- * Maximum number of actions files. This limit is arbitrary - it's just used
+ * Maximum number of actions/filter files. This limit is arbitrary - it's just used
* to size an array.
*/
-#define MAX_ACTION_FILES 10
+#define MAX_AF_FILES 10
/**
* The state of a Privoxy processing thread.
char *x_forwarded;
/** Actions files associated with this client */
- struct file_list *actions_list[MAX_ACTION_FILES];
+ struct file_list *actions_list[MAX_AF_FILES];
- /** pcrs job file. */
- struct file_list *rlist;
+ /** pcrs job files. */
+ struct file_list *rlist[MAX_AF_FILES];
/** Length after content modification. */
size_t content_length;
/** The description of the CGI, to appear on the main menu, or NULL to hide it. */
const char * const description;
+
+ /** A flag that indicates whether unintentional calls to this CGI can cause damage */
+ int harmless;
};
struct block_spec *next; /**< Next entry in linked list */
};
+/**
+ * Arbitrary limit for the number of trusted referrers
+ * Privoxy can print in its blocking message.
+ */
+#define MAX_TRUSTED_REFERRERS 512
+
#endif /* def FEATURE_TRUST */
/** configuration_spec::feature_flags: Web-based toggle. */
#define RUNTIME_FEATURE_CGI_TOGGLE 2
+/** configuration_spec::feature_flags: HTTP-header-based toggle. */
+#define RUNTIME_FEATURE_HTTP_TOGGLE 4
+
+/** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
+#define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8
/**
* Data loaded from the configuration file.
*
* - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
* - RUNTIME_FEATURE_CGI_TOGGLE
+ * - RUNTIME_FEATURE_HTTP_TOGGLE
+ * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
*/
unsigned feature_flags;
const char *logdir;
/** The full paths to the actions files. */
- const char *actions_file[MAX_ACTION_FILES];
+ const char *actions_file[MAX_AF_FILES];
/** The short names of the actions files. */
- const char *actions_file_short[MAX_ACTION_FILES];
+ const char *actions_file_short[MAX_AF_FILES];
/** The administrator's email address */
char *admin_address;
/** URL to the user manual (on our website or local copy) */
char *usermanual;
- /** The file name of the pcre filter file */
- const char *re_filterfile;
+ /** The file names of the pcre filter files. */
+ const char *re_filterfile[MAX_AF_FILES];
+
+ /** The short names of the pcre filter files. */
+ const char *re_filterfile_short[MAX_AF_FILES];
#ifdef FEATURE_COOKIE_JAR
struct list trust_info[1];
/** FIXME: DOCME: Document this. */
- struct url_spec *trust_list[64];
+ struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
#endif /* def FEATURE_TRUST */
/** Information about parent proxies (forwarding). */
struct forward_spec *forward;
+ /** Number of retries in case a forwarded connection attempt fails */
+ int forwarded_connect_retries;
+
/** All options from the config file, HTML-formatted. */
char *proxy_args;
#define HOME_PAGE_URL "http://www.privoxy.org/"
/** URL for the Privoxy user manual. */
-#define USER_MANUAL_URL HOME_PAGE_URL "/" VERSION "/user-manual/"
+#define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
/** Prefix for actions help links (append to USER_MANUAL_URL). */
#define ACTIONS_HELP_PREFIX "actions-file.html#"
*/
#define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
-
-/* HTTP snipplets.
- *
- * FIXME: This is very inefficient. There could be one copy of these strings
- * for each .c file!! They should be "extern", not "static".
- */
-static const char CSUCCEED[] =
- "HTTP/1.0 200 Connection established\n"
- "Proxy-Agent: Privoxy/" VERSION "\r\n\r\n";
-
-static const char CHEADER[] =
- "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" */
#endif