docs-xml/manpages/vfs_nfs4acl_xattr.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="vfs_nfs4acl_xattr.8">
   4
   5   <refmeta>
   6     <refentrytitle>vfs_nfs4acl_xattr</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>vfs_nfs4acl_xattr</refname>
  16     <refpurpose>Save NTFS-ACLs as NFS4 encoded blobs in extended
  17     attributes</refpurpose>
  18   </refnamediv>
  19
  20   <refsynopsisdiv>
  21     <cmdsynopsis>
  22       <command>vfs objects = nfs4acl_xattr</command>
  23     </cmdsynopsis>
  24   </refsynopsisdiv>
  25
  26   <refsect1>
  27     <title>DESCRIPTION</title>
  28
  29     <para>This VFS module is part of the
  30     <citerefentry><refentrytitle>samba</refentrytitle>
  31     <manvolnum>7</manvolnum></citerefentry> suite.</para>
  32
  33     <para>The <command>vfs_acl_xattr</command> VFS module stores NTFS Access
  34     Control Lists (ACLs) in Extended Attributes (EAs/xattrs).  This enables the
  35     full mapping of Windows ACLs on Samba servers.
  36     </para>
  37
  38     <para>This module is stackable.</para>
  39   </refsect1>
  40
  41
  42   <refsect1>
  43     <title>OPTIONS</title>
  44
  45     <variablelist>
  46
  47       <varlistentry>
  48         <term>nfs4acl_xattr:encoding = [nfs|ndr|xdr]</term>
  49         <listitem>
  50           <para>This parameter configures the marshaling format used in the ACL
  51           blob and the default extended attribute name used to store the blob.
  52           </para>
  53
  54           <para>When set to <emphasis>nfs</emphasis> - fetch and store the NT
  55           ACL in NFS 4.0 or 4.1 compatible XDR encoding. By default this uses
  56           the extended attribute "system.nfs4_acl". This setting also
  57           disables <emphasis>validate_mode</emphasis>.</para>
  58
  59           <para>When set to <emphasis>ndr (default)</emphasis> - store the NT
  60           ACL with POSIX draft NFSv4 compatible NDR encoding. By default this
  61           uses the extended attribute "security.nfs4acl_ndr".</para>
  62
  63           <para>When set to <emphasis>xdr</emphasis> - store the NT ACL in a
  64           format similar to NFS 4.1 RFC 5661 in XDR encoding. The main
  65           differences to RFC 5661 are the use of ids instead of strings as users
  66           and group identifiers and an additional attribute per nfsace4. By
  67           default this encoding stores the blob in the extended attribute
  68           "security.nfs4acl_xdr".</para>
  69         </listitem>
  70       </varlistentry>
  71
  72       <varlistentry>
  73         <term>nfs4acl_xattr:version = [40|41]</term>
  74         <listitem>
  75           <para>This parameter configures the NFS4 ACL level. Only
  76           <emphasis>41</emphasis> fully supports mapping NT ACLs and should be
  77           used. The default is <emphasis>41</emphasis>.</para>
  78         </listitem>
  79       </varlistentry>
  80
  81       <varlistentry>
  82         <term>nfs4acl_xattr:default acl style = [posix|windows|everyone]</term>
  83         <listitem>
  84           <para>This parameter determines the type of ACL that is synthesized in
  85           case a file or directory lacks an ACL extended attribute.</para>
  86
  87           <para>When set to <emphasis>posix</emphasis>, an ACL will be
  88           synthesized based on the POSIX mode permissions for user, group and
  89           others, with an additional ACE for <emphasis>NT
  90           Authority\SYSTEM</emphasis> will full rights.</para>
  91
  92           <para>When set to <emphasis>windows</emphasis>, an ACL is synthesized
  93           the same way Windows does it, only including permissions for the owner
  94           and <emphasis>NT Authority\SYSTEM</emphasis>.</para>
  95
  96           <para>When set to <emphasis>everyone</emphasis>, an ACL is synthesized
  97           giving full permissions to everyone (S-1-1-0).</para>
  98
  99           <para>The default for this option is
 100           <emphasis>everyone</emphasis>.</para>
 101         </listitem>
 102       </varlistentry>
 103
 104       <varlistentry>
 105         <term>nfs4acl_xattr:xattr_name = STRING</term>
 106         <listitem>
 107           <para>This parameter configures the extended attribute name used to
 108           store the marshaled ACL.</para>
 109           <para>The default depends on the setting for
 110           <emphasis>nfs4acl_xattr:encoding</emphasis>.</para>
 111         </listitem>
 112       </varlistentry>
 113
 114       <varlistentry>
 115         <term>nfs4acl_xattr:nfs4_id_numeric = yes|no (default: no)</term>
 116         <listitem>
 117           <para>This parameter tells the module how the NFS4 server encodes user
 118           and group identifiers on the network. With the default setting the
 119           module expects identifiers encoded as per the NFS4 RFC as
 120           user@domain.</para>
 121           <para>When set to <emphasis>yes</emphasis>, the module expects the
 122           identifiers as numeric string.</para>
 123           <para>The default for this options<emphasis>no</emphasis>.</para>
 124         </listitem>
 125       </varlistentry>
 126
 127       <varlistentry>
 128         <term>nfs4acl_xattr:validate_mode = yes|no</term>
 129         <listitem>
 130           <para>This parameter configures whether the module enforces the POSIX
 131           mode is set to 0777 for directories and 0666 for files. If this
 132           constrained is not met, the xattr with the ACL blob is
 133           discarded.</para>
 134           <para>The default depends on the setting for
 135           <emphasis>nfs4acl_xattr:encoding</emphasis>: when set to
 136           <emphasis>nfs</emphasis> this setting is disabled by default,
 137           otherwise it is enabled.</para>
 138         </listitem>
 139       </varlistentry>
 140
 141     </variablelist>
 142   </refsect1>
 143
 144   <refsect1>
 145     <title>EXAMPLES</title>
 146
 147     <para>A directory can be exported via Samba using this module as
 148     follows:</para>
 149
 150     <programlisting>
 151       <smbconfsection name="[samba_gpfs_share]"/>
 152       <smbconfoption name="vfs objects">nfs4acl_xattr</smbconfoption>
 153       <smbconfoption name="path">/foo/bar</smbconfoption>
 154     </programlisting>
 155   </refsect1>
 156
 157   <refsect1>
 158     <title>AUTHOR</title>
 159
 160     <para>The original Samba software and related utilities
 161     were created by Andrew Tridgell. Samba is now developed
 162     by the Samba Team as an Open Source project similar
 163     to the way the Linux kernel is developed.</para>
 164   </refsect1>
 165
 166 </refentry>