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;
62 # include <winsock2.h>
63 /* without winsock2.h I get lots of compiler warnings about
64 * #warning Please include winsock2.h before windows.h
68 typedef CRITICAL_SECTION privoxy_mutex_t;
71 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
72 #include "mbedtls/net_sockets.h"
73 #include "mbedtls/entropy.h"
74 #include "mbedtls/ctr_drbg.h"
76 #if defined(MBEDTLS_SSL_CACHE_C)
77 #include "mbedtls/ssl_cache.h"
79 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
81 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
85 #undef X509_EXTENSIONS
87 #include <openssl/ssl.h>
88 #include <openssl/bio.h>
89 #include <openssl/err.h>
90 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
92 /* Need for struct sockaddr_storage */
96 # include <sys/socket.h>
99 # include <ws2tcpip.h>
100 typedef unsigned short in_port_t;
106 * Include appropriate regular expression libraries.
107 * Note that pcrs and pcre (native) are needed for cgi
108 * and are included anyway.
114 # ifdef PCRE_H_IN_SUBDIR
115 # include <pcre/pcre.h>
128 # include "pcreposix.h"
130 # ifdef PCRE_H_IN_SUBDIR
131 # include <pcre/pcreposix.h>
133 # include <pcreposix.h>
139 * I don't want to have to #include all this just for the declaration
140 * of SOCKET. However, it looks like we have to...
151 typedef SOCKET jb_socket;
153 #define JB_INVALID_SOCKET INVALID_SOCKET
155 #else /* ndef _WIN32 */
158 * The type used by sockets. On UNIX it's an int. Microsoft decided to
159 * make it an unsigned.
161 typedef int jb_socket;
164 * The error value used for variables of type jb_socket. On UNIX this
165 * is -1, however Microsoft decided to make socket handles unsigned, so
166 * they use a different value.
169 #define JB_INVALID_SOCKET (-1)
171 #endif /* ndef _WIN32 */
175 * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
180 JB_ERR_OK = 0, /**< Success, no error */
181 JB_ERR_MEMORY = 1, /**< Out of memory */
182 JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
183 JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
184 JB_ERR_PARSE = 4, /**< Error parsing file */
185 JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
186 CGI actions editor. */
187 JB_ERR_COMPRESS = 6 /**< Error on decompression */
190 typedef enum privoxy_err jb_err;
193 * This macro is used to free a pointer that may be NULL.
194 * It also sets the variable to NULL after it's been freed.
195 * The parameter should be a simple variable without side effects.
197 #define freez(X) { if(X) { free((void*)X); X = NULL ; } }
201 * Macro definitions for platforms where isspace() and friends
202 * are macros that use their argument directly as an array index
203 * and thus better be positive. Supposedly that's the case on
204 * some unspecified Solaris versions.
205 * Note: Remember to #include <ctype.h> if you use these macros.
207 #define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
208 #define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
209 #define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
210 #define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
211 #define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
214 * Use for statically allocated buffers if you have no other choice.
215 * Remember to check the length of what you write into the buffer
216 * - we don't want any buffer overflows!
218 #define BUFFER_SIZE 5000
221 * Max length of CGI parameters (arbitrary limit).
223 #define CGI_PARAM_LEN_MAX 500U
226 * Buffer size for capturing struct hostent data in the
227 * gethostby(name|addr)_r library calls. Since we don't
228 * loop over gethostbyname_r, the buffer must be sufficient
229 * to accommodate multiple IN A RRs, as used in DNS round robin
230 * load balancing. W3C's wwwlib uses 1K, so that should be
231 * good enough for us, too.
234 * XXX: Temporary doubled, for some configurations
235 * 1K is still too small and we didn't get the
236 * real fix ready for inclusion.
238 #define HOSTENT_BUFFER_SIZE 2048
241 * Default TCP/IP address to listen on, as a string.
242 * Set to "127.0.0.1:8118".
244 #define HADDR_DEFAULT "127.0.0.1:8118"
247 /* Forward def for struct client_state */
248 struct configuration_spec;
252 * Entry in a linked list of strings.
257 * The string pointer. It must point to a dynamically malloc()ed
258 * string or be NULL for the list functions to work. In the latter
259 * case, just be careful next time you iterate through the list in
264 /** Next entry in the linked list, or NULL if no more. */
265 struct list_entry *next;
269 * A header for a linked list of strings.
273 /** First entry in the list, or NULL if the list is empty. */
274 struct list_entry *first;
276 /** Last entry in the list, or NULL if the list is empty. */
277 struct list_entry *last;
282 * An entry in a map. This is a name=value pair.
286 /** The key for the map. */
288 /** The value associated with that key. */
290 /** The next map entry, or NULL if none. */
291 struct map_entry *next;
295 * A map from a string to another string.
296 * This is used for the parameters passed in a HTTP GET request, and
297 * to store the exports when the CGI interface is filling in a template.
301 /** The first map entry, or NULL if the map is empty. */
302 struct map_entry *first;
303 /** The last map entry, or NULL if the map is empty. */
304 struct map_entry *last;
307 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
309 * Struct of attributes necessary for TLS/SSL connection
312 mbedtls_ssl_context ssl;
313 mbedtls_ssl_config conf;
314 mbedtls_net_context socket_fd;
315 mbedtls_x509_crt server_cert;
316 mbedtls_x509_crt ca_cert;
317 mbedtls_pk_context prim_key;
318 int *ciphersuites_list;
320 #if defined(MBEDTLS_SSL_CACHE_C)
321 mbedtls_ssl_cache_context cache;
323 } mbedtls_connection_attr;
324 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
326 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
328 * Struct of attributes necessary for TLS/SSL connection
333 } openssl_connection_attr;
334 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
336 * A HTTP request. This includes the method (GET, POST) and
339 * This is also used whenever we want to match a URL against a
340 * URL pattern. This always contains the URL to match, and never
341 * a URL pattern. (See struct url_spec).
345 char *cmd; /**< Whole command line: method, URL, Version */
346 char *ocmd; /**< Backup of original cmd for CLF logging */
347 char *gpc; /**< HTTP method: GET, POST, ... */
348 char *url; /**< The URL */
349 char *version; /**< Protocol version */
350 int status; /**< HTTP Status */
352 char *host; /**< Host part of URL */
353 int port; /**< Port of URL or 80 (default) */
354 char *path; /**< Path of URL */
355 char *hostport; /**< host[:port] */
356 int ssl; /**< Flag if protocol is https */
358 char *host_ip_addr_str; /**< String with dotted decimal representation
359 of host's IP. NULL before connect_to() */
361 char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
362 char **dvec; /**< List of pointers to the strings in dbuffer. */
363 int dcount; /**< How many parts to this domain? (length of dvec) */
365 #ifdef FEATURE_HTTPS_INSPECTION
366 int client_ssl; /**< Flag if we should communicate with client over ssl */
367 int server_ssl; /**< Flag if we should communicate with server over ssl */
368 unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
369 unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
374 #ifdef FEATURE_HTTPS_INSPECTION
376 * Struct for linked list containing certificates
378 typedef struct certs_chain {
379 char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
380 char file_buf[CERT_FILE_BUF_SIZE]; /* buffer for whole certificate - format to save in file */
381 struct certs_chain *next; /* next certificate in chain of trust */
386 * Reasons for generating a http_response instead of delivering
387 * the requested resource. Mostly ordered the way they are checked
407 * Response generated by CGI, blocker, or error handler
411 char *status; /**< HTTP status (string). */
412 struct list headers[1]; /**< List of header lines. */
413 char *head; /**< Formatted http response head. */
414 size_t head_length; /**< Length of http response head. */
415 char *body; /**< HTTP document body. */
416 size_t content_length; /**< Length of body, REQUIRED if binary body. */
417 int is_static; /**< Nonzero if the content will never change and
418 should be cached by the browser (e.g. images). */
419 enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
424 #ifdef FEATURE_PCRE_HOST_PATTERNS
425 regex_t *host_regex;/**< Regex for host matching */
426 enum host_regex_type { VANILLA_HOST_PATTERN, PCRE_HOST_PATTERN } host_regex_type;
427 #endif /* defined FEATURE_PCRE_HOST_PATTERNS */
428 char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
429 char **dvec; /**< List of pointers to the strings in dbuffer. */
430 int dcount; /**< How many parts to this domain? (length of dvec) */
431 int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
433 char *port_list; /**< List of acceptable ports, or NULL to match all ports */
435 regex_t *preg; /**< Regex for matching path part */
439 * A URL or a tag pattern.
443 /** The string which was parsed to produce this pattern_spec.
444 Used for debugging or display only. */
449 struct url_spec url_spec;
453 unsigned int flags; /**< Bitmap with various pattern properties. */
457 * Constant for host part matching in URLs. If set, indicates that the start of
458 * the pattern must match the start of the URL. E.g. this is not set for the
459 * pattern ".example.com", so that it will match both "example.com" and
460 * "www.example.com". It is set for the pattern "example.com", which makes it
461 * match "example.com" only, not "www.example.com".
463 #define ANCHOR_LEFT 1
466 * Constant for host part matching in URLs. If set, indicates that the end of
467 * the pattern must match the end of the URL. E.g. this is not set for the
468 * pattern "ad.", so that it will match any host called "ad", irrespective
469 * of how many subdomains are in the fully-qualified domain name.
471 #define ANCHOR_RIGHT 2
473 /** Pattern spec bitmap: It's an URL pattern. */
474 #define PATTERN_SPEC_URL_PATTERN 0x00000001UL
476 /** Pattern spec bitmap: It's a TAG pattern. */
477 #define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
479 /** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
480 #define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
482 /** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
483 #define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
485 /** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
486 #define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
489 * An I/O buffer. Holds a string which can be appended to, and can have data
490 * removed from the beginning.
494 char *buf; /**< Start of buffer */
495 char *cur; /**< Start of relevant data */
496 char *eod; /**< End of relevant data */
497 size_t size; /**< Size as malloc()ed */
501 /* Bits for csp->content_type bitmask: */
502 #define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
503 #define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
504 #define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
506 /* Although these are not, strictly speaking, content types
507 * (they are content encodings), it is simple to handle them
510 #define CT_GZIP 0x0010U /**< gzip-compressed data. */
511 #define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
512 #define CT_BROTLI 0x0040U /**< Brotli-compressed data. */
515 * Flag to signal that the server declared the content type,
516 * so we can differentiate between unknown and undeclared
519 #define CT_DECLARED 0x0080U
522 * The mask which includes all actions.
524 #define ACTION_MASK_ALL (~0UL)
527 * The most compatible set of actions - i.e. none.
529 #define ACTION_MOST_COMPATIBLE 0x00000000UL
531 /** Action bitmap: Block the request. */
532 #define ACTION_BLOCK 0x00000001UL
533 /** Action bitmap: Deanimate if it's a GIF. */
534 #define ACTION_DEANIMATE 0x00000002UL
535 /** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
536 #define ACTION_DOWNGRADE 0x00000004UL
537 /** Action bitmap: Fast redirects. */
538 #define ACTION_FAST_REDIRECTS 0x00000008UL
539 /** Action bitmap: Remove or add "X-Forwarded-For" header. */
540 #define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
541 /** Action bitmap: Hide "From" header. */
542 #define ACTION_HIDE_FROM 0x00000020UL
543 /** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
544 #define ACTION_HIDE_REFERER 0x00000040UL
545 /** Action bitmap: Hide "User-Agent" and similar headers. */
546 #define ACTION_HIDE_USER_AGENT 0x00000080UL
547 /** Action bitmap: This is an image. */
548 #define ACTION_IMAGE 0x00000100UL
549 /** Action bitmap: Sets the image blocker. */
550 #define ACTION_IMAGE_BLOCKER 0x00000200UL
551 /** Action bitmap: Prevent compression. */
552 #define ACTION_NO_COMPRESSION 0x00000400UL
553 /** Action bitmap: Change cookies to session only cookies. */
554 #define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
555 /** Action bitmap: Block cookies coming from the client. */
556 #define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
557 /** Action bitmap: Block cookies coming from the server. */
558 #define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
559 /** Action bitmap: Override the forward settings in the config file */
560 #define ACTION_FORWARD_OVERRIDE 0x00004000UL
561 /** Action bitmap: Block as empty document */
562 #define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
563 /** Action bitmap: Limit CONNECT requests to safe ports. */
564 #define ACTION_LIMIT_CONNECT 0x00010000UL
565 /** Action bitmap: Redirect request. */
566 #define ACTION_REDIRECT 0x00020000UL
567 /** Action bitmap: Crunch or modify "if-modified-since" header. */
568 #define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
569 /** Action bitmap: Overwrite Content-Type header. */
570 #define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
571 /** Action bitmap: Crunch specified server header. */
572 #define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
573 /** Action bitmap: Crunch specified client header */
574 #define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
575 /** Action bitmap: Enable text mode by force */
576 #define ACTION_FORCE_TEXT_MODE 0x00400000UL
577 /** Action bitmap: Remove the "If-None-Match" header. */
578 #define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
579 /** Action bitmap: Enable content-disposition crunching */
580 #define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
581 /** Action bitmap: Replace or block Last-Modified header */
582 #define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
583 /** Action bitmap: Replace or block Accept-Language header */
584 #define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
585 /** Action bitmap: Limit the cookie lifetime */
586 #define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
587 /** Action bitmap: Delay writes */
588 #define ACTION_DELAY_RESPONSE 0x10000000UL
589 /** Action bitmap: Turn https inspection on */
590 #define ACTION_HTTPS_INSPECTION 0x20000000UL
591 /** Action bitmap: Turn certificates verification off */
592 #define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
594 /** Action string index: How to deanimate GIFs */
595 #define ACTION_STRING_DEANIMATE 0
596 /** Action string index: Replacement for "From:" header */
597 #define ACTION_STRING_FROM 1
598 /** Action string index: How to block images */
599 #define ACTION_STRING_IMAGE_BLOCKER 2
600 /** Action string index: Replacement for "Referer:" header */
601 #define ACTION_STRING_REFERER 3
602 /** Action string index: Replacement for "User-Agent:" header */
603 #define ACTION_STRING_USER_AGENT 4
604 /** Action string index: Legal CONNECT ports. */
605 #define ACTION_STRING_LIMIT_CONNECT 5
606 /** Action string index: Server headers containing this pattern are crunched*/
607 #define ACTION_STRING_SERVER_HEADER 6
608 /** Action string index: Client headers containing this pattern are crunched*/
609 #define ACTION_STRING_CLIENT_HEADER 7
610 /** Action string index: Replacement for the "Accept-Language:" header*/
611 #define ACTION_STRING_LANGUAGE 8
612 /** Action string index: Replacement for the "Content-Type:" header*/
613 #define ACTION_STRING_CONTENT_TYPE 9
614 /** Action string index: Replacement for the "content-disposition:" header*/
615 #define ACTION_STRING_CONTENT_DISPOSITION 10
616 /** Action string index: Replacement for the "If-Modified-Since:" header*/
617 #define ACTION_STRING_IF_MODIFIED_SINCE 11
618 /** Action string index: Replacement for the "Last-Modified:" header. */
619 #define ACTION_STRING_LAST_MODIFIED 12
620 /** Action string index: Redirect URL */
621 #define ACTION_STRING_REDIRECT 13
622 /** Action string index: Decode before redirect? */
623 #define ACTION_STRING_FAST_REDIRECTS 14
624 /** Action string index: Overriding forward rule. */
625 #define ACTION_STRING_FORWARD_OVERRIDE 15
626 /** Action string index: Reason for the block. */
627 #define ACTION_STRING_BLOCK 16
628 /** Action string index: what to do with the "X-Forwarded-For" header. */
629 #define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
630 /** Action string index: how many minutes cookies should be valid. */
631 #define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
632 /** Action string index: how many milliseconds writes should be delayed. */
633 #define ACTION_STRING_DELAY_RESPONSE 19
634 /** Number of string actions. */
635 #define ACTION_STRING_COUNT 20
638 /* To make the ugly hack in sed easier to understand */
639 #define CHECK_EVERY_HEADER_REMAINING 0
642 /** Index into current_action_spec::multi[] for headers to add. */
643 #define ACTION_MULTI_ADD_HEADER 0
644 /** Index into current_action_spec::multi[] for content filters to apply. */
645 #define ACTION_MULTI_FILTER 1
646 /** Index into current_action_spec::multi[] for server-header filters to apply. */
647 #define ACTION_MULTI_SERVER_HEADER_FILTER 2
648 /** Index into current_action_spec::multi[] for client-header filters to apply. */
649 #define ACTION_MULTI_CLIENT_HEADER_FILTER 3
650 /** Index into current_action_spec::multi[] for client-header tags to apply. */
651 #define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
652 /** Index into current_action_spec::multi[] for server-header tags to apply. */
653 #define ACTION_MULTI_SERVER_HEADER_TAGGER 5
654 /** Number of multi-string actions. */
655 #define ACTION_MULTI_EXTERNAL_FILTER 6
656 /** Index into current_action_spec::multi[] for tags to suppress. */
657 #define ACTION_MULTI_SUPPRESS_TAG 7
658 /** Number of multi-string actions. */
659 #define ACTION_MULTI_COUNT 8
663 * This structure contains a list of actions to apply to a URL.
664 * It only contains positive instructions - no "-" options.
665 * It is not used to store the actions list itself, only for
666 * url_actions() to return the current values.
668 struct current_action_spec
670 /** Actions to apply. A bit set to "1" means perform the action. */
674 * Parameters for those actions that require them.
675 * Each entry is valid if & only if the corresponding entry in "flags" is
678 char * string[ACTION_STRING_COUNT];
680 /** Lists of strings for multi-string actions. */
681 struct list multi[ACTION_MULTI_COUNT][1];
686 * This structure contains a set of changes to actions.
687 * It can contain both positive and negative instructions.
688 * It is used to store an entry in the actions list.
692 unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
693 unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
696 * Parameters for those actions that require them.
697 * Each entry is valid if & only if the corresponding entry in "flags" is
700 char * string[ACTION_STRING_COUNT];
702 /** Lists of strings to remove, for multi-string actions. */
703 struct list multi_remove[ACTION_MULTI_COUNT][1];
705 /** If nonzero, remove *all* strings from the multi-string action. */
706 int multi_remove_all[ACTION_MULTI_COUNT];
708 /** Lists of strings to add, for multi-string actions. */
709 struct list multi_add[ACTION_MULTI_COUNT][1];
714 * This structure is used to store action files.
716 * It contains an URL or tag pattern, and the changes to
717 * the actions. It's a linked list and should only be
718 * free'd through unload_actions_file() unless there's
719 * only a single entry.
723 struct pattern_spec url[1]; /**< The URL or tag pattern. */
725 struct action_spec *action; /**< Action settings that might be shared with
726 the list entry before or after the current
727 one and can't be free'd willy nilly. */
729 struct url_actions *next; /**< Next action section in file, or NULL. */
732 enum forwarder_type {
733 /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
735 /**< original SOCKS 4 protocol */
737 /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
739 /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
741 /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
744 * Don't use a SOCKS server, forward to the specified webserver.
745 * The difference to SOCKS_NONE is that a request line without
752 * Structure to hold the server socket and the information
753 * required to make sure we only reuse the connection if
754 * the host and forwarding settings are the same.
756 struct reusable_connection
760 time_t timestamp; /* XXX: rename? */
763 time_t response_received;
766 * Number of seconds after which this
767 * connection will no longer be reused.
769 unsigned int keep_alive_timeout;
771 * Number of requests that were sent to this connection.
772 * This is currently only for debugging purposes.
774 unsigned int requests_sent_total;
778 enum forwarder_type forwarder_type;
790 * Flags for use in csp->flags
794 * Flag for csp->flags: Set if this client is processing data.
795 * Cleared when the thread associated with this structure dies.
797 #define CSP_FLAG_ACTIVE 0x01U
800 * Flag for csp->flags: Set if the server's reply is in "chunked"
803 #define CSP_FLAG_CHUNKED 0x02U
806 * Flag for csp->flags: Set if this request was enforced, although it would
807 * normally have been blocked.
809 #define CSP_FLAG_FORCED 0x04U
812 * Flag for csp->flags: Set if any modification to the body was done.
814 #define CSP_FLAG_MODIFIED 0x08U
817 * Flag for csp->flags: Set if request was blocked.
819 #define CSP_FLAG_REJECTED 0x10U
822 * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
824 #define CSP_FLAG_TOGGLED_ON 0x20U
827 * Flag for csp->flags: Set if an acceptable Connection header
828 * has already been set by the client.
830 #define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
833 * Flag for csp->flags: Set if an acceptable Connection header
834 * has already been set by the server.
836 #define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
839 * Flag for csp->flags: Signals header parsers whether they
840 * are parsing server or client headers.
842 #define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
845 * Flag for csp->flags: Set if adding the Host: header
848 #define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
851 * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
852 * XXX: As we now have tags we might as well ditch this.
854 #define CSP_FLAG_NO_FILTERING 0x00000400U
857 * Flag for csp->flags: Set the client IP has appended to
858 * an already existing X-Forwarded-For header in which case
859 * no new header has to be generated.
861 #define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
864 * Flag for csp->flags: Set if the server wants to keep
865 * the connection alive.
867 #define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
870 * Flag for csp->flags: Set if the server specified the
873 #define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
876 * Flag for csp->flags: Set if we know the content length,
877 * either because the server set it, or we figured it out
880 #define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
883 * Flag for csp->flags: Set if the client wants to keep
884 * the connection alive.
886 #define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
889 * Flag for csp->flags: Set if we think we got the whole
890 * client request and shouldn't read any additional data
891 * coming from the client until the current request has
894 #define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
897 * Flag for csp->flags: Set if the server promised us to
898 * keep the connection open for a known number of seconds.
900 #define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
903 * Flag for csp->flags: Set if we think we can't reuse
904 * the server socket. XXX: It's also set after sabotaging
905 * pipelining attempts which is somewhat inconsistent with
908 #define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
911 * Flag for csp->flags: Set if the Proxy-Connection header
912 * is among the server headers.
914 #define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
917 * Flag for csp->flags: Set if the client reused its connection.
919 #define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
922 * Flag for csp->flags: Set if the supports deflate compression.
924 #define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
927 * Flag for csp->flags: Set if the content has been deflated by Privoxy
929 #define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
932 * Flag for csp->flags: Set if we already read (parts of)
933 * a pipelined request in which case the client obviously
934 * isn't done talking.
936 #define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
939 * Flag for csp->flags: Set if the client body is chunk-encoded
941 #define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
944 * Flag for csp->flags: Set if the client set the Expect header
946 #define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
949 * Flag for csp->flags: Set if we answered the request ourselves.
951 #define CSP_FLAG_CRUNCHED 0x04000000U
955 * Flag for csp->flags: Set if we are working with fuzzed input
957 #define CSP_FLAG_FUZZED_INPUT 0x08000000U
961 * Flags for use in return codes of child processes
965 * Flag for process return code: Set if exiting process has been toggled
966 * during its lifetime.
968 #define RC_FLAG_TOGGLED 0x10
971 * Flag for process return code: Set if exiting process has blocked its
974 #define RC_FLAG_BLOCKED 0x20
977 * Maximum number of actions/filter files. This limit is arbitrary - it's just used
980 #define MAX_AF_FILES 100
983 * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
986 #define MAX_LISTENING_SOCKETS 10
989 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
990 mbedtls_connection_attr mbedtls_attr; /* Mbed TLS attrs*/
991 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
992 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
993 openssl_connection_attr openssl_attr; /* OpenSSL atrrs */
994 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
997 * The state of a Privoxy processing thread.
1001 /** The proxy's configuration */
1002 struct configuration_spec * config;
1004 /** The actions to perform on the current request */
1005 struct current_action_spec action[1];
1007 /** socket to talk to client (web browser) */
1010 /** Number of requests received on the client socket. */
1011 unsigned int requests_received_total;
1013 /** current connection to the server (may go through a proxy) */
1014 struct reusable_connection server_connection;
1016 /** Multi-purpose flag container, see CSP_FLAG_* above */
1019 /** Client PC's IP address, as reported by the accept() function.
1023 /** Client PC's TCP address, as reported by the accept() function.
1025 struct sockaddr_storage tcp_addr;
1027 /** Client PC's IP address, as reported by the accept() function.
1029 unsigned long ip_addr_long;
1030 #endif /* def HAVE_RFC2553 */
1032 /** The host name and port (as a string of the form '<hostname>:<port>')
1033 of the server socket to which the client connected. */
1034 char *listen_addr_str;
1036 /** The URL that was requested */
1037 struct http_request http[1];
1040 * The final forwarding settings.
1041 * XXX: Currently this is only used for forward-override,
1042 * so we can free the space in sweep.
1044 struct forward_spec * fwd;
1046 /** An I/O buffer used for buffering data read from the server */
1047 /* XXX: should be renamed to server_iob */
1050 struct ssl_attr ssl_server_attr; /* attributes for connection to server */
1051 struct ssl_attr ssl_client_attr; /* attributes for connection to client */
1053 /** An I/O buffer used for buffering data read from the client */
1054 struct iob client_iob[1];
1056 /** Buffer used to briefly store data read from the network
1057 * before forwarding or processing it.
1059 char *receive_buffer;
1060 size_t receive_buffer_size;
1062 /** List of all headers for this request */
1063 struct list headers[1];
1065 #ifdef FEATURE_HTTPS_INSPECTION
1066 /** List of all encrypted headers for this request */
1067 struct list https_headers[1];
1070 /** List of all tags that apply to this request */
1071 struct list tags[1];
1073 #ifdef FEATURE_CLIENT_TAGS
1074 /** List of all tags that apply to this client (assigned based on address) */
1075 struct list client_tags[1];
1076 /** The address of the client the request (presumably) came from.
1077 * Either the address returned by accept(), or the address provided
1078 * with the X-Forwarded-For header, provided Privoxy has been configured
1081 char *client_address;
1084 /** MIME-Type key, see CT_* above */
1085 unsigned int content_type;
1087 /** Actions files associated with this client */
1088 struct file_list *actions_list[MAX_AF_FILES];
1090 /** pcrs job files. */
1091 struct file_list *rlist[MAX_AF_FILES];
1093 /** Length after content modification. */
1094 unsigned long long content_length;
1096 /* XXX: is this the right location? */
1098 /** Expected length of content after which we
1099 * should stop reading from the server socket.
1101 unsigned long long expected_content_length;
1103 /** Expected length of content after which we
1104 * should stop reading from the client socket.
1106 unsigned long long expected_client_content_length;
1108 #ifdef FEATURE_TRUST
1111 struct file_list *tlist;
1113 #endif /* def FEATURE_TRUST */
1116 * Failure reason to embedded in the CGI error page,
1117 * or NULL. Currently only used for socks errors.
1119 char *error_message;
1121 #ifdef FEATURE_HTTPS_INSPECTION
1122 /* Result of server certificate verification
1124 * Values for flag determining certificate validity
1125 * are compatible with return value of function
1126 * mbedtls_ssl_get_verify_result() for mbedtls
1127 * and SSL_get_verify_result() for openssl.
1128 * There are no values for "invalid certificate", they are
1129 * set by the functions mentioned above.
1131 #define SSL_CERT_VALID 0
1132 #ifdef FEATURE_HTTPS_INSPECTION_MBEDTLS
1133 #define SSL_CERT_NOT_VERIFIED 0xFFFFFFFF
1134 uint32_t server_cert_verification_result;
1135 #endif /* FEATURE_HTTPS_INSPECTION_MBEDTLS */
1136 #ifdef FEATURE_HTTPS_INSPECTION_OPENSSL
1137 #define SSL_CERT_NOT_VERIFIED ~0L
1138 long server_cert_verification_result;
1139 #endif /* FEATURE_HTTPS_INSPECTION_OPENSSL */
1141 /* Flag for certificate validity checking */
1142 int dont_verify_certificate;
1145 * Flags if SSL connection with server or client is opened.
1146 * Thanks to this flags, we can call function to close both connections
1147 * and we don't have to care about more details.
1149 int ssl_with_server_is_opened;
1150 int ssl_with_client_is_opened;
1153 * Server certificate chain of trust including strings with certificates
1154 * information and string with whole certificate file
1156 struct certs_chain server_certs_chain;
1161 * List of client states so the main thread can keep
1162 * track of them and garbage collect their resources.
1164 struct client_states
1166 struct client_states *next;
1167 struct client_state csp;
1171 * A function to add a header
1173 typedef jb_err (*add_header_func_ptr)(struct client_state *);
1176 * A function to process a header
1178 typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
1182 * List of available CGI functions.
1184 struct cgi_dispatcher
1186 /** The URL of the CGI, relative to the CGI root. */
1187 const char * const name;
1189 /** The handler function for the CGI */
1190 jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
1192 /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
1193 const char * const description;
1195 /** A flag that indicates whether unintentional calls to this CGI can cause damage */
1201 * A data file used by Privoxy. Kept in a linked list.
1206 * This is a pointer to the data structures associated with the file.
1207 * Read-only once the structure has been created.
1212 * The unloader function.
1213 * Normally NULL. When we are finished with file (i.e. when we have
1214 * loaded a new one), set to a pointer to an unloader function.
1215 * Unloader will be called by sweep() (called from main loop) when
1216 * all clients using this file are done. This prevents threading
1219 void (*unloader)(void *);
1222 * Used internally by sweep(). Do not access from elsewhere.
1227 * File last-modified time, so we can check if file has been changed.
1228 * Read-only once the structure has been created.
1230 time_t lastmodified;
1233 * The full filename.
1238 * Pointer to next entry in the linked list of all "file_list"s.
1239 * This linked list is so that sweep() can navigate it.
1240 * Since sweep() can remove items from the list, we must be careful
1241 * to only access this value from main thread (when we know sweep
1242 * won't be running).
1244 struct file_list *next;
1248 #ifdef FEATURE_TRUST
1251 * The format of a trust file when loaded into memory.
1255 struct pattern_spec url[1]; /**< The URL pattern */
1256 int reject; /**< FIXME: Please document this! */
1257 struct block_spec *next; /**< Next entry in linked list */
1261 * Arbitrary limit for the number of trusted referrers.
1263 #define MAX_TRUSTED_REFERRERS 512
1265 #endif /* def FEATURE_TRUST */
1268 * How to forward a connection to a parent proxy.
1272 /** URL pattern that this forward_spec is for. */
1273 struct pattern_spec url[1];
1275 /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
1276 enum forwarder_type type;
1278 /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
1281 /** SOCKS server port. */
1284 /** SOCKS5 username. */
1285 char *auth_username;
1287 /** SOCKS5 password. */
1288 char *auth_password;
1290 /** Parent HTTP proxy hostname, or NULL for none. */
1293 /** Parent HTTP proxy port. */
1296 /** Next entry in the linked list. */
1297 struct forward_spec *next;
1301 /* Supported filter types */
1304 FT_CONTENT_FILTER = 0,
1305 FT_CLIENT_HEADER_FILTER = 1,
1306 FT_SERVER_HEADER_FILTER = 2,
1307 FT_CLIENT_HEADER_TAGGER = 3,
1308 FT_SERVER_HEADER_TAGGER = 4,
1309 #ifdef FEATURE_EXTERNAL_FILTERS
1310 FT_EXTERNAL_CONTENT_FILTER = 5,
1312 FT_SUPPRESS_TAG = 6,
1313 FT_INVALID_FILTER = 42,
1316 #ifdef FEATURE_EXTERNAL_FILTERS
1317 #define MAX_FILTER_TYPES 7
1319 #define MAX_FILTER_TYPES 6
1323 * This struct represents one filter (one block) from
1324 * the re_filterfile. If there is more than one filter
1325 * in the file, the file will be represented by a
1326 * chained list of re_filterfile specs.
1328 struct re_filterfile_spec
1330 char *name; /**< Name from FILTER: statement in re_filterfile. */
1331 char *description; /**< Description from FILTER: statement in re_filterfile. */
1332 struct list patterns[1]; /**< The patterns from the re_filterfile. */
1333 pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
1334 enum filter_type type; /**< Filter type (content, client-header, server-header). */
1335 int dynamic; /**< Set to one if the pattern might contain variables
1336 and has to be recompiled for every request. */
1337 struct re_filterfile_spec *next; /**< The pointer for chaining. */
1343 #define ACL_PERMIT 1 /**< Accept connection request */
1344 #define ACL_DENY 2 /**< Reject connection request */
1347 * An IP address pattern. Used to specify networks in the ACL.
1349 struct access_control_addr
1352 struct sockaddr_storage addr; /* <The TCP address in network order. */
1353 struct sockaddr_storage mask; /* <The TCP mask in network order. */
1355 unsigned long addr; /**< The IP address as an integer. */
1356 unsigned long mask; /**< The network mask as an integer. */
1357 unsigned long port; /**< The port number. */
1358 #endif /* HAVE_RFC2553 */
1362 * An access control list (ACL) entry.
1364 * This is a linked list.
1366 struct access_control_list
1368 struct access_control_addr src[1]; /**< Client IP address */
1369 struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
1371 int wildcard_dst; /** < dst address is wildcard */
1374 short action; /**< ACL_PERMIT or ACL_DENY */
1375 struct access_control_list *next; /**< The next entry in the ACL. */
1378 #endif /* def FEATURE_ACL */
1381 /** Maximum number of loaders (actions, re_filter, ...) */
1385 * This struct represents a client-spcific-tag and it's description
1387 struct client_tag_spec
1389 char *name; /**< Name from "client-specific-tag bla" directive */
1390 char *description; /**< Description from "client-specific-tag-description " directive */
1391 struct client_tag_spec *next; /**< The pointer for chaining. */
1394 /** configuration_spec::feature_flags: CGI actions editor. */
1395 #define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
1397 /** configuration_spec::feature_flags: Web-based toggle. */
1398 #define RUNTIME_FEATURE_CGI_TOGGLE 2U
1400 /** configuration_spec::feature_flags: HTTP-header-based toggle. */
1401 #define RUNTIME_FEATURE_HTTP_TOGGLE 4U
1403 /** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
1404 #define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
1406 /** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
1407 #define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
1409 /** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
1410 #define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
1412 /** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
1413 #define RUNTIME_FEATURE_CGI_CRUNCHING 64U
1415 /** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
1416 #define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
1418 /** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
1419 #define RUNTIME_FEATURE_CONNECTION_SHARING 256U
1421 /** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
1422 #define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
1424 /** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
1425 #define RUNTIME_FEATURE_COMPRESSION 1024U
1427 /** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
1428 #define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
1430 /** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
1431 #define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
1434 * Data loaded from the configuration file.
1436 * (Anomaly: toggle is still handled through a global, not this structure)
1438 struct configuration_spec
1443 /** Nonzero to enable multithreading. */
1446 /** Bitmask of features that can be controlled through the config file. */
1447 unsigned feature_flags;
1449 /** The log file name. */
1450 const char *logfile;
1452 /** The config file directory. */
1453 const char *confdir;
1455 /** The directory for customized CGI templates. */
1456 const char *templdir;
1458 /** "Cross-origin resource sharing" (CORS) allowed origin */
1459 const char *cors_allowed_origin;
1461 #ifdef FEATURE_EXTERNAL_FILTERS
1462 /** The template used to create temporary files. */
1463 const char *temporary_directory;
1466 /** The log file directory. */
1469 /** The full paths to the actions files. */
1470 const char *actions_file[MAX_AF_FILES];
1472 /** The short names of the actions files. */
1473 const char *actions_file_short[MAX_AF_FILES];
1475 /** The administrator's email address */
1476 char *admin_address;
1478 /** A URL with info on this proxy */
1479 char *proxy_info_url;
1481 /** URL to the user manual (on our website or local copy) */
1484 /** The file names of the pcre filter files. */
1485 const char *re_filterfile[MAX_AF_FILES];
1487 /** The short names of the pcre filter files. */
1488 const char *re_filterfile_short[MAX_AF_FILES];
1490 /**< List of ordered client header names. */
1491 struct list ordered_client_headers[1];
1493 /** The hostname to show on CGI pages, or NULL to use the real one. */
1494 const char *hostname;
1496 /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
1497 const char *haddr[MAX_LISTENING_SOCKETS];
1499 /** Trusted referring site that can be used to reach CGI
1500 * pages that aren't marked as harmful.
1502 const char *trusted_cgi_referrer;
1504 /** Ports to bind to. Defaults to HADDR_PORT == 8118. */
1505 int hport[MAX_LISTENING_SOCKETS];
1507 /** Size limit for IOB */
1508 size_t buffer_limit;
1510 /** Size of the receive buffer */
1511 size_t receive_buffer_size;
1513 /** Use accf_http(4) if available */
1514 int enable_accept_filter;
1516 /** Backlog passed to listen() */
1519 #ifdef FEATURE_TRUST
1521 /** The file name of the trust file. */
1522 const char * trustfile;
1524 /** FIXME: DOCME: Document this. */
1525 struct list trust_info[1];
1527 /** FIXME: DOCME: Document this. */
1528 struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
1530 #endif /* def FEATURE_TRUST */
1532 #ifdef FEATURE_CLIENT_TAGS
1533 struct client_tag_spec client_tags[1];
1535 /* Maximum number of seconds a temporarily enabled tag stays enabled. */
1536 unsigned int client_tag_lifetime;
1537 #endif /* def FEATURE_CLIENT_TAGS */
1538 int trust_x_forwarded_for;
1542 /** The access control list (ACL). */
1543 struct access_control_list *acl;
1545 #endif /* def FEATURE_ACL */
1547 /** Information about parent proxies (forwarding). */
1548 struct forward_spec *forward;
1550 /** Number of retries in case a forwarded connection attempt fails */
1551 int forwarded_connect_retries;
1553 /** Maximum number of client connections. */
1554 int max_client_connections;
1556 /* Timeout when waiting on sockets for data to become available. */
1559 #ifdef FEATURE_CONNECTION_KEEP_ALIVE
1560 /* Maximum number of seconds after which an open connection will no longer be reused. */
1561 unsigned int keep_alive_timeout;
1563 /* Assumed server-side keep alive timeout if none is specified. */
1564 unsigned int default_server_timeout;
1567 #ifdef FEATURE_COMPRESSION
1568 int compression_level;
1571 /** All options from the config file, HTML-formatted. */
1574 /** The configuration file object. */
1575 struct file_list *config_file_list;
1577 /** List of loaders */
1578 int (*loaders[NLOADERS])(struct client_state *);
1580 /** Nonzero if we need to bind() to the new port. */
1583 #ifdef FEATURE_HTTPS_INSPECTION
1584 /** Password for proxy ca file **/
1587 /** Directory with files of ca **/
1590 /** Filename of ca certificate **/
1591 char * ca_cert_file;
1593 /** Filename of ca key **/
1596 /** Directory for saving certificates and keys for each webpage **/
1597 char *certificate_directory;
1599 /** Cipher list to use **/
1602 /** Filename of trusted CAs certificates **/
1603 char * trusted_cas_file;
1607 /** Calculates the number of elements in an array, using sizeof. */
1608 #define SZ(X) (sizeof(X) / sizeof(*X))
1610 /** The force load URL prefix. Not behind an ifdef because
1611 * it's always used for the show-status page. */
1612 #define FORCE_PREFIX "/PRIVOXY-FORCE"
1614 #ifdef FEATURE_NO_GIFS
1615 /** The MIME type for images ("image/png" or "image/gif"). */
1616 #define BUILTIN_IMAGE_MIMETYPE "image/png"
1618 #define BUILTIN_IMAGE_MIMETYPE "image/gif"
1619 #endif /* def FEATURE_NO_GIFS */
1626 /** URL for the Privoxy home page. */
1627 #define HOME_PAGE_URL "https://www.privoxy.org/"
1629 /** URL for the Privoxy user manual. */
1630 #define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
1632 /** Prefix for actions help links (append to USER_MANUAL_URL). */
1633 #define ACTIONS_HELP_PREFIX "actions-file.html#"
1635 /** Prefix for config option help links (append to USER_MANUAL_URL). */
1636 #define CONFIG_HELP_PREFIX "config.html#"
1639 * The "hosts" to intercept and display CGI pages.
1640 * First one is a hostname only, second one can specify host and path.
1643 * 1) Do not specify the http: prefix
1644 * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
1645 * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
1647 #define CGI_SITE_1_HOST "p.p"
1648 #define CGI_SITE_2_HOST "config.privoxy.org"
1649 #define CGI_SITE_2_PATH ""
1652 * The prefix for CGI pages. Written out in generated HTML.
1653 * INCLUDES the trailing slash.
1655 #ifdef FEATURE_HTTPS_INSPECTION
1656 #define CGI_PREFIX "//" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1657 #define CGI_PREFIX_HTTPS "https:" CGI_PREFIX
1659 #define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1661 #define CGI_PREFIX_HTTP "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
1663 #endif /* ndef PROJECT_H_INCLUDED */