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