Showing preview only (663K chars total). Download the full file or copy to clipboard to get everything.
Repository: essandess/macOS-Fortress
Branch: master
Commit: fa709de78eef
Files: 33
Total size: 642.3 KB
Directory structure:
gitextract_vxp6e2ml/
├── .gitmodules
├── LICENSE
├── README.md
├── blacklist.txt
├── blockips.conf
├── com.github.essandess.easylist-pac.plist
├── config
├── deprecated/
│ ├── Squid.wrapper
│ ├── disable.sh
│ ├── macosfortress_boot_check
│ ├── net.securemecca.pac.plist
│ ├── org.adblockplus.privoxy-adblock.plist
│ └── squid-27.conf
├── disable.sh
├── macosfortress_setup_check.sh
├── match-all.action
├── net.dshield.block.plist
├── net.emergingthreats.blockips.plist
├── net.hphosts.hosts.plist
├── net.openbsd.pf.brutexpire.plist
├── net.openbsd.pf.plist
├── org.opensource.flashcookiedelete.plist
├── org.squid-cache.squid-rotate.plist
├── pf.conf
├── pf_attacks
├── pf_restart
├── privoxy_restart
├── proxy.pac
├── readme-and-install.sh
├── squid.conf
├── squid_restart
├── user.action
└── whitelist.txt
================================================
FILE CONTENTS
================================================
================================================
FILE: .gitmodules
================================================
[submodule "privoxy-adblock"]
path = deprecated/privoxy-adblock
url = ../privoxy-adblock.git
[submodule "easylist-pac-privoxy"]
path = easylist-pac-privoxy
url = ../easylist-pac-privoxy.git
branch = master
[submodule "macOS-clamAV"]
path = deprecated/macOS-clamAV
url = ../macOS-clamAV.git
================================================
FILE: LICENSE
================================================
The MIT License (MIT)
Copyright (c) 2014 essandess
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
================================================
FILE: README.md
================================================
macOS-Fortress
===========
# macOS-Fortress: Firewall, Blackhole, and Privatizing Proxy for Trackers, Attackers, Malware, Adware, and Spammers; with On-Demand and On-Access Anti-Virus Scanning
Kernel-level, OS-level, and client-level security for macOS. Built to address a steady stream of attacks visible on snort and server logs, as well as blocks ads, malicious scripts, and conceal information used to track you around the web. After this package was installed, snort and other detections have fallen to a fraction with a few simple blocking actions. This setup is a lot more capable and effective than using a simple adblocking browser add-on. There's a world of difference between ad-filled web pages with and without a filtering proxy server. It's also saved me from inadvertantly clicking on phishing links.
## Proxy features
* macOS adaptive firewall
* Adaptive firewall to brute force attacks
* IP blocks updated about twice a day from emergingthreats.net (IP blocks, compromised hosts, Malvertisers) and [dshield.org](https://secure.dshield.org)’s top-20
* Host blocks updated about twice a day from [hphosts.net](https://www.hosts-file.net)
* HTTPS Inspection using [Privoxy](http://www.privoxy.org)
* [EasyList](https://easylist.to/index.html) Tracker and Adblock Rules for [Privoxy](http://www.privoxy.org) with [adblock2privoxy](../../../adblock2privoxy)
* Incorporates multiple blocking rulesets into both Privoxy and PAC formats, including [easyprivacy.txt](https://easylist.to/easylist/easyprivacy.txt), [easylist.txt](https://easylist.to/easylist/easylist.txt), [fanboy-annoyance.txt](https://easylist.to/easylist/fanboy-annoyance.txt), [fanboy-social.txt](https://easylist.to/easylist/fanboy-social.txt), [antiadblockfilters.txt](https://easylist-downloads.adblockplus.org/antiadblockfilters.txt), [malwaredomains_full.txt](https://easylist-downloads.adblockplus.org/malwaredomains_full.txt), and the anti-spamware list [adblock-list.txt](https://raw.githubusercontent.com/Dawsey21/Lists/master/adblock-list.txt).
## Anti-Virus features
* Configures [clamAV](http://www.clamav.net) for macOS with regular on-demand scans and on-access scanning of user `Downloads`
and `Desktop` directories.
* See the [MacPorts](https://www.macports.org/) port `clamav-server` for details, `port notes clamav-server`.
## Installation
```bash
sudo port install macos-fortress
port notes macos-fortress
sudo port load macos-fortress
```
After initial installation, it is necessary to kickstart these launch daemons, which run on a schedule, and do not run at load time:
```bash
sudo launchctl kickstart -k system/org.macports.macos-fortress-dshield
sudo launchctl kickstart -k system/org.macports.macos-fortress-emergingthreats
sudo launchctl kickstart -k system/org.macports.macos-fortress-hphosts
sudo launchctl kickstart -k system/org.macports.adblock2privoxy
sudo launchctl kickstart -k system/org.macports.macos-fortress-easylistpac
```
The default web server is native macOS Apache, which must be started with the command:
```bash
sudo apachectl start
```
Note that all files in this repo are superceded by the MacPorts port
[macos-fortress](https://github.com/macports/macports-ports/tree/master/net/macos-fortress), including the
deprecated installation script [readme-and-install.sh](./readme-and-install.sh).
### Firewall-only installation
```bash
sudo port install macos-fortress-pf
port notes macos-fortress-pf
sudo port load macos-fortress-pf
```
### Proxy-only installation
```bash
sudo port install macos-fortress-proxy
port notes macos-fortress-proxy
sudo port load macos-fortress-proxy
```
## Check and troubleshoot setup
> `sudo sh macosfortress_setup_check.sh`
Working output:
```
Checking macOS-Fortress installed items (run as sudo)…
Checking launchd.plist files…
[✅] /Library/LaunchDaemons/net.openbsd.pf.plist exists
[✅] /Library/LaunchDaemons/net.openbsd.pf.brutexpire.plist exists
[✅] /Library/LaunchDaemons/net.emergingthreats.blockips.plist exists
[✅] /Library/LaunchDaemons/net.dshield.block.plist exists
[✅] /Library/LaunchDaemons/net.hphosts.hosts.plist exists
[✅] /Library/LaunchDaemons/com.github.essandess.easylist-pac.plist exists
[✅] /Library/LaunchDaemons/com.github.essandess.adblock2privoxy.plist exists
[✅] /Library/LaunchDaemons/com.github.essandess.adblock2privoxy.nginx.plist exists
[✅] /Library/LaunchDaemons/org.squid-cache.squid-rotate.plist exists
[✅] /Library/LaunchDaemons/org.macports.Privoxy.plist exists
[✅] /Library/LaunchDaemons/org.macports.clamd.plist exists
[✅] /Library/LaunchDaemons/org.macports.freshclam.plist exists
[✅] /Library/LaunchDaemons/org.macports.ClamavScanSchedule.plist exists
[✅] /Library/LaunchDaemons/org.macports.ClamavScanOnAccess.plist exists
Checking launchd.plist's. These should all be installed with return
code 0 (2d column of `sudo launchctl list`)…
[✅] - 0 com.github.essandess.easylist-pac
[✅] - 0 net.dshield.block
[✅] 91695 0 org.macports.ClamdScanOnAccess
[✅] - 0 org.macports.freshclam
[✅] - 0 net.openbsd.pf
[✅] - 0 com.github.essandess.adblock2privoxy
[✅] 35403 0 org.macports.clamd
[✅] - 0 org.macports.ClamavScanSchedule
[✅] - 0 net.openbsd.pf.brutexpire
[✅] - 0 net.emergingthreats.blockips
[✅] 36183 0 org.macports.Privoxy
[✅] 5578 0 com.github.essandess.adblock2privoxy.nginx
[✅] - 0 net.hphosts.hosts
Checking PF files…
[✅] /etc/pf.conf exists
[✅] /usr/local/etc/blockips.conf exists
[✅] /usr/local/etc/emerging-Block-IPs.txt exists
[✅] /usr/local/etc/compromised-ips.txt exists
[✅] /usr/local/etc/dshield_block_ip.txt exists
[✅] /usr/local/etc/block.txt exists
[✅] /usr/local/etc/block.txt.asc exists
Checking PF…
[✅] PF is enabled and running
Checking hphosts files…
[✅] /etc/hosts-hphosts exists
[✅] /usr/local/etc/hosts.zip exists
[✅] /usr/local/etc/hphosts-partial.asp exists
[✅] /usr/local/etc/whitelist.txt exists
[✅] /usr/local/etc/blacklist.txt exists
Checking /etc/hosts-hphosts creation…
[✅] /etc/hosts-hphosts exists
Checking proxy PAC and proxy chain files…
[✅] /Library/WebServer/Documents/proxy.pac.orig exists
[✅] /Library/WebServer/Documents/proxy.pac exists
[✅] /usr/local/bin/easylist_pac.py exists
[✅] /usr/local/bin/adblock2privoxy exists
[✅] /usr/local/etc/proxy.pac exists
[✅] /usr/local/etc/adblock2privoxy/nginx.conf exists
[✅] /usr/local/etc/adblock2privoxy/css/default.html exists
[✅] /usr/local/etc/adblock2privoxy/privoxy/ab2p.action exists
[✅] /usr/local/etc/adblock2privoxy/privoxy/ab2p.filter exists
[✅] /usr/local/etc/adblock2privoxy/privoxy/ab2p.system.action exists
[✅] /usr/local/etc/adblock2privoxy/privoxy/ab2p.system.filter exists
[✅] /opt/local/etc/privoxy/config exists
[✅] /opt/local/var/log/privoxy/logfile exists
Checking proxy status…
[✅] Privoxy is running properly
[✅] Privoxy config http://p.p/ via http://localhost:3128 is running properly
[✅] nginx is running properly
[✅] PAC /Library/WebServer/Documents/proxy.pac.orig passes Javascript parsing
[✅] PAC /Library/WebServer/Documents/proxy.pac passes Javascript parsing
[✅] Web server for http://localhost/proxy.pac is running properly
[✅] Blackhole server for http://localhost:8119/ is running properly
```
## Disabling
```
sudo port unload macos-fortress
```
or
```
sudo port uninstall macos-fortress
```
This repo is superceded by the MacPorts port
[macos-fortress](https://github.com/macports/macports-ports/tree/master/net/macos-fortress), including the
deprecated disable/uninstall script [disable.sh](./disable.sh), which was originally used to unload all launch daemons,
disable the pf firewall, and list all installed files **without** removing them.
## Configuration modifications
There are three major, independent, and configurable components to the repo: the PF firewall, the proxy chain, and the
AV scanner. Here are a few configuration pointers.
### PF firewall
The file [pf.conf](./pf.conf) controls the firewall ruleset and likely must be edited on a specific computer and network, or
edited for a VPN server [configuration](../../../macos-openvpn-server/pf.conf).
* The PF firewall can be disabled with the command:
> `sudo pfctl -d`
* The variable `int_if` for the internal interface is set to `en0`. This should be changed to the active interface on your
computer, which can be determined with the command `ifconfig -a`, or more specificall:
> `ifconfig | pcregrep -M -o '^[^\t:]+:([^\n]|\n\t)*status: active' | egrep -o -m 1 '^[^\t:]+'`
* The table `<lan_inet>` is set to the standard reserved ranges `{ 10/8, 172.16/12, 192.168/16 }`. This must be changed
to the CIDR ranges on the specific LAN.
* Specific services accessible only on the LAN and on the open internet should be selected and set in the appropriate
variables. See `/etc/services`.
* The PF firewall ruleset can be flushed, enabled, and reintialized with the command:
> `sudo pfctl -Fall && sudo pfctl -ef /etc/pf.conf`
* See the `pfctl` commands in the script [pf_attacks](./pf_attacks) to determine IP addresses and counts for the various
blocked IPs. E.g., the adaptive table `<bruteforce>` is shown using the command:
> `sudo pfctl -t bruteforce -Ts`
### Proxy
Privoxy on port 8118 is configured in [config](./config) to sent web requests to the internet, wih HTTPS inspection configured for
blocking content within TLS encrypted tunnels—the great majorityof we content. An auxiliary nginx webserver for CSS-based
element hiding is configured on port 8119. Privoxy `.action` and `.filter` files, and nginx `.css` files are created from Easylist rules
using the repo [adblock2privoxy](../../../adblock2privoxy).
Browsing to the privoxy configuration page http://p.p/ through any of these proxy configurations is a check on whether the
proxy is running and configured correctly.
To provide these services on a firewalled LAN, edit the privoxy and nginx configuration files
[config](./config), and [nginx.conf](../../../adblock2privoxy//nginx.conf) so that they're
available for devices on the LAN, or connecting from a [VPN tunnel](../../../macos-openvpn-server/).
### Macports updates
Update Macports packages regularly. This command with update the Macports database, update all installed packages, and uninstall all older, inactive versions.
`sudo bash -c 'port selfupdate ; port -puN upgrade outdated ; port uninstall inactive'`
### Warning about Privoxy compression
Though it's possible to build Privoxy with the `configure` `--enable-compression` option,
compressed HTTP traffic within a [VPN tunnel](../../../macos-openvpn-server) exposes your traffic to the
CRIME/BEAST/[VORACLE](https://openvpn.net/security-advisory/the-voracle-attack-vulnerability/) attacks and is generally not
recommended.
## Installation details
The MacPorts port
[macos-fortress](https://github.com/macports/macports-ports/tree/master/net/macos-fortress)
(`sudo port install macos-fortress`) installs and configures an macOS Firewall and Privatizing
Proxy. It will:
* Uses Macports to download and install several key utilities and applications (wget gnupg p7zip squid privoxy nmap)
* Configure macOS's PF native firewall (man pfctl, man pf.conf), and privoxy
* Networking on the local computer can be set up to use this Automatic Proxy Configuration without breaking App Store or other updates (see Privoxy config)
* Uncomment the nat directive in pf.conf if you wish to set up an [OpenVPN server](../../../macos-openvpn-server)
* Install and launch daemons that download and regularly update open source IP and host blacklists. The sources are emergingthreats.net (net.emergingthreats.blockips.plist), dshield.org (net.dshield.block.plist), hosts-file.net (net.hphosts.hosts.plist)
* After installation the connection between clients and the internet looks this this:
> **Application** :arrow_right: **`proxy.pac`** :arrow_right:port 8118:arrow_right: **Privoxy** :arrow_right: **Internet**
An auxilliary nginx-based webserver (nominally on `localhost:8119`) is used for both a `proxy.pac` ad and tracker blackhole and for CSS element blocking rules with the Privoxy configuration generated by [adblock2privoxy](../../../adblock2privoxy).
## Public Service Announcement
This firewall is configured to block all known tracker and adware content—in the browser, in-app, wherever it finds them. Many websites now offer an additional way to block ads: subscribe to their content. Security and privacy will always necessitate ad blocking, but now that this software has become mainstream with mainstream effects, ad blocker users must consider the [potential impact](http://arstechnica.com/business/2010/03/why-ad-blocking-is-devastating-to-the-sites-you-love/) of ad blocking on the writers and publications that are important to them. Personally, two publications that I gladly pay for, especially for their important 2016 US Presidential election coverage, are the *[New York Times](http://www.nytimes.com)* and *[The Atlantic](http://www.theatlantic.com)*. I encourage all users to subscribe to their own preferred publications and writers.
## Tracker blocking
[Lightbeam](https://www.mozilla.org/en-US/lightbeam/), the tracking tracker Firefox add-on, shows how ad- and tracker-blocking works to prevent third parties monitoring you or your children's online activities. My daughter enjoys the learning exercises at the children's website [ABCya!](http://www.abcya.com). The Lightbeam graph below on the left shows all the third party trackers after less than a minute of browser activity, without using a privatizing proxy. The graph on the right shows all this tracker activity blocked when this privatizing proxy is used.
| 
------------ | -------------
Lightbeam graph without proxy | Lightbeam graph with proxy
This problem is the subject of Gary Kovacs's TED talk, *Tracking Our Online Trackers:*
[](https://www.youtube.com/watch?v=f_f5wNw-2c0 "Tracking our online trackers")
## Attack blocking
The snort intrusion detection system reports far fewer events when known attack sites are blackholed by the packet filter:
| 
------------ | -------------
snort+BASE Overview | snort+BASE Events
## Notes
* Configure the squid proxy to accept connections on the LAN IP and set LAN device Automatic Proxy Configurations to http://lan_ip/proxy.pac to protect devices on the LAN.
* Count the number of attacks since boot with the script pf_attacks. ``Attack'' is defined as the number of blocked IPs in PF's bruteforce table plus the number of denied connections from blacklisted IPs in the tables compromised_ips, dshield_block_ip, and emerging_threats.
* Both squid and Privoxy are configured to forge the User-Agent. The default is an iPad to allow mobile device access. Change this to your local needs if necessary.
* Whitelist or blacklist specific domain names with the files `/usr/local/etc/whitelist.txt` and `/usr/local/etc/blacklist.txt`. After editing these file, use launchctl to unload and load the plist `/Library/LaunchDaemons/net.hphosts.hosts.plist`, which recreates the hostfile `/etc/hosts-hphost` and reconfigures the squid proxy to use the updates.
* Sometimes pf and privoxy do not launch at boot, in spite of the use of the use of their launch daemons. Fix this by hand after boot with the scripts `macosfortress_boot_check`, or individually using `pf_restart`, `privoxy_restart`, and `squid_restart`. And please post a solution if you find one.
* All open source updates are done using the `wget -N` option to save everyone's bandwidth
## Security
* These services are intended to be run on a secure LAN behind a router firewall.
* The default proxy configuration will only accept connections made from the local computer (localhost). If you change this to accept connections from any client on your LAN, do not configure the router to forward ports 8118, or you will be running an open web proxy.
================================================
FILE: blacklist.txt
================================================
# blacklisted hosts of the form "127.0.0.1 hostname.tld" appened to /etc/hosts
# 127.0.0.1 www.ahostnamethatyouwanttoblackholebutwillneveractuallyseeontheinternet.net
# https://krebsonsecurity.com/2014/01/deconstructing-the-9-84-credit-card-hustle/
127.0.0.1 callscs.in
127.0.0.1 cewebcs.com
127.0.0.1 cs-casa.com
127.0.0.1 cewcs.com
127.0.0.1 eduacc.in
127.0.0.1 educs.in
127.0.0.1 eetsac.com
127.0.0.1 etosac.com
127.0.0.1 feosac.com
127.0.0.1 foculu.com
127.0.0.1 homecs.in
127.0.0.1 iawcs.com
127.0.0.1 iewcs.com
127.0.0.1 livecs.in
127.0.0.1 netcs.in
127.0.0.1 ntccs.in
127.0.0.1 ntsupp.com
127.0.0.1 onwsac.com
127.0.0.1 premcs.in
127.0.0.1 profcs.com
127.0.0.1 quikcs.com
127.0.0.1 sacluc.com
127.0.0.1 sacsis.com
127.0.0.1 sewcs.com
127.0.0.1 suppcs.in
127.0.0.1 tdwcs.com
127.0.0.1 techcs.in
127.0.0.1 vagacs.com
127.0.0.1 webcs.in
# https://guardianapp.com/ios-app-location-report-sep2018.html
127.0.0.1 api.areametrics.com
127.0.0.1 in.cuebiq.com
127.0.0.1 et.intake.factual.com
127.0.0.1 api.factual.com
127.0.0.1 api.beaconsinspace.com
127.0.0.1 api.huq.io
127.0.0.1 m2m-api.inmarket.com
127.0.0.1 mobileapi.mobiquitynetworks.com
127.0.0.1 sdk.revealmobile.com
127.0.0.1 api.safegraph.com
127.0.0.1 incoming-data-sense360.s3.amazonaws.com
127.0.0.1 ios-quinoa-personal-identify-prod.sense360eng.com
127.0.0.1 ios-quinoa-events-prod.sense360eng.com
127.0.0.1 ios-quinoa-high-frequency-events-prod.sense360eng.com
127.0.0.1 v1.blueberry.cloud.databerries.com
127.0.0.1 pie.wirelessregistry.com
# Blocking this domain breaks CNN app live streaming -- send to nginx blackhole
# To diagnose:
# tcpdump -e -ttt -i en0 -w my-iPad-cnn-3128.pcap src my-iPad or dst my-iPad
# grep -a 'URL: <a' < my-iPad-cnn-3128.pcap | perl -lne 's/^.*URL: <a href="https?:\/\/([-\w.]+)\/?.*?">.*$/\1/; print;' | uniq
127.0.0.1:8119 bea4.v.fwmrm.net
================================================
FILE: blockips.conf
================================================
# Define tables and drop rules for open source IP blocks
# Reload with:
# pfctl -a blockips -T load -f /usr/local/etc/blockips.conf
# Emerging Threats Open Source, http://rules.emergingthreats.net/fwrules/
# http://rules.emergingthreats.net/fwrules/emerging-Block-IPs.txt
table <emerging_threats> persist file "/usr/local/etc/emerging-Block-IPs.txt"
block drop log quick from <emerging_threats> to any
# http://rules.emergingthreats.net/blockrules/compromised-ips.txt
table <compromised_ips> persist file "/usr/local/etc/compromised-ips.txt"
block drop log quick from <compromised_ips> to any
# THIS RULESET HAS BEEN OBSOLETED!!
# http://rules.emergingthreats.net/blockrules/rbn-ips.txt
#table <rbn_ips> persist file "/usr/local/etc/rbn-ips.txt"
#block drop log quick from <rbn_ips> to any
# http://rules.emergingthreats.net/blockrules/rbn-malvertisers-ips.txt
#table <rbn_malvertisers_ips> persist file "/usr/local/etc/rbn-malvertisers-ips.txt"
#block drop log quick from <rbn_malvertisers_ips> to any
# dshield.org block list
table <dshield_block_ip> persist file "/usr/local/etc/dshield_block_ip.txt"
block drop log quick from <dshield_block_ip> to any
================================================
FILE: com.github.essandess.easylist-pac.plist
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>com.github.essandess.easylist-pac</string>
<key>Program</key>
<string>/bin/bash</string>
<key>ProgramArguments</key>
<array>
<string>/bin/bash</string>
<string>-c</string>
<string>PATH=$PATH:/opt/local/bin PROXY_PAC_DIRECTORY=/Library/WebServer/Documents PYTHONIOENCODING=utf_8 ; /bin/mkdir -p /usr/local/etc ; ( /bin/test -f $PROXY_PAC_DIRECTORY/proxy.pac.orig || /usr/bin/install -m 644 -S $PROXY_PAC_DIRECTORY/proxy.pac $PROXY_PAC_DIRECTORY/proxy.pac.orig ) && /usr/local/bin/easylist_pac.py -p 127.0.0.1:3128 -b 127.0.0.1:8119 -d /usr/local/etc -P $PROXY_PAC_DIRECTORY/proxy.pac.orig && /usr/bin/install -m 644 -g admin -S /usr/local/etc/proxy.pac $PROXY_PAC_DIRECTORY/proxy.pac</string>
</array>
<key>RunAtLoad</key>
<false/>
<key>StartCalendarInterval</key>
<array>
<dict>
<key>Weekday</key>
<integer>7</integer>
<key>Hour</key>
<integer>1</integer>
<key>Minute</key>
<integer>10</integer>
</dict>
</array>
<key>StandardErrorPath</key>
<string>/var/log/system.log</string>
<key>StandardOutPath</key>
<string>/var/log/system.log</string>
</dict>
</plist>
================================================
FILE: config
================================================
# Sample Configuration File for Privoxy 3.0.26
#
# $Id: config,v 1.112 2016/08/26 13:14:18 fabiankeil Exp $
#
# Copyright (C) 2001-2016 Privoxy Developers https://www.privoxy.org/
#
#####################################################################
# #
# Table of Contents #
# #
# I. INTRODUCTION #
# II. FORMAT OF THE CONFIGURATION FILE #
# #
# 1. LOCAL SET-UP DOCUMENTATION #
# 2. CONFIGURATION AND LOG FILE LOCATIONS #
# 3. DEBUGGING #
# 4. ACCESS CONTROL AND SECURITY #
# 5. FORWARDING #
# 6. MISCELLANEOUS #
# 7. WINDOWS GUI OPTIONS #
# #
#####################################################################
#
#
# I. INTRODUCTION
# ===============
#
# This file holds Privoxy's main configuration. Privoxy detects
# configuration changes automatically, so you don't have to restart
# it unless you want to load a different configuration file.
#
# The configuration will be reloaded with the first request after
# the change was done, this request itself will still use the old
# configuration, though. In other words: it takes two requests
# before you see the result of your changes. Requests that are
# dropped due to ACL don't trigger reloads.
#
# When starting Privoxy on Unix systems, give the location of this
# file as last argument. On Windows systems, Privoxy will look for
# this file with the name 'config.txt' in the current working
# directory of the Privoxy process.
#
#
# II. FORMAT OF THE CONFIGURATION FILE
# ====================================
#
# Configuration lines consist of an initial keyword followed by a
# list of values, all separated by whitespace (any number of spaces
# or tabs). For example,
#
# actionsfile default.action
#
# Indicates that the actionsfile is named 'default.action'.
#
# The '#' indicates a comment. Any part of a line following a '#' is
# ignored, except if the '#' is preceded by a '\'.
#
# Thus, by placing a # at the start of an existing configuration
# line, you can make it a comment and it will be treated as if it
# weren't there. This is called "commenting out" an option and can
# be useful. Removing the # again is called "uncommenting".
#
# Note that commenting out an option and leaving it at its default
# are two completely different things! Most options behave very
# differently when unset. See the "Effect if unset" explanation in
# each option's description for details.
#
# Long lines can be continued on the next line by using a `\' as the
# last character.
#
#
# 1. LOCAL SET-UP DOCUMENTATION
# ==============================
#
# If you intend to operate Privoxy for more users than just
# yourself, it might be a good idea to let them know how to reach
# you, what you block and why you do that, your policies, etc.
#
#
# 1.1. user-manual
# =================
#
# Specifies:
#
# Location of the Privoxy User Manual.
#
# Type of value:
#
# A fully qualified URI
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# https://www.privoxy.org/version/user-manual/ will be used,
# where version is the Privoxy version.
#
# Notes:
#
# The User Manual URI is the single best source of information
# on Privoxy, and is used for help links from some of the
# internal CGI pages. The manual itself is normally packaged
# with the binary distributions, so you probably want to set
# this to a locally installed copy.
#
# Examples:
#
# 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
#
# The User Manual is then available to anyone with access to
# Privoxy, by following the built-in URL: http://
# config.privoxy.org/user-manual/ (or the shortcut: http://p.p/
# user-manual/).
#
# 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/
#
# WARNING!!!
#
# If set, this option should be the first option in the
# config file, because it is used while the config file is
# being read.
#
#user-manual https://www.privoxy.org/user-manual/
#
# 1.2. trust-info-url
# ====================
#
# Specifies:
#
# A URL to be displayed in the error page that users will see if
# access to an untrusted page is denied.
#
# Type of value:
#
# URL
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# No links are displayed on the "untrusted" error page.
#
# Notes:
#
# The value of this option only matters if the experimental
# trust mechanism has been activated. (See trustfile below.)
#
# If you use the trust mechanism, it is a good idea to write up
# some on-line documentation about your trust policy and to
# specify the URL(s) here. Use multiple times for multiple URLs.
#
# The URL(s) should be added to the trustfile as well, so users
# don't end up locked out from the information on why they were
# locked out in the first place!
#
#trust-info-url http://www.example.com/why_we_block.html
#trust-info-url http://www.example.com/what_we_allow.html
#
# 1.3. admin-address
# ===================
#
# Specifies:
#
# An email address to reach the Privoxy administrator.
#
# Type of value:
#
# Email address
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# No email address is displayed on error pages and the CGI user
# interface.
#
# Notes:
#
# If both admin-address and proxy-info-url are unset, the whole
# "Local Privoxy Support" box on all generated pages will not be
# shown.
#
#admin-address privoxy-admin@example.com
admin-address root@localhost
#
# 1.4. proxy-info-url
# ====================
#
# Specifies:
#
# A URL to documentation about the local Privoxy setup,
# configuration or policies.
#
# Type of value:
#
# URL
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# No link to local documentation is displayed on error pages and
# the CGI user interface.
#
# Notes:
#
# If both admin-address and proxy-info-url are unset, the whole
# "Local Privoxy Support" box on all generated pages will not be
# shown.
#
# This URL shouldn't be blocked ;-)
#
#proxy-info-url http://www.example.com/proxy-service.html
#
# 2. CONFIGURATION AND LOG FILE LOCATIONS
# ========================================
#
# Privoxy can (and normally does) use a number of other files for
# additional configuration, help and logging. This section of the
# configuration file tells Privoxy where to find those other files.
#
# The user running Privoxy, must have read permission for all
# configuration files, and write permission to any files that would
# be modified, such as log files and actions files.
#
#
# 2.1. confdir
# =============
#
# Specifies:
#
# The directory where the other configuration files are located.
#
# Type of value:
#
# Path name
#
# Default value:
#
# /etc/privoxy (Unix) or Privoxy installation dir (Windows)
#
# Effect if unset:
#
# Mandatory
#
# Notes:
#
# No trailing "/", please.
#
confdir /opt/local/etc/privoxy
#
# 2.2. templdir
# ==============
#
# Specifies:
#
# An alternative directory where the templates are loaded from.
#
# Type of value:
#
# Path name
#
# Default value:
#
# unset
#
# Effect if unset:
#
# The templates are assumed to be located in confdir/template.
#
# Notes:
#
# Privoxy's original templates are usually overwritten with each
# update. Use this option to relocate customized templates that
# should be kept. As template variables might change between
# updates, you shouldn't expect templates to work with Privoxy
# releases other than the one they were part of, though.
#
#templdir .
#
# 2.3. temporary-directory
# =========================
#
# Specifies:
#
# A directory where Privoxy can create temporary files.
#
# Type of value:
#
# Path name
#
# Default value:
#
# unset
#
# Effect if unset:
#
# No temporary files are created, external filters don't work.
#
# Notes:
#
# To execute external filters, Privoxy has to create temporary
# files. This directive specifies the directory the temporary
# files should be written to.
#
# It should be a directory only Privoxy (and trusted users) can
# access.
#
#temporary-directory .
#
# 2.4. logdir
# ============
#
# Specifies:
#
# The directory where all logging takes place (i.e. where the
# logfile is located).
#
# Type of value:
#
# Path name
#
# Default value:
#
# /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
#
# Effect if unset:
#
# Mandatory
#
# Notes:
#
# No trailing "/", please.
#
logdir /opt/local/var/log/privoxy
#
# 2.5. actionsfile
# =================
#
# Specifies:
#
# The actions file(s) to use
#
# Type of value:
#
# Complete file name, relative to confdir
#
# Default values:
#
# match-all.action # Actions that are applied to all sites and maybe overruled later on.
#
# default.action # Main actions file
#
# user.action # User customizations
#
# Effect if unset:
#
# No actions are taken at all. More or less neutral proxying.
#
# Notes:
#
# Multiple actionsfile lines are permitted, and are in fact
# recommended!
#
# The default values are default.action, which is the "main"
# actions file maintained by the developers, and user.action,
# where you can make your personal additions.
#
# Actions files contain all the per site and per URL
# configuration for ad blocking, cookie management, privacy
# considerations, etc.
#
actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
actionsfile default.action # Main actions file
actionsfile user.action # User customizations
actionsfile /usr/local/etc/adblock2privoxy/privoxy/ab2p.system.action
actionsfile /usr/local/etc/adblock2privoxy/privoxy/ab2p.action
#
# 2.6. filterfile
# ================
#
# Specifies:
#
# The filter file(s) to use
#
# Type of value:
#
# File name, relative to confdir
#
# Default value:
#
# default.filter (Unix) or default.filter.txt (Windows)
#
# Effect if unset:
#
# No textual content filtering takes place, i.e. all +filter{name}
# actions in the actions files are turned neutral.
#
# Notes:
#
# Multiple filterfile lines are permitted.
#
# The filter files contain content modification rules that use
# regular expressions. These rules permit powerful changes on
# the content of Web pages, and optionally the headers as well,
# e.g., you could try to disable your favorite JavaScript
# annoyances, re-write the actual displayed text, or just have
# some fun playing buzzword bingo with web pages.
#
# The +filter{name} actions rely on the relevant filter (name)
# to be defined in a filter file!
#
# A pre-defined filter file called default.filter that contains
# a number of useful filters for common problems is included in
# the distribution. See the section on the filter action for a
# list.
#
# It is recommended to place any locally adapted filters into a
# separate file, such as user.filter.
#
filterfile default.filter
filterfile user.filter # User customizations
filterfile /usr/local/etc/adblock2privoxy/privoxy/ab2p.system.filter
filterfile /usr/local/etc/adblock2privoxy/privoxy/ab2p.filter
#
# 2.7. logfile
# =============
#
# Specifies:
#
# The log file to use
#
# Type of value:
#
# File name, relative to logdir
#
# Default value:
#
# Unset (commented out). When activated: logfile (Unix) or
# privoxy.log (Windows).
#
# Effect if unset:
#
# No logfile is written.
#
# Notes:
#
# The logfile is where all logging and error messages are
# written. The level of detail and number of messages are set
# with the debug option (see below). The logfile can be useful
# for tracking down a problem with Privoxy (e.g., it's not
# blocking an ad you think it should block) and it can help you
# to monitor what your browser is doing.
#
# Depending on the debug options below, the logfile may be a
# privacy risk if third parties can get access to it. As most
# users will never look at it, Privoxy only logs fatal errors by
# default.
#
# For most troubleshooting purposes, you will have to change
# that, please refer to the debugging section for details.
#
# Any log files must be writable by whatever user Privoxy is
# being run as (on Unix, default user id is "privoxy").
#
# To prevent the logfile from growing indefinitely, it is
# recommended to periodically rotate or shorten it. Many
# operating systems support log rotation out of the box, some
# require additional software to do it. For details, please
# refer to the documentation for your operating system.
#
logfile logfile
#
# 2.8. trustfile
# ===============
#
# Specifies:
#
# The name of the trust file to use
#
# Type of value:
#
# File name, relative to confdir
#
# Default value:
#
# Unset (commented out). When activated: trust (Unix) or
# trust.txt (Windows)
#
# Effect if unset:
#
# The entire trust mechanism is disabled.
#
# Notes:
#
# The trust mechanism is an experimental feature for building
# white-lists and should be used with care. It is NOT
# recommended for the casual user.
#
# If you specify a trust file, Privoxy will only allow access to
# sites that are specified in the trustfile. Sites can be listed
# in one of two ways:
#
# Prepending a ~ character limits access to this site only (and
# any sub-paths within this site), e.g. ~www.example.com allows
# access to ~www.example.com/features/news.html, etc.
#
# Or, you can designate sites as trusted referrers, by
# prepending the name with a + character. The effect is that
# access to untrusted sites will be granted -- but only if a
# link from this trusted referrer was used to get there. The
# link target will then be added to the "trustfile" so that
# future, direct accesses will be granted. Sites added via this
# mechanism do not become trusted referrers themselves (i.e.
# they are added with a ~ designation). There is a limit of 512
# such entries, after which new entries will not be made.
#
# If you use the + operator in the trust file, it may grow
# considerably over time.
#
# It is recommended that Privoxy be compiled with the
# --disable-force, --disable-toggle and --disable-editor
# options, if this feature is to be used.
#
# Possible applications include limiting Internet access for
# children.
#
#trustfile trust
#
# 3. DEBUGGING
# =============
#
# These options are mainly useful when tracing a problem. Note that
# you might also want to invoke Privoxy with the --no-daemon command
# line option when debugging.
#
#
# 3.1. debug
# ===========
#
# Specifies:
#
# Key values that determine what information gets logged.
#
# Type of value:
#
# Integer values
#
# Default value:
#
# 0 (i.e.: only fatal errors (that cause Privoxy to exit) are
# logged)
#
# Effect if unset:
#
# Default value is used (see above).
#
# Notes:
#
# The available debug levels are:
#
# debug 1 # Log the destination for each request Privoxy 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 Privoxy 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 multiple debug lines.
#
# A debug level of 1 is informative because it will show you
# each request 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).
#
# If you are used to the more verbose settings, simply enable
# the debug lines below again.
#
# If you want to use pure CLF (Common Log Format), you should
# set "debug 512" ONLY and not enable anything else.
#
# Privoxy has a hard-coded limit for the length of log messages.
# If it's reached, messages are logged truncated and marked with
# "... [too long, truncated]".
#
# Please don't file any support requests without trying to
# reproduce the problem with increased debug level first. Once
# you read the log messages, you may even be able to solve the
# problem on your own.
#
#debug 1 # Log the destination for each request Privoxy let through. See also debug 1024.
#debug 1024 # Actions that are applied to all sites and maybe overruled later on.
#debug 4096 # Startup banner and warnings
#debug 8192 # Non-fatal errors
#
# 3.2. single-threaded
# =====================
#
# Specifies:
#
# Whether to run only one server thread.
#
# Type of value:
#
# 1 or 0
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Multi-threaded (or, where unavailable: forked) operation, i.e.
# the ability to serve multiple requests simultaneously.
#
# Notes:
#
# This option is only there for debugging purposes. It will
# drastically reduce performance.
#
#single-threaded 1
#
# 3.3. hostname
# ==============
#
# Specifies:
#
# The hostname shown on the CGI pages.
#
# Type of value:
#
# Text
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# The hostname provided by the operating system is used.
#
# Notes:
#
# On some misconfigured systems resolving the hostname fails or
# takes too much time and slows Privoxy down. Setting a fixed
# hostname works around the problem.
#
# In other circumstances it might be desirable to show a
# hostname other than the one returned by the operating system.
# For example if the system has several different hostnames and
# you don't want to use the first one.
#
# Note that Privoxy does not validate the specified hostname
# value.
#
hostname localhost
#
# 4. ACCESS CONTROL AND SECURITY
# ===============================
#
# This section of the config file controls the security-relevant
# aspects of Privoxy's configuration.
#
#
# 4.1. listen-address
# ====================
#
# Specifies:
#
# The address and TCP port on which Privoxy will listen for
# client requests.
#
# Type of value:
#
# [IP-Address]:Port
#
# [Hostname]:Port
#
# Default value:
#
# 127.0.0.1:8118
#
# Effect if unset:
#
# Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is
# suitable and recommended for home users who run Privoxy on the
# same machine as their browser.
#
# Notes:
#
# You will need to configure your browser(s) to this proxy
# address and port.
#
# If you already have another service running on port 8118, or
# if you want to serve requests from other machines (e.g. on
# your local network) as well, you will need to override the
# default.
#
# You can use this statement multiple times to make Privoxy
# listen on more ports or more IP addresses. Suitable if your
# operating system does not support sharing IPv6 and IPv4
# protocols on the same socket.
#
# If a hostname is used instead of an IP address, Privoxy will
# try to resolve it to an IP address and if there are multiple,
# use the first one returned.
#
# If the address for the hostname isn't already known on the
# system (for example because it's in /etc/hostname), this may
# result in DNS traffic.
#
# If the specified address isn't available on the system, or if
# the hostname can't be resolved, Privoxy will fail to start.
#
# 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.
#
# Some operating systems will prefer IPv6 to IPv4 addresses even
# if the system has no IPv6 connectivity which is usually not
# expected by the user. Some even rely on DNS to resolve
# localhost which mean the "localhost" address used may not
# actually be local.
#
# It is therefore recommended to explicitly configure the
# intended IP address instead of relying on the operating
# system, unless there's a strong reason not to.
#
# If you leave out the address, Privoxy will bind to all IPv4
# interfaces (addresses) on your machine and may become
# reachable from the Internet and/or the local network. Be aware
# that some GNU/Linux distributions modify that behaviour
# without updating the documentation. Check for non-standard
# patches if your Privoxy version behaves differently.
#
# If you configure Privoxy to be reachable from the network,
# consider using access control lists (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:
# enable-edit-actions and enable-remote-toggle
#
# Example:
#
# Suppose you are running Privoxy on a machine which has the
# address 192.168.0.1 on your local private network
# (192.168.0.0) and has another outside connection with a
# different address. You want it to serve requests from inside
# only:
#
# listen-address 192.168.0.1:8118
#
# Suppose you are running Privoxy on an IPv6-capable machine and
# you want it to listen on the IPv6 address of the loopback
# device:
#
# listen-address [::1]:8118
#
listen-address 127.0.0.1:8118
#
# 4.2. toggle
# ============
#
# Specifies:
#
# Initial state of "toggle" status
#
# Type of value:
#
# 1 or 0
#
# Default value:
#
# 1
#
# Effect if unset:
#
# Act as if toggled on
#
# Notes:
#
# If set to 0, Privoxy will start in "toggled off" mode, i.e.
# mostly behave like a normal, content-neutral proxy with both
# ad blocking and content filtering disabled. See
# enable-remote-toggle below.
#
toggle 1
#
# 4.3. enable-remote-toggle
# ==========================
#
# Specifies:
#
# Whether or not the web-based toggle feature may be used
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# The web-based toggle feature is disabled.
#
# Notes:
#
# When toggled off, Privoxy mostly acts like a normal,
# content-neutral proxy, i.e. doesn't block ads or filter
# content.
#
# Access to the toggle feature can not be controlled separately
# by "ACLs" or HTTP authentication, so that everybody who can
# access Privoxy (see "ACLs" and listen-address above) can
# toggle it for all users. So this option is not recommended for
# multi-user environments with untrusted users.
#
# Note that malicious client side code (e.g Java) is also
# capable of using this option.
#
# As a lot of Privoxy users don't read documentation, this
# feature is disabled by default.
#
# Note that you must have compiled Privoxy with support for this
# feature, otherwise this option has no effect.
#
enable-remote-toggle 0
#
# 4.4. enable-remote-http-toggle
# ===============================
#
# Specifies:
#
# Whether or not Privoxy recognizes special HTTP headers to
# change its behaviour.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Privoxy ignores special HTTP headers.
#
# Notes:
#
# When toggled on, the client can change Privoxy's behaviour by
# setting special HTTP headers. Currently the only supported
# special header is "X-Filter: No", to disable filtering for the
# ongoing request, even if it is enabled in one of the action
# files.
#
# This feature is disabled by default. If you are using Privoxy
# in a environment with trusted clients, you may enable this
# feature at your discretion. Note that malicious client side
# code (e.g Java) is also capable of using this feature.
#
# This option will be removed in future releases as it has been
# obsoleted by the more general header taggers.
#
enable-remote-http-toggle 0
#
# 4.5. enable-edit-actions
# =========================
#
# Specifies:
#
# Whether or not the web-based actions file editor may be used
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# The web-based actions file editor is disabled.
#
# Notes:
#
# Access to the editor can not be controlled separately by
# "ACLs" or HTTP authentication, so that everybody who can
# access Privoxy (see "ACLs" and listen-address above) can
# modify its configuration for all users.
#
# This option is not recommended for environments with untrusted
# users and as a lot of Privoxy users don't read documentation,
# this feature is disabled by default.
#
# Note that malicious client side code (e.g Java) is also
# capable of using the actions editor and you shouldn't enable
# this options unless you understand the consequences and are
# sure your browser is configured correctly.
#
# Note that you must have compiled Privoxy with support for this
# feature, otherwise this option has no effect.
#
enable-edit-actions 0
#
# 4.6. enforce-blocks
# ====================
#
# Specifies:
#
# Whether the user is allowed to ignore blocks and can "go there
# anyway".
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Blocks are not enforced.
#
# Notes:
#
# Privoxy is mainly used to block and filter requests as a
# service to the user, for example to block ads and other junk
# that clogs the pipes. Privoxy's configuration isn't perfect
# and sometimes innocent pages are blocked. In this situation it
# makes sense to allow the user to enforce the request and have
# Privoxy ignore the block.
#
# In the default configuration Privoxy's "Blocked" page contains
# a "go there anyway" link to adds a special string (the force
# prefix) to the request URL. If that link is used, Privoxy will
# detect the force prefix, remove it again and let the request
# pass.
#
# Of course Privoxy can also be used to enforce a network
# policy. In that case the user obviously should not be able to
# bypass any blocks, and that's what the "enforce-blocks" option
# is for. If it's enabled, Privoxy hides the "go there anyway"
# link. If the user adds the force prefix by hand, it will not
# be accepted and the circumvention attempt is logged.
#
# Examples:
#
# enforce-blocks 1
#
enforce-blocks 0
#
# 4.7. ACLs: permit-access and deny-access
# =========================================
#
# Specifies:
#
# Who can access what.
#
# Type of value:
#
# src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
#
# Where src_addr and dst_addr are IPv4 addresses in dotted
# decimal notation or valid DNS names, port is a port number,
# and src_masklen and dst_masklen are subnet masks in CIDR
# notation, i.e. integer values from 2 to 30 representing the
# length (in bits) of the network address. The masks and the
# whole destination part are optional.
#
# If your system implements RFC 3493, then src_addr and dst_addr
# can be IPv6 addresses delimeted by brackets, port can be a
# number or a service name, and src_masklen and dst_masklen can
# be a number from 0 to 128.
#
# Default value:
#
# Unset
#
# If no port is specified, any port will match. If no
# src_masklen or src_masklen is given, the complete IP address
# has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
#
# Effect if unset:
#
# Don't restrict access further than implied by listen-address
#
# Notes:
#
# Access controls are included at the request of ISPs and
# systems administrators, and are not usually needed by
# individual users. For a typical home user, it will normally
# suffice to ensure that Privoxy only listens on the localhost
# (127.0.0.1) or internal (home) network address by means of the
# listen-address option.
#
# Please see the warnings in the FAQ that Privoxy is not
# intended to be a substitute for a firewall or to encourage
# anyone to defer addressing basic security weaknesses.
#
# Multiple ACL lines are OK. If any ACLs are specified, Privoxy
# only talks to IP addresses that match at least one
# permit-access line and don't match any subsequent deny-access
# line. In other words, the last match wins, with the default
# being deny-access.
#
# If Privoxy is using a forwarder (see forward below) for a
# particular destination URL, the dst_addr that is examined is
# the address of the forwarder and NOT the address of the
# ultimate target. This is necessary because it may be
# impossible for the local Privoxy to determine the IP address
# of the ultimate target (that's often what gateways are used
# for).
#
# You should prefer using IP addresses over DNS names, because
# the address lookups take time. All DNS names must resolve! You
# can not use domain patterns like "*.org" or partial domain
# names. If a DNS name resolves to multiple IP addresses, only
# the first one is used.
#
# Some systems allow IPv4 clients to connect to IPv6 server
# sockets. Then the client's IPv4 address will be translated by
# the system into IPv6 address space with special prefix
# ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
# can handle it and maps such ACL addresses automatically.
#
# Denying access to particular sites by ACL may have undesired
# side effects if the site in question is hosted on a machine
# which also hosts other sites (most sites are).
#
# Examples:
#
# Explicitly define the default behavior if no ACL and
# listen-address are set: "localhost" is OK. The absence of a
# dst_addr implies that all destination addresses are OK:
#
# 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
#
# Allow access from any host on the 26-bit subnet 192.168.45.64
# to anywhere, with the exception that 192.168.45.73 may not
# access the IP address behind 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
#
# 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
#
#
# 4.8. buffer-limit
# ==================
#
# Specifies:
#
# Maximum size of the buffer for content filtering.
#
# Type of value:
#
# Size in Kbytes
#
# Default value:
#
# 4096
#
# Effect if unset:
#
# Use a 4MB (4096 KB) limit.
#
# Notes:
#
# For content filtering, i.e. the +filter and +deanimate-gif
# actions, it is necessary that Privoxy buffers the entire
# document body. This can be potentially dangerous, since a
# server could just keep sending data indefinitely and wait for
# your RAM to exhaust -- with nasty consequences. Hence this
# option.
#
# When a document buffer size reaches the buffer-limit, it is
# flushed to the client unfiltered and no further attempt to
# filter the rest of the document is made. Remember that there
# may be multiple threads running, which might require up to
# buffer-limit Kbytes each, unless you have enabled
# "single-threaded" above.
#
buffer-limit 4096
#
# 4.9. enable-proxy-authentication-forwarding
# ============================================
#
# Specifies:
#
# Whether or not proxy authentication through Privoxy should
# work.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Proxy authentication headers are removed.
#
# Notes:
#
# Privoxy itself does not support proxy authentication, but can
# allow clients to authenticate against Privoxy's parent proxy.
#
# By default Privoxy (3.0.21 and later) don't do that and remove
# Proxy-Authorization headers in requests and Proxy-Authenticate
# headers in responses to make it harder for malicious sites to
# trick inexperienced users into providing login information.
#
# If this option is enabled the headers are forwarded.
#
# Enabling this option is not recommended if there is no parent
# proxy that requires authentication or if the local network
# between Privoxy and the parent proxy isn't trustworthy. If
# proxy authentication is only required for some requests, it is
# recommended to use a client header filter to remove the
# authentication headers for requests where they aren't needed.
#
enable-proxy-authentication-forwarding 0
#
# 5. FORWARDING
# ==============
#
# This feature allows routing of HTTP requests through a chain of
# multiple proxies.
#
# Forwarding can be used to chain Privoxy with a caching proxy to
# speed up browsing. Using a parent proxy may also be necessary if
# the machine that Privoxy runs on has no direct Internet access.
#
# Note that parent proxies can severely decrease your privacy level.
# For example a parent proxy could add your IP address to the
# request headers and if it's a caching proxy it may add the "Etag"
# header to revalidation requests again, even though you configured
# Privoxy to remove it. It may also ignore Privoxy's header time
# randomization and use the original values which could be used by
# the server as cookie replacement to track your steps between
# visits.
#
# Also specified here are SOCKS proxies. Privoxy supports the SOCKS
# 4 and SOCKS 4A protocols.
#
#
# 5.1. forward
# =============
#
# Specifies:
#
# To which parent HTTP proxy specific requests should be routed.
#
# Type of value:
#
# target_pattern http_parent[:port]
#
# where target_pattern is a URL pattern that specifies to which
# requests (i.e. URLs) this forward rule shall apply. Use / to
# denote "all URLs". http_parent[:port] is the DNS name or IP
# address of the parent HTTP proxy through which the requests
# should be forwarded, optionally followed by its listening port
# (default: 8000). Use a single dot (.) to denote "no
# forwarding".
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# Don't use parent HTTP proxies.
#
# Notes:
#
# If http_parent is ".", then requests are not forwarded to
# another HTTP proxy but are made directly to the web servers.
#
# http_parent can be a numerical IPv6 address (if RFC 3493 is
# implemented). To prevent clashes with the port delimiter, the
# whole IP address has to be put into brackets. On the other
# hand a target_pattern containing an IPv6 address has to be put
# into angle brackets (normal brackets are reserved for regular
# expressions already).
#
# Multiple lines are OK, they are checked in sequence, and the
# last match wins.
#
# Examples:
#
# 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 .
#
# 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 .
#
# Parent proxy specified by an IPv6 address:
#
# 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]:*> .
#
#
# See http://www.christianschenk.org/blog/enhancing-your-privacy-using-squid-and-privoxy/
forward / .
forward :443 .
# I2P
#forward .i2p localhost:4443
# 5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
# =========================================================================
#
# Specifies:
#
# Through which SOCKS proxy (and optionally to which parent HTTP
# proxy) specific requests should be routed.
#
# Type of value:
#
# target_pattern socks_proxy[:port] http_parent[:port]
#
# where target_pattern is a URL pattern that specifies to which
# requests (i.e. URLs) this forward rule shall apply. Use / to
# denote "all URLs". http_parent and socks_proxy are IP
# addresses in dotted decimal notation or valid DNS names (
# 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
#
# Default value:
#
# Unset
#
# Effect if unset:
#
# Don't use SOCKS proxies.
#
# Notes:
#
# Multiple lines are OK, they are checked in sequence, and the
# last match wins.
#
# The difference between forward-socks4 and forward-socks4a is
# that in the SOCKS 4A protocol, the DNS resolution of the
# target hostname happens on the SOCKS server, while in SOCKS 4
# it happens locally.
#
# With forward-socks5 the DNS resolution will happen on the
# remote server as well.
#
# forward-socks5t works like vanilla forward-socks5 but lets
# Privoxy additionally use Tor-specific SOCKS extensions.
# Currently the only supported SOCKS extension is optimistic
# data which can reduce the latency for the first request made
# on a newly created connection.
#
# socks_proxy and http_parent can be a numerical IPv6 address
# (if RFC 3493 is implemented). To prevent clashes with the port
# delimiter, the whole IP address has to be put into brackets.
# On the other hand a target_pattern containing an IPv6 address
# has to be put into angle brackets (normal brackets are
# reserved for regular expressions already).
#
# If http_parent is ".", then requests are not forwarded to
# another HTTP proxy but are made (HTTP-wise) directly to the
# web servers, albeit through a SOCKS proxy.
#
# Examples:
#
# From the company example.com, direct connections are made to
# all "internal" domains, but everything outbound goes through
# their ISP's proxy by way of example.com's corporate SOCKS 4A
# gateway to the Internet.
#
# 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 .
#
# To chain Privoxy and Tor, both running on the same system, you
# would use something like:
#
# forward-socks5t / 127.0.0.1:9050 .
#
# Note that if you got Tor through one of the bundles, you may
# have to change the port from 9050 to 9150 (or even another
# one). For details, please check the documentation on the Tor
# website.
#
# The public Tor network can't be used to reach your local
# network, if you need to access local servers you therefore
# might want to make some exceptions:
#
# forward 192.168.*.*/ .
# forward 10.*.*.*/ .
# forward 127.*.*.*/ .
#
# Unencrypted connections to systems in these address ranges
# will be as (un)secure as the local network is, but the
# alternative is that you can't reach the local network through
# Privoxy at all. Of course this may actually be desired and
# there is no reason to make these exceptions if you aren't sure
# you need them.
#
# If you also want to be able to reach servers in your local
# network by using their names, you will need additional
# exceptions that look like this:
#
# forward localhost/ .
#
#
# 5.3. forwarded-connect-retries
# ===============================
#
# Specifies:
#
# How often Privoxy retries if a forwarded connection request
# fails.
#
# Type of value:
#
# Number of retries.
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Connections forwarded through other proxies are treated like
# direct connections and no retry attempts are made.
#
# Notes:
#
# forwarded-connect-retries is mainly interesting for socks4a
# connections, where Privoxy can't detect why the connections
# failed. The connection might have failed because of a DNS
# timeout in which case a retry makes sense, but it might also
# have failed because the server doesn't exist or isn't
# reachable. In this case the retry will just delay the
# appearance of Privoxy's error message.
#
# Note that in the context of this option, "forwarded
# connections" includes all connections that Privoxy forwards
# through other proxies. This option is not limited to the HTTP
# CONNECT method.
#
# Only use this option, if you are getting lots of
# forwarding-related error messages that go away when you try
# again manually. Start with a small value and check Privoxy's
# logfile from time to time, to see how many retries are usually
# needed.
#
# Examples:
#
# forwarded-connect-retries 1
#
forwarded-connect-retries 0
#
# 6. MISCELLANEOUS
# =================
#
# 6.1. accept-intercepted-requests
# =================================
#
# Specifies:
#
# Whether intercepted requests should be treated as valid.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Only proxy requests are accepted, intercepted requests are
# treated as invalid.
#
# Notes:
#
# If you don't trust your clients and want to force them to use
# Privoxy, enable this option and configure your packet filter
# to redirect outgoing HTTP connections into Privoxy.
#
# Note that intercepting encrypted connections (HTTPS) isn't
# supported.
#
# Make sure that Privoxy's own requests aren't redirected as
# well. Additionally take care that Privoxy can't intentionally
# connect to itself, otherwise you could run into redirection
# loops if Privoxy's listening port is reachable by the outside
# or an attacker has access to the pages you visit.
#
# If you are running Privoxy as intercepting proxy without being
# able to intercept all client requests you may want to adjust
# the CGI templates to make sure they don't reference content
# from config.privoxy.org.
#
# Examples:
#
# accept-intercepted-requests 1
#
accept-intercepted-requests 0
#
# 6.2. allow-cgi-request-crunching
# =================================
#
# Specifies:
#
# Whether requests to Privoxy's CGI pages can be blocked or
# redirected.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Privoxy ignores block and redirect actions for its CGI pages.
#
# Notes:
#
# By default Privoxy ignores block or redirect actions for its
# CGI pages. Intercepting these requests can be useful in
# multi-user setups to implement fine-grained access control,
# but it can also render the complete web interface useless and
# make debugging problems painful if done without care.
#
# Don't enable this option unless you're sure that you really
# need it.
#
# Examples:
#
# allow-cgi-request-crunching 1
#
allow-cgi-request-crunching 0
#
# 6.3. split-large-forms
# =======================
#
# Specifies:
#
# Whether the CGI interface should stay compatible with broken
# HTTP clients.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# The CGI form generate long GET URLs.
#
# Notes:
#
# Privoxy's CGI forms can lead to rather long URLs. This isn't a
# problem as far as the HTTP standard is concerned, but it can
# confuse clients with arbitrary URL length limitations.
#
# Enabling split-large-forms causes Privoxy to divide big forms
# into smaller ones to keep the URL length down. It makes
# editing a lot less convenient and you can no longer submit all
# changes at once, but at least it works around this browser
# bug.
#
# If you don't notice any editing problems, there is no reason
# to enable this option, but if one of the submit buttons
# appears to be broken, you should give it a try.
#
# Examples:
#
# split-large-forms 1
#
split-large-forms 0
#
# 6.4. keep-alive-timeout
# ========================
#
# Specifies:
#
# Number of seconds after which an open connection will no
# longer be reused.
#
# Type of value:
#
# Time in seconds.
#
# Default value:
#
# None
#
# Effect if unset:
#
# Connections are not kept alive.
#
# Notes:
#
# This option allows clients to keep the connection to Privoxy
# alive. If the server supports it, Privoxy will keep the
# connection to the server alive as well. Under certain
# circumstances this may result in speed-ups.
#
# By default, Privoxy will close the connection to the server if
# the client connection gets closed, or if the specified timeout
# has been reached without a new request coming in. This
# behaviour can be changed with the connection-sharing option.
#
# This option has no effect if Privoxy has been compiled without
# keep-alive support.
#
# Note that a timeout of five seconds as used in the default
# configuration file significantly decreases the number of
# connections that will be reused. The value is used because
# some browsers limit the number of connections they open to a
# single host and apply the same limit to proxies. This can
# result in a single website "grabbing" all the connections the
# browser allows, which means connections to other websites
# can't be opened until the connections currently in use time
# out.
#
# Several users have reported this as a Privoxy bug, so the
# default value has been reduced. Consider increasing it to 300
# seconds or even more if you think your browser can handle it.
# If your browser appears to be hanging, it probably can't.
#
# Examples:
#
# keep-alive-timeout 300
#
keep-alive-timeout 300
#
# 6.5. tolerate-pipelining
# =========================
#
# Specifies:
#
# Whether or not pipelined requests should be served.
#
# Type of value:
#
# 0 or 1.
#
# Default value:
#
# None
#
# Effect if unset:
#
# If Privoxy receives more than one request at once, it
# terminates the client connection after serving the first one.
#
# Notes:
#
# Privoxy currently doesn't pipeline outgoing requests, thus
# allowing pipelining on the client connection is not guaranteed
# to improve the performance.
#
# By default Privoxy tries to discourage clients from pipelining
# by discarding aggressively pipelined requests, which forces
# the client to resend them through a new connection.
#
# This option lets Privoxy tolerate pipelining. Whether or not
# that improves performance mainly depends on the client
# configuration.
#
# If you are seeing problems with pages not properly loading,
# disabling this option could work around the problem.
#
# Examples:
#
# tolerate-pipelining 1
#
#tolerate-pipelining 1
#
# 6.6. default-server-timeout
# ============================
#
# Specifies:
#
# Assumed server-side keep-alive timeout if not specified by the
# server.
#
# Type of value:
#
# Time in seconds.
#
# Default value:
#
# None
#
# Effect if unset:
#
# Connections for which the server didn't specify the keep-alive
# timeout are not reused.
#
# Notes:
#
# Enabling this option significantly increases the number of
# connections that are reused, provided the keep-alive-timeout
# option is also enabled.
#
# While it also increases the number of connections problems
# when Privoxy tries to reuse a connection that already has been
# closed on the server side, or is closed while Privoxy is
# trying to reuse it, this should only be a problem if it
# happens for the first request sent by the client. If it
# happens for requests on reused client connections, Privoxy
# will simply close the connection and the client is supposed to
# retry the request without bothering the user.
#
# Enabling this option is therefore only recommended if the
# connection-sharing option is disabled.
#
# It is an error to specify a value larger than the
# keep-alive-timeout value.
#
# This option has no effect if Privoxy has been compiled without
# keep-alive support.
#
# Examples:
#
# default-server-timeout 60
#
default-server-timeout 60
#
# 6.7. connection-sharing
# ========================
#
# Specifies:
#
# Whether or not outgoing connections that have been kept alive
# should be shared between different incoming connections.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# None
#
# Effect if unset:
#
# Connections are not shared.
#
# Notes:
#
# This option has no effect if Privoxy has been compiled without
# keep-alive support, or if it's disabled.
#
# Notes:
#
# Note that reusing connections doesn't necessary cause
# speedups. There are also a few privacy implications you should
# be aware of.
#
# If this option is effective, 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 Privoxy and the server unless
# the client's request hasn't been completed yet.
#
# If the outgoing connection is idle, it will not be closed
# until either Privoxy's or the server's timeout is reached.
# While it's open, the server knows that the system running
# Privoxy is still there.
#
# If there are more than one client (maybe even belonging to
# multiple users), they will be able to reuse each others
# connections. This is potentially dangerous in case of
# authentication schemes like NTLM where only the connection is
# authenticated, instead of requiring authentication for each
# request.
#
# If there is only a single client, and if said client can keep
# connections alive on its own, enabling this option has next to
# no effect. If the client doesn't support connection
# keep-alive, enabling this option may make sense as it allows
# Privoxy to keep outgoing connections alive even if the client
# itself doesn't support it.
#
# You should also be aware that enabling this option increases
# the likelihood of getting the "No server or forwarder data"
# error message, especially if you are using a slow connection
# to the Internet.
#
# This option should only be used by experienced users who
# understand the risks and can weight them against the benefits.
#
# Examples:
#
# connection-sharing 1
#
connection-sharing 0
#
# 6.8. socket-timeout
# ====================
#
# Specifies:
#
# Number of seconds after which a socket times out if no data is
# received.
#
# Type of value:
#
# Time in seconds.
#
# Default value:
#
# None
#
# Effect if unset:
#
# A default value of 300 seconds is used.
#
# Notes:
#
# The default is quite high and you probably want to reduce it.
# If you aren't using an occasionally slow proxy like Tor,
# reducing it to a few seconds should be fine.
#
# Examples:
#
# socket-timeout 300
#
socket-timeout 60
#
# 6.9. max-client-connections
# ============================
#
# Specifies:
#
# Maximum number of client connections that will be served.
#
# Type of value:
#
# Positive number.
#
# Default value:
#
# 128
#
# Effect if unset:
#
# Connections are served until a resource limit is reached.
#
# Notes:
#
# Privoxy creates one thread (or process) for every incoming
# client connection that isn't rejected based on the access
# control settings.
#
# If the system is powerful enough, Privoxy can theoretically
# deal with several hundred (or thousand) connections at the
# same time, but some operating systems enforce resource limits
# by shutting down offending processes and their default limits
# may be below the ones Privoxy would require under heavy load.
#
# Configuring Privoxy to enforce a connection limit below the
# thread or process limit used by the operating system makes
# sure this doesn't happen. Simply increasing the operating
# system's limit would work too, but if Privoxy isn't the only
# application running on the system, you may actually want to
# limit the resources used by Privoxy.
#
# If Privoxy is only used by a single trusted user, limiting the
# number of client connections is probably unnecessary. If there
# are multiple possibly untrusted users you probably still want
# to additionally use a packet filter to limit the maximal
# number of incoming connections per client. Otherwise a
# malicious user could intentionally create a high number of
# connections to prevent other users from using Privoxy.
#
# Obviously using this option only makes sense if you choose a
# limit below the one enforced by the operating system.
#
# One most POSIX-compliant systems Privoxy 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 Privoxy with a
# different FD_SETSIZE limit.
#
# Examples:
#
# max-client-connections 256
#
max-client-connections 256
#
# 6.10. handle-as-empty-doc-returns-ok
# =====================================
#
# Specifies:
#
# The status code Privoxy returns for pages blocked with
# +handle-as-empty-document.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Privoxy returns a status 403(forbidden) for all blocked pages.
#
# Effect if set:
#
# Privoxy returns a status 200(OK) for pages blocked with
# +handle-as-empty-document and a status 403(Forbidden) for all
# other blocked pages.
#
# Notes:
#
# This directive was added as a work-around for Firefox bug
# 492459: "Websites are no longer rendered if SSL requests for
# JavaScripts are blocked by a proxy."
# (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug
# has been fixed for quite some time, but this directive is also
# useful to make it harder for websites to detect whether or not
# resources are being blocked.
#
#handle-as-empty-doc-returns-ok 1
#
# 6.11. enable-compression
# =========================
#
# Specifies:
#
# Whether or not buffered content is compressed before delivery.
#
# Type of value:
#
# 0 or 1
#
# Default value:
#
# 0
#
# Effect if unset:
#
# Privoxy does not compress buffered content.
#
# Effect if set:
#
# Privoxy compresses buffered content before delivering it to
# the client, provided the client supports it.
#
# Notes:
#
# This directive is only supported if Privoxy has been compiled
# with FEATURE_COMPRESSION, which should not to be confused with
# FEATURE_ZLIB.
#
# Compressing buffered content is mainly useful if Privoxy and
# the client are running on different systems. If they are
# running on the same system, enabling compression is likely to
# slow things down. If you didn't measure otherwise, you should
# assume that it does and keep this option disabled.
#
# Privoxy will not compress buffered content below a certain
# length.
#
#enable-compression 1
#
# 6.12. compression-level
# ========================
#
# Specifies:
#
# The compression level that is passed to the zlib library when
# compressing buffered content.
#
# Type of value:
#
# Positive number ranging from 0 to 9.
#
# Default value:
#
# 1
#
# Notes:
#
# Compressing the data more takes usually longer than
# compressing it less or not compressing it at all. Which level
# is best depends on the connection between Privoxy and the
# client. If you can't be bothered to benchmark it for yourself,
# you should stick with the default and keep compression
# disabled.
#
# If compression is disabled, the compression level is
# irrelevant.
#
# 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
#
#
#compression-level 9
#
# 6.13. client-header-order
# ==========================
#
# Specifies:
#
# The order in which client headers are sorted before forwarding
# them.
#
# Type of value:
#
# Client header names delimited by spaces or tabs
#
# Default value:
#
# None
#
# Notes:
#
# By default Privoxy leaves the client headers in the order they
# were sent by the client. Headers are modified in-place, new
# headers are added at the end of the already existing headers.
#
# The header order can be used to fingerprint client requests
# independently of other headers like the User-Agent.
#
# This directive allows to sort the headers differently to
# better mimic a different User-Agent. Client headers will be
# emitted in the order given, headers whose name isn't
# explicitly specified are added at the end.
#
# Note that sorting headers in an uncommon way will make
# fingerprinting actually easier. Encrypted headers are not
# affected by this directive.
#
#client-header-order Host \
# Accept \
# Accept-Language \
# Accept-Encoding \
# Proxy-Connection \
# Referer \
# Cookie \
# DNT \
# If-Modified-Since \
# Cache-Control \
# Content-Length \
# Content-Type
#
#
# 6.14. client-specific-tag
# ==========================
#
# Specifies:
#
# The name of a tag that will always be set for clients that
# requested it through the webinterface.
#
# Type of value:
#
# Tag name followed by a description that will be shown in the
# webinterface
#
# Default value:
#
# None
#
# Notes:
#
# +-----------------------------------------------------+
# | Warning |
# |-----------------------------------------------------|
# |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
# impacting other users.
#
# One use case is allowing users to circumvent certain blocks
# without having to allow them to circumvent all blocks. This is
# not possible with the enable-remote-toggle feature because it
# would bluntly disable all blocks for all users and also affect
# other actions like filters. It also is set globally which
# renders it useless in most multi-user setups.
#
# After a client-specific tag has been defined with the
# client-specific-tag directive, action sections can be
# activated based on the tag by using a CLIENT-TAG pattern. The
# CLIENT-TAG pattern is evaluated at the same priority as URL
# patterns, as a result the last matching pattern wins. Tags
# that are created based on client or server headers are
# evaluated later on and can overrule CLIENT-TAG and URL
# patterns!
#
# The tag is set for all requests that come from clients that
# requested it to be set. Note that "clients" are differentiated
# by IP address, if the IP address changes the tag has to be
# requested again.
#
# 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.
#
# 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
# disable-content-filters Disable content-filters but do not affect other actions
#
#
#
# 6.15. client-tag-lifetime
# ==========================
#
# Specifies:
#
# How long a temporarily enabled tag remains enabled.
#
# Type of value:
#
# Time in seconds.
#
# Default value:
#
# 60
#
# Notes:
#
# +-----------------------------------------------------+
# | Warning |
# |-----------------------------------------------------|
# |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 that is the result of an overly-broad
# URL pattern.
#
# The CGI interface http://config.privoxy.org/client-tags
# therefore provides a "enable this tag temporarily" option. If
# it is used, the tag will be set until the client-tag-lifetime
# is over.
#
# Examples:
#
# # Increase the time to life for temporarily enabled tags to 3 minutes
# client-tag-lifetime 180
#
#
#
# 6.16. trust-x-forwarded-for
# ============================
#
# Specifies:
#
# Whether or not Privoxy should use IP addresses specified with
# the X-Forwarded-For header
#
# Type of value:
#
# 0 or one
#
# Default value:
#
# 0
#
# Notes:
#
# +-----------------------------------------------------+
# | Warning |
# |-----------------------------------------------------|
# |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. If multiple clients use the same proxy, they
# will share the same client tag settings which is usually not
# desired.
#
# This option lets Privoxy use the X-Forwarded-For header value
# as client IP address. If the proxy sets the header, multiple
# clients using the same proxy do not share the same client tag
# settings.
#
# This option should only be enabled if Privoxy can only be
# reached through a proxy and if the proxy can be trusted to set
# the header correctly. It is recommended that ACL are used to
# make sure only trusted systems can reach Privoxy.
#
# If access to Privoxy isn't limited to trusted systems, this
# option would allow malicious clients to change the client tags
# for other clients or increase Privoxy's memory requirements by
# registering lots of client tag settings for clients that don't
# exist.
#
# Examples:
#
# # Allow systems that can reach Privoxy to provide the client
# # IP address with a X-Forwarded-For header.
# trust-x-forwarded-for 1
#
#
#
# 7. WINDOWS GUI OPTIONS
# =======================
#
# Privoxy has a number of options specific to the Windows GUI
# interface:
#
#
#
# If "activity-animation" is set to 1, the Privoxy icon will animate
# when "Privoxy" is active. To turn off, set to 0.
#
#activity-animation 1
#
#
#
# If "log-messages" is set to 1, Privoxy copies log messages to the
# console window. The log detail depends on the debug directive.
#
#log-messages 1
#
#
#
# If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
# the amount of memory used for the log messages displayed in the
# console window, will be limited to "log-max-lines" (see below).
#
# Warning: Setting this to 0 will result in the buffer to grow
# infinitely and eat up all your memory!
#
#log-buffer-size 1
#
#
#
# log-max-lines is the maximum number of lines held in the log
# buffer. See above.
#
#log-max-lines 200
#
#
#
# If "log-highlight-messages" is set to 1, Privoxy will highlight
# portions of the log messages with a bold-faced font:
#
#log-highlight-messages 1
#
#
#
# The font used in the console window:
#
#log-font-name Comic Sans MS
#
#
#
# Font size used in the console window:
#
#log-font-size 8
#
#
#
# "show-on-task-bar" controls whether or not Privoxy will appear as
# a button on the Task bar when minimized:
#
#show-on-task-bar 0
#
#
#
# If "close-button-minimizes" is set to 1, the Windows close button
# will minimize Privoxy instead of closing the program (close with
# the exit option on the File menu).
#
#close-button-minimizes 1
#
#
#
# The "hide-console" option is specific to the MS-Win console
# version of Privoxy. If this option is used, Privoxy will
# disconnect from and hide the command console.
#
#hide-console
#
#
#
================================================
FILE: deprecated/Squid.wrapper
================================================
#!/bin/sh
#
# MacPorts generated daemondo support script
#
#
# Init
#
prefix=/opt/local
#
# Start
#
Start()
{
cd /opt/local/var/squid
if [ ! -d "/opt/local/var/squid/cache/00" ]; then
/opt/local/sbin/squid -s -z
fi
/opt/local/sbin/squid -s -N
}
#
# Stop
#
Stop()
{
cd /opt/local/var/squid
/opt/local/sbin/squid -k shutdown
while /opt/local/sbin/squid -k check; do
sleep 1
done
}
#
# Restart
#
Restart()
{
Stop
Start
}
#
# Run
#
Run()
{
case $1 in
start ) Start ;;
stop ) Stop ;;
restart) Restart ;;
* ) echo "$0: unknown argument: $1";;
esac
}
#
# Run a phase based on the selector
#
Run $1
================================================
FILE: deprecated/disable.sh
================================================
#!/bin/bash -x
# OS X Fortress: Firewall, Blackhole, and Privatizing Proxy
# for Trackers, Attackers, Malware, Adware, and Spammers
# disable.sh
# commands
SUDO=/usr/bin/sudo
PORT=/opt/local/bin/port
LAUNCHCTL=/bin/launchctl
PFCTL=/sbin/pfctl
KILLALL=/usr/bin/killall
CAT=/bin/cat
ECHO=/bin/echo
$CAT <<HELPSTRING
OS X Fortress: Firewall, Blackhole, and Privatizing Proxy
for Trackers, Attackers, Malware, Adware, and Spammers
Kernel-level, OS-level, and client-level security for OS X.
This disable script will unload all launch daemons, disable
the pf firewall, and list all insalled files WITHOUT removing them.
Disabling…
HELPSTRING
$ECHO "Unloading launchctl daemons…"
LAUNCHDAEMONS=/Library/LaunchDaemons
launchctl_unload () { if [ -f $LAUNCHDAEMONS/$PLIST ]; then $SUDO $LAUNCHCTL unload -w $LAUNCHDAEMONS/$PLIST; fi; }
for FNAME in \
net.openbsd.pf.plist \
net.openbsd.pf.brutexpire.plist \
net.emergingthreats.blockips.plist \
net.dshield.block.plist \
net.hphosts.hosts.plist \
net.securemecca.pac.plist \
org.adblockplus.privoxy-adblock.plist \
org.squid-cache.squid-rotate.plist \
; do
launchctl_unload
done
$ECHO "Disabling pf firewall…"
$SUDO $PFCTL -d
$ECHO "Killing the squid and privoxy proxies…"
$SUDO $PORT unload squid
$SUDO $KILLALL -9 squid
$SUDO $KILLALL -9 '(squid-1)'
$SUDO $PORT unload privoxy
$ECHO ""
$ECHO "These files still exist:"
fname_exists () { if [ -f $FNAME ]; then $ECHO "$FNAME"; fi; }
PROXY_PAC_DIRECTORY=/Library/WebServer/Documents
for FNAME in \
$PROXY_PAC_DIRECTORY/proxy.pac \
/etc/hosts.orig \
/etc/pf.conf.orig \
$LAUNCHDAEMONS/net.openbsd.pf.plist \
$LAUNCHDAEMONS/net.openbsd.pf.brutexpire.plist \
$LAUNCHDAEMONS/net.emergingthreats.blockips.plist \
$LAUNCHDAEMONS/net.dshield.block.plist \
$LAUNCHDAEMONS/net.hphosts.hosts.plist \
$LAUNCHDAEMONS/net.securemecca.pac.plist \
$LAUNCHDAEMONS/org.adblockplus.privoxy-adblock.plist \
$HOME/Library/LaunchAgents/org.opensource.flashcookiedelete.plist \
/usr/local/etc/blockips.conf \
/usr/local/etc/whitelist.txt \
/usr/local/etc/blacklist.txt \
/usr/local/bin/macosfortress_setup_check.sh \
/usr/local/bin/osxfortress_boot_check \
/usr/local/bin/pf_restart \
/usr/local/bin/squid_restart \
/usr/local/bin/privoxy_restart \
/usr/local/bin/privoxy-adblock.sh \
/opt/local/etc/LaunchDaemons/org.macports.Squid/Squid.wrapper.orig \
; do
fname_exists
done
exit 0
================================================
FILE: deprecated/macosfortress_boot_check
================================================
#!/bin/bash -x
# macosfortress_boot_check -- check to make sure that all desired services are running
# commands
SUDO=/usr/bin/sudo
LAUNCHCTL=/bin/launchctl
PORT=/opt/local/bin/port
PFCTL=/sbin/pfctl
HEAD=/usr/bin/head
TAIL=/usr/bin/tail
LSOF=/usr/sbin/lsof
KILLALL=/usr/bin/killall
# pfctl
if ! [[ `$SUDO $PFCTL -s info | $HEAD -1 | $TAIL -1` =~ "Status: Enabled" ]]; then
$SUDO $LAUNCHCTL unload -w /Library/LaunchDaemons/net.openbsd.pf.plist
$SUDO $LAUNCHCTL load -w /Library/LaunchDaemons/net.openbsd.pf.plist
fi
# squid
# make sure there aren't multiple squid jobs running
if ! [[ `$SUDO $LSOF -i ':3128' | $TAIL -1` && `ps -ef | grep "/opt/local/sbin/squid -s" | grep -v grep | wc -l` -eq 1 ]]; then
$SUDO $PORT unload squid4
$SUDO $KILLALL '(squid-1)'
$SUDO $KILLALL 'squid'
/bin/sleep 5
$SUDO $PORT load squid4
fi
# privoxy
if ! [[ `$SUDO $LSOF -i ':8118' | $TAIL -1` ]]; then
$SUDO $PORT unload privoxy
$SUDO $PORT load privoxy
fi
================================================
FILE: deprecated/net.securemecca.pac.plist
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>net.securemecca.pac.plist</string>
<key>Program</key>
<string>/bin/bash</string>
<key>ProgramArguments</key>
<array>
<string>/bin/bash</string>
<string>-c</string>
<string>export PROXY_PAC_DIRECTORY=/Library/WebServer/Documents; /bin/mkdir -p /usr/local/etc ; ( /bin/test -f $PROXY_PAC_DIRECTORY/proxy.pac.orig || /usr/bin/install -m 644 -S $PROXY_PAC_DIRECTORY/proxy.pac $PROXY_PAC_DIRECTORY/proxy.pac.orig ) && /bin/cp $PROXY_PAC_DIRECTORY/proxy.pac.orig /tmp/proxy.pac.orig && /opt/local/bin/wget -N -P /usr/local/etc http://securemecca.com/Downloads/AutoPac_EN.unx.7z && /opt/local/bin/7za x -aoa -o/tmp /usr/local/etc/AutoPac_EN.unx.7z AutoPac_EN.unx && /opt/local/bin/gpg --verify /tmp/AutoPac_EN.unx/proxy_en.sig /tmp/AutoPac_EN.unx/proxy_en && /usr/bin/printf '// *Modified for mydomainname.com*\n// King of the PAC from http://securemecca.com/pac.html:\n' > /tmp/proxy.pac && /usr/bin/sed -E 's/return[ \t]+normal/return MyFindProxyForURL(url.toString(), host)/g' /tmp/AutoPac_EN.unx/proxy_en >> /tmp/proxy.pac && /usr/bin/sed -E 's/function[ \t]+FindProxyForURL/function MyFindProxyForURL/' /tmp/proxy.pac.orig >> /tmp/proxy.pac && /usr/bin/install -m 644 -g admin -S /tmp/proxy.pac $PROXY_PAC_DIRECTORY/proxy.pac ; /bin/rm -fr /tmp/proxy.pac /tmp/proxy.pac.orig /tmp/AutoPac_EN.unx</string>
</array>
<key>RunAtLoad</key>
<true/>
<key>StartInterval</key>
<integer>90450</integer>
<key>ServiceDescription</key>
<string>securemecca.com King of the PAC Modification</string>
<key>StandardErrorPath</key>
<string>/var/log/system.log</string>
<key>StandardOutPath</key>
<string>/var/log/system.log</string>
</dict>
</plist>
================================================
FILE: deprecated/org.adblockplus.privoxy-adblock.plist
================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>Label</key>
<string>org.adblockplus.privoxy-adblock.plist</string>
<key>Program</key>
<string>/bin/bash</string>
<key>ProgramArguments</key>
<array>
<string>/bin/bash</string>
<string>-c</string>
<string>/usr/local/bin/privoxy-adblock.sh && /bin/launchctl unload -w /Library/LaunchDaemons/org.macports.Privoxy.plist && /bin/launchctl load -w /Library/LaunchDaemons/org.macports.Privoxy.plist</string>
</array>
<key>RunAtLoad</key>
<true/>
<key>StartInterval</key>
<integer>90450</integer>
<key>ServiceDescription</key>
<string>GitHub skroll/privoxy-adblock fork</string>
<key>StandardErrorPath</key>
<string>/var/log/system.log</string>
<key>StandardOutPath</key>
<string>/var/log/system.log</string>
</dict>
</plist>
================================================
FILE: deprecated/squid-27.conf
================================================
# WELCOME TO SQUID 2.7.STABLE9
# ----------------------------
#
# This is the default Squid configuration file. You may wish
# to look at the Squid home page (http://www.squid-cache.org/)
# for the FAQ and other documentation.
#
# The default Squid config file shows what the defaults for
# various options happen to be. If you don't need to change the
# default, you shouldn't uncomment the line. Doing so may cause
# run-time problems. In some cases "none" refers to no default
# setting at all, while in other cases it refers to a valid
# option - the comments for that keyword indicate if this is the
# case.
#
# Configuration options can be included using the "include" directive.
# Include takes a list of files to include. Quoting and wildcards is
# supported.
#
# For example,
#
# include /path/to/included/file/squid.acl.config
#
# Includes can be nested up to a hard-coded depth of 16 levels.
# This arbitrary restriction is to prevent recursive include references
# from causing Squid entering an infinite loop whilst trying to load
# configuration files.
# OPTIONS FOR AUTHENTICATION
# -----------------------------------------------------------------------------
# TAG: auth_param
# This is used to define parameters for the various authentication
# schemes supported by Squid.
#
# format: auth_param scheme parameter [setting]
#
# The order in which authentication schemes are presented to the client is
# dependent on the order the scheme first appears in config file. IE
# has a bug (it's not RFC 2617 compliant) in that it will use the basic
# scheme if basic is the first entry presented, even if more secure
# schemes are presented. For now use the order in the recommended
# settings section below. If other browsers have difficulties (don't
# recognize the schemes offered even if you are using basic) either
# put basic first, or disable the other schemes (by commenting out their
# program entry).
#
# Once an authentication scheme is fully configured, it can only be
# shutdown by shutting squid down and restarting. Changes can be made on
# the fly and activated with a reconfigure. I.E. You can change to a
# different helper, but not unconfigure the helper completely.
#
# Please note that while this directive defines how Squid processes
# authentication it does not automatically activate authentication.
# To use authentication you must in addition make use of ACLs based
# on login name in http_access (proxy_auth, proxy_auth_regex or
# external with %LOGIN used in the format tag). The browser will be
# challenged for authentication on the first such acl encountered
# in http_access processing and will also be re-challenged for new
# login credentials if the request is being denied by a proxy_auth
# type acl.
#
# WARNING: authentication can't be used in a transparently intercepting
# proxy as the client then thinks it is talking to an origin server and
# not the proxy. This is a limitation of bending the TCP/IP protocol to
# transparently intercepting port 80, not a limitation in Squid.
#
# === Parameters for the basic scheme follow. ===
#
# "program" cmdline
# Specify the command for the external authenticator. Such a program
# reads a line containing "username password" and replies "OK" or
# "ERR" in an endless loop. "ERR" responses may optionally be followed
# by a error description available as %m in the returned error page.
#
# By default, the basic authentication scheme is not used unless a
# program is specified.
#
# If you want to use the traditional proxy authentication, jump over to
# the helpers/basic_auth/NCSA directory and type:
# % make
# % make install
#
# Then, set this line to something like
#
# auth_param basic program /opt/local/libexec/ncsa_auth /opt/local/etc/passwd
#
# "children" numberofchildren
# The number of authenticator processes to spawn. If you start too few
# squid will have to wait for them to process a backlog of credential
# verifications, slowing it down. When credential verifications are
# done via a (slow) network you are likely to need lots of
# authenticator processes.
# auth_param basic children 5
#
# "concurrency" numberofconcurrentrequests
# The number of concurrent requests/channels the helper supports.
# Changes the protocol used to include a channel number first on
# the request/response line, allowing multiple requests to be sent
# to the same helper in parallell without wating for the response.
# Must not be set unless it's known the helper supports this.
#
# "realm" realmstring
# Specifies the realm name which is to be reported to the client for
# the basic proxy authentication scheme (part of the text the user
# will see when prompted their username and password).
# auth_param basic realm Squid proxy-caching web server
#
# "credentialsttl" timetolive
# Specifies how long squid assumes an externally validated
# username:password pair is valid for - in other words how often the
# helper program is called for that user. Set this low to force
# revalidation with short lived passwords. Note that setting this high
# does not impact your susceptibility to replay attacks unless you are
# using an one-time password system (such as SecureID). If you are using
# such a system, you will be vulnerable to replay attacks unless you
# also use the max_user_ip ACL in an http_access rule.
# auth_param basic credentialsttl 2 hours
#
# "casesensitive" on|off
# Specifies if usernames are case sensitive. Most user databases are
# case insensitive allowing the same username to be spelled using both
# lower and upper case letters, but some are case sensitive. This
# makes a big difference for user_max_ip ACL processing and similar.
# auth_param basic casesensitive off
#
# "blankpassword" on|off
# Specifies if blank passwords should be supported. Defaults to off
# as there is multiple authentication backends which handles blank
# passwords as "guest" access.
#
# === Parameters for the digest scheme follow ===
#
# "program" cmdline
# Specify the command for the external authenticator. Such a program
# reads a line containing "username":"realm" and replies with the
# appropriate H(A1) value hex encoded or ERR if the user (or his H(A1)
# hash) does not exists. See RFC 2616 for the definition of H(A1).
# "ERR" responses may optionally be followed by a error description
# available as %m in the returned error page.
#
# By default, the digest authentication scheme is not used unless a
# program is specified.
#
# If you want to use a digest authenticator, jump over to the
# helpers/digest_auth/ directory and choose the authenticator to use.
# It it's directory type
# % make
# % make install
#
# Then, set this line to something like
#
# auth_param digest program /opt/local/libexec/digest_auth_pw /opt/local/etc/digpass
#
# "children" numberofchildren
# The number of authenticator processes to spawn. If you start too few
# squid will have to wait for them to process a backlog of credential
# verifications, slowing it down. When credential verifications are
# done via a (slow) network you are likely to need lots of
# authenticator processes.
# auth_param digest children 5
#
# "concurrency" numberofconcurrentrequests
# The number of concurrent requests/channels the helper supports.
# Changes the protocol used to include a channel number first on
# the request/response line, allowing multiple requests to be sent
# to the same helper in parallell without wating for the response.
# Must not be set unless it's known the helper supports this.
#
# "realm" realmstring
# Specifies the realm name which is to be reported to the client for the
# digest proxy authentication scheme (part of the text the user will see
# when prompted their username and password).
# auth_param digest realm Squid proxy-caching web server
#
# "nonce_garbage_interval" timeinterval
# Specifies the interval that nonces that have been issued to clients are
# checked for validity.
# auth_param digest nonce_garbage_interval 5 minutes
#
# "nonce_max_duration" timeinterval
# Specifies the maximum length of time a given nonce will be valid for.
# auth_param digest nonce_max_duration 30 minutes
#
# "nonce_max_count" number
# Specifies the maximum number of times a given nonce can be used.
# auth_param digest nonce_max_count 50
#
# "nonce_strictness" on|off
# Determines if squid requires strict increment-by-1 behavior for nonce
# counts, or just incrementing (off - for use when useragents generate
# nonce counts that occasionally miss 1 (ie, 1,2,4,6)).
# auth_param digest nonce_strictness off
#
# "check_nonce_count" on|off
# This directive if set to off can disable the nonce count check
# completely to work around buggy digest qop implementations in certain
# mainstream browser versions. Default on to check the nonce count to
# protect from authentication replay attacks.
# auth_param digest check_nonce_count on
#
# "post_workaround" on|off
# This is a workaround to certain buggy browsers who sends an incorrect
# request digest in POST requests when reusing the same nonce as acquired
# earlier in response to a GET request.
# auth_param digest post_workaround off
#
# === NTLM scheme options follow ===
#
# "program" cmdline
# Specify the command for the external NTLM authenticator. Such a
# program participates in the NTLMSSP exchanges between Squid and the
# client and reads commands according to the Squid NTLMSSP helper
# protocol. See helpers/ntlm_auth/ for details. Recommended ntlm
# authenticator is ntlm_auth from Samba-3.X, but a number of other
# ntlm authenticators is available.
#
# By default, the ntlm authentication scheme is not used unless a
# program is specified.
#
# auth_param ntlm program /path/to/samba/bin/ntlm_auth --helper-protocol=squid-2.5-ntlmssp
#
# "children" numberofchildren
# The number of authenticator processes to spawn. If you start too few
# squid will have to wait for them to process a backlog of credential
# verifications, slowing it down. When credential verifications are
# done via a (slow) network you are likely to need lots of
# authenticator processes.
# auth_param ntlm children 5
#
# "keep_alive" on|off
# This option enables the use of keep-alive on the initial
# authentication request. It has been reported some versions of MSIE
# have problems if this is enabled, but performance will be increased
# if enabled.
#
# auth_param ntlm keep_alive on
#
# === Negotiate scheme options follow ===
#
# "program" cmdline
# Specify the command for the external Negotiate authenticator. Such a
# program participates in the SPNEGO exchanges between Squid and the
# client and reads commands according to the Squid ntlmssp helper
# protocol. See helpers/ntlm_auth/ for details. Recommended SPNEGO
# authenticator is ntlm_auth from Samba-4.X.
#
# By default, the Negotiate authentication scheme is not used unless a
# program is specified.
#
# auth_param negotiate program /path/to/samba/bin/ntlm_auth --helper-protocol=gss-spnego
#
# "children" numberofchildren
# The number of authenticator processes to spawn. If you start too few
# squid will have to wait for them to process a backlog of credential
# verifications, slowing it down. When credential verifications are
# done via a (slow) network you are likely to need lots of
# authenticator processes.
# auth_param negotiate children 5
#
# "keep_alive" on|off
# If you experience problems with PUT/POST requests when using the
# Negotiate authentication scheme then you can try setting this to
# off. This will cause Squid to forcibly close the connection on
# the initial requests where the browser asks which schemes are
# supported by the proxy.
#
# auth_param negotiate keep_alive on
#
#Recommended minimum configuration per scheme:
#auth_param negotiate program <uncomment and complete this line to activate>
#auth_param negotiate children 5
#auth_param negotiate keep_alive on
#auth_param ntlm program <uncomment and complete this line to activate>
#auth_param ntlm children 5
#auth_param ntlm keep_alive on
#auth_param digest program <uncomment and complete this line>
#auth_param digest children 5
#auth_param digest realm Squid proxy-caching web server
#auth_param digest nonce_garbage_interval 5 minutes
#auth_param digest nonce_max_duration 30 minutes
#auth_param digest nonce_max_count 50
#auth_param basic program <uncomment and complete this line>
#auth_param basic children 5
#auth_param basic realm Squid proxy-caching web server
#auth_param basic credentialsttl 2 hours
#auth_param basic casesensitive off
# TAG: authenticate_cache_garbage_interval
# The time period between garbage collection across the username cache.
# This is a tradeoff between memory utilization (long intervals - say
# 2 days) and CPU (short intervals - say 1 minute). Only change if you
# have good reason to.
#
#Default:
# authenticate_cache_garbage_interval 1 hour
# TAG: authenticate_ttl
# The time a user & their credentials stay in the logged in user cache
# since their last request. When the garbage interval passes, all user
# credentials that have passed their TTL are removed from memory.
#
#Default:
# authenticate_ttl 1 hour
# TAG: authenticate_ip_ttl
# If you use proxy authentication and the 'max_user_ip' ACL, this
# directive controls how long Squid remembers the IP addresses
# associated with each user. Use a small value (e.g., 60 seconds) if
# your users might change addresses quickly, as is the case with
# dialups. You might be safe using a larger value (e.g., 2 hours) in a
# corporate LAN environment with relatively static address assignments.
#
#Default:
# authenticate_ip_ttl 0 seconds
# TAG: authenticate_ip_shortcircuit_ttl
# Cache authentication credentials per client IP address for this
# long. Default is 0 seconds (disabled).
#
# See also authenticate_ip_shortcircuit_access directive.
#
#Default:
# authenticate_ip_shortcircuit_ttl 0 seconds
# ACCESS CONTROLS
# -----------------------------------------------------------------------------
# TAG: external_acl_type
# This option defines external acl classes using a helper program to
# look up the status
#
# external_acl_type name [options] FORMAT.. /path/to/helper [helper arguments..]
#
# Options:
#
# ttl=n TTL in seconds for cached results (defaults to 3600
# for 1 hour)
# negative_ttl=n
# TTL for cached negative lookups (default same
# as ttl)
# children=n number of processes spawn to service external acl
# lookups of this type. (default 5).
# concurrency=n concurrency level per process. Only used with helpers
# capable of processing more than one query at a time.
# Note: see compatibility note below
# cache=n result cache size, 0 is unbounded (default)
# grace= Percentage remaining of TTL where a refresh of a
# cached entry should be initiated without needing to
# wait for a new reply. (default 0 for no grace period)
# protocol=2.5 Compatibility mode for Squid-2.5 external acl helpers
#
# FORMAT specifications
#
# %LOGIN Authenticated user login name
# %EXT_USER Username from external acl
# %IDENT Ident user name
# %SRC Client IP
# %SRCPORT Client source port
# %URI Requested URI
# %DST Requested host
# %PROTO Requested protocol
# %PORT Requested port
# %METHOD Request method
# %MYADDR Squid interface address
# %MYPORT Squid http_port number
# %PATH Requested URL-path (including query-string if any)
# %USER_CERT SSL User certificate in PEM format
# %USER_CERTCHAIN SSL User certificate chain in PEM format
# %USER_CERT_xx SSL User certificate subject attribute xx
# %USER_CA_xx SSL User certificate issuer attribute xx
# %{Header} HTTP request header "Header"
# %{Hdr:member} HTTP request header "Hdr" list member "member"
# %{Hdr:;member}
# HTTP request header list member using ; as
# list separator. ; can be any non-alphanumeric
# character.
# %ACL The ACL name
# %DATA The ACL arguments. If not used then any arguments
# is automatically added at the end
#
# In addition to the above, any string specified in the referencing
# acl will also be included in the helper request line, after the
# specified formats (see the "acl external" directive)
#
# The helper receives lines per the above format specification,
# and returns lines starting with OK or ERR indicating the validity
# of the request and optionally followed by additional keywords with
# more details.
#
# General result syntax:
#
# OK/ERR keyword=value ...
#
# Defined keywords:
#
# user= The users name (login also understood)
# password= The users password (for PROXYPASS login= cache_peer)
# message= Error message or similar used as %o in error messages
# (error also understood)
# log= String to be logged in access.log. Available as
# %ea in logformat specifications
#
# If protocol=3.0 (the default) then URL escaping is used to protect
# each value in both requests and responses.
#
# If using protocol=2.5 then all values need to be enclosed in quotes
# if they may contain whitespace, or the whitespace escaped using \.
# And quotes or \ characters within the keyword value must be \ escaped.
#
# When using the concurrency= option the protocol is changed by
# introducing a query channel tag infront of the request/response.
# The query channel tag is a number between 0 and concurrency-1.
#
# Compatibility Note: The children= option was named concurrency= in
# Squid-2.5.STABLE3 and earlier, and was accepted as an alias for the
# duration of the Squid-2.5 releases to keep compatibility. However,
# the meaning of concurrency= option has changed in Squid-2.6 to match
# that of Squid-3 and the old syntax no longer works.
#
#Default:
# none
# TAG: acl
# Defining an Access List
#
# Every access list definition must begin with an aclname and acltype,
# followed by either type-specific arguments or a quoted filename that
# they are read from.
#
# acl aclname acltype argument ...
# acl aclname acltype "file" ...
#
# when using "file", the file should contain one item per line.
#
# By default, regular expressions are CASE-SENSITIVE. To make
# them case-insensitive, use the -i option.
#
# acl aclname src ip-address/netmask ... (clients IP address)
# acl aclname src addr1-addr2/netmask ... (range of addresses)
# acl aclname dst ip-address/netmask ... (URL host's IP address)
# acl aclname myip ip-address/netmask ... (local socket IP address)
#
# acl aclname arp mac-address ... (xx:xx:xx:xx:xx:xx notation)
# # The arp ACL requires the special configure option --enable-arp-acl.
# # Furthermore, the arp ACL code is not portable to all operating systems.
# # It works on Linux, Solaris, FreeBSD and some other *BSD variants.
# #
# # NOTE: Squid can only determine the MAC address for clients that are on
# # the same subnet. If the client is on a different subnet, then Squid cannot
# # find out its MAC address.
#
# acl aclname srcdomain .foo.com ... # reverse lookup, client IP
# acl aclname dstdomain .foo.com ... # Destination server from URL
# acl aclname srcdom_regex [-i] xxx ... # regex matching client name
# acl aclname dstdom_regex [-i] xxx ... # regex matching server
# # For dstdomain and dstdom_regex a reverse lookup is tried if a IP
# # based URL is used and no match is found. The name "none" is used
# # if the reverse lookup fails.
#
# acl aclname time [day-abbrevs] [h1:m1-h2:m2]
# # day-abbrevs:
# # S - Sunday
# # M - Monday
# # T - Tuesday
# # W - Wednesday
# # H - Thursday
# # F - Friday
# # A - Saturday
# # h1:m1 must be less than h2:m2
# acl aclname url_regex [-i] ^http:// ... # regex matching on whole URL
# acl aclname urlpath_regex [-i] \.gif$ ... # regex matching on URL path
# acl aclname urllogin [-i] [^a-zA-Z0-9] ... # regex matching on URL login field
# acl aclname port 80 70 21 ...
# acl aclname port 0-1024 ... # ranges allowed
# acl aclname myport 3128 ... # (local socket TCP port)
# acl aclname myportname 3128 ... # http(s)_port name
# acl aclname proto HTTP FTP ...
# acl aclname method GET POST ...
# acl aclname browser [-i] regexp ...
# # pattern match on User-Agent header (see also req_header below)
# acl aclname referer_regex [-i] regexp ...
# # pattern match on Referer header
# # Referer is highly unreliable, so use with care
# acl aclname ident username ...
# acl aclname ident_regex [-i] pattern ...
# # string match on ident output.
# # use REQUIRED to accept any non-null ident.
# acl aclname src_as number ...
# acl aclname dst_as number ...
# # Except for access control, AS numbers can be used for
# # routing of requests to specific caches. Here's an
# # example for routing all requests for AS#1241 and only
# # those to mycache.mydomain.net:
# # acl asexample dst_as 1241
# # cache_peer_access mycache.mydomain.net allow asexample
# # cache_peer_access mycache_mydomain.net deny all
#
# acl aclname proxy_auth [-i] username ...
# acl aclname proxy_auth_regex [-i] pattern ...
# # list of valid usernames
# # use REQUIRED to accept any valid username.
# #
# # NOTE: when a Proxy-Authentication header is sent but it is not
# # needed during ACL checking the username is NOT logged
# # in access.log.
# #
# # NOTE: proxy_auth requires a EXTERNAL authentication program
# # to check username/password combinations (see
# # auth_param directive).
# #
# # NOTE: proxy_auth can't be used in a transparent proxy as
# # the browser needs to be configured for using a proxy in order
# # to respond to proxy authentication.
#
# acl aclname snmp_community string ...
# # A community string to limit access to your SNMP Agent
# # Example:
# #
# # acl snmppublic snmp_community public
#
# acl aclname maxconn number
# # This will be matched when the client's IP address has
# # more than <number> HTTP connections established.
#
# acl aclname max_user_ip [-s] number
# # This will be matched when the user attempts to log in from more
# # than <number> different ip addresses. The authenticate_ip_ttl
# # parameter controls the timeout on the ip entries.
# # If -s is specified the limit is strict, denying browsing
# # from any further IP addresses until the ttl has expired. Without
# # -s Squid will just annoy the user by "randomly" denying requests.
# # (the counter is reset each time the limit is reached and a
# # request is denied)
# # NOTE: in acceleration mode or where there is mesh of child proxies,
# # clients may appear to come from multiple addresses if they are
# # going through proxy farms, so a limit of 1 may cause user problems.
#
# acl aclname req_mime_type mime-type ...
# # regex match against the mime type of the request generated
# # by the client. Can be used to detect file upload or some
# # types HTTP tunneling requests.
# # NOTE: This does NOT match the reply. You cannot use this
# # to match the returned file type.
#
# acl aclname req_header header-name [-i] any\.regex\.here
# # regex match against any of the known request headers. May be
# # thought of as a superset of "browser", "referer" and "mime-type"
# # ACLs.
#
# acl aclname rep_mime_type mime-type ...
# # regex match against the mime type of the reply received by
# # squid. Can be used to detect file download or some
# # types HTTP tunneling requests.
# # NOTE: This has no effect in http_access rules. It only has
# # effect in rules that affect the reply data stream such as
# # http_reply_access.
#
# acl aclname rep_header header-name [-i] any\.regex\.here
# # regex match against any of the known reply headers. May be
# # thought of as a superset of "browser", "referer" and "mime-type"
# # ACLs.
# #
# # Example:
# #
# # acl many_spaces rep_header Content-Disposition -i [[:space:]]{3,}
#
# acl aclname external class_name [arguments...]
# # external ACL lookup via a helper class defined by the
# # external_acl_type directive.
#
# acl aclname urlgroup group1 ...
# # match against the urlgroup as indicated by redirectors
#
# acl aclname user_cert attribute values...
# # match against attributes in a user SSL certificate
# # attribute is one of DN/C/O/CN/L/ST
#
# acl aclname ca_cert attribute values...
# # match against attributes a users issuing CA SSL certificate
# # attribute is one of DN/C/O/CN/L/ST
#
# acl aclname ext_user username ...
# acl aclname ext_user_regex [-i] pattern ...
# # string match on username returned by external acl helper
# # use REQUIRED to accept any non-null user name.
#
#Examples:
#acl macaddress arp 09:00:2b:23:45:67
#acl myexample dst_as 1241
#acl password proxy_auth REQUIRED
#acl fileupload req_mime_type -i ^multipart/form-data$
#acl javascript rep_mime_type -i ^application/x-javascript$
#
#Recommended minimum configuration:
acl all src all
acl manager proto cache_object
acl localhost src 127.0.0.1
acl to_localhost dst 127.0.0.0/8 0.0.0.0/32
#
# Example rule allowing access from your local networks.
# Adapt to list your (internal) IP networks from where browsing
# should be allowed
acl localnet src 10.0.0.0/8 # RFC1918 possible internal network
#acl localnet src 172.16.0.0/12 # RFC1918 possible internal network
#acl localnet src 192.168.0.0/16 # RFC1918 possible internal network
#
acl SSL_ports port 443
acl Safe_ports port 80 # http
acl Safe_ports port 21 # ftp
acl Safe_ports port 443 # https
acl Safe_ports port 70 # gopher
acl Safe_ports port 210 # wais
acl Safe_ports port 1025-65535 # unregistered ports
acl Safe_ports port 280 # http-mgmt
acl Safe_ports port 488 # gss-http
acl Safe_ports port 591 # filemaker
acl Safe_ports port 777 # multiling http
acl CONNECT method CONNECT
# TAG: http_access
# Allowing or Denying access based on defined access lists
#
# Access to the HTTP port:
# http_access allow|deny [!]aclname ...
#
# NOTE on default values:
#
# If there are no "access" lines present, the default is to deny
# the request.
#
# If none of the "access" lines cause a match, the default is the
# opposite of the last line in the list. If the last line was
# deny, the default is allow. Conversely, if the last line
# is allow, the default will be deny. For these reasons, it is a
# good idea to have an "deny all" or "allow all" entry at the end
# of your access lists to avoid potential confusion.
#
#Default:
# http_access deny all
#
#Recommended minimum configuration:
#
# Only allow cachemgr access from localhost
http_access allow manager localhost
http_access deny manager
# Deny requests to unknown ports
http_access deny !Safe_ports
# Deny CONNECT to other than SSL ports
http_access deny CONNECT !SSL_ports
#
# We strongly recommend the following be uncommented to protect innocent
# web applications running on the proxy server who think the only
# one who can access services on "localhost" is a local user
http_access deny to_localhost
#
# INSERT YOUR OWN RULE(S) HERE TO ALLOW ACCESS FROM YOUR CLIENTS
http_access allow localhost
# Example rule allowing access from your local networks.
# Adapt localnet in the ACL section to list your (internal) IP networks
# from where browsing should be allowed
http_access allow localnet
# And finally deny all other access to this proxy
http_access deny all
# TAG: http_access2
# Allowing or Denying access based on defined access lists
#
# Identical to http_access, but runs after redirectors. If not set
# then only http_access is used.
#
#Default:
# none
# TAG: http_reply_access
# Allow replies to client requests. This is complementary to http_access.
#
# http_reply_access allow|deny [!] aclname ...
#
# NOTE: if there are no access lines present, the default is to allow
# all replies
#
# If none of the access lines cause a match the opposite of the
# last line will apply. Thus it is good practice to end the rules
# with an "allow all" or "deny all" entry.
#
#Default:
# http_reply_access allow all
# TAG: icp_access
# Allowing or Denying access to the ICP port based on defined
# access lists
#
# icp_access allow|deny [!]aclname ...
#
# See http_access for details
#
#Default:
# icp_access deny all
#
#Allow ICP queries from local networks only
icp_access allow localnet
icp_access deny all
# TAG: htcp_access
# Note: This option is only available if Squid is rebuilt with the
# --enable-htcp option
#
# Allowing or Denying access to the HTCP port based on defined
# access lists
#
# htcp_access allow|deny [!]aclname ...
#
# See http_access for details
#
# NOTE: The default if no htcp_access lines are present is to
# deny all traffic. This default may cause problems with peers
# using the htcp or htcp-oldsquid options.
#
#Default:
# htcp_access deny all
#
#Allow HTCP queries from local networks only
# htcp_access allow localnet
# htcp_access deny all
# TAG: htcp_clr_access
# Note: This option is only available if Squid is rebuilt with the
# --enable-htcp option
#
# Allowing or Denying access to purge content using HTCP based
# on defined access lists
#
# htcp_clr_access allow|deny [!]aclname ...
#
# See http_access for details
#
##Allow HTCP CLR requests from trusted peers
#acl htcp_clr_peer src 172.16.1.2
#htcp_clr_access allow htcp_clr_peer
#
#Default:
# htcp_clr_access deny all
# TAG: miss_access
# Use to force your neighbors to use you as a sibling instead of
# a parent. For example:
#
# acl localclients src 172.16.0.0/16
# miss_access allow localclients
# miss_access deny !localclients
#
# This means only your local clients are allowed to fetch
# MISSES and all other clients can only fetch HITS.
#
# By default, allow all clients who passed the http_access rules
# to fetch MISSES from us.
#
#Default setting:
# miss_access allow all
# TAG: ident_lookup_access
# A list of ACL elements which, if matched, cause an ident
# (RFC931) lookup to be performed for this request. For
# example, you might choose to always perform ident lookups
# for your main multi-user Unix boxes, but not for your Macs
# and PCs. By default, ident lookups are not performed for
# any requests.
#
# To enable ident lookups for specific client addresses, you
# can follow this example:
#
# acl ident_aware_hosts src 198.168.1.0/255.255.255.0
# ident_lookup_access allow ident_aware_hosts
# ident_lookup_access deny all
#
# Only src type ACL checks are fully supported. A src_domain
# ACL might work at times, but it will not always provide
# the correct result.
#
#Default:
# ident_lookup_access deny all
# TAG: reply_body_max_size bytes deny acl acl...
# This option specifies the maximum size of a reply body in bytes.
# It can be used to prevent users from downloading very large files,
# such as MP3's and movies. When the reply headers are received,
# the reply_body_max_size lines are processed, and the first line with
# a result of "deny" is used as the maximum body size for this reply.
# This size is checked twice. First when we get the reply headers,
# we check the content-length value. If the content length value exists
# and is larger than the allowed size, the request is denied and the
# user receives an error message that says "the request or reply
# is too large." If there is no content-length, and the reply
# size exceeds this limit, the client's connection is just closed
# and they will receive a partial reply.
#
# WARNING: downstream caches probably can not detect a partial reply
# if there is no content-length header, so they will cache
# partial responses and give them out as hits. You should NOT
# use this option if you have downstream caches.
#
# If you set this parameter to zero (the default), there will be
# no limit imposed.
#
#Default:
# reply_body_max_size 0 allow all
# TAG: authenticate_ip_shortcircuit_access
# Access list determining when shortcicuiting the authentication process
# based on source IP cached credentials is acceptable. Use this to deny
# using the ip auth cache on requests from child proxies or other source
# ip's having multiple users.
#
# See also authenticate_ip_shortcircuit_ttl directive
#
#Default:
# none
# OPTIONS FOR X-Forwarded-For
# -----------------------------------------------------------------------------
# TAG: follow_x_forwarded_for
# Note: This option is only available if Squid is rebuilt with the
# -DFOLLOW_X_FORWARDED_FOR option
#
# Allowing or Denying the X-Forwarded-For header to be followed to
# find the original source of a request.
#
# Requests may pass through a chain of several other proxies
# before reaching us. The X-Forwarded-For header will contain a
# comma-separated list of the IP addresses in the chain, with the
# rightmost address being the most recent.
#
# If a request reaches us from a source that is allowed by this
# configuration item, then we consult the X-Forwarded-For header
# to see where that host received the request from. If the
# X-Forwarded-For header contains multiple addresses, and if
# acl_uses_indirect_client is on, then we continue backtracking
# until we reach an address for which we are not allowed to
# follow the X-Forwarded-For header, or until we reach the first
# address in the list. (If acl_uses_indirect_client is off, then
# it's impossible to backtrack through more than one level of
# X-Forwarded-For addresses.)
#
# The end result of this process is an IP address that we will
# refer to as the indirect client address. This address may
# be treated as the client address for access control, delay
# pools and logging, depending on the acl_uses_indirect_client,
# delay_pool_uses_indirect_client and log_uses_indirect_client
# options.
#
# SECURITY CONSIDERATIONS:
#
# Any host for which we follow the X-Forwarded-For header
# can place incorrect information in the header, and Squid
# will use the incorrect information as if it were the
# source address of the request. This may enable remote
# hosts to bypass any access control restrictions that are
# based on the client's source addresses.
#
# For example:
#
# acl localhost src 127.0.0.1
# acl my_other_proxy srcdomain .proxy.example.com
# follow_x_forwarded_for allow localhost
# follow_x_forwarded_for allow my_other_proxy
#
#Default:
# follow_x_forwarded_for deny all
# TAG: acl_uses_indirect_client on|off
# Note: This option is only available if Squid is rebuilt with the
# -DFOLLOW_X_FORWARDED_FOR option
#
# Controls whether the indirect client address
# (see follow_x_forwarded_for) is used instead of the
# direct client address in acl matching.
#
#Default:
# acl_uses_indirect_client on
# TAG: delay_pool_uses_indirect_client on|off
# Note: This option is only available if Squid is rebuilt with the
# -DFOLLOW_X_FORWARDED_FOR option
#
# Controls whether the indirect client address
# (see follow_x_forwarded_for) is used instead of the
# direct client address in delay pools.
#
#Default:
# delay_pool_uses_indirect_client on
# TAG: log_uses_indirect_client on|off
# Note: This option is only available if Squid is rebuilt with the
# -DFOLLOW_X_FORWARDED_FOR option
#
# Controls whether the indirect client address
# (see follow_x_forwarded_for) is used instead of the
# direct client address in the access log.
#
#Default:
# log_uses_indirect_client on
# SSL OPTIONS
# -----------------------------------------------------------------------------
# TAG: ssl_unclean_shutdown
# Some browsers (especially MSIE) bugs out on SSL shutdown
# messages.
#
#Default:
# ssl_unclean_shutdown off
# TAG: ssl_engine
# The OpenSSL engine to use. You will need to set this if you
# would like to use hardware SSL acceleration for example.
#
#Default:
# none
# TAG: sslproxy_client_certificate
# Client SSL Certificate to use when proxying https:// URLs
#
#Default:
# none
# TAG: sslproxy_client_key
# Client SSL Key to use when proxying https:// URLs
#
#Default:
# none
# TAG: sslproxy_version
# SSL version level to use when proxying https:// URLs
#
#Default:
# sslproxy_version 1
# TAG: sslproxy_options
# SSL engine options to use when proxying https:// URLs
#
#Default:
# none
# TAG: sslproxy_cipher
# SSL cipher list to use when proxying https:// URLs
#
#Default:
# none
# TAG: sslproxy_cafile
# file containing CA certificates to use when verifying server
# certificates while proxying https:// URLs
#
#Default:
# none
# TAG: sslproxy_capath
# directory containing CA certificates to use when verifying
# server certificates while proxying https:// URLs
#
#Default:
# none
# TAG: sslproxy_flags
# Various flags modifying the use of SSL while proxying https:// URLs:
# DONT_VERIFY_PEER Accept certificates even if they fail to
# verify.
# NO_DEFAULT_CA Don't use the default CA list built in
# to OpenSSL.
#
#Default:
# none
# TAG: sslpassword_program
# Specify a program used for entering SSL key passphrases
# when using encrypted SSL certificate keys. If not specified
# keys must either be unencrypted, or Squid started with the -N
# option to allow it to query interactively for the passphrase.
#
#Default:
# none
# NETWORK OPTIONS
# -----------------------------------------------------------------------------
# TAG: http_port
# Usage: port [options]
# hostname:port [options]
# 1.2.3.4:port [options]
#
# The socket addresses where Squid will listen for HTTP client
# requests. You may specify multiple socket addresses.
# There are three forms: port alone, hostname with port, and
# IP address with port. If you specify a hostname or IP
# address, Squid binds the socket to that specific
# address. This replaces the old 'tcp_incoming_address'
# option. Most likely, you do not need to bind to a specific
# address, so you can use the port number alone.
#
# If you are running Squid in accelerator mode, you
# probably want to listen on port 80 also, or instead.
#
# The -I command line option will override the *first* port
# specified here.
#
# You may specify multiple socket addresses on multiple lines.
#
# Options:
#
# transparent Support for transparent interception of
# outgoing requests without browser settings.
#
# tproxy Support Linux TPROXY for spoofing outgoing
# connections using the client IP address.
#
# accel Accelerator mode. See also the related vhost,
# vport and defaultsite directives.
#
# defaultsite=domainname
# What to use for the Host: header if it is not present
# in a request. Determines what site (not origin server)
# accelerators should consider the default.
# Defaults to visible_hostname:port if not set
# May be combined with vport=NN to override the port number.
# Implies accel.
#
# vhost Accelerator mode using Host header for virtual
# domain support. Implies accel.
#
# vport Accelerator with IP based virtual host support.
# Implies accel.
#
# vport=NN As above, but uses specified port number rather
# than the http_port number. Implies accel.
#
# allow-direct Allow direct forwarding in accelerator mode. Normally
# accelerated requests is denied direct forwarding as it
# never_direct was used.
#
# urlgroup= Default urlgroup to mark requests with (see
# also acl urlgroup and url_rewrite_program)
#
# protocol= Protocol to reconstruct accelerated requests with.
# Defaults to http.
#
# no-connection-auth
# Prevent forwarding of Microsoft connection oriented
# authentication (NTLM, Negotiate and Kerberos)
#
# act-as-origin
# Act is if this Squid is the origin server.
# This currently means generate own Date: and
# Expires: headers. Implies accel.
#
# http11 Enables HTTP/1.1 support to clients. The HTTP/1.1
# support is still incomplete with an internal HTTP/1.0
# hop, but should work with most clients. The main
# HTTP/1.1 features missing due to this is forwarding
# of requests using chunked transfer encoding (results
# in 411) and forwarding of 1xx responses (silently
# dropped)
#
# name= Specifies a internal name for the port. Defaults to
# the port specification (port or addr:port)
#
# tcpkeepalive[=idle,interval,timeout]
# Enable TCP keepalive probes of idle connections
# idle is the initial time before TCP starts probing
# the connection, interval how often to probe, and
# timeout the time before giving up.
#
# If you run Squid on a dual-homed machine with an internal
# and an external interface we recommend you to specify the
# internal address:port in http_port. This way Squid will only be
# visible on the internal address.
#
# Squid normally listens to port 3128
http_port 127.0.0.1:3128 name=localhost
# Uncomment and change to your server IP for LAN or OpenVPN access
#http_port 10.0.1.3:3128 name=LAN
#http_port 10.8.0.1:3128 name=OpenVPN
# TAG: https_port
# Usage: [ip:]port cert=certificate.pem [key=key.pem] [options...]
#
# The socket address where Squid will listen for HTTPS client
# requests.
#
# This is really only useful for situations where you are running
# squid in accelerator mode and you want to do the SSL work at the
# accelerator level.
#
# You may specify multiple socket addresses on multiple lines,
# each with their own SSL certificate and/or options.
#
# Options:
#
# In addition to the options specified for http_port the folling
# SSL related options is supported:
#
# cert= Path to SSL certificate (PEM format).
#
# key= Path to SSL private key file (PEM format)
# if not specified, the certificate file is
# assumed to be a combined certificate and
# key file.
#
# version= The version of SSL/TLS supported
# 1 automatic (default)
# 2 SSLv2 only
# 3 SSLv3 only
# 4 TLSv1 only
#
# cipher= Colon separated list of supported ciphers.
#
# options= Various SSL engine options. The most important
# being:
# NO_SSLv2 Disallow the use of SSLv2
# NO_SSLv3 Disallow the use of SSLv3
# NO_TLSv1 Disallow the use of TLSv1
# SINGLE_DH_USE Always create a new key when using
# temporary/ephemeral DH key exchanges
# See src/ssl_support.c or OpenSSL SSL_CTX_set_options
# documentation for a complete list of options.
#
# clientca= File containing the list of CAs to use when
# requesting a client certificate.
#
# cafile= File containing additional CA certificates to
# use when verifying client certificates. If unset
# clientca will be used.
#
# capath= Directory containing additional CA certificates
# and CRL lists to use when verifying client certificates.
#
# crlfile= File of additional CRL lists to use when verifying
# the client certificate, in addition to CRLs stored in
# the capath. Implies VERIFY_CRL flag below.
#
# dhparams= File containing DH parameters for temporary/ephemeral
# DH key exchanges.
#
# sslflags= Various flags modifying the use of SSL:
# DELAYED_AUTH
# Don't request client certificates
# immediately, but wait until acl processing
# requires a certificate (not yet implemented).
# NO_DEFAULT_CA
# Don't use the default CA lists built in
# to OpenSSL.
# NO_SESSION_REUSE
# Don't allow for session reuse. Each connection
# will result in a new SSL session.
# VERIFY_CRL
# Verify CRL lists when accepting client
# certificates.
# VERIFY_CRL_ALL
# Verify CRL lists for all certificates in the
# client certificate chain.
#
# sslcontext= SSL session ID context identifier.
#
#
#Default:
# none
# TAG: tcp_outgoing_tos
# Allows you to select a TOS/Diffserv value to mark outgoing
# connections with, based on the username or source address
# making the request.
#
# tcp_outgoing_tos ds-field [!]aclname ...
#
# Example where normal_service_net uses the TOS value 0x00
# and good_service_net uses 0x20
#
# acl normal_service_net src 10.0.0.0/255.255.255.0
# acl good_service_net src 10.0.1.0/255.255.255.0
# tcp_outgoing_tos 0x00 normal_service_net
# tcp_outgoing_tos 0x20 good_service_net
#
# TOS/DSCP values really only have local significance - so you should
# know what you're specifying. For more information, see RFC2474 and
# RFC3260.
#
# The TOS/DSCP byte must be exactly that - a octet value 0 - 255, or
# "default" to use whatever default your host has. Note that in
# practice often only values 0 - 63 is usable as the two highest bits
# have been redefined for use by ECN (RFC3168).
#
# Processing proceeds in the order specified, and stops at first fully
# matching line.
#
# Note: The use of this directive using client dependent ACLs is
# incompatible with the use of server side persistent connections. To
# ensure correct results it is best to set server_persisten_connections
# to off when using this directive in such configurations.
#
#Default:
# none
# TAG: tcp_outgoing_address
# Allows you to map requests to different outgoing IP addresses
# based on the username or source address of the user making
# the request.
#
# tcp_outgoing_address ipaddr [[!]aclname] ...
#
# Example where requests from 10.0.0.0/24 will be forwarded
# with source address 10.1.0.1, 10.0.2.0/24 forwarded with
# source address 10.1.0.2 and the rest will be forwarded with
# source address 10.1.0.3.
#
# acl normal_service_net src 10.0.0.0/24
# acl good_service_net src 10.0.1.0/24 10.0.2.0/24
# tcp_outgoing_address 10.1.0.1 normal_service_net
# tcp_outgoing_address 10.1.0.2 good_service_net
# tcp_outgoing_address 10.1.0.3
#
# Processing proceeds in the order specified, and stops at first fully
# matching line.
#
# Note: The use of this directive using client dependent ACLs is
# incompatible with the use of server side persistent connections. To
# ensure correct results it is best to set server_persistent_connections
# to off when using this directive in such configurations.
#
#Default:
# none
# TAG: zph_mode
# This option enables packet level marking of HIT/MISS responses,
# either using IP TOS or socket priority.
# off Feature disabled
# tos Set the IP TOS/Diffserv field
# priority Set the socket priority (may get mapped to TOS by OS,
# otherwise only usable in local rulesets)
# option Embed the mark in an IP option field. See also
# zph_option.
#
# See also tcp_outgoing_tos for details/requirements about TOS usage.
#
#Default:
# zph_mode off
# TAG: zph_local
# Allows you to select a TOS/Diffserv/Priority value to mark local hits.
# Default: 0 (disabled).
#
#Default:
# zph_local 0
# TAG: zph_sibling
# Allows you to select a TOS/Diffserv/Priority value to mark sibling hits.
# Default: 0 (disabled).
#
#Default:
# zph_sibling 0
# TAG: zph_parent
# Allows you to select a TOS/Diffserv/Priority value to mark parent hits.
# Default: 0 (disabled).
#
#Default:
# zph_parent 0
# TAG: zph_option
# The IP option to use when zph_mode is set to "option". Defaults to
# 136 which is officially registered as "SATNET Stream ID".
#
#Default:
# zph_option 136
# OPTIONS WHICH AFFECT THE NEIGHBOR SELECTION ALGORITHM
# -----------------------------------------------------------------------------
# TAG: cache_peer
# To specify other caches in a hierarchy, use the format:
#
# cache_peer hostname type http-port icp-port [options]
#
# For example,
#
# # proxy icp
# # hostname type port port options
# # -------------------- -------- ----- ----- -----------
# cache_peer parent.foo.net parent 3128 3130 proxy-only default
# cache_peer sib1.foo.net sibling 3128 3130 proxy-only
# cache_peer sib2.foo.net sibling 3128 3130 proxy-only
#
# type: either 'parent', 'sibling', or 'multicast'.
#
# proxy-port: The port number where the cache listens for proxy
# requests.
#
# icp-port: Used for querying neighbor caches about
# objects. To have a non-ICP neighbor
# specify '7' for the ICP port and make sure the
# neighbor machine has the UDP echo port
# enabled in its /etc/inetd.conf file.
# NOTE: Also requires icp_port option enabled to send/receive
# requests via this method.
#
# options: proxy-only
# weight=n
# ttl=n
# no-query
# default
# round-robin
# carp
# multicast-responder
# multicast-siblings
# closest-only
# no-digest
# no-netdb-exchange
# no-delay
# login=user:password | PASS | *:password
# connect-timeout=nn
# digest-url=url
# allow-miss
# max-conn=n
# htcp
# htcp-oldsquid
# originserver
# userhash
# sourcehash
# name=xxx
# monitorurl=url
# monitorsize=sizespec
# monitorinterval=seconds
# monitortimeout=seconds
# forceddomain=name
# ssl
# sslcert=/path/to/ssl/certificate
# sslkey=/path/to/ssl/key
# sslversion=1|2|3|4
# sslcipher=...
# ssloptions=...
# front-end-https[=on|auto]
# connection-auth[=on|off|auto]
# idle=n
# http11
#
# use 'proxy-only' to specify objects fetched
# from this cache should not be saved locally.
#
# use 'weight=n' to affect the selection of a peer
# during any weighted peer-selection mechanisms.
# The weight must be an integer; default is 1,
# larger weights are favored more.
# This option does not affect parent selection if a peering
# protocol is not in use.
#
# use 'ttl=n' to specify a IP multicast TTL to use
# when sending an ICP queries to this address.
# Only useful when sending to a multicast group.
# Because we don't accept ICP replies from random
# hosts, you must configure other group members as
# peers with the 'multicast-responder' option below.
#
# use 'no-query' to NOT send ICP queries to this
# neighbor.
#
# use 'default' if this is a parent cache which can
# be used as a "last-resort" if a peer cannot be located
# by any of the peer-selection mechanisms.
# If specified more than once, only the first is used.
#
# use 'round-robin' to define a set of parents which
# should be used in a round-robin fashion in the
# absence of any ICP queries.
#
# use 'carp' to define a set of parents which should
# be used as a CARP array. The requests will be
# distributed among the parents based on the CARP load
# balancing hash function based on their weight.
#
# 'multicast-responder' indicates the named peer
# is a member of a multicast group. ICP queries will
# not be sent directly to the peer, but ICP replies
# will be accepted from it.
#
# the 'multicast-siblings' option is meant to be used
# only for cache peers of type "multicast". It instructs
# Squid that ALL members of this multicast group have
# "sibling" relationship with it, not "parent". This is
# an optimization that avoids useless multicast queries
# to a multicast group when the requested object would
# be fetched only from a "parent" cache, anyway. It's
# useful, e.g., when configuring a pool of redundant
# Squid proxies, being members of the same
# multicast group.
#
# 'closest-only' indicates that, for ICP_OP_MISS
# replies, we'll only forward CLOSEST_PARENT_MISSes
# and never FIRST_PARENT_MISSes.
#
# use 'no-digest' to NOT request cache digests from
# this neighbor.
#
# 'no-netdb-exchange' disables requesting ICMP
# RTT database (NetDB) from the neighbor.
#
# use 'no-delay' to prevent access to this neighbor
# from influencing the delay pools.
#
# use 'login=user:password' if this is a personal/workgroup
# proxy and your parent requires proxy authentication.
# Note: The string can include URL escapes (i.e. %20 for
# spaces). This also means % must be written as %%.
#
# use 'login=PASS' if users must authenticate against
# the upstream proxy or in the case of a reverse proxy
# configuration, the origin web server. This will pass
# the users credentials as they are to the peer.
# Note: To combine this with local authentication the Basic
# authentication scheme must be used, and both servers must
# share the same user database as HTTP only allows for
# a single login (one for proxy, one for origin server).
# Also be warned this will expose your users proxy
# password to the peer. USE WITH CAUTION
#
# use 'login=*:password' to pass the username to the
# upstream cache, but with a fixed password. This is meant
# to be used when the peer is in another administrative
# domain, but it is still needed to identify each user.
# The star can optionally be followed by some extra
# information which is added to the username. This can
# be used to identify this proxy to the peer, similar to
# the login=username:password option above.
#
# use 'connect-timeout=nn' to specify a peer
# specific connect timeout (also see the
# peer_connect_timeout directive)
#
# use 'digest-url=url' to tell Squid to fetch the cache
# digest (if digests are enabled) for this host from
# the specified URL rather than the Squid default
# location.
#
# use 'allow-miss' to disable Squid's use of only-if-cached
# when forwarding requests to siblings. This is primarily
# useful when icp_hit_stale is used by the sibling. To
# extensive use of this option may result in forwarding
# loops, and you should avoid having two-way peerings
# with this option. (for example to deny peer usage on
# requests from peer by denying cache_peer_access if the
# source is a peer)
#
# use 'max-conn=n' to limit the amount of connections Squid
# may open to this peer.
#
# use 'htcp' to send HTCP, instead of ICP, queries
# to the neighbor. You probably also want to
# set the "icp port" to 4827 instead of 3130.
# You must also allow this Squid htcp_access and
# http_access in the peer Squid configuration.
#
# use 'htcp-oldsquid' to send HTCP to old Squid versions
# You must also allow this Squid htcp_access and
# http_access in the peer Squid configuration.
#
# 'originserver' causes this parent peer to be contacted as
# a origin server. Meant to be used in accelerator setups.
#
# use 'userhash' to load-balance amongst a set of parents
# based on the client proxy_auth or ident username.
#
# use 'sourcehash' to load-balance amongst a set of parents
# based on the client source ip.
#
# use 'name=xxx' if you have multiple peers on the same
# host but different ports. This name can be used to
# differentiate the peers in cache_peer_access and similar
# directives.
#
# use 'monitorurl=url' to have periodically request a given
# URL from the peer, and only consider the peer as alive
# if this monitoring is successful (default none)
#
# use 'monitorsize=min[-max]' to limit the size range of
# 'monitorurl' replies considered valid. Defaults to 0 to
# accept any size replies as valid.
#
# use 'monitorinterval=seconds' to change frequency of
# how often the peer is monitored with 'monitorurl'
# (default 300 for a 5 minute interval). If set to 0
# then monitoring is disabled even if a URL is defined.
#
# use 'monitortimeout=seconds' to change the timeout of
# 'monitorurl'. Defaults to 'monitorinterval'.
#
# use 'forceddomain=name' to forcibly set the Host header
# of requests forwarded to this peer. Useful in accelerator
# setups where the server (peer) expects a certain domain
# name and using redirectors to feed this domain name
# is not feasible.
#
# use 'ssl' to indicate connections to this peer should
# be SSL/TLS encrypted.
#
# use 'sslcert=/path/to/ssl/certificate' to specify a client
# SSL certificate to use when connecting to this peer.
#
# use 'sslkey=/path/to/ssl/key' to specify the private SSL
# key corresponding to sslcert above. If 'sslkey' is not
# specified 'sslcert' is assumed to reference a
# combined file containing both the certificate and the key.
#
# use sslversion=1|2|3|4 to specify the SSL version to use
# when connecting to this peer
# 1 = automatic (default)
# 2 = SSL v2 only
# 3 = SSL v3 only
# 4 = TLS v1 only
#
# use sslcipher=... to specify the list of valid SSL ciphers
# to use when connecting to this peer.
#
# use ssloptions=... to specify various SSL engine options:
# NO_SSLv2 Disallow the use of SSLv2
# NO_SSLv3 Disallow the use of SSLv3
# NO_TLSv1 Disallow the use of TLSv1
# See src/ssl_support.c or the OpenSSL documentation for
# a more complete list.
#
# use sslcafile=... to specify a file containing
# additional CA certificates to use when verifying the
# peer certificate.
#
# use sslcapath=... to specify a directory containing
# additional CA certificates to use when verifying the
# peer certificate.
#
# use sslcrlfile=... to specify a certificate revocation
# list file to use when verifying the peer certificate.
#
# use sslflags=... to specify various flags modifying the
# SSL implementation:
# DONT_VERIFY_PEER
# Accept certificates even if they fail to
# verify.
# NO_DEFAULT_CA
# Don't use the default CA list built in
# to OpenSSL.
#
# use ssldomain= to specify the peer name as advertised
# in it's certificate. Used for verifying the correctness
# of the received peer certificate. If not specified the
# peer hostname will be used.
#
# use front-end-https to enable the "Front-End-Https: On"
# header needed when using Squid as a SSL frontend in front
# of Microsoft OWA. See MS KB document Q307347 for details
# on this header. If set to auto the header will
# only be added if the request is forwarded as a https://
# URL.
#
# use connection-auth=off to tell Squid that this peer does
# not support Microsoft connection oriented authentication,
# and any such challenges received from there should be
# ignored. Default is auto to automatically determine the
# status of the peer.
#
# use idle=n to specify a minimum number of idle connections
# that should be kept open to this peer.
#
# use http11 to send requests using HTTP/1.1 to this peer.
# Note: The HTTP/1.1 support is still incomplete, with an
# internal HTTP/1.0 hop. As result 1xx responses will not
# be forwarded.
#
#Default:
# none
# See http://www.privoxy.org/user-manual/config.html
# Define Privoxy as parent proxy (without ICP)
cache_peer 127.0.0.1 parent 8118 0 no-digest no-query default name=privoxy
# Use LAN IP if Privoxy configured to listen on LAN
#cache_peer 10.0.1.3 parent 8118 0 no-digest no-query default name=privoxy
# TAG: cache_peer_domain
# Use to limit the domains for which a neighbor cache will be
# queried. Usage:
#
# cache_peer_domain cache-host domain [domain ...]
# cache_peer_domain cache-host !domain
#
# For example, specifying
#
# cache_peer_domain parent.foo.net .edu
#
# has the effect such that UDP query packets are sent to
# 'bigserver' only when the requested object exists on a
# server in the .edu domain. Prefixing the domain name
# with '!' means the cache will be queried for objects
# NOT in that domain.
#
# NOTE: * Any number of domains may be given for a cache-host,
# either on the same or separate lines.
# * When multiple domains are given for a particular
# cache-host, the first matched domain is applied.
# * Cache hosts with no domain restrictions are queried
# for all requests.
# * There are no defaults.
# * There is also a 'cache_peer_access' tag in the ACL
# section.
#
#Default:
# none
# TAG: cache_peer_access
# Similar to 'cache_peer_domain' but provides more flexibility by
# using ACL elements.
#
# cache_peer_access cache-host allow|deny [!]aclname ...
#
# The syntax is identical to 'http_access' and the other lists of
# ACL elements. See the comments for 'http_access' below, or
# the Squid FAQ (http://www.squid-cache.org/FAQ/FAQ-10.html).
#
#Default:
# none
# TAG: neighbor_type_domain
# usage: neighbor_type_domain neighbor parent|sibling domain domain ...
#
# Modifying the neighbor type for specific domains is now
# possible. You can treat some domains differently than the the
# default neighbor type specified on the 'cache_peer' line.
# Normally it should only be necessary to list domains which
# should be treated differently because the default neighbor type
# applies for hostnames which do not match domains listed here.
#
#EXAMPLE:
# cache_peer cache.foo.org parent 3128 3130
# neighbor_type_domain cache.foo.org sibling .com .net
# neighbor_type_domain cache.foo.org sibling .au .de
#
#Default:
# none
# TAG: dead_peer_timeout (seconds)
# This controls how long Squid waits to declare a peer cache
# as "dead." If there are no ICP replies received in this
# amount of time, Squid will declare the peer dead and not
# expect to receive any further ICP replies. However, it
# continues to send ICP queries, and will mark the peer as
# alive upon receipt of the first subsequent ICP reply.
#
# This timeout also affects when Squid expects to receive ICP
# replies from peers. If more than 'dead_peer' seconds have
# passed since the last ICP reply was received, Squid will not
# expect to receive an ICP reply on the next query. Thus, if
# your time between requests is greater than this timeout, you
# will see a lot of requests sent DIRECT to origin servers
# instead of to your parents.
#
#Default:
# dead_peer_timeout 10 seconds
# TAG: hierarchy_stoplist
# A list of words which, if found in a URL, cause the object to
# be handled directly by this cache. In other words, use this
# to not query neighbor caches for certain objects. You may
# list this option multiple times. Note: never_direct overrides
# this option.
#We recommend you to use at least the following line.
hierarchy_stoplist cgi-bin ?
# MEMORY CACHE OPTIONS
# -----------------------------------------------------------------------------
# TAG: cache_mem (bytes)
# NOTE: THIS PARAMETER DOES NOT SPECIFY THE MAXIMUM PROCESS SIZE.
# IT ONLY PLACES A LIMIT ON HOW MUCH ADDITIONAL MEMORY SQUID WILL
# USE AS A MEMORY CACHE OF OBJECTS. SQUID USES MEMORY FOR OTHER
# THINGS AS WELL. SEE THE SQUID FAQ SECTION 8 FOR DETAILS.
#
# 'cache_mem' specifies the ideal amount of memory to be used
# for:
# * In-Transit objects
# * Hot Objects
# * Negative-Cached objects
#
# Data for these objects are stored in 4 KB blocks. This
# parameter specifies the ideal upper limit on the total size of
# 4 KB blocks allocated. In-Transit objects take the highest
# priority.
#
# In-transit objects have priority over the others. When
# additional space is needed for incoming data, negative-cached
# and hot objects will be released. In other words, the
# negative-cached and hot objects will fill up any unused space
# not needed for in-transit objects.
#
# If circumstances require, this limit will be exceeded.
# Specifically, if your incoming request rate requires more than
# 'cache_mem' of memory to hold in-transit objects, Squid will
# exceed this limit to satisfy the new requests. When the load
# decreases, blocks will be freed until the high-water mark is
# reached. Thereafter, blocks will be used to store hot
# objects.
#
#Default:
# cache_mem 8 MB
cache_mem 32 MB
# TAG: maximum_object_size_in_memory (bytes)
# Objects greater than this size will not be attempted to kept in
# the memory cache. This should be set high enough to keep objects
# accessed frequently in memory to improve performance whilst low
# enough to keep larger objects from hoarding cache_mem.
#
#Default:
# maximum_object_size_in_memory 8 KB
# TAG: memory_replacement_policy
# The memory replacement policy parameter determines which
# objects are purged from memory when memory space is needed.
#
# See cache_replacement_policy for details.
#
#Default:
# memory_replacement_policy lru
# DISK CACHE OPTIONS
# -----------------------------------------------------------------------------
# TAG: cache_replacement_policy
# The cache replacement policy parameter determines which
# objects are evicted (replaced) when disk space is needed.
#
# lru : Squid's original list based LRU policy
# heap GDSF : Greedy-Dual Size Frequency
# heap LFUDA: Least Frequently Used with Dynamic Aging
# heap LRU : LRU policy implemented using a heap
#
# Applies to any cache_dir lines listed below this.
#
# The LRU policies keeps recently referenced objects.
#
# The heap GDSF policy optimizes object hit rate by keeping smaller
# popular objects in cache so it has a better chance of getting a
# hit. It achieves a lower byte hit rate than LFUDA though since
# it evicts larger (possibly popular) objects.
#
# The heap LFUDA policy keeps popular objects in cache regardless of
# their size and thus optimizes byte hit rate at the expense of
# hit rate since one large, popular object will prevent many
# smaller, slightly less popular objects from being cached.
#
# Both policies utilize a dynamic aging mechanism that prevents
# cache pollution that can otherwise occur with frequency-based
# replacement policies.
#
# NOTE: if using the LFUDA replacement policy you should increase
# the value of maximum_object_size above its default of 4096 KB to
# to maximize the potential byte hit rate improvement of LFUDA.
#
# For more information about the GDSF and LFUDA cache replacement
# policies see http://www.hpl.hp.com/techreports/1999/HPL-1999-69.html
# and http://fog.hpl.external.hp.com/techreports/98/HPL-98-173.html.
#
#Default:
# cache_replacement_policy lru
# TAG: cache_dir
# Usage:
#
# cache_dir Type Directory-Name Fs-specific-data [options]
#
# You can specify multiple cache_dir lines to spread the
# cache among different disk partitions.
#
# Type specifies the kind of storage system to use. Only "ufs"
# is built by default. To enable any of the other storage systems
# see the --enable-storeio configure option.
#
# 'Directory' is a top-level directory where cache swap
# files will be stored. If you want to use an entire disk
# for caching, this can be the mount-point directory.
# The directory must exist and be writable by the Squid
# process. Squid will NOT create this directory for you.
# Only using COSS, a raw disk device or a stripe file can
# be specified, but the configuration of the "cache_swap_log"
# tag is mandatory.
#
# The ufs store type:
#
# "ufs" is the old well-known Squid storage format that has always
# been there.
#
# cache_dir ufs Directory-Name Mbytes L1 L2 [options]
#
# 'Mbytes' is the amount of disk space (MB) to use under this
# directory. The default is 100 MB. Change this to suit your
# configuration. Do NOT put the size of your disk drive here.
# Instead, if you want Squid to use the entire disk drive,
# subtract 20% and use that value.
#
# 'Level-1' is the number of first-level subdirectories which
# will be created under the 'Directory'. The default is 16.
#
# 'Level-2' is the number of second-level subdirectories which
# will be created under each first-level directory. The default
# is 256.
#
# The aufs store type:
#
# "aufs" uses the same storage format as "ufs", utilizing
# POSIX-threads to avoid blocking the main Squid process on
# disk-I/O. This was formerly known in Squid as async-io.
#
# cache_dir aufs Directory-Name Mbytes L1 L2 [options]
#
# see argument descriptions under ufs above
#
# The diskd store type:
#
# "diskd" uses the same storage format as "ufs", utilizing a
# separate process to avoid blocking the main Squid process on
# disk-I/O.
#
# cache_dir diskd Directory-Name Mbytes L1 L2 [options] [Q1=n] [Q2=n]
#
# see argument descriptions under ufs above
#
# Q1 specifies the number of unacknowledged I/O requests when Squid
# stops opening new files. If this many messages are in the queues,
# Squid won't open new files. Default is 64
#
# Q2 specifies the number of unacknowledged messages when Squid
# starts blocking. If this many messages are in the queues,
# Squid blocks until it receives some replies. Default is 72
#
# When Q1 < Q2 (the default), the cache directory is optimized
# for lower response time at the expense of a decrease in hit
# ratio. If Q1 > Q2, the cache directory is optimized for
# higher hit ratio at the expense of an increase in response
# time.
#
# The coss store type:
#
# block-size=n defines the "block size" for COSS cache_dir's.
# Squid uses file numbers as block numbers. Since file numbers
# are limited to 24 bits, the block size determines the maximum
# size of the COSS partition. The default is 512 bytes, which
# leads to a maximum cache_dir size of 512<<24, or 8 GB. Note
# you should not change the COSS block size after Squid
# has written some objects to the cache_dir.
#
# overwrite-percent=n defines the percentage of disk that COSS
# must write to before a given object will be moved to the
# current stripe. A value of "n" closer to 100 will cause COSS
# to waste less disk space by having multiple copies of an object
# on disk, but will increase the chances of overwriting a popular
# object as COSS overwrites stripes. A value of "n" close to 0
# will cause COSS to keep all current objects in the current COSS
# stripe at the expense of the hit rate. The default value of 50
# will allow any given object to be stored on disk a maximum of
# 2 times.
#
# max-stripe-waste=n defines the maximum amount of space that COSS
# will waste in a given stripe (in bytes). When COSS writes data
# to disk, it will potentially waste up to "max-size" worth of disk
# space for each 1MB of data written. If "max-size" is set to a
# large value (ie >256k), this could potentially result in large
# amounts of wasted disk space. Setting this value to a lower value
# (ie 64k or 32k) will result in a COSS disk refusing to cache
# larger objects until the COSS stripe has been filled to within
# "max-stripe-waste" of the maximum size (1MB).
#
# membufs=n defines the number of "memory-only" stripes that COSS
# will use. When an cache hit is performed on a COSS stripe before
# COSS has reached the overwrite-percent value for that object,
# COSS will use a series of memory buffers to hold the object in
# while the data is sent to the client. This will define the maximum
# number of memory-only buffers that COSS will use. The default value
# is 10, which will use a maximum of 10MB of memory for buffers.
#
# maxfullbufs=n defines the maximum number of stripes a COSS partition
# will have in memory waiting to be freed (either because the disk is
# under load and the stripe is unwritten, or because clients are still
# transferring data from objects using the memory). In order to try
# and maintain a good hit rate under load, COSS will reserve the last
# 2 full stripes for object hits. (ie a COSS cache_dir will reject
# new objects when the number of full stripes is 2 less than maxfullbufs)
#
# The null store type:
#
# no options are allowed or required
#
# Common options:
#
# no-store, no new objects should be stored to this cache_dir
#
# min-size=n, refers to the min object size this storedir will accept.
# It's used to restrict a storedir to only store large objects
# (e.g. aufs) while other storedirs are optimized for smaller objects
# (e.g. COSS). Defaults to 0.
#
# max-size=n, refers to the max object size this storedir supports.
# It is used to initially choose the storedir to dump the object.
# Note: To make optimal use of the max-size limits you should order
# the cache_dir lines with the smallest max-size value first and the
# ones with no max-size specification last.
#
# Note that for coss, max-size must be less than COSS_MEMBUF_SZ
# (hard coded at 1 MB).
#
#Default:
# cache_dir ufs /opt/local/var/squid/cache 100 16 256
# TAG: store_dir_select_algorithm
# Set this to 'round-robin' as an alternative.
#
#Default:
# store_dir_select_algorithm least-load
# TAG: max_open_disk_fds
# To avoid having disk as the I/O bottleneck Squid can optionally
# bypass the on-disk cache if more than this amount of disk file
# descriptors are open.
#
# A value of 0 indicates no limit.
#
#Default:
# max_open_disk_fds 0
# TAG: minimum_object_size (bytes)
# Objects smaller than this size will NOT be saved on disk. The
# value is specified in kilobytes, and the default is 0 KB, which
# means there is no minimum.
#
#Default:
# minimum_object_size 0 KB
# TAG: maximum_object_size (bytes)
# Objects larger than this size will NOT be saved on disk. The
# value is specified in kilobytes, and the default is 4MB. If
# you wish to get a high BYTES hit ratio, you should probably
# increase this (one 32 MB object hit counts for 3200 10KB
# hits). If you wish to increase speed more than your want to
# save bandwidth you should leave this low.
#
# NOTE: if using the LFUDA replacement policy you should increase
# this value to maximize the byte hit rate improvement of LFUDA!
# See replacement_policy below for a discussion of this policy.
#
#Default:
# maximum_object_size 4096 KB
# TAG: cache_swap_low (percent, 0-100)
# TAG: cache_swap_high (percent, 0-100)
#
# The low- and high-water marks for cache object replacement.
# Replacement begins when the swap (disk) usage is above the
# low-water mark and attempts to maintain utilization near the
# low-water mark. As swap utilization gets close to high-water
# mark object eviction becomes more aggressive. If utilization is
# close to the low-water mark less replacement is done each time.
#
# Defaults are 90% and 95%. If you have a large cache, 5% could be
# hundreds of MB. If this is the case you may wish to set these
# numbers closer together.
#
#Default:
# cache_swap_low 90
# cache_swap_high 95
# TAG: update_headers on|off
# By default Squid updates stored HTTP headers when receiving
# a 304 response. Set this to off if you want to disable this
# for disk I/O performance reasons. Disabling this VIOLATES the
# HTTP standard, and could make you liable for problems which it
# causes.
#
#Default:
# update_headers on
# LOGFILE OPTIONS
# -----------------------------------------------------------------------------
# TAG: logformat
# Usage:
#
# logformat <name> <format specification>
#
# Defines an access log format.
#
# The <format specification> is a string with embedded % format codes
#
# % format codes all follow the same basic structure where all but
# the formatcode is optional. Output strings are automatically escaped
# as required according to their context and the output format
# modifiers are usually not needed, but can be specified if an explicit
# output format is desired.
#
# % ["|[|'|#] [-] [[0]width] [{argument}] formatcode
#
# " output in quoted string format
# [ output in squid text log format as used by log_mime_hdrs
# # output in URL quoted format
# ' output as-is
#
# - left aligned
# width field width. If starting with 0 the
# output is zero padded
# {arg} argument such as header name etc
#
# Format codes:
#
# >a Client source IP address
# >A Client FQDN
# >p Client source port
# <A Server IP address or peer name
# la Local IP address (http_port)
# lp Local port number (http_port)
# oa Our outgoing IP address (tcp_outgoing_address)
# ts Seconds since epoch
# tu subsecond time (milliseconds)
# tl Local time. Optional strftime format argument
# default %d/%b/%Y:%H:%M:%S %z
# tg GMT time. Optional strftime format argument
# default %d/%b/%Y:%H:%M:%S %z
# tr Response time (milliseconds)
# >h Request header. Optional header name argument
# on the format header[:[separator]element]
# <h Reply header. Optional header name argument
# as for >h
# un User name
# ul User name from authentication
# ui User name from ident
# us User name from SSL
# ue User name from external acl helper
# Hs HTTP status code
# Ss Squid request status (TCP_MISS etc)
# Sh Squid hierarchy status (DEFAULT_PARENT etc)
# mt MIME content type
# rm Request method (GET/POST etc)
# ru Request URL
# rp Request URL-Path excluding hostname
# rv Request protocol version
# ea Log string returned by external acl
# <st Reply size including HTTP headers
# >st Request size including HTTP headers
# st Request+Reply size including HTTP headers
# sn Unique sequence number per log line entry
# % a literal % character
#
# The default formats available (which do not need re-defining) are:
#
#logformat squid %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt
#logformat squidmime %ts.%03tu %6tr %>a %Ss/%03Hs %<st %rm %ru %un %Sh/%<A %mt [%>h] [%<h]
#logformat common %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st %Ss:%Sh
#logformat combined %>a %ui %un [%tl] "%rm %ru HTTP/%rv" %Hs %<st "%{Referer}>h" "%{User-Agent}>h" %Ss:%Sh
#
#Default:
# none
# TAG: access_log
# These files log client request activities. Has a line every HTTP or
# ICP request. The format is:
# access_log <filepath> [<logformat name> [acl acl ...]]
# access_log none [acl acl ...]]
#
# Will log to the specified file using the specified format (which
# must be defined in a logformat directive) those entries which match
# ALL the acl's specified (which must be defined in acl clauses).
# If no acl is specified, all requests will be logged to this file.
#
# To disable logging of a request use the filepath "none", in which case
# a logformat name should not be specified.
#
# To log the request via syslog specify a filepath of "syslog":
#
# access_log syslog[:facility.priority] [format [acl1 [acl2 ....]]]
# where facility could be any of:
# authpriv, daemon, local0 .. local7 or user.
#
# And priority could be any of:
# err, warning, notice, info, debug.
access_log /opt/local/var/squid/logs/access.log squid
# TAG: log_access allow|deny acl acl...
# This options allows you to control which requests gets logged
# to access.log (see access_log directive). Requests denied for
# logging will also not be accounted for in performance counters.
#
#Default:
# none
# TAG: logfile_daemon
# Specify the path to the logfile-writing daemon. This daemon is
# used to write the access and store logs, if configured.
#
#Default:
# logfile_daemon /opt/local/libexec/squid/logfile-daemon
# TAG: cache_log
# Cache logging file. This is where general information about
# your cache's behavior goes. You can increase the amount of data
# logged to this file with the "debug_options" tag below.
#
#Default:
# cache_log /opt/local/var/squid/logs/cache.log
# TAG: cache_store_log
# Logs the activities of the storage manager. Shows which
# objects are ejected from the cache, and which objects are
# saved and for how long. To disable, enter "none". There are
# not really utilities to analyze this data, so you can safely
# disable it.
#
#Default:
# cache_store_log /opt/local/var/squid/logs/store.log
# TAG: cache_swap_state
# Location for the cache "swap.state" file. This index file holds
# the metadata of objects saved on disk. It is used to rebuild
# the cache during startup. Normally this file resides in each
# 'cache_dir' directory, but you may specify an alternate
# pathname here. Note you must give a full filename, not just
# a directory. Since this is the index for the whole object
# list you CANNOT periodically rotate it!
#
# If %s can be used in the file name it will be replaced with a
# a representation of the cache_dir name where each / is replaced
# with '.'. This is needed to allow adding/removing cache_dir
# lines when cache_swap_log is being used.
#
# If have more than one 'cache_dir', and %s is not used in the name
# these swap logs will have names such as:
#
# cache_swap_log.00
# cache_swap_log.01
# cache_swap_log.02
#
# The numbered extension (which is added automatically)
# corresponds to the order of the 'cache_dir' lines in this
# configuration file. If you change the order of the 'cache_dir'
# lines in this file, these index files will NOT correspond to
# the correct 'cache_dir' entry (unless you manually rename
# them). We recommend you do NOT use this option. It is
# better to keep these index files in each 'cache_dir' directory.
#
#Default:
# none
# TAG: logfile_rotate
# Specifies the number of logfile rotations to make when you
# type 'squid -k rotate'. The default is 10, which will rotate
# with extensions 0 through 9. Setting logfile_rotate to 0 will
# disable the file name rotation, but the logfiles are still closed
# and re-opened. This will enable you to rename the logfiles
# yourself just before sending the rotate signal.
#
# Note, the 'squid -k rotate' command normally sends a USR1
# signal to the running squid process. In certain situations
# (e.g. on Linux with Async I/O), USR1 is used for other
# purposes, so -k rotate uses another signal. It is best to get
# in the habit of using 'squid -k rotate' instead of 'kill -USR1
# <pid>'.
#
#Default:
# logfile_rotate 10
# TAG: emulate_httpd_log on|off
# The Cache can emulate the log file format which many 'httpd'
# programs use. To disable/enable this emulation, set
# emulate_httpd_log to 'off' or 'on'. The default
# is to use the native log format since it includes useful
# information Squid-specific log analyzers use.
#
#Default:
# emulate_httpd_log off
# TAG: log_ip_on_direct on|off
# Log the destination IP address in the hierarchy log tag when going
# direct. Earlier Squid versions logged the hostname here. If you
# prefer the old way set this to off.
#
#Default:
# log_ip_on_direct on
# TAG: mime_table
# Pathname to Squid's MIME table. You shouldn't need to change
# this, but the default file contains examples and formatting
# information if you do.
#
#Default:
# mime_table /opt/local/etc/squid/mime.conf
# TAG: log_mime_hdrs on|off
# The Cache can record both the request and the response MIME
# headers for each HTTP transaction. The headers are encoded
# safely and will appear as two bracketed fields at the end of
# the access log (for either the native or httpd-emulated log
# formats). To enable this logging set log_mime_hdrs to 'on'.
#
#Default:
# log_mime_hdrs off
# TAG: useragent_log
# Note: This option is only available if Squid is rebuilt with the
# --enable-useragent-log option
#
# Squid will write the User-Agent field from HTTP requests
# to the filename specified here. By default useragent_log
# is disabled.
#
#Default:
# none
# TAG: referer_log
# Note: This option is only available if Squid is rebuilt with the
# --enable-referer-log option
#
# Squid will write the Referer field from HTTP requests to the
# filename specified here. By default referer_log is disabled.
# Note that "referer" is actually a misspelling of "referrer"
# however the misspelt version has been accepted into the HTTP RFCs
# and we accept both.
#
#Default:
# none
# TAG: pid_filename
# A filename to write the process-id to. To disable, enter "none".
#
#Default:
# pid_filename /opt/local/var/run/squid/squid.pid
# TAG: debug_options
# Logging options are set as section,level where each source file
# is assigned a unique section. Lower levels result in less
# output, Full debugging (level 9) can result in a very large
# log file, so be careful. The magic word "ALL" sets debugging
# levels for all sections. We recommend normally running with
# "ALL,1".
#
#Default:
# debug_options ALL,1
# TAG: log_fqdn on|off
# Turn this on if you wish to log fully qualified domain names
# in the access.log. To do this Squid does a DNS lookup of all
# IP's connecting to it. This can (in some situations) increase
# latency, which makes your cache seem slower for interactive
# browsing.
#
#Default:
# log_fqdn off
# TAG: client_netmask
# A netmask for client addresses in logfiles and cachemgr output.
# Change this to protect the privacy of your cache clients.
# A netmask of 255.255.255.0 will log all IP's in that range with
# the last digit set to '0'.
#
#Default:
# client_netmask 255.255.255.255
# TAG: forward_log
# Note: This option is only available if Squid is rebuilt with the
# --enable-forward-log option
#
# Logs the server-side requests.
#
# This is currently work in progress.
#
#Default:
# none
# TAG: strip_query_terms
# By default, Squid strips query terms from requested URLs before
# logging. This protects your user's privacy.
#
#Default:
# strip_query_terms on
# TAG: buffered_logs on|off
# cache.log log file is written with stdio functions, and as such
# it can be buffered or unbuffered. By default it will be unbuffered.
# Buffering it can speed up the writing slightly (though you are
# unlikely to need to worry unless you run with tons of debugging
# enabled in which case performance will suffer badly anyway..).
#
#Default:
# buffered_logs off
# TAG: netdb_filename
# A filename where Squid stores it's netdb state between restarts.
# To disable, enter "none".
#
#Default:
# netdb_filename /opt/local/var/squid/logs/netdb.state
# OPTIONS FOR FTP GATEWAYING
# -----------------------------------------------------------------------------
# TAG: ftp_user
# If you want the anonymous login password to be more informative
# (and enable the use of picky ftp servers), set this to something
# reasonable for your domain, like wwwuser@somewhere.net
#
# The reason why this is domainless by default is the
# request can be made on the behalf of a user in any domain,
# depending on how the cache is used.
# Some ftp server also validate the email address is valid
# (for example perl.com).
#
#Default:
# ftp_user Squid@
# TAG: ftp_list_width
# Sets the width of ftp listings. This should be set to fit in
# the width of a standard browser. Setting this too small
# can cut off long filenames when browsing ftp sites.
#
#Default:
# ftp_list_width 32
# TAG: ftp_passive
# If your firewall does not allow Squid to use passive
# connections, turn off this option.
#
#Default:
# ftp_passive on
# TAG: ftp_sanitycheck
# For security and data integrity reasons Squid by default performs
# sanity checks of the addresses of FTP data connections ensure the
# data connection is to the requested server. If you need to allow
# FTP connections to servers using another IP address for the data
# connection turn this off.
#
#Default:
# ftp_sanitycheck on
# TAG: ftp_telnet_protocol
# The FTP protocol is officially defined to use the telnet protocol
# as transport channel for the control connection. However, many
# implementations are broken and does not respect this aspect of
# the FTP protocol.
#
# If you have trouble accessing files with ASCII code 255 in the
# path or similar problems involving this ASCII code you can
# try setting this directive to off. If that helps, report to the
# operator of the FTP server in question that their FTP server
# is broken and does not follow the FTP standard.
#
#Default:
# ftp_telnet_protocol on
# OPTIONS FOR EXTERNAL SUPPORT PROGRAMS
# -----------------------------------------------------------------------------
# TAG: diskd_program
# Specify the location of the diskd executable.
# Note this is only useful if you have compiled in
# diskd as one of the store io modules.
#
#Default:
# diskd_program /opt/local/libexec/squid/diskd-daemon
# TAG: unlinkd_program
# Specify the location of the executable for file deletion process.
#
#Default:
# unlinkd_program /opt/local/libexec/squid/unlinkd
# TAG: pinger_program
# Note: This option is only available if Squid is rebuilt with the
# --enable-icmp option
#
# Specify the location of the executable for the pinger process.
#
#Default:
# pinger_program /opt/local/libexec/squid/pinger
# OPTIONS FOR URL REWRITING
# -----------------------------------------------------------------------------
# TAG: storeurl_rewrite_program
# Specify the location of the executable for the Store URL rewriter.
# The Store URL rewriter allows URLs to be "normalised" ; mapping
# multiple URLs to a single URL representation for cache operations.
#
# For example, if you request an object at:
#
# http://srv1.example.com/image.gif
#
# and a subsequent request for:
#
# http://srv2.example.com/image.gif
#
# then Squid will treat these both as different URLs and cache them
# seperately.
#
# This is almost the normal case, but an increasing number of sites
# distribute the same content between multiple frontend hosts.
# The Store URL rewriter allows you to rewrite these URLs to one URL
# to use for cache operations, but not -fetches-. Fetches are still
# made from the original site, but stored with the store URL rewritten
# URL as the store key.
#
# For each requested URL rewriter will receive on line with the format
#
# URL <SP> client_ip "/" fqdn <SP> user <SP> method <SP> urlgroup
# [<SP> kvpairs] <NL>
#
# In the future, the rewriter interface will be extended with
# key=value pairs ("kvpairs" shown above). Rewriter programs
# should be prepared to receive and possibly ignore additional
# whitespace-separated tokens on each input line.
#
# And the rewriter may return a rewritten URL. The other components of
# the request line does not need to be returned (ignored if they are).
#
# By default, a Store URL rewriter is not used.
#
# Please note - the normal URL rewriter rewrites Squid's _destination_
# URL - ie, what it fetches. The Store URL rewriter rewrites Squid's
# _store_ URL - ie, what it uses to store and retrieve objects.
#
#Default:
# none
# TAG: storeurl_rewrite_children
#
#
#Default:
# storeurl_rewrite_children 5
# TAG: storeurl_rewrite_concurrency
#
#
#Default:
# storeurl_rewrite_concurrency 0
# TAG: url_rewrite_program
# Specify the location of the executable for the URL rewriter.
# Since they can perform almost any function there isn't one included.
#
# For each requested URL rewriter will receive on line with the format
#
# URL <SP> client_ip "/" fqdn <SP> user <SP> method <SP> urlgroup
# [<SP> kvpairs] <NL>
#
# In the future, the rewriter interface will be extended with
# key=value pairs ("kvpairs" shown above). Rewriter programs
# should be prepared to receive and possibly ignore additional
# whitespace-separated tokens on each input line.
#
# And the rewriter may return a rewritten URL. The other components of
# the request line does not need to be returned (ignored if they are).
#
# The rewriter can also indicate that a client-side redirect should
# be performed to the new URL. This is done by prefixing the returned
# URL with "301:" (moved permanently) or 302: (moved temporarily).
#
# It can also return a "urlgroup" that can subsequently be matched
# in cache_peer_access and similar ACL driven rules. An urlgroup is
# returned by prefixing the returned URL with "!urlgroup!".
#
# By default, a URL rewriter is not used.
#
#Default:
# none
# TAG: url_rewrite_children
# The number of redirector processes to spawn. If you start
# too few Squid will have to wait for them to process a backlog of
# URLs, slowing it down. If you start too many they will use RAM
# and other system resources.
#
#Default:
# url_rewrite_children 5
# TAG: url_rewrite_concurrency
# The number of requests each redirector helper can handle in
# parallel. Defaults to 0 which indicates the redirector
# is a old-style single threaded redirector.
#
# When this directive is set to a value >= 1 then the protocol
# used to communicate with the helper is modified to include
# a request ID in front of the request/response. The request
# ID from the request must be echoed back with the response
# to that request.
#
#Default:
# url_rewrite_concurrency 0
# TAG: url_rewrite_host_header
# By default Squid rewrites any Host: header in redirected
# requests. If you are running an accelerator this may
# not be a wanted effect of a redirector.
#
# WARNING: Entries are cached on the result of the URL rewriting
# process, so be careful if you have domain-virtual hosts.
#
#Default:
# url_rewrite_host_header on
# TAG: url_rewrite_access
# If defined, this access list specifies which requests are
# sent to the redirector processes. By default all requests
# are sent.
#
#Default:
# none
# TAG: storeurl_access
#
#
#Default:
# none
# TAG: redirector_bypass
# When this is 'on', a request will not go through the
# redirector if all redirectors are busy. If this is 'off'
# and the redirector queue grows too large, Squid will exit
# with a FATAL error and ask you to increase the number of
# redirectors. You should only enable this if the redirectors
# are not critical to your caching system. If you use
# redirectors for access control, and you enable this option,
# users may have access to pages they should not
# be allowed to request.
#
#Default:
# redirector_bypass off
# TAG: location_rewrite_program
# Specify the location of the executable for the Location rewriter,
# used to rewrite server generated redirects. Usually used in
# conjunction with a url_rewrite_program
#
# For each Location header received the location rewriter will receive
# one line with the format:
#
# location URL <SP> requested URL <SP> urlgroup <NL>
#
# And the rewriter may return a rewritten Location URL or a blank line.
# The other components of the request line does not need to be returned
# (ignored if they are).
#
# By default, a Location rewriter is not used.
#
#Default:
# none
# TAG: location_rewrite_children
# The number of location rewriting processes to spawn. If you start
# too few Squid will have to wait for them to process a backlog of
# URLs, slowing it down. If you start too many they will use RAM
# and other system resources.
#
#Default:
# location_rewrite_children 5
# TAG: location_rewrite_concurrency
# The number of requests each Location rewriter helper can handle in
# parallel. Defaults to 0 which indicates that the helper
# is a old-style singlethreaded helper.
#
#Default:
# location_rewrite_concurrency 0
# TAG: location_rewrite_access
# If defined, this access list specifies which requests are
# sent to the location rewriting processes. By default all Location
# headers are sent.
#
#Default:
# none
# OPTIONS FOR TUNING THE CACHE
# -----------------------------------------------------------------------------
# TAG: cache
# A list of ACL elements which, if matched, cause the request to
# not be satisfied from the cache and the reply to not be cached.
# In other words, use this to force certain objects to never be cached.
#
# You must use the word 'DENY' to indicate the ACL names which should
# NOT be cached.
#
# Default is to allow all to be cached.
#
#Default:
# none
# TAG: max_stale time-units
# This option puts an upper limit on how stale content Squid
# will serve from the cache if cache validation fails.
#
#Default:
# max_stale 1 week
# TAG: refresh_pattern
# usage: refresh_pattern [-i] regex min percent max [options]
#
# By default, regular expressions are CASE-SENSITIVE. To make
# them case-insensitive, use the -i option.
#
# 'Min' is the time (in minutes) an object without an explicit
# expiry time should be considered fresh. The recommended
# value is 0, any higher values may cause dynamic applications
# to be erroneously cached unless the application designer
# has taken the appropriate actions.
#
# 'Percent' is a percentage of the objects age (time since last
# modification age) an object without explicit expiry time
# will be considered fresh.
#
# 'Max' is an upper limit on how long objects without an explicit
# expiry time will be considered fresh.
#
# options: override-expire
# override-lastmod
# reload-into-ims
# ignore-reload
# ignore-no-cache
# ignore-private
# ignore-auth
# stale-while-revalidate=NN
# ignore-stale-while-revalidate
# max-stale=NN
# negative-ttl=NN
#
# override-expire enforces min age even if the server
# sent an explicit expiry time (e.g., with the
# Expires: header or Cache-Control: max-age). Doing this
# VIOLATES the HTTP standard. Enabling this feature
# could make you liable for problems which it causes.
#
# Note: this does not enforce staleness - it only extends
# freshness / min. If the server returns a Expires time which
# is longer than your max time, Squid will still consider
# the object fresh for that period of time.
#
# override-lastmod enforces min age even on objects
# that were modified recently.
#
# reload-into-ims changes client no-cache or ``reload''
# to If-Modified-Since requests. Doing this VIOLATES the
# HTTP standard. Enabling this feature could make you
# liable for problems which it causes.
#
# ignore-reload ignores a client no-cache or ``reload''
# header. Doing this VIOLATES the HTTP standard. Enabling
# this feature could make you liable for problems which
# it causes.
#
# ignore-no-cache ignores any ``Pragma: no-cache'' and
# ``Cache-control: no-cache'' headers received from a server.
# The HTTP RFC never allows the use of this (Pragma) header
# from a server, only a client, though plenty of servers
# send it anyway.
#
# ignore-private ignores any ``Cache-control: private''
# headers received from a server. Doing this VIOLATES
# the HTTP standard. Enabling this feature could make you
# liable for problems which it causes.
#
# ignore-auth caches responses to requests with authorization,
# as if the originserver had sent ``Cache-control: public''
# in the response header. Doing this VIOLATES the HTTP standard.
# Enabling this feature could make you liable for problems which
# it causes.
#
# stale-while-revalidate=NN makes Squid perform an asyncronous
# cache validation if the object isn't more stale than NN.
# Doing this VIOLATES the HTTP standard. Enabling this
# feature could make you liable for problems which it
# causes.
#
# ignore-stale-while-revalidate makes Squid ignore any 'Cache-Control:
# stale-while-revalidate=NN' headers received from a server. Can be
# combined with stale-while-revalidate=NN to override the server provided
# value.
#
# max-stale=NN provided a maximum staleness factor. Squid won't
# serve objects more stale than this even if it failed to
# validate the object.
#
# negative-ttl=NN overrides the global negative_ttl parameter
# selectively for URLs matching this pattern (in seconds).
#
# Basically a cached object is:
#
# FRESH if expires < now, else STALE
# STALE if age > max
# FRESH if lm-factor < percent, else STALE
# FRESH if age < min
# else STALE
#
# The refresh_pattern lines are checked in the order listed here.
# The first entry which matches is used. If none of the entries
# match the default will be used.
#
# Note, you must uncomment all the default lines if you want
# to change one. The default setting is only active if none is
# used.
#
#Suggested default:
refresh_pattern ^ftp: 1440 20% 10080
refresh_pattern ^gopher: 1440 0% 1440
refresh_pattern -i (/cgi-bin/|\?) 0 0% 0
refresh_pattern . 0 20% 4320
# TAG: quick_abort_min (KB)
# TAG: quick_abort_max (KB)
# TAG: quick_abort_pct (percent)
# The cache by default continues downloading aborted requests
# which are almost completed (less than 16 KB remaining). This
# may be undesirable on slow (e.g. SLIP) links and/or very busy
# caches. Impatient users may tie up file descriptors and
# bandwidth by repeatedly requesting and immediately aborting
# downloads.
#
# When the user aborts a request, Squid will check the
# quick_abort values to the amount of data transfered until
# then.
#
# If the transfer has less than 'quick_abort_min' KB remaining,
# it will finish the retrieval.
#
# If the transfer has more than 'quick_abort_max' KB remaining,
# it will abort the retrieval.
#
# If more than 'quick_abort_pct' of the transfer has completed,
# it will finish the retrieval.
#
# If you do not want any retrieval to continue after the client
# has aborted, set both 'quick_abort_min' and 'quick_abort_max'
# to '0 KB'.
#
# If you want retrievals to always continue if they are being
# cached set 'quick_abort_min' to '-1 KB'.
#
#Default:
# quick_abort_min 16 KB
# quick_abort_max 16 KB
# quick_abort_pct 95
# TAG: read_ahead_gap buffer-size
# The amount of data the cache will buffer ahead of what has been
# sent to the client when retrieving an object from another server.
#
#Default:
# read_ahead_gap 16 KB
# TAG: negative_ttl time-units
# Time-to-Live (TTL) for failed requests. Certain types of
# failures (such as "connection refused" and "404 Not Found") are
# negatively-cached for a configurable amount of time. The
# default is 5 minutes. Note that this is different from
# negative caching of DNS lookups.
#
#Default:
# negative_ttl 5 minutes
# TAG: positive_dns_ttl time-units
# Upper limit on how long Squid will cache positive DNS responses.
# Default is 6 hours (360 minutes). T
gitextract_vxp6e2ml/ ├── .gitmodules ├── LICENSE ├── README.md ├── blacklist.txt ├── blockips.conf ├── com.github.essandess.easylist-pac.plist ├── config ├── deprecated/ │ ├── Squid.wrapper │ ├── disable.sh │ ├── macosfortress_boot_check │ ├── net.securemecca.pac.plist │ ├── org.adblockplus.privoxy-adblock.plist │ └── squid-27.conf ├── disable.sh ├── macosfortress_setup_check.sh ├── match-all.action ├── net.dshield.block.plist ├── net.emergingthreats.blockips.plist ├── net.hphosts.hosts.plist ├── net.openbsd.pf.brutexpire.plist ├── net.openbsd.pf.plist ├── org.opensource.flashcookiedelete.plist ├── org.squid-cache.squid-rotate.plist ├── pf.conf ├── pf_attacks ├── pf_restart ├── privoxy_restart ├── proxy.pac ├── readme-and-install.sh ├── squid.conf ├── squid_restart ├── user.action └── whitelist.txt
Condensed preview — 33 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (693K chars).
[
{
"path": ".gitmodules",
"chars": 297,
"preview": "[submodule \"privoxy-adblock\"]\n\tpath = deprecated/privoxy-adblock\n\turl = ../privoxy-adblock.git\n[submodule \"easylist-pac-"
},
{
"path": "LICENSE",
"chars": 1077,
"preview": "The MIT License (MIT)\n\nCopyright (c) 2014 essandess\n\nPermission is hereby granted, free of charge, to any person obtaini"
},
{
"path": "README.md",
"chars": 16069,
"preview": "macOS-Fortress\n===========\n\n# macOS-Fortress: Firewall, Blackhole, and Privatizing Proxy for Trackers, Attackers, Malwar"
},
{
"path": "blacklist.txt",
"chars": 1840,
"preview": "\n# blacklisted hosts of the form \"127.0.0.1 hostname.tld\" appened to /etc/hosts\n# 127.0.0.1\twww.ahostnamethatyouwanttobl"
},
{
"path": "blockips.conf",
"chars": 1163,
"preview": "# Define tables and drop rules for open source IP blocks\n# Reload with:\n# pfctl -a blockips -T load -f /usr/local/etc/bl"
},
{
"path": "com.github.essandess.easylist-pac.plist",
"chars": 1506,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "config",
"chars": 68720,
"preview": "# Sample Configuration File for Privoxy 3.0.26\n#\n# $Id: config,v 1.112 2016/08/26 13:14:18 fabiankeil Exp $\n#\n# C"
},
{
"path": "deprecated/Squid.wrapper",
"chars": 658,
"preview": "#!/bin/sh\n#\n# MacPorts generated daemondo support script\n#\n\n#\n# Init\n#\nprefix=/opt/local\n\n#\n# Start\n#\nStart()\n{\n cd /o"
},
{
"path": "deprecated/disable.sh",
"chars": 2409,
"preview": "#!/bin/bash -x\n\n# OS X Fortress: Firewall, Blackhole, and Privatizing Proxy\n# for Trackers, Attackers, Malware, Adware, "
},
{
"path": "deprecated/macosfortress_boot_check",
"chars": 981,
"preview": "#!/bin/bash -x\n\n# macosfortress_boot_check -- check to make sure that all desired services are running\n\n# commands\nSUDO="
},
{
"path": "deprecated/net.securemecca.pac.plist",
"chars": 1957,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "deprecated/org.adblockplus.privoxy-adblock.plist",
"chars": 933,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "deprecated/squid-27.conf",
"chars": 172963,
"preview": "\n#\tWELCOME TO SQUID 2.7.STABLE9\n#\t----------------------------\n#\n#\tThis is the default Squid configuration file. You may"
},
{
"path": "disable.sh",
"chars": 2587,
"preview": "#!/bin/bash -x\n\n# macOS-Fortress: Firewall, Blackhole, and Privatizing Proxy\n# for Trackers, Attackers, Malware, Adware,"
},
{
"path": "macosfortress_setup_check.sh",
"chars": 8914,
"preview": "#!/bin/sh\n\n# macOS-Fortress: Firewall, Blackhole, and Privatizing Proxy\n# for Trackers, Attackers, Malware, Adware, and "
},
{
"path": "match-all.action",
"chars": 1302,
"preview": "#############################################################################\n# $Id: match-all.action,v 1.4 2016/03/27 1"
},
{
"path": "net.dshield.block.plist",
"chars": 1494,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "net.emergingthreats.blockips.plist",
"chars": 938,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "net.hphosts.hosts.plist",
"chars": 2856,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "net.openbsd.pf.brutexpire.plist",
"chars": 743,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "net.openbsd.pf.plist",
"chars": 1009,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "org.opensource.flashcookiedelete.plist",
"chars": 787,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "org.squid-cache.squid-rotate.plist",
"chars": 583,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "pf.conf",
"chars": 8647,
"preview": "#\n# Default PF configuration file.\n#\n# This file contains the main ruleset, which gets automatically loaded\n# at startup"
},
{
"path": "pf_attacks",
"chars": 541,
"preview": "#!/bin/bash\n\n# Count attacks on the PF firewall\n\nnum=0\n\nres=$(sudo pfctl -t bruteforce -Ts 2>&1 | sed -e 1,2d | wc -l)\nn"
},
{
"path": "pf_restart",
"chars": 166,
"preview": "#!/bin/bash -x\n\n# restart pf\n\nsudo launchctl unload -w /Library/LaunchDaemons/net.openbsd.pf.plist\nsudo launchctl load -"
},
{
"path": "privoxy_restart",
"chars": 183,
"preview": "#!/bin/bash -x\n\n# restart Privoxy\n\nsudo launchctl unload -w /Library/LaunchDaemons/org.macports.Privoxy.plist\nsudo launc"
},
{
"path": "proxy.pac",
"chars": 999,
"preview": "function FindProxyForURL(url, host)\n{\nif (\n// Bypass proxy on the LAN for local DNS domainname\n// (host == \"mydomainna"
},
{
"path": "readme-and-install.sh",
"chars": 17566,
"preview": "#!/bin/bash -x\n\n# macOS Fortress: Firewall, Blackhole, and Privatizing Proxy\n# for Trackers, Attackers, Malware, Adware,"
},
{
"path": "squid.conf",
"chars": 326577,
"preview": "#\tWELCOME TO SQUID 4.7\n#\t----------------------------\n#\t\n#\tThis is the documentation for the Squid configuration file.\n#"
},
{
"path": "squid_restart",
"chars": 229,
"preview": "#!/bin/bash -x\n\n# restart Squid\n\nsudo launchctl unload -w /Library/LaunchDaemons/org.macports.Squid.plist\nsudo killall '"
},
{
"path": "user.action",
"chars": 10173,
"preview": "######################################################################\n# \n# File : $Source: /cvsroot/ijbswa/cur"
},
{
"path": "whitelist.txt",
"chars": 862,
"preview": "\n# whitelisted hosts (FQDN and DN) will be deleted frpm hphost's host.zip\ns3.amazonaws.com\nwww.s3.amazonaws.com\nbroker.a"
}
]
About this extraction
This page contains the full source code of the essandess/macOS-Fortress GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 33 files (642.3 KB), approximately 173.2k tokens. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.