docs-xml/smbdotconf/security/passwordhashgpgkeyids.xml

   1 <samba:parameter name="password hash gpg key ids"
   2                  context="G"
   3                  type="cmdlist"
   4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
   5 <description>
   6         <para>If <command moreinfo="none">samba</command> is running as an
   7         active directory domain controller, it is possible to store the
   8         cleartext password of accounts in a PGP/OpenGPG encrypted form.</para>
   9
  10         <para>You can specify one or more recipients by key id or user id.
  11         Note that 32bit key ids are not allowed, specify at least 64bit.</para>
  12
  13         <para>The value is stored as 'Primary:SambaGPG' in the
  14         <command moreinfo="none">supplementalCredentials</command> attribute.</para>
  15
  16         <para>As password changes can occur on any domain controller,
  17         you should configure this on each of them. Note that this feature is currently
  18         available only on Samba domain controllers.</para>
  19
  20         <para>This option is only available if <command moreinfo="none">samba</command>
  21         was compiled with <command moreinfo="none">gpgme</command> support.</para>
  22
  23         <para>You may need to export the <command moreinfo="none">GNUPGHOME</command>
  24         environment variable before starting <command moreinfo="none">samba</command>.
  25         <emphasis>It is strongly recommended to only store the public key in this
  26         location. The private key is not used for encryption and should be
  27         only stored where decryption is required.</emphasis></para>
  28
  29         <para>Being able to restore the cleartext password helps, when they need to be imported
  30         into other authentication systems later (see <command moreinfo="none">samba-tool user getpassword</command>)
  31         or you want to keep the passwords in sync with another system, e.g. an OpenLDAP server
  32         (see <command moreinfo="none">samba-tool user syncpasswords</command>).</para>
  33
  34         <para>While this option needs to be configured on all domain controllers, the
  35         <command moreinfo="none">samba-tool user syncpasswords</command> command should
  36         run on a single domain controller only (typically the PDC-emulator).</para>
  37 </description>
  38
  39 <related>unix password sync</related>
  40
  41 <value type="default"></value>
  42 <value type="example">4952E40301FAB41A</value>
  43 <value type="example">selftest@samba.example.com</value>
  44 <value type="example">selftest@samba.example.com, 4952E40301FAB41A</value>
  45 </samba:parameter>