~ubuntu-branches/ubuntu/precise/autofs5/precise

« back to all changes in this revision

Viewing changes to .pc/autofs-5.0.5-add-external-bind-method.patch/man/autofs_ldap_auth.conf.5.in

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2011-07-03 14:35:46 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20110703143546-nej26krjij0rf792
Tags: 5.0.6-0ubuntu1
* New upstream release:
  - Dropped upstream patches 
  - Refreshed debian/patches/17ld.patch.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" t
2
 
.TH AUTOFS_LDAP_AUTH.CONF 5 "19 Feb 2010"
3
 
.SH NAME
4
 
autofs_ldap_auth.conf \- autofs LDAP authentication configuration
5
 
.SH "DESCRIPTION"
6
 
LDAP authenticated binds, TLS encrypted connections and certification
7
 
may be used by setting appropriate values in the autofs authentication
8
 
configuration file and configuring the LDAP client with appropriate
9
 
settings.  The default location of this file is
10
 
.nh
11
 
.BR @@autofsmapdir@@/autofs_ldap_auth.conf .
12
 
.hy
13
 
If this file exists it will be used to establish whether TLS or authentication
14
 
should be used.
15
 
.P
16
 
An example of this file is:
17
 
.sp
18
 
.RS +.2i
19
 
.ta 1.0i
20
 
.nf
21
 
<?xml version="1.0" ?>
22
 
<autofs_ldap_sasl_conf
23
 
        usetls="yes"
24
 
        tlsrequired="no"
25
 
        authrequired="no"
26
 
        authtype="DIGEST-MD5"
27
 
        user="xyz"
28
 
        secret="abc"
29
 
/>
30
 
.fi
31
 
.RE
32
 
.sp
33
 
If TLS encryption is to be used the location of the Certificate Authority
34
 
certificate must be set within the LDAP client configuration in 
35
 
order to validate the server certificate. If, in addition, a certified
36
 
connection is to be used then the client certificate and private key file
37
 
locations must also be configured within the LDAP client.
38
 
.SH "OPTIONS"
39
 
This files contains a single XML element, as shown in the example above, with
40
 
several attributes.
41
 
.TP
42
 
The possible attributes are:
43
 
.TP
44
 
\fBusetls="yes"|"no"\fP
45
 
Determines whether an encrypted connection to the ldap server
46
 
should be attempted.
47
 
.TP
48
 
\fBtlsrequired="yes"|"no"\fP
49
 
This flag tells whether the ldap connection must be encrypted. If set to "yes",
50
 
the automounter will fail to start if an encrypted connection cannot be
51
 
established.
52
 
.TP
53
 
\fBauthrequired="yes"|"no"|"autodetect"|"simple"\fP
54
 
This option tells whether an authenticated connection to the ldap server is
55
 
required in order to perform ldap queries. If the flag is set to yes, only
56
 
sasl authenticated connections will be allowed. If it is set to no then
57
 
authentication is not needed for ldap server connections. If it is set to
58
 
autodetect then the ldap server will be queried to establish a suitable sasl
59
 
authentication  mechanism. If no suitable mechanism can be found, connections
60
 
to the ldap server are made without authentication. Finally, if it is set to
61
 
simple, then simple authentication will be used instead of SASL.
62
 
.TP
63
 
\fBauthtype="GSSAPI"|"LOGIN"|"PLAIN"|"ANONYMOUS"|"DIGEST-MD5"\fP
64
 
This attribute can be used to specify a preferred authentication mechanism.
65
 
 In normal operations, the automounter will attempt to authenticate to the
66
 
ldap server using the list of supportedSASLmechanisms obtained from the
67
 
directory server.  Explicitly setting the authtype will bypass this selection
68
 
and only try the mechanism specified.
69
 
.TP
70
 
\fBuser="<username>"\fP
71
 
This attribute holds the authentication identity used by authentication
72
 
mechanisms that require it.  Legal values for this attribute include any
73
 
printable characters that can be used by the selected authentication
74
 
mechanism.
75
 
.TP
76
 
\fBsecret="<password>"\fP
77
 
This attribute holds the secret used by authentication mechanisms that
78
 
require it. Legal values for this attribute include any printable
79
 
characters that can be used by the selected authentication mechanism.
80
 
.TP
81
 
\fBclientprinc="<GSSAPI client principal>"\fP
82
 
When using GSSAPI authentication, this attribute is consulted to determine
83
 
the principal name to use when authenticating to the directory server. By
84
 
default, this will be set to "autofsclient/<fqdn>@<REALM>.
85
 
.TP
86
 
\fBcredentialcache="<external credential cache path>"\fP
87
 
When using GSSAPI authentication, this attribute can be used to specify an
88
 
externally configured credential cache that is used during authentication.
89
 
By default, autofs will setup a memory based credential cache.
90
 
.SH "SEE ALSO"
91
 
.BR auto.master (5),
92
 
.SH AUTHOR
93
 
This manual page was written by Ian Kent <raven@themaw.net>.