s3:modules: Use #ifdef instead of #if for config.h definitions
[Samba.git] / source3 / modules / vfs_zfsacl.c
blob2c5d82ae207d01b1337c6fcbb8a5002ab9f53a91
1 /*
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
8 * issues.
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/>.
25 #include "includes.h"
26 #include "system/filesys.h"
27 #include "smbd/smbd.h"
28 #include "nfs4_acls.h"
30 #ifdef HAVE_FREEBSD_SUNACL_H
31 #include "sunacl.h"
32 #endif
34 #undef DBGC_CLASS
35 #define DBGC_CLASS DBGC_VFS
37 #define ZFSACL_MODULE_NAME "zfsacl"
39 /* zfs_get_nt_acl()
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,
44 TALLOC_CTX *mem_ctx,
45 const struct smb_filename *smb_fname,
46 struct SMB4ACL_T **ppacl)
48 int naces, i;
49 ace_t *acebuf;
50 struct SMB4ACL_T *pacl;
51 SMB_STRUCT_STAT sbuf;
52 const SMB_STRUCT_STAT *psbuf = NULL;
53 int ret;
54 bool is_dir;
56 if (VALID_STAT(smb_fname->st)) {
57 psbuf = &smb_fname->st;
60 if (psbuf == NULL) {
61 ret = vfs_stat_smb_basename(conn, smb_fname, &sbuf);
62 if (ret != 0) {
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);
67 psbuf = &sbuf;
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) {
73 if(errno == ENOSYS) {
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));
77 } else {
78 DEBUG(9, ("acl(ACE_GETACLCNT, %s): %s ", smb_fname->base_name,
79 strerror(errno)));
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);
86 if(acebuf == NULL) {
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,
92 strerror(errno)));
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
110 * #8442.
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;
129 } else {
130 aceprop.flags = 0;
132 if(smb_add_ace4(pacl, &aceprop) == NULL)
133 return NT_STATUS_NO_MEMORY;
136 *ppacl = pacl;
137 return NT_STATUS_OK;
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;
145 ace_t *acebuf;
146 struct SMB4ACE_T *smbace;
147 TALLOC_CTX *mem_ctx;
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);
153 if(acebuf == NULL) {
154 errno = ENOMEM;
155 return False;
157 /* handle all aces */
158 for(smbace = smb_first_ace4(smbacl), i = 0;
159 smbace!=NULL;
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.
167 See bug #7909. */
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;
174 break;
175 case SMB_ACE4_WHO_OWNER:
176 acebuf[i].a_flags |= ACE_OWNER;
177 break;
178 case SMB_ACE4_WHO_GROUP:
179 acebuf[i].a_flags |= ACE_GROUP|ACE_IDENTIFIER_GROUP;
180 break;
181 default:
182 DEBUG(8, ("unsupported special_id %d\n", \
183 aceprop->who.special_id));
184 continue; /* don't add it !!! */
186 have_special_id = true;
190 if (!have_special_id
191 && lp_parm_bool(fsp->conn->params->service, "zfsacl",
192 "denymissingspecial", false)) {
193 errno = EACCES;
194 return false;
197 SMB_ASSERT(i == naces);
199 /* store acl */
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)));
205 } else {
206 DEBUG(9, ("acl(ACE_SETACL, %s): %s ", fsp_str_dbg(fsp),
207 strerror(errno)));
209 return 0;
212 return True;
215 /* zfs_set_nt_acl()
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,
224 zfs_process_smbacl);
227 static NTSTATUS zfsacl_fget_nt_acl(struct vfs_handle_struct *handle,
228 struct files_struct *fsp,
229 uint32_t security_info,
230 TALLOC_CTX *mem_ctx,
231 struct security_descriptor **ppdesc)
233 struct SMB4ACL_T *pacl;
234 NTSTATUS status;
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)) {
240 TALLOC_FREE(frame);
241 if (!NT_STATUS_EQUAL(status, NT_STATUS_NOT_SUPPORTED)) {
242 return status;
245 status = make_default_filesystem_acl(mem_ctx,
246 DEFAULT_ACL_POSIX,
247 fsp->fsp_name->base_name,
248 &fsp->fsp_name->st,
249 ppdesc);
250 if (!NT_STATUS_IS_OK(status)) {
251 return status;
253 (*ppdesc)->type |= SEC_DESC_DACL_PROTECTED;
254 return NT_STATUS_OK;
257 status = smb_fget_nt_acl_nfs4(fsp, NULL, security_info, mem_ctx,
258 ppdesc, pacl);
259 TALLOC_FREE(frame);
260 return status;
263 static NTSTATUS zfsacl_get_nt_acl(struct vfs_handle_struct *handle,
264 const struct smb_filename *smb_fname,
265 uint32_t security_info,
266 TALLOC_CTX *mem_ctx,
267 struct security_descriptor **ppdesc)
269 struct SMB4ACL_T *pacl;
270 NTSTATUS status;
271 TALLOC_CTX *frame = talloc_stackframe();
273 status = zfs_get_nt_acl_common(handle->conn, frame, smb_fname, &pacl);
274 if (!NT_STATUS_IS_OK(status)) {
275 TALLOC_FREE(frame);
276 if (!NT_STATUS_EQUAL(status, NT_STATUS_NOT_SUPPORTED)) {
277 return status;
280 if (!VALID_STAT(smb_fname->st)) {
281 DBG_ERR("No stat info for [%s]\n",
282 smb_fname_str_dbg(smb_fname));
283 return NT_STATUS_INTERNAL_ERROR;
286 status = make_default_filesystem_acl(mem_ctx,
287 DEFAULT_ACL_POSIX,
288 smb_fname->base_name,
289 &smb_fname->st,
290 ppdesc);
291 if (!NT_STATUS_IS_OK(status)) {
292 return status;
294 (*ppdesc)->type |= SEC_DESC_DACL_PROTECTED;
295 return NT_STATUS_OK;
298 status = smb_get_nt_acl_nfs4(handle->conn,
299 smb_fname,
300 NULL,
301 security_info,
302 mem_ctx,
303 ppdesc,
304 pacl);
305 TALLOC_FREE(frame);
306 return status;
309 static NTSTATUS zfsacl_fset_nt_acl(vfs_handle_struct *handle,
310 files_struct *fsp,
311 uint32_t security_info_sent,
312 const struct security_descriptor *psd)
314 return zfs_set_nt_acl(handle, fsp, security_info_sent, psd);
317 /* nils.goroll@hamburg.de 2008-06-16 :
319 See also
320 - https://bugzilla.samba.org/show_bug.cgi?id=5446
321 - http://bugs.opensolaris.org/view_bug.do?bug_id=6688240
323 Solaris supports NFSv4 and ZFS ACLs through a common system call, acl(2)
324 with ACE_SETACL / ACE_GETACL / ACE_GETACLCNT, which is being wrapped for
325 use by samba in this module.
327 As the acl(2) interface is identical for ZFS and for NFS, this module,
328 vfs_zfsacl, can not only be used for ZFS, but also for sharing NFSv4
329 mounts on Solaris.
331 But while "traditional" POSIX DRAFT ACLs (using acl(2) with SETACL
332 / GETACL / GETACLCNT) fail for ZFS, the Solaris NFS client
333 implemets a compatibility wrapper, which will make calls to
334 traditional ACL calls though vfs_solarisacl succeed. As the
335 compatibility wrapper's implementation is (by design) incomplete,
336 we want to make sure that it is never being called.
338 As long as Samba does not support an exiplicit method for a module
339 to define conflicting vfs methods, we should override all conflicting
340 methods here.
342 For this to work, we need to make sure that this module is initialised
343 *after* vfs_solarisacl
345 Function declarations taken from vfs_solarisacl
348 static SMB_ACL_T zfsacl_fail__sys_acl_get_file(vfs_handle_struct *handle,
349 const struct smb_filename *smb_fname,
350 SMB_ACL_TYPE_T type,
351 TALLOC_CTX *mem_ctx)
353 return (SMB_ACL_T)NULL;
356 static SMB_ACL_T zfsacl_fail__sys_acl_get_fd(vfs_handle_struct *handle,
357 files_struct *fsp,
358 TALLOC_CTX *mem_ctx)
360 return (SMB_ACL_T)NULL;
363 static int zfsacl_fail__sys_acl_set_file(vfs_handle_struct *handle,
364 const struct smb_filename *smb_fname,
365 SMB_ACL_TYPE_T type,
366 SMB_ACL_T theacl)
368 return -1;
371 static int zfsacl_fail__sys_acl_set_fd(vfs_handle_struct *handle,
372 files_struct *fsp,
373 SMB_ACL_T theacl)
375 return -1;
378 static int zfsacl_fail__sys_acl_delete_def_file(vfs_handle_struct *handle,
379 const struct smb_filename *smb_fname)
381 return -1;
384 static int zfsacl_fail__sys_acl_blob_get_file(vfs_handle_struct *handle,
385 const struct smb_filename *smb_fname,
386 TALLOC_CTX *mem_ctx,
387 char **blob_description,
388 DATA_BLOB *blob)
390 return -1;
393 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)
395 return -1;
398 /* VFS operations structure */
400 static struct vfs_fn_pointers zfsacl_fns = {
401 .sys_acl_get_file_fn = zfsacl_fail__sys_acl_get_file,
402 .sys_acl_get_fd_fn = zfsacl_fail__sys_acl_get_fd,
403 .sys_acl_blob_get_file_fn = zfsacl_fail__sys_acl_blob_get_file,
404 .sys_acl_blob_get_fd_fn = zfsacl_fail__sys_acl_blob_get_fd,
405 .sys_acl_set_file_fn = zfsacl_fail__sys_acl_set_file,
406 .sys_acl_set_fd_fn = zfsacl_fail__sys_acl_set_fd,
407 .sys_acl_delete_def_file_fn = zfsacl_fail__sys_acl_delete_def_file,
408 .fget_nt_acl_fn = zfsacl_fget_nt_acl,
409 .get_nt_acl_fn = zfsacl_get_nt_acl,
410 .fset_nt_acl_fn = zfsacl_fset_nt_acl,
413 static_decl_vfs;
414 NTSTATUS vfs_zfsacl_init(TALLOC_CTX *ctx)
416 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "zfsacl",
417 &zfsacl_fns);