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 #ifdef HAVE_FREEBSD_SUNACL_H
35 #define DBGC_CLASS DBGC_VFS
37 #define ZFSACL_MODULE_NAME "zfsacl"
39 struct zfsacl_config_data {
40 struct smbacl4_vfs_params nfs4_params;
41 bool zfsacl_denymissingspecial;
45 * read the local file's acls and return it in NT form
46 * using the NFSv4 format conversion
48 static NTSTATUS zfs_get_nt_acl_common(struct connection_struct *conn,
50 const struct smb_filename *smb_fname,
51 struct SMB4ACL_T **ppacl)
55 struct SMB4ACL_T *pacl;
57 const SMB_STRUCT_STAT *psbuf = NULL;
61 if (VALID_STAT(smb_fname->st)) {
62 psbuf = &smb_fname->st;
66 ret = vfs_stat_smb_basename(conn, smb_fname, &sbuf);
68 DBG_INFO("stat [%s]failed: %s\n",
69 smb_fname_str_dbg(smb_fname), strerror(errno));
70 return map_nt_error_from_unix(errno);
74 is_dir = S_ISDIR(psbuf->st_ex_mode);
76 /* read the number of file aces */
77 if((naces = acl(smb_fname->base_name, ACE_GETACLCNT, 0, NULL)) == -1) {
79 DEBUG(9, ("acl(ACE_GETACLCNT, %s): Operation is not "
80 "supported on the filesystem where the file "
81 "reside\n", smb_fname->base_name));
83 DEBUG(9, ("acl(ACE_GETACLCNT, %s): %s ", smb_fname->base_name,
86 return map_nt_error_from_unix(errno);
88 /* allocate the field of ZFS aces */
89 mem_ctx = talloc_tos();
90 acebuf = (ace_t *) talloc_size(mem_ctx, sizeof(ace_t)*naces);
92 return NT_STATUS_NO_MEMORY;
94 /* read the aces into the field */
95 if(acl(smb_fname->base_name, ACE_GETACL, naces, acebuf) < 0) {
96 DEBUG(9, ("acl(ACE_GETACL, %s): %s ", smb_fname->base_name,
98 return map_nt_error_from_unix(errno);
100 /* create SMB4ACL data */
101 if((pacl = smb_create_smb4acl(mem_ctx)) == NULL) {
102 return NT_STATUS_NO_MEMORY;
104 for(i=0; i<naces; i++) {
105 SMB_ACE4PROP_T aceprop;
107 aceprop.aceType = (uint32_t) acebuf[i].a_type;
108 aceprop.aceFlags = (uint32_t) acebuf[i].a_flags;
109 aceprop.aceMask = (uint32_t) acebuf[i].a_access_mask;
110 aceprop.who.id = (uint32_t) acebuf[i].a_who;
113 * Windows clients expect SYNC on acls to correctly allow
114 * rename, cf bug #7909. But not on DENY ace entries, cf bug
117 if (aceprop.aceType == SMB_ACE4_ACCESS_ALLOWED_ACE_TYPE) {
118 aceprop.aceMask |= SMB_ACE4_SYNCHRONIZE;
121 if (is_dir && (aceprop.aceMask & SMB_ACE4_ADD_FILE)) {
122 aceprop.aceMask |= SMB_ACE4_DELETE_CHILD;
125 if(aceprop.aceFlags & ACE_OWNER) {
126 aceprop.flags = SMB_ACE4_ID_SPECIAL;
127 aceprop.who.special_id = SMB_ACE4_WHO_OWNER;
128 } else if(aceprop.aceFlags & ACE_GROUP) {
129 aceprop.flags = SMB_ACE4_ID_SPECIAL;
130 aceprop.who.special_id = SMB_ACE4_WHO_GROUP;
131 } else if(aceprop.aceFlags & ACE_EVERYONE) {
132 aceprop.flags = SMB_ACE4_ID_SPECIAL;
133 aceprop.who.special_id = SMB_ACE4_WHO_EVERYONE;
137 if(smb_add_ace4(pacl, &aceprop) == NULL)
138 return NT_STATUS_NO_MEMORY;
145 /* call-back function processing the NT acl -> ZFS acl using NFSv4 conv. */
146 static bool zfs_process_smbacl(vfs_handle_struct *handle, files_struct *fsp,
147 struct SMB4ACL_T *smbacl)
149 int naces = smb_get_naces(smbacl), i;
151 struct SMB4ACE_T *smbace;
153 bool have_special_id = false;
154 struct zfsacl_config_data *config = NULL;
156 SMB_VFS_HANDLE_GET_DATA(handle, config,
157 struct zfsacl_config_data,
160 /* allocate the field of ZFS aces */
161 mem_ctx = talloc_tos();
162 acebuf = (ace_t *) talloc_size(mem_ctx, sizeof(ace_t)*naces);
167 /* handle all aces */
168 for(smbace = smb_first_ace4(smbacl), i = 0;
170 smbace = smb_next_ace4(smbace), i++) {
171 SMB_ACE4PROP_T *aceprop = smb_get_ace4(smbace);
173 acebuf[i].a_type = aceprop->aceType;
174 acebuf[i].a_flags = aceprop->aceFlags;
175 acebuf[i].a_access_mask = aceprop->aceMask;
176 /* SYNC on acls is a no-op on ZFS.
178 acebuf[i].a_access_mask &= ~SMB_ACE4_SYNCHRONIZE;
179 acebuf[i].a_who = aceprop->who.id;
180 if(aceprop->flags & SMB_ACE4_ID_SPECIAL) {
181 switch(aceprop->who.special_id) {
182 case SMB_ACE4_WHO_EVERYONE:
183 acebuf[i].a_flags |= ACE_EVERYONE;
185 case SMB_ACE4_WHO_OWNER:
186 acebuf[i].a_flags |= ACE_OWNER;
188 case SMB_ACE4_WHO_GROUP:
189 acebuf[i].a_flags |= ACE_GROUP|ACE_IDENTIFIER_GROUP;
192 DEBUG(8, ("unsupported special_id %d\n", \
193 aceprop->who.special_id));
194 continue; /* don't add it !!! */
196 have_special_id = true;
200 if (!have_special_id && config->zfsacl_denymissingspecial) {
205 SMB_ASSERT(i == naces);
208 if(acl(fsp->fsp_name->base_name, ACE_SETACL, naces, acebuf)) {
209 if(errno == ENOSYS) {
210 DEBUG(9, ("acl(ACE_SETACL, %s): Operation is not "
211 "supported on the filesystem where the file "
212 "reside", fsp_str_dbg(fsp)));
214 DEBUG(9, ("acl(ACE_SETACL, %s): %s ", fsp_str_dbg(fsp),
224 * set the local file's acls obtaining it in NT form
225 * using the NFSv4 format conversion
227 static NTSTATUS zfs_set_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
228 uint32_t security_info_sent,
229 const struct security_descriptor *psd)
231 struct zfsacl_config_data *config = NULL;
233 SMB_VFS_HANDLE_GET_DATA(handle, config,
234 struct zfsacl_config_data,
235 return NT_STATUS_INTERNAL_ERROR);
237 return smb_set_nt_acl_nfs4(handle,
239 &config->nfs4_params,
245 static NTSTATUS zfsacl_fget_nt_acl(struct vfs_handle_struct *handle,
246 struct files_struct *fsp,
247 uint32_t security_info,
249 struct security_descriptor **ppdesc)
251 struct SMB4ACL_T *pacl;
253 TALLOC_CTX *frame = talloc_stackframe();
255 status = zfs_get_nt_acl_common(handle->conn, frame,
256 fsp->fsp_name, &pacl);
257 if (!NT_STATUS_IS_OK(status)) {
259 if (!NT_STATUS_EQUAL(status, NT_STATUS_NOT_SUPPORTED)) {
263 status = make_default_filesystem_acl(mem_ctx,
265 fsp->fsp_name->base_name,
268 if (!NT_STATUS_IS_OK(status)) {
271 (*ppdesc)->type |= SEC_DESC_DACL_PROTECTED;
275 status = smb_fget_nt_acl_nfs4(fsp, NULL, security_info, mem_ctx,
281 static NTSTATUS zfsacl_get_nt_acl(struct vfs_handle_struct *handle,
282 const struct smb_filename *smb_fname,
283 uint32_t security_info,
285 struct security_descriptor **ppdesc)
287 struct SMB4ACL_T *pacl;
289 TALLOC_CTX *frame = talloc_stackframe();
291 status = zfs_get_nt_acl_common(handle->conn, frame, smb_fname, &pacl);
292 if (!NT_STATUS_IS_OK(status)) {
294 if (!NT_STATUS_EQUAL(status, NT_STATUS_NOT_SUPPORTED)) {
298 if (!VALID_STAT(smb_fname->st)) {
299 DBG_ERR("No stat info for [%s]\n",
300 smb_fname_str_dbg(smb_fname));
301 return NT_STATUS_INTERNAL_ERROR;
304 status = make_default_filesystem_acl(mem_ctx,
306 smb_fname->base_name,
309 if (!NT_STATUS_IS_OK(status)) {
312 (*ppdesc)->type |= SEC_DESC_DACL_PROTECTED;
316 status = smb_get_nt_acl_nfs4(handle->conn,
327 static NTSTATUS zfsacl_fset_nt_acl(vfs_handle_struct *handle,
329 uint32_t security_info_sent,
330 const struct security_descriptor *psd)
332 return zfs_set_nt_acl(handle, fsp, security_info_sent, psd);
335 /* nils.goroll@hamburg.de 2008-06-16 :
338 - https://bugzilla.samba.org/show_bug.cgi?id=5446
339 - http://bugs.opensolaris.org/view_bug.do?bug_id=6688240
341 Solaris supports NFSv4 and ZFS ACLs through a common system call, acl(2)
342 with ACE_SETACL / ACE_GETACL / ACE_GETACLCNT, which is being wrapped for
343 use by samba in this module.
345 As the acl(2) interface is identical for ZFS and for NFS, this module,
346 vfs_zfsacl, can not only be used for ZFS, but also for sharing NFSv4
349 But while "traditional" POSIX DRAFT ACLs (using acl(2) with SETACL
350 / GETACL / GETACLCNT) fail for ZFS, the Solaris NFS client
351 implemets a compatibility wrapper, which will make calls to
352 traditional ACL calls though vfs_solarisacl succeed. As the
353 compatibility wrapper's implementation is (by design) incomplete,
354 we want to make sure that it is never being called.
356 As long as Samba does not support an exiplicit method for a module
357 to define conflicting vfs methods, we should override all conflicting
360 For this to work, we need to make sure that this module is initialised
361 *after* vfs_solarisacl
363 Function declarations taken from vfs_solarisacl
366 static SMB_ACL_T zfsacl_fail__sys_acl_get_file(vfs_handle_struct *handle,
367 const struct smb_filename *smb_fname,
371 return (SMB_ACL_T)NULL;
374 static SMB_ACL_T zfsacl_fail__sys_acl_get_fd(vfs_handle_struct *handle,
378 return (SMB_ACL_T)NULL;
381 static int zfsacl_fail__sys_acl_set_file(vfs_handle_struct *handle,
382 const struct smb_filename *smb_fname,
389 static int zfsacl_fail__sys_acl_set_fd(vfs_handle_struct *handle,
396 static int zfsacl_fail__sys_acl_delete_def_file(vfs_handle_struct *handle,
397 const struct smb_filename *smb_fname)
402 static int zfsacl_fail__sys_acl_blob_get_file(vfs_handle_struct *handle,
403 const struct smb_filename *smb_fname,
405 char **blob_description,
411 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)
416 static int zfsacl_connect(struct vfs_handle_struct *handle,
417 const char *service, const char *user)
419 struct zfsacl_config_data *config = NULL;
422 ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
427 config = talloc_zero(handle->conn, struct zfsacl_config_data);
429 DBG_ERR("talloc_zero() failed\n");
434 config->zfsacl_denymissingspecial = lp_parm_bool(SNUM(handle->conn),
435 "zfsacl", "denymissingspecial", false);
437 ret = smbacl4_get_vfs_params(handle->conn, &config->nfs4_params);
443 SMB_VFS_HANDLE_SET_DATA(handle, config,
444 NULL, struct zfsacl_config_data,
450 /* VFS operations structure */
452 static struct vfs_fn_pointers zfsacl_fns = {
453 .connect_fn = zfsacl_connect,
454 .sys_acl_get_file_fn = zfsacl_fail__sys_acl_get_file,
455 .sys_acl_get_fd_fn = zfsacl_fail__sys_acl_get_fd,
456 .sys_acl_blob_get_file_fn = zfsacl_fail__sys_acl_blob_get_file,
457 .sys_acl_blob_get_fd_fn = zfsacl_fail__sys_acl_blob_get_fd,
458 .sys_acl_set_file_fn = zfsacl_fail__sys_acl_set_file,
459 .sys_acl_set_fd_fn = zfsacl_fail__sys_acl_set_fd,
460 .sys_acl_delete_def_file_fn = zfsacl_fail__sys_acl_delete_def_file,
461 .fget_nt_acl_fn = zfsacl_fget_nt_acl,
462 .get_nt_acl_fn = zfsacl_get_nt_acl,
463 .fset_nt_acl_fn = zfsacl_fset_nt_acl,
467 NTSTATUS vfs_zfsacl_init(TALLOC_CTX *ctx)
469 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "zfsacl",