2 * Convert ZFS/NFSv4 acls to NT acls and vice versa.
4 * Copyright (C) Jiri Sasek, 2007
5 * based on the foobar.c module which is copyrighted by Volker Lendecke
7 * Many thanks to Axel Apitz for help to fix the special ace's handling
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 3 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, see <http://www.gnu.org/licenses/>.
26 #include "system/filesys.h"
27 #include "smbd/smbd.h"
28 #include "nfs4_acls.h"
30 #if HAVE_FREEBSD_SUNACL_H
35 #define DBGC_CLASS DBGC_VFS
37 #define ZFSACL_MODULE_NAME "zfsacl"
40 * read the local file's acls and return it in NT form
41 * using the NFSv4 format conversion
43 static NTSTATUS
zfs_get_nt_acl_common(struct connection_struct
*conn
,
45 const struct smb_filename
*smb_fname
,
46 struct SMB4ACL_T
**ppacl
)
50 struct SMB4ACL_T
*pacl
;
52 const SMB_STRUCT_STAT
*psbuf
= NULL
;
56 if (VALID_STAT(smb_fname
->st
)) {
57 psbuf
= &smb_fname
->st
;
61 ret
= vfs_stat_smb_basename(conn
, smb_fname
, &sbuf
);
63 DBG_INFO("stat [%s]failed: %s\n",
64 smb_fname_str_dbg(smb_fname
), strerror(errno
));
65 return map_nt_error_from_unix(errno
);
69 is_dir
= S_ISDIR(psbuf
->st_ex_mode
);
71 /* read the number of file aces */
72 if((naces
= acl(smb_fname
->base_name
, ACE_GETACLCNT
, 0, NULL
)) == -1) {
74 DEBUG(9, ("acl(ACE_GETACLCNT, %s): Operation is not "
75 "supported on the filesystem where the file "
76 "reside\n", smb_fname
->base_name
));
78 DEBUG(9, ("acl(ACE_GETACLCNT, %s): %s ", smb_fname
->base_name
,
81 return map_nt_error_from_unix(errno
);
83 /* allocate the field of ZFS aces */
84 mem_ctx
= talloc_tos();
85 acebuf
= (ace_t
*) talloc_size(mem_ctx
, sizeof(ace_t
)*naces
);
87 return NT_STATUS_NO_MEMORY
;
89 /* read the aces into the field */
90 if(acl(smb_fname
->base_name
, ACE_GETACL
, naces
, acebuf
) < 0) {
91 DEBUG(9, ("acl(ACE_GETACL, %s): %s ", smb_fname
->base_name
,
93 return map_nt_error_from_unix(errno
);
95 /* create SMB4ACL data */
96 if((pacl
= smb_create_smb4acl(mem_ctx
)) == NULL
) {
97 return NT_STATUS_NO_MEMORY
;
99 for(i
=0; i
<naces
; i
++) {
100 SMB_ACE4PROP_T aceprop
;
102 aceprop
.aceType
= (uint32_t) acebuf
[i
].a_type
;
103 aceprop
.aceFlags
= (uint32_t) acebuf
[i
].a_flags
;
104 aceprop
.aceMask
= (uint32_t) acebuf
[i
].a_access_mask
;
105 aceprop
.who
.id
= (uint32_t) acebuf
[i
].a_who
;
108 * Windows clients expect SYNC on acls to correctly allow
109 * rename, cf bug #7909. But not on DENY ace entries, cf bug
112 if (aceprop
.aceType
== SMB_ACE4_ACCESS_ALLOWED_ACE_TYPE
) {
113 aceprop
.aceMask
|= SMB_ACE4_SYNCHRONIZE
;
116 if (is_dir
&& (aceprop
.aceMask
& SMB_ACE4_ADD_FILE
)) {
117 aceprop
.aceMask
|= SMB_ACE4_DELETE_CHILD
;
120 if(aceprop
.aceFlags
& ACE_OWNER
) {
121 aceprop
.flags
= SMB_ACE4_ID_SPECIAL
;
122 aceprop
.who
.special_id
= SMB_ACE4_WHO_OWNER
;
123 } else if(aceprop
.aceFlags
& ACE_GROUP
) {
124 aceprop
.flags
= SMB_ACE4_ID_SPECIAL
;
125 aceprop
.who
.special_id
= SMB_ACE4_WHO_GROUP
;
126 } else if(aceprop
.aceFlags
& ACE_EVERYONE
) {
127 aceprop
.flags
= SMB_ACE4_ID_SPECIAL
;
128 aceprop
.who
.special_id
= SMB_ACE4_WHO_EVERYONE
;
132 if(smb_add_ace4(pacl
, &aceprop
) == NULL
)
133 return NT_STATUS_NO_MEMORY
;
140 /* call-back function processing the NT acl -> ZFS acl using NFSv4 conv. */
141 static bool zfs_process_smbacl(vfs_handle_struct
*handle
, files_struct
*fsp
,
142 struct SMB4ACL_T
*smbacl
)
144 int naces
= smb_get_naces(smbacl
), i
;
146 struct SMB4ACE_T
*smbace
;
148 bool have_special_id
= false;
150 /* allocate the field of ZFS aces */
151 mem_ctx
= talloc_tos();
152 acebuf
= (ace_t
*) talloc_size(mem_ctx
, sizeof(ace_t
)*naces
);
157 /* handle all aces */
158 for(smbace
= smb_first_ace4(smbacl
), i
= 0;
160 smbace
= smb_next_ace4(smbace
), i
++) {
161 SMB_ACE4PROP_T
*aceprop
= smb_get_ace4(smbace
);
163 acebuf
[i
].a_type
= aceprop
->aceType
;
164 acebuf
[i
].a_flags
= aceprop
->aceFlags
;
165 acebuf
[i
].a_access_mask
= aceprop
->aceMask
;
166 /* SYNC on acls is a no-op on ZFS.
168 acebuf
[i
].a_access_mask
&= ~SMB_ACE4_SYNCHRONIZE
;
169 acebuf
[i
].a_who
= aceprop
->who
.id
;
170 if(aceprop
->flags
& SMB_ACE4_ID_SPECIAL
) {
171 switch(aceprop
->who
.special_id
) {
172 case SMB_ACE4_WHO_EVERYONE
:
173 acebuf
[i
].a_flags
|= ACE_EVERYONE
;
175 case SMB_ACE4_WHO_OWNER
:
176 acebuf
[i
].a_flags
|= ACE_OWNER
;
178 case SMB_ACE4_WHO_GROUP
:
179 acebuf
[i
].a_flags
|= ACE_GROUP
|ACE_IDENTIFIER_GROUP
;
182 DEBUG(8, ("unsupported special_id %d\n", \
183 aceprop
->who
.special_id
));
184 continue; /* don't add it !!! */
186 have_special_id
= true;
191 && lp_parm_bool(fsp
->conn
->params
->service
, "zfsacl",
192 "denymissingspecial", false)) {
197 SMB_ASSERT(i
== naces
);
200 if(acl(fsp
->fsp_name
->base_name
, ACE_SETACL
, naces
, acebuf
)) {
201 if(errno
== ENOSYS
) {
202 DEBUG(9, ("acl(ACE_SETACL, %s): Operation is not "
203 "supported on the filesystem where the file "
204 "reside", fsp_str_dbg(fsp
)));
206 DEBUG(9, ("acl(ACE_SETACL, %s): %s ", fsp_str_dbg(fsp
),
216 * set the local file's acls obtaining it in NT form
217 * using the NFSv4 format conversion
219 static NTSTATUS
zfs_set_nt_acl(vfs_handle_struct
*handle
, files_struct
*fsp
,
220 uint32_t security_info_sent
,
221 const struct security_descriptor
*psd
)
223 return smb_set_nt_acl_nfs4(handle
, fsp
, NULL
, security_info_sent
, psd
,
227 static NTSTATUS
zfsacl_fget_nt_acl(struct vfs_handle_struct
*handle
,
228 struct files_struct
*fsp
,
229 uint32_t security_info
,
231 struct security_descriptor
**ppdesc
)
233 struct SMB4ACL_T
*pacl
;
235 TALLOC_CTX
*frame
= talloc_stackframe();
237 status
= zfs_get_nt_acl_common(handle
->conn
, frame
,
238 fsp
->fsp_name
, &pacl
);
239 if (!NT_STATUS_IS_OK(status
)) {
244 status
= smb_fget_nt_acl_nfs4(fsp
, NULL
, security_info
, mem_ctx
,
250 static NTSTATUS
zfsacl_get_nt_acl(struct vfs_handle_struct
*handle
,
251 const struct smb_filename
*smb_fname
,
252 uint32_t security_info
,
254 struct security_descriptor
**ppdesc
)
256 struct SMB4ACL_T
*pacl
;
258 TALLOC_CTX
*frame
= talloc_stackframe();
260 status
= zfs_get_nt_acl_common(handle
->conn
, frame
, smb_fname
, &pacl
);
261 if (!NT_STATUS_IS_OK(status
)) {
266 status
= smb_get_nt_acl_nfs4(handle
->conn
,
277 static NTSTATUS
zfsacl_fset_nt_acl(vfs_handle_struct
*handle
,
279 uint32_t security_info_sent
,
280 const struct security_descriptor
*psd
)
282 return zfs_set_nt_acl(handle
, fsp
, security_info_sent
, psd
);
285 /* nils.goroll@hamburg.de 2008-06-16 :
288 - https://bugzilla.samba.org/show_bug.cgi?id=5446
289 - http://bugs.opensolaris.org/view_bug.do?bug_id=6688240
291 Solaris supports NFSv4 and ZFS ACLs through a common system call, acl(2)
292 with ACE_SETACL / ACE_GETACL / ACE_GETACLCNT, which is being wrapped for
293 use by samba in this module.
295 As the acl(2) interface is identical for ZFS and for NFS, this module,
296 vfs_zfsacl, can not only be used for ZFS, but also for sharing NFSv4
299 But while "traditional" POSIX DRAFT ACLs (using acl(2) with SETACL
300 / GETACL / GETACLCNT) fail for ZFS, the Solaris NFS client
301 implemets a compatibility wrapper, which will make calls to
302 traditional ACL calls though vfs_solarisacl succeed. As the
303 compatibility wrapper's implementation is (by design) incomplete,
304 we want to make sure that it is never being called.
306 As long as Samba does not support an exiplicit method for a module
307 to define conflicting vfs methods, we should override all conflicting
310 For this to work, we need to make sure that this module is initialised
311 *after* vfs_solarisacl
313 Function declarations taken from vfs_solarisacl
316 static SMB_ACL_T
zfsacl_fail__sys_acl_get_file(vfs_handle_struct
*handle
,
317 const struct smb_filename
*smb_fname
,
321 return (SMB_ACL_T
)NULL
;
324 static SMB_ACL_T
zfsacl_fail__sys_acl_get_fd(vfs_handle_struct
*handle
,
328 return (SMB_ACL_T
)NULL
;
331 static int zfsacl_fail__sys_acl_set_file(vfs_handle_struct
*handle
,
332 const struct smb_filename
*smb_fname
,
339 static int zfsacl_fail__sys_acl_set_fd(vfs_handle_struct
*handle
,
346 static int zfsacl_fail__sys_acl_delete_def_file(vfs_handle_struct
*handle
,
347 const struct smb_filename
*smb_fname
)
352 static int zfsacl_fail__sys_acl_blob_get_file(vfs_handle_struct
*handle
,
353 const struct smb_filename
*smb_fname
,
355 char **blob_description
,
361 static int zfsacl_fail__sys_acl_blob_get_fd(vfs_handle_struct
*handle
, files_struct
*fsp
, TALLOC_CTX
*mem_ctx
, char **blob_description
, DATA_BLOB
*blob
)
366 /* VFS operations structure */
368 static struct vfs_fn_pointers zfsacl_fns
= {
369 .sys_acl_get_file_fn
= zfsacl_fail__sys_acl_get_file
,
370 .sys_acl_get_fd_fn
= zfsacl_fail__sys_acl_get_fd
,
371 .sys_acl_blob_get_file_fn
= zfsacl_fail__sys_acl_blob_get_file
,
372 .sys_acl_blob_get_fd_fn
= zfsacl_fail__sys_acl_blob_get_fd
,
373 .sys_acl_set_file_fn
= zfsacl_fail__sys_acl_set_file
,
374 .sys_acl_set_fd_fn
= zfsacl_fail__sys_acl_set_fd
,
375 .sys_acl_delete_def_file_fn
= zfsacl_fail__sys_acl_delete_def_file
,
376 .fget_nt_acl_fn
= zfsacl_fget_nt_acl
,
377 .get_nt_acl_fn
= zfsacl_get_nt_acl
,
378 .fset_nt_acl_fn
= zfsacl_fset_nt_acl
,
382 NTSTATUS
vfs_zfsacl_init(TALLOC_CTX
*ctx
)
384 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION
, "zfsacl",