security/integrity/ima/ima_main.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Integrity Measurement Architecture
   4  *
   5  * Copyright (C) 2005,2006,2007,2008 IBM Corporation
   6  *
   7  * Authors:
   8  * Reiner Sailer <[email protected]>
   9  * Serge Hallyn <[email protected]>
  10  * Kylene Hall <[email protected]>
  11  * Mimi Zohar <[email protected]>
  12  *
  13  * File: ima_main.c
  14  *      implements the IMA hooks: ima_bprm_check, ima_file_mmap,
  15  *      and ima_file_check.
  16  */
  17
  18 #include <linux/module.h>
  19 #include <linux/file.h>
  20 #include <linux/binfmts.h>
  21 #include <linux/kernel_read_file.h>
  22 #include <linux/mount.h>
  23 #include <linux/mman.h>
  24 #include <linux/slab.h>
  25 #include <linux/xattr.h>
  26 #include <linux/ima.h>
  27 #include <linux/iversion.h>
  28 #include <linux/fs.h>
  29
  30 #include "ima.h"
  31
  32 #ifdef CONFIG_IMA_APPRAISE
  33 int ima_appraise = IMA_APPRAISE_ENFORCE;
  34 #else
  35 int ima_appraise;
  36 #endif
  37
  38 int __ro_after_init ima_hash_algo = HASH_ALGO_SHA1;
  39 static int hash_setup_done;
  40
  41 static struct notifier_block ima_lsm_policy_notifier = {
  42         .notifier_call = ima_lsm_policy_change,
  43 };
  44
  45 static int __init hash_setup(char *str)
  46 {
  47         struct ima_template_desc *template_desc = ima_template_desc_current();
  48         int i;
  49
  50         if (hash_setup_done)
  51                 return 1;
  52
  53         if (strcmp(template_desc->name, IMA_TEMPLATE_IMA_NAME) == 0) {
  54                 if (strncmp(str, "sha1", 4) == 0) {
  55                         ima_hash_algo = HASH_ALGO_SHA1;
  56                 } else if (strncmp(str, "md5", 3) == 0) {
  57                         ima_hash_algo = HASH_ALGO_MD5;
  58                 } else {
  59                         pr_err("invalid hash algorithm \"%s\" for template \"%s\"",
  60                                 str, IMA_TEMPLATE_IMA_NAME);
  61                         return 1;
  62                 }
  63                 goto out;
  64         }
  65
  66         i = match_string(hash_algo_name, HASH_ALGO__LAST, str);
  67         if (i < 0) {
  68                 pr_err("invalid hash algorithm \"%s\"", str);
  69                 return 1;
  70         }
  71
  72         ima_hash_algo = i;
  73 out:
  74         hash_setup_done = 1;
  75         return 1;
  76 }
  77 __setup("ima_hash=", hash_setup);
  78
  79 enum hash_algo ima_get_current_hash_algo(void)
  80 {
  81         return ima_hash_algo;
  82 }
  83
  84 /* Prevent mmap'ing a file execute that is already mmap'ed write */
  85 static int mmap_violation_check(enum ima_hooks func, struct file *file,
  86                                 char **pathbuf, const char **pathname,
  87                                 char *filename)
  88 {
  89         struct inode *inode;
  90         int rc = 0;
  91
  92         if ((func == MMAP_CHECK) && mapping_writably_mapped(file->f_mapping)) {
  93                 rc = -ETXTBSY;
  94                 inode = file_inode(file);
  95
  96                 if (!*pathbuf)  /* ima_rdwr_violation possibly pre-fetched */
  97                         *pathname = ima_d_path(&file->f_path, pathbuf,
  98                                                filename);
  99                 integrity_audit_msg(AUDIT_INTEGRITY_DATA, inode, *pathname,
 100                                     "mmap_file", "mmapped_writers", rc, 0);
 101         }
 102         return rc;
 103 }
 104
 105 /*
 106  * ima_rdwr_violation_check
 107  *
 108  * Only invalidate the PCR for measured files:
 109  *      - Opening a file for write when already open for read,
 110  *        results in a time of measure, time of use (ToMToU) error.
 111  *      - Opening a file for read when already open for write,
 112  *        could result in a file measurement error.
 113  *
 114  */
 115 static void ima_rdwr_violation_check(struct file *file,
 116                                      struct integrity_iint_cache *iint,
 117                                      int must_measure,
 118                                      char **pathbuf,
 119                                      const char **pathname,
 120                                      char *filename)
 121 {
 122         struct inode *inode = file_inode(file);
 123         fmode_t mode = file->f_mode;
 124         bool send_tomtou = false, send_writers = false;
 125
 126         if (mode & FMODE_WRITE) {
 127                 if (atomic_read(&inode->i_readcount) && IS_IMA(inode)) {
 128                         if (!iint)
 129                                 iint = integrity_iint_find(inode);
 130                         /* IMA_MEASURE is set from reader side */
 131                         if (iint && test_bit(IMA_MUST_MEASURE,
 132                                                 &iint->atomic_flags))
 133                                 send_tomtou = true;
 134                 }
 135         } else {
 136                 if (must_measure)
 137                         set_bit(IMA_MUST_MEASURE, &iint->atomic_flags);
 138                 if (inode_is_open_for_write(inode) && must_measure)
 139                         send_writers = true;
 140         }
 141
 142         if (!send_tomtou && !send_writers)
 143                 return;
 144
 145         *pathname = ima_d_path(&file->f_path, pathbuf, filename);
 146
 147         if (send_tomtou)
 148                 ima_add_violation(file, *pathname, iint,
 149                                   "invalid_pcr", "ToMToU");
 150         if (send_writers)
 151                 ima_add_violation(file, *pathname, iint,
 152                                   "invalid_pcr", "open_writers");
 153 }
 154
 155 static void ima_check_last_writer(struct integrity_iint_cache *iint,
 156                                   struct inode *inode, struct file *file)
 157 {
 158         fmode_t mode = file->f_mode;
 159         bool update;
 160
 161         if (!(mode & FMODE_WRITE))
 162                 return;
 163
 164         mutex_lock(&iint->mutex);
 165         if (atomic_read(&inode->i_writecount) == 1) {
 166                 update = test_and_clear_bit(IMA_UPDATE_XATTR,
 167                                             &iint->atomic_flags);
 168                 if (!IS_I_VERSION(inode) ||
 169                     !inode_eq_iversion(inode, iint->version) ||
 170                     (iint->flags & IMA_NEW_FILE)) {
 171                         iint->flags &= ~(IMA_DONE_MASK | IMA_NEW_FILE);
 172                         iint->measured_pcrs = 0;
 173                         if (update)
 174                                 ima_update_xattr(iint, file);
 175                 }
 176         }
 177         mutex_unlock(&iint->mutex);
 178 }
 179
 180 /**
 181  * ima_file_free - called on __fput()
 182  * @file: pointer to file structure being freed
 183  *
 184  * Flag files that changed, based on i_version
 185  */
 186 void ima_file_free(struct file *file)
 187 {
 188         struct inode *inode = file_inode(file);
 189         struct integrity_iint_cache *iint;
 190
 191         if (!ima_policy_flag || !S_ISREG(inode->i_mode))
 192                 return;
 193
 194         iint = integrity_iint_find(inode);
 195         if (!iint)
 196                 return;
 197
 198         ima_check_last_writer(iint, inode, file);
 199 }
 200
 201 static int process_measurement(struct file *file, const struct cred *cred,
 202                                u32 secid, char *buf, loff_t size, int mask,
 203                                enum ima_hooks func)
 204 {
 205         struct inode *inode = file_inode(file);
 206         struct integrity_iint_cache *iint = NULL;
 207         struct ima_template_desc *template_desc = NULL;
 208         char *pathbuf = NULL;
 209         char filename[NAME_MAX];
 210         const char *pathname = NULL;
 211         int rc = 0, action, must_appraise = 0;
 212         int pcr = CONFIG_IMA_MEASURE_PCR_IDX;
 213         struct evm_ima_xattr_data *xattr_value = NULL;
 214         struct modsig *modsig = NULL;
 215         int xattr_len = 0;
 216         bool violation_check;
 217         enum hash_algo hash_algo;
 218         unsigned int allowed_algos = 0;
 219
 220         if (!ima_policy_flag || !S_ISREG(inode->i_mode))
 221                 return 0;
 222
 223         /* Return an IMA_MEASURE, IMA_APPRAISE, IMA_AUDIT action
 224          * bitmask based on the appraise/audit/measurement policy.
 225          * Included is the appraise submask.
 226          */
 227         action = ima_get_action(file_mnt_user_ns(file), inode, cred, secid,
 228                                 mask, func, &pcr, &template_desc, NULL,
 229                                 &allowed_algos);
 230         violation_check = ((func == FILE_CHECK || func == MMAP_CHECK) &&
 231                            (ima_policy_flag & IMA_MEASURE));
 232         if (!action && !violation_check)
 233                 return 0;
 234
 235         must_appraise = action & IMA_APPRAISE;
 236
 237         /*  Is the appraise rule hook specific?  */
 238         if (action & IMA_FILE_APPRAISE)
 239                 func = FILE_CHECK;
 240
 241         inode_lock(inode);
 242
 243         if (action) {
 244                 iint = integrity_inode_get(inode);
 245                 if (!iint)
 246                         rc = -ENOMEM;
 247         }
 248
 249         if (!rc && violation_check)
 250                 ima_rdwr_violation_check(file, iint, action & IMA_MEASURE,
 251                                          &pathbuf, &pathname, filename);
 252
 253         inode_unlock(inode);
 254
 255         if (rc)
 256                 goto out;
 257         if (!action)
 258                 goto out;
 259
 260         mutex_lock(&iint->mutex);
 261
 262         if (test_and_clear_bit(IMA_CHANGE_ATTR, &iint->atomic_flags))
 263                 /* reset appraisal flags if ima_inode_post_setattr was called */
 264                 iint->flags &= ~(IMA_APPRAISE | IMA_APPRAISED |
 265                                  IMA_APPRAISE_SUBMASK | IMA_APPRAISED_SUBMASK |
 266                                  IMA_NONACTION_FLAGS);
 267
 268         /*
 269          * Re-evaulate the file if either the xattr has changed or the
 270          * kernel has no way of detecting file change on the filesystem.
 271          * (Limited to privileged mounted filesystems.)
 272          */
 273         if (test_and_clear_bit(IMA_CHANGE_XATTR, &iint->atomic_flags) ||
 274             ((inode->i_sb->s_iflags & SB_I_IMA_UNVERIFIABLE_SIGNATURE) &&
 275              !(inode->i_sb->s_iflags & SB_I_UNTRUSTED_MOUNTER) &&
 276              !(action & IMA_FAIL_UNVERIFIABLE_SIGS))) {
 277                 iint->flags &= ~IMA_DONE_MASK;
 278                 iint->measured_pcrs = 0;
 279         }
 280
 281         /* Determine if already appraised/measured based on bitmask
 282          * (IMA_MEASURE, IMA_MEASURED, IMA_XXXX_APPRAISE, IMA_XXXX_APPRAISED,
 283          *  IMA_AUDIT, IMA_AUDITED)
 284          */
 285         iint->flags |= action;
 286         action &= IMA_DO_MASK;
 287         action &= ~((iint->flags & (IMA_DONE_MASK ^ IMA_MEASURED)) >> 1);
 288
 289         /* If target pcr is already measured, unset IMA_MEASURE action */
 290         if ((action & IMA_MEASURE) && (iint->measured_pcrs & (0x1 << pcr)))
 291                 action ^= IMA_MEASURE;
 292
 293         /* HASH sets the digital signature and update flags, nothing else */
 294         if ((action & IMA_HASH) &&
 295             !(test_bit(IMA_DIGSIG, &iint->atomic_flags))) {
 296                 xattr_len = ima_read_xattr(file_dentry(file),
 297                                            &xattr_value, xattr_len);
 298                 if ((xattr_value && xattr_len > 2) &&
 299                     (xattr_value->type == EVM_IMA_XATTR_DIGSIG))
 300                         set_bit(IMA_DIGSIG, &iint->atomic_flags);
 301                 iint->flags |= IMA_HASHED;
 302                 action ^= IMA_HASH;
 303                 set_bit(IMA_UPDATE_XATTR, &iint->atomic_flags);
 304         }
 305
 306         /* Nothing to do, just return existing appraised status */
 307         if (!action) {
 308                 if (must_appraise) {
 309                         rc = mmap_violation_check(func, file, &pathbuf,
 310                                                   &pathname, filename);
 311                         if (!rc)
 312                                 rc = ima_get_cache_status(iint, func);
 313                 }
 314                 goto out_locked;
 315         }
 316
 317         if ((action & IMA_APPRAISE_SUBMASK) ||
 318             strcmp(template_desc->name, IMA_TEMPLATE_IMA_NAME) != 0) {
 319                 /* read 'security.ima' */
 320                 xattr_len = ima_read_xattr(file_dentry(file),
 321                                            &xattr_value, xattr_len);
 322
 323                 /*
 324                  * Read the appended modsig if allowed by the policy, and allow
 325                  * an additional measurement list entry, if needed, based on the
 326                  * template format and whether the file was already measured.
 327                  */
 328                 if (iint->flags & IMA_MODSIG_ALLOWED) {
 329                         rc = ima_read_modsig(func, buf, size, &modsig);
 330
 331                         if (!rc && ima_template_has_modsig(template_desc) &&
 332                             iint->flags & IMA_MEASURED)
 333                                 action |= IMA_MEASURE;
 334                 }
 335         }
 336
 337         hash_algo = ima_get_hash_algo(xattr_value, xattr_len);
 338
 339         rc = ima_collect_measurement(iint, file, buf, size, hash_algo, modsig);
 340         if (rc == -ENOMEM)
 341                 goto out_locked;
 342
 343         if (!pathbuf)   /* ima_rdwr_violation possibly pre-fetched */
 344                 pathname = ima_d_path(&file->f_path, &pathbuf, filename);
 345
 346         if (action & IMA_MEASURE)
 347                 ima_store_measurement(iint, file, pathname,
 348                                       xattr_value, xattr_len, modsig, pcr,
 349                                       template_desc);
 350         if (rc == 0 && (action & IMA_APPRAISE_SUBMASK)) {
 351                 rc = ima_check_blacklist(iint, modsig, pcr);
 352                 if (rc != -EPERM) {
 353                         inode_lock(inode);
 354                         rc = ima_appraise_measurement(func, iint, file,
 355                                                       pathname, xattr_value,
 356                                                       xattr_len, modsig);
 357                         inode_unlock(inode);
 358                 }
 359                 if (!rc)
 360                         rc = mmap_violation_check(func, file, &pathbuf,
 361                                                   &pathname, filename);
 362         }
 363         if (action & IMA_AUDIT)
 364                 ima_audit_measurement(iint, pathname);
 365
 366         if ((file->f_flags & O_DIRECT) && (iint->flags & IMA_PERMIT_DIRECTIO))
 367                 rc = 0;
 368
 369         /* Ensure the digest was generated using an allowed algorithm */
 370         if (rc == 0 && must_appraise && allowed_algos != 0 &&
 371             (allowed_algos & (1U << hash_algo)) == 0) {
 372                 rc = -EACCES;
 373
 374                 integrity_audit_msg(AUDIT_INTEGRITY_DATA, file_inode(file),
 375                                     pathname, "collect_data",
 376                                     "denied-hash-algorithm", rc, 0);
 377         }
 378 out_locked:
 379         if ((mask & MAY_WRITE) && test_bit(IMA_DIGSIG, &iint->atomic_flags) &&
 380              !(iint->flags & IMA_NEW_FILE))
 381                 rc = -EACCES;
 382         mutex_unlock(&iint->mutex);
 383         kfree(xattr_value);
 384         ima_free_modsig(modsig);
 385 out:
 386         if (pathbuf)
 387                 __putname(pathbuf);
 388         if (must_appraise) {
 389                 if (rc && (ima_appraise & IMA_APPRAISE_ENFORCE))
 390                         return -EACCES;
 391                 if (file->f_mode & FMODE_WRITE)
 392                         set_bit(IMA_UPDATE_XATTR, &iint->atomic_flags);
 393         }
 394         return 0;
 395 }
 396
 397 /**
 398  * ima_file_mmap - based on policy, collect/store measurement.
 399  * @file: pointer to the file to be measured (May be NULL)
 400  * @prot: contains the protection that will be applied by the kernel.
 401  *
 402  * Measure files being mmapped executable based on the ima_must_measure()
 403  * policy decision.
 404  *
 405  * On success return 0.  On integrity appraisal error, assuming the file
 406  * is in policy and IMA-appraisal is in enforcing mode, return -EACCES.
 407  */
 408 int ima_file_mmap(struct file *file, unsigned long prot)
 409 {
 410         u32 secid;
 411
 412         if (file && (prot & PROT_EXEC)) {
 413                 security_current_getsecid_subj(&secid);
 414                 return process_measurement(file, current_cred(), secid, NULL,
 415                                            0, MAY_EXEC, MMAP_CHECK);
 416         }
 417
 418         return 0;
 419 }
 420
 421 /**
 422  * ima_file_mprotect - based on policy, limit mprotect change
 423  * @vma: vm_area_struct protection is set to
 424  * @prot: contains the protection that will be applied by the kernel.
 425  *
 426  * Files can be mmap'ed read/write and later changed to execute to circumvent
 427  * IMA's mmap appraisal policy rules.  Due to locking issues (mmap semaphore
 428  * would be taken before i_mutex), files can not be measured or appraised at
 429  * this point.  Eliminate this integrity gap by denying the mprotect
 430  * PROT_EXECUTE change, if an mmap appraise policy rule exists.
 431  *
 432  * On mprotect change success, return 0.  On failure, return -EACESS.
 433  */
 434 int ima_file_mprotect(struct vm_area_struct *vma, unsigned long prot)
 435 {
 436         struct ima_template_desc *template = NULL;
 437         struct file *file;
 438         char filename[NAME_MAX];
 439         char *pathbuf = NULL;
 440         const char *pathname = NULL;
 441         struct inode *inode;
 442         int result = 0;
 443         int action;
 444         u32 secid;
 445         int pcr;
 446
 447         /* Is mprotect making an mmap'ed file executable? */
 448         if (!(ima_policy_flag & IMA_APPRAISE) || !vma->vm_file ||
 449             !(prot & PROT_EXEC) || (vma->vm_flags & VM_EXEC))
 450                 return 0;
 451
 452         security_current_getsecid_subj(&secid);
 453         inode = file_inode(vma->vm_file);
 454         action = ima_get_action(file_mnt_user_ns(vma->vm_file), inode,
 455                                 current_cred(), secid, MAY_EXEC, MMAP_CHECK,
 456                                 &pcr, &template, NULL, NULL);
 457
 458         /* Is the mmap'ed file in policy? */
 459         if (!(action & (IMA_MEASURE | IMA_APPRAISE_SUBMASK)))
 460                 return 0;
 461
 462         if (action & IMA_APPRAISE_SUBMASK)
 463                 result = -EPERM;
 464
 465         file = vma->vm_file;
 466         pathname = ima_d_path(&file->f_path, &pathbuf, filename);
 467         integrity_audit_msg(AUDIT_INTEGRITY_DATA, inode, pathname,
 468                             "collect_data", "failed-mprotect", result, 0);
 469         if (pathbuf)
 470                 __putname(pathbuf);
 471
 472         return result;
 473 }
 474
 475 /**
 476  * ima_bprm_check - based on policy, collect/store measurement.
 477  * @bprm: contains the linux_binprm structure
 478  *
 479  * The OS protects against an executable file, already open for write,
 480  * from being executed in deny_write_access() and an executable file,
 481  * already open for execute, from being modified in get_write_access().
 482  * So we can be certain that what we verify and measure here is actually
 483  * what is being executed.
 484  *
 485  * On success return 0.  On integrity appraisal error, assuming the file
 486  * is in policy and IMA-appraisal is in enforcing mode, return -EACCES.
 487  */
 488 int ima_bprm_check(struct linux_binprm *bprm)
 489 {
 490         int ret;
 491         u32 secid;
 492
 493         security_current_getsecid_subj(&secid);
 494         ret = process_measurement(bprm->file, current_cred(), secid, NULL, 0,
 495                                   MAY_EXEC, BPRM_CHECK);
 496         if (ret)
 497                 return ret;
 498
 499         security_cred_getsecid(bprm->cred, &secid);
 500         return process_measurement(bprm->file, bprm->cred, secid, NULL, 0,
 501                                    MAY_EXEC, CREDS_CHECK);
 502 }
 503
 504 /**
 505  * ima_file_check - based on policy, collect/store measurement.
 506  * @file: pointer to the file to be measured
 507  * @mask: contains MAY_READ, MAY_WRITE, MAY_EXEC or MAY_APPEND
 508  *
 509  * Measure files based on the ima_must_measure() policy decision.
 510  *
 511  * On success return 0.  On integrity appraisal error, assuming the file
 512  * is in policy and IMA-appraisal is in enforcing mode, return -EACCES.
 513  */
 514 int ima_file_check(struct file *file, int mask)
 515 {
 516         u32 secid;
 517
 518         security_current_getsecid_subj(&secid);
 519         return process_measurement(file, current_cred(), secid, NULL, 0,
 520                                    mask & (MAY_READ | MAY_WRITE | MAY_EXEC |
 521                                            MAY_APPEND), FILE_CHECK);
 522 }
 523 EXPORT_SYMBOL_GPL(ima_file_check);
 524
 525 static int __ima_inode_hash(struct inode *inode, struct file *file, char *buf,
 526                             size_t buf_size)
 527 {
 528         struct integrity_iint_cache *iint = NULL, tmp_iint;
 529         int rc, hash_algo;
 530
 531         if (ima_policy_flag) {
 532                 iint = integrity_iint_find(inode);
 533                 if (iint)
 534                         mutex_lock(&iint->mutex);
 535         }
 536
 537         if ((!iint || !(iint->flags & IMA_COLLECTED)) && file) {
 538                 if (iint)
 539                         mutex_unlock(&iint->mutex);
 540
 541                 memset(&tmp_iint, 0, sizeof(tmp_iint));
 542                 tmp_iint.inode = inode;
 543                 mutex_init(&tmp_iint.mutex);
 544
 545                 rc = ima_collect_measurement(&tmp_iint, file, NULL, 0,
 546                                              ima_hash_algo, NULL);
 547                 if (rc < 0) {
 548                         /* ima_hash could be allocated in case of failure. */
 549                         if (rc != -ENOMEM)
 550                                 kfree(tmp_iint.ima_hash);
 551
 552                         return -EOPNOTSUPP;
 553                 }
 554
 555                 iint = &tmp_iint;
 556                 mutex_lock(&iint->mutex);
 557         }
 558
 559         if (!iint)
 560                 return -EOPNOTSUPP;
 561
 562         /*
 563          * ima_file_hash can be called when ima_collect_measurement has still
 564          * not been called, we might not always have a hash.
 565          */
 566         if (!iint->ima_hash) {
 567                 mutex_unlock(&iint->mutex);
 568                 return -EOPNOTSUPP;
 569         }
 570
 571         if (buf) {
 572                 size_t copied_size;
 573
 574                 copied_size = min_t(size_t, iint->ima_hash->length, buf_size);
 575                 memcpy(buf, iint->ima_hash->digest, copied_size);
 576         }
 577         hash_algo = iint->ima_hash->algo;
 578         mutex_unlock(&iint->mutex);
 579
 580         if (iint == &tmp_iint)
 581                 kfree(iint->ima_hash);
 582
 583         return hash_algo;
 584 }
 585
 586 /**
 587  * ima_file_hash - return a measurement of the file
 588  * @file: pointer to the file
 589  * @buf: buffer in which to store the hash
 590  * @buf_size: length of the buffer
 591  *
 592  * On success, return the hash algorithm (as defined in the enum hash_algo).
 593  * If buf is not NULL, this function also outputs the hash into buf.
 594  * If the hash is larger than buf_size, then only buf_size bytes will be copied.
 595  * It generally just makes sense to pass a buffer capable of holding the largest
 596  * possible hash: IMA_MAX_DIGEST_SIZE.
 597  * The file hash returned is based on the entire file, including the appended
 598  * signature.
 599  *
 600  * If the measurement cannot be performed, return -EOPNOTSUPP.
 601  * If the parameters are incorrect, return -EINVAL.
 602  */
 603 int ima_file_hash(struct file *file, char *buf, size_t buf_size)
 604 {
 605         if (!file)
 606                 return -EINVAL;
 607
 608         return __ima_inode_hash(file_inode(file), file, buf, buf_size);
 609 }
 610 EXPORT_SYMBOL_GPL(ima_file_hash);
 611
 612 /**
 613  * ima_inode_hash - return the stored measurement if the inode has been hashed
 614  * and is in the iint cache.
 615  * @inode: pointer to the inode
 616  * @buf: buffer in which to store the hash
 617  * @buf_size: length of the buffer
 618  *
 619  * On success, return the hash algorithm (as defined in the enum hash_algo).
 620  * If buf is not NULL, this function also outputs the hash into buf.
 621  * If the hash is larger than buf_size, then only buf_size bytes will be copied.
 622  * It generally just makes sense to pass a buffer capable of holding the largest
 623  * possible hash: IMA_MAX_DIGEST_SIZE.
 624  * The hash returned is based on the entire contents, including the appended
 625  * signature.
 626  *
 627  * If IMA is disabled or if no measurement is available, return -EOPNOTSUPP.
 628  * If the parameters are incorrect, return -EINVAL.
 629  */
 630 int ima_inode_hash(struct inode *inode, char *buf, size_t buf_size)
 631 {
 632         if (!inode)
 633                 return -EINVAL;
 634
 635         return __ima_inode_hash(inode, NULL, buf, buf_size);
 636 }
 637 EXPORT_SYMBOL_GPL(ima_inode_hash);
 638
 639 /**
 640  * ima_post_create_tmpfile - mark newly created tmpfile as new
 641  * @mnt_userns: user namespace of the mount the inode was found from
 642  * @inode: inode of the newly created tmpfile
 643  *
 644  * No measuring, appraising or auditing of newly created tmpfiles is needed.
 645  * Skip calling process_measurement(), but indicate which newly, created
 646  * tmpfiles are in policy.
 647  */
 648 void ima_post_create_tmpfile(struct user_namespace *mnt_userns,
 649                              struct inode *inode)
 650 {
 651         struct integrity_iint_cache *iint;
 652         int must_appraise;
 653
 654         if (!ima_policy_flag || !S_ISREG(inode->i_mode))
 655                 return;
 656
 657         must_appraise = ima_must_appraise(mnt_userns, inode, MAY_ACCESS,
 658                                           FILE_CHECK);
 659         if (!must_appraise)
 660                 return;
 661
 662         /* Nothing to do if we can't allocate memory */
 663         iint = integrity_inode_get(inode);
 664         if (!iint)
 665                 return;
 666
 667         /* needed for writing the security xattrs */
 668         set_bit(IMA_UPDATE_XATTR, &iint->atomic_flags);
 669         iint->ima_file_status = INTEGRITY_PASS;
 670 }
 671
 672 /**
 673  * ima_post_path_mknod - mark as a new inode
 674  * @mnt_userns: user namespace of the mount the inode was found from
 675  * @dentry: newly created dentry
 676  *
 677  * Mark files created via the mknodat syscall as new, so that the
 678  * file data can be written later.
 679  */
 680 void ima_post_path_mknod(struct user_namespace *mnt_userns,
 681                          struct dentry *dentry)
 682 {
 683         struct integrity_iint_cache *iint;
 684         struct inode *inode = dentry->d_inode;
 685         int must_appraise;
 686
 687         if (!ima_policy_flag || !S_ISREG(inode->i_mode))
 688                 return;
 689
 690         must_appraise = ima_must_appraise(mnt_userns, inode, MAY_ACCESS,
 691                                           FILE_CHECK);
 692         if (!must_appraise)
 693                 return;
 694
 695         /* Nothing to do if we can't allocate memory */
 696         iint = integrity_inode_get(inode);
 697         if (!iint)
 698                 return;
 699
 700         /* needed for re-opening empty files */
 701         iint->flags |= IMA_NEW_FILE;
 702 }
 703
 704 /**
 705  * ima_read_file - pre-measure/appraise hook decision based on policy
 706  * @file: pointer to the file to be measured/appraised/audit
 707  * @read_id: caller identifier
 708  * @contents: whether a subsequent call will be made to ima_post_read_file()
 709  *
 710  * Permit reading a file based on policy. The policy rules are written
 711  * in terms of the policy identifier.  Appraising the integrity of
 712  * a file requires a file descriptor.
 713  *
 714  * For permission return 0, otherwise return -EACCES.
 715  */
 716 int ima_read_file(struct file *file, enum kernel_read_file_id read_id,
 717                   bool contents)
 718 {
 719         enum ima_hooks func;
 720         u32 secid;
 721
 722         /*
 723          * Do devices using pre-allocated memory run the risk of the
 724          * firmware being accessible to the device prior to the completion
 725          * of IMA's signature verification any more than when using two
 726          * buffers? It may be desirable to include the buffer address
 727          * in this API and walk all the dma_map_single() mappings to check.
 728          */
 729
 730         /*
 731          * There will be a call made to ima_post_read_file() with
 732          * a filled buffer, so we don't need to perform an extra
 733          * read early here.
 734          */
 735         if (contents)
 736                 return 0;
 737
 738         /* Read entire file for all partial reads. */
 739         func = read_idmap[read_id] ?: FILE_CHECK;
 740         security_current_getsecid_subj(&secid);
 741         return process_measurement(file, current_cred(), secid, NULL,
 742                                    0, MAY_READ, func);
 743 }
 744
 745 const int read_idmap[READING_MAX_ID] = {
 746         [READING_FIRMWARE] = FIRMWARE_CHECK,
 747         [READING_MODULE] = MODULE_CHECK,
 748         [READING_KEXEC_IMAGE] = KEXEC_KERNEL_CHECK,
 749         [READING_KEXEC_INITRAMFS] = KEXEC_INITRAMFS_CHECK,
 750         [READING_POLICY] = POLICY_CHECK
 751 };
 752
 753 /**
 754  * ima_post_read_file - in memory collect/appraise/audit measurement
 755  * @file: pointer to the file to be measured/appraised/audit
 756  * @buf: pointer to in memory file contents
 757  * @size: size of in memory file contents
 758  * @read_id: caller identifier
 759  *
 760  * Measure/appraise/audit in memory file based on policy.  Policy rules
 761  * are written in terms of a policy identifier.
 762  *
 763  * On success return 0.  On integrity appraisal error, assuming the file
 764  * is in policy and IMA-appraisal is in enforcing mode, return -EACCES.
 765  */
 766 int ima_post_read_file(struct file *file, void *buf, loff_t size,
 767                        enum kernel_read_file_id read_id)
 768 {
 769         enum ima_hooks func;
 770         u32 secid;
 771
 772         /* permit signed certs */
 773         if (!file && read_id == READING_X509_CERTIFICATE)
 774                 return 0;
 775
 776         if (!file || !buf || size == 0) { /* should never happen */
 777                 if (ima_appraise & IMA_APPRAISE_ENFORCE)
 778                         return -EACCES;
 779                 return 0;
 780         }
 781
 782         func = read_idmap[read_id] ?: FILE_CHECK;
 783         security_current_getsecid_subj(&secid);
 784         return process_measurement(file, current_cred(), secid, buf, size,
 785                                    MAY_READ, func);
 786 }
 787
 788 /**
 789  * ima_load_data - appraise decision based on policy
 790  * @id: kernel load data caller identifier
 791  * @contents: whether the full contents will be available in a later
 792  *            call to ima_post_load_data().
 793  *
 794  * Callers of this LSM hook can not measure, appraise, or audit the
 795  * data provided by userspace.  Enforce policy rules requiring a file
 796  * signature (eg. kexec'ed kernel image).
 797  *
 798  * For permission return 0, otherwise return -EACCES.
 799  */
 800 int ima_load_data(enum kernel_load_data_id id, bool contents)
 801 {
 802         bool ima_enforce, sig_enforce;
 803
 804         ima_enforce =
 805                 (ima_appraise & IMA_APPRAISE_ENFORCE) == IMA_APPRAISE_ENFORCE;
 806
 807         switch (id) {
 808         case LOADING_KEXEC_IMAGE:
 809                 if (IS_ENABLED(CONFIG_KEXEC_SIG)
 810                     && arch_ima_get_secureboot()) {
 811                         pr_err("impossible to appraise a kernel image without a file descriptor; try using kexec_file_load syscall.\n");
 812                         return -EACCES;
 813                 }
 814
 815                 if (ima_enforce && (ima_appraise & IMA_APPRAISE_KEXEC)) {
 816                         pr_err("impossible to appraise a kernel image without a file descriptor; try using kexec_file_load syscall.\n");
 817                         return -EACCES; /* INTEGRITY_UNKNOWN */
 818                 }
 819                 break;
 820         case LOADING_FIRMWARE:
 821                 if (ima_enforce && (ima_appraise & IMA_APPRAISE_FIRMWARE) && !contents) {
 822                         pr_err("Prevent firmware sysfs fallback loading.\n");
 823                         return -EACCES; /* INTEGRITY_UNKNOWN */
 824                 }
 825                 break;
 826         case LOADING_MODULE:
 827                 sig_enforce = is_module_sig_enforced();
 828
 829                 if (ima_enforce && (!sig_enforce
 830                                     && (ima_appraise & IMA_APPRAISE_MODULES))) {
 831                         pr_err("impossible to appraise a module without a file descriptor. sig_enforce kernel parameter might help\n");
 832                         return -EACCES; /* INTEGRITY_UNKNOWN */
 833                 }
 834                 break;
 835         default:
 836                 break;
 837         }
 838         return 0;
 839 }
 840
 841 /**
 842  * ima_post_load_data - appraise decision based on policy
 843  * @buf: pointer to in memory file contents
 844  * @size: size of in memory file contents
 845  * @load_id: kernel load data caller identifier
 846  * @description: @load_id-specific description of contents
 847  *
 848  * Measure/appraise/audit in memory buffer based on policy.  Policy rules
 849  * are written in terms of a policy identifier.
 850  *
 851  * On success return 0.  On integrity appraisal error, assuming the file
 852  * is in policy and IMA-appraisal is in enforcing mode, return -EACCES.
 853  */
 854 int ima_post_load_data(char *buf, loff_t size,
 855                        enum kernel_load_data_id load_id,
 856                        char *description)
 857 {
 858         if (load_id == LOADING_FIRMWARE) {
 859                 if ((ima_appraise & IMA_APPRAISE_FIRMWARE) &&
 860                     (ima_appraise & IMA_APPRAISE_ENFORCE)) {
 861                         pr_err("Prevent firmware loading_store.\n");
 862                         return -EACCES; /* INTEGRITY_UNKNOWN */
 863                 }
 864                 return 0;
 865         }
 866
 867         return 0;
 868 }
 869
 870 /**
 871  * process_buffer_measurement - Measure the buffer or the buffer data hash
 872  * @mnt_userns: user namespace of the mount the inode was found from
 873  * @inode: inode associated with the object being measured (NULL for KEY_CHECK)
 874  * @buf: pointer to the buffer that needs to be added to the log.
 875  * @size: size of buffer(in bytes).
 876  * @eventname: event name to be used for the buffer entry.
 877  * @func: IMA hook
 878  * @pcr: pcr to extend the measurement
 879  * @func_data: func specific data, may be NULL
 880  * @buf_hash: measure buffer data hash
 881  * @digest: buffer digest will be written to
 882  * @digest_len: buffer length
 883  *
 884  * Based on policy, either the buffer data or buffer data hash is measured
 885  *
 886  * Return: 0 if the buffer has been successfully measured, 1 if the digest
 887  * has been written to the passed location but not added to a measurement entry,
 888  * a negative value otherwise.
 889  */
 890 int process_buffer_measurement(struct user_namespace *mnt_userns,
 891                                struct inode *inode, const void *buf, int size,
 892                                const char *eventname, enum ima_hooks func,
 893                                int pcr, const char *func_data,
 894                                bool buf_hash, u8 *digest, size_t digest_len)
 895 {
 896         int ret = 0;
 897         const char *audit_cause = "ENOMEM";
 898         struct ima_template_entry *entry = NULL;
 899         struct integrity_iint_cache iint = {};
 900         struct ima_event_data event_data = {.iint = &iint,
 901                                             .filename = eventname,
 902                                             .buf = buf,
 903                                             .buf_len = size};
 904         struct ima_template_desc *template;
 905         struct ima_max_digest_data hash;
 906         char digest_hash[IMA_MAX_DIGEST_SIZE];
 907         int digest_hash_len = hash_digest_size[ima_hash_algo];
 908         int violation = 0;
 909         int action = 0;
 910         u32 secid;
 911
 912         if (digest && digest_len < digest_hash_len)
 913                 return -EINVAL;
 914
 915         if (!ima_policy_flag && !digest)
 916                 return -ENOENT;
 917
 918         template = ima_template_desc_buf();
 919         if (!template) {
 920                 ret = -EINVAL;
 921                 audit_cause = "ima_template_desc_buf";
 922                 goto out;
 923         }
 924
 925         /*
 926          * Both LSM hooks and auxilary based buffer measurements are
 927          * based on policy.  To avoid code duplication, differentiate
 928          * between the LSM hooks and auxilary buffer measurements,
 929          * retrieving the policy rule information only for the LSM hook
 930          * buffer measurements.
 931          */
 932         if (func) {
 933                 security_current_getsecid_subj(&secid);
 934                 action = ima_get_action(mnt_userns, inode, current_cred(),
 935                                         secid, 0, func, &pcr, &template,
 936                                         func_data, NULL);
 937                 if (!(action & IMA_MEASURE) && !digest)
 938                         return -ENOENT;
 939         }
 940
 941         if (!pcr)
 942                 pcr = CONFIG_IMA_MEASURE_PCR_IDX;
 943
 944         iint.ima_hash = &hash.hdr;
 945         iint.ima_hash->algo = ima_hash_algo;
 946         iint.ima_hash->length = hash_digest_size[ima_hash_algo];
 947
 948         ret = ima_calc_buffer_hash(buf, size, iint.ima_hash);
 949         if (ret < 0) {
 950                 audit_cause = "hashing_error";
 951                 goto out;
 952         }
 953
 954         if (buf_hash) {
 955                 memcpy(digest_hash, hash.hdr.digest, digest_hash_len);
 956
 957                 ret = ima_calc_buffer_hash(digest_hash, digest_hash_len,
 958                                            iint.ima_hash);
 959                 if (ret < 0) {
 960                         audit_cause = "hashing_error";
 961                         goto out;
 962                 }
 963
 964                 event_data.buf = digest_hash;
 965                 event_data.buf_len = digest_hash_len;
 966         }
 967
 968         if (digest)
 969                 memcpy(digest, iint.ima_hash->digest, digest_hash_len);
 970
 971         if (!ima_policy_flag || (func && !(action & IMA_MEASURE)))
 972                 return 1;
 973
 974         ret = ima_alloc_init_template(&event_data, &entry, template);
 975         if (ret < 0) {
 976                 audit_cause = "alloc_entry";
 977                 goto out;
 978         }
 979
 980         ret = ima_store_template(entry, violation, NULL, event_data.buf, pcr);
 981         if (ret < 0) {
 982                 audit_cause = "store_entry";
 983                 ima_free_template_entry(entry);
 984         }
 985
 986 out:
 987         if (ret < 0)
 988                 integrity_audit_message(AUDIT_INTEGRITY_PCR, NULL, eventname,
 989                                         func_measure_str(func),
 990                                         audit_cause, ret, 0, ret);
 991
 992         return ret;
 993 }
 994
 995 /**
 996  * ima_kexec_cmdline - measure kexec cmdline boot args
 997  * @kernel_fd: file descriptor of the kexec kernel being loaded
 998  * @buf: pointer to buffer
 999  * @size: size of buffer
1000  *
1001  * Buffers can only be measured, not appraised.
1002  */
1003 void ima_kexec_cmdline(int kernel_fd, const void *buf, int size)
1004 {
1005         struct fd f;
1006
1007         if (!buf || !size)
1008                 return;
1009
1010         f = fdget(kernel_fd);
1011         if (!f.file)
1012                 return;
1013
1014         process_buffer_measurement(file_mnt_user_ns(f.file), file_inode(f.file),
1015                                    buf, size, "kexec-cmdline", KEXEC_CMDLINE, 0,
1016                                    NULL, false, NULL, 0);
1017         fdput(f);
1018 }
1019
1020 /**
1021  * ima_measure_critical_data - measure kernel integrity critical data
1022  * @event_label: unique event label for grouping and limiting critical data
1023  * @event_name: event name for the record in the IMA measurement list
1024  * @buf: pointer to buffer data
1025  * @buf_len: length of buffer data (in bytes)
1026  * @hash: measure buffer data hash
1027  * @digest: buffer digest will be written to
1028  * @digest_len: buffer length
1029  *
1030  * Measure data critical to the integrity of the kernel into the IMA log
1031  * and extend the pcr.  Examples of critical data could be various data
1032  * structures, policies, and states stored in kernel memory that can
1033  * impact the integrity of the system.
1034  *
1035  * Return: 0 if the buffer has been successfully measured, 1 if the digest
1036  * has been written to the passed location but not added to a measurement entry,
1037  * a negative value otherwise.
1038  */
1039 int ima_measure_critical_data(const char *event_label,
1040                               const char *event_name,
1041                               const void *buf, size_t buf_len,
1042                               bool hash, u8 *digest, size_t digest_len)
1043 {
1044         if (!event_name || !event_label || !buf || !buf_len)
1045                 return -ENOPARAM;
1046
1047         return process_buffer_measurement(&init_user_ns, NULL, buf, buf_len,
1048                                           event_name, CRITICAL_DATA, 0,
1049                                           event_label, hash, digest,
1050                                           digest_len);
1051 }
1052 EXPORT_SYMBOL_GPL(ima_measure_critical_data);
1053
1054 static int __init init_ima(void)
1055 {
1056         int error;
1057
1058         ima_appraise_parse_cmdline();
1059         ima_init_template_list();
1060         hash_setup(CONFIG_IMA_DEFAULT_HASH);
1061         error = ima_init();
1062
1063         if (error && strcmp(hash_algo_name[ima_hash_algo],
1064                             CONFIG_IMA_DEFAULT_HASH) != 0) {
1065                 pr_info("Allocating %s failed, going to use default hash algorithm %s\n",
1066                         hash_algo_name[ima_hash_algo], CONFIG_IMA_DEFAULT_HASH);
1067                 hash_setup_done = 0;
1068                 hash_setup(CONFIG_IMA_DEFAULT_HASH);
1069                 error = ima_init();
1070         }
1071
1072         if (error)
1073                 return error;
1074
1075         error = register_blocking_lsm_notifier(&ima_lsm_policy_notifier);
1076         if (error)
1077                 pr_warn("Couldn't register LSM notifier, error %d\n", error);
1078
1079         if (!error)
1080                 ima_update_policy_flags();
1081
1082         return error;
1083 }
1084
1085 late_initcall(init_ima);        /* Start IMA after the TPM is available */