security/apparmor/include/policy.h

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