X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fwebserver%2Fuser-manual%2Factions-file.html;h=c0eb301334dab507876087e57c68150a8b5c75c8;hp=f9fd3383c3d20763bf5d0a8cfcce1c1295e80e10;hb=3db7a58b2bbed7b6356b2a0600e93ec4f2846499;hpb=3438a9978a79dbb702e70e2e8a80d727f0ddd6e1 diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index f9fd3383..c0eb3013 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -7,7 +7,7 @@ NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"> +HREF="../p_doc.css"> Privoxy 3.0.7 User ManualPrivoxy 3.0.17 User ManualPrivoxy with - differing purposes: -

-

The list of actions files to be used are defined in the main configuration file, and are processed in the order they are defined (e.g. @@ -528,7 +501,7 @@ CLASS="SECT2" >

8.1. Finding the Right Mix

8.2. How to Edit

http://config.privoxy.org/show-status. - The editor allows both fine-grained control over every single feature on a - per-URL basis, and easy choosing from wholesale sets of defaults like - enable-edit-actions must be enabled for + this to work. The editor allows both fine-grained control over every single + feature on a per-URL basis, and easy choosing from wholesale sets of defaults + like "Cautious", "Medium" or or + "Advanced". - Warning: the . Warning: the "Advanced" setting is more aggressive, and - will be more likely to cause problems for some sites. Experienced users only!

setting is more + aggressive, and will be more likely to cause problems for some sites. + Experienced users only! +

If you prefer plain text editing to GUIs, you can of course also directly edit the the actions files with your favorite text editor. Look at @@ -671,7 +650,7 @@ CLASS="LITERAL" >handle-as-image +blockblock{Banner ads.} } # Block these as if they were images. Send no block page. banners.example.com @@ -735,44 +714,61 @@ CLASS="EMPHASIS" > Generally, an URL pattern has the form <domain>/<path>, where both the +><domain><port>/<path>, where the <domain> and , the <port> + and the <path> are - optional. (This is why the special are optional. (This is why the special + / pattern matches all - URLs). Note that the protocol portion of the URL pattern (e.g. - pattern matches all URLs). Note that the protocol + portion of the URL pattern (e.g. http://) should ) should + not be included in - the pattern. This is assumed already!

be included in the pattern. This is assumed already!

The pattern matching syntax is different for the domain and path parts of the URL. The domain part uses a simple globbing type matching technique, - while the path part uses a more flexible + while the path part uses more flexible "Regular - Expressions (PCRE)" based syntax.

(POSIX 1003.2).

The port part of a pattern is a decimal port number preceded by a colon + (:). If the domain part contains a numerical IPv6 address, + it has to be put into angle brackets + (<, >).

www.example.com/index.html$www.example.com/index.html

/

Matches any URL because there's no requirement for either the + domain or the path to match anything. +

:8000/

Matches any URL pointing to TCP port 8000. +

<2001:db8::1>/

Matches any URL with the host address 2001:db8::1. + (Note that the real URL uses plain brackets, not angle brackets.) +

index.html

8.4.1. The Domain Pattern

matches any domain that ENDS in - matches any domain with first-level domain .example.comcom + and second-level domain example. + For example www.example.com, + example.com and foo.bar.baz.example.com. + Note that it wouldn't match if the second-level domain was another-example.

www. +> (It also matches the domain + www but most of the time that doesn't matter.)

8.4.2. The Path Pattern

Privoxy uses Perl compatible (PCRE) +> uses "modern" POSIX 1003.2 "Regular - Expression" based syntax - (through the PCRE library) for - matching the path portion (after the slash), and is thus more flexible.

for matching the path portion (after the slash), + and is thus more flexible.

There is an Appendix with a brief quick-start into regular - expressions, and full (very technical) documentation on PCRE regex syntax is available on-line - at http://www.pcre.org/man.txt. - You might also find the Perl man page on regular expressions (man perlre) - useful, which is available on-line at http://perldoc.perl.org/perlre.html.

man re_format
).

Note that the path pattern is automatically left-anchored at the Privoxy doesn't silently add a "^", @@ -1407,13 +1445,18 @@ CLASS="QUOTE" tags can be used to activate other tagger actions, as long as these other taggers look for headers that haven't already be parsed.

For example you could tag client requests which use the POST method, - use this tag to activate another tagger that adds a tag if cookies - are send, and then block based on the cookie tag. However if you'd - reverse the position of the described taggers, and activated the method - tagger based on the cookie tagger, no method tags would be created. +> For example you could tag client requests which use the + POST method, + then use this tag to activate another tagger that adds a tag if cookies + are sent, and then use a block action based on the cookie tag. This allows + the outcome of one action, to be input into a subsequent action. However if + you'd reverse the position of the described taggers, and activated the + method tagger based on the cookie tagger, no method tags would be created. The method tagger would look for the request line, but at the time - the cookie tag is created the request line has already been parsed.

While this is a limitation you should be aware of, this kind of indirection is seldom needed anyway and even the example doesn't @@ -1534,7 +1577,7 @@ CLASS="REPLACEABLE" > Example: +block+handle-as-image

are, you definitely don't need to worry about this one.

Headers added by this action are not modified by other actions. +

Example usage:
Type:

Boolean.

Parameterized.

Parameter:

N/A

A block reason that should be given to the user.

Notes:
"BLOCKED" page - for requests to blocked pages. This page contains links to find out why the request - was blocked, and a click-through to the blocked content (the latter only if compiled with the - force feature enabled). The "BLOCKED" page adapts to the available - screen space -- it displays full-blown if space allows, or miniaturized and text-only - if loaded into a small frame or window. If you are using Privoxy - right now, you can take a look at the - "BLOCKED" - page. + for requests to blocked pages. This page contains the block reason given as + parameter, a link to find out why the block action applies, and a click-through + to the blocked content (the latter only if the force feature is available and + enabled).

@@ -1967,18 +1996,18 @@ WIDTH="90%" >

{+block}      
+>{+block{No nasty stuff for you.}}
 # Block and replace with "blocked" page
  .nasty-stuff.example.com
 
-{+block +handle-as-image} 
+{+block{Doubleclick banners.} +handle-as-image} 
 # Block and replace with image
  .ad.doubleclick.net
  .ads.r.us/banners/
 
-{+block +handle-as-empty-document} 
+{+block{Layered ads.} +handle-as-empty-document} 
 # Block and then ignore
- adserver.exampleclick.net/.*\.js$

8.5.3. change-x-forwarded-for

Typical use:

Improve privacy by not forwarding the source of the request in the HTTP headers.

Effect:

Deletes the "X-Forwarded-For:" HTTP header from the client request, + or adds a new one. +

Type:

Parameterized.

Parameter:

  • "block" to delete the header.

  • "add" to create the header (or append + the client's IP address to an already existing one). +

Notes:

It is safe and recommended to use block. +

Forwarding the source address of the request may make + sense in some multi-user setups but is also a privacy risk. +

Example usage:

+change-x-forwarded-for{block}
+

8.5.3. client-header-filter8.5.4. client-header-filter

If the request URL gets changed, Privoxy will detect that and use the new + one. This can be used to rewrite the request destination behind the client's + back, for example to specify a Tor exit relay for certain requests. +

Please refer to the filter file chapter

{+client-header-filter{hide-tor-exit-notation}}
-.exit/
+># Hide Tor exit notation in Host and Referer Headers
+{+client-header-filter{hide-tor-exit-notation}}
+/
     
8.5.4. client-header-tagger8.5.5. client-header-tagger

# Tag every request with the User-Agent header
-{+client-header-filter{user-agent}}
+{+client-header-tagger{user-agent}}
 /
+
+# Tagging itself doesn't change the action
+# settings, sections with TAG patterns do:
+#
+# If it's a download agent, use a different forwarding proxy,
+# show the real User-Agent and make sure resume works.
+{+forward-override{forward-socks5 10.0.0.2:2222 .} \
+ -hide-if-modified-since      \
+ -overwrite-last-modified     \
+ -hide-user-agent             \
+ -filter                      \
+ -deanimate-gifs              \
+}
+TAG:^User-Agent: NetBSD-ftp/
+TAG:^User-Agent: Novell ZYPP Installer
+TAG:^User-Agent: RPM APT-HTTP/
+TAG:^User-Agent: fetch libfetch/
+TAG:^User-Agent: Ubuntu APT-HTTP/
+TAG:^User-Agent: MPlayer/
     
8.5.5. content-type-overwrite8.5.6. content-type-overwrite

8.5.6. crunch-client-header8.5.7. crunch-client-header

8.5.7. crunch-if-none-match8.5.8. crunch-if-none-match

8.5.8. crunch-incoming-cookies8.5.9. crunch-incoming-cookies

8.5.9. crunch-server-header8.5.10. crunch-server-header

8.5.10. crunch-outgoing-cookies8.5.11. crunch-outgoing-cookies

8.5.11. deanimate-gifs8.5.12. deanimate-gifs

8.5.12. downgrade-http-version8.5.13. downgrade-http-version

8.5.13. fast-redirects8.5.14. fast-redirects

8.5.14. filter8.5.15. filter

Filtering requires buffering the page content, which may appear to slow down page rendering since nothing is displayed until all content has - passed the filters. (It does not really take longer, but seems that way - since the page is not incrementally displayed.) This effect will be more - noticeable on slower connections. + passed the filters. (The total time until the page is completely rendered + doesn't change much, but it may be perceived as slower since the page is + not incrementally displayed.) + This effect will be more noticeable on slower connections.

+filter{js-annoyances}       # Get rid of particularly annoying JavaScript abuse
+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse.
+filter{js-events}           # Kill all JS event bindings (Radically destructive! Only for extra nasty sites)
+filter{js-events} # Kill all JS event bindings and timers (Radically destructive! Only for extra nasty sites).
+filter{html-annoyances}     # Get rid of particularly annoying HTML abuse
+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.
+filter{content-cookies}     # Kill cookies that come in the HTML or JS content
+filter{content-cookies} # Kill cookies that come in the HTML or JS content.
+filter{refresh-tags}        # Kill automatic refresh tags (for dial-on-demand setups)
+filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups).
+filter{img-reorder}         # Reorder attributes in <img> tags to make the banners-by-* filters more effective
+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective.
+filter{banners-by-size}     # Kill banners by size
+filter{banners-by-size} # Kill banners by size.
+filter{banners-by-link}     # Kill banners by their links to known clicktrackers
+filter{banners-by-link} # Kill banners by their links to known clicktrackers.
+filter{webbugs}             # Squish WebBugs (1x1 invisible GIFs used for user tracking)
+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking).
+filter{tiny-textforms}      # Extend those tiny textareas up to 40x80 and kill the hard wrap
+filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap.
+filter{jumping-windows}     # Prevent windows from resizing and moving themselves
+filter{jumping-windows} # Prevent windows from resizing and moving themselves.
+filter{frameset-borders}    # Give frames a border and make them resizeable
+filter{frameset-borders} # Give frames a border and make them resizable.
+filter{demoronizer}         # Fix MS's non-standard use of standard charsets
+filter{demoronizer} # Fix MS's non-standard use of standard charsets.
+filter{shockwave-flash}     # Kill embedded Shockwave Flash objects
+filter{shockwave-flash} # Kill embedded Shockwave Flash objects.
+filter{quicktime-kioskmode} # Make Quicktime movies savable
+filter{quicktime-kioskmode} # Make Quicktime movies saveable.
+filter{crude-parental}      # Crude parental filtering (demo only)
+filter{crude-parental} # Crude parental filtering. Note that this filter doesn't work reliably.
+filter{ie-exploits}         # Disable a known Internet Explorer bug exploits
+filter{ie-exploits} # Disable some known Internet Explorer bug exploits.
+filter{site-specifics}      # Custom filters for specific site related problems
+filter{site-specifics} # Cure for site-specific problems. Don't apply generally!

+filter{google}              # Removes text ads and other Google specific improvements
+filter{no-ping} # Removes non-standard ping attributes in <a> and <area> tags.

+filter{yahoo}               # Removes text ads and other Yahoo specific improvements
+filter{google} # CSS-based block for Google text ads. Also removes a width limitation and the toolbar advertisement.

+filter{msn}                 # Removes text ads and other MSN specific improvements
+filter{yahoo} # CSS-based block for Yahoo text ads. Also removes a width limitation.

+filter{blogspot}            # Cleans up Blogspot blogs
+filter{msn} # CSS-based block for MSN text ads. Also removes tracking URLs and a width limitation.

+filter{no-ping}             # Removes non-standard ping attributes from anchor and area tags
+filter{blogspot} # Cleans up some Blogspot blogs. Read the fine print before using this.
8.5.15. force-text-mode8.5.16. force-text-mode

8.5.16. forward-override8.5.17. forward-override

"forward-socks4" - to use a socks4 connection (with local DNS resolution) instead. + to use a socks4 connection (with local DNS resolution) instead, use "forward-socks5" + for socks5 connections (with remote DNS resolution).

  • "forward-socks4" to use a socks4 connection - (with local DNS resolution) instead. + (with local DNS resolution) instead, use "forward-socks5" + for socks5 connections (with remote DNS resolution).

  • Notes:

    This action takes parameters similar to the +> This action takes parameters similar to the forward8.5.17. handle-as-empty-document8.5.18. handle-as-empty-document

    # Block all documents on example.org that end with ".js", # but send an empty document instead of the usual HTML message. -{+block +handle-as-empty-document} +{+block{Blocked JavaScript} +handle-as-empty-document} example.org/.*\.js$ 8.5.18. handle-as-image8.5.19. handle-as-image

    8.5.19. hide-accept-language8.5.20. hide-accept-language

    8.5.20. hide-content-disposition8.5.21. hide-content-disposition

    8.5.21. hide-if-modified-since8.5.22. hide-if-modified-since

    "If-Modified-Since:" makes - sure it isn't used as a cookie replacement, but you will run into - caching problems if the random range is too high. + it less likely that the server can use the time as a cookie replacement, + but you will run into caching problems if the random range is too high.

    It is a good idea to only use a small negative value and let @@ -4934,7 +5095,8 @@ CLASS="LITERAL" HREF="actions-file.html#CRUNCH-IF-NONE-MATCH" >crunch-if-none-match. +>, + otherwise it's more or less pointless.

    # Let the browser revalidate without being tracked across sessions
    -{ +hide-if-modified-since{-60} \
    +># Let the browser revalidate but make tracking based on the time less likely.
    +{+hide-if-modified-since{-60} \
      +overwrite-last-modified{randomize} \
      +crunch-if-none-match}
     /

    8.5.22. hide-forwarded-for-headers

    Typical use:

    Improve privacy by not embedding the source of the request in the HTTP headers.

    Effect:

    Deletes any existing "X-Forwarded-for:" HTTP header from client requests, - and prevents adding a new one. -

    Type:

    Boolean.

    Parameter:

    N/A -

    Notes:

    It is safe to leave this on. -

    Example usage:

    +hide-forwarded-for-headers
    -

    8.5.23. hide-from-header

    "conditional-forge" to forge the header if the host has changed.

  • "block" to delete the header unconditionally.

  • Always blocking the referrer, or using a custom one, can lead to failures on servers that check the referrer before they answer any - requests, in an attempt to prevent their valuable content from being + requests, in an attempt to prevent their content from being embedded or linked to elsewhere.

    Typical use:

    Conceal your type of browser and client operating system

    Try to conceal your type of browser and client operating system

    Effect:
    the right thing to do: good web sites work browser-independently). -

    8.5.26. inspect-jpegs8.5.26. limit-connect

    Typical use:

    To protect against the MS buffer over-run in JPEG processing

    Prevent abuse of Privoxy as a TCP proxy relay or disable SSL for untrusted sites

    Effect:

    Protect against a known exploit +> Specifies to which ports HTTP CONNECT requests are allowable.

    Type:

    Boolean.

    Parameterized.

    Parameter:

    N/A +> A comma-separated list of ports or port ranges (the latter using dashes, with the minimum + defaulting to 0 and the maximum to 65K).

    Notes:

    See Microsoft Security Bulletin MS04-028. JPEG images are one of the most - common image types found across the Internet. The exploit as described can - allow execution of code on the target system, giving an attacker access - to the system in question by merely planting an altered JPEG image, which - would have no obvious indications of what lurks inside. This action - prevents this exploit. +> By default, i.e. if no limit-connect action applies, + Privoxy allows HTTP CONNECT requests to all + ports. Use limit-connect if fine-grained control + is desired for some or all destinations.

    Note that the described exploit is only one of many, - using this action does not mean that you no longer - have to patch the client. -

    The CONNECT methods exists in HTTP to allow access to secure websites + ("https://" URLs) through proxies. It works very simply: + the proxy connects to the server on the specified port, and then + short-circuits its connections to the client and to the remote server. + This means CONNECT-enabled proxies can be used as TCP relays very easily. +

    Privoxy relays HTTPS traffic without seeing + the decoded content. Websites can leverage this limitation to circumvent Privoxy's + filters. By specifying an invalid port range you can disable HTTPS entirely. +

    Example usage:
    Example usages:

    +inspect-jpegs
    +limit-connect{443} # Port 443 is OK. ++limit-connect{80,443} # Ports 80 and 443 are OK. ++limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK. ++limit-connect{-} # All ports are OK ++limit-connect{,} # No HTTPS/SSL traffic is allowed

    +

    8.5.27. kill-popups8.5.27. prevent-compression

    Typical use:

    Eliminate those annoying pop-up windows (deprecated)

    Ensure that servers send the content uncompressed, so it can be + passed through filters. +

    Effect:

    While loading the document, replace JavaScript code that opens - pop-up windows with (syntactically neutral) dummy code on the fly. +> Removes the Accept-Encoding header which can be used to ask for compressed transfer.

    Notes:

    This action is basically a built-in, hardwired special-purpose filter - action, but there are important differences: For kill-popups, - the document need not be buffered, so it can be incrementally rendered while - downloading. But kill-popups doesn't catch as many pop-ups as - More and more websites send their content compressed by default, which + is generally a good idea and saves bandwidth. But the filter{all-popups}filter - does and is not as smart as and + filter{unsolicited-popupsdeanimate-gifs} - is. + actions need access to the uncompressed data.

    Think of it as a fast and efficient replacement for a filter that you - can use if you don't want any filtering at all. Note that it doesn't make - sense to combine it with any filter action, - since as soon as one filter applies, - the whole document needs to be buffered anyway, which destroys the advantage of - the kill-popups action over its filter equivalent. +> When compiled with zlib support (available since Privoxy 3.0.7), content that should be + filtered is decompressed on-the-fly and you don't have to worry about this action. + If you are using an older Privoxy version, or one that hasn't been compiled with zlib + support, this action can be used to convince the server to send the content uncompressed.

    Killing all pop-ups unconditionally is problematic. Many shops and banks rely on - pop-ups to display forms, shopping carts etc, and the filter{unsolicited-popups} - does a better job of catching only the unwanted ones. +> Most text-based instances compress very well, the size is seldom decreased by less than 50%, + for markup-heavy instances like news feeds saving more than 90% of the original size isn't + unusual.

    If the only kind of pop-ups that you want to kill are exit consoles (those - really nasty windows that appear when you close an other - one), you might want to use - filter{js-annoyances} - instead. +> Not using compression will therefore slow down the transfer, and you should only + enable this action if you really need it. As of Privoxy 3.0.7 it's disabled in all + predefined action settings.

    This action is most appropriate for browsers that don't have any controls - for unwanted pop-ups. Not recommended for general usage. +> Note that some (rare) ill-configured sites don't handle requests for uncompressed + documents correctly. Broken PHP applications tend to send an empty document body, + some IIS versions only send the beginning of the content. If you enable + prevent-compression per default, you might want to add + exceptions for those sites. See the example for how to do that.

    Example usage:
    Example usage (sections):

    +kill-popups

    8.5.28. limit-connect

    Typical use:

    Prevent abuse of Privoxy as a TCP proxy relay or disable SSL for untrusted sites

    Effect:

    Specifies to which ports HTTP CONNECT requests are allowable. -

    Type:

    Parameterized.

    Parameter:

    A comma-separated list of ports or port ranges (the latter using dashes, with the minimum - defaulting to 0 and the maximum to 65K). -

    Notes:

    By default, i.e. if no limit-connect action applies, - Privoxy only allows HTTP CONNECT - requests to port 443 (the standard, secure HTTPS port). Use - limit-connect if more fine-grained control is desired - for some or all destinations. -

    The CONNECT methods exists in HTTP to allow access to secure websites - ("https://" URLs) through proxies. It works very simply: - the proxy connects to the server on the specified port, and then - short-circuits its connections to the client and to the remote server. - This can be a big security hole, since CONNECT-enabled proxies can be - abused as TCP relays very easily. -

    Privoxy relays HTTPS traffic without seeing - the decoded content. Websites can leverage this limitation to circumvent Privoxy's - filters. By specifying an invalid port range you can disable HTTPS entirely. - If you plan to disable SSL by default, consider enabling - treat-forbidden-connects-like-blocks - as well, to be able to quickly create exceptions. -

    Example usages:

    +limit-connect{443}                   # This is the default and need not be specified.
    -+limit-connect{80,443}                # Ports 80 and 443 are OK.
    -+limit-connect{-3, 7, 20-100, 500-}   # Ports less than 3, 7, 20 to 100 and above 500 are OK.
    -+limit-connect{-}                     # All ports are OK
    -+limit-connect{,}                     # No HTTPS/SSL traffic is allowed
    -

    8.5.29. prevent-compression

    Typical use:

    Ensure that servers send the content uncompressed, so it can be - passed through filters. -

    Effect:

    Removes the Accept-Encoding header which can be used to ask for compressed transfer. -

    Type:

    Boolean.

    Parameter:

    N/A -

    Notes:

    More and more websites send their content compressed by default, which - is generally a good idea and saves bandwidth. But the filter, deanimate-gifs - and kill-popups actions need - access to the uncompressed data. -

    When compiled with zlib support (available since Privoxy 3.0.7), content that should be - filtered is decompressed on-the-fly and you don't have to worry about this action. - If you are using an older Privoxy version, or one that hasn't been compiled with zlib - support, this action can be used to convince the server to send the content uncompressed. -

    Most text-based instances compress very well, the size is seldom decreased by less than 50%, - for markup-heavy instances like news feeds saving more than 90% of the original size isn't - unusual. -

    Not using compression will therefore slow down the transfer, and you should only - enable this action if you really need it. As of Privoxy 3.0.7 it's disabled in all - predefined action settings. -

    Note that some (rare) ill-configured sites don't handle requests for uncompressed - documents correctly. Broken PHP applications tend to send an empty document body, - some IIS versions only send the beginning of the content. If you enable - prevent-compression per default, you might want to add - exceptions for those sites. See the example for how to do that. -

    Example usage (sections):

    # Selectively turn off compression, and enable a filter
    -#
    -{ +filter{tiny-textforms} +prevent-compression }
    -# Match only these sites
    - .google.
    - sourceforge.net
    - sf.net
    -
    -# Or instead, we could set a universal default:
    -#
    -{ +prevent-compression }
    - / # Match all sites
    -
    -# Then maybe make exceptions for broken sites:
    -#
    -{ -prevent-compression }
    -.compusa.com/
    # Selectively turn off compression, and enable a filter +# +{ +filter{tiny-textforms} +prevent-compression } +# Match only these sites + .google. + sourceforge.net + sf.net + +# Or instead, we could set a universal default: +# +{ +prevent-compression } + / # Match all sites + +# Then maybe make exceptions for broken sites: +# +{ -prevent-compression } +.compusa.com/
    8.5.30. overwrite-last-modified8.5.28. overwrite-last-modified

    hided-if-modified-sincehide-if-modified-since
    to further customize your random range. @@ -6147,7 +5977,7 @@ CLASS="SECT3" CLASS="SECT3" >8.5.31. redirect8.5.29. redirect

    In case of problems with your redirects, or simply to watch + them working, enable debug 128. +

    Example usages:
    -

    8.5.32. send-vanilla-wafer

    Typical use:

    Feed log analysis scripts with useless data. -

    Effect:

    Sends a cookie with each request stating that you do not accept any copyright - on cookies sent to you, and asking the site operator not to track you. -

    Type:

    Boolean.

    Parameter:

    N/A -

    Notes:

    The vanilla wafer is a (relatively) unique header and could conceivably be used to track you. -

    This action is rarely used and not enabled in the default configuration. -

    Example usage:

    +send-vanilla-wafer
    -

    8.5.33. send-wafer

    Typical use:

    Send custom cookies or feed log analysis scripts with even more useless data. -

    Effect:

    Sends a custom, user-defined cookie with each request. -

    Type:

    Multi-value.

    Parameter:

    A string of the form "name=value". -

    Notes:

    Being multi-valued, multiple instances of this action can apply to the same request, - resulting in multiple cookies being sent. -

    This action is rarely used and not enabled in the default configuration. -

    Example usage (section):

    {+send-wafer{UsingPrivoxy=true}}
    -my-internal-testing-server.void
    8.5.34. server-header-filter8.5.30. server-header-filter

    8.5.35. server-header-tagger8.5.31. server-header-tagger

    Typical use:

    Disable or disable filters based on the Content-Type header. +> Enable or disable filters based on the Content-Type header.

    # Tag every request with the declared content type
    -{+client-header-filter{content-type}}
    +># Tag every request with the content type declared by the server
    +{+server-header-tagger{content-type}}
     /
         
    8.5.36. session-cookies-only8.5.32. session-cookies-only

    8.5.37. set-image-blocker8.5.33. set-image-blocker

    8.5.38. treat-forbidden-connects-like-blocks

    Typical use:

    Block forbidden connects with an easy to find error message.

    Effect:

    If this action is enabled, Privoxy no longer - makes a difference between forbidden connects and ordinary blocks. -

    Type:

    Boolean

    Parameter:

    N/A

    Notes:

    By default Privoxy answers - forbidden "Connect" requests - with a short error message inside the headers. If the browser doesn't display - headers (most don't), you just see an empty page. -

    With this action enabled, Privoxy displays - the message that is used for ordinary blocks instead. If you decide - to make an exception for the page in question, you can do so by - following the "See why" link. -

    For "Connect" requests the clients tell - Privoxy which host they are interested - in, but not which document they plan to get later. As a result, the - "Go there anyway" wouldn't work and is therefore suppressed. -

    Example usage:

    +treat-forbidden-connects-like-blocks
    -

    8.5.39. Summary8.5.34. Summary

    Note that many of these actions have the potential to cause a page to @@ -7310,7 +6890,7 @@ HREF="actions-file.html#CRUNCH-INCOMING-COOKIES" HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES" >crunch-outgoing-cookies - +block-as-image = +block +handle-as-image + +block-as-image = +block{Blocked image.} +handle-as-image allow-all-cookies = -crunch-all-cookies -session-cookies-onlyhide-referrer -kill-popups -prevent-compression @@ -7345,9 +6922,6 @@ HREF="actions-file.html#PREVENT-COMPRESSION" shop = -crunch-all-cookies -filter{all-popups} -kill-popups # Short names for other aliases, for really lazy people ;-) @@ -7393,7 +6967,7 @@ CLASS="SCREEN" # These shops require pop-ups: # - {-kill-popups -filter{all-popups} -filter{unsolicited-popups}} + {-filter{all-popups} -filter{unsolicited-popups}} .dabs.com .overclockers.co.uk. Now, let's look at an example match-all.action, default.action + and user.action file and see how all these pieces come together:

    8.7.1. match-all.action

    Remember all actions are disabled when matching starts, + so we have to explicitly enable the ones we want.

    While the match-all.action file only contains a + single section, it is probably the most important one. It has only one + pattern, "/", but this pattern + matches all URLs. Therefore, the set of + actions used in this "default" section will + be applied to all requests as a start. It can be partly or + wholly overridden by other actions files like default.action and + and user.action - file and see how all these pieces come together:

    8.7.1. default.action

    , but it will still be largely responsible + for your overall browsing experience.

    Every config file should start with a short comment stating its purpose:

    Again, at the start of matching, all actions are disabled, so there is + no need to disable any actions here. (Remember: a "+" + preceding the action name enables the action, a "-" disables!). + Also note how this long line has been made more readable by splitting it into + multiple lines with line continuation.

    # Sample default.action file <ijbswa-developers@lists.sourceforge.net>
    { \ + +change-x-forwarded-for{block} \ + +hide-from-header{block} \ + +set-image-blocker{pattern} \ +} +/ # Match all URLs +

    Then, since this is the The default behavior is now set.

    8.7.2. default.action

    If you aren't a developer, there's no need for you to edit the + default.action file. It is maintained by + the Privoxy developers and if you disagree with some of the + sections, you should overrule them in your user.action.

    Understanding the default.action file, the -first section is a special section for internal use that you needn't -change or worry about:

    file can + help you with your user.action, though.

    The first section in this file is a special section for internal use + that prevents older Privoxy versions from reading the file:

    ########################################################################## # Settings -- Don't change! For internal Privoxy use ONLY. ########################################################################## - {{settings}} -for-privoxy-version=3.0

    After that comes the (optional) alias section. We'll use the example -section from the above After that comes the (optional) alias section. We'll use the example + section from the above chapter on aliases, -that also explains why and how aliases are used:

    crunch-outgoing-cookies - +block-as-image = +block +handle-as-image + +block-as-image = +block{Blocked image.} +handle-as-image mercy-for-cookies = -crunch-all-cookies -session-cookies-only -hide-referrer -kill-popups shop = -crunch-all-cookies -filter{all-popups} -kill-popups

    Now come the regular sections, i.e. sets of actions, accompanied - by URL patterns to which they apply. Remember all actions - are disabled when matching starts, so we have to explicitly - enable the ones we want.

    The first regular section is probably the most important. It has only - one pattern, "/", but this pattern - matches all URLs. Therefore, the - set of actions used in this "default" section will - be applied to all requests as a start. It can be partly or - wholly overridden by later matches further down this file, or in user.action, - but it will still be largely responsible for your overall browsing - experience.

    Again, at the start of matching, all actions are disabled, so there is - no real need to disable any actions here, but we will do that nonetheless, - to have a complete listing for your reference. (Remember: a "+" - preceding the action name enables the action, a "-" disables!). - Also note how this long line has been made more readable by splitting it into - multiple lines with line continuation.

    ##########################################################################
    -# "Defaults" section:
    -##########################################################################
    - { \
    - -add-header \
    - -client-header-filter{hide-tor-exit-notation} \
    - -block \
    - -content-type-overwrite \
    - -crunch-client-header \
    - -crunch-if-none-match \
    - -crunch-incoming-cookies \
    - -crunch-server-header \
    - -crunch-outgoing-cookies \
    - +deanimate-gifs \
    - -downgrade-http-version \
    - -fast-redirects{check-decoded-url} \
    - -filter{js-annoyances} \
    - -filter{js-events} \
    - +filter{html-annoyances} \
    - -filter{content-cookies} \
    - +filter{refresh-tags} \
    - -filter{unsolicited-popups} \
    - -filter{all-popups} \
    - -filter{img-reorder} \
    - -filter{banners-by-size} \
    - -filter{banners-by-link} \
    - +filter{webbugs} \
    - -filter{tiny-textforms} \
    - -filter{jumping-windows} \
    - -filter{frameset-borders} \
    - -filter{demoronizer} \
    - -filter{shockwave-flash} \
    - -filter{quicktime-kioskmode} \
    - -filter{fun} \
    - -filter{crude-parental} \
    - +filter{ie-exploits} \     
    - -filter{google} \
    - -filter{yahoo} \
    - -filter{msn} \
    - -filter{blogspot} \
    - -filter{no-ping} \
    - -force-text-mode \
    - -handle-as-empty-document \
    - -handle-as-image \
    - -hide-accept-language \
    - -hide-content-disposition \
    - -hide-if-modified-since \
    - +hide-forwarded-for-headers \
    - +hide-from-header{block} \
    - +hide-referrer{forge} \
    - -hide-user-agent \
    - -inspect-jpegs \
    - -kill-popups \
    - -limit-connect \
    - +prevent-compression \
    - -overwrite-last-modified \
    - -redirect \
    - -send-vanilla-wafer \
    - -send-wafer \
    - -server-header-filter{xml-to-html} \
    - -server-header-filter{html-to-xml} \
    - +session-cookies-only \
    - +set-image-blocker{pattern} \
    - -treat-forbidden-connects-like-blocks \
    - }
    - / # forward slash will match *all* potential URL patterns.

    The default behavior is now set. Note that some actions, like not hiding - the user agent, are part of a "general policy" that applies - universally and won't get any exceptions defined later. Other choices, - like not blocking (which is understandably the - default!) need exceptions, i.e. we need to specify explicitly what we - want to block in later sections.

    The first of our specialized sections is concerned with "fragile"fast-redirects - action, which we enabled per default above, breaks some sites. So disable - it for popular sites where we know it misbehaves:

    match-all.action
    , + breaks some sites. So disable it for popular sites where we know it misbehaves:

    and - information). We can mark any URL as an image with the +block+block{Banner ads.} } # Generic patterns: @@ -8386,8 +7731,8 @@ CLASS="SECT3" >

    8.7.2. user.action8.7.3. user.action

    So far we are painting with a broad brush by setting general policies, @@ -8435,7 +7780,7 @@ WIDTH="100%" >

    # My user.action file. <fred@foobar.com>
    # My user.action file. <fred@example.com>
    { +block }{ +block{} }
    section. Note that { +handle-as-image @@ -8612,9 +7957,9 @@ CLASS="SCREEN" >{ +block } +>{Nasty ads.} } www.example.com/nasty-ads/sponsor\.gif - another.popular.site.net/more/junk/here/default.filter, - but it is disabled in the distributed actions file. (My colleagues on the team just - don't have a sense of humour, that's why! ;-). So you'd like to turn it on in your private, + but it is disabled in the distributed actions file. + So you'd like to turn it on in your private, update-safe config, once and for all: