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