X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=088b864498cd9dd17c25b9014b1fd35c6a4f523a;hp=d2d371b3bc857dcebb167269e630830f2d02faa1;hb=cd275efe90ca39d461537daf389e79a3cd79e507;hpb=90ea7f6b1ae23b022794bf78f8f9d000d7dcda4c diff --git a/project.h b/project.h index d2d371b3..088b8644 100644 --- a/project.h +++ b/project.h @@ -1,7 +1,7 @@ #ifndef PROJECT_H_INCLUDED #define PROJECT_H_INCLUDED /** Version string. */ -#define PROJECT_H_VERSION "$Id: project.h,v 1.95 2007/04/30 15:02:19 fabiankeil Exp $" +#define PROJECT_H_VERSION "$Id: project.h,v 1.123 2008/11/10 16:55:59 fabiankeil Exp $" /********************************************************************* * * File : $Source: /cvsroot/ijbswa/current/project.h,v $ @@ -10,7 +10,7 @@ * project. Does not define any variables or functions * (though it does declare some macros). * - * Copyright : Written by and Copyright (C) 2001 - 2007 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 @@ -37,6 +37,109 @@ * * Revisions : * $Log: project.h,v $ + * Revision 1.123 2008/11/10 16:55:59 fabiankeil + * Fix a gcc44 warning (in filters.c). + * + * Revision 1.122 2008/10/16 07:11:34 fabiankeil + * Fix a bunch of gcc44 conversion warnings. + * + * Revision 1.121 2008/10/09 18:21:41 fabiankeil + * Flush work-in-progress changes to keep outgoing connections + * alive where possible. Incomplete and mostly #ifdef'd out. + * + * Revision 1.120 2008/09/21 13:36:52 fabiankeil + * If change-x-forwarded-for{add} is used and the client + * sends multiple X-Forwarded-For headers, append the client's + * IP address to each one of them. "Traditionally" we would + * lose all but the last one. + * + * Revision 1.119 2008/09/20 10:04:33 fabiankeil + * Remove hide-forwarded-for-headers action which has + * been obsoleted by change-x-forwarded-for{block}. + * + * Revision 1.118 2008/09/19 15:26:29 fabiankeil + * Add change-x-forwarded-for{} action to block or add + * X-Forwarded-For headers. Mostly based on code removed + * before 3.0.7. + * + * Revision 1.117 2008/08/30 12:03:07 fabiankeil + * Remove FEATURE_COOKIE_JAR. + * + * Revision 1.116 2008/05/20 16:05:02 fabiankeil + * Move parsers structure definition from project.h to parsers.h. + * + * Revision 1.115 2008/05/19 16:57:20 fabiankeil + * Declare all members of the parsers structure immutable. + * + * Revision 1.114 2008/04/11 16:35:39 fabiankeil + * Oops, I forgot to shorten the URL_SPEC_INITIALIZER in my last commit. + * + * Revision 1.113 2008/04/10 14:41:04 fabiankeil + * Ditch url_spec's path member now that it's no longer used. + * + * Revision 1.112 2008/04/06 15:18:34 fabiankeil + * Oh well, rename the --enable-pcre-host-patterns option to + * --enable-extended-host-patterns as it's not really PCRE syntax. + * + * Revision 1.111 2008/04/06 14:54:26 fabiankeil + * Use PCRE syntax in host patterns when configured + * with --enable-pcre-host-patterns. + * + * 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. * @@ -878,15 +981,17 @@ struct url_spec Used for debugging or display only. */ char *spec; +#ifdef FEATURE_EXTENDED_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_EXTENDED_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. */ - size_t pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */ regex_t *preg; /**< Regex for matching path part */ regex_t *tag_regex; /**< Regex for matching tags */ }; @@ -894,7 +999,11 @@ struct url_spec /** * 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, NULL } +#ifndef FEATURE_EXTENDED_HOST_PATTERNS +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL } +#else +#define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL } +#endif /* def FEATURE_EXTENDED_HOST_PATTERNS */ /** * Constant for host part matching in URLs. If set, indicates that the start of @@ -945,7 +1054,6 @@ struct iob #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. */ -#define CT_JPEG 0x0008U /**< Suitable for JPEG filtering. */ /* Although these are not, strictly speaking, content types * (they are content encodings), it is simple to handle them @@ -954,6 +1062,13 @@ struct iob #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. */ @@ -972,8 +1087,8 @@ struct iob #define ACTION_DOWNGRADE 0x00000004UL /** Action bitmap: Fast redirects. */ #define ACTION_FAST_REDIRECTS 0x00000008UL -/** Action bitmap: Remove existing "Forwarded" header, and do not add another. */ -#define ACTION_HIDE_FORWARDED 0x00000010UL +/** Action bitmap: Remove or add "X-Forwarded-For" header. */ +#define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL /** Action bitmap: Hide "From" header. */ #define ACTION_HIDE_FROM 0x00000020UL /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */ @@ -992,14 +1107,14 @@ struct iob #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 +/** 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 -/** Action bitmap: Inspect if it's a JPEG. */ -#define ACTION_JPEG_INSPECT 0x00020000UL +/** 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. */ @@ -1018,16 +1133,6 @@ struct iob #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 */ @@ -1060,8 +1165,14 @@ struct iob #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 +/** Action string index: what to do with the "X-Forwarded-For" header. */ +#define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17 /** Number of string actions. */ -#define ACTION_STRING_COUNT 15 +#define ACTION_STRING_COUNT 18 /* To make the ugly hack in sed easier to understand */ @@ -1070,20 +1181,18 @@ struct iob /** 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 content filters to apply. */ -#define ACTION_MULTI_FILTER 2 +#define ACTION_MULTI_FILTER 1 /** Index into current_action_spec::multi[] for server-header filters to apply. */ -#define ACTION_MULTI_SERVER_HEADER_FILTER 3 +#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 4 +#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 5 +#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 6 +#define ACTION_MULTI_SERVER_HEADER_TAGGER 5 /** Number of multi-string actions. */ -#define ACTION_MULTI_COUNT 7 +#define ACTION_MULTI_COUNT 6 /** @@ -1138,18 +1247,22 @@ struct action_spec /** - * 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. */ }; @@ -1161,40 +1274,40 @@ struct url_actions * Flag for csp->flags: Set if this client is processing data. * Cleared when the thread associated with this structure dies. */ -#define CSP_FLAG_ACTIVE 0x01 +#define CSP_FLAG_ACTIVE 0x01U /** * Flag for csp->flags: Set if the server's reply is in "chunked" * transfer encoding */ -#define CSP_FLAG_CHUNKED 0x02 +#define CSP_FLAG_CHUNKED 0x02U /** * Flag for csp->flags: Set if this request was enforced, although it would * normally have been blocked. */ -#define CSP_FLAG_FORCED 0x04 +#define CSP_FLAG_FORCED 0x04U /** * Flag for csp->flags: Set if any modification to the body was done. */ -#define CSP_FLAG_MODIFIED 0x08 +#define CSP_FLAG_MODIFIED 0x08U /** * Flag for csp->flags: Set if request was blocked. */ -#define CSP_FLAG_REJECTED 0x10 +#define CSP_FLAG_REJECTED 0x10U /** * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE). */ -#define CSP_FLAG_TOGGLED_ON 0x20 +#define CSP_FLAG_TOGGLED_ON 0x20U /** - * Flag for csp->flags: Set if adding the 'Connection: close' header - * for the client isn't necessary. + * Flag for csp->flags: Set if an acceptable Connection header + * is already set. */ -#define CSP_FLAG_CLIENT_CONNECTION_CLOSE_SET 0x00000040UL +#define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040UL /** * Flag for csp->flags: Set if adding the 'Connection: close' header @@ -1214,6 +1327,35 @@ struct url_actions */ #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 + +/** + * Flag for csp->flags: Set the client IP has appended to + * an already existing X-Forwarded-For header in which case + * no new header has to be generated. + */ +#define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800UL + +/** + * Flag for csp->flags: Set if the server wants to keep + * the connection alive. + * + * XXX: Incomplete implementation, we currently only + * look for "Connection: keep-alive". + */ +#define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000UL + +#ifdef FEATURE_CONNECTION_KEEP_ALIVE +/** + * Flag for csp->flags: Set if the server specified the + * content length. + */ +#define CSP_FLAG_CONTENT_LENGTH_SET 0x00002000UL +#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */ /* * Flags for use in return codes of child processes @@ -1262,19 +1404,18 @@ struct client_state char *ip_addr_str; /** Client PC's IP address, as reported by the accept() function. 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; + unsigned long ip_addr_long; /** 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]; @@ -1287,9 +1428,6 @@ struct client_state /** MIME-Type key, see CT_* above */ unsigned int content_type; - /** The "X-Forwarded-For:" header sent by the client */ - char *x_forwarded; - /** Actions files associated with this client */ struct file_list *actions_list[MAX_AF_FILES]; @@ -1299,6 +1437,14 @@ struct client_state /** Length after content modification. */ size_t content_length; +#ifdef FEATURE_CONNECTION_KEEP_ALIVE + /** Expected length of content after which we + * should stop reading from the server socket. + */ + /* XXX: is this the right location? */ + size_t expected_content_length; +#endif /* def FEATURE_CONNECTION_KEEP_ALIVE */ + #ifdef FEATURE_TRUST /** Trust file. */ @@ -1328,22 +1474,6 @@ typedef jb_err (*add_header_func_ptr)(struct client_state *); typedef jb_err (*parser_func_ptr )(struct client_state *, char **); -/** - * List of functions to run on a list of headers - */ -struct parsers -{ - /** The header prefix to match */ - char *str; - - /** The length of the prefix to match */ - size_t len; - - /** The function to apply to this line */ - parser_func_ptr parser; -}; - - /** * List of available CGI functions. */ @@ -1434,6 +1564,7 @@ struct block_spec #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 */ /** @@ -1444,7 +1575,7 @@ struct forward_spec /** 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. */ @@ -1534,23 +1665,28 @@ struct access_control_list /** configuration_spec::feature_flags: CGI actions editor. */ -#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1 +#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U /** configuration_spec::feature_flags: Web-based toggle. */ -#define RUNTIME_FEATURE_CGI_TOGGLE 2 +#define RUNTIME_FEATURE_CGI_TOGGLE 2U /** configuration_spec::feature_flags: HTTP-header-based toggle. */ -#define RUNTIME_FEATURE_HTTP_TOGGLE 4 +#define RUNTIME_FEATURE_HTTP_TOGGLE 4U /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */ -#define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8 +#define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */ -#define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16 +#define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */ -#define RUNTIME_FEATURE_ENFORCE_BLOCKS 32 +#define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U +/** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */ +#define RUNTIME_FEATURE_CGI_CRUNCHING 64U + +/** configuration_spec::feature_flags: Try to keep the connection to the server alive. */ +#define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U /** * Data loaded from the configuration file. @@ -1609,15 +1745,8 @@ struct configuration_spec /** The short names of the pcre filter files. */ const char *re_filterfile_short[MAX_AF_FILES]; -#ifdef FEATURE_COOKIE_JAR - - /** The file name of the cookie jar file */ - const char * jarfile; - - /** The handle to the cookie jar file */ - FILE * jar; - -#endif /* def FEATURE_COOKIE_JAR */ + /** The hostname to show on CGI pages, or NULL to use the real one. */ + const char *hostname; /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */ const char *haddr;