X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fp-config.sgml;h=0a9330dbe8061cbdb38f427ae49190981b653188;hb=4697cf05fcd27c0c559477f66d82784ebcb60b42;hp=2acf7fe5f6ad3b143f3ec664817e4bd627ae9176;hpb=8544684b8acfab273ee2c89b7236334833938fa2;p=privoxy.git diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index 2acf7fe5..0a9330db 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-2019 Privoxy Developers https://www.privoxy.org/ + Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/ See LICENSE. ======================================================================== @@ -90,7 +90,7 @@ Sample Configuration File for Privoxy &p-version; -Copyright (C) 2001-2019 Privoxy Developers https://www.privoxy.org/ +Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/ @@ -107,7 +107,7 @@ Copyright (C) 2001-2019 Privoxy Developers https://www.privoxy.org/ 4. ACCESS CONTROL AND SECURITY # 5. FORWARDING # 6. MISCELLANEOUS # - 7. TLS # + 7. HTTPS INSPECTION (EXPERIMENTAL) # 8. WINDOWS GUI OPTIONS # # ################################################################## @@ -241,22 +241,22 @@ II. FORMAT OF THE CONFIGURATION FILE Unix, in local filesystem (may not work with all browsers): -   user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ + user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/ Windows, in local filesystem, must use forward slash notation: -   user-manual  file:/c:/some-dir/privoxy-&p-version;/user-manual/ + user-manual file:/c:/some-dir/privoxy-&p-version;/user-manual/ Windows, UNC notation (with forward slashes): -   user-manual  file://///some-server/some-path/privoxy-&p-version;/user-manual/ + user-manual file://///some-server/some-path/privoxy-&p-version;/user-manual/ --> The best all purpose solution is simply to put the full local PATH to where the User Manual is located: - user-manual /usr/share/doc/privoxy/user-manual + user-manual /usr/share/doc/privoxy/user-manual The User Manual is then available to anyone with access to Privoxy, by following the built-in URL: @@ -267,7 +267,7 @@ II. FORMAT OF THE CONFIGURATION FILE If the documentation is not on the local system, it can be accessed from a remote server, as: - user-manual http://example.com/privoxy/user-manual/ + user-manual http://example.com/privoxy/user-manual/ @@ -738,6 +738,7 @@ actionsfile fk 2007-11-07 --> @@actionsfile user.action # User customizations]]> +@@#actionsfile regression-tests.action # Tests for privoxy-regression-test]]> @@ -1016,22 +1017,22 @@ actionsfile The available debug levels are: - debug 1 # Log the destination for each request &my-app; let through. See also debug 1024. - debug 2 # show each connection status - debug 4 # show I/O status - debug 8 # show header parsing - debug 16 # log all data written to the network - debug 32 # debug force feature - debug 64 # debug regular expression filters - debug 128 # debug redirects - debug 256 # debug GIF de-animation - debug 512 # Common Log Format - debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why. - debug 2048 # CGI user interface - debug 4096 # Startup banner and warnings. - debug 8192 # Non-fatal errors - debug 32768 # log all data read from the network - debug 65536 # Log the applying actions +debug 1 # Log the destination for each request. See also debug 1024. +debug 2 # show each connection status +debug 4 # show tagging-related messages +debug 8 # show header parsing +debug 16 # log all data written to the network +debug 32 # debug force feature +debug 64 # debug regular expression filters +debug 128 # debug redirects +debug 256 # debug GIF de-animation +debug 512 # Common Log Format +debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why. +debug 2048 # CGI user interface +debug 4096 # Startup banner and warnings. +debug 8192 # Non-fatal errors +debug 32768 # log all data read from the network +debug 65536 # Log the applying actions To select multiple debug levels, you can either add them or use @@ -1042,7 +1043,7 @@ actionsfile as it happens. 1, 1024, 4096 and 8192 are recommended so that you will notice when things go wrong. The other levels are probably only of interest if you are hunting down a specific problem. - They can produce a hell of an output (especially 16). + They can produce a lot of output (especially 16). If you are used to the more verbose settings, simply enable the debug lines @@ -1066,10 +1067,17 @@ actionsfile -@@#debug 1 # Log the destination for each request &my-app; let through.]]> +@@#debug 1 # Log the destination for each request. See also debug 1024.]]> +@@#debug 2 # show each connection status]]> +@@#debug 4 # show tagging-related messages]]> +@@#debug 8 # show header parsing]]> +@@#debug 128 # debug redirects]]> +@@#debug 256 # debug GIF de-animation]]> +@@#debug 512 # Common Log Format]]> @@#debug 1024 # Log the destination for requests &my-app; didn't let through, and the reason why.]]> @@#debug 4096 # Startup banner and warnings]]> @@#debug 8192 # Non-fatal errors]]> +@@#debug 65536 # Log applying actions]]> @@ -1260,13 +1268,16 @@ 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. They can only be used if Privoxy has been compiled with IPv6 support. If you aren't sure if your version supports it, have a look at - http://config.privoxy.org/show-status. + http://config.privoxy.org/show-status. Some operating systems will prefer IPv6 to IPv4 addresses even if the @@ -1291,8 +1302,8 @@ actionsfile (ACL's, see below), and/or a firewall. - If you open Privoxy to untrusted users, you will - also want to make sure that the following actions are disabled: Privoxy to untrusted users, you should + also make sure that the following actions are disabled: enable-edit-actions and enable-remote-toggle @@ -1308,7 +1319,7 @@ actionsfile You want it to serve requests from inside only: - listen-address 192.168.0.1:8118 +listen-address 192.168.0.1:8118 Suppose you are running Privoxy on an @@ -1316,7 +1327,7 @@ actionsfile of the loopback device: - listen-address [::1]:8118 +listen-address [::1]:8118 @@ -1627,7 +1638,7 @@ actionsfile - Examples: + Example: enforce-blocks 1 @@ -1674,7 +1685,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 @@ -1765,14 +1776,14 @@ ACLs: permit-access and deny-access all destination addresses are OK: - permit-access localhost +permit-access localhost Allow any host on the same class C subnet as www.privoxy.org access to nothing but www.example.com (or other domains hosted on the same system): - permit-access www.privoxy.org/24 www.example.com/32 +permit-access www.privoxy.org/24 www.example.com/32 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere, @@ -1780,22 +1791,22 @@ ACLs: permit-access and deny-access www.dirty-stuff.example.com: - permit-access 192.168.45.64/26 - deny-access 192.168.45.73 www.dirty-stuff.example.com +permit-access 192.168.45.64/26 +deny-access 192.168.45.73 www.dirty-stuff.example.com Allow access from the IPv4 network 192.0.2.0/24 even if listening on an IPv6 wild card address (not supported on all platforms): - permit-access 192.0.2.0/24 +permit-access 192.0.2.0/24 This is equivalent to the following line even if listening on an IPv4 address (not supported on all platforms): - permit-access [::ffff:192.0.2.0]/120 +permit-access [::ffff:192.0.2.0]/120 @@ -2176,30 +2187,30 @@ ACLs: permit-access and deny-access Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle): - forward / parent-proxy.example.org:8080 - forward :443 . +forward / parent-proxy.example.org:8080 +forward :443 . Everything goes to our example ISP's caching proxy, except for requests to that ISP's sites: - forward / caching-proxy.isp.example.net:8000 - forward .isp.example.net . +forward / caching-proxy.isp.example.net:8000 +forward .isp.example.net . Parent proxy specified by an IPv6 address: - forward / [2001:DB8::1]:8000 +forward / [2001:DB8::1]:8000 Suppose your parent proxy doesn't support IPv6: - forward / parent-proxy.example.org:8000 - forward ipv6-server.example.org . - forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> . +forward / parent-proxy.example.org:8000 +forward ipv6-server.example.org . +forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> . @@ -2307,21 +2318,21 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t the Internet. - forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080 - forward .example.com . +forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080 +forward .example.com . A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this: - forward-socks4 / socks-gw.example.com:1080 . +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 . +forward-socks5 / user:pass@socks-gw.example.com:1080 . @@ -2329,7 +2340,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t something like: - forward-socks5t / 127.0.0.1:9050 . +forward-socks5t / 127.0.0.1:9050 . Note that if you got Tor through one of the bundles, you may @@ -2343,9 +2354,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t therefore might want to make some exceptions: - forward 192.168.*.*/ . - forward 10.*.*.*/ . - forward 127.*.*.*/ . +forward 192.168.*.*/ . +forward 10.*.*.*/ . +forward 127.*.*.*/ . Unencrypted connections to systems in these address ranges will @@ -2360,7 +2371,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t this: - forward localhost/ . +forward localhost/ . @@ -2389,18 +2400,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t host-a: - - forward / . - forward .isp-b.example.net host-b:8118 + +forward / . +forward .isp-b.example.net host-b:8118 host-b: - - forward / . - forward .isp-a.example.org host-a:8118 + +forward / . +forward .isp-a.example.org host-a:8118 @@ -2420,18 +2431,19 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t run on the same box, your squid configuration could then look like this: - - # Define Privoxy as parent proxy (without ICP) - cache_peer 127.0.0.1 parent 8118 7 no-query + +# Define Privoxy as parent proxy (without ICP) +cache_peer 127.0.0.1 parent 8118 7 no-query - # Define ACL for protocol FTP - acl ftp proto FTP +# Define ACL for protocol FTP +acl ftp proto FTP - # Do not forward FTP requests to Privoxy - always_direct allow ftp +# Do not forward FTP requests to Privoxy +always_direct allow ftp - # Forward all the rest to Privoxy - never_direct allow all +# Forward all the rest to Privoxy +never_direct allow all + You would then need to change your browser's proxy settings to squid's address and port. @@ -2444,9 +2456,10 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t say, on antivir.example.com, port 8010: - - forward / . - forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010 + +forward / . +forward /.*\.(exe|com|dll|zip)$ antivir.example.com:8010 + ]]> @@ -2505,7 +2518,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: forwarded-connect-retries 1 @@ -2582,7 +2595,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: accept-intercepted-requests 1 @@ -2640,7 +2653,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: allow-cgi-request-crunching 1 @@ -2707,7 +2720,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: split-large-forms 1 @@ -2790,7 +2803,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: keep-alive-timeout 300 @@ -2859,7 +2872,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: tolerate-pipelining 1 @@ -2940,7 +2953,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: default-server-timeout 60 @@ -2948,7 +2961,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t -@@#default-server-timeout 60]]> +@@#default-server-timeout 5]]> @@ -3002,9 +3015,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t There are also a few privacy implications you should be aware of. - If this option is effective, outgoing connections are shared between + If this option is enabled, outgoing connections are shared between clients (if there are more than one) and closing the browser that initiated - the outgoing connection does no longer affect the connection between &my-app; + the outgoing connection does not affect the connection between &my-app; and the server unless the client's request hasn't been completed yet. @@ -3039,7 +3052,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: connection-sharing 1 @@ -3092,10 +3105,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t If you aren't using an occasionally slow proxy like Tor, reducing it to a few seconds should be fine. + + + When a TLS library is being used to read or write data from a socket with + https-inspection + enabled the socket-timeout currently isn't applied and the timeout + used depends on the library (which may not even use a timeout). + + - Examples: + Example: socket-timeout 300 @@ -3132,16 +3153,11 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Effect if unset: + Notes: Connections are served until a resource limit is reached. - - - - Notes: - &my-app; creates one thread (or process) for every incoming client connection that isn't rejected based on the access control settings. @@ -3175,15 +3191,20 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t One most POSIX-compliant systems &my-app; can't properly deal with - more than FD_SETSIZE file descriptors at the same time and has to reject - connections if the limit is reached. This will likely change in a - future version, but currently this limit can't be increased without - recompiling &my-app; with a different FD_SETSIZE limit. + more than FD_SETSIZE file descriptors if &my-app; has been configured + to use select() and has to reject connections if the limit is reached. + When using select() this limit therefore can't be increased without + recompiling &my-app; with a different FD_SETSIZE limit unless &my-app; + is running on Windows with _WIN32 defined. + + + When &my-app; has been configured to use poll() the FD_SETSIZE limit + does not apply. - Examples: + Example: max-client-connections 256 @@ -3232,13 +3253,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, @@ -3262,7 +3283,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: listen-backlog 4096 @@ -3333,7 +3354,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: enable-accept-filter 1 @@ -3515,18 +3536,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Examples: - # Best speed (compared to the other levels) - compression-level 1 - - # Best compression - compression-level 9 - - # No compression. Only useful for testing as the added header - # slightly increases the amount of data that has to be sent. - # If your benchmark shows that using this compression level - # is superior to using no compression at all, the benchmark - # is likely to be flawed. - compression-level 0 +# Best speed (compared to the other levels) +compression-level 1 + +# Best compression +compression-level 9 + +# No compression. Only useful for testing as the added header +# slightly increases the amount of data that has to be sent. +# If your benchmark shows that using this compression level +# is superior to using no compression at all, the benchmark +# is likely to be flawed. +compression-level 0 @@ -3579,7 +3600,10 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Note that sorting headers in an uncommon way will make fingerprinting - actually easier. Encrypted headers are not affected by this directive. + actually easier. + Encrypted headers are not affected by this directive unless + https-inspection + is enabled. @@ -3593,9 +3617,13 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Referer \ Cookie \ DNT \ + Connection \ + Pragma \ + Upgrade-Insecure-Requests \ If-Modified-Since \ Cache-Control \ Content-Length \ + Origin \ Content-Type ]]> @@ -3629,12 +3657,6 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Notes: - - - This is an experimental feature. The syntax is likely to change - in future versions. - - Client-specific tags allow Privoxy admins to create different profiles and let the users chose which one they want without @@ -3668,7 +3690,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Clients can request tags to be set by using the CGI interface http://config.privoxy.org/client-tags. The specific tag description is only used on the web page and should - be phrased in away that the user understand the effect of the tag. + be phrased in away that the user understands the effect of the tag. @@ -3676,10 +3698,15 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Examples: - # 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 - client-specific-tag disable-content-filters Disable content-filters but do not affect other actions + # 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 + client-specific-tag disable-content-filters Disable content-filters but do not affect other actions + client-specific-tag overrule-redirects Overrule redirect sections + client-specific-tag allow-cookies Do not crunch cookies in either direction + client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits) + client-specific-tag no-https-inspection Disable HTTPS inspection + client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled @@ -3715,12 +3742,6 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Notes: - - - This is an experimental feature. The syntax is likely to change - in future versions. - - In case of some tags users may not want to enable them permanently, but only for a short amount of time, for example to circumvent a block @@ -3736,11 +3757,11 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: - # Increase the time to life for temporarily enabled tags to 3 minutes - client-tag-lifetime 180 + # Increase the time to life for temporarily enabled tags to 3 minutes + client-tag-lifetime 180 @@ -3776,12 +3797,6 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Notes: - - - This is an experimental feature. The syntax is likely to change - in future versions. - - If clients reach Privoxy through another proxy, for example a load balancer, Privoxy can't tell the client's IP address from the connection. @@ -3808,12 +3823,12 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: - # Allow systems that can reach Privoxy to provide the client - # IP address with a X-Forwarded-For header. - trust-x-forwarded-for 1 + # Allow systems that can reach Privoxy to provide the client + # IP address with a X-Forwarded-For header. + trust-x-forwarded-for 1 @@ -3881,11 +3896,11 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - Examples: + Example: - # Increase the receive buffer size - receive-buffer-size 32768 + # Increase the receive buffer size + receive-buffer-size 32768 @@ -3897,8 +3912,16 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t - -TLS/SSL + +HTTPS Inspection (Experimental) + + + HTTPS inspection allows to filter encrypted requests and responses. + This is only supported when Privoxy + has been built with FEATURE_HTTPS_INSPECTION. + If you aren't sure if your version supports it, have a look at + http://config.privoxy.org/show-status. + @@ -3942,10 +3965,14 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t 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: + Example: ca-directory /usr/local/etc/privoxy/CA @@ -4000,12 +4027,23 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t in ".crt" format. - It can be generated with: openssl req -new -x509 -extensions v3_ca -keyout cakey.pem -out cacert.crt -days 3650 + 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: + Example: ca-cert-file root.crt @@ -4056,14 +4094,20 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t 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. + This directive specifies the name of the CA key file in ".pem" format. + The ca-cert-file section contains + a command to generate it. + + + The CA key is used by &my-app; to sign generated certificates. + + + Access to the key should be limited to Privoxy. - Examples: + Example: ca-key-file cakey.pem @@ -4071,7 +4115,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t -@@#ca-key-file root.pem]]> +@@#ca-key-file cakey.pem]]> @@ -4118,14 +4162,21 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t 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. + + If disclosure of the password is a compliance issue consider blocking + the relevant CGI requests after enabling the enforce-blocks + and allow-cgi-request-crunching. + + - Examples: + Example: ca-password blafasel @@ -4146,7 +4197,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t Specifies: - Directory to safe generated keys and certificates. + Directory to save generated keys and certificates. @@ -4177,12 +4228,37 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t This directive specifies the directory where generated - TLS/SSL keys and certificates are saved. + 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. + + + &my-app; currently does not garbage-collect obsolete keys + and certificates and does not keep track of how may keys + and certificates exist. + + + &my-app; admins should monitor the size of the directory + and/or make sure there is sufficient space available. + A cron job to limit the number of keys and certificates + to a certain number may be worth considering. + + - Examples: + Example: certificate-directory /usr/local/var/privoxy/certs @@ -4197,6 +4273,131 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t +cipher-list + + + Specifies: + + + A list of ciphers to use in TLS handshakes + + + + + Type of value: + + + Text + + + + + Default value: + + None + + + + Effect if unset: + + + A default value is inherited from the TLS library. + + + + + Notes: + + + This directive allows to specify a non-default list of ciphers to use + in TLS handshakes with clients and servers. + + + Ciphers are separated by colons. Which ciphers are supported + depends on the TLS library. When using OpenSSL, unsupported ciphers + are skipped. When using MbedTLS they are rejected. + + + + Specifying an unusual cipher list makes fingerprinting easier. + Note that the default list provided by the TLS library may + be unusual when compared to the one used by modern browsers + as well. + + + + + + Examples: + + + # Explicitly set a couple of ciphers with names used by MbedTLS +cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\ +TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:\ +TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\ +TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:\ +TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384:\ +TLS-ECDHE-ECDSA-WITH-AES-256-CCM:\ +TLS-ECDHE-ECDSA-WITH-AES-256-CCM-8:\ +TLS-ECDHE-ECDSA-WITH-AES-128-CCM:\ +TLS-ECDHE-ECDSA-WITH-AES-128-CCM-8:\ +TLS-ECDHE-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\ +TLS-ECDHE-ECDSA-WITH-CAMELLIA-256-GCM-SHA384:\ +TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256:\ +TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384:\ +TLS-ECDHE-RSA-WITH-CAMELLIA-128-GCM-SHA256:\ +TLS-ECDHE-RSA-WITH-CAMELLIA-256-GCM-SHA384:\ +TLS-DHE-RSA-WITH-AES-256-GCM-SHA384:\ +TLS-DHE-RSA-WITH-AES-128-GCM-SHA256:\ +TLS-DHE-RSA-WITH-AES-256-CCM:\ +TLS-DHE-RSA-WITH-AES-256-CCM-8:\ +TLS-DHE-RSA-WITH-AES-128-CCM:\ +TLS-DHE-RSA-WITH-AES-128-CCM-8:\ +TLS-DHE-RSA-WITH-CAMELLIA-128-GCM-SHA256:\ +TLS-DHE-RSA-WITH-CAMELLIA-256-GCM-SHA384:\ +TLS-ECDH-RSA-WITH-AES-128-GCM-SHA256:\ +TLS-ECDH-RSA-WITH-AES-256-GCM-SHA384:\ +TLS-ECDH-RSA-WITH-CAMELLIA-128-GCM-SHA256:\ +TLS-ECDH-RSA-WITH-CAMELLIA-256-GCM-SHA384:\ +TLS-ECDH-ECDSA-WITH-AES-128-GCM-SHA256:\ +TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384:\ +TLS-ECDH-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\ +TLS-ECDH-ECDSA-WITH-CAMELLIA-256-GCM-SHA384 + + + # Explicitly set a couple of ciphers with names used by OpenSSL +cipher-list ECDHE-RSA-AES256-GCM-SHA384:\ +ECDHE-ECDSA-AES256-GCM-SHA384:\ +DH-DSS-AES256-GCM-SHA384:\ +DHE-DSS-AES256-GCM-SHA384:\ +DH-RSA-AES256-GCM-SHA384:\ +DHE-RSA-AES256-GCM-SHA384:\ +ECDH-RSA-AES256-GCM-SHA384:\ +ECDH-ECDSA-AES256-GCM-SHA384:\ +ECDHE-RSA-AES128-GCM-SHA256:\ +ECDHE-ECDSA-AES128-GCM-SHA256:\ +DH-DSS-AES128-GCM-SHA256:\ +DHE-DSS-AES128-GCM-SHA256:\ +DH-RSA-AES128-GCM-SHA256:\ +DHE-RSA-AES128-GCM-SHA256:\ +ECDH-RSA-AES128-GCM-SHA256:\ +ECDH-ECDSA-AES128-GCM-SHA256:\ +ECDHE-RSA-AES256-GCM-SHA384:\ +AES128-SHA + + + # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS) +cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH + + + + + + + + + + trusted-cas-file @@ -4234,16 +4435,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t This directive specifies the trusted CAs file that is used when validating - certificates for intercepted TLS/SSL request. + certificates for intercepted TLS/SSL requests. An example file can be downloaded from - https://curl.haxx.se/ca/cacert.pem. + https://curl.se/ca/cacert.pem. + If you want to create the file yourself, please see: + https://curl.se/docs/caextract.html. - Examples: + Example: trusted-cas-file trusted_cas_file.pem