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)
49 if (!ea_all || !bytes)
53 const struct EA_FULL *ea = Add2Ptr(ea_all, *off);
54 u32 next_off = *off + unpacked_ea_size(ea);
59 if (ea->name_len == name_len &&
60 !memcmp(ea->name, name, name_len))
64 if (next_off >= bytes)
70 * ntfs_read_ea - Read all extended attributes.
71 * @ea: New allocated memory.
72 * @info: Pointer into resident data.
74 static int ntfs_read_ea(struct ntfs_inode *ni, struct EA_FULL **ea,
75 size_t add_bytes, const struct EA_INFO **info)
78 struct ntfs_sb_info *sbi = ni->mi.sbi;
79 struct ATTR_LIST_ENTRY *le = NULL;
80 struct ATTRIB *attr_info, *attr_ea;
84 static_assert(le32_to_cpu(ATTR_EA_INFO) < le32_to_cpu(ATTR_EA));
90 ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, NULL);
92 ni_find_attr(ni, attr_info, &le, ATTR_EA, NULL, 0, NULL, NULL);
94 if (!attr_ea || !attr_info)
97 *info = resident_data_ex(attr_info, sizeof(struct EA_INFO));
101 /* Check Ea limit. */
102 size = le32_to_cpu((*info)->size);
103 if (size > sbi->ea_max_size)
106 if (attr_size(attr_ea) > sbi->ea_max_size)
109 /* Allocate memory for packed Ea. */
110 ea_p = kmalloc(size + add_bytes, GFP_NOFS);
116 } else if (attr_ea->non_res) {
117 struct runs_tree run;
121 err = attr_load_runs(attr_ea, ni, &run, NULL);
123 err = ntfs_read_run_nb(sbi, &run, 0, ea_p, size, NULL);
129 void *p = resident_data_ex(attr_ea, size);
135 memcpy(ea_p, p, size);
138 memset(Add2Ptr(ea_p, size), 0, add_bytes);
151 * Copy a list of xattrs names into the buffer
152 * provided, or compute the buffer size required.
155 * * Number of bytes used / required on
156 * * -ERRNO - on failure
158 static ssize_t ntfs_list_ea(struct ntfs_inode *ni, char *buffer,
159 size_t bytes_per_buffer)
161 const struct EA_INFO *info;
162 struct EA_FULL *ea_all = NULL;
163 const struct EA_FULL *ea;
168 err = ntfs_read_ea(ni, &ea_all, 0, &info);
172 if (!info || !ea_all)
175 size = le32_to_cpu(info->size);
177 /* Enumerate all xattrs. */
178 for (ret = 0, off = 0; off < size; off += unpacked_ea_size(ea)) {
179 ea = Add2Ptr(ea_all, off);
182 if (ret + ea->name_len + 1 > bytes_per_buffer) {
187 memcpy(buffer + ret, ea->name, ea->name_len);
188 buffer[ret + ea->name_len] = 0;
191 ret += ea->name_len + 1;
196 return err ? err : ret;
199 static int ntfs_get_ea(struct inode *inode, const char *name, size_t name_len,
200 void *buffer, size_t size, size_t *required)
202 struct ntfs_inode *ni = ntfs_i(inode);
203 const struct EA_INFO *info;
204 struct EA_FULL *ea_all = NULL;
205 const struct EA_FULL *ea;
209 if (!(ni->ni_flags & NI_FLAG_EA))
217 if (name_len > 255) {
222 err = ntfs_read_ea(ni, &ea_all, 0, &info);
229 /* Enumerate all xattrs. */
230 if (!find_ea(ea_all, le32_to_cpu(info->size), name, name_len, &off)) {
234 ea = Add2Ptr(ea_all, off);
236 len = le16_to_cpu(ea->elength);
249 memcpy(buffer, ea->name + ea->name_len + 1, len);
257 return err ? err : len;
260 static noinline int ntfs_set_ea(struct inode *inode, const char *name,
261 size_t name_len, const void *value,
262 size_t val_size, int flags)
264 struct ntfs_inode *ni = ntfs_i(inode);
265 struct ntfs_sb_info *sbi = ni->mi.sbi;
267 struct EA_INFO ea_info;
268 const struct EA_INFO *info;
269 struct EA_FULL *new_ea;
270 struct EA_FULL *ea_all = NULL;
271 size_t add, new_pack;
275 struct ATTR_LIST_ENTRY *le;
276 struct mft_inode *mi;
277 struct runs_tree ea_run;
285 if (name_len > 255) {
290 add = ALIGN(struct_size(ea_all, name, 1 + name_len + val_size), 4);
292 err = ntfs_read_ea(ni, &ea_all, add, &info);
297 memset(&ea_info, 0, sizeof(ea_info));
301 memcpy(&ea_info, info, sizeof(ea_info));
302 size = le32_to_cpu(ea_info.size);
303 size_pack = ea_info.size_pack;
306 if (info && find_ea(ea_all, size, name, name_len, &off)) {
310 if (flags & XATTR_CREATE) {
315 ea = Add2Ptr(ea_all, off);
318 * Check simple case when we try to insert xattr with the same value
319 * e.g. ntfs_save_wsl_perm
321 if (val_size && le16_to_cpu(ea->elength) == val_size &&
322 !memcmp(ea->name + ea->name_len + 1, value, val_size)) {
323 /* xattr already contains the required value. */
327 /* Remove current xattr. */
328 if (ea->flags & FILE_NEED_EA)
329 le16_add_cpu(&ea_info.count, -1);
331 ea_sz = unpacked_ea_size(ea);
333 le16_add_cpu(&ea_info.size_pack, 0 - packed_ea_size(ea));
335 memmove(ea, Add2Ptr(ea, ea_sz), size - off - ea_sz);
338 memset(Add2Ptr(ea_all, size), 0, ea_sz);
340 ea_info.size = cpu_to_le32(size);
342 if ((flags & XATTR_REPLACE) && !val_size) {
347 if (flags & XATTR_REPLACE) {
353 ea_all = kzalloc(add, GFP_NOFS);
361 /* Append new xattr. */
362 new_ea = Add2Ptr(ea_all, size);
363 new_ea->size = cpu_to_le32(add);
365 new_ea->name_len = name_len;
366 new_ea->elength = cpu_to_le16(val_size);
367 memcpy(new_ea->name, name, name_len);
368 new_ea->name[name_len] = 0;
369 memcpy(new_ea->name + name_len + 1, value, val_size);
370 new_pack = le16_to_cpu(ea_info.size_pack) + packed_ea_size(new_ea);
371 ea_info.size_pack = cpu_to_le16(new_pack);
372 /* New size of ATTR_EA. */
374 ea_info.size = cpu_to_le32(size);
377 * 1. Check ea_info.size_pack for overflow.
378 * 2. New attibute size must fit value from $AttrDef
380 if (new_pack > 0xffff || size > sbi->ea_max_size) {
383 "The size of extended attributes must not exceed 64KiB");
384 err = -EFBIG; // -EINVAL?
397 err = ni_insert_resident(ni, sizeof(struct EA_INFO),
398 ATTR_EA_INFO, NULL, 0, NULL, NULL,
403 err = ni_insert_resident(ni, 0, ATTR_EA, NULL, 0, NULL, NULL,
410 err = attr_set_size(ni, ATTR_EA, NULL, 0, &ea_run, new_sz, &new_sz,
416 attr = ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, &mi);
423 /* Delete xattr, ATTR_EA_INFO */
424 ni_remove_attr_le(ni, attr, mi, le);
426 p = resident_data_ex(attr, sizeof(struct EA_INFO));
431 memcpy(p, &ea_info, sizeof(struct EA_INFO));
436 attr = ni_find_attr(ni, NULL, &le, ATTR_EA, NULL, 0, NULL, &mi);
443 /* Delete xattr, ATTR_EA */
444 ni_remove_attr_le(ni, attr, mi, le);
445 } else if (attr->non_res) {
446 err = ntfs_sb_write_run(sbi, &ea_run, 0, ea_all, size, 0);
450 p = resident_data_ex(attr, size);
455 memcpy(p, ea_all, size);
459 /* Check if we delete the last xattr. */
461 ni->ni_flags |= NI_FLAG_EA;
463 ni->ni_flags &= ~NI_FLAG_EA;
465 if (ea_info.size_pack != size_pack)
466 ni->ni_flags |= NI_FLAG_UPDATE_PARENT;
467 mark_inode_dirty(&ni->vfs_inode);
478 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
479 static struct posix_acl *ntfs_get_acl_ex(struct user_namespace *mnt_userns,
480 struct inode *inode, int type,
483 struct ntfs_inode *ni = ntfs_i(inode);
486 struct posix_acl *acl;
491 /* Allocate PATH_MAX bytes. */
494 return ERR_PTR(-ENOMEM);
496 /* Possible values of 'type' was already checked above. */
497 if (type == ACL_TYPE_ACCESS) {
498 name = XATTR_NAME_POSIX_ACL_ACCESS;
499 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
501 name = XATTR_NAME_POSIX_ACL_DEFAULT;
502 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
508 err = ntfs_get_ea(inode, name, name_len, buf, PATH_MAX, &req);
513 /* Translate extended attribute to acl. */
515 acl = posix_acl_from_xattr(mnt_userns, buf, err);
516 } else if (err == -ENODATA) {
523 set_cached_acl(inode, type, acl);
531 * ntfs_get_acl - inode_operations::get_acl
533 struct posix_acl *ntfs_get_acl(struct inode *inode, int type, bool rcu)
536 return ERR_PTR(-ECHILD);
538 /* TODO: init_user_ns? */
539 return ntfs_get_acl_ex(&init_user_ns, inode, type, 0);
542 static noinline int ntfs_set_acl_ex(struct user_namespace *mnt_userns,
543 struct inode *inode, struct posix_acl *acl,
547 size_t size, name_len;
552 if (S_ISLNK(inode->i_mode))
556 case ACL_TYPE_ACCESS:
558 umode_t mode = inode->i_mode;
560 err = posix_acl_update_mode(mnt_userns, inode, &mode,
565 if (inode->i_mode != mode) {
566 inode->i_mode = mode;
567 mark_inode_dirty(inode);
570 name = XATTR_NAME_POSIX_ACL_ACCESS;
571 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
574 case ACL_TYPE_DEFAULT:
575 if (!S_ISDIR(inode->i_mode))
576 return acl ? -EACCES : 0;
577 name = XATTR_NAME_POSIX_ACL_DEFAULT;
578 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
586 /* Remove xattr if it can be presented via mode. */
589 flags = XATTR_REPLACE;
591 size = posix_acl_xattr_size(acl->a_count);
592 value = kmalloc(size, GFP_NOFS);
595 err = posix_acl_to_xattr(mnt_userns, acl, value, size);
601 err = ntfs_set_ea(inode, name, name_len, value, size, flags);
602 if (err == -ENODATA && !size)
603 err = 0; /* Removing non existed xattr. */
605 set_cached_acl(inode, type, acl);
614 * ntfs_set_acl - inode_operations::set_acl
616 int ntfs_set_acl(struct user_namespace *mnt_userns, struct inode *inode,
617 struct posix_acl *acl, int type)
619 return ntfs_set_acl_ex(mnt_userns, inode, acl, type);
623 * ntfs_init_acl - Initialize the ACLs of a new inode.
625 * Called from ntfs_create_inode().
627 int ntfs_init_acl(struct user_namespace *mnt_userns, struct inode *inode,
630 struct posix_acl *default_acl, *acl;
633 err = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
638 err = ntfs_set_acl_ex(mnt_userns, inode, default_acl,
640 posix_acl_release(default_acl);
642 inode->i_default_acl = NULL;
649 err = ntfs_set_acl_ex(mnt_userns, inode, acl,
651 posix_acl_release(acl);
659 * ntfs_acl_chmod - Helper for ntfs3_setattr().
661 int ntfs_acl_chmod(struct user_namespace *mnt_userns, struct inode *inode)
663 struct super_block *sb = inode->i_sb;
665 if (!(sb->s_flags & SB_POSIXACL))
668 if (S_ISLNK(inode->i_mode))
671 return posix_acl_chmod(mnt_userns, inode, inode->i_mode);
675 * ntfs_permission - inode_operations::permission
677 int ntfs_permission(struct user_namespace *mnt_userns, struct inode *inode,
680 if (ntfs_sb(inode->i_sb)->options->noacsrules) {
681 /* "No access rules" mode - Allow all changes. */
685 return generic_permission(mnt_userns, inode, mask);
689 * ntfs_listxattr - inode_operations::listxattr
691 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
693 struct inode *inode = d_inode(dentry);
694 struct ntfs_inode *ni = ntfs_i(inode);
697 if (!(ni->ni_flags & NI_FLAG_EA)) {
698 /* no xattr in file */
704 ret = ntfs_list_ea(ni, buffer, size);
711 static int ntfs_getxattr(const struct xattr_handler *handler, struct dentry *de,
712 struct inode *inode, const char *name, void *buffer,
716 struct ntfs_inode *ni = ntfs_i(inode);
717 size_t name_len = strlen(name);
719 /* Dispatch request. */
720 if (name_len == sizeof(SYSTEM_DOS_ATTRIB) - 1 &&
721 !memcmp(name, SYSTEM_DOS_ATTRIB, sizeof(SYSTEM_DOS_ATTRIB))) {
722 /* system.dos_attrib */
725 } else if (size < sizeof(u8)) {
729 *(u8 *)buffer = le32_to_cpu(ni->std_fa);
734 if (name_len == sizeof(SYSTEM_NTFS_ATTRIB) - 1 &&
735 !memcmp(name, SYSTEM_NTFS_ATTRIB, sizeof(SYSTEM_NTFS_ATTRIB))) {
736 /* system.ntfs_attrib */
739 } else if (size < sizeof(u32)) {
743 *(u32 *)buffer = le32_to_cpu(ni->std_fa);
748 if (name_len == sizeof(SYSTEM_NTFS_SECURITY) - 1 &&
749 !memcmp(name, SYSTEM_NTFS_SECURITY, sizeof(SYSTEM_NTFS_SECURITY))) {
750 /* system.ntfs_security*/
751 struct SECURITY_DESCRIPTOR_RELATIVE *sd = NULL;
754 if (!is_ntfs3(ni->mi.sbi)) {
755 /* We should get nt4 security. */
758 } else if (le32_to_cpu(ni->std_security_id) <
764 err = ntfs_get_security_by_id(ni->mi.sbi, ni->std_security_id,
769 if (!is_sd_valid(sd, sd_size)) {
772 "looks like you get incorrect security descriptor id=%u",
773 ni->std_security_id);
778 } else if (size < sd_size) {
782 memcpy(buffer, sd, sd_size);
788 /* Deal with NTFS extended attribute. */
789 err = ntfs_get_ea(inode, name, name_len, buffer, size, NULL);
796 * ntfs_setxattr - inode_operations::setxattr
798 static noinline int ntfs_setxattr(const struct xattr_handler *handler,
799 struct user_namespace *mnt_userns,
800 struct dentry *de, struct inode *inode,
801 const char *name, const void *value,
802 size_t size, int flags)
805 struct ntfs_inode *ni = ntfs_i(inode);
806 size_t name_len = strlen(name);
807 enum FILE_ATTRIBUTE new_fa;
809 /* Dispatch request. */
810 if (name_len == sizeof(SYSTEM_DOS_ATTRIB) - 1 &&
811 !memcmp(name, SYSTEM_DOS_ATTRIB, sizeof(SYSTEM_DOS_ATTRIB))) {
812 if (sizeof(u8) != size)
814 new_fa = cpu_to_le32(*(u8 *)value);
818 if (name_len == sizeof(SYSTEM_NTFS_ATTRIB) - 1 &&
819 !memcmp(name, SYSTEM_NTFS_ATTRIB, sizeof(SYSTEM_NTFS_ATTRIB))) {
820 if (size != sizeof(u32))
822 new_fa = cpu_to_le32(*(u32 *)value);
824 if (S_ISREG(inode->i_mode)) {
825 /* Process compressed/sparsed in special way. */
827 err = ni_new_attr_flags(ni, new_fa);
834 * Thanks Mark Harmstone:
835 * Keep directory bit consistency.
837 if (S_ISDIR(inode->i_mode))
838 new_fa |= FILE_ATTRIBUTE_DIRECTORY;
840 new_fa &= ~FILE_ATTRIBUTE_DIRECTORY;
842 if (ni->std_fa != new_fa) {
844 if (new_fa & FILE_ATTRIBUTE_READONLY)
845 inode->i_mode &= ~0222;
847 inode->i_mode |= 0222;
848 /* Std attribute always in primary record. */
850 mark_inode_dirty(inode);
857 if (name_len == sizeof(SYSTEM_NTFS_SECURITY) - 1 &&
858 !memcmp(name, SYSTEM_NTFS_SECURITY, sizeof(SYSTEM_NTFS_SECURITY))) {
859 /* system.ntfs_security*/
862 struct ATTR_STD_INFO5 *std;
864 if (!is_ntfs3(ni->mi.sbi)) {
866 * We should replace ATTR_SECURE.
867 * Skip this way cause it is nt4 feature.
873 if (!is_sd_valid(value, size)) {
877 "you try to set invalid security descriptor");
881 err = ntfs_insert_security(ni->mi.sbi, value, size,
882 &security_id, &inserted);
890 } else if (std->security_id != security_id) {
891 std->security_id = ni->std_security_id = security_id;
892 /* Std attribute always in primary record. */
894 mark_inode_dirty(&ni->vfs_inode);
900 /* Deal with NTFS extended attribute. */
901 err = ntfs_set_ea(inode, name, name_len, value, size, flags);
910 * save uid/gid/mode in xattr
912 int ntfs_save_wsl_perm(struct inode *inode)
917 /* TODO: refactor this, so we don't lock 4 times in ntfs_set_ea */
918 value = cpu_to_le32(i_uid_read(inode));
919 err = ntfs_set_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value,
924 value = cpu_to_le32(i_gid_read(inode));
925 err = ntfs_set_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value,
930 value = cpu_to_le32(inode->i_mode);
931 err = ntfs_set_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value,
936 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
937 value = cpu_to_le32(inode->i_rdev);
938 err = ntfs_set_ea(inode, "$LXDEV", sizeof("$LXDEV") - 1, &value,
945 /* In case of error should we delete all WSL xattr? */
952 * get uid/gid/mode from xattr
953 * it is called from ntfs_iget5->ntfs_read_mft
955 void ntfs_get_wsl_perm(struct inode *inode)
960 if (ntfs_get_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value[0],
961 sizeof(value[0]), &sz) == sizeof(value[0]) &&
962 ntfs_get_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value[1],
963 sizeof(value[1]), &sz) == sizeof(value[1]) &&
964 ntfs_get_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value[2],
965 sizeof(value[2]), &sz) == sizeof(value[2])) {
966 i_uid_write(inode, (uid_t)le32_to_cpu(value[0]));
967 i_gid_write(inode, (gid_t)le32_to_cpu(value[1]));
968 inode->i_mode = le32_to_cpu(value[2]);
970 if (ntfs_get_ea(inode, "$LXDEV", sizeof("$$LXDEV") - 1,
971 &value[0], sizeof(value),
972 &sz) == sizeof(value[0])) {
973 inode->i_rdev = le32_to_cpu(value[0]);
978 static bool ntfs_xattr_user_list(struct dentry *dentry)
984 static const struct xattr_handler ntfs_xattr_handler = {
986 .get = ntfs_getxattr,
987 .set = ntfs_setxattr,
988 .list = ntfs_xattr_user_list,
991 const struct xattr_handler *ntfs_xattr_handlers[] = {