xref: /openbmc/linux/security/apparmor/include/policy.h (revision e844fe9b51c984472ea98be3b2d1201ba9ee3213)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3  * AppArmor security module
4  *
5  * This file contains AppArmor policy definitions.
6  *
7  * Copyright (C) 1998-2008 Novell/SUSE
8  * Copyright 2009-2010 Canonical Ltd.
9  */
10 
11 #ifndef __AA_POLICY_H
12 #define __AA_POLICY_H
13 
14 #include <linux/capability.h>
15 #include <linux/cred.h>
16 #include <linux/kref.h>
17 #include <linux/rhashtable.h>
18 #include <linux/sched.h>
19 #include <linux/slab.h>
20 #include <linux/socket.h>
21 
22 #include "apparmor.h"
23 #include "audit.h"
24 #include "capability.h"
25 #include "domain.h"
26 #include "file.h"
27 #include "lib.h"
28 #include "label.h"
29 #include "net.h"
30 #include "perms.h"
31 #include "resource.h"
32 
33 
34 struct aa_ns;
35 
36 extern int unprivileged_userns_apparmor_policy;
37 
38 extern const char *const aa_profile_mode_names[];
39 #define APPARMOR_MODE_NAMES_MAX_INDEX 4
40 
41 #define PROFILE_MODE(_profile, _mode)		\
42 	((aa_g_profile_mode == (_mode)) ||	\
43 	 ((_profile)->mode == (_mode)))
44 
45 #define COMPLAIN_MODE(_profile)	PROFILE_MODE((_profile), APPARMOR_COMPLAIN)
46 
47 #define KILL_MODE(_profile) PROFILE_MODE((_profile), APPARMOR_KILL)
48 
49 #define PROFILE_IS_HAT(_profile) ((_profile)->label.flags & FLAG_HAT)
50 
51 #define CHECK_DEBUG1(_profile) ((_profile)->label.flags & FLAG_DEBUG1)
52 
53 #define CHECK_DEBUG2(_profile) ((_profile)->label.flags & FLAG_DEBUG2)
54 
55 #define profile_is_stale(_profile) (label_is_stale(&(_profile)->label))
56 
57 #define on_list_rcu(X) (!list_empty(X) && (X)->prev != LIST_POISON2)
58 
59 /*
60  * FIXME: currently need a clean way to replace and remove profiles as a
61  * set.  It should be done at the namespace level.
62  * Either, with a set of profiles loaded at the namespace level or via
63  * a mark and remove marked interface.
64  */
65 enum profile_mode {
66 	APPARMOR_ENFORCE,	/* enforce access rules */
67 	APPARMOR_COMPLAIN,	/* allow and log access violations */
68 	APPARMOR_KILL,		/* kill task on access violation */
69 	APPARMOR_UNCONFINED,	/* profile set to unconfined */
70 };
71 
72 
73 /* struct aa_policydb - match engine for a policy
74  * dfa: dfa pattern match
75  * start: set of start states for the different classes of data
76  */
77 struct aa_policydb {
78 	struct aa_dfa *dfa;
79 	struct aa_perms *perms;
80 	struct aa_domain trans;
81 	unsigned int start[AA_CLASS_LAST + 1];
82 };
83 
84 static inline void aa_destroy_policydb(struct aa_policydb *policy)
85 {
86 	aa_put_dfa(policy->dfa);
87 	if (policy->perms)
88 		kvfree(policy->perms);
89 	aa_free_domain_entries(&policy->trans);
90 
91 }
92 
93 static inline struct aa_perms *aa_lookup_perms(struct aa_policydb *policy,
94 					       unsigned int state)
95 {
96 	unsigned int index = ACCEPT_TABLE(policy->dfa)[state];
97 
98 	if (!(policy->perms))
99 		return &default_perms;
100 
101 	return &(policy->perms[index]);
102 }
103 
104 
105 /* struct aa_data - generic data structure
106  * key: name for retrieving this data
107  * size: size of data in bytes
108  * data: binary data
109  * head: reserved for rhashtable
110  */
111 struct aa_data {
112 	char *key;
113 	u32 size;
114 	char *data;
115 	struct rhash_head head;
116 };
117 
118 
119 /* struct aa_profile - basic confinement data
120  * @base - base components of the profile (name, refcount, lists, lock ...)
121  * @label - label this profile is an extension of
122  * @parent: parent of profile
123  * @ns: namespace the profile is in
124  * @rename: optional profile name that this profile renamed
125  * @attach: human readable attachment string
126  * @xmatch: optional extended matching for unconfined executables names
127  * @xmatch_len: xmatch prefix len, used to determine xmatch priority
128  * @audit: the auditing mode of the profile
129  * @mode: the enforcement mode of the profile
130  * @path_flags: flags controlling path generation behavior
131  * @disconnected: what to prepend if attach_disconnected is specified
132  * @size: the memory consumed by this profiles rules
133  * @policy: general match rules governing policy
134  * @file: The set of rules governing basic file access and domain transitions
135  * @caps: capabilities for the profile
136  * @rlimits: rlimits for the profile
137  *
138  * @dents: dentries for the profiles file entries in apparmorfs
139  * @dirname: name of the profile dir in apparmorfs
140  * @data: hashtable for free-form policy aa_data
141  *
142  * The AppArmor profile contains the basic confinement data.  Each profile
143  * has a name, and exists in a namespace.  The @name and @exec_match are
144  * used to determine profile attachment against unconfined tasks.  All other
145  * attachments are determined by profile X transition rules.
146  *
147  * Profiles have a hierarchy where hats and children profiles keep
148  * a reference to their parent.
149  *
150  * Profile names can not begin with a : and can not contain the \0
151  * character.  If a profile name begins with / it will be considered when
152  * determining profile attachment on "unconfined" tasks.
153  */
154 struct aa_profile {
155 	struct aa_policy base;
156 	struct aa_profile __rcu *parent;
157 
158 	struct aa_ns *ns;
159 	const char *rename;
160 
161 	const char *attach;
162 	struct aa_policydb xmatch;
163 	unsigned int xmatch_len;
164 
165 	enum audit_mode audit;
166 	long mode;
167 	u32 path_flags;
168 	const char *disconnected;
169 	int size;
170 
171 	struct aa_policydb policy;
172 	struct aa_policydb file;
173 	struct aa_caps caps;
174 
175 	int xattr_count;
176 	char **xattrs;
177 
178 	struct aa_rlimit rlimits;
179 
180 	int secmark_count;
181 	struct aa_secmark *secmark;
182 
183 	struct aa_loaddata *rawdata;
184 	unsigned char *hash;
185 	char *dirname;
186 	struct dentry *dents[AAFS_PROF_SIZEOF];
187 	struct rhashtable *data;
188 	struct aa_label label;
189 };
190 
191 extern enum profile_mode aa_g_profile_mode;
192 
193 #define AA_MAY_LOAD_POLICY	AA_MAY_APPEND
194 #define AA_MAY_REPLACE_POLICY	AA_MAY_WRITE
195 #define AA_MAY_REMOVE_POLICY	AA_MAY_DELETE
196 
197 #define profiles_ns(P) ((P)->ns)
198 #define name_is_shared(A, B) ((A)->hname && (A)->hname == (B)->hname)
199 
200 void aa_add_profile(struct aa_policy *common, struct aa_profile *profile);
201 
202 
203 void aa_free_proxy_kref(struct kref *kref);
204 struct aa_profile *aa_alloc_profile(const char *name, struct aa_proxy *proxy,
205 				    gfp_t gfp);
206 struct aa_profile *aa_new_null_profile(struct aa_profile *parent, bool hat,
207 				       const char *base, gfp_t gfp);
208 void aa_free_profile(struct aa_profile *profile);
209 void aa_free_profile_kref(struct kref *kref);
210 struct aa_profile *aa_find_child(struct aa_profile *parent, const char *name);
211 struct aa_profile *aa_lookupn_profile(struct aa_ns *ns, const char *hname,
212 				      size_t n);
213 struct aa_profile *aa_lookup_profile(struct aa_ns *ns, const char *name);
214 struct aa_profile *aa_fqlookupn_profile(struct aa_label *base,
215 					const char *fqname, size_t n);
216 struct aa_profile *aa_match_profile(struct aa_ns *ns, const char *name);
217 
218 ssize_t aa_replace_profiles(struct aa_ns *view, struct aa_label *label,
219 			    u32 mask, struct aa_loaddata *udata);
220 ssize_t aa_remove_profiles(struct aa_ns *view, struct aa_label *label,
221 			   char *name, size_t size);
222 void __aa_profile_list_release(struct list_head *head);
223 
224 #define PROF_ADD 1
225 #define PROF_REPLACE 0
226 
227 #define profile_unconfined(X) ((X)->mode == APPARMOR_UNCONFINED)
228 
229 /**
230  * aa_get_newest_profile - simple wrapper fn to wrap the label version
231  * @p: profile (NOT NULL)
232  *
233  * Returns refcount to newest version of the profile (maybe @p)
234  *
235  * Requires: @p must be held with a valid refcount
236  */
237 static inline struct aa_profile *aa_get_newest_profile(struct aa_profile *p)
238 {
239 	return labels_profile(aa_get_newest_label(&p->label));
240 }
241 
242 static inline unsigned int PROFILE_MEDIATES(struct aa_profile *profile,
243 					    unsigned char class)
244 {
245 	if (class <= AA_CLASS_LAST)
246 		return profile->policy.start[class];
247 	else
248 		return aa_dfa_match_len(profile->policy.dfa,
249 					profile->policy.start[0], &class, 1);
250 }
251 
252 static inline unsigned int PROFILE_MEDIATES_AF(struct aa_profile *profile,
253 					       u16 AF) {
254 	unsigned int state = PROFILE_MEDIATES(profile, AA_CLASS_NET);
255 	__be16 be_af = cpu_to_be16(AF);
256 
257 	if (!state)
258 		return 0;
259 	return aa_dfa_match_len(profile->policy.dfa, state, (char *) &be_af, 2);
260 }
261 
262 /**
263  * aa_get_profile - increment refcount on profile @p
264  * @p: profile  (MAYBE NULL)
265  *
266  * Returns: pointer to @p if @p is NULL will return NULL
267  * Requires: @p must be held with valid refcount when called
268  */
269 static inline struct aa_profile *aa_get_profile(struct aa_profile *p)
270 {
271 	if (p)
272 		kref_get(&(p->label.count));
273 
274 	return p;
275 }
276 
277 /**
278  * aa_get_profile_not0 - increment refcount on profile @p found via lookup
279  * @p: profile  (MAYBE NULL)
280  *
281  * Returns: pointer to @p if @p is NULL will return NULL
282  * Requires: @p must be held with valid refcount when called
283  */
284 static inline struct aa_profile *aa_get_profile_not0(struct aa_profile *p)
285 {
286 	if (p && kref_get_unless_zero(&p->label.count))
287 		return p;
288 
289 	return NULL;
290 }
291 
292 /**
293  * aa_get_profile_rcu - increment a refcount profile that can be replaced
294  * @p: pointer to profile that can be replaced (NOT NULL)
295  *
296  * Returns: pointer to a refcounted profile.
297  *     else NULL if no profile
298  */
299 static inline struct aa_profile *aa_get_profile_rcu(struct aa_profile __rcu **p)
300 {
301 	struct aa_profile *c;
302 
303 	rcu_read_lock();
304 	do {
305 		c = rcu_dereference(*p);
306 	} while (c && !kref_get_unless_zero(&c->label.count));
307 	rcu_read_unlock();
308 
309 	return c;
310 }
311 
312 /**
313  * aa_put_profile - decrement refcount on profile @p
314  * @p: profile  (MAYBE NULL)
315  */
316 static inline void aa_put_profile(struct aa_profile *p)
317 {
318 	if (p)
319 		kref_put(&p->label.count, aa_label_kref);
320 }
321 
322 static inline int AUDIT_MODE(struct aa_profile *profile)
323 {
324 	if (aa_g_audit != AUDIT_NORMAL)
325 		return aa_g_audit;
326 
327 	return profile->audit;
328 }
329 
330 bool aa_policy_view_capable(struct aa_label *label, struct aa_ns *ns);
331 bool aa_policy_admin_capable(struct aa_label *label, struct aa_ns *ns);
332 int aa_may_manage_policy(struct aa_label *label, struct aa_ns *ns,
333 			 u32 mask);
334 bool aa_current_policy_view_capable(struct aa_ns *ns);
335 bool aa_current_policy_admin_capable(struct aa_ns *ns);
336 
337 #endif /* __AA_POLICY_H */
338