ldap.erb 22.9 KB
Newer Older
1
2
# -*- text -*-
#
3
#  $Id: 1741d7e6ed472617f190f90a545272be980a6ff1 $
4
5
6
7

#
#  Lightweight Directory Access Protocol (LDAP)
#
8
ldap <%= @name %> {
9
10
11
12
	#  Note that this needs to match the name(s) in the LDAP server
	#  certificate, if you're using ldaps.  See OpenLDAP documentation
	#  for the behavioral semantics of specifying more than one host.
	#
13
14
	#  Depending on the libldap in use, server may be an LDAP URI.
	#  In the case of OpenLDAP this allows additional the following
15
	#  additional schemes:
16
17
18
19
20
21
	#  - ldaps:// (LDAP over SSL)
	#  - ldapi:// (LDAP over Unix socket)
	#  - ldapc:// (Connectionless LDAP)
	server = 'localhost'
#	server = 'ldap.rrdns.example.org'
#	server = 'ldap.rrdns.example.org'
Jonathan Gazeley's avatar
Jonathan Gazeley committed
22
<% @serverconcatarray.each do |srv| -%>	server = '<%= srv %>'
23
<% end -%>
24
25

	#  Port to connect on, defaults to 389, will be ignored for LDAP URIs.
26
#	port = 389
27
	port = <%= @port %>
28
29
30

	#  Administrator account for searching and possibly modifying.
	#  If using SASL + KRB5 these should be commented out.
31
32
#	identity = 'cn=admin,dc=example,dc=org'
#	password = mypass
33
<%- if @identity -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
34
	identity = '<%= @identity %>'
35
36
<%- end -%>
<%- if @password -%>
Jason Lavoie's avatar
Jason Lavoie committed
37
	password = '<%= @password %>'
38
<%- end -%>
39
40
41

	#  Unless overridden in another section, the dn from which all
	#  searches will start from.
42
#	base_dn = 'dc=example,dc=org'
43
44
	base_dn = '<%= @basedn %>'

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
	#
	#  You can run the 'ldapsearch' command line tool using the
	#  parameters from this module's configuration.
	#
	#    ldapsearch -D ${identity} -w ${password} -h ${server}  -b 'CN=user,${base_dn}'
	#
	#  That will give you the LDAP information for 'user'.
	#
	#  Group membership can be queried by using the above "ldapsearch" string,
	#  and adding "memberof" qualifiers.  For ActiveDirectory, use:
	#
	#    ldapsearch ... '(&(objectClass=user)(sAMAccountName=user)(memberof=CN=group,${base_dn}))'
	#
	#  Where 'user' is the user as above, and 'group' is the group you are querying for.
	#

61
62
63
	#
	#  SASL parameters to use for admin binds
	#
64
65
66
	#  When we're prompted by the SASL library, these control
	#  the responses given, as well as the identity and password
	#  directives above.
67
68
69
70
71
72
	#
	#  If any directive is commented out, a NULL response will be
	#  provided to cyrus-sasl.
	#
	#  Unfortunately the only way to control Keberos here is through
	#  environmental variables, as cyrus-sasl provides no API to
73
	#  set the krb5 config directly.
74
75
76
77
78
79
80
81
	#
	#  Full documentation for MIT krb5 can be found here:
	#
	#	http://web.mit.edu/kerberos/krb5-devel/doc/admin/env_variables.html
	#
	#  At a minimum you probably want to set KRB5_CLIENT_KTNAME.
	#
	sasl {
82
		# SASL mechanism
83
84
#		mech = 'PLAIN'
<%- if @sasl.has_key?('mech') -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
85
		mech = '<%= @sasl['mech'] %>'
86
<%- end -%>
87

88
		# SASL authorisation identity to proxy.
89
90
#		proxy = 'autz_id'
<%- if @sasl.has_key?('proxy') -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
91
		proxy = '<%= @sasl['proxy'] %>'
92
<%- end -%>
93

94
		# SASL realm. Used for kerberos.
95
96
#		realm = 'example.org'
<%- if @sasl.has_key?('realm') -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
97
		realm = '<%= @sasl['realm'] %>'
98
<%- end -%>
99
100
101
102
103
104
105
106
107
108
	}

	#
	#  Generic valuepair attribute
	#

	#  If set, this will attribute will be retrieved in addition to any
	#  mapped attributes.
	#
	#  Values should be in the format:
109
	#  	<radius attr> <op> <value>
110
111
	#
	#  Where:
112
	#  	<radius attr>:	Is the attribute you wish to create
113
114
	# 			with any valid list and request qualifiers.
	#  	<op>: 		Is any assignment operator (=, :=, +=, -=).
115
	#  	<value>:	Is the value to parse into the new valuepair.
116
117
	# 			If the value is wrapped in double quotes it
	#			will be xlat expanded.
118
119
#	valuepair_attribute = 'radiusAttribute'
<%- if @valuepair_attribute -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
120
	valuepair_attribute = <%= @valuepair_attribute %>
121
<%- end -%>
122
123
124
125
126
127
128
129
130
131

	#
	#  Mapping of LDAP directory attributes to RADIUS dictionary attributes.
	#

	#  WARNING: Although this format is almost identical to the unlang
	#  update section format, it does *NOT* mean that you can use other
	#  unlang constructs in module configuration files.
	#
	#  Configuration items are in the format:
132
	# 	<radius attr> <op> <ldap attr>
133
134
	#
	#  Where:
135
	#  	<radius attr>:	Is the destination RADIUS attribute
136
137
138
139
140
141
142
	# 			with any valid list and request qualifiers.
	#  	<op>: 		Is any assignment attribute (=, :=, +=, -=).
	#  	<ldap attr>:	Is the attribute associated with user or
	#			profile objects in the LDAP directory.
	# 			If the attribute name is wrapped in double
	# 			quotes it will be xlat expanded.
	#
143
144
145
	#  Request and list qualifiers may also be placed after the 'update'
	#  section name to set defaults destination requests/lists
	#  for unqualified RADIUS attributes.
146
147
	#
	#  Note: LDAP attribute names should be single quoted unless you want
148
149
	#  the name value to be derived from an xlat expansion, or an
	#  attribute ref.
150
	update {
151
#		control:Password-With-Header	+= 'userPassword'
152
153
154
155
156
157
158
159
160
#		control:NT-Password		:= 'ntPassword'
#		reply:Reply-Message		:= 'radiusReplyMessage'
#		reply:Tunnel-Type		:= 'radiusTunnelType'
#		reply:Tunnel-Medium-Type	:= 'radiusTunnelMediumType'
#		reply:Tunnel-Private-Group-ID	:= 'radiusTunnelPrivategroupId'

		#  Where only a list is specified as the RADIUS attribute,
		#  the value of the LDAP attribute is parsed as a valuepair
		#  in the same format as the 'valuepair_attribute' (above).
161
162
163
164
165
166
167
168
#		control:			+= 'radiusControlAttribute'
#		request:			+= 'radiusRequestAttribute'
#		reply:				+= 'radiusReplyAttribute'
<%- if @update -%>
		<%= @update.join("\n		") %>
<%- else -%>
	update {
		control:Password-With-Header	+= 'userPassword'
169
170
171
		control:			+= 'radiusControlAttribute'
		request:			+= 'radiusRequestAttribute'
		reply:				+= 'radiusReplyAttribute'
172
	}
173
<%- end -%>
174

175
176
	}

177
178
	#  Set to yes if you have eDirectory and want to use the universal
	#  password mechanism.
179
180
#	edir = no
<%- if @edir -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
181
	edir = <%= @edir %>
182
<%- end -%>
183

184

185
186
187
	#  Set to yes if you want to bind as the user after retrieving the
	#  Cleartext-Password. This will consume the login grace, and
	#  verify user authorization.
188
189
#	edir_autz = no
<%- if @edir_autz -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
190
	edir_autz = <%= @edir_autz %>
191
<%- end -%>
192
193
194

	#  Note: set_auth_type was removed in v3.x.x
	#
195
196
197
198
199
	#  Equivalent functionality can be achieved by adding the
	#  following "if" statement to the authorize {} section of
	#  the virtual server, after the "ldap" module.  For example:
	#
	#    ...
200
	#    ldap
201
	#    if ((ok || updated) && User-Password && !control:Auth-Type) {
202
203
204
205
	#        update {
	#            control:Auth-Type := ldap
	#        }
	#    }
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
	#    ...
	#
	#  You will also need to uncomment the "Auth-Type LDAP" block in the
	#  "authenticate" section.
	#

	#
	#  Name of the attribute that contains the user DN.
	#  The default name is LDAP-UserDn.
	#
	#  If you have multiple LDAP instances, you should
	#  change this configuration item to:
	#
	#	${.:instance}-LDAP-UserDn
	#
	#  That change allows the modules to set their own
	#  User DN, and to not conflict with each other.
	#
	user_dn = "LDAP-UserDn"
225
226
227
228
229
230

	#
	#  User object identification.
	#
	user {
		#  Where to start searching in the tree for users
231
    	base_dn = "<%= @user_base_dn %>"
232
233
234

		#  Filter for user objects, should be specific enough
		#  to identify a single user object.
235
236
237
238
239
240
		#
		#  For Active Directory, you should use
		#  "samaccountname=" instead of "uid="
		#
#		filter = "(uid=%{%{Stripped-User-Name}:-%{User-Name}})"
		filter = "<%= @user_filter %>"
241
242
243
244
245
246
247

		#  SASL parameters to use for user binds
		#
		#  When we're prompted by the SASL library, these control
		#  the responses given.
		#
		#  Any of the config items below may be an attribute ref
248
249
		#  or and expansion, so different SASL mechs, proxy IDs
		#  and realms may be used for different users.
250
		sasl {
251
			# SASL mechanism
252
253
#			mech = 'PLAIN'
<%- if @user_sasl.has_key?('mech') -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
254
			mech = '<%= @user_sasl['mech'] %>'
255
<%- end -%>
256

257
			# SASL authorisation identity to proxy.
258
259
#			proxy = &User-Name
<%- if @user_sasl.has_key?('proxy') -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
260
			proxy = '<%= @user_sasl['proxy'] %>'
261
<%- end -%>
262

263
			# SASL realm. Used for kerberos.
264
265
266
267
#			realm = 'example.org'
<%- if @user_sasl.has_key?('realm') -%>
			# SASL realm. Used for kerberos.
<%- end -%>
268
269
		}

270
		#  Search scope, may be 'base', 'one', sub' or 'children'
271
272
#		scope = 'sub'
<%- if @user_scope -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
273
		scope = '<%= @user_scope %>'
274
<%- end -%>
275
276
277

		#  Server side result sorting
		#
278
279
280
		#  A list of space delimited attributes to order the result
		#  set by, if the filter matches multiple objects.
		#  Only the first result in the set will be processed.
281
282
283
284
285
286
		#
		#  If the attribute name is prefixed with a hyphen '-' the
		#  sorting order will be reversed for that attribute.
		#
		#  If sort_by is set, and the server does not support sorting
		#  the search will fail.
287
288
#		sort_by = '-uid'
<%- if @user_sort_by -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
289
		sort_by = '<%= @user_sort_by %>'
290
<%- end -%>
291
292
293
294

		#  If this is undefined, anyone is authorised.
		#  If it is defined, the contents of this attribute
		#  determine whether or not the user is authorised
295
296
#		access_attribute = 'dialupAccess'
<%- if @user_access_attribute -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
297
		access_attribute = '<%= @user_access_attribute %>'
298
<%- end -%>
299
300
301
302
303
304
305
306
307
308
309
310

		#  Control whether the presence of 'access_attribute'
		#  allows access, or denys access.
		#
		#  If 'yes', and the access_attribute is present, or
		#  'no' and the access_attribute is absent then access
		#  will be allowed.
		#
		#  If 'yes', and the access_attribute is absent, or
		#  'no' and the access_attribute is present, then
		#  access will not be allowed.
		#
311
312
		#  If the value of the access_attribute is 'false', it
		#  will negate the result.
313
314
315
316
317
318
319
320
321
		#
		#  e.g.
		#    access_positive = yes
		#    access_attribute = userAccessAllowed
		#
		#  With an LDAP object containing:
		#    userAccessAllowed: false
		#
		#  Will result in the user being locked out.
322
323
#		access_positive = yes
<%- if @user_access_positive -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
324
		access_positive = <%= @user_access_positive %>
325
<%- end -%>
326
327
328
329
330
331
332
	}

	#
	#  User membership checking.
	#
	group {
		#  Where to start searching in the tree for groups
333
#		base_dn = "${..base_dn}"
Jonathan Gazeley's avatar
Jonathan Gazeley committed
334
		base_dn = "<%= @group_base_dn %>"
335

336

337
338
		#  Filter for group objects, should match all available
		#  group objects a user might be a member of.
339
340
341
342
		#
		#  If using Active Directory you are likely to need "group"
		#  instead of "posixGroup".
#		filter = '(objectClass=posixGroup)'
Jonathan Gazeley's avatar
Jonathan Gazeley committed
343
		filter = "<%= @group_filter %>"
344

345
		# Search scope, may be 'base', 'one', sub' or 'children'
346
347
#		scope = 'sub'
<%- if @group_scope -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
348
		scope = '<%= @group_scope %>'
349
<%- end -%>
350
351
352
353

		#  Attribute that uniquely identifies a group.
		#  Is used when converting group DNs to group
		#  names.
354
355
#		name_attribute = cn
<%- if @group_name_attribute -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
356
		name_attribute = <%= @group_name_attribute %>
357
<%- end -%>
358

359
		#  Filter to find all group objects a user is a member of.
360
361
		#  That is, group objects with attributes that
		#  identify members (the inverse of membership_attribute).
362
363
364
365
366
367
		#
		#  Note that this configuration references the "user_dn"
		#  configuration defined above.
		#
#		membership_filter = "(|(member=%{control:${..user_dn}})(memberUid=%{%{Stripped-User-Name}:-%{User-Name}}))"
<%- if @group_membership_filter -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
368
		membership_filter = "<%= @group_membership_filter %>"
369
<%- end -%>
370

371
		#  The attribute, in user objects, which contain the names
372
373
374
375
376
		#  or DNs of groups a user is a member of.
		#
		#  Unless a conversion between group name and group DN is
		#  needed, there's no requirement for the group objects
		#  referenced to actually exist.
377
378
379
380
381
382
383
384
		#
		#  If the LDAP server does not support the "memberOf"
		#  attribute (or equivalent), then you will need to use the
		#  membership_filter option above instead. If you can't see
		#  the memberOf attribute then it is also possible that the
		#  LDAP bind user does not have the correct permissions to
		#  view it.
#		membership_attribute = 'memberOf'
Jonathan Gazeley's avatar
Jonathan Gazeley committed
385
		membership_attribute = '<%= @group_membership_attribute %>'
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400

		#  If cacheable_name or cacheable_dn are enabled,
		#  all group information for the user will be
		#  retrieved from the directory and written to LDAP-Group
		#  attributes appropriate for the instance of rlm_ldap.
		#
		#  For group comparisons these attributes will be checked
		#  instead of querying the LDAP directory directly.
		#
		#  This feature is intended to be used with rlm_cache.
		#
		#  If you wish to use this feature, you should enable
		#  the type that matches the format of your check items
		#  i.e. if your groups are specified as DNs then enable
		#  cacheable_dn else enable cacheable_name.
401
402
403
#		cacheable_name = 'no'
#		cacheable_dn = 'no'
<%- if @group_cacheable_name -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
404
		cacheable_name = '<%= @group_cacheable_name %>'
405
406
<%- end -%>
<%- if @group_cacheable_dn -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
407
		cacheable_dn = '<%= @group_cacheable_dn %>'
408
<%- end -%>
409
410
411
412
413

		#  Override the normal cache attribute (<inst>-LDAP-Group or
		#  LDAP-Group if using the default instance) and create a
		#  custom attribute.  This can help if multiple module instances
		#  are used in fail-over.
414
415
#		cache_attribute = 'LDAP-Cached-Membership'
<%- if @group_cache_attribute -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
416
		cache_attribute = '<%= @group_cache_attribute %>'
417
<%- end -%>
418

419
420
421
422
423
424
425
		#  If the group being checked is specified as a name, but
		#  the user's groups are referenced by DN, and one of those
		#  group DNs is invalid, the whole group check is treated as
		#  invalid, and a negative result will be returned.
		#  When set to 'yes', this option ignores invalid DN
		#  references.
#		allow_dangling_group_ref = 'no'
426
427
428
429
430
431
432
433
	}

	#
	#  User profiles. RADIUS profile objects contain sets of attributes
	#  to insert into the request. These attributes are mapped using
	#  the same mapping scheme applied to user objects (the update section above).
	#
	profile {
434
		#  Filter for RADIUS profile objects
435
436
#		filter = '(objectclass=radiusprofile)'
<%- if @profile_filter -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
437
		filter = '<%= @profile_filter %>'
438
<%- end -%>
439
440
441
442
443
444

		#  The default profile.  This may be a DN or an attribute
		#  reference.
		#  To get old v2.2.x style behaviour, or to use the
		#  &User-Profile attribute to specify the default profile,
		#  set this to &control:User-Profile.
445
446
#		default = 'cn=radprofile,dc=example,dc=org'
<%- if @profile_default -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
447
		default = '<%= @profile_default %>'
448
<%- end -%>
449
450
451
452
453
454

		#  The LDAP attribute containing profile DNs to apply
		#  in addition to the default profile above.  These are
		#  retrieved from the user object, at the same time as the
		#  attributes from the update section, are are applied
		#  if authorization is successful.
455
456
#		attribute = 'radiusProfileDn'
<%- if @profile_attribute -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
457
		attribute = '<%= @profile_attribute %>'
458
<%- end -%>
459
460
461
462
463
464
465
	}

	#
	#  Bulk load clients from the directory
	#
	client {
		#   Where to start searching in the tree for clients
466
#		base_dn = "${..base_dn}"
Jonathan Gazeley's avatar
Jonathan Gazeley committed
467
		base_dn = "<%= @client_base_dn %>"
468
469
470
471

		#
		#  Filter to match client objects
		#
472
#		filter = '(objectClass=radiusClient)'
Jonathan Gazeley's avatar
Jonathan Gazeley committed
473
		filter = '<%= @client_filter %>'
474

475
		# Search scope, may be 'base', 'one', 'sub' or 'children'
476
477
#		scope = 'sub'
<%- if @client_scope -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
478
		scope = '<%= @client_scope %>'
479
<%- end -%>
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519

		#
		#  Sets default values (not obtained from LDAP) for new client entries
		#
		template {
#			login				= 'test'
#			password			= 'test'
#			proto	 			= tcp
#			require_message_authenticator	= yes

			# Uncomment to add a home_server with the same
			# attributes as the client.
#			coa_server {
#				response_window = 2.0
#			}
		}

		#
		#  Client attribute mappings are in the format:
		#      <client attribute> = <ldap attribute>
		#
		#  The following attributes are required:
		#    * ipaddr | ipv4addr | ipv6addr - Client IP Address.
		#    * secret - RADIUS shared secret.
		#
		#  All other attributes usually supported in a client
		#  definition are also supported here.
		#
		#  Schemas are available in doc/schemas/ldap for openldap and eDirectory
		#
		attribute {
			ipaddr				= 'radiusClientIdentifier'
			secret				= 'radiusClientSecret'
#			shortname			= 'radiusClientShortname'
#			nas_type			= 'radiusClientType'
#			virtual_server			= 'radiusClientVirtualServer'
#			require_message_authenticator	= 'radiusClientRequireMa'
		}
	}

520
	#  Load clients on startup
521
522
#	read_clients = no
<%- if @read_clients -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
523
	read_clients = <%= @read_clients %>
524
<%- end -%>
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589

	#
	#  Modify user object on receiving Accounting-Request
	#

	#  Useful for recording things like the last time the user logged
	#  in, or the Acct-Session-ID for CoA/DM.
	#
	#  LDAP modification items are in the format:
	# 	<ldap attr> <op> <value>
	#
	#  Where:
	#  	<ldap attr>:	The LDAP attribute to add modify or delete.
	#  	<op>: 		One of the assignment operators:
	#			(:=, +=, -=, ++).
	#			Note: '=' is *not* supported.
	#  	<value>:	The value to add modify or delete.
	#
	#  WARNING: If using the ':=' operator with a multi-valued LDAP
	#  attribute, all instances of the attribute will be removed and
	#  replaced with a single attribute.
	accounting {
		reference = "%{tolower:type.%{Acct-Status-Type}}"

		type {
			start {
				update {
					description := "Online at %S"
				}
			}

			interim-update {
				update {
					description := "Last seen at %S"
				}
			}

			stop {
				update {
					description := "Offline at %S"
				}
			}
		}
	}

	#
	#  Post-Auth can modify LDAP objects too
	#
	post-auth {
		update {
			description := "Authenticated at %S"
		}
	}

	#
	#  LDAP connection-specific options.
	#
	#  These options set timeouts, keep-alives, etc. for the connections.
	#
	options {
		#  Control under which situations aliases are followed.
		#  May be one of 'never', 'searching', 'finding' or 'always'
		#  default: libldap's default which is usually 'never'.
		#
		#  LDAP_OPT_DEREF is set to this value.
590
591
#		dereference = 'always'
<%- if @dereference -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
592
		dereference = '<%= @dereference %>'
593
<%- end -%>
594
595
596
597
598
599
600
601

		#
		#  The following two configuration items control whether the
		#  server follows references returned by LDAP directory.
		#  They are  mostly for Active Directory compatibility.
		#  If you set these to 'no', then searches will likely return
		#  'operations error', instead of a useful result.
		#
Jonathan Gazeley's avatar
Jonathan Gazeley committed
602
603
		chase_referrals = <%= @chase_referrals %>
		rebind = <%= @rebind %>
604

605
606
607
608
609
		# SASL Security Properties (see SASL_SECPROPS in ldap.conf man page).
		# Note - uncomment when using GSS-API sasl mechanism along with TLS
		# encryption against Active-Directory LDAP servers (this disables
		# sealing and signing at the GSS level as required by AD).
		#sasl_secprops = 'noanonymous,noplain,maxssf=0'
610
611
612
613
614
615
616
617

		#  Seconds to wait for LDAP query to finish. default: 20
		res_timeout = <%= @timeout %>

		#  Seconds LDAP server has to process the query (server-side
		#  time limit). default: 20
		#
		#  LDAP_OPT_TIMELIMIT is set to this value.
Jonathan Gazeley's avatar
Jonathan Gazeley committed
618
		srv_timelimit = <%= @timelimit %>
619

620
621
622
623
624
625
		#  Seconds to wait for response of the server. (network
		#  failures) default: 10
		#
		#  LDAP_OPT_NETWORK_TIMEOUT is set to this value.
		net_timeout = 1

626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
		#  LDAP_OPT_X_KEEPALIVE_IDLE
		idle = <%= @idle %>

		#  LDAP_OPT_X_KEEPALIVE_PROBES
		probes = <%= @probes %>

		#  LDAP_OPT_X_KEEPALIVE_INTERVAL
		interval = <%= @interval %>

		#  ldap_debug: debug flag for LDAP SDK
		#  (see OpenLDAP documentation).  Set this to enable
		#  huge amounts of LDAP debugging on the screen.
		#  You should only use this if you are an LDAP expert.
		#
		#	default: 0x0000 (no debugging messages)
		#	Example:(LDAP_DEBUG_FILTER+LDAP_DEBUG_CONNS)
Jonathan Gazeley's avatar
Jonathan Gazeley committed
642
		ldap_debug = <%= @ldap_debug %>
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
	}

	#
	#  This subsection configures the tls related items
	#  that control how FreeRADIUS connects to an LDAP
	#  server.  It contains all of the 'tls_*' configuration
	#  entries used in older versions of FreeRADIUS.  Those
	#  configuration entries can still be used, but we recommend
	#  using these.
	#
	tls {
		# Set this to 'yes' to use TLS encrypted connections
		# to the LDAP database by using the StartTLS extended
		# operation.
		#
		# The StartTLS operation is supposed to be
		# used with normal ldap connections instead of
		# using ldaps (port 636) connections
661
#		start_tls = yes
662
663
		start_tls = <%= @starttls %>

664
665
666
667
668
669
670
#		ca_file	= ${certdir}/cacert.pem

#		ca_path	= ${certdir}
#		certificate_file = /path/to/radius.crt
#		private_key_file = /path/to/radius.key
#		random_file = /dev/urandom

671
<% if @cafile -%>
672
		ca_file = <%= @cafile %>
673
<% end -%>
674

675
676
677
<% if @capath -%>
		ca_path = <%= @capath %>
<% end -%>
678
<% if @certfile -%>
679
680
		certificate_file = <%= @certfile %>
<% end -%>
681
<% if @keyfile -%>
682
683
		private_key_file = <%= @keyfile %>
<% end -%>
684
<%- if @random_file -%>
Jonathan Gazeley's avatar
Jonathan Gazeley committed
685
		random_file = <%= @random_file %>
686
<%- end -%>
687

688
 		#  Certificate Verification requirements.  Can be:
689
		#    'never' (do not even bother trying)
690
 		#    'allow' (try, but don't fail if the certificate
691
692
693
694
695
696
697
		#		cannot be verified)
		#    'demand' (fail if the certificate does not verify)
		#    'hard'  (similar to 'demand' but fails if TLS
		#             cannot negotiate)
 		#
		#  The default is libldap's default, which varies based
		#  on the contents of ldap.conf.
698
699

#		require_cert	= 'demand'
700
		require_cert    = '<%= @requirecert %>'
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
	}

	#  As of version 3.0, the 'pool' section has replaced the
	#  following configuration items:
	#
	#  ldap_connections_number

	#  The connection pool is new for 3.0, and will be used in many
	#  modules, for all kinds of connection-related activity.
	#
	#  When the server is not threaded, the connection pool
	#  limits are ignored, and only one connection is used.
	pool {
		#  Connections to create during module instantiation.
		#  If the server cannot create specified number of
		#  connections during instantiation it will exit.
		#  Set to 0 to allow the server to start without the
		#  directory being available.
719
#		start = ${thread[pool].start_servers}
720
721
722
		start = <%= @start %>

		#  Minimum number of connections to keep open
723
#		min = ${thread[pool].min_spare_servers}
724
725
726
727
728
729
730
731
732
733
734
735
736
		min = <%= @min %>

		#  Maximum number of connections
		#
		#  If these connections are all in use and a new one
		#  is requested, the request will NOT get a connection.
		#
		#  Setting 'max' to LESS than the number of threads means
		#  that some threads may starve, and you will see errors
		#  like 'No connections available and at max connection limit'
		#
		#  Setting 'max' to MORE than the number of threads means
		#  that there are more connections than necessary.
737
#		max = ${thread[pool].max_servers}
738
739
740
741
742
743
		max = <%= @max %>

		#  Spare connections to be left idle
		#
		#  NOTE: Idle connections WILL be closed if "idle_timeout"
		#  is set.  This should be less than or equal to "max" above.
744
#		spare = ${thread[pool].max_spare_servers}
745
746
747
748
749
		spare = <%= @spare %>

		#  Number of uses before the connection is closed
		#
		#  0 means "infinite"
750
#		uses = 0
751
752
753
754
755
		uses = <%= @uses %>

		#  The number of seconds to wait after the server tries
		#  to open a connection, and fails.  During this time,
		#  no new connections will be opened.
756
#		retry_delay = 30
Jonathan Gazeley's avatar
Jonathan Gazeley committed
757
		retry_delay = <%= @retry_delay %>
758
759

		#  The lifetime (in seconds) of the connection
760
#		lifetime = 0
Jonathan Gazeley's avatar
Jonathan Gazeley committed
761
		lifetime = <%= @lifetime %>
762
763
764

		#  Idle timeout (in seconds).  A connection which is
		#  unused for this length of time will be closed.
765
#		idle_timeout = 60
Jonathan Gazeley's avatar
Jonathan Gazeley committed
766
		idle_timeout = <%= @idle_timeout %>
767
768
769
770
771
772
773
774
775
776
777
778

		#  NOTE: All configuration settings are enforced.  If a
		#  connection is closed because of 'idle_timeout',
		#  'uses', or 'lifetime', then the total number of
		#  connections MAY fall below 'min'.  When that
		#  happens, it will open a new connection.  It will
		#  also log a WARNING message.
		#
		#  The solution is to either lower the 'min' connections,
		#  or increase lifetime/idle_timeout.
	}
}