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
81 #undef X509_EXTENSIONS
83 #include <openssl/ssl.h>
84 #include <openssl/bio.h>
85 #include <openssl/err.h>
86 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
88 /* Need for struct sockaddr_storage */
92 # include <sys/socket.h>
95 # include <ws2tcpip.h>
96 typedef unsigned short in_port_t;
102 * Include appropriate regular expression libraries.
103 * Note that pcrs and pcre (native) are needed for cgi
104 * and are included anyway.
110 # ifdef PCRE_H_IN_SUBDIR
111 # include <pcre/pcre.h>
124 # include "pcreposix.h"
126 # ifdef PCRE_H_IN_SUBDIR
127 # include <pcre/pcreposix.h>
129 # include <pcreposix.h>
135 * I don't want to have to #include all this just for the declaration
136 * of SOCKET. However, it looks like we have to...
147 typedef SOCKET jb_socket;
149 #define JB_INVALID_SOCKET INVALID_SOCKET
151 #else /* ndef _WIN32 */
154 * The type used by sockets. On UNIX it's an int. Microsoft decided to
155 * make it an unsigned.
157 typedef int jb_socket;
160 * The error value used for variables of type jb_socket. On UNIX this
161 * is -1, however Microsoft decided to make socket handles unsigned, so
162 * they use a different value.
165 #define JB_INVALID_SOCKET (-1)
167 #endif /* ndef _WIN32 */
171 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
176 JB_ERR_OK = 0, /**< Success, no error */
177 JB_ERR_MEMORY = 1, /**< Out of memory */
178 JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
179 JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
180 JB_ERR_PARSE = 4, /**< Error parsing file */
181 JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
182 CGI actions editor. */
183 JB_ERR_COMPRESS = 6 /**< Error on decompression */
186 typedef enum privoxy_err jb_err;
189 * This macro is used to free a pointer that may be NULL.
190 * It also sets the variable to NULL after it's been freed.
191 * The parameter should be a simple variable without side effects.
193 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
197 * Macro definitions for platforms where isspace() and friends
198 * are macros that use their argument directly as an array index
199 * and thus better be positive. Supposedly that's the case on
200 * some unspecified Solaris versions.
201 * Note: Remember to #include <ctype.h> if you use these macros.
203 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
204 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
205 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
206 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
207 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
210 * Use for statically allocated buffers if you have no other choice.
211 * Remember to check the length of what you write into the buffer
212 * - we don't want any buffer overflows!
214 #define BUFFER_SIZE 5000
217 * Max length of CGI parameters (arbitrary limit).
219 #define CGI_PARAM_LEN_MAX 500U
222 * Buffer size for capturing struct hostent data in the
223 * gethostby(name|addr)_r library calls. Since we don't
224 * loop over gethostbyname_r, the buffer must be sufficient
225 * to accommodate multiple IN A RRs, as used in DNS round robin
226 * load balancing. W3C's wwwlib uses 1K, so that should be
227 * good enough for us, too.
230 * XXX: Temporary doubled, for some configurations
231 * 1K is still too small and we didn't get the
232 * real fix ready for inclusion.
234 #define HOSTENT_BUFFER_SIZE 2048
237 * Default TCP/IP address to listen on, as a string.
238 * Set to "127.0.0.1:8118".
240 #define HADDR_DEFAULT "127.0.0.1:8118"
243 /* Forward def for struct client_state */
244 struct configuration_spec;
248 * Entry in a linked list of strings.
253 * The string pointer. It must point to a dynamically malloc()ed
254 * string or be NULL for the list functions to work. In the latter
255 * case, just be careful next time you iterate through the list in
260 /** Next entry in the linked list, or NULL if no more. */
261 struct list_entry *next;
265 * A header for a linked list of strings.
269 /** First entry in the list, or NULL if the list is empty. */
270 struct list_entry *first;
272 /** Last entry in the list, or NULL if the list is empty. */
273 struct list_entry *last;
278 * An entry in a map. This is a name=value pair.
282 /** The key for the map. */
284 /** The value associated with that key. */
286 /** The next map entry, or NULL if none. */
287 struct map_entry *next;
291 * A map from a string to another string.
292 * This is used for the parameters passed in a HTTP GET request, and
293 * to store the exports when the CGI interface is filling in a template.
297 /** The first map entry, or NULL if the map is empty. */
298 struct map_entry *first;
299 /** The last map entry, or NULL if the map is empty. */
300 struct map_entry *last;
303 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
305 * Struct of attributes necessary for TLS/SSL connection
308 mbedtls_ssl_context ssl;
309 mbedtls_ssl_config conf;
310 mbedtls_net_context socket_fd;
311 mbedtls_x509_crt server_cert;
312 mbedtls_x509_crt ca_cert;
313 mbedtls_pk_context prim_key;
314 int *ciphersuites_list;
316 #if defined(MBEDTLS_SSL_CACHE_C)
317 mbedtls_ssl_cache_context cache;
319 } mbedtls_connection_attr;
320 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
322 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
324 * Struct of attributes necessary for TLS/SSL connection
329 } openssl_connection_attr;
330 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
332 * A HTTP request. This includes the method (GET, POST) and
335 * This is also used whenever we want to match a URL against a
336 * URL pattern. This always contains the URL to match, and never
337 * a URL pattern. (See struct url_spec).
341 char *cmd; /**< Whole command line: method, URL, Version */
342 char *ocmd; /**< Backup of original cmd for CLF logging */
343 char *gpc; /**< HTTP method: GET, POST, ... */
344 char *url; /**< The URL */
345 char *version; /**< Protocol version */
346 int status; /**< HTTP Status */
348 char *host; /**< Host part of URL */
349 int port; /**< Port of URL or 80 (default) */
350 char *path; /**< Path of URL */
351 char *hostport; /**< host[:port] */
352 int ssl; /**< Flag if protocol is https */
354 char *host_ip_addr_str; /**< String with dotted decimal representation
355 of host's IP. NULL before connect_to() */
357 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
358 char **dvec; /**< List of pointers to the strings in dbuffer. */
359 int dcount; /**< How many parts to this domain? (length of dvec) */
361 #ifdef FEATURE_HTTPS_INSPECTION
362 int client_ssl; /**< Flag if we should communicate with client over ssl */
363 int server_ssl; /**< Flag if we should communicate with server over ssl */
364 unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
365 unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
370 #ifdef FEATURE_HTTPS_INSPECTION
372 * Struct for linked list containing certificates
374 typedef struct certs_chain {
375 char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
376 char file_buf[CERT_FILE_BUF_SIZE]; /* buffer for whole certificate - format to save in file */
377 struct certs_chain *next; /* next certificate in chain of trust */
382 * Reasons for generating a http_response instead of delivering
383 * the requested resource. Mostly ordered the way they are checked
403 * Response generated by CGI, blocker, or error handler
407 char *status; /**< HTTP status (string). */
408 struct list headers[1]; /**< List of header lines. */
409 char *head; /**< Formatted http response head. */
410 size_t head_length; /**< Length of http response head. */
411 char *body; /**< HTTP document body. */
412 size_t content_length; /**< Length of body, REQUIRED if binary body. */
413 int is_static; /**< Nonzero if the content will never change and
414 should be cached by the browser (e.g. images). */
415 enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
420 #ifdef FEATURE_PCRE_HOST_PATTERNS
421 regex_t *host_regex;/**< Regex for host matching */
422 enum host_regex_type { VANILLA_HOST_PATTERN, PCRE_HOST_PATTERN } host_regex_type;
423 #endif /* defined FEATURE_PCRE_HOST_PATTERNS */
424 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
425 char **dvec; /**< List of pointers to the strings in dbuffer. */
426 int dcount; /**< How many parts to this domain? (length of dvec) */
427 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
429 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
431 regex_t *preg; /**< Regex for matching path part */
435 * A URL or a tag pattern.
439 /** The string which was parsed to produce this pattern_spec.
440 Used for debugging or display only. */
445 struct url_spec url_spec;
449 unsigned int flags; /**< Bitmap with various pattern properties. */
453 * Constant for host part matching in URLs. If set, indicates that the start of
454 * the pattern must match the start of the URL. E.g. this is not set for the
455 * pattern ".example.com", so that it will match both "example.com" and
456 * "www.example.com". It is set for the pattern "example.com", which makes it
457 * match "example.com" only, not "www.example.com".
459 #define ANCHOR_LEFT 1
462 * Constant for host part matching in URLs. If set, indicates that the end of
463 * the pattern must match the end of the URL. E.g. this is not set for the
464 * pattern "ad.", so that it will match any host called "ad", irrespective
465 * of how many subdomains are in the fully-qualified domain name.
467 #define ANCHOR_RIGHT 2
469 /** Pattern spec bitmap: It's an URL pattern. */
470 #define PATTERN_SPEC_URL_PATTERN 0x00000001UL
472 /** Pattern spec bitmap: It's a TAG pattern. */
473 #define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
475 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
476 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
478 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
479 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
481 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
482 #define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
485 * An I/O buffer. Holds a string which can be appended to, and can have data
486 * removed from the beginning.
490 char *buf; /**< Start of buffer */
491 char *cur; /**< Start of relevant data */
492 char *eod; /**< End of relevant data */
493 size_t size; /**< Size as malloc()ed */
497 /* Bits for csp->content_type bitmask: */
498 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
499 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
500 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
502 /* Although these are not, strictly speaking, content types
503 * (they are content encodings), it is simple to handle them
506 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
507 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
508 #define CT_BROTLI 0x0040U /**< Brotli-compressed data. */
511 * Flag to signal that the server declared the content type,
512 * so we can differentiate between unknown and undeclared
515 #define CT_DECLARED 0x0080U
518 * The mask which includes all actions.
520 #define ACTION_MASK_ALL (~0UL)
523 * The most compatible set of actions - i.e. none.
525 #define ACTION_MOST_COMPATIBLE 0x00000000UL
527 /** Action bitmap: Block the request. */
528 #define ACTION_BLOCK 0x00000001UL
529 /** Action bitmap: Deanimate if it's a GIF. */
530 #define ACTION_DEANIMATE 0x00000002UL
531 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
532 #define ACTION_DOWNGRADE 0x00000004UL
533 /** Action bitmap: Fast redirects. */
534 #define ACTION_FAST_REDIRECTS 0x00000008UL
535 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
536 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
537 /** Action bitmap: Hide "From" header. */
538 #define ACTION_HIDE_FROM 0x00000020UL
539 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
540 #define ACTION_HIDE_REFERER 0x00000040UL
541 /** Action bitmap: Hide "User-Agent" and similar headers. */
542 #define ACTION_HIDE_USER_AGENT 0x00000080UL
543 /** Action bitmap: This is an image. */
544 #define ACTION_IMAGE 0x00000100UL
545 /** Action bitmap: Sets the image blocker. */
546 #define ACTION_IMAGE_BLOCKER 0x00000200UL
547 /** Action bitmap: Prevent compression. */
548 #define ACTION_NO_COMPRESSION 0x00000400UL
549 /** Action bitmap: Change cookies to session only cookies. */
550 #define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
551 /** Action bitmap: Block cookies coming from the client. */
552 #define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
553 /** Action bitmap: Block cookies coming from the server. */
554 #define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
555 /** Action bitmap: Override the forward settings in the config file */
556 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
557 /** Action bitmap: Block as empty document */
558 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
559 /** Action bitmap: Limit CONNECT requests to safe ports. */
560 #define ACTION_LIMIT_CONNECT 0x00010000UL
561 /** Action bitmap: Redirect request. */
562 #define ACTION_REDIRECT 0x00020000UL
563 /** Action bitmap: Crunch or modify "if-modified-since" header. */
564 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
565 /** Action bitmap: Overwrite Content-Type header. */
566 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
567 /** Action bitmap: Crunch specified server header. */
568 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
569 /** Action bitmap: Crunch specified client header */
570 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
571 /** Action bitmap: Enable text mode by force */
572 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
573 /** Action bitmap: Remove the "If-None-Match" header. */
574 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
575 /** Action bitmap: Enable content-disposition crunching */
576 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
577 /** Action bitmap: Replace or block Last-Modified header */
578 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
579 /** Action bitmap: Replace or block Accept-Language header */
580 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
581 /** Action bitmap: Limit the cookie lifetime */
582 #define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
583 /** Action bitmap: Delay writes */
584 #define ACTION_DELAY_RESPONSE 0x10000000UL
585 /** Action bitmap: Turn https inspection on */
586 #define ACTION_HTTPS_INSPECTION 0x20000000UL
587 /** Action bitmap: Turn certificates verification off */
588 #define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
590 /** Action string index: How to deanimate GIFs */
591 #define ACTION_STRING_DEANIMATE 0
592 /** Action string index: Replacement for "From:" header */
593 #define ACTION_STRING_FROM 1
594 /** Action string index: How to block images */
595 #define ACTION_STRING_IMAGE_BLOCKER 2
596 /** Action string index: Replacement for "Referer:" header */
597 #define ACTION_STRING_REFERER 3
598 /** Action string index: Replacement for "User-Agent:" header */
599 #define ACTION_STRING_USER_AGENT 4
600 /** Action string index: Legal CONNECT ports. */
601 #define ACTION_STRING_LIMIT_CONNECT 5
602 /** Action string index: Server headers containing this pattern are crunched*/
603 #define ACTION_STRING_SERVER_HEADER 6
604 /** Action string index: Client headers containing this pattern are crunched*/
605 #define ACTION_STRING_CLIENT_HEADER 7
606 /** Action string index: Replacement for the "Accept-Language:" header*/
607 #define ACTION_STRING_LANGUAGE 8
608 /** Action string index: Replacement for the "Content-Type:" header*/
609 #define ACTION_STRING_CONTENT_TYPE 9
610 /** Action string index: Replacement for the "content-disposition:" header*/
611 #define ACTION_STRING_CONTENT_DISPOSITION 10
612 /** Action string index: Replacement for the "If-Modified-Since:" header*/
613 #define ACTION_STRING_IF_MODIFIED_SINCE 11
614 /** Action string index: Replacement for the "Last-Modified:" header. */
615 #define ACTION_STRING_LAST_MODIFIED 12
616 /** Action string index: Redirect URL */
617 #define ACTION_STRING_REDIRECT 13
618 /** Action string index: Decode before redirect? */
619 #define ACTION_STRING_FAST_REDIRECTS 14
620 /** Action string index: Overriding forward rule. */
621 #define ACTION_STRING_FORWARD_OVERRIDE 15
622 /** Action string index: Reason for the block. */
623 #define ACTION_STRING_BLOCK 16
624 /** Action string index: what to do with the "X-Forwarded-For" header. */
625 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
626 /** Action string index: how many minutes cookies should be valid. */
627 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
628 /** Action string index: how many milliseconds writes should be delayed. */
629 #define ACTION_STRING_DELAY_RESPONSE 19
630 /** Number of string actions. */
631 #define ACTION_STRING_COUNT 20
634 /* To make the ugly hack in sed easier to understand */
635 #define CHECK_EVERY_HEADER_REMAINING 0
638 /** Index into current_action_spec::multi[] for headers to add. */
639 #define ACTION_MULTI_ADD_HEADER 0
640 /** Index into current_action_spec::multi[] for content filters to apply. */
641 #define ACTION_MULTI_FILTER 1
642 /** Index into current_action_spec::multi[] for server-header filters to apply. */
643 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
644 /** Index into current_action_spec::multi[] for client-header filters to apply. */
645 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
646 /** Index into current_action_spec::multi[] for client-header tags to apply. */
647 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
648 /** Index into current_action_spec::multi[] for server-header tags to apply. */
649 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
650 /** Number of multi-string actions. */
651 #define ACTION_MULTI_EXTERNAL_FILTER 6
652 /** Number of multi-string actions. */
653 #define ACTION_MULTI_COUNT 7
657 * This structure contains a list of actions to apply to a URL.
658 * It only contains positive instructions - no "-" options.
659 * It is not used to store the actions list itself, only for
660 * url_actions() to return the current values.
662 struct current_action_spec
664 /** Actions to apply. A bit set to "1" means perform the action. */
668 * Parameters for those actions that require them.
669 * Each entry is valid if & only if the corresponding entry in "flags" is
672 char * string[ACTION_STRING_COUNT];
674 /** Lists of strings for multi-string actions. */
675 struct list multi[ACTION_MULTI_COUNT][1];
680 * This structure contains a set of changes to actions.
681 * It can contain both positive and negative instructions.
682 * It is used to store an entry in the actions list.
686 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
687 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
690 * Parameters for those actions that require them.
691 * Each entry is valid if & only if the corresponding entry in "flags" is
694 char * string[ACTION_STRING_COUNT];
696 /** Lists of strings to remove, for multi-string actions. */
697 struct list multi_remove[ACTION_MULTI_COUNT][1];
699 /** If nonzero, remove *all* strings from the multi-string action. */
700 int multi_remove_all[ACTION_MULTI_COUNT];
702 /** Lists of strings to add, for multi-string actions. */
703 struct list multi_add[ACTION_MULTI_COUNT][1];
708 * This structure is used to store action files.
710 * It contains an URL or tag pattern, and the changes to
711 * the actions. It's a linked list and should only be
712 * free'd through unload_actions_file() unless there's
713 * only a single entry.
717 struct pattern_spec url[1]; /**< The URL or tag pattern. */
719 struct action_spec *action; /**< Action settings that might be shared with
720 the list entry before or after the current
721 one and can't be free'd willy nilly. */
723 struct url_actions *next; /**< Next action section in file, or NULL. */
726 enum forwarder_type {
727 /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
729 /**< original SOCKS 4 protocol */
731 /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
733 /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
735 /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
738 * Don't use a SOCKS server, forward to the specified webserver.
739 * The difference to SOCKS_NONE is that a request line without
746 * Structure to hold the server socket and the information
747 * required to make sure we only reuse the connection if
748 * the host and forwarding settings are the same.
750 struct reusable_connection
754 time_t timestamp; /* XXX: rename? */
757 time_t response_received;
760 * Number of seconds after which this
761 * connection will no longer be reused.
763 unsigned int keep_alive_timeout;
765 * Number of requests that were sent to this connection.
766 * This is currently only for debugging purposes.
768 unsigned int requests_sent_total;
772 enum forwarder_type forwarder_type;
784 * Flags for use in csp->flags
788 * Flag for csp->flags: Set if this client is processing data.
789 * Cleared when the thread associated with this structure dies.
791 #define CSP_FLAG_ACTIVE 0x01U
794 * Flag for csp->flags: Set if the server's reply is in "chunked"
797 #define CSP_FLAG_CHUNKED 0x02U
800 * Flag for csp->flags: Set if this request was enforced, although it would
801 * normally have been blocked.
803 #define CSP_FLAG_FORCED 0x04U
806 * Flag for csp->flags: Set if any modification to the body was done.
808 #define CSP_FLAG_MODIFIED 0x08U
811 * Flag for csp->flags: Set if request was blocked.
813 #define CSP_FLAG_REJECTED 0x10U
816 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
818 #define CSP_FLAG_TOGGLED_ON 0x20U
821 * Flag for csp->flags: Set if an acceptable Connection header
822 * has already been set by the client.
824 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
827 * Flag for csp->flags: Set if an acceptable Connection header
828 * has already been set by the server.
830 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
833 * Flag for csp->flags: Signals header parsers whether they
834 * are parsing server or client headers.
836 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
839 * Flag for csp->flags: Set if adding the Host: header
842 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
845 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
846 * XXX: As we now have tags we might as well ditch this.
848 #define CSP_FLAG_NO_FILTERING 0x00000400U
851 * Flag for csp->flags: Set the client IP has appended to
852 * an already existing X-Forwarded-For header in which case
853 * no new header has to be generated.
855 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
858 * Flag for csp->flags: Set if the server wants to keep
859 * the connection alive.
861 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
864 * Flag for csp->flags: Set if the server specified the
867 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
870 * Flag for csp->flags: Set if we know the content length,
871 * either because the server set it, or we figured it out
874 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
877 * Flag for csp->flags: Set if the client wants to keep
878 * the connection alive.
880 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
883 * Flag for csp->flags: Set if we think we got the whole
884 * client request and shouldn't read any additional data
885 * coming from the client until the current request has
888 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
891 * Flag for csp->flags: Set if the server promised us to
892 * keep the connection open for a known number of seconds.
894 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
897 * Flag for csp->flags: Set if we think we can't reuse
898 * the server socket. XXX: It's also set after sabotaging
899 * pipelining attempts which is somewhat inconsistent with
902 #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
905 * Flag for csp->flags: Set if the Proxy-Connection header
906 * is among the server headers.
908 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
911 * Flag for csp->flags: Set if the client reused its connection.
913 #define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
916 * Flag for csp->flags: Set if the supports deflate compression.
918 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
921 * Flag for csp->flags: Set if the content has been deflated by Privoxy
923 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
926 * Flag for csp->flags: Set if we already read (parts of)
927 * a pipelined request in which case the client obviously
928 * isn't done talking.
930 #define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
933 * Flag for csp->flags: Set if the client body is chunk-encoded
935 #define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
938 * Flag for csp->flags: Set if the client set the Expect header
940 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
943 * Flag for csp->flags: Set if we answered the request ourselves.
945 #define CSP_FLAG_CRUNCHED 0x04000000U
949 * Flag for csp->flags: Set if we are working with fuzzed input
951 #define CSP_FLAG_FUZZED_INPUT 0x08000000U
955 * Flags for use in return codes of child processes
959 * Flag for process return code: Set if exiting process has been toggled
960 * during its lifetime.
962 #define RC_FLAG_TOGGLED 0x10
965 * Flag for process return code: Set if exiting process has blocked its
968 #define RC_FLAG_BLOCKED 0x20
971 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
974 #define MAX_AF_FILES 100
977 * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
980 #define MAX_LISTENING_SOCKETS 10
983 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
984 mbedtls_connection_attr mbedtls_attr; /* Mbed TLS attrs*/
985 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
986 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
987 openssl_connection_attr openssl_attr; /* OpenSSL atrrs */
988 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
991 * The state of a Privoxy processing thread.
995 /** The proxy's configuration */
996 struct configuration_spec * config;
998 /** The actions to perform on the current request */
999 struct current_action_spec action[1];
1001 /** socket to talk to client (web browser) */
1004 /** Number of requests received on the client socket. */
1005 unsigned int requests_received_total;
1007 /** current connection to the server (may go through a proxy) */
1008 struct reusable_connection server_connection;
1010 /** Multi-purpose flag container, see CSP_FLAG_* above */
1013 /** Client PC's IP address, as reported by the accept() function.
1017 /** Client PC's TCP address, as reported by the accept() function.
1019 struct sockaddr_storage tcp_addr;
1021 /** Client PC's IP address, as reported by the accept() function.
1023 unsigned long ip_addr_long;
1024 #endif /* def HAVE_RFC2553 */
1026 /** The host name and port (as a string of the form '<hostname>:<port>')
1027 of the server socket to which the client connected. */
1028 char *listen_addr_str;
1030 /** The URL that was requested */
1031 struct http_request http[1];
1034 * The final forwarding settings.
1035 * XXX: Currently this is only used for forward-override,
1036 * so we can free the space in sweep.
1038 struct forward_spec * fwd;
1040 /** An I/O buffer used for buffering data read from the server */
1041 /* XXX: should be renamed to server_iob */
1044 struct ssl_attr ssl_server_attr; /* attributes for connection to server */
1045 struct ssl_attr ssl_client_attr; /* attributes for connection to client */
1047 /** An I/O buffer used for buffering data read from the client */
1048 struct iob client_iob[1];
1050 /** Buffer used to briefly store data read from the network
1051 * before forwarding or processing it.
1053 char *receive_buffer;
1054 size_t receive_buffer_size;
1056 /** List of all headers for this request */
1057 struct list headers[1];
1059 #ifdef FEATURE_HTTPS_INSPECTION
1060 /** List of all encrypted headers for this request */
1061 struct list https_headers[1];
1064 /** List of all tags that apply to this request */
1065 struct list tags[1];
1067 #ifdef FEATURE_CLIENT_TAGS
1068 /** List of all tags that apply to this client (assigned based on address) */
1069 struct list client_tags[1];
1070 /** The address of the client the request (presumably) came from.
1071 * Either the address returned by accept(), or the address provided
1072 * with the X-Forwarded-For header, provided Privoxy has been configured
1075 char *client_address;
1078 /** MIME-Type key, see CT_* above */
1079 unsigned int content_type;
1081 /** Actions files associated with this client */
1082 struct file_list *actions_list[MAX_AF_FILES];
1084 /** pcrs job files. */
1085 struct file_list *rlist[MAX_AF_FILES];
1087 /** Length after content modification. */
1088 unsigned long long content_length;
1090 /* XXX: is this the right location? */
1092 /** Expected length of content after which we
1093 * should stop reading from the server socket.
1095 unsigned long long expected_content_length;
1097 /** Expected length of content after which we
1098 * should stop reading from the client socket.
1100 unsigned long long expected_client_content_length;
1102 #ifdef FEATURE_TRUST
1105 struct file_list *tlist;
1107 #endif /* def FEATURE_TRUST */
1110 * Failure reason to embedded in the CGI error page,
1111 * or NULL. Currently only used for socks errors.
1113 char *error_message;
1115 #ifdef FEATURE_HTTPS_INSPECTION
1116 /* Result of server certificate verification
1118 * Values for flag determining certificate validity
1119 * are compatible with return value of function
1120 * mbedtls_ssl_get_verify_result() for mbedtls
1121 * and SSL_get_verify_result() for openssl.
1122 * There are no values for "invalid certificate", they are
1123 * set by the functions mentioned above.
1125 #define SSL_CERT_VALID 0
1126 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1127 #define SSL_CERT_NOT_VERIFIED 0xFFFFFFFF
1128 uint32_t server_cert_verification_result;
1129 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1130 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1131 #define SSL_CERT_NOT_VERIFIED ~0L
1132 long server_cert_verification_result;
1133 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1135 /* Flag for certificate validity checking */
1136 int dont_verify_certificate;
1139 * Flags if SSL connection with server or client is opened.
1140 * Thanks to this flags, we can call function to close both connections
1141 * and we don't have to care about more details.
1143 int ssl_with_server_is_opened;
1144 int ssl_with_client_is_opened;
1147 * Server certificate chain of trust including strings with certificates
1148 * information and string with whole certificate file
1150 struct certs_chain server_certs_chain;
1155 * List of client states so the main thread can keep
1156 * track of them and garbage collect their resources.
1158 struct client_states
1160 struct client_states *next;
1161 struct client_state csp;
1165 * A function to add a header
1167 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1170 * A function to process a header
1172 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1176 * List of available CGI functions.
1178 struct cgi_dispatcher
1180 /** The URL of the CGI, relative to the CGI root. */
1181 const char * const name;
1183 /** The handler function for the CGI */
1184 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1186 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1187 const char * const description;
1189 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1195 * A data file used by Privoxy. Kept in a linked list.
1200 * This is a pointer to the data structures associated with the file.
1201 * Read-only once the structure has been created.
1206 * The unloader function.
1207 * Normally NULL. When we are finished with file (i.e. when we have
1208 * loaded a new one), set to a pointer to an unloader function.
1209 * Unloader will be called by sweep() (called from main loop) when
1210 * all clients using this file are done. This prevents threading
1213 void (*unloader)(void *);
1216 * Used internally by sweep(). Do not access from elsewhere.
1221 * File last-modified time, so we can check if file has been changed.
1222 * Read-only once the structure has been created.
1224 time_t lastmodified;
1227 * The full filename.
1232 * Pointer to next entry in the linked list of all "file_list"s.
1233 * This linked list is so that sweep() can navigate it.
1234 * Since sweep() can remove items from the list, we must be careful
1235 * to only access this value from main thread (when we know sweep
1236 * won't be running).
1238 struct file_list *next;
1242 #ifdef FEATURE_TRUST
1245 * The format of a trust file when loaded into memory.
1249 struct pattern_spec url[1]; /**< The URL pattern */
1250 int reject; /**< FIXME: Please document this! */
1251 struct block_spec *next; /**< Next entry in linked list */
1255 * Arbitrary limit for the number of trusted referrers.
1257 #define MAX_TRUSTED_REFERRERS 512
1259 #endif /* def FEATURE_TRUST */
1262 * How to forward a connection to a parent proxy.
1266 /** URL pattern that this forward_spec is for. */
1267 struct pattern_spec url[1];
1269 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1270 enum forwarder_type type;
1272 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1275 /** SOCKS server port. */
1278 /** SOCKS5 username. */
1279 char *auth_username;
1281 /** SOCKS5 password. */
1282 char *auth_password;
1284 /** Parent HTTP proxy hostname, or NULL for none. */
1287 /** Parent HTTP proxy port. */
1290 /** Next entry in the linked list. */
1291 struct forward_spec *next;
1295 /* Supported filter types */
1298 FT_CONTENT_FILTER = 0,
1299 FT_CLIENT_HEADER_FILTER = 1,
1300 FT_SERVER_HEADER_FILTER = 2,
1301 FT_CLIENT_HEADER_TAGGER = 3,
1302 FT_SERVER_HEADER_TAGGER = 4,
1303 #ifdef FEATURE_EXTERNAL_FILTERS
1304 FT_EXTERNAL_CONTENT_FILTER = 5,
1306 FT_INVALID_FILTER = 42,
1309 #ifdef FEATURE_EXTERNAL_FILTERS
1310 #define MAX_FILTER_TYPES 6
1312 #define MAX_FILTER_TYPES 5
1316 * This struct represents one filter (one block) from
1317 * the re_filterfile. If there is more than one filter
1318 * in the file, the file will be represented by a
1319 * chained list of re_filterfile specs.
1321 struct re_filterfile_spec
1323 char *name; /**< Name from FILTER: statement in re_filterfile. */
1324 char *description; /**< Description from FILTER: statement in re_filterfile. */
1325 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1326 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1327 enum filter_type type; /**< Filter type (content, client-header, server-header). */
1328 int dynamic; /**< Set to one if the pattern might contain variables
1329 and has to be recompiled for every request. */
1330 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1336 #define ACL_PERMIT 1 /**< Accept connection request */
1337 #define ACL_DENY 2 /**< Reject connection request */
1340 * An IP address pattern. Used to specify networks in the ACL.
1342 struct access_control_addr
1345 struct sockaddr_storage addr; /* <The TCP address in network order. */
1346 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1348 unsigned long addr; /**< The IP address as an integer. */
1349 unsigned long mask; /**< The network mask as an integer. */
1350 unsigned long port; /**< The port number. */
1351 #endif /* HAVE_RFC2553 */
1355 * An access control list (ACL) entry.
1357 * This is a linked list.
1359 struct access_control_list
1361 struct access_control_addr src[1]; /**< Client IP address */
1362 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1364 int wildcard_dst; /** < dst address is wildcard */
1367 short action; /**< ACL_PERMIT or ACL_DENY */
1368 struct access_control_list *next; /**< The next entry in the ACL. */
1371 #endif /* def FEATURE_ACL */
1374 /** Maximum number of loaders (actions, re_filter, ...) */
1378 * This struct represents a client-spcific-tag and it's description
1380 struct client_tag_spec
1382 char *name; /**< Name from "client-specific-tag bla" directive */
1383 char *description; /**< Description from "client-specific-tag-description " directive */
1384 struct client_tag_spec *next; /**< The pointer for chaining. */
1387 /** configuration_spec::feature_flags: CGI actions editor. */
1388 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1390 /** configuration_spec::feature_flags: Web-based toggle. */
1391 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1393 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1394 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1396 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1397 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1399 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1400 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1402 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1403 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1405 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1406 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1408 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1409 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1411 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1412 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1414 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1415 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
1417 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1418 #define RUNTIME_FEATURE_COMPRESSION 1024U
1420 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1421 #define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
1423 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1424 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
1427 * Data loaded from the configuration file.
1429 * (Anomaly: toggle is still handled through a global, not this structure)
1431 struct configuration_spec
1436 /** Nonzero to enable multithreading. */
1439 /** Bitmask of features that can be controlled through the config file. */
1440 unsigned feature_flags;
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 /** Nonzero if we need to bind() to the new port. */
1576 #ifdef FEATURE_HTTPS_INSPECTION
1577 /** Password for proxy ca file **/
1580 /** Directory with files of ca **/
1583 /** Filename of ca certificate **/
1584 char * ca_cert_file;
1586 /** Filename of ca key **/
1589 /** Directory for saving certificates and keys for each webpage **/
1590 char *certificate_directory;
1592 /** Cipher list to use **/
1595 /** Filename of trusted CAs certificates **/
1596 char * trusted_cas_file;
1600 /** Calculates the number of elements in an array, using sizeof. */
1601 #define SZ(X) (sizeof(X) / sizeof(*X))
1603 /** The force load URL prefix. Not behind an ifdef because
1604 * it's always used for the show-status page. */
1605 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1607 #ifdef FEATURE_NO_GIFS
1608 /** The MIME type for images ("image/png" or "image/gif"). */
1609 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1611 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1612 #endif /* def FEATURE_NO_GIFS */
1619 /** URL for the Privoxy home page. */
1620 #define HOME_PAGE_URL "https://www.privoxy.org/"
1622 /** URL for the Privoxy user manual. */
1623 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1625 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1626 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1628 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1629 #define CONFIG_HELP_PREFIX "config.html#"
1632 * The "hosts" to intercept and display CGI pages.
1633 * First one is a hostname only, second one can specify host and path.
1636 * 1) Do not specify the http: prefix
1637 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1638 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1640 #define CGI_SITE_1_HOST "p.p"
1641 #define CGI_SITE_2_HOST "config.privoxy.org"
1642 #define CGI_SITE_2_PATH ""
1645 * The prefix for CGI pages. Written out in generated HTML.
1646 * INCLUDES the trailing slash.
1648 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1649 #define CGI_PREFIX_HTTPS "https://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1651 #endif /* ndef PROJECT_H_INCLUDED */