source: squid-ssl/trunk/fuentes/helpers/external_acl/file_userip/ext_file_userip_acl.8 @ 5495

Last change on this file since 5495 was 5495, checked in by Juanma, 2 years ago

Initial release

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