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_ATTRIB_BE "system.ntfs_attrib_be"
21 #define SYSTEM_NTFS_SECURITY "system.ntfs_security"
24 static inline size_t unpacked_ea_size(const struct EA_FULL *ea)
26 return ea->size ? le32_to_cpu(ea->size) :
27 ALIGN(struct_size(ea, name,
29 le16_to_cpu(ea->elength)),
33 static inline size_t packed_ea_size(const struct EA_FULL *ea)
35 return struct_size(ea, name,
36 1 + ea->name_len + le16_to_cpu(ea->elength)) -
37 offsetof(struct EA_FULL, flags);
43 * Assume there is at least one xattr in the list.
45 static inline bool find_ea(const struct EA_FULL *ea_all, u32 bytes,
46 const char *name, u8 name_len, u32 *off, u32 *ea_sz)
54 for (; *off < bytes; *off += ea_size) {
55 const struct EA_FULL *ea = Add2Ptr(ea_all, *off);
56 ea_size = unpacked_ea_size(ea);
57 if (ea->name_len == name_len &&
58 !memcmp(ea->name, name, name_len)) {
69 * ntfs_read_ea - Read all extended attributes.
70 * @ea: New allocated memory.
71 * @info: Pointer into resident data.
73 static int ntfs_read_ea(struct ntfs_inode *ni, struct EA_FULL **ea,
74 size_t add_bytes, const struct EA_INFO **info)
77 struct ntfs_sb_info *sbi = ni->mi.sbi;
78 struct ATTR_LIST_ENTRY *le = NULL;
79 struct ATTRIB *attr_info, *attr_ea;
81 u32 size, off, ea_size;
83 static_assert(le32_to_cpu(ATTR_EA_INFO) < le32_to_cpu(ATTR_EA));
89 ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, NULL);
91 ni_find_attr(ni, attr_info, &le, ATTR_EA, NULL, 0, NULL, NULL);
93 if (!attr_ea || !attr_info)
96 *info = resident_data_ex(attr_info, sizeof(struct EA_INFO));
100 /* Check Ea limit. */
101 size = le32_to_cpu((*info)->size);
102 if (size > sbi->ea_max_size) {
107 if (attr_size(attr_ea) > sbi->ea_max_size) {
113 /* EA info persists, but xattr is empty. Looks like EA problem. */
117 /* Allocate memory for packed Ea. */
118 ea_p = kmalloc(size_add(size, add_bytes), GFP_NOFS);
122 if (attr_ea->non_res) {
123 struct runs_tree run;
127 err = attr_load_runs_range(ni, ATTR_EA, NULL, 0, &run, 0, size);
129 err = ntfs_read_run_nb(sbi, &run, 0, ea_p, size, NULL);
135 void *p = resident_data_ex(attr_ea, size);
139 memcpy(ea_p, p, size);
142 memset(Add2Ptr(ea_p, size), 0, add_bytes);
145 /* Check all attributes for consistency. */
146 for (off = 0; off < size; off += ea_size) {
147 const struct EA_FULL *ef = Add2Ptr(ea_p, off);
148 u32 bytes = size - off;
150 /* Check if we can use field ea->size. */
151 if (bytes < sizeof(ef->size))
155 ea_size = le32_to_cpu(ef->size);
161 /* Check if we can use fields ef->name_len and ef->elength. */
162 if (bytes < offsetof(struct EA_FULL, name))
165 ea_size = ALIGN(struct_size(ef, name,
167 le16_to_cpu(ef->elength)),
179 ntfs_set_state(sbi, NTFS_DIRTY_DIRTY);
186 * Copy a list of xattrs names into the buffer
187 * provided, or compute the buffer size required.
190 * * Number of bytes used / required on
191 * * -ERRNO - on failure
193 static ssize_t ntfs_list_ea(struct ntfs_inode *ni, char *buffer,
194 size_t bytes_per_buffer)
196 const struct EA_INFO *info;
197 struct EA_FULL *ea_all = NULL;
198 const struct EA_FULL *ea;
204 err = ntfs_read_ea(ni, &ea_all, 0, &info);
208 if (!info || !ea_all)
211 size = le32_to_cpu(info->size);
213 /* Enumerate all xattrs. */
215 for (off = 0; off + sizeof(struct EA_FULL) < size; off += ea_size) {
216 ea = Add2Ptr(ea_all, off);
217 ea_size = unpacked_ea_size(ea);
222 if (ea->name_len > ea_size) {
223 ntfs_set_state(ni->mi.sbi, NTFS_DIRTY_ERROR);
224 err = -EINVAL; /* corrupted fs */
229 /* Check if we can use field ea->name */
230 if (off + ea_size > size)
233 if (ret + ea->name_len + 1 > bytes_per_buffer) {
238 memcpy(buffer + ret, ea->name, ea->name_len);
239 buffer[ret + ea->name_len] = 0;
242 ret += ea->name_len + 1;
247 return err ? err : ret;
250 static int ntfs_get_ea(struct inode *inode, const char *name, size_t name_len,
251 void *buffer, size_t size, size_t *required)
253 struct ntfs_inode *ni = ntfs_i(inode);
254 const struct EA_INFO *info;
255 struct EA_FULL *ea_all = NULL;
256 const struct EA_FULL *ea;
260 if (!(ni->ni_flags & NI_FLAG_EA))
268 if (name_len > 255) {
273 err = ntfs_read_ea(ni, &ea_all, 0, &info);
280 /* Enumerate all xattrs. */
281 if (!find_ea(ea_all, le32_to_cpu(info->size), name, name_len, &off,
286 ea = Add2Ptr(ea_all, off);
288 len = le16_to_cpu(ea->elength);
301 memcpy(buffer, ea->name + ea->name_len + 1, len);
309 return err ? err : len;
312 static noinline int ntfs_set_ea(struct inode *inode, const char *name,
313 size_t name_len, const void *value,
314 size_t val_size, int flags, bool locked,
317 struct ntfs_inode *ni = ntfs_i(inode);
318 struct ntfs_sb_info *sbi = ni->mi.sbi;
320 struct EA_INFO ea_info;
321 const struct EA_INFO *info;
322 struct EA_FULL *new_ea;
323 struct EA_FULL *ea_all = NULL;
324 size_t add, new_pack;
325 u32 off, size, ea_sz;
328 struct ATTR_LIST_ENTRY *le;
329 struct mft_inode *mi;
330 struct runs_tree ea_run;
339 if (name_len > 255) {
344 add = ALIGN(struct_size(ea_all, name, 1 + name_len + val_size), 4);
346 err = ntfs_read_ea(ni, &ea_all, add, &info);
351 memset(&ea_info, 0, sizeof(ea_info));
355 memcpy(&ea_info, info, sizeof(ea_info));
356 size = le32_to_cpu(ea_info.size);
357 size_pack = ea_info.size_pack;
360 if (info && find_ea(ea_all, size, name, name_len, &off, &ea_sz)) {
363 if (flags & XATTR_CREATE) {
368 ea = Add2Ptr(ea_all, off);
371 * Check simple case when we try to insert xattr with the same value
372 * e.g. ntfs_save_wsl_perm
374 if (val_size && le16_to_cpu(ea->elength) == val_size &&
375 !memcmp(ea->name + ea->name_len + 1, value, val_size)) {
376 /* xattr already contains the required value. */
380 /* Remove current xattr. */
381 if (ea->flags & FILE_NEED_EA)
382 le16_add_cpu(&ea_info.count, -1);
384 le16_add_cpu(&ea_info.size_pack, 0 - packed_ea_size(ea));
386 memmove(ea, Add2Ptr(ea, ea_sz), size - off - ea_sz);
389 memset(Add2Ptr(ea_all, size), 0, ea_sz);
391 ea_info.size = cpu_to_le32(size);
393 if ((flags & XATTR_REPLACE) && !val_size) {
398 if (flags & XATTR_REPLACE) {
404 ea_all = kzalloc(add, GFP_NOFS);
412 /* Append new xattr. */
413 new_ea = Add2Ptr(ea_all, size);
414 new_ea->size = cpu_to_le32(add);
416 new_ea->name_len = name_len;
417 new_ea->elength = cpu_to_le16(val_size);
418 memcpy(new_ea->name, name, name_len);
419 new_ea->name[name_len] = 0;
420 memcpy(new_ea->name + name_len + 1, value, val_size);
421 new_pack = le16_to_cpu(ea_info.size_pack) + packed_ea_size(new_ea);
422 ea_info.size_pack = cpu_to_le16(new_pack);
423 /* New size of ATTR_EA. */
425 ea_info.size = cpu_to_le32(size);
428 * 1. Check ea_info.size_pack for overflow.
429 * 2. New attribute size must fit value from $AttrDef
431 if (new_pack > 0xffff || size > sbi->ea_max_size) {
434 "The size of extended attributes must not exceed 64KiB");
435 err = -EFBIG; // -EINVAL?
448 err = ni_insert_resident(ni, sizeof(struct EA_INFO),
449 ATTR_EA_INFO, NULL, 0, NULL, NULL,
454 err = ni_insert_resident(ni, 0, ATTR_EA, NULL, 0, NULL, NULL,
461 err = attr_set_size(ni, ATTR_EA, NULL, 0, &ea_run, new_sz, &new_sz,
467 attr = ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, &mi);
474 /* Delete xattr, ATTR_EA_INFO */
475 ni_remove_attr_le(ni, attr, mi, le);
477 p = resident_data_ex(attr, sizeof(struct EA_INFO));
482 memcpy(p, &ea_info, sizeof(struct EA_INFO));
487 attr = ni_find_attr(ni, NULL, &le, ATTR_EA, NULL, 0, NULL, &mi);
494 /* Delete xattr, ATTR_EA */
495 ni_remove_attr_le(ni, attr, mi, le);
496 } else if (attr->non_res) {
497 err = attr_load_runs_range(ni, ATTR_EA, NULL, 0, &ea_run, 0,
502 err = ntfs_sb_write_run(sbi, &ea_run, 0, ea_all, size, 0);
506 p = resident_data_ex(attr, size);
511 memcpy(p, ea_all, size);
515 /* Check if we delete the last xattr. */
517 ni->ni_flags |= NI_FLAG_EA;
519 ni->ni_flags &= ~NI_FLAG_EA;
521 if (ea_info.size_pack != size_pack)
522 ni->ni_flags |= NI_FLAG_UPDATE_PARENT;
524 *ea_size = ea_info.size_pack;
525 mark_inode_dirty(&ni->vfs_inode);
537 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
540 * ntfs_get_acl - inode_operations::get_acl
542 struct posix_acl *ntfs_get_acl(struct mnt_idmap *idmap, struct dentry *dentry,
545 struct inode *inode = d_inode(dentry);
546 struct ntfs_inode *ni = ntfs_i(inode);
549 struct posix_acl *acl;
554 /* Allocate PATH_MAX bytes. */
557 return ERR_PTR(-ENOMEM);
559 /* Possible values of 'type' was already checked above. */
560 if (type == ACL_TYPE_ACCESS) {
561 name = XATTR_NAME_POSIX_ACL_ACCESS;
562 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
564 name = XATTR_NAME_POSIX_ACL_DEFAULT;
565 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
570 err = ntfs_get_ea(inode, name, name_len, buf, PATH_MAX, &req);
574 /* Translate extended attribute to acl. */
576 acl = posix_acl_from_xattr(&init_user_ns, buf, err);
577 } else if (err == -ENODATA) {
584 set_cached_acl(inode, type, acl);
591 static noinline int ntfs_set_acl_ex(struct mnt_idmap *idmap,
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(idmap, inode, &mode, &acl);
614 name = XATTR_NAME_POSIX_ACL_ACCESS;
615 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
618 case ACL_TYPE_DEFAULT:
619 if (!S_ISDIR(inode->i_mode))
620 return acl ? -EACCES : 0;
621 name = XATTR_NAME_POSIX_ACL_DEFAULT;
622 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
630 /* Remove xattr if it can be presented via mode. */
633 flags = XATTR_REPLACE;
635 size = posix_acl_xattr_size(acl->a_count);
636 value = kmalloc(size, GFP_NOFS);
639 err = posix_acl_to_xattr(&init_user_ns, acl, value, size);
645 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0, NULL);
646 if (err == -ENODATA && !size)
647 err = 0; /* Removing non existed xattr. */
649 set_cached_acl(inode, type, acl);
650 inode->i_mode = mode;
651 inode_set_ctime_current(inode);
652 mark_inode_dirty(inode);
662 * ntfs_set_acl - inode_operations::set_acl
664 int ntfs_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
665 struct posix_acl *acl, int type)
667 return ntfs_set_acl_ex(idmap, d_inode(dentry), acl, type, false);
671 * ntfs_init_acl - Initialize the ACLs of a new inode.
673 * Called from ntfs_create_inode().
675 int ntfs_init_acl(struct mnt_idmap *idmap, struct inode *inode,
678 struct posix_acl *default_acl, *acl;
681 err = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
686 err = ntfs_set_acl_ex(idmap, inode, default_acl,
687 ACL_TYPE_DEFAULT, true);
688 posix_acl_release(default_acl);
690 inode->i_default_acl = NULL;
695 err = ntfs_set_acl_ex(idmap, inode, acl,
696 ACL_TYPE_ACCESS, true);
697 posix_acl_release(acl);
707 * ntfs_acl_chmod - Helper for ntfs3_setattr().
709 int ntfs_acl_chmod(struct mnt_idmap *idmap, struct dentry *dentry)
711 struct inode *inode = d_inode(dentry);
712 struct super_block *sb = inode->i_sb;
714 if (!(sb->s_flags & SB_POSIXACL))
717 if (S_ISLNK(inode->i_mode))
720 return posix_acl_chmod(idmap, dentry, inode->i_mode);
724 * ntfs_listxattr - inode_operations::listxattr
726 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
728 struct inode *inode = d_inode(dentry);
729 struct ntfs_inode *ni = ntfs_i(inode);
732 if (!(ni->ni_flags & NI_FLAG_EA)) {
733 /* no xattr in file */
739 ret = ntfs_list_ea(ni, buffer, size);
746 static int ntfs_getxattr(const struct xattr_handler *handler, struct dentry *de,
747 struct inode *inode, const char *name, void *buffer,
751 struct ntfs_inode *ni = ntfs_i(inode);
753 if (unlikely(ntfs3_forced_shutdown(inode->i_sb)))
756 /* Dispatch request. */
757 if (!strcmp(name, SYSTEM_DOS_ATTRIB)) {
758 /* system.dos_attrib */
761 } else if (size < sizeof(u8)) {
765 *(u8 *)buffer = le32_to_cpu(ni->std_fa);
770 if (!strcmp(name, SYSTEM_NTFS_ATTRIB) ||
771 !strcmp(name, SYSTEM_NTFS_ATTRIB_BE)) {
772 /* system.ntfs_attrib */
775 } else if (size < sizeof(u32)) {
779 *(u32 *)buffer = le32_to_cpu(ni->std_fa);
780 if (!strcmp(name, SYSTEM_NTFS_ATTRIB_BE))
781 *(__be32 *)buffer = cpu_to_be32(*(u32 *)buffer);
786 if (!strcmp(name, SYSTEM_NTFS_SECURITY)) {
787 /* system.ntfs_security*/
788 struct SECURITY_DESCRIPTOR_RELATIVE *sd = NULL;
791 if (!is_ntfs3(ni->mi.sbi)) {
792 /* We should get nt4 security. */
795 } else if (le32_to_cpu(ni->std_security_id) <
801 err = ntfs_get_security_by_id(ni->mi.sbi, ni->std_security_id,
806 if (!is_sd_valid(sd, sd_size)) {
809 "looks like you get incorrect security descriptor id=%u",
810 ni->std_security_id);
815 } else if (size < sd_size) {
819 memcpy(buffer, sd, sd_size);
825 /* Deal with NTFS extended attribute. */
826 err = ntfs_get_ea(inode, name, strlen(name), buffer, size, NULL);
833 * ntfs_setxattr - inode_operations::setxattr
835 static noinline int ntfs_setxattr(const struct xattr_handler *handler,
836 struct mnt_idmap *idmap, struct dentry *de,
837 struct inode *inode, const char *name,
838 const void *value, size_t size, int flags)
841 struct ntfs_inode *ni = ntfs_i(inode);
842 enum FILE_ATTRIBUTE new_fa;
844 /* Dispatch request. */
845 if (!strcmp(name, SYSTEM_DOS_ATTRIB)) {
846 if (sizeof(u8) != size)
848 new_fa = cpu_to_le32(*(u8 *)value);
852 if (!strcmp(name, SYSTEM_NTFS_ATTRIB) ||
853 !strcmp(name, SYSTEM_NTFS_ATTRIB_BE)) {
854 if (size != sizeof(u32))
856 if (!strcmp(name, SYSTEM_NTFS_ATTRIB_BE))
857 new_fa = cpu_to_le32(be32_to_cpu(*(__be32 *)value));
859 new_fa = cpu_to_le32(*(u32 *)value);
861 if (S_ISREG(inode->i_mode)) {
862 /* Process compressed/sparsed in special way. */
864 err = ni_new_attr_flags(ni, new_fa);
871 * Thanks Mark Harmstone:
872 * Keep directory bit consistency.
874 if (S_ISDIR(inode->i_mode))
875 new_fa |= FILE_ATTRIBUTE_DIRECTORY;
877 new_fa &= ~FILE_ATTRIBUTE_DIRECTORY;
879 if (ni->std_fa != new_fa) {
881 if (new_fa & FILE_ATTRIBUTE_READONLY)
882 inode->i_mode &= ~0222;
884 inode->i_mode |= 0222;
885 /* Std attribute always in primary record. */
887 mark_inode_dirty(inode);
894 if (!strcmp(name, SYSTEM_NTFS_SECURITY)) {
895 /* system.ntfs_security*/
898 struct ATTR_STD_INFO5 *std;
900 if (!is_ntfs3(ni->mi.sbi)) {
902 * We should replace ATTR_SECURE.
903 * Skip this way cause it is nt4 feature.
909 if (!is_sd_valid(value, size)) {
913 "you try to set invalid security descriptor");
917 err = ntfs_insert_security(ni->mi.sbi, value, size,
918 &security_id, &inserted);
926 } else if (std->security_id != security_id) {
927 std->security_id = ni->std_security_id = security_id;
928 /* Std attribute always in primary record. */
930 mark_inode_dirty(&ni->vfs_inode);
936 /* Deal with NTFS extended attribute. */
937 err = ntfs_set_ea(inode, name, strlen(name), value, size, flags, 0,
941 inode_set_ctime_current(inode);
942 mark_inode_dirty(inode);
950 * save uid/gid/mode in xattr
952 int ntfs_save_wsl_perm(struct inode *inode, __le16 *ea_size)
956 struct ntfs_inode *ni = ntfs_i(inode);
959 value = cpu_to_le32(i_uid_read(inode));
960 err = ntfs_set_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value,
961 sizeof(value), 0, true, ea_size);
965 value = cpu_to_le32(i_gid_read(inode));
966 err = ntfs_set_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value,
967 sizeof(value), 0, true, ea_size);
971 value = cpu_to_le32(inode->i_mode);
972 err = ntfs_set_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value,
973 sizeof(value), 0, true, ea_size);
977 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
978 value = cpu_to_le32(inode->i_rdev);
979 err = ntfs_set_ea(inode, "$LXDEV", sizeof("$LXDEV") - 1, &value,
980 sizeof(value), 0, true, ea_size);
987 /* In case of error should we delete all WSL xattr? */
994 * get uid/gid/mode from xattr
995 * it is called from ntfs_iget5->ntfs_read_mft
997 void ntfs_get_wsl_perm(struct inode *inode)
1002 if (ntfs_get_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value[0],
1003 sizeof(value[0]), &sz) == sizeof(value[0]) &&
1004 ntfs_get_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value[1],
1005 sizeof(value[1]), &sz) == sizeof(value[1]) &&
1006 ntfs_get_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value[2],
1007 sizeof(value[2]), &sz) == sizeof(value[2])) {
1008 i_uid_write(inode, (uid_t)le32_to_cpu(value[0]));
1009 i_gid_write(inode, (gid_t)le32_to_cpu(value[1]));
1010 inode->i_mode = le32_to_cpu(value[2]);
1012 if (ntfs_get_ea(inode, "$LXDEV", sizeof("$$LXDEV") - 1,
1013 &value[0], sizeof(value),
1014 &sz) == sizeof(value[0])) {
1015 inode->i_rdev = le32_to_cpu(value[0]);
1020 static bool ntfs_xattr_user_list(struct dentry *dentry)
1026 static const struct xattr_handler ntfs_other_xattr_handler = {
1028 .get = ntfs_getxattr,
1029 .set = ntfs_setxattr,
1030 .list = ntfs_xattr_user_list,
1033 const struct xattr_handler * const ntfs_xattr_handlers[] = {
1034 &ntfs_other_xattr_handler,