X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=427483216f2addef8afc218d276d0cf40f53c14b;hp=84bde7e55c5bb24a3284728365cacfc284cdd6a3;hb=c1c254de39540a55a837a6ab24b6a4ce22fc7fa2;hpb=3e837e6e9561de90b1db799199f8036977cb36b0
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 84bde7e5..42748321 100644
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,7 +3,7 @@
Purpose : Used with other docs and files only.
- Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
@@ -90,7 +90,7 @@
Sample Configuration File for Privoxy &p-version;
-Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
+Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
@@ -107,7 +107,8 @@ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
4. ACCESS CONTROL AND SECURITY #
5. FORWARDING #
6. MISCELLANEOUS #
- 7. WINDOWS GUI OPTIONS #
+ 7. TLS #
+ 8. WINDOWS GUI OPTIONS #
#
##################################################################
@@ -1015,7 +1016,7 @@ actionsfile
The available debug levels are:
- debug 1 # Log the destination for each request &my-app; let through. See also debug 1024.
+ debug 1 # Log the destination for each request. See also debug 1024.
debug 2 # show each connection status
debug 4 # show I/O status
debug 8 # show header parsing
@@ -1259,6 +1260,9 @@ actionsfile
If the specified address isn't available on the system, or if the
hostname can't be resolved, Privoxy
will fail to start.
+ On GNU/Linux, and other platforms that can listen on not yet assigned IP
+ addresses, Privoxy will start and will listen on the specified
+ address whenever the IP address is assigned to the system
IPv6 addresses containing colons have to be quoted by brackets.
@@ -1673,7 +1677,7 @@ ACLs: permit-access and deny-access
If your system implements
RFC 3493, then
src_addr and dst_addr can be IPv6 addresses delimeted by
+ class="parameter">dst_addr can be IPv6 addresses delimited by
brackets, port can be a number
or a service name, and
src_masklen and
@@ -1983,6 +1987,11 @@ ACLs: permit-access and deny-access
Requests are accepted if the specified trusted-cgi-refer is the prefix
of the Referer.
+
+ If the trusted source is supposed to access the CGI pages via
+ JavaScript the cors-allowed-origin
+ option can be used.
+
Declaring pages the admin doesn't control trustworthy may allow
@@ -1994,7 +2003,75 @@ ACLs: permit-access and deny-access
-@@trusted-cgi-referer http://www.example.org/local-privoxy-control-page]]>
+@@#trusted-cgi-referer http://www.example.org/local-privoxy-control-page]]>
+
+
+
+
+cors-allowed-origin
+
+
+ Specifies:
+
+
+ A trusted website which can access &my-app;'s CGI pages through JavaScript.
+
+
+
+
+ Type of value:
+
+ URL
+
+
+
+ Default value:
+
+ Unset
+
+
+
+ Effect if unset:
+
+
+ No external sites get access via cross-origin resource sharing.
+
+
+
+
+ Notes:
+
+
+ Modern browsers by default prevent cross-origin requests made
+ via JavaScript to &my-app;'s CGI interface even if &my-app;
+ would trust the referer because it's white listed via the
+ trusted-cgi-referer
+ directive.
+
+
+ Cross-origin resource sharing (CORS) is a mechanism to allow
+ cross-origin requests.
+
+
+ The cors-allowed-origin option can be used to specify
+ a domain that is allowed to make requests to Privoxy CGI interface
+ via JavaScript. It is used in combination with the
+ trusted-cgi-referer
+ directive.
+
+
+
+ Declaring domains the admin doesn't control trustworthy may allow
+ malicious third parties to modify Privoxy's internal state against
+ the user's wishes and without the user's knowledge.
+
+
+
+
+
+
+@@#cors-allowed-origin http://www.example.org/]]>
@@ -2153,7 +2230,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
target_pattern
- socks_proxy[:port]
+ [user:pass@]socks_proxy[:port]
http_parent[:port]
@@ -2166,7 +2243,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
(http_parent
may be . to denote no HTTP forwarding), and the optional
port parameters are TCP ports,
- i.e. integer values from 1 to 65535
+ i.e. integer values from 1 to 65535. user and
+ pass can be used for SOCKS5 authentication if required.
@@ -2242,6 +2320,13 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
forward-socks4 / socks-gw.example.com:1080 .
+
+ To connect SOCKS5 proxy which requires username/password authentication:
+
+
+ forward-socks5 / user:pass@socks-gw.example.com:1080 .
+
+
To chain Privoxy and Tor, both running on the same system, you would use
something like:
@@ -3150,13 +3235,13 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
Under high load incoming connection may queue up before Privoxy
- gets around to serve them. The queue length is limitted by the
+ gets around to serve them. The queue length is limited by the
operating system. Once the queue is full, additional connections
are dropped before Privoxy can accept and serve them.
Increasing the queue length allows Privoxy to accept more
- incomming connections that arrive roughly at the same time.
+ incoming connections that arrive roughly at the same time.
Note that Privoxy can only request a certain queue length,
@@ -3597,7 +3682,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
# Define a couple of tags, the described effect requires action sections
# that are enabled based on CLIENT-TAG patterns.
client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
- disable-content-filters Disable content-filters but do not affect other actions
+ client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
@@ -3814,6 +3899,395 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
+
+
+TLS/SSL Inspection
+
+
+
+ca-directory
+
+
+ Specifies:
+
+
+ Directory with the CA key, the CA certificate and the trusted CAs file.
+
+
+
+
+ Type of value:
+
+
+ Text
+
+
+
+
+ Default value:
+
+ Empty string
+
+
+
+ Effect if unset:
+
+
+ Default value is used.
+
+
+
+
+ Notes:
+
+
+ This directive specifies the directory where the
+ CA key, the CA certificate and the trusted CAs file
+ are located.
+
+
+ The permissions should only let &my-app; and the &my-app;
+ admin access the directory.
+
+
+
+
+ Examples:
+
+
+ ca-directory /usr/local/etc/privoxy/CA
+
+
+
+
+@@#ca-directory /usr/local/etc/privoxy/CA]]>
+
+
+
+
+
+
+ca-cert-file
+
+
+ Specifies:
+
+
+ The CA certificate file in ".crt" format.
+
+
+
+
+ Type of value:
+
+
+ Text
+
+
+
+
+ Default value:
+
+ cacert.crt
+
+
+
+ Effect if unset:
+
+
+ Default value is used.
+
+
+
+
+ Notes:
+
+
+ This directive specifies the name of the CA certificate file
+ in ".crt" format.
+
+
+ The file is used by &my-app; to generate website certificates
+ when https inspection is enabled with the
+ https-inspection
+ action.
+
+
+ &my-app; clients should import the certificate so that they
+ can validate the generated certificates.
+
+
+ The file can be generated with:
+ openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.crt -days 3650
+
+
+
+
+ Examples:
+
+
+ ca-cert-file root.crt
+
+
+
+
+@@#ca-cert-file cacert.crt]]>
+
+
+
+
+
+
+ca-key-file
+
+
+ Specifies:
+
+
+ The CA key file in ".pem" format.
+
+
+
+
+ Type of value:
+
+
+ Text
+
+
+
+
+ Default value:
+
+ cacert.pem
+
+
+
+ Effect if unset:
+
+
+ Default value is used.
+
+
+
+
+ Notes:
+
+
+ This directive specifies the name of the CA key file
+ in ".pem" format. See the ca-cert-file
+ for a command to generate it.
+
+
+
+
+ Examples:
+
+
+ ca-key-file cakey.pem
+
+
+
+
+@@#ca-key-file root.pem]]>
+
+
+
+
+
+
+ca-password
+
+
+ Specifies:
+
+
+ The password for the CA keyfile.
+
+
+
+
+ Type of value:
+
+
+ Text
+
+
+
+
+ Default value:
+
+ Empty string
+
+
+
+ Effect if unset:
+
+
+ Default value is used.
+
+
+
+
+ Notes:
+
+
+ This directive specifies the password for the CA keyfile
+ that is used when Privoxy generates certificates for intercepted
+ requests.
+
+
+ Note that the password is shown on the CGI page so don't
+ reuse an important one.
+
+
+
+
+ Examples:
+
+
+ ca-password blafasel
+
+
+
+
+@@#ca-password swordfish]]>
+
+
+
+
+
+
+certificate-directory
+
+
+ Specifies:
+
+
+ Directory to save generated keys and certificates.
+
+
+
+
+ Type of value:
+
+
+ Text
+
+
+
+
+ Default value:
+
+ ./certs
+
+
+
+ Effect if unset:
+
+
+ Default value is used.
+
+
+
+
+ Notes:
+
+
+ This directive specifies the directory where generated
+ TLS/SSL keys and certificates are saved when https inspection
+ is enabled with the
+ https-inspection
+ action.
+
+
+ The keys and certificates currently have to be deleted manually
+ when changing the ca-cert-file
+ and the ca-cert-key.
+
+
+ The permissions should only let &my-app; and the &my-app;
+ admin access the directory.
+
+
+
+
+ Examples:
+
+
+ certificate-directory /usr/local/var/privoxy/certs
+
+
+
+
+@@#certificate-directory /usr/local/var/privoxy/certs]]>
+
+
+
+
+
+
+trusted-cas-file
+
+
+ Specifies:
+
+
+ The trusted CAs file in ".pem" format.
+
+
+
+
+ Type of value:
+
+
+ File name relative to ca-directory
+
+
+
+
+ Default value:
+
+ trustedCAs.pem
+
+
+
+ Effect if unset:
+
+
+ Default value is used.
+
+
+
+
+ Notes:
+
+
+ This directive specifies the trusted CAs file that is used when validating
+ certificates for intercepted TLS/SSL requests.
+
+
+ An example file can be downloaded from
+ https://curl.haxx.se/ca/cacert.pem.
+
+
+
+
+ Examples:
+
+
+ trusted-cas-file trusted_cas_file.pem
+
+
+
+
+@@#trusted-cas-file trustedCAs.pem]]>
+
+
+
+
+
+