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. */
213 for (off = 0; off + sizeof(struct EA_FULL) < size; off += ea_size) {
214 ea = Add2Ptr(ea_all, off);
215 ea_size = unpacked_ea_size(ea);
220 if (ea->name_len > ea_size)
224 /* Check if we can use field ea->name */
225 if (off + ea_size > size)
228 if (ret + ea->name_len + 1 > bytes_per_buffer) {
233 memcpy(buffer + ret, ea->name, ea->name_len);
234 buffer[ret + ea->name_len] = 0;
237 ret += ea->name_len + 1;
242 return err ? err : ret;
245 static int ntfs_get_ea(struct inode *inode, const char *name, size_t name_len,
246 void *buffer, size_t size, size_t *required)
248 struct ntfs_inode *ni = ntfs_i(inode);
249 const struct EA_INFO *info;
250 struct EA_FULL *ea_all = NULL;
251 const struct EA_FULL *ea;
255 if (!(ni->ni_flags & NI_FLAG_EA))
263 if (name_len > 255) {
268 err = ntfs_read_ea(ni, &ea_all, 0, &info);
275 /* Enumerate all xattrs. */
276 if (!find_ea(ea_all, le32_to_cpu(info->size), name, name_len, &off,
281 ea = Add2Ptr(ea_all, off);
283 len = le16_to_cpu(ea->elength);
296 memcpy(buffer, ea->name + ea->name_len + 1, len);
304 return err ? err : len;
307 static noinline int ntfs_set_ea(struct inode *inode, const char *name,
308 size_t name_len, const void *value,
309 size_t val_size, int flags, bool locked)
311 struct ntfs_inode *ni = ntfs_i(inode);
312 struct ntfs_sb_info *sbi = ni->mi.sbi;
314 struct EA_INFO ea_info;
315 const struct EA_INFO *info;
316 struct EA_FULL *new_ea;
317 struct EA_FULL *ea_all = NULL;
318 size_t add, new_pack;
319 u32 off, size, ea_sz;
322 struct ATTR_LIST_ENTRY *le;
323 struct mft_inode *mi;
324 struct runs_tree ea_run;
333 if (name_len > 255) {
338 add = ALIGN(struct_size(ea_all, name, 1 + name_len + val_size), 4);
340 err = ntfs_read_ea(ni, &ea_all, add, &info);
345 memset(&ea_info, 0, sizeof(ea_info));
349 memcpy(&ea_info, info, sizeof(ea_info));
350 size = le32_to_cpu(ea_info.size);
351 size_pack = ea_info.size_pack;
354 if (info && find_ea(ea_all, size, name, name_len, &off, &ea_sz)) {
357 if (flags & XATTR_CREATE) {
362 ea = Add2Ptr(ea_all, off);
365 * Check simple case when we try to insert xattr with the same value
366 * e.g. ntfs_save_wsl_perm
368 if (val_size && le16_to_cpu(ea->elength) == val_size &&
369 !memcmp(ea->name + ea->name_len + 1, value, val_size)) {
370 /* xattr already contains the required value. */
374 /* Remove current xattr. */
375 if (ea->flags & FILE_NEED_EA)
376 le16_add_cpu(&ea_info.count, -1);
378 le16_add_cpu(&ea_info.size_pack, 0 - packed_ea_size(ea));
380 memmove(ea, Add2Ptr(ea, ea_sz), size - off - ea_sz);
383 memset(Add2Ptr(ea_all, size), 0, ea_sz);
385 ea_info.size = cpu_to_le32(size);
387 if ((flags & XATTR_REPLACE) && !val_size) {
392 if (flags & XATTR_REPLACE) {
398 ea_all = kzalloc(add, GFP_NOFS);
406 /* Append new xattr. */
407 new_ea = Add2Ptr(ea_all, size);
408 new_ea->size = cpu_to_le32(add);
410 new_ea->name_len = name_len;
411 new_ea->elength = cpu_to_le16(val_size);
412 memcpy(new_ea->name, name, name_len);
413 new_ea->name[name_len] = 0;
414 memcpy(new_ea->name + name_len + 1, value, val_size);
415 new_pack = le16_to_cpu(ea_info.size_pack) + packed_ea_size(new_ea);
416 ea_info.size_pack = cpu_to_le16(new_pack);
417 /* New size of ATTR_EA. */
419 ea_info.size = cpu_to_le32(size);
422 * 1. Check ea_info.size_pack for overflow.
423 * 2. New attibute size must fit value from $AttrDef
425 if (new_pack > 0xffff || size > sbi->ea_max_size) {
428 "The size of extended attributes must not exceed 64KiB");
429 err = -EFBIG; // -EINVAL?
442 err = ni_insert_resident(ni, sizeof(struct EA_INFO),
443 ATTR_EA_INFO, NULL, 0, NULL, NULL,
448 err = ni_insert_resident(ni, 0, ATTR_EA, NULL, 0, NULL, NULL,
455 err = attr_set_size(ni, ATTR_EA, NULL, 0, &ea_run, new_sz, &new_sz,
461 attr = ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, &mi);
468 /* Delete xattr, ATTR_EA_INFO */
469 ni_remove_attr_le(ni, attr, mi, le);
471 p = resident_data_ex(attr, sizeof(struct EA_INFO));
476 memcpy(p, &ea_info, sizeof(struct EA_INFO));
481 attr = ni_find_attr(ni, NULL, &le, ATTR_EA, NULL, 0, NULL, &mi);
488 /* Delete xattr, ATTR_EA */
489 ni_remove_attr_le(ni, attr, mi, le);
490 } else if (attr->non_res) {
491 err = attr_load_runs_range(ni, ATTR_EA, NULL, 0, &ea_run, 0,
496 err = ntfs_sb_write_run(sbi, &ea_run, 0, ea_all, size, 0);
500 p = resident_data_ex(attr, size);
505 memcpy(p, ea_all, size);
509 /* Check if we delete the last xattr. */
511 ni->ni_flags |= NI_FLAG_EA;
513 ni->ni_flags &= ~NI_FLAG_EA;
515 if (ea_info.size_pack != size_pack)
516 ni->ni_flags |= NI_FLAG_UPDATE_PARENT;
517 mark_inode_dirty(&ni->vfs_inode);
529 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
530 static struct posix_acl *ntfs_get_acl_ex(struct inode *inode, int type,
533 struct ntfs_inode *ni = ntfs_i(inode);
536 struct posix_acl *acl;
541 /* Allocate PATH_MAX bytes. */
544 return ERR_PTR(-ENOMEM);
546 /* Possible values of 'type' was already checked above. */
547 if (type == ACL_TYPE_ACCESS) {
548 name = XATTR_NAME_POSIX_ACL_ACCESS;
549 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
551 name = XATTR_NAME_POSIX_ACL_DEFAULT;
552 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
558 err = ntfs_get_ea(inode, name, name_len, buf, PATH_MAX, &req);
563 /* Translate extended attribute to acl. */
565 acl = posix_acl_from_xattr(&init_user_ns, buf, err);
566 } else if (err == -ENODATA) {
573 set_cached_acl(inode, type, acl);
581 * ntfs_get_acl - inode_operations::get_acl
583 struct posix_acl *ntfs_get_acl(struct inode *inode, int type, bool rcu)
586 return ERR_PTR(-ECHILD);
588 return ntfs_get_acl_ex(inode, type, 0);
591 static noinline int ntfs_set_acl_ex(struct user_namespace *mnt_userns,
592 struct inode *inode, struct posix_acl *acl,
593 int type, bool init_acl)
596 size_t size, name_len;
602 if (S_ISLNK(inode->i_mode))
605 mode = inode->i_mode;
607 case ACL_TYPE_ACCESS:
608 /* Do not change i_mode if we are in init_acl */
609 if (acl && !init_acl) {
610 err = posix_acl_update_mode(mnt_userns, inode, &mode,
615 name = XATTR_NAME_POSIX_ACL_ACCESS;
616 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
619 case ACL_TYPE_DEFAULT:
620 if (!S_ISDIR(inode->i_mode))
621 return acl ? -EACCES : 0;
622 name = XATTR_NAME_POSIX_ACL_DEFAULT;
623 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
631 /* Remove xattr if it can be presented via mode. */
634 flags = XATTR_REPLACE;
636 size = posix_acl_xattr_size(acl->a_count);
637 value = kmalloc(size, GFP_NOFS);
640 err = posix_acl_to_xattr(&init_user_ns, acl, value, size);
646 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0);
647 if (err == -ENODATA && !size)
648 err = 0; /* Removing non existed xattr. */
650 set_cached_acl(inode, type, acl);
651 if (inode->i_mode != mode) {
652 inode->i_mode = mode;
653 mark_inode_dirty(inode);
664 * ntfs_set_acl - inode_operations::set_acl
666 int ntfs_set_acl(struct user_namespace *mnt_userns, struct inode *inode,
667 struct posix_acl *acl, int type)
669 return ntfs_set_acl_ex(mnt_userns, inode, acl, type, false);
673 * ntfs_init_acl - Initialize the ACLs of a new inode.
675 * Called from ntfs_create_inode().
677 int ntfs_init_acl(struct user_namespace *mnt_userns, struct inode *inode,
680 struct posix_acl *default_acl, *acl;
683 err = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
688 err = ntfs_set_acl_ex(mnt_userns, inode, default_acl,
689 ACL_TYPE_DEFAULT, true);
690 posix_acl_release(default_acl);
692 inode->i_default_acl = NULL;
697 err = ntfs_set_acl_ex(mnt_userns, inode, acl,
698 ACL_TYPE_ACCESS, true);
699 posix_acl_release(acl);
709 * ntfs_acl_chmod - Helper for ntfs3_setattr().
711 int ntfs_acl_chmod(struct user_namespace *mnt_userns, struct inode *inode)
713 struct super_block *sb = inode->i_sb;
715 if (!(sb->s_flags & SB_POSIXACL))
718 if (S_ISLNK(inode->i_mode))
721 return posix_acl_chmod(mnt_userns, inode, inode->i_mode);
725 * ntfs_permission - inode_operations::permission
727 int ntfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
730 if (ntfs_sb(inode->i_sb)->options->noacsrules) {
731 /* "No access rules" mode - Allow all changes. */
735 return generic_permission(mnt_userns, inode, mask);
739 * ntfs_listxattr - inode_operations::listxattr
741 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
743 struct inode *inode = d_inode(dentry);
744 struct ntfs_inode *ni = ntfs_i(inode);
747 if (!(ni->ni_flags & NI_FLAG_EA)) {
748 /* no xattr in file */
754 ret = ntfs_list_ea(ni, buffer, size);
761 static int ntfs_getxattr(const struct xattr_handler *handler, struct dentry *de,
762 struct inode *inode, const char *name, void *buffer,
766 struct ntfs_inode *ni = ntfs_i(inode);
767 size_t name_len = strlen(name);
769 /* Dispatch request. */
770 if (name_len == sizeof(SYSTEM_DOS_ATTRIB) - 1 &&
771 !memcmp(name, SYSTEM_DOS_ATTRIB, sizeof(SYSTEM_DOS_ATTRIB))) {
772 /* system.dos_attrib */
775 } else if (size < sizeof(u8)) {
779 *(u8 *)buffer = le32_to_cpu(ni->std_fa);
784 if (name_len == sizeof(SYSTEM_NTFS_ATTRIB) - 1 &&
785 !memcmp(name, SYSTEM_NTFS_ATTRIB, sizeof(SYSTEM_NTFS_ATTRIB))) {
786 /* system.ntfs_attrib */
789 } else if (size < sizeof(u32)) {
793 *(u32 *)buffer = le32_to_cpu(ni->std_fa);
798 if (name_len == sizeof(SYSTEM_NTFS_SECURITY) - 1 &&
799 !memcmp(name, SYSTEM_NTFS_SECURITY, sizeof(SYSTEM_NTFS_SECURITY))) {
800 /* system.ntfs_security*/
801 struct SECURITY_DESCRIPTOR_RELATIVE *sd = NULL;
804 if (!is_ntfs3(ni->mi.sbi)) {
805 /* We should get nt4 security. */
808 } else if (le32_to_cpu(ni->std_security_id) <
814 err = ntfs_get_security_by_id(ni->mi.sbi, ni->std_security_id,
819 if (!is_sd_valid(sd, sd_size)) {
822 "looks like you get incorrect security descriptor id=%u",
823 ni->std_security_id);
828 } else if (size < sd_size) {
832 memcpy(buffer, sd, sd_size);
838 /* Deal with NTFS extended attribute. */
839 err = ntfs_get_ea(inode, name, name_len, buffer, size, NULL);
846 * ntfs_setxattr - inode_operations::setxattr
848 static noinline int ntfs_setxattr(const struct xattr_handler *handler,
849 struct user_namespace *mnt_userns,
850 struct dentry *de, struct inode *inode,
851 const char *name, const void *value,
852 size_t size, int flags)
855 struct ntfs_inode *ni = ntfs_i(inode);
856 size_t name_len = strlen(name);
857 enum FILE_ATTRIBUTE new_fa;
859 /* Dispatch request. */
860 if (name_len == sizeof(SYSTEM_DOS_ATTRIB) - 1 &&
861 !memcmp(name, SYSTEM_DOS_ATTRIB, sizeof(SYSTEM_DOS_ATTRIB))) {
862 if (sizeof(u8) != size)
864 new_fa = cpu_to_le32(*(u8 *)value);
868 if (name_len == sizeof(SYSTEM_NTFS_ATTRIB) - 1 &&
869 !memcmp(name, SYSTEM_NTFS_ATTRIB, sizeof(SYSTEM_NTFS_ATTRIB))) {
870 if (size != sizeof(u32))
872 new_fa = cpu_to_le32(*(u32 *)value);
874 if (S_ISREG(inode->i_mode)) {
875 /* Process compressed/sparsed in special way. */
877 err = ni_new_attr_flags(ni, new_fa);
884 * Thanks Mark Harmstone:
885 * Keep directory bit consistency.
887 if (S_ISDIR(inode->i_mode))
888 new_fa |= FILE_ATTRIBUTE_DIRECTORY;
890 new_fa &= ~FILE_ATTRIBUTE_DIRECTORY;
892 if (ni->std_fa != new_fa) {
894 if (new_fa & FILE_ATTRIBUTE_READONLY)
895 inode->i_mode &= ~0222;
897 inode->i_mode |= 0222;
898 /* Std attribute always in primary record. */
900 mark_inode_dirty(inode);
907 if (name_len == sizeof(SYSTEM_NTFS_SECURITY) - 1 &&
908 !memcmp(name, SYSTEM_NTFS_SECURITY, sizeof(SYSTEM_NTFS_SECURITY))) {
909 /* system.ntfs_security*/
912 struct ATTR_STD_INFO5 *std;
914 if (!is_ntfs3(ni->mi.sbi)) {
916 * We should replace ATTR_SECURE.
917 * Skip this way cause it is nt4 feature.
923 if (!is_sd_valid(value, size)) {
927 "you try to set invalid security descriptor");
931 err = ntfs_insert_security(ni->mi.sbi, value, size,
932 &security_id, &inserted);
940 } else if (std->security_id != security_id) {
941 std->security_id = ni->std_security_id = security_id;
942 /* Std attribute always in primary record. */
944 mark_inode_dirty(&ni->vfs_inode);
950 /* Deal with NTFS extended attribute. */
951 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0);
954 inode->i_ctime = current_time(inode);
955 mark_inode_dirty(inode);
963 * save uid/gid/mode in xattr
965 int ntfs_save_wsl_perm(struct inode *inode)
969 struct ntfs_inode *ni = ntfs_i(inode);
972 value = cpu_to_le32(i_uid_read(inode));
973 err = ntfs_set_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value,
974 sizeof(value), 0, true); /* true == already locked. */
978 value = cpu_to_le32(i_gid_read(inode));
979 err = ntfs_set_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value,
980 sizeof(value), 0, true);
984 value = cpu_to_le32(inode->i_mode);
985 err = ntfs_set_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value,
986 sizeof(value), 0, true);
990 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
991 value = cpu_to_le32(inode->i_rdev);
992 err = ntfs_set_ea(inode, "$LXDEV", sizeof("$LXDEV") - 1, &value,
993 sizeof(value), 0, true);
1000 /* In case of error should we delete all WSL xattr? */
1007 * get uid/gid/mode from xattr
1008 * it is called from ntfs_iget5->ntfs_read_mft
1010 void ntfs_get_wsl_perm(struct inode *inode)
1015 if (ntfs_get_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value[0],
1016 sizeof(value[0]), &sz) == sizeof(value[0]) &&
1017 ntfs_get_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value[1],
1018 sizeof(value[1]), &sz) == sizeof(value[1]) &&
1019 ntfs_get_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value[2],
1020 sizeof(value[2]), &sz) == sizeof(value[2])) {
1021 i_uid_write(inode, (uid_t)le32_to_cpu(value[0]));
1022 i_gid_write(inode, (gid_t)le32_to_cpu(value[1]));
1023 inode->i_mode = le32_to_cpu(value[2]);
1025 if (ntfs_get_ea(inode, "$LXDEV", sizeof("$$LXDEV") - 1,
1026 &value[0], sizeof(value),
1027 &sz) == sizeof(value[0])) {
1028 inode->i_rdev = le32_to_cpu(value[0]);
1033 static bool ntfs_xattr_user_list(struct dentry *dentry)
1039 static const struct xattr_handler ntfs_other_xattr_handler = {
1041 .get = ntfs_getxattr,
1042 .set = ntfs_setxattr,
1043 .list = ntfs_xattr_user_list,
1046 const struct xattr_handler *ntfs_xattr_handlers[] = {
1047 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
1048 &posix_acl_access_xattr_handler,
1049 &posix_acl_default_xattr_handler,
1051 &ntfs_other_xattr_handler,