2 Unix SMB/CIFS implementation.
3 Wrap VxFS calls in vfs functions.
4 This module is for ACL and XATTR handling.
6 Copyright (C) Symantec Corporation <www.symantec.com> 2014
7 Copyright (C) Veritas Technologies LLC <www.veritas.com> 2016
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>.
24 #include "smbd/smbd.h"
25 #include "librpc/gen_ndr/ndr_xattr.h"
26 #include "../libcli/security/security.h"
27 #include "../librpc/gen_ndr/ndr_security.h"
28 #include "system/filesys.h"
34 #define DBGC_CLASS DBGC_VFS
36 #define MODULE_NAME "vxfs"
39 * WARNING !! WARNING !!
41 * DO NOT CHANGE THIS FROM "system." space to
42 * "user." space unless you are shipping a product
43 * that RESTRICTS access to extended attributes
44 * to smbd-only. "system." space is restricted
45 * to root access only, "user." space is available
48 * If this is changed to "user." and access
49 * to extended attributes is available via
50 * local processes or other remote file system
51 * (e.g. NFS) then the security of the system
52 * WILL BE COMPROMISED. i.e. non-root users
53 * WILL be able to overwrite Samba ACLs on
56 * If you need to modify this define, do
57 * so using CFLAGS on your build command
59 * e.g. CFLAGS=-DXATTR_USER_NTACL="user.NTACL"
61 * Added by: <jra@samba.org> 17 Sept. 2014.
65 #ifndef XATTR_USER_NTACL
66 #define XATTR_USER_NTACL "system.NTACL"
70 #define VXFS_ACL_UNDEFINED_TYPE 0
71 #define VXFS_ACL_USER_OBJ 1
72 #define VXFS_ACL_GROUP_OBJ 2
73 #define VXFS_ACL_USER 3
74 #define VXFS_ACL_GROUP 4
75 #define VXFS_ACL_OTHER 5
76 #define VXFS_ACL_MASK 6
81 * This will compare two ace entries for sorting
82 * each entry contains: type, perms and id
83 * Sort by type first, if type is same sort by id.
85 static int vxfs_ace_cmp(const void *ace1, const void *ace2)
88 uint16_t type_a1, type_a2;
89 uint32_t id_a1, id_a2;
91 /* Type must be compared first */
92 type_a1 = SVAL(ace1, 0);
93 type_a2 = SVAL(ace2, 0);
95 ret = (type_a1 - type_a2);
97 /* Compare ID under type */
98 /* skip perm thus take offset as 4*/
99 id_a1 = IVAL(ace1, 4);
100 id_a2 = IVAL(ace2, 4);
107 static void vxfs_print_ace_buf(char *buf, int count) {
113 DEBUG(10, ("vfs_vxfs: Printing aces:\n"));
114 for (i = 0; i < count; i++) {
115 type = SVAL(buf, offset);
117 perm = SVAL(buf, offset);
119 id = IVAL(buf, offset);
122 DEBUG(10, ("vfs_vxfs: type = %u, perm = %u, id = %u\n",
123 (unsigned int)type, (unsigned int)perm,
129 * Sort aces so that comparing 2 ACLs will be straight forward.
130 * This function will fill buffer as follows:
132 * 1. ace->a_type will be filled as first 2 bytes in buf.
133 * 2. ace->a_perm will be filled as next 2 bytes.
134 * 3. ace->xid will be filled as next 4 bytes.
135 * Thus each ace entry in buf is equal to 8 bytes.
136 * Also a_type is mapped to VXFS_ACL_* so that ordering aces
139 static char * vxfs_sort_acl(SMB_ACL_T theacl, TALLOC_CTX *mem_ctx,
143 struct smb_acl_entry *smb_ace;
150 count = theacl->count;
152 buf = talloc_zero_size(mem_ctx, count * 8);
157 smb_ace = theacl->acl;
159 for (i = 0; i < count; i++) {
161 /* Map type to SMB_ACL_* to VXFS_ACL_* */
162 switch(smb_ace->a_type) {
164 type = VXFS_ACL_USER;
166 case SMB_ACL_USER_OBJ:
167 type = VXFS_ACL_USER_OBJ;
170 type = VXFS_ACL_GROUP;
172 case SMB_ACL_GROUP_OBJ:
173 type = VXFS_ACL_GROUP_OBJ;
176 type = VXFS_ACL_OTHER;
179 type = VXFS_ACL_MASK;
190 * We get owner uid and owner group gid in o_uid and o_gid
191 * Put these ids instead of -1
193 switch(smb_ace->a_type) {
195 id = smb_ace->info.user.uid;
198 id = smb_ace->info.group.gid;
200 case SMB_ACL_USER_OBJ:
203 case SMB_ACL_GROUP_OBJ:
217 perm = smb_ace->a_perm & 0xff;
219 /* TYPE is the first 2 bytes of an entry */
220 SSVAL(buf, offset, type);
223 /* PERM is the next 2 bytes of an entry */
224 SSVAL(buf, offset, perm);
227 /* ID is the last 4 bytes of an entry */
228 SIVAL(buf, offset, id);
234 qsort(buf, count, 8, vxfs_ace_cmp);
236 DEBUG(10, ("vfs_vxfs: Print sorted aces:\n"));
237 vxfs_print_ace_buf(buf, count);
242 /* This function gets e_buf as an arg which is sorted and created out of
243 * existing ACL. This function will compact this e_buf to c_buf where USER
244 * and GROUP aces matching with USER_OBJ and GROUP_OBJ will be merged
246 * This is similar to what posix_acls.c does. This will make sure existing
247 * acls are converted much similar to what posix_acls calculates.
250 static char * vxfs_compact_buf(char *e_buf, int *new_count, int count,
253 int i, e_offset = 0, c_offset = 0;
254 uint16_t type, perm, o_perm;
255 uint32_t id, owner_id, group_id;
263 c_buf = talloc_zero_size(mem_ctx, count * 8);
268 /*Copy first two enries from e_buf to c_buf
269 *These are USER_OBJ and GROUP_OBJ
272 memcpy(c_buf, e_buf, 16);
276 owner_id = IVAL(e_buf, 4);
277 group_id = IVAL(e_buf, 12);
279 c_offset = e_offset = 16;
281 /* Start comparing other entries */
282 for (i = 2; i < count; i++) {
284 type = SVAL(e_buf, e_offset);
286 perm = SVAL(e_buf, e_offset);
288 id = IVAL(e_buf, e_offset);
293 if (id == owner_id) {
294 o_perm = SVAL(c_buf, 2);
296 SSVAL(c_buf, 2, o_perm);
297 DEBUG(10, ("vfs_vxfs: merging with owner"
300 "e_id = %u\n", (unsigned int)type,
307 if (id == group_id) {
308 o_perm = SVAL(c_buf, 10);
310 SSVAL(c_buf, 10, o_perm);
311 DEBUG(10, ("vfs_vxfs: merging with owner group"
314 "e_id = %u\n", (unsigned int)type,
322 SSVAL(c_buf, c_offset, type);
325 SSVAL(c_buf, c_offset, perm);
328 SIVAL(c_buf, c_offset, id);
333 DEBUG(10, ("vfs_vxfs: new_count is %d\n", *new_count));
337 /* Actually compare New ACL and existing ACL buf */
338 static bool vxfs_compare_acls(char *e_buf, char *n_buf, int n_count,
341 uint16_t e_type, n_type, e_perm, n_perm;
345 if (!e_buf && !n_buf) {
346 DEBUG(10, ("vfs_vxfs: Empty buffers!\n"));
350 if ((e_count < 2) || (n_count < 2)) {
353 /*Get type from last entry from both buffers.
354 * It may or may not be ACL_MASK
356 n_type = SVAL(n_buf, offset + (8 * (n_count-1)));
357 e_type = SVAL(e_buf, offset + (8 * (e_count-1)));
359 /* Check for ACL_MASK entry properly. Handle all 4 cases*/
361 /* If ACL_MASK entry is present in any of the buffers,
362 * it will be always the last one. Calculate count to compare
363 * based on if ACL_MASK is present on new and existing ACL
365 if ((n_type != VXFS_ACL_MASK) && (e_type == VXFS_ACL_MASK)){
366 DEBUG(10, ("vfs_vxfs: New ACL does not have mask entry,"
367 "reduce count by 1 and compare\n"));
368 e_count = e_count -1;
370 if ((n_type == VXFS_ACL_MASK) && (e_type != VXFS_ACL_MASK)){
371 DEBUG(10, ("vfs_vxfs: new ACL to be set contains mask"
372 "existing ACL does not have mask entry\n"
373 "Need to set New ACL\n"));
377 if (memcmp(e_buf, n_buf, (e_count * 8)) != 0) {
378 DEBUG(10, ("vfs_vxfs: Compare with memcmp,"
379 "buffers not same!\n"));
386 /* In VxFS, POSIX ACLs are pointed by separate inode for each file/dir.
387 * However, files/dir share same POSIX ACL inode if ACLs are inherited
389 * To retain this behaviour, below function avoids ACL set call if
390 * underlying ACLs are already same and thus saves creating extra inode.
392 * This function will execute following steps:
393 * 1. Get existing ACL
394 * 2. Sort New ACL and existing ACL into buffers
395 * 3. Compact existing ACL buf
396 * 4. Finally compare New ACL buf and Compact buf
397 * 5. If same, return true
398 * 6. Else need to set New ACL
401 static bool vxfs_compare(connection_struct *conn,
402 const struct smb_filename *smb_fname,
404 SMB_ACL_TYPE_T the_acl_type)
406 char *name = smb_fname->base_name;
407 SMB_ACL_T existing_acl = NULL;
410 TALLOC_CTX *mem_ctx = talloc_tos();
411 char *existing_buf = NULL, *new_buf = NULL, *compact_buf = NULL;
412 struct smb_filename *smb_fname = NULL;
415 DEBUG(10, ("vfs_vxfs: Getting existing ACL for %s\n", name));
417 existing_acl = SMB_VFS_SYS_ACL_GET_FILE(conn, smb_fname, the_acl_type,
419 if (existing_acl == NULL) {
420 DEBUG(10, ("vfs_vxfs: Failed to get ACL\n"));
424 DEBUG(10, ("vfs_vxfs: Existing ACL count=%d\n", existing_acl->count));
425 DEBUG(10, ("vfs_vxfs: New ACL count=%d\n", the_acl->count));
427 if (existing_acl->count == 0) {
428 DEBUG(10, ("vfs_vxfs: ACL count is 0, Need to set\n"));
432 status = SMB_VFS_STAT(conn, smb_fname);
434 DEBUG(10, ("vfs_vxfs: stat failed!\n"));
438 DEBUG(10, ("vfs_vxfs: Sorting existing ACL\n"));
439 existing_buf = vxfs_sort_acl(existing_acl, mem_ctx,
440 smb_fname->st.st_ex_uid,
441 smb_fname->st.st_ex_gid);
445 DEBUG(10, ("vfs_vxfs: Sorting new ACL\n"));
446 new_buf = vxfs_sort_acl(the_acl, mem_ctx, smb_fname->st.st_ex_uid,
447 smb_fname->st.st_ex_gid);
452 DEBUG(10, ("vfs_vxfs: Compact existing buf\n"));
453 compact_buf = vxfs_compact_buf(existing_buf, &count,
460 vxfs_print_ace_buf(compact_buf, count);
462 /* COmpare ACLs only if count is same or mismatch by 1 */
463 if ((count == the_acl->count) ||
464 (count == the_acl->count + 1) ||
465 (count+1 == the_acl->count)) {
467 if (vxfs_compare_acls(compact_buf, new_buf, the_acl->count,
469 DEBUG(10, ("vfs_vxfs: ACLs matched. Not setting.\n"));
473 DEBUG(10, ("vfs_vxfs: ACLs NOT matched. Setting\n"));
475 DEBUG(10, ("vfs_vxfs: ACLs count does not match. Setting\n"));
480 TALLOC_FREE(existing_acl);
481 TALLOC_FREE(existing_buf);
482 TALLOC_FREE(compact_buf);
483 TALLOC_FREE(new_buf);
488 static int vxfs_sys_acl_set_fd(vfs_handle_struct *handle,
489 struct files_struct *fsp,
494 if (vxfs_compare(fsp->conn, fsp->fsp_name, theacl,
499 return SMB_VFS_NEXT_SYS_ACL_SET_FD(handle, fsp, type, theacl);
502 static int vxfs_set_xattr(struct vfs_handle_struct *handle,
503 const struct smb_filename *smb_fname_in,
509 struct smb_filename *smb_fname = NULL;
514 DEBUG(10, ("In vxfs_set_xattr\n"));
516 smb_fname = cp_smb_filename_nostream(talloc_tos(), smb_fname_in);
517 if (smb_fname == NULL) {
522 if (SMB_VFS_NEXT_STAT(handle, smb_fname) != 0) {
523 TALLOC_FREE(smb_fname);
527 is_dir = S_ISDIR(smb_fname->st.st_ex_mode);
529 ret = vxfs_setxattr_path(smb_fname_in->base_name, name, value, size,
532 ((ret == -1) && (errno != ENOTSUP) && (errno != ENOSYS))) {
534 * Now remve old style xattr if it exists
536 SMB_VFS_NEXT_REMOVEXATTR(handle, smb_fname, name);
538 * Do not bother about return value
546 DEBUG(10, ("Fallback to xattr\n"));
547 if (strcmp(name, XATTR_NTACL_NAME) == 0) {
548 ret = SMB_VFS_NEXT_SETXATTR(handle, smb_fname,
558 /* Clients can't set XATTR_USER_NTACL directly. */
559 if (strcasecmp(name, XATTR_USER_NTACL) == 0) {
560 saved_errno = EACCES;
565 ret = SMB_VFS_NEXT_SETXATTR(handle, smb_fname,
566 name, value, size, flags);
573 TALLOC_FREE(smb_fname);
574 if (saved_errno != 0) {
580 static int vxfs_fset_xattr(struct vfs_handle_struct *handle,
581 struct files_struct *fsp, const char *name,
582 const void *value, size_t size, int flags){
585 DEBUG(10, ("In vxfs_fset_xattr\n"));
587 ret = vxfs_setxattr_fd(fsp_get_io_fd(fsp), name, value, size, flags);
589 ((ret == -1) && (errno != ENOTSUP) && (errno != ENOSYS))) {
590 SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp, name);
594 DEBUG(10, ("Fallback to xattr"));
595 if (strcmp(name, XATTR_NTACL_NAME) == 0) {
596 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, XATTR_USER_NTACL,
600 /* Clients can't set XATTR_USER_NTACL directly. */
601 if (strcasecmp(name, XATTR_USER_NTACL) == 0) {
606 return SMB_VFS_NEXT_FSETXATTR(handle, fsp, name, value, size, flags);
609 static ssize_t vxfs_get_xattr(struct vfs_handle_struct *handle,
610 const struct smb_filename *smb_fname,
616 DEBUG(10, ("In vxfs_get_xattr\n"));
617 ret = vxfs_getxattr_path(smb_fname->base_name, name, value, size);
618 if ((ret != -1) || ((errno != ENOTSUP) &&
619 (errno != ENOSYS) && (errno != ENODATA))) {
623 DEBUG(10, ("Fallback to xattr\n"));
624 if (strcmp(name, XATTR_NTACL_NAME) == 0) {
625 return SMB_VFS_NEXT_GETXATTR(handle, smb_fname,
626 XATTR_USER_NTACL, value, size);
629 /* Clients can't see XATTR_USER_NTACL directly. */
630 if (strcasecmp(name, XATTR_USER_NTACL) == 0) {
635 return SMB_VFS_NEXT_GETXATTR(handle, smb_fname, name, value, size);
638 static ssize_t vxfs_fget_xattr(struct vfs_handle_struct *handle,
639 struct files_struct *fsp, const char *name,
640 void *value, size_t size){
643 DEBUG(10, ("In vxfs_fget_xattr\n"));
645 ret = vxfs_getxattr_fd(fsp_get_io_fd(fsp), name, value, size);
646 if ((ret != -1) || ((errno != ENOTSUP) &&
647 (errno != ENOSYS) && (errno != ENODATA))) {
651 DEBUG(10, ("Fallback to xattr\n"));
652 if (strcmp(name, XATTR_NTACL_NAME) == 0) {
653 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, XATTR_USER_NTACL,
657 /* Clients can't see XATTR_USER_NTACL directly. */
658 if (strcasecmp(name, XATTR_USER_NTACL) == 0) {
663 return SMB_VFS_NEXT_FGETXATTR(handle, fsp, name, value, size);
666 static int vxfs_remove_xattr(struct vfs_handle_struct *handle,
667 const struct smb_filename *smb_fname_in,
671 int ret = 0, ret_new = 0, old_errno;
672 struct smb_filename *smb_fname = NULL;
674 DEBUG(10, ("In vxfs_remove_xattr\n"));
676 smb_fname = cp_smb_filename_nostream(talloc_tos(), smb_fname_in);
677 if (smb_fname == NULL) {
682 /* Remove with old way */
683 if (strcmp(name, XATTR_NTACL_NAME) == 0) {
684 ret = SMB_VFS_NEXT_REMOVEXATTR(handle, smb_fname,
687 if (strcasecmp(name, XATTR_USER_NTACL) != 0) {
688 ret = SMB_VFS_NEXT_REMOVEXATTR(handle, smb_fname,
692 /* Remove with new way */
695 if (SMB_VFS_NEXT_STAT(handle, smb_fname) != 0) {
696 TALLOC_FREE(smb_fname);
700 is_dir = S_ISDIR(smb_fname->st.st_ex_mode);
701 TALLOC_FREE(smb_fname);
703 * If both fail, return failuer else return whichever succeeded
705 ret_new = vxfs_removexattr_path(smb_fname_in->base_name, name, is_dir);
706 if (errno == ENOTSUP || errno == ENOSYS) {
709 if ((ret_new != -1) && (ret == -1)) {
717 static int vxfs_fremove_xattr(struct vfs_handle_struct *handle,
718 struct files_struct *fsp, const char *name){
719 int ret = 0, ret_new = 0, old_errno;
721 DEBUG(10, ("In vxfs_fremove_xattr\n"));
723 /* Remove with old way */
724 if (strcmp(name, XATTR_NTACL_NAME) == 0) {
725 ret = SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp,
728 /* Clients can't remove XATTR_USER_NTACL directly. */
729 if (strcasecmp(name, XATTR_USER_NTACL) != 0) {
730 ret = SMB_VFS_NEXT_FREMOVEXATTR(handle, fsp,
736 /* Remove with new way */
737 ret_new = vxfs_removexattr_fd(fsp_get_io_fd(fsp), name);
739 * If both fail, return failuer else return whichever succeeded
741 if (errno == ENOTSUP || errno == ENOSYS) {
744 if ((ret_new != -1) && (ret == -1)) {
752 static size_t vxfs_filter_list(char *list, size_t size)
756 while (str - list < size) {
757 size_t element_len = strlen(str) + 1;
758 if (strcasecmp(str, XATTR_USER_NTACL) == 0) {
761 size - (str - list) - element_len);
770 static ssize_t vxfs_flistxattr(struct vfs_handle_struct *handle,
771 struct files_struct *fsp, char *list,
776 result = vxfs_listxattr_fd(fsp_get_io_fd(fsp), list, size);
777 if (result >= 0 || ((errno != ENOTSUP) && (errno != ENOSYS))) {
781 result = SMB_VFS_NEXT_FLISTXATTR(handle, fsp, list, size);
787 /* Remove any XATTR_USER_NTACL elements from the returned list. */
788 result = vxfs_filter_list(list, result);
793 static NTSTATUS vxfs_set_ea_dos_attributes(struct vfs_handle_struct *handle,
794 const struct smb_filename *smb_fname,
799 bool attrset = false;
802 DBG_DEBUG("Entered function\n");
804 is_dir = S_ISDIR(smb_fname->st.st_ex_mode);
805 if (!(dosmode & FILE_ATTRIBUTE_READONLY)) {
806 ret = vxfs_checkwxattr_path(smb_fname->base_name);
808 DBG_DEBUG("ret:%d\n", ret);
809 if ((errno != EOPNOTSUPP) && (errno != ENOENT)) {
810 return map_nt_error_from_unix(errno);
814 if (dosmode & FILE_ATTRIBUTE_READONLY) {
815 ret = vxfs_setwxattr_path(smb_fname->base_name, is_dir);
816 DBG_DEBUG("ret:%d\n", ret);
818 if ((errno != EOPNOTSUPP) && (errno != EINVAL)) {
819 return map_nt_error_from_unix(errno);
825 err = SMB_VFS_NEXT_SET_DOS_ATTRIBUTES(handle, smb_fname, dosmode);
826 if (!NT_STATUS_IS_OK(err)) {
828 ret = vxfs_clearwxattr_path(smb_fname->base_name, is_dir);
829 DBG_DEBUG("ret:%d\n", ret);
830 if ((ret == -1) && (errno != ENOENT)) {
831 return map_nt_error_from_unix(errno);
839 static NTSTATUS vxfs_fset_ea_dos_attributes(struct vfs_handle_struct *handle,
840 struct files_struct *fsp,
845 bool attrset = false;
847 DBG_DEBUG("Entered function\n");
849 if (!(dosmode & FILE_ATTRIBUTE_READONLY)) {
850 ret = vxfs_checkwxattr_fd(fsp_get_io_fd(fsp));
852 DBG_DEBUG("ret:%d\n", ret);
853 if ((errno != EOPNOTSUPP) && (errno != ENOENT)) {
854 return map_nt_error_from_unix(errno);
858 if (dosmode & FILE_ATTRIBUTE_READONLY) {
859 ret = vxfs_setwxattr_fd(fsp_get_io_fd(fsp));
860 DBG_DEBUG("ret:%d\n", ret);
862 if ((errno != EOPNOTSUPP) && (errno != EINVAL)) {
863 return map_nt_error_from_unix(errno);
869 err = SMB_VFS_NEXT_FSET_DOS_ATTRIBUTES(handle, fsp, dosmode);
870 if (!NT_STATUS_IS_OK(err)) {
872 ret = vxfs_clearwxattr_fd(fsp_get_io_fd(fsp));
873 DBG_DEBUG("ret:%d\n", ret);
874 if ((ret == -1) && (errno != ENOENT)) {
875 return map_nt_error_from_unix(errno);
882 static int vfs_vxfs_connect(struct vfs_handle_struct *handle,
883 const char *service, const char *user)
888 ret = SMB_VFS_NEXT_CONNECT(handle, service, user);
898 static struct vfs_fn_pointers vfs_vxfs_fns = {
899 .connect_fn = vfs_vxfs_connect,
901 #ifdef VXFS_ACL_SHARE
902 .sys_acl_set_fd_fn = vxfs_sys_acl_set_fd,
905 .set_dos_attributes_fn = vxfs_set_ea_dos_attributes,
906 .fset_dos_attributes_fn = vxfs_fset_ea_dos_attributes,
907 .getxattr_fn = vxfs_get_xattr,
908 .getxattrat_send_fn = vfs_not_implemented_getxattrat_send,
909 .getxattrat_recv_fn = vfs_not_implemented_getxattrat_recv,
910 .fgetxattr_fn = vxfs_fget_xattr,
911 .flistxattr_fn = vxfs_flistxattr,
912 .removexattr_fn = vxfs_remove_xattr,
913 .fremovexattr_fn = vxfs_fremove_xattr,
914 .setxattr_fn = vxfs_set_xattr,
915 .fsetxattr_fn = vxfs_fset_xattr,
919 NTSTATUS vfs_vxfs_init(TALLOC_CTX *ctx)
921 return smb_register_vfs(SMB_VFS_INTERFACE_VERSION, "vxfs",