docs-xml/smbdotconf/ldap/ldapssl.xml

   1 <samba:parameter name="ldap ssl"
   2                  context="G"
   3                  type="enum"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>This option is used to define whether or not Samba should
   7         use SSL when connecting to the ldap server
   8         This is <emphasis>NOT</emphasis> related to
   9         Samba's previous SSL support which was enabled by specifying the
  10         <command moreinfo="none">--with-ssl</command> option to the
  11         <filename moreinfo="none">configure</filename>
  12         script.</para>
  13
  14         <para>LDAP connections should be secured where possible. This may be
  15         done setting <emphasis>either</emphasis> this parameter to
  16         <parameter moreinfo="none">Start_tls</parameter>
  17         <emphasis>or</emphasis> by specifying <parameter moreinfo="none">ldaps://</parameter> in
  18         the URL argument of <smbconfoption name="passdb backend"/>.</para>
  19
  20         <para>The <smbconfoption name="ldap ssl"/> can be set to one of
  21         two values:</para>
  22         <itemizedlist>
  23                 <listitem>
  24                         <para><parameter moreinfo="none">Off</parameter> = Never
  25                         use SSL when querying the directory.</para>
  26                 </listitem>
  27
  28                 <listitem>
  29                         <para><parameter moreinfo="none">start tls</parameter> = Use
  30                         the LDAPv3 StartTLS extended operation (RFC2830) for
  31                         communicating with the directory server.</para>
  32                 </listitem>
  33         </itemizedlist>
  34         <para>
  35         Please note that this parameter does only affect <emphasis>rpc</emphasis>
  36         methods. To enable the LDAPv3 StartTLS extended operation (RFC2830) for
  37         <emphasis>ads</emphasis>, set
  38         <smbconfoption name="ldap ssl">yes</smbconfoption>
  39         <emphasis>and</emphasis>
  40         <smbconfoption name="ldap ssl ads">yes</smbconfoption>.
  41         See <refentrytitle>smb.conf</refentrytitle><manvolnum>5</manvolnum>
  42         for more information on <smbconfoption name="ldap ssl ads"/>.
  43         </para>
  44
  45 </description>
  46 <value type="default">start tls</value>
  47 </samba:parameter>