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 = [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>ndr (default)</emphasis> - store the NT
  55           ACL with POSIX draft NFSv4 compatible NDR encoding. By default this
  56           uses the extended attribute "security.nfs4acl_ndr".</para>
  57
  58           <para>When set to <emphasis>xdr</emphasis> - store the NT ACL in a
  59           format similar to NFS 4.1 RFC 5661 in XDR encoding. The main
  60           differences to RFC 5661 are the use of ids instead of strings as users
  61           and group identifiers and an additional attribute per nfsace4. By
  62           default this encoding stores the blob in the extended attribute
  63           "security.nfs4acl_xdr".</para>
  64         </listitem>
  65       </varlistentry>
  66
  67       <varlistentry>
  68         <term>nfs4acl_xattr:version = [40|41]</term>
  69         <listitem>
  70           <para>This parameter configures the NFS4 ACL level. Only
  71           <emphasis>41</emphasis> fully supports mapping NT ACLs and should be
  72           used. The default is <emphasis>41</emphasis>.</para>
  73         </listitem>
  74       </varlistentry>
  75
  76       <varlistentry>
  77         <term>nfs4acl_xattr:default acl style = [posix|windows|everyone]</term>
  78         <listitem>
  79           <para>This parameter determines the type of ACL that is synthesized in
  80           case a file or directory lacks an ACL extended attribute.</para>
  81
  82           <para>When set to <emphasis>posix</emphasis>, an ACL will be
  83           synthesized based on the POSIX mode permissions for user, group and
  84           others, with an additional ACE for <emphasis>NT
  85           Authority\SYSTEM</emphasis> will full rights.</para>
  86
  87           <para>When set to <emphasis>windows</emphasis>, an ACL is synthesized
  88           the same way Windows does it, only including permissions for the owner
  89           and <emphasis>NT Authority\SYSTEM</emphasis>.</para>
  90
  91           <para>When set to <emphasis>everyone</emphasis>, an ACL is synthesized
  92           giving full permissions to everyone (S-1-1-0).</para>
  93
  94           <para>The default for this option is
  95           <emphasis>everyone</emphasis>.</para>
  96         </listitem>
  97       </varlistentry>
  98
  99       <varlistentry>
 100         <term>nfs4acl_xattr:xattr_name = STRING</term>
 101         <listitem>
 102           <para>This parameter configures the extended attribute name used to
 103           store the marshaled ACL.</para>
 104           <para>The default depends on the setting for
 105           <emphasis>nfs4acl_xattr:encoding</emphasis>.</para>
 106         </listitem>
 107       </varlistentry>
 108
 109     </variablelist>
 110   </refsect1>
 111
 112   <refsect1>
 113     <title>EXAMPLES</title>
 114
 115     <para>A directory can be exported via Samba using this module as
 116     follows:</para>
 117
 118     <programlisting>
 119       <smbconfsection name="[samba_gpfs_share]"/>
 120       <smbconfoption name="vfs objects">nfs4acl_xattr</smbconfoption>
 121       <smbconfoption name="path">/foo/bar</smbconfoption>
 122     </programlisting>
 123   </refsect1>
 124
 125   <refsect1>
 126     <title>AUTHOR</title>
 127
 128     <para>The original Samba software and related utilities
 129     were created by Andrew Tridgell. Samba is now developed
 130     by the Samba Team as an Open Source project similar
 131     to the way the Linux kernel is developed.</para>
 132   </refsect1>
 133
 134 </refentry>