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);
223 /* Check if we can use field ea->name */
224 if (off + ea_size > size)
227 if (ret + ea->name_len + 1 > bytes_per_buffer) {
232 memcpy(buffer + ret, ea->name, ea->name_len);
233 buffer[ret + ea->name_len] = 0;
236 ret += ea->name_len + 1;
241 return err ? err : ret;
244 static int ntfs_get_ea(struct inode *inode, const char *name, size_t name_len,
245 void *buffer, size_t size, size_t *required)
247 struct ntfs_inode *ni = ntfs_i(inode);
248 const struct EA_INFO *info;
249 struct EA_FULL *ea_all = NULL;
250 const struct EA_FULL *ea;
254 if (!(ni->ni_flags & NI_FLAG_EA))
262 if (name_len > 255) {
267 err = ntfs_read_ea(ni, &ea_all, 0, &info);
274 /* Enumerate all xattrs. */
275 if (!find_ea(ea_all, le32_to_cpu(info->size), name, name_len, &off,
280 ea = Add2Ptr(ea_all, off);
282 len = le16_to_cpu(ea->elength);
295 memcpy(buffer, ea->name + ea->name_len + 1, len);
303 return err ? err : len;
306 static noinline int ntfs_set_ea(struct inode *inode, const char *name,
307 size_t name_len, const void *value,
308 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 attribute 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;
518 *ea_size = ea_info.size_pack;
519 mark_inode_dirty(&ni->vfs_inode);
531 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
534 * ntfs_get_acl - inode_operations::get_acl
536 struct posix_acl *ntfs_get_acl(struct mnt_idmap *idmap, struct dentry *dentry,
539 struct inode *inode = d_inode(dentry);
540 struct ntfs_inode *ni = ntfs_i(inode);
543 struct posix_acl *acl;
548 /* Allocate PATH_MAX bytes. */
551 return ERR_PTR(-ENOMEM);
553 /* Possible values of 'type' was already checked above. */
554 if (type == ACL_TYPE_ACCESS) {
555 name = XATTR_NAME_POSIX_ACL_ACCESS;
556 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
558 name = XATTR_NAME_POSIX_ACL_DEFAULT;
559 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
564 err = ntfs_get_ea(inode, name, name_len, buf, PATH_MAX, &req);
568 /* Translate extended attribute to acl. */
570 acl = posix_acl_from_xattr(&init_user_ns, buf, err);
571 } else if (err == -ENODATA) {
578 set_cached_acl(inode, type, acl);
585 static noinline int ntfs_set_acl_ex(struct mnt_idmap *idmap,
586 struct inode *inode, struct posix_acl *acl,
587 int type, bool init_acl)
590 size_t size, name_len;
596 if (S_ISLNK(inode->i_mode))
599 mode = inode->i_mode;
601 case ACL_TYPE_ACCESS:
602 /* Do not change i_mode if we are in init_acl */
603 if (acl && !init_acl) {
604 err = posix_acl_update_mode(idmap, inode, &mode, &acl);
608 name = XATTR_NAME_POSIX_ACL_ACCESS;
609 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
612 case ACL_TYPE_DEFAULT:
613 if (!S_ISDIR(inode->i_mode))
614 return acl ? -EACCES : 0;
615 name = XATTR_NAME_POSIX_ACL_DEFAULT;
616 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
624 /* Remove xattr if it can be presented via mode. */
627 flags = XATTR_REPLACE;
629 size = posix_acl_xattr_size(acl->a_count);
630 value = kmalloc(size, GFP_NOFS);
633 err = posix_acl_to_xattr(&init_user_ns, acl, value, size);
639 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0, NULL);
640 if (err == -ENODATA && !size)
641 err = 0; /* Removing non existed xattr. */
643 set_cached_acl(inode, type, acl);
644 inode->i_mode = mode;
645 inode_set_ctime_current(inode);
646 mark_inode_dirty(inode);
656 * ntfs_set_acl - inode_operations::set_acl
658 int ntfs_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
659 struct posix_acl *acl, int type)
661 return ntfs_set_acl_ex(idmap, d_inode(dentry), 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 mnt_idmap *idmap, 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(idmap, 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(idmap, 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 mnt_idmap *idmap, struct dentry *dentry)
705 struct inode *inode = d_inode(dentry);
706 struct super_block *sb = inode->i_sb;
708 if (!(sb->s_flags & SB_POSIXACL))
711 if (S_ISLNK(inode->i_mode))
714 return posix_acl_chmod(idmap, dentry, inode->i_mode);
718 * ntfs_listxattr - inode_operations::listxattr
720 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
722 struct inode *inode = d_inode(dentry);
723 struct ntfs_inode *ni = ntfs_i(inode);
726 if (!(ni->ni_flags & NI_FLAG_EA)) {
727 /* no xattr in file */
733 ret = ntfs_list_ea(ni, buffer, size);
740 static int ntfs_getxattr(const struct xattr_handler *handler, struct dentry *de,
741 struct inode *inode, const char *name, void *buffer,
745 struct ntfs_inode *ni = ntfs_i(inode);
747 /* Dispatch request. */
748 if (!strcmp(name, SYSTEM_DOS_ATTRIB)) {
749 /* system.dos_attrib */
752 } else if (size < sizeof(u8)) {
756 *(u8 *)buffer = le32_to_cpu(ni->std_fa);
761 if (!strcmp(name, SYSTEM_NTFS_ATTRIB) ||
762 !strcmp(name, SYSTEM_NTFS_ATTRIB_BE)) {
763 /* system.ntfs_attrib */
766 } else if (size < sizeof(u32)) {
770 *(u32 *)buffer = le32_to_cpu(ni->std_fa);
771 if (!strcmp(name, SYSTEM_NTFS_ATTRIB_BE))
772 *(__be32 *)buffer = cpu_to_be32(*(u32 *)buffer);
777 if (!strcmp(name, SYSTEM_NTFS_SECURITY)) {
778 /* system.ntfs_security*/
779 struct SECURITY_DESCRIPTOR_RELATIVE *sd = NULL;
782 if (!is_ntfs3(ni->mi.sbi)) {
783 /* We should get nt4 security. */
786 } else if (le32_to_cpu(ni->std_security_id) <
792 err = ntfs_get_security_by_id(ni->mi.sbi, ni->std_security_id,
797 if (!is_sd_valid(sd, sd_size)) {
800 "looks like you get incorrect security descriptor id=%u",
801 ni->std_security_id);
806 } else if (size < sd_size) {
810 memcpy(buffer, sd, sd_size);
816 /* Deal with NTFS extended attribute. */
817 err = ntfs_get_ea(inode, name, strlen(name), buffer, size, NULL);
824 * ntfs_setxattr - inode_operations::setxattr
826 static noinline int ntfs_setxattr(const struct xattr_handler *handler,
827 struct mnt_idmap *idmap, struct dentry *de,
828 struct inode *inode, const char *name,
829 const void *value, size_t size, int flags)
832 struct ntfs_inode *ni = ntfs_i(inode);
833 enum FILE_ATTRIBUTE new_fa;
835 /* Dispatch request. */
836 if (!strcmp(name, SYSTEM_DOS_ATTRIB)) {
837 if (sizeof(u8) != size)
839 new_fa = cpu_to_le32(*(u8 *)value);
843 if (!strcmp(name, SYSTEM_NTFS_ATTRIB) ||
844 !strcmp(name, SYSTEM_NTFS_ATTRIB_BE)) {
845 if (size != sizeof(u32))
847 if (!strcmp(name, SYSTEM_NTFS_ATTRIB_BE))
848 new_fa = cpu_to_le32(be32_to_cpu(*(__be32 *)value));
850 new_fa = cpu_to_le32(*(u32 *)value);
852 if (S_ISREG(inode->i_mode)) {
853 /* Process compressed/sparsed in special way. */
855 err = ni_new_attr_flags(ni, new_fa);
862 * Thanks Mark Harmstone:
863 * Keep directory bit consistency.
865 if (S_ISDIR(inode->i_mode))
866 new_fa |= FILE_ATTRIBUTE_DIRECTORY;
868 new_fa &= ~FILE_ATTRIBUTE_DIRECTORY;
870 if (ni->std_fa != new_fa) {
872 if (new_fa & FILE_ATTRIBUTE_READONLY)
873 inode->i_mode &= ~0222;
875 inode->i_mode |= 0222;
876 /* Std attribute always in primary record. */
878 mark_inode_dirty(inode);
885 if (!strcmp(name, SYSTEM_NTFS_SECURITY)) {
886 /* system.ntfs_security*/
889 struct ATTR_STD_INFO5 *std;
891 if (!is_ntfs3(ni->mi.sbi)) {
893 * We should replace ATTR_SECURE.
894 * Skip this way cause it is nt4 feature.
900 if (!is_sd_valid(value, size)) {
904 "you try to set invalid security descriptor");
908 err = ntfs_insert_security(ni->mi.sbi, value, size,
909 &security_id, &inserted);
917 } else if (std->security_id != security_id) {
918 std->security_id = ni->std_security_id = security_id;
919 /* Std attribute always in primary record. */
921 mark_inode_dirty(&ni->vfs_inode);
927 /* Deal with NTFS extended attribute. */
928 err = ntfs_set_ea(inode, name, strlen(name), value, size, flags, 0,
932 inode_set_ctime_current(inode);
933 mark_inode_dirty(inode);
941 * save uid/gid/mode in xattr
943 int ntfs_save_wsl_perm(struct inode *inode, __le16 *ea_size)
947 struct ntfs_inode *ni = ntfs_i(inode);
950 value = cpu_to_le32(i_uid_read(inode));
951 err = ntfs_set_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value,
952 sizeof(value), 0, true, ea_size);
956 value = cpu_to_le32(i_gid_read(inode));
957 err = ntfs_set_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value,
958 sizeof(value), 0, true, ea_size);
962 value = cpu_to_le32(inode->i_mode);
963 err = ntfs_set_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value,
964 sizeof(value), 0, true, ea_size);
968 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
969 value = cpu_to_le32(inode->i_rdev);
970 err = ntfs_set_ea(inode, "$LXDEV", sizeof("$LXDEV") - 1, &value,
971 sizeof(value), 0, true, ea_size);
978 /* In case of error should we delete all WSL xattr? */
985 * get uid/gid/mode from xattr
986 * it is called from ntfs_iget5->ntfs_read_mft
988 void ntfs_get_wsl_perm(struct inode *inode)
993 if (ntfs_get_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value[0],
994 sizeof(value[0]), &sz) == sizeof(value[0]) &&
995 ntfs_get_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value[1],
996 sizeof(value[1]), &sz) == sizeof(value[1]) &&
997 ntfs_get_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value[2],
998 sizeof(value[2]), &sz) == sizeof(value[2])) {
999 i_uid_write(inode, (uid_t)le32_to_cpu(value[0]));
1000 i_gid_write(inode, (gid_t)le32_to_cpu(value[1]));
1001 inode->i_mode = le32_to_cpu(value[2]);
1003 if (ntfs_get_ea(inode, "$LXDEV", sizeof("$$LXDEV") - 1,
1004 &value[0], sizeof(value),
1005 &sz) == sizeof(value[0])) {
1006 inode->i_rdev = le32_to_cpu(value[0]);
1011 static bool ntfs_xattr_user_list(struct dentry *dentry)
1017 static const struct xattr_handler ntfs_other_xattr_handler = {
1019 .get = ntfs_getxattr,
1020 .set = ntfs_setxattr,
1021 .list = ntfs_xattr_user_list,
1024 const struct xattr_handler *ntfs_xattr_handlers[] = {
1025 &ntfs_other_xattr_handler,