#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
/** Version string. */
-#define PROJECT_H_VERSION "$Id: project.h,v 1.70 2002/05/12 16:05:50 jongfoster Exp $"
+#define PROJECT_H_VERSION "$Id: project.h,v 1.110 2008/03/29 12:13:46 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-2008 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
* Revisions :
* $Log: project.h,v $
+ * Revision 1.110 2008/03/29 12:13:46 fabiankeil
+ * Remove send-wafer and send-vanilla-wafer actions.
+ *
+ * Revision 1.109 2008/03/28 15:13:41 fabiankeil
+ * Remove inspect-jpegs action.
+ *
+ * Revision 1.108 2008/03/27 18:27:36 fabiankeil
+ * Remove kill-popups action.
+ *
+ * Revision 1.107 2008/03/26 18:07:08 fabiankeil
+ * Add hostname directive. Closes PR#1918189.
+ *
+ * Revision 1.106 2008/03/24 11:21:03 fabiankeil
+ * Share the action settings for multiple patterns in the same
+ * section so we waste less memory for gigantic block lists
+ * (and load them slightly faster). Reported by Franz Schwartau.
+ *
+ * Revision 1.105 2008/03/21 11:16:27 fabiankeil
+ * Garbage-collect csp->my_ip_addr_str and csp->my_hostname.
+ *
+ * Revision 1.104 2008/03/04 18:30:40 fabiankeil
+ * Remove the treat-forbidden-connects-like-blocks action. We now
+ * use the "blocked" page for forbidden CONNECT requests by default.
+ *
+ * Revision 1.103 2008/03/01 14:00:45 fabiankeil
+ * Let the block action take the reason for the block
+ * as argument and show it on the "blocked" page.
+ *
+ * Revision 1.102 2008/02/03 13:46:14 fabiankeil
+ * Add SOCKS5 support. Patch #1862863 by Eric M. Hopper with minor changes.
+ *
+ * Revision 1.101 2007/12/07 18:29:23 fabiankeil
+ * Remove now-obsolete csp member x_forwarded.
+ *
+ * Revision 1.100 2007/09/02 13:42:11 fabiankeil
+ * - Allow port lists in url patterns.
+ * - Ditch unused url_spec member pathlen.
+ *
+ * Revision 1.99 2007/07/21 11:51:36 fabiankeil
+ * As Hal noticed, checking dispatch_cgi() as the last cruncher
+ * looks like a bug if CGI requests are blocked unintentionally,
+ * so don't do it unless the user enabled the new config option
+ * "allow-cgi-request-crunching".
+ *
+ * Revision 1.98 2007/07/14 07:31:26 fabiankeil
+ * Add new csp->content_type flag (CT_DECLARED).
+ *
+ * Revision 1.97 2007/05/27 12:38:08 fabiankeil
+ * - Remove some left-overs from the switch to dedicated header filters.
+ * - Adjust "X-Filter: No" to disable dedicated header filters.
+ * - Prepare for forward-override{}
+ *
+ * Revision 1.96 2007/05/14 10:41:15 fabiankeil
+ * Ditch the csp member cookie_list[] which isn't used anymore.
+ *
+ * Revision 1.95 2007/04/30 15:02:19 fabiankeil
+ * Introduce dynamic pcrs jobs that can resolve variables.
+ *
+ * Revision 1.94 2007/04/15 16:39:21 fabiankeil
+ * Introduce tags as alternative way to specify which
+ * actions apply to a request. At the moment tags can be
+ * created based on client and server headers.
+ *
+ * Revision 1.93 2007/03/20 15:16:34 fabiankeil
+ * Use dedicated header filter actions instead of abusing "filter".
+ * Replace "filter-client-headers" and "filter-client-headers"
+ * with "server-header-filter" and "client-header-filter".
+ *
+ * Revision 1.92 2007/03/17 15:20:05 fabiankeil
+ * New config option: enforce-blocks.
+ *
+ * Revision 1.91 2007/03/05 13:28:03 fabiankeil
+ * Add some CSP_FLAGs for the header parsers.
+ *
+ * Revision 1.90 2007/02/07 10:36:16 fabiankeil
+ * Add new http_response member to save
+ * the reason why the response was generated.
+ *
+ * Revision 1.89 2007/01/27 13:09:16 fabiankeil
+ * Add new config option "templdir" to
+ * change the templates directory.
+ *
+ * Revision 1.88 2007/01/25 13:36:59 fabiankeil
+ * Add csp->error_message for failure reasons
+ * that should be embedded into the CGI pages.
+ *
+ * Revision 1.87 2007/01/01 19:36:37 fabiankeil
+ * Integrate a modified version of Wil Mahan's
+ * zlib patch (PR #895531).
+ *
+ * Revision 1.86 2006/12/31 17:56:37 fabiankeil
+ * Added config option accept-intercepted-requests
+ * and disabled it by default.
+ *
+ * Revision 1.85 2006/12/31 15:03:31 fabiankeil
+ * Fix gcc43 compiler warnings and a comment.
+ *
+ * Revision 1.84 2006/12/21 12:57:48 fabiankeil
+ * Add config option "split-large-forms"
+ * to work around the browser bug reported
+ * in BR #1570678.
+ *
+ * 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.70 2002/05/12 16:05:50 jongfoster
* Fixing ACTION_MASK_ALL to be unsigned long rather than
* just unsigned int. I don't know if anyone is porting
* 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
#define JB_ERR_PARSE 4 /**< Error parsing file */
#define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
CGI actions editor. */
-
+#define JB_ERR_COMPRESS 6 /**< Error on decompression */
/**
* This macro is used to free a pointer that may be NULL.
* 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;
int dcount; /**< How many parts to this domain? (length of dvec) */
};
+/**
+ * Reasons for generating a http_response instead of delivering
+ * the requested resource. Mostly ordered the way they are checked
+ * for in chat().
+ */
+#define RSP_REASON_UNSUPPORTED 1
+#define RSP_REASON_BLOCKED 2
+#define RSP_REASON_UNTRUSTED 3
+#define RSP_REASON_REDIRECTED 4
+#define RSP_REASON_CGI_CALL 5
+#define RSP_REASON_NO_SUCH_DOMAIN 6
+#define RSP_REASON_FORWARDING_FAILED 7
+#define RSP_REASON_CONNECT_FAILED 8
+#define RSP_REASON_OUT_OF_MEMORY 9
+#define RSP_REASON_INTERNAL_ERROR 10
/**
* Response generated by CGI, blocker, or error handler
size_t content_length; /**< Length of body, REQUIRED if binary body. */
int is_static; /**< Nonzero if the content will never change and
should be cached by the browser (e.g. images). */
+ int reason; /**< Why the response was generated in the first place. */
};
/**
- * A URL pattern.
+ * A URL or a tag pattern.
*/
struct url_spec
{
Used for debugging or display only. */
char *spec;
+#ifdef FEATURE_PCRE_HOST_PATTERNS
+ regex_t *host_regex;/**< Regex for host matching */
+#else
char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
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. */
+#endif /* defined FEATURE_PCRE_HOST_PATTERNS */
- int port; /**< The port number, or 0 to match all ports. */
+ char *port_list; /**< List of acceptable ports, or NULL to match all ports */
- char *path; /**< The source for the regex. */
- int pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */
+ char *path; /**< The source for the regex. */
regex_t *preg; /**< Regex for matching path part */
+ regex_t *tag_regex; /**< Regex for matching tags */
};
/**
* If you declare a static url_spec, this is the value to initialize it to zero.
*/
-#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, 0, NULL, 0, NULL }
+#ifndef FEATURE_PCRE_HOST_PATTERNS
+#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL, NULL }
+#else
+#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL, NULL }
+#endif /* def FEATURE_PCRE_HOST_PATTERNS */
/**
* Constant for host part matching in URLs. If set, indicates that the start of
*/
#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
-/* Bits for csp->content_type */
-#define CT_TEXT 1 /**< csp->content_type bitmask:
- Suitable for pcrs filtering. */
-#define CT_GIF 2 /**< csp->content_type bitmask:
- Suitable for GIF filtering. */
-#define CT_TABOO 4 /**< csp->content_type bitmask:
- DO NOT filter, irrespective of other flags. */
+/* Bits for csp->content_type bitmask: */
+#define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
+#define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
+#define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
+
+/* Although these are not, strictly speaking, content types
+ * (they are content encodings), it is simple to handle them
+ * as such.
+ */
+#define CT_GZIP 0x0010U /**< gzip-compressed data. */
+#define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
+
+/**
+ * Flag to signal that the server declared the content type,
+ * so we can differentiate between unknown and undeclared
+ * content types.
+ */
+#define CT_DECLARED 0x0040U
/**
* 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
-/** Action bitmap: Filter out popups. */
-#define ACTION_NO_POPUPS 0x00004000UL
-/** Action bitmap: Send a vanilla wafer. */
-#define ACTION_VANILLA_WAFER 0x00008000UL
+#define ACTION_NO_COOKIE_SET 0x00002000UL
+/** Action bitmap: Override the forward settings in the config file */
+#define ACTION_FORWARD_OVERRIDE 0x00004000UL
+/** Action bitmap: Block as empty document */
+#define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
/** Action bitmap: Limit CONNECT requests to safe ports. */
-#define ACTION_LIMIT_CONNECT 0x00010000UL
+#define ACTION_LIMIT_CONNECT 0x00010000UL
+/** Action bitmap: Redirect request. */
+#define ACTION_REDIRECT 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 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
+/** Action string index: Overriding forward rule. */
+#define ACTION_STRING_FORWARD_OVERRIDE 15
+/** Action string index: Reason for the block. */
+#define ACTION_STRING_BLOCK 16
/** Number of string actions. */
-#define ACTION_STRING_COUNT 6
+#define ACTION_STRING_COUNT 17
+
+
+/* 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
-/** Index into current_action_spec::multi[] for headers to add. */
-#define ACTION_MULTI_WAFER 1
-/** Index into current_action_spec::multi[] for filters to apply. */
-#define ACTION_MULTI_FILTER 2
+#define ACTION_MULTI_ADD_HEADER 0
+/** Index into current_action_spec::multi[] for content filters to apply. */
+#define ACTION_MULTI_FILTER 1
+/** Index into current_action_spec::multi[] for server-header filters to apply. */
+#define ACTION_MULTI_SERVER_HEADER_FILTER 2
+/** Index into current_action_spec::multi[] for client-header filters to apply. */
+#define ACTION_MULTI_CLIENT_HEADER_FILTER 3
+/** Index into current_action_spec::multi[] for client-header tags to apply. */
+#define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
+/** Index into current_action_spec::multi[] for server-header tags to apply. */
+#define ACTION_MULTI_SERVER_HEADER_TAGGER 5
/** Number of multi-string actions. */
-#define ACTION_MULTI_COUNT 3
+#define ACTION_MULTI_COUNT 6
/**
/**
- * This structure is used to store the actions list.
+ * This structure is used to store action files.
*
- * It contains a URL pattern, and the chages to the actions.
- * It is a linked list.
+ * It contains an URL or tag pattern, and the changes to
+ * the actions. It's a linked list and should only be
+ * free'd through unload_actions_file() unless there's
+ * only a single entry.
*/
struct url_actions
{
- struct url_spec url[1]; /**< URL pattern. */
+ struct url_spec url[1]; /**< The URL or tag pattern. */
- struct action_spec action[1]; /**< Actions. */
+ struct action_spec *action; /**< Action settings that might be shared with
+ the list entry before or after the current
+ one and can't be free'd willy nilly. */
- struct url_actions * next; /**< Next action in file, or NULL. */
+ struct url_actions *next; /**< Next action section in file, or NULL. */
};
*/
#define CSP_FLAG_TOGGLED_ON 0x20
+/**
+ * Flag for csp->flags: Set if adding the 'Connection: close' header
+ * for the client isn't necessary.
+ */
+#define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL
/**
- * Maximum number of actions files. This limit is arbitrary - it's just used
+ * Flag for csp->flags: Set if adding the 'Connection: close' header
+ * for the server isn't necessary.
+ */
+#define CSP_FLAG_SERVER_CONNECTION_CLOSE_SET 0x00000080UL
+
+/**
+ * Flag for csp->flags: Signals header parsers whether they
+ * are parsing server or client headers.
+ */
+#define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100UL
+
+/**
+ * Flag for csp->flags: Set if adding the Host: header
+ * isn't necessary.
+ */
+#define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200UL
+
+/**
+ * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
+ * XXX: As we now have tags we might as well ditch this.
+ */
+#define CSP_FLAG_NO_FILTERING 0x00000400UL
+
+
+/*
+ * 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/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.
jb_socket sfd;
/** Multi-purpose flag container, see CSP_FLAG_* above */
- unsigned short int flags;
+ unsigned int flags;
/** Client PC's IP address, as reported by the accept() function.
As a string. */
As a number. */
long ip_addr_long;
- /** Our IP address. I.e. the IP address that the client used to reach us,
- as a string. */
- char *my_ip_addr_str;
-
- /** Our hostname. I.e. the reverse DNS of the IP address that the client
- used to reach us, as a string. */
- char *my_hostname;
-
/** The URL that was requested */
struct http_request http[1];
+ /*
+ * The final forwarding settings.
+ * XXX: Currently this is only used for forward-override,
+ * so we can free the space in sweep.
+ */
+ struct forward_spec * fwd;
+
/** An I/O buffer used for buffering data read from the network */
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];
+ /** List of all tags that apply to this request */
+ struct list tags[1];
/** MIME-Type key, see CT_* above */
- unsigned short int content_type;
-
- /** The "X-Forwarded-For:" header sent by the client */
- char *x_forwarded;
+ unsigned int content_type;
/** 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;
#endif /* def FEATURE_TRUST */
+ /**
+ * Failure reason to embedded in the CGI error page,
+ * or NULL. Currently only used for socks errors.
+ */
+ char *error_message;
+
/** Next thread in linked list. Only read or modify from the main thread! */
struct client_state *next;
};
/** 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.
+ */
+#define MAX_TRUSTED_REFERRERS 512
+
#endif /* def FEATURE_TRUST */
#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 */
+#define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
/**
/** URL pattern that this forward_spec is for. */
struct url_spec url[1];
- /** Connection type. Must be SOCKS_NONE, SOCKS_4, or SOCKS_4A. */
+ /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
int type;
/** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
*/
#define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
+/* Supported filter types */
+#define FT_CONTENT_FILTER 0
+#define FT_CLIENT_HEADER_FILTER 1
+#define FT_SERVER_HEADER_FILTER 2
+#define FT_CLIENT_HEADER_TAGGER 3
+#define FT_SERVER_HEADER_TAGGER 4
+
+#define MAX_FILTER_TYPES 5
/**
* This struct represents one filter (one block) from
char *description; /**< Description from FILTER: statement in re_filterfile. */
struct list patterns[1]; /**< The patterns from the re_filterfile. */
pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
+ int type; /**< Filter type (content, client-header, server-header). */
+ int dynamic; /**< Set to one if the pattern might contain variables
+ and has to be recompiled for every request. */
struct re_filterfile_spec *next; /**< The pointer for chaining. */
};
/** configuration_spec::feature_flags: CGI actions editor. */
-#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
+#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1
/** configuration_spec::feature_flags: Web-based toggle. */
-#define RUNTIME_FEATURE_CGI_TOGGLE 2
+#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
+
+/** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
+#define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16
+
+/** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
+#define RUNTIME_FEATURE_ENFORCE_BLOCKS 32
+
+/** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
+#define RUNTIME_FEATURE_CGI_CRUNCHING 64
/**
*
* - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
* - RUNTIME_FEATURE_CGI_TOGGLE
+ * - RUNTIME_FEATURE_HTTP_TOGGLE
+ * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
*/
unsigned feature_flags;
/** The config file directory. */
const char *confdir;
+ /** The directory for customized CGI templates. */
+ const char *templdir;
+
/** The log file directory. */
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];
+
+ /** The hostname to show on CGI pages, or NULL to use the real one. */
+ const char *hostname;
#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;
#endif /* def FEATURE_NO_GIFS */
-/* Hardwired URLs */
+/*
+ * Hardwired URLs
+ */
+
+/** URL for the Privoxy home page. */
+#define HOME_PAGE_URL "http://www.privoxy.org/"
-/** URL for the Privoxy home page. No trailing "/". */
-#define HOME_PAGE_URL "http://www.privoxy.org"
+/** URL for the Privoxy user manual. */
+#define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
-/** URL for the Privoxy user manual. With a trailing "/". */
-#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#"
-/** FIXME: DOCME: Document this. */
-#define HELP_LINK_PREFIX "configuration.html#"
+/** Prefix for config option help links (append to USER_MANUAL_URL). */
+#define CONFIG_HELP_PREFIX "config.html#"
/*
* The "hosts" to intercept and display CGI pages.
*/
#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
projects / privoxy.git / blobdiff