security/apparmor/include/policy.h

   1 /*
   2  * AppArmor security module
   3  *
   4  * This file contains AppArmor policy definitions.
   5  *
   6  * Copyright (C) 1998-2008 Novell/SUSE
   7  * Copyright 2009-2010 Canonical Ltd.
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License as
  11  * published by the Free Software Foundation, version 2 of the
  12  * License.
  13  */
  14
  15 #ifndef __AA_POLICY_H
  16 #define __AA_POLICY_H
  17
  18 #include <linux/capability.h>
  19 #include <linux/cred.h>
  20 #include <linux/kref.h>
  21 #include <linux/sched.h>
  22 #include <linux/slab.h>
  23 #include <linux/socket.h>
  24
  25 #include "apparmor.h"
  26 #include "audit.h"
  27 #include "capability.h"
  28 #include "domain.h"
  29 #include "file.h"
  30 #include "resource.h"
  31
  32 extern const char *const profile_mode_names[];
  33 #define APPARMOR_NAMES_MAX_INDEX 3
  34
  35 #define PROFILE_MODE(_profile, _mode)           \
  36         ((aa_g_profile_mode == (_mode)) ||      \
  37          ((_profile)->mode == (_mode)))
  38
  39 #define COMPLAIN_MODE(_profile) PROFILE_MODE((_profile), APPARMOR_COMPLAIN)
  40
  41 #define KILL_MODE(_profile) PROFILE_MODE((_profile), APPARMOR_KILL)
  42
  43 #define PROFILE_IS_HAT(_profile) ((_profile)->flags & PFLAG_HAT)
  44
  45 #define PROFILE_INVALID(_profile) ((_profile)->flags & PFLAG_INVALID)
  46
  47 #define on_list_rcu(X) (!list_empty(X) && (X)->prev != LIST_POISON2)
  48
  49 /*
  50  * FIXME: currently need a clean way to replace and remove profiles as a
  51  * set.  It should be done at the namespace level.
  52  * Either, with a set of profiles loaded at the namespace level or via
  53  * a mark and remove marked interface.
  54  */
  55 enum profile_mode {
  56         APPARMOR_ENFORCE,       /* enforce access rules */
  57         APPARMOR_COMPLAIN,      /* allow and log access violations */
  58         APPARMOR_KILL,          /* kill task on access violation */
  59 };
  60
  61 enum profile_flags {
  62         PFLAG_HAT = 1,                  /* profile is a hat */
  63         PFLAG_UNCONFINED = 2,           /* profile is an unconfined profile */
  64         PFLAG_NULL = 4,                 /* profile is null learning profile */
  65         PFLAG_IX_ON_NAME_ERROR = 8,     /* fallback to ix on name lookup fail */
  66         PFLAG_IMMUTABLE = 0x10,         /* don't allow changes/replacement */
  67         PFLAG_USER_DEFINED = 0x20,      /* user based profile - lower privs */
  68         PFLAG_NO_LIST_REF = 0x40,       /* list doesn't keep profile ref */
  69         PFLAG_OLD_NULL_TRANS = 0x100,   /* use // as the null transition */
  70         PFLAG_INVALID = 0x200,          /* profile replaced/removed */
  71         PFLAG_NS_COUNT = 0x400,         /* carries NS ref count */
  72
  73         /* These flags must correspond with PATH_flags */
  74         PFLAG_MEDIATE_DELETED = 0x10000, /* mediate instead delegate deleted */
  75 };
  76
  77 struct aa_profile;
  78
  79 /* struct aa_policy - common part of both namespaces and profiles
  80  * @name: name of the object
  81  * @hname - The hierarchical name
  82  * @list: list policy object is on
  83  * @rcu: rcu head used when removing from @list
  84  * @profiles: head of the profiles list contained in the object
  85  */
  86 struct aa_policy {
  87         char *name;
  88         char *hname;
  89         struct list_head list;
  90         struct list_head profiles;
  91         struct rcu_head rcu;
  92 };
  93
  94 /* struct aa_ns_acct - accounting of profiles in namespace
  95  * @max_size: maximum space allowed for all profiles in namespace
  96  * @max_count: maximum number of profiles that can be in this namespace
  97  * @size: current size of profiles
  98  * @count: current count of profiles (includes null profiles)
  99  */
 100 struct aa_ns_acct {
 101         int max_size;
 102         int max_count;
 103         int size;
 104         int count;
 105 };
 106
 107 /* struct aa_namespace - namespace for a set of profiles
 108  * @base: common policy
 109  * @parent: parent of namespace
 110  * @lock: lock for modifying the object
 111  * @acct: accounting for the namespace
 112  * @unconfined: special unconfined profile for the namespace
 113  * @sub_ns: list of namespaces under the current namespace.
 114  * @uniq_null: uniq value used for null learning profiles
 115  *
 116  * An aa_namespace defines the set profiles that are searched to determine
 117  * which profile to attach to a task.  Profiles can not be shared between
 118  * aa_namespaces and profile names within a namespace are guaranteed to be
 119  * unique.  When profiles in separate namespaces have the same name they
 120  * are NOT considered to be equivalent.
 121  *
 122  * Namespaces are hierarchical and only namespaces and profiles below the
 123  * current namespace are visible.
 124  *
 125  * Namespace names must be unique and can not contain the characters :/\0
 126  *
 127  * FIXME TODO: add vserver support of namespaces (can it all be done in
 128  *             userspace?)
 129  */
 130 struct aa_namespace {
 131         struct aa_policy base;
 132         struct aa_namespace *parent;
 133         struct mutex lock;
 134         struct aa_ns_acct acct;
 135         struct aa_profile *unconfined;
 136         struct list_head sub_ns;
 137         atomic_t uniq_null;
 138 };
 139
 140 /* struct aa_policydb - match engine for a policy
 141  * dfa: dfa pattern match
 142  * start: set of start states for the different classes of data
 143  */
 144 struct aa_policydb {
 145         /* Generic policy DFA specific rule types will be subsections of it */
 146         struct aa_dfa *dfa;
 147         unsigned int start[AA_CLASS_LAST + 1];
 148
 149 };
 150
 151 struct aa_replacedby {
 152         struct kref count;
 153         struct aa_profile __rcu *profile;
 154 };
 155
 156
 157 /* struct aa_profile - basic confinement data
 158  * @base - base components of the profile (name, refcount, lists, lock ...)
 159  * @count: reference count of the obj
 160  * @parent: parent of profile
 161  * @ns: namespace the profile is in
 162  * @replacedby: is set to the profile that replaced this profile
 163  * @rename: optional profile name that this profile renamed
 164  * @xmatch: optional extended matching for unconfined executables names
 165  * @xmatch_len: xmatch prefix len, used to determine xmatch priority
 166  * @audit: the auditing mode of the profile
 167  * @mode: the enforcement mode of the profile
 168  * @flags: flags controlling profile behavior
 169  * @path_flags: flags controlling path generation behavior
 170  * @size: the memory consumed by this profiles rules
 171  * @policy: general match rules governing policy
 172  * @file: The set of rules governing basic file access and domain transitions
 173  * @caps: capabilities for the profile
 174  * @rlimits: rlimits for the profile
 175  *
 176  * The AppArmor profile contains the basic confinement data.  Each profile
 177  * has a name, and exists in a namespace.  The @name and @exec_match are
 178  * used to determine profile attachment against unconfined tasks.  All other
 179  * attachments are determined by profile X transition rules.
 180  *
 181  * The @replacedby struct is write protected by the profile lock.
 182  *
 183  * Profiles have a hierarchy where hats and children profiles keep
 184  * a reference to their parent.
 185  *
 186  * Profile names can not begin with a : and can not contain the \0
 187  * character.  If a profile name begins with / it will be considered when
 188  * determining profile attachment on "unconfined" tasks.
 189  */
 190 struct aa_profile {
 191         struct aa_policy base;
 192         struct kref count;
 193         struct aa_profile __rcu *parent;
 194
 195         struct aa_namespace *ns;
 196         struct aa_replacedby *replacedby;
 197         const char *rename;
 198
 199         struct aa_dfa *xmatch;
 200         int xmatch_len;
 201         enum audit_mode audit;
 202         enum profile_mode mode;
 203         long flags;
 204         u32 path_flags;
 205         int size;
 206
 207         struct aa_policydb policy;
 208         struct aa_file_rules file;
 209         struct aa_caps caps;
 210         struct aa_rlimit rlimits;
 211 };
 212
 213 extern struct aa_namespace *root_ns;
 214 extern enum profile_mode aa_g_profile_mode;
 215
 216 void aa_add_profile(struct aa_policy *common, struct aa_profile *profile);
 217
 218 bool aa_ns_visible(struct aa_namespace *curr, struct aa_namespace *view);
 219 const char *aa_ns_name(struct aa_namespace *parent, struct aa_namespace *child);
 220 int aa_alloc_root_ns(void);
 221 void aa_free_root_ns(void);
 222 void aa_free_namespace_kref(struct kref *kref);
 223
 224 struct aa_namespace *aa_find_namespace(struct aa_namespace *root,
 225                                        const char *name);
 226
 227
 228 void aa_free_replacedby_kref(struct kref *kref);
 229 struct aa_profile *aa_alloc_profile(const char *name);
 230 struct aa_profile *aa_new_null_profile(struct aa_profile *parent, int hat);
 231 void aa_free_profile_kref(struct kref *kref);
 232 struct aa_profile *aa_find_child(struct aa_profile *parent, const char *name);
 233 struct aa_profile *aa_lookup_profile(struct aa_namespace *ns, const char *name);
 234 struct aa_profile *aa_match_profile(struct aa_namespace *ns, const char *name);
 235
 236 ssize_t aa_replace_profiles(void *udata, size_t size, bool noreplace);
 237 ssize_t aa_remove_profiles(char *name, size_t size);
 238
 239 #define PROF_ADD 1
 240 #define PROF_REPLACE 0
 241
 242 #define unconfined(X) ((X)->flags & PFLAG_UNCONFINED)
 243
 244
 245 /**
 246  * aa_get_profile - increment refcount on profile @p
 247  * @p: profile  (MAYBE NULL)
 248  *
 249  * Returns: pointer to @p if @p is NULL will return NULL
 250  * Requires: @p must be held with valid refcount when called
 251  */
 252 static inline struct aa_profile *aa_get_profile(struct aa_profile *p)
 253 {
 254         if (p)
 255                 kref_get(&(p->count));
 256
 257         return p;
 258 }
 259
 260 /**
 261  * aa_get_profile_not0 - increment refcount on profile @p found via lookup
 262  * @p: profile  (MAYBE NULL)
 263  *
 264  * Returns: pointer to @p if @p is NULL will return NULL
 265  * Requires: @p must be held with valid refcount when called
 266  */
 267 static inline struct aa_profile *aa_get_profile_not0(struct aa_profile *p)
 268 {
 269         if (p && kref_get_not0(&p->count))
 270                 return p;
 271
 272         return NULL;
 273 }
 274
 275 /**
 276  * aa_get_profile_rcu - increment a refcount profile that can be replaced
 277  * @p: pointer to profile that can be replaced (NOT NULL)
 278  *
 279  * Returns: pointer to a refcounted profile.
 280  *     else NULL if no profile
 281  */
 282 static inline struct aa_profile *aa_get_profile_rcu(struct aa_profile __rcu **p)
 283 {
 284         struct aa_profile *c;
 285
 286         rcu_read_lock();
 287         do {
 288                 c = rcu_dereference(*p);
 289         } while (c && !kref_get_not0(&c->count));
 290         rcu_read_unlock();
 291
 292         return c;
 293 }
 294
 295 /**
 296  * aa_get_newest_profile - find the newest version of @profile
 297  * @profile: the profile to check for newer versions of
 298  *
 299  * Returns: refcounted newest version of @profile taking into account
 300  *          replacement, renames and removals
 301  *          return @profile.
 302  */
 303 static inline struct aa_profile *aa_get_newest_profile(struct aa_profile *p)
 304 {
 305         if (!p)
 306                 return NULL;
 307
 308         if (PROFILE_INVALID(p))
 309                 return aa_get_profile_rcu(&p->replacedby->profile);
 310
 311         return aa_get_profile(p);
 312 }
 313
 314 /**
 315  * aa_put_profile - decrement refcount on profile @p
 316  * @p: profile  (MAYBE NULL)
 317  */
 318 static inline void aa_put_profile(struct aa_profile *p)
 319 {
 320         if (p) {
 321                 if (p->flags & PFLAG_NS_COUNT)
 322                         kref_put(&p->count, aa_free_namespace_kref);
 323                 else
 324                         kref_put(&p->count, aa_free_profile_kref);
 325         }
 326 }
 327
 328 static inline struct aa_replacedby *aa_get_replacedby(struct aa_replacedby *p)
 329 {
 330         if (p)
 331                 kref_get(&(p->count));
 332
 333         return p;
 334 }
 335
 336 static inline void aa_put_replacedby(struct aa_replacedby *p)
 337 {
 338         if (p)
 339                 kref_put(&p->count, aa_free_replacedby_kref);
 340 }
 341
 342 /* requires profile list write lock held */
 343 static inline void __aa_update_replacedby(struct aa_profile *orig,
 344                                           struct aa_profile *new)
 345 {
 346         struct aa_profile *tmp = rcu_dereference(orig->replacedby->profile);
 347         rcu_assign_pointer(orig->replacedby->profile, aa_get_profile(new));
 348         orig->flags |= PFLAG_INVALID;
 349         aa_put_profile(tmp);
 350 }
 351
 352 /**
 353  * aa_get_namespace - increment references count on @ns
 354  * @ns: namespace to increment reference count of (MAYBE NULL)
 355  *
 356  * Returns: pointer to @ns, if @ns is NULL returns NULL
 357  * Requires: @ns must be held with valid refcount when called
 358  */
 359 static inline struct aa_namespace *aa_get_namespace(struct aa_namespace *ns)
 360 {
 361         if (ns)
 362                 aa_get_profile(ns->unconfined);
 363
 364         return ns;
 365 }
 366
 367 /**
 368  * aa_put_namespace - decrement refcount on @ns
 369  * @ns: namespace to put reference of
 370  *
 371  * Decrement reference count of @ns and if no longer in use free it
 372  */
 373 static inline void aa_put_namespace(struct aa_namespace *ns)
 374 {
 375         if (ns)
 376                 aa_put_profile(ns->unconfined);
 377 }
 378
 379 static inline int AUDIT_MODE(struct aa_profile *profile)
 380 {
 381         if (aa_g_audit != AUDIT_NORMAL)
 382                 return aa_g_audit;
 383
 384         return profile->audit;
 385 }
 386
 387 bool aa_may_manage_policy(int op);
 388
 389 #endif /* __AA_POLICY_H */