Add the pointer to the receive buffer to the csp
[privoxy.git] / project.h
1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 /** Version string. */
4 #define PROJECT_H_VERSION "$Id: project.h,v 1.223 2017/06/26 12:13:52 fabiankeil Exp $"
5 /*********************************************************************
6  *
7  * File        :  $Source: /cvsroot/ijbswa/current/project.h,v $
8  *
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).
12  *
13  * Copyright   :  Written by and Copyright (C) 2001-2014 the
14  *                Privoxy team. http://www.privoxy.org/
15  *
16  *                Based on the Internet Junkbuster originally written
17  *                by and Copyright (C) 1997 Anonymous Coders and
18  *                Junkbusters Corporation.  http://www.junkbusters.com
19  *
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.
25  *
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.
31  *
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.
37  *
38  *********************************************************************/
39
40
41 /* Declare struct FILE for vars and funcs. */
42 #include <stdio.h>
43
44 /* Need time_t for file_list */
45 #include <time.h>
46 /* Needed for pcre choice */
47 #include "config.h"
48
49 /* Need for struct sockaddr_storage */
50 #ifdef HAVE_RFC2553
51 #  ifndef _WIN32
52 #    include <netdb.h>
53 #    include <sys/socket.h>
54 #  else
55 #    include <stdint.h>
56 #    include <ws2tcpip.h>
57      typedef unsigned short in_port_t;
58 #  endif
59 #endif
60
61
62 /*
63  * Include appropriate regular expression libraries.
64  * Note that pcrs and pcre (native) are needed for cgi
65  * and are included anyway.
66  */
67
68 #ifdef STATIC_PCRE
69 #  include "pcre.h"
70 #else
71 #  ifdef PCRE_H_IN_SUBDIR
72 #    include <pcre/pcre.h>
73 #  else
74 #    include <pcre.h>
75 #  endif
76 #endif
77
78 #ifdef STATIC_PCRS
79 #  include "pcrs.h"
80 #else
81 #  include <pcrs.h>
82 #endif
83
84 #ifdef STATIC_PCRE
85 #  include "pcreposix.h"
86 #else
87 #  ifdef PCRE_H_IN_SUBDIR
88 #    include <pcre/pcreposix.h>
89 #  else
90 #    include <pcreposix.h>
91 #  endif
92 #endif
93
94 #ifdef AMIGA
95 #include "amiga.h"
96 #endif /* def AMIGA */
97
98 #ifdef _WIN32
99 /*
100  * I don't want to have to #include all this just for the declaration
101  * of SOCKET.  However, it looks like we have to...
102  */
103 #ifndef STRICT
104 #define STRICT
105 #endif
106 #include <windows.h>
107 #endif
108
109
110 #ifdef _WIN32
111
112 typedef SOCKET jb_socket;
113
114 #define JB_INVALID_SOCKET INVALID_SOCKET
115
116 #else /* ndef _WIN32 */
117
118 /**
119  * The type used by sockets.  On UNIX it's an int.  Microsoft decided to
120  * make it an unsigned.
121  */
122 typedef int jb_socket;
123
124 /**
125  * The error value used for variables of type jb_socket.  On UNIX this
126  * is -1, however Microsoft decided to make socket handles unsigned, so
127  * they use a different value.
128  */
129
130 #define JB_INVALID_SOCKET (-1)
131
132 #endif /* ndef _WIN32 */
133
134
135 /**
136  * A standard error code.  This should be JB_ERR_OK or one of the JB_ERR_xxx
137  * series of errors.
138  */
139 enum privoxy_err
140 {
141    JB_ERR_OK         = 0, /**< Success, no error                        */
142    JB_ERR_MEMORY     = 1, /**< Out of memory                            */
143    JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters        */
144    JB_ERR_FILE       = 3, /**< Error opening, reading or writing a file */
145    JB_ERR_PARSE      = 4, /**< Error parsing file                       */
146    JB_ERR_MODIFIED   = 5, /**< File has been modified outside of the
147                                CGI actions editor.                      */
148    JB_ERR_COMPRESS   = 6  /**< Error on decompression                   */
149 };
150
151 typedef enum privoxy_err jb_err;
152
153 /**
154  * This macro is used to free a pointer that may be NULL.
155  * It also sets the variable to NULL after it's been freed.
156  * The paramater should be a simple variable without side effects.
157  */
158 #define freez(X)  { if(X) { free((void*)X); X = NULL ; } }
159
160
161 /**
162  * Macro definitions for platforms where isspace() and friends
163  * are macros that use their argument directly as an array index
164  * and thus better be positive. Supposedly that's the case on
165  * some unspecified Solaris versions.
166  * Note: Remember to #include <ctype.h> if you use these macros.
167  */
168 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
169 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
170 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
171 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
172 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
173
174 /**
175  * Use for statically allocated buffers if you have no other choice.
176  * Remember to check the length of what you write into the buffer
177  * - we don't want any buffer overflows!
178  */
179 #define BUFFER_SIZE 5000
180
181 /**
182  * Max length of CGI parameters (arbitrary limit).
183  */
184 #define CGI_PARAM_LEN_MAX 500U
185
186 /**
187  * Buffer size for capturing struct hostent data in the
188  * gethostby(name|addr)_r library calls. Since we don't
189  * loop over gethostbyname_r, the buffer must be sufficient
190  * to accommodate multiple IN A RRs, as used in DNS round robin
191  * load balancing. W3C's wwwlib uses 1K, so that should be
192  * good enough for us, too.
193  */
194 /**
195  * XXX: Temporary doubled, for some configurations
196  * 1K is still too small and we didn't get the
197  * real fix ready for inclusion.
198  */
199 #define HOSTENT_BUFFER_SIZE 2048
200
201 /**
202  * Default TCP/IP address to listen on, as a string.
203  * Set to "127.0.0.1:8118".
204  */
205 #define HADDR_DEFAULT   "127.0.0.1:8118"
206
207
208 /* Forward def for struct client_state */
209 struct configuration_spec;
210
211
212 /**
213  * Entry in a linked list of strings.
214  */
215 struct list_entry
216 {
217    /**
218     * The string pointer. It must point to a dynamically malloc()ed
219     * string or be NULL for the list functions to work. In the latter
220     * case, just be careful next time you iterate through the list in
221     * your own code.
222     */
223    char *str;
224
225    /** Next entry in the linked list, or NULL if no more. */
226    struct list_entry *next;
227 };
228
229 /**
230  * A header for a linked list of strings.
231  */
232 struct list
233 {
234    /** First entry in the list, or NULL if the list is empty. */
235    struct list_entry *first;
236
237    /** Last entry in the list, or NULL if the list is empty. */
238    struct list_entry *last;
239 };
240
241
242 /**
243  * An entry in a map.  This is a name=value pair.
244  */
245 struct map_entry
246 {
247    /** The key for the map. */
248    const char *name;
249    /** The value associated with that key. */
250    const char *value;
251    /** The next map entry, or NULL if none. */
252    struct map_entry *next;
253 };
254
255 /**
256  * A map from a string to another string.
257  * This is used for the paramaters passed in a HTTP GET request, and
258  * to store the exports when the CGI interface is filling in a template.
259  */
260 struct map
261 {
262    /** The first map entry, or NULL if the map is empty. */
263    struct map_entry *first;
264    /** The last map entry, or NULL if the map is empty. */
265    struct map_entry *last;
266 };
267
268
269 /**
270  * A HTTP request.  This includes the method (GET, POST) and
271  * the parsed URL.
272  *
273  * This is also used whenever we want to match a URL against a
274  * URL pattern.  This always contains the URL to match, and never
275  * a URL pattern.  (See struct url_spec).
276  */
277 struct http_request
278 {
279    char *cmd;      /**< Whole command line: method, URL, Version */
280    char *ocmd;     /**< Backup of original cmd for CLF logging */
281    char *gpc;      /**< HTTP method: GET, POST, ... */
282    char *url;      /**< The URL */
283    char *ver;      /**< Protocol version */
284    int status;     /**< HTTP Status */
285
286    char *host;     /**< Host part of URL */
287    int   port;     /**< Port of URL or 80 (default) */
288    char *path;     /**< Path of URL */
289    char *hostport; /**< host[:port] */
290    int   ssl;      /**< Flag if protocol is https */
291
292    char *host_ip_addr_str; /**< String with dotted decimal representation
293                                 of host's IP. NULL before connect_to() */
294
295 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
296    char  *dbuffer; /**< Buffer with '\0'-delimited domain name.           */
297    char **dvec;    /**< List of pointers to the strings in dbuffer.       */
298    int    dcount;  /**< How many parts to this domain? (length of dvec)   */
299 #endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
300 };
301
302 /**
303  * Reasons for generating a http_response instead of delivering
304  * the requested resource. Mostly ordered the way they are checked
305  * for in chat().
306  */
307 enum crunch_reason
308 {
309    UNSUPPORTED,
310    BLOCKED,
311    UNTRUSTED,
312    REDIRECTED,
313    CGI_CALL,
314    NO_SUCH_DOMAIN,
315    FORWARDING_FAILED,
316    CONNECT_FAILED,
317    OUT_OF_MEMORY,
318    INTERNAL_ERROR,
319    CONNECTION_TIMEOUT,
320    NO_SERVER_DATA
321 };
322
323 /**
324  * Response generated by CGI, blocker, or error handler
325  */
326 struct http_response
327 {
328   char  *status;                    /**< HTTP status (string). */
329   struct list headers[1];           /**< List of header lines. */
330   char  *head;                      /**< Formatted http response head. */
331   size_t head_length;               /**< Length of http response head. */
332   char  *body;                      /**< HTTP document body. */
333   size_t content_length;            /**< Length of body, REQUIRED if binary body. */
334   int    is_static;                 /**< Nonzero if the content will never change and
335                                          should be cached by the browser (e.g. images). */
336   enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
337 };
338
339 struct url_spec
340 {
341 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
342    regex_t *host_regex;/**< Regex for host matching                          */
343 #else
344    char  *dbuffer;     /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
345    char **dvec;        /**< List of pointers to the strings in dbuffer.       */
346    int    dcount;      /**< How many parts to this domain? (length of dvec)   */
347    int    unanchored;  /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT.  */
348 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
349
350    char  *port_list;   /**< List of acceptable ports, or NULL to match all ports */
351
352    regex_t *preg;      /**< Regex for matching path part                      */
353 };
354
355 /**
356  * A URL or a tag pattern.
357  */
358 struct pattern_spec
359 {
360    /** The string which was parsed to produce this pattern_spec.
361        Used for debugging or display only.  */
362    char  *spec;
363
364    union
365    {
366       struct url_spec url_spec;
367       regex_t *tag_regex;
368    } pattern;
369
370    unsigned int flags; /**< Bitmap with various pattern properties. */
371 };
372
373 /**
374  * Constant for host part matching in URLs.  If set, indicates that the start of
375  * the pattern must match the start of the URL.  E.g. this is not set for the
376  * pattern ".example.com", so that it will match both "example.com" and
377  * "www.example.com".  It is set for the pattern "example.com", which makes it
378  * match "example.com" only, not "www.example.com".
379  */
380 #define ANCHOR_LEFT  1
381
382 /**
383  * Constant for host part matching in URLs.  If set, indicates that the end of
384  * the pattern must match the end of the URL.  E.g. this is not set for the
385  * pattern "ad.", so that it will match any host called "ad", irrespective
386  * of how many subdomains are in the fully-qualified domain name.
387  */
388 #define ANCHOR_RIGHT 2
389
390 /** Pattern spec bitmap: It's an URL pattern. */
391 #define PATTERN_SPEC_URL_PATTERN          0x00000001UL
392
393 /** Pattern spec bitmap: It's a TAG pattern. */
394 #define PATTERN_SPEC_TAG_PATTERN          0x00000002UL
395
396 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
397 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
398
399 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
400 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
401
402 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
403 #define PATTERN_SPEC_CLIENT_TAG_PATTERN      0x00000010UL
404
405 /**
406  * An I/O buffer.  Holds a string which can be appended to, and can have data
407  * removed from the beginning.
408  */
409 struct iob
410 {
411    char *buf;    /**< Start of buffer        */
412    char *cur;    /**< Start of relevant data */
413    char *eod;    /**< End of relevant data   */
414    size_t size;  /**< Size as malloc()ed     */
415 };
416
417
418 /**
419  * Return the number of bytes in the I/O buffer associated with the passed
420  * I/O buffer. May be zero.
421  */
422 #define IOB_PEEK(IOB) ((IOB->cur > IOB->eod) ? (IOB->eod - IOB->cur) : 0)
423
424
425 /* Bits for csp->content_type bitmask: */
426 #define CT_TEXT    0x0001U /**< Suitable for pcrs filtering. */
427 #define CT_GIF     0x0002U /**< Suitable for GIF filtering.  */
428 #define CT_TABOO   0x0004U /**< DO NOT filter, irrespective of other flags. */
429
430 /* Although these are not, strictly speaking, content types
431  * (they are content encodings), it is simple to handle them
432  * as such.
433  */
434 #define CT_GZIP    0x0010U /**< gzip-compressed data. */
435 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
436
437 /**
438  * Flag to signal that the server declared the content type,
439  * so we can differentiate between unknown and undeclared
440  * content types.
441  */
442 #define CT_DECLARED 0x0040U
443
444 /**
445  * The mask which includes all actions.
446  */
447 #define ACTION_MASK_ALL        (~0UL)
448
449 /**
450  * The most compatible set of actions - i.e. none.
451  */
452 #define ACTION_MOST_COMPATIBLE                       0x00000000UL
453
454 /** Action bitmap: Block the request. */
455 #define ACTION_BLOCK                                 0x00000001UL
456 /** Action bitmap: Deanimate if it's a GIF. */
457 #define ACTION_DEANIMATE                             0x00000002UL
458 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
459 #define ACTION_DOWNGRADE                             0x00000004UL
460 /** Action bitmap: Fast redirects. */
461 #define ACTION_FAST_REDIRECTS                        0x00000008UL
462 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
463 #define ACTION_CHANGE_X_FORWARDED_FOR                0x00000010UL
464 /** Action bitmap: Hide "From" header. */
465 #define ACTION_HIDE_FROM                             0x00000020UL
466 /** Action bitmap: Hide "Referer" header.  (sic - follow HTTP, not English). */
467 #define ACTION_HIDE_REFERER                          0x00000040UL
468 /** Action bitmap: Hide "User-Agent" and similar headers. */
469 #define ACTION_HIDE_USER_AGENT                       0x00000080UL
470 /** Action bitmap: This is an image. */
471 #define ACTION_IMAGE                                 0x00000100UL
472 /** Action bitmap: Sets the image blocker. */
473 #define ACTION_IMAGE_BLOCKER                         0x00000200UL
474 /** Action bitmap: Prevent compression. */
475 #define ACTION_NO_COMPRESSION                        0x00000400UL
476 /** Action bitmap: Change cookies to session only cookies. */
477 #define ACTION_SESSION_COOKIES_ONLY                  0x00000800UL
478 /** Action bitmap: Block cookies coming from the client. */
479 #define ACTION_CRUNCH_OUTGOING_COOKIES               0x00001000UL
480 /** Action bitmap: Block cookies coming from the server. */
481 #define ACTION_CRUNCH_INCOMING_COOKIES               0x00002000UL
482 /** Action bitmap: Override the forward settings in the config file */
483 #define ACTION_FORWARD_OVERRIDE                      0x00004000UL
484 /** Action bitmap: Block as empty document */
485 #define  ACTION_HANDLE_AS_EMPTY_DOCUMENT             0x00008000UL
486 /** Action bitmap: Limit CONNECT requests to safe ports. */
487 #define ACTION_LIMIT_CONNECT                         0x00010000UL
488 /** Action bitmap: Redirect request. */
489 #define  ACTION_REDIRECT                             0x00020000UL
490 /** Action bitmap: Crunch or modify "if-modified-since" header. */
491 #define ACTION_HIDE_IF_MODIFIED_SINCE                0x00040000UL
492 /** Action bitmap: Overwrite Content-Type header. */
493 #define ACTION_CONTENT_TYPE_OVERWRITE                0x00080000UL
494 /** Action bitmap: Crunch specified server header. */
495 #define ACTION_CRUNCH_SERVER_HEADER                  0x00100000UL
496 /** Action bitmap: Crunch specified client header */
497 #define ACTION_CRUNCH_CLIENT_HEADER                  0x00200000UL
498 /** Action bitmap: Enable text mode by force */
499 #define ACTION_FORCE_TEXT_MODE                       0x00400000UL
500 /** Action bitmap: Remove the "If-None-Match" header. */
501 #define ACTION_CRUNCH_IF_NONE_MATCH                  0x00800000UL
502 /** Action bitmap: Enable content-disposition crunching */
503 #define ACTION_HIDE_CONTENT_DISPOSITION              0x01000000UL
504 /** Action bitmap: Replace or block Last-Modified header */
505 #define ACTION_OVERWRITE_LAST_MODIFIED               0x02000000UL
506 /** Action bitmap: Replace or block Accept-Language header */
507 #define ACTION_HIDE_ACCEPT_LANGUAGE                  0x04000000UL
508 /** Action bitmap: Limit the cookie lifetime */
509 #define ACTION_LIMIT_COOKIE_LIFETIME                 0x08000000UL
510
511
512 /** Action string index: How to deanimate GIFs */
513 #define ACTION_STRING_DEANIMATE             0
514 /** Action string index: Replacement for "From:" header */
515 #define ACTION_STRING_FROM                  1
516 /** Action string index: How to block images */
517 #define ACTION_STRING_IMAGE_BLOCKER         2
518 /** Action string index: Replacement for "Referer:" header */
519 #define ACTION_STRING_REFERER               3
520 /** Action string index: Replacement for "User-Agent:" header */
521 #define ACTION_STRING_USER_AGENT            4
522 /** Action string index: Legal CONNECT ports. */
523 #define ACTION_STRING_LIMIT_CONNECT         5
524 /** Action string index: Server headers containing this pattern are crunched*/
525 #define ACTION_STRING_SERVER_HEADER         6
526 /** Action string index: Client headers containing this pattern are crunched*/
527 #define ACTION_STRING_CLIENT_HEADER         7
528 /** Action string index: Replacement for the "Accept-Language:" header*/
529 #define ACTION_STRING_LANGUAGE              8
530 /** Action string index: Replacement for the "Content-Type:" header*/
531 #define ACTION_STRING_CONTENT_TYPE          9
532 /** Action string index: Replacement for the "content-disposition:" header*/
533 #define ACTION_STRING_CONTENT_DISPOSITION  10
534 /** Action string index: Replacement for the "If-Modified-Since:" header*/
535 #define ACTION_STRING_IF_MODIFIED_SINCE    11
536 /** Action string index: Replacement for the "Last-Modified:" header. */
537 #define ACTION_STRING_LAST_MODIFIED        12
538 /** Action string index: Redirect URL */
539 #define ACTION_STRING_REDIRECT             13
540 /** Action string index: Decode before redirect? */
541 #define ACTION_STRING_FAST_REDIRECTS       14
542 /** Action string index: Overriding forward rule. */
543 #define ACTION_STRING_FORWARD_OVERRIDE     15
544 /** Action string index: Reason for the block. */
545 #define ACTION_STRING_BLOCK                16
546 /** Action string index: what to do with the "X-Forwarded-For" header. */
547 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
548 /** Action string index: how many minutes cookies should be valid. */
549 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
550 /** Number of string actions. */
551 #define ACTION_STRING_COUNT                19
552
553
554 /* To make the ugly hack in sed easier to understand */
555 #define CHECK_EVERY_HEADER_REMAINING 0
556
557
558 /** Index into current_action_spec::multi[] for headers to add. */
559 #define ACTION_MULTI_ADD_HEADER              0
560 /** Index into current_action_spec::multi[] for content filters to apply. */
561 #define ACTION_MULTI_FILTER                  1
562 /** Index into current_action_spec::multi[] for server-header filters to apply. */
563 #define ACTION_MULTI_SERVER_HEADER_FILTER    2
564 /** Index into current_action_spec::multi[] for client-header filters to apply. */
565 #define ACTION_MULTI_CLIENT_HEADER_FILTER    3
566 /** Index into current_action_spec::multi[] for client-header tags to apply. */
567 #define ACTION_MULTI_CLIENT_HEADER_TAGGER    4
568 /** Index into current_action_spec::multi[] for server-header tags to apply. */
569 #define ACTION_MULTI_SERVER_HEADER_TAGGER    5
570 /** Number of multi-string actions. */
571 #define ACTION_MULTI_EXTERNAL_FILTER         6
572 /** Number of multi-string actions. */
573 #define ACTION_MULTI_COUNT                   7
574
575
576 /**
577  * This structure contains a list of actions to apply to a URL.
578  * It only contains positive instructions - no "-" options.
579  * It is not used to store the actions list itself, only for
580  * url_actions() to return the current values.
581  */
582 struct current_action_spec
583 {
584    /** Actions to apply.  A bit set to "1" means perform the action. */
585    unsigned long flags;
586
587    /**
588     * Paramaters for those actions that require them.
589     * Each entry is valid if & only if the corresponding entry in "flags" is
590     * set.
591     */
592    char * string[ACTION_STRING_COUNT];
593
594    /** Lists of strings for multi-string actions. */
595    struct list multi[ACTION_MULTI_COUNT][1];
596 };
597
598
599 /**
600  * This structure contains a set of changes to actions.
601  * It can contain both positive and negative instructions.
602  * It is used to store an entry in the actions list.
603  */
604 struct action_spec
605 {
606    unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
607    unsigned long add;  /**< Actions to add.  A bit set to "1" means add action.    */
608
609    /**
610     * Parameters for those actions that require them.
611     * Each entry is valid if & only if the corresponding entry in "flags" is
612     * set.
613     */
614    char * string[ACTION_STRING_COUNT];
615
616    /** Lists of strings to remove, for multi-string actions. */
617    struct list multi_remove[ACTION_MULTI_COUNT][1];
618
619    /** If nonzero, remove *all* strings from the multi-string action. */
620    int         multi_remove_all[ACTION_MULTI_COUNT];
621
622    /** Lists of strings to add, for multi-string actions. */
623    struct list multi_add[ACTION_MULTI_COUNT][1];
624 };
625
626
627 /**
628  * This structure is used to store action files.
629  *
630  * It contains an URL or tag pattern, and the changes to
631  * the actions. It's a linked list and should only be
632  * free'd through unload_actions_file() unless there's
633  * only a single entry.
634  */
635 struct url_actions
636 {
637    struct pattern_spec url[1]; /**< The URL or tag pattern. */
638
639    struct action_spec *action; /**< Action settings that might be shared with
640                                     the list entry before or after the current
641                                     one and can't be free'd willy nilly. */
642
643    struct url_actions *next;   /**< Next action section in file, or NULL. */
644 };
645
646 enum forwarder_type {
647    /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
648    SOCKS_NONE =  0,
649    /**< original SOCKS 4 protocol              */
650    SOCKS_4    = 40,
651    /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
652    SOCKS_4A   = 41,
653    /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
654    SOCKS_5    = 50,
655    /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
656    SOCKS_5T,
657    /**<
658     * Don't use a SOCKS server, forward to the specified webserver.
659     * The difference to SOCKS_NONE is that a request line without
660     * full URL is sent.
661     */
662    FORWARD_WEBSERVER,
663 };
664
665 /*
666  * Structure to hold the server socket and the information
667  * required to make sure we only reuse the connection if
668  * the host and forwarding settings are the same.
669  */
670 struct reusable_connection
671 {
672    jb_socket sfd;
673    int       in_use;
674    time_t    timestamp; /* XXX: rename? */
675
676    time_t    request_sent;
677    time_t    response_received;
678
679    /*
680     * Number of seconds after which this
681     * connection will no longer be reused.
682     */
683    unsigned int keep_alive_timeout;
684    /*
685     * Number of requests that were sent to this connection.
686     * This is currently only for debugging purposes.
687     */
688    unsigned int requests_sent_total;
689
690    char *host;
691    int  port;
692    enum forwarder_type forwarder_type;
693    char *gateway_host;
694    int  gateway_port;
695    char *forward_host;
696    int  forward_port;
697 };
698
699
700 /*
701  * Flags for use in csp->flags
702  */
703
704 /**
705  * Flag for csp->flags: Set if this client is processing data.
706  * Cleared when the thread associated with this structure dies.
707  */
708 #define CSP_FLAG_ACTIVE     0x01U
709
710 /**
711  * Flag for csp->flags: Set if the server's reply is in "chunked"
712  * transfer encoding
713  */
714 #define CSP_FLAG_CHUNKED    0x02U
715
716 /**
717  * Flag for csp->flags: Set if this request was enforced, although it would
718  * normally have been blocked.
719  */
720 #define CSP_FLAG_FORCED     0x04U
721
722 /**
723  * Flag for csp->flags: Set if any modification to the body was done.
724  */
725 #define CSP_FLAG_MODIFIED   0x08U
726
727 /**
728  * Flag for csp->flags: Set if request was blocked.
729  */
730 #define CSP_FLAG_REJECTED   0x10U
731
732 /**
733  * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
734  */
735 #define CSP_FLAG_TOGGLED_ON 0x20U
736
737 /**
738  * Flag for csp->flags: Set if an acceptable Connection header
739  * has already been set by the client.
740  */
741 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET  0x00000040U
742
743 /**
744  * Flag for csp->flags: Set if an acceptable Connection header
745  * has already been set by the server.
746  */
747 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET  0x00000080U
748
749 /**
750  * Flag for csp->flags: Signals header parsers whether they
751  * are parsing server or client headers.
752  */
753 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE    0x00000100U
754
755 /**
756  * Flag for csp->flags: Set if adding the Host: header
757  * isn't necessary.
758  */
759 #define CSP_FLAG_HOST_HEADER_IS_SET            0x00000200U
760
761 /**
762  * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
763  * XXX: As we now have tags we might as well ditch this.
764  */
765 #define CSP_FLAG_NO_FILTERING                  0x00000400U
766
767 /**
768  * Flag for csp->flags: Set the client IP has appended to
769  * an already existing X-Forwarded-For header in which case
770  * no new header has to be generated.
771  */
772 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED      0x00000800U
773
774 /**
775  * Flag for csp->flags: Set if the server wants to keep
776  * the connection alive.
777  */
778 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE  0x00001000U
779
780 /**
781  * Flag for csp->flags: Set if the server specified the
782  * content length.
783  */
784 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET     0x00002000U
785
786 /**
787  * Flag for csp->flags: Set if we know the content length,
788  * either because the server set it, or we figured it out
789  * on our own.
790  */
791 #define CSP_FLAG_CONTENT_LENGTH_SET            0x00004000U
792
793 /**
794  * Flag for csp->flags: Set if the client wants to keep
795  * the connection alive.
796  */
797 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE  0x00008000U
798
799 /**
800  * Flag for csp->flags: Set if we think we got the whole
801  * client request and shouldn't read any additional data
802  * coming from the client until the current request has
803  * been dealt with.
804  */
805 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
806
807 /**
808  * Flag for csp->flags: Set if the server promised us to
809  * keep the connection open for a known number of seconds.
810  */
811 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET  0x00020000U
812
813 /**
814  * Flag for csp->flags: Set if we think we can't reuse
815  * the server socket. XXX: It's also set after sabotaging
816  * pipelining attempts which is somewhat inconsistent with
817  * the name.
818  */
819 #define CSP_FLAG_SERVER_SOCKET_TAINTED          0x00040000U
820
821 /**
822  * Flag for csp->flags: Set if the Proxy-Connection header
823  * is among the server headers.
824  */
825 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
826
827 /**
828  * Flag for csp->flags: Set if the client reused its connection.
829  */
830 #define CSP_FLAG_REUSED_CLIENT_CONNECTION           0x00100000U
831
832 /**
833  * Flag for csp->flags: Set if the supports deflate compression.
834  */
835 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE            0x00200000U
836
837 /**
838  * Flag for csp->flags: Set if the content has been deflated by Privoxy
839  */
840 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED          0x00400000U
841
842 /**
843  * Flag for csp->flags: Set if we already read (parts of)
844  * a pipelined request in which case the client obviously
845  * isn't done talking.
846  */
847 #define CSP_FLAG_PIPELINED_REQUEST_WAITING          0x00800000U
848
849 /**
850  * Flag for csp->flags: Set if the client body is chunk-encoded
851  */
852 #define CSP_FLAG_CHUNKED_CLIENT_BODY                0x01000000U
853
854 /**
855  * Flag for csp->flags: Set if the client set the Expect header
856  */
857 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION     0x02000000U
858
859 /**
860  * Flag for csp->flags: Set if we answered the request ourselve.
861  */
862 #define CSP_FLAG_CRUNCHED                           0x04000000U
863
864 #ifdef FUZZ
865 /**
866  * Flag for csp->flags: Set if we are working with fuzzed input
867  */
868 #define CSP_FLAG_FUZZED_INPUT                       0x08000000U
869 #endif
870
871 /*
872  * Flags for use in return codes of child processes
873  */
874
875 /**
876  * Flag for process return code: Set if exiting process has been toggled
877  * during its lifetime.
878  */
879 #define RC_FLAG_TOGGLED   0x10
880
881 /**
882  * Flag for process return code: Set if exiting process has blocked its
883  * request.
884  */
885 #define RC_FLAG_BLOCKED   0x20
886
887 /**
888  * Maximum number of actions/filter files.  This limit is arbitrary - it's just used
889  * to size an array.
890  */
891 #define MAX_AF_FILES 30
892
893 /**
894  * Maximum number of sockets to listen to.  This limit is arbitrary - it's just used
895  * to size an array.
896  */
897 #define MAX_LISTENING_SOCKETS 10
898
899 /**
900  * The state of a Privoxy processing thread.
901  */
902 struct client_state
903 {
904    /** The proxy's configuration */
905    struct configuration_spec * config;
906
907    /** The actions to perform on the current request */
908    struct current_action_spec  action[1];
909
910    /** socket to talk to client (web browser) */
911    jb_socket cfd;
912
913    /** Number of requests received on the client socket. */
914    unsigned int requests_received_total;
915
916    /** current connection to the server (may go through a proxy) */
917    struct reusable_connection server_connection;
918
919    /** Multi-purpose flag container, see CSP_FLAG_* above */
920    unsigned int flags;
921
922    /** Client PC's IP address, as reported by the accept() function.
923        As a string. */
924    char *ip_addr_str;
925 #ifdef HAVE_RFC2553
926    /** Client PC's TCP address, as reported by the accept() function.
927        As a sockaddr. */
928    struct sockaddr_storage tcp_addr;
929 #else
930    /** Client PC's IP address, as reported by the accept() function.
931        As a number. */
932    unsigned long ip_addr_long;
933 #endif /* def HAVE_RFC2553 */
934
935    /** The host name and port (as a string of the form '<hostname>:<port>')
936        of the server socket to which the client connected. */
937    char *listen_addr_str;
938
939    /** The URL that was requested */
940    struct http_request http[1];
941
942    /*
943     * The final forwarding settings.
944     * XXX: Currently this is only used for forward-override,
945     * so we can free the space in sweep.
946     */
947    struct forward_spec * fwd;
948
949    /** An I/O buffer used for buffering data read from the server */
950    /* XXX: should be renamed to server_iob */
951    struct iob iob[1];
952
953    /** An I/O buffer used for buffering data read from the client */
954    struct iob client_iob[1];
955
956    /** Buffer used to briefly store data read from the network
957     *  before forwarding or processing it.
958     */
959    char *receive_buffer;
960    size_t receive_buffer_size;
961
962    /** List of all headers for this request */
963    struct list headers[1];
964
965    /** List of all tags that apply to this request */
966    struct list tags[1];
967
968 #ifdef FEATURE_CLIENT_TAGS
969    /** List of all tags that apply to this client (assigned based on address) */
970    struct list client_tags[1];
971    /** The address of the client the request (presumably) came from.
972     *  Either the address returned by accept(), or the address provided
973     *  with the X-Forwarded-For header, provided Privoxy has been configured
974     *  to use it.
975     */
976    char *client_address;
977 #endif
978
979    /** MIME-Type key, see CT_* above */
980    unsigned int content_type;
981
982    /** Actions files associated with this client */
983    struct file_list *actions_list[MAX_AF_FILES];
984
985    /** pcrs job files. */
986    struct file_list *rlist[MAX_AF_FILES];
987
988    /** Length after content modification. */
989    unsigned long long content_length;
990
991    /* XXX: is this the right location? */
992
993    /** Expected length of content after which we
994     * should stop reading from the server socket.
995     */
996    unsigned long long expected_content_length;
997
998    /** Expected length of content after which we
999     *  should stop reading from the client socket.
1000     */
1001    unsigned long long expected_client_content_length;
1002
1003 #ifdef FEATURE_TRUST
1004
1005    /** Trust file. */
1006    struct file_list *tlist;
1007
1008 #endif /* def FEATURE_TRUST */
1009
1010    /**
1011     * Failure reason to embedded in the CGI error page,
1012     * or NULL. Currently only used for socks errors.
1013     */
1014    char *error_message;
1015 };
1016
1017 /**
1018  * List of client states so the main thread can keep
1019  * track of them and garbage collect their resources.
1020  */
1021 struct client_states
1022 {
1023    struct client_states *next;
1024    struct client_state csp;
1025 };
1026
1027 /**
1028  * A function to add a header
1029  */
1030 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1031
1032 /**
1033  * A function to process a header
1034  */
1035 typedef jb_err (*parser_func_ptr    )(struct client_state *, char **);
1036
1037
1038 /**
1039  * List of available CGI functions.
1040  */
1041 struct cgi_dispatcher
1042 {
1043    /** The URL of the CGI, relative to the CGI root. */
1044    const char * const name;
1045
1046    /** The handler function for the CGI */
1047    jb_err    (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1048
1049    /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1050    const char * const description;
1051
1052    /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1053    int harmless;
1054 };
1055
1056
1057 /**
1058  * A data file used by Privoxy.  Kept in a linked list.
1059  */
1060 struct file_list
1061 {
1062    /**
1063     * This is a pointer to the data structures associated with the file.
1064     * Read-only once the structure has been created.
1065     */
1066    void *f;
1067
1068    /**
1069     * The unloader function.
1070     * Normally NULL.  When we are finished with file (i.e. when we have
1071     * loaded a new one), set to a pointer to an unloader function.
1072     * Unloader will be called by sweep() (called from main loop) when
1073     * all clients using this file are done.  This prevents threading
1074     * problems.
1075     */
1076    void (*unloader)(void *);
1077
1078    /**
1079     * Used internally by sweep().  Do not access from elsewhere.
1080     */
1081    int active;
1082
1083    /**
1084     * File last-modified time, so we can check if file has been changed.
1085     * Read-only once the structure has been created.
1086     */
1087    time_t lastmodified;
1088
1089    /**
1090     * The full filename.
1091     */
1092    char * filename;
1093
1094    /**
1095     * Pointer to next entry in the linked list of all "file_list"s.
1096     * This linked list is so that sweep() can navigate it.
1097     * Since sweep() can remove items from the list, we must be careful
1098     * to only access this value from main thread (when we know sweep
1099     * won't be running).
1100     */
1101    struct file_list *next;
1102 };
1103
1104
1105 #ifdef FEATURE_TRUST
1106
1107 /**
1108  * The format of a trust file when loaded into memory.
1109  */
1110 struct block_spec
1111 {
1112    struct pattern_spec url[1]; /**< The URL pattern              */
1113    int    reject;              /**< FIXME: Please document this! */
1114    struct block_spec *next;    /**< Next entry in linked list    */
1115 };
1116
1117 /**
1118  * Arbitrary limit for the number of trusted referrers.
1119  */
1120 #define MAX_TRUSTED_REFERRERS 512
1121
1122 #endif /* def FEATURE_TRUST */
1123
1124 /**
1125  * How to forward a connection to a parent proxy.
1126  */
1127 struct forward_spec
1128 {
1129    /** URL pattern that this forward_spec is for. */
1130    struct pattern_spec url[1];
1131
1132    /** Connection type.  Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1133    enum forwarder_type type;
1134
1135    /** SOCKS server hostname.  Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1136    char *gateway_host;
1137
1138    /** SOCKS server port. */
1139    int   gateway_port;
1140
1141    /** Parent HTTP proxy hostname, or NULL for none. */
1142    char *forward_host;
1143
1144    /** Parent HTTP proxy port. */
1145    int   forward_port;
1146
1147    /** Next entry in the linked list. */
1148    struct forward_spec *next;
1149 };
1150
1151
1152 /* Supported filter types */
1153 enum filter_type
1154 {
1155    FT_CONTENT_FILTER       = 0,
1156    FT_CLIENT_HEADER_FILTER = 1,
1157    FT_SERVER_HEADER_FILTER = 2,
1158    FT_CLIENT_HEADER_TAGGER = 3,
1159    FT_SERVER_HEADER_TAGGER = 4,
1160 #ifdef FEATURE_EXTERNAL_FILTERS
1161    FT_EXTERNAL_CONTENT_FILTER = 5,
1162 #endif
1163    FT_INVALID_FILTER       = 42,
1164 };
1165
1166 #ifdef FEATURE_EXTERNAL_FILTERS
1167 #define MAX_FILTER_TYPES        6
1168 #else
1169 #define MAX_FILTER_TYPES        5
1170 #endif
1171
1172 /**
1173  * This struct represents one filter (one block) from
1174  * the re_filterfile. If there is more than one filter
1175  * in the file, the file will be represented by a
1176  * chained list of re_filterfile specs.
1177  */
1178 struct re_filterfile_spec
1179 {
1180    char *name;                      /**< Name from FILTER: statement in re_filterfile. */
1181    char *description;               /**< Description from FILTER: statement in re_filterfile. */
1182    struct list patterns[1];         /**< The patterns from the re_filterfile. */
1183    pcrs_job *joblist;               /**< The resulting compiled pcrs_jobs. */
1184    enum filter_type type;           /**< Filter type (content, client-header, server-header). */
1185    int dynamic;                     /**< Set to one if the pattern might contain variables
1186                                          and has to be recompiled for every request. */
1187    struct re_filterfile_spec *next; /**< The pointer for chaining. */
1188 };
1189
1190
1191 #ifdef FEATURE_ACL
1192
1193 #define ACL_PERMIT   1  /**< Accept connection request */
1194 #define ACL_DENY     2  /**< Reject connection request */
1195
1196 /**
1197  * An IP address pattern.  Used to specify networks in the ACL.
1198  */
1199 struct access_control_addr
1200 {
1201 #ifdef HAVE_RFC2553
1202    struct sockaddr_storage addr; /* <The TCP address in network order. */
1203    struct sockaddr_storage mask; /* <The TCP mask in network order. */
1204 #else
1205    unsigned long addr;  /**< The IP address as an integer. */
1206    unsigned long mask;  /**< The network mask as an integer. */
1207    unsigned long port;  /**< The port number. */
1208 #endif /* HAVE_RFC2553 */
1209 };
1210
1211 /**
1212  * An access control list (ACL) entry.
1213  *
1214  * This is a linked list.
1215  */
1216 struct access_control_list
1217 {
1218    struct access_control_addr src[1];  /**< Client IP address */
1219    struct access_control_addr dst[1];  /**< Website or parent proxy IP address */
1220 #ifdef HAVE_RFC2553
1221    int wildcard_dst;                   /** < dst address is wildcard */
1222 #endif
1223
1224    short action;                       /**< ACL_PERMIT or ACL_DENY */
1225    struct access_control_list *next;   /**< The next entry in the ACL. */
1226 };
1227
1228 #endif /* def FEATURE_ACL */
1229
1230
1231 /** Maximum number of loaders (actions, re_filter, ...) */
1232 #define NLOADERS 8
1233
1234 /**
1235  * This struct represents a client-spcific-tag and it's description
1236  */
1237 struct client_tag_spec
1238 {
1239    char *name;        /**< Name from "client-specific-tag bla" directive */
1240    char *description; /**< Description from "client-specific-tag-description " directive */
1241    struct client_tag_spec *next; /**< The pointer for chaining. */
1242 };
1243
1244 /** configuration_spec::feature_flags: CGI actions editor. */
1245 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS             1U
1246
1247 /** configuration_spec::feature_flags: Web-based toggle. */
1248 #define RUNTIME_FEATURE_CGI_TOGGLE                   2U
1249
1250 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1251 #define RUNTIME_FEATURE_HTTP_TOGGLE                  4U
1252
1253 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1254 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS            8U
1255
1256 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1257 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1258
1259 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1260 #define RUNTIME_FEATURE_ENFORCE_BLOCKS              32U
1261
1262 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1263 #define RUNTIME_FEATURE_CGI_CRUNCHING               64U
1264
1265 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1266 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE      128U
1267
1268 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1269 #define RUNTIME_FEATURE_CONNECTION_SHARING         256U
1270
1271 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1272 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK       512U
1273
1274 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1275 #define RUNTIME_FEATURE_COMPRESSION               1024U
1276
1277 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1278 #define RUNTIME_FEATURE_TOLERATE_PIPELINING       2048U
1279
1280 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1281 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS      4096U
1282
1283 /**
1284  * Data loaded from the configuration file.
1285  *
1286  * (Anomaly: toggle is still handled through a global, not this structure)
1287  */
1288 struct configuration_spec
1289 {
1290    /** What to log */
1291    int debug;
1292
1293    /** Nonzero to enable multithreading. */
1294    int multi_threaded;
1295
1296    /** Bitmask of features that can be controlled through the config file. */
1297    unsigned feature_flags;
1298
1299    /** The log file name. */
1300    const char *logfile;
1301
1302    /** The config file directory. */
1303    const char *confdir;
1304
1305    /** The directory for customized CGI templates. */
1306    const char *templdir;
1307
1308 #ifdef FEATURE_EXTERNAL_FILTERS
1309    /** The template used to create temporary files. */
1310    const char *temporary_directory;
1311 #endif
1312
1313    /** The log file directory. */
1314    const char *logdir;
1315
1316    /** The full paths to the actions files. */
1317    const char *actions_file[MAX_AF_FILES];
1318
1319    /** The short names of the actions files. */
1320    const char *actions_file_short[MAX_AF_FILES];
1321
1322    /** The administrator's email address */
1323    char *admin_address;
1324
1325    /** A URL with info on this proxy */
1326    char *proxy_info_url;
1327
1328    /** URL to the user manual (on our website or local copy) */
1329    char *usermanual;
1330
1331    /** The file names of the pcre filter files. */
1332    const char *re_filterfile[MAX_AF_FILES];
1333
1334    /** The short names of the pcre filter files. */
1335    const char *re_filterfile_short[MAX_AF_FILES];
1336
1337    /**< List of ordered client header names. */
1338    struct list ordered_client_headers[1];
1339
1340    /** The hostname to show on CGI pages, or NULL to use the real one. */
1341    const char *hostname;
1342
1343    /** IP addresses to bind to.  Defaults to HADDR_DEFAULT == 127.0.0.1. */
1344    const char *haddr[MAX_LISTENING_SOCKETS];
1345
1346    /** Trusted referring site that can be used to reach CGI
1347      * pages that aren't marked as harmful.
1348      */
1349    const char *trusted_cgi_referrer;
1350
1351    /** Ports to bind to.  Defaults to HADDR_PORT == 8118. */
1352    int         hport[MAX_LISTENING_SOCKETS];
1353
1354    /** Size limit for IOB */
1355    size_t buffer_limit;
1356
1357    /** Size of the receive buffer */
1358    size_t receive_buffer_size;
1359
1360    /** Use accf_http(4) if available */
1361    int enable_accept_filter;
1362
1363    /** Backlog passed to listen() */
1364    int listen_backlog;
1365
1366 #ifdef FEATURE_TRUST
1367
1368    /** The file name of the trust file. */
1369    const char * trustfile;
1370
1371    /** FIXME: DOCME: Document this. */
1372    struct list trust_info[1];
1373
1374    /** FIXME: DOCME: Document this. */
1375    struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1376
1377 #endif /* def FEATURE_TRUST */
1378
1379 #ifdef FEATURE_CLIENT_TAGS
1380    struct client_tag_spec client_tags[1];
1381
1382    /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1383    unsigned int client_tag_lifetime;
1384 #endif /* def FEATURE_CLIENT_TAGS */
1385    int trust_x_forwarded_for;
1386
1387 #ifdef FEATURE_ACL
1388
1389    /** The access control list (ACL). */
1390    struct access_control_list *acl;
1391
1392 #endif /* def FEATURE_ACL */
1393
1394    /** Information about parent proxies (forwarding). */
1395    struct forward_spec *forward;
1396
1397    /** Number of retries in case a forwarded connection attempt fails */
1398    int forwarded_connect_retries;
1399
1400    /** Maximum number of client connections. */
1401    int max_client_connections;
1402
1403    /* Timeout when waiting on sockets for data to become available. */
1404    int socket_timeout;
1405
1406 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1407    /* Maximum number of seconds after which an open connection will no longer be reused. */
1408    unsigned int keep_alive_timeout;
1409
1410    /* Assumed server-side keep alive timeout if none is specified. */
1411    unsigned int default_server_timeout;
1412 #endif
1413
1414 #ifdef FEATURE_COMPRESSION
1415    int compression_level;
1416 #endif
1417
1418    /** All options from the config file, HTML-formatted. */
1419    char *proxy_args;
1420
1421    /** The configuration file object. */
1422    struct file_list *config_file_list;
1423
1424    /** List of loaders */
1425    int (*loaders[NLOADERS])(struct client_state *);
1426
1427    /** Nonzero if we need to bind() to the new port. */
1428    int need_bind;
1429 };
1430
1431 /** Calculates the number of elements in an array, using sizeof. */
1432 #define SZ(X)  (sizeof(X) / sizeof(*X))
1433
1434 /** The force load URL prefix. Not behind an ifdef because
1435   * it's always used for the show-status page. */
1436 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1437
1438 #ifdef FEATURE_NO_GIFS
1439 /** The MIME type for images ("image/png" or "image/gif"). */
1440 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1441 #else
1442 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1443 #endif /* def FEATURE_NO_GIFS */
1444
1445
1446 /*
1447  * Hardwired URLs
1448  */
1449
1450 /** URL for the Privoxy home page. */
1451 #define HOME_PAGE_URL     "https://www.privoxy.org/"
1452
1453 /** URL for the Privoxy user manual. */
1454 #define USER_MANUAL_URL   HOME_PAGE_URL VERSION "/user-manual/"
1455
1456 /** Prefix for actions help links  (append to USER_MANUAL_URL). */
1457 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1458
1459 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1460 #define CONFIG_HELP_PREFIX  "config.html#"
1461
1462 /*
1463  * The "hosts" to intercept and display CGI pages.
1464  * First one is a hostname only, second one can specify host and path.
1465  *
1466  * Notes:
1467  * 1) Do not specify the http: prefix
1468  * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1469  * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1470  */
1471 #define CGI_SITE_1_HOST "p.p"
1472 #define CGI_SITE_2_HOST "config.privoxy.org"
1473 #define CGI_SITE_2_PATH ""
1474
1475 /**
1476  * The prefix for CGI pages.  Written out in generated HTML.
1477  * INCLUDES the trailing slash.
1478  */
1479 #define CGI_PREFIX  "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1480
1481 #endif /* ndef PROJECT_H_INCLUDED */
1482
1483 /*
1484   Local Variables:
1485   tab-width: 3
1486   end:
1487 */