• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2008 IBM Corporation
4  *
5  * Author: Mimi Zohar <zohar@us.ibm.com>
6  *
7  * File: ima_api.c
8  *	Implements must_appraise_or_measure, collect_measurement,
9  *	appraise_measurement, store_measurement and store_template.
10  */
11 #include <linux/slab.h>
12 #include <linux/file.h>
13 #include <linux/fs.h>
14 #include <linux/xattr.h>
15 #include <linux/evm.h>
16 #include <linux/iversion.h>
17 
18 #include "ima.h"
19 
20 /*
21  * ima_free_template_entry - free an existing template entry
22  */
ima_free_template_entry(struct ima_template_entry * entry)23 void ima_free_template_entry(struct ima_template_entry *entry)
24 {
25 	int i;
26 
27 	for (i = 0; i < entry->template_desc->num_fields; i++)
28 		kfree(entry->template_data[i].data);
29 
30 	kfree(entry);
31 }
32 
33 /*
34  * ima_alloc_init_template - create and initialize a new template entry
35  */
ima_alloc_init_template(struct ima_event_data * event_data,struct ima_template_entry ** entry,struct ima_template_desc * desc)36 int ima_alloc_init_template(struct ima_event_data *event_data,
37 			    struct ima_template_entry **entry,
38 			    struct ima_template_desc *desc)
39 {
40 	struct ima_template_desc *template_desc;
41 	int i, result = 0;
42 
43 	if (desc)
44 		template_desc = desc;
45 	else
46 		template_desc = ima_template_desc_current();
47 
48 	*entry = kzalloc(struct_size(*entry, template_data,
49 				     template_desc->num_fields), GFP_NOFS);
50 	if (!*entry)
51 		return -ENOMEM;
52 
53 	(*entry)->template_desc = template_desc;
54 	for (i = 0; i < template_desc->num_fields; i++) {
55 		const struct ima_template_field *field =
56 			template_desc->fields[i];
57 		u32 len;
58 
59 		result = field->field_init(event_data,
60 					   &((*entry)->template_data[i]));
61 		if (result != 0)
62 			goto out;
63 
64 		len = (*entry)->template_data[i].len;
65 		(*entry)->template_data_len += sizeof(len);
66 		(*entry)->template_data_len += len;
67 	}
68 	return 0;
69 out:
70 	ima_free_template_entry(*entry);
71 	*entry = NULL;
72 	return result;
73 }
74 
75 /*
76  * ima_store_template - store ima template measurements
77  *
78  * Calculate the hash of a template entry, add the template entry
79  * to an ordered list of measurement entries maintained inside the kernel,
80  * and also update the aggregate integrity value (maintained inside the
81  * configured TPM PCR) over the hashes of the current list of measurement
82  * entries.
83  *
84  * Applications retrieve the current kernel-held measurement list through
85  * the securityfs entries in /sys/kernel/security/ima. The signed aggregate
86  * TPM PCR (called quote) can be retrieved using a TPM user space library
87  * and is used to validate the measurement list.
88  *
89  * Returns 0 on success, error code otherwise
90  */
ima_store_template(struct ima_template_entry * entry,int violation,struct inode * inode,const unsigned char * filename,int pcr)91 int ima_store_template(struct ima_template_entry *entry,
92 		       int violation, struct inode *inode,
93 		       const unsigned char *filename, int pcr)
94 {
95 	static const char op[] = "add_template_measure";
96 	static const char audit_cause[] = "hashing_error";
97 	char *template_name = entry->template_desc->name;
98 	int result;
99 	struct {
100 		struct ima_digest_data hdr;
101 		char digest[TPM_DIGEST_SIZE];
102 	} hash;
103 
104 	if (!violation) {
105 		int num_fields = entry->template_desc->num_fields;
106 
107 		/* this function uses default algo */
108 		hash.hdr.algo = HASH_ALGO_SHA1;
109 		result = ima_calc_field_array_hash(&entry->template_data[0],
110 						   entry->template_desc,
111 						   num_fields, &hash.hdr);
112 		if (result < 0) {
113 			integrity_audit_msg(AUDIT_INTEGRITY_PCR, inode,
114 					    template_name, op,
115 					    audit_cause, result, 0);
116 			return result;
117 		}
118 		memcpy(entry->digest, hash.hdr.digest, hash.hdr.length);
119 	}
120 	entry->pcr = pcr;
121 	result = ima_add_template_entry(entry, violation, op, inode, filename);
122 	return result;
123 }
124 
125 /*
126  * ima_add_violation - add violation to measurement list.
127  *
128  * Violations are flagged in the measurement list with zero hash values.
129  * By extending the PCR with 0xFF's instead of with zeroes, the PCR
130  * value is invalidated.
131  */
ima_add_violation(struct file * file,const unsigned char * filename,struct integrity_iint_cache * iint,const char * op,const char * cause)132 void ima_add_violation(struct file *file, const unsigned char *filename,
133 		       struct integrity_iint_cache *iint,
134 		       const char *op, const char *cause)
135 {
136 	struct ima_template_entry *entry;
137 	struct inode *inode = file_inode(file);
138 	struct ima_event_data event_data = { .iint = iint,
139 					     .file = file,
140 					     .filename = filename,
141 					     .violation = cause };
142 	int violation = 1;
143 	int result;
144 
145 	/* can overflow, only indicator */
146 	atomic_long_inc(&ima_htable.violations);
147 
148 	result = ima_alloc_init_template(&event_data, &entry, NULL);
149 	if (result < 0) {
150 		result = -ENOMEM;
151 		goto err_out;
152 	}
153 	result = ima_store_template(entry, violation, inode,
154 				    filename, CONFIG_IMA_MEASURE_PCR_IDX);
155 	if (result < 0)
156 		ima_free_template_entry(entry);
157 err_out:
158 	integrity_audit_msg(AUDIT_INTEGRITY_PCR, inode, filename,
159 			    op, cause, result, 0);
160 }
161 
162 /**
163  * ima_get_action - appraise & measure decision based on policy.
164  * @inode: pointer to inode to measure
165  * @cred: pointer to credentials structure to validate
166  * @secid: secid of the task being validated
167  * @mask: contains the permission mask (MAY_READ, MAY_WRITE, MAY_EXEC,
168  *        MAY_APPEND)
169  * @func: caller identifier
170  * @pcr: pointer filled in if matched measure policy sets pcr=
171  * @template_desc: pointer filled in if matched measure policy sets template=
172  *
173  * The policy is defined in terms of keypairs:
174  *		subj=, obj=, type=, func=, mask=, fsmagic=
175  *	subj,obj, and type: are LSM specific.
176  *	func: FILE_CHECK | BPRM_CHECK | CREDS_CHECK | MMAP_CHECK | MODULE_CHECK
177  *	| KEXEC_CMDLINE
178  *	mask: contains the permission mask
179  *	fsmagic: hex value
180  *
181  * Returns IMA_MEASURE, IMA_APPRAISE mask.
182  *
183  */
ima_get_action(struct inode * inode,const struct cred * cred,u32 secid,int mask,enum ima_hooks func,int * pcr,struct ima_template_desc ** template_desc)184 int ima_get_action(struct inode *inode, const struct cred *cred, u32 secid,
185 		   int mask, enum ima_hooks func, int *pcr,
186 		   struct ima_template_desc **template_desc)
187 {
188 	int flags = IMA_MEASURE | IMA_AUDIT | IMA_APPRAISE | IMA_HASH;
189 
190 	flags &= ima_policy_flag;
191 
192 	return ima_match_policy(inode, cred, secid, func, mask, flags, pcr,
193 				template_desc);
194 }
195 
196 /*
197  * ima_collect_measurement - collect file measurement
198  *
199  * Calculate the file hash, if it doesn't already exist,
200  * storing the measurement and i_version in the iint.
201  *
202  * Must be called with iint->mutex held.
203  *
204  * Return 0 on success, error code otherwise
205  */
ima_collect_measurement(struct integrity_iint_cache * iint,struct file * file,void * buf,loff_t size,enum hash_algo algo,struct modsig * modsig)206 int ima_collect_measurement(struct integrity_iint_cache *iint,
207 			    struct file *file, void *buf, loff_t size,
208 			    enum hash_algo algo, struct modsig *modsig)
209 {
210 	const char *audit_cause = "failed";
211 	struct inode *inode = file_inode(file);
212 	struct inode *real_inode = d_real_inode(file_dentry(file));
213 	const char *filename = file->f_path.dentry->d_name.name;
214 	int result = 0;
215 	int length;
216 	void *tmpbuf;
217 	u64 i_version;
218 	struct {
219 		struct ima_digest_data hdr;
220 		char digest[IMA_MAX_DIGEST_SIZE];
221 	} hash;
222 
223 	/*
224 	 * Always collect the modsig, because IMA might have already collected
225 	 * the file digest without collecting the modsig in a previous
226 	 * measurement rule.
227 	 */
228 	if (modsig)
229 		ima_collect_modsig(modsig, buf, size);
230 
231 	if (iint->flags & IMA_COLLECTED)
232 		goto out;
233 
234 	/*
235 	 * Dectecting file change is based on i_version. On filesystems
236 	 * which do not support i_version, support is limited to an initial
237 	 * measurement/appraisal/audit.
238 	 */
239 	i_version = inode_query_iversion(inode);
240 	hash.hdr.algo = algo;
241 
242 	/* Initialize hash digest to 0's in case of failure */
243 	memset(&hash.digest, 0, sizeof(hash.digest));
244 
245 	if (buf)
246 		result = ima_calc_buffer_hash(buf, size, &hash.hdr);
247 	else
248 		result = ima_calc_file_hash(file, &hash.hdr);
249 
250 	if (result && result != -EBADF && result != -EINVAL)
251 		goto out;
252 
253 	length = sizeof(hash.hdr) + hash.hdr.length;
254 	tmpbuf = krealloc(iint->ima_hash, length, GFP_NOFS);
255 	if (!tmpbuf) {
256 		result = -ENOMEM;
257 		goto out;
258 	}
259 
260 	iint->ima_hash = tmpbuf;
261 	memcpy(iint->ima_hash, &hash, length);
262 	iint->version = i_version;
263 	if (real_inode != inode) {
264 		iint->real_ino = real_inode->i_ino;
265 		iint->real_dev = real_inode->i_sb->s_dev;
266 	}
267 
268 	/* Possibly temporary failure due to type of read (eg. O_DIRECT) */
269 	if (!result)
270 		iint->flags |= IMA_COLLECTED;
271 out:
272 	if (result) {
273 		if (file->f_flags & O_DIRECT)
274 			audit_cause = "failed(directio)";
275 
276 		integrity_audit_msg(AUDIT_INTEGRITY_DATA, inode,
277 				    filename, "collect_data", audit_cause,
278 				    result, 0);
279 	}
280 	return result;
281 }
282 
283 /*
284  * ima_store_measurement - store file measurement
285  *
286  * Create an "ima" template and then store the template by calling
287  * ima_store_template.
288  *
289  * We only get here if the inode has not already been measured,
290  * but the measurement could already exist:
291  *	- multiple copies of the same file on either the same or
292  *	  different filesystems.
293  *	- the inode was previously flushed as well as the iint info,
294  *	  containing the hashing info.
295  *
296  * Must be called with iint->mutex held.
297  */
ima_store_measurement(struct integrity_iint_cache * iint,struct file * file,const unsigned char * filename,struct evm_ima_xattr_data * xattr_value,int xattr_len,const struct modsig * modsig,int pcr,struct ima_template_desc * template_desc)298 void ima_store_measurement(struct integrity_iint_cache *iint,
299 			   struct file *file, const unsigned char *filename,
300 			   struct evm_ima_xattr_data *xattr_value,
301 			   int xattr_len, const struct modsig *modsig, int pcr,
302 			   struct ima_template_desc *template_desc)
303 {
304 	static const char op[] = "add_template_measure";
305 	static const char audit_cause[] = "ENOMEM";
306 	int result = -ENOMEM;
307 	struct inode *inode = file_inode(file);
308 	struct ima_template_entry *entry;
309 	struct ima_event_data event_data = { .iint = iint,
310 					     .file = file,
311 					     .filename = filename,
312 					     .xattr_value = xattr_value,
313 					     .xattr_len = xattr_len,
314 					     .modsig = modsig };
315 	int violation = 0;
316 
317 	/*
318 	 * We still need to store the measurement in the case of MODSIG because
319 	 * we only have its contents to put in the list at the time of
320 	 * appraisal, but a file measurement from earlier might already exist in
321 	 * the measurement list.
322 	 */
323 	if (iint->measured_pcrs & (0x1 << pcr) && !modsig)
324 		return;
325 
326 	result = ima_alloc_init_template(&event_data, &entry, template_desc);
327 	if (result < 0) {
328 		integrity_audit_msg(AUDIT_INTEGRITY_PCR, inode, filename,
329 				    op, audit_cause, result, 0);
330 		return;
331 	}
332 
333 	result = ima_store_template(entry, violation, inode, filename, pcr);
334 	if ((!result || result == -EEXIST) && !(file->f_flags & O_DIRECT)) {
335 		iint->flags |= IMA_MEASURED;
336 		iint->measured_pcrs |= (0x1 << pcr);
337 	}
338 	if (result < 0)
339 		ima_free_template_entry(entry);
340 }
341 
ima_audit_measurement(struct integrity_iint_cache * iint,const unsigned char * filename)342 void ima_audit_measurement(struct integrity_iint_cache *iint,
343 			   const unsigned char *filename)
344 {
345 	struct audit_buffer *ab;
346 	char *hash;
347 	const char *algo_name = hash_algo_name[iint->ima_hash->algo];
348 	int i;
349 
350 	if (iint->flags & IMA_AUDITED)
351 		return;
352 
353 	hash = kzalloc((iint->ima_hash->length * 2) + 1, GFP_KERNEL);
354 	if (!hash)
355 		return;
356 
357 	for (i = 0; i < iint->ima_hash->length; i++)
358 		hex_byte_pack(hash + (i * 2), iint->ima_hash->digest[i]);
359 	hash[i * 2] = '\0';
360 
361 	ab = audit_log_start(audit_context(), GFP_KERNEL,
362 			     AUDIT_INTEGRITY_RULE);
363 	if (!ab)
364 		goto out;
365 
366 	audit_log_format(ab, "file=");
367 	audit_log_untrustedstring(ab, filename);
368 	audit_log_format(ab, " hash=\"%s:%s\"", algo_name, hash);
369 
370 	audit_log_task_info(ab);
371 	audit_log_end(ab);
372 
373 	iint->flags |= IMA_AUDITED;
374 out:
375 	kfree(hash);
376 	return;
377 }
378 
379 /*
380  * ima_d_path - return a pointer to the full pathname
381  *
382  * Attempt to return a pointer to the full pathname for use in the
383  * IMA measurement list, IMA audit records, and auditing logs.
384  *
385  * On failure, return a pointer to a copy of the filename, not dname.
386  * Returning a pointer to dname, could result in using the pointer
387  * after the memory has been freed.
388  */
ima_d_path(const struct path * path,char ** pathbuf,char * namebuf)389 const char *ima_d_path(const struct path *path, char **pathbuf, char *namebuf)
390 {
391 	char *pathname = NULL;
392 
393 	*pathbuf = __getname();
394 	if (*pathbuf) {
395 		pathname = d_absolute_path(path, *pathbuf, PATH_MAX);
396 		if (IS_ERR(pathname)) {
397 			__putname(*pathbuf);
398 			*pathbuf = NULL;
399 			pathname = NULL;
400 		}
401 	}
402 
403 	if (!pathname) {
404 		strlcpy(namebuf, path->dentry->d_name.name, NAME_MAX);
405 		pathname = namebuf;
406 	}
407 
408 	return pathname;
409 }
410