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