By: Junkbuster Developers
-$Id: user-manual.sgml,v 1.22 2001/11/05 23:57:51 hal9 Exp $
+$Id: user-manual.sgml,v 1.31 2002/03/02 22:45:52 david__schmidt Exp $
The user manual gives the users information on how to install and configure
Internet Junkbuster. Internet Junkbuster is an application that provides
3. Junkbuster Configuration
3.1. The Main Configuration File
+
+ 3.1.1. Defining Other Configuration Files
+ 3.1.2. Other Configuration Options
+ 3.1.3. Access Control List (ACL)
+ 3.1.4. Forwarding
+ 3.1.5. Windows GUI Options
+
3.2. The Actions File
+
+ 3.2.1. URL Domain and Path Syntax
+ 3.2.2. Actions
+ 3.2.3. Aliases
+
3.3. The Filter File
+ 3.4. Templates
4. Quickstart to Using Junkbuster
5. Contact the Developers
1. Introduction
Internet 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.
+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
+This documentation is included with the current BETA version of Internet
Junkbuster and is incomplete 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 many significant changes and enhancements over earlier verions. The
-target release date for stable v3.0 is December 2001.
+configuration files. Development 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 RSN.
-Since this is a development version, some features are in the process of being
-implemented. This documentation may be slightly out of sync as a result. And
-there are bugs, though hopefully not many!
+Since this is a BETA version, not all new features are well tested. This
+documentation may be slightly out of sync as a result. And there may be bugs,
+though hopefully not many!
-------------------------------------------------------------------------------
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:
- * A browser based configuration utility (WIP at http://i.j.b).
+ * 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)
+ individual user settings. (not implemented yet, probably a 3.1 feature)
- * Blocking of annoying pop-up browser windows (previously available as a
- patch).
+ * Blocking of annoying pop-up browser windows.
- * Support for HTTP/1.1 (partially implemented at this point).
+ * HTTP/1.1 compliant (most, but not all 1.1 features are supported).
* Support for Perl Compatible Regular Expressions in the configuration files,
- and generally a more sophisticated configuration syntax over previous
- versions.
+ and generally a more sophisticated and flexible configuration syntax over
+ previous versions.
- * Web page content filtering.
+ * GIF de-animation.
- * Multi-threaded.
+ * 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.
+
+ * In addition, the configuration is much more powerful and versatile
+ over-all.
-In addition, the configuration is more versatile overall.
-
-------------------------------------------------------------------------------
2. Installation
For gzipped tar archives, unpack the source:
tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.9_alpha
+ cd ijb_source_2.9.10_beta
For retrieving the current CVS sources, you'll need the CVS package installed
Then, in either case, to build from tarball/CVS source:
- ./configure (--help to see options)
- make (the make from gnu, gmake for *BSD)
+ ./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)
+ make -n install (to see where all the files will go)
+ make install (to really install)
For Redhat and SuSE Linux RPM packages, see below.
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
+ /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
- /usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
This will place the Junkbuster configuration files in /etc/junkbuster/, and log
This will create both binary and src RPMs in the usual places. Example:
- /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
- /usr/src/packages/SRPMS/junkbuster-2.9.9-1.src.rpm
+ /usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
To install, of course:
- rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
This will place the Junkbuster configuration files in /etc/junkbuster/, and log
2.4. OS/2
-The OS/2 version of Junkbuster requires the EMX runtime library to be
-installed. The EMX runtime library is available on the hobbes OS/2 archive,
-among many other locations: 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
-
Junkbuster is packaged in a WarpIN self- installing archive. The
self-installing program will be named depending on the release version,
-something like: ijbos123.exe. In order to install it, simply run this
+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
-working EMX/GCC environment, plus several Unix-like tools. The Hobbes OS/2
-archive is a good place to start when building such an environment. A set of
-Unix-like tools named gnupack is located here: http://hobbes.nmsu.edu/cgi-bin/
-h-search?sh=1&key=gnupack&stype=all&sort=type&dir=%2Fpub%2Fos2%2Fapps
+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.
-Once you have the source code unpacked as above, you can build the binaries
-from the current/ directory:
+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
- make
+ cd ..\os2setup
+ nmake -f Makefile.vac
+You will see this sequence laid out in os2build.cmd.
+
-------------------------------------------------------------------------------
2.5. Windows
Some quick notes on other Operating Systems.
-For FreeBSD (and other *BSDs?), the build will need gmake instead of the
+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.
3. Junkbuster Configuration
-For Unix, *BSD 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 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.
-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):
* The main configuration file is named config on Linux, Unix, BSD, and OS/2,
and config.txt on Windows. On Amiga, it is AmiTCP:db/junkbuster/config.
* 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./. This is
- the easiest method of configuring actions. (Still under active
- development.)
+ based editor for this file that can be accessed via http://i.j.b. This is
+ the easiest method of configuring actions. (Other actions files are
+ included as well with differing levels of filtering and blocking, e.g.
+ ijb-basic.action.)
* The re_filterfile file can be used to rewrite the raw page content,
including text as well as embedded HTML and JavaScript.
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.
+are not processed by Junkbuster. After 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
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 per-user
+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.
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 kept
only during the current browser session (i.e. they are not saved to disk).
-Popups are disabled for all sites. All sites are filtered if "re_filterfile"
+Pop-ups 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.
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 content, or just have
+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 :-/
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 trust
+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 display
Junkbuster installation, it's 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.
+blocked or modified. Default: Don't show a link to on-line documentation.
proxy-info-url http://www.your-site.com/proxy.html
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
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.
+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 (on).
For content filtering, i.e. the "+filter" and "+deanimate-gif" actions, it is
-neccessary that Junkbuster buffers the entire document body. This can be
+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.
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./.
+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
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
+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
forward lpwa. lpwa.com:8000
-(NOTE: the syntax for specifiying target_domain has changed since the previous
+(NOTE: the syntax for specifying target_domain has changed since the previous
paragraph was written -- it will not work now. More information is welcome.)
In this fictitious example, everything goes via an ISP's caching proxy, except
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, or accepted only during
-the current browser session (i.e. not written to disk).
+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.
To determine which actions apply to a request, the URL of the request is
compared to all patterns in this file. Every time it matches, the list of
applicable actions for the URL is incrementally updated. You can trace this
process by visiting 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".
+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, as
www. - matches any domain that STARTS with "www".
-Additionally, there are wildcards that you can use in the domain names
-themselves. They work pretty similar to shell wildcards: "*" stands for zero or
-more arbitrary characters, "?" stands for any single character. And you can
-define charachter classes in square brackets and they can be freely mixed:
+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 character classes in square brackets and they can be freely mixed:
ad*.example.com - matches "adserver.example.com", "ads.example.com", etc but
not "sfads.example.com".
"wwwd.example.com", "wwwz.example.com", etc., but not "wwww.example.com".
If Junkbuster was compiled with "pcre" support (default), Perl compatible
-regular expressions can be used. See the pcre/docs/ direcory or "man perlre"
+regular expressions 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 Appendix. For instance:
{-name} # disable this action
- * Parameterized (e.g. "+/-hide-user-agent"):
+ * parameterized (e.g. "+/-hide-user-agent"):
{+name{param}} # enable action and set parameter to "param"
{-name} # disable action
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 banner animations,
+ 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).
some.where-else.
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
Turn off cookies by default, then allow a few through for specified sites:
- # Turn off all persistant 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 benefit from persistant cookies
+ # Exceptions to the above, sites that benefit from persistent cookies
{ -no-cookies-read }
{ -no-cookies-set }
{ -no-cookies-keep }
--no page enter for me-->/i
+-------------------------------------------------------------------------------
+
+3.4. 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 locate in /etc/junkbuster/templates by default. These may be customized, if
+desired.
+
-------------------------------------------------------------------------------
4. Quickstart to Using Junkbuster
-Install package, then run and enjoy! Junbuster accepts only one command line
+Install package, then run and enjoy! JunkBuster accepts only one command line
option -- the configuration file to be used. Example Unix startup command:
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 persistant cookies, and add
+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
HTTP/1.1 support is not fully 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 compatiblity. For Mozilla, look under Edit -> Preferences ->
+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.)
+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,
6.2. History
-Junkbuster was originally written by Anonymous Coders and JunkBusters
+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. The last stable release was v2.0.2, which has now grown
http://ijbswa.sourceforge.net/
- http://i.j.b./
+ http://i.j.b/
http://www.junkbusters.com/ht/en/cookies.html
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 wildcards against URLs.
+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
"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 wildcards, and other special
-characters, called metacharacters. The "metacharacters" have special meanings
-and are used to build the complex pattern to be matched against. Perl
+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 wildcard
+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 asterik which matches any and
+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"!
\ - 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 metacharacter.
+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.
-() - Pararentheses are used to group a sub-expression, or multiple
+() - parentheses are used to group a sub-expression, or multiple
sub-expressions.
| - The "bar" character works like an "or" conditional statement. A match is
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 occurence of "microsoft". The "i" at the end of the expression
+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 ;-).
projects / privoxy.git / blobdiff