1 // SPDX-License-Identifier: GPL-2.0-only
3 * AppArmor security module
5 * This file contains AppArmor mediation of files
7 * Copyright (C) 1998-2008 Novell/SUSE
8 * Copyright 2009-2010 Canonical Ltd.
11 #include <linux/tty.h>
12 #include <linux/fdtable.h>
13 #include <linux/file.h>
15 #include <linux/mount.h>
17 #include "include/apparmor.h"
18 #include "include/audit.h"
19 #include "include/cred.h"
20 #include "include/file.h"
21 #include "include/match.h"
22 #include "include/net.h"
23 #include "include/path.h"
24 #include "include/policy.h"
25 #include "include/label.h"
27 static u32 map_mask_to_chr_mask(u32 mask)
29 u32 m = mask & PERMS_CHRS_MASK;
31 if (mask & AA_MAY_GETATTR)
33 if (mask & (AA_MAY_SETATTR | AA_MAY_CHMOD | AA_MAY_CHOWN))
40 * file_audit_cb - call back for file specific audit fields
41 * @ab: audit_buffer (NOT NULL)
42 * @va: audit struct to audit values of (NOT NULL)
44 static void file_audit_cb(struct audit_buffer *ab, void *va)
46 struct common_audit_data *sa = va;
47 kuid_t fsuid = current_fsuid();
50 if (aad(sa)->request & AA_AUDIT_FILE_MASK) {
51 aa_perm_mask_to_str(str, sizeof(str), aa_file_perm_chrs,
52 map_mask_to_chr_mask(aad(sa)->request));
53 audit_log_format(ab, " requested_mask=\"%s\"", str);
55 if (aad(sa)->denied & AA_AUDIT_FILE_MASK) {
56 aa_perm_mask_to_str(str, sizeof(str), aa_file_perm_chrs,
57 map_mask_to_chr_mask(aad(sa)->denied));
58 audit_log_format(ab, " denied_mask=\"%s\"", str);
60 if (aad(sa)->request & AA_AUDIT_FILE_MASK) {
61 audit_log_format(ab, " fsuid=%d",
62 from_kuid(&init_user_ns, fsuid));
63 audit_log_format(ab, " ouid=%d",
64 from_kuid(&init_user_ns, aad(sa)->fs.ouid));
68 audit_log_format(ab, " target=");
69 aa_label_xaudit(ab, labels_ns(aad(sa)->label), aad(sa)->peer,
70 FLAG_VIEW_SUBNS, GFP_KERNEL);
71 } else if (aad(sa)->fs.target) {
72 audit_log_format(ab, " target=");
73 audit_log_untrustedstring(ab, aad(sa)->fs.target);
78 * aa_audit_file - handle the auditing of file operations
79 * @profile: the profile being enforced (NOT NULL)
80 * @perms: the permissions computed for the request (NOT NULL)
81 * @op: operation being mediated
82 * @request: permissions requested
83 * @name: name of object being mediated (MAYBE NULL)
84 * @target: name of target (MAYBE NULL)
85 * @tlabel: target label (MAY BE NULL)
87 * @info: extra information message (MAYBE NULL)
88 * @error: 0 if operation allowed else failure error code
90 * Returns: %0 or error on failure
92 int aa_audit_file(struct aa_profile *profile, struct aa_perms *perms,
93 const char *op, u32 request, const char *name,
94 const char *target, struct aa_label *tlabel,
95 kuid_t ouid, const char *info, int error)
97 int type = AUDIT_APPARMOR_AUTO;
98 DEFINE_AUDIT_DATA(sa, LSM_AUDIT_DATA_TASK, AA_CLASS_FILE, op);
101 aad(&sa)->request = request;
102 aad(&sa)->name = name;
103 aad(&sa)->fs.target = target;
104 aad(&sa)->peer = tlabel;
105 aad(&sa)->fs.ouid = ouid;
106 aad(&sa)->info = info;
107 aad(&sa)->error = error;
110 if (likely(!aad(&sa)->error)) {
111 u32 mask = perms->audit;
113 if (unlikely(AUDIT_MODE(profile) == AUDIT_ALL))
116 /* mask off perms that are not being force audited */
117 aad(&sa)->request &= mask;
119 if (likely(!aad(&sa)->request))
121 type = AUDIT_APPARMOR_AUDIT;
123 /* only report permissions that were denied */
124 aad(&sa)->request = aad(&sa)->request & ~perms->allow;
125 AA_BUG(!aad(&sa)->request);
127 if (aad(&sa)->request & perms->kill)
128 type = AUDIT_APPARMOR_KILL;
130 /* quiet known rejects, assumes quiet and kill do not overlap */
131 if ((aad(&sa)->request & perms->quiet) &&
132 AUDIT_MODE(profile) != AUDIT_NOQUIET &&
133 AUDIT_MODE(profile) != AUDIT_ALL)
134 aad(&sa)->request &= ~perms->quiet;
136 if (!aad(&sa)->request)
137 return aad(&sa)->error;
140 aad(&sa)->denied = aad(&sa)->request & ~perms->allow;
141 return aa_audit(type, profile, &sa, file_audit_cb);
144 static int path_name(const char *op, struct aa_label *label,
145 const struct path *path, int flags, char *buffer,
146 const char **name, struct path_cond *cond, u32 request)
148 struct aa_profile *profile;
149 const char *info = NULL;
152 error = aa_path_name(path, flags, buffer, name, &info,
153 labels_profile(label)->disconnected);
155 fn_for_each_confined(label, profile,
156 aa_audit_file(profile, &nullperms, op, request, *name,
157 NULL, NULL, cond->uid, info, error));
165 * aa_lookup_fperms - convert dfa compressed perms to internal perms
166 * @dfa: dfa to lookup perms for (NOT NULL)
167 * @state: state in dfa
168 * @cond: conditions to consider (NOT NULL)
170 * TODO: convert from dfa + state to permission entry
172 * Returns: a pointer to a file permission set
174 struct aa_perms default_perms = {};
175 struct aa_perms *aa_lookup_fperms(struct aa_policydb *file_rules,
176 aa_state_t state, struct path_cond *cond)
178 unsigned int index = ACCEPT_TABLE(file_rules->dfa)[state];
180 if (!(file_rules->perms))
181 return &default_perms;
183 if (uid_eq(current_fsuid(), cond->uid))
184 return &(file_rules->perms[index]);
186 return &(file_rules->perms[index + 1]);
190 * aa_str_perms - find permission that match @name
191 * @dfa: to match against (MAYBE NULL)
192 * @state: state to start matching in
193 * @name: string to match against dfa (NOT NULL)
194 * @cond: conditions to consider for permission set computation (NOT NULL)
195 * @perms: Returns - the permissions found when matching @name
197 * Returns: the final state in @dfa when beginning @start and walking @name
199 aa_state_t aa_str_perms(struct aa_policydb *file_rules, aa_state_t start,
200 const char *name, struct path_cond *cond,
201 struct aa_perms *perms)
204 state = aa_dfa_match(file_rules->dfa, start, name);
205 *perms = *(aa_lookup_fperms(file_rules, state, cond));
210 static int __aa_path_perm(const char *op, struct aa_profile *profile,
211 const char *name, u32 request,
212 struct path_cond *cond, int flags,
213 struct aa_perms *perms)
215 struct aa_ruleset *rules = list_first_entry(&profile->rules,
216 typeof(*rules), list);
219 if (profile_unconfined(profile))
221 aa_str_perms(&(rules->file), rules->file.start[AA_CLASS_FILE],
223 if (request & ~perms->allow)
225 return aa_audit_file(profile, perms, op, request, name, NULL, NULL,
230 static int profile_path_perm(const char *op, struct aa_profile *profile,
231 const struct path *path, char *buffer, u32 request,
232 struct path_cond *cond, int flags,
233 struct aa_perms *perms)
238 if (profile_unconfined(profile))
241 error = path_name(op, &profile->label, path,
242 flags | profile->path_flags, buffer, &name, cond,
246 return __aa_path_perm(op, profile, name, request, cond, flags,
251 * aa_path_perm - do permissions check & audit for @path
252 * @op: operation being checked
253 * @label: profile being enforced (NOT NULL)
254 * @path: path to check permissions of (NOT NULL)
255 * @flags: any additional path flags beyond what the profile specifies
256 * @request: requested permissions
257 * @cond: conditional info for this request (NOT NULL)
259 * Returns: %0 else error if access denied or other error
261 int aa_path_perm(const char *op, struct aa_label *label,
262 const struct path *path, int flags, u32 request,
263 struct path_cond *cond)
265 struct aa_perms perms = {};
266 struct aa_profile *profile;
270 flags |= PATH_DELEGATE_DELETED | (S_ISDIR(cond->mode) ? PATH_IS_DIR :
272 buffer = aa_get_buffer(false);
275 error = fn_for_each_confined(label, profile,
276 profile_path_perm(op, profile, path, buffer, request,
277 cond, flags, &perms));
279 aa_put_buffer(buffer);
285 * xindex_is_subset - helper for aa_path_link
286 * @link: link permission set
287 * @target: target permission set
289 * test target x permissions are equal OR a subset of link x permissions
290 * this is done as part of the subset test, where a hardlink must have
291 * a subset of permissions that the target has.
293 * Returns: true if subset else false
295 static inline bool xindex_is_subset(u32 link, u32 target)
297 if (((link & ~AA_X_UNSAFE) != (target & ~AA_X_UNSAFE)) ||
298 ((link & AA_X_UNSAFE) && !(target & AA_X_UNSAFE)))
304 static int profile_path_link(struct aa_profile *profile,
305 const struct path *link, char *buffer,
306 const struct path *target, char *buffer2,
307 struct path_cond *cond)
309 struct aa_ruleset *rules = list_first_entry(&profile->rules,
310 typeof(*rules), list);
311 const char *lname, *tname = NULL;
312 struct aa_perms lperms = {}, perms;
313 const char *info = NULL;
314 u32 request = AA_MAY_LINK;
318 error = path_name(OP_LINK, &profile->label, link, profile->path_flags,
319 buffer, &lname, cond, AA_MAY_LINK);
323 /* buffer2 freed below, tname is pointer in buffer2 */
324 error = path_name(OP_LINK, &profile->label, target, profile->path_flags,
325 buffer2, &tname, cond, AA_MAY_LINK);
330 /* aa_str_perms - handles the case of the dfa being NULL */
331 state = aa_str_perms(&(rules->file),
332 rules->file.start[AA_CLASS_FILE], lname,
335 if (!(lperms.allow & AA_MAY_LINK))
338 /* test to see if target can be paired with link */
339 state = aa_dfa_null_transition(rules->file.dfa, state);
340 aa_str_perms(&(rules->file), state, tname, cond, &perms);
342 /* force audit/quiet masks for link are stored in the second entry
345 lperms.audit = perms.audit;
346 lperms.quiet = perms.quiet;
347 lperms.kill = perms.kill;
349 if (!(perms.allow & AA_MAY_LINK)) {
350 info = "target restricted";
355 /* done if link subset test is not required */
356 if (!(perms.allow & AA_LINK_SUBSET))
359 /* Do link perm subset test requiring allowed permission on link are
360 * a subset of the allowed permissions on target.
362 aa_str_perms(&(rules->file), rules->file.start[AA_CLASS_FILE],
363 tname, cond, &perms);
365 /* AA_MAY_LINK is not considered in the subset test */
366 request = lperms.allow & ~AA_MAY_LINK;
367 lperms.allow &= perms.allow | AA_MAY_LINK;
369 request |= AA_AUDIT_FILE_MASK & (lperms.allow & ~perms.allow);
370 if (request & ~lperms.allow) {
372 } else if ((lperms.allow & MAY_EXEC) &&
373 !xindex_is_subset(lperms.xindex, perms.xindex)) {
374 lperms.allow &= ~MAY_EXEC;
376 info = "link not subset of target";
384 return aa_audit_file(profile, &lperms, OP_LINK, request, lname, tname,
385 NULL, cond->uid, info, error);
389 * aa_path_link - Handle hard link permission check
390 * @label: the label being enforced (NOT NULL)
391 * @old_dentry: the target dentry (NOT NULL)
392 * @new_dir: directory the new link will be created in (NOT NULL)
393 * @new_dentry: the link being created (NOT NULL)
395 * Handle the permission test for a link & target pair. Permission
396 * is encoded as a pair where the link permission is determined
397 * first, and if allowed, the target is tested. The target test
398 * is done from the point of the link match (not start of DFA)
399 * making the target permission dependent on the link permission match.
401 * The subset test if required forces that permissions granted
402 * on link are a subset of the permission granted to target.
404 * Returns: %0 if allowed else error
406 int aa_path_link(struct aa_label *label, struct dentry *old_dentry,
407 const struct path *new_dir, struct dentry *new_dentry)
409 struct path link = { .mnt = new_dir->mnt, .dentry = new_dentry };
410 struct path target = { .mnt = new_dir->mnt, .dentry = old_dentry };
411 struct path_cond cond = {
412 d_backing_inode(old_dentry)->i_uid,
413 d_backing_inode(old_dentry)->i_mode
415 char *buffer = NULL, *buffer2 = NULL;
416 struct aa_profile *profile;
419 /* buffer freed below, lname is pointer in buffer */
420 buffer = aa_get_buffer(false);
421 buffer2 = aa_get_buffer(false);
423 if (!buffer || !buffer2)
426 error = fn_for_each_confined(label, profile,
427 profile_path_link(profile, &link, buffer, &target,
430 aa_put_buffer(buffer);
431 aa_put_buffer(buffer2);
435 static void update_file_ctx(struct aa_file_ctx *fctx, struct aa_label *label,
438 struct aa_label *l, *old;
440 /* update caching of label on file_ctx */
441 spin_lock(&fctx->lock);
442 old = rcu_dereference_protected(fctx->label,
443 lockdep_is_held(&fctx->lock));
444 l = aa_label_merge(old, label, GFP_ATOMIC);
447 rcu_assign_pointer(fctx->label, l);
451 fctx->allow |= request;
453 spin_unlock(&fctx->lock);
456 static int __file_path_perm(const char *op, struct aa_label *label,
457 struct aa_label *flabel, struct file *file,
458 u32 request, u32 denied, bool in_atomic)
460 struct aa_profile *profile;
461 struct aa_perms perms = {};
462 vfsuid_t vfsuid = i_uid_into_vfsuid(file_mnt_idmap(file),
464 struct path_cond cond = {
465 .uid = vfsuid_into_kuid(vfsuid),
466 .mode = file_inode(file)->i_mode
471 /* revalidation due to label out of date. No revocation at this time */
472 if (!denied && aa_label_is_subset(flabel, label))
473 /* TODO: check for revocation on stale profiles */
476 flags = PATH_DELEGATE_DELETED | (S_ISDIR(cond.mode) ? PATH_IS_DIR : 0);
477 buffer = aa_get_buffer(in_atomic);
481 /* check every profile in task label not in current cache */
482 error = fn_for_each_not_in_set(flabel, label, profile,
483 profile_path_perm(op, profile, &file->f_path, buffer,
484 request, &cond, flags, &perms));
485 if (denied && !error) {
487 * check every profile in file label that was not tested
488 * in the initial check above.
490 * TODO: cache full perms so this only happens because of
492 * TODO: don't audit here
495 error = fn_for_each(label, profile,
496 profile_path_perm(op, profile, &file->f_path,
497 buffer, request, &cond, flags,
500 error = fn_for_each_not_in_set(label, flabel, profile,
501 profile_path_perm(op, profile, &file->f_path,
502 buffer, request, &cond, flags,
506 update_file_ctx(file_ctx(file), label, request);
508 aa_put_buffer(buffer);
513 static int __file_sock_perm(const char *op, struct aa_label *label,
514 struct aa_label *flabel, struct file *file,
515 u32 request, u32 denied)
517 struct socket *sock = (struct socket *) file->private_data;
522 /* revalidation due to label out of date. No revocation at this time */
523 if (!denied && aa_label_is_subset(flabel, label))
526 /* TODO: improve to skip profiles cached in flabel */
527 error = aa_sock_file_perm(label, op, request, sock);
529 /* TODO: improve to skip profiles checked above */
530 /* check every profile in file label to is cached */
531 last_error(error, aa_sock_file_perm(flabel, op, request, sock));
534 update_file_ctx(file_ctx(file), label, request);
540 * aa_file_perm - do permission revalidation check & audit for @file
541 * @op: operation being checked
542 * @label: label being enforced (NOT NULL)
543 * @file: file to revalidate access permissions on (NOT NULL)
544 * @request: requested permissions
545 * @in_atomic: whether allocations need to be done in atomic context
547 * Returns: %0 if access allowed else error
549 int aa_file_perm(const char *op, struct aa_label *label, struct file *file,
550 u32 request, bool in_atomic)
552 struct aa_file_ctx *fctx;
553 struct aa_label *flabel;
560 fctx = file_ctx(file);
563 flabel = rcu_dereference(fctx->label);
566 /* revalidate access, if task is unconfined, or the cached cred
567 * doesn't match or if the request is for more permissions than
570 * Note: the test for !unconfined(flabel) is to handle file
571 * delegation from unconfined tasks
573 denied = request & ~fctx->allow;
574 if (unconfined(label) || unconfined(flabel) ||
575 (!denied && aa_label_is_subset(flabel, label))) {
580 flabel = aa_get_newest_label(flabel);
582 /* TODO: label cross check */
584 if (file->f_path.mnt && path_mediated_fs(file->f_path.dentry))
585 error = __file_path_perm(op, label, flabel, file, request,
588 else if (S_ISSOCK(file_inode(file)->i_mode))
589 error = __file_sock_perm(op, label, flabel, file, request,
591 aa_put_label(flabel);
597 static void revalidate_tty(struct aa_label *label)
599 struct tty_struct *tty;
602 tty = get_current_tty();
606 spin_lock(&tty->files_lock);
607 if (!list_empty(&tty->tty_files)) {
608 struct tty_file_private *file_priv;
610 /* TODO: Revalidate access to controlling tty. */
611 file_priv = list_first_entry(&tty->tty_files,
612 struct tty_file_private, list);
613 file = file_priv->file;
615 if (aa_file_perm(OP_INHERIT, label, file, MAY_READ | MAY_WRITE,
619 spin_unlock(&tty->files_lock);
626 static int match_file(const void *p, struct file *file, unsigned int fd)
628 struct aa_label *label = (struct aa_label *)p;
630 if (aa_file_perm(OP_INHERIT, label, file, aa_map_file_to_perms(file),
637 /* based on selinux's flush_unauthorized_files */
638 void aa_inherit_files(const struct cred *cred, struct files_struct *files)
640 struct aa_label *label = aa_get_newest_cred_label(cred);
641 struct file *devnull = NULL;
644 revalidate_tty(label);
646 /* Revalidate access to inherited open files. */
647 n = iterate_fd(files, 0, match_file, label);
648 if (!n) /* none found? */
651 devnull = dentry_open(&aa_null, O_RDWR, cred);
654 /* replace all the matching ones with this */
656 replace_fd(n - 1, devnull, 0);
657 } while ((n = iterate_fd(files, n, match_file, label)) != 0);