1 // SPDX-License-Identifier: LGPL-2.1
4 * Copyright (c) International Business Machines Corp., 2003, 2007
5 * Author(s): Steve French (sfrench@us.ibm.com)
10 #include <linux/posix_acl_xattr.h>
11 #include <linux/slab.h>
12 #include <linux/xattr.h>
16 #include "cifsproto.h"
17 #include "cifs_debug.h"
18 #include "cifs_fs_sb.h"
19 #include "cifs_unicode.h"
20 #include "cifs_ioctl.h"
22 #define MAX_EA_VALUE_SIZE CIFSMaxBufSize
23 #define CIFS_XATTR_CIFS_ACL "system.cifs_acl" /* DACL only */
24 #define CIFS_XATTR_CIFS_NTSD "system.cifs_ntsd" /* owner plus DACL */
25 #define CIFS_XATTR_CIFS_NTSD_FULL "system.cifs_ntsd_full" /* owner/DACL/SACL */
26 #define CIFS_XATTR_ATTRIB "cifs.dosattrib" /* full name: user.cifs.dosattrib */
27 #define CIFS_XATTR_CREATETIME "cifs.creationtime" /* user.cifs.creationtime */
29 * Although these three are just aliases for the above, need to move away from
30 * confusing users and using the 20+ year old term 'cifs' when it is no longer
31 * secure, replaced by SMB2 (then even more highly secure SMB3) many years ago
33 #define SMB3_XATTR_CIFS_ACL "system.smb3_acl" /* DACL only */
34 #define SMB3_XATTR_CIFS_NTSD "system.smb3_ntsd" /* owner plus DACL */
35 #define SMB3_XATTR_CIFS_NTSD_FULL "system.smb3_ntsd_full" /* owner/DACL/SACL */
36 #define SMB3_XATTR_ATTRIB "smb3.dosattrib" /* full name: user.smb3.dosattrib */
37 #define SMB3_XATTR_CREATETIME "smb3.creationtime" /* user.smb3.creationtime */
38 /* BB need to add server (Samba e.g) support for security and trusted prefix */
40 enum { XATTR_USER, XATTR_CIFS_ACL, XATTR_ACL_ACCESS, XATTR_ACL_DEFAULT,
41 XATTR_CIFS_NTSD, XATTR_CIFS_NTSD_FULL };
43 static int cifs_attrib_set(unsigned int xid, struct cifs_tcon *pTcon,
44 struct inode *inode, const char *full_path,
45 const void *value, size_t size)
47 ssize_t rc = -EOPNOTSUPP;
48 __u32 *pattrib = (__u32 *)value;
50 FILE_BASIC_INFO info_buf;
52 if ((value == NULL) || (size != sizeof(__u32)))
55 memset(&info_buf, 0, sizeof(info_buf));
57 info_buf.Attributes = cpu_to_le32(attrib);
58 if (pTcon->ses->server->ops->set_file_info)
59 rc = pTcon->ses->server->ops->set_file_info(inode, full_path,
62 CIFS_I(inode)->cifsAttrs = attrib;
67 static int cifs_creation_time_set(unsigned int xid, struct cifs_tcon *pTcon,
68 struct inode *inode, const char *full_path,
69 const void *value, size_t size)
71 ssize_t rc = -EOPNOTSUPP;
72 __u64 *pcreation_time = (__u64 *)value;
74 FILE_BASIC_INFO info_buf;
76 if ((value == NULL) || (size != sizeof(__u64)))
79 memset(&info_buf, 0, sizeof(info_buf));
80 creation_time = *pcreation_time;
81 info_buf.CreationTime = cpu_to_le64(creation_time);
82 if (pTcon->ses->server->ops->set_file_info)
83 rc = pTcon->ses->server->ops->set_file_info(inode, full_path,
86 CIFS_I(inode)->createtime = creation_time;
91 static int cifs_xattr_set(const struct xattr_handler *handler,
92 struct mnt_idmap *idmap,
93 struct dentry *dentry, struct inode *inode,
94 const char *name, const void *value,
95 size_t size, int flags)
99 struct super_block *sb = dentry->d_sb;
100 struct cifs_sb_info *cifs_sb = CIFS_SB(sb);
101 struct tcon_link *tlink;
102 struct cifs_tcon *pTcon;
103 const char *full_path;
106 tlink = cifs_sb_tlink(cifs_sb);
108 return PTR_ERR(tlink);
109 pTcon = tlink_tcon(tlink);
112 page = alloc_dentry_path();
114 full_path = build_path_from_dentry(dentry, page);
115 if (IS_ERR(full_path)) {
116 rc = PTR_ERR(full_path);
119 /* return dos attributes as pseudo xattr */
120 /* return alt name if available as pseudo attr */
122 /* if proc/fs/cifs/streamstoxattr is set then
123 search server for EAs or streams to
125 if (size > MAX_EA_VALUE_SIZE) {
126 cifs_dbg(FYI, "size of EA value too large\n");
131 switch (handler->flags) {
133 cifs_dbg(FYI, "%s:setting user xattr %s\n", __func__, name);
134 if ((strcmp(name, CIFS_XATTR_ATTRIB) == 0) ||
135 (strcmp(name, SMB3_XATTR_ATTRIB) == 0)) {
136 rc = cifs_attrib_set(xid, pTcon, inode, full_path,
138 if (rc == 0) /* force revalidate of the inode */
139 CIFS_I(inode)->time = 0;
141 } else if ((strcmp(name, CIFS_XATTR_CREATETIME) == 0) ||
142 (strcmp(name, SMB3_XATTR_CREATETIME) == 0)) {
143 rc = cifs_creation_time_set(xid, pTcon, inode,
144 full_path, value, size);
145 if (rc == 0) /* force revalidate of the inode */
146 CIFS_I(inode)->time = 0;
150 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_NO_XATTR)
153 if (pTcon->ses->server->ops->set_EA) {
154 rc = pTcon->ses->server->ops->set_EA(xid, pTcon,
155 full_path, name, value, (__u16)size,
156 cifs_sb->local_nls, cifs_sb);
158 inode_set_ctime_current(inode);
163 case XATTR_CIFS_NTSD:
164 case XATTR_CIFS_NTSD_FULL: {
165 struct cifs_ntsd *pacl;
169 pacl = kmalloc(size, GFP_KERNEL);
173 memcpy(pacl, value, size);
174 if (pTcon->ses->server->ops->set_acl) {
178 switch (handler->flags) {
179 case XATTR_CIFS_NTSD_FULL:
180 aclflags = (CIFS_ACL_OWNER |
185 case XATTR_CIFS_NTSD:
186 aclflags = (CIFS_ACL_OWNER |
192 aclflags = CIFS_ACL_DACL;
195 rc = pTcon->ses->server->ops->set_acl(pacl,
196 size, inode, full_path, aclflags);
200 if (rc == 0) /* force revalidate of the inode */
201 CIFS_I(inode)->time = 0;
209 free_dentry_path(page);
211 cifs_put_tlink(tlink);
215 static int cifs_attrib_get(struct dentry *dentry,
216 struct inode *inode, void *value,
222 rc = cifs_revalidate_dentry_attr(dentry);
227 if ((value == NULL) || (size == 0))
228 return sizeof(__u32);
229 else if (size < sizeof(__u32))
232 /* return dos attributes as pseudo xattr */
233 pattribute = (__u32 *)value;
234 *pattribute = CIFS_I(inode)->cifsAttrs;
236 return sizeof(__u32);
239 static int cifs_creation_time_get(struct dentry *dentry, struct inode *inode,
240 void *value, size_t size)
245 rc = cifs_revalidate_dentry_attr(dentry);
249 if ((value == NULL) || (size == 0))
250 return sizeof(__u64);
251 else if (size < sizeof(__u64))
254 /* return dos attributes as pseudo xattr */
255 pcreatetime = (__u64 *)value;
256 *pcreatetime = CIFS_I(inode)->createtime;
257 return sizeof(__u64);
261 static int cifs_xattr_get(const struct xattr_handler *handler,
262 struct dentry *dentry, struct inode *inode,
263 const char *name, void *value, size_t size)
265 ssize_t rc = -EOPNOTSUPP;
267 struct super_block *sb = dentry->d_sb;
268 struct cifs_sb_info *cifs_sb = CIFS_SB(sb);
269 struct tcon_link *tlink;
270 struct cifs_tcon *pTcon;
271 const char *full_path;
274 tlink = cifs_sb_tlink(cifs_sb);
276 return PTR_ERR(tlink);
277 pTcon = tlink_tcon(tlink);
280 page = alloc_dentry_path();
282 full_path = build_path_from_dentry(dentry, page);
283 if (IS_ERR(full_path)) {
284 rc = PTR_ERR(full_path);
288 /* return alt name if available as pseudo attr */
289 switch (handler->flags) {
291 cifs_dbg(FYI, "%s:querying user xattr %s\n", __func__, name);
292 if ((strcmp(name, CIFS_XATTR_ATTRIB) == 0) ||
293 (strcmp(name, SMB3_XATTR_ATTRIB) == 0)) {
294 rc = cifs_attrib_get(dentry, inode, value, size);
296 } else if ((strcmp(name, CIFS_XATTR_CREATETIME) == 0) ||
297 (strcmp(name, SMB3_XATTR_CREATETIME) == 0)) {
298 rc = cifs_creation_time_get(dentry, inode, value, size);
302 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_NO_XATTR)
305 if (pTcon->ses->server->ops->query_all_EAs)
306 rc = pTcon->ses->server->ops->query_all_EAs(xid, pTcon,
307 full_path, name, value, size, cifs_sb);
311 case XATTR_CIFS_NTSD:
312 case XATTR_CIFS_NTSD_FULL: {
314 * fetch owner, DACL, and SACL if asked for full descriptor,
315 * fetch owner and DACL otherwise
317 u32 acllen, extra_info;
318 struct cifs_ntsd *pacl;
320 if (pTcon->ses->server->ops->get_acl == NULL)
321 goto out; /* rc already EOPNOTSUPP */
323 if (handler->flags == XATTR_CIFS_NTSD_FULL) {
324 extra_info = SACL_SECINFO;
328 pacl = pTcon->ses->server->ops->get_acl(cifs_sb,
329 inode, full_path, &acllen, extra_info);
332 cifs_dbg(VFS, "%s: error %zd getting sec desc\n",
339 memcpy(value, pacl, acllen);
348 /* We could add an additional check for streams ie
349 if proc/fs/cifs/streamstoxattr is set then
350 search server for EAs or streams to
357 free_dentry_path(page);
359 cifs_put_tlink(tlink);
363 ssize_t cifs_listxattr(struct dentry *direntry, char *data, size_t buf_size)
365 ssize_t rc = -EOPNOTSUPP;
367 struct cifs_sb_info *cifs_sb = CIFS_SB(direntry->d_sb);
368 struct tcon_link *tlink;
369 struct cifs_tcon *pTcon;
370 const char *full_path;
373 if (unlikely(cifs_forced_shutdown(cifs_sb)))
376 if (cifs_sb->mnt_cifs_flags & CIFS_MOUNT_NO_XATTR)
379 tlink = cifs_sb_tlink(cifs_sb);
381 return PTR_ERR(tlink);
382 pTcon = tlink_tcon(tlink);
385 page = alloc_dentry_path();
387 full_path = build_path_from_dentry(direntry, page);
388 if (IS_ERR(full_path)) {
389 rc = PTR_ERR(full_path);
392 /* return dos attributes as pseudo xattr */
393 /* return alt name if available as pseudo attr */
395 /* if proc/fs/cifs/streamstoxattr is set then
396 search server for EAs or streams to
399 if (pTcon->ses->server->ops->query_all_EAs)
400 rc = pTcon->ses->server->ops->query_all_EAs(xid, pTcon,
401 full_path, NULL, data, buf_size, cifs_sb);
403 free_dentry_path(page);
405 cifs_put_tlink(tlink);
409 static const struct xattr_handler cifs_user_xattr_handler = {
410 .prefix = XATTR_USER_PREFIX,
412 .get = cifs_xattr_get,
413 .set = cifs_xattr_set,
416 /* os2.* attributes are treated like user.* attributes */
417 static const struct xattr_handler cifs_os2_xattr_handler = {
418 .prefix = XATTR_OS2_PREFIX,
420 .get = cifs_xattr_get,
421 .set = cifs_xattr_set,
424 static const struct xattr_handler cifs_cifs_acl_xattr_handler = {
425 .name = CIFS_XATTR_CIFS_ACL,
426 .flags = XATTR_CIFS_ACL,
427 .get = cifs_xattr_get,
428 .set = cifs_xattr_set,
432 * Although this is just an alias for the above, need to move away from
433 * confusing users and using the 20 year old term 'cifs' when it is no
434 * longer secure and was replaced by SMB2/SMB3 a long time ago, and
435 * SMB3 and later are highly secure.
437 static const struct xattr_handler smb3_acl_xattr_handler = {
438 .name = SMB3_XATTR_CIFS_ACL,
439 .flags = XATTR_CIFS_ACL,
440 .get = cifs_xattr_get,
441 .set = cifs_xattr_set,
444 static const struct xattr_handler cifs_cifs_ntsd_xattr_handler = {
445 .name = CIFS_XATTR_CIFS_NTSD,
446 .flags = XATTR_CIFS_NTSD,
447 .get = cifs_xattr_get,
448 .set = cifs_xattr_set,
452 * Although this is just an alias for the above, need to move away from
453 * confusing users and using the 20 year old term 'cifs' when it is no
454 * longer secure and was replaced by SMB2/SMB3 a long time ago, and
455 * SMB3 and later are highly secure.
457 static const struct xattr_handler smb3_ntsd_xattr_handler = {
458 .name = SMB3_XATTR_CIFS_NTSD,
459 .flags = XATTR_CIFS_NTSD,
460 .get = cifs_xattr_get,
461 .set = cifs_xattr_set,
464 static const struct xattr_handler cifs_cifs_ntsd_full_xattr_handler = {
465 .name = CIFS_XATTR_CIFS_NTSD_FULL,
466 .flags = XATTR_CIFS_NTSD_FULL,
467 .get = cifs_xattr_get,
468 .set = cifs_xattr_set,
472 * Although this is just an alias for the above, need to move away from
473 * confusing users and using the 20 year old term 'cifs' when it is no
474 * longer secure and was replaced by SMB2/SMB3 a long time ago, and
475 * SMB3 and later are highly secure.
477 static const struct xattr_handler smb3_ntsd_full_xattr_handler = {
478 .name = SMB3_XATTR_CIFS_NTSD_FULL,
479 .flags = XATTR_CIFS_NTSD_FULL,
480 .get = cifs_xattr_get,
481 .set = cifs_xattr_set,
484 const struct xattr_handler * const cifs_xattr_handlers[] = {
485 &cifs_user_xattr_handler,
486 &cifs_os2_xattr_handler,
487 &cifs_cifs_acl_xattr_handler,
488 &smb3_acl_xattr_handler, /* alias for above since avoiding "cifs" */
489 &cifs_cifs_ntsd_xattr_handler,
490 &smb3_ntsd_xattr_handler, /* alias for above since avoiding "cifs" */
491 &cifs_cifs_ntsd_full_xattr_handler,
492 &smb3_ntsd_full_xattr_handler, /* alias for above since avoiding "cifs" */