Next update of VFS modules development guide
[kai/samba.git] / docs / smbdotconf / security / securitymask.xml
1 <samba:parameter name="security mask"
2                  context="S"
3                                  type="string"
4                  xmlns:samba="http://www.samba.org/samba/DTD/samba-doc">
5 <description>
6     <para>
7         This parameter controls what UNIX permission bits will be set when a Windows NT client is manipulating the
8         UNIX permission on a file using the native NT security dialog box.
9         </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         security mode"/>, which works in a manner similar to this one but uses a logical OR instead of an AND. 
15         </para>
16
17     <para>
18         Essentially, all bits set to zero in this mask will result in setting to zero the corresponding bits on the
19         file permissions regardless of the previous status of this bits on the file.
20     </para>
21
22     <para>
23         If not set explicitly this parameter is 0777, allowing a user to set all the user/group/world permissions on a file.
24     </para>
25
26     <para><emphasis>
27         Note</emphasis> that users who can access the Samba server through other means can easily bypass this 
28     restriction, so it is primarily useful for standalone &quot;appliance&quot; systems.  Administrators of
29         most normal systems will probably want to leave it set to <constant>0777</constant>.
30         </para>
31 </description>
32
33 <related>force directory security mode</related>
34 <related>directory security mask</related>
35 <related>force security mode</related>
36
37 <value type="default">0777</value>
38 <value type="example">0770</value>
39 </samba:parameter>