security/integrity/ima/ima_api.c

   1 /*
   2  * Copyright (C) 2008 IBM Corporation
   3  *
   4  * Author: Mimi Zohar <zohar@us.ibm.com>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation, version 2 of the
   9  * License.
  10  *
  11  * File: ima_api.c
  12  *      Implements must_appraise_or_measure, collect_measurement,
  13  *      appraise_measurement, store_measurement and store_template.
  14  */
  15 #include <linux/module.h>
  16 #include <linux/slab.h>
  17 #include <linux/file.h>
  18 #include <linux/fs.h>
  19 #include <linux/xattr.h>
  20 #include <linux/evm.h>
  21 #include <crypto/hash_info.h>
  22 #include "ima.h"
  23
  24 /*
  25  * ima_alloc_init_template - create and initialize a new template entry
  26  */
  27 int ima_alloc_init_template(struct integrity_iint_cache *iint,
  28                             struct file *file, const unsigned char *filename,
  29                             struct evm_ima_xattr_data *xattr_value,
  30                             int xattr_len, struct ima_template_entry **entry)
  31 {
  32         struct ima_template_desc *template_desc = ima_template_desc_current();
  33         int i, result = 0;
  34
  35         *entry = kzalloc(sizeof(**entry) + template_desc->num_fields *
  36                          sizeof(struct ima_field_data), GFP_NOFS);
  37         if (!*entry)
  38                 return -ENOMEM;
  39
  40         for (i = 0; i < template_desc->num_fields; i++) {
  41                 struct ima_template_field *field = template_desc->fields[i];
  42                 u32 len;
  43
  44                 result = field->field_init(iint, file, filename,
  45                                            xattr_value, xattr_len,
  46                                            &((*entry)->template_data[i]));
  47                 if (result != 0)
  48                         goto out;
  49
  50                 len = (*entry)->template_data[i].len;
  51                 (*entry)->template_data_len += sizeof(len);
  52                 (*entry)->template_data_len += len;
  53         }
  54         (*entry)->template_desc = template_desc;
  55         return 0;
  56 out:
  57         kfree(*entry);
  58         *entry = NULL;
  59         return result;
  60 }
  61
  62 /*
  63  * ima_store_template - store ima template measurements
  64  *
  65  * Calculate the hash of a template entry, add the template entry
  66  * to an ordered list of measurement entries maintained inside the kernel,
  67  * and also update the aggregate integrity value (maintained inside the
  68  * configured TPM PCR) over the hashes of the current list of measurement
  69  * entries.
  70  *
  71  * Applications retrieve the current kernel-held measurement list through
  72  * the securityfs entries in /sys/kernel/security/ima. The signed aggregate
  73  * TPM PCR (called quote) can be retrieved using a TPM user space library
  74  * and is used to validate the measurement list.
  75  *
  76  * Returns 0 on success, error code otherwise
  77  */
  78 int ima_store_template(struct ima_template_entry *entry,
  79                        int violation, struct inode *inode,
  80                        const unsigned char *filename)
  81 {
  82         const char *op = "add_template_measure";
  83         const char *audit_cause = "hashing_error";
  84         char *template_name = entry->template_desc->name;
  85         int result;
  86         struct {
  87                 struct ima_digest_data hdr;
  88                 char digest[TPM_DIGEST_SIZE];
  89         } hash;
  90
  91         if (!violation) {
  92                 int num_fields = entry->template_desc->num_fields;
  93
  94                 /* this function uses default algo */
  95                 hash.hdr.algo = HASH_ALGO_SHA1;
  96                 result = ima_calc_field_array_hash(&entry->template_data[0],
  97                                                    entry->template_desc,
  98                                                    num_fields, &hash.hdr);
  99                 if (result < 0) {
 100                         integrity_audit_msg(AUDIT_INTEGRITY_PCR, inode,
 101                                             template_name, op,
 102                                             audit_cause, result, 0);
 103                         return result;
 104                 }
 105                 memcpy(entry->digest, hash.hdr.digest, hash.hdr.length);
 106         }
 107         result = ima_add_template_entry(entry, violation, op, inode, filename);
 108         return result;
 109 }
 110
 111 /*
 112  * ima_add_violation - add violation to measurement list.
 113  *
 114  * Violations are flagged in the measurement list with zero hash values.
 115  * By extending the PCR with 0xFF's instead of with zeroes, the PCR
 116  * value is invalidated.
 117  */
 118 void ima_add_violation(struct file *file, const unsigned char *filename,
 119                        const char *op, const char *cause)
 120 {
 121         struct ima_template_entry *entry;
 122         struct inode *inode = file->f_dentry->d_inode;
 123         int violation = 1;
 124         int result;
 125
 126         /* can overflow, only indicator */
 127         atomic_long_inc(&ima_htable.violations);
 128
 129         result = ima_alloc_init_template(NULL, file, filename,
 130                                          NULL, 0, &entry);
 131         if (result < 0) {
 132                 result = -ENOMEM;
 133                 goto err_out;
 134         }
 135         result = ima_store_template(entry, violation, inode, filename);
 136         if (result < 0)
 137                 kfree(entry);
 138 err_out:
 139         integrity_audit_msg(AUDIT_INTEGRITY_PCR, inode, filename,
 140                             op, cause, result, 0);
 141 }
 142
 143 /**
 144  * ima_get_action - appraise & measure decision based on policy.
 145  * @inode: pointer to inode to measure
 146  * @mask: contains the permission mask (MAY_READ, MAY_WRITE, MAY_EXECUTE)
 147  * @function: calling function (FILE_CHECK, BPRM_CHECK, MMAP_CHECK, MODULE_CHECK)
 148  *
 149  * The policy is defined in terms of keypairs:
 150  *              subj=, obj=, type=, func=, mask=, fsmagic=
 151  *      subj,obj, and type: are LSM specific.
 152  *      func: FILE_CHECK | BPRM_CHECK | MMAP_CHECK | MODULE_CHECK
 153  *      mask: contains the permission mask
 154  *      fsmagic: hex value
 155  *
 156  * Returns IMA_MEASURE, IMA_APPRAISE mask.
 157  *
 158  */
 159 int ima_get_action(struct inode *inode, int mask, int function)
 160 {
 161         int flags = IMA_MEASURE | IMA_AUDIT | IMA_APPRAISE;
 162
 163         if (!ima_appraise)
 164                 flags &= ~IMA_APPRAISE;
 165
 166         return ima_match_policy(inode, function, mask, flags);
 167 }
 168
 169 int ima_must_measure(struct inode *inode, int mask, int function)
 170 {
 171         return ima_match_policy(inode, function, mask, IMA_MEASURE);
 172 }
 173
 174 /*
 175  * ima_collect_measurement - collect file measurement
 176  *
 177  * Calculate the file hash, if it doesn't already exist,
 178  * storing the measurement and i_version in the iint.
 179  *
 180  * Must be called with iint->mutex held.
 181  *
 182  * Return 0 on success, error code otherwise
 183  */
 184 int ima_collect_measurement(struct integrity_iint_cache *iint,
 185                             struct file *file,
 186                             struct evm_ima_xattr_data **xattr_value,
 187                             int *xattr_len)
 188 {
 189         struct inode *inode = file_inode(file);
 190         const char *filename = file->f_dentry->d_name.name;
 191         int result = 0;
 192         struct {
 193                 struct ima_digest_data hdr;
 194                 char digest[IMA_MAX_DIGEST_SIZE];
 195         } hash;
 196
 197         if (xattr_value)
 198                 *xattr_len = ima_read_xattr(file->f_dentry, xattr_value);
 199
 200         if (!(iint->flags & IMA_COLLECTED)) {
 201                 u64 i_version = file_inode(file)->i_version;
 202
 203                 /* use default hash algorithm */
 204                 hash.hdr.algo = ima_hash_algo;
 205
 206                 if (xattr_value)
 207                         ima_get_hash_algo(*xattr_value, *xattr_len, &hash.hdr);
 208
 209                 result = ima_calc_file_hash(file, &hash.hdr);
 210                 if (!result) {
 211                         int length = sizeof(hash.hdr) + hash.hdr.length;
 212                         void *tmpbuf = krealloc(iint->ima_hash, length,
 213                                                 GFP_NOFS);
 214                         if (tmpbuf) {
 215                                 iint->ima_hash = tmpbuf;
 216                                 memcpy(iint->ima_hash, &hash, length);
 217                                 iint->version = i_version;
 218                                 iint->flags |= IMA_COLLECTED;
 219                         } else
 220                                 result = -ENOMEM;
 221                 }
 222         }
 223         if (result)
 224                 integrity_audit_msg(AUDIT_INTEGRITY_DATA, inode,
 225                                     filename, "collect_data", "failed",
 226                                     result, 0);
 227         return result;
 228 }
 229
 230 /*
 231  * ima_store_measurement - store file measurement
 232  *
 233  * Create an "ima" template and then store the template by calling
 234  * ima_store_template.
 235  *
 236  * We only get here if the inode has not already been measured,
 237  * but the measurement could already exist:
 238  *      - multiple copies of the same file on either the same or
 239  *        different filesystems.
 240  *      - the inode was previously flushed as well as the iint info,
 241  *        containing the hashing info.
 242  *
 243  * Must be called with iint->mutex held.
 244  */
 245 void ima_store_measurement(struct integrity_iint_cache *iint,
 246                            struct file *file, const unsigned char *filename,
 247                            struct evm_ima_xattr_data *xattr_value,
 248                            int xattr_len)
 249 {
 250         const char *op = "add_template_measure";
 251         const char *audit_cause = "ENOMEM";
 252         int result = -ENOMEM;
 253         struct inode *inode = file_inode(file);
 254         struct ima_template_entry *entry;
 255         int violation = 0;
 256
 257         if (iint->flags & IMA_MEASURED)
 258                 return;
 259
 260         result = ima_alloc_init_template(iint, file, filename,
 261                                          xattr_value, xattr_len, &entry);
 262         if (result < 0) {
 263                 integrity_audit_msg(AUDIT_INTEGRITY_PCR, inode, filename,
 264                                     op, audit_cause, result, 0);
 265                 return;
 266         }
 267
 268         result = ima_store_template(entry, violation, inode, filename);
 269         if (!result || result == -EEXIST)
 270                 iint->flags |= IMA_MEASURED;
 271         if (result < 0)
 272                 kfree(entry);
 273 }
 274
 275 void ima_audit_measurement(struct integrity_iint_cache *iint,
 276                            const unsigned char *filename)
 277 {
 278         struct audit_buffer *ab;
 279         char hash[(iint->ima_hash->length * 2) + 1];
 280         const char *algo_name = hash_algo_name[iint->ima_hash->algo];
 281         char algo_hash[sizeof(hash) + strlen(algo_name) + 2];
 282         int i;
 283
 284         if (iint->flags & IMA_AUDITED)
 285                 return;
 286
 287         for (i = 0; i < iint->ima_hash->length; i++)
 288                 hex_byte_pack(hash + (i * 2), iint->ima_hash->digest[i]);
 289         hash[i * 2] = '\0';
 290
 291         ab = audit_log_start(current->audit_context, GFP_KERNEL,
 292                              AUDIT_INTEGRITY_RULE);
 293         if (!ab)
 294                 return;
 295
 296         audit_log_format(ab, "file=");
 297         audit_log_untrustedstring(ab, filename);
 298         audit_log_format(ab, " hash=");
 299         snprintf(algo_hash, sizeof(algo_hash), "%s:%s", algo_name, hash);
 300         audit_log_untrustedstring(ab, algo_hash);
 301
 302         audit_log_task_info(ab, current);
 303         audit_log_end(ab);
 304
 305         iint->flags |= IMA_AUDITED;
 306 }
 307
 308 const char *ima_d_path(struct path *path, char **pathbuf)
 309 {
 310         char *pathname = NULL;
 311
 312         /* We will allow 11 spaces for ' (deleted)' to be appended */
 313         *pathbuf = kmalloc(PATH_MAX + 11, GFP_KERNEL);
 314         if (*pathbuf) {
 315                 pathname = d_path(path, *pathbuf, PATH_MAX + 11);
 316                 if (IS_ERR(pathname)) {
 317                         kfree(*pathbuf);
 318                         *pathbuf = NULL;
 319                         pathname = NULL;
 320                 }
 321         }
 322         return pathname;
 323 }