Source Format Enforcement (#763)

[thirdparty/squid.git] / src / acl / external / file_userip / ext_file_userip_acl.8

.if !'po4a'hide' .TH ext_file_userip_acl 8
.
.SH NAME
ext_file_userip_acl \- Restrict users to certain IP addresses, using a text file backend.
.PP
Version 1.0
.
.SH SYNOPSIS
.if !'po4a'hide' .B ext_file_userip_acl
.if !'po4a'hide' .B [\-dh] [\-f 
file name
.if !'po4a'hide' .B ]
.
.SH DESCRIPTION
.B ext_file_userip_acl
is an installed binary. An external helper for the Squid external acl scheme.
.PP
It works by reading a pair composed by an IP address and an username
on STDIN and matching it against a configuration file.
.
.SH OPTIONS
.if !'po4a'hide' .TP 12
.if !'po4a'hide' .B \-d
Write debug info to stderr.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-f file
Configuration 
.B file 
to load.
.
.if !'po4a'hide' .TP
.if !'po4a'hide' .B \-h
Display the binary help and command line syntax info using stderr.
.
.SH CONFIGURATION
.PP
The 
.B squid.conf 
configuration for the external ACL should be:
.if !'po4a'hide' .RS
.if !'po4a'hide' .B external_acl_type type-name %SRC %LOGIN /path/to/ext_file_userip_acl -f /path/to/config.file
.if !'po4a'hide' .RE
.PP
If the helper program finds a matching username/ip in the configuration file, it returns
.B OK
, otherwise it returns
.B ERR .
.PP
The configuration file format is as follows:
.if !'po4a'hide' .RS
.if !'po4a'hide' ip_addr[/netmask]	username|@group|ALL|NONE
.if !'po4a'hide' .RE
.PP
Where 
.B ip_addr 
is a dotted quad format IP address, the 
.B netmask
must be in dotted quad format too.
.PP
When the second parameter is prefixed with an 
.B "@"
, the program will lookup the
.B "/etc/group"
file entry for the specified username.
.PP
There are other two directives, 
.B ALL 
and 
.B NONE 
, which mean \(dqany user on this IP address may authenticate\(dq or \(dqno user on this IP address may authenticate\(dq.
.
.SH AUTHOR
This program was written by
.if !'po4a'hide' .I Rodrigo Campos <rodrigo@geekbunker.org>
.PP
This manual was written by
.if !'po4a'hide' .I Rodrigo Campos <rodrigo@geekbunker.org>
.if !'po4a'hide' .I Amos Jeffries <amosjeffries@squid-cache.org>
.
.SH COPYRIGHT
.PP
 * Copyright (C) 1996-2021 The Squid Software Foundation and contributors
 *
 * Squid software is distributed under GPLv2+ license and includes
 * contributions from numerous individuals and organizations.
 * Please see the COPYING and CONTRIBUTORS files for details.
.PP
This program and documentation is copyright to the authors named above.
.PP
Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+).
.
.SH QUESTIONS
Questions on the usage of this program can be sent to the
.I Squid Users mailing list
.if !'po4a'hide' <squid-users@lists.squid-cache.org>
.
.SH REPORTING BUGS
Bug reports need to be made in English.
See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
.PP
Report bugs or bug fixes using http://bugs.squid-cache.org/
.PP
Report serious security bugs to
.I Squid Bugs <squid-bugs@lists.squid-cache.org>
.PP
Report ideas for new improvements to the
.I Squid Developers mailing list
.if !'po4a'hide' <squid-dev@lists.squid-cache.org>
.
.SH SEE ALSO
.if !'po4a'hide' .BR squid "(8), "
.if !'po4a'hide' .BR GPL "(7), "
.br
The Squid FAQ wiki
.if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq
.br
The Squid Configuration Manual
.if !'po4a'hide' http://www.squid-cache.org/Doc/config/