docs-xml/manpages/vfs_acl_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_acl_xattr.8">
   4
   5 <refmeta>
   6         <refentrytitle>vfs_acl_xattr</refentrytitle>
   7         <manvolnum>8</manvolnum>
   8         <refmiscinfo class="source">Samba</refmiscinfo>
   9         <refmiscinfo class="manual">System Administration tools</refmiscinfo>
  10         <refmiscinfo class="version">4.6</refmiscinfo>
  11 </refmeta>
  12
  13
  14 <refnamediv>
  15         <refname>vfs_acl_xattr</refname>
  16         <refpurpose>Save NTFS-ACLs in Extended Attributes (EAs)</refpurpose>
  17 </refnamediv>
  18
  19 <refsynopsisdiv>
  20         <cmdsynopsis>
  21                 <command>vfs objects = acl_xattr</command>
  22         </cmdsynopsis>
  23 </refsynopsisdiv>
  24
  25 <refsect1>
  26         <title>DESCRIPTION</title>
  27
  28         <para>This VFS module is part of the
  29         <citerefentry><refentrytitle>samba</refentrytitle>
  30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
  31
  32         <para>The <command>vfs_acl_xattr</command> VFS module stores
  33         NTFS Access Control Lists (ACLs) in Extended Attributes (EAs).
  34         This enables the full mapping of Windows ACLs on Samba
  35         servers.
  36         </para>
  37
  38         <para>The ACLs are stored in the Extended Attribute
  39         <parameter>security.NTACL</parameter> of a file or directory.
  40         This Attribute is <emphasis>not</emphasis> listed by
  41         <command>getfattr -d <filename>filename</filename></command>.
  42         To show the current value, the name of the EA must be specified
  43         (e.g. <command>getfattr -n security.NTACL <filename>filename</filename>
  44         </command>).
  45         </para>
  46
  47         <para>
  48         This module forces the following parameters:
  49         <itemizedlist>
  50         <listitem><para>inherit acls = true</para></listitem>
  51         <listitem><para>dos filemode = true</para></listitem>
  52         <listitem><para>force unknown acl user = true</para></listitem>
  53         </itemizedlist>
  54         </para>
  55
  56         <para>This module is stackable.</para>
  57 </refsect1>
  58
  59 <refsect1>
  60         <title>OPTIONS</title>
  61
  62         <variablelist>
  63                 <!-- please keep in sync with the other acl vfs modules that provide the same options -->
  64                 <varlistentry>
  65                 <term>acl_xattr:ignore system acls = [yes|no]</term>
  66                 <listitem>
  67                 <para>
  68                 When set to <emphasis>yes</emphasis>, a best effort mapping
  69                 from/to the POSIX ACL layer will <emphasis>not</emphasis> be
  70                 done by this module. The default is <emphasis>no</emphasis>,
  71                 which means that Samba keeps setting and evaluating both the
  72                 system ACLs and the NT ACLs. This is better if you need your
  73                 system ACLs be set for local or NFS file access, too. If you only
  74                 access the data via Samba you might set this to yes to achieve
  75                 better NT ACL compatibility.
  76                 </para>
  77
  78                 <para>
  79                 If <emphasis>acl_xattr:ignore system acls</emphasis>
  80                 is set to <emphasis>yes</emphasis>, the following
  81                 additional settings will be enforced:
  82                 <itemizedlist>
  83                 <listitem><para>create mask = 0666</para></listitem>
  84                 <listitem><para>directory mask = 0777</para></listitem>
  85                 <listitem><para>map archive = no</para></listitem>
  86                 <listitem><para>map hidden = no</para></listitem>
  87                 <listitem><para>map readonly = no</para></listitem>
  88                 <listitem><para>map system = no</para></listitem>
  89                 <listitem><para>store dos attributes = yes</para></listitem>
  90                 </itemizedlist>
  91                 </para>
  92                 </listitem>
  93                 </varlistentry>
  94
  95                 <varlistentry>
  96                 <term>acl_xattr:default acl style = [posix|windows]</term>
  97                 <listitem>
  98                 <para>
  99                 This parameter determines the type of ACL that is synthesized in
 100                 case a file or directory lacks an
 101                 <emphasis>security.NTACL</emphasis> xattr.
 102                 </para>
 103                 <para>
 104                 When set to <emphasis>posix</emphasis>, an ACL will be
 105                 synthesized based on the POSIX mode permissions for user, group
 106                 and others, with an additional ACE for <emphasis>NT
 107                 Authority\SYSTEM</emphasis> will full rights.
 108                 </para>
 109                 <para>
 110                 When set to <emphasis>windows</emphasis>, an ACL is synthesized
 111                 the same way Windows does it, only including permissions for the
 112                 owner and <emphasis>NT Authority\SYSTEM</emphasis>.
 113                 </para>
 114                 <para>
 115                 The default for this option is <emphasis>posix</emphasis>.
 116                 </para>
 117                 </listitem>
 118                 </varlistentry>
 119         </variablelist>
 120
 121 </refsect1>
 122
 123 <refsect1>
 124         <title>AUTHOR</title>
 125
 126         <para>The original Samba software and related utilities
 127         were created by Andrew Tridgell. Samba is now developed
 128         by the Samba Team as an Open Source project similar
 129         to the way the Linux kernel is developed.</para>
 130 </refsect1>
 131
 132 </refentry>