Arthur de Jong

Open Source / Free Software developer

summaryrefslogtreecommitdiffstats
path: root/man/nslcd.conf.5.xml
blob: 76a3855d7fcdf6a43c71e765031b86ba44c0ba1a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
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
520
521
522
523
524
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
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<!--
   nslcd.conf.5.xml - docbook manual page for nslcd.conf

   Copyright (C) 1997-2005 Luke Howard
   Copyright (C) 2007, 2008, 2009, 2010, 2011 Arthur de Jong

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
   License as published by the Free Software Foundation; either
   version 2.1 of the License, or (at your option) any later version.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free Software
   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
   02110-1301 USA
-->

<refentry id="nssldapdconf5">

 <refentryinfo>
  <author>
   <firstname>Arthur</firstname>
   <surname>de Jong</surname>
  </author>
 </refentryinfo>

 <refmeta>
  <refentrytitle>nslcd.conf</refentrytitle>
  <manvolnum>5</manvolnum>
  <refmiscinfo class="version">Version 0.7.15</refmiscinfo>
  <refmiscinfo class="manual">System Manager's Manual</refmiscinfo>
  <refmiscinfo class="date">Oct 2011</refmiscinfo>
 </refmeta>

 <refnamediv id="name">
  <refname>nslcd.conf</refname>
  <refpurpose>configuration file for LDAP nameservice daemon</refpurpose>
 </refnamediv>

 <refsect1 id="description">
  <title>Description</title>
  <para>
   The <emphasis>nss-pam-ldapd</emphasis> package allows <acronym>LDAP</acronym>
   directory servers to be used as a primary source of name service
   information. (Name service information typically includes users, hosts,
   groups, and other such data historically stored in flat files or
   <acronym>NIS</acronym>.)
  </para>
  <para>
    The file <filename>nslcd.conf</filename> contains the
    configuration information for running <command>nslcd</command> (see
    <citerefentry><refentrytitle>nslcd</refentrytitle><manvolnum>8</manvolnum></citerefentry>).
    The file contains options, one on each line, defining the way
    <acronym>NSS</acronym> lookups and <acronym>PAM</acronym> actions
    are mapped to <acronym>LDAP</acronym> lookups.
  </para>
 </refsect1>

 <refsect1 id="options">
  <title>Options</title>

  <refsect2 id="runtime_options">
   <title>Runtime options</title>
   <variablelist>

    <varlistentry>
     <term><option>threads</option> <replaceable>NUM</replaceable></term>
     <listitem>
      <para>
       Specifies the number of threads to start that can handle requests
       and perform <acronym>LDAP</acronym> queries.
       The default is to start 5 threads.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>uid</option> <replaceable>UID</replaceable></term>
     <listitem>
      <para>
       This specifies the user id with which the daemon should be run.
       This can be a numerical id or a symbolic value.
       If no uid is specified no attempt to change the user will be made.
       Note that you should use values that don't need <acronym>LDAP</acronym>
       to resolve.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>gid</option> <replaceable>GID</replaceable></term>
     <listitem>
      <para>
       This specifies the group id with which the daemon should be run.
       This can be a numerical id or a symbolic value.
       If no gid is specified no attempt to change the group will be made.
       Note that you should use values that don't need <acronym>LDAP</acronym>
       to resolve.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

  <refsect2 id="general_connection_options">
   <title>General connection options</title>
   <variablelist>

    <varlistentry>
     <term><option>uri</option> <replaceable>URI</replaceable></term>
     <listitem>
      <para>
       Specifies the <acronym>LDAP</acronym> <acronym>URI</acronym> of the
       server to connect to.
       The <acronym>URI</acronym> scheme may be <literal>ldap</literal>,
       <literal>ldapi</literal> or <literal>ldaps</literal>, specifying
       <acronym>LDAP</acronym> over <acronym>TCP</acronym>,
       <acronym>ICP</acronym> or <acronym>SSL</acronym> respectively (if
       supported by the <acronym>LDAP</acronym> library).
       Alternatively, the value <literal>DNS</literal> may be
       used to try to lookup the server using <acronym>DNS</acronym>
       <acronym>SRV</acronym> records.
      </para>
      <para>
       When using the ldapi scheme, %2f should be used to escape slashes
       (e.g. ldapi://%2fvar%2frun%2fslapd%2fldapi/), although most of the
       time this should not be needed.
      </para>
      <para>
       This option may be specified multiple times. Normally, only the first
       server will be used with the following servers as fall-back (see
       <option>bind_timelimit</option> below).
      </para>
      <para>
       If <acronym>LDAP</acronym> lookups are used for host name resolution,
       any host names should be specified as an IP address or name that can be
       resolved without using <acronym>LDAP</acronym>.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>ldap_version</option> <replaceable>VERSION</replaceable></term>
     <listitem>
      <para>
       Specifies the version of the <acronym>LDAP</acronym> protocol to use.
       The default is to use the maximum version supported by the
       <acronym>LDAP</acronym> library.</para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>binddn</option> <replaceable>DN</replaceable></term>
     <listitem>
      <para>
       Specifies the distinguished name with which to bind to the directory
       server for lookups.
       The default is to bind anonymously.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>bindpw</option> <replaceable>PASSWORD</replaceable></term>
     <listitem>
      <para>
       Specifies the clear text credentials with which to bind.
       This option is only applicable when used with <option>binddn</option> above.
       If you set this option you should consider changing the permissions
       of the <filename>nslcd.conf</filename> file to only grant access to
       the root user.
<!-- WHEN SASL IS DOCUMENTED:
       This option is only applicable when either the <option>binddn</option> or
       <option>sasl_authcid</option> options are used.
-->
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>rootpwmoddn</option> <replaceable>DN</replaceable></term>
     <listitem>
      <para>
       Specifies the distinguished name to use when the root user tries to
       modify a user's password using the PAM module. The PAM module prompts
       the user for the admin password instead of the user's password.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

  <refsect2 id="sasl_authentication_options">
   <title><acronym>SASL</acronym> authentication options</title>
   <variablelist>

    <varlistentry>
     <term><option>sasl_mech</option> <replaceable>MECHANISM</replaceable></term>
     <listitem>
      <para>
       Specifies the <acronym>SASL</acronym> mechanism to be used when
       performing <acronym>SASL</acronym> authentication.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>sasl_realm</option> <replaceable>REALM</replaceable></term>
     <listitem>
      <para>
       Specifies the <acronym>SASL</acronym> realm to be used when performing
       <acronym>SASL</acronym> authentication.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>sasl_authcid</option> <replaceable>AUTHCID</replaceable></term>
     <listitem>
      <para>
       Specifies the authentication identity to be used when performing
       <acronym>SASL</acronym> authentication.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>sasl_authzid</option> <replaceable>AUTHZID</replaceable></term>
     <listitem>
      <para>
       Specifies the authorization identity to be used when performing
       <acronym>SASL</acronym> authentication.
       Must be specified in one of the formats: dn:&lt;distinguished name&gt;
       or u:&lt;username&gt;.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>sasl_secprops</option> <replaceable>PROPERTIES</replaceable></term>
     <listitem>
      <para>
       Specifies Cyrus <acronym>SASL</acronym> security properties.
       Allowed values are described in the
       <citerefentry><refentrytitle>ldap.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
       manual page.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

  <refsect2 id="kerberos_authentication_options">
   <title>Kerberos authentication options</title>
   <variablelist>

    <varlistentry>
     <term><option>krb5_ccname</option> <replaceable>NAME</replaceable></term>
     <listitem>
      <para>
       Set the name for the GSS-API Kerberos credentials cache.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

  <refsect2 id="search_mapping_options">
   <title>Search/mapping options</title>
   <variablelist>

    <varlistentry>
     <term><option>base</option>
           <optional><replaceable>MAP</replaceable></optional>
           <replaceable>DN</replaceable></term>
     <listitem>
      <para>
       Specifies the base distinguished name (<acronym>DN</acronym>)
       to use as search base.
       This option may be supplied multiple times and all specified bases
       will be searched.
      </para>
      <para>
       A global search base may be specified or a MAP-specific one.
       If no MAP-specific search bases are defined the global ones are used.
      </para>
      <para>
       If, instead of a <acronym>DN</acronym>, the value
       <replaceable>DOMAIN</replaceable> is specified, the host's
       <acronym>DNS</acronym> domain is used to construct a search base.
      </para>
      <para>
       If this value is not defined an attempt is made to look it up
       in the configured <acronym>LDAP</acronym> server. Note that if the
       <acronym>LDAP</acronym> server is unavailable during start-up
       <command>nslcd</command> will not start.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>scope</option>
           <optional><replaceable>MAP</replaceable></optional>
           sub<optional>tree</optional>|one<optional>level</optional>|base</term>
     <listitem>
      <para>
       Specifies the search scope (subtree, one level or base object).
       The default scope is subtree; base scope is almost never useful for
       name service lookups.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>deref</option> never|searching|finding|always</term>
     <listitem>
      <para>
       Specifies the policy for dereferencing aliases.
       The default policy is to never dereference aliases.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>referrals</option> yes|no</term>
     <listitem>
      <para>
       Specifies whether automatic referral chasing should be enabled.
       The default behaviour is to chase referrals.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>filter</option>
           <replaceable>MAP</replaceable>
           <replaceable>FILTER</replaceable></term>
     <listitem>
      <para>
       The <replaceable>FILTER</replaceable>
       is an <acronym>LDAP</acronym> search filter to use for a
       specific map.
       The default filter is a basic search on the
       objectClass for the map (e.g. <literal>(objectClass=posixAccount)</literal>).
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>map</option>
           <replaceable>MAP</replaceable>
           <replaceable>ATTRIBUTE</replaceable>
           <replaceable>NEWATTRIBUTE</replaceable></term>
     <listitem>
      <para>
       This option allows for custom attributes to be looked up instead of
       the default RFC 2307 attributes.
       The <replaceable>MAP</replaceable> may be one of
       the supported maps below.
       The <replaceable>ATTRIBUTE</replaceable> is the one as
       used in <acronym>RFC</acronym> 2307 (e.g. <literal>userPassword</literal>,
       <literal>ipProtocolNumber</literal> or <literal>macAddress</literal>).
       The <replaceable>NEWATTRIBUTE</replaceable> may be any attribute
       as it is available in the directory.
      </para>
      <para>
       If the <replaceable>NEWATTRIBUTE</replaceable> is presented in
       quotes (") it is treated as an expression which will be evaluated
       to build up the actual value used.
       See the section on attribute mapping expressions below for more details.
      </para>
      <para>
       Only some attributes for passwd and shadow entries may be mapped with
       an expression (because other attributes may be used in search
       filters).
       For passwd entries the following attributes may be mapped with an
       expression: <literal>gidNumber</literal>, <literal>gecos</literal>,
       <literal>homeDirectory</literal> and <literal>loginShell</literal>.
       For shadow entries the following attributes may be mapped with an
       expression: <literal>shadowLastChange</literal>, <literal>shadowMin</literal>,
       <literal>shadowMax</literal>, <literal>shadowWarning</literal>,
       <literal>shadowInactive</literal>, <literal>shadowExpire</literal> and
       <literal>shadowFlag</literal>.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

  <refsect2 id="timing_reconnect_options">
   <title>Timing/reconnect options</title>
   <variablelist>

    <varlistentry>
     <term><option>bind_timelimit</option> <replaceable>SECONDS</replaceable></term>
     <listitem>
      <para>
       Specifies the time limit (in seconds) to use when connecting to the
       directory server.
       This is distinct from the time limit specified in
       <option>timelimit</option> and affects the set-up of the connection only.
       Note that not all <acronym>LDAP</acronym> client libraries have support
       for setting the connection time out.
       The default <option>bind_timelimit</option> is 10 seconds.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>timelimit</option> <replaceable>SECONDS</replaceable></term>
     <listitem>
      <para>
       Specifies the time limit (in seconds) to wait for a response from the
       <acronym>LDAP</acronym> server.
       A value of zero (0), which is the default, is to wait indefinitely for
       searches to be completed.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>idle_timelimit</option> <replaceable>SECONDS</replaceable></term>
     <listitem>
      <para>
       Specifies the period if inactivity (in seconds) after which the
       connection to the <acronym>LDAP</acronym> server will be closed.
       The default is not to time out connections.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>reconnect_sleeptime</option> <replaceable>SECONDS</replaceable></term>
     <listitem>
      <para>
       Specifies the number of seconds to sleep when connecting to all
       <acronym>LDAP</acronym> servers fails.
       By default 1 second is waited between the first failure and the first
       retry.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>reconnect_retrytime</option> <replaceable>SECONDS</replaceable></term>
     <listitem>
      <para>
       Specifies the time after which the <acronym>LDAP</acronym> server is
       considered to be permanently unavailable.
       Once this time is reached retries will be done only once per this time period.
       The default value is 10 seconds.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>

   <para>
    Note that the reconnect logic as described above is the mechanism that
    is used between <command>nslcd</command> and the <acronym>LDAP</acronym>
    server. The mechanism between the <acronym>NSS</acronym> and
    <acronym>PAM</acronym> client libraries on one end and
    <command>nslcd</command> on the other is simpler with a fixed compiled-in
    time out of a 10 seconds for writing to <command>nslcd</command> and
    a time out of 60 seconds for reading answers.
    <command>nslcd</command> itself has a read time out of 0.5 seconds
    and a write time out of 60 seconds.
   </para>

  </refsect2>

  <refsect2 id="ssl_tls_options">
   <title><acronym>SSL</acronym>/<acronym>TLS</acronym> options</title>
   <variablelist>

    <varlistentry>
     <term><option>ssl</option> on|off|start_tls</term>
     <listitem>
      <para>
       Specifies whether to use <acronym>SSL</acronym>/<acronym>TLS</acronym> or not (the default is not to). If
       <replaceable>start_tls</replaceable>
       is specified then StartTLS is used rather than raw <acronym>LDAP</acronym> over <acronym>SSL</acronym>.
       Not all <acronym>LDAP</acronym> client libraries support both <acronym>SSL</acronym>,
       StartTLS and all related configuration options.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_reqcert</option> never|allow|try|demand|hard</term>
     <listitem>
      <para>
       Specifies what checks to perform on a server-supplied certificate.
       The meaning of the values is described in the
       <citerefentry><refentrytitle>ldap.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
       manual page.
       At least one of <option>tls_cacertdir</option> and
       <option>tls_cacertfile</option> is required if peer verification is
       enabled.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_cacertdir</option> <replaceable>PATH</replaceable></term>
     <listitem>
      <para>
       Specifies the directory containing X.509 certificates for peer
       authentication.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_cacertfile</option> <replaceable>PATH</replaceable></term>
     <listitem>
      <para>
       Specifies the path to the X.509 certificate for peer authentication.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_randfile</option> <replaceable>PATH</replaceable></term>
     <listitem>
      <para>
       Specifies the path to an entropy source.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_ciphers</option> <replaceable>CIPHERS</replaceable></term>
     <listitem>
      <para>
       Specifies the ciphers to use for <acronym>TLS</acronym>.
       See your <acronym>TLS</acronym> implementation's
       documentation for further information.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_cert</option> <replaceable>PATH</replaceable></term>
     <listitem>
      <para>
       Specifies the path to the file containing the local certificate for
       client <acronym>TLS</acronym> authentication.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>tls_key</option> <replaceable>PATH</replaceable></term>
     <listitem>
      <para>
       Specifies the path to the file containing the private key for client
       <acronym>TLS</acronym> authentication.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

  <refsect2 id="other_options">
   <title>Other options</title>
   <variablelist>

<!-- do not document this option for now as support it is not finalized
    <varlistentry>
     <term><option>restart</option> yes|no</term>
     <listitem>
      <para>
       Specifies whether the <acronym>LDAP</acronym>
       client library should restart the
       <emphasis remap="B">select()</emphasis>
       system call when interrupted. This feature is not supported by all
       client libraries.
      </para>
     </listitem>
    </varlistentry>
-->

    <varlistentry>
     <term><option>pagesize</option> <replaceable>NUMBER</replaceable></term>
     <listitem>
      <para>
       Set this to a number greater than 0 to request paged results from
       the <acronym>LDAP</acronym> server in accordance with RFC2696.
       The default (0) is to not request paged results.
      </para>
      <para>
       This is useful for <acronym>LDAP</acronym> servers that contain a
       lot of entries (e.g. more than 500) and limit the number of entries
       that are returned with one request.
       For OpenLDAP servers you may need to set
       <option>sizelimit size.prtotal=unlimited</option>
       for allowing more entries to be returned over multiple pages.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>nss_initgroups_ignoreusers</option> user1,user2,...</term>
     <listitem>
      <para>
       This option prevents group membership lookups through
       <acronym>LDAP</acronym> for the specified users. This can be useful
       in case of unavailability of the <acronym>LDAP</acronym> server.
       This option may be specified multiple times.
      </para>
      <para>
       Alternatively, the value <literal>ALLLOCAL</literal> may be
       used. With that value nslcd builds a full list of
       non-<acronym>LDAP</acronym> users on startup.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term><option>pam_authz_search</option>
           <replaceable>FILTER</replaceable></term>
     <listitem>
      <para>
       This option allows flexible fine tuning of the authorisation check that
       should be performed. The search filter specified is executed and
       if any entries match, access is granted, otherwise access is denied.
      </para>
      <para>
       The search filter can contain the following variable references:
         <literal>$username</literal>, <literal>$service</literal>,
         <literal>$ruser</literal>, <literal>$rhost</literal>,
         <literal>$tty</literal>, <literal>$hostname</literal>,
         <literal>$dn</literal>, and <literal>$uid</literal>.
       These references are substituted in the search filter using the
       same syntax as described in the section on attribute mapping
       expressions below.
      </para>
      <para>
       For example, to check that the user has a proper authorizedService
       value if the attribute is present:
       <literal>(&amp;(objectClass=posixAccount)(uid=$username)
       (|(authorizedService=$service)(!(authorizedService=*))))</literal>
      </para>
      <para>
       The default behaviour is not to do this extra search and always
       grant access.
      </para>
     </listitem>
    </varlistentry>

   </variablelist>
  </refsect2>

 </refsect1>

 <refsect1 id="maps">
  <title>Supported maps</title>
  <para>
   The following maps are supported. They are referenced as
   <replaceable>MAP</replaceable> in the options above.
  </para>
  <variablelist remap="TP">
   <varlistentry>
    <term>alias<optional>es</optional></term>
    <listitem><para>
     Mail aliases.
     Note that most mail servers do not use the <acronym>NSS</acronym>
     interface for requesting mail aliases and parse
     <filename>/etc/aliases</filename> on their own.
    </para></listitem>
   </varlistentry>
   <varlistentry>
    <term>ether<optional>s</optional></term>
    <listitem><para>Ethernet numbers (mac addresses).</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>group</term>
    <listitem><para>Posix groups.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>host<optional>s</optional></term>
    <listitem><para>Host names.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>netgroup</term>
    <listitem><para>Host and user groups used for access control.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>network<optional>s</optional></term>
    <listitem><para>Network numbers.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>passwd</term>
    <listitem><para>Posix users.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>protocol<optional>s</optional></term>
    <listitem><para>Protocol definitions (like in <filename>/etc/protocols</filename>).</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>rpc</term>
    <listitem><para>Remote procedure call names and numbers.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>service<optional>s</optional></term>
    <listitem><para>Network service names and numbers.</para></listitem>
   </varlistentry>
   <varlistentry>
    <term>shadow</term>
    <listitem><para>Shadow user password information.</para></listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 id="attmappingexpressions">
  <title>Attribute mapping expressions</title>
  <para>
   For some attributes a mapping expression may be used to construct the
   resulting value. This is currently only possible for attributes that do
   not need to be used in search filters.
  </para>
  <para>
   The expressions are a subset of the double quoted string expressions in the
   Bourne (POSIX) shell.
   Instead of variable substitution, attribute lookups are done on the current
   entry and the attribute value is substituted.
   The following expressions are supported:
  </para>
  <variablelist remap="TP">
   <varlistentry>
    <term><literal>${attr}</literal> (or <literal>$attr</literal> for short)</term>
    <listitem><para>
     will substitute the value of the attribute
    </para></listitem>
   </varlistentry>
   <varlistentry>
    <term><literal>${attr:-word}</literal></term>
    <listitem><para>
     (use default) will substitbute the value of the attribute or, if the
     attribute is not set or empty substitute the word
    </para></listitem>
   </varlistentry>
   <varlistentry>
    <term><literal>${attr:+word}</literal></term>
    <listitem><para>
     (use alternative) will substitbute word if attribute is set, otherwise
     substitute the empty string
    </para></listitem>
   </varlistentry>
  </variablelist>
  <para>
   The <command>nslcd</command> daemon checks the expressions to figure
   out which attributes to fetch from <acronym>LDAP</acronym>.
   Some examples to demonstrate how these expressions may be used in
   attribute mapping:
  </para>
  <variablelist remap="TP">
   <varlistentry>
    <term><literal>"${shadowFlag:-0}"</literal></term>
    <listitem><para>
     use the <literal>shadowFlag</literal> attribute, using the
     value 0 as default
    </para></listitem>
   </varlistentry>
   <varlistentry>
    <term><literal>"${homeDirectory:-/home/$uid}"</literal></term>
    <listitem><para>
     use the <literal>uid</literal> attribute to build a
     <literal>homeDirectory</literal> value if that attribute is missing
    </para></listitem>
   </varlistentry>
   <varlistentry>
    <term><literal>"${isDisabled:+100}"</literal></term>
    <listitem><para>
     if the <literal>isDisabled</literal> attribute is set, return 100,
     otherwise leave value empty
    </para></listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 id="files">
  <title>Files</title>
  <variablelist remap="TP">
   <varlistentry>
    <term><filename>/etc/nslcd.conf</filename></term>
    <listitem><para>the main configuration file</para></listitem>
   </varlistentry>
   <varlistentry>
    <term><filename>/etc/nsswitch.conf</filename></term>
    <listitem><para>Name Service Switch configuration file</para></listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 id="see_also">
  <title>See Also</title>
  <para>
   <citerefentry><refentrytitle>nslcd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
   <citerefentry><refentrytitle>nsswitch.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>
  </para>
 </refsect1>

 <refsect1 id="author">
  <title>Author</title>
  <para>This manual was written by Arthur de Jong &lt;arthur@arthurdejong.org&gt;
        and is based on the
        <citerefentry><refentrytitle>nss_ldap</refentrytitle><manvolnum>5</manvolnum></citerefentry>
        manual developed by PADL Software Pty Ltd.</para>
 </refsect1>

</refentry>