helpers/external_acl/file_userip/ext_file_userip_acl.8

   1 .if !'po4a'hide' .TH ext_file_userip_acl 8
   2 .
   3 .SH NAME
   4 .if !'po4a'hide' .B ext_file_userip_acl
   5 .if !'po4a'hide' \-
   6 Restrict users to cetain IP addresses, using a text file backend.
   7 .PP
   8 Version 1.0
   9 .
  10 .SH SYNOPSIS
  11 .if !'po4a'hide' .B ext_file_userip_acl
  12 .if !'po4a'hide' .B [\-dh] [\-f
  13 file name
  14 .if !'po4a'hide' .B ]
  15 .
  16 .SH DESCRIPTION
  17 .B ext_file_userip_acl
  18 is an installed binary. An external helper for the Squid external acl scheme.
  19 .PP
  20 It works by reading a pair composed by an ip address and an username
  21 on STDIN and matching it against a configuration file.
  22 .
  23 .SH OPTIONS
  24 .if !'po4a'hide' .TP 12
  25 .if !'po4a'hide' .B \-d
  26 Write debug info to stderr.
  27 .
  28 .if !'po4a'hide' .TP
  29 .if !'po4a'hide' .B \-f file
  30 Configuration
  31 .B file
  32  to load.
  33 .
  34 .if !'po4a'hide' .TP
  35 .if !'po4a'hide' .B \-h
  36 Display the binary help and command line syntax info using stderr.
  37 .
  38 .SH CONFIGURATION
  39 .PP
  40 The
  41 .B squid.conf
  42 configuration for the external ACL should be:
  43 .if !'po4a'hide' .RS
  44 .if !'po4a'hide' .B external_acl_type type-name %SRC %LOGIN /path/to/ext_file_userip_acl -f /path/to/config.file
  45 .if !'po4a'hide' .RE
  46 .PP
  47 If the helper program finds a matching username/ip in the configuration file, it returns
  48 .B OK
  49 , otherwise it returns
  50 .B ERR .
  51 .PP
  52 The configuration file format is as follows:
  53 .if !'po4a'hide' .RS
  54 .if !'po4a'hide' ip_addr[/netmask]      username|@group|ALL|NONE
  55 .if !'po4a'hide' .RE
  56 .PP
  57 Where
  58 .B ip_addr
  59 is a dotted quad format IP address, the
  60 .B netmask
  61 must be in dotted quad format too.
  62 .PP
  63 When the second parameter is prefixed with an
  64 .B "@"
  65 , the program will lookup the
  66 .B "/etc/group"
  67 file entry for the specified username.
  68 .PP
  69 There are other two directives,
  70 .B ALL
  71 and
  72 .B NONE
  73 , which mean \"any user on this IP address may authenticate\" or \"no user on this ip address may authenticate\".
  74 .
  75 .SH AUTHOR
  76 This program was written by
  77 .if !'po4a'hide' .I Rodrigo Campos <rodrigo@geekbunker.org>
  78 .PP
  79 This manual was written by
  80 .if !'po4a'hide' .I Rodrigo Campos <rodrigo@geekbunker.org>
  81 .if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
  82 .
  83 .SH COPYRIGHT
  84 This program and documentation is copyright to the authors named above.
  85 .PP
  86 Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).
  87 .
  88 .SH QUESTIONS
  89 Questions on the usage of this program can be sent to the
  90 .I Squid Users mailing list
  91 .if !'po4a'hide' <squid-users@squid-cache.org>
  92 .
  93 .SH REPORTING BUGS
  94 Bug reports need to be made in English.
  95 See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
  96 .PP
  97 Report bugs or bug fixes using http://bugs.squid-cache.org/
  98 .PP
  99 Report serious security bugs to
 100 .I Squid Bugs <squid-bugs@squid-cache.org>
 101 .PP
 102 Report ideas for new improvements to the
 103 .I Squid Developers mailing list
 104 .if !'po4a'hide' <squid-dev@squid-cache.org>
 105 .
 106 .SH SEE ALSO
 107 .if !'po4a'hide' .BR squid "(8), "
 108 .if !'po4a'hide' .BR GPL "(7), "
 109 .br
 110 The Squid FAQ wiki
 111 .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
 112 .br
 113 The Squid Configuration Manual
 114 .if !'po4a'hide' http://www.squid-cache.org/Doc/config/