1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
4 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
8 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
10 $Id: user-manual.sgml,v 1.13 2001/10/10 17:28:33 hal9 Exp $
12 Written by and Copyright (C) 2001 the SourceForge
13 IJBSWA team. http://ijbswa.sourceforge.net
15 Based on the Internet Junkbuster originally written
16 by and Copyright (C) 1997 Anonymous Coders and
17 Junkbusters Corporation. http://www.junkbusters.com
21 Sun 09/23/01 08:53:31 PM
23 This is an unfinished, rough draft. Anyone reading this, believe let me
24 know errors!!!!! Stefan, especially you!
26 Hal Burgiss <hal@foobox.net>
31 <title>Junkbuster User Manual</title>
33 <pubdate>$Id: user-manual.sgml,v 1.13 2001/10/10 17:28:33 hal9 Exp $</pubdate>
38 <orgname>By: Junkbuster Developers</orgname>
45 The user manual gives the users information on how to install and configure
46 <application>Internet Junkbuster</application>. <application>Internet
47 Junkbuster</application> is an application that provides privacy and
48 security to users of the World Wide Web.
51 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/doc/user-manual/">http://ijbswa.sourceforge.net/doc/user-manual/</ulink>.
55 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
62 <!-- ~~~~~ New section ~~~~~ -->
64 <sect1 id="introduction"><title>Introduction</title>
66 <application>Internet Junkbuster</application> is a web proxy with advanced
67 filtering capabilities for protecting privacy, filtering web page content,
68 managing cookies and removing ads, banners, pop-ups and other obnoxious
69 Internet Junk. <application>Junkbuster</application> has a very flexible
70 configuration and can be customized to suit individual needs and tastes.
71 <application>Internet Junkbuster</application> has application for both
72 stand-alone systems and multi-user networks.
76 This documentation is included with the current development version of
77 <application>Internet Junkbuster</application> and is incomplete at this
78 point. The most up to date reference for the time being is still the comments
79 in the source files and in the individual configuration files. Development
80 of version 3.0 is currently underway, and includes significant changes and
81 enhancements over earlier verions. The target release date for stable v3.0 is
86 Since this is a development version, some features are in the process of
87 being implemented. This documentation may be slightly out of sync as a
88 result. And there <emphasis>are</emphasis> bugs!
92 <!-- ~~~~~ New section ~~~~~ -->
94 <title>New Features</title>
96 In addition to <application>Junkbuster's</application> traditional features
97 of ad and banner blocking and cookie management, this is a list of new
98 features currently under development:
106 Modularized configuration that will allow for system wide settings, and
107 individual user settings.
113 A browser based GUI configuration utility.
119 Blocking of annoying pop-up browser windows (previously available as a
126 Partial support for HTTP/1.1.
132 Support for Perl Compatible Regular Expressions in the configuration files, and
133 generally a more sophisticated configuration syntax over previous versions.
139 Web page content filtering.
156 <!-- ~ End section ~ -->
159 <!-- ~~~~~ New section ~~~~~ -->
160 <sect1 id="installation"><title>Installation</title>
162 <application>Junkbuster</application> is available as raw source code, or
163 pre-compiled binaries. See the <ulink
164 url="http://sourceforge.net/projects/ijbswa/">Junkbuster Home Page</ulink>
165 for current releases. <application>Junkbuster</application> is also available
167 url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
168 This is the recommended approach at this time. But please be aware that CVS
169 is constantly changing, and it may break in mysterious ways.
172 <!-- ~~~~~ New section ~~~~~ -->
173 <sect2 id="installation-source"><title>Source</title>
175 For gzipped tar archives, unpack the source:
180 tar zxvf ijb_source_2.9*
186 For retrieving the current CVS sources, you'll need the CVS
187 package installed first. To download CVS source:
192 cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
193 cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
199 This will create a directory named <filename>current/</filename>, which will
200 contain the source tree.
204 Then, in either case, to build from source:
217 For Redhat and SuSE Linux RPM packages, see below.
223 <!-- ~~~~~ New section ~~~~~ -->
224 <sect2 id="installation-rh"><title>Red Hat</title>
226 To build Redhat RPM packages, install source as above. Then:
237 This will create both binary and src RPMs in the usual places. Example:
241 /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
244 /usr/src/redhat/SRPMS/junkbuster-2.9.8-1.src.rpm
248 To install, of course:
253 rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
258 This will place the <application>Junkbuster</application> configuration
259 files in <filename>/etc/junkbuster/</filename>, and log files in
260 <filename>/var/log/junkbuster/</filename>.
265 <!-- ~~~~~ New section ~~~~~ -->
266 <sect2 id="installation-suse"><title>SuSE</title>
268 To build SuSE RPM packages, install source as above. Then:
279 This will create both binary and src RPMs in the usual places. Example:
283 /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
286 /usr/src/suse/SRPMS/junkbuster-2.9.8-1.src.rpm
290 To install, of course:
295 rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
300 This will place the <application>Junkbuster</application> configuration
301 files in <filename>/etc/junkbuster/</filename>, and log files in
302 <filename>/var/log/junkbuster/</filename>.
308 <!-- ~~~~~ New section ~~~~~ -->
309 <sect2 id="installation-os2"><title>OS/2</title>
316 The OS/2 version of <application>Junkbuster</application> requires the EMX
317 runtime library to be installed. The EMX runtime library is available on
318 the hobbes OS/2 archive, among many other locations:
319 <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&button=Search&key=emxrt.zip&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d</ulink>
323 <application>Junkbuster</application> is packaged in a WarpIN self-
324 installing archive. The self-installing program will be named depending
325 on the release version, something like:
326 <filename>ijbos123.exe</filename>. In order to install it, simply run
327 this executable or double-click on its icon and follow the WarpIN
328 installation panels. A shadow of the <application>Junkbuster</application>
329 executable will be placed in your startup folder so it will start
330 automatically whenever OS/2 starts.
334 The directory you choose to install <application>Junkbuster</application>
335 into will contain all of the configuration files.
339 If you would like to build binary images on OS/2 yourself, you will need
340 a working EMX/GCC environment, plus several Unix-like tools. The Hobbes
341 OS/2 archive is a good place to start when building such an environment.
342 A set of Unix-like tools named gnupack is located here:
343 <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps</ulink>
346 Once you have the source code unpacked as above, you can build the binaries
347 from the <filename>current/</filename> directory:
361 <!-- ~~~~~ New section ~~~~~ -->
362 <sect2 id="installation-win"><title>Windows</title>
363 <para>I need help on this. Not a clue here. Also for
364 configuration section below.
368 <!-- ~~~~~ New section ~~~~~ -->
369 <sect2 id="installation-other"><title>Other</title>
371 Some quick notes on other Operating Systems.
375 For FreeBSD (and other *BSDs?), the build will need <command>gmake</command>
376 instead of the included <command>make</command>. <command>gmake</command> is
377 available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
378 The rest should be the same as above for Linux/Unix.
385 <!-- ~ End section ~ -->
388 <!-- ~~~~~ New section ~~~~~ -->
389 <sect1 id="configuration"><title>Junkbuster Configuration</title>
391 For Unix, *BSD and Linux, all configuraton files are located in
392 <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
393 these are all in the same directory as the
394 <application>Junkbuster</application> executable. The name and number of
395 configuration files has changed from previous versions, and is subject to
396 change as development progresses.
400 The installed defaults provide a reasonable starting point. For the
401 time being, there are only three default configuration files (this will
410 The main configuration file is named <filename>config</filename>
411 on Linux, Unix, BSD, and OS/2, and <filename>junkbustr.txt</filename> on
418 The <filename>actionsfile</filename> file is used to define various
419 actions relating to images, banners, pop-ups, banners and cookies.
425 The <filename>re_filterfile</filename> file can be used to rewrite the raw
426 page content, including text as well as embedded HTML and JavaScript.
434 <filename>actionsfile</filename> and <filename>re_filterfile</filename>
435 can use Perl style regular expressions for maximum flexibility. All files use
436 the <quote><literal>#</literal></quote> character to denote a comment. Such
437 lines are not processed by <application>Junkbuster</application>. After
438 making any changes, restart <application>Junkbuster</application> in order
439 for the changes to take effect.
443 <!-- ~~~~~ New section ~~~~~ -->
446 <title>The Main Configuration File</title>
448 Again, the main configuration file is named <filename>config</filename> on
449 Linux/Unix/BSD and OS/2, and <filename>junkbustr.txt</filename> on Windows.
450 Configuration lines consist of an initial keyword followed by a list of
451 values, all separated by whitespace (any number of spaces or tabs). For
459 <emphasis>blockfile blocklist.ini</emphasis>
466 Indicates that the blockfile is named <quote>blocklist.ini</quote>.
470 The <quote><literal>#</literal></quote> indicates a comment. Any part of a
471 line following a <quote><literal>#</literal></quote> is ignored, except if
472 the <quote><literal>#</literal></quote> is preceded by a
473 <quote><literal>\</literal></quote>.
477 Thus, by placing a <quote><literal>#</literal></quote> at the start of an
478 existing configuration line, you can make it a comment and it will be treated
479 as if it weren't there. This is called <quote>commenting out</quote> an
480 option and can be useful to turn off features: If you comment out the
481 <quote>logfile</quote> line, <application>junkbuster</application> will not
482 log to a file at all. Watch for the <quote>default:</quote> section in each
483 explanation to see what happens if the option is left unset (or commented
488 Long lines can be continued on the next line by using a
489 <quote><literal>\</literal></quote> as the very last character.
493 There are various aspects of <application>Junkbuster</application> behavior
494 that can be adjusted.
498 <!-- ~~~~~ New section ~~~~~ -->
501 <title>Defining Other Configuration Files</title>
504 <application>Junkbuster</application> can use a number of other files to tell it
505 what ads to block, what cookies to accept, etc. This section of the
506 configuration file tells <application>Junkbuster</application> where to find
507 all those other files.
511 On <application>Windows</application>, <application>Junkbuster</application>
512 looks for these files in the same directory as the executable. On Unix and
513 OS/2, <application>Junkbuster</application> looks for these files in the current
514 working directory. In either case, an absolute path name can be used to
519 When development goes modular and multiuser, the blocker, filter, and
520 per-user config will be stored in subdirectories of <quote>confdir</quote>.
521 For now, only <filename>confdir/templates</filename> is used for storing HTML
522 templates for CGI results.
526 The location of the configuration files:
533 <emphasis>confdir /etc/junkbuster</emphasis> # No trailing /, please.
540 The directory where all logging (i.e. <filename>logfile</filename> and
541 <filename>jarfile</filename>) takes place. No trailing
542 <quote><literal>/</literal></quote>, please:
549 <emphasis>logdir /var/log/junkbuster</emphasis>
556 Note that all file specifications below are relative to
557 the above two directories!
561 The <quote>actionsfile</quote> contains patterns to specify the actions to
562 apply to requests for each site. Default: Cookies to and from all
563 destinations are filtered. Popups are disabled for all sites. All sites are
564 filtered if re_filterfile specified. No sites are blocked. An empty image is
565 displayed for filtered ads and other images (formerly
566 <quote>tinygif</quote>). The syntax of this file is explained in detail
567 <link linkend="actionsfile">below</link>.
574 <emphasis>actionsfile actionsfile</emphasis>
581 The <quote>re_filterfile</quote> file contains content modification rules.
582 These rules permit powerful changes on the content of Web pages, e.g., you
583 could disable your favourite JavaScript annoyances, rewrite the actual
584 content, or just have some fun replacing <quote>Microsoft</quote> with
585 <quote>MicroSuck</quote> wherever it appears on a Web page. Default: No
586 content modification, or whatever the developers are playing with :-/
593 <emphasis>re_filterfile re_filterfile</emphasis>
600 The logfile is where all logging and error messages are written. The logfile
601 can be useful for tracking down a problem with
602 <application>Junkbuster</application> (e.g., it's not blocking an ad you
603 think it should block) but in most cases you probably will never look at it.
607 Your logfile will grow indefinitely, and you will probably want to
608 periodically remove it. On Unix systems, you can do this with a cron job
609 (see <quote>man cron</quote>). For Redhat, a <command>logrotate</command>
610 script has been included.
614 On SuSE Linux systems, you can place a line like <quote>/var/log/junkbuster.*
615 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
616 the effect that cron.daily will automatically archive, gzip, and empty the
617 log, when it exceeds 1M size.
621 Default: Log to the a file named <filename>logfile</filename>.
622 Comment out to disable logging.
629 <emphasis>logfile logfile</emphasis>
636 The <quote>jarfile</quote> defines where
637 <application>Junkbuster</application> stores the cookies it intercepts. Note
638 that if you use a <quote>jarfile</quote>, it may grow quite large. Default:
639 Don't store intercepted cookies.
646 <emphasis>#jarfile jarfile</emphasis>
653 If you specify a <quote>trustfile</quote>,
654 <application>Junkbuster</application> will only allow access to sites that
655 are named in the trustfile. You can also mark sites as trusted referrers,
656 with the effect that access to untrusted sites will be granted, if a link
657 from a trusted referrer was used. The link target will then be added to the
658 <quote>trustfile</quote>. This is a very restrictive feature that typical
659 users most propably want to leave disabled. Default: Disabled, don't use the
667 <emphasis>#trustfile trust</emphasis>
674 If you use the trust mechanism, it is a good idea to write up some online
675 documentation about your blocking policy and to specify the URL(s) here. They
676 will appear on the page that your users receive when they try to access
677 untrusted content. Use multiple times for multiple URLs. Default: Don't
678 display links on the <quote>untrusted</quote> info page.
685 <emphasis>trust-info-url http://www.your-site.com/why_we_block.html</emphasis>
686 <emphasis>trust-info-url http://www.your-site.com/what_we_allow.html</emphasis>
694 <!-- ~ End section ~ -->
698 <!-- ~~~~~ New section ~~~~~ -->
701 <title>Other Configuration Options</title>
704 This part of the configuration file contains options that control how
705 <application>Junkbuster</application> operates.
709 <quote>Admin-address</quote> should be set to the email address of the proxy
710 administrator. It is used in many of the proxy-generated pages. Default:
718 <emphasis>#admin-address fill@me.in.please</emphasis>
725 <quote>Proxy-info-url</quote> can be set to a URL that contains more info
726 about this <application>Junkbuster</application> installation, it's
727 configuration and policies. It is used in many of the proxy-generated pages
728 and its use is highly recommended in multi-user installations, since your
729 users will want to know why certain content is blocked or modified. Default:
730 Don't show a link to online documentation.
737 <emphasis>proxy-info-url http://www.your-site.com/proxy.html</emphasis>
744 <quote>Listen-address</quote> specifies the address and port where
745 <application>Junkbuster</application> will listen for connections from your
746 Web browser. The default is to listen on the localhost port 8000, and
747 this is suitable for most users. (In your web browser, under proxy
748 configuration, list the proxy server as <quote>localhost</quote> and the
749 port as <quote>8000</quote>).
753 If you already have another service running on port 8000, or if you want to
754 serve requests from other machines (e.g. on your local network) as well, you
755 will need to override the default. The syntax is
756 <quote>listen-address [<ip-address>]:<port></quote>. If you leave
757 out the IP adress, <application>junkbuster</application> will bind to all
758 interfaces (addresses) on your machine and may become reachable from the
759 internet. In that case, consider using access control lists (acl's) (see
760 <quote>aclfile</quote> above).
764 For example, suppose you are running <application>Junkbuster</application> on
765 a machine which has the address 192.168.0.1 on your local private network
766 (192.168.0.0) and has another outside connection with a different address.
767 You want it to serve requests from inside only:
774 <emphasis>listen-address 192.168.0.1:8000</emphasis>
781 If you want it to listen on all addresses (including the outside
789 <emphasis>listen-address :8000</emphasis>
796 If you do this, consider using ACLs (see <quote>aclfile</quote> above). Note:
797 you will need to point your browser(s) to the address and port that you have
798 configured here. Default: localhost:8000 (127.0.0.1:8000).
802 The debug option sets the level of debugging information to log in the
803 logfile (and to the console in the Windows version). A debug level of 1 is
804 informative because it will show you each request as it happens. Higher
805 levels of debug are probably only of interest to developers.
812 debug 1 # GPC = show each GET/POST/CONNECT request
813 debug 2 # CONN = show each connection status
814 debug 4 # IO = show I/O status
815 debug 8 # HDR = show header parsing
816 debug 16 # LOG = log all data into the logfile
817 debug 32 # FRC = debug force feature
818 debug 64 # REF = debug regular expression filter
819 debug 128 # = debug fast redirects
820 debug 256 # = debug GIF deanimation
821 debug 512 # CLF = Common Log Format
822 debug 1024 # = debug kill popups
823 debug 4096 # INFO = Startup banner and warnings.
824 debug 8192 # ERROR = Non-fatal errors
831 It is <emphasis>highly recommended</emphasis> that you enable ERROR
832 reporting (debug 8192), at least until the next stable release.
836 The reporting of FATAL errors (i.e. ones which crash
837 <application>JunkBuster</application>) is always on and cannot be disabled.
841 If you want to use CLF (Common Log Format), you should set <quote>debug
842 512</quote> ONLY, do not enable anything else.
846 Multiple <quote>debug</quote> directives, are OK - they're logical-OR'd
854 <emphasis>debug 15 # same as setting the first 4 listed above</emphasis>
868 <emphasis>debug 1 # URLs</emphasis>
869 <emphasis>debug 4096 # Info</emphasis>
870 <emphasis>debug 8192 # Errors - *we highly recommended enabling this*</emphasis>
877 <application>Junkbuster</application> normally uses
878 <quote>multi-threading</quote>, a software technique that permits it to
879 handle many different requests simultaneously. In some cases you may wish to
880 disable this -- particularly if you're trying to debug a problem. The
881 <quote>single-threaded</quote> option forces
882 <application>Junkbuster</application> to handle requests sequentially.
883 Default: Multi-threaded mode.
890 <emphasis>#single-threaded</emphasis>
897 <quote>toggle</quote> allows you to temporarily disable all
898 <application>Junkbuster's</application> filtering. Just set <quote>toggle
903 The Windows version of <application>Junkbuster</application> puts an icon in
904 the system tray, which allows you to change this option without having to
905 edit this file. If you right-click on that icon (or select the
906 <quote>Options</quote> menu), one choice is <quote>Enable</quote>. Clicking
907 on enable toggles <application>Junkbuster</application> on and off. This is
908 useful if you want to temporarily disable
909 <application>Junkbuster</application>, e.g., to access a site that requires
910 cookies which you normally have blocked.
914 <quote>toggle 1</quote> means <application>Junkbuster</application> runs
915 normally, <quote>toggle 0</quote> means that
916 <application>Junkbuster</application> becomes a non-anonymizing non-blocking
924 <emphasis>toggle 1</emphasis>
932 <!-- ~ End section ~ -->
935 <!-- ~~~~~ New section ~~~~~ -->
938 <title>Access Control List (ACL)</title>
940 Access controls are included at the request of some ISPs and systems
941 administrators, and are not usually needed by individual users. Please note
942 the warnings in the FAQ that this proxy is not intended to be a substitute
943 for a firewall or to encourage anyone to defer addressing basic security
948 If no access settings are specified, the proxy talks to anyone that
949 connects. If any access settings file are specified, then the proxy
950 talks only to IP addresses permitted somewhere in this file and not
951 denied later in this file.
955 Summary -- if using an ACL:
960 Client must have permission to receive service.
965 LAST match in ACL wins.
970 Default behavior is to deny service.
975 The syntax for an entry in the Access Control List is:
982 ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ]
989 Where the individual fields are:
996 <emphasis>ACTION</emphasis> = <quote>permit-access</quote> or <quote>deny-access</quote>
998 <emphasis>SRC_ADDR</emphasis> = client hostname or dotted IP address
999 <emphasis>SRC_MASKLEN</emphasis> = number of bits in the subnet mask for the source
1001 <emphasis>DST_ADDR</emphasis> = server or forwarder hostname or dotted IP address
1002 <emphasis>DST_MASKLEN</emphasis> = number of bits in the subnet mask for the target
1010 The field separator (FS) is whitespace (space or tab).
1014 IMPORTANT NOTE: If the <application>junkbuster</application> is using a
1015 forwarder (see below) or a gateway for a particular destination URL, the
1016 <literal>DST_ADDR</literal> that is examined is the address of the forwarder
1017 or the gateway and <emphasis>NOT</emphasis> the address of the ultimate
1018 target. This is necessary because it may be impossible for the local
1019 <application>Junkbuster</application> to determine the address of the
1020 ultimate target (that's often what gateways are used for).
1024 Here are a few examples to show how the ACL features work:
1028 <quote>localhost</quote> is OK -- no DST_ADDR implies that
1029 <emphasis>ALL</emphasis> destination addresses are OK:
1036 <emphasis>permit-access localhost</emphasis>
1043 A silly example to illustrate permitting any host on the class-C subnet with
1044 <application>Junkbuster</application> to go anywhere:
1051 <emphasis>permit-access www.junkbusters.com/24</emphasis>
1058 Except deny one particular IP address from using it at all:
1065 <emphasis>deny-access ident.junkbusters.com</emphasis>
1072 You can also specify an explicit network address and subnet mask.
1073 Explicit addresses do not have to be resolved to be used.
1080 <emphasis>permit-access 207.153.200.0/24</emphasis>
1087 A subnet mask of 0 matches anything, so the next line permits everyone.
1094 <emphasis>permit-access 0.0.0.0/0</emphasis>
1101 Note, you <emphasis>cannot</emphasis> say:
1108 <emphasis>permit-access .org</emphasis>
1115 to allow all *.org domains. Every IP address listed must resolve fully.
1119 An ISP may want to provide a <application>Junkbuster</application> that is
1120 accessible by <quote>the world</quote> and yet restrict use of some of their
1121 private content to hosts on its internal network (i.e. its own subscribers).
1122 Say, for instance the ISP owns the Class-B IP address block 123.124.0.0 (a 16
1123 bit netmask). This is how they could do it:
1130 <emphasis>permit-access 0.0.0.0/0 0.0.0.0/0</emphasis> # other clients can go anywhere
1131 # with the following exceptions:
1133 <emphasis>deny-access</emphasis> 0.0.0.0/0 123.124.0.0/16 # block all external requests for
1134 # sites on the ISP's network
1136 <emphasis>permit 0.0.0.0/0 www.my_isp.com</emphasis> # except for the ISP's main
1139 <emphasis>permit 123.124.0.0/16 0.0.0.0/0</emphasis> # the ISP's clients can go
1147 Note that if some hostnames are listed with multiple IP addresses,
1148 the primary value returned by DNS (via gethostbyname()) is used. Default:
1149 Anyone can access the proxy.
1154 <!-- ~ End section ~ -->
1157 <!-- ~~~~~ New section ~~~~~ -->
1160 <title>Forwarding</title>
1163 This feature allows routing of HTTP requests via multiple proxies.
1164 It can be used to better protect privacy and confidentiality when
1165 accessing specific domains by routing requests to those domains
1166 to a special purpose filtering proxy such as lpwa.com.
1170 It can also be used in an environment with multiple networks to route
1171 requests via multiple gateways allowing transparent access to multiple
1172 networks without having to modify browser configurations.
1176 Also specified here are SOCKS proxies. <application>Junkbuster</application>
1177 SOCKS 4 and SOCKS 4A. The difference is that SOCKS 4A will resolve the target
1178 hostname using DNS on the SOCKS server, not our local DNS client.
1182 The syntax of each line is:
1189 <emphasis>forward target_domain[:port] http_proxy_host[:port]</emphasis>
1190 <emphasis>forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1191 <emphasis>forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port]</emphasis>
1198 If http_proxy_host is <quote>.</quote>, then requests are not forwarded to a
1199 HTTP proxy but are made directly to the web servers.
1203 Lines are checked in sequence, and the last match wins.
1207 There is an implicit line equivalent to the following, which specifies that
1208 anything not finding a match on the list is to go out without forwarding
1209 or gateway protocol, like so:
1216 <emphasis>forward .* . </emphasis># implicit
1223 In the following common configuration, everything goes to Lucent's LPWA,
1224 except SSL on port 443 (which it doesn't handle):
1231 <emphasis>forward .* lpwa.com:8000</emphasis>
1232 <emphasis>forward :443 .</emphasis>
1239 See the FAQ for instructions on how to automate the login procedure for LPWA.
1240 Some users have reported difficulties related to LPWA's use of
1241 <quote>.</quote> as the last element of the domain, and have said that this
1242 can be fixed with this:
1249 <emphasis>forward lpwa. lpwa.com:8000</emphasis>
1256 (NOTE: the syntax for specifiying target_domain has changed since the
1257 previous paragraph was written -- it will not work now. More information
1262 In this fictitious example, everything goes via an ISP's caching proxy,
1263 except requests to that ISP:
1270 <emphasis>forward .* caching.myisp.net:8000</emphasis>
1271 <emphasis>forward myisp.net .</emphasis>
1278 For the @home network, we're told the forwarding configuration is this:
1286 <emphasis>forward .* proxy:8080</emphasis>
1293 Also, we're told they insist on getting cookies and JavaScript, so you need
1294 to add home.com to the cookie file. We consider JavaScript a security risk.
1295 Java need not be enabled.
1299 In this example direct connections are made to all <quote>internal</quote>
1300 domains, but everything else goes through Lucent's LPWA by way of the
1301 company's SOCKS gateway to the Internet.
1308 <emphasis>forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080</emphasis>
1309 <emphasis>forward my_company.com .</emphasis>
1316 This is how you could set up a site that always uses SOCKS but no forwarders:
1323 <emphasis>forward_socks4a .* . firewall.my_company.com:1080</emphasis>
1330 An advanced example for network administrators:
1334 If you have links to multiple ISPs that provide various special content to
1335 their subscribers, you can configure forwarding to pass requests to the
1336 specific host that's connected to that ISP so that everybody can see all
1337 of the content on all of the ISPs.
1341 This is a bit tricky, but here's an example:
1346 host-a has a PPP connection to isp-a.com. And host-b has a PPP connection to
1347 isp-b.com. host-a can run a <application>Junkbuster</application> proxy with
1348 forwarding like this:
1355 <emphasis>forward .* .</emphasis>
1356 <emphasis>forward isp-b.com host-b:8000</emphasis>
1363 host-b can run a <application>Junkbuster</application> proxy with forwarding
1371 <emphasis>forward .* .</emphasis>
1372 <emphasis>forward isp-a.com host-a:8000</emphasis>
1379 Now, <emphasis>anyone</emphasis> on the Internet (including users on host-a
1380 and host-b) can set their browser's proxy to <emphasis>either</emphasis>
1381 host-a or host-b and be able to browse the content on isp-a or isp-b.
1385 Here's another practical example, for University of Kent at
1386 Canterbury students with a network connection in their room, who
1387 need to use the University's Squid web cache.
1394 <emphasis>forward *. ssbcache.ukc.ac.uk:3128</emphasis> # Use the proxy, except for:
1395 <emphasis>forward .ukc.ac.uk . </emphasis> # Anything on the same domain as us
1396 <emphasis>forward * . </emphasis> # Host with no domain specified
1397 <emphasis>forward 129.12.*.* . </emphasis> # A dotted IP on our /16 network.
1398 <emphasis>forward 127.*.*.* . </emphasis> # Loopback address
1399 <emphasis>forward localhost.localdomain . </emphasis> # Loopback address
1400 <emphasis>forward www.ukc.mirror.ac.uk . </emphasis> # Specific host
1407 If you intend to chain <application>Junkbuster</application> and
1408 <application>squid</application> locally, then chain as
1409 <literal>browser -> squid -> junkbuster</literal> is the recommended way.
1413 Your squid configuration could then look like this:
1420 # Define junkbuster as parent cache
1421 cache_peer 127.0.0.1 8000 parent 0 no-query
1423 # Define ACL for protocol FTP
1426 # Do not forward ACL FTP to junkbuster
1427 always_direct allow FTP
1429 # Do not forward ACL CONNECT (https) to junkbuster
1430 always_direct allow CONNECT
1432 # Forward the rest to junkbuster
1433 never_direct allow all
1441 <!-- ~ End section ~ -->
1444 <!-- ~~~~~ New section ~~~~~ -->
1447 <title>Windows GUI Options</title>
1449 Removed references to Win32. HB 09/23/01
1452 <application>Junkbuster</application> has a number of options specific to the
1453 Windows GUI interface:
1457 If <quote>activity-animation</quote> is set to 1, the
1458 <application>Junkbuster</application> icon will animate when
1459 <quote>Junkbuster</quote> is active. To turn off, set to 0.
1466 <emphasis>activity-animation 1</emphasis>
1473 If <quote>log-messages</quote> is set to 1,
1474 <application>Junkbuster</application> will log messages to the console
1482 <emphasis>log-messages 1</emphasis>
1489 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
1490 i.e. the amount of memory used for the log messages displayed in the
1491 console window, will be limited to <quote>log-max-lines</quote> (see below).
1495 Warning: Setting this to 0 will result in the buffer to grow infinitely and
1496 eat up all your memory!
1503 <emphasis>log-buffer-size 1</emphasis>
1510 <application>log-max-lines</application> is the maximum number of lines held
1511 in the log buffer. See above.
1518 <emphasis>log-max-lines 200</emphasis>
1525 If <quote>log-highlight-messages</quote> is set to 1,
1526 <application>Junkbuster</application> will highlight portions of the log
1527 messages with a bold-faced font:
1534 <emphasis>log-highlight-messages 1</emphasis>
1541 The font used in the console window:
1548 <emphasis>log-font-name Comic Sans MS</emphasis>
1555 Font size used in the console window:
1562 <emphasis>log-font-size 8</emphasis>
1569 <quote>show-on-task-bar</quote> controls whether or not
1570 <application>Junkbuster</application> will appear as a button on the Task bar
1578 <emphasis>show-on-task-bar 0</emphasis>
1585 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
1586 button will minimize <application>Junkbuster</application> instead of closing
1587 the program (close with the exit option on the File menu).
1594 <emphasis>close-button-minimizes 1</emphasis>
1601 The <quote>hide-console</quote> option is specific to the MS-Win console
1602 version of <application>JunkBuster</application>. If this option is used,
1603 <application>Junkbuster</application> will disconnect from and hide the
1620 <!-- ~ End section ~ -->
1623 <!-- ~~~~~ New section ~~~~~ -->
1624 <sect2 id="actionsfile">
1625 <title>The Actions File</title>
1628 The <quote>actionsfile</quote> is used to define what actions
1629 <application>Junkbuster</application> takes, and thus determines how images,
1630 cookies and various other aspects of HTTP content and transactions are
1631 handled. Images can be anything you want, including ads, banners, or just
1632 some obnoxious image that you would rather not see. Cookies can be accepted
1633 or rejected. The default file is in fact named <filename>actionsfile</filename>.
1637 To determine which actions apply to a request, the URL of the request is
1638 compared to all patterns in this file. Every time it matches, the list of
1639 applicable actions for the URL is incrementally updated. You can trace
1640 this process by visiting <ulink
1641 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info</ulink>.
1645 There are four types of lines in this file: comments (begin with a
1646 <quote>#</quote> character), actions, aliases and patterns, all of which are
1651 <!-- ~~~~~ New section ~~~~~ -->
1653 <title>URL Domain and Path Syntax</title>
1655 Generally, a pattern has the form <domain>/<path>, where both the
1656 <domain> and <path> part are optional. If you only specify a
1657 domain part, the <quote>/</quote> can be left out:
1661 <emphasis>www.example.com</emphasis> - is a domain only pattern and will match any request to
1662 <quote>www.example.com</quote>.
1666 <emphasis>www.example.com/</emphasis> - means exactly the same.
1670 <emphasis>www.example.com/index.html</emphasis> - matches only the single
1671 document <quote>/index.html</quote> on <quote>www.example.com</quote>.
1675 <emphasis>/index.html</emphasis> - matches the document <quote>/index.html</quote>, regardless of
1680 <emphasis>index.html</emphasis> - matches nothing, since it would be
1681 interpreted as a domain name and there is no top-level domain called
1682 <quote>.html</quote>.
1686 The matching of the domain part offers some flexible options: if the
1687 domain starts or ends with a dot, it becomes unanchored at that end.
1692 <emphasis>.example.com</emphasis> - matches any domain that <emphasis>ENDS</emphasis> in
1693 <quote>.example.com</quote>.
1697 <emphasis>www.</emphasis> - matches any domain that <emphasis>STARTS</emphasis> with
1702 Additionally, there are wildcards that you can use in the domain names
1703 themselves. They work pretty similar to shell wildcards: <quote>*</quote>
1704 stands for zero or more arbitrary characters, <quote>?</quote> stands for
1705 any single character. And you can define charachter classes in square
1706 brackets and they can be freely mixed:
1710 <emphasis>ad*.example.com</emphasis> - matches <quote>adserver.example.com</quote>,
1711 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>.
1715 <emphasis>*ad*.example.com</emphasis> - matches all of the above, and then some.
1719 <emphasis>.?pix.com</emphasis> - matches <quote>www.ipix.com</quote>,
1720 <quote>pictures.epix.com</quote>, <quote>a.b.c.d.e.upix.com</quote>, etc.
1724 <emphasis>www[1-9a-ez].example.com</emphasis> - matches <quote>www1.example.com</quote>,
1725 <quote>www4.example.com</quote>, <quote>wwwd.example.com</quote>,
1726 <quote>wwwz.example.com</quote>, etc., but <emphasis>not</emphasis>
1727 <quote>wwww.example.com</quote>.
1731 If <application>Junkbuster</application> was compiled with
1732 <quote>pcre</quote> support (default), Perl compatible regular expressions
1733 can be used. See the <filename>pcre/docs/</filename> direcory or <quote>man
1734 perlre</quote> (also available on <ulink
1735 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>)
1736 for details. A brief discussion of regular expressions is in the
1737 <link linkend="regex">Appendix</link>. For instance:
1741 <emphasis>/.*/advert[0-9]+\.jpe?g</emphasis> - would match a URL from any
1742 domain, with any path that includes <quote>advert</quote> followed
1743 immediately by one or more digits, then a <quote>.</quote> and ending in
1744 either <quote>jpeg</quote> or <quote>jpg</quote>. So we match
1745 <quote>example.com/ads/advert2.jpg</quote>, and
1746 <quote>www.example.com/ads/banners/advert39.jpeg</quote>, but not
1747 <quote>www.example.com/ads/banners/advert39.gif</quote> (no gifs in the
1752 Please note that matching in the path is case
1753 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
1754 sensitive at any point in the pattern by using the
1755 <quote>(?-i)</quote> switch:
1759 <emphasis>www.example.com/(?-i)PaTtErN.*</emphasis> - will match only
1760 documents whose path starts with <quote>PaTtErN</quote> in
1761 <emphasis>exactly</emphasis> this capitalization.
1766 <!-- ~ End section ~ -->
1770 <!-- ~~~~~ New section ~~~~~ -->
1773 <title>Actions</title>
1775 Actions are enabled if preceded with a <quote>+</quote>, and disabled if
1776 preceded with a <quote>-</quote>. Actions are invoked by enclosing the
1777 action name in curly braces (e.g. {+some_action}), followed by a list of
1778 URLs to which the action applies. There are three classes of actions:
1786 Boolean (e.g. <quote>+/-block</quote>):
1792 <emphasis>{+name}</emphasis> # enable this action
1793 <emphasis>{-name}</emphasis> # disable this action
1803 Parameterized (e.g. <quote>+/-hide-user-agent</quote>):
1809 <emphasis>{+name{param}}</emphasis> # enable action and set parameter to <quote>param</quote>
1810 <emphasis>{-name}</emphasis> # disable action
1819 Multi-value (e.g. <quote>{+/-add-header{Name: value}}</quote>, <quote>{+/-wafer{name=value}}</quote>):
1825 <emphasis>{+name{param}}</emphasis> # enable action and add parameter <quote>param</quote>
1826 <emphasis>{-name{param}}</emphasis> # remove the parameter <quote>param</quote>
1827 <emphasis>{-name}</emphasis> # disable this action totally
1838 If nothing is specified in this file, no <quote>actions</quote> are taken.
1839 So in this case <application>JunkBuster</application> would just be a
1840 normal, non-blocking, non-anonymizing proxy. You must specifically
1841 enable the privacy and blocking features you need (although the
1842 provided default <filename>actionsfile</filename> file will
1843 give a good starting point).
1847 Later defined actions always over-ride earlier ones. For multi-valued
1848 actions, the actions are applied in the order they are specified.
1852 The list of valid <application>Junkbuster</application> <quote>actions</quote> are:
1860 Add the specified HTTP header, which is not checked for validity.
1861 You may specify this many times to specify many different headers:
1867 <emphasis>+add-header{Name: value}</emphasis>
1877 Block this URL totally.
1883 <emphasis>+block</emphasis>
1893 De-animate all animated GIF images, i.e. reduce them to their last frame.
1894 This will also shrink the images considerably (in bytes, not pixels!). If
1895 the option <quote>first</quote> is given, the first frame of the animation
1896 is used as the replacement. If <quote>last</quote> is given, the last frame
1897 of the animation is used instead, which propably makes more sense for most
1898 banner animations, but also has the risk of not showing the entire last
1899 frame (if it is only a delta to an earlier frame).
1905 <emphasis>+deanimate-gifs{last}</emphasis>
1906 <emphasis>+deanimate-gifs{first}</emphasis>
1915 <quote>+downgrade</quote> will downgrade HTTP/1.1 client requests to
1916 HTTP/1.0 and downgrade the responses as well. Use this action for servers
1917 that use HTTP/1.1 protocol features that
1918 <application>Junkbuster</application> doesn't handle well yet. HTTP/1.1
1919 is only partially implemented. Default is not to downgrade requests.
1925 <emphasis>+downgrade</emphasis>
1934 Many sites, like yahoo.com, don't just link to other sites. Instead, they
1935 will link to some script on their own server, giving the destination as a
1936 parameter, which will then redirect you to the final target. URLs resulting
1937 from this scheme typically look like:
1938 http://some.place/some_script?http://some.where-else.
1941 Sometimes, there are even multiple consecutive redirects encoded in the
1942 URL. These redirections via scripts make your web browing more traceable,
1943 since the server from which you follow such a link can see where you go to.
1944 Apart from that, valuable bandwidth and time is wasted, while your browser
1945 ask the server for one redirect after the other. Plus, it feeds the
1949 The <quote>+fast-redirects</quote> option enables interception of these
1950 requests by <application>Junkbuster</application>, who will cut off all but
1951 the last valid URL in the request and send a local redirect back to your
1952 browser without contacting the remote site.
1958 <emphasis>+fast-redirects</emphasis>
1967 Filter the website through the re_filterfile:
1973 <emphasis>+filter{filename}</emphasis>
1982 Block any existing X-Forwarded-for header, and do not add a new one:
1988 <emphasis>+hide-forwarded</emphasis>
1997 If the browser sends a <quote>From:</quote> header containing your e-mail
1998 address, this either completely removes the header (<quote>block</quote>), or
1999 changes it to the specified e-mail address.
2005 <emphasis>+hide-from{block}</emphasis>
2006 <emphasis>+hide-from{spam@sittingduck.xqq}</emphasis>
2015 Don't send the <quote>Referer:</quote> (sic) header to the web site. You
2016 can block it, forge a URL to the same server as the request (which is
2017 preferred because some sites will not send images otherwise) or set it to a
2018 constant string of your choice.
2024 <emphasis>+hide-referer{block}</emphasis>
2025 <emphasis>+hide-referer{forge}</emphasis>
2026 <emphasis>+hide-referer{http://nowhere.com}</emphasis>
2035 Alternative spelling of <quote>+hide-referer</quote>. It has the same
2036 parameters, and can be freely mixed with, <quote>+hide-referer</quote>.
2037 (<quote>referrer</quote> is the correct English spelling, however the HTTP
2038 specification has a bug - it requires it to be spelled <quote>referer</quote>.)
2044 <emphasis>+hide-referrer{...}</emphasis>
2053 Change the <quote>User-Agent:</quote> header so web servers can't tell your
2054 browser type. Warning! This breaks many web sites. Specify the
2055 user-agent value you want. Example, pretend to be using Netscape on
2062 <emphasis>+hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)}</emphasis>
2069 Or to identify yourself explicitly as a <quote>Junkbuster</quote> user:
2075 <emphasis>+hide-user-agent{JunkBuster/1.0}</emphasis>
2080 (Don't change the version number from 1.0 - after all, why tell them?)
2087 <emphasis>+hide-user-agent{browser-type}</emphasis>
2097 Treat this URL as an image. This only matters if it's also <quote>+block</quote>ed,
2098 in which case a <quote>blocked</quote> image can be sent rather than a HTML page.
2099 See <quote>+image-blocker{}</quote> below for the control over what is actually sent.
2105 <emphasis>+image</emphasis>
2114 Decides what to do with URLs that end up tagged with <quote>{+block
2115 +image}</quote>. There are 4 options. <quote>-image-blocker</quote> will
2116 send a HTML <quote>blocked</quote> page, usually resulting in a
2117 <quote>broken image</quote> icon. <quote>+image-blocker{logo}</quote> will
2118 send a <quote>JunkBuster</quote> image.
2119 <quote>+image-blocker{blank}</quote> will send a 1x1 transparent GIF image.
2120 And finally, <quote>+image-blocker{http://xyz.com}</quote> will send a HTTP
2121 temporary redirect to the specified image. This has the advantage of the
2122 icon being being cached by the browser, which will speed up the display.
2128 <emphasis>+image-blocker{logo}</emphasis>
2129 <emphasis>+image-blocker{blank}</emphasis>
2130 <emphasis>+image-blocker{http://i.j.b/send-banner}</emphasis>
2139 By default (i.e. in the absence of a <quote>+limit-connect</quote>
2140 action), <application>Junkbuster</application> will only allow CONNECT
2141 requests to port 443, which is the standard port for https as a
2146 The CONNECT methods exists in HTTP to allow access to secure websites
2147 (https:// URLs) through proxies. It works very simply: the proxy
2148 connects to the server on the specified port, and then short-circuits
2149 its connections to the client <emphasis>and</emphasis> to the remote proxy.
2150 This can be a big security hole, since CONNECT-enabled proxies can
2151 be abused as TCP relays very easily.
2155 If you want to allow CONNECT for more ports than this, or want to forbid
2156 CONNECT altogether, you can specify a comma separated list of ports and
2157 port ranges (the latter using dashes, with the minimum defaulting to 0 and
2165 <emphasis>+limit-connect{443} # This is the default and need no be specified.</emphasis>
2166 <emphasis>+limit-connect{80,443} # Ports 80 and 443 are OK.</emphasis>
2167 <emphasis>+limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100</emphasis>
2168 <emphasis> #and above 500 are OK.</emphasis>
2178 <quote>+no-compression</quote> prevents the website from compressing the
2179 data. Some websites do this, which can be a problem for
2180 <application>Junkbuster</application>, since <quote>+filter</quote>,
2181 <quote>+no-popup</quote> and <quote>+gif-deanimate</quote> will not work on
2182 compressed data. This will slow down connections to those websites,
2183 though. Default is <quote>nocompression</quote> is turned on.
2190 <emphasis>+nocompression</emphasis>
2199 Prevent the website from reading cookies:
2205 <emphasis>+no-cookies-read</emphasis>
2214 Prevent the website from setting cookies:
2220 <emphasis>+no-cookies-set</emphasis>
2229 Filter the website through a built-in filter to disable those obnoxious
2230 JavaScript pop-up windows via window.open(), etc. The two alternative
2231 spellings are equivalent.
2237 <emphasis>+no-popup</emphasis>
2238 <emphasis>+no-popups</emphasis>
2247 This action only applies if you are using a <filename>jarfile</filename>
2248 for saving cookies. It sends a cookie to every site stating that you do not
2249 accept any copyright on cookies sent to you, and asking them not to track
2250 you. Of course, this is a (relatively) unique header they could use to
2257 <emphasis>+vanilla-wafer</emphasis>
2266 This allows you to add an arbitrary cookie. It can be specified multiple
2267 times in order to add as many cookies as you like.
2273 <emphasis>+wafer{name=value}</emphasis>
2284 The meaning of any of the above is reversed by preceding the action with a
2285 <quote>-</quote>, in place of the <quote>+</quote>.
2293 Turn off cookies by default, then allow a few through for specified sites:
2300 # Turn off all cookies
2301 { +no-cookies-read }
2304 # Execeptions to the above, sites that need cookies
2305 { -no-cookies-read }
2313 # Alternative way of saying the same thing
2314 {-no-cookies-set -no-cookies-read}
2323 Now turn off <quote>fast redirects</quote>, and then we allow two exceptions:
2333 # Reverse it for these two sites, which don't work right without it.
2335 www.ukc.ac.uk/cgi-bin/wac\.cgi\?
2343 Turn on page filtering, with one exception for sourceforge:
2350 # Run everything through the default filter file (<filename>re_filterfile</filename>):
2353 # But please don't re_filter code from sourceforge!
2355 .cvs.sourceforge.net
2362 Now some URLs that we want <quote>blocked</quote>, ie we won't see them.
2363 Many of these use regular expressions that will expand to match multiple
2373 /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g))
2374 /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/])
2375 /.*/(ng)?adclient\.cgi
2376 /.*/(plain|live|rotate)[-_.]?ads?/
2377 /.*/(sponsor)s?[0-9]?/
2378 /.*/_?(plain|live)?ads?(-banners)?/
2380 /.*/ad(sdna_image|gifs?)/
2381 /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe)
2385 /.*/adv((er)?ts?|ertis(ing|ements?))?/
2389 /.*/cgi-bin/centralad/getimage
2390 /.*/images/addver\.gif
2391 /.*/images/marketing/.*\.(gif|jpe?g)
2395 /.*/sponsors?[0-9]?/
2396 /.*/advert[0-9]+\.jpg
2403 /graphics/defaultAd/
2405 /image\.ng/transactionID
2406 /images/.*/.*_anim\.gif # alvin brattli
2407 /ip_img/.*\.(gif|jpe?g)
2411 /cgi-bin/nph-adclick.exe/
2412 /.*/Image/BannerAdvertising/
2414 /.*/adlib/server\.cgi
2423 <!-- ~ End section ~ -->
2426 <!-- ~~~~~ New section ~~~~~ -->
2428 <title>Aliases</title>
2430 Custom <quote>actions</quote>, known to <application>Junkbuster</application>
2431 as <quote>aliases</quote>, can be defined by combing other <quote>actions</quote>.
2432 These can in turn be invoked just like the built-in <quote>actions</quote>.
2433 Currently, an alias can contain any character except space, tab, <quote>=</quote>,
2434 <quote>{</quote> or <quote>}</quote>. But please use only <quote>a</quote>-
2435 <quote>z</quote>, <quote>0</quote>-<quote>9</quote>, <quote>+</quote>, and
2436 <quote>-</quote>. Alias names are not case sensitive, and must be defined
2437 before they are used.
2441 Now let's define a few aliases:
2452 +no-cookies = +no-cookies-set +no-cookies-read
2453 -no-cookies = -no-cookies-set -no-cookies-read
2454 fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups
2455 shop = -no-cookies -filter -fast-redirects
2456 +imageblock = +block +image
2458 #For people who don't like to type too much: ;-)
2461 c2 = -no-cookies-set +no-cookies-read
2462 c3 = +no-cookies-set -no-cookies-read
2463 #... etc. Customize to your heart's content.
2470 Some examples using our <quote>shop</quote> and <quote>fragile</quote>
2478 # These sites are very complex and require
2479 # minimal interference.
2481 .office.microsoft.com
2482 .windowsupdate.microsoft.com
2484 # Shopping sites - still want to block ads.
2487 .worldpay.com # for quietpc.com
2491 # These shops require pop-ups
2503 <!-- ~ End section ~ -->
2506 <!-- ~~~~~ New section ~~~~~ -->
2507 <sect2 id="filterfile">
2508 <title>The Filter File</title>
2510 The filter file defines what filtering of web pages
2511 <application>Junkbuster</application> does. The default filter file is
2512 <filename>re_filterfile</filename>, located in the config directory. In this
2513 file, <emphasis>any document content</emphasis>, whether viewable text or
2514 embedded non-visible content, can be changed.
2518 This file uses regular expressions to alter or remove any string in the
2519 target page. Some examples from the included default <filename>re_filterfile</filename>:
2523 Stop web pages from displaying annoying messages in the status bar by
2524 deleting such references:
2531 # The status bar is for displaying link targets, not pointless buzzwords.
2532 # Again, check it out on http://www.airport-cgn.de/.
2533 s/status='.*?';*//ig
2540 Just for kicks, replace any occurrence of <quote>Microsoft</quote> with
2541 <quote>MicroSuck</quote>:
2548 s/microsoft(?!.com)/MicroSuck/ig
2555 Kill those auto-refresh tags:
2562 # Kill refresh tags. I like to refresh myself. Manually.
2563 # check it out on http://www.airport-cgn.de/ and go to the arrivals page.
2565 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i
2566 s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i
2576 <!-- ~~~~~ New section ~~~~~ -->
2577 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
2579 Install package, then run and enjoy! Be sure your browser is set to use
2580 the proxy which is by default at localhost, port 8000. With
2581 <application>Netscape</application> (and <application>Mozilla</application>),
2582 this can be set under <literal>Edit -> Preferences -> Advanced ->
2583 Proxies -> HTTP Proxy</literal>. For <application>Internet
2584 Explorer</application>: <literal>Internet Properties -> Connections ->
2585 LAN Setting</literal>. Then, check <quote>Use Proxy</quote> and fill in the
2586 appropriate info (Address: localhost, Port: 8000).
2590 The included default configuration files should give a reasonable starting
2591 point, though may be somewhat aggressive in blocking junk. You will probably
2592 want to keep an eye out for sites that require cookies, and add these to
2593 <filename>actionsfile</filename> as needed. By default, most of these will
2594 be blocked until you add them to the configuration. If you want the browser
2595 to handle this instead, you will need to edit
2596 <filename>actionsfile</filename> and disable this feature. If you use more
2597 than one browser, it would make more sense to let
2598 <application>Junkbuster</application> handle this. In which case, the
2599 browser(s) should be set to accept all cookies.
2603 HTTP/1.1 support is not fully implemented. If browsers that
2604 support HTTP/1.1 (like Mozilla or recent versions of I.E.) experience
2605 problems, you might try to force HTTP/1.0 compatiblity. For Mozilla, look under <literal>Edit ->
2606 Preferences -> Debug -> Networking</literal>. Or set the
2607 <quote>+downgrade</quote> config option in <filename>actionsfile</filename>.
2611 After running <application>Junkbuster</application> for a while, you can
2612 start to fine tune the configuration to suit your personal, or site,
2613 preferences and requirements. There are many, many aspects that can
2618 If you encounter problems, please verify it is a
2619 <application>Junkbuster</application> bug, by disabling
2620 <application>Junkbuster</application>, and then trying the same page.
2621 Also, try another browser if possible to eliminate browser or site
2622 problems. Before reporting it as a bug, see if there is not a configuration
2623 option that is enabled that is causing the page not to load. You can
2624 then add an exception for that page or site. If a bug, please report it to
2625 the developers (see below).
2631 <!-- ~~~~~ New section ~~~~~ -->
2632 <sect1 id="contact"><title>Contact the Developers</title>
2635 To be filled. mention the support forums as the primary channel of
2636 communication (bugs, feature requests, etc.)
2638 Feature requests and other questions should be posted to the <ulink
2639 url="http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse">Feature
2640 request page</ulink> at SourceForge. There is also an archive there.
2644 Anyone interested in actively participating in development and related
2645 discussions can join the appropriate mailing list
2646 <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
2647 Archives are available here too.
2651 Please report bugs, using the form at
2652 <ulink url="http://sourceforge.net/tracker/?group_id=11118&atid=111118">Sourceforge</ulink>.
2653 Please try to verify that it is a <application>Junkbuster</application> bug,
2654 and not a browser or site bug first. Also, check to make sure this is not
2655 already a known bug.
2661 <!-- ~~~~~ New section ~~~~~ -->
2662 <sect1 id="copyright"><title>Copyright and History</title>
2665 <title>License</title>
2667 <application>Internet Junkbuster</application> is free software; you can
2668 redistribute it and/or modify it under the terms of the GNU General Public
2669 License as published by the Free Software Foundation; either version 2 of the
2670 License, or (at your option) any later version.
2674 This program is distributed in the hope that it will be useful, but WITHOUT
2675 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
2676 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
2677 details, which is available from <ulink
2678 url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
2679 Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2684 <!-- ~ End section ~ -->
2687 <!-- ~~~~~ New section ~~~~~ -->
2690 <title>History</title>
2692 <application>Junkbuster</application> was originally written by Anonymous
2694 url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
2695 Corporation</ulink>, and was released as free open-source software under the
2696 GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
2697 Waldherr</ulink> made many improvements, and started the <ulink
2698 url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
2699 rekindle development. The last stable release was v2.0.2, which has now
2707 <!-- ~~~~~ New section ~~~~~ -->
2708 <sect1 id="seealso"><title>See also</title>
2709 <para>To be filled. What should go here :/
2715 <!-- ~~~~~ New section ~~~~~ -->
2716 <sect1 id="appendix"><title>Appendix</title>
2719 <!-- ~~~~~ New section ~~~~~ -->
2721 <title>Regular Expressions</title>
2723 <application>Junkbuster</application> can use <quote>regular expressions</quote>
2724 in various config files. Assuming support for <quote>pcre</quote> (Perl
2725 Compatible Regular Expressions) is compiled in, which is the default. Such
2726 configuration directives do not require regular expressions, but they can be
2727 used to increase flexibility by matching a pattern with wildcards against
2732 If you are reading this, you probably don't understand what <quote>regular
2733 expressions</quote> are, or what they can do. So this will be a very brief
2734 introduction only. A full explanation would require a book ;-)
2738 <quote>Regular expressions</quote> is a way of matching one character
2739 expression against another to see if it matches or not. One of the
2740 <quote>expressions</quote> is a literal string of readable characters
2741 (letter, numbers, etc), and the other is a complex string of literal
2742 characters combined with wildcards, and other special characters, called
2743 metacharacters. The <quote>metacharacters</quote> have special meanings and
2744 are used to build the complex pattern to be matched against. Perl Compatible
2745 Regular Expressions is an enhanced form of the regular expression language
2746 with backward compatibility.
2750 To make a simple analogy, we do something similar when we use wildcard
2751 characters when listing files with the <command>dir</command> command in DOS.
2752 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
2753 character here is the asterik which matches any and all characters. We can be
2754 more specific and use <literal>?</literal> to match just individual
2755 characters. So <quote>dir file?.text</quote> would match
2756 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
2757 matching, using a similar technique to <quote>regular expressions</quote>!
2761 Regular expressions do essentially the same thing, but are much, much more
2762 powerful. There are many more <quote>special characters</quote> and ways of
2763 building complex patterns however. Let's look at a few of the common ones,
2764 and then some examples:
2769 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
2770 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
2776 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
2783 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
2790 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
2797 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
2798 the following character should be taken literally. This is used where one of the
2799 special characters (e.g. <quote>.</quote>) needs to be taken literally and
2800 not as a special metacharacter.
2806 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
2807 any of the enclosed characters are encountered.
2813 <emphasis>()</emphasis> - Pararentheses are used to group a sub-expression,
2814 or multiple sub-expressions.
2820 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
2821 <quote>or</quote> conditional statement. A match is successful if the
2822 sub-expression on either side of <quote>|</quote> matches.
2828 <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text.
2829 <quote>string1</quote> is replaced by <quote>string2</quote> in this
2835 These are just some of the ones you are likely to use when matching URLs with
2836 <application>Junkbuster</application>, and is a long way from a definitive
2837 list. This is enough to get us started with a few simple examples which may
2838 be more illuminating:
2842 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
2843 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
2844 denote any character, zero or more times. In other words, any string at all.
2845 So we start with a literal forward slash, then our regular expression pattern
2846 (<quote>.*</quote>) another literal forward slash, the string
2847 <quote>banners</quote>, another forward slash, and lastly another
2848 <quote>.*</quote>. We are building
2849 a directory path here. This will match any file with the path that has a
2850 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
2851 any characters, and this could conceivably be more forward slashes, so it
2852 might expand into a much longer looking path. For example, this could match:
2853 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
2854 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
2855 possible combinations, just so it has <quote>banners</quote> in the path
2860 A now something a little more complex:
2864 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
2865 We have several literal forward slashes again (<quote>/</quote>), so we are
2866 building another expression that is a file path statement. We have another
2867 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
2868 it matches our expression. The only true literal that <emphasis>must
2869 match</emphasis> our pattern is <application>adv</application>, together with
2870 the forward slashes. What comes after the <quote>adv</quote> string is the
2875 Remember the <quote>?</quote> means the preceding expression (either a
2876 literal character or anything grouped with <quote>(...)</quote> in this case)
2877 can exist or not, since this means either zero or one match. So
2878 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
2879 individual sub-expressions: <quote>(er)</quote>,
2880 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
2881 means <quote>or</quote>. We have two of those. For instance,
2882 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
2883 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
2884 attempt at matching as many variations of <quote>advertisement</quote>, and
2885 similar, as possible. So this would expand to match just <quote>adv</quote>,
2886 or <quote>advert</quote>, or <quote>adverts</quote>, or
2887 <quote>advertising</quote>, or <quote>advertisement</quote>, or
2888 <quote>advertisements</quote>. You get the idea. But it would not match
2889 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
2890 changing our regular expression to:
2891 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
2896 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
2897 another path statement with forward slashes. Anything in the square brackets
2898 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
2899 shorthand expression to mean any digit one through nine. It is the same as
2900 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
2901 means one or more of the preceding expression must be included. The preceding
2902 expression here is what is in the square brackets -- in this case, any digit
2903 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
2904 This includes a <quote>|</quote>, so this needs to match the expression on
2905 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
2906 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
2907 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
2908 can be matched once or not at all. So we are building an expression here to
2909 match image GIF or JPEG type image file. It must include the literal
2910 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
2911 (which is now a literal, and not a special character, since it is escaped
2912 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
2913 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
2914 include: <quote>//advert1.jpg</quote>,
2915 <quote>/nasty/ads/advert1234.gif</quote>,
2916 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
2917 <quote>advert1.gif</quote> (no leading slash), or
2918 <quote>/adverts232.jpg</quote> (the expression does not include an
2919 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
2920 in the expression anywhere).
2924 <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is
2925 a substitution. <quote>MicroSuck</quote> will replace any occurence of
2926 <quote>microsoft</quote>. The <quote>i</quote> at the end of the expression
2927 means ignore case. The <quote>(?!.com)</quote> means
2928 the match should fail if <quote>microsoft</quote> is followed by
2929 <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
2930 modifier. In case this is a hyperlink, we don't want to break it ;-).
2934 We are barely scratching the surface of regular expressions here so that you
2935 can understand the default <application>Junkbuster</application>
2936 configuration files, and maybe use this knowledge to customize your own
2937 installation. There is much, much more that can be done with regular
2938 expressions. Now that you know enough to get started, you can learn more on
2943 More reading on Perl Compatible Regular expressions:
2944 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
2953 This program is free software; you can redistribute it
2954 and/or modify it under the terms of the GNU General
2955 Public License as published by the Free Software
2956 Foundation; either version 2 of the License, or (at
2957 your option) any later version.
2959 This program is distributed in the hope that it will
2960 be useful, but WITHOUT ANY WARRANTY; without even the
2961 implied warranty of MERCHANTABILITY or FITNESS FOR A
2962 PARTICULAR PURPOSE. See the GNU General Public
2963 License for more details.
2965 The GNU General Public License should be included with
2966 this file. If not, you can view it at
2967 http://www.gnu.org/copyleft/gpl.html
2968 or write to the Free Software Foundation, Inc., 59
2969 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
2971 $Log: user-manual.sgml,v $
2972 Revision 1.13 2001/10/10 17:28:33 hal9
2975 Revision 1.12 2001/09/28 02:57:04 hal9
2978 Revision 1.11 2001/09/28 02:25:20 hal9
2981 Revision 1.9 2001/09/27 23:50:29 hal9
2982 A few changes. A short section on regular expression in appendix.
2984 Revision 1.8 2001/09/25 00:34:59 hal9
2985 Some additions, and re-arranging.
2987 Revision 1.7 2001/09/24 14:31:36 hal9
2990 Revision 1.6 2001/09/24 14:10:32 hal9
2991 Including David's OS/2 installation instructions.
2993 Revision 1.2 2001/09/13 15:27:40 swa
2996 Revision 1.1 2001/09/12 15:36:41 swa
2997 source files for junkbuster documentation
2999 Revision 1.3 2001/09/10 17:43:59 swa
3000 first proposal of a structure.
3002 Revision 1.2 2001/06/13 14:28:31 swa
3003 docs should have an author.
3005 Revision 1.1 2001/06/13 14:20:37 swa
3006 first import of project's documentation for the webserver.