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-2014 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
48 #ifdef FEATURE_PTHREAD
50 typedef pthread_mutex_t privoxy_mutex_t;
55 typedef CRITICAL_SECTION privoxy_mutex_t;
58 #include "mbedtls/net_sockets.h"
59 #include "mbedtls/entropy.h"
60 #include "mbedtls/ctr_drbg.h"
62 #if defined(MBEDTLS_SSL_CACHE_C)
63 #include "mbedtls/ssl_cache.h"
67 * Macros for SSL structures
69 #define CERT_INFO_BUF_SIZE 4096
70 #define CERT_FILE_BUF_SIZE 16384
71 #define ISSUER_NAME_BUF_SIZE 2048
72 #define HASH_OF_HOST_BUF_SIZE 16
75 /* Need for struct sockaddr_storage */
79 # include <sys/socket.h>
82 # include <ws2tcpip.h>
83 typedef unsigned short in_port_t;
89 * Include appropriate regular expression libraries.
90 * Note that pcrs and pcre (native) are needed for cgi
91 * and are included anyway.
97 # ifdef PCRE_H_IN_SUBDIR
98 # include <pcre/pcre.h>
111 # include "pcreposix.h"
113 # ifdef PCRE_H_IN_SUBDIR
114 # include <pcre/pcreposix.h>
116 # include <pcreposix.h>
122 * I don't want to have to #include all this just for the declaration
123 * of SOCKET. However, it looks like we have to...
134 typedef SOCKET jb_socket;
136 #define JB_INVALID_SOCKET INVALID_SOCKET
138 #else /* ndef _WIN32 */
141 * The type used by sockets. On UNIX it's an int. Microsoft decided to
142 * make it an unsigned.
144 typedef int jb_socket;
147 * The error value used for variables of type jb_socket. On UNIX this
148 * is -1, however Microsoft decided to make socket handles unsigned, so
149 * they use a different value.
152 #define JB_INVALID_SOCKET (-1)
154 #endif /* ndef _WIN32 */
158 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
163 JB_ERR_OK = 0, /**< Success, no error */
164 JB_ERR_MEMORY = 1, /**< Out of memory */
165 JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
166 JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
167 JB_ERR_PARSE = 4, /**< Error parsing file */
168 JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
169 CGI actions editor. */
170 JB_ERR_COMPRESS = 6 /**< Error on decompression */
173 typedef enum privoxy_err jb_err;
176 * This macro is used to free a pointer that may be NULL.
177 * It also sets the variable to NULL after it's been freed.
178 * The parameter should be a simple variable without side effects.
180 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
184 * Macro definitions for platforms where isspace() and friends
185 * are macros that use their argument directly as an array index
186 * and thus better be positive. Supposedly that's the case on
187 * some unspecified Solaris versions.
188 * Note: Remember to #include <ctype.h> if you use these macros.
190 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
191 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
192 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
193 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
194 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
197 * Use for statically allocated buffers if you have no other choice.
198 * Remember to check the length of what you write into the buffer
199 * - we don't want any buffer overflows!
201 #define BUFFER_SIZE 5000
204 * Max length of CGI parameters (arbitrary limit).
206 #define CGI_PARAM_LEN_MAX 500U
209 * Buffer size for capturing struct hostent data in the
210 * gethostby(name|addr)_r library calls. Since we don't
211 * loop over gethostbyname_r, the buffer must be sufficient
212 * to accommodate multiple IN A RRs, as used in DNS round robin
213 * load balancing. W3C's wwwlib uses 1K, so that should be
214 * good enough for us, too.
217 * XXX: Temporary doubled, for some configurations
218 * 1K is still too small and we didn't get the
219 * real fix ready for inclusion.
221 #define HOSTENT_BUFFER_SIZE 2048
224 * Default TCP/IP address to listen on, as a string.
225 * Set to "127.0.0.1:8118".
227 #define HADDR_DEFAULT "127.0.0.1:8118"
230 /* Forward def for struct client_state */
231 struct configuration_spec;
235 * Entry in a linked list of strings.
240 * The string pointer. It must point to a dynamically malloc()ed
241 * string or be NULL for the list functions to work. In the latter
242 * case, just be careful next time you iterate through the list in
247 /** Next entry in the linked list, or NULL if no more. */
248 struct list_entry *next;
252 * A header for a linked list of strings.
256 /** First entry in the list, or NULL if the list is empty. */
257 struct list_entry *first;
259 /** Last entry in the list, or NULL if the list is empty. */
260 struct list_entry *last;
265 * An entry in a map. This is a name=value pair.
269 /** The key for the map. */
271 /** The value associated with that key. */
273 /** The next map entry, or NULL if none. */
274 struct map_entry *next;
278 * A map from a string to another string.
279 * This is used for the parameters passed in a HTTP GET request, and
280 * to store the exports when the CGI interface is filling in a template.
284 /** The first map entry, or NULL if the map is empty. */
285 struct map_entry *first;
286 /** The last map entry, or NULL if the map is empty. */
287 struct map_entry *last;
290 #ifdef FEATURE_HTTPS_INSPECTION
292 * Struct of attributes necessary for TLS/SSL connection
295 mbedtls_ssl_context ssl;
296 mbedtls_ssl_config conf;
297 mbedtls_net_context socket_fd;
298 mbedtls_x509_crt server_cert;
299 mbedtls_x509_crt ca_cert;
300 mbedtls_pk_context prim_key;
302 #if defined(MBEDTLS_SSL_CACHE_C)
303 mbedtls_ssl_cache_context cache;
305 } mbedtls_connection_attr;
309 * A HTTP request. This includes the method (GET, POST) and
312 * This is also used whenever we want to match a URL against a
313 * URL pattern. This always contains the URL to match, and never
314 * a URL pattern. (See struct url_spec).
318 char *cmd; /**< Whole command line: method, URL, Version */
319 char *ocmd; /**< Backup of original cmd for CLF logging */
320 char *gpc; /**< HTTP method: GET, POST, ... */
321 char *url; /**< The URL */
322 char *version; /**< Protocol version */
323 int status; /**< HTTP Status */
325 char *host; /**< Host part of URL */
326 int port; /**< Port of URL or 80 (default) */
327 char *path; /**< Path of URL */
328 char *hostport; /**< host[:port] */
329 int ssl; /**< Flag if protocol is https */
331 char *host_ip_addr_str; /**< String with dotted decimal representation
332 of host's IP. NULL before connect_to() */
334 #ifndef FEATURE_EXTENDED_HOST_PATTERNS
335 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
336 char **dvec; /**< List of pointers to the strings in dbuffer. */
337 int dcount; /**< How many parts to this domain? (length of dvec) */
338 #endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
340 #ifdef FEATURE_HTTPS_INSPECTION
341 int client_ssl; /**< Flag if we should communicate with client over ssl */
342 int server_ssl; /**< Flag if we should communicate with server over ssl */
343 unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
344 unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
349 #ifdef FEATURE_HTTPS_INSPECTION
351 * Struct for linked list containing certificates
353 typedef struct certs_chain {
354 char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
355 char file_buf[CERT_FILE_BUF_SIZE]; /* buffer for whole certificate - format to save in file */
356 struct certs_chain *next; /* next certificate in chain of trust */
361 * Reasons for generating a http_response instead of delivering
362 * the requested resource. Mostly ordered the way they are checked
382 * Response generated by CGI, blocker, or error handler
386 char *status; /**< HTTP status (string). */
387 struct list headers[1]; /**< List of header lines. */
388 char *head; /**< Formatted http response head. */
389 size_t head_length; /**< Length of http response head. */
390 char *body; /**< HTTP document body. */
391 size_t content_length; /**< Length of body, REQUIRED if binary body. */
392 int is_static; /**< Nonzero if the content will never change and
393 should be cached by the browser (e.g. images). */
394 enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
399 #ifdef FEATURE_EXTENDED_HOST_PATTERNS
400 regex_t *host_regex;/**< Regex for host matching */
402 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
403 char **dvec; /**< List of pointers to the strings in dbuffer. */
404 int dcount; /**< How many parts to this domain? (length of dvec) */
405 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
406 #endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
408 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
410 regex_t *preg; /**< Regex for matching path part */
414 * A URL or a tag pattern.
418 /** The string which was parsed to produce this pattern_spec.
419 Used for debugging or display only. */
424 struct url_spec url_spec;
428 unsigned int flags; /**< Bitmap with various pattern properties. */
432 * Constant for host part matching in URLs. If set, indicates that the start of
433 * the pattern must match the start of the URL. E.g. this is not set for the
434 * pattern ".example.com", so that it will match both "example.com" and
435 * "www.example.com". It is set for the pattern "example.com", which makes it
436 * match "example.com" only, not "www.example.com".
438 #define ANCHOR_LEFT 1
441 * Constant for host part matching in URLs. If set, indicates that the end of
442 * the pattern must match the end of the URL. E.g. this is not set for the
443 * pattern "ad.", so that it will match any host called "ad", irrespective
444 * of how many subdomains are in the fully-qualified domain name.
446 #define ANCHOR_RIGHT 2
448 /** Pattern spec bitmap: It's an URL pattern. */
449 #define PATTERN_SPEC_URL_PATTERN 0x00000001UL
451 /** Pattern spec bitmap: It's a TAG pattern. */
452 #define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
454 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
455 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
457 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
458 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
460 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
461 #define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
464 * An I/O buffer. Holds a string which can be appended to, and can have data
465 * removed from the beginning.
469 char *buf; /**< Start of buffer */
470 char *cur; /**< Start of relevant data */
471 char *eod; /**< End of relevant data */
472 size_t size; /**< Size as malloc()ed */
477 * Return the number of bytes in the I/O buffer associated with the passed
478 * I/O buffer. May be zero.
480 #define IOB_PEEK(IOB) ((IOB->cur > IOB->eod) ? (IOB->eod - IOB->cur) : 0)
483 /* Bits for csp->content_type bitmask: */
484 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
485 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
486 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
488 /* Although these are not, strictly speaking, content types
489 * (they are content encodings), it is simple to handle them
492 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
493 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
496 * Flag to signal that the server declared the content type,
497 * so we can differentiate between unknown and undeclared
500 #define CT_DECLARED 0x0040U
503 * The mask which includes all actions.
505 #define ACTION_MASK_ALL (~0UL)
508 * The most compatible set of actions - i.e. none.
510 #define ACTION_MOST_COMPATIBLE 0x00000000UL
512 /** Action bitmap: Block the request. */
513 #define ACTION_BLOCK 0x00000001UL
514 /** Action bitmap: Deanimate if it's a GIF. */
515 #define ACTION_DEANIMATE 0x00000002UL
516 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
517 #define ACTION_DOWNGRADE 0x00000004UL
518 /** Action bitmap: Fast redirects. */
519 #define ACTION_FAST_REDIRECTS 0x00000008UL
520 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
521 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
522 /** Action bitmap: Hide "From" header. */
523 #define ACTION_HIDE_FROM 0x00000020UL
524 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
525 #define ACTION_HIDE_REFERER 0x00000040UL
526 /** Action bitmap: Hide "User-Agent" and similar headers. */
527 #define ACTION_HIDE_USER_AGENT 0x00000080UL
528 /** Action bitmap: This is an image. */
529 #define ACTION_IMAGE 0x00000100UL
530 /** Action bitmap: Sets the image blocker. */
531 #define ACTION_IMAGE_BLOCKER 0x00000200UL
532 /** Action bitmap: Prevent compression. */
533 #define ACTION_NO_COMPRESSION 0x00000400UL
534 /** Action bitmap: Change cookies to session only cookies. */
535 #define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
536 /** Action bitmap: Block cookies coming from the client. */
537 #define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
538 /** Action bitmap: Block cookies coming from the server. */
539 #define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
540 /** Action bitmap: Override the forward settings in the config file */
541 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
542 /** Action bitmap: Block as empty document */
543 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
544 /** Action bitmap: Limit CONNECT requests to safe ports. */
545 #define ACTION_LIMIT_CONNECT 0x00010000UL
546 /** Action bitmap: Redirect request. */
547 #define ACTION_REDIRECT 0x00020000UL
548 /** Action bitmap: Crunch or modify "if-modified-since" header. */
549 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
550 /** Action bitmap: Overwrite Content-Type header. */
551 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
552 /** Action bitmap: Crunch specified server header. */
553 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
554 /** Action bitmap: Crunch specified client header */
555 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
556 /** Action bitmap: Enable text mode by force */
557 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
558 /** Action bitmap: Remove the "If-None-Match" header. */
559 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
560 /** Action bitmap: Enable content-disposition crunching */
561 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
562 /** Action bitmap: Replace or block Last-Modified header */
563 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
564 /** Action bitmap: Replace or block Accept-Language header */
565 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
566 /** Action bitmap: Limit the cookie lifetime */
567 #define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
568 /** Action bitmap: Delay writes */
569 #define ACTION_DELAY_RESPONSE 0x10000000UL
570 /** Action bitmap: Turn https inspection on */
571 #define ACTION_HTTPS_INSPECTION 0x20000000UL
572 /** Action bitmap: Turn certificates verification off */
573 #define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
575 /** Action string index: How to deanimate GIFs */
576 #define ACTION_STRING_DEANIMATE 0
577 /** Action string index: Replacement for "From:" header */
578 #define ACTION_STRING_FROM 1
579 /** Action string index: How to block images */
580 #define ACTION_STRING_IMAGE_BLOCKER 2
581 /** Action string index: Replacement for "Referer:" header */
582 #define ACTION_STRING_REFERER 3
583 /** Action string index: Replacement for "User-Agent:" header */
584 #define ACTION_STRING_USER_AGENT 4
585 /** Action string index: Legal CONNECT ports. */
586 #define ACTION_STRING_LIMIT_CONNECT 5
587 /** Action string index: Server headers containing this pattern are crunched*/
588 #define ACTION_STRING_SERVER_HEADER 6
589 /** Action string index: Client headers containing this pattern are crunched*/
590 #define ACTION_STRING_CLIENT_HEADER 7
591 /** Action string index: Replacement for the "Accept-Language:" header*/
592 #define ACTION_STRING_LANGUAGE 8
593 /** Action string index: Replacement for the "Content-Type:" header*/
594 #define ACTION_STRING_CONTENT_TYPE 9
595 /** Action string index: Replacement for the "content-disposition:" header*/
596 #define ACTION_STRING_CONTENT_DISPOSITION 10
597 /** Action string index: Replacement for the "If-Modified-Since:" header*/
598 #define ACTION_STRING_IF_MODIFIED_SINCE 11
599 /** Action string index: Replacement for the "Last-Modified:" header. */
600 #define ACTION_STRING_LAST_MODIFIED 12
601 /** Action string index: Redirect URL */
602 #define ACTION_STRING_REDIRECT 13
603 /** Action string index: Decode before redirect? */
604 #define ACTION_STRING_FAST_REDIRECTS 14
605 /** Action string index: Overriding forward rule. */
606 #define ACTION_STRING_FORWARD_OVERRIDE 15
607 /** Action string index: Reason for the block. */
608 #define ACTION_STRING_BLOCK 16
609 /** Action string index: what to do with the "X-Forwarded-For" header. */
610 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
611 /** Action string index: how many minutes cookies should be valid. */
612 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
613 /** Action string index: how many milliseconds writes should be delayed. */
614 #define ACTION_STRING_DELAY_RESPONSE 19
615 /** Number of string actions. */
616 #define ACTION_STRING_COUNT 20
619 /* To make the ugly hack in sed easier to understand */
620 #define CHECK_EVERY_HEADER_REMAINING 0
623 /** Index into current_action_spec::multi[] for headers to add. */
624 #define ACTION_MULTI_ADD_HEADER 0
625 /** Index into current_action_spec::multi[] for content filters to apply. */
626 #define ACTION_MULTI_FILTER 1
627 /** Index into current_action_spec::multi[] for server-header filters to apply. */
628 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
629 /** Index into current_action_spec::multi[] for client-header filters to apply. */
630 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
631 /** Index into current_action_spec::multi[] for client-header tags to apply. */
632 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
633 /** Index into current_action_spec::multi[] for server-header tags to apply. */
634 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
635 /** Number of multi-string actions. */
636 #define ACTION_MULTI_EXTERNAL_FILTER 6
637 /** Number of multi-string actions. */
638 #define ACTION_MULTI_COUNT 7
642 * This structure contains a list of actions to apply to a URL.
643 * It only contains positive instructions - no "-" options.
644 * It is not used to store the actions list itself, only for
645 * url_actions() to return the current values.
647 struct current_action_spec
649 /** Actions to apply. A bit set to "1" means perform the action. */
653 * Parameters for those actions that require them.
654 * Each entry is valid if & only if the corresponding entry in "flags" is
657 char * string[ACTION_STRING_COUNT];
659 /** Lists of strings for multi-string actions. */
660 struct list multi[ACTION_MULTI_COUNT][1];
665 * This structure contains a set of changes to actions.
666 * It can contain both positive and negative instructions.
667 * It is used to store an entry in the actions list.
671 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
672 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
675 * Parameters for those actions that require them.
676 * Each entry is valid if & only if the corresponding entry in "flags" is
679 char * string[ACTION_STRING_COUNT];
681 /** Lists of strings to remove, for multi-string actions. */
682 struct list multi_remove[ACTION_MULTI_COUNT][1];
684 /** If nonzero, remove *all* strings from the multi-string action. */
685 int multi_remove_all[ACTION_MULTI_COUNT];
687 /** Lists of strings to add, for multi-string actions. */
688 struct list multi_add[ACTION_MULTI_COUNT][1];
693 * This structure is used to store action files.
695 * It contains an URL or tag pattern, and the changes to
696 * the actions. It's a linked list and should only be
697 * free'd through unload_actions_file() unless there's
698 * only a single entry.
702 struct pattern_spec url[1]; /**< The URL or tag pattern. */
704 struct action_spec *action; /**< Action settings that might be shared with
705 the list entry before or after the current
706 one and can't be free'd willy nilly. */
708 struct url_actions *next; /**< Next action section in file, or NULL. */
711 enum forwarder_type {
712 /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
714 /**< original SOCKS 4 protocol */
716 /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
718 /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
720 /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
723 * Don't use a SOCKS server, forward to the specified webserver.
724 * The difference to SOCKS_NONE is that a request line without
731 * Structure to hold the server socket and the information
732 * required to make sure we only reuse the connection if
733 * the host and forwarding settings are the same.
735 struct reusable_connection
739 time_t timestamp; /* XXX: rename? */
742 time_t response_received;
745 * Number of seconds after which this
746 * connection will no longer be reused.
748 unsigned int keep_alive_timeout;
750 * Number of requests that were sent to this connection.
751 * This is currently only for debugging purposes.
753 unsigned int requests_sent_total;
757 enum forwarder_type forwarder_type;
766 * Flags for use in csp->flags
770 * Flag for csp->flags: Set if this client is processing data.
771 * Cleared when the thread associated with this structure dies.
773 #define CSP_FLAG_ACTIVE 0x01U
776 * Flag for csp->flags: Set if the server's reply is in "chunked"
779 #define CSP_FLAG_CHUNKED 0x02U
782 * Flag for csp->flags: Set if this request was enforced, although it would
783 * normally have been blocked.
785 #define CSP_FLAG_FORCED 0x04U
788 * Flag for csp->flags: Set if any modification to the body was done.
790 #define CSP_FLAG_MODIFIED 0x08U
793 * Flag for csp->flags: Set if request was blocked.
795 #define CSP_FLAG_REJECTED 0x10U
798 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
800 #define CSP_FLAG_TOGGLED_ON 0x20U
803 * Flag for csp->flags: Set if an acceptable Connection header
804 * has already been set by the client.
806 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
809 * Flag for csp->flags: Set if an acceptable Connection header
810 * has already been set by the server.
812 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
815 * Flag for csp->flags: Signals header parsers whether they
816 * are parsing server or client headers.
818 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
821 * Flag for csp->flags: Set if adding the Host: header
824 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
827 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
828 * XXX: As we now have tags we might as well ditch this.
830 #define CSP_FLAG_NO_FILTERING 0x00000400U
833 * Flag for csp->flags: Set the client IP has appended to
834 * an already existing X-Forwarded-For header in which case
835 * no new header has to be generated.
837 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
840 * Flag for csp->flags: Set if the server wants to keep
841 * the connection alive.
843 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
846 * Flag for csp->flags: Set if the server specified the
849 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
852 * Flag for csp->flags: Set if we know the content length,
853 * either because the server set it, or we figured it out
856 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
859 * Flag for csp->flags: Set if the client wants to keep
860 * the connection alive.
862 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
865 * Flag for csp->flags: Set if we think we got the whole
866 * client request and shouldn't read any additional data
867 * coming from the client until the current request has
870 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
873 * Flag for csp->flags: Set if the server promised us to
874 * keep the connection open for a known number of seconds.
876 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
879 * Flag for csp->flags: Set if we think we can't reuse
880 * the server socket. XXX: It's also set after sabotaging
881 * pipelining attempts which is somewhat inconsistent with
884 #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
887 * Flag for csp->flags: Set if the Proxy-Connection header
888 * is among the server headers.
890 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
893 * Flag for csp->flags: Set if the client reused its connection.
895 #define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
898 * Flag for csp->flags: Set if the supports deflate compression.
900 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
903 * Flag for csp->flags: Set if the content has been deflated by Privoxy
905 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
908 * Flag for csp->flags: Set if we already read (parts of)
909 * a pipelined request in which case the client obviously
910 * isn't done talking.
912 #define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
915 * Flag for csp->flags: Set if the client body is chunk-encoded
917 #define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
920 * Flag for csp->flags: Set if the client set the Expect header
922 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
925 * Flag for csp->flags: Set if we answered the request ourselves.
927 #define CSP_FLAG_CRUNCHED 0x04000000U
931 * Flag for csp->flags: Set if we are working with fuzzed input
933 #define CSP_FLAG_FUZZED_INPUT 0x08000000U
937 * Flags for use in return codes of child processes
941 * Flag for process return code: Set if exiting process has been toggled
942 * during its lifetime.
944 #define RC_FLAG_TOGGLED 0x10
947 * Flag for process return code: Set if exiting process has blocked its
950 #define RC_FLAG_BLOCKED 0x20
953 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
956 #define MAX_AF_FILES 100
959 * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
962 #define MAX_LISTENING_SOCKETS 10
965 * The state of a Privoxy processing thread.
969 /** The proxy's configuration */
970 struct configuration_spec * config;
972 /** The actions to perform on the current request */
973 struct current_action_spec action[1];
975 /** socket to talk to client (web browser) */
978 /** Number of requests received on the client socket. */
979 unsigned int requests_received_total;
981 /** current connection to the server (may go through a proxy) */
982 struct reusable_connection server_connection;
984 /** Multi-purpose flag container, see CSP_FLAG_* above */
987 /** Client PC's IP address, as reported by the accept() function.
991 /** Client PC's TCP address, as reported by the accept() function.
993 struct sockaddr_storage tcp_addr;
995 /** Client PC's IP address, as reported by the accept() function.
997 unsigned long ip_addr_long;
998 #endif /* def HAVE_RFC2553 */
1000 /** The host name and port (as a string of the form '<hostname>:<port>')
1001 of the server socket to which the client connected. */
1002 char *listen_addr_str;
1004 /** The URL that was requested */
1005 struct http_request http[1];
1008 * The final forwarding settings.
1009 * XXX: Currently this is only used for forward-override,
1010 * so we can free the space in sweep.
1012 struct forward_spec * fwd;
1014 /** An I/O buffer used for buffering data read from the server */
1015 /* XXX: should be renamed to server_iob */
1018 #ifdef FEATURE_HTTPS_INSPECTION
1019 mbedtls_connection_attr mbedtls_server_attr; /* attributes for connection to server */
1020 mbedtls_connection_attr mbedtls_client_attr; /* attributes for connection to client */
1023 /** An I/O buffer used for buffering data read from the client */
1024 struct iob client_iob[1];
1026 /** Buffer used to briefly store data read from the network
1027 * before forwarding or processing it.
1029 char *receive_buffer;
1030 size_t receive_buffer_size;
1032 /** List of all headers for this request */
1033 struct list headers[1];
1035 #ifdef FEATURE_HTTPS_INSPECTION
1036 /** List of all encrypted headers for this request */
1037 struct list https_headers[1];
1040 /** List of all tags that apply to this request */
1041 struct list tags[1];
1043 #ifdef FEATURE_CLIENT_TAGS
1044 /** List of all tags that apply to this client (assigned based on address) */
1045 struct list client_tags[1];
1046 /** The address of the client the request (presumably) came from.
1047 * Either the address returned by accept(), or the address provided
1048 * with the X-Forwarded-For header, provided Privoxy has been configured
1051 char *client_address;
1054 /** MIME-Type key, see CT_* above */
1055 unsigned int content_type;
1057 /** Actions files associated with this client */
1058 struct file_list *actions_list[MAX_AF_FILES];
1060 /** pcrs job files. */
1061 struct file_list *rlist[MAX_AF_FILES];
1063 /** Length after content modification. */
1064 unsigned long long content_length;
1066 /* XXX: is this the right location? */
1068 /** Expected length of content after which we
1069 * should stop reading from the server socket.
1071 unsigned long long expected_content_length;
1073 /** Expected length of content after which we
1074 * should stop reading from the client socket.
1076 unsigned long long expected_client_content_length;
1078 #ifdef FEATURE_TRUST
1081 struct file_list *tlist;
1083 #endif /* def FEATURE_TRUST */
1086 * Failure reason to embedded in the CGI error page,
1087 * or NULL. Currently only used for socks errors.
1089 char *error_message;
1091 #ifdef FEATURE_HTTPS_INSPECTION
1092 /* Result of server certificate verification */
1093 uint32_t server_cert_verification_result;
1095 /* Flag for certificate validity checking */
1096 int dont_verify_certificate;
1099 * Flags if SSL connection with server or client is opened.
1100 * Thanks to this flags, we can call function to close both connections
1101 * and we don't have to care about more details.
1103 int ssl_with_server_is_opened;
1104 int ssl_with_client_is_opened;
1107 * Server certificate chain of trust including strings with certificates
1108 * information and string with whole certificate file
1110 struct certs_chain server_certs_chain;
1115 * List of client states so the main thread can keep
1116 * track of them and garbage collect their resources.
1118 struct client_states
1120 struct client_states *next;
1121 struct client_state csp;
1125 * A function to add a header
1127 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1130 * A function to process a header
1132 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1136 * List of available CGI functions.
1138 struct cgi_dispatcher
1140 /** The URL of the CGI, relative to the CGI root. */
1141 const char * const name;
1143 /** The handler function for the CGI */
1144 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1146 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1147 const char * const description;
1149 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1155 * A data file used by Privoxy. Kept in a linked list.
1160 * This is a pointer to the data structures associated with the file.
1161 * Read-only once the structure has been created.
1166 * The unloader function.
1167 * Normally NULL. When we are finished with file (i.e. when we have
1168 * loaded a new one), set to a pointer to an unloader function.
1169 * Unloader will be called by sweep() (called from main loop) when
1170 * all clients using this file are done. This prevents threading
1173 void (*unloader)(void *);
1176 * Used internally by sweep(). Do not access from elsewhere.
1181 * File last-modified time, so we can check if file has been changed.
1182 * Read-only once the structure has been created.
1184 time_t lastmodified;
1187 * The full filename.
1192 * Pointer to next entry in the linked list of all "file_list"s.
1193 * This linked list is so that sweep() can navigate it.
1194 * Since sweep() can remove items from the list, we must be careful
1195 * to only access this value from main thread (when we know sweep
1196 * won't be running).
1198 struct file_list *next;
1202 #ifdef FEATURE_TRUST
1205 * The format of a trust file when loaded into memory.
1209 struct pattern_spec url[1]; /**< The URL pattern */
1210 int reject; /**< FIXME: Please document this! */
1211 struct block_spec *next; /**< Next entry in linked list */
1215 * Arbitrary limit for the number of trusted referrers.
1217 #define MAX_TRUSTED_REFERRERS 512
1219 #endif /* def FEATURE_TRUST */
1222 * How to forward a connection to a parent proxy.
1226 /** URL pattern that this forward_spec is for. */
1227 struct pattern_spec url[1];
1229 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1230 enum forwarder_type type;
1232 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1235 /** SOCKS server port. */
1238 /** SOCKS5 username. */
1239 char *auth_username;
1241 /** SOCKS5 password. */
1242 char *auth_password;
1244 /** Parent HTTP proxy hostname, or NULL for none. */
1247 /** Parent HTTP proxy port. */
1250 /** Next entry in the linked list. */
1251 struct forward_spec *next;
1255 /* Supported filter types */
1258 FT_CONTENT_FILTER = 0,
1259 FT_CLIENT_HEADER_FILTER = 1,
1260 FT_SERVER_HEADER_FILTER = 2,
1261 FT_CLIENT_HEADER_TAGGER = 3,
1262 FT_SERVER_HEADER_TAGGER = 4,
1263 #ifdef FEATURE_EXTERNAL_FILTERS
1264 FT_EXTERNAL_CONTENT_FILTER = 5,
1266 FT_INVALID_FILTER = 42,
1269 #ifdef FEATURE_EXTERNAL_FILTERS
1270 #define MAX_FILTER_TYPES 6
1272 #define MAX_FILTER_TYPES 5
1276 * This struct represents one filter (one block) from
1277 * the re_filterfile. If there is more than one filter
1278 * in the file, the file will be represented by a
1279 * chained list of re_filterfile specs.
1281 struct re_filterfile_spec
1283 char *name; /**< Name from FILTER: statement in re_filterfile. */
1284 char *description; /**< Description from FILTER: statement in re_filterfile. */
1285 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1286 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1287 enum filter_type type; /**< Filter type (content, client-header, server-header). */
1288 int dynamic; /**< Set to one if the pattern might contain variables
1289 and has to be recompiled for every request. */
1290 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1296 #define ACL_PERMIT 1 /**< Accept connection request */
1297 #define ACL_DENY 2 /**< Reject connection request */
1300 * An IP address pattern. Used to specify networks in the ACL.
1302 struct access_control_addr
1305 struct sockaddr_storage addr; /* <The TCP address in network order. */
1306 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1308 unsigned long addr; /**< The IP address as an integer. */
1309 unsigned long mask; /**< The network mask as an integer. */
1310 unsigned long port; /**< The port number. */
1311 #endif /* HAVE_RFC2553 */
1315 * An access control list (ACL) entry.
1317 * This is a linked list.
1319 struct access_control_list
1321 struct access_control_addr src[1]; /**< Client IP address */
1322 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1324 int wildcard_dst; /** < dst address is wildcard */
1327 short action; /**< ACL_PERMIT or ACL_DENY */
1328 struct access_control_list *next; /**< The next entry in the ACL. */
1331 #endif /* def FEATURE_ACL */
1334 /** Maximum number of loaders (actions, re_filter, ...) */
1338 * This struct represents a client-spcific-tag and it's description
1340 struct client_tag_spec
1342 char *name; /**< Name from "client-specific-tag bla" directive */
1343 char *description; /**< Description from "client-specific-tag-description " directive */
1344 struct client_tag_spec *next; /**< The pointer for chaining. */
1347 /** configuration_spec::feature_flags: CGI actions editor. */
1348 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1350 /** configuration_spec::feature_flags: Web-based toggle. */
1351 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1353 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1354 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1356 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1357 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1359 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1360 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1362 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1363 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1365 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1366 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1368 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1369 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1371 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1372 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1374 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1375 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
1377 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1378 #define RUNTIME_FEATURE_COMPRESSION 1024U
1380 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1381 #define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
1383 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1384 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
1387 * Data loaded from the configuration file.
1389 * (Anomaly: toggle is still handled through a global, not this structure)
1391 struct configuration_spec
1396 /** Nonzero to enable multithreading. */
1399 /** Bitmask of features that can be controlled through the config file. */
1400 unsigned feature_flags;
1402 /** The log file name. */
1403 const char *logfile;
1405 /** The config file directory. */
1406 const char *confdir;
1408 /** The directory for customized CGI templates. */
1409 const char *templdir;
1411 /** "Cross-origin resource sharing" (CORS) allowed origin */
1412 const char *cors_allowed_origin;
1414 #ifdef FEATURE_EXTERNAL_FILTERS
1415 /** The template used to create temporary files. */
1416 const char *temporary_directory;
1419 /** The log file directory. */
1422 /** The full paths to the actions files. */
1423 const char *actions_file[MAX_AF_FILES];
1425 /** The short names of the actions files. */
1426 const char *actions_file_short[MAX_AF_FILES];
1428 /** The administrator's email address */
1429 char *admin_address;
1431 /** A URL with info on this proxy */
1432 char *proxy_info_url;
1434 /** URL to the user manual (on our website or local copy) */
1437 /** The file names of the pcre filter files. */
1438 const char *re_filterfile[MAX_AF_FILES];
1440 /** The short names of the pcre filter files. */
1441 const char *re_filterfile_short[MAX_AF_FILES];
1443 /**< List of ordered client header names. */
1444 struct list ordered_client_headers[1];
1446 /** The hostname to show on CGI pages, or NULL to use the real one. */
1447 const char *hostname;
1449 /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1450 const char *haddr[MAX_LISTENING_SOCKETS];
1452 /** Trusted referring site that can be used to reach CGI
1453 * pages that aren't marked as harmful.
1455 const char *trusted_cgi_referrer;
1457 /** Ports to bind to. Defaults to HADDR_PORT == 8118. */
1458 int hport[MAX_LISTENING_SOCKETS];
1460 /** Size limit for IOB */
1461 size_t buffer_limit;
1463 /** Size of the receive buffer */
1464 size_t receive_buffer_size;
1466 /** Use accf_http(4) if available */
1467 int enable_accept_filter;
1469 /** Backlog passed to listen() */
1472 #ifdef FEATURE_TRUST
1474 /** The file name of the trust file. */
1475 const char * trustfile;
1477 /** FIXME: DOCME: Document this. */
1478 struct list trust_info[1];
1480 /** FIXME: DOCME: Document this. */
1481 struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1483 #endif /* def FEATURE_TRUST */
1485 #ifdef FEATURE_CLIENT_TAGS
1486 struct client_tag_spec client_tags[1];
1488 /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1489 unsigned int client_tag_lifetime;
1490 #endif /* def FEATURE_CLIENT_TAGS */
1491 int trust_x_forwarded_for;
1495 /** The access control list (ACL). */
1496 struct access_control_list *acl;
1498 #endif /* def FEATURE_ACL */
1500 /** Information about parent proxies (forwarding). */
1501 struct forward_spec *forward;
1503 /** Number of retries in case a forwarded connection attempt fails */
1504 int forwarded_connect_retries;
1506 /** Maximum number of client connections. */
1507 int max_client_connections;
1509 /* Timeout when waiting on sockets for data to become available. */
1512 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1513 /* Maximum number of seconds after which an open connection will no longer be reused. */
1514 unsigned int keep_alive_timeout;
1516 /* Assumed server-side keep alive timeout if none is specified. */
1517 unsigned int default_server_timeout;
1520 #ifdef FEATURE_COMPRESSION
1521 int compression_level;
1524 /** All options from the config file, HTML-formatted. */
1527 /** The configuration file object. */
1528 struct file_list *config_file_list;
1530 /** List of loaders */
1531 int (*loaders[NLOADERS])(struct client_state *);
1533 /** Nonzero if we need to bind() to the new port. */
1536 #ifdef FEATURE_HTTPS_INSPECTION
1537 /** Password for proxy ca file **/
1540 /** Directory with files of ca **/
1543 /** Filename of ca certificate **/
1544 char * ca_cert_file;
1546 /** Filename of ca key **/
1549 /** Directory for saving certificates and keys for each webpage **/
1550 char *certificate_directory;
1552 /** Filename of trusted CAs certificates **/
1553 char * trusted_cas_file;
1557 /** Calculates the number of elements in an array, using sizeof. */
1558 #define SZ(X) (sizeof(X) / sizeof(*X))
1560 /** The force load URL prefix. Not behind an ifdef because
1561 * it's always used for the show-status page. */
1562 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1564 #ifdef FEATURE_NO_GIFS
1565 /** The MIME type for images ("image/png" or "image/gif"). */
1566 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1568 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1569 #endif /* def FEATURE_NO_GIFS */
1576 /** URL for the Privoxy home page. */
1577 #define HOME_PAGE_URL "https://www.privoxy.org/"
1579 /** URL for the Privoxy user manual. */
1580 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1582 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1583 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1585 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1586 #define CONFIG_HELP_PREFIX "config.html#"
1589 * The "hosts" to intercept and display CGI pages.
1590 * First one is a hostname only, second one can specify host and path.
1593 * 1) Do not specify the http: prefix
1594 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1595 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1597 #define CGI_SITE_1_HOST "p.p"
1598 #define CGI_SITE_2_HOST "config.privoxy.org"
1599 #define CGI_SITE_2_PATH ""
1602 * The prefix for CGI pages. Written out in generated HTML.
1603 * INCLUDES the trailing slash.
1605 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1607 #endif /* ndef PROJECT_H_INCLUDED */