Moving docs tree to docs-xml to make room for generated docs in the release tarball.
[vlendec/samba-autobuild/.git] / docs-xml / smbdotconf / security / directorysecuritymask.xml
1 <samba:parameter name="directory security mask"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>This parameter controls what UNIX permission bits
7     will be set when a Windows NT client is manipulating the UNIX
8     permission on a directory using the native NT security dialog
9     box.</para>
10
11     <para>
12         This parameter is applied as a mask (AND'ed with) to the incoming permission bits, thus resetting
13         any bits not in this mask.  Make sure not to mix up this parameter with <smbconfoption name="force
14         directory security mode"/>, which works similar like this one but uses logical OR instead of AND.
15         Essentially, zero bits in this mask are a set of bits that will always be set to zero.
16         </para>
17
18     <para>
19         Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
20         file permissions regardless of the previous status of this bits on the file.
21     </para>
22
23     <para>If not set explicitly this parameter is set to 0777
24     meaning a user is allowed to set all the user/group/world
25     permissions on a directory.</para>
26
27     <para><emphasis>Note</emphasis> that users who can access the 
28     Samba server through other means can easily bypass this restriction, 
29     so it is primarily useful for standalone &quot;appliance&quot; systems.  
30     Administrators of most normal systems will probably want to leave
31         it as the default of <constant>0777</constant>.</para>
32 </description>
33
34 <related>force directory security mode</related>
35 <related>security mask</related>
36 <related>force security mode</related>
37 <value type="default">0777</value>
38 <value type="example">0700</value>
39 </samba:parameter>