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_PTHREAD
59 typedef pthread_mutex_t privoxy_mutex_t;
64 typedef CRITICAL_SECTION privoxy_mutex_t;
67 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
68 #include "mbedtls/net_sockets.h"
69 #include "mbedtls/entropy.h"
70 #include "mbedtls/ctr_drbg.h"
72 #if defined(MBEDTLS_SSL_CACHE_C)
73 #include "mbedtls/ssl_cache.h"
75 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
77 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
78 #include <openssl/ssl.h>
79 #include <openssl/bio.h>
80 #include <openssl/err.h>
81 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
83 /* Need for struct sockaddr_storage */
87 # include <sys/socket.h>
90 # include <ws2tcpip.h>
91 typedef unsigned short in_port_t;
97 * Include appropriate regular expression libraries.
98 * Note that pcrs and pcre (native) are needed for cgi
99 * and are included anyway.
105 # ifdef PCRE_H_IN_SUBDIR
106 # include <pcre/pcre.h>
119 # include "pcreposix.h"
121 # ifdef PCRE_H_IN_SUBDIR
122 # include <pcre/pcreposix.h>
124 # include <pcreposix.h>
130 * I don't want to have to #include all this just for the declaration
131 * of SOCKET. However, it looks like we have to...
142 typedef SOCKET jb_socket;
144 #define JB_INVALID_SOCKET INVALID_SOCKET
146 #else /* ndef _WIN32 */
149 * The type used by sockets. On UNIX it's an int. Microsoft decided to
150 * make it an unsigned.
152 typedef int jb_socket;
155 * The error value used for variables of type jb_socket. On UNIX this
156 * is -1, however Microsoft decided to make socket handles unsigned, so
157 * they use a different value.
160 #define JB_INVALID_SOCKET (-1)
162 #endif /* ndef _WIN32 */
166 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
171 JB_ERR_OK = 0, /**< Success, no error */
172 JB_ERR_MEMORY = 1, /**< Out of memory */
173 JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
174 JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
175 JB_ERR_PARSE = 4, /**< Error parsing file */
176 JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
177 CGI actions editor. */
178 JB_ERR_COMPRESS = 6 /**< Error on decompression */
181 typedef enum privoxy_err jb_err;
184 * This macro is used to free a pointer that may be NULL.
185 * It also sets the variable to NULL after it's been freed.
186 * The parameter should be a simple variable without side effects.
188 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
192 * Macro definitions for platforms where isspace() and friends
193 * are macros that use their argument directly as an array index
194 * and thus better be positive. Supposedly that's the case on
195 * some unspecified Solaris versions.
196 * Note: Remember to #include <ctype.h> if you use these macros.
198 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
199 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
200 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
201 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
202 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
205 * Use for statically allocated buffers if you have no other choice.
206 * Remember to check the length of what you write into the buffer
207 * - we don't want any buffer overflows!
209 #define BUFFER_SIZE 5000
212 * Max length of CGI parameters (arbitrary limit).
214 #define CGI_PARAM_LEN_MAX 500U
217 * Buffer size for capturing struct hostent data in the
218 * gethostby(name|addr)_r library calls. Since we don't
219 * loop over gethostbyname_r, the buffer must be sufficient
220 * to accommodate multiple IN A RRs, as used in DNS round robin
221 * load balancing. W3C's wwwlib uses 1K, so that should be
222 * good enough for us, too.
225 * XXX: Temporary doubled, for some configurations
226 * 1K is still too small and we didn't get the
227 * real fix ready for inclusion.
229 #define HOSTENT_BUFFER_SIZE 2048
232 * Default TCP/IP address to listen on, as a string.
233 * Set to "127.0.0.1:8118".
235 #define HADDR_DEFAULT "127.0.0.1:8118"
238 /* Forward def for struct client_state */
239 struct configuration_spec;
243 * Entry in a linked list of strings.
248 * The string pointer. It must point to a dynamically malloc()ed
249 * string or be NULL for the list functions to work. In the latter
250 * case, just be careful next time you iterate through the list in
255 /** Next entry in the linked list, or NULL if no more. */
256 struct list_entry *next;
260 * A header for a linked list of strings.
264 /** First entry in the list, or NULL if the list is empty. */
265 struct list_entry *first;
267 /** Last entry in the list, or NULL if the list is empty. */
268 struct list_entry *last;
273 * An entry in a map. This is a name=value pair.
277 /** The key for the map. */
279 /** The value associated with that key. */
281 /** The next map entry, or NULL if none. */
282 struct map_entry *next;
286 * A map from a string to another string.
287 * This is used for the parameters passed in a HTTP GET request, and
288 * to store the exports when the CGI interface is filling in a template.
292 /** The first map entry, or NULL if the map is empty. */
293 struct map_entry *first;
294 /** The last map entry, or NULL if the map is empty. */
295 struct map_entry *last;
298 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
300 * Struct of attributes necessary for TLS/SSL connection
303 mbedtls_ssl_context ssl;
304 mbedtls_ssl_config conf;
305 mbedtls_net_context socket_fd;
306 mbedtls_x509_crt server_cert;
307 mbedtls_x509_crt ca_cert;
308 mbedtls_pk_context prim_key;
310 #if defined(MBEDTLS_SSL_CACHE_C)
311 mbedtls_ssl_cache_context cache;
313 } mbedtls_connection_attr;
314 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
316 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
318 * Struct of attributes necessary for TLS/SSL connection
323 } openssl_connection_attr;
324 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
326 * A HTTP request. This includes the method (GET, POST) and
329 * This is also used whenever we want to match a URL against a
330 * URL pattern. This always contains the URL to match, and never
331 * a URL pattern. (See struct url_spec).
335 char *cmd; /**< Whole command line: method, URL, Version */
336 char *ocmd; /**< Backup of original cmd for CLF logging */
337 char *gpc; /**< HTTP method: GET, POST, ... */
338 char *url; /**< The URL */
339 char *version; /**< Protocol version */
340 int status; /**< HTTP Status */
342 char *host; /**< Host part of URL */
343 int port; /**< Port of URL or 80 (default) */
344 char *path; /**< Path of URL */
345 char *hostport; /**< host[:port] */
346 int ssl; /**< Flag if protocol is https */
348 char *host_ip_addr_str; /**< String with dotted decimal representation
349 of host's IP. NULL before connect_to() */
351 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
352 char **dvec; /**< List of pointers to the strings in dbuffer. */
353 int dcount; /**< How many parts to this domain? (length of dvec) */
355 #ifdef FEATURE_HTTPS_INSPECTION
356 int client_ssl; /**< Flag if we should communicate with client over ssl */
357 int server_ssl; /**< Flag if we should communicate with server over ssl */
358 unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
359 unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
364 #ifdef FEATURE_HTTPS_INSPECTION
366 * Struct for linked list containing certificates
368 typedef struct certs_chain {
369 char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
370 char file_buf[CERT_FILE_BUF_SIZE]; /* buffer for whole certificate - format to save in file */
371 struct certs_chain *next; /* next certificate in chain of trust */
376 * Reasons for generating a http_response instead of delivering
377 * the requested resource. Mostly ordered the way they are checked
397 * Response generated by CGI, blocker, or error handler
401 char *status; /**< HTTP status (string). */
402 struct list headers[1]; /**< List of header lines. */
403 char *head; /**< Formatted http response head. */
404 size_t head_length; /**< Length of http response head. */
405 char *body; /**< HTTP document body. */
406 size_t content_length; /**< Length of body, REQUIRED if binary body. */
407 int is_static; /**< Nonzero if the content will never change and
408 should be cached by the browser (e.g. images). */
409 enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
414 #ifdef FEATURE_PCRE_HOST_PATTERNS
415 regex_t *host_regex;/**< Regex for host matching */
416 enum host_regex_type { VANILLA_HOST_PATTERN, PCRE_HOST_PATTERN } host_regex_type;
417 #endif /* defined FEATURE_PCRE_HOST_PATTERNS */
418 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
419 char **dvec; /**< List of pointers to the strings in dbuffer. */
420 int dcount; /**< How many parts to this domain? (length of dvec) */
421 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
423 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
425 regex_t *preg; /**< Regex for matching path part */
429 * A URL or a tag pattern.
433 /** The string which was parsed to produce this pattern_spec.
434 Used for debugging or display only. */
439 struct url_spec url_spec;
443 unsigned int flags; /**< Bitmap with various pattern properties. */
447 * Constant for host part matching in URLs. If set, indicates that the start of
448 * the pattern must match the start of the URL. E.g. this is not set for the
449 * pattern ".example.com", so that it will match both "example.com" and
450 * "www.example.com". It is set for the pattern "example.com", which makes it
451 * match "example.com" only, not "www.example.com".
453 #define ANCHOR_LEFT 1
456 * Constant for host part matching in URLs. If set, indicates that the end of
457 * the pattern must match the end of the URL. E.g. this is not set for the
458 * pattern "ad.", so that it will match any host called "ad", irrespective
459 * of how many subdomains are in the fully-qualified domain name.
461 #define ANCHOR_RIGHT 2
463 /** Pattern spec bitmap: It's an URL pattern. */
464 #define PATTERN_SPEC_URL_PATTERN 0x00000001UL
466 /** Pattern spec bitmap: It's a TAG pattern. */
467 #define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
469 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
470 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
472 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
473 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
475 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
476 #define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
479 * An I/O buffer. Holds a string which can be appended to, and can have data
480 * removed from the beginning.
484 char *buf; /**< Start of buffer */
485 char *cur; /**< Start of relevant data */
486 char *eod; /**< End of relevant data */
487 size_t size; /**< Size as malloc()ed */
492 * Return the number of bytes in the I/O buffer associated with the passed
493 * I/O buffer. May be zero.
495 #define IOB_PEEK(IOB) ((IOB->cur > IOB->eod) ? (IOB->eod - IOB->cur) : 0)
498 /* Bits for csp->content_type bitmask: */
499 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
500 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
501 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
503 /* Although these are not, strictly speaking, content types
504 * (they are content encodings), it is simple to handle them
507 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
508 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
509 #define CT_BROTLI 0x0040U /**< Brotli-compressed data. */
512 * Flag to signal that the server declared the content type,
513 * so we can differentiate between unknown and undeclared
516 #define CT_DECLARED 0x0080U
519 * The mask which includes all actions.
521 #define ACTION_MASK_ALL (~0UL)
524 * The most compatible set of actions - i.e. none.
526 #define ACTION_MOST_COMPATIBLE 0x00000000UL
528 /** Action bitmap: Block the request. */
529 #define ACTION_BLOCK 0x00000001UL
530 /** Action bitmap: Deanimate if it's a GIF. */
531 #define ACTION_DEANIMATE 0x00000002UL
532 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
533 #define ACTION_DOWNGRADE 0x00000004UL
534 /** Action bitmap: Fast redirects. */
535 #define ACTION_FAST_REDIRECTS 0x00000008UL
536 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
537 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
538 /** Action bitmap: Hide "From" header. */
539 #define ACTION_HIDE_FROM 0x00000020UL
540 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
541 #define ACTION_HIDE_REFERER 0x00000040UL
542 /** Action bitmap: Hide "User-Agent" and similar headers. */
543 #define ACTION_HIDE_USER_AGENT 0x00000080UL
544 /** Action bitmap: This is an image. */
545 #define ACTION_IMAGE 0x00000100UL
546 /** Action bitmap: Sets the image blocker. */
547 #define ACTION_IMAGE_BLOCKER 0x00000200UL
548 /** Action bitmap: Prevent compression. */
549 #define ACTION_NO_COMPRESSION 0x00000400UL
550 /** Action bitmap: Change cookies to session only cookies. */
551 #define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
552 /** Action bitmap: Block cookies coming from the client. */
553 #define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
554 /** Action bitmap: Block cookies coming from the server. */
555 #define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
556 /** Action bitmap: Override the forward settings in the config file */
557 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
558 /** Action bitmap: Block as empty document */
559 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
560 /** Action bitmap: Limit CONNECT requests to safe ports. */
561 #define ACTION_LIMIT_CONNECT 0x00010000UL
562 /** Action bitmap: Redirect request. */
563 #define ACTION_REDIRECT 0x00020000UL
564 /** Action bitmap: Crunch or modify "if-modified-since" header. */
565 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
566 /** Action bitmap: Overwrite Content-Type header. */
567 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
568 /** Action bitmap: Crunch specified server header. */
569 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
570 /** Action bitmap: Crunch specified client header */
571 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
572 /** Action bitmap: Enable text mode by force */
573 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
574 /** Action bitmap: Remove the "If-None-Match" header. */
575 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
576 /** Action bitmap: Enable content-disposition crunching */
577 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
578 /** Action bitmap: Replace or block Last-Modified header */
579 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
580 /** Action bitmap: Replace or block Accept-Language header */
581 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
582 /** Action bitmap: Limit the cookie lifetime */
583 #define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
584 /** Action bitmap: Delay writes */
585 #define ACTION_DELAY_RESPONSE 0x10000000UL
586 /** Action bitmap: Turn https inspection on */
587 #define ACTION_HTTPS_INSPECTION 0x20000000UL
588 /** Action bitmap: Turn certificates verification off */
589 #define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
591 /** Action string index: How to deanimate GIFs */
592 #define ACTION_STRING_DEANIMATE 0
593 /** Action string index: Replacement for "From:" header */
594 #define ACTION_STRING_FROM 1
595 /** Action string index: How to block images */
596 #define ACTION_STRING_IMAGE_BLOCKER 2
597 /** Action string index: Replacement for "Referer:" header */
598 #define ACTION_STRING_REFERER 3
599 /** Action string index: Replacement for "User-Agent:" header */
600 #define ACTION_STRING_USER_AGENT 4
601 /** Action string index: Legal CONNECT ports. */
602 #define ACTION_STRING_LIMIT_CONNECT 5
603 /** Action string index: Server headers containing this pattern are crunched*/
604 #define ACTION_STRING_SERVER_HEADER 6
605 /** Action string index: Client headers containing this pattern are crunched*/
606 #define ACTION_STRING_CLIENT_HEADER 7
607 /** Action string index: Replacement for the "Accept-Language:" header*/
608 #define ACTION_STRING_LANGUAGE 8
609 /** Action string index: Replacement for the "Content-Type:" header*/
610 #define ACTION_STRING_CONTENT_TYPE 9
611 /** Action string index: Replacement for the "content-disposition:" header*/
612 #define ACTION_STRING_CONTENT_DISPOSITION 10
613 /** Action string index: Replacement for the "If-Modified-Since:" header*/
614 #define ACTION_STRING_IF_MODIFIED_SINCE 11
615 /** Action string index: Replacement for the "Last-Modified:" header. */
616 #define ACTION_STRING_LAST_MODIFIED 12
617 /** Action string index: Redirect URL */
618 #define ACTION_STRING_REDIRECT 13
619 /** Action string index: Decode before redirect? */
620 #define ACTION_STRING_FAST_REDIRECTS 14
621 /** Action string index: Overriding forward rule. */
622 #define ACTION_STRING_FORWARD_OVERRIDE 15
623 /** Action string index: Reason for the block. */
624 #define ACTION_STRING_BLOCK 16
625 /** Action string index: what to do with the "X-Forwarded-For" header. */
626 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
627 /** Action string index: how many minutes cookies should be valid. */
628 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
629 /** Action string index: how many milliseconds writes should be delayed. */
630 #define ACTION_STRING_DELAY_RESPONSE 19
631 /** Number of string actions. */
632 #define ACTION_STRING_COUNT 20
635 /* To make the ugly hack in sed easier to understand */
636 #define CHECK_EVERY_HEADER_REMAINING 0
639 /** Index into current_action_spec::multi[] for headers to add. */
640 #define ACTION_MULTI_ADD_HEADER 0
641 /** Index into current_action_spec::multi[] for content filters to apply. */
642 #define ACTION_MULTI_FILTER 1
643 /** Index into current_action_spec::multi[] for server-header filters to apply. */
644 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
645 /** Index into current_action_spec::multi[] for client-header filters to apply. */
646 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
647 /** Index into current_action_spec::multi[] for client-header tags to apply. */
648 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
649 /** Index into current_action_spec::multi[] for server-header tags to apply. */
650 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
651 /** Number of multi-string actions. */
652 #define ACTION_MULTI_EXTERNAL_FILTER 6
653 /** Number of multi-string actions. */
654 #define ACTION_MULTI_COUNT 7
658 * This structure contains a list of actions to apply to a URL.
659 * It only contains positive instructions - no "-" options.
660 * It is not used to store the actions list itself, only for
661 * url_actions() to return the current values.
663 struct current_action_spec
665 /** Actions to apply. A bit set to "1" means perform the action. */
669 * Parameters for those actions that require them.
670 * Each entry is valid if & only if the corresponding entry in "flags" is
673 char * string[ACTION_STRING_COUNT];
675 /** Lists of strings for multi-string actions. */
676 struct list multi[ACTION_MULTI_COUNT][1];
681 * This structure contains a set of changes to actions.
682 * It can contain both positive and negative instructions.
683 * It is used to store an entry in the actions list.
687 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
688 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
691 * Parameters for those actions that require them.
692 * Each entry is valid if & only if the corresponding entry in "flags" is
695 char * string[ACTION_STRING_COUNT];
697 /** Lists of strings to remove, for multi-string actions. */
698 struct list multi_remove[ACTION_MULTI_COUNT][1];
700 /** If nonzero, remove *all* strings from the multi-string action. */
701 int multi_remove_all[ACTION_MULTI_COUNT];
703 /** Lists of strings to add, for multi-string actions. */
704 struct list multi_add[ACTION_MULTI_COUNT][1];
709 * This structure is used to store action files.
711 * It contains an URL or tag pattern, and the changes to
712 * the actions. It's a linked list and should only be
713 * free'd through unload_actions_file() unless there's
714 * only a single entry.
718 struct pattern_spec url[1]; /**< The URL or tag pattern. */
720 struct action_spec *action; /**< Action settings that might be shared with
721 the list entry before or after the current
722 one and can't be free'd willy nilly. */
724 struct url_actions *next; /**< Next action section in file, or NULL. */
727 enum forwarder_type {
728 /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
730 /**< original SOCKS 4 protocol */
732 /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
734 /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
736 /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
739 * Don't use a SOCKS server, forward to the specified webserver.
740 * The difference to SOCKS_NONE is that a request line without
747 * Structure to hold the server socket and the information
748 * required to make sure we only reuse the connection if
749 * the host and forwarding settings are the same.
751 struct reusable_connection
755 time_t timestamp; /* XXX: rename? */
758 time_t response_received;
761 * Number of seconds after which this
762 * connection will no longer be reused.
764 unsigned int keep_alive_timeout;
766 * Number of requests that were sent to this connection.
767 * This is currently only for debugging purposes.
769 unsigned int requests_sent_total;
773 enum forwarder_type forwarder_type;
782 * Flags for use in csp->flags
786 * Flag for csp->flags: Set if this client is processing data.
787 * Cleared when the thread associated with this structure dies.
789 #define CSP_FLAG_ACTIVE 0x01U
792 * Flag for csp->flags: Set if the server's reply is in "chunked"
795 #define CSP_FLAG_CHUNKED 0x02U
798 * Flag for csp->flags: Set if this request was enforced, although it would
799 * normally have been blocked.
801 #define CSP_FLAG_FORCED 0x04U
804 * Flag for csp->flags: Set if any modification to the body was done.
806 #define CSP_FLAG_MODIFIED 0x08U
809 * Flag for csp->flags: Set if request was blocked.
811 #define CSP_FLAG_REJECTED 0x10U
814 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
816 #define CSP_FLAG_TOGGLED_ON 0x20U
819 * Flag for csp->flags: Set if an acceptable Connection header
820 * has already been set by the client.
822 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
825 * Flag for csp->flags: Set if an acceptable Connection header
826 * has already been set by the server.
828 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
831 * Flag for csp->flags: Signals header parsers whether they
832 * are parsing server or client headers.
834 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
837 * Flag for csp->flags: Set if adding the Host: header
840 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
843 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
844 * XXX: As we now have tags we might as well ditch this.
846 #define CSP_FLAG_NO_FILTERING 0x00000400U
849 * Flag for csp->flags: Set the client IP has appended to
850 * an already existing X-Forwarded-For header in which case
851 * no new header has to be generated.
853 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
856 * Flag for csp->flags: Set if the server wants to keep
857 * the connection alive.
859 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
862 * Flag for csp->flags: Set if the server specified the
865 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
868 * Flag for csp->flags: Set if we know the content length,
869 * either because the server set it, or we figured it out
872 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
875 * Flag for csp->flags: Set if the client wants to keep
876 * the connection alive.
878 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
881 * Flag for csp->flags: Set if we think we got the whole
882 * client request and shouldn't read any additional data
883 * coming from the client until the current request has
886 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
889 * Flag for csp->flags: Set if the server promised us to
890 * keep the connection open for a known number of seconds.
892 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
895 * Flag for csp->flags: Set if we think we can't reuse
896 * the server socket. XXX: It's also set after sabotaging
897 * pipelining attempts which is somewhat inconsistent with
900 #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
903 * Flag for csp->flags: Set if the Proxy-Connection header
904 * is among the server headers.
906 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
909 * Flag for csp->flags: Set if the client reused its connection.
911 #define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
914 * Flag for csp->flags: Set if the supports deflate compression.
916 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
919 * Flag for csp->flags: Set if the content has been deflated by Privoxy
921 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
924 * Flag for csp->flags: Set if we already read (parts of)
925 * a pipelined request in which case the client obviously
926 * isn't done talking.
928 #define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
931 * Flag for csp->flags: Set if the client body is chunk-encoded
933 #define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
936 * Flag for csp->flags: Set if the client set the Expect header
938 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
941 * Flag for csp->flags: Set if we answered the request ourselves.
943 #define CSP_FLAG_CRUNCHED 0x04000000U
947 * Flag for csp->flags: Set if we are working with fuzzed input
949 #define CSP_FLAG_FUZZED_INPUT 0x08000000U
953 * Flags for use in return codes of child processes
957 * Flag for process return code: Set if exiting process has been toggled
958 * during its lifetime.
960 #define RC_FLAG_TOGGLED 0x10
963 * Flag for process return code: Set if exiting process has blocked its
966 #define RC_FLAG_BLOCKED 0x20
969 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
972 #define MAX_AF_FILES 100
975 * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
978 #define MAX_LISTENING_SOCKETS 10
981 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
982 mbedtls_connection_attr mbedtls_attr; /* Mbed TLS attrs*/
983 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
984 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
985 openssl_connection_attr openssl_attr; /* OpenSSL atrrs */
986 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
989 * The state of a Privoxy processing thread.
993 /** The proxy's configuration */
994 struct configuration_spec * config;
996 /** The actions to perform on the current request */
997 struct current_action_spec action[1];
999 /** socket to talk to client (web browser) */
1002 /** Number of requests received on the client socket. */
1003 unsigned int requests_received_total;
1005 /** current connection to the server (may go through a proxy) */
1006 struct reusable_connection server_connection;
1008 /** Multi-purpose flag container, see CSP_FLAG_* above */
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 /** MIME-Type key, see CT_* above */
1077 unsigned int content_type;
1079 /** Actions files associated with this client */
1080 struct file_list *actions_list[MAX_AF_FILES];
1082 /** pcrs job files. */
1083 struct file_list *rlist[MAX_AF_FILES];
1085 /** Length after content modification. */
1086 unsigned long long content_length;
1088 /* XXX: is this the right location? */
1090 /** Expected length of content after which we
1091 * should stop reading from the server socket.
1093 unsigned long long expected_content_length;
1095 /** Expected length of content after which we
1096 * should stop reading from the client socket.
1098 unsigned long long expected_client_content_length;
1100 #ifdef FEATURE_TRUST
1103 struct file_list *tlist;
1105 #endif /* def FEATURE_TRUST */
1108 * Failure reason to embedded in the CGI error page,
1109 * or NULL. Currently only used for socks errors.
1111 char *error_message;
1113 #ifdef FEATURE_HTTPS_INSPECTION
1114 /* Result of server certificate verification
1116 * Values for flag determining certificate validity
1117 * are compatible with return value of function
1118 * mbedtls_ssl_get_verify_result() for mbedtls
1119 * and SSL_get_verify_result() for openssl.
1120 * There are no values for "invalid certificate", they are
1121 * set by the functions mentioned above.
1123 #define SSL_CERT_VALID 0
1124 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1125 #define SSL_CERT_NOT_VERIFIED 0xFFFFFFFF
1126 uint32_t server_cert_verification_result;
1127 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1128 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1129 #define SSL_CERT_NOT_VERIFIED ~0L
1130 long server_cert_verification_result;
1131 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1133 /* Flag for certificate validity checking */
1134 int dont_verify_certificate;
1137 * Flags if SSL connection with server or client is opened.
1138 * Thanks to this flags, we can call function to close both connections
1139 * and we don't have to care about more details.
1141 int ssl_with_server_is_opened;
1142 int ssl_with_client_is_opened;
1145 * Server certificate chain of trust including strings with certificates
1146 * information and string with whole certificate file
1148 struct certs_chain server_certs_chain;
1153 * List of client states so the main thread can keep
1154 * track of them and garbage collect their resources.
1156 struct client_states
1158 struct client_states *next;
1159 struct client_state csp;
1163 * A function to add a header
1165 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1168 * A function to process a header
1170 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1174 * List of available CGI functions.
1176 struct cgi_dispatcher
1178 /** The URL of the CGI, relative to the CGI root. */
1179 const char * const name;
1181 /** The handler function for the CGI */
1182 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1184 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1185 const char * const description;
1187 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1193 * A data file used by Privoxy. Kept in a linked list.
1198 * This is a pointer to the data structures associated with the file.
1199 * Read-only once the structure has been created.
1204 * The unloader function.
1205 * Normally NULL. When we are finished with file (i.e. when we have
1206 * loaded a new one), set to a pointer to an unloader function.
1207 * Unloader will be called by sweep() (called from main loop) when
1208 * all clients using this file are done. This prevents threading
1211 void (*unloader)(void *);
1214 * Used internally by sweep(). Do not access from elsewhere.
1219 * File last-modified time, so we can check if file has been changed.
1220 * Read-only once the structure has been created.
1222 time_t lastmodified;
1225 * The full filename.
1230 * Pointer to next entry in the linked list of all "file_list"s.
1231 * This linked list is so that sweep() can navigate it.
1232 * Since sweep() can remove items from the list, we must be careful
1233 * to only access this value from main thread (when we know sweep
1234 * won't be running).
1236 struct file_list *next;
1240 #ifdef FEATURE_TRUST
1243 * The format of a trust file when loaded into memory.
1247 struct pattern_spec url[1]; /**< The URL pattern */
1248 int reject; /**< FIXME: Please document this! */
1249 struct block_spec *next; /**< Next entry in linked list */
1253 * Arbitrary limit for the number of trusted referrers.
1255 #define MAX_TRUSTED_REFERRERS 512
1257 #endif /* def FEATURE_TRUST */
1260 * How to forward a connection to a parent proxy.
1264 /** URL pattern that this forward_spec is for. */
1265 struct pattern_spec url[1];
1267 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1268 enum forwarder_type type;
1270 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1273 /** SOCKS server port. */
1276 /** SOCKS5 username. */
1277 char *auth_username;
1279 /** SOCKS5 password. */
1280 char *auth_password;
1282 /** Parent HTTP proxy hostname, or NULL for none. */
1285 /** Parent HTTP proxy port. */
1288 /** Next entry in the linked list. */
1289 struct forward_spec *next;
1293 /* Supported filter types */
1296 FT_CONTENT_FILTER = 0,
1297 FT_CLIENT_HEADER_FILTER = 1,
1298 FT_SERVER_HEADER_FILTER = 2,
1299 FT_CLIENT_HEADER_TAGGER = 3,
1300 FT_SERVER_HEADER_TAGGER = 4,
1301 #ifdef FEATURE_EXTERNAL_FILTERS
1302 FT_EXTERNAL_CONTENT_FILTER = 5,
1304 FT_INVALID_FILTER = 42,
1307 #ifdef FEATURE_EXTERNAL_FILTERS
1308 #define MAX_FILTER_TYPES 6
1310 #define MAX_FILTER_TYPES 5
1314 * This struct represents one filter (one block) from
1315 * the re_filterfile. If there is more than one filter
1316 * in the file, the file will be represented by a
1317 * chained list of re_filterfile specs.
1319 struct re_filterfile_spec
1321 char *name; /**< Name from FILTER: statement in re_filterfile. */
1322 char *description; /**< Description from FILTER: statement in re_filterfile. */
1323 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1324 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1325 enum filter_type type; /**< Filter type (content, client-header, server-header). */
1326 int dynamic; /**< Set to one if the pattern might contain variables
1327 and has to be recompiled for every request. */
1328 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1334 #define ACL_PERMIT 1 /**< Accept connection request */
1335 #define ACL_DENY 2 /**< Reject connection request */
1338 * An IP address pattern. Used to specify networks in the ACL.
1340 struct access_control_addr
1343 struct sockaddr_storage addr; /* <The TCP address in network order. */
1344 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1346 unsigned long addr; /**< The IP address as an integer. */
1347 unsigned long mask; /**< The network mask as an integer. */
1348 unsigned long port; /**< The port number. */
1349 #endif /* HAVE_RFC2553 */
1353 * An access control list (ACL) entry.
1355 * This is a linked list.
1357 struct access_control_list
1359 struct access_control_addr src[1]; /**< Client IP address */
1360 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1362 int wildcard_dst; /** < dst address is wildcard */
1365 short action; /**< ACL_PERMIT or ACL_DENY */
1366 struct access_control_list *next; /**< The next entry in the ACL. */
1369 #endif /* def FEATURE_ACL */
1372 /** Maximum number of loaders (actions, re_filter, ...) */
1376 * This struct represents a client-spcific-tag and it's description
1378 struct client_tag_spec
1380 char *name; /**< Name from "client-specific-tag bla" directive */
1381 char *description; /**< Description from "client-specific-tag-description " directive */
1382 struct client_tag_spec *next; /**< The pointer for chaining. */
1385 /** configuration_spec::feature_flags: CGI actions editor. */
1386 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1388 /** configuration_spec::feature_flags: Web-based toggle. */
1389 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1391 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1392 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1394 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1395 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1397 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1398 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1400 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1401 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1403 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1404 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1406 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1407 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1409 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1410 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1412 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1413 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
1415 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1416 #define RUNTIME_FEATURE_COMPRESSION 1024U
1418 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1419 #define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
1421 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1422 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
1425 * Data loaded from the configuration file.
1427 * (Anomaly: toggle is still handled through a global, not this structure)
1429 struct configuration_spec
1434 /** Nonzero to enable multithreading. */
1437 /** Bitmask of features that can be controlled through the config file. */
1438 unsigned feature_flags;
1440 /** The log file name. */
1441 const char *logfile;
1443 /** The config file directory. */
1444 const char *confdir;
1446 /** The directory for customized CGI templates. */
1447 const char *templdir;
1449 /** "Cross-origin resource sharing" (CORS) allowed origin */
1450 const char *cors_allowed_origin;
1452 #ifdef FEATURE_EXTERNAL_FILTERS
1453 /** The template used to create temporary files. */
1454 const char *temporary_directory;
1457 /** The log file directory. */
1460 /** The full paths to the actions files. */
1461 const char *actions_file[MAX_AF_FILES];
1463 /** The short names of the actions files. */
1464 const char *actions_file_short[MAX_AF_FILES];
1466 /** The administrator's email address */
1467 char *admin_address;
1469 /** A URL with info on this proxy */
1470 char *proxy_info_url;
1472 /** URL to the user manual (on our website or local copy) */
1475 /** The file names of the pcre filter files. */
1476 const char *re_filterfile[MAX_AF_FILES];
1478 /** The short names of the pcre filter files. */
1479 const char *re_filterfile_short[MAX_AF_FILES];
1481 /**< List of ordered client header names. */
1482 struct list ordered_client_headers[1];
1484 /** The hostname to show on CGI pages, or NULL to use the real one. */
1485 const char *hostname;
1487 /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1488 const char *haddr[MAX_LISTENING_SOCKETS];
1490 /** Trusted referring site that can be used to reach CGI
1491 * pages that aren't marked as harmful.
1493 const char *trusted_cgi_referrer;
1495 /** Ports to bind to. Defaults to HADDR_PORT == 8118. */
1496 int hport[MAX_LISTENING_SOCKETS];
1498 /** Size limit for IOB */
1499 size_t buffer_limit;
1501 /** Size of the receive buffer */
1502 size_t receive_buffer_size;
1504 /** Use accf_http(4) if available */
1505 int enable_accept_filter;
1507 /** Backlog passed to listen() */
1510 #ifdef FEATURE_TRUST
1512 /** The file name of the trust file. */
1513 const char * trustfile;
1515 /** FIXME: DOCME: Document this. */
1516 struct list trust_info[1];
1518 /** FIXME: DOCME: Document this. */
1519 struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1521 #endif /* def FEATURE_TRUST */
1523 #ifdef FEATURE_CLIENT_TAGS
1524 struct client_tag_spec client_tags[1];
1526 /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1527 unsigned int client_tag_lifetime;
1528 #endif /* def FEATURE_CLIENT_TAGS */
1529 int trust_x_forwarded_for;
1533 /** The access control list (ACL). */
1534 struct access_control_list *acl;
1536 #endif /* def FEATURE_ACL */
1538 /** Information about parent proxies (forwarding). */
1539 struct forward_spec *forward;
1541 /** Number of retries in case a forwarded connection attempt fails */
1542 int forwarded_connect_retries;
1544 /** Maximum number of client connections. */
1545 int max_client_connections;
1547 /* Timeout when waiting on sockets for data to become available. */
1550 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1551 /* Maximum number of seconds after which an open connection will no longer be reused. */
1552 unsigned int keep_alive_timeout;
1554 /* Assumed server-side keep alive timeout if none is specified. */
1555 unsigned int default_server_timeout;
1558 #ifdef FEATURE_COMPRESSION
1559 int compression_level;
1562 /** All options from the config file, HTML-formatted. */
1565 /** The configuration file object. */
1566 struct file_list *config_file_list;
1568 /** List of loaders */
1569 int (*loaders[NLOADERS])(struct client_state *);
1571 /** Nonzero if we need to bind() to the new port. */
1574 #ifdef FEATURE_HTTPS_INSPECTION
1575 /** Password for proxy ca file **/
1578 /** Directory with files of ca **/
1581 /** Filename of ca certificate **/
1582 char * ca_cert_file;
1584 /** Filename of ca key **/
1587 /** Directory for saving certificates and keys for each webpage **/
1588 char *certificate_directory;
1590 /** Filename of trusted CAs certificates **/
1591 char * trusted_cas_file;
1595 /** Calculates the number of elements in an array, using sizeof. */
1596 #define SZ(X) (sizeof(X) / sizeof(*X))
1598 /** The force load URL prefix. Not behind an ifdef because
1599 * it's always used for the show-status page. */
1600 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1602 #ifdef FEATURE_NO_GIFS
1603 /** The MIME type for images ("image/png" or "image/gif"). */
1604 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1606 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1607 #endif /* def FEATURE_NO_GIFS */
1614 /** URL for the Privoxy home page. */
1615 #define HOME_PAGE_URL "https://www.privoxy.org/"
1617 /** URL for the Privoxy user manual. */
1618 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1620 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1621 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1623 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1624 #define CONFIG_HELP_PREFIX "config.html#"
1627 * The "hosts" to intercept and display CGI pages.
1628 * First one is a hostname only, second one can specify host and path.
1631 * 1) Do not specify the http: prefix
1632 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1633 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1635 #define CGI_SITE_1_HOST "p.p"
1636 #define CGI_SITE_2_HOST "config.privoxy.org"
1637 #define CGI_SITE_2_PATH ""
1640 * The prefix for CGI pages. Written out in generated HTML.
1641 * INCLUDES the trailing slash.
1643 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1644 #define CGI_PREFIX_HTTPS "https://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1646 #endif /* ndef PROJECT_H_INCLUDED */