docs-xml/manpages/idmap_hash.8.xml

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
   3 <refentry id="idmap_hash.8">
   4
   5 <refmeta>
   6         <refentrytitle>idmap_hash</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">&doc.version;</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>idmap_hash</refname>
  16         <refpurpose>DO NOT USE THIS BACKEND</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <title>DESCRIPTION</title>
  21         <para>DO NOT USE THIS PLUGIN
  22
  23           The idmap_hash plugin implements a hashing algorithm used to map
  24           SIDs for domain users and groups to 31-bit uids and gids, respectively.
  25           This plugin also implements the nss_info API and can be used
  26           to support a local name mapping files if enabled via the
  27           &quot;winbind normalize names&quot; and &quot;winbind nss info&quot;
  28           parameters in smb.conf.
  29           The module divides the range into subranges for each domain that is being
  30           handled by the idmap config.
  31
  32           The module needs the complete UID and GID range to be able to map all
  33           SIDs.  The lowest value for the range should be the smallest ID
  34           available in the system. This is normally 1000. The highest ID should
  35           be set to 2147483647.
  36
  37           A smaller range will lead to issues because of the hashing algorithm
  38           used. The overall range to map all SIDs is 0 - 2147483647. Any range
  39           smaller than 0 - 2147483647 will filter some SIDs. As we can normally
  40           only start with 1000, we are not able to map 1000 SIDs. This already
  41           can lead to issues. The smaller the range the less SIDs can be mapped.
  42
  43           We do not recommend to use this plugin. It will be removed in a future
  44           release of Samba.
  45         </para>
  46 </refsynopsisdiv>
  47
  48 <refsect1>
  49         <title>IDMAP OPTIONS</title>
  50
  51         <variablelist>
  52                 <varlistentry>
  53                 <term>name_map</term>
  54                 <listitem><para>
  55                     Specifies the absolute path to the name mapping
  56                     file used by the nss_info API.  Entries in the file
  57                     are of the form &quot;<replaceable>unix name</replaceable>
  58                     = <replaceable>qualified domain name</replaceable>&quot;.
  59                     Mapping of both user and group names is supported.
  60                 </para></listitem>
  61                 </varlistentry>
  62         </variablelist>
  63 </refsect1>
  64
  65 <refsect1>
  66         <title>EXAMPLES</title>
  67         <para>The following example utilizes the idmap_hash plugin for
  68           the idmap and nss_info information.
  69         </para>
  70
  71         <programlisting>
  72         [global]
  73         idmap config * : backend = hash
  74         idmap config * : range = 1000-2147483647
  75
  76         winbind nss info = hash
  77         winbind normalize names = yes
  78         idmap_hash:name_map = /etc/samba/name_map.cfg
  79         </programlisting>
  80 </refsect1>
  81
  82 <refsect1>
  83         <title>AUTHOR</title>
  84
  85         <para>
  86         The original Samba software and related utilities
  87         were created by Andrew Tridgell. Samba is now developed
  88         by the Samba Team as an Open Source project similar
  89         to the way the Linux kernel is developed.
  90         </para>
  91 </refsect1>
  92
  93 </refentry>