-#ifndef _PROJECT_H
-#define _PROJECT_H
-#define PROJECT_H_VERSION "$Id: project.h,v 1.1 2001/05/13 21:57:07 administrator Exp $"
+#ifndef PROJECT_H_INCLUDED
+#define PROJECT_H_INCLUDED
/*********************************************************************
*
- * File : $Source: /home/administrator/cvs/ijb/project.h,v $
+ * File : $Source: /cvsroot/ijbswa/current/project.h,v $
*
* Purpose : Defines data structures which are widely used in the
* project. Does not define any variables or functions
* (though it does declare some macros).
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
- * IJBSWA team. http://ijbswa.sourceforge.net
+ * Copyright : Written by and Copyright (C) 2001-2014 the
+ * Privoxy team. https://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
- * by and Copyright (C) 1997 Anonymous Coders and
+ * by and Copyright (C) 1997 Anonymous Coders and
* Junkbusters Corporation. http://www.junkbusters.com
*
- * This program is free software; you can redistribute it
+ * This program is free software; you can redistribute it
* and/or modify it under the terms of the GNU General
* Public License as published by the Free Software
* Foundation; either version 2 of the License, or (at
* or write to the Free Software Foundation, Inc., 59
* Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*
- * Revisions :
- * $Log: project.h,v $
- *
*********************************************************************/
-\f
+
/* Declare struct FILE for vars and funcs. */
#include <stdio.h>
/* Need time_t for file_list */
#include <time.h>
+/* Needed for pcre choice */
+#include "config.h"
+
+#ifdef FEATURE_HTTPS_INSPECTION
+#ifdef FEATURE_PTHREAD
+# include <pthread.h>
+ typedef pthread_mutex_t privoxy_mutex_t;
+#else
+# ifdef _WIN32
+# include <windows.h>
+# endif
+ typedef CRITICAL_SECTION privoxy_mutex_t;
+#endif
+
+#include "mbedtls/net_sockets.h"
+#include "mbedtls/entropy.h"
+#include "mbedtls/ctr_drbg.h"
+
+#if defined(MBEDTLS_SSL_CACHE_C)
+#include "mbedtls/ssl_cache.h"
+#endif
+
+/*
+* Macros for SSL structures
+*/
+#define CERT_INFO_BUF_SIZE 4096
+#define CERT_FILE_BUF_SIZE 16384
+#define ISSUER_NAME_BUF_SIZE 2048
+#define HASH_OF_HOST_BUF_SIZE 16
+#endif
+
+/* Need for struct sockaddr_storage */
+#ifdef HAVE_RFC2553
+# ifndef _WIN32
+# include <netdb.h>
+# include <sys/socket.h>
+# else
+# include <stdint.h>
+# include <ws2tcpip.h>
+ typedef unsigned short in_port_t;
+# endif
+#endif
+
/*
* Include appropriate regular expression libraries.
- *
- * PCRS ==> Include pcre
- * REGEX && PCRE ==> Include pcre and pcreposix
- * REGEX && !PCRE ==> Include gnu_regex
- *
- * STATIC ==> Use #include "pcre.h" (compiling at same time)
- * !STATIC ==> Use #include <pcre.h> (System library)
- *
+ * Note that pcrs and pcre (native) are needed for cgi
+ * and are included anyway.
*/
-#if (defined(REGEX) && defined(PCRE)) || defined(PCRS)
-# ifdef STATIC
-# include "pcre.h"
+
+#ifdef STATIC_PCRE
+# include "pcre.h"
+#else
+# ifdef PCRE_H_IN_SUBDIR
+# include <pcre/pcre.h>
# else
# include <pcre.h>
# endif
-#endif /* (defined(REGEX) && defined(PCRE)) || defined(PCRS) */
+#endif
+
+#ifdef STATIC_PCRS
+# include "pcrs.h"
+#else
+# include <pcrs.h>
+#endif
-#if defined(REGEX) && defined(PCRE)
-# ifdef STATIC
-# include "pcreposix.h"
+#ifdef STATIC_PCRE
+# include "pcreposix.h"
+#else
+# ifdef PCRE_H_IN_SUBDIR
+# include <pcre/pcreposix.h>
# else
# include <pcreposix.h>
# endif
-#endif /* defined(REGEX) && defined(PCRE) */
+#endif
-#if defined(REGEX) && !defined(PCRE)
-# include "gnu_regex.h"
+#ifdef _WIN32
+/*
+ * I don't want to have to #include all this just for the declaration
+ * of SOCKET. However, it looks like we have to...
+ */
+#ifndef STRICT
+#define STRICT
+#endif
+#include <windows.h>
#endif
-#ifdef PCRS
-#include "pcrs.h"
-#endif /* def PCRS */
-#ifdef AMIGA
-#include "amiga.h"
-#endif /* def AMIGA */
+#ifdef _WIN32
-#ifdef __cplusplus
-extern "C" {
-#endif
+typedef SOCKET jb_socket;
-#define FOREVER 1
+#define JB_INVALID_SOCKET INVALID_SOCKET
-/* Default IP and port to listen on */
-#define HADDR_DEFAULT "127.0.0.1"
-#define HADDR_PORT 8000
+#else /* ndef _WIN32 */
+/**
+ * The type used by sockets. On UNIX it's an int. Microsoft decided to
+ * make it an unsigned.
+ */
+typedef int jb_socket;
-/* Need this for struct gateway */
-struct client_state;
+/**
+ * The error value used for variables of type jb_socket. On UNIX this
+ * is -1, however Microsoft decided to make socket handles unsigned, so
+ * they use a different value.
+ */
+#define JB_INVALID_SOCKET (-1)
-struct http_request
+#endif /* ndef _WIN32 */
+
+
+/**
+ * A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
+ * series of errors.
+ */
+enum privoxy_err
{
- char *cmd;
- char *gpc;
- char *host;
- int port;
- char *path;
- char *ver;
- char *hostport; /* "host[:port]" */
- int ssl;
+ JB_ERR_OK = 0, /**< Success, no error */
+ JB_ERR_MEMORY = 1, /**< Out of memory */
+ JB_ERR_CGI_PARAMS = 2, /**< Missing or corrupt CGI parameters */
+ JB_ERR_FILE = 3, /**< Error opening, reading or writing a file */
+ JB_ERR_PARSE = 4, /**< Error parsing file */
+ JB_ERR_MODIFIED = 5, /**< File has been modified outside of the
+ CGI actions editor. */
+ JB_ERR_COMPRESS = 6 /**< Error on decompression */
+};
+
+typedef enum privoxy_err jb_err;
+
+/**
+ * This macro is used to free a pointer that may be NULL.
+ * It also sets the variable to NULL after it's been freed.
+ * The parameter should be a simple variable without side effects.
+ */
+#define freez(X) { if(X) { free((void*)X); X = NULL ; } }
+
+
+/**
+ * Macro definitions for platforms where isspace() and friends
+ * are macros that use their argument directly as an array index
+ * and thus better be positive. Supposedly that's the case on
+ * some unspecified Solaris versions.
+ * Note: Remember to #include <ctype.h> if you use these macros.
+ */
+#define privoxy_isdigit(__X) isdigit((int)(unsigned char)(__X))
+#define privoxy_isupper(__X) isupper((int)(unsigned char)(__X))
+#define privoxy_toupper(__X) toupper((int)(unsigned char)(__X))
+#define privoxy_tolower(__X) tolower((int)(unsigned char)(__X))
+#define privoxy_isspace(__X) isspace((int)(unsigned char)(__X))
+
+/**
+ * Use for statically allocated buffers if you have no other choice.
+ * Remember to check the length of what you write into the buffer
+ * - we don't want any buffer overflows!
+ */
+#define BUFFER_SIZE 5000
+
+/**
+ * Max length of CGI parameters (arbitrary limit).
+ */
+#define CGI_PARAM_LEN_MAX 500U
+
+/**
+ * Buffer size for capturing struct hostent data in the
+ * gethostby(name|addr)_r library calls. Since we don't
+ * loop over gethostbyname_r, the buffer must be sufficient
+ * to accommodate multiple IN A RRs, as used in DNS round robin
+ * load balancing. W3C's wwwlib uses 1K, so that should be
+ * good enough for us, too.
+ */
+/**
+ * XXX: Temporary doubled, for some configurations
+ * 1K is still too small and we didn't get the
+ * real fix ready for inclusion.
+ */
+#define HOSTENT_BUFFER_SIZE 2048
+
+/**
+ * Default TCP/IP address to listen on, as a string.
+ * Set to "127.0.0.1:8118".
+ */
+#define HADDR_DEFAULT "127.0.0.1:8118"
+
+
+/* Forward def for struct client_state */
+struct configuration_spec;
+
+
+/**
+ * Entry in a linked list of strings.
+ */
+struct list_entry
+{
+ /**
+ * The string pointer. It must point to a dynamically malloc()ed
+ * string or be NULL for the list functions to work. In the latter
+ * case, just be careful next time you iterate through the list in
+ * your own code.
+ */
+ char *str;
+
+ /** Next entry in the linked list, or NULL if no more. */
+ struct list_entry *next;
+};
+
+/**
+ * A header for a linked list of strings.
+ */
+struct list
+{
+ /** First entry in the list, or NULL if the list is empty. */
+ struct list_entry *first;
+
+ /** Last entry in the list, or NULL if the list is empty. */
+ struct list_entry *last;
};
-struct gateway
+/**
+ * An entry in a map. This is a name=value pair.
+ */
+struct map_entry
{
- /* generic attributes */
- char *name;
- int (*conn)(const struct gateway *, struct http_request *, struct client_state *);
- int type;
+ /** The key for the map. */
+ const char *name;
+ /** The value associated with that key. */
+ const char *value;
+ /** The next map entry, or NULL if none. */
+ struct map_entry *next;
+};
- /* domain specific attributes */
- char *gateway_host;
- int gateway_port;
+/**
+ * A map from a string to another string.
+ * This is used for the parameters passed in a HTTP GET request, and
+ * to store the exports when the CGI interface is filling in a template.
+ */
+struct map
+{
+ /** The first map entry, or NULL if the map is empty. */
+ struct map_entry *first;
+ /** The last map entry, or NULL if the map is empty. */
+ struct map_entry *last;
+};
- char *forward_host;
- int forward_port;
+#ifdef FEATURE_HTTPS_INSPECTION
+/*
+ * Struct of attributes necessary for TLS/SSL connection
+ */
+typedef struct {
+ mbedtls_ssl_context ssl;
+ mbedtls_ssl_config conf;
+ mbedtls_net_context socket_fd;
+ mbedtls_x509_crt server_cert;
+ mbedtls_x509_crt ca_cert;
+ mbedtls_pk_context prim_key;
+
+ #if defined(MBEDTLS_SSL_CACHE_C)
+ mbedtls_ssl_cache_context cache;
+ #endif
+} mbedtls_connection_attr;
+#endif
+
+/**
+ * A HTTP request. This includes the method (GET, POST) and
+ * the parsed URL.
+ *
+ * This is also used whenever we want to match a URL against a
+ * URL pattern. This always contains the URL to match, and never
+ * a URL pattern. (See struct url_spec).
+ */
+struct http_request
+{
+ char *cmd; /**< Whole command line: method, URL, Version */
+ char *ocmd; /**< Backup of original cmd for CLF logging */
+ char *gpc; /**< HTTP method: GET, POST, ... */
+ char *url; /**< The URL */
+ char *version; /**< Protocol version */
+ int status; /**< HTTP Status */
+
+ char *host; /**< Host part of URL */
+ int port; /**< Port of URL or 80 (default) */
+ char *path; /**< Path of URL */
+ char *hostport; /**< host[:port] */
+ int ssl; /**< Flag if protocol is https */
+
+ char *host_ip_addr_str; /**< String with dotted decimal representation
+ of host's IP. NULL before connect_to() */
+
+#ifndef FEATURE_EXTENDED_HOST_PATTERNS
+ char *dbuffer; /**< Buffer with '\0'-delimited domain name. */
+ char **dvec; /**< List of pointers to the strings in dbuffer. */
+ int dcount; /**< How many parts to this domain? (length of dvec) */
+#endif /* ndef FEATURE_EXTENDED_HOST_PATTERNS */
+
+#ifdef FEATURE_HTTPS_INSPECTION
+ int client_ssl; /**< Flag if we should communicate with client over ssl */
+ int server_ssl; /**< Flag if we should communicate with server over ssl */
+ unsigned char hash_of_host_hex[(HASH_OF_HOST_BUF_SIZE * 2) + 1]; /**< chars for hash in hex string and one for '\0' */
+ unsigned char hash_of_host[HASH_OF_HOST_BUF_SIZE+1]; /**< chars for bytes of hash and one for '\0' */
+#endif
};
-struct proxy_args
+#ifdef FEATURE_HTTPS_INSPECTION
+/*
+ * Struct for linked list containing certificates
+ */
+typedef struct certs_chain {
+ char info_buf[CERT_INFO_BUF_SIZE]; /* text info about properties of certificate */
+ char file_buf[CERT_FILE_BUF_SIZE]; /* buffer for whole certificate - format to save in file */
+ struct certs_chain *next; /* next certificate in chain of trust */
+} certs_chain_t;
+#endif
+
+/**
+ * Reasons for generating a http_response instead of delivering
+ * the requested resource. Mostly ordered the way they are checked
+ * for in chat().
+ */
+enum crunch_reason
{
- char *header;
- char *invocation;
- char *gateways;
- char *trailer;
+ UNSUPPORTED,
+ BLOCKED,
+ UNTRUSTED,
+ REDIRECTED,
+ CGI_CALL,
+ NO_SUCH_DOMAIN,
+ FORWARDING_FAILED,
+ CONNECT_FAILED,
+ OUT_OF_MEMORY,
+ INTERNAL_ERROR,
+ CONNECTION_TIMEOUT,
+ NO_SERVER_DATA
};
+/**
+ * Response generated by CGI, blocker, or error handler
+ */
+struct http_response
+{
+ char *status; /**< HTTP status (string). */
+ struct list headers[1]; /**< List of header lines. */
+ char *head; /**< Formatted http response head. */
+ size_t head_length; /**< Length of http response head. */
+ char *body; /**< HTTP document body. */
+ size_t content_length; /**< Length of body, REQUIRED if binary body. */
+ int is_static; /**< Nonzero if the content will never change and
+ should be cached by the browser (e.g. images). */
+ enum crunch_reason crunch_reason; /**< Why the response was generated in the first place. */
+};
+struct url_spec
+{
+#ifdef FEATURE_EXTENDED_HOST_PATTERNS
+ regex_t *host_regex;/**< Regex for host matching */
+#else
+ char *dbuffer; /**< Buffer with '\0'-delimited domain name, or NULL to match all hosts. */
+ char **dvec; /**< List of pointers to the strings in dbuffer. */
+ int dcount; /**< How many parts to this domain? (length of dvec) */
+ int unanchored; /**< Bitmap - flags are ANCHOR_LEFT and ANCHOR_RIGHT. */
+#endif /* defined FEATURE_EXTENDED_HOST_PATTERNS */
+
+ char *port_list; /**< List of acceptable ports, or NULL to match all ports */
+
+ regex_t *preg; /**< Regex for matching path part */
+};
+
+/**
+ * A URL or a tag pattern.
+ */
+struct pattern_spec
+{
+ /** The string which was parsed to produce this pattern_spec.
+ Used for debugging or display only. */
+ char *spec;
+
+ union
+ {
+ struct url_spec url_spec;
+ regex_t *tag_regex;
+ } pattern;
+
+ unsigned int flags; /**< Bitmap with various pattern properties. */
+};
+
+/**
+ * Constant for host part matching in URLs. If set, indicates that the start of
+ * the pattern must match the start of the URL. E.g. this is not set for the
+ * pattern ".example.com", so that it will match both "example.com" and
+ * "www.example.com". It is set for the pattern "example.com", which makes it
+ * match "example.com" only, not "www.example.com".
+ */
+#define ANCHOR_LEFT 1
+
+/**
+ * Constant for host part matching in URLs. If set, indicates that the end of
+ * the pattern must match the end of the URL. E.g. this is not set for the
+ * pattern "ad.", so that it will match any host called "ad", irrespective
+ * of how many subdomains are in the fully-qualified domain name.
+ */
+#define ANCHOR_RIGHT 2
+
+/** Pattern spec bitmap: It's an URL pattern. */
+#define PATTERN_SPEC_URL_PATTERN 0x00000001UL
+
+/** Pattern spec bitmap: It's a TAG pattern. */
+#define PATTERN_SPEC_TAG_PATTERN 0x00000002UL
+
+/** Pattern spec bitmap: It's a NO-REQUEST-TAG pattern. */
+#define PATTERN_SPEC_NO_REQUEST_TAG_PATTERN 0x00000004UL
+
+/** Pattern spec bitmap: It's a NO-RESPONSE-TAG pattern. */
+#define PATTERN_SPEC_NO_RESPONSE_TAG_PATTERN 0x00000008UL
+
+/** Pattern spec bitmap: It's a CLIENT-TAG pattern. */
+#define PATTERN_SPEC_CLIENT_TAG_PATTERN 0x00000010UL
+
+/**
+ * An I/O buffer. Holds a string which can be appended to, and can have data
+ * removed from the beginning.
+ */
struct iob
{
- char *buf;
- char *cur;
- char *eod;
+ char *buf; /**< Start of buffer */
+ char *cur; /**< Start of relevant data */
+ char *eod; /**< End of relevant data */
+ size_t size; /**< Size as malloc()ed */
};
-struct list
+/**
+ * Return the number of bytes in the I/O buffer associated with the passed
+ * I/O buffer. May be zero.
+ */
+#define IOB_PEEK(IOB) ((IOB->cur > IOB->eod) ? (IOB->eod - IOB->cur) : 0)
+
+
+/* Bits for csp->content_type bitmask: */
+#define CT_TEXT 0x0001U /**< Suitable for pcrs filtering. */
+#define CT_GIF 0x0002U /**< Suitable for GIF filtering. */
+#define CT_TABOO 0x0004U /**< DO NOT filter, irrespective of other flags. */
+
+/* Although these are not, strictly speaking, content types
+ * (they are content encodings), it is simple to handle them
+ * as such.
+ */
+#define CT_GZIP 0x0010U /**< gzip-compressed data. */
+#define CT_DEFLATE 0x0020U /**< zlib-compressed data. */
+
+/**
+ * Flag to signal that the server declared the content type,
+ * so we can differentiate between unknown and undeclared
+ * content types.
+ */
+#define CT_DECLARED 0x0040U
+
+/**
+ * The mask which includes all actions.
+ */
+#define ACTION_MASK_ALL (~0UL)
+
+/**
+ * The most compatible set of actions - i.e. none.
+ */
+#define ACTION_MOST_COMPATIBLE 0x00000000UL
+
+/** Action bitmap: Block the request. */
+#define ACTION_BLOCK 0x00000001UL
+/** Action bitmap: Deanimate if it's a GIF. */
+#define ACTION_DEANIMATE 0x00000002UL
+/** Action bitmap: Downgrade HTTP/1.1 to 1.0. */
+#define ACTION_DOWNGRADE 0x00000004UL
+/** Action bitmap: Fast redirects. */
+#define ACTION_FAST_REDIRECTS 0x00000008UL
+/** Action bitmap: Remove or add "X-Forwarded-For" header. */
+#define ACTION_CHANGE_X_FORWARDED_FOR 0x00000010UL
+/** Action bitmap: Hide "From" header. */
+#define ACTION_HIDE_FROM 0x00000020UL
+/** Action bitmap: Hide "Referer" header. (sic - follow HTTP, not English). */
+#define ACTION_HIDE_REFERER 0x00000040UL
+/** Action bitmap: Hide "User-Agent" and similar headers. */
+#define ACTION_HIDE_USER_AGENT 0x00000080UL
+/** Action bitmap: This is an image. */
+#define ACTION_IMAGE 0x00000100UL
+/** Action bitmap: Sets the image blocker. */
+#define ACTION_IMAGE_BLOCKER 0x00000200UL
+/** Action bitmap: Prevent compression. */
+#define ACTION_NO_COMPRESSION 0x00000400UL
+/** Action bitmap: Change cookies to session only cookies. */
+#define ACTION_SESSION_COOKIES_ONLY 0x00000800UL
+/** Action bitmap: Block cookies coming from the client. */
+#define ACTION_CRUNCH_OUTGOING_COOKIES 0x00001000UL
+/** Action bitmap: Block cookies coming from the server. */
+#define ACTION_CRUNCH_INCOMING_COOKIES 0x00002000UL
+/** Action bitmap: Override the forward settings in the config file */
+#define ACTION_FORWARD_OVERRIDE 0x00004000UL
+/** Action bitmap: Block as empty document */
+#define ACTION_HANDLE_AS_EMPTY_DOCUMENT 0x00008000UL
+/** Action bitmap: Limit CONNECT requests to safe ports. */
+#define ACTION_LIMIT_CONNECT 0x00010000UL
+/** Action bitmap: Redirect request. */
+#define ACTION_REDIRECT 0x00020000UL
+/** Action bitmap: Crunch or modify "if-modified-since" header. */
+#define ACTION_HIDE_IF_MODIFIED_SINCE 0x00040000UL
+/** Action bitmap: Overwrite Content-Type header. */
+#define ACTION_CONTENT_TYPE_OVERWRITE 0x00080000UL
+/** Action bitmap: Crunch specified server header. */
+#define ACTION_CRUNCH_SERVER_HEADER 0x00100000UL
+/** Action bitmap: Crunch specified client header */
+#define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
+/** Action bitmap: Enable text mode by force */
+#define ACTION_FORCE_TEXT_MODE 0x00400000UL
+/** Action bitmap: Remove the "If-None-Match" header. */
+#define ACTION_CRUNCH_IF_NONE_MATCH 0x00800000UL
+/** Action bitmap: Enable content-disposition crunching */
+#define ACTION_HIDE_CONTENT_DISPOSITION 0x01000000UL
+/** Action bitmap: Replace or block Last-Modified header */
+#define ACTION_OVERWRITE_LAST_MODIFIED 0x02000000UL
+/** Action bitmap: Replace or block Accept-Language header */
+#define ACTION_HIDE_ACCEPT_LANGUAGE 0x04000000UL
+/** Action bitmap: Limit the cookie lifetime */
+#define ACTION_LIMIT_COOKIE_LIFETIME 0x08000000UL
+/** Action bitmap: Delay writes */
+#define ACTION_DELAY_RESPONSE 0x10000000UL
+/** Action bitmap: Turn https inspection on */
+#define ACTION_HTTPS_INSPECTION 0x20000000UL
+/** Action bitmap: Turn certificates verification off */
+#define ACTION_IGNORE_CERTIFICATE_ERRORS 0x40000000UL
+
+/** Action string index: How to deanimate GIFs */
+#define ACTION_STRING_DEANIMATE 0
+/** Action string index: Replacement for "From:" header */
+#define ACTION_STRING_FROM 1
+/** Action string index: How to block images */
+#define ACTION_STRING_IMAGE_BLOCKER 2
+/** Action string index: Replacement for "Referer:" header */
+#define ACTION_STRING_REFERER 3
+/** Action string index: Replacement for "User-Agent:" header */
+#define ACTION_STRING_USER_AGENT 4
+/** Action string index: Legal CONNECT ports. */
+#define ACTION_STRING_LIMIT_CONNECT 5
+/** Action string index: Server headers containing this pattern are crunched*/
+#define ACTION_STRING_SERVER_HEADER 6
+/** Action string index: Client headers containing this pattern are crunched*/
+#define ACTION_STRING_CLIENT_HEADER 7
+/** Action string index: Replacement for the "Accept-Language:" header*/
+#define ACTION_STRING_LANGUAGE 8
+/** Action string index: Replacement for the "Content-Type:" header*/
+#define ACTION_STRING_CONTENT_TYPE 9
+/** Action string index: Replacement for the "content-disposition:" header*/
+#define ACTION_STRING_CONTENT_DISPOSITION 10
+/** Action string index: Replacement for the "If-Modified-Since:" header*/
+#define ACTION_STRING_IF_MODIFIED_SINCE 11
+/** Action string index: Replacement for the "Last-Modified:" header. */
+#define ACTION_STRING_LAST_MODIFIED 12
+/** Action string index: Redirect URL */
+#define ACTION_STRING_REDIRECT 13
+/** Action string index: Decode before redirect? */
+#define ACTION_STRING_FAST_REDIRECTS 14
+/** Action string index: Overriding forward rule. */
+#define ACTION_STRING_FORWARD_OVERRIDE 15
+/** Action string index: Reason for the block. */
+#define ACTION_STRING_BLOCK 16
+/** Action string index: what to do with the "X-Forwarded-For" header. */
+#define ACTION_STRING_CHANGE_X_FORWARDED_FOR 17
+/** Action string index: how many minutes cookies should be valid. */
+#define ACTION_STRING_LIMIT_COOKIE_LIFETIME 18
+/** Action string index: how many milliseconds writes should be delayed. */
+#define ACTION_STRING_DELAY_RESPONSE 19
+/** Number of string actions. */
+#define ACTION_STRING_COUNT 20
+
+
+/* To make the ugly hack in sed easier to understand */
+#define CHECK_EVERY_HEADER_REMAINING 0
+
+
+/** Index into current_action_spec::multi[] for headers to add. */
+#define ACTION_MULTI_ADD_HEADER 0
+/** Index into current_action_spec::multi[] for content filters to apply. */
+#define ACTION_MULTI_FILTER 1
+/** Index into current_action_spec::multi[] for server-header filters to apply. */
+#define ACTION_MULTI_SERVER_HEADER_FILTER 2
+/** Index into current_action_spec::multi[] for client-header filters to apply. */
+#define ACTION_MULTI_CLIENT_HEADER_FILTER 3
+/** Index into current_action_spec::multi[] for client-header tags to apply. */
+#define ACTION_MULTI_CLIENT_HEADER_TAGGER 4
+/** Index into current_action_spec::multi[] for server-header tags to apply. */
+#define ACTION_MULTI_SERVER_HEADER_TAGGER 5
+/** Number of multi-string actions. */
+#define ACTION_MULTI_EXTERNAL_FILTER 6
+/** Number of multi-string actions. */
+#define ACTION_MULTI_COUNT 7
+
+
+/**
+ * This structure contains a list of actions to apply to a URL.
+ * It only contains positive instructions - no "-" options.
+ * It is not used to store the actions list itself, only for
+ * url_actions() to return the current values.
+ */
+struct current_action_spec
{
- char *str;
- struct list *last;
- struct list *next;
+ /** Actions to apply. A bit set to "1" means perform the action. */
+ unsigned long flags;
+
+ /**
+ * Parameters for those actions that require them.
+ * Each entry is valid if & only if the corresponding entry in "flags" is
+ * set.
+ */
+ char * string[ACTION_STRING_COUNT];
+
+ /** Lists of strings for multi-string actions. */
+ struct list multi[ACTION_MULTI_COUNT][1];
};
-#define IOB_PEEK(CSP) ((CSP->iob->cur > CSP->iob->eod) ? (CSP->iob->eod - CSP->iob->cur) : 0)
-#define IOB_RESET(CSP) if(CSP->iob->buf) free(CSP->iob->buf); memset(CSP->iob, '\0', sizeof(CSP->iob));
+/**
+ * This structure contains a set of changes to actions.
+ * It can contain both positive and negative instructions.
+ * It is used to store an entry in the actions list.
+ */
+struct action_spec
+{
+ unsigned long mask; /**< Actions to keep. A bit set to "0" means remove action. */
+ unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
+
+ /**
+ * Parameters for those actions that require them.
+ * Each entry is valid if & only if the corresponding entry in "flags" is
+ * set.
+ */
+ char * string[ACTION_STRING_COUNT];
-/* Constants defining bitmask for csp->accept_types */
+ /** Lists of strings to remove, for multi-string actions. */
+ struct list multi_remove[ACTION_MULTI_COUNT][1];
+
+ /** If nonzero, remove *all* strings from the multi-string action. */
+ int multi_remove_all[ACTION_MULTI_COUNT];
+
+ /** Lists of strings to add, for multi-string actions. */
+ struct list multi_add[ACTION_MULTI_COUNT][1];
+};
-#ifdef DETECT_MSIE_IMAGES
-/* MSIE detected by user-agent string */
-#define ACCEPT_TYPE_IS_MSIE 0x0001
+/**
+ * This structure is used to store action files.
+ *
+ * It contains an URL or tag pattern, and the changes to
+ * the actions. It's a linked list and should only be
+ * free'd through unload_actions_file() unless there's
+ * only a single entry.
+ */
+struct url_actions
+{
+ struct pattern_spec url[1]; /**< The URL or tag pattern. */
+
+ struct action_spec *action; /**< Action settings that might be shared with
+ the list entry before or after the current
+ one and can't be free'd willy nilly. */
+
+ struct url_actions *next; /**< Next action section in file, or NULL. */
+};
+
+enum forwarder_type {
+ /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
+ SOCKS_NONE = 0,
+ /**< original SOCKS 4 protocol */
+ SOCKS_4 = 40,
+ /**< SOCKS 4A, DNS resolution is done by the SOCKS server */
+ SOCKS_4A = 41,
+ /**< SOCKS 5 with hostnames, DNS resolution is done by the SOCKS server */
+ SOCKS_5 = 50,
+ /**< Like SOCKS5, but uses non-standard Tor extensions (currently only optimistic data) */
+ SOCKS_5T,
+ /**<
+ * Don't use a SOCKS server, forward to the specified webserver.
+ * The difference to SOCKS_NONE is that a request line without
+ * full URL is sent.
+ */
+ FORWARD_WEBSERVER,
+};
/*
- * *If* this is MSIE, it wants an image. (Or this is a shift-reload, or
- * it's got an image from this URL before... yuck!)
- * Only meaningful if ACCEPT_TYPE_IS_MSIE set
+ * Structure to hold the server socket and the information
+ * required to make sure we only reuse the connection if
+ * the host and forwarding settings are the same.
*/
-#define ACCEPT_TYPE_MSIE_IMAGE 0x0002
+struct reusable_connection
+{
+ jb_socket sfd;
+ int in_use;
+ time_t timestamp; /* XXX: rename? */
+
+ time_t request_sent;
+ time_t response_received;
+
+ /*
+ * Number of seconds after which this
+ * connection will no longer be reused.
+ */
+ unsigned int keep_alive_timeout;
+ /*
+ * Number of requests that were sent to this connection.
+ * This is currently only for debugging purposes.
+ */
+ unsigned int requests_sent_total;
+
+ char *host;
+ int port;
+ enum forwarder_type forwarder_type;
+ char *gateway_host;
+ int gateway_port;
+ char *forward_host;
+ int forward_port;
+};
+
/*
- * *If* this is MSIE, it wants a HTML document.
- * Only meaningful if ACCEPT_TYPE_IS_MSIE set
+ * Flags for use in csp->flags
+ */
+
+/**
+ * Flag for csp->flags: Set if this client is processing data.
+ * Cleared when the thread associated with this structure dies.
+ */
+#define CSP_FLAG_ACTIVE 0x01U
+
+/**
+ * Flag for csp->flags: Set if the server's reply is in "chunked"
+ * transfer encoding
+ */
+#define CSP_FLAG_CHUNKED 0x02U
+
+/**
+ * Flag for csp->flags: Set if this request was enforced, although it would
+ * normally have been blocked.
+ */
+#define CSP_FLAG_FORCED 0x04U
+
+/**
+ * Flag for csp->flags: Set if any modification to the body was done.
+ */
+#define CSP_FLAG_MODIFIED 0x08U
+
+/**
+ * Flag for csp->flags: Set if request was blocked.
+ */
+#define CSP_FLAG_REJECTED 0x10U
+
+/**
+ * Flag for csp->flags: Set if we are toggled on (FEATURE_TOGGLE).
+ */
+#define CSP_FLAG_TOGGLED_ON 0x20U
+
+/**
+ * Flag for csp->flags: Set if an acceptable Connection header
+ * has already been set by the client.
+ */
+#define CSP_FLAG_CLIENT_CONNECTION_HEADER_SET 0x00000040U
+
+/**
+ * Flag for csp->flags: Set if an acceptable Connection header
+ * has already been set by the server.
+ */
+#define CSP_FLAG_SERVER_CONNECTION_HEADER_SET 0x00000080U
+
+/**
+ * Flag for csp->flags: Signals header parsers whether they
+ * are parsing server or client headers.
+ */
+#define CSP_FLAG_CLIENT_HEADER_PARSING_DONE 0x00000100U
+
+/**
+ * Flag for csp->flags: Set if adding the Host: header
+ * isn't necessary.
+ */
+#define CSP_FLAG_HOST_HEADER_IS_SET 0x00000200U
+
+/**
+ * Flag for csp->flags: Set if filtering is disabled by X-Filter: No
+ * XXX: As we now have tags we might as well ditch this.
+ */
+#define CSP_FLAG_NO_FILTERING 0x00000400U
+
+/**
+ * Flag for csp->flags: Set the client IP has appended to
+ * an already existing X-Forwarded-For header in which case
+ * no new header has to be generated.
*/
-#define ACCEPT_TYPE_MSIE_HTML 0x0004
+#define CSP_FLAG_X_FORWARDED_FOR_APPENDED 0x00000800U
-#endif /* def DETECT_MSIE_IMAGES */
+/**
+ * Flag for csp->flags: Set if the server wants to keep
+ * the connection alive.
+ */
+#define CSP_FLAG_SERVER_CONNECTION_KEEP_ALIVE 0x00001000U
+/**
+ * Flag for csp->flags: Set if the server specified the
+ * content length.
+ */
+#define CSP_FLAG_SERVER_CONTENT_LENGTH_SET 0x00002000U
+
+/**
+ * Flag for csp->flags: Set if we know the content length,
+ * either because the server set it, or we figured it out
+ * on our own.
+ */
+#define CSP_FLAG_CONTENT_LENGTH_SET 0x00004000U
+
+/**
+ * Flag for csp->flags: Set if the client wants to keep
+ * the connection alive.
+ */
+#define CSP_FLAG_CLIENT_CONNECTION_KEEP_ALIVE 0x00008000U
+
+/**
+ * Flag for csp->flags: Set if we think we got the whole
+ * client request and shouldn't read any additional data
+ * coming from the client until the current request has
+ * been dealt with.
+ */
+#define CSP_FLAG_CLIENT_REQUEST_COMPLETELY_READ 0x00010000U
+
+/**
+ * Flag for csp->flags: Set if the server promised us to
+ * keep the connection open for a known number of seconds.
+ */
+#define CSP_FLAG_SERVER_KEEP_ALIVE_TIMEOUT_SET 0x00020000U
+
+/**
+ * Flag for csp->flags: Set if we think we can't reuse
+ * the server socket. XXX: It's also set after sabotaging
+ * pipelining attempts which is somewhat inconsistent with
+ * the name.
+ */
+#define CSP_FLAG_SERVER_SOCKET_TAINTED 0x00040000U
+
+/**
+ * Flag for csp->flags: Set if the Proxy-Connection header
+ * is among the server headers.
+ */
+#define CSP_FLAG_SERVER_PROXY_CONNECTION_HEADER_SET 0x00080000U
+
+/**
+ * Flag for csp->flags: Set if the client reused its connection.
+ */
+#define CSP_FLAG_REUSED_CLIENT_CONNECTION 0x00100000U
+
+/**
+ * Flag for csp->flags: Set if the supports deflate compression.
+ */
+#define CSP_FLAG_CLIENT_SUPPORTS_DEFLATE 0x00200000U
+
+/**
+ * Flag for csp->flags: Set if the content has been deflated by Privoxy
+ */
+#define CSP_FLAG_BUFFERED_CONTENT_DEFLATED 0x00400000U
+
+/**
+ * Flag for csp->flags: Set if we already read (parts of)
+ * a pipelined request in which case the client obviously
+ * isn't done talking.
+ */
+#define CSP_FLAG_PIPELINED_REQUEST_WAITING 0x00800000U
+/**
+ * Flag for csp->flags: Set if the client body is chunk-encoded
+ */
+#define CSP_FLAG_CHUNKED_CLIENT_BODY 0x01000000U
+
+/**
+ * Flag for csp->flags: Set if the client set the Expect header
+ */
+#define CSP_FLAG_UNSUPPORTED_CLIENT_EXPECTATION 0x02000000U
+
+/**
+ * Flag for csp->flags: Set if we answered the request ourselves.
+ */
+#define CSP_FLAG_CRUNCHED 0x04000000U
+
+#ifdef FUZZ
+/**
+ * Flag for csp->flags: Set if we are working with fuzzed input
+ */
+#define CSP_FLAG_FUZZED_INPUT 0x08000000U
+#endif
+
+/*
+ * Flags for use in return codes of child processes
+ */
+
+/**
+ * Flag for process return code: Set if exiting process has been toggled
+ * during its lifetime.
+ */
+#define RC_FLAG_TOGGLED 0x10
+
+/**
+ * Flag for process return code: Set if exiting process has blocked its
+ * request.
+ */
+#define RC_FLAG_BLOCKED 0x20
+
+/**
+ * Maximum number of actions/filter files. This limit is arbitrary - it's just used
+ * to size an array.
+ */
+#define MAX_AF_FILES 100
+
+/**
+ * Maximum number of sockets to listen to. This limit is arbitrary - it's just used
+ * to size an array.
+ */
+#define MAX_LISTENING_SOCKETS 10
+
+/**
+ * The state of a Privoxy processing thread.
+ */
struct client_state
{
- int send_user_cookie;
- int accept_server_cookie;
- int cfd;
- int sfd;
-
-#ifdef STATISTICS
- /* 1 if this URL was rejected, 0 otherwise. Allows actual stats inc to
- * occur in main thread only for thread-safety.
- */
- int rejected;
-#endif /* def STATISTICS */
+ /** The proxy's configuration */
+ struct configuration_spec * config;
+
+ /** The actions to perform on the current request */
+ struct current_action_spec action[1];
+
+ /** socket to talk to client (web browser) */
+ jb_socket cfd;
+
+ /** Number of requests received on the client socket. */
+ unsigned int requests_received_total;
+
+ /** current connection to the server (may go through a proxy) */
+ struct reusable_connection server_connection;
-#ifdef FORCE_LOAD
- int force;
-#endif /* def FORCE_LOAD */
+ /** Multi-purpose flag container, see CSP_FLAG_* above */
+ unsigned int flags;
+
+ /** Client PC's IP address, as reported by the accept() function.
+ As a string. */
+ char *ip_addr_str;
+#ifdef HAVE_RFC2553
+ /** Client PC's TCP address, as reported by the accept() function.
+ As a sockaddr. */
+ struct sockaddr_storage tcp_addr;
+#else
+ /** Client PC's IP address, as reported by the accept() function.
+ As a number. */
+ unsigned long ip_addr_long;
+#endif /* def HAVE_RFC2553 */
+
+ /** The host name and port (as a string of the form '<hostname>:<port>')
+ of the server socket to which the client connected. */
+ char *listen_addr_str;
+
+ /** The URL that was requested */
+ struct http_request http[1];
-#ifdef TOGGLE
/*
- * by haroon - most of credit to srt19170
- * We add an "on/off" toggle here that is used to effectively toggle
- * the Junkbuster off or on
+ * The final forwarding settings.
+ * XXX: Currently this is only used for forward-override,
+ * so we can free the space in sweep.
*/
- int toggled_on;
+ struct forward_spec * fwd;
+
+ /** An I/O buffer used for buffering data read from the server */
+ /* XXX: should be renamed to server_iob */
+ struct iob iob[1];
+
+#ifdef FEATURE_HTTPS_INSPECTION
+ mbedtls_connection_attr mbedtls_server_attr; /* attributes for connection to server */
+ mbedtls_connection_attr mbedtls_client_attr; /* attributes for connection to client */
#endif
- char *ip_addr_str;
- long ip_addr_long;
- char *referrer;
+ /** An I/O buffer used for buffering data read from the client */
+ struct iob client_iob[1];
-#if defined(DETECT_MSIE_IMAGES)
- /* Types the client will accept.
- * Bitmask - see ACCEPT_TYPE_XXX constants.
+ /** Buffer used to briefly store data read from the network
+ * before forwarding or processing it.
*/
- int accept_types;
-#endif /* defined(DETECT_MSIE_IMAGES) */
+ char *receive_buffer;
+ size_t receive_buffer_size;
- const struct gateway *gw;
- struct http_request http[1];
+ /** List of all headers for this request */
+ struct list headers[1];
- struct iob iob[1];
+#ifdef FEATURE_HTTPS_INSPECTION
+ /** List of all encrypted headers for this request */
+ struct list https_headers[1];
+#endif
- struct list headers[1];
- struct list cookie_list[1];
-#ifdef PCRS
- int is_text;
-#endif /* def PCRS */
+ /** List of all tags that apply to this request */
+ struct list tags[1];
- char *x_forwarded;
+#ifdef FEATURE_CLIENT_TAGS
+ /** List of all tags that apply to this client (assigned based on address) */
+ struct list client_tags[1];
+ /** The address of the client the request (presumably) came from.
+ * Either the address returned by accept(), or the address provided
+ * with the X-Forwarded-For header, provided Privoxy has been configured
+ * to use it.
+ */
+ char *client_address;
+#endif
- int active;
+ /** MIME-Type key, see CT_* above */
+ unsigned int content_type;
- /* files associated with this client */
- struct file_list *blist; /* blockfile */
- struct file_list *clist; /* cookiefile */
- struct file_list *flist; /* forwardfile */
+ /** Actions files associated with this client */
+ struct file_list *actions_list[MAX_AF_FILES];
-#ifdef ACL_FILES
- struct file_list *alist; /* aclfile */
-#endif /* def ACL_FILES */
+ /** pcrs job files. */
+ struct file_list *rlist[MAX_AF_FILES];
-#ifdef USE_IMAGE_LIST
- struct file_list *ilist; /* imagefile */
-#endif /* def USE_IMAGE_LIST */
+ /** Length after content modification. */
+ unsigned long long content_length;
-#ifdef KILLPOPUPS
- struct file_list *plist; /* kill popup file */
-#endif /* def KILLPOPUPS */
+ /* XXX: is this the right location? */
-#ifdef PCRS
- struct file_list *rlist; /* Perl re_filterfile */
-#endif /* def PCRS */
+ /** Expected length of content after which we
+ * should stop reading from the server socket.
+ */
+ unsigned long long expected_content_length;
-#ifdef TRUST_FILES
- struct file_list *tlist; /* trustfile */
-#endif /* def TRUST_FILES */
+ /** Expected length of content after which we
+ * should stop reading from the client socket.
+ */
+ unsigned long long expected_client_content_length;
- struct client_state *next;
-};
+#ifdef FEATURE_TRUST
+ /** Trust file. */
+ struct file_list *tlist;
-struct parsers
-{
- char *str;
- char len;
- char *(*parser)(const struct parsers *, char *, struct client_state *);
-};
+#endif /* def FEATURE_TRUST */
+
+ /**
+ * Failure reason to embedded in the CGI error page,
+ * or NULL. Currently only used for socks errors.
+ */
+ char *error_message;
+
+#ifdef FEATURE_HTTPS_INSPECTION
+ /* Result of server certificate verification */
+ uint32_t server_cert_verification_result;
+ /* Flag for certificate validity checking */
+ int dont_verify_certificate;
-struct interceptors
+ /*
+ * Flags if SSL connection with server or client is opened.
+ * Thanks to this flags, we can call function to close both connections
+ * and we don't have to care about more details.
+ */
+ int ssl_with_server_is_opened;
+ int ssl_with_client_is_opened;
+
+ /*
+ * Server certificate chain of trust including strings with certificates
+ * information and string with whole certificate file
+ */
+ struct certs_chain server_certs_chain;
+#endif
+};
+
+/**
+ * List of client states so the main thread can keep
+ * track of them and garbage collect their resources.
+ */
+struct client_states
{
- char *str;
- char len;
- char *(*interceptor)(struct http_request *http, struct client_state *csp);
+ struct client_states *next;
+ struct client_state csp;
};
+/**
+ * A function to add a header
+ */
+typedef jb_err (*add_header_func_ptr)(struct client_state *);
+
+/**
+ * A function to process a header
+ */
+typedef jb_err (*parser_func_ptr )(struct client_state *, char **);
-/* this allows the proxy to permit/block access to any host and/or path */
-struct url_spec
+/**
+ * List of available CGI functions.
+ */
+struct cgi_dispatcher
{
- char *spec;
- char *domain;
- char *dbuf;
- char **dvec;
- int dcnt;
- int toplevel;
-
- char *path;
- int pathlen;
- int port;
-#ifdef REGEX
- regex_t *preg;
-#endif
+ /** The URL of the CGI, relative to the CGI root. */
+ const char * const name;
+
+ /** The handler function for the CGI */
+ jb_err (* const handler)(struct client_state *csp, struct http_response *rsp, const struct map *parameters);
+
+ /** The description of the CGI, to appear on the main menu, or NULL to hide it. */
+ const char * const description;
+
+ /** A flag that indicates whether unintentional calls to this CGI can cause damage */
+ int harmless;
};
+/**
+ * A data file used by Privoxy. Kept in a linked list.
+ */
struct file_list
{
- /*
- * this is a pointer to the data structures associated with the file.
+ /**
+ * This is a pointer to the data structures associated with the file.
* Read-only once the structure has been created.
*/
void *f;
-
- /* Normally NULL. When we are finished with file (i.e. when we have
+
+ /**
+ * The unloader function.
+ * Normally NULL. When we are finished with file (i.e. when we have
* loaded a new one), set to a pointer to an unloader function.
* Unloader will be called by sweep() (called from main loop) when
- * all clients using this file are done. This prevents threading
+ * all clients using this file are done. This prevents threading
* problems.
*/
void (*unloader)(void *);
- /* Used internally by sweep(). Do not access from elsewhere. */
+ /**
+ * Used internally by sweep(). Do not access from elsewhere.
+ */
int active;
-#ifndef SPLIT_PROXY_ARGS
- /* String to be displayed as part of show-proxy-args display.
+ /**
+ * File last-modified time, so we can check if file has been changed.
* Read-only once the structure has been created.
*/
- char *proxy_args;
-#endif /* ndef SPLIT_PROXY_ARGS */
+ time_t lastmodified;
- /* Following variables allow us to check if file has been changed.
- * Read-only once the structure has been created.
+ /**
+ * The full filename.
*/
- time_t lastmodified;
char * filename;
- /* Pointer to next entry in the linked list of all "file_list"s.
+ /**
+ * Pointer to next entry in the linked list of all "file_list"s.
* This linked list is so that sweep() can navigate it.
* Since sweep() can remove items from the list, we must be careful
* to only access this value from main thread (when we know sweep
};
+#ifdef FEATURE_TRUST
+
+/**
+ * The format of a trust file when loaded into memory.
+ */
struct block_spec
{
- struct url_spec url[1];
- int reject;
- struct block_spec *next;
+ struct pattern_spec url[1]; /**< The URL pattern */
+ int reject; /**< FIXME: Please document this! */
+ struct block_spec *next; /**< Next entry in linked list */
};
+/**
+ * Arbitrary limit for the number of trusted referrers.
+ */
+#define MAX_TRUSTED_REFERRERS 512
+
+#endif /* def FEATURE_TRUST */
-struct cookie_spec
+/**
+ * How to forward a connection to a parent proxy.
+ */
+struct forward_spec
{
- struct url_spec url[1];
- int send_user_cookie;
- int accept_server_cookie;
- struct cookie_spec *next;
+ /** URL pattern that this forward_spec is for. */
+ struct pattern_spec url[1];
+
+ /** Connection type. Must be SOCKS_NONE, SOCKS_4, SOCKS_4A or SOCKS_5. */
+ enum forwarder_type type;
+
+ /** SOCKS server hostname. Only valid if "type" is SOCKS_4 or SOCKS_4A. */
+ char *gateway_host;
+
+ /** SOCKS server port. */
+ int gateway_port;
+
+ /** SOCKS5 username. */
+ char *auth_username;
+
+ /** SOCKS5 password. */
+ char *auth_password;
+
+ /** Parent HTTP proxy hostname, or NULL for none. */
+ char *forward_host;
+
+ /** Parent HTTP proxy port. */
+ int forward_port;
+
+ /** Next entry in the linked list. */
+ struct forward_spec *next;
};
-struct forward_spec
+/* Supported filter types */
+enum filter_type
{
- struct url_spec url[1];
- int reject;
- struct gateway gw[1];
- struct forward_spec *next;
+ FT_CONTENT_FILTER = 0,
+ FT_CLIENT_HEADER_FILTER = 1,
+ FT_SERVER_HEADER_FILTER = 2,
+ FT_CLIENT_HEADER_TAGGER = 3,
+ FT_SERVER_HEADER_TAGGER = 4,
+#ifdef FEATURE_EXTERNAL_FILTERS
+ FT_EXTERNAL_CONTENT_FILTER = 5,
+#endif
+ FT_INVALID_FILTER = 42,
};
+#ifdef FEATURE_EXTERNAL_FILTERS
+#define MAX_FILTER_TYPES 6
+#else
+#define MAX_FILTER_TYPES 5
+#endif
-#ifdef PCRS
+/**
+ * This struct represents one filter (one block) from
+ * the re_filterfile. If there is more than one filter
+ * in the file, the file will be represented by a
+ * chained list of re_filterfile specs.
+ */
struct re_filterfile_spec
{
- struct list patterns[1];
- /* See README.re_filter */
- pcrs_job *joblist;
+ char *name; /**< Name from FILTER: statement in re_filterfile. */
+ char *description; /**< Description from FILTER: statement in re_filterfile. */
+ struct list patterns[1]; /**< The patterns from the re_filterfile. */
+ pcrs_job *joblist; /**< The resulting compiled pcrs_jobs. */
+ enum filter_type type; /**< Filter type (content, client-header, server-header). */
+ int dynamic; /**< Set to one if the pattern might contain variables
+ and has to be recompiled for every request. */
+ struct re_filterfile_spec *next; /**< The pointer for chaining. */
};
-#endif /* def PCRS */
-#ifdef KILLPOPUPS
-/* Entries on popup blocklist */
-struct popup_blocklist
+#ifdef FEATURE_ACL
+
+#define ACL_PERMIT 1 /**< Accept connection request */
+#define ACL_DENY 2 /**< Reject connection request */
+
+/**
+ * An IP address pattern. Used to specify networks in the ACL.
+ */
+struct access_control_addr
{
- char *host_name;
- struct popup_blocklist *next;
+#ifdef HAVE_RFC2553
+ struct sockaddr_storage addr; /* <The TCP address in network order. */
+ struct sockaddr_storage mask; /* <The TCP mask in network order. */
+#else
+ unsigned long addr; /**< The IP address as an integer. */
+ unsigned long mask; /**< The network mask as an integer. */
+ unsigned long port; /**< The port number. */
+#endif /* HAVE_RFC2553 */
};
-/* Actual type used in file object */
-struct popup_settings
+/**
+ * An access control list (ACL) entry.
+ *
+ * This is a linked list.
+ */
+struct access_control_list
{
- struct popup_blocklist *blocked;
- struct popup_blocklist *allowed;
+ struct access_control_addr src[1]; /**< Client IP address */
+ struct access_control_addr dst[1]; /**< Website or parent proxy IP address */
+#ifdef HAVE_RFC2553
+ int wildcard_dst; /** < dst address is wildcard */
+#endif
+
+ short action; /**< ACL_PERMIT or ACL_DENY */
+ struct access_control_list *next; /**< The next entry in the ACL. */
};
-#endif /* def KILLPOPUPS */
-#ifdef ACL_FILES
-#define ACL_PERMIT 1 /* accept connection request */
-#define ACL_DENY 2 /* reject connection request */
+#endif /* def FEATURE_ACL */
-struct access_control_addr
+
+/** Maximum number of loaders (actions, re_filter, ...) */
+#define NLOADERS 8
+
+/**
+ * This struct represents a client-spcific-tag and it's description
+ */
+struct client_tag_spec
{
- unsigned long addr;
- unsigned long mask;
- unsigned long port;
+ char *name; /**< Name from "client-specific-tag bla" directive */
+ char *description; /**< Description from "client-specific-tag-description " directive */
+ struct client_tag_spec *next; /**< The pointer for chaining. */
};
-struct access_control_list
+/** configuration_spec::feature_flags: CGI actions editor. */
+#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
+
+/** configuration_spec::feature_flags: Web-based toggle. */
+#define RUNTIME_FEATURE_CGI_TOGGLE 2U
+
+/** configuration_spec::feature_flags: HTTP-header-based toggle. */
+#define RUNTIME_FEATURE_HTTP_TOGGLE 4U
+
+/** configuration_spec::feature_flags: Split large forms to limit the number of GET arguments. */
+#define RUNTIME_FEATURE_SPLIT_LARGE_FORMS 8U
+
+/** configuration_spec::feature_flags: Check the host header for requests with host-less request lines. */
+#define RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS 16U
+
+/** configuration_spec::feature_flags: Don't allow to circumvent blocks with the force prefix. */
+#define RUNTIME_FEATURE_ENFORCE_BLOCKS 32U
+
+/** configuration_spec::feature_flags: Allow to block or redirect CGI requests. */
+#define RUNTIME_FEATURE_CGI_CRUNCHING 64U
+
+/** configuration_spec::feature_flags: Try to keep the connection to the server alive. */
+#define RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE 128U
+
+/** configuration_spec::feature_flags: Share outgoing connections between different client connections. */
+#define RUNTIME_FEATURE_CONNECTION_SHARING 256U
+
+/** configuration_spec::feature_flags: Pages blocked with +handle-as-empty-doc get a return status of 200 OK. */
+#define RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK 512U
+
+/** configuration_spec::feature_flags: Buffered content is sent compressed if the client supports it. */
+#define RUNTIME_FEATURE_COMPRESSION 1024U
+
+/** configuration_spec::feature_flags: Pipelined requests are served instead of being discarded. */
+#define RUNTIME_FEATURE_TOLERATE_PIPELINING 2048U
+
+/** configuration_spec::feature_flags: Proxy authentication headers are forwarded instead of removed. */
+#define RUNTIME_FEATURE_FORWARD_PROXY_AUTHENTICATION_HEADERS 4096U
+
+/**
+ * Data loaded from the configuration file.
+ *
+ * (Anomaly: toggle is still handled through a global, not this structure)
+ */
+struct configuration_spec
{
- struct access_control_addr src[1];
- struct access_control_addr dst[1];
+ /** What to log */
+ int debug;
+
+ /** Nonzero to enable multithreading. */
+ int multi_threaded;
+
+ /** Bitmask of features that can be controlled through the config file. */
+ unsigned feature_flags;
+
+ /** The log file name. */
+ const char *logfile;
+
+ /** The config file directory. */
+ const char *confdir;
+
+ /** The directory for customized CGI templates. */
+ const char *templdir;
+
+ /** "Cross-origin resource sharing" (CORS) allowed origin */
+ const char *cors_allowed_origin;
+
+#ifdef FEATURE_EXTERNAL_FILTERS
+ /** The template used to create temporary files. */
+ const char *temporary_directory;
+#endif
+
+ /** The log file directory. */
+ const char *logdir;
+
+ /** The full paths to the actions files. */
+ const char *actions_file[MAX_AF_FILES];
+
+ /** The short names of the actions files. */
+ const char *actions_file_short[MAX_AF_FILES];
+
+ /** The administrator's email address */
+ char *admin_address;
+
+ /** A URL with info on this proxy */
+ char *proxy_info_url;
+
+ /** URL to the user manual (on our website or local copy) */
+ char *usermanual;
+
+ /** The file names of the pcre filter files. */
+ const char *re_filterfile[MAX_AF_FILES];
+
+ /** The short names of the pcre filter files. */
+ const char *re_filterfile_short[MAX_AF_FILES];
+
+ /**< List of ordered client header names. */
+ struct list ordered_client_headers[1];
+
+ /** The hostname to show on CGI pages, or NULL to use the real one. */
+ const char *hostname;
+
+ /** IP addresses to bind to. Defaults to HADDR_DEFAULT == 127.0.0.1. */
+ const char *haddr[MAX_LISTENING_SOCKETS];
+
+ /** Trusted referring site that can be used to reach CGI
+ * pages that aren't marked as harmful.
+ */
+ const char *trusted_cgi_referrer;
+
+ /** Ports to bind to. Defaults to HADDR_PORT == 8118. */
+ int hport[MAX_LISTENING_SOCKETS];
- short action;
- struct access_control_list *next;
+ /** Size limit for IOB */
+ size_t buffer_limit;
+
+ /** Size of the receive buffer */
+ size_t receive_buffer_size;
+
+ /** Use accf_http(4) if available */
+ int enable_accept_filter;
+
+ /** Backlog passed to listen() */
+ int listen_backlog;
+
+#ifdef FEATURE_TRUST
+
+ /** The file name of the trust file. */
+ const char * trustfile;
+
+ /** FIXME: DOCME: Document this. */
+ struct list trust_info[1];
+
+ /** FIXME: DOCME: Document this. */
+ struct pattern_spec *trust_list[MAX_TRUSTED_REFERRERS];
+
+#endif /* def FEATURE_TRUST */
+
+#ifdef FEATURE_CLIENT_TAGS
+ struct client_tag_spec client_tags[1];
+
+ /* Maximum number of seconds a temporarily enabled tag stays enabled. */
+ unsigned int client_tag_lifetime;
+#endif /* def FEATURE_CLIENT_TAGS */
+ int trust_x_forwarded_for;
+
+#ifdef FEATURE_ACL
+
+ /** The access control list (ACL). */
+ struct access_control_list *acl;
+
+#endif /* def FEATURE_ACL */
+
+ /** Information about parent proxies (forwarding). */
+ struct forward_spec *forward;
+
+ /** Number of retries in case a forwarded connection attempt fails */
+ int forwarded_connect_retries;
+
+ /** Maximum number of client connections. */
+ int max_client_connections;
+
+ /* Timeout when waiting on sockets for data to become available. */
+ int socket_timeout;
+
+#ifdef FEATURE_CONNECTION_KEEP_ALIVE
+ /* Maximum number of seconds after which an open connection will no longer be reused. */
+ unsigned int keep_alive_timeout;
+
+ /* Assumed server-side keep alive timeout if none is specified. */
+ unsigned int default_server_timeout;
+#endif
+
+#ifdef FEATURE_COMPRESSION
+ int compression_level;
+#endif
+
+ /** All options from the config file, HTML-formatted. */
+ char *proxy_args;
+
+ /** The configuration file object. */
+ struct file_list *config_file_list;
+
+ /** List of loaders */
+ int (*loaders[NLOADERS])(struct client_state *);
+
+ /** Nonzero if we need to bind() to the new port. */
+ int need_bind;
+
+#ifdef FEATURE_HTTPS_INSPECTION
+ /** Password for proxy ca file **/
+ char * ca_password;
+
+ /** Directory with files of ca **/
+ char *ca_directory;
+
+ /** Filename of ca certificate **/
+ char * ca_cert_file;
+
+ /** Filename of ca key **/
+ char * ca_key_file;
+
+ /** Directory for saving certificates and keys for each webpage **/
+ char *certificate_directory;
+
+ /** Filename of trusted CAs certificates **/
+ char * trusted_cas_file;
+#endif
};
-#endif /* def ACL_FILES */
+/** Calculates the number of elements in an array, using sizeof. */
#define SZ(X) (sizeof(X) / sizeof(*X))
-#define WHITEBG "<body bgcolor=\"#ffffff\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
-#define BODY "<body bgcolor=\"#f8f8f0\" link=\"#000078\" alink=\"#ff0022\" vlink=\"#787878\">\n"
-#define BANNER "<strong>Internet J<small>UNK<i><font color=\"red\">BUSTER</font></i></small></strong>"
-
-#ifdef FORCE_LOAD
-/*\r
- * FIXME: Unfortunately, IE lowercases the domain name. JunkBuster does\r
- * a case-sensitive compare. JunkBuster should be modified to do a\r
- * case-insensitive compatison. As a temporary workaround, I've lowercased\r
- * the FORCE_PREFIX.\r
- *\r
- * #define FORCE_PREFIX "IJB-FORCE-LOAD-"\r
- */\r
-#define FORCE_PREFIX "ijb-force-load-"\r
-#endif /* def FORCE_LOAD */
-
-#define HOME_PAGE_URL "http://ijbswa.sourceforge.net/"
-#define REDIRECT_URL HOME_PAGE_URL "redirect.php?v=" VERSION "&to="
-
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
+/** The force load URL prefix. Not behind an ifdef because
+ * it's always used for the show-status page. */
+#define FORCE_PREFIX "/PRIVOXY-FORCE"
+
+#ifdef FEATURE_NO_GIFS
+/** The MIME type for images ("image/png" or "image/gif"). */
+#define BUILTIN_IMAGE_MIMETYPE "image/png"
+#else
+#define BUILTIN_IMAGE_MIMETYPE "image/gif"
+#endif /* def FEATURE_NO_GIFS */
+
+
+/*
+ * Hardwired URLs
+ */
+
+/** URL for the Privoxy home page. */
+#define HOME_PAGE_URL "https://www.privoxy.org/"
+
+/** URL for the Privoxy user manual. */
+#define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
+
+/** Prefix for actions help links (append to USER_MANUAL_URL). */
+#define ACTIONS_HELP_PREFIX "actions-file.html#"
+
+/** Prefix for config option help links (append to USER_MANUAL_URL). */
+#define CONFIG_HELP_PREFIX "config.html#"
+
+/*
+ * The "hosts" to intercept and display CGI pages.
+ * First one is a hostname only, second one can specify host and path.
+ *
+ * Notes:
+ * 1) Do not specify the http: prefix
+ * 2) CGI_SITE_2_PATH must not end with /, one will be added automatically.
+ * 3) CGI_SITE_2_PATH must start with /, unless it is the empty string.
+ */
+#define CGI_SITE_1_HOST "p.p"
+#define CGI_SITE_2_HOST "config.privoxy.org"
+#define CGI_SITE_2_PATH ""
+
+/**
+ * The prefix for CGI pages. Written out in generated HTML.
+ * INCLUDES the trailing slash.
+ */
+#define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
+#define CGI_PREFIX_HTTPS "https://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
-#endif /* ndef _PROJECT_H */
+#endif /* ndef PROJECT_H_INCLUDED */
/*
Local Variables: