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. */
214 for (ret = 0, off = 0; off < size; off += ea_size) {
215 ea = Add2Ptr(ea_all, off);
216 ea_size = unpacked_ea_size(ea);
222 if (ret + ea->name_len + 1 > bytes_per_buffer) {
227 memcpy(buffer + ret, ea->name, ea->name_len);
228 buffer[ret + ea->name_len] = 0;
231 ret += ea->name_len + 1;
236 return err ? err : ret;
239 static int ntfs_get_ea(struct inode *inode, const char *name, size_t name_len,
240 void *buffer, size_t size, size_t *required)
242 struct ntfs_inode *ni = ntfs_i(inode);
243 const struct EA_INFO *info;
244 struct EA_FULL *ea_all = NULL;
245 const struct EA_FULL *ea;
249 if (!(ni->ni_flags & NI_FLAG_EA))
257 if (name_len > 255) {
262 err = ntfs_read_ea(ni, &ea_all, 0, &info);
269 /* Enumerate all xattrs. */
270 if (!find_ea(ea_all, le32_to_cpu(info->size), name, name_len, &off,
275 ea = Add2Ptr(ea_all, off);
277 len = le16_to_cpu(ea->elength);
290 memcpy(buffer, ea->name + ea->name_len + 1, len);
298 return err ? err : len;
301 static noinline int ntfs_set_ea(struct inode *inode, const char *name,
302 size_t name_len, const void *value,
303 size_t val_size, int flags, bool locked,
306 struct ntfs_inode *ni = ntfs_i(inode);
307 struct ntfs_sb_info *sbi = ni->mi.sbi;
309 struct EA_INFO ea_info;
310 const struct EA_INFO *info;
311 struct EA_FULL *new_ea;
312 struct EA_FULL *ea_all = NULL;
313 size_t add, new_pack;
314 u32 off, size, ea_sz;
317 struct ATTR_LIST_ENTRY *le;
318 struct mft_inode *mi;
319 struct runs_tree ea_run;
328 if (name_len > 255) {
333 add = ALIGN(struct_size(ea_all, name, 1 + name_len + val_size), 4);
335 err = ntfs_read_ea(ni, &ea_all, add, &info);
340 memset(&ea_info, 0, sizeof(ea_info));
344 memcpy(&ea_info, info, sizeof(ea_info));
345 size = le32_to_cpu(ea_info.size);
346 size_pack = ea_info.size_pack;
349 if (info && find_ea(ea_all, size, name, name_len, &off, &ea_sz)) {
352 if (flags & XATTR_CREATE) {
357 ea = Add2Ptr(ea_all, off);
360 * Check simple case when we try to insert xattr with the same value
361 * e.g. ntfs_save_wsl_perm
363 if (val_size && le16_to_cpu(ea->elength) == val_size &&
364 !memcmp(ea->name + ea->name_len + 1, value, val_size)) {
365 /* xattr already contains the required value. */
369 /* Remove current xattr. */
370 if (ea->flags & FILE_NEED_EA)
371 le16_add_cpu(&ea_info.count, -1);
373 le16_add_cpu(&ea_info.size_pack, 0 - packed_ea_size(ea));
375 memmove(ea, Add2Ptr(ea, ea_sz), size - off - ea_sz);
378 memset(Add2Ptr(ea_all, size), 0, ea_sz);
380 ea_info.size = cpu_to_le32(size);
382 if ((flags & XATTR_REPLACE) && !val_size) {
387 if (flags & XATTR_REPLACE) {
393 ea_all = kzalloc(add, GFP_NOFS);
401 /* Append new xattr. */
402 new_ea = Add2Ptr(ea_all, size);
403 new_ea->size = cpu_to_le32(add);
405 new_ea->name_len = name_len;
406 new_ea->elength = cpu_to_le16(val_size);
407 memcpy(new_ea->name, name, name_len);
408 new_ea->name[name_len] = 0;
409 memcpy(new_ea->name + name_len + 1, value, val_size);
410 new_pack = le16_to_cpu(ea_info.size_pack) + packed_ea_size(new_ea);
411 ea_info.size_pack = cpu_to_le16(new_pack);
412 /* New size of ATTR_EA. */
414 ea_info.size = cpu_to_le32(size);
417 * 1. Check ea_info.size_pack for overflow.
418 * 2. New attribute size must fit value from $AttrDef
420 if (new_pack > 0xffff || size > sbi->ea_max_size) {
423 "The size of extended attributes must not exceed 64KiB");
424 err = -EFBIG; // -EINVAL?
437 err = ni_insert_resident(ni, sizeof(struct EA_INFO),
438 ATTR_EA_INFO, NULL, 0, NULL, NULL,
443 err = ni_insert_resident(ni, 0, ATTR_EA, NULL, 0, NULL, NULL,
450 err = attr_set_size(ni, ATTR_EA, NULL, 0, &ea_run, new_sz, &new_sz,
456 attr = ni_find_attr(ni, NULL, &le, ATTR_EA_INFO, NULL, 0, NULL, &mi);
463 /* Delete xattr, ATTR_EA_INFO */
464 ni_remove_attr_le(ni, attr, mi, le);
466 p = resident_data_ex(attr, sizeof(struct EA_INFO));
471 memcpy(p, &ea_info, sizeof(struct EA_INFO));
476 attr = ni_find_attr(ni, NULL, &le, ATTR_EA, NULL, 0, NULL, &mi);
483 /* Delete xattr, ATTR_EA */
484 ni_remove_attr_le(ni, attr, mi, le);
485 } else if (attr->non_res) {
486 err = attr_load_runs_range(ni, ATTR_EA, NULL, 0, &ea_run, 0,
491 err = ntfs_sb_write_run(sbi, &ea_run, 0, ea_all, size, 0);
495 p = resident_data_ex(attr, size);
500 memcpy(p, ea_all, size);
504 /* Check if we delete the last xattr. */
506 ni->ni_flags |= NI_FLAG_EA;
508 ni->ni_flags &= ~NI_FLAG_EA;
510 if (ea_info.size_pack != size_pack)
511 ni->ni_flags |= NI_FLAG_UPDATE_PARENT;
513 *ea_size = ea_info.size_pack;
514 mark_inode_dirty(&ni->vfs_inode);
526 #ifdef CONFIG_NTFS3_FS_POSIX_ACL
529 * ntfs_get_acl - inode_operations::get_acl
531 struct posix_acl *ntfs_get_acl(struct mnt_idmap *idmap, struct dentry *dentry,
534 struct inode *inode = d_inode(dentry);
535 struct ntfs_inode *ni = ntfs_i(inode);
538 struct posix_acl *acl;
543 /* Allocate PATH_MAX bytes. */
546 return ERR_PTR(-ENOMEM);
548 /* Possible values of 'type' was already checked above. */
549 if (type == ACL_TYPE_ACCESS) {
550 name = XATTR_NAME_POSIX_ACL_ACCESS;
551 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
553 name = XATTR_NAME_POSIX_ACL_DEFAULT;
554 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
559 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);
580 static noinline int ntfs_set_acl_ex(struct mnt_idmap *idmap,
581 struct inode *inode, struct posix_acl *acl,
582 int type, bool init_acl)
585 size_t size, name_len;
591 if (S_ISLNK(inode->i_mode))
594 mode = inode->i_mode;
596 case ACL_TYPE_ACCESS:
597 /* Do not change i_mode if we are in init_acl */
598 if (acl && !init_acl) {
599 err = posix_acl_update_mode(idmap, inode, &mode, &acl);
603 name = XATTR_NAME_POSIX_ACL_ACCESS;
604 name_len = sizeof(XATTR_NAME_POSIX_ACL_ACCESS) - 1;
607 case ACL_TYPE_DEFAULT:
608 if (!S_ISDIR(inode->i_mode))
609 return acl ? -EACCES : 0;
610 name = XATTR_NAME_POSIX_ACL_DEFAULT;
611 name_len = sizeof(XATTR_NAME_POSIX_ACL_DEFAULT) - 1;
619 /* Remove xattr if it can be presented via mode. */
622 flags = XATTR_REPLACE;
624 size = posix_acl_xattr_size(acl->a_count);
625 value = kmalloc(size, GFP_NOFS);
628 err = posix_acl_to_xattr(&init_user_ns, acl, value, size);
634 err = ntfs_set_ea(inode, name, name_len, value, size, flags, 0, NULL);
635 if (err == -ENODATA && !size)
636 err = 0; /* Removing non existed xattr. */
638 set_cached_acl(inode, type, acl);
639 inode->i_mode = mode;
640 inode->i_ctime = current_time(inode);
641 mark_inode_dirty(inode);
651 * ntfs_set_acl - inode_operations::set_acl
653 int ntfs_set_acl(struct mnt_idmap *idmap, struct dentry *dentry,
654 struct posix_acl *acl, int type)
656 return ntfs_set_acl_ex(idmap, d_inode(dentry), acl, type, false);
660 * ntfs_init_acl - Initialize the ACLs of a new inode.
662 * Called from ntfs_create_inode().
664 int ntfs_init_acl(struct mnt_idmap *idmap, struct inode *inode,
667 struct posix_acl *default_acl, *acl;
670 err = posix_acl_create(dir, &inode->i_mode, &default_acl, &acl);
675 err = ntfs_set_acl_ex(idmap, inode, default_acl,
676 ACL_TYPE_DEFAULT, true);
677 posix_acl_release(default_acl);
679 inode->i_default_acl = NULL;
684 err = ntfs_set_acl_ex(idmap, inode, acl,
685 ACL_TYPE_ACCESS, true);
686 posix_acl_release(acl);
696 * ntfs_acl_chmod - Helper for ntfs3_setattr().
698 int ntfs_acl_chmod(struct mnt_idmap *idmap, struct dentry *dentry)
700 struct inode *inode = d_inode(dentry);
701 struct super_block *sb = inode->i_sb;
703 if (!(sb->s_flags & SB_POSIXACL))
706 if (S_ISLNK(inode->i_mode))
709 return posix_acl_chmod(idmap, dentry, inode->i_mode);
713 * ntfs_listxattr - inode_operations::listxattr
715 ssize_t ntfs_listxattr(struct dentry *dentry, char *buffer, size_t size)
717 struct inode *inode = d_inode(dentry);
718 struct ntfs_inode *ni = ntfs_i(inode);
721 if (!(ni->ni_flags & NI_FLAG_EA)) {
722 /* no xattr in file */
728 ret = ntfs_list_ea(ni, buffer, size);
735 static int ntfs_getxattr(const struct xattr_handler *handler, struct dentry *de,
736 struct inode *inode, const char *name, void *buffer,
740 struct ntfs_inode *ni = ntfs_i(inode);
742 /* Dispatch request. */
743 if (!strcmp(name, SYSTEM_DOS_ATTRIB)) {
744 /* system.dos_attrib */
747 } else if (size < sizeof(u8)) {
751 *(u8 *)buffer = le32_to_cpu(ni->std_fa);
756 if (!strcmp(name, SYSTEM_NTFS_ATTRIB) ||
757 !strcmp(name, SYSTEM_NTFS_ATTRIB_BE)) {
758 /* system.ntfs_attrib */
761 } else if (size < sizeof(u32)) {
765 *(u32 *)buffer = le32_to_cpu(ni->std_fa);
766 if (!strcmp(name, SYSTEM_NTFS_ATTRIB_BE))
767 *(__be32 *)buffer = cpu_to_be32(*(u32 *)buffer);
772 if (!strcmp(name, SYSTEM_NTFS_SECURITY)) {
773 /* system.ntfs_security*/
774 struct SECURITY_DESCRIPTOR_RELATIVE *sd = NULL;
777 if (!is_ntfs3(ni->mi.sbi)) {
778 /* We should get nt4 security. */
781 } else if (le32_to_cpu(ni->std_security_id) <
787 err = ntfs_get_security_by_id(ni->mi.sbi, ni->std_security_id,
792 if (!is_sd_valid(sd, sd_size)) {
795 "looks like you get incorrect security descriptor id=%u",
796 ni->std_security_id);
801 } else if (size < sd_size) {
805 memcpy(buffer, sd, sd_size);
811 /* Deal with NTFS extended attribute. */
812 err = ntfs_get_ea(inode, name, strlen(name), buffer, size, NULL);
819 * ntfs_setxattr - inode_operations::setxattr
821 static noinline int ntfs_setxattr(const struct xattr_handler *handler,
822 struct mnt_idmap *idmap, struct dentry *de,
823 struct inode *inode, const char *name,
824 const void *value, size_t size, int flags)
827 struct ntfs_inode *ni = ntfs_i(inode);
828 enum FILE_ATTRIBUTE new_fa;
830 /* Dispatch request. */
831 if (!strcmp(name, SYSTEM_DOS_ATTRIB)) {
832 if (sizeof(u8) != size)
834 new_fa = cpu_to_le32(*(u8 *)value);
838 if (!strcmp(name, SYSTEM_NTFS_ATTRIB) ||
839 !strcmp(name, SYSTEM_NTFS_ATTRIB_BE)) {
840 if (size != sizeof(u32))
842 if (!strcmp(name, SYSTEM_NTFS_ATTRIB_BE))
843 new_fa = cpu_to_le32(be32_to_cpu(*(__be32 *)value));
845 new_fa = cpu_to_le32(*(u32 *)value);
847 if (S_ISREG(inode->i_mode)) {
848 /* Process compressed/sparsed in special way. */
850 err = ni_new_attr_flags(ni, new_fa);
857 * Thanks Mark Harmstone:
858 * Keep directory bit consistency.
860 if (S_ISDIR(inode->i_mode))
861 new_fa |= FILE_ATTRIBUTE_DIRECTORY;
863 new_fa &= ~FILE_ATTRIBUTE_DIRECTORY;
865 if (ni->std_fa != new_fa) {
867 if (new_fa & FILE_ATTRIBUTE_READONLY)
868 inode->i_mode &= ~0222;
870 inode->i_mode |= 0222;
871 /* Std attribute always in primary record. */
873 mark_inode_dirty(inode);
880 if (!strcmp(name, SYSTEM_NTFS_SECURITY)) {
881 /* system.ntfs_security*/
884 struct ATTR_STD_INFO5 *std;
886 if (!is_ntfs3(ni->mi.sbi)) {
888 * We should replace ATTR_SECURE.
889 * Skip this way cause it is nt4 feature.
895 if (!is_sd_valid(value, size)) {
899 "you try to set invalid security descriptor");
903 err = ntfs_insert_security(ni->mi.sbi, value, size,
904 &security_id, &inserted);
912 } else if (std->security_id != security_id) {
913 std->security_id = ni->std_security_id = security_id;
914 /* Std attribute always in primary record. */
916 mark_inode_dirty(&ni->vfs_inode);
922 /* Deal with NTFS extended attribute. */
923 err = ntfs_set_ea(inode, name, strlen(name), value, size, flags, 0,
927 inode->i_ctime = current_time(inode);
928 mark_inode_dirty(inode);
936 * save uid/gid/mode in xattr
938 int ntfs_save_wsl_perm(struct inode *inode, __le16 *ea_size)
942 struct ntfs_inode *ni = ntfs_i(inode);
945 value = cpu_to_le32(i_uid_read(inode));
946 err = ntfs_set_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value,
947 sizeof(value), 0, true, ea_size);
951 value = cpu_to_le32(i_gid_read(inode));
952 err = ntfs_set_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value,
953 sizeof(value), 0, true, ea_size);
957 value = cpu_to_le32(inode->i_mode);
958 err = ntfs_set_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value,
959 sizeof(value), 0, true, ea_size);
963 if (S_ISCHR(inode->i_mode) || S_ISBLK(inode->i_mode)) {
964 value = cpu_to_le32(inode->i_rdev);
965 err = ntfs_set_ea(inode, "$LXDEV", sizeof("$LXDEV") - 1, &value,
966 sizeof(value), 0, true, ea_size);
973 /* In case of error should we delete all WSL xattr? */
980 * get uid/gid/mode from xattr
981 * it is called from ntfs_iget5->ntfs_read_mft
983 void ntfs_get_wsl_perm(struct inode *inode)
988 if (ntfs_get_ea(inode, "$LXUID", sizeof("$LXUID") - 1, &value[0],
989 sizeof(value[0]), &sz) == sizeof(value[0]) &&
990 ntfs_get_ea(inode, "$LXGID", sizeof("$LXGID") - 1, &value[1],
991 sizeof(value[1]), &sz) == sizeof(value[1]) &&
992 ntfs_get_ea(inode, "$LXMOD", sizeof("$LXMOD") - 1, &value[2],
993 sizeof(value[2]), &sz) == sizeof(value[2])) {
994 i_uid_write(inode, (uid_t)le32_to_cpu(value[0]));
995 i_gid_write(inode, (gid_t)le32_to_cpu(value[1]));
996 inode->i_mode = le32_to_cpu(value[2]);
998 if (ntfs_get_ea(inode, "$LXDEV", sizeof("$$LXDEV") - 1,
999 &value[0], sizeof(value),
1000 &sz) == sizeof(value[0])) {
1001 inode->i_rdev = le32_to_cpu(value[0]);
1006 static bool ntfs_xattr_user_list(struct dentry *dentry)
1012 static const struct xattr_handler ntfs_other_xattr_handler = {
1014 .get = ntfs_getxattr,
1015 .set = ntfs_setxattr,
1016 .list = ntfs_xattr_user_list,
1019 const struct xattr_handler *ntfs_xattr_handlers[] = {
1020 &ntfs_other_xattr_handler,