Next update of VFS modules development guide
[ira/wip.git] / docs / smbdotconf / security / forcedirectorysecuritymode.xml
1 <samba:parameter name="force directory security mode"
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 can be modified when a Windows NT client is manipulating
8         the UNIX permission on a directory using the native NT security dialog box.
9         </para>
10
11     <para>
12         This parameter is applied as a mask (OR'ed with) to the changed permission bits, thus forcing any bits in this
13         mask that the user may have modified to be on.  Make sure not to mix up this parameter with <smbconfoption
14         name="directory security mask"/>, which works in a similar manner to this one, but uses a logical AND instead
15         of an OR. 
16         </para>
17
18         <para>
19         Essentially, this mask may be treated as a set of bits that, when modifying security on a directory, 
20         to will enable (1) any flags that are off (0) but which the mask has set to on (1).
21         </para>
22
23     <para>
24         If not set explicitly this parameter is 0000, which allows a user to modify all the user/group/world
25         permissions on a directory without restrictions.
26         </para>
27
28     <note><para>
29         Users who can access the Samba server through other means can easily bypass this restriction, so it is
30         primarily useful for standalone &quot;appliance&quot; systems.  Administrators of most normal systems will
31         probably want to leave it set as 0000.
32         </para></note>
33
34 </description>
35
36 <value type="default">0</value>
37 <value type="example">700</value>
38
39 <related>directory security mask</related>
40 <related>security mask</related>
41 <related>force security mode</related>
42
43 </samba:parameter>