]>
Commit | Line | Data |
---|---|---|
c152a447 AJ |
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' \- | |
10228f68 | 6 | Restrict users to certain IP addresses, using a text file backend. |
c152a447 AJ |
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 | |
10228f68 | 20 | It works by reading a pair composed by an IP address and an username |
c152a447 AJ |
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. | |
06fcded4 AJ |
27 | . |
28 | .if !'po4a'hide' .TP | |
29 | .if !'po4a'hide' .B \-f file | |
30 | Configuration | |
10228f68 AJ |
31 | .B file |
32 | to load. | |
06fcded4 AJ |
33 | . |
34 | .if !'po4a'hide' .TP | |
c152a447 AJ |
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: | |
06fcded4 AJ |
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 | |
c152a447 AJ |
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: | |
06fcded4 AJ |
53 | .if !'po4a'hide' .RS |
54 | .if !'po4a'hide' ip_addr[/netmask] username|@group|ALL|NONE | |
55 | .if !'po4a'hide' .RE | |
c152a447 AJ |
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 | |
10228f68 | 73 | , which mean \"any user on this IP address may authenticate\" or \"no user on this IP address may authenticate\". |
c152a447 AJ |
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 | |
ca02e0ec AJ |
84 | .PP |
85 | * Copyright (C) 1996-2014 The Squid Software Foundation and contributors | |
86 | * | |
87 | * Squid software is distributed under GPLv2+ license and includes | |
88 | * contributions from numerous individuals and organizations. | |
89 | * Please see the COPYING and CONTRIBUTORS files for details. | |
90 | .PP | |
c152a447 AJ |
91 | This program and documentation is copyright to the authors named above. |
92 | .PP | |
93 | Distributed under the GNU General Public License (GNU GPL) version 2 or later (GPLv2+). | |
94 | . | |
95 | .SH QUESTIONS | |
96 | Questions on the usage of this program can be sent to the | |
97 | .I Squid Users mailing list | |
98 | .if !'po4a'hide' <squid-users@squid-cache.org> | |
99 | . | |
100 | .SH REPORTING BUGS | |
101 | Bug reports need to be made in English. | |
102 | See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report. | |
103 | .PP | |
104 | Report bugs or bug fixes using http://bugs.squid-cache.org/ | |
105 | .PP | |
106 | Report serious security bugs to | |
107 | .I Squid Bugs <squid-bugs@squid-cache.org> | |
108 | .PP | |
109 | Report ideas for new improvements to the | |
110 | .I Squid Developers mailing list | |
111 | .if !'po4a'hide' <squid-dev@squid-cache.org> | |
112 | . | |
113 | .SH SEE ALSO | |
114 | .if !'po4a'hide' .BR squid "(8), " | |
115 | .if !'po4a'hide' .BR GPL "(7), " | |
116 | .br | |
117 | The Squid FAQ wiki | |
118 | .if !'po4a'hide' http://wiki.squid-cache.org/SquidFaq | |
119 | .br | |
120 | The Squid Configuration Manual | |
121 | .if !'po4a'hide' http://www.squid-cache.org/Doc/config/ |