1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.138 2009/05/16 13:27:20 fabiankeil Exp $"
5 /*********************************************************************
7 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
9 * Purpose : Defines data structures which are widely used in the
10 * project. Does not define any variables or functions
11 * (though it does declare some macros).
13 * Copyright : Written by and Copyright (C) 2001-2009 the
14 * Privoxy team. http://www.privoxy.org/
16 * Based on the Internet Junkbuster originally written
17 * by and Copyright (C) 1997 Anonymous Coders and
18 * Junkbusters Corporation. http://www.junkbusters.com
20 * This program is free software; you can redistribute it
21 * and/or modify it under the terms of the GNU General
22 * Public License as published by the Free Software
23 * Foundation; either version 2 of the License, or (at
24 * your option) any later version.
26 * This program is distributed in the hope that it will
27 * be useful, but WITHOUT ANY WARRANTY; without even the
28 * implied warranty of MERCHANTABILITY or FITNESS FOR A
29 * PARTICULAR PURPOSE. See the GNU General Public
30 * License for more details.
32 * The GNU General Public License should be included with
33 * this file. If not, you can view it at
34 * http://www.gnu.org/copyleft/gpl.html
35 * or write to the Free Software Foundation, Inc., 59
36 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
38 *********************************************************************/
41 /* Declare struct FILE for vars and funcs. */
44 /* Need time_t for file_list */
46 /* Needed for pcre choice */
50 /* Need for struct sockaddr_storage */
51 #include <sys/socket.h>
56 * Include appropriate regular expression libraries.
57 * Note that pcrs and pcre (native) are needed for cgi
58 * and are included anyway.
64 # ifdef PCRE_H_IN_SUBDIR
65 # include <pcre/pcre.h>
78 # include "pcreposix.h"
80 # ifdef PCRE_H_IN_SUBDIR
81 # include <pcre/pcreposix.h>
83 # include <pcreposix.h>
89 #endif /* def AMIGA */
93 * I don't want to have to #include all this just for the declaration
94 * of SOCKET. However, it looks like we have to...
109 typedef SOCKET jb_socket;
111 #define JB_INVALID_SOCKET INVALID_SOCKET
113 #else /* ndef _WIN32 */
116 * The type used by sockets. On UNIX it's an int. Microsoft decided to
117 * make it an unsigned.
119 typedef int jb_socket;
122 * The error value used for variables of type jb_socket. On UNIX this
123 * is -1, however Microsoft decided to make socket handles unsigned, so
124 * they use a different value.
127 #define JB_INVALID_SOCKET (-1)
129 #endif /* ndef _WIN32 */
133 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
138 #define JB_ERR_OK 0 /**< Success, no error */
139 #define JB_ERR_MEMORY 1 /**< Out of memory */
140 #define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
141 #define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
142 #define JB_ERR_PARSE 4 /**< Error parsing file */
143 #define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
144 CGI actions editor. */
145 #define JB_ERR_COMPRESS 6 /**< Error on decompression */
148 * This macro is used to free a pointer that may be NULL.
149 * It also sets the variable to NULL after it's been freed.
150 * The paramater should be a simple variable without side effects.
152 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
156 * Fix a problem with Solaris. There should be no effect on other
159 * Solaris's isspace() is a macro which uses it's argument directly
160 * as an array index. Therefore we need to make sure that high-bit
161 * characters generate +ve values, and ideally we also want to make
162 * the argument match the declared parameter type of "int".
164 * Note: Remember to #include <ctype.h> if you use these macros.
166 #define ijb_toupper(__X) toupper((int)(unsigned char)(__X))
167 #define ijb_tolower(__X) tolower((int)(unsigned char)(__X))
168 #define ijb_isspace(__X) isspace((int)(unsigned char)(__X))
171 * Use for statically allocated buffers if you have no other choice.
172 * Remember to check the length of what you write into the buffer
173 * - we don't want any buffer overflows!
175 #define BUFFER_SIZE 5000
178 * Max length of CGI parameters (arbitrary limit).
180 #define CGI_PARAM_LEN_MAX 500U
183 * Buffer size for capturing struct hostent data in the
184 * gethostby(name|addr)_r library calls. Since we don't
185 * loop over gethostbyname_r, the buffer must be sufficient
186 * to accomodate multiple IN A RRs, as used in DNS round robin
187 * load balancing. W3C's wwwlib uses 1K, so that should be
188 * good enough for us, too.
191 * XXX: Temporary doubled, for some configurations
192 * 1K is still too small and we didn't get the
193 * real fix ready for inclusion.
195 #define HOSTENT_BUFFER_SIZE 2048
198 * Do not use. Originally this was so that you can
199 * say "while (FOREVER) { ...do something... }".
200 * However, this gives a warning with some compilers (e.g. VC++).
201 * Instead, use "for (;;) { ...do something... }".
206 * Default TCP/IP address to listen on, as a string.
207 * Set to "127.0.0.1:8118".
209 #define HADDR_DEFAULT "127.0.0.1:8118"
212 /* Forward def for struct client_state */
213 struct configuration_spec;
217 * Entry in a linked list of strings.
222 * The string pointer. It must point to a dynamically malloc()ed
223 * string or be NULL for the list functions to work. In the latter
224 * case, just be careful next time you iterate through the list in
229 /** Next entry in the linked list, or NULL if no more. */
230 struct list_entry *next;
234 * A header for a linked list of strings.
238 /** First entry in the list, or NULL if the list is empty. */
239 struct list_entry *first;
241 /** Last entry in the list, or NULL if the list is empty. */
242 struct list_entry *last;
247 * An entry in a map. This is a name=value pair.
251 /** The key for the map. */
253 /** The value associated with that key. */
255 /** The next map entry, or NULL if none. */
256 struct map_entry *next;
260 * A map from a string to another string.
261 * This is used for the paramaters passed in a HTTP GET request, and
262 * to store the exports when the CGI interface is filling in a template.
266 /** The first map entry, or NULL if the map is empty. */
267 struct map_entry *first;
268 /** The last map entry, or NULL if the map is empty. */
269 struct map_entry *last;
274 * A HTTP request. This includes the method (GET, POST) and
277 * This is also used whenever we want to match a URL against a
278 * URL pattern. This always contains the URL to match, and never
279 * a URL pattern. (See struct url_spec).
283 char *cmd; /**< Whole command line: method, URL, Version */
284 char *ocmd; /**< Backup of original cmd for CLF logging */
285 char *gpc; /**< HTTP method: GET, POST, ... */
286 char *url; /**< The URL */
287 char *ver; /**< Protocol version */
288 int status; /**< HTTP Status */
290 char *host; /**< Host part of URL */
291 int port; /**< Port of URL or 80 (default) */
292 char *path; /**< Path of URL */
293 char *hostport; /**< host[:port] */
294 int ssl; /**< Flag if protocol is https */
296 char *host_ip_addr_str; /**< String with dotted decimal representation
297 of host's IP. NULL before connect_to() */
299 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
300 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
301 char **dvec; /**< List of pointers to the strings in dbuffer. */
302 int dcount; /**< How many parts to this domain? (length of dvec) */
303 #endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
307 * Reasons for generating a http_response instead of delivering
308 * the requested resource. Mostly ordered the way they are checked
311 #define RSP_REASON_UNSUPPORTED 1
312 #define RSP_REASON_BLOCKED 2
313 #define RSP_REASON_UNTRUSTED 3
314 #define RSP_REASON_REDIRECTED 4
315 #define RSP_REASON_CGI_CALL 5
316 #define RSP_REASON_NO_SUCH_DOMAIN 6
317 #define RSP_REASON_FORWARDING_FAILED 7
318 #define RSP_REASON_CONNECT_FAILED 8
319 #define RSP_REASON_OUT_OF_MEMORY 9
320 #define RSP_REASON_INTERNAL_ERROR 10
323 * Response generated by CGI, blocker, or error handler
327 char *status; /**< HTTP status (string). */
328 struct list headers[1]; /**< List of header lines. */
329 char *head; /**< Formatted http response head. */
330 size_t head_length; /**< Length of http response head. */
331 char *body; /**< HTTP document body. */
332 size_t content_length; /**< Length of body, REQUIRED if binary body. */
333 int is_static; /**< Nonzero if the content will never change and
334 should be cached by the browser (e.g. images). */
335 int reason; /**< Why the response was generated in the first place. */
339 * A URL or a tag pattern.
343 /** The string which was parsed to produce this url_spec.
344 Used for debugging or display only. */
347 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
348 regex_t *host_regex;/**< Regex for host matching */
350 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
351 char **dvec; /**< List of pointers to the strings in dbuffer. */
352 int dcount; /**< How many parts to this domain? (length of dvec) */
353 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
354 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
356 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
358 regex_t *preg; /**< Regex for matching path part */
359 regex_t *tag_regex; /**< Regex for matching tags */
363 * If you declare a static url_spec, this is the value to initialize it to zero.
365 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
366 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, 0, 0, NULL, NULL, NULL }
368 #define URL_SPEC_INITIALIZER { NULL, NULL, NULL, NULL, NULL }
369 #endif /* def FEATURE_EXTENDED_HOST_PATTERNS */
372 * Constant for host part matching in URLs. If set, indicates that the start of
373 * the pattern must match the start of the URL. E.g. this is not set for the
374 * pattern ".example.com", so that it will match both "example.com" and
375 * "www.example.com". It is set for the pattern "example.com", which makes it
376 * match "example.com" only, not "www.example.com".
378 #define ANCHOR_LEFT 1
381 * Constant for host part matching in URLs. If set, indicates that the end of
382 * the pattern must match the end of the URL. E.g. this is not set for the
383 * pattern "ad.", so that it will match any host called "ad", irrespective
384 * of how many subdomains are in the fully-qualified domain name.
386 #define ANCHOR_RIGHT 2
390 * An I/O buffer. Holds a string which can be appended to, and can have data
391 * removed from the beginning.
395 char *buf; /**< Start of buffer */
396 char *cur; /**< Start of relevant data */
397 char *eod; /**< End of relevant data */
398 size_t size; /**< Size as malloc()ed */
403 * Return the number of bytes in the I/O buffer associated with the passed
404 * client_state pointer.
407 #define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
411 * Remove any data in the I/O buffer associated with the passed
412 * client_state pointer.
414 #define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
416 /* Bits for csp->content_type bitmask: */
417 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
418 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
419 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
421 /* Although these are not, strictly speaking, content types
422 * (they are content encodings), it is simple to handle them
425 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
426 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
429 * Flag to signal that the server declared the content type,
430 * so we can differentiate between unknown and undeclared
433 #define CT_DECLARED 0x0040U
436 * The mask which includes all actions.
438 #define ACTION_MASK_ALL (~0UL)
441 * The most compatible set of actions - i.e. none.
443 #define ACTION_MOST_COMPATIBLE 0x00000000UL
445 /** Action bitmap: Block the request. */
446 #define ACTION_BLOCK 0x00000001UL
447 /** Action bitmap: Deanimate if it's a GIF. */
448 #define ACTION_DEANIMATE 0x00000002UL
449 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
450 #define ACTION_DOWNGRADE 0x00000004UL
451 /** Action bitmap: Fast redirects. */
452 #define ACTION_FAST_REDIRECTS 0x00000008UL
453 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
454 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
455 /** Action bitmap: Hide "From" header. */
456 #define ACTION_HIDE_FROM 0x00000020UL
457 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
458 #define ACTION_HIDE_REFERER 0x00000040UL
459 /** Action bitmap: Hide "User-Agent" and similar headers. */
460 #define ACTION_HIDE_USER_AGENT 0x00000080UL
461 /** Action bitmap: This is an image. */
462 #define ACTION_IMAGE 0x00000100UL
463 /** Action bitmap: Sets the image blocker. */
464 #define ACTION_IMAGE_BLOCKER 0x00000200UL
465 /** Action bitmap: Prevent compression. */
466 #define ACTION_NO_COMPRESSION 0x00000400UL
467 /** Action bitmap: Change cookies to session only cookies. */
468 #define ACTION_NO_COOKIE_KEEP 0x00000800UL
469 /** Action bitmap: Block rending cookies. */
470 #define ACTION_NO_COOKIE_READ 0x00001000UL
471 /** Action bitmap: Block setting cookies. */
472 #define ACTION_NO_COOKIE_SET 0x00002000UL
473 /** Action bitmap: Override the forward settings in the config file */
474 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
475 /** Action bitmap: Block as empty document */
476 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
477 /** Action bitmap: Limit CONNECT requests to safe ports. */
478 #define ACTION_LIMIT_CONNECT 0x00010000UL
479 /** Action bitmap: Redirect request. */
480 #define ACTION_REDIRECT 0x00020000UL
481 /** Action bitmap: Crunch or modify "if-modified-since" header. */
482 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
483 /** Action bitmap: Overwrite Content-Type header. */
484 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
485 /** Action bitmap: Crunch specified server header. */
486 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
487 /** Action bitmap: Crunch specified client header */
488 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
489 /** Action bitmap: Enable text mode by force */
490 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
491 /** Action bitmap: Enable text mode by force */
492 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
493 /** Action bitmap: Enable content-dispostion crunching */
494 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
495 /** Action bitmap: Replace or block Last-Modified header */
496 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
497 /** Action bitmap: Replace or block Accept-Language header */
498 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
501 /** Action string index: How to deanimate GIFs */
502 #define ACTION_STRING_DEANIMATE 0
503 /** Action string index: Replacement for "From:" header */
504 #define ACTION_STRING_FROM 1
505 /** Action string index: How to block images */
506 #define ACTION_STRING_IMAGE_BLOCKER 2
507 /** Action string index: Replacement for "Referer:" header */
508 #define ACTION_STRING_REFERER 3
509 /** Action string index: Replacement for "User-Agent:" header */
510 #define ACTION_STRING_USER_AGENT 4
511 /** Action string index: Legal CONNECT ports. */
512 #define ACTION_STRING_LIMIT_CONNECT 5
513 /** Action string index: Server headers containing this pattern are crunched*/
514 #define ACTION_STRING_SERVER_HEADER 6
515 /** Action string index: Client headers containing this pattern are crunched*/
516 #define ACTION_STRING_CLIENT_HEADER 7
517 /** Action string index: Replacement for the "Accept-Language:" header*/
518 #define ACTION_STRING_LANGUAGE 8
519 /** Action string index: Replacement for the "Content-Type:" header*/
520 #define ACTION_STRING_CONTENT_TYPE 9
521 /** Action string index: Replacement for the "content-dispostion:" header*/
522 #define ACTION_STRING_CONTENT_DISPOSITION 10
523 /** Action string index: Replacement for the "If-Modified-Since:" header*/
524 #define ACTION_STRING_IF_MODIFIED_SINCE 11
525 /** Action string index: Replacement for the "Last-Modified:" header. */
526 #define ACTION_STRING_LAST_MODIFIED 12
527 /** Action string index: Redirect URL */
528 #define ACTION_STRING_REDIRECT 13
529 /** Action string index: Decode before redirect? */
530 #define ACTION_STRING_FAST_REDIRECTS 14
531 /** Action string index: Overriding forward rule. */
532 #define ACTION_STRING_FORWARD_OVERRIDE 15
533 /** Action string index: Reason for the block. */
534 #define ACTION_STRING_BLOCK 16
535 /** Action string index: what to do with the "X-Forwarded-For" header. */
536 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
537 /** Number of string actions. */
538 #define ACTION_STRING_COUNT 18
541 /* To make the ugly hack in sed easier to understand */
542 #define CHECK_EVERY_HEADER_REMAINING 0
545 /** Index into current_action_spec::multi[] for headers to add. */
546 #define ACTION_MULTI_ADD_HEADER 0
547 /** Index into current_action_spec::multi[] for content filters to apply. */
548 #define ACTION_MULTI_FILTER 1
549 /** Index into current_action_spec::multi[] for server-header filters to apply. */
550 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
551 /** Index into current_action_spec::multi[] for client-header filters to apply. */
552 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
553 /** Index into current_action_spec::multi[] for client-header tags to apply. */
554 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
555 /** Index into current_action_spec::multi[] for server-header tags to apply. */
556 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
557 /** Number of multi-string actions. */
558 #define ACTION_MULTI_COUNT 6
562 * This structure contains a list of actions to apply to a URL.
563 * It only contains positive instructions - no "-" options.
564 * It is not used to store the actions list itself, only for
565 * url_actions() to return the current values.
567 struct current_action_spec
569 /** Actions to apply. A bit set to "1" means perform the action. */
573 * Paramaters for those actions that require them.
574 * Each entry is valid if & only if the corresponding entry in "flags" is
577 char * string[ACTION_STRING_COUNT];
579 /** Lists of strings for multi-string actions. */
580 struct list multi[ACTION_MULTI_COUNT][1];
585 * This structure contains a set of changes to actions.
586 * It can contain both positive and negative instructions.
587 * It is used to store an entry in the actions list.
591 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
592 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
595 * Paramaters for those actions that require them.
596 * Each entry is valid if & only if the corresponding entry in "flags" is
599 char * string[ACTION_STRING_COUNT];
601 /** Lists of strings to remove, for multi-string actions. */
602 struct list multi_remove[ACTION_MULTI_COUNT][1];
604 /** If nonzero, remove *all* strings from the multi-string action. */
605 int multi_remove_all[ACTION_MULTI_COUNT];
607 /** Lists of strings to add, for multi-string actions. */
608 struct list multi_add[ACTION_MULTI_COUNT][1];
613 * This structure is used to store action files.
615 * It contains an URL or tag pattern, and the changes to
616 * the actions. It's a linked list and should only be
617 * free'd through unload_actions_file() unless there's
618 * only a single entry.
622 struct url_spec url[1]; /**< The URL or tag pattern. */
624 struct action_spec *action; /**< Action settings that might be shared with
625 the list entry before or after the current
626 one and can't be free'd willy nilly. */
628 struct url_actions *next; /**< Next action section in file, or NULL. */
633 * Structure to make sure we only reuse the server socket
634 * if the host and forwarding settings are the same.
636 struct reusable_connection
642 * Number of seconds after which this
643 * connection will no longer be reused.
645 unsigned int keep_alive_timeout;
658 * Flags for use in csp->flags
662 * Flag for csp->flags: Set if this client is processing data.
663 * Cleared when the thread associated with this structure dies.
665 #define CSP_FLAG_ACTIVE 0x01U
668 * Flag for csp->flags: Set if the server's reply is in "chunked"
671 #define CSP_FLAG_CHUNKED 0x02U
674 * Flag for csp->flags: Set if this request was enforced, although it would
675 * normally have been blocked.
677 #define CSP_FLAG_FORCED 0x04U
680 * Flag for csp->flags: Set if any modification to the body was done.
682 #define CSP_FLAG_MODIFIED 0x08U
685 * Flag for csp->flags: Set if request was blocked.
687 #define CSP_FLAG_REJECTED 0x10U
690 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
692 #define CSP_FLAG_TOGGLED_ON 0x20U
695 * Flag for csp->flags: Set if an acceptable Connection header
696 * has already been set by the client.
698 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
701 * Flag for csp->flags: Set if an acceptable Connection header
702 * has already been set by the server.
704 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
707 * Flag for csp->flags: Signals header parsers whether they
708 * are parsing server or client headers.
710 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
713 * Flag for csp->flags: Set if adding the Host: header
716 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
719 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
720 * XXX: As we now have tags we might as well ditch this.
722 #define CSP_FLAG_NO_FILTERING 0x00000400U
725 * Flag for csp->flags: Set the client IP has appended to
726 * an already existing X-Forwarded-For header in which case
727 * no new header has to be generated.
729 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
732 * Flag for csp->flags: Set if the server wants to keep
733 * the connection alive.
735 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
737 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
739 * Flag for csp->flags: Set if the server specified the
742 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00002000U
745 * Flag for csp->flags: Set if the client wants to keep
746 * the connection alive.
748 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00004000U
749 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
752 * Flags for use in return codes of child processes
756 * Flag for process return code: Set if exiting porcess has been toggled
757 * during its lifetime.
759 #define RC_FLAG_TOGGLED 0x10
762 * Flag for process return code: Set if exiting porcess has blocked its
765 #define RC_FLAG_BLOCKED 0x20
768 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
771 #define MAX_AF_FILES 10
774 * The state of a Privoxy processing thread.
778 /** The proxy's configuration */
779 struct configuration_spec * config;
781 /** The actions to perform on the current request */
782 struct current_action_spec action[1];
784 /** socket to talk to client (web browser) */
787 /** socket to talk to server (web server or proxy) */
790 /** current connection to the server (may go through a proxy) */
791 struct reusable_connection server_connection;
793 /** Multi-purpose flag container, see CSP_FLAG_* above */
796 /** Client PC's IP address, as reported by the accept() function.
800 /** Client PC's TCP address, as reported by the accept() function.
802 struct sockaddr_storage tcp_addr;
804 /** Client PC's IP address, as reported by the accept() function.
806 unsigned long ip_addr_long;
807 #endif /* def HAVE_RFC2553 */
809 /** The URL that was requested */
810 struct http_request http[1];
813 * The final forwarding settings.
814 * XXX: Currently this is only used for forward-override,
815 * so we can free the space in sweep.
817 struct forward_spec * fwd;
819 /** An I/O buffer used for buffering data read from the network */
822 /** List of all headers for this request */
823 struct list headers[1];
825 /** List of all tags that apply to this request */
828 /** MIME-Type key, see CT_* above */
829 unsigned int content_type;
831 /** Actions files associated with this client */
832 struct file_list *actions_list[MAX_AF_FILES];
834 /** pcrs job files. */
835 struct file_list *rlist[MAX_AF_FILES];
837 /** Length after content modification. */
838 unsigned long long content_length;
840 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
841 /** Expected length of content after which we
842 * should stop reading from the server socket.
844 /* XXX: is this the right location? */
845 unsigned long long expected_content_length;
846 #endif /* def FEATURE_CONNECTION_KEEP_ALIVE */
851 struct file_list *tlist;
853 #endif /* def FEATURE_TRUST */
856 * Failure reason to embedded in the CGI error page,
857 * or NULL. Currently only used for socks errors.
861 /** Next thread in linked list. Only read or modify from the main thread! */
862 struct client_state *next;
867 * A function to add a header
869 typedef jb_err (*add_header_func_ptr)(struct client_state *);
872 * A function to process a header
874 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
878 * List of available CGI functions.
880 struct cgi_dispatcher
882 /** The URL of the CGI, relative to the CGI root. */
883 const char * const name;
885 /** The handler function for the CGI */
886 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
888 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
889 const char * const description;
891 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
897 * A data file used by Privoxy. Kept in a linked list.
902 * This is a pointer to the data structures associated with the file.
903 * Read-only once the structure has been created.
908 * The unloader function.
909 * Normally NULL. When we are finished with file (i.e. when we have
910 * loaded a new one), set to a pointer to an unloader function.
911 * Unloader will be called by sweep() (called from main loop) when
912 * all clients using this file are done. This prevents threading
915 void (*unloader)(void *);
918 * Used internally by sweep(). Do not access from elsewhere.
923 * File last-modified time, so we can check if file has been changed.
924 * Read-only once the structure has been created.
934 * Pointer to next entry in the linked list of all "file_list"s.
935 * This linked list is so that sweep() can navigate it.
936 * Since sweep() can remove items from the list, we must be careful
937 * to only access this value from main thread (when we know sweep
940 struct file_list *next;
947 * The format of a trust file when loaded into memory.
951 struct url_spec url[1]; /**< The URL pattern */
952 int reject; /**< FIXME: Please document this! */
953 struct block_spec *next; /**< Next entry in linked list */
957 * Arbitrary limit for the number of trusted referrers.
959 #define MAX_TRUSTED_REFERRERS 512
961 #endif /* def FEATURE_TRUST */
964 #define SOCKS_NONE 0 /**< Don't use a SOCKS server */
965 #define SOCKS_4 40 /**< original SOCKS 4 protocol */
966 #define SOCKS_4A 41 /**< as modified for hosts w/o external DNS */
967 #define SOCKS_5 50 /**< as modified for hosts w/o external DNS */
971 * How to forward a connection to a parent proxy.
975 /** URL pattern that this forward_spec is for. */
976 struct url_spec url[1];
978 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
981 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
984 /** SOCKS server port. */
987 /** Parent HTTP proxy hostname, or NULL for none. */
990 /** Parent HTTP proxy port. */
993 /** Next entry in the linked list. */
994 struct forward_spec *next;
999 * Initializer for a static struct forward_spec.
1001 #define FORWARD_SPEC_INITIALIZER { { URL_SPEC_INITIALIZER }, 0, NULL, 0, NULL, 0, NULL }
1003 /* Supported filter types */
1004 #define FT_CONTENT_FILTER 0
1005 #define FT_CLIENT_HEADER_FILTER 1
1006 #define FT_SERVER_HEADER_FILTER 2
1007 #define FT_CLIENT_HEADER_TAGGER 3
1008 #define FT_SERVER_HEADER_TAGGER 4
1010 #define MAX_FILTER_TYPES 5
1013 * This struct represents one filter (one block) from
1014 * the re_filterfile. If there is more than one filter
1015 * in the file, the file will be represented by a
1016 * chained list of re_filterfile specs.
1018 struct re_filterfile_spec
1020 char *name; /**< Name from FILTER: statement in re_filterfile. */
1021 char *description; /**< Description from FILTER: statement in re_filterfile. */
1022 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1023 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1024 int type; /**< Filter type (content, client-header, server-header). */
1025 int dynamic; /**< Set to one if the pattern might contain variables
1026 and has to be recompiled for every request. */
1027 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1033 #define ACL_PERMIT 1 /**< Accept connection request */
1034 #define ACL_DENY 2 /**< Reject connection request */
1037 * An IP address pattern. Used to specify networks in the ACL.
1039 struct access_control_addr
1042 struct sockaddr_storage addr; /* <The TCP address in network order. */
1043 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1045 unsigned long addr; /**< The IP address as an integer. */
1046 unsigned long mask; /**< The network mask as an integer. */
1047 unsigned long port; /**< The port number. */
1048 #endif /* HAVE_RFC2553 */
1052 * An access control list (ACL) entry.
1054 * This is a linked list.
1056 struct access_control_list
1058 struct access_control_addr src[1]; /**< Client IP address */
1059 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1061 int wildcard_dst; /** < dst address is wildcard */
1064 short action; /**< ACL_PERMIT or ACL_DENY */
1065 struct access_control_list *next; /**< The next entry in the ACL. */
1068 #endif /* def FEATURE_ACL */
1071 /** Maximum number of loaders (actions, re_filter, ...) */
1075 /** configuration_spec::feature_flags: CGI actions editor. */
1076 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1078 /** configuration_spec::feature_flags: Web-based toggle. */
1079 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1081 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1082 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1084 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1085 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1087 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1088 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1090 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1091 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1093 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1094 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1096 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1097 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1099 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1100 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1103 * Data loaded from the configuration file.
1105 * (Anomaly: toggle is still handled through a global, not this structure)
1107 struct configuration_spec
1112 /** Nonzero to enable multithreading. */
1116 * Bitmask of features that can be enabled/disabled through the config
1117 * file. Currently defined bits:
1119 * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
1120 * - RUNTIME_FEATURE_CGI_TOGGLE
1121 * - RUNTIME_FEATURE_HTTP_TOGGLE
1122 * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
1124 unsigned feature_flags;
1126 /** The log file name. */
1127 const char *logfile;
1129 /** The config file directory. */
1130 const char *confdir;
1132 /** The directory for customized CGI templates. */
1133 const char *templdir;
1135 /** The log file directory. */
1138 /** The full paths to the actions files. */
1139 const char *actions_file[MAX_AF_FILES];
1141 /** The short names of the actions files. */
1142 const char *actions_file_short[MAX_AF_FILES];
1144 /** The administrator's email address */
1145 char *admin_address;
1147 /** A URL with info on this proxy */
1148 char *proxy_info_url;
1150 /** URL to the user manual (on our website or local copy) */
1153 /** The file names of the pcre filter files. */
1154 const char *re_filterfile[MAX_AF_FILES];
1156 /** The short names of the pcre filter files. */
1157 const char *re_filterfile_short[MAX_AF_FILES];
1159 /** The hostname to show on CGI pages, or NULL to use the real one. */
1160 const char *hostname;
1162 /** IP address to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1165 /** Port to bind to. Defaults to HADDR_PORT == 8118. */
1168 /** Size limit for IOB */
1169 size_t buffer_limit;
1171 #ifdef FEATURE_TRUST
1173 /** The file name of the trust file. */
1174 const char * trustfile;
1176 /** FIXME: DOCME: Document this. */
1177 struct list trust_info[1];
1179 /** FIXME: DOCME: Document this. */
1180 struct url_spec *trust_list[MAX_TRUSTED_REFERRERS];
1182 #endif /* def FEATURE_TRUST */
1186 /** The access control list (ACL). */
1187 struct access_control_list *acl;
1189 #endif /* def FEATURE_ACL */
1191 /** Information about parent proxies (forwarding). */
1192 struct forward_spec *forward;
1194 /** Number of retries in case a forwarded connection attempt fails */
1195 int forwarded_connect_retries;
1197 /** Maximum number of client connections. */
1198 int max_client_connections;
1200 /* Timeout when waiting on sockets for data to become available. */
1203 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1204 /* Maximum number of seconds after which an open connection will no longer be reused. */
1205 unsigned int keep_alive_timeout;
1208 /** All options from the config file, HTML-formatted. */
1211 /** The configuration file object. */
1212 struct file_list *config_file_list;
1214 /** List of loaders */
1215 int (*loaders[NLOADERS])(struct client_state *);
1217 /** Nonzero if we need to bind() to the new port. */
1221 /** Calculates the number of elements in an array, using sizeof. */
1222 #define SZ(X) (sizeof(X) / sizeof(*X))
1224 #ifdef FEATURE_FORCE_LOAD
1225 /** The force load URL prefix. */
1226 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1227 #endif /* def FEATURE_FORCE_LOAD */
1229 #ifdef FEATURE_NO_GIFS
1230 /** The MIME type for images ("image/png" or "image/gif"). */
1231 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1233 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1234 #endif /* def FEATURE_NO_GIFS */
1241 /** URL for the Privoxy home page. */
1242 #define HOME_PAGE_URL "http://www.privoxy.org/"
1244 /** URL for the Privoxy user manual. */
1245 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1247 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1248 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1250 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1251 #define CONFIG_HELP_PREFIX "config.html#"
1254 * The "hosts" to intercept and display CGI pages.
1255 * First one is a hostname only, second one can specify host and path.
1258 * 1) Do not specify the http: prefix
1259 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1260 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1262 #define CGI_SITE_1_HOST "p.p"
1263 #define CGI_SITE_2_HOST "config.privoxy.org"
1264 #define CGI_SITE_2_PATH ""
1267 * The prefix for CGI pages. Written out in generated HTML.
1268 * INCLUDES the trailing slash.
1270 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1276 #endif /* ndef PROJECT_H_INCLUDED */