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
49 * Macros for SSL structures
51 #define CERT_INFO_BUF_SIZE 4096
52 #define CERT_FILE_BUF_SIZE 16384
53 #define ISSUER_NAME_BUF_SIZE 2048
54 #define HASH_OF_HOST_BUF_SIZE 16
55 #endif /* FEATURE_HTTPS_INSPECTION */
57 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
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"
65 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
67 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
71 #undef X509_EXTENSIONS
73 #include <openssl/ssl.h>
74 #include <openssl/bio.h>
75 #include <openssl/err.h>
76 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
78 /* Need for struct sockaddr_storage */
82 # include <sys/socket.h>
85 # include <ws2tcpip.h>
86 typedef unsigned short in_port_t;
92 * Include appropriate regular expression libraries.
93 * Note that pcrs and pcre (native) are needed for cgi
94 * and are included anyway.
100 # ifdef PCRE_H_IN_SUBDIR
101 # include <pcre/pcre.h>
114 # include "pcreposix.h"
116 # ifdef PCRE_H_IN_SUBDIR
117 # include <pcre/pcreposix.h>
119 # include <pcreposix.h>
125 * I don't want to have to #include all this just for the declaration
126 * of SOCKET. However, it looks like we have to...
137 typedef SOCKET jb_socket;
139 #define JB_INVALID_SOCKET INVALID_SOCKET
141 #else /* ndef _WIN32 */
144 * The type used by sockets. On UNIX it's an int. Microsoft decided to
145 * make it an unsigned.
147 typedef int jb_socket;
150 * The error value used for variables of type jb_socket. On UNIX this
151 * is -1, however Microsoft decided to make socket handles unsigned, so
152 * they use a different value.
155 #define JB_INVALID_SOCKET (-1)
157 #endif /* ndef _WIN32 */
161 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
166 JB_ERR_OK = 0, /**< Success, no error */
167 JB_ERR_MEMORY = 1, /**< Out of memory */
168 JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
169 JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
170 JB_ERR_PARSE = 4, /**< Error parsing file */
171 JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
172 CGI actions editor. */
173 JB_ERR_COMPRESS = 6 /**< Error on decompression */
176 typedef enum privoxy_err jb_err;
179 * This macro is used to free a pointer that may be NULL.
180 * It also sets the variable to NULL after it's been freed.
181 * The parameter should be a simple variable without side effects.
183 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
187 * Macro definitions for platforms where isspace() and friends
188 * are macros that use their argument directly as an array index
189 * and thus better be positive. Supposedly that's the case on
190 * some unspecified Solaris versions.
191 * Note: Remember to #include <ctype.h> if you use these macros.
193 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
194 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
195 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
196 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
197 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
200 * Use for statically allocated buffers if you have no other choice.
201 * Remember to check the length of what you write into the buffer
202 * - we don't want any buffer overflows!
204 #define BUFFER_SIZE 5000
207 * Max length of CGI parameters (arbitrary limit).
209 #define CGI_PARAM_LEN_MAX 500U
212 * Buffer size for capturing struct hostent data in the
213 * gethostby(name|addr)_r library calls. Since we don't
214 * loop over gethostbyname_r, the buffer must be sufficient
215 * to accommodate multiple IN A RRs, as used in DNS round robin
216 * load balancing. W3C's wwwlib uses 1K, so that should be
217 * good enough for us, too.
220 * XXX: Temporary doubled, for some configurations
221 * 1K is still too small and we didn't get the
222 * real fix ready for inclusion.
224 #define HOSTENT_BUFFER_SIZE 2048
227 * Default TCP/IP address to listen on, as a string.
228 * Set to "127.0.0.1:8118".
230 #define HADDR_DEFAULT "127.0.0.1:8118"
233 /* Forward def for struct client_state */
234 struct configuration_spec;
238 * Entry in a linked list of strings.
243 * The string pointer. It must point to a dynamically malloc()ed
244 * string or be NULL for the list functions to work. In the latter
245 * case, just be careful next time you iterate through the list in
250 /** Next entry in the linked list, or NULL if no more. */
251 struct list_entry *next;
255 * A header for a linked list of strings.
259 /** First entry in the list, or NULL if the list is empty. */
260 struct list_entry *first;
262 /** Last entry in the list, or NULL if the list is empty. */
263 struct list_entry *last;
268 * An entry in a map. This is a name=value pair.
272 /** The key for the map. */
274 /** The value associated with that key. */
276 /** The next map entry, or NULL if none. */
277 struct map_entry *next;
281 * A map from a string to another string.
282 * This is used for the parameters passed in a HTTP GET request, and
283 * to store the exports when the CGI interface is filling in a template.
287 /** The first map entry, or NULL if the map is empty. */
288 struct map_entry *first;
289 /** The last map entry, or NULL if the map is empty. */
290 struct map_entry *last;
293 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
295 * Struct of attributes necessary for TLS/SSL connection
298 mbedtls_ssl_context ssl;
299 mbedtls_ssl_config conf;
300 mbedtls_net_context socket_fd;
301 mbedtls_x509_crt server_cert;
302 mbedtls_x509_crt ca_cert;
303 mbedtls_pk_context prim_key;
304 int *ciphersuites_list;
306 #if defined(MBEDTLS_SSL_CACHE_C)
307 mbedtls_ssl_cache_context cache;
309 } mbedtls_connection_attr;
310 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
312 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
314 * Struct of attributes necessary for TLS/SSL connection
319 } openssl_connection_attr;
320 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
322 * A HTTP request. This includes the method (GET, POST) and
325 * This is also used whenever we want to match a URL against a
326 * URL pattern. This always contains the URL to match, and never
327 * a URL pattern. (See struct url_spec).
331 char *cmd; /**< Whole command line: method, URL, Version */
332 char *ocmd; /**< Backup of original cmd for CLF logging */
333 char *gpc; /**< HTTP method: GET, POST, ... */
334 char *url; /**< The URL */
335 char *version; /**< Protocol version */
336 int status; /**< HTTP Status */
338 int port; /**< Port of URL or 80 (default) */
339 char *host; /**< Host part of URL */
340 char *path; /**< Path of URL */
341 char *hostport; /**< host[:port] */
343 char *host_ip_addr_str; /**< String with dotted decimal representation
344 of host's IP. NULL before connect_to() */
346 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
347 char **dvec; /**< List of pointers to the strings in dbuffer. */
348 int dcount; /**< How many parts to this domain? (length of dvec) */
350 #ifdef FEATURE_HTTPS_INSPECTION
351 int client_ssl; /**< Flag if we should communicate with client over ssl */
352 int server_ssl; /**< Flag if we should communicate with server over ssl */
353 unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
354 unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
356 short int ssl; /**< Flag if protocol is https */
360 #ifdef FEATURE_HTTPS_INSPECTION
362 * Struct for linked list containing certificates
364 typedef struct certs_chain {
365 char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
366 char file_buf[CERT_FILE_BUF_SIZE]; /* buffer for whole certificate - format to save in file */
367 struct certs_chain *next; /* next certificate in chain of trust */
372 * Reasons for generating a http_response instead of delivering
373 * the requested resource. Mostly ordered the way they are checked
393 * Response generated by CGI, blocker, or error handler
397 char *status; /**< HTTP status (string). */
398 struct list headers[1]; /**< List of header lines. */
399 char *head; /**< Formatted http response head. */
400 size_t head_length; /**< Length of http response head. */
401 char *body; /**< HTTP document body. */
402 size_t content_length; /**< Length of body, REQUIRED if binary body. */
403 int is_static; /**< Nonzero if the content will never change and
404 should be cached by the browser (e.g. images). */
405 enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
410 #ifdef FEATURE_PCRE_HOST_PATTERNS
411 regex_t *host_regex;/**< Regex for host matching */
412 enum host_regex_type { VANILLA_HOST_PATTERN, PCRE_HOST_PATTERN } host_regex_type;
413 #endif /* defined FEATURE_PCRE_HOST_PATTERNS */
414 int dcount; /**< How many parts to this domain? (length of dvec) */
415 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
416 char **dvec; /**< List of pointers to the strings in dbuffer. */
417 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
419 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
421 regex_t *preg; /**< Regex for matching path part */
425 * A URL or a tag pattern.
429 /** The string which was parsed to produce this pattern_spec.
430 Used for debugging or display only. */
435 struct url_spec url_spec;
439 unsigned int flags; /**< Bitmap with various pattern properties. */
443 * Constant for host part matching in URLs. If set, indicates that the start of
444 * the pattern must match the start of the URL. E.g. this is not set for the
445 * pattern ".example.com", so that it will match both "example.com" and
446 * "www.example.com". It is set for the pattern "example.com", which makes it
447 * match "example.com" only, not "www.example.com".
449 #define ANCHOR_LEFT 1
452 * Constant for host part matching in URLs. If set, indicates that the end of
453 * the pattern must match the end of the URL. E.g. this is not set for the
454 * pattern "ad.", so that it will match any host called "ad", irrespective
455 * of how many subdomains are in the fully-qualified domain name.
457 #define ANCHOR_RIGHT 2
459 /** Pattern spec bitmap: It's an URL pattern. */
460 #define PATTERN_SPEC_URL_PATTERN 0x00000001UL
462 /** Pattern spec bitmap: It's a TAG pattern. */
463 #define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
465 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
466 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
468 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
469 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
471 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
472 #define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
475 * An I/O buffer. Holds a string which can be appended to, and can have data
476 * removed from the beginning.
480 char *buf; /**< Start of buffer */
481 char *cur; /**< Start of relevant data */
482 char *eod; /**< End of relevant data */
483 size_t size; /**< Size as malloc()ed */
487 /* Bits for csp->content_type bitmask: */
488 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
489 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
490 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
492 /* Although these are not, strictly speaking, content types
493 * (they are content encodings), it is simple to handle them
496 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
497 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
498 #define CT_BROTLI 0x0040U /**< Brotli-compressed data. */
501 * Flag to signal that the server declared the content type,
502 * so we can differentiate between unknown and undeclared
505 #define CT_DECLARED 0x0080U
508 * The mask which includes all actions.
510 #define ACTION_MASK_ALL (~0UL)
513 * The most compatible set of actions - i.e. none.
515 #define ACTION_MOST_COMPATIBLE 0x00000000UL
517 /** Action bitmap: Block the request. */
518 #define ACTION_BLOCK 0x00000001UL
519 /** Action bitmap: Deanimate if it's a GIF. */
520 #define ACTION_DEANIMATE 0x00000002UL
521 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
522 #define ACTION_DOWNGRADE 0x00000004UL
523 /** Action bitmap: Fast redirects. */
524 #define ACTION_FAST_REDIRECTS 0x00000008UL
525 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
526 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
527 /** Action bitmap: Hide "From" header. */
528 #define ACTION_HIDE_FROM 0x00000020UL
529 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
530 #define ACTION_HIDE_REFERER 0x00000040UL
531 /** Action bitmap: Hide "User-Agent" and similar headers. */
532 #define ACTION_HIDE_USER_AGENT 0x00000080UL
533 /** Action bitmap: This is an image. */
534 #define ACTION_IMAGE 0x00000100UL
535 /** Action bitmap: Sets the image blocker. */
536 #define ACTION_IMAGE_BLOCKER 0x00000200UL
537 /** Action bitmap: Prevent compression. */
538 #define ACTION_NO_COMPRESSION 0x00000400UL
539 /** Action bitmap: Change cookies to session only cookies. */
540 #define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
541 /** Action bitmap: Block cookies coming from the client. */
542 #define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
543 /** Action bitmap: Block cookies coming from the server. */
544 #define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
545 /** Action bitmap: Override the forward settings in the config file */
546 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
547 /** Action bitmap: Block as empty document */
548 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
549 /** Action bitmap: Limit CONNECT requests to safe ports. */
550 #define ACTION_LIMIT_CONNECT 0x00010000UL
551 /** Action bitmap: Redirect request. */
552 #define ACTION_REDIRECT 0x00020000UL
553 /** Action bitmap: Crunch or modify "if-modified-since" header. */
554 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
555 /** Action bitmap: Overwrite Content-Type header. */
556 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
557 /** Action bitmap: Crunch specified server header. */
558 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
559 /** Action bitmap: Crunch specified client header */
560 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
561 /** Action bitmap: Enable text mode by force */
562 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
563 /** Action bitmap: Remove the "If-None-Match" header. */
564 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
565 /** Action bitmap: Enable content-disposition crunching */
566 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
567 /** Action bitmap: Replace or block Last-Modified header */
568 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
569 /** Action bitmap: Replace or block Accept-Language header */
570 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
571 /** Action bitmap: Limit the cookie lifetime */
572 #define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
573 /** Action bitmap: Delay writes */
574 #define ACTION_DELAY_RESPONSE 0x10000000UL
575 /** Action bitmap: Turn https inspection on */
576 #define ACTION_HTTPS_INSPECTION 0x20000000UL
577 /** Action bitmap: Turn certificates verification off */
578 #define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
580 /** Action string index: How to deanimate GIFs */
581 #define ACTION_STRING_DEANIMATE 0
582 /** Action string index: Replacement for "From:" header */
583 #define ACTION_STRING_FROM 1
584 /** Action string index: How to block images */
585 #define ACTION_STRING_IMAGE_BLOCKER 2
586 /** Action string index: Replacement for "Referer:" header */
587 #define ACTION_STRING_REFERER 3
588 /** Action string index: Replacement for "User-Agent:" header */
589 #define ACTION_STRING_USER_AGENT 4
590 /** Action string index: Legal CONNECT ports. */
591 #define ACTION_STRING_LIMIT_CONNECT 5
592 /** Action string index: Server headers containing this pattern are crunched*/
593 #define ACTION_STRING_SERVER_HEADER 6
594 /** Action string index: Client headers containing this pattern are crunched*/
595 #define ACTION_STRING_CLIENT_HEADER 7
596 /** Action string index: Replacement for the "Accept-Language:" header*/
597 #define ACTION_STRING_LANGUAGE 8
598 /** Action string index: Replacement for the "Content-Type:" header*/
599 #define ACTION_STRING_CONTENT_TYPE 9
600 /** Action string index: Replacement for the "content-disposition:" header*/
601 #define ACTION_STRING_CONTENT_DISPOSITION 10
602 /** Action string index: Replacement for the "If-Modified-Since:" header*/
603 #define ACTION_STRING_IF_MODIFIED_SINCE 11
604 /** Action string index: Replacement for the "Last-Modified:" header. */
605 #define ACTION_STRING_LAST_MODIFIED 12
606 /** Action string index: Redirect URL */
607 #define ACTION_STRING_REDIRECT 13
608 /** Action string index: Decode before redirect? */
609 #define ACTION_STRING_FAST_REDIRECTS 14
610 /** Action string index: Overriding forward rule. */
611 #define ACTION_STRING_FORWARD_OVERRIDE 15
612 /** Action string index: Reason for the block. */
613 #define ACTION_STRING_BLOCK 16
614 /** Action string index: what to do with the "X-Forwarded-For" header. */
615 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
616 /** Action string index: how many minutes cookies should be valid. */
617 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
618 /** Action string index: how many milliseconds writes should be delayed. */
619 #define ACTION_STRING_DELAY_RESPONSE 19
620 /** Number of string actions. */
621 #define ACTION_STRING_COUNT 20
624 /* To make the ugly hack in sed easier to understand */
625 #define CHECK_EVERY_HEADER_REMAINING 0
628 /** Index into current_action_spec::multi[] for headers to add. */
629 #define ACTION_MULTI_ADD_HEADER 0
630 /** Index into current_action_spec::multi[] for content filters to apply. */
631 #define ACTION_MULTI_FILTER 1
632 /** Index into current_action_spec::multi[] for server-header filters to apply. */
633 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
634 /** Index into current_action_spec::multi[] for client-header filters to apply. */
635 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
636 /** Index into current_action_spec::multi[] for client-header tags to apply. */
637 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
638 /** Index into current_action_spec::multi[] for server-header tags to apply. */
639 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
640 /** Number of multi-string actions. */
641 #define ACTION_MULTI_EXTERNAL_FILTER 6
642 /** Index into current_action_spec::multi[] for tags to suppress. */
643 #define ACTION_MULTI_SUPPRESS_TAG 7
644 /** Index into current_action_spec::multi[] for client body filters to apply. */
645 #define ACTION_MULTI_CLIENT_BODY_FILTER 8
646 /** Number of multi-string actions. */
647 #define ACTION_MULTI_COUNT 9
651 * This structure contains a list of actions to apply to a URL.
652 * It only contains positive instructions - no "-" options.
653 * It is not used to store the actions list itself, only for
654 * url_actions() to return the current values.
656 struct current_action_spec
658 /** Actions to apply. A bit set to "1" means perform the action. */
662 * Parameters for those actions that require them.
663 * Each entry is valid if & only if the corresponding entry in "flags" is
666 char * string[ACTION_STRING_COUNT];
668 /** Lists of strings for multi-string actions. */
669 struct list multi[ACTION_MULTI_COUNT][1];
674 * This structure contains a set of changes to actions.
675 * It can contain both positive and negative instructions.
676 * It is used to store an entry in the actions list.
680 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
681 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
684 * Parameters for those actions that require them.
685 * Each entry is valid if & only if the corresponding entry in "flags" is
688 char * string[ACTION_STRING_COUNT];
690 /** Lists of strings to remove, for multi-string actions. */
691 struct list multi_remove[ACTION_MULTI_COUNT][1];
693 /** If nonzero, remove *all* strings from the multi-string action. */
694 int multi_remove_all[ACTION_MULTI_COUNT];
696 /** Lists of strings to add, for multi-string actions. */
697 struct list multi_add[ACTION_MULTI_COUNT][1];
702 * This structure is used to store action files.
704 * It contains an URL or tag pattern, and the changes to
705 * the actions. It's a linked list and should only be
706 * free'd through unload_actions_file() unless there's
707 * only a single entry.
711 struct pattern_spec url[1]; /**< The URL or tag pattern. */
713 struct action_spec *action; /**< Action settings that might be shared with
714 the list entry before or after the current
715 one and can't be free'd willy nilly. */
717 struct url_actions *next; /**< Next action section in file, or NULL. */
720 enum forwarder_type {
721 /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
723 /**< original SOCKS 4 protocol */
725 /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
727 /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
729 /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
732 * Don't use a SOCKS server, forward to the specified webserver.
733 * The difference to SOCKS_NONE is that a request line without
740 * Structure to hold the server socket and the information
741 * required to make sure we only reuse the connection if
742 * the host and forwarding settings are the same.
744 struct reusable_connection
748 time_t timestamp; /* XXX: rename? */
751 time_t response_received;
754 * Number of seconds after which this
755 * connection will no longer be reused.
757 unsigned int keep_alive_timeout;
759 * Number of requests that were sent to this connection.
760 * This is currently only for debugging purposes.
762 unsigned int requests_sent_total;
766 enum forwarder_type forwarder_type;
779 * Flags for use in csp->flags
783 * Flag for csp->flags: Set if this client is processing data.
784 * Cleared when the thread associated with this structure dies.
786 #define CSP_FLAG_ACTIVE 0x01U
789 * Flag for csp->flags: Set if the server's reply is in "chunked"
792 #define CSP_FLAG_CHUNKED 0x02U
795 * Flag for csp->flags: Set if this request was enforced, although it would
796 * normally have been blocked.
798 #define CSP_FLAG_FORCED 0x04U
801 * Flag for csp->flags: Set if any modification to the body was done.
803 #define CSP_FLAG_MODIFIED 0x08U
806 * Flag for csp->flags: Set if request was blocked.
808 #define CSP_FLAG_REJECTED 0x10U
811 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
813 #define CSP_FLAG_TOGGLED_ON 0x20U
816 * Flag for csp->flags: Set if an acceptable Connection header
817 * has already been set by the client.
819 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
822 * Flag for csp->flags: Set if an acceptable Connection header
823 * has already been set by the server.
825 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
828 * Flag for csp->flags: Signals header parsers whether they
829 * are parsing server or client headers.
831 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
834 * Flag for csp->flags: Set if adding the Host: header
837 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
840 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
841 * XXX: As we now have tags we might as well ditch this.
843 #define CSP_FLAG_NO_FILTERING 0x00000400U
846 * Flag for csp->flags: Set the client IP has appended to
847 * an already existing X-Forwarded-For header in which case
848 * no new header has to be generated.
850 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
853 * Flag for csp->flags: Set if the server wants to keep
854 * the connection alive.
856 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
859 * Flag for csp->flags: Set if the server specified the
862 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
865 * Flag for csp->flags: Set if we know the content length,
866 * either because the server set it, or we figured it out
869 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
872 * Flag for csp->flags: Set if the client wants to keep
873 * the connection alive.
875 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
878 * Flag for csp->flags: Set if we think we got the whole
879 * client request and shouldn't read any additional data
880 * coming from the client until the current request has
883 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
886 * Flag for csp->flags: Set if the server promised us to
887 * keep the connection open for a known number of seconds.
889 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
892 * Flag for csp->flags: Set if we think we can't reuse
893 * the server socket. XXX: It's also set after sabotaging
894 * pipelining attempts which is somewhat inconsistent with
897 #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
900 * Flag for csp->flags: Set if the Proxy-Connection header
901 * is among the server headers.
903 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
906 * Flag for csp->flags: Set if the client reused its connection.
908 #define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
911 * Flag for csp->flags: Set if the supports deflate compression.
913 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
916 * Flag for csp->flags: Set if the content has been deflated by Privoxy
918 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
921 * Flag for csp->flags: Set if we already read (parts of)
922 * a pipelined request in which case the client obviously
923 * isn't done talking.
925 #define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
928 * Flag for csp->flags: Set if the client body is chunk-encoded
930 #define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
933 * Flag for csp->flags: Set if the client set the Expect header
935 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
938 * Flag for csp->flags: Set if we answered the request ourselves.
940 #define CSP_FLAG_CRUNCHED 0x04000000U
944 * Flag for csp->flags: Set if we are working with fuzzed input
946 #define CSP_FLAG_FUZZED_INPUT 0x08000000U
950 * Flags for use in return codes of child processes
954 * Flag for process return code: Set if exiting process has been toggled
955 * during its lifetime.
957 #define RC_FLAG_TOGGLED 0x10
960 * Flag for process return code: Set if exiting process has blocked its
963 #define RC_FLAG_BLOCKED 0x20
966 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
969 #define MAX_AF_FILES 100
972 * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
975 #define MAX_LISTENING_SOCKETS 10
978 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
979 mbedtls_connection_attr mbedtls_attr; /* Mbed TLS attrs*/
980 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
981 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
982 openssl_connection_attr openssl_attr; /* OpenSSL atrrs */
983 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
986 * The state of a Privoxy processing thread.
990 /** The proxy's configuration */
991 struct configuration_spec * config;
993 /** The actions to perform on the current request */
994 struct current_action_spec action[1];
996 /** socket to talk to client (web browser) */
999 /** Number of requests received on the client socket. */
1000 unsigned int requests_received_total;
1002 /** current connection to the server (may go through a proxy) */
1003 struct reusable_connection server_connection;
1005 /** Multi-purpose flag container, see CSP_FLAG_* above */
1008 /** MIME-Type key, see CT_* above */
1009 unsigned int content_type;
1011 /** Client PC's IP address, as reported by the accept() function.
1015 /** Client PC's TCP address, as reported by the accept() function.
1017 struct sockaddr_storage tcp_addr;
1019 /** Client PC's IP address, as reported by the accept() function.
1021 unsigned long ip_addr_long;
1022 #endif /* def HAVE_RFC2553 */
1024 /** The host name and port (as a string of the form '<hostname>:<port>')
1025 of the server socket to which the client connected. */
1026 char *listen_addr_str;
1028 /** The URL that was requested */
1029 struct http_request http[1];
1032 * The final forwarding settings.
1033 * XXX: Currently this is only used for forward-override,
1034 * so we can free the space in sweep.
1036 struct forward_spec * fwd;
1038 /** An I/O buffer used for buffering data read from the server */
1039 /* XXX: should be renamed to server_iob */
1042 struct ssl_attr ssl_server_attr; /* attributes for connection to server */
1043 struct ssl_attr ssl_client_attr; /* attributes for connection to client */
1045 /** An I/O buffer used for buffering data read from the client */
1046 struct iob client_iob[1];
1048 /** Buffer used to briefly store data read from the network
1049 * before forwarding or processing it.
1051 char *receive_buffer;
1052 size_t receive_buffer_size;
1054 /** List of all headers for this request */
1055 struct list headers[1];
1057 #ifdef FEATURE_HTTPS_INSPECTION
1058 /** List of all encrypted headers for this request */
1059 struct list https_headers[1];
1062 /** List of all tags that apply to this request */
1063 struct list tags[1];
1065 #ifdef FEATURE_CLIENT_TAGS
1066 /** List of all tags that apply to this client (assigned based on address) */
1067 struct list client_tags[1];
1068 /** The address of the client the request (presumably) came from.
1069 * Either the address returned by accept(), or the address provided
1070 * with the X-Forwarded-For header, provided Privoxy has been configured
1073 char *client_address;
1076 /** Actions files associated with this client */
1077 struct file_list *actions_list[MAX_AF_FILES];
1079 /** pcrs job files. */
1080 struct file_list *rlist[MAX_AF_FILES];
1082 /** Length after content modification. */
1083 unsigned long long content_length;
1085 /* XXX: is this the right location? */
1087 /** Expected length of content after which we
1088 * should stop reading from the server socket.
1090 unsigned long long expected_content_length;
1092 /** Expected length of content after which we
1093 * should stop reading from the client socket.
1095 unsigned long long expected_client_content_length;
1097 #ifdef FEATURE_TRUST
1100 struct file_list *tlist;
1102 #endif /* def FEATURE_TRUST */
1105 * Failure reason to embedded in the CGI error page,
1106 * or NULL. Currently only used for socks errors.
1108 char *error_message;
1110 #ifdef FEATURE_HTTPS_INSPECTION
1111 /* Result of server certificate verification
1113 * Values for flag determining certificate validity
1114 * are compatible with return value of function
1115 * mbedtls_ssl_get_verify_result() for mbedtls
1116 * and SSL_get_verify_result() for openssl.
1117 * There are no values for "invalid certificate", they are
1118 * set by the functions mentioned above.
1120 #define SSL_CERT_VALID 0
1121 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1122 #define SSL_CERT_NOT_VERIFIED 0xFFFFFFFF
1123 uint32_t server_cert_verification_result;
1124 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1125 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1126 #define SSL_CERT_NOT_VERIFIED ~0L
1127 long server_cert_verification_result;
1128 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1130 /* Flag for certificate validity checking */
1131 int dont_verify_certificate;
1134 * Flags if SSL connection with server or client is opened.
1135 * Thanks to this flags, we can call function to close both connections
1136 * and we don't have to care about more details.
1138 short int ssl_with_server_is_opened;
1139 short int ssl_with_client_is_opened;
1142 * Server certificate chain of trust including strings with certificates
1143 * information and string with whole certificate file
1145 struct certs_chain server_certs_chain;
1150 * List of client states so the main thread can keep
1151 * track of them and garbage collect their resources.
1153 struct client_states
1155 struct client_states *next;
1156 struct client_state csp;
1160 * A function to add a header
1162 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1165 * A function to process a header
1167 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1171 * List of available CGI functions.
1173 struct cgi_dispatcher
1175 /** The URL of the CGI, relative to the CGI root. */
1176 const char * const name;
1178 /** The handler function for the CGI */
1179 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1181 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1182 const char * const description;
1184 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1190 * A data file used by Privoxy. Kept in a linked list.
1195 * This is a pointer to the data structures associated with the file.
1196 * Read-only once the structure has been created.
1201 * The unloader function.
1202 * Normally NULL. When we are finished with file (i.e. when we have
1203 * loaded a new one), set to a pointer to an unloader function.
1204 * Unloader will be called by sweep() (called from main loop) when
1205 * all clients using this file are done. This prevents threading
1208 void (*unloader)(void *);
1211 * Used internally by sweep(). Do not access from elsewhere.
1216 * File last-modified time, so we can check if file has been changed.
1217 * Read-only once the structure has been created.
1219 time_t lastmodified;
1222 * The full filename.
1227 * Pointer to next entry in the linked list of all "file_list"s.
1228 * This linked list is so that sweep() can navigate it.
1229 * Since sweep() can remove items from the list, we must be careful
1230 * to only access this value from main thread (when we know sweep
1231 * won't be running).
1233 struct file_list *next;
1237 #ifdef FEATURE_TRUST
1240 * The format of a trust file when loaded into memory.
1244 struct pattern_spec url[1]; /**< The URL pattern */
1245 int reject; /**< FIXME: Please document this! */
1246 struct block_spec *next; /**< Next entry in linked list */
1250 * Arbitrary limit for the number of trusted referrers.
1252 #define MAX_TRUSTED_REFERRERS 512
1254 #endif /* def FEATURE_TRUST */
1257 * How to forward a connection to a parent proxy.
1261 /** URL pattern that this forward_spec is for. */
1262 struct pattern_spec url[1];
1264 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1265 enum forwarder_type type;
1267 /** SOCKS server port. */
1270 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1273 /** SOCKS5 username. */
1274 char *auth_username;
1276 /** SOCKS5 password. */
1277 char *auth_password;
1279 /** Parent HTTP proxy hostname, or NULL for none. */
1282 /** Parent HTTP proxy port. */
1285 /** Next entry in the linked list. */
1286 struct forward_spec *next;
1290 /* Supported filter types */
1293 FT_CONTENT_FILTER = 0,
1294 FT_CLIENT_HEADER_FILTER = 1,
1295 FT_SERVER_HEADER_FILTER = 2,
1296 FT_CLIENT_HEADER_TAGGER = 3,
1297 FT_SERVER_HEADER_TAGGER = 4,
1298 FT_SUPPRESS_TAG = 5,
1299 FT_CLIENT_BODY_FILTER = 6,
1300 #ifdef FEATURE_EXTERNAL_FILTERS
1301 FT_EXTERNAL_CONTENT_FILTER = 7,
1303 FT_INVALID_FILTER = 42,
1306 #ifdef FEATURE_EXTERNAL_FILTERS
1307 #define MAX_FILTER_TYPES 8
1309 #define MAX_FILTER_TYPES 7
1313 * This struct represents one filter (one block) from
1314 * the re_filterfile. If there is more than one filter
1315 * in the file, the file will be represented by a
1316 * chained list of re_filterfile specs.
1318 struct re_filterfile_spec
1320 char *name; /**< Name from FILTER: statement in re_filterfile. */
1321 char *description; /**< Description from FILTER: statement in re_filterfile. */
1322 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1323 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1324 enum filter_type type; /**< Filter type (content, client-header, server-header). */
1325 int dynamic; /**< Set to one if the pattern might contain variables
1326 and has to be recompiled for every request. */
1327 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1333 #define ACL_PERMIT 1 /**< Accept connection request */
1334 #define ACL_DENY 2 /**< Reject connection request */
1337 * An IP address pattern. Used to specify networks in the ACL.
1339 struct access_control_addr
1342 struct sockaddr_storage addr; /* <The TCP address in network order. */
1343 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1345 unsigned long addr; /**< The IP address as an integer. */
1346 unsigned long mask; /**< The network mask as an integer. */
1347 unsigned long port; /**< The port number. */
1348 #endif /* HAVE_RFC2553 */
1352 * An access control list (ACL) entry.
1354 * This is a linked list.
1356 struct access_control_list
1358 struct access_control_addr src[1]; /**< Client IP address */
1359 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1361 short wildcard_dst; /** < dst address is wildcard */
1364 short action; /**< ACL_PERMIT or ACL_DENY */
1365 struct access_control_list *next; /**< The next entry in the ACL. */
1368 #endif /* def FEATURE_ACL */
1371 /** Maximum number of loaders (actions, re_filter, ...) */
1375 * This struct represents a client-spcific-tag and it's description
1377 struct client_tag_spec
1379 char *name; /**< Name from "client-specific-tag bla" directive */
1380 char *description; /**< Description from "client-specific-tag-description " directive */
1381 struct client_tag_spec *next; /**< The pointer for chaining. */
1384 /** configuration_spec::feature_flags: CGI actions editor. */
1385 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1387 /** configuration_spec::feature_flags: Web-based toggle. */
1388 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1390 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1391 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1393 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1394 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1396 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1397 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1399 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1400 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1402 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1403 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1405 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1406 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1408 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1409 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1411 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1412 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
1414 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1415 #define RUNTIME_FEATURE_COMPRESSION 1024U
1417 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1418 #define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
1420 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1421 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
1424 * Data loaded from the configuration file.
1426 * (Anomaly: toggle is still handled through a global, not this structure)
1428 struct configuration_spec
1433 /** Nonzero to enable multithreading. */
1436 /** Bitmask of features that can be controlled through the config file. */
1437 unsigned feature_flags;
1439 /** Nonzero if we need to bind() to the new port. */
1442 /** The log file name. */
1443 const char *logfile;
1445 /** The config file directory. */
1446 const char *confdir;
1448 /** The directory for customized CGI templates. */
1449 const char *templdir;
1451 /** "Cross-origin resource sharing" (CORS) allowed origin */
1452 const char *cors_allowed_origin;
1454 #ifdef FEATURE_EXTERNAL_FILTERS
1455 /** The template used to create temporary files. */
1456 const char *temporary_directory;
1459 /** The log file directory. */
1462 /** The full paths to the actions files. */
1463 const char *actions_file[MAX_AF_FILES];
1465 /** The short names of the actions files. */
1466 const char *actions_file_short[MAX_AF_FILES];
1468 /** The administrator's email address */
1469 char *admin_address;
1471 /** A URL with info on this proxy */
1472 char *proxy_info_url;
1474 /** URL to the user manual (on our website or local copy) */
1477 /** The file names of the pcre filter files. */
1478 const char *re_filterfile[MAX_AF_FILES];
1480 /** The short names of the pcre filter files. */
1481 const char *re_filterfile_short[MAX_AF_FILES];
1483 /**< List of ordered client header names. */
1484 struct list ordered_client_headers[1];
1486 /** The hostname to show on CGI pages, or NULL to use the real one. */
1487 const char *hostname;
1489 /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1490 const char *haddr[MAX_LISTENING_SOCKETS];
1492 /** Trusted referring site that can be used to reach CGI
1493 * pages that aren't marked as harmful.
1495 const char *trusted_cgi_referrer;
1497 /** Ports to bind to. Defaults to HADDR_PORT == 8118. */
1498 int hport[MAX_LISTENING_SOCKETS];
1500 /** Size limit for IOB */
1501 size_t buffer_limit;
1503 /** Size of the receive buffer */
1504 size_t receive_buffer_size;
1506 /** Use accf_http(4) if available */
1507 int enable_accept_filter;
1509 /** Backlog passed to listen() */
1512 #ifdef FEATURE_TRUST
1514 /** The file name of the trust file. */
1515 const char * trustfile;
1517 /** FIXME: DOCME: Document this. */
1518 struct list trust_info[1];
1520 /** FIXME: DOCME: Document this. */
1521 struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1523 #endif /* def FEATURE_TRUST */
1525 #ifdef FEATURE_CLIENT_TAGS
1526 struct client_tag_spec client_tags[1];
1528 /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1529 unsigned int client_tag_lifetime;
1530 #endif /* def FEATURE_CLIENT_TAGS */
1531 int trust_x_forwarded_for;
1535 /** The access control list (ACL). */
1536 struct access_control_list *acl;
1538 #endif /* def FEATURE_ACL */
1540 /** Information about parent proxies (forwarding). */
1541 struct forward_spec *forward;
1543 /** Number of retries in case a forwarded connection attempt fails */
1544 int forwarded_connect_retries;
1546 /** Maximum number of client connections. */
1547 int max_client_connections;
1549 /* Timeout when waiting on sockets for data to become available. */
1552 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1553 /* Maximum number of seconds after which an open connection will no longer be reused. */
1554 unsigned int keep_alive_timeout;
1556 /* Assumed server-side keep alive timeout if none is specified. */
1557 unsigned int default_server_timeout;
1560 #ifdef FEATURE_COMPRESSION
1561 int compression_level;
1564 /** All options from the config file, HTML-formatted. */
1567 /** The configuration file object. */
1568 struct file_list *config_file_list;
1570 /** List of loaders */
1571 int (*loaders[NLOADERS])(struct client_state *);
1573 #ifdef FEATURE_HTTPS_INSPECTION
1574 /** Password for proxy ca file **/
1577 /** Directory with files of ca **/
1580 /** Filename of ca certificate **/
1581 char * ca_cert_file;
1583 /** Filename of ca key **/
1586 /** Directory for saving certificates and keys for each webpage **/
1587 char *certificate_directory;
1589 /** Cipher list to use **/
1592 /** Filename of trusted CAs certificates **/
1593 char * trusted_cas_file;
1597 /** Calculates the number of elements in an array, using sizeof. */
1598 #define SZ(X) (sizeof(X) / sizeof(*X))
1600 /** The force load URL prefix. Not behind an ifdef because
1601 * it's always used for the show-status page. */
1602 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1604 #ifdef FEATURE_NO_GIFS
1605 /** The MIME type for images ("image/png" or "image/gif"). */
1606 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1608 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1609 #endif /* def FEATURE_NO_GIFS */
1616 /** URL for the Privoxy home page. */
1617 #define HOME_PAGE_URL "https://www.privoxy.org/"
1619 /** URL for the Privoxy user manual. */
1620 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1622 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1623 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1625 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1626 #define CONFIG_HELP_PREFIX "config.html#"
1629 * The "hosts" to intercept and display CGI pages.
1630 * First one is a hostname only, second one can specify host and path.
1633 * 1) Do not specify the http: prefix
1634 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1635 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1637 #define CGI_SITE_1_HOST "p.p"
1638 #define CGI_SITE_2_HOST "config.privoxy.org"
1639 #define CGI_SITE_2_PATH ""
1642 * The prefix for CGI pages. Written out in generated HTML.
1643 * INCLUDES the trailing slash.
1645 #ifdef FEATURE_HTTPS_INSPECTION
1646 #define CGI_PREFIX "//" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1647 #define CGI_PREFIX_HTTPS "https:" CGI_PREFIX
1649 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1651 #define CGI_PREFIX_HTTP "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1653 #endif /* ndef PROJECT_H_INCLUDED */