← Back to branch summary

~clint-fewbar/ubuntu/precise/squid3/ignore-sighup-early

« back to all changes in this revision

Viewing changes to helpers/external_acl/ldap_group/squid_ldap_group.8

  • Committer: Bazaar Package Importer
  • Author(s): Luigi Gangitano
  • Date: 2006-11-11 10:32:06 UTC
  • Revision ID: james.westby@ubuntu.com-20061111103206-f3p0r9g0vq44rp3r
Tags: upstream-3.0.PRE5
Import upstream version 3.0.PRE5

Show diffs side-by-side

added added

removed removed

Lines of Context:
helpers/external_acl/ldap_group/squid_ldap_group.8
 
1
.TH squid_ldap_group 8 "30 January 2005" "Version 2.17"
 
2
.
 
3
.SH NAME
 
4
squid_ldap_group - Squid LDAP external acl group helper
 
5
.
 
6
.SH SYNOPSIS
 
7
squid_ldap_group -b "base DN" -f "LDAP search filter" [options] [ldap_server_name[:port]|URI]...
 
8
.
 
9
.SH DESCRIPTION
 
10
This helper allows Squid to connect to a LDAP directory to
 
11
authorize users via LDAP groups.
 
12
LDAP options are specified as parameters on the command line,
 
13
while the username(s) and group(s) to be checked against the
 
14
LDAP directory are specified on subsequent lines of input to the
 
15
helper, one username/group pair per line separated by a space.
 
16
.P
 
17
As expected by the external_acl construct of Squid, after
 
18
specifying a username and group followed by a new line, this
 
19
helper will produce either OK or ERR on the following line
 
20
to show if the user is a member of the specified group.
 
21
.P
 
22
The program operates by searching with a search filter based
 
23
on the users user name and requested group, and if a match
 
24
is found it is determined that the user belongs to the group.
 
25
.
 
26
.TP
 
27
.BI "-b " "basedn " (REQUIRED)
 
28
Specifies the base DN under which the groups are located.
 
29
.
 
30
.TP
 
31
.BI "-B " "basedn "
 
32
Specifies the base DN under which the users are located (if different)
 
33
.
 
34
.TP
 
35
.B "-g"
 
36
Specifies that the first query argument sent to the helper by Squid is
 
37
a extension to the basedn and will be temporarily added in front of the
 
38
global basedn for this query.
 
39
.
 
40
.TP
 
41
.BI "-f " filter
 
42
LDAP search filter used to search the LDAP directory for any
 
43
matching group memberships.
 
44
.BR
 
45
In the filter %u will be replaced by the user name (or DN if
 
46
the -F or -u options are used) and %g by the requested group name.
 
47
.
 
48
.TP
 
49
.BI "-F " filter
 
50
LDAP search filter used to search the LDAP directory for any
 
51
matching users.
 
52
.BR
 
53
In the filter %s will be replaced by the user name. If % is to be
 
54
included literally in the filter then use %%.
 
55
.
 
56
.TP
 
57
.BI "-u " attr
 
58
LDAP attribute used to construct the user DN from the user name and
 
59
base dn without needing to search for the user.
 
60
.
 
61
.TP
 
62
.BI "-s " base|one|sub
 
63
search scope. Defaults to 'sub'.
 
64
.IP
 
65
.B base
 
66
object only,
 
67
.B one
 
68
level below the base object or
 
69
.BR sub tree
 
70
below the base object
 
71
.
 
72
.TP
 
73
.BI "-D " "binddn " "-w " password
 
74
The DN and password to bind as while performing searches. Required
 
75
if the directory does not allow anonymous searches.
 
76
.IP
 
77
As the password needs to be printed in plain text in your Squid configuration
 
78
and will be sent on the command line to the helper it is strongly recommended
 
79
to use a account with minimal associated privileges.  This to limit the damage
 
80
in case someone could get hold of a copy of your Squid configuration file or
 
81
extracts the password used from a process listing.
 
82
.
 
83
.TP
 
84
.BI "-D " "binddn " "-W " "secretfile "
 
85
The DN and the name of a file containing the password
 
86
to bind as while performing searches. 
 
87
.IP
 
88
Less insecure version of the former parameter pair with two advantages:
 
89
The password does not occur in the process listing, 
 
90
and the password is not being compromised if someone gets the squid 
 
91
configuration file without getting the secretfile.
 
92
.
 
93
.TP
 
94
.BI -P
 
95
Use a persistent LDAP connection. Normally the LDAP connection
 
96
is only open while verifying a users group membership to preserve
 
97
resources at the LDAP server. This option causes the LDAP connection to
 
98
be kept open, allowing it to be reused for further user
 
99
validations. Recommended for larger installations.
 
100
.
 
101
.TP
 
102
.BI -R
 
103
do not follow referrals
 
104
.
 
105
.TP
 
106
.BI "-a " never|always|search|find
 
107
when to dereference aliases. Defaults to 'never'
 
108
.IP
 
109
.BI never
 
110
dereference aliases (default),
 
111
.BI always
 
112
dereference aliases, only while
 
113
.BR search ing
 
114
or only to
 
115
.B find
 
116
the base object
 
117
.
 
118
.TP
 
119
.BI -H " ldapuri"
 
120
Specity the LDAP server to connect to by a LDAP URI (requires OpenLDAP libraries)
 
121
.
 
122
.TP
 
123
.BI -h " ldapserver"
 
124
Specify the LDAP server to connect to
 
125
.TP
 
126
.BI -p " ldapport"
 
127
Specify an alternate TCP port where the ldap server is listening if
 
128
other than the default LDAP port 389.
 
129
.
 
130
.TP
 
131
.BI -v " 2|3"
 
132
LDAP protocol version. Defaults to 2 if not specified.
 
133
.
 
134
.TP
 
135
.BI -Z
 
136
Use TLS encryption
 
137
.
 
138
.TP
 
139
.BI -E certpath
 
140
Enable LDAP over SSL (requires Netscape LDAP API libraries)
 
141
.
 
142
.TP
 
143
.BI -c connect_timeout
 
144
Specify timeout used when connecting to LDAP servers (requires
 
145
Netscape LDAP API libraries)
 
146
.TP
 
147
.BI -t search_timeout
 
148
Specify time limit on LDAP search operations
 
149
.
 
150
.TP
 
151
.BI -S
 
152
Strip NT domain name component from user names (/ or \\ separated)
 
153
.
 
154
.TP
 
155
.BI -d
 
156
Debug mode where each step taken will get reported in detail.
 
157
Useful for understanding what goes wrong if the results is
 
158
not what is expected.
 
159
 
 
160
.SH SQUID CONFIGURATION
 
161
.
 
162
This helper is intended to be used as a external_acl_type helper from
 
163
squid.conf.
 
164
.P
 
165
.ft CR
 
166
.nf
 
167
external_acl_type ldap_group %LOGIN /path/to/squid_ldap_group ...
 
168
.br
 
169
acl group1 external ldap_group Group1
 
170
.br
 
171
acl group2 external ldap_group Group2
 
172
.fi
 
173
.ft
 
174
.
 
175
.SH NOTES
 
176
.
 
177
When constructing search filters it is recommended to first test the filter
 
178
using ldapsearch before you attempt to use squid_ldap_group. This to verify
 
179
that the filter matches what you expect.
 
180
.
 
181
.SH AUTHOR
 
182
This manual page was written by 
 
183
.I Henrik Nordstrom <hno@marasystems.com>
 
184
.P
 
185
squid_ldap_group is written by 
 
186
.I Flavio Pescuma <flavio@marasystems.com>
 
187
and
 
188
.IR "Henrik Nordstrom <hno@squid-cache.org>" ,
 
189
based on prior work in squid_ldap_auth by
 
190
.I Glen Newton <glen.newton@nrc.ca>
 
191
.
 
192
.SH KNOWN LIMITATIONS
 
193
Max 16 occurrences of %s in the -u argument is supported.
 
194
.
 
195
.SH QUESTIONS
 
196
Any questions on usage can be sent to 
 
197
.IR "Squid Users <squid-users@squid-cache.org>" ,
 
198
or to your favorite LDAP list/friend if the question is more related to
 
199
LDAP than Squid.
 
200
.
 
201
.SH REPORTING BUGS
 
202
Report bugs or bug-fixes to
 
203
.I Squid Bugs <squid-bugs@squid-cache.org>
 
204
or ideas for new improvements to 
 
205
.I Squid Developers <squid-dev@squid-cache.org>
 
206
.
 
207
.SH "SEE ALSO"
 
208
.BR squid_ldap_auth ( 8 ),
 
209
.BR ldapsearch ( 1 ),
 
210
.br
 
211
Your favorite LDAP documentation
 
212
.br
 
213
.BR RFC2254 " - The String Representation of LDAP Search Filters,"