fs/attr.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  *  linux/fs/attr.c
   4  *
   5  *  Copyright (C) 1991, 1992  Linus Torvalds
   6  *  changes by Thomas Schoebel-Theuer
   7  */
   8
   9 #include <linux/export.h>
  10 #include <linux/time.h>
  11 #include <linux/mm.h>
  12 #include <linux/string.h>
  13 #include <linux/sched/signal.h>
  14 #include <linux/capability.h>
  15 #include <linux/fsnotify.h>
  16 #include <linux/fcntl.h>
  17 #include <linux/security.h>
  18 #include <linux/evm.h>
  19 #include <linux/ima.h>
  20
  21 #include "internal.h"
  22
  23 /**
  24  * setattr_should_drop_sgid - determine whether the setgid bit needs to be
  25  *                            removed
  26  * @mnt_userns: user namespace of the mount @inode was found from
  27  * @inode:      inode to check
  28  *
  29  * This function determines whether the setgid bit needs to be removed.
  30  * We retain backwards compatibility and require setgid bit to be removed
  31  * unconditionally if S_IXGRP is set. Otherwise we have the exact same
  32  * requirements as setattr_prepare() and setattr_copy().
  33  *
  34  * Return: ATTR_KILL_SGID if setgid bit needs to be removed, 0 otherwise.
  35  */
  36 int setattr_should_drop_sgid(struct user_namespace *mnt_userns,
  37                              const struct inode *inode)
  38 {
  39         umode_t mode = inode->i_mode;
  40
  41         if (!(mode & S_ISGID))
  42                 return 0;
  43         if (mode & S_IXGRP)
  44                 return ATTR_KILL_SGID;
  45         if (!in_group_or_capable(mnt_userns, inode,
  46                                  i_gid_into_vfsgid(mnt_userns, inode)))
  47                 return ATTR_KILL_SGID;
  48         return 0;
  49 }
  50
  51 /**
  52  * setattr_should_drop_suidgid - determine whether the set{g,u}id bit needs to
  53  *                               be dropped
  54  * @mnt_userns: user namespace of the mount @inode was found from
  55  * @inode:      inode to check
  56  *
  57  * This function determines whether the set{g,u}id bits need to be removed.
  58  * If the setuid bit needs to be removed ATTR_KILL_SUID is returned. If the
  59  * setgid bit needs to be removed ATTR_KILL_SGID is returned. If both
  60  * set{g,u}id bits need to be removed the corresponding mask of both flags is
  61  * returned.
  62  *
  63  * Return: A mask of ATTR_KILL_S{G,U}ID indicating which - if any - setid bits
  64  * to remove, 0 otherwise.
  65  */
  66 int setattr_should_drop_suidgid(struct user_namespace *mnt_userns,
  67                                 struct inode *inode)
  68 {
  69         umode_t mode = inode->i_mode;
  70         int kill = 0;
  71
  72         /* suid always must be killed */
  73         if (unlikely(mode & S_ISUID))
  74                 kill = ATTR_KILL_SUID;
  75
  76         kill |= setattr_should_drop_sgid(mnt_userns, inode);
  77
  78         if (unlikely(kill && !capable(CAP_FSETID) && S_ISREG(mode)))
  79                 return kill;
  80
  81         return 0;
  82 }
  83 EXPORT_SYMBOL(setattr_should_drop_suidgid);
  84
  85 /**
  86  * chown_ok - verify permissions to chown inode
  87  * @mnt_userns: user namespace of the mount @inode was found from
  88  * @inode:      inode to check permissions on
  89  * @ia_vfsuid:  uid to chown @inode to
  90  *
  91  * If the inode has been found through an idmapped mount the user namespace of
  92  * the vfsmount must be passed through @mnt_userns. This function will then
  93  * take care to map the inode according to @mnt_userns before checking
  94  * permissions. On non-idmapped mounts or if permission checking is to be
  95  * performed on the raw inode simply passs init_user_ns.
  96  */
  97 static bool chown_ok(struct user_namespace *mnt_userns,
  98                      const struct inode *inode, vfsuid_t ia_vfsuid)
  99 {
 100         vfsuid_t vfsuid = i_uid_into_vfsuid(mnt_userns, inode);
 101         if (vfsuid_eq_kuid(vfsuid, current_fsuid()) &&
 102             vfsuid_eq(ia_vfsuid, vfsuid))
 103                 return true;
 104         if (capable_wrt_inode_uidgid(mnt_userns, inode, CAP_CHOWN))
 105                 return true;
 106         if (!vfsuid_valid(vfsuid) &&
 107             ns_capable(inode->i_sb->s_user_ns, CAP_CHOWN))
 108                 return true;
 109         return false;
 110 }
 111
 112 /**
 113  * chgrp_ok - verify permissions to chgrp inode
 114  * @mnt_userns: user namespace of the mount @inode was found from
 115  * @inode:      inode to check permissions on
 116  * @ia_vfsgid:  gid to chown @inode to
 117  *
 118  * If the inode has been found through an idmapped mount the user namespace of
 119  * the vfsmount must be passed through @mnt_userns. This function will then
 120  * take care to map the inode according to @mnt_userns before checking
 121  * permissions. On non-idmapped mounts or if permission checking is to be
 122  * performed on the raw inode simply passs init_user_ns.
 123  */
 124 static bool chgrp_ok(struct user_namespace *mnt_userns,
 125                      const struct inode *inode, vfsgid_t ia_vfsgid)
 126 {
 127         vfsgid_t vfsgid = i_gid_into_vfsgid(mnt_userns, inode);
 128         vfsuid_t vfsuid = i_uid_into_vfsuid(mnt_userns, inode);
 129         if (vfsuid_eq_kuid(vfsuid, current_fsuid())) {
 130                 if (vfsgid_eq(ia_vfsgid, vfsgid))
 131                         return true;
 132                 if (vfsgid_in_group_p(ia_vfsgid))
 133                         return true;
 134         }
 135         if (capable_wrt_inode_uidgid(mnt_userns, inode, CAP_CHOWN))
 136                 return true;
 137         if (!vfsgid_valid(vfsgid) &&
 138             ns_capable(inode->i_sb->s_user_ns, CAP_CHOWN))
 139                 return true;
 140         return false;
 141 }
 142
 143 /**
 144  * setattr_prepare - check if attribute changes to a dentry are allowed
 145  * @idmap:      idmap of the mount the inode was found from
 146  * @dentry:     dentry to check
 147  * @attr:       attributes to change
 148  *
 149  * Check if we are allowed to change the attributes contained in @attr
 150  * in the given dentry.  This includes the normal unix access permission
 151  * checks, as well as checks for rlimits and others. The function also clears
 152  * SGID bit from mode if user is not allowed to set it. Also file capabilities
 153  * and IMA extended attributes are cleared if ATTR_KILL_PRIV is set.
 154  *
 155  * If the inode has been found through an idmapped mount the idmap of
 156  * the vfsmount must be passed through @idmap. This function will then
 157  * take care to map the inode according to @idmap before checking
 158  * permissions. On non-idmapped mounts or if permission checking is to be
 159  * performed on the raw inode simply passs @nop_mnt_idmap.
 160  *
 161  * Should be called as the first thing in ->setattr implementations,
 162  * possibly after taking additional locks.
 163  */
 164 int setattr_prepare(struct mnt_idmap *idmap, struct dentry *dentry,
 165                     struct iattr *attr)
 166 {
 167         struct user_namespace *mnt_userns = mnt_idmap_owner(idmap);
 168         struct inode *inode = d_inode(dentry);
 169         unsigned int ia_valid = attr->ia_valid;
 170
 171         /*
 172          * First check size constraints.  These can't be overriden using
 173          * ATTR_FORCE.
 174          */
 175         if (ia_valid & ATTR_SIZE) {
 176                 int error = inode_newsize_ok(inode, attr->ia_size);
 177                 if (error)
 178                         return error;
 179         }
 180
 181         /* If force is set do it anyway. */
 182         if (ia_valid & ATTR_FORCE)
 183                 goto kill_priv;
 184
 185         /* Make sure a caller can chown. */
 186         if ((ia_valid & ATTR_UID) &&
 187             !chown_ok(mnt_userns, inode, attr->ia_vfsuid))
 188                 return -EPERM;
 189
 190         /* Make sure caller can chgrp. */
 191         if ((ia_valid & ATTR_GID) &&
 192             !chgrp_ok(mnt_userns, inode, attr->ia_vfsgid))
 193                 return -EPERM;
 194
 195         /* Make sure a caller can chmod. */
 196         if (ia_valid & ATTR_MODE) {
 197                 vfsgid_t vfsgid;
 198
 199                 if (!inode_owner_or_capable(mnt_userns, inode))
 200                         return -EPERM;
 201
 202                 if (ia_valid & ATTR_GID)
 203                         vfsgid = attr->ia_vfsgid;
 204                 else
 205                         vfsgid = i_gid_into_vfsgid(mnt_userns, inode);
 206
 207                 /* Also check the setgid bit! */
 208                 if (!in_group_or_capable(mnt_userns, inode, vfsgid))
 209                         attr->ia_mode &= ~S_ISGID;
 210         }
 211
 212         /* Check for setting the inode time. */
 213         if (ia_valid & (ATTR_MTIME_SET | ATTR_ATIME_SET | ATTR_TIMES_SET)) {
 214                 if (!inode_owner_or_capable(mnt_userns, inode))
 215                         return -EPERM;
 216         }
 217
 218 kill_priv:
 219         /* User has permission for the change */
 220         if (ia_valid & ATTR_KILL_PRIV) {
 221                 int error;
 222
 223                 error = security_inode_killpriv(mnt_userns, dentry);
 224                 if (error)
 225                         return error;
 226         }
 227
 228         return 0;
 229 }
 230 EXPORT_SYMBOL(setattr_prepare);
 231
 232 /**
 233  * inode_newsize_ok - may this inode be truncated to a given size
 234  * @inode:      the inode to be truncated
 235  * @offset:     the new size to assign to the inode
 236  *
 237  * inode_newsize_ok must be called with i_mutex held.
 238  *
 239  * inode_newsize_ok will check filesystem limits and ulimits to check that the
 240  * new inode size is within limits. inode_newsize_ok will also send SIGXFSZ
 241  * when necessary. Caller must not proceed with inode size change if failure is
 242  * returned. @inode must be a file (not directory), with appropriate
 243  * permissions to allow truncate (inode_newsize_ok does NOT check these
 244  * conditions).
 245  *
 246  * Return: 0 on success, -ve errno on failure
 247  */
 248 int inode_newsize_ok(const struct inode *inode, loff_t offset)
 249 {
 250         if (offset < 0)
 251                 return -EINVAL;
 252         if (inode->i_size < offset) {
 253                 unsigned long limit;
 254
 255                 limit = rlimit(RLIMIT_FSIZE);
 256                 if (limit != RLIM_INFINITY && offset > limit)
 257                         goto out_sig;
 258                 if (offset > inode->i_sb->s_maxbytes)
 259                         goto out_big;
 260         } else {
 261                 /*
 262                  * truncation of in-use swapfiles is disallowed - it would
 263                  * cause subsequent swapout to scribble on the now-freed
 264                  * blocks.
 265                  */
 266                 if (IS_SWAPFILE(inode))
 267                         return -ETXTBSY;
 268         }
 269
 270         return 0;
 271 out_sig:
 272         send_sig(SIGXFSZ, current, 0);
 273 out_big:
 274         return -EFBIG;
 275 }
 276 EXPORT_SYMBOL(inode_newsize_ok);
 277
 278 /**
 279  * setattr_copy - copy simple metadata updates into the generic inode
 280  * @idmap:      idmap of the mount the inode was found from
 281  * @inode:      the inode to be updated
 282  * @attr:       the new attributes
 283  *
 284  * setattr_copy must be called with i_mutex held.
 285  *
 286  * setattr_copy updates the inode's metadata with that specified
 287  * in attr on idmapped mounts. Necessary permission checks to determine
 288  * whether or not the S_ISGID property needs to be removed are performed with
 289  * the correct idmapped mount permission helpers.
 290  * Noticeably missing is inode size update, which is more complex
 291  * as it requires pagecache updates.
 292  *
 293  * If the inode has been found through an idmapped mount the idmap of
 294  * the vfsmount must be passed through @idmap. This function will then
 295  * take care to map the inode according to @idmap before checking
 296  * permissions. On non-idmapped mounts or if permission checking is to be
 297  * performed on the raw inode simply pass @nop_mnt_idmap.
 298  *
 299  * The inode is not marked as dirty after this operation. The rationale is
 300  * that for "simple" filesystems, the struct inode is the inode storage.
 301  * The caller is free to mark the inode dirty afterwards if needed.
 302  */
 303 void setattr_copy(struct mnt_idmap *idmap, struct inode *inode,
 304                   const struct iattr *attr)
 305 {
 306         struct user_namespace *mnt_userns = mnt_idmap_owner(idmap);
 307         unsigned int ia_valid = attr->ia_valid;
 308
 309         i_uid_update(mnt_userns, attr, inode);
 310         i_gid_update(mnt_userns, attr, inode);
 311         if (ia_valid & ATTR_ATIME)
 312                 inode->i_atime = attr->ia_atime;
 313         if (ia_valid & ATTR_MTIME)
 314                 inode->i_mtime = attr->ia_mtime;
 315         if (ia_valid & ATTR_CTIME)
 316                 inode->i_ctime = attr->ia_ctime;
 317         if (ia_valid & ATTR_MODE) {
 318                 umode_t mode = attr->ia_mode;
 319                 if (!in_group_or_capable(mnt_userns, inode,
 320                                          i_gid_into_vfsgid(mnt_userns, inode)))
 321                         mode &= ~S_ISGID;
 322                 inode->i_mode = mode;
 323         }
 324 }
 325 EXPORT_SYMBOL(setattr_copy);
 326
 327 int may_setattr(struct mnt_idmap *idmap, struct inode *inode,
 328                 unsigned int ia_valid)
 329 {
 330         int error;
 331         struct user_namespace *mnt_userns = mnt_idmap_owner(idmap);
 332
 333         if (ia_valid & (ATTR_MODE | ATTR_UID | ATTR_GID | ATTR_TIMES_SET)) {
 334                 if (IS_IMMUTABLE(inode) || IS_APPEND(inode))
 335                         return -EPERM;
 336         }
 337
 338         /*
 339          * If utimes(2) and friends are called with times == NULL (or both
 340          * times are UTIME_NOW), then we need to check for write permission
 341          */
 342         if (ia_valid & ATTR_TOUCH) {
 343                 if (IS_IMMUTABLE(inode))
 344                         return -EPERM;
 345
 346                 if (!inode_owner_or_capable(mnt_userns, inode)) {
 347                         error = inode_permission(idmap, inode, MAY_WRITE);
 348                         if (error)
 349                                 return error;
 350                 }
 351         }
 352         return 0;
 353 }
 354 EXPORT_SYMBOL(may_setattr);
 355
 356 /**
 357  * notify_change - modify attributes of a filesytem object
 358  * @idmap:      idmap of the mount the inode was found from
 359  * @dentry:     object affected
 360  * @attr:       new attributes
 361  * @delegated_inode: returns inode, if the inode is delegated
 362  *
 363  * The caller must hold the i_mutex on the affected object.
 364  *
 365  * If notify_change discovers a delegation in need of breaking,
 366  * it will return -EWOULDBLOCK and return a reference to the inode in
 367  * delegated_inode.  The caller should then break the delegation and
 368  * retry.  Because breaking a delegation may take a long time, the
 369  * caller should drop the i_mutex before doing so.
 370  *
 371  * Alternatively, a caller may pass NULL for delegated_inode.  This may
 372  * be appropriate for callers that expect the underlying filesystem not
 373  * to be NFS exported.  Also, passing NULL is fine for callers holding
 374  * the file open for write, as there can be no conflicting delegation in
 375  * that case.
 376  *
 377  * If the inode has been found through an idmapped mount the idmap of
 378  * the vfsmount must be passed through @idmap. This function will then
 379  * take care to map the inode according to @idmap before checking
 380  * permissions. On non-idmapped mounts or if permission checking is to be
 381  * performed on the raw inode simply pass @nop_mnt_idmap.
 382  */
 383 int notify_change(struct mnt_idmap *idmap, struct dentry *dentry,
 384                   struct iattr *attr, struct inode **delegated_inode)
 385 {
 386         struct user_namespace *mnt_userns = mnt_idmap_owner(idmap);
 387         struct inode *inode = dentry->d_inode;
 388         umode_t mode = inode->i_mode;
 389         int error;
 390         struct timespec64 now;
 391         unsigned int ia_valid = attr->ia_valid;
 392
 393         WARN_ON_ONCE(!inode_is_locked(inode));
 394
 395         error = may_setattr(idmap, inode, ia_valid);
 396         if (error)
 397                 return error;
 398
 399         if ((ia_valid & ATTR_MODE)) {
 400                 umode_t amode = attr->ia_mode;
 401                 /* Flag setting protected by i_mutex */
 402                 if (is_sxid(amode))
 403                         inode->i_flags &= ~S_NOSEC;
 404         }
 405
 406         now = current_time(inode);
 407
 408         attr->ia_ctime = now;
 409         if (!(ia_valid & ATTR_ATIME_SET))
 410                 attr->ia_atime = now;
 411         else
 412                 attr->ia_atime = timestamp_truncate(attr->ia_atime, inode);
 413         if (!(ia_valid & ATTR_MTIME_SET))
 414                 attr->ia_mtime = now;
 415         else
 416                 attr->ia_mtime = timestamp_truncate(attr->ia_mtime, inode);
 417
 418         if (ia_valid & ATTR_KILL_PRIV) {
 419                 error = security_inode_need_killpriv(dentry);
 420                 if (error < 0)
 421                         return error;
 422                 if (error == 0)
 423                         ia_valid = attr->ia_valid &= ~ATTR_KILL_PRIV;
 424         }
 425
 426         /*
 427          * We now pass ATTR_KILL_S*ID to the lower level setattr function so
 428          * that the function has the ability to reinterpret a mode change
 429          * that's due to these bits. This adds an implicit restriction that
 430          * no function will ever call notify_change with both ATTR_MODE and
 431          * ATTR_KILL_S*ID set.
 432          */
 433         if ((ia_valid & (ATTR_KILL_SUID|ATTR_KILL_SGID)) &&
 434             (ia_valid & ATTR_MODE))
 435                 BUG();
 436
 437         if (ia_valid & ATTR_KILL_SUID) {
 438                 if (mode & S_ISUID) {
 439                         ia_valid = attr->ia_valid |= ATTR_MODE;
 440                         attr->ia_mode = (inode->i_mode & ~S_ISUID);
 441                 }
 442         }
 443         if (ia_valid & ATTR_KILL_SGID) {
 444                 if (mode & S_ISGID) {
 445                         if (!(ia_valid & ATTR_MODE)) {
 446                                 ia_valid = attr->ia_valid |= ATTR_MODE;
 447                                 attr->ia_mode = inode->i_mode;
 448                         }
 449                         attr->ia_mode &= ~S_ISGID;
 450                 }
 451         }
 452         if (!(attr->ia_valid & ~(ATTR_KILL_SUID | ATTR_KILL_SGID)))
 453                 return 0;
 454
 455         /*
 456          * Verify that uid/gid changes are valid in the target
 457          * namespace of the superblock.
 458          */
 459         if (ia_valid & ATTR_UID &&
 460             !vfsuid_has_fsmapping(mnt_userns, inode->i_sb->s_user_ns,
 461                                   attr->ia_vfsuid))
 462                 return -EOVERFLOW;
 463         if (ia_valid & ATTR_GID &&
 464             !vfsgid_has_fsmapping(mnt_userns, inode->i_sb->s_user_ns,
 465                                   attr->ia_vfsgid))
 466                 return -EOVERFLOW;
 467
 468         /* Don't allow modifications of files with invalid uids or
 469          * gids unless those uids & gids are being made valid.
 470          */
 471         if (!(ia_valid & ATTR_UID) &&
 472             !vfsuid_valid(i_uid_into_vfsuid(mnt_userns, inode)))
 473                 return -EOVERFLOW;
 474         if (!(ia_valid & ATTR_GID) &&
 475             !vfsgid_valid(i_gid_into_vfsgid(mnt_userns, inode)))
 476                 return -EOVERFLOW;
 477
 478         error = security_inode_setattr(idmap, dentry, attr);
 479         if (error)
 480                 return error;
 481         error = try_break_deleg(inode, delegated_inode);
 482         if (error)
 483                 return error;
 484
 485         if (inode->i_op->setattr)
 486                 error = inode->i_op->setattr(idmap, dentry, attr);
 487         else
 488                 error = simple_setattr(idmap, dentry, attr);
 489
 490         if (!error) {
 491                 fsnotify_change(dentry, ia_valid);
 492                 ima_inode_post_setattr(mnt_userns, dentry);
 493                 evm_inode_post_setattr(dentry, ia_valid);
 494         }
 495
 496         return error;
 497 }
 498 EXPORT_SYMBOL(notify_change);