X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=project.h;h=5469ebe9314687cff6e3e9b1a216e668136f2db8;hp=aaaeed2b33da11c350b1095de7f5bf14513632dd;hb=66d5f733f047a1a177bfd1867ad53a933dd3ee7f;hpb=1b65660a5bb4e9d8511906406ebcc8a008c7baee diff --git a/project.h b/project.h index aaaeed2b..5469ebe9 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.74 2006/07/18 14:48:47 david__schmidt Exp $" +#define PROJECT_H_VERSION "$Id: project.h,v 1.91 2007/03/05 13:28:03 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 - 2004 the SourceForge + * Copyright : Written by and Copyright (C) 2001 - 2007 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -37,6 +37,83 @@ * * Revisions : * $Log: project.h,v $ + * 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: * 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) @@ -579,7 +656,7 @@ typedef int jb_err; #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. @@ -624,7 +701,12 @@ typedef int jb_err; * 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 @@ -739,6 +821,21 @@ struct http_request 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 @@ -753,6 +850,7 @@ struct http_response 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. */ }; /** @@ -772,7 +870,7 @@ struct url_spec int port; /**< The port number, or 0 to match all ports. */ char *path; /**< The source for the regex. */ - int pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */ + size_t pathlen; /**< ==strlen(path). Needed for prefix matching. FIXME: Now obsolete? */ regex_t *preg; /**< Regex for matching path part */ }; @@ -826,15 +924,18 @@ struct iob */ #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. */ -#define CT_JPEG 8 /**< csp->content_type bitmask: - Suitable for JPEG filtering. */ +/* 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. */ +#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 + * as such. + */ +#define CT_GZIP 0x0010U /**< gzip-compressed data. */ +#define CT_DEFLATE 0x0020U /**< zlib-compressed data. */ /** * The mask which includes all actions. @@ -844,44 +945,73 @@ struct iob /** * 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 +#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 @@ -916,38 +1046,6 @@ struct iob /** Number of string actions. */ #define ACTION_STRING_COUNT 15 -/* - * These defines really belong a few lines higher, - * but moving them down here makes this patch apply - * against Privoxy 3.0.3 as well. - */ -/** 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 headers with pcre */ -#define ACTION_FILTER_HEADERS 0x40000000UL - /*To make the ugly hack in sed easier to understand*/ #define CHECK_EVERY_HEADER_REMAINING 0 @@ -1067,6 +1165,30 @@ struct url_actions */ #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 + +/** + * 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 + /* * Flags for use in return codes of child processes @@ -1108,7 +1230,7 @@ struct client_state 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. */ @@ -1138,7 +1260,7 @@ struct client_state struct list cookie_list[1]; /** MIME-Type key, see CT_* above */ - unsigned short int content_type; + unsigned int content_type; /** The "X-Forwarded-For:" header sent by the client */ char *x_forwarded; @@ -1159,6 +1281,12 @@ struct client_state #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; }; @@ -1270,6 +1398,11 @@ struct block_spec 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 */ @@ -1365,10 +1498,22 @@ struct access_control_list /** 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 /** @@ -1390,6 +1535,8 @@ struct configuration_spec * * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS * - RUNTIME_FEATURE_CGI_TOGGLE + * - RUNTIME_FEATURE_HTTP_TOGGLE + * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS */ unsigned feature_flags; @@ -1399,6 +1546,9 @@ struct configuration_spec /** The config file directory. */ const char *confdir; + /** The directory for customized CGI templates. */ + const char *templdir; + /** The log file directory. */ const char *logdir; @@ -1451,7 +1601,7 @@ struct configuration_spec 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 */ @@ -1465,6 +1615,9 @@ struct configuration_spec /** 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; @@ -1529,22 +1682,6 @@ struct configuration_spec */ #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