#ifndef PROJECT_H_INCLUDED
#define PROJECT_H_INCLUDED
-/** Version string. */
-#define PROJECT_H_VERSION "$Id: project.h,v 1.197 2013/11/24 14:21:58 fabiankeil Exp $"
/*********************************************************************
*
* File : $Source: /cvsroot/ijbswa/current/project.h,v $
* project. Does not define any variables or functions
* (though it does declare some macros).
*
- * Copyright : Written by and Copyright (C) 2001-2012 the
+ * Copyright : Written by and Copyright (C) 2001-2014 the
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
# include <sys/socket.h>
# else
# include <stdint.h>
-# include <winsock2.h>
# include <ws2tcpip.h>
typedef unsigned short in_port_t;
# endif
#endif
-#ifdef __cplusplus
-extern "C" {
-#endif
-
#ifdef _WIN32
typedef SOCKET jb_socket;
* A standard error code. This should be JB_ERR_OK or one of the JB_ERR_xxx
* series of errors.
*/
-typedef int jb_err;
+enum privoxy_err
+{
+ 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 */
+};
-#define JB_ERR_OK 0 /**< Success, no error */
-#define JB_ERR_MEMORY 1 /**< Out of memory */
-#define JB_ERR_CGI_PARAMS 2 /**< Missing or corrupt CGI parameters */
-#define JB_ERR_FILE 3 /**< Error opening, reading or writing a file */
-#define JB_ERR_PARSE 4 /**< Error parsing file */
-#define JB_ERR_MODIFIED 5 /**< File has been modified outside of the
- CGI actions editor. */
-#define 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.
*/
#define HOSTENT_BUFFER_SIZE 2048
-/**
- * Do not use. Originally this was so that you can
- * say "while (FOREVER) { ...do something... }".
- * However, this gives a warning with some compilers (e.g. VC++).
- * Instead, use "for (;;) { ...do something... }".
- */
-#define FOREVER 1
-
/**
* Default TCP/IP address to listen on, as a string.
* Set to "127.0.0.1:8118".
*/
#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
#define ACTION_CRUNCH_CLIENT_HEADER 0x00200000UL
/** Action bitmap: Enable text mode by force */
#define ACTION_FORCE_TEXT_MODE 0x00400000UL
-/** Action bitmap: Enable text mode by force */
+/** 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
/** 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_COUNT 6
+#define ACTION_MULTI_EXTERNAL_FILTER 6
+/** Number of multi-string actions. */
+#define ACTION_MULTI_COUNT 7
/**
unsigned long add; /**< Actions to add. A bit set to "1" means add action. */
/**
- * Paramaters for those actions that require them.
+ * Parameters for those actions that require them.
* Each entry is valid if & only if the corresponding entry in "flags" is
* set.
*/
};
enum forwarder_type {
- /**< Don't use a SOCKS server */
+ /**< Don't use a SOCKS server, forward to a HTTP proxy directly */
SOCKS_NONE = 0,
/**< original SOCKS 4 protocol */
SOCKS_4 = 40,
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,
};
/*
*/
#define CSP_FLAG_TOGGLED_ON 0x20U
-/**
- * Flag for csp->flags: Set if we answered the request ourselve.
- */
-#define CSP_FLAG_CRUNCHED 0x40U
-
/**
* Flag for csp->flags: Set if an acceptable Connection header
* has already been set by the client.
*/
#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 ourselve.
+ */
+#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 porcess has been toggled
+ * 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 porcess has blocked its
+ * Flag for process return code: Set if exiting process has blocked its
* request.
*/
#define RC_FLAG_BLOCKED 0x20
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];
/** An I/O buffer used for buffering data read from the client */
struct iob client_iob[1];
+ /** Buffer used to briefly store data read from the network
+ * before forwarding or processing it.
+ */
+ char *receive_buffer;
+ size_t receive_buffer_size;
+
/** List of all headers for this request */
struct list headers[1];
/** List of all tags that apply to this request */
struct list tags[1];
+#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
+
/** MIME-Type key, see CT_* above */
unsigned int content_type;
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
/**
* This struct represents one filter (one block) from
/** 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
+{
+ 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. */
+};
/** configuration_spec::feature_flags: CGI actions editor. */
#define RUNTIME_FEATURE_CGI_EDIT_ACTIONS 1U
/** Nonzero to enable multithreading. */
int multi_threaded;
- /**
- * Bitmask of features that can be enabled/disabled through the config
- * file. Currently defined bits:
- *
- * - RUNTIME_FEATURE_CGI_EDIT_ACTIONS
- * - RUNTIME_FEATURE_CGI_TOGGLE
- * - RUNTIME_FEATURE_HTTP_TOGGLE
- * - RUNTIME_FEATURE_SPLIT_LARGE_FORMS
- * - RUNTIME_FEATURE_ACCEPT_INTERCEPTED_REQUESTS
- * - RUNTIME_FEATURE_ENFORCE_BLOCKS
- * - RUNTIME_FEATURE_CGI_CRUNCHING
- * - RUNTIME_FEATURE_CONNECTION_KEEP_ALIVE
- * - RUNTIME_FEATURE_CONNECTION_SHARING
- * - RUNTIME_FEATURE_EMPTY_DOC_RETURNS_OK
- */
+ /** Bitmask of features that can be controlled through the config file. */
unsigned feature_flags;
/** The log file name. */
/** The directory for customized CGI templates. */
const char *templdir;
+#ifdef FEATURE_EXTERNAL_FILTERS
+ /** The template used to create temporary files. */
+ const char *temporary_directory;
+#endif
+
/** The log file directory. */
const char *logdir;
/** 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];
/** 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. */
#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). */
/** Calculates the number of elements in an array, using sizeof. */
#define SZ(X) (sizeof(X) / sizeof(*X))
-#ifdef FEATURE_FORCE_LOAD
-/** The force load URL prefix. */
+/** The force load URL prefix. Not behind an ifdef because
+ * it's always used for the show-status page. */
#define FORCE_PREFIX "/PRIVOXY-FORCE"
-#endif /* def FEATURE_FORCE_LOAD */
#ifdef FEATURE_NO_GIFS
/** The MIME type for images ("image/png" or "image/gif"). */
*/
/** URL for the Privoxy home page. */
-#define HOME_PAGE_URL "http://www.privoxy.org/"
+#define HOME_PAGE_URL "https://www.privoxy.org/"
/** URL for the Privoxy user manual. */
#define USER_MANUAL_URL HOME_PAGE_URL VERSION "/user-manual/"
*/
#define CGI_PREFIX "http://" CGI_SITE_2_HOST CGI_SITE_2_PATH "/"
-#ifdef __cplusplus
-} /* extern "C" */
-#endif
-
#endif /* ndef PROJECT_H_INCLUDED */
/*