nfs4_acls: Use switch/case for checking idmap type
[Samba.git] / docs-xml / manpages / vfs_acl_tdb.8.xml
blob5f3c6ba045e854b8bc48cea0ac537bc711a15cf0
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_tdb.8">
5 <refmeta>
6         <refentrytitle>vfs_acl_tdb</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>
14 <refnamediv>
15         <refname>vfs_acl_tdb</refname>
16         <refpurpose>Save NTFS-ACLs in a tdb file</refpurpose>
17 </refnamediv>
19 <refsynopsisdiv>
20         <cmdsynopsis>
21                 <command>vfs objects = acl_tdb</command>
22         </cmdsynopsis>
23 </refsynopsisdiv>
25 <refsect1>
26         <title>DESCRIPTION</title>
28         <para>This VFS module is part of the
29         <citerefentry><refentrytitle>samba</refentrytitle>
30         <manvolnum>7</manvolnum></citerefentry> suite.</para>
32         <para>The <command>vfs_acl_tdb</command> VFS module stores
33         NTFS Access Control Lists (ACLs) in a tdb file.
34         This enables the full mapping of Windows ACLs on Samba
35         servers.
36         </para>
38         <para>
39         The ACL settings are stored in
40         <filename>$LOCKDIR/file_ntacls.tdb</filename>.
41         </para>
43         <para>
44         This module forces the following parameters:
45         <itemizedlist>
46         <listitem><para>inherit acls = true</para></listitem>
47         <listitem><para>dos filemode = true</para></listitem>
48         <listitem><para>force unknown acl user = true</para></listitem>
49         </itemizedlist>
50         </para>
52         <para>This module is stackable.</para>
53 </refsect1>
55 <refsect1>
56         <title>OPTIONS</title>
58         <variablelist>
59                 <!-- please keep in sync with the other acl vfs modules that provide the same options -->
60                 <varlistentry>
61                 <term>acl_tdb:ignore system acls = [yes|no]</term>
62                 <listitem>
63                 <para>
64                 When set to <emphasis>yes</emphasis>, a best effort mapping
65                 from/to the POSIX ACL layer will <emphasis>not</emphasis> be
66                 done by this module. The default is <emphasis>no</emphasis>,
67                 which means that Samba keeps setting and evaluating both the
68                 system ACLs and the NT ACLs. This is better if you need your
69                 system ACLs be set for local or NFS file access, too. If you only
70                 access the data via Samba you might set this to yes to achieve
71                 better NT ACL compatibility.
72                 </para>
74                 <para>
75                 If <emphasis>acl_tdb:ignore system acls</emphasis>
76                 is set to <emphasis>yes</emphasis>, the following
77                 additional settings will be enforced:
78                 <itemizedlist>
79                 <listitem><para>create mask = 0666</para></listitem>
80                 <listitem><para>directory mask = 0777</para></listitem>
81                 <listitem><para>map archive = no</para></listitem>
82                 <listitem><para>map hidden = no</para></listitem>
83                 <listitem><para>map readonly = no</para></listitem>
84                 <listitem><para>map system = no</para></listitem>
85                 <listitem><para>store dos attributes = yes</para></listitem>
86                 </itemizedlist>
87                 </para>
88                 </listitem>
89                 </varlistentry>
91                 <varlistentry>
92                 <term>acl_tdb:default acl style = [posix|windows|everyone]</term>
93                 <listitem>
94                 <para>
95                 This parameter determines the type of ACL that is synthesized in
96                 case a file or directory lacks an
97                 <emphasis>security.NTACL</emphasis> xattr.
98                 </para>
99                 <para>
100                 When set to <emphasis>posix</emphasis>, an ACL will be
101                 synthesized based on the POSIX mode permissions for user, group
102                 and others, with an additional ACE for <emphasis>NT
103                 Authority\SYSTEM</emphasis> will full rights.
104                 </para>
105                 <para>
106                 When set to <emphasis>windows</emphasis>, an ACL is synthesized
107                 the same way Windows does it, only including permissions for the
108                 owner and <emphasis>NT Authority\SYSTEM</emphasis>.
109                 </para>
110                 <para>
111                 When set to <emphasis>everyone</emphasis>, an ACL is synthesized
112                 giving full permissions to everyone (S-1-1-0).
113                 </para>
114                 <para>
115                 The default for this option is <emphasis>posix</emphasis>.
116                 </para>
117                 </listitem>
118                 </varlistentry>
119         </variablelist>
121 </refsect1>
123 <refsect1>
124         <title>AUTHOR</title>
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>
132 </refentry>