1 // SPDX-License-Identifier: GPL-2.0
4 * Copyright (C) 2019-2021 Paragon Software GmbH, All rights reserved.
9 #include <linux/posix_acl.h>
10 #include <linux/posix_acl_xattr.h>
11 #include <linux/xattr.h>
18 #define SYSTEM_DOS_ATTRIB "system.dos_attrib"
19 #define SYSTEM_NTFS_ATTRIB "system.ntfs_attrib"
20 #define SYSTEM_NTFS_SECURITY "system.ntfs_security"
23 static inline size_t unpacked_ea_size(const struct EA_FULL *ea)
25 return ea->size ? le32_to_cpu(ea->size)
26 : ALIGN(struct_size(ea, name,
28 le16_to_cpu(ea->elength)),
32 static inline size_t packed_ea_size(const struct EA_FULL *ea)
34 return struct_size(ea, name,
35 1 + ea->name_len + le16_to_cpu(ea->elength)) -
36 offsetof(struct EA_FULL, flags);
42 * Assume there is at least one xattr in the list.
44 static inline bool find_ea(const struct EA_FULL *ea_all, u32 bytes,
45 const char *name, u8 name_len, u32 *off, u32 *ea_sz)
53 for (; *off < bytes; *off += ea_size) {
54 const struct EA_FULL *ea = Add2Ptr(ea_all, *off);
55 ea_size = unpacked_ea_size(ea);
56 if (ea->name_len == name_len &&
57 !memcmp(ea->name, name, name_len)) {
68 * ntfs_read_ea - Read all extended attributes.
69 * @ea: New allocated memory.
70 * @info: Pointer into resident data.
72 static int ntfs_read_ea(struct ntfs_inode *ni, struct EA_FULL **ea,
73 size_t add_bytes, const struct EA_INFO **info)
76 struct ntfs_sb_info *sbi = ni->mi.sbi;
77 struct ATTR_LIST_ENTRY *le = NULL;
78 struct ATTRIB *attr_info, *attr_ea;
80 u32 size, off, ea_size;
82 static_assert(le32_to_cpu(ATTR_EA_INFO) < le32_to_cpu(ATTR_EA));
88 ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, NULL);
90 ni_find_attr(ni, attr_info, &le, ATTR_EA, NULL, 0, NULL, NULL);
92 if (!attr_ea || !attr_info)
95 *info = resident_data_ex(attr_info, sizeof(struct EA_INFO));
100 size = le32_to_cpu((*info)->size);
101 if (size > sbi->ea_max_size) {
106 if (attr_size(attr_ea) > sbi->ea_max_size) {
112 /* EA info persists, but xattr is empty. Looks like EA problem. */
116 /* Allocate memory for packed Ea. */
117 ea_p = kmalloc(size_add(size, add_bytes), GFP_NOFS);
121 if (attr_ea->non_res) {
122 struct runs_tree run;
126 err = attr_load_runs_range(ni, ATTR_EA, NULL, 0, &run, 0, size);
128 err = ntfs_read_run_nb(sbi, &run, 0, ea_p, size, NULL);
134 void *p = resident_data_ex(attr_ea, size);
138 memcpy(ea_p, p, size);
141 memset(Add2Ptr(ea_p, size), 0, add_bytes);
143 /* Check all attributes for consistency. */
144 for (off = 0; off < size; off += ea_size) {
145 const struct EA_FULL *ef = Add2Ptr(ea_p, off);
146 u32 bytes = size - off;
148 /* Check if we can use field ea->size. */
149 if (bytes < sizeof(ef->size))
153 ea_size = le32_to_cpu(ef->size);
159 /* Check if we can use fields ef->name_len and ef->elength. */
160 if (bytes < offsetof(struct EA_FULL, name))
163 ea_size = ALIGN(struct_size(ef, name,
165 le16_to_cpu(ef->elength)),
177 ntfs_set_state(sbi, NTFS_DIRTY_DIRTY);
184 * Copy a list of xattrs names into the buffer
185 * provided, or compute the buffer size required.
188 * * Number of bytes used / required on
189 * * -ERRNO - on failure
191 static ssize_t ntfs_list_ea(struct ntfs_inode *ni, char *buffer,
192 size_t bytes_per_buffer)
194 const struct EA_INFO *info;
195 struct EA_FULL *ea_all = NULL;
196 const struct EA_FULL *ea;
202 err = ntfs_read_ea(ni, &ea_all, 0, &info);
206 if (!info || !ea_all)
209 size = le32_to_cpu(info->size);
211 /* Enumerate all xattrs. */
212 for (ret = 0, off = 0; off < size; off += ea_size) {
213 ea = Add2Ptr(ea_all, off);
214 ea_size = unpacked_ea_size(ea);
220 if (ret + ea->name_len + 1 > bytes_per_buffer) {
225 memcpy(buffer + ret, ea->name, ea->name_len);
226 buffer[ret + ea->name_len] = 0;
229 ret += ea->name_len + 1;
234 return err ? err : ret;
237 static int ntfs_get_ea(struct inode *inode, const char *name, size_t name_len,
238 void *buffer, size_t size, size_t *required)
240 struct ntfs_inode *ni = ntfs_i(inode);
241 const struct EA_INFO *info;
242 struct EA_FULL *ea_all = NULL;
243 const struct EA_FULL *ea;
247 if (!(ni->ni_flags & NI_FLAG_EA))
255 if (name_len > 255) {
260 err = ntfs_read_ea(ni, &ea_all, 0, &info);
267 /* Enumerate all xattrs. */
268 if (!find_ea(ea_all, le32_to_cpu(info->size), name, name_len, &off,
273 ea = Add2Ptr(ea_all, off);
275 len = le16_to_cpu(ea->elength);
288 memcpy(buffer, ea->name + ea->name_len + 1, len);
296 return err ? err : len;
299 static noinline int ntfs_set_ea(struct inode *inode, const char *name,
300 size_t name_len, const void *value,
301 size_t val_size, int flags, bool locked)
303 struct ntfs_inode *ni = ntfs_i(inode);
304 struct ntfs_sb_info *sbi = ni->mi.sbi;
306 struct EA_INFO ea_info;
307 const struct EA_INFO *info;
308 struct EA_FULL *new_ea;
309 struct EA_FULL *ea_all = NULL;
310 size_t add, new_pack;
311 u32 off, size, ea_sz;
314 struct ATTR_LIST_ENTRY *le;
315 struct mft_inode *mi;
316 struct runs_tree ea_run;
325 if (name_len > 255) {
330 add = ALIGN(struct_size(ea_all, name, 1 + name_len + val_size), 4);
332 err = ntfs_read_ea(ni, &ea_all, add, &info);
337 memset(&ea_info, 0, sizeof(ea_info));
341 memcpy(&ea_info, info, sizeof(ea_info));
342 size = le32_to_cpu(ea_info.size);
343 size_pack = ea_info.size_pack;
346 if (info && find_ea(ea_all, size, name, name_len, &off, &ea_sz)) {
349 if (flags & XATTR_CREATE) {
354 ea = Add2Ptr(ea_all, off);
357 * Check simple case when we try to insert xattr with the same value
358 * e.g. ntfs_save_wsl_perm
360 if (val_size && le16_to_cpu(ea->elength) == val_size &&
361 !memcmp(ea->name + ea->name_len + 1, value, val_size)) {
362 /* xattr already contains the required value. */
366 /* Remove current xattr. */
367 if (ea->flags & FILE_NEED_EA)
368 le16_add_cpu(&ea_info.count, -1);
370 le16_add_cpu(&ea_info.size_pack, 0 - packed_ea_size(ea));
372 memmove(ea, Add2Ptr(ea, ea_sz), size - off - ea_sz);
375 memset(Add2Ptr(ea_all, size), 0, ea_sz);
377 ea_info.size = cpu_to_le32(size);
379 if ((flags & XATTR_REPLACE) && !val_size) {
384 if (flags & XATTR_REPLACE) {
390 ea_all = kzalloc(add, GFP_NOFS);
398 /* Append new xattr. */
399 new_ea = Add2Ptr(ea_all, size);
400 new_ea->size = cpu_to_le32(add);
402 new_ea->name_len = name_len;
403 new_ea->elength = cpu_to_le16(val_size);
404 memcpy(new_ea->name, name, name_len);
405 new_ea->name[name_len] = 0;
406 memcpy(new_ea->name + name_len + 1, value, val_size);
407 new_pack = le16_to_cpu(ea_info.size_pack) + packed_ea_size(new_ea);
408 ea_info.size_pack = cpu_to_le16(new_pack);
409 /* New size of ATTR_EA. */
411 ea_info.size = cpu_to_le32(size);
414 * 1. Check ea_info.size_pack for overflow.
415 * 2. New attibute size must fit value from $AttrDef
417 if (new_pack > 0xffff || size > sbi->ea_max_size) {
420 "The size of extended attributes must not exceed 64KiB");
421 err = -EFBIG; // -EINVAL?
434 err = ni_insert_resident(ni, sizeof(struct EA_INFO),
435 ATTR_EA_INFO, NULL, 0, NULL, NULL,
440 err = ni_insert_resident(ni, 0, ATTR_EA, NULL, 0, NULL, NULL,
447 err = attr_set_size(ni, ATTR_EA, NULL, 0, &ea_run, new_sz, &new_sz,
453 attr = ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, &mi);
460 /* Delete xattr, ATTR_EA_INFO */
461 ni_remove_attr_le(ni, attr, mi, le);
463 p = resident_data_ex(attr, sizeof(struct EA_INFO));
468 memcpy(p, &ea_info, sizeof(struct EA_INFO));
473 attr = ni_find_attr(ni, NULL, &le, ATTR_EA, NULL, 0, NULL, &mi);
480 /* Delete xattr, ATTR_EA */
481 ni_remove_attr_le(ni, attr, mi, le);
482 } else if (attr->non_res) {
483 err = attr_load_runs_range(ni, ATTR_EA, NULL, 0, &ea_run, 0,
488 err = ntfs_sb_write_run(sbi, &ea_run, 0, ea_all, size, 0);
492 p = resident_data_ex(attr, size);
497 memcpy(p, ea_all, size);
501 /* Check if we delete the last xattr. */
503 ni->ni_flags |= NI_FLAG_EA;
505 ni->ni_flags &= ~NI_FLAG_EA;
507 if (ea_info.size_pack != size_pack)
508 ni->ni_flags |= NI_FLAG_UPDATE_PARENT;
509 mark_inode_dirty(&ni->vfs_inode);
521 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
522 static struct posix_acl *ntfs_get_acl_ex(struct inode *inode, int type,
525 struct ntfs_inode *ni = ntfs_i(inode);
528 struct posix_acl *acl;
533 /* Allocate PATH_MAX bytes. */
536 return ERR_PTR(-ENOMEM);
538 /* Possible values of 'type' was already checked above. */
539 if (type == ACL_TYPE_ACCESS) {
540 name = XATTR_NAME_POSIX_ACL_ACCESS;
541 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
543 name = XATTR_NAME_POSIX_ACL_DEFAULT;
544 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
550 err = ntfs_get_ea(inode, name, name_len, buf, PATH_MAX, &req);
555 /* Translate extended attribute to acl. */
557 acl = posix_acl_from_xattr(&init_user_ns, buf, err);
558 } else if (err == -ENODATA) {
565 set_cached_acl(inode, type, acl);
573 * ntfs_get_acl - inode_operations::get_acl
575 struct posix_acl *ntfs_get_acl(struct inode *inode, int type, bool rcu)
578 return ERR_PTR(-ECHILD);
580 return ntfs_get_acl_ex(inode, type, 0);
583 static noinline int ntfs_set_acl_ex(struct user_namespace *mnt_userns,
584 struct inode *inode, struct posix_acl *acl,
585 int type, bool init_acl)
588 size_t size, name_len;
594 if (S_ISLNK(inode->i_mode))
597 mode = inode->i_mode;
599 case ACL_TYPE_ACCESS:
600 /* Do not change i_mode if we are in init_acl */
601 if (acl && !init_acl) {
602 err = posix_acl_update_mode(mnt_userns, inode, &mode,
607 name = XATTR_NAME_POSIX_ACL_ACCESS;
608 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
611 case ACL_TYPE_DEFAULT:
612 if (!S_ISDIR(inode->i_mode))
613 return acl ? -EACCES : 0;
614 name = XATTR_NAME_POSIX_ACL_DEFAULT;
615 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
623 /* Remove xattr if it can be presented via mode. */
626 flags = XATTR_REPLACE;
628 size = posix_acl_xattr_size(acl->a_count);
629 value = kmalloc(size, GFP_NOFS);
632 err = posix_acl_to_xattr(&init_user_ns, acl, value, size);
638 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0);
639 if (err == -ENODATA && !size)
640 err = 0; /* Removing non existed xattr. */
642 set_cached_acl(inode, type, acl);
643 if (inode->i_mode != mode) {
644 inode->i_mode = mode;
645 mark_inode_dirty(inode);
656 * ntfs_set_acl - inode_operations::set_acl
658 int ntfs_set_acl(struct user_namespace *mnt_userns, struct inode *inode,
659 struct posix_acl *acl, int type)
661 return ntfs_set_acl_ex(mnt_userns, inode, acl, type, false);
665 * ntfs_init_acl - Initialize the ACLs of a new inode.
667 * Called from ntfs_create_inode().
669 int ntfs_init_acl(struct user_namespace *mnt_userns, struct inode *inode,
672 struct posix_acl *default_acl, *acl;
675 err = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
680 err = ntfs_set_acl_ex(mnt_userns, inode, default_acl,
681 ACL_TYPE_DEFAULT, true);
682 posix_acl_release(default_acl);
684 inode->i_default_acl = NULL;
689 err = ntfs_set_acl_ex(mnt_userns, inode, acl,
690 ACL_TYPE_ACCESS, true);
691 posix_acl_release(acl);
701 * ntfs_acl_chmod - Helper for ntfs3_setattr().
703 int ntfs_acl_chmod(struct user_namespace *mnt_userns, struct inode *inode)
705 struct super_block *sb = inode->i_sb;
707 if (!(sb->s_flags & SB_POSIXACL))
710 if (S_ISLNK(inode->i_mode))
713 return posix_acl_chmod(mnt_userns, inode, inode->i_mode);
717 * ntfs_permission - inode_operations::permission
719 int ntfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
722 if (ntfs_sb(inode->i_sb)->options->noacsrules) {
723 /* "No access rules" mode - Allow all changes. */
727 return generic_permission(mnt_userns, inode, mask);
731 * ntfs_listxattr - inode_operations::listxattr
733 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
735 struct inode *inode = d_inode(dentry);
736 struct ntfs_inode *ni = ntfs_i(inode);
739 if (!(ni->ni_flags & NI_FLAG_EA)) {
740 /* no xattr in file */
746 ret = ntfs_list_ea(ni, buffer, size);
753 static int ntfs_getxattr(const struct xattr_handler *handler, struct dentry *de,
754 struct inode *inode, const char *name, void *buffer,
758 struct ntfs_inode *ni = ntfs_i(inode);
759 size_t name_len = strlen(name);
761 /* Dispatch request. */
762 if (name_len == sizeof(SYSTEM_DOS_ATTRIB) - 1 &&
763 !memcmp(name, SYSTEM_DOS_ATTRIB, sizeof(SYSTEM_DOS_ATTRIB))) {
764 /* system.dos_attrib */
767 } else if (size < sizeof(u8)) {
771 *(u8 *)buffer = le32_to_cpu(ni->std_fa);
776 if (name_len == sizeof(SYSTEM_NTFS_ATTRIB) - 1 &&
777 !memcmp(name, SYSTEM_NTFS_ATTRIB, sizeof(SYSTEM_NTFS_ATTRIB))) {
778 /* system.ntfs_attrib */
781 } else if (size < sizeof(u32)) {
785 *(u32 *)buffer = le32_to_cpu(ni->std_fa);
790 if (name_len == sizeof(SYSTEM_NTFS_SECURITY) - 1 &&
791 !memcmp(name, SYSTEM_NTFS_SECURITY, sizeof(SYSTEM_NTFS_SECURITY))) {
792 /* system.ntfs_security*/
793 struct SECURITY_DESCRIPTOR_RELATIVE *sd = NULL;
796 if (!is_ntfs3(ni->mi.sbi)) {
797 /* We should get nt4 security. */
800 } else if (le32_to_cpu(ni->std_security_id) <
806 err = ntfs_get_security_by_id(ni->mi.sbi, ni->std_security_id,
811 if (!is_sd_valid(sd, sd_size)) {
814 "looks like you get incorrect security descriptor id=%u",
815 ni->std_security_id);
820 } else if (size < sd_size) {
824 memcpy(buffer, sd, sd_size);
830 /* Deal with NTFS extended attribute. */
831 err = ntfs_get_ea(inode, name, name_len, buffer, size, NULL);
838 * ntfs_setxattr - inode_operations::setxattr
840 static noinline int ntfs_setxattr(const struct xattr_handler *handler,
841 struct user_namespace *mnt_userns,
842 struct dentry *de, struct inode *inode,
843 const char *name, const void *value,
844 size_t size, int flags)
847 struct ntfs_inode *ni = ntfs_i(inode);
848 size_t name_len = strlen(name);
849 enum FILE_ATTRIBUTE new_fa;
851 /* Dispatch request. */
852 if (name_len == sizeof(SYSTEM_DOS_ATTRIB) - 1 &&
853 !memcmp(name, SYSTEM_DOS_ATTRIB, sizeof(SYSTEM_DOS_ATTRIB))) {
854 if (sizeof(u8) != size)
856 new_fa = cpu_to_le32(*(u8 *)value);
860 if (name_len == sizeof(SYSTEM_NTFS_ATTRIB) - 1 &&
861 !memcmp(name, SYSTEM_NTFS_ATTRIB, sizeof(SYSTEM_NTFS_ATTRIB))) {
862 if (size != sizeof(u32))
864 new_fa = cpu_to_le32(*(u32 *)value);
866 if (S_ISREG(inode->i_mode)) {
867 /* Process compressed/sparsed in special way. */
869 err = ni_new_attr_flags(ni, new_fa);
876 * Thanks Mark Harmstone:
877 * Keep directory bit consistency.
879 if (S_ISDIR(inode->i_mode))
880 new_fa |= FILE_ATTRIBUTE_DIRECTORY;
882 new_fa &= ~FILE_ATTRIBUTE_DIRECTORY;
884 if (ni->std_fa != new_fa) {
886 if (new_fa & FILE_ATTRIBUTE_READONLY)
887 inode->i_mode &= ~0222;
889 inode->i_mode |= 0222;
890 /* Std attribute always in primary record. */
892 mark_inode_dirty(inode);
899 if (name_len == sizeof(SYSTEM_NTFS_SECURITY) - 1 &&
900 !memcmp(name, SYSTEM_NTFS_SECURITY, sizeof(SYSTEM_NTFS_SECURITY))) {
901 /* system.ntfs_security*/
904 struct ATTR_STD_INFO5 *std;
906 if (!is_ntfs3(ni->mi.sbi)) {
908 * We should replace ATTR_SECURE.
909 * Skip this way cause it is nt4 feature.
915 if (!is_sd_valid(value, size)) {
919 "you try to set invalid security descriptor");
923 err = ntfs_insert_security(ni->mi.sbi, value, size,
924 &security_id, &inserted);
932 } else if (std->security_id != security_id) {
933 std->security_id = ni->std_security_id = security_id;
934 /* Std attribute always in primary record. */
936 mark_inode_dirty(&ni->vfs_inode);
942 /* Deal with NTFS extended attribute. */
943 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0);
946 inode->i_ctime = current_time(inode);
947 mark_inode_dirty(inode);
955 * save uid/gid/mode in xattr
957 int ntfs_save_wsl_perm(struct inode *inode)
961 struct ntfs_inode *ni = ntfs_i(inode);
964 value = cpu_to_le32(i_uid_read(inode));
965 err = ntfs_set_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value,
966 sizeof(value), 0, true); /* true == already locked. */
970 value = cpu_to_le32(i_gid_read(inode));
971 err = ntfs_set_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value,
972 sizeof(value), 0, true);
976 value = cpu_to_le32(inode->i_mode);
977 err = ntfs_set_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value,
978 sizeof(value), 0, true);
982 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
983 value = cpu_to_le32(inode->i_rdev);
984 err = ntfs_set_ea(inode, "$LXDEV", sizeof("$LXDEV") - 1, &value,
985 sizeof(value), 0, true);
992 /* In case of error should we delete all WSL xattr? */
999 * get uid/gid/mode from xattr
1000 * it is called from ntfs_iget5->ntfs_read_mft
1002 void ntfs_get_wsl_perm(struct inode *inode)
1007 if (ntfs_get_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value[0],
1008 sizeof(value[0]), &sz) == sizeof(value[0]) &&
1009 ntfs_get_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value[1],
1010 sizeof(value[1]), &sz) == sizeof(value[1]) &&
1011 ntfs_get_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value[2],
1012 sizeof(value[2]), &sz) == sizeof(value[2])) {
1013 i_uid_write(inode, (uid_t)le32_to_cpu(value[0]));
1014 i_gid_write(inode, (gid_t)le32_to_cpu(value[1]));
1015 inode->i_mode = le32_to_cpu(value[2]);
1017 if (ntfs_get_ea(inode, "$LXDEV", sizeof("$$LXDEV") - 1,
1018 &value[0], sizeof(value),
1019 &sz) == sizeof(value[0])) {
1020 inode->i_rdev = le32_to_cpu(value[0]);
1025 static bool ntfs_xattr_user_list(struct dentry *dentry)
1031 static const struct xattr_handler ntfs_other_xattr_handler = {
1033 .get = ntfs_getxattr,
1034 .set = ntfs_setxattr,
1035 .list = ntfs_xattr_user_list,
1038 const struct xattr_handler *ntfs_xattr_handlers[] = {
1039 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
1040 &posix_acl_access_xattr_handler,
1041 &posix_acl_default_xattr_handler,
1043 &ntfs_other_xattr_handler,