Debian Codegraph @

upstream/opensuse-tumbleweed/man8/vfs_acl_xattr.8

raw
1 '\" t
2 .\" Title: vfs_acl_xattr
3 .\" Author: [see the "AUTHOR" section]
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: 05/26/2026
6 .\" Manual: System Administration tools
7 .\" Source: Samba 4.23.8-git.477.f78166bceedSUSE-oS16.9-x86_64
8 .\" Language: English
9 .\"
10 .TH "VFS_ACL_XATTR" "8" "05/26/2026" "Samba 4\&.23\&.8\-git\&.477\&.f78166bcee" "System Administration tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 vfs_acl_xattr \- Save NTFS\-ACLs in Extended Attributes (EAs)
32 .SH "SYNOPSIS"
33 .HP \w'\ 'u
34 vfs objects = acl_xattr
35 .SH "DESCRIPTION"
36 .PP
37 This VFS module is part of the
38 \fBsamba\fR(7)
39 suite\&.
40 .PP
41 This module is made for systems which do not support standardized NFS4 ACLs but only a deprecated POSIX ACL draft implementation\&. This is usually the case on Linux systems\&. Systems that do support just use NFSv4 ACLs directly instead of this module\&. Such support is usually provided by the filesystem VFS module specific to the underlying filesystem that supports NFS4 ACLs
42 .PP
43 The
44 vfs_acl_xattr
45 VFS module stores NTFS Access Control Lists (ACLs) in Extended Attributes (EAs)\&. This enables the full mapping of Windows ACLs on Samba servers even if the ACL implementation is not capable of doing so\&.
46 .PP
47 The NT ACLs are stored in the
48 \fIsecurity\&.NTACL\fR
49 extended attribute of files and directories in a form containing the Windows SID representing the users and groups in the ACL\&. This is different from the uid and gids stored in local filesystem ACLs and the mapping from users and groups to Windows SIDs must be consistent in order to maintain the meaning of the stored NT ACL That extended attribute is
50 \fInot\fR
51 listed by the Linux command
52 getfattr \-d filename\&. To show the current value, the name of the EA must be specified (e\&.g\&.
53 getfattr \-n security\&.NTACL filename)\&.
54 .PP
55 This module forces the following parameters:
56 .RS
57 .sp
58 .RS 4
59 .ie n \{\
60 \h'-04'\(bu\h'+03'\c
61 .\}
62 .el \{\
63 .sp -1
64 .IP \(bu 2.3
65 .\}
66 inherit acls = true
67 .RE
68 .sp
69 .RS 4
70 .ie n \{\
71 \h'-04'\(bu\h'+03'\c
72 .\}
73 .el \{\
74 .sp -1
75 .IP \(bu 2.3
76 .\}
77 dos filemode = true
78 .RE
79 .sp
80 .RS 4
81 .ie n \{\
82 \h'-04'\(bu\h'+03'\c
83 .\}
84 .el \{\
85 .sp -1
86 .IP \(bu 2.3
87 .\}
88 force unknown acl user = true
89 .RE
90 .sp
91 .RE
92 .PP
93 This module is stackable\&.
94 .SH "OPTIONS"
95 .PP
96 acl_xattr:security_acl_name = NAME
97 .RS 4
98 This option allows to redefine the default location for the NTACL extended attribute (xattr)\&. If not set, NTACL xattrs are written to security\&.NTACL which is a protected location, which means the content of the security\&.NTACL attribute is not accessible from normal users outside of Samba\&. When this option is set to use a user\-defined value, e\&.g\&. user\&.NTACL then any user can potentially access and overwrite this information\&. The module prevents access to this xattr over SMB, but the xattr may still be accessed by other means (eg local access, SSH, NFS)\&. This option must only be used when this consequence is clearly understood and when specific precautions are taken to avoid compromising the ACL content\&.
99 .RE
100 .PP
101 acl_xattr:ignore system acls = [yes|no]
102 .RS 4
103 When set to
104 \fIyes\fR, a best effort mapping from/to the POSIX draft ACL layer will
105 \fInot\fR
106 be done by this module\&. The default is
107 \fIno\fR, which means that Samba keeps setting and evaluating both the system ACLs and the NT ACLs\&. This is better if you need your system ACLs be set for local or NFS file access, too\&. If you only access the data via Samba you might set this to yes to achieve better NT ACL compatibility\&.
108 .sp
109 If
110 \fIacl_xattr:ignore system acls\fR
111 is set to
112 \fIyes\fR, the following additional settings will be enforced:
113 .RS
114 .sp
115 .RS 4
116 .ie n \{\
117 \h'-04'\(bu\h'+03'\c
118 .\}
119 .el \{\
120 .sp -1
121 .IP \(bu 2.3
122 .\}
123 create mask = 0666
124 .RE
125 .sp
126 .RS 4
127 .ie n \{\
128 \h'-04'\(bu\h'+03'\c
129 .\}
130 .el \{\
131 .sp -1
132 .IP \(bu 2.3
133 .\}
134 directory mask = 0777
135 .RE
136 .sp
137 .RS 4
138 .ie n \{\
139 \h'-04'\(bu\h'+03'\c
140 .\}
141 .el \{\
142 .sp -1
143 .IP \(bu 2.3
144 .\}
145 map archive = no
146 .RE
147 .sp
148 .RS 4
149 .ie n \{\
150 \h'-04'\(bu\h'+03'\c
151 .\}
152 .el \{\
153 .sp -1
154 .IP \(bu 2.3
155 .\}
156 map hidden = no
157 .RE
158 .sp
159 .RS 4
160 .ie n \{\
161 \h'-04'\(bu\h'+03'\c
162 .\}
163 .el \{\
164 .sp -1
165 .IP \(bu 2.3
166 .\}
167 map readonly = no
168 .RE
169 .sp
170 .RS 4
171 .ie n \{\
172 \h'-04'\(bu\h'+03'\c
173 .\}
174 .el \{\
175 .sp -1
176 .IP \(bu 2.3
177 .\}
178 map system = no
179 .RE
180 .sp
181 .RS 4
182 .ie n \{\
183 \h'-04'\(bu\h'+03'\c
184 .\}
185 .el \{\
186 .sp -1
187 .IP \(bu 2.3
188 .\}
189 store dos attributes = yes
190 .RE
191 .sp
192 .RE
193 .RE
194 .PP
195 acl_xattr:default acl style = [posix|windows|everyone]
196 .RS 4
197 This parameter determines the type of ACL that is synthesized in case a file or directory lacks an
198 \fIsecurity\&.NTACL\fR
199 xattr\&.
200 .sp
201 When set to
202 \fIposix\fR, an ACL will be synthesized based on the POSIX mode permissions for user, group and others, with an additional ACE for
203 \fINT Authority\eSYSTEM\fR
204 will full rights\&.
205 .sp
206 When set to
207 \fIwindows\fR, an ACL is synthesized the same way Windows does it, only including permissions for the owner and
208 \fINT Authority\eSYSTEM\fR\&.
209 .sp
210 When set to
211 \fIeveryone\fR, an ACL is synthesized giving full permissions to everyone (S\-1\-1\-0)\&.
212 .sp
213 The default for this option is
214 \fIposix\fR\&.
215 .RE
216 .SH "AUTHOR"
217 .PP
218 The original Samba software and related utilities were created by Andrew Tridgell\&. Samba is now developed by the Samba Team as an Open Source project similar to the way the Linux kernel is developed\&.