1 #ifndef PROJECT_H_INCLUDED
2 #define PROJECT_H_INCLUDED
3 /*********************************************************************
5 * File : $Source: /cvsroot/ijbswa/current/project.h,v $
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).
11 * Copyright : Written by and Copyright (C) 2001-2021 the
12 * Privoxy team. https://www.privoxy.org/
14 * Based on the Internet Junkbuster originally written
15 * by and Copyright (C) 1997 Anonymous Coders and
16 * Junkbusters Corporation. http://www.junkbusters.com
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.
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.
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.
36 *********************************************************************/
39 /* Declare struct FILE for vars and funcs. */
42 /* Need time_t for file_list */
44 /* Needed for pcre choice */
47 #ifdef FEATURE_HTTPS_INSPECTION
49 * Macros for SSL structures
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 */
56 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
57 #include "mbedtls/net_sockets.h"
58 #include "mbedtls/entropy.h"
59 #include "mbedtls/ctr_drbg.h"
61 #if defined(MBEDTLS_SSL_CACHE_C)
62 #include "mbedtls/ssl_cache.h"
64 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
66 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
69 #include <minwindef.h>
71 #include <minwinbase.h>
74 #undef X509_EXTENSIONS
76 #include <openssl/ssl.h>
77 #include <openssl/bio.h>
78 #include <openssl/err.h>
79 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
81 #ifdef FEATURE_HTTPS_INSPECTION_WOLFSSL
82 #include <wolfssl/options.h>
83 #include <wolfssl/ssl.h>
84 #endif /* FEATURE_HTTPS_INSPECTION_WOLFSSL */
86 /* Need for struct sockaddr_storage */
90 # include <sys/socket.h>
93 # include <ws2tcpip.h>
94 typedef unsigned short in_port_t;
100 * Include appropriate regular expression libraries.
101 * Note that pcrs and pcre (native) are needed for cgi
102 * and are included anyway.
108 # include "pcre2posix.h"
111 # include "pcreposix.h"
115 # ifdef PCRE2_H_IN_SUBDIR
116 # define PCRE2_CODE_UNIT_WIDTH 8
117 # include <pcre2/pcre2.h>
119 # define PCRE2_CODE_UNIT_WIDTH 8
122 # ifdef PCRE2POSIX_H_IN_SUBDIR
123 # include <pcre2/pcre2posix.h>
125 # include <pcre2posix.h>
128 # ifdef PCRE_H_IN_SUBDIR
129 # include <pcre/pcre.h>
133 # ifdef PCREPOSIX_H_IN_SUBDIR
134 # include <pcre/pcreposix.h>
136 # include <pcreposix.h>
149 * I don't want to have to #include all this just for the declaration
150 * of SOCKET. However, it looks like we have to...
161 typedef SOCKET jb_socket;
163 #define JB_INVALID_SOCKET INVALID_SOCKET
165 #else /* ndef _WIN32 */
168 * The type used by sockets. On UNIX it's an int. Microsoft decided to
169 * make it an unsigned.
171 typedef int jb_socket;
174 * The error value used for variables of type jb_socket. On UNIX this
175 * is -1, however Microsoft decided to make socket handles unsigned, so
176 * they use a different value.
179 #define JB_INVALID_SOCKET (-1)
181 #endif /* ndef _WIN32 */
185 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
190 JB_ERR_OK = 0, /**< Success, no error */
191 JB_ERR_MEMORY = 1, /**< Out of memory */
192 JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
193 JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
194 JB_ERR_PARSE = 4, /**< Error parsing file */
195 JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
196 CGI actions editor. */
197 JB_ERR_COMPRESS = 6 /**< Error on decompression */
200 typedef enum privoxy_err jb_err;
203 * This macro is used to free a pointer that may be NULL.
204 * It also sets the variable to NULL after it's been freed.
205 * The parameter should be a simple variable without side effects.
207 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
211 * Macro definitions for platforms where isspace() and friends
212 * are macros that use their argument directly as an array index
213 * and thus better be positive. Supposedly that's the case on
214 * some unspecified Solaris versions.
215 * Note: Remember to #include <ctype.h> if you use these macros.
217 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
218 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
219 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
220 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
221 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
224 * Use for statically allocated buffers if you have no other choice.
225 * Remember to check the length of what you write into the buffer
226 * - we don't want any buffer overflows!
228 #define BUFFER_SIZE 5000
231 * Max length of CGI parameters (arbitrary limit).
233 #define CGI_PARAM_LEN_MAX 500U
236 * Buffer size for capturing struct hostent data in the
237 * gethostby(name|addr)_r library calls. Since we don't
238 * loop over gethostbyname_r, the buffer must be sufficient
239 * to accommodate multiple IN A RRs, as used in DNS round robin
240 * load balancing. W3C's wwwlib uses 1K, so that should be
241 * good enough for us, too.
244 * XXX: Temporary doubled, for some configurations
245 * 1K is still too small and we didn't get the
246 * real fix ready for inclusion.
248 #define HOSTENT_BUFFER_SIZE 2048
251 * Default TCP/IP address to listen on, as a string.
252 * Set to "127.0.0.1:8118".
254 #define HADDR_DEFAULT "127.0.0.1:8118"
257 /* Forward def for struct client_state */
258 struct configuration_spec;
262 * Entry in a linked list of strings.
267 * The string pointer. It must point to a dynamically malloc()ed
268 * string or be NULL for the list functions to work. In the latter
269 * case, just be careful next time you iterate through the list in
274 /** Next entry in the linked list, or NULL if no more. */
275 struct list_entry *next;
279 * A header for a linked list of strings.
283 /** First entry in the list, or NULL if the list is empty. */
284 struct list_entry *first;
286 /** Last entry in the list, or NULL if the list is empty. */
287 struct list_entry *last;
292 * An entry in a map. This is a name=value pair.
296 /** The key for the map. */
298 /** The value associated with that key. */
300 /** The next map entry, or NULL if none. */
301 struct map_entry *next;
305 * A map from a string to another string.
306 * This is used for the parameters passed in a HTTP GET request, and
307 * to store the exports when the CGI interface is filling in a template.
311 /** The first map entry, or NULL if the map is empty. */
312 struct map_entry *first;
313 /** The last map entry, or NULL if the map is empty. */
314 struct map_entry *last;
317 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
319 * Struct of attributes necessary for TLS/SSL connection
322 mbedtls_ssl_context ssl;
323 mbedtls_ssl_config conf;
324 mbedtls_net_context socket_fd;
325 mbedtls_x509_crt server_cert;
326 mbedtls_x509_crt ca_cert;
327 mbedtls_pk_context prim_key;
328 int *ciphersuites_list;
330 #if defined(MBEDTLS_SSL_CACHE_C)
331 mbedtls_ssl_cache_context cache;
333 } mbedtls_connection_attr;
334 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
336 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
338 * Struct of attributes necessary for TLS/SSL connection
343 } openssl_connection_attr;
344 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
346 #ifdef FEATURE_HTTPS_INSPECTION_WOLFSSL
348 * Struct of attributes necessary for TLS/SSL connection
353 } wolfssl_connection_attr;
354 #endif /* def FEATURE_HTTPS_INSPECTION_WOLFSSL */
357 * A HTTP request. This includes the method (GET, POST) and
360 * This is also used whenever we want to match a URL against a
361 * URL pattern. This always contains the URL to match, and never
362 * a URL pattern. (See struct url_spec).
366 char *cmd; /**< Whole command line: method, URL, Version */
367 char *ocmd; /**< Backup of original cmd for CLF logging */
368 char *gpc; /**< HTTP method: GET, POST, ... */
369 char *url; /**< The URL */
370 char *version; /**< Protocol version */
371 int status; /**< HTTP Status */
373 int port; /**< Port of URL or 80 (default) */
374 char *host; /**< Host part of URL */
375 char *path; /**< Path of URL */
376 char *hostport; /**< host[:port] */
378 char *host_ip_addr_str; /**< String with dotted decimal representation
379 of host's IP. NULL before connect_to() */
381 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
382 char **dvec; /**< List of pointers to the strings in dbuffer. */
383 int dcount; /**< How many parts to this domain? (length of dvec) */
385 #ifdef FEATURE_HTTPS_INSPECTION
386 int client_ssl; /**< Flag if we should communicate with client over ssl */
387 int server_ssl; /**< Flag if we should communicate with server over ssl */
388 unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
389 unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
391 short int ssl; /**< Flag if protocol is https */
395 #ifdef FEATURE_HTTPS_INSPECTION
397 * Struct for linked list containing certificates
399 typedef struct certs_chain {
400 char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
401 char *file_buf; /* buffer for whole certificate - format to save in file */
402 struct certs_chain *next; /* next certificate in chain of trust */
407 * Reasons for generating a http_response instead of delivering
408 * the requested resource. Mostly ordered the way they are checked
428 * Response generated by CGI, blocker, or error handler
432 char *status; /**< HTTP status (string). */
433 struct list headers[1]; /**< List of header lines. */
434 char *head; /**< Formatted http response head. */
435 size_t head_length; /**< Length of http response head. */
436 char *body; /**< HTTP document body. */
437 size_t content_length; /**< Length of body, REQUIRED if binary body. */
438 int is_static; /**< Nonzero if the content will never change and
439 should be cached by the browser (e.g. images). */
440 enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
444 #define REGEX_TYPE pcre2_code
446 #define REGEX_TYPE regex_t
451 #ifdef FEATURE_PCRE_HOST_PATTERNS
452 REGEX_TYPE *host_regex;/**< Regex for host matching */
453 enum host_regex_type { VANILLA_HOST_PATTERN, PCRE_HOST_PATTERN } host_regex_type;
454 #endif /* defined FEATURE_PCRE_HOST_PATTERNS */
455 int dcount; /**< How many parts to this domain? (length of dvec) */
456 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
457 char **dvec; /**< List of pointers to the strings in dbuffer. */
458 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
460 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
462 REGEX_TYPE *preg; /**< Regex for matching path part */
466 * A URL or a tag pattern.
470 /** The string which was parsed to produce this pattern_spec.
471 Used for debugging or display only. */
476 struct url_spec url_spec;
477 REGEX_TYPE *tag_regex;
480 unsigned int flags; /**< Bitmap with various pattern properties. */
484 * Constant for host part matching in URLs. If set, indicates that the start of
485 * the pattern must match the start of the URL. E.g. this is not set for the
486 * pattern ".example.com", so that it will match both "example.com" and
487 * "www.example.com". It is set for the pattern "example.com", which makes it
488 * match "example.com" only, not "www.example.com".
490 #define ANCHOR_LEFT 1
493 * Constant for host part matching in URLs. If set, indicates that the end of
494 * the pattern must match the end of the URL. E.g. this is not set for the
495 * pattern "ad.", so that it will match any host called "ad", irrespective
496 * of how many subdomains are in the fully-qualified domain name.
498 #define ANCHOR_RIGHT 2
500 /** Pattern spec bitmap: It's an URL pattern. */
501 #define PATTERN_SPEC_URL_PATTERN 0x00000001UL
503 /** Pattern spec bitmap: It's a TAG pattern. */
504 #define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
506 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
507 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
509 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
510 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
512 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
513 #define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
516 * An I/O buffer. Holds a string which can be appended to, and can have data
517 * removed from the beginning.
521 char *buf; /**< Start of buffer */
522 char *cur; /**< Start of relevant data */
523 char *eod; /**< End of relevant data */
524 size_t size; /**< Size as malloc()ed */
528 /* Bits for csp->content_type bitmask: */
529 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
530 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
531 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
533 /* Although these are not, strictly speaking, content types
534 * (they are content encodings), it is simple to handle them
537 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
538 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
539 #define CT_BROTLI 0x0040U /**< Brotli-compressed data. */
542 * Flag to signal that the server declared the content type,
543 * so we can differentiate between unknown and undeclared
546 #define CT_DECLARED 0x0080U
549 * The mask which includes all actions.
551 #define ACTION_MASK_ALL (~0UL)
554 * The most compatible set of actions - i.e. none.
556 #define ACTION_MOST_COMPATIBLE 0x00000000UL
558 /** Action bitmap: Block the request. */
559 #define ACTION_BLOCK 0x00000001UL
560 /** Action bitmap: Deanimate if it's a GIF. */
561 #define ACTION_DEANIMATE 0x00000002UL
562 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
563 #define ACTION_DOWNGRADE 0x00000004UL
564 /** Action bitmap: Fast redirects. */
565 #define ACTION_FAST_REDIRECTS 0x00000008UL
566 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
567 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
568 /** Action bitmap: Hide "From" header. */
569 #define ACTION_HIDE_FROM 0x00000020UL
570 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
571 #define ACTION_HIDE_REFERER 0x00000040UL
572 /** Action bitmap: Hide "User-Agent" and similar headers. */
573 #define ACTION_HIDE_USER_AGENT 0x00000080UL
574 /** Action bitmap: This is an image. */
575 #define ACTION_IMAGE 0x00000100UL
576 /** Action bitmap: Sets the image blocker. */
577 #define ACTION_IMAGE_BLOCKER 0x00000200UL
578 /** Action bitmap: Prevent compression. */
579 #define ACTION_NO_COMPRESSION 0x00000400UL
580 /** Action bitmap: Change cookies to session only cookies. */
581 #define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
582 /** Action bitmap: Block cookies coming from the client. */
583 #define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
584 /** Action bitmap: Block cookies coming from the server. */
585 #define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
586 /** Action bitmap: Override the forward settings in the config file */
587 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
588 /** Action bitmap: Block as empty document */
589 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
590 /** Action bitmap: Limit CONNECT requests to safe ports. */
591 #define ACTION_LIMIT_CONNECT 0x00010000UL
592 /** Action bitmap: Redirect request. */
593 #define ACTION_REDIRECT 0x00020000UL
594 /** Action bitmap: Crunch or modify "if-modified-since" header. */
595 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
596 /** Action bitmap: Overwrite Content-Type header. */
597 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
598 /** Action bitmap: Crunch specified server header. */
599 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
600 /** Action bitmap: Crunch specified client header */
601 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
602 /** Action bitmap: Enable text mode by force */
603 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
604 /** Action bitmap: Remove the "If-None-Match" header. */
605 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
606 /** Action bitmap: Enable content-disposition crunching */
607 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
608 /** Action bitmap: Replace or block Last-Modified header */
609 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
610 /** Action bitmap: Replace or block Accept-Language header */
611 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
612 /** Action bitmap: Limit the cookie lifetime */
613 #define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
614 /** Action bitmap: Delay writes */
615 #define ACTION_DELAY_RESPONSE 0x10000000UL
616 /** Action bitmap: Turn https inspection on */
617 #define ACTION_HTTPS_INSPECTION 0x20000000UL
618 /** Action bitmap: Turn certificates verification off */
619 #define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
621 /** Action string index: How to deanimate GIFs */
622 #define ACTION_STRING_DEANIMATE 0
623 /** Action string index: Replacement for "From:" header */
624 #define ACTION_STRING_FROM 1
625 /** Action string index: How to block images */
626 #define ACTION_STRING_IMAGE_BLOCKER 2
627 /** Action string index: Replacement for "Referer:" header */
628 #define ACTION_STRING_REFERER 3
629 /** Action string index: Replacement for "User-Agent:" header */
630 #define ACTION_STRING_USER_AGENT 4
631 /** Action string index: Legal CONNECT ports. */
632 #define ACTION_STRING_LIMIT_CONNECT 5
633 /** Action string index: Server headers containing this pattern are crunched*/
634 #define ACTION_STRING_SERVER_HEADER 6
635 /** Action string index: Client headers containing this pattern are crunched*/
636 #define ACTION_STRING_CLIENT_HEADER 7
637 /** Action string index: Replacement for the "Accept-Language:" header*/
638 #define ACTION_STRING_LANGUAGE 8
639 /** Action string index: Replacement for the "Content-Type:" header*/
640 #define ACTION_STRING_CONTENT_TYPE 9
641 /** Action string index: Replacement for the "content-disposition:" header*/
642 #define ACTION_STRING_CONTENT_DISPOSITION 10
643 /** Action string index: Replacement for the "If-Modified-Since:" header*/
644 #define ACTION_STRING_IF_MODIFIED_SINCE 11
645 /** Action string index: Replacement for the "Last-Modified:" header. */
646 #define ACTION_STRING_LAST_MODIFIED 12
647 /** Action string index: Redirect URL */
648 #define ACTION_STRING_REDIRECT 13
649 /** Action string index: Decode before redirect? */
650 #define ACTION_STRING_FAST_REDIRECTS 14
651 /** Action string index: Overriding forward rule. */
652 #define ACTION_STRING_FORWARD_OVERRIDE 15
653 /** Action string index: Reason for the block. */
654 #define ACTION_STRING_BLOCK 16
655 /** Action string index: what to do with the "X-Forwarded-For" header. */
656 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
657 /** Action string index: how many minutes cookies should be valid. */
658 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
659 /** Action string index: how many milliseconds writes should be delayed. */
660 #define ACTION_STRING_DELAY_RESPONSE 19
661 /** Number of string actions. */
662 #define ACTION_STRING_COUNT 20
665 /* To make the ugly hack in sed easier to understand */
666 #define CHECK_EVERY_HEADER_REMAINING 0
669 /** Index into current_action_spec::multi[] for headers to add. */
670 #define ACTION_MULTI_ADD_HEADER 0
671 /** Index into current_action_spec::multi[] for content filters to apply. */
672 #define ACTION_MULTI_FILTER 1
673 /** Index into current_action_spec::multi[] for server-header filters to apply. */
674 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
675 /** Index into current_action_spec::multi[] for client-header filters to apply. */
676 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
677 /** Index into current_action_spec::multi[] for client-header tags to apply. */
678 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
679 /** Index into current_action_spec::multi[] for server-header tags to apply. */
680 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
681 /** Number of multi-string actions. */
682 #define ACTION_MULTI_EXTERNAL_FILTER 6
683 /** Index into current_action_spec::multi[] for tags to suppress. */
684 #define ACTION_MULTI_SUPPRESS_TAG 7
685 /** Index into current_action_spec::multi[] for client body filters to apply. */
686 #define ACTION_MULTI_CLIENT_BODY_FILTER 8
687 /** Index into current_action_spec::multi[] for client body taggers to apply. */
688 #define ACTION_MULTI_CLIENT_BODY_TAGGER 9
689 /** Number of multi-string actions. */
690 #define ACTION_MULTI_COUNT 10
694 * This structure contains a list of actions to apply to a URL.
695 * It only contains positive instructions - no "-" options.
696 * It is not used to store the actions list itself, only for
697 * url_actions() to return the current values.
699 struct current_action_spec
701 /** Actions to apply. A bit set to "1" means perform the action. */
705 * Parameters for those actions that require them.
706 * Each entry is valid if & only if the corresponding entry in "flags" is
709 char * string[ACTION_STRING_COUNT];
711 /** Lists of strings for multi-string actions. */
712 struct list multi[ACTION_MULTI_COUNT][1];
717 * This structure contains a set of changes to actions.
718 * It can contain both positive and negative instructions.
719 * It is used to store an entry in the actions list.
723 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
724 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
727 * Parameters for those actions that require them.
728 * Each entry is valid if & only if the corresponding entry in "flags" is
731 char * string[ACTION_STRING_COUNT];
733 /** Lists of strings to remove, for multi-string actions. */
734 struct list multi_remove[ACTION_MULTI_COUNT][1];
736 /** If nonzero, remove *all* strings from the multi-string action. */
737 int multi_remove_all[ACTION_MULTI_COUNT];
739 /** Lists of strings to add, for multi-string actions. */
740 struct list multi_add[ACTION_MULTI_COUNT][1];
745 * This structure is used to store action files.
747 * It contains an URL or tag pattern, and the changes to
748 * the actions. It's a linked list and should only be
749 * free'd through unload_actions_file() unless there's
750 * only a single entry.
754 struct pattern_spec url[1]; /**< The URL or tag pattern. */
756 struct action_spec *action; /**< Action settings that might be shared with
757 the list entry before or after the current
758 one and can't be free'd willy nilly. */
760 struct url_actions *next; /**< Next action section in file, or NULL. */
763 enum forwarder_type {
764 /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
766 /**< original SOCKS 4 protocol */
768 /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
770 /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
772 /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
775 * Don't use a SOCKS server, forward to the specified webserver.
776 * The difference to SOCKS_NONE is that a request line without
783 * Structure to hold the server socket and the information
784 * required to make sure we only reuse the connection if
785 * the host and forwarding settings are the same.
787 struct reusable_connection
791 time_t timestamp; /* XXX: rename? */
794 time_t response_received;
797 * Number of seconds after which this
798 * connection will no longer be reused.
800 unsigned int keep_alive_timeout;
802 * Number of requests that were sent to this connection.
803 * This is currently only for debugging purposes.
805 unsigned int requests_sent_total;
809 enum forwarder_type forwarder_type;
822 * Flags for use in csp->flags
826 * Flag for csp->flags: Set if this client is processing data.
827 * Cleared when the thread associated with this structure dies.
829 #define CSP_FLAG_ACTIVE 0x01U
832 * Flag for csp->flags: Set if the server's reply is in "chunked"
835 #define CSP_FLAG_CHUNKED 0x02U
838 * Flag for csp->flags: Set if this request was enforced, although it would
839 * normally have been blocked.
841 #define CSP_FLAG_FORCED 0x04U
844 * Flag for csp->flags: Set if any modification to the body was done.
846 #define CSP_FLAG_MODIFIED 0x08U
849 * Flag for csp->flags: Set if request was blocked.
851 #define CSP_FLAG_REJECTED 0x10U
854 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
856 #define CSP_FLAG_TOGGLED_ON 0x20U
859 * Flag for csp->flags: Set if an acceptable Connection header
860 * has already been set by the client.
862 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
865 * Flag for csp->flags: Set if an acceptable Connection header
866 * has already been set by the server.
868 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
871 * Flag for csp->flags: Signals header parsers whether they
872 * are parsing server or client headers.
874 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
877 * Flag for csp->flags: Set if adding the Host: header
880 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
883 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
884 * XXX: As we now have tags we might as well ditch this.
886 #define CSP_FLAG_NO_FILTERING 0x00000400U
889 * Flag for csp->flags: Set the client IP has appended to
890 * an already existing X-Forwarded-For header in which case
891 * no new header has to be generated.
893 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
896 * Flag for csp->flags: Set if the server wants to keep
897 * the connection alive.
899 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
902 * Flag for csp->flags: Set if the server specified the
905 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
908 * Flag for csp->flags: Set if we know the content length,
909 * either because the server set it, or we figured it out
912 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
915 * Flag for csp->flags: Set if the client wants to keep
916 * the connection alive.
918 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
921 * Flag for csp->flags: Set if we think we got the whole
922 * client request and shouldn't read any additional data
923 * coming from the client until the current request has
926 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
929 * Flag for csp->flags: Set if the server promised us to
930 * keep the connection open for a known number of seconds.
932 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
935 * Flag for csp->flags: Set if we think we can't reuse
936 * the server socket. XXX: It's also set after sabotaging
937 * pipelining attempts which is somewhat inconsistent with
940 #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
943 * Flag for csp->flags: Set if the Proxy-Connection header
944 * is among the server headers.
946 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
949 * Flag for csp->flags: Set if the client reused its connection.
951 #define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
954 * Flag for csp->flags: Set if the supports deflate compression.
956 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
959 * Flag for csp->flags: Set if the content has been deflated by Privoxy
961 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
964 * Flag for csp->flags: Set if we already read (parts of)
965 * a pipelined request in which case the client obviously
966 * isn't done talking.
968 #define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
971 * Flag for csp->flags: Set if the client body is chunk-encoded
973 #define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
976 * Flag for csp->flags: Set if the client set the Expect header
978 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
981 * Flag for csp->flags: Set if we answered the request ourselves.
983 #define CSP_FLAG_CRUNCHED 0x04000000U
987 * Flag for csp->flags: Set if we are working with fuzzed input
989 #define CSP_FLAG_FUZZED_INPUT 0x08000000U
993 * Flags for use in return codes of child processes
997 * Flag for process return code: Set if exiting process has been toggled
998 * during its lifetime.
1000 #define RC_FLAG_TOGGLED 0x10
1003 * Flag for process return code: Set if exiting process has blocked its
1006 #define RC_FLAG_BLOCKED 0x20
1009 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
1012 #define MAX_AF_FILES 100
1015 * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
1018 #define MAX_LISTENING_SOCKETS 10
1021 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1022 mbedtls_connection_attr mbedtls_attr; /* Mbed TLS attrs*/
1023 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1024 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1025 openssl_connection_attr openssl_attr; /* OpenSSL atrrs */
1026 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1027 #ifdef FEATURE_HTTPS_INSPECTION_WOLFSSL
1028 wolfssl_connection_attr wolfssl_attr; /* wolfSSL atrrs */
1029 #endif /* FEATURE_HTTPS_INSPECTION_WOLFSSL */
1032 * The state of a Privoxy processing thread.
1036 /** The proxy's configuration */
1037 struct configuration_spec * config;
1039 /** The actions to perform on the current request */
1040 struct current_action_spec action[1];
1042 /** socket to talk to client (web browser) */
1045 /** Number of requests received on the client socket. */
1046 unsigned int requests_received_total;
1048 /** current connection to the server (may go through a proxy) */
1049 struct reusable_connection server_connection;
1051 /** Multi-purpose flag container, see CSP_FLAG_* above */
1054 /** MIME-Type key, see CT_* above */
1055 unsigned int content_type;
1057 /** Client PC's IP address, as reported by the accept() function.
1061 /** Client PC's TCP address, as reported by the accept() function.
1063 struct sockaddr_storage tcp_addr;
1065 /** Client PC's IP address, as reported by the accept() function.
1067 unsigned long ip_addr_long;
1068 #endif /* def HAVE_RFC2553 */
1070 /** The host name and port (as a string of the form '<hostname>:<port>')
1071 of the server socket to which the client connected. */
1072 char *listen_addr_str;
1074 /** The URL that was requested */
1075 struct http_request http[1];
1078 * The final forwarding settings.
1079 * XXX: Currently this is only used for forward-override,
1080 * so we can free the space in sweep.
1082 struct forward_spec * fwd;
1084 /** An I/O buffer used for buffering data read from the server */
1085 /* XXX: should be renamed to server_iob */
1088 struct ssl_attr ssl_server_attr; /* attributes for connection to server */
1089 struct ssl_attr ssl_client_attr; /* attributes for connection to client */
1091 /** An I/O buffer used for buffering data read from the client */
1092 struct iob client_iob[1];
1094 /** Buffer used to briefly store data read from the network
1095 * before forwarding or processing it.
1097 char *receive_buffer;
1098 size_t receive_buffer_size;
1100 /** List of all headers for this request */
1101 struct list headers[1];
1103 #ifdef FEATURE_HTTPS_INSPECTION
1104 /** List of all encrypted headers for this request */
1105 struct list https_headers[1];
1108 /** List of all tags that apply to this request */
1109 struct list tags[1];
1111 #ifdef FEATURE_CLIENT_TAGS
1112 /** List of all tags that apply to this client (assigned based on address) */
1113 struct list client_tags[1];
1114 /** The address of the client the request (presumably) came from.
1115 * Either the address returned by accept(), or the address provided
1116 * with the X-Forwarded-For header, provided Privoxy has been configured
1119 char *client_address;
1122 /** Actions files associated with this client */
1123 struct file_list *actions_list[MAX_AF_FILES];
1125 /** pcrs job files. */
1126 struct file_list *rlist[MAX_AF_FILES];
1128 /** Length after content modification. */
1129 unsigned long long content_length;
1131 /* XXX: is this the right location? */
1133 /** Expected length of content after which we
1134 * should stop reading from the server socket.
1136 unsigned long long expected_content_length;
1138 /** Expected length of content after which we
1139 * should stop reading from the client socket.
1141 unsigned long long expected_client_content_length;
1143 #ifdef FEATURE_TRUST
1146 struct file_list *tlist;
1148 #endif /* def FEATURE_TRUST */
1151 * Failure reason to embedded in the CGI error page,
1152 * or NULL. Currently only used for socks errors.
1154 char *error_message;
1156 #ifdef FEATURE_HTTPS_INSPECTION
1157 /* Result of server certificate verification
1159 * Values for flag determining certificate validity
1160 * are compatible with return value of function
1161 * mbedtls_ssl_get_verify_result() for mbedtls
1162 * and SSL_get_verify_result() for openssl.
1163 * There are no values for "invalid certificate", they are
1164 * set by the functions mentioned above.
1166 #define SSL_CERT_VALID 0
1167 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1168 #define SSL_CERT_NOT_VERIFIED 0xFFFFFFFF
1169 uint32_t server_cert_verification_result;
1170 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1171 #if defined(FEATURE_HTTPS_INSPECTION_OPENSSL) || defined(FEATURE_HTTPS_INSPECTION_WOLFSSL)
1172 #define SSL_CERT_NOT_VERIFIED ~0L
1173 long server_cert_verification_result;
1174 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1176 /* Flag for certificate validity checking */
1177 int dont_verify_certificate;
1180 * Flags if SSL connection with server or client is opened.
1181 * Thanks to this flags, we can call function to close both connections
1182 * and we don't have to care about more details.
1184 short int ssl_with_server_is_opened;
1185 short int ssl_with_client_is_opened;
1188 * Server certificate chain of trust including strings with certificates
1189 * information and string with whole certificate file
1191 struct certs_chain server_certs_chain;
1196 * List of client states so the main thread can keep
1197 * track of them and garbage collect their resources.
1199 struct client_states
1201 struct client_states *next;
1202 struct client_state csp;
1206 * A function to add a header
1208 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1211 * A function to process a header
1213 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1217 * List of available CGI functions.
1219 struct cgi_dispatcher
1221 /** The URL of the CGI, relative to the CGI root. */
1222 const char * const name;
1224 /** The handler function for the CGI */
1225 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1227 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1228 const char * const description;
1230 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1236 * A data file used by Privoxy. Kept in a linked list.
1241 * This is a pointer to the data structures associated with the file.
1242 * Read-only once the structure has been created.
1247 * The unloader function.
1248 * Normally NULL. When we are finished with file (i.e. when we have
1249 * loaded a new one), set to a pointer to an unloader function.
1250 * Unloader will be called by sweep() (called from main loop) when
1251 * all clients using this file are done. This prevents threading
1254 void (*unloader)(void *);
1257 * Used internally by sweep(). Do not access from elsewhere.
1262 * File last-modified time, so we can check if file has been changed.
1263 * Read-only once the structure has been created.
1265 time_t lastmodified;
1268 * The full filename.
1273 * Pointer to next entry in the linked list of all "file_list"s.
1274 * This linked list is so that sweep() can navigate it.
1275 * Since sweep() can remove items from the list, we must be careful
1276 * to only access this value from main thread (when we know sweep
1277 * won't be running).
1279 struct file_list *next;
1283 #ifdef FEATURE_TRUST
1286 * The format of a trust file when loaded into memory.
1290 struct pattern_spec url[1]; /**< The URL pattern */
1291 int reject; /**< FIXME: Please document this! */
1292 struct block_spec *next; /**< Next entry in linked list */
1296 * Arbitrary limit for the number of trusted referrers.
1298 #define MAX_TRUSTED_REFERRERS 512
1300 #endif /* def FEATURE_TRUST */
1303 * How to forward a connection to a parent proxy.
1307 /** URL pattern that this forward_spec is for. */
1308 struct pattern_spec url[1];
1310 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1311 enum forwarder_type type;
1313 /** SOCKS server port. */
1316 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1319 /** SOCKS5 username. */
1320 char *auth_username;
1322 /** SOCKS5 password. */
1323 char *auth_password;
1325 /** Parent HTTP proxy hostname, or NULL for none. */
1328 /** Parent HTTP proxy port. */
1331 /** Next entry in the linked list. */
1332 struct forward_spec *next;
1336 /* Supported filter types */
1339 FT_CONTENT_FILTER = 0,
1340 FT_CLIENT_HEADER_FILTER = 1,
1341 FT_SERVER_HEADER_FILTER = 2,
1342 FT_CLIENT_HEADER_TAGGER = 3,
1343 FT_SERVER_HEADER_TAGGER = 4,
1344 FT_SUPPRESS_TAG = 5,
1345 FT_CLIENT_BODY_FILTER = 6,
1346 FT_CLIENT_BODY_TAGGER = 7,
1348 #ifdef FEATURE_EXTERNAL_FILTERS
1349 FT_EXTERNAL_CONTENT_FILTER = 9,
1351 FT_INVALID_FILTER = 42,
1354 #ifdef FEATURE_EXTERNAL_FILTERS
1355 #define MAX_FILTER_TYPES 10
1357 #define MAX_FILTER_TYPES 9
1361 * This struct represents one filter (one block) from
1362 * the re_filterfile. If there is more than one filter
1363 * in the file, the file will be represented by a
1364 * chained list of re_filterfile specs.
1366 struct re_filterfile_spec
1368 char *name; /**< Name from FILTER: statement in re_filterfile. */
1369 char *description; /**< Description from FILTER: statement in re_filterfile. */
1370 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1371 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1372 enum filter_type type; /**< Filter type (content, client-header, server-header). */
1373 int dynamic; /**< Set to one if the pattern might contain variables
1374 and has to be recompiled for every request. */
1375 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1381 #define ACL_PERMIT 1 /**< Accept connection request */
1382 #define ACL_DENY 2 /**< Reject connection request */
1385 * An IP address pattern. Used to specify networks in the ACL.
1387 struct access_control_addr
1390 struct sockaddr_storage addr; /* <The TCP address in network order. */
1391 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1393 unsigned long addr; /**< The IP address as an integer. */
1394 unsigned long mask; /**< The network mask as an integer. */
1395 unsigned long port; /**< The port number. */
1396 #endif /* HAVE_RFC2553 */
1400 * An access control list (ACL) entry.
1402 * This is a linked list.
1404 struct access_control_list
1406 struct access_control_addr src[1]; /**< Client IP address */
1407 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1409 short wildcard_dst; /** < dst address is wildcard */
1412 short action; /**< ACL_PERMIT or ACL_DENY */
1413 struct access_control_list *next; /**< The next entry in the ACL. */
1416 #endif /* def FEATURE_ACL */
1419 /** Maximum number of loaders (actions, re_filter, ...) */
1423 * This struct represents a client-spcific-tag and it's description
1425 struct client_tag_spec
1427 char *name; /**< Name from "client-specific-tag bla" directive */
1428 char *description; /**< Description from "client-specific-tag-description " directive */
1429 struct client_tag_spec *next; /**< The pointer for chaining. */
1432 /** configuration_spec::feature_flags: CGI actions editor. */
1433 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1435 /** configuration_spec::feature_flags: Web-based toggle. */
1436 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1438 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1439 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1441 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1442 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1444 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1445 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1447 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1448 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1450 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1451 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1453 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1454 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1456 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1457 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1459 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1460 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
1462 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1463 #define RUNTIME_FEATURE_COMPRESSION 1024U
1465 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1466 #define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
1468 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1469 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
1472 * Data loaded from the configuration file.
1474 * (Anomaly: toggle is still handled through a global, not this structure)
1476 struct configuration_spec
1481 /** Nonzero to enable multithreading. */
1484 /** Bitmask of features that can be controlled through the config file. */
1485 unsigned feature_flags;
1487 /** Nonzero if we need to bind() to the new port. */
1490 /** The log file name. */
1491 const char *logfile;
1493 /** The config file directory. */
1494 const char *confdir;
1496 /** The directory for customized CGI templates. */
1497 const char *templdir;
1499 /** "Cross-origin resource sharing" (CORS) allowed origin */
1500 const char *cors_allowed_origin;
1502 #ifdef FEATURE_EXTERNAL_FILTERS
1503 /** The template used to create temporary files. */
1504 const char *temporary_directory;
1507 /** The log file directory. */
1510 /** The full paths to the actions files. */
1511 const char *actions_file[MAX_AF_FILES];
1513 /** The short names of the actions files. */
1514 const char *actions_file_short[MAX_AF_FILES];
1516 /** The administrator's email address */
1517 char *admin_address;
1519 /** A URL with info on this proxy */
1520 char *proxy_info_url;
1522 /** URL to the user manual (on our website or local copy) */
1525 /** The file names of the pcre filter files. */
1526 const char *re_filterfile[MAX_AF_FILES];
1528 /** The short names of the pcre filter files. */
1529 const char *re_filterfile_short[MAX_AF_FILES];
1531 /**< List of ordered client header names. */
1532 struct list ordered_client_headers[1];
1534 /** The hostname to show on CGI pages, or NULL to use the real one. */
1535 const char *hostname;
1537 /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1538 const char *haddr[MAX_LISTENING_SOCKETS];
1540 /** Trusted referring site that can be used to reach CGI
1541 * pages that aren't marked as harmful.
1543 const char *trusted_cgi_referrer;
1545 /** Ports to bind to. Defaults to HADDR_PORT == 8118. */
1546 int hport[MAX_LISTENING_SOCKETS];
1548 /** Size limit for IOB */
1549 size_t buffer_limit;
1551 /** Size of the receive buffer */
1552 size_t receive_buffer_size;
1554 /** Use accf_http(4) if available */
1555 int enable_accept_filter;
1557 /** Backlog passed to listen() */
1560 #ifdef FEATURE_TRUST
1562 /** The file name of the trust file. */
1563 const char * trustfile;
1565 /** FIXME: DOCME: Document this. */
1566 struct list trust_info[1];
1568 /** FIXME: DOCME: Document this. */
1569 struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1571 #endif /* def FEATURE_TRUST */
1573 #ifdef FEATURE_CLIENT_TAGS
1574 struct client_tag_spec client_tags[1];
1576 /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1577 unsigned int client_tag_lifetime;
1578 #endif /* def FEATURE_CLIENT_TAGS */
1579 int trust_x_forwarded_for;
1583 /** The access control list (ACL). */
1584 struct access_control_list *acl;
1586 #endif /* def FEATURE_ACL */
1588 /** Information about parent proxies (forwarding). */
1589 struct forward_spec *forward;
1591 /** Number of retries in case a forwarded connection attempt fails */
1592 int forwarded_connect_retries;
1594 /** Maximum number of client connections. */
1595 int max_client_connections;
1597 /* Timeout when waiting on sockets for data to become available. */
1600 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1601 /* Maximum number of seconds after which an open connection will no longer be reused. */
1602 unsigned int keep_alive_timeout;
1604 /* Assumed server-side keep alive timeout if none is specified. */
1605 unsigned int default_server_timeout;
1608 #ifdef FEATURE_COMPRESSION
1609 int compression_level;
1612 /** All options from the config file, HTML-formatted. */
1615 /** The configuration file object. */
1616 struct file_list *config_file_list;
1618 /** List of loaders */
1619 int (*loaders[NLOADERS])(struct client_state *);
1621 #ifdef FEATURE_HTTPS_INSPECTION
1622 /** Password for proxy ca file **/
1625 /** Directory with files of ca **/
1628 /** Filename of ca certificate **/
1631 /** Filename of ca key **/
1634 /** Directory for saving certificates and keys for each webpage **/
1635 char *certificate_directory;
1637 /** Cipher list to use **/
1640 /** Filename of trusted CAs certificates **/
1641 char *trusted_cas_file;
1645 /** Calculates the number of elements in an array, using sizeof. */
1646 #define SZ(X) (sizeof(X) / sizeof(*X))
1648 /** The force load URL prefix. Not behind an ifdef because
1649 * it's always used for the show-status page. */
1650 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1652 #ifdef FEATURE_NO_GIFS
1653 /** The MIME type for images ("image/png" or "image/gif"). */
1654 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1656 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1657 #endif /* def FEATURE_NO_GIFS */
1664 /** URL for the Privoxy home page. */
1665 #define HOME_PAGE_URL "https://www.privoxy.org/"
1667 /** URL for the Privoxy user manual. */
1668 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1670 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1671 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1673 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1674 #define CONFIG_HELP_PREFIX "config.html#"
1677 * The "hosts" to intercept and display CGI pages.
1678 * First one is a hostname only, second one can specify host and path.
1681 * 1) Do not specify the http: prefix
1682 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1683 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1685 #define CGI_SITE_1_HOST "p.p"
1686 #define CGI_SITE_2_HOST "config.privoxy.org"
1687 #define CGI_SITE_2_PATH ""
1690 * The prefix for CGI pages. Written out in generated HTML.
1691 * INCLUDES the trailing slash.
1693 #ifdef FEATURE_HTTPS_INSPECTION
1694 #define CGI_PREFIX "//" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1695 #define CGI_PREFIX_HTTPS "https:" CGI_PREFIX
1697 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1699 #define CGI_PREFIX_HTTP "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1701 #endif /* ndef PROJECT_H_INCLUDED */