Whamcloud - gitweb
LU-8648 all: remove all Sun license and URL references
[fs/lustre-release.git] / lustre / llite / xattr.c
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License version 2 only,
8  * as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License version 2 for more details (a copy is included
14  * in the LICENSE file that accompanied this code).
15  *
16  * You should have received a copy of the GNU General Public License
17  * version 2 along with this program; If not, see
18  * http://www.gnu.org/licenses/gpl-2.0.html
19  *
20  * GPL HEADER END
21  */
22 /*
23  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24  * Use is subject to license terms.
25  *
26  * Copyright (c) 2011, 2015, Intel Corporation.
27  */
28 /*
29  * This file is part of Lustre, http://www.lustre.org/
30  * Lustre is a trademark of Sun Microsystems, Inc.
31  */
32
33 #include <linux/fs.h>
34 #include <linux/sched.h>
35 #include <linux/mm.h>
36 #include <linux/xattr.h>
37 #include <linux/selinux.h>
38
39 #define DEBUG_SUBSYSTEM S_LLITE
40
41 #include <obd_support.h>
42 #include <lustre_dlm.h>
43 #include <lustre_ver.h>
44 #include <lustre_eacl.h>
45
46 #include "llite_internal.h"
47
48 /* xattr related to IMA(Integrity Measurement Architecture) */
49 #ifndef XATTR_NAME_IMA
50 #define XATTR_NAME_IMA          "security.ima"
51 #endif
52 #ifndef XATTR_NAME_EVM
53 #define XATTR_NAME_EVM          "security.evm"
54 #endif
55
56 #define XATTR_USER_T            (1)
57 #define XATTR_TRUSTED_T         (2)
58 #define XATTR_SECURITY_T        (3)
59 #define XATTR_ACL_ACCESS_T      (4)
60 #define XATTR_ACL_DEFAULT_T     (5)
61 #define XATTR_LUSTRE_T          (6)
62 #define XATTR_OTHER_T           (7)
63
64 static
65 int get_xattr_type(const char *name)
66 {
67         if (!strcmp(name, XATTR_NAME_POSIX_ACL_ACCESS))
68                 return XATTR_ACL_ACCESS_T;
69
70         if (!strcmp(name, XATTR_NAME_POSIX_ACL_DEFAULT))
71                 return XATTR_ACL_DEFAULT_T;
72
73         if (!strncmp(name, XATTR_USER_PREFIX,
74                      sizeof(XATTR_USER_PREFIX) - 1))
75                 return XATTR_USER_T;
76
77         if (!strncmp(name, XATTR_TRUSTED_PREFIX,
78                      sizeof(XATTR_TRUSTED_PREFIX) - 1))
79                 return XATTR_TRUSTED_T;
80
81         if (!strncmp(name, XATTR_SECURITY_PREFIX,
82                      sizeof(XATTR_SECURITY_PREFIX) - 1))
83                 return XATTR_SECURITY_T;
84
85         if (!strncmp(name, XATTR_LUSTRE_PREFIX,
86                      sizeof(XATTR_LUSTRE_PREFIX) - 1))
87                 return XATTR_LUSTRE_T;
88
89         return XATTR_OTHER_T;
90 }
91
92 static
93 int xattr_type_filter(struct ll_sb_info *sbi, int xattr_type)
94 {
95         if ((xattr_type == XATTR_ACL_ACCESS_T ||
96              xattr_type == XATTR_ACL_DEFAULT_T) &&
97            !(sbi->ll_flags & LL_SBI_ACL))
98                 return -EOPNOTSUPP;
99
100         if (xattr_type == XATTR_USER_T && !(sbi->ll_flags & LL_SBI_USER_XATTR))
101                 return -EOPNOTSUPP;
102         if (xattr_type == XATTR_TRUSTED_T && !cfs_capable(CFS_CAP_SYS_ADMIN))
103                 return -EPERM;
104         if (xattr_type == XATTR_OTHER_T)
105                 return -EOPNOTSUPP;
106
107         return 0;
108 }
109
110 static
111 int ll_setxattr_common(struct inode *inode, const char *name,
112                        const void *value, size_t size,
113                        int flags, __u64 valid)
114 {
115         struct ll_sb_info *sbi = ll_i2sbi(inode);
116         struct ptlrpc_request *req = NULL;
117         int xattr_type, rc;
118         const char *pv = value;
119         ENTRY;
120
121         /*FIXME: enable IMA when the conditions are ready */
122         if (strncmp(name, XATTR_NAME_IMA,
123                     sizeof(XATTR_NAME_IMA)) == 0 ||
124             strncmp(name, XATTR_NAME_EVM,
125                     sizeof(XATTR_NAME_EVM)) == 0)
126                 return -EOPNOTSUPP;
127
128         xattr_type = get_xattr_type(name);
129         rc = xattr_type_filter(sbi, xattr_type);
130         if (rc)
131                 RETURN(rc);
132
133         if ((xattr_type == XATTR_ACL_ACCESS_T ||
134              xattr_type == XATTR_ACL_DEFAULT_T) &&
135 #ifdef HAVE_INODE_OWNER_OR_CAPABLE
136             !inode_owner_or_capable(inode))
137 #else
138             !is_owner_or_cap(inode))
139 #endif
140                 return -EPERM;
141
142         /* b10667: ignore lustre special xattr for now */
143         if (strcmp(name, XATTR_NAME_HSM) == 0 ||
144                 (xattr_type == XATTR_TRUSTED_T &&
145                 strcmp(name, XATTR_NAME_LOV) == 0) ||
146                 (xattr_type == XATTR_LUSTRE_T &&
147                  strcmp(name, "lustre.lov") == 0))
148                 RETURN(0);
149
150         /* b15587: ignore security.capability xattr for now */
151         if ((xattr_type == XATTR_SECURITY_T &&
152             strcmp(name, "security.capability") == 0))
153                 RETURN(0);
154
155         /* LU-549:  Disable security.selinux when selinux is disabled */
156         if (xattr_type == XATTR_SECURITY_T && !selinux_is_enabled() &&
157             strcmp(name, "security.selinux") == 0)
158                 RETURN(-EOPNOTSUPP);
159
160         /* In user.* namespace, only regular files and directories can have
161          * extended attributes. */
162         if (xattr_type == XATTR_USER_T) {
163                 if (!S_ISREG(inode->i_mode) && !S_ISDIR(inode->i_mode))
164                         RETURN(-EPERM);
165         }
166
167         rc = md_setxattr(sbi->ll_md_exp, ll_inode2fid(inode), valid, name, pv,
168                          size, 0, flags, ll_i2suppgid(inode), &req);
169         if (rc) {
170                 if (rc == -EOPNOTSUPP && xattr_type == XATTR_USER_T) {
171                         LCONSOLE_INFO("Disabling user_xattr feature because "
172                                       "it is not supported on the server\n");
173                         sbi->ll_flags &= ~LL_SBI_USER_XATTR;
174                 }
175                 RETURN(rc);
176         }
177
178         ptlrpc_req_finished(req);
179         RETURN(0);
180 }
181
182 static int get_hsm_state(struct inode *inode, __u32 *hus_states)
183 {
184         struct md_op_data *op_data;
185         struct hsm_user_state *hus;
186         int rc;
187
188         OBD_ALLOC_PTR(hus);
189         if (hus == NULL)
190                 return -ENOMEM;
191
192         op_data = ll_prep_md_op_data(NULL, inode, NULL, NULL, 0, 0,
193                                      LUSTRE_OPC_ANY, hus);
194         if (!IS_ERR(op_data)) {
195                 rc = obd_iocontrol(LL_IOC_HSM_STATE_GET, ll_i2mdexp(inode),
196                                    sizeof(*op_data), op_data, NULL);
197                 if (rc == 0)
198                         *hus_states = hus->hus_states;
199                 else
200                         CDEBUG(D_VFSTRACE, "obd_iocontrol failed. rc = %d\n",
201                                rc);
202
203                 ll_finish_md_op_data(op_data);
204         } else {
205                 rc = PTR_ERR(op_data);
206                 CDEBUG(D_VFSTRACE, "Could not prepare the opdata. rc = %d\n",
207                        rc);
208         }
209         OBD_FREE_PTR(hus);
210         return rc;
211 }
212
213 int ll_setxattr(struct dentry *dentry, const char *name,
214                 const void *value, size_t size, int flags)
215 {
216         struct inode *inode = dentry->d_inode;
217
218         LASSERT(inode);
219         LASSERT(name);
220
221         CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p), xattr %s\n",
222                PFID(ll_inode2fid(inode)), inode, name);
223
224         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_SETXATTR, 1);
225
226         if ((strncmp(name, XATTR_TRUSTED_PREFIX,
227                      sizeof(XATTR_TRUSTED_PREFIX) - 1) == 0 &&
228              strcmp(name + sizeof(XATTR_TRUSTED_PREFIX) - 1, "lov") == 0) ||
229             (strncmp(name, XATTR_LUSTRE_PREFIX,
230                      sizeof(XATTR_LUSTRE_PREFIX) - 1) == 0 &&
231              strcmp(name + sizeof(XATTR_LUSTRE_PREFIX) - 1, "lov") == 0)) {
232                 struct lov_user_md *lump = (struct lov_user_md *)value;
233                 int rc = 0;
234
235                 /* Attributes that are saved via getxattr will always have
236                  * the stripe_offset as 0.  Instead, the MDS should be
237                  * allowed to pick the starting OST index.   b=17846 */
238                 if (lump != NULL && lump->lmm_stripe_offset == 0)
239                         lump->lmm_stripe_offset = -1;
240                 /* Avoid anyone directly setting the RELEASED flag. */
241                 if (lump != NULL &&
242                         (lump->lmm_pattern & LOV_PATTERN_F_RELEASED)) {
243                         /* Only if we have a released flag check if the file
244                         * was indeed archived. */
245                         __u32 state = HS_NONE;
246                         rc = get_hsm_state(inode, &state);
247                         if (rc != 0)
248                                 RETURN(rc);
249                         if (!(state & HS_ARCHIVED)) {
250                                 CDEBUG(D_VFSTRACE,
251                                         "hus_states state = %x, pattern = %x\n",
252                                         state, lump->lmm_pattern);
253                                 /* Here the state is: real file is not
254                                  * archived but user is requesting to set
255                                  * the RELEASED flag so we mask off the
256                                  * released flag from the request */
257                                 lump->lmm_pattern ^= LOV_PATTERN_F_RELEASED;
258                         }
259                 }
260
261                 if (lump != NULL && S_ISREG(inode->i_mode)) {
262                         struct file     f;
263                         __u64           it_flags = FMODE_WRITE;
264                         int             lum_size;
265
266                         lum_size = ll_lov_user_md_size(lump);
267                         if (lum_size < 0 || size < lum_size)
268                                 return 0; /* b=10667: ignore error */
269
270                         memset(&f, 0, sizeof(f)); /* f.f_flags is used below */
271                         f.f_path.dentry = dentry;
272                         rc = ll_lov_setstripe_ea_info(inode, &f, it_flags, lump,
273                                                       lum_size);
274                         /* b=10667: rc always be 0 here for now */
275                         rc = 0;
276                 } else if (S_ISDIR(inode->i_mode)) {
277                         rc = ll_dir_setstripe(inode, lump, 0);
278                 }
279
280                 return rc;
281
282         } else if (strcmp(name, XATTR_NAME_LMA) == 0 ||
283                    strcmp(name, XATTR_NAME_LINK) == 0)
284                 return 0;
285
286         return ll_setxattr_common(inode, name, value, size, flags,
287                                   OBD_MD_FLXATTR);
288 }
289
290 int ll_removexattr(struct dentry *dentry, const char *name)
291 {
292         struct inode *inode = dentry->d_inode;
293
294         LASSERT(inode);
295         LASSERT(name);
296
297         CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p), xattr %s\n",
298                PFID(ll_inode2fid(inode)), inode, name);
299
300         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_REMOVEXATTR, 1);
301         return ll_setxattr_common(inode, name, NULL, 0, 0,
302                                   OBD_MD_FLXATTRRM);
303 }
304
305 int ll_getxattr_common(struct inode *inode, const char *name,
306                        void *buffer, size_t size, __u64 valid)
307 {
308         struct ll_sb_info *sbi = ll_i2sbi(inode);
309         struct ptlrpc_request *req = NULL;
310         struct mdt_body *body;
311         int xattr_type, rc;
312         void *xdata;
313         struct ll_inode_info *lli = ll_i2info(inode);
314         ENTRY;
315
316         CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p)\n",
317                PFID(ll_inode2fid(inode)), inode);
318
319         /* listxattr have slightly different behavior from of ext3:
320          * without 'user_xattr' ext3 will list all xattr names but
321          * filtered out "^user..*"; we list them all for simplicity.
322          */
323         if (!name) {
324                 xattr_type = XATTR_OTHER_T;
325                 goto do_getxattr;
326         }
327
328         xattr_type = get_xattr_type(name);
329         rc = xattr_type_filter(sbi, xattr_type);
330         if (rc)
331                 RETURN(rc);
332
333         /* b15587: ignore security.capability xattr for now */
334         if ((xattr_type == XATTR_SECURITY_T &&
335             strcmp(name, "security.capability") == 0))
336                 RETURN(-ENODATA);
337
338         /* LU-549:  Disable security.selinux when selinux is disabled */
339         if (xattr_type == XATTR_SECURITY_T && !selinux_is_enabled() &&
340             strcmp(name, "security.selinux") == 0)
341                 RETURN(-EOPNOTSUPP);
342
343 #ifdef CONFIG_FS_POSIX_ACL
344         /* posix acl is under protection of LOOKUP lock. when calling to this,
345          * we just have path resolution to the target inode, so we have great
346          * chance that cached ACL is uptodate.
347          */
348         if (xattr_type == XATTR_ACL_ACCESS_T) {
349                 struct posix_acl *acl;
350
351                 spin_lock(&lli->lli_lock);
352                 acl = posix_acl_dup(lli->lli_posix_acl);
353                 spin_unlock(&lli->lli_lock);
354
355                 if (!acl)
356                         RETURN(-ENODATA);
357
358                 rc = posix_acl_to_xattr(&init_user_ns, acl, buffer, size);
359                 posix_acl_release(acl);
360                 RETURN(rc);
361         }
362         if (xattr_type == XATTR_ACL_DEFAULT_T && !S_ISDIR(inode->i_mode))
363                 RETURN(-ENODATA);
364 #endif
365
366 do_getxattr:
367         if (sbi->ll_xattr_cache_enabled &&
368             xattr_type != XATTR_ACL_ACCESS_T &&
369             (xattr_type != XATTR_SECURITY_T ||
370                 strcmp(name, "security.selinux") != 0)) {
371                 rc = ll_xattr_cache_get(inode, name, buffer, size, valid);
372                 if (rc == -EAGAIN)
373                         goto getxattr_nocache;
374                 if (rc < 0)
375                         GOTO(out_xattr, rc);
376
377                 /* Add "system.posix_acl_access" to the list */
378                 if (lli->lli_posix_acl != NULL && valid & OBD_MD_FLXATTRLS) {
379                         if (size == 0) {
380                                 rc += sizeof(XATTR_NAME_ACL_ACCESS);
381                         } else if (size - rc >= sizeof(XATTR_NAME_ACL_ACCESS)) {
382                                 memcpy(buffer + rc, XATTR_NAME_ACL_ACCESS,
383                                        sizeof(XATTR_NAME_ACL_ACCESS));
384                                 rc += sizeof(XATTR_NAME_ACL_ACCESS);
385                         } else {
386                                 GOTO(out_xattr, rc = -ERANGE);
387                         }
388                 }
389         } else {
390 getxattr_nocache:
391                 rc = md_getxattr(sbi->ll_md_exp, ll_inode2fid(inode),
392                                 valid, name, NULL, 0, size, 0, &req);
393
394                 if (rc < 0)
395                         GOTO(out_xattr, rc);
396
397                 body = req_capsule_server_get(&req->rq_pill, &RMF_MDT_BODY);
398                 LASSERT(body);
399
400                 /* only detect the xattr size */
401                 if (size == 0)
402                         GOTO(out, rc = body->mbo_eadatasize);
403
404                 if (size < body->mbo_eadatasize) {
405                         CERROR("server bug: replied size %u > %u\n",
406                                 body->mbo_eadatasize, (int)size);
407                         GOTO(out, rc = -ERANGE);
408                 }
409
410                 if (body->mbo_eadatasize == 0)
411                         GOTO(out, rc = -ENODATA);
412
413                 /* do not need swab xattr data */
414                 xdata = req_capsule_server_sized_get(&req->rq_pill, &RMF_EADATA,
415                                                         body->mbo_eadatasize);
416                 if (!xdata)
417                         GOTO(out, rc = -EFAULT);
418
419                 memcpy(buffer, xdata, body->mbo_eadatasize);
420                 rc = body->mbo_eadatasize;
421         }
422
423         EXIT;
424
425 out_xattr:
426         if (rc == -EOPNOTSUPP && xattr_type == XATTR_USER_T) {
427                 LCONSOLE_INFO("%s: disabling user_xattr feature because "
428                                 "it is not supported on the server: rc = %d\n",
429                                 ll_get_fsname(inode->i_sb, NULL, 0), rc);
430                 sbi->ll_flags &= ~LL_SBI_USER_XATTR;
431         }
432 out:
433         ptlrpc_req_finished(req);
434         return rc;
435 }
436
437 static ssize_t ll_getxattr_lov(struct inode *inode, void *buf, size_t buf_size)
438 {
439         ssize_t rc;
440
441         if (S_ISREG(inode->i_mode)) {
442                 struct cl_object *obj = ll_i2info(inode)->lli_clob;
443                 struct lu_env *env;
444                 struct cl_layout cl = {
445                         .cl_buf.lb_buf = buf,
446                         .cl_buf.lb_len = buf_size,
447                 };
448                 __u16 refcheck;
449
450                 if (obj == NULL)
451                         RETURN(-ENODATA);
452
453                 env = cl_env_get(&refcheck);
454                 if (IS_ERR(env))
455                         RETURN(PTR_ERR(env));
456
457                 rc = cl_object_layout_get(env, obj, &cl);
458                 if (rc < 0)
459                         GOTO(out_env, rc);
460
461                 if (cl.cl_size == 0)
462                         GOTO(out_env, rc = -ENODATA);
463
464                 rc = cl.cl_size;
465
466                 if (buf_size == 0)
467                         GOTO(out_env, rc);
468
469                 LASSERT(buf != NULL && rc <= buf_size);
470
471                 /* Do not return layout gen for getxattr() since
472                  * otherwise it would confuse tar --xattr by
473                  * recognizing layout gen as stripe offset when the
474                  * file is restored. See LU-2809. */
475                 ((struct lov_mds_md *)buf)->lmm_layout_gen = 0;
476 out_env:
477                 cl_env_put(env, &refcheck);
478
479                 RETURN(rc);
480         } else if (S_ISDIR(inode->i_mode)) {
481                 struct lov_mds_md *lmm = NULL;
482                 int lmm_size = 0;
483                 struct ptlrpc_request *req = NULL;
484
485                 rc = ll_dir_getstripe(inode, (void **)&lmm, &lmm_size,
486                                       &req, 0);
487                 if (rc < 0)
488                         GOTO(out_req, rc);
489
490                 if (buf_size == 0)
491                         GOTO(out_req, rc = lmm_size);
492
493                 if (buf_size < lmm_size)
494                         GOTO(out_req, rc = -ERANGE);
495
496                 memcpy(buf, lmm, lmm_size);
497                 GOTO(out_req, rc = lmm_size);
498 out_req:
499                 if (req != NULL)
500                         ptlrpc_req_finished(req);
501
502                 return rc;
503         } else {
504                 RETURN(-ENODATA);
505         }
506 }
507
508 ssize_t ll_getxattr(struct dentry *dentry, const char *name, void *buf,
509                     size_t buf_size)
510 {
511         struct inode *inode = dentry->d_inode;
512
513         LASSERT(inode);
514         LASSERT(name);
515
516         CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p), xattr %s\n",
517                PFID(ll_inode2fid(inode)), inode, name);
518
519         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_GETXATTR, 1);
520
521         if (strcmp(name, XATTR_LUSTRE_LOV) == 0 ||
522             strcmp(name, XATTR_NAME_LOV) == 0)
523                 return ll_getxattr_lov(inode, buf, buf_size);
524         else
525                 return ll_getxattr_common(inode, name, buf, buf_size,
526                                           OBD_MD_FLXATTR);
527 }
528
529 ssize_t ll_listxattr(struct dentry *dentry, char *buf, size_t buf_size)
530 {
531         struct inode *inode = dentry->d_inode;
532         struct ll_sb_info *sbi = ll_i2sbi(inode);
533         char *xattr_name;
534         ssize_t rc, rc2;
535         size_t len, rem;
536
537         CDEBUG(D_VFSTRACE, "VFS Op:inode="DFID"(%p)\n",
538                PFID(ll_inode2fid(inode)), inode);
539
540         ll_stats_ops_tally(ll_i2sbi(inode), LPROC_LL_LISTXATTR, 1);
541
542         rc = ll_getxattr_common(inode, NULL, buf, buf_size, OBD_MD_FLXATTRLS);
543         if (rc < 0)
544                 RETURN(rc);
545
546         /* If we're being called to get the size of the xattr list
547          * (buf_size == 0) then just assume that a lustre.lov xattr
548          * exists. */
549         if (buf_size == 0)
550                 RETURN(rc + sizeof(XATTR_LUSTRE_LOV));
551
552         xattr_name = buf;
553         rem = rc;
554
555         while (rem > 0) {
556                 len = strnlen(xattr_name, rem - 1) + 1;
557                 rem -= len;
558                 if (xattr_type_filter(sbi, get_xattr_type(xattr_name)) == 0) {
559                         /* Skip OK xattr type, leave it in buffer. */
560                         xattr_name += len;
561                         continue;
562                 }
563
564                 /* Move up remaining xattrs in buffer removing the
565                  * xattr that is not OK. */
566                 memmove(xattr_name, xattr_name + len, rem);
567                 rc -= len;
568         }
569
570         rc2 = ll_getxattr_lov(inode, NULL, 0);
571         if (rc2 == -ENODATA)
572                 RETURN(rc);
573
574         if (rc2 < 0)
575                 RETURN(rc2);
576
577         if (buf_size < rc + sizeof(XATTR_LUSTRE_LOV))
578                 RETURN(-ERANGE);
579
580         memcpy(buf + rc, XATTR_LUSTRE_LOV, sizeof(XATTR_LUSTRE_LOV));
581
582         RETURN(rc + sizeof(XATTR_LUSTRE_LOV));
583 }