X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=5b62f379c9e97174f3dced254781d7bd5242f127;hp=da10618b8c8e00ff30bae389eaa14ba44f77a7a3;hb=0c0171d3f0339ee3075ae384a58613ca88334460;hpb=05dfb69d1ff3a6e1aad8887f645a24268a9bb6b4 diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index da10618b..5b62f379 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -1,13 +1,12 @@ - + @@ -30,7 +28,7 @@ Hal Burgiss Junkbuster User Manual -$Id: user-manual.sgml,v 1.4 2001/09/24 01:27:56 hal9 Exp $ +$Id: user-manual.sgml,v 1.46 2002/03/10 00:51:08 hal9 Exp $ @@ -42,18 +40,23 @@ Hal Burgiss - The user manual gives the users information on how to install and configure + The user manual gives users information on how to install, configure and use Internet Junkbuster. Internet - Junkbuster is an application that provides privacy and - security to users of the World Wide Web. + Junkbuster is a web proxy with advanced filtering capabilities + for protecting privacy, filtering web page content, managing cookies, + controlling access, and removing ads, banners, pop-ups and other obnoxious + Internet Junk. Junkbuster has a very flexible configuration and can be + customized to suit individual needs and tastes. Internet + Junkbuster has application for both stand-alone systems and + multi-user networks. -You can find the latest version of the user manual at http://ijbswa.sourceforge.net/doc/user-manual/. +You can find the latest version of the user manual at http://ijbswa.sourceforge.net/user-manual/. - - Feel free to send a note to the developers at ijbswa-developers@lists.sourceforge.net. - + + + @@ -64,64 +67,140 @@ You can find the latest version of the user manual at Introduction Internet Junkbuster is a web proxy with advanced - filtering capabilities for protecting privacy, filtering web page content, - managing cookies and removing ads, banners, pop-ups and other obnoxious - Internet Junk. Junkbuster has a very flexible - configuration and can be customized to suit individual needs and tastes. - Internet Junkbuster has application for both - stand-alone systems and multi-user networks. + filtering capabilities for protecting privacy, filtering and modifying web + page content, managing cookies, controlling access, and removing ads, + banners, pop-ups and other obnoxious Internet Junk. + Junkbuster has a very flexible configuration and + can be customized to suit individual needs and tastes. Internet + Junkbuster has application for both stand-alone systems and + multi-user networks. - This documentation is included with the current development version of - Internet Junkbuster and is incomplete at this + This documentation is included with the current BETA version of + Internet Junkbuster and is mostly complete at this point. The most up to date reference for the time being is still the comments in the source files and in the individual configuration files. Development - of version 3.0 is currently underway, and includes significant changes and - enhancements over earlier verions. + of version 3.0 is currently nearing completion, and includes many significant + changes and enhancements over earlier versions. The target release date for + stable v3.0 is soon ;-) - Since this is a development version, there are bugs! + Since this is a BETA version, not all new features are well tested. This + documentation may be slightly out of sync as a result (especially with + CVS sources). And there may be bugs, though hopefully + not many! - + -License +New Features - Internet Junkbuster is free software; you can - redistribute it and/or modify it under the terms of the GNU General Public - License as published by the Free Software Foundation; either version 2 of the - License, or (at your option) any later version. + In addition to Junkbuster's traditional features + of ad and banner blocking and cookie management, this is a list of new + features currently under development: - This program is distributed in the hope that it will be useful, but WITHOUT - ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS - FOR A PARTICULAR PURPOSE. See the GNU General Public License for more - details, which is available from the Free Software Foundation, - Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. - + - + + + Integrated browser based configuration and control utility (http://i.j.b). Browser-based tracing of rule + and filter effects. + + - + + + Modularized configuration that will allow for system wide settings, and + individual user settings. (not implemented yet, probably a 3.1 feature) + + + + + Blocking of annoying pop-up browser windows. + + - + + + HTTP/1.1 compliant (most, but not all 1.1 features are supported). + + - -History - - Junkbuster was originally written by JunkBusters - Corporation, and was released as free open-source software under the - GNU GPL. Stefan - Waldherr made many improvements, and started the SourceForge project to - rekindle development. + + + Support for Perl Compatible Regular Expressions in the configuration files, and + generally a more sophisticated and flexible configuration syntax over + previous versions. + + + + + + GIF de-animation. + + + + + + Web page content filtering (removes banners based on size, + invisible web-bugs, JavaScript, pop-ups, status bar abuse, + etc.) + + + + + + Bypass many click-tracking scripts (avoids script redirection). + + + + + + + Multi-threaded (POSIX and native threads). + + + + + + Auto-detection and re-reading of config file changes. + + + + + + User-customizable HTML templates (e.g. 404 error page). + + + + + + Improved cookie management features (e.g. session based cookies). + + + + + + Builds from source on most UNIX-like systems. Packages available for: Linux + (RedHat, SuSE, or Debian), Windows, Sun Solaris, Mac OSX, OS/2, HP-UX 11 and AmigaOS. + + + + + + + In addition, the configuration is much more powerful and versatile over-all. + + + + @@ -137,10 +216,11 @@ You can find the latest version of the user manual at Junkbuster Home Page - for current releases. Junkbuster is also available - via Junkbuster + is also available via CVS. - This is the recommended approach at this time. + This is the recommended approach at this time. But please be aware that CVS + is constantly changing, and it may break in mysterious ways. @@ -151,8 +231,8 @@ You can find the latest version of the user manual at - Then, in either case, to build from source: + Then, in either case, to build from tarball/CVS source: - ./configure - make - su - make install + ./configure (--help to see options) + make (the make from gnu, gmake for *BSD) + su + make -n install (to see where all the files will go) + make install (to really install) @@ -202,6 +283,8 @@ You can find the latest version of the user manual at -    /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm +    /usr/src/redhat/RPMS/i686/junkbuster-2.9.11-1.i686.rpm -    /usr/src/redhat/SRPMS/junkbuster-2.9.8-1.src.rpm +    /usr/src/redhat/SRPMS/junkbuster-2.9.11-1.src.rpm @@ -224,7 +307,7 @@ You can find the latest version of the user manual at + autoheader [suggested for CVS source] + autoconf [suggested for CVS source] ./configure make suse-dist @@ -254,10 +339,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/suse/RPMS/i686/junkbuster-2.9.8-1.i686.rpm + rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.11-1.i686.rpm @@ -279,17 +364,86 @@ You can find the latest version of the user manual at OS/2 + + + + + Junkbuster is packaged in a WarpIN self- + installing archive. The self-installing program will be named depending + on the release version, something like: + ijbos2_setup_1.2.3.exe. In order to install it, simply + run this executable or double-click on its icon and follow the WarpIN + installation panels. A shadow of the Junkbuster + executable will be placed in your startup folder so it will start + automatically whenever OS/2 starts. + + + + The directory you choose to install Junkbuster + into will contain all of the configuration files. + + + + If you would like to build binary images on OS/2 yourself, you will need + a few Unix-like tools: autoconf, autoheader and sh. These tools will be + used to create the required config.h file, which is not part of the + source distribution because it differs based on platform. You will also + need a compiler. + The distribution has been created using IBM VisualAge compilers, but you + can use any compiler you like. GCC/EMX has the disadvantage of needing + to be single-threaded due to a limitation of EMX's implementation of the + select() socket call. + + + + In addition to needing the source code distribution as outlined earlier, + you will want to extract the os2seutp directory from CVS: + + cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login + cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup + + This will create a directory named os2setup/, which will contain the + Makefile.vac makefile and os2build.cmd + which is used to completely create the binary distribution. The sequence + of events for building the executable for yourself goes something like this: + + cd current + autoheader + autoconf + sh configure + cd ..\os2setup + nmake -f Makefile.vac + + You will see this sequence laid out in os2build.cmd. + + + + + Windows -I need help on this. Not a clue here. Also for -configuration section below. +Click-click. (I need help on this. Not a clue here. Also for +configuration section below. HB.) Other -I need help on this too. OS/2? What others? + + Some quick notes on other Operating Systems. + + + For FreeBSD (and other *BSDs?), the build will require gmake + instead of the included make. gmake is + available from http://www.gnu.org. + The rest should be the same as above for Linux/Unix. + + @@ -298,19 +452,87 @@ configuration section below. -Junkbuster Configuration +JunkBuster Configuration + + All JunkBuster configuration is kept + in text files. These files can be edited with a text editor. + Many important aspects of JunkBuster can + also be controlled easily with a web browser. + + + + + + + +Controlling Junkbuster with Your Web Browser + + JunkBuster can be reached by the special + URL http://i.j.b/ (or alternately + http://ijbswa.sourceforge.net/config/, + which is an internal page. You will see the following section: + + + + + + +Please choose from the following options: + + * Show information about the current configuration + * Show the source code version numbers + * Show the client's request headers. + * Show which actions apply to a URL and why + * Toggle JunkBuster on or off + * Edit the actions list + + + + + + This should be self-explanatory. Note the last item is an editor for the + actions list, which is where much of the ad, banner, cookie, + and URL blocking magic is configured as well as other advanced features of + Junkbuster. This is an easy way to adjust various + aspects of Junkbuster configuration. The actions + file, and other configuration files, are explained in detail below. + Junkbuster will automatically detect any changes + to these files. + + + + Toggle JunkBuster On or Off is handy for sites that might + have problems with your current actions and filters, or just to test if + a site misbehaves, whether it is JunkBuster + causing the problem or not. Junkbuster continues + to run as a proxy in this case, but all filtering is disabled. + + + + + + + + + + + + + +Configuration Files Overview - For Unix and Linux, all configuraton files are located in - /etc/junkbuster/ by default. For MS Windows and OS/2, - these are all in the same directory as the Junkbuster - executable. The name and number of configuration files has changed from - previous versions, and is subject to change as development progresses. + For Unix, *BSD and Linux, all configuration files are located in + /etc/junkbuster/ by default. For MS Windows, OS/2, and + AmigaOS these are all in the same directory as the + Junkbuster executable. The name and number of + configuration files has changed from previous versions, and is subject to + change as development progresses. - The installed defaults provide a reasonable starting point. For the - time being, there are only three default configuration files (this will - change in time): + The installed defaults provide a reasonable starting point, though possibly + aggressive by some standards. For the time being, there are only three + default configuration files (this will change in time): @@ -319,14 +541,20 @@ configuration section below. The main configuration file is named config - on Linux, Unix and OS/2, and junkbustr.txt on Windows. + on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt + on Windows. - The actionsfile file is used to define various - actions relating to images, banners, pop-ups, banners and cookies. + The ijb.action file is used to define various + actions relating to images, banners, pop-ups, access + restrictions, banners and cookies. There is a CGI based editor for this + file that can be accessed via http://i.j.b. (Other actions + files are included as well with differing levels of filtering + and blocking, e.g. ijb-basic.action.) @@ -341,13 +569,23 @@ configuration section below. - actionsfile and re_filterfile + ijb.action and re_filterfile can use Perl style regular expressions for maximum flexibility. All files use the # character to denote a comment. Such lines are not processed by Junkbuster. After - making any changes, restart Junkbuster in order - for the changes to take effect. + making any changes, there is no need to restart + Junkbuster in order for the changes to take + effect. Junkbuster should detect such changes + automatically. + + + + While under development, the configuration content is subject to change. + The below documentation may not be accurate by the time you read this. + Also, what constitutes a default setting, may change, so + please check all your configuration files on important issues. + @@ -356,7 +594,7 @@ configuration section below. The Main Configuration File Again, the main configuration file is named config on - Linux, Unix and OS/2, and junkbustr.txt on Windows. + Linux/Unix/BSD and OS/2, and config.txt on Windows. 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: @@ -364,11 +602,11 @@ configuration section below. - + blockfile blocklist.ini - + @@ -377,7 +615,7 @@ configuration section below. - The # indicates a comment. Any part of a + A # indicates a comment. Any part of a line following a # is ignored, except if the # is preceded by a \. @@ -401,7 +639,7 @@ configuration section below. There are various aspects of Junkbuster behavior - that can be adjusted. + that can be tuned. @@ -418,15 +656,16 @@ configuration section below. - On Windows, Junkbuster - looks for these files in the same directory as the executable. On Unix and OS/2, + On Windows and AmigaOS, + Junkbuster looks for these files in the same + directory as the executable. On Unix and OS/2, Junkbuster looks for these files in the current - working directory. In either case, an absolute path name can be used to + working directory. In either case, an absolute path name can be used to avoid problems. - When development goes modular and multiuser, the blocker, filter, and + When development goes modular and multi-user, the blocker, filter, and per-user config will be stored in subdirectories of confdir. For now, only confdir/templates is used for storing HTML templates for CGI results. @@ -438,11 +677,11 @@ configuration section below. - + confdir /etc/junkbuster # No trailing /, please. - + @@ -454,11 +693,11 @@ configuration section below. - + logdir /var/log/junkbuster - + @@ -468,41 +707,52 @@ configuration section below. - The actionsfile contains patterns to specify the actions to + The ijb.action file contains patterns to specify the actions to apply to requests for each site. Default: Cookies to and from all - destinations are filtered. Popups are disabled for all sites. All sites are - filtered if re_filterfile specified. No sites are blocked. An empty image is - displayed for filtered ads and other images (formerly - tinygif). The syntax of this file is explained in detail - below. + destinations are kept only during the current browser session (i.e. they + are not saved to disk). Pop-ups are disabled for all sites. All sites are + filtered if re_filterfile specified according to the + contents of re_filterfile. No sites are blocked. The + JunkBuster logo is displayed for filtered ads and other images . The syntax + of this file is explained in detail below. - + - actionsfile actionsfile + actionsfile ijb.action - + The re_filterfile file contains content modification rules. These rules permit powerful changes on the content of Web pages, e.g., you - could disable your favourite JavaScript annoyances, rewrite the actual + could disable your favorite JavaScript annoyances, rewrite the actual content, or just have some fun replacing Microsoft with MicroSuck wherever it appears on a Web page. Default: No content modification, or whatever the developers are playing with :-/ + + Filtering requires buffering the page content, which may appear to slow down + page rendering since nothing is displayed until all content has passed + the filters. (It does not really take longer, but seems that way since + the page is not incrementally displayed.) This effect will be more noticeable + on slower connections. + + + - + re_filterfile re_filterfile - + @@ -534,11 +784,11 @@ configuration section below. - + logfile logfile - + @@ -551,11 +801,11 @@ configuration section below. - + #jarfile jarfile - + @@ -566,22 +816,22 @@ configuration section below. with the effect that access to untrusted sites will be granted, if a link from a trusted referrer was used. The link target will then be added to the trustfile. This is a very restrictive feature that typical - users most propably want to leave disabled. Default: Disabled, don't use the + users most probably want to leave disabled. Default: Disabled, don't use the trust mechanism. - + #trustfile trust - + - If you use the trust mechanism, it is a good idea to write up some online + If you use the trust mechanism, it is a good idea to write up some on-line documentation about your blocking policy and to specify the URL(s) here. They will appear on the page that your users receive when they try to access untrusted content. Use multiple times for multiple URLs. Default: Don't @@ -590,12 +840,12 @@ configuration section below. - + trust-info-url http://www.your-site.com/why_we_block.html trust-info-url http://www.your-site.com/what_we_allow.html - + @@ -623,11 +873,11 @@ configuration section below. - + #admin-address fill@me.in.please - + @@ -637,37 +887,37 @@ configuration section below. configuration and policies. It is used in many of the proxy-generated pages and its use is highly recommended in multi-user installations, since your users will want to know why certain content is blocked or modified. Default: - Don't show a link to online documentation. + Don't show a link to on-line documentation. - + proxy-info-url http://www.your-site.com/proxy.html - + Listen-address specifies the address and port where Junkbuster will listen for connections from your - Web browser. The default is to listen on the localhost port 8000, and + Web browser. The default is to listen on the localhost port 8118, and this is suitable for most users. (In your web browser, under proxy configuration, list the proxy server as localhost and the - port as 8000). + port as 8118). - If you already have another service running on port 8000, or if you want to + 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. The syntax is listen-address [<ip-address>]:<port>. If you leave - out the IP adress, junkbuster will bind to all + out the IP address, junkbuster will bind to all interfaces (addresses) on your machine and may become reachable from the - internet. In that case, consider using access control lists (acl's) (see - aclfile above). + Internet. In that case, consider using access control lists (acl's) (see + aclfile above), or a firewall. @@ -679,11 +929,11 @@ configuration section below. - + - listen-address 192.168.0.1:8000 + listen-address 192.168.0.1:8118 - + @@ -694,18 +944,18 @@ configuration section below. - + - listen-address :8000 + listen-address :8118 - + If you do this, consider using ACLs (see aclfile above). Note: you will need to point your browser(s) to the address and port that you have - configured here. Default: localhost:8000 (127.0.0.1:8000). + configured here. Default: localhost:8118 (127.0.0.1:8118). @@ -715,10 +965,10 @@ configuration section below. levels of debug are probably only of interest to developers. - - - - + + + + debug 1 # GPC = show each GET/POST/CONNECT request debug 2 # CONN = show each connection status debug 4 # IO = show I/O status @@ -727,15 +977,15 @@ configuration section below. debug 32 # FRC = debug force feature debug 64 # REF = debug regular expression filter debug 128 # = debug fast redirects - debug 256 # = debug GIF deanimation + debug 256 # = debug GIF de-animation debug 512 # CLF = Common Log Format - debug 1024 # = debug kill popups + debug 1024 # = debug kill pop-ups debug 4096 # INFO = Startup banner and warnings. debug 8192 # ERROR = Non-fatal errors - - - - + + + + It is highly recommended that you enable ERROR @@ -759,11 +1009,11 @@ configuration section below. - + debug 15 # same as setting the first 4 listed above - + @@ -773,13 +1023,13 @@ configuration section below. - + debug 1 # URLs debug 4096 # Info debug 8192 # Errors - *we highly recommended enabling this* - + @@ -795,11 +1045,11 @@ configuration section below. - + #single-threaded - + @@ -811,29 +1061,109 @@ configuration section below. The Windows version of Junkbuster puts an icon in - the system tray, which allows you to change this option without having to - edit this file. If you right-click on that icon (or select the - Options menu), one choice is Enable. Clicking - on enable toggles Junkbuster on and off. This is - useful if you want to temporarily disable - Junkbuster, e.g., to access a site that requires - cookies which you normally have blocked. + the system tray, which also allows you to change this option. If you + right-click on that icon (or select the Options menu), one + choice is Enable. Clicking on enable toggles + Junkbuster on and off. This is useful if you want + to temporarily disable Junkbuster, e.g., to access + a site that requires cookies which you would otherwise have blocked. This can also + be toggled via a web browser at the Junkbuster + internal address of http://i.j.b on + any platform. toggle 1 means Junkbuster runs normally, toggle 0 means that Junkbuster becomes a non-anonymizing non-blocking - proxy. Default: 1. + proxy. Default: 1 (on). - + toggle 1 - + + + + + + For content filtering, i.e. the +filter and + +deanimate-gif actions, it is necessary that + Junkbuster 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. + + + + The buffer-limit option lets you set the maximum + size in Kbytes that each buffer may use. When the documents buffer exceeds + this size, it is flushed to the client unfiltered and no further attempt to + filter the rest of it is made. Remember that there may multiple threads + running, which might require increasing the buffer-limit + Kbytes each, unless you have enabled + single-threaded above. + + + + + + + buffer-limit 4069 + + + + + + + To enable the web-based ijb.action file editor set + enable-edit-actions to 1, or 0 to disable. Note + that you must have compiled JunkBuster with + support for this feature, otherwise this option has no effect. This + internal page can be reached at http://i.j.b. + + + + Security note: If this is enabled, anyone who can use the proxy + can edit the actions file, and their changes will affect all users. + For shared proxies, you probably want to disable this. Default: enabled. + + + + + + + enable-edit-actions 1 + + + + + + + Allow JunkBuster to be toggled on and off + remotely, using your web browser. Set enable-remote-toggleto + 1 to enable, and 0 to disable. Note that you must have compiled + JunkBuster with support for this feature, + otherwise this option has no effect. + + + + Security note: If this is enabled, anyone who can use the proxy can toggle + it on or off (see http://i.j.b), and + their changes will affect all users. For shared proxies, you probably want to + disable this. Default: enabled. + + + + + + + enable-remote-toggle 1 + + @@ -887,11 +1217,11 @@ configuration section below. - + ACTION SRC_ADDR[/SRC_MASKLEN] [ DST_ADDR[/DST_MASKLEN] ] - + @@ -901,7 +1231,7 @@ configuration section below. - + ACTION = permit-access or deny-access @@ -911,7 +1241,7 @@ configuration section below. DST_ADDR = server or forwarder hostname or dotted IP address DST_MASKLEN = number of bits in the subnet mask for the target - + @@ -941,11 +1271,11 @@ configuration section below. - + permit-access localhost - + @@ -956,11 +1286,11 @@ configuration section below. - + permit-access www.junkbusters.com/24 - + @@ -970,11 +1300,11 @@ configuration section below. - + deny-access ident.junkbusters.com - + @@ -985,11 +1315,11 @@ configuration section below. - + permit-access 207.153.200.0/24 - + @@ -999,11 +1329,11 @@ configuration section below. - + permit-access 0.0.0.0/0 - + @@ -1013,11 +1343,11 @@ configuration section below. - + permit-access .org - + @@ -1035,7 +1365,7 @@ configuration section below. - + permit-access 0.0.0.0/0 0.0.0.0/0 # other clients can go anywhere # with the following exceptions: @@ -1049,7 +1379,7 @@ configuration section below. permit 123.124.0.0/16 0.0.0.0/0 # the ISP's clients can go # anywhere - + @@ -1070,10 +1400,11 @@ configuration section below. Forwarding - This feature allows routing of HTTP requests via multiple proxies. + This feature allows chaining of HTTP requests via multiple proxies. It can be used to better protect privacy and confidentiality when accessing specific domains by routing requests to those domains - to a special purpose filtering proxy such as lpwa.com. + to a special purpose filtering proxy such as lpwa.com. Or to use + a caching proxy to speed up browsing. @@ -1094,13 +1425,13 @@ configuration section below. - + forward target_domain[:port] http_proxy_host[:port] forward-socks4 target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port] forward-socks4a target_domain[:port] socks_proxy_host[:port] http_proxy_host[:port] - + @@ -1121,11 +1452,11 @@ configuration section below. - + forward .* . # implicit - + @@ -1136,12 +1467,12 @@ configuration section below. - + forward .* lpwa.com:8000 forward :443 . - + @@ -1154,16 +1485,16 @@ configuration section below. - + forward lpwa. lpwa.com:8000 - + - (NOTE: the syntax for specifiying target_domain has changed since the + (NOTE: the syntax for specifying target_domain has changed since the previous paragraph was written -- it will not work now. More information is welcome.) @@ -1175,12 +1506,12 @@ configuration section below. - + forward .* caching.myisp.net:8000 forward myisp.net . - + @@ -1191,17 +1522,17 @@ configuration section below. - + forward .* proxy:8080 - + - Also, we're told they insist on getting cookies and JavaScript, so you need - to add home.com to the cookie file. We consider JavaScript a security risk. + Also, we're told they insist on getting cookies and JavaScript, so you should + add home.com to the cookie file. We consider JavaScript a security risk. Java need not be enabled. @@ -1213,12 +1544,12 @@ configuration section below. - + - forward_socks4 .* lpwa.com:8000 firewall.my_company.com:1080 + forward-socks4 .* lpwa.com:8000 firewall.my_company.com:1080 forward my_company.com . - + @@ -1228,11 +1559,11 @@ configuration section below. - + - forward_socks4a .* . firewall.my_company.com:1080 + forward-socks4a .* . firewall.my_company.com:1080 - + @@ -1260,12 +1591,12 @@ configuration section below. - + forward .* . - forward isp-b.com host-b:8000 + forward isp-b.com host-b:8118 - + @@ -1276,12 +1607,12 @@ configuration section below. - + forward .* . - forward isp-a.com host-a:8000 + forward isp-a.com host-a:8118 - + @@ -1299,7 +1630,7 @@ configuration section below. - + forward *. ssbcache.ukc.ac.uk:3128 # Use the proxy, except for: forward .ukc.ac.uk . # Anything on the same domain as us @@ -1309,7 +1640,7 @@ configuration section below. forward localhost.localdomain . # Loopback address forward www.ukc.mirror.ac.uk . # Specific host - + @@ -1325,11 +1656,14 @@ configuration section below. - + # Define junkbuster as parent cache - cache_peer 127.0.0.1 8000 parent 0 no-query - + + cache_peer 127.0.0.1 parent 8118 0 no-query + # Define ACL for protocol FTP acl FTP proto FTP @@ -1342,7 +1676,7 @@ configuration section below. # Forward the rest to junkbuster never_direct allow all - + @@ -1371,11 +1705,11 @@ Removed references to Win32. HB 09/23/01 - + activity-animation 1 - + @@ -1387,11 +1721,11 @@ Removed references to Win32. HB 09/23/01 - + log-messages 1 - + @@ -1408,11 +1742,11 @@ Removed references to Win32. HB 09/23/01 - + log-buffer-size 1 - + @@ -1423,11 +1757,11 @@ Removed references to Win32. HB 09/23/01 - + log-max-lines 200 - + @@ -1439,11 +1773,11 @@ Removed references to Win32. HB 09/23/01 - + log-highlight-messages 1 - + @@ -1453,11 +1787,11 @@ Removed references to Win32. HB 09/23/01 - + log-font-name Comic Sans MS - + @@ -1467,11 +1801,11 @@ Removed references to Win32. HB 09/23/01 - + log-font-size 8 - + @@ -1483,11 +1817,11 @@ Removed references to Win32. HB 09/23/01 - + show-on-task-bar 0 - + @@ -1499,11 +1833,11 @@ Removed references to Win32. HB 09/23/01 - + close-button-minimizes 1 - + @@ -1516,11 +1850,11 @@ Removed references to Win32. HB 09/23/01 - + #hide-console - + @@ -1535,12 +1869,16 @@ Removed references to Win32. HB 09/23/01 The Actions File - The actionsfile is used to define what actions + The ijb.action file (formerly + actionsfile) is used to define what actions Junkbuster takes, and thus determines how images, cookies and various other aspects of HTTP content and transactions are handled. Images can be anything you want, including ads, banners, or just some obnoxious image that you would rather not see. Cookies can be accepted - or rejected. The default file is in fact named actionsfile. + or rejected, or accepted only during the current browser session (i.e. + not written to disk). Changes to ijb.action should + be immediately visible to Junkbuster without + the need to restart. @@ -1551,10 +1889,18 @@ Removed references to Win32. HB 09/23/01 url="http://i.j.b/show-url-info">http://i.j.b/show-url-info. + + The actions file can be edited with a browser by loading + http://i.j.b/, and then select + Edit Actions. + + There are four types of lines in this file: comments (begin with a # character), actions, aliases and patterns, all of which are - explained below. + explained below, as well as the configuration file syntax that + Junkbuster understands. + @@ -1609,10 +1955,10 @@ Removed references to Win32. HB 09/23/01 - Additionally, there are wildcards that you can use in the domain names - themselves. They work pretty similar to shell wildcards: * + Additionally, there are wild-cards that you can use in the domain names + themselves. They work pretty similar to shell wild-cards: * stands for zero or more arbitrary characters, ? stands for - any single character. And you can define charachter classes in square + any single character. And you can define character classes in square brackets and they can be freely mixed: @@ -1640,7 +1986,7 @@ Removed references to Win32. HB 09/23/01 If Junkbuster was compiled with pcre support (default), Perl compatible regular expressions - can be used. See the pcre/docs/ direcory or man + can be used. See the pcre/docs/ directory or man perlre (also available on http://www.perldoc.com/perl5.6/pod/perlre.html) for details. A brief discussion of regular expressions is in the @@ -1697,12 +2043,12 @@ Removed references to Win32. HB 09/23/01 - + {+name} # enable this action {-name} # disable this action - + @@ -1710,16 +2056,16 @@ Removed references to Win32. HB 09/23/01 - Parameterized (e.g. +/-hide-user-agent): + parameterized (e.g. +/-hide-user-agent): - + {+name{param}} # enable action and set parameter to param {-name} # disable action - + @@ -1730,13 +2076,13 @@ Removed references to Win32. HB 09/23/01 - + {+name{param}} # enable action and add parameter param {-name{param}} # remove the parameter param {-name} # disable this action totally - + @@ -1749,7 +2095,7 @@ Removed references to Win32. HB 09/23/01 So in this case JunkBuster would just be a normal, non-blocking, non-anonymizing proxy. You must specifically enable the privacy and blocking features you need (although the - provided default actionsfile file will + provided default ijb.action file will give a good starting point). @@ -1772,11 +2118,11 @@ Removed references to Win32. HB 09/23/01 - + +add-header{Name: value} - + @@ -1788,11 +2134,11 @@ Removed references to Win32. HB 09/23/01 - + +block - + @@ -1804,22 +2150,41 @@ Removed references to Win32. HB 09/23/01 This will also shrink the images considerably (in bytes, not pixels!). If the option first is given, the first frame of the animation is used as the replacement. If last is given, the last frame - of the animation is used instead, which propably makes more sense for most + of the animation is used instead, which probably makes more sense for most banner animations, but also has the risk of not showing the entire last frame (if it is only a delta to an earlier frame). - + +deanimate-gifs{last} +deanimate-gifs{first} - + - + + + + +downgrade will downgrade HTTP/1.1 client requests to + HTTP/1.0 and downgrade the responses as well. Use this action for servers + that use HTTP/1.1 protocol features that + Junkbuster doesn't handle well yet. HTTP/1.1 + is only partially implemented. Default is not to downgrade requests. + + + + + + +downgrade + + + + + + Many sites, like yahoo.com, don't just link to other sites. Instead, they @@ -1830,7 +2195,7 @@ Removed references to Win32. HB 09/23/01 Sometimes, there are even multiple consecutive redirects encoded in the - URL. These redirections via scripts make your web browing more traceable, + URL. These redirections via scripts make your web browsing more traceable, since the server from which you follow such a link can see where you go to. Apart from that, valuable bandwidth and time is wasted, while your browser ask the server for one redirect after the other. Plus, it feeds the @@ -1844,11 +2209,11 @@ Removed references to Win32. HB 09/23/01 - + +fast-redirects - + @@ -1859,11 +2224,11 @@ Removed references to Win32. HB 09/23/01 - + +filter{filename} - + @@ -1874,11 +2239,11 @@ Removed references to Win32. HB 09/23/01 - + +hide-forwarded - + @@ -1891,12 +2256,12 @@ Removed references to Win32. HB 09/23/01 - + +hide-from{block} +hide-from{spam@sittingduck.xqq} - + @@ -1910,13 +2275,13 @@ Removed references to Win32. HB 09/23/01 - + +hide-referer{block} +hide-referer{forge} +hide-referer{http://nowhere.com} - + @@ -1930,11 +2295,11 @@ Removed references to Win32. HB 09/23/01 - + +hide-referrer{...} - + @@ -1948,11 +2313,11 @@ Removed references to Win32. HB 09/23/01 - + +hide-user-agent{Mozilla (X11; I; Linux 2.0.32 i586)} - + @@ -1991,11 +2356,11 @@ Removed references to Win32. HB 09/23/01 - + +image - + @@ -2003,112 +2368,194 @@ Removed references to Win32. HB 09/23/01 Decides what to do with URLs that end up tagged with {+block - +image}. There are 4 options. -image-blocker will - send a HTML blocked page, usually resulting in a - broken image icon. +image-blocker{logo} will - send a JunkBuster image. - +image-blocker{blank} will send a 1x1 transparent GIF image. - And finally, +image-blocker{http://xyz.com} will send a HTTP - temporary redirect to the specified image. This has the advantage of the - icon being being cached by the browser, which will speed up the display. + +image}, e.g an advertizement. There are five options. + -image-blocker will send a HTML blocked page, + usually resulting in a broken image icon. + +image-blocker{logo} will send a JunkBuster + logo image. +image-blocker{blank} will send a 1x1 + transparent GIF image. And finally, + +image-blocker{http://xyz.com} will send a HTTP temporary + redirect to the specified image. This has the advantage of the icon being + being cached by the browser, which will speed up the display. + +image-blocker{pattern} will send a checkboard type pattern, + which scales better than the logo (which can get blocky if the browser + enlarges it too much). - + +image-blocker{logo} +image-blocker{blank} +image-blocker{http://i.j.b/send-banner} - + - - Prevent the website from reading cookies: + + By default (i.e. in the absence of a +limit-connect + action), Junkbuster will only allow CONNECT + requests to port 443, which is the standard port for https as a + precaution. + + + + The CONNECT methods exists in HTTP to allow access to secure websites + (https:// URLs) through proxies. It works very simply: the proxy + connects to the server on the specified port, and then short-circuits + its connections to the client and to the remote proxy. + This can be a big security hole, since CONNECT-enabled proxies can + be abused as TCP relays very easily. + + + If you want to allow CONNECT for more ports than this, or want to forbid + CONNECT altogether, you can specify a comma separated list of ports and + port ranges (the latter using dashes, with the minimum defaulting to 0 and + max to 65K): + + - + - +no-cookies-read + +limit-connect{443} # This is the default and need no be specified. + +limit-connect{80,443} # Ports 80 and 443 are OK. + +limit-connect{-3, 7, 20-100, 500-} # Port less than 3, 7, 20 to 100 + #and above 500 are OK. - + - + + - - Prevent the website from setting cookies: + + +no-compression prevents the website from compressing the + data. Some websites do this, which can be a problem for + Junkbuster, since +filter, + +no-popup and +gif-deanimate will not work on + compressed data. This will slow down connections to those websites, + though. Default is nocompression is turned on. + - + - +no-cookies-set + +nocompression - + - + - Filter the website through a built-in filter to disable those obnoxious - JavaScript pop-up windows via window.open(), etc. The two alternative - spellings are equivalent. + If the website sets cookies, no-cookies-keep will make sure + they are erased when you exit and restart your web browser. This makes + profiling cookies useless, but won't break sites which require cookies so + that you can log in for transactions. Default: on. - + - +no-popup - +no-popups + +no-cookies-keep - + - This action only applies if you are using a jarfile - for saving cookies. It sends a cookie to every site stating that you do not - accept any copyright on cookies sent to you, and asking them not to track - you. Of course, this is a (relatively) unique header they could use to - track you. + Prevent the website from reading cookies: - + - +vanilla-wafer + +no-cookies-read - + - This allows you to add an arbitrary cookie. It can be specified multiple - times in order to add as many cookies as you like. + Prevent the website from setting cookies: - + - +wafer{name=value} + +no-cookies-set - + - - + + + + Filter the website through a built-in filter to disable those obnoxious + JavaScript pop-up windows via window.open(), etc. The two alternative + spellings are equivalent. + + + + + + +no-popup + +no-popups + + + + + + + + + This action only applies if you are using a jarfile + for saving cookies. It sends a cookie to every site stating that you do not + accept any copyright on cookies sent to you, and asking them not to track + you. Of course, this is a (relatively) unique header they could use to + track you. + + + + + + +vanilla-wafer + + + + + + + + + This allows you to add an arbitrary cookie. It can be specified multiple + times in order to add as many cookies as you like. + + + + + + +wafer{name=value} + + + + + + + @@ -2126,15 +2573,18 @@ Removed references to Win32. HB 09/23/01 - + - # Turn off all cookies + # Turn off all persistent cookies { +no-cookies-read } { +no-cookies-set } + # Allow cookies for this browser session ONLY + { +no-cookies-keep } - # Execeptions to the above, sites that need cookies + # Exceptions to the above, sites that benefit from persistent cookies { -no-cookies-read } { -no-cookies-set } + { -no-cookies-keep } .javasoft.com .sun.com .yahoo.com @@ -2142,11 +2592,11 @@ Removed references to Win32. HB 09/23/01 .redhat.com # Alternative way of saying the same thing - {-no-cookies-set -no-cookies-read} + {-no-cookies-set -no-cookies-read -no-cookies-keep} .sourceforge.net .sf.net - + @@ -2156,7 +2606,7 @@ Removed references to Win32. HB 09/23/01 - + # Turn them off! {+fast-redirects} @@ -2166,7 +2616,7 @@ Removed references to Win32. HB 09/23/01 www.ukc.ac.uk/cgi-bin/wac\.cgi\? login.yahoo.com - + @@ -2176,7 +2626,7 @@ Removed references to Win32. HB 09/23/01 - + # Run everything through the default filter file (re_filterfile): {+filter} @@ -2185,7 +2635,7 @@ Removed references to Win32. HB 09/23/01 {-filter} .cvs.sourceforge.net - + @@ -2197,7 +2647,7 @@ Removed references to Win32. HB 09/23/01 - + # Blocklist: {+block} @@ -2245,7 +2695,7 @@ Removed references to Win32. HB 09/23/01 /.*/adlib/server\.cgi /autoads/ - + @@ -2259,13 +2709,15 @@ Removed references to Win32. HB 09/23/01 Aliases Custom actions, known to Junkbuster - as aliases, can be defined by combing other actions. + as aliases, can be defined by combining other actions. These can in turn be invoked just like the built-in actions. Currently, an alias can contain any character except space, tab, =, { or }. But please use only a- z, 0-9, +, and - -. Alias names are not case sensitive, and must be defined - before they are used. + -. Alias names are not case sensitive, and + must be defined before anything else in the + ijb.actionfile ! And there can only be one set of + aliases defined. @@ -2274,12 +2726,10 @@ Removed references to Win32. HB 09/23/01 - + - # Aliases + # Useful customer aliases we can use later. These must come first! {{alias}} - - # Useful aliases +no-cookies = +no-cookies-set +no-cookies-read -no-cookies = -no-cookies-set -no-cookies-read fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups @@ -2293,7 +2743,7 @@ Removed references to Win32. HB 09/23/01 c3 = +no-cookies-set -no-cookies-read #... etc. Customize to your heart's content. - + @@ -2304,13 +2754,14 @@ Removed references to Win32. HB 09/23/01 - + # These sites are very complex and require # minimal interference. {fragile} .office.microsoft.com .windowsupdate.microsoft.com + .nytimes.com # Shopping sites - still want to block ads. {shop} @@ -2324,7 +2775,7 @@ Removed references to Win32. HB 09/23/01 .dabs.com .overclockers.co.uk - + @@ -2338,16 +2789,16 @@ Removed references to Win32. HB 09/23/01 The Filter File - The filter file defines what filtering of web pages - Junkbuster does. The default filter file is - re_filterfile, located in the config directory. In this - file, any document content, whether viewable text or - embedded non-visible content, can be changed. + Any web page can be dynamically modified with the filter file. This + modification can be removal, or re-writing, of any web page content, + including tags and non-visible content. The default filter file is + re_filterfile, located in the config directory. This file uses regular expressions to alter or remove any string in the - target page. Some examples from the included default re_filterfile: + target page. The expressions can only operate on one line at a time .Some + examples from the included default re_filterfile: @@ -2357,13 +2808,13 @@ Removed references to Win32. HB 09/23/01 - + # The status bar is for displaying link targets, not pointless buzzwords. # Again, check it out on http://www.airport-cgn.de/. s/status='.*?';*//ig - + @@ -2374,11 +2825,11 @@ Removed references to Win32. HB 09/23/01 - + s/microsoft(?!.com)/MicroSuck/ig - + @@ -2388,7 +2839,7 @@ Removed references to Win32. HB 09/23/01 - + # Kill refresh tags. I like to refresh myself. Manually. # check it out on http://www.airport-cgn.de/ and go to the arrivals page. @@ -2396,37 +2847,365 @@ Removed references to Win32. HB 09/23/01 s/<meta[^>]*http-equiv[^>]*refresh.*URL=([^>]*?)"?>/<link rev="x-refresh" href=$1>/i s/<meta[^>]*http-equiv="?page-enter"?[^>]*content=[^>]*>/<!--no page enter for me-->/i - + + + + + + + + +Templates + + When Junkbuster displays one of its internal + pages, such as a 404 Not Found error page, it uses the appropriate template. + On Linux, BSD, and Unix, these are located in + /etc/junkbuster/templates by default. These may be + customized, if desired. + + + + + + + + Quickstart to Using Junkbuster -To be filled. + + Install package, then run and enjoy! JunkBuster + is typically started by specifying the main configuration file to be + used on the command line. Example Unix startup command: + + + + + + # /usr/sbin/junkbuster /etc/junkbuster/config + + + + + + An init script is provided for SuSE and Redhat. + + + +For for SuSE: /etc/rc.d/junkbuster start + + + +For RedHat: /etc/rc.d/init.d/junkbuster start + + + + + If no configuration file is specified on the command line, + Junkbuster will look for a file named + config in the current directory. Except on Win32 where + it will try config.txt. If no file is specified on the + command line and no default configuration file can be found, + Junkbuster will fail to start. + + + + Be sure your browser is set to use the proxy which is by default at + localhost, port 8118. With Netscape (and + Mozilla), this can be set under Edit + -> Preferences -> Advanced -> Proxies -> HTTP Proxy. + For Internet Explorer: Tools > + Internet Properties -> Connections -> LAN Setting. Then, + check Use Proxy and fill in the appropriate info (Address: + localhost, Port: 8118). Include if HTTPS proxy support too. + + + The included default configuration files should give a reasonable starting + point, though may be somewhat aggressive in blocking junk. You will probably + want to keep an eye out for sites that require persistent cookies, and add these to + ijb.action as needed. By default, most of these will + be accepted only during the current browser session, until you add them to + the configuration. If you want the browser to handle this instead, you will + need to edit ijb.action and disable this feature. If you + use more than one browser, it would make more sense to let + Junkbuster handle this. In which case, the + browser(s) should be set to accept all cookies. + + + + If a particular site shows problems loading properly, try adding it + to the {fragile} section of + ijb.action. This will turn off most actions for + this site. + + + + Junkbuster is HTTP/1.1 compliant, but not all 1.1 + features are as yet implemented. If browsers that support HTTP/1.1 (like + Mozilla or recent versions of I.E.) experience + problems, you might try to force HTTP/1.0 compatibility. For Mozilla, look + under Edit -> Preferences -> Debug -> Networking. + Or set the +downgrade config option in + ijb.action. + + + + After running Junkbuster for a while, you can + start to fine tune the configuration to suit your personal, or site, + preferences and requirements. There are many, many aspects that can + be customized. Actions (as specified in ijb.action) + can be adjusted by pointing your browser to + http://i.j.b/, + and then follow the link to edit the actions list. + (This is an internal page and does not require Internet access.) + + + + In fact, various aspects of Junkbuster + configuration can be viewed from this page, including + current configuration parameters, source code version numbers, + the browser's request headers, and actions that apply + to a given URL. In addition to the ijb.action file + editor mentioned above, Junkbuster can also + be turned on and off from this page. + + + + If you encounter problems, please verify it is a + Junkbuster bug, by disabling + Junkbuster, and then trying the same page. + Also, try another browser if possible to eliminate browser or site + problems. Before reporting it as a bug, see if there is not a configuration + option that is enabled that is causing the page not to load. You can + then add an exception for that page or site. If a bug, please report it to + the developers (see below). + + + + + + + +Command Line Options + + JunkBuster may be invoked with the following + command-line options: + + + + + + + + --version + + + Print version info and exit, Unix only. + + + + + --help + + + Print a short usage info and exit, Unix only. + + + + + --no-daemon + + + Don't become a daemon, i.e. don't fork and become process group + leader, don't detach from controlling tty. Unix only. + + + + + --pidfile FILE + + + + On startup, write the process ID to FILE. Delete the + FILE on exit. Failiure to create or delete the + FILE is non-fatal. If no FILE + option is given, no PID file will be used. Unix only. + + + + + --user USER[.GROUP] + + + + After (optionally) writing the PID file, assume the user ID of + USER, and if included the GID of GROUP. Exit if the + privileges are not sufficient to do so. Unix only. + + + + + configfile + + + If no configfile is included on the command line, + JunkBuster will look for a file named + config in the current directory (except on Win32 + where it will look for config.txt instead). Specify + full path to avoid confusion. + + + + + + + + + + + -Contact the developers -To be filled. mention the support forums as the primary channel of -communication (bugs, feature requests, etc.) + +Contacting the Developers, Bug Reporting and Feature +Requests + +We value your feedback. However, to provide you with the best support, +please note: + + + + Use the Sourceforge support forum to get + help. + + Submit bugs only thru our Sourceforge bug + forum. +Make sure that the bug has not already been submitted. Please try to +verify that it is a Junkbuster bug, and not +a browser or site bug first. If you are using your own custom configuration, +please try the stock configs to see if the problem is a configuration +related bug. And if not using the latest development snapshot, please +try the latest one. Or even better, CVS sources. + + + + Submit feature requests only thru our Sourceforge feature request forum. + + + + + + +For any other issues, feel free to use the mailing lists. + + + + Anyone interested in actively participating in development and related + discussions can join the appropriate mailing list + here. + Archives are available here too. + + + Copyright and History -To be filled. + + +License + + Internet Junkbuster is free software; you can + redistribute it and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either version 2 of the + License, or (at your option) any later version. + + + This program is distributed in the hope that it will be useful, but WITHOUT + ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + FOR A PARTICULAR PURPOSE. See the GNU General Public License for more + details, which is available from the Free Software Foundation, + Inc, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + + + + + + + + + +History + + Junkbuster was originally written by Anonymous + Coders and Junkbuster's + Corporation, and was released as free open-source software under the + GNU GPL. Stefan + Waldherr made many improvements, and started the SourceForge project to + rekindle development. There are now several active developers contributing. + The last stable release was v2.0.2, which has now grown whiskers ;-). + + + + See also -To be filled. + + + + +   http://sourceforge.net/projects/ijbswa + + + + +   http://ijbswa.sourceforge.net/ + + + + +   http://i.j.b/ + + + + +   http://www.junkbusters.com/ht/en/cookies.html + + + + +   http://www.waldherr.org/junkbuster/ + + + + +   http://privacy.net/analyze/ + + + + +  http://www.squid-cache.org/ + + + @@ -2440,7 +3219,362 @@ communication (bugs, feature requests, etc.) Regular Expressions - WIP + Junkbuster can use regular expressions + in various config files. Assuming support for pcre (Perl + Compatible Regular Expressions) is compiled in, which is the default. Such + configuration directives do not require regular expressions, but they can be + used to increase flexibility by matching a pattern with wild-cards against + URLs. + + + + If you are reading this, you probably don't understand what regular + expressions are, or what they can do. So this will be a very brief + introduction only. A full explanation would require a book ;-) + + + + Regular expressions is a way of matching one character + expression against another to see if it matches or not. One of the + expressions is a literal string of readable characters + (letter, numbers, etc), and the other is a complex string of literal + characters combined with wild-cards, and other special characters, called + meta-characters. The meta-characters have special meanings and + are used to build the complex pattern to be matched against. Perl Compatible + Regular Expressions is an enhanced form of the regular expression language + with backward compatibility. + + + + To make a simple analogy, we do something similar when we use wild-card + characters when listing files with the dir command in DOS. + *.* matches all filenames. The special + character here is the asterisk which matches any and all characters. We can be + more specific and use ? to match just individual + characters. So dir file?.text would match + file1.txt, file2.txt, etc. We are pattern + matching, using a similar technique to regular expressions! + + + + Regular expressions do essentially the same thing, but are much, much more + powerful. There are many more special characters and ways of + building complex patterns however. Let's look at a few of the common ones, + and then some examples: + + + + + . - Matches any single character, e.g. a, + A, 4, :, or @. + + + + + + ? - The preceding character or expression is matched ZERO or ONE + times. Either/or. + + + + + + + - The preceding character or expression is matched ONE or MORE + times. + + + + + + * - The preceding character or expression is matched ZERO or MORE + times. + + + + + + \ - The escape character denotes that + the following character should be taken literally. This is used where one of the + special characters (e.g. .) needs to be taken literally and + not as a special meta-character. + + + + + + [] - Characters enclosed in brackets will be matched if + any of the enclosed characters are encountered. + + + + + + () - parentheses are used to group a sub-expression, + or multiple sub-expressions. + + + + + + | - The bar character works like an + or conditional statement. A match is successful if the + sub-expression on either side of | matches. + + + + + + s/string1/string2/g - This is used to rewrite strings of text. + string1 is replaced by string2 in this + example. + + + + + These are just some of the ones you are likely to use when matching URLs with + Junkbuster, and is a long way from a definitive + list. This is enough to get us started with a few simple examples which may + be more illuminating: + + + + /.*/banners/.* - A simple example + that uses the common combination of . and * to + denote any character, zero or more times. In other words, any string at all. + So we start with a literal forward slash, then our regular expression pattern + (.*) another literal forward slash, the string + banners, another forward slash, and lastly another + .*. We are building + a directory path here. This will match any file with the path that has a + directory named banners in it. The .* matches + any characters, and this could conceivably be more forward slashes, so it + might expand into a much longer looking path. For example, this could match: + /eye/hate/spammers/banners/annoy_me_please.gif, or just + /banners/annoying.html, or almost an infinite number of other + possible combinations, just so it has banners in the path + somewhere. + + + + A now something a little more complex: + + + + /.*/adv((er)?ts?|ertis(ing|ements?))?/ - + We have several literal forward slashes again (/), so we are + building another expression that is a file path statement. We have another + .*, so we are matching against any conceivable sub-path, just so + it matches our expression. The only true literal that must + match our pattern is adv, together with + the forward slashes. What comes after the adv string is the + interesting part. + + + + Remember the ? means the preceding expression (either a + literal character or anything grouped with (...) in this case) + can exist or not, since this means either zero or one match. So + ((er)?ts?|ertis(ing|ements?)) is optional, as are the + individual sub-expressions: (er), + (ing|ements?), and the s. The | + means or. We have two of those. For instance, + (ing|ements?), can expand to match either ing + OR ements?. What is being done here, is an + attempt at matching as many variations of advertisement, and + similar, as possible. So this would expand to match just adv, + or advert, or adverts, or + advertising, or advertisement, or + advertisements. You get the idea. But it would not match + advertizements (with a z). We could fix that by + changing our regular expression to: + /.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/, which would then match + either spelling. + + + + /.*/advert[0-9]+\.(gif|jpe?g) - Again + another path statement with forward slashes. Anything in the square brackets + [] can be matched. This is using 0-9 as a + shorthand expression to mean any digit one through nine. It is the same as + saying 0123456789. So any digit matches. The + + means one or more of the preceding expression must be included. The preceding + expression here is what is in the square brackets -- in this case, any digit + one through nine. Then, at the end, we have a grouping: (gif|jpe?g). + This includes a |, so this needs to match the expression on + either side of that bar character also. A simple gif on one side, and the other + side will in turn match either jpeg or jpg, + since the ? means the letter e is optional and + can be matched once or not at all. So we are building an expression here to + match image GIF or JPEG type image file. It must include the literal + string advert, then one or more digits, and a . + (which is now a literal, and not a special character, since it is escaped + with \), and lastly either gif, or + jpeg, or jpg. Some possible matches would + include: //advert1.jpg, + /nasty/ads/advert1234.gif, + /banners/from/hell/advert99.jpg. It would not match + advert1.gif (no leading slash), or + /adverts232.jpg (the expression does not include an + s), or /advert1.jsp (jsp is not + in the expression anywhere). + + + + s/microsoft(?!.com)/MicroSuck/i - This is + a substitution. MicroSuck will replace any occurrence of + microsoft. The i at the end of the expression + means ignore case. The (?!.com) means + the match should fail if microsoft is followed by + .com. In other words, this acts like a NOT + modifier. In case this is a hyperlink, we don't want to break it ;-). + + + + We are barely scratching the surface of regular expressions here so that you + can understand the default Junkbuster + configuration files, and maybe use this knowledge to customize your own + installation. There is much, much more that can be done with regular + expressions. Now that you know enough to get started, you can learn more on + your own :/ + + + + More reading on Perl Compatible Regular expressions: + http://www.perldoc.com/perl5.6/pod/perlre.html + + + + + + + + + +JunkBuster's Internal Pages + + + Since JunkBuster proxies each requested + web page, it is easy for JunkBuster to + trap certain URLs. In this way, we can talk directly to + JunkBuster, and see how it is + configured, see how our rules are being applied, change these + rules and other configuration options, and even turn + JunkBuster off. + + + + + The URLs listed below are the special ones that allow direct access + to JunkBuster. Of course, + JunkBuster must be running to access these. If + not, you will get a friendly error message. + + + + + + + + + Junkbuster main page: + +
+ + http://ijbswa.sourceforge.net/config/ + +
+ + Alternately, this may be reached at http://i.j.b/, + but this variation may not work as reliably as the above in some + configurations. + + + + + + Show information about the current configuration: + +
+ + http://ijbswa.sourceforge.net/config/show-status + +
+ + + + + Show the source code version numbers: + +
+ + http://ijbswa.sourceforge.net/config/show-version + +
+ + + + + Show the client's request headers: + +
+ + http://ijbswa.sourceforge.net/config/show-request + +
+ + + + + Show which actions apply to a URL and why: + +
+ + http://ijbswa.sourceforge.net/config/show-url-info + +
+ + + + + Toggle JunkBuster on or off: + +
+ + http://ijbswa.sourceforge.net/config/toggle + +
+ + Short cuts. Turn off, then on: + +
+ + http://ijbswa.sourceforge.net/config/toggle?set=disable + +
+
+ + http://ijbswa.sourceforge.net/config/toggle?set=enable + +
+ + + + + Edit the actions list file: + +
+ + http://ijbswa.sourceforge.net/config/edit-actions + +
+ + + + + + + These may be bookmarked for quick reference. + @@ -2468,8 +3602,119 @@ communication (bugs, feature requests, etc.) Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ - Revision 1.4 2001/09/24 01:27:56 hal9 - Draft. Unfinished. + Revision 1.46 2002/03/10 00:51:08 hal9 + Added section on JB internal pages in Appendix. + + Revision 1.45 2002/03/09 17:43:53 swa + more distros + + Revision 1.44 2002/03/09 17:08:48 hal9 + New section on Jon's actions file editor, and move some stuff around. + + Revision 1.43 2002/03/08 00:47:32 hal9 + Added imageblock{pattern}. + + Revision 1.42 2002/03/07 18:16:55 swa + looks better + + Revision 1.41 2002/03/07 16:46:43 hal9 + Fix a few markup problems for jade. + + Revision 1.40 2002/03/07 16:28:39 swa + provide correct feedback channels + + Revision 1.39 2002/03/06 16:19:28 hal9 + Note on perceived filtering slowdown per FR. + + Revision 1.38 2002/03/05 23:55:14 hal9 + Stupid I did it again. Double hyphen in comment breaks jade. + + Revision 1.37 2002/03/05 23:53:49 hal9 + jade barfs on '- -' embedded in comments. - -user option broke it. + + Revision 1.36 2002/03/05 22:53:28 hal9 + Add new - - user option. + + Revision 1.35 2002/03/05 00:17:27 hal9 + Added section on command line options. + + Revision 1.34 2002/03/04 19:32:07 oes + Changed default port to 8118 + + Revision 1.33 2002/03/03 19:46:13 hal9 + Emphasis on where/how to report bugs, etc + + Revision 1.32 2002/03/03 09:26:06 joergs + AmigaOS changes, config is now loaded from PROGDIR: instead of + AmiTCP:db/junkbuster/ if no configuration file is specified on the + command line. + + Revision 1.31 2002/03/02 22:45:52 david__schmidt + Just tweaking + + Revision 1.30 2002/03/02 22:00:14 hal9 + Updated 'New Features' list. Ran through spell-checker. + + Revision 1.29 2002/03/02 20:34:07 david__schmidt + Update OS/2 build section + + Revision 1.28 2002/02/24 14:34:24 jongfoster + Formatting changes. Now changing the doctype to DocBook XML 4.1 + will work - no other changes are needed. + + Revision 1.27 2002/01/11 14:14:32 hal9 + Added a very short section on Templates + + Revision 1.26 2002/01/09 20:02:50 hal9 + Fix bug re: auto-detect config file changes. + + Revision 1.25 2002/01/09 18:20:30 hal9 + Touch ups for *.action files. + + Revision 1.24 2001/12/02 01:13:42 hal9 + Fix typo. + + Revision 1.23 2001/12/02 00:20:41 hal9 + Updates for recent changes. + + Revision 1.22 2001/11/05 23:57:51 hal9 + Minor update for startup now daemon mode. + + Revision 1.21 2001/10/31 21:11:03 hal9 + Correct 2 minor errors + + Revision 1.18 2001/10/24 18:45:26 hal9 + *** empty log message *** + + Revision 1.17 2001/10/24 17:10:55 hal9 + Catching up with Jon's recent work, and a few other things. + + Revision 1.16 2001/10/21 17:19:21 swa + wrong url in documentation + + Revision 1.15 2001/10/14 23:46:24 hal9 + Various minor changes. Fleshed out SEE ALSO section. + + Revision 1.13 2001/10/10 17:28:33 hal9 + Very minor changes. + + Revision 1.12 2001/09/28 02:57:04 hal9 + Ditto :/ + + Revision 1.11 2001/09/28 02:25:20 hal9 + Ditto. + + Revision 1.9 2001/09/27 23:50:29 hal9 + A few changes. A short section on regular expression in appendix. + + Revision 1.8 2001/09/25 00:34:59 hal9 + Some additions, and re-arranging. + + Revision 1.7 2001/09/24 14:31:36 hal9 + Diddling. + + Revision 1.6 2001/09/24 14:10:32 hal9 + Including David's OS/2 installation instructions. Revision 1.2 2001/09/13 15:27:40 swa cosmetics