junkbuster.1

   1 .\" Revised man page 10/13/01, for development version.\r
   2 .\" Hal Burgiss <hal@foobox.net> \r
   3 .\" for Junkbuster developers: ijbswa-developers@lists.sourceforge.net\r
   4 .\"\r
   5 .TH JUNKBUSTER 1 "v2.9.10 (beta) Date: 2002/01/09"\r
   6 \r
   7 .SH NAME\r
   8 \fBjunkbuster\fP\r
   9 - The\r
  10 Internet Junkbuster\r
  11 Proxy\r
  12 \s-2(TM)\s+2\r
  13 .SH SYNOPSIS\r
  14 \fBjunkbuster\fP\r
  15 \fI\&[config_file]\fP\r
  16 .br\r
  17 \fBjunkbstr.exe\fP\r
  18 \fI\&[config_file]\fP\r
  19 (Windows)\r
  20 .br\r
  21 .P\r
  22 If the configuration file is not specified on the command line,\r
  23 \fBJunkbuster\fP will look for a file named \fIconfig\fP in the \r
  24 current directory (except on Amiga where it will look for \r
  25 \fIAmiTCP:db/junkbuster/config\fP and Win32 where it will try \r
  26 \fIconfig.txt\fP).\r
  27 \r
  28 \r
  29 .SH DESCRIPTION\r
  30 \fBJunkbuster\fP\r
  31 is an instrumentable HTTP proxy that filters the \r
  32 \s-2HTTP\s0\r
  33 data stream between\r
  34 web servers and browsers.\r
  35 \fBJunkbuster\fP can be used to protect privacy, manage cookies, filter web\r
  36 page content, manage access restrictions, and to discard such annoying Internet\r
  37 junk as ads, banners, and pop-ups. Or whatever other annoyances strike your\r
  38 fancy.\r
  39 \r
  40 .SH INSTALLATION AND USE\r
  41 Browsers must be configured to use \r
  42 \fBJunkbuster\fP\r
  43 (the default is localhost, \r
  44 port 8000).\r
  45 To set the \r
  46 \s-2HTTP\s0\r
  47 proxy in Netscape and Mozilla,\r
  48 go through:\r
  49 \fB\&Edit\fP;\r
  50 \fB\&Preferences\fP;\r
  51 \fB\&Advanced\fP;\r
  52 \fB\&Proxies\fP;\r
  53 \fB\&Manual Proxy Configuration\fP;\r
  54 \fB\&View\fP.\r
  55 .P\r
  56 For Internet Explorer,\r
  57 go through:\r
  58 \fB\&Tools\fP;\r
  59 \fB\&Internet Properties\fP;\r
  60 \fB\&Connections\fP;\r
  61 \fB\&LAN Settings\fP.\r
  62 .P\r
  63 Set the HTTP proxy location for localhost, port 8000.\r
  64 The\r
  65 Secure (SSL) Proxy\" ijbfaq.html#security\r
  66 should also be set to the same values,\r
  67 otherwise\r
  68 \fB\&https:\fP\r
  69 \s-2URL\s0s\r
  70 won't be proxied.\r
  71 .P\r
  72 For other browser, check the documentation.\r
  73 \r
  74 .SH CONFIGURATION\r
  75 All \fBJunkbuster\fP configuration is done via the various configuration \r
  76 files. The default configuration files are: \fIconfig\fP, \r
  77 \fIijb.action\fP, and \fIre_filterfile\fP. These are well commented. \r
  78 On Unix and Unix-like systems, these are located in \fI/etc/junkbuster/\fP \r
  79 by default. On Windows and OS/2, these files are in the same directory \r
  80 as the \fBJunkbuster\fP executable. \r
  81 .P\r
  82 The name and number of configuration files has changed from previous versions,\r
  83 and is subject to change as development progresses. In fact, the configuration\r
  84 itself is changed and much more sophisticated. See the user-manual for a brief\r
  85 explanation of all configuration options.\r
  86 .P\r
  87 \fBJunkbuster's\fP configuration parameters can be viewed at\r
  88 \fIhttp://i.j.b/\fP. This is an internal page. In\r
  89 addition, the \fIijb.action\fP file can be edited here, and \fBJunkbuster\fP can\r
  90 be toggled on/off.\r
  91 \r
  92 .SH "SAMPLE CONFIGURATION"\r
  93 .PP\r
  94 A brief example of what an \fIijb.action\fP configuration might look like:\r
  95 .PP\r
  96 .nf\r
  97 \r
  98 # Define a few useful custom aliases for later use\r
  99 {{alias}}\r
 100 # Don't accept cookies\r
 101 +no-cookies = +no-cookies-set +no-cookies-read\r
 102 # Do accept cookies\r
 103 -no-cookies = -no-cookies-set -no-cookies-read\r
 104 +imageblock = +block +image\r
 105 \r
 106 ## Default Policies (actions) ############################\r
 107 { \\\r
 108  -block \\\r
 109  -downgrade \\\r
 110  +fast-redirects \\\r
 111  +filter \\\r
 112  +no-compression \\\r
 113  +hide-forwarded \\\r
 114  +hide-from{block} \\\r
 115  +hide-referer{forge} \\\r
 116  -hide-user-agent \\\r
 117  -image \\\r
 118  +image-blocker{blank} \\\r
 119  +no-cookies-keep \\\r
 120  -no-cookies-read \\\r
 121  -no-cookies-set \\\r
 122  +no-popups \\\r
 123  -vanilla-wafer \\\r
 124  -wafer \\\r
 125 }\r
 126 /\r
 127 \r
 128 # Now set exceptions to the above defined policies #######\r
 129 \r
 130 # Sites where we want persistant cookies\r
 131 {-no-cookies -no-cookies-keep}\r
 132  .redhat.com\r
 133  .sun.com\r
 134  .yahoo.com\r
 135  .msdn.microsoft.com\r
 136 \r
 137 # This site requires cookies AND 'fast-redirects' on\r
 138 {-no-cookies -no-cookies-keep -fast-redirects}\r
 139  .nytimes.com\r
 140 \r
 141 # Add custom headers, and turn off filtering of page source\r
 142 {+add-header{X-Privacy: Yes please} #-add-header{*} \\\r
 143  +add-header{X-User-Tracking: No thanks!} -filter}\r
 144  privacy.net\r
 145 \r
 146 # Block, and treat these URLs as 'images'.\r
 147 {+imageblock}\r
 148  .adforce.imgis.com\r
 149  .ad.preferences.com/image.*\r
 150  .ads.web.aol.com\r
 151  .ad-adex3.flycast.com\r
 152  .ad.doubleclick.net\r
 153  .ln.doubleclick.net\r
 154  .ad.de.doubleclick.net\r
 155  /.*/count\\.cgi\\?.*df=\r
 156  194.221.183.22[1-7]\r
 157  a196.g.akamai.net/7/196/2670/000[12]/images.gmx.net/i4/images/.*/\r
 158 \r
 159 # Block any URLs that match these patterns\r
 160 {+block}\r
 161  /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\\.(gif|jpe?g))\r
 162  /.*/(plain|live|rotate)[-_.]?ads?/\r
 163  /.*/(sponsor)s?[0-9]?/\r
 164  /.*/ad(server|stream|juggler)\\.(cgi|pl|dll|exe)\r
 165  /.*/adbanners/\r
 166  /.*/adv((er)?ts?|ertis(ing|ements?))?/\r
 167  /.*/banners?/\r
 168  /.*/popupads/\r
 169  /.*/advert[0-9]+\\.jpg\r
 170  /ad_images/\r
 171  /.*/ads/\r
 172  /images/.*/.*_anim\\.gif\r
 173  /rotations/ \r
 174  /.*(ms)?backoff(ice)?.*\\.(gif|jpe?g)\r
 175  195.63.104.*/(inbox|log|meld|folderlu|folderru|log(in|out)[lmr]u|)\r
 176  .images.nytimes.com\r
 177  .images.yahoo.com/adv/\r
 178  /.*cnnstore\\.gif\r
 179 \r
 180 .fi\r
 181 .sp\r
 182 .PP\r
 183 See the comments in the configuration files themselves, or the user-manual \r
 184 for explanations of the above syntax, and other \fBJunkbuster\fP configuration \r
 185 options.\r
 186 \r
 187 .SH "FILES"\r
 188 \fI/usr/sbin/junkbuster\fP\r
 189 .br\r
 190 \fI/etc/junkbuster/config\fP\r
 191 .br\r
 192 \fI/etc/junkbuster/ijb.action\fP\r
 193 .br\r
 194 \fI/etc/junkbuster/ijb-advanced.action\fP\r
 195 .br\r
 196 \fI/etc/junkbuster/ijb-basic.action\fP\r
 197 .br\r
 198 \fI/etc/junkbuster/ijb-intermediate.action\fP\r
 199 .br\r
 200 \fI/etc/junkbuster/re_filterfile\fP\r
 201 .br\r
 202 \fI/etc/junkbuster/trust\fP\r
 203 .br\r
 204 \fI/etc/junkbuster/templates/*\fP\r
 205 .br\r
 206 \fI/var/log/junkbuster/logfile\fP\r
 207 \r
 208 .P\r
 209 Various other files should be included, but may vary depending on platform \r
 210 and build configuration. More documentation should be included in the local\r
 211 documentation directory, though is not complete at this time.\r
 212 \r
 213 .SH SIGNALS\r
 214 \fBJunkbuster\fP use the signal \fISIGHUP\fP (see kill -l) to reload all configuration\r
 215 files (see CONFIGURATION). This includes the re-open of the logfiles\r
 216 (logfile and jarfile) eg. used\r
 217 after rotation of the logfiles by logrotate.\r
 218 The \fISIGHUP\fP behavior is only for UNIX like OS'.\r
 219 .br\r
 220 However the configfile will be re-read if \fBJunkbuster\fP detects a changed\r
 221 modification time and then behaves like a re-start of \fBJunkbuster\fP \r
 222 in context of all the pertinent files.\r
 223  \r
 224 .SH NOTES\r
 225 This is a development version of \fBJunkbuster\fP. Not all features are  \r
 226 complete.\r
 227 \r
 228 .SH BUGS\r
 229 Yes. HTTP/1.1 support is only partially implemented. See the user-manual for \r
 230 how and where to report bugs.\r
 231 \r
 232 .SH SEE ALSO\r
 233 .br\r
 234 http://i.j.b/\r
 235 .br\r
 236 http://ijbswa.sourceforge.net/\r
 237 .br\r
 238 http://sourceforge.net/projects/ijbswa\r
 239 .br\r
 240 http://www.waldherr.org/junkbuster/\" waldherr.org#\r
 241 .br\r
 242 http://www.junkbusters.com/ht/en/cookies.html\" cookies.html#\r
 243 .br\r
 244 http://privacy.net/analyze/\r
 245 .br\r
 246 http://www.squid-cache.org/\r
 247 .br\r
 248 http://linuxalpha.ch/packages/\r
 249 \r
 250 .SH DEVELOPMENT TEAM\r
 251 .br\r
 252  Stefan Waldherr \r
 253 .br\r
 254  Andreas Oesterhelt \r
 255 .br\r
 256  Jon Foster \r
 257 .br\r
 258  Markus Breitenbach\r
 259 .br\r
 260  Thomas Steudten\r
 261 .br\r
 262  David Schmidt\r
 263 .br\r
 264  Haroon Rafique\r
 265 .br\r
 266  Jorg Strohmayer\r
 267 .br\r
 268  Shamim Mohamed\r
 269 .br\r
 270  Sarantis Paskalis\r
 271 .br\r
 272  Gabriel L. Somlo\r
 273 .br\r
 274  John Venvertloh\r
 275 .br\r
 276  Hal Burgiss\r
 277 \r
 278 .SH COPYRIGHT AND LICENSE\r
 279 Orginally written by, and copyrighted by, the Anonymous Coders and Junkbusters\r
 280 Corporation. \r
 281 .P\r
 282 This program is free software; you can redistribute it and/or modify\r
 283 it under the terms of the GNU General Public License as published by\r
 284 the Free Software Foundation; either version 2 of the License, or\r
 285 (at your option) any later version.\r
 286 .P\r
 287 This program is distributed in the hope that it will be useful,\r
 288 but WITHOUT ANY WARRANTY; without even the implied warranty of\r
 289 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
 290 GNU General Public License for more details.\r
 291 .P\r
 292 You should have received a copy of the GNU General Public License\r
 293 along with this program; if not, write to the Free Software\r
 294 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA\r
 295 .P\r
 296 Internet Junkbuster\r
 297 Proxy\r
 298 is a\r
 299 trademark\" legal.html#marks\r
 300 of Junkbusters Corporation.\r