VERSION: Re-enable git snapshots.
[Samba.git] / source3 / modules / vfs_zfsacl.c
blob1b59c24157dea956328d0805f15a147d9b1eb0ee
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 #if 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(const char *name,
44 uint32 security_info,
45 SMB4ACL_T **ppacl)
47 int naces, i;
48 ace_t *acebuf;
49 SMB4ACL_T *pacl;
50 TALLOC_CTX *mem_ctx;
52 /* read the number of file aces */
53 if((naces = acl(name, ACE_GETACLCNT, 0, NULL)) == -1) {
54 if(errno == ENOSYS) {
55 DEBUG(9, ("acl(ACE_GETACLCNT, %s): Operation is not "
56 "supported on the filesystem where the file "
57 "reside\n", name));
58 } else {
59 DEBUG(9, ("acl(ACE_GETACLCNT, %s): %s ", name,
60 strerror(errno)));
62 return map_nt_error_from_unix(errno);
64 /* allocate the field of ZFS aces */
65 mem_ctx = talloc_tos();
66 acebuf = (ace_t *) talloc_size(mem_ctx, sizeof(ace_t)*naces);
67 if(acebuf == NULL) {
68 return NT_STATUS_NO_MEMORY;
70 /* read the aces into the field */
71 if(acl(name, ACE_GETACL, naces, acebuf) < 0) {
72 DEBUG(9, ("acl(ACE_GETACL, %s): %s ", name,
73 strerror(errno)));
74 return map_nt_error_from_unix(errno);
76 /* create SMB4ACL data */
77 if((pacl = smb_create_smb4acl()) == NULL) {
78 return NT_STATUS_NO_MEMORY;
80 for(i=0; i<naces; i++) {
81 SMB_ACE4PROP_T aceprop;
83 aceprop.aceType = (uint32) acebuf[i].a_type;
84 aceprop.aceFlags = (uint32) acebuf[i].a_flags;
85 aceprop.aceMask = (uint32) acebuf[i].a_access_mask;
86 aceprop.who.id = (uint32) acebuf[i].a_who;
88 if(aceprop.aceFlags & ACE_OWNER) {
89 aceprop.flags = SMB_ACE4_ID_SPECIAL;
90 aceprop.who.special_id = SMB_ACE4_WHO_OWNER;
91 } else if(aceprop.aceFlags & ACE_GROUP) {
92 aceprop.flags = SMB_ACE4_ID_SPECIAL;
93 aceprop.who.special_id = SMB_ACE4_WHO_GROUP;
94 } else if(aceprop.aceFlags & ACE_EVERYONE) {
95 aceprop.flags = SMB_ACE4_ID_SPECIAL;
96 aceprop.who.special_id = SMB_ACE4_WHO_EVERYONE;
97 } else {
98 aceprop.flags = 0;
100 if(smb_add_ace4(pacl, &aceprop) == NULL)
101 return NT_STATUS_NO_MEMORY;
104 *ppacl = pacl;
105 return NT_STATUS_OK;
108 /* call-back function processing the NT acl -> ZFS acl using NFSv4 conv. */
109 static bool zfs_process_smbacl(files_struct *fsp, SMB4ACL_T *smbacl)
111 int naces = smb_get_naces(smbacl), i;
112 ace_t *acebuf;
113 SMB4ACE_T *smbace;
114 TALLOC_CTX *mem_ctx;
115 bool have_special_id = false;
117 /* allocate the field of ZFS aces */
118 mem_ctx = talloc_tos();
119 acebuf = (ace_t *) talloc_size(mem_ctx, sizeof(ace_t)*naces);
120 if(acebuf == NULL) {
121 errno = ENOMEM;
122 return False;
124 /* handle all aces */
125 for(smbace = smb_first_ace4(smbacl), i = 0;
126 smbace!=NULL;
127 smbace = smb_next_ace4(smbace), i++) {
128 SMB_ACE4PROP_T *aceprop = smb_get_ace4(smbace);
130 acebuf[i].a_type = aceprop->aceType;
131 acebuf[i].a_flags = aceprop->aceFlags;
132 acebuf[i].a_access_mask = aceprop->aceMask;
133 /* SYNC on acls is a no-op on ZFS.
134 See bug #7909. */
135 acebuf[i].a_access_mask &= ~SMB_ACE4_SYNCHRONIZE;
136 acebuf[i].a_who = aceprop->who.id;
137 if(aceprop->flags & SMB_ACE4_ID_SPECIAL) {
138 switch(aceprop->who.special_id) {
139 case SMB_ACE4_WHO_EVERYONE:
140 acebuf[i].a_flags |= ACE_EVERYONE;
141 break;
142 case SMB_ACE4_WHO_OWNER:
143 acebuf[i].a_flags |= ACE_OWNER;
144 break;
145 case SMB_ACE4_WHO_GROUP:
146 acebuf[i].a_flags |= ACE_GROUP;
147 break;
148 default:
149 DEBUG(8, ("unsupported special_id %d\n", \
150 aceprop->who.special_id));
151 continue; /* don't add it !!! */
153 have_special_id = true;
157 if (!have_special_id
158 && lp_parm_bool(fsp->conn->params->service, "zfsacl",
159 "denymissingspecial", false)) {
160 errno = EACCES;
161 return false;
164 SMB_ASSERT(i == naces);
166 /* store acl */
167 if(acl(fsp->fsp_name->base_name, ACE_SETACL, naces, acebuf)) {
168 if(errno == ENOSYS) {
169 DEBUG(9, ("acl(ACE_SETACL, %s): Operation is not "
170 "supported on the filesystem where the file "
171 "reside", fsp_str_dbg(fsp)));
172 } else {
173 DEBUG(9, ("acl(ACE_SETACL, %s): %s ", fsp_str_dbg(fsp),
174 strerror(errno)));
176 return 0;
179 return True;
182 /* zfs_set_nt_acl()
183 * set the local file's acls obtaining it in NT form
184 * using the NFSv4 format conversion
186 static NTSTATUS zfs_set_nt_acl(vfs_handle_struct *handle, files_struct *fsp,
187 uint32 security_info_sent,
188 const struct security_descriptor *psd)
190 return smb_set_nt_acl_nfs4(fsp, security_info_sent, psd,
191 zfs_process_smbacl);
194 static NTSTATUS zfsacl_fget_nt_acl(struct vfs_handle_struct *handle,
195 struct files_struct *fsp,
196 uint32 security_info,
197 TALLOC_CTX *mem_ctx,
198 struct security_descriptor **ppdesc)
200 SMB4ACL_T *pacl;
201 NTSTATUS status;
203 status = zfs_get_nt_acl_common(fsp->fsp_name->base_name,
204 security_info,
205 &pacl);
206 if (!NT_STATUS_IS_OK(status)) {
207 return status;
210 return smb_fget_nt_acl_nfs4(fsp, security_info, mem_ctx, ppdesc, pacl);
213 static NTSTATUS zfsacl_get_nt_acl(struct vfs_handle_struct *handle,
214 const char *name, uint32 security_info,
215 TALLOC_CTX *mem_ctx,
216 struct security_descriptor **ppdesc)
218 SMB4ACL_T *pacl;
219 NTSTATUS status;
221 status = zfs_get_nt_acl_common(name, security_info, &pacl);
222 if (!NT_STATUS_IS_OK(status)) {
223 return status;
226 return smb_get_nt_acl_nfs4(handle->conn, name, security_info,
227 mem_ctx, ppdesc,
228 pacl);
231 static NTSTATUS zfsacl_fset_nt_acl(vfs_handle_struct *handle,
232 files_struct *fsp,
233 uint32 security_info_sent,
234 const struct security_descriptor *psd)
236 return zfs_set_nt_acl(handle, fsp, security_info_sent, psd);
239 /* nils.goroll@hamburg.de 2008-06-16 :
241 See also
242 - https://bugzilla.samba.org/show_bug.cgi?id=5446
243 - http://bugs.opensolaris.org/view_bug.do?bug_id=6688240
245 Solaris supports NFSv4 and ZFS ACLs through a common system call, acl(2)
246 with ACE_SETACL / ACE_GETACL / ACE_GETACLCNT, which is being wrapped for
247 use by samba in this module.
249 As the acl(2) interface is identical for ZFS and for NFS, this module,
250 vfs_zfsacl, can not only be used for ZFS, but also for sharing NFSv4
251 mounts on Solaris.
253 But while "traditional" POSIX DRAFT ACLs (using acl(2) with SETACL
254 / GETACL / GETACLCNT) fail for ZFS, the Solaris NFS client
255 implemets a compatibility wrapper, which will make calls to
256 traditional ACL calls though vfs_solarisacl succeed. As the
257 compatibility wrapper's implementation is (by design) incomplete,
258 we want to make sure that it is never being called.
260 As long as Samba does not support an exiplicit method for a module
261 to define conflicting vfs methods, we should override all conflicting
262 methods here.
264 For this to work, we need to make sure that this module is initialised
265 *after* vfs_solarisacl
267 Function declarations taken from vfs_solarisacl
270 static SMB_ACL_T zfsacl_fail__sys_acl_get_file(vfs_handle_struct *handle,
271 const char *path_p,
272 SMB_ACL_TYPE_T type)
274 return (SMB_ACL_T)NULL;
277 static SMB_ACL_T zfsacl_fail__sys_acl_get_fd(vfs_handle_struct *handle,
278 files_struct *fsp)
280 return (SMB_ACL_T)NULL;
283 static int zfsacl_fail__sys_acl_set_file(vfs_handle_struct *handle,
284 const char *name,
285 SMB_ACL_TYPE_T type,
286 SMB_ACL_T theacl)
288 return -1;
291 static int zfsacl_fail__sys_acl_set_fd(vfs_handle_struct *handle,
292 files_struct *fsp,
293 SMB_ACL_T theacl)
295 return -1;
298 static int zfsacl_fail__sys_acl_delete_def_file(vfs_handle_struct *handle,
299 const char *path)
301 return -1;
304 /* VFS operations structure */
306 static struct vfs_fn_pointers zfsacl_fns = {
307 .sys_acl_get_file_fn = zfsacl_fail__sys_acl_get_file,
308 .sys_acl_get_fd_fn = zfsacl_fail__sys_acl_get_fd,
309 .sys_acl_set_file_fn = zfsacl_fail__sys_acl_set_file,
310 .sys_acl_set_fd_fn = zfsacl_fail__sys_acl_set_fd,
311 .sys_acl_delete_def_file_fn = zfsacl_fail__sys_acl_delete_def_file,
312 .fget_nt_acl_fn = zfsacl_fget_nt_acl,
313 .get_nt_acl_fn = zfsacl_get_nt_acl,
314 .fset_nt_acl_fn = zfsacl_fset_nt_acl,
317 NTSTATUS vfs_zfsacl_init(void);
318 NTSTATUS vfs_zfsacl_init(void)
320 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "zfsacl",
321 &zfsacl_fns);