security/smack/smack.h

   1 /*
   2  * Copyright (C) 2007 Casey Schaufler <casey@schaufler-ca.com>
   3  *
   4  *      This program is free software; you can redistribute it and/or modify
   5  *      it under the terms of the GNU General Public License as published by
   6  *      the Free Software Foundation, version 2.
   7  *
   8  * Author:
   9  *      Casey Schaufler <casey@schaufler-ca.com>
  10  *
  11  */
  12
  13 #ifndef _SECURITY_SMACK_H
  14 #define _SECURITY_SMACK_H
  15
  16 #include <linux/capability.h>
  17 #include <linux/spinlock.h>
  18 #include <linux/security.h>
  19 #include <linux/in.h>
  20 #include <net/netlabel.h>
  21 #include <linux/list.h>
  22 #include <linux/rculist.h>
  23 #include <linux/lsm_audit.h>
  24
  25 /*
  26  * Smack labels were limited to 23 characters for a long time.
  27  */
  28 #define SMK_LABELLEN    24
  29 #define SMK_LONGLABEL   256
  30
  31 /*
  32  * This is the repository for labels seen so that it is
  33  * not necessary to keep allocating tiny chuncks of memory
  34  * and so that they can be shared.
  35  *
  36  * Labels are never modified in place. Anytime a label
  37  * is imported (e.g. xattrset on a file) the list is checked
  38  * for it and it is added if it doesn't exist. The address
  39  * is passed out in either case. Entries are added, but
  40  * never deleted.
  41  *
  42  * Since labels are hanging around anyway it doesn't
  43  * hurt to maintain a secid for those awkward situations
  44  * where kernel components that ought to use LSM independent
  45  * interfaces don't. The secid should go away when all of
  46  * these components have been repaired.
  47  *
  48  * The cipso value associated with the label gets stored here, too.
  49  *
  50  * Keep the access rules for this subject label here so that
  51  * the entire set of rules does not need to be examined every
  52  * time.
  53  */
  54 struct smack_known {
  55         struct list_head                list;
  56         struct hlist_node               smk_hashed;
  57         char                            *smk_known;
  58         u32                             smk_secid;
  59         struct netlbl_lsm_secattr       smk_netlabel;   /* on wire labels */
  60         struct list_head                smk_rules;      /* access rules */
  61         struct mutex                    smk_rules_lock; /* lock for rules */
  62 };
  63
  64 /*
  65  * Maximum number of bytes for the levels in a CIPSO IP option.
  66  * Why 23? CIPSO is constrained to 30, so a 32 byte buffer is
  67  * bigger than can be used, and 24 is the next lower multiple
  68  * of 8, and there are too many issues if there isn't space set
  69  * aside for the terminating null byte.
  70  */
  71 #define SMK_CIPSOLEN    24
  72
  73 struct superblock_smack {
  74         char            *smk_root;
  75         char            *smk_floor;
  76         char            *smk_hat;
  77         char            *smk_default;
  78         int             smk_initialized;
  79 };
  80
  81 struct socket_smack {
  82         struct smack_known      *smk_out;       /* outbound label */
  83         char                    *smk_in;        /* inbound label */
  84         char                    *smk_packet;    /* TCP peer label */
  85 };
  86
  87 /*
  88  * Inode smack data
  89  */
  90 struct inode_smack {
  91         char                    *smk_inode;     /* label of the fso */
  92         struct smack_known      *smk_task;      /* label of the task */
  93         struct smack_known      *smk_mmap;      /* label of the mmap domain */
  94         struct mutex            smk_lock;       /* initialization lock */
  95         int                     smk_flags;      /* smack inode flags */
  96 };
  97
  98 struct task_smack {
  99         struct smack_known      *smk_task;      /* label for access control */
 100         struct smack_known      *smk_forked;    /* label when forked */
 101         struct list_head        smk_rules;      /* per task access rules */
 102         struct mutex            smk_rules_lock; /* lock for the rules */
 103 };
 104
 105 #define SMK_INODE_INSTANT       0x01    /* inode is instantiated */
 106 #define SMK_INODE_TRANSMUTE     0x02    /* directory is transmuting */
 107 #define SMK_INODE_CHANGED       0x04    /* smack was transmuted */
 108
 109 /*
 110  * A label access rule.
 111  */
 112 struct smack_rule {
 113         struct list_head        list;
 114         struct smack_known      *smk_subject;
 115         char                    *smk_object;
 116         int                     smk_access;
 117 };
 118
 119 /*
 120  * An entry in the table identifying hosts.
 121  */
 122 struct smk_netlbladdr {
 123         struct list_head        list;
 124         struct sockaddr_in      smk_host;       /* network address */
 125         struct in_addr          smk_mask;       /* network mask */
 126         char                    *smk_label;     /* label */
 127 };
 128
 129 /*
 130  * An entry in the table identifying ports.
 131  */
 132 struct smk_port_label {
 133         struct list_head        list;
 134         struct sock             *smk_sock;      /* socket initialized on */
 135         unsigned short          smk_port;       /* the port number */
 136         char                    *smk_in;        /* incoming label */
 137         struct smack_known      *smk_out;       /* outgoing label */
 138 };
 139
 140 struct smack_onlycap {
 141         struct list_head        list;
 142         struct smack_known      *smk_label;
 143 };
 144
 145 /*
 146  * Mount options
 147  */
 148 #define SMK_FSDEFAULT   "smackfsdef="
 149 #define SMK_FSFLOOR     "smackfsfloor="
 150 #define SMK_FSHAT       "smackfshat="
 151 #define SMK_FSROOT      "smackfsroot="
 152 #define SMK_FSTRANS     "smackfstransmute="
 153
 154 #define SMACK_CIPSO_OPTION      "-CIPSO"
 155
 156 /*
 157  * How communications on this socket are treated.
 158  * Usually it's determined by the underlying netlabel code
 159  * but there are certain cases, including single label hosts
 160  * and potentially single label interfaces for which the
 161  * treatment can not be known in advance.
 162  *
 163  * The possibility of additional labeling schemes being
 164  * introduced in the future exists as well.
 165  */
 166 #define SMACK_UNLABELED_SOCKET  0
 167 #define SMACK_CIPSO_SOCKET      1
 168
 169 /*
 170  * smackfs magic number
 171  */
 172 #define SMACK_MAGIC     0x43415d53 /* "SMAC" */
 173
 174 /*
 175  * CIPSO defaults.
 176  */
 177 #define SMACK_CIPSO_DOI_DEFAULT         3       /* Historical */
 178 #define SMACK_CIPSO_DOI_INVALID         -1      /* Not a DOI */
 179 #define SMACK_CIPSO_DIRECT_DEFAULT      250     /* Arbitrary */
 180 #define SMACK_CIPSO_MAPPED_DEFAULT      251     /* Also arbitrary */
 181 #define SMACK_CIPSO_MAXLEVEL            255     /* CIPSO 2.2 standard */
 182 /*
 183  * CIPSO 2.2 standard is 239, but Smack wants to use the
 184  * categories in a structured way that limits the value to
 185  * the bits in 23 bytes, hence the unusual number.
 186  */
 187 #define SMACK_CIPSO_MAXCATNUM           184     /* 23 * 8 */
 188
 189 /*
 190  * Flags for untraditional access modes.
 191  * It shouldn't be necessary to avoid conflicts with definitions
 192  * in fs.h, but do so anyway.
 193  */
 194 #define MAY_TRANSMUTE   0x00001000      /* Controls directory labeling */
 195 #define MAY_LOCK        0x00002000      /* Locks should be writes, but ... */
 196
 197 /*
 198  * Just to make the common cases easier to deal with
 199  */
 200 #define MAY_ANYREAD     (MAY_READ | MAY_EXEC)
 201 #define MAY_READWRITE   (MAY_READ | MAY_WRITE)
 202 #define MAY_NOT         0
 203
 204 /*
 205  * Number of access types used by Smack (rwxatl)
 206  */
 207 #define SMK_NUM_ACCESS_TYPE 6
 208
 209 /*
 210  * Smack audit data; is empty if CONFIG_AUDIT not set
 211  * to save some stack
 212  */
 213 struct smk_audit_info {
 214 #ifdef CONFIG_AUDIT
 215         struct common_audit_data a;
 216 #endif
 217 };
 218
 219 struct smack_master_list {
 220         struct list_head        list;
 221         struct smack_rule       *smk_rule;
 222 };
 223
 224 /*
 225  * These functions are in smack_lsm.c
 226  */
 227 struct inode_smack *new_inode_smack(char *);
 228
 229 /*
 230  * These functions are in smack_access.c
 231  */
 232 int smk_access_entry(char *, char *, struct list_head *);
 233 int smk_access(struct smack_known *, char *, int, struct smk_audit_info *);
 234 int smk_curacc(char *, u32, struct smk_audit_info *);
 235 struct smack_known *smack_from_secid(const u32);
 236 char *smk_parse_smack(const char *string, int len);
 237 int smk_netlbl_mls(int, char *, struct netlbl_lsm_secattr *, int);
 238 char *smk_import(const char *, int);
 239 struct smack_known *smk_import_entry(const char *, int);
 240 void smk_insert_entry(struct smack_known *skp);
 241 struct smack_known *smk_find_entry(const char *);
 242 u32 smack_to_secid(const char *);
 243 int smack_privileged(int cap);
 244
 245 /*
 246  * Shared data.
 247  */
 248 extern int smack_cipso_direct;
 249 extern int smack_cipso_mapped;
 250 extern struct smack_known *smack_net_ambient;
 251 extern const char *smack_cipso_option;
 252
 253 extern struct smack_known smack_known_floor;
 254 extern struct smack_known smack_known_hat;
 255 extern struct smack_known smack_known_huh;
 256 extern struct smack_known smack_known_invalid;
 257 extern struct smack_known smack_known_star;
 258 extern struct smack_known smack_known_web;
 259
 260 extern struct mutex     smack_known_lock;
 261 extern struct list_head smack_known_list;
 262 extern struct list_head smk_netlbladdr_list;
 263
 264 /* Cache for fast and thrifty allocations */
 265 extern struct kmem_cache *smack_rule_cache;
 266 extern struct kmem_cache *smack_master_list_cache;
 267
 268 extern struct security_operations smack_ops;
 269
 270 extern struct mutex     smack_onlycap_lock;
 271 extern struct list_head smack_onlycap_list;
 272
 273 #define SMACK_HASH_SLOTS 16
 274 extern struct hlist_head smack_known_hash[SMACK_HASH_SLOTS];
 275
 276 /*
 277  * Is the directory transmuting?
 278  */
 279 static inline int smk_inode_transmutable(const struct inode *isp)
 280 {
 281         struct inode_smack *sip = isp->i_security;
 282         return (sip->smk_flags & SMK_INODE_TRANSMUTE) != 0;
 283 }
 284
 285 /*
 286  * Present a pointer to the smack label in an inode blob.
 287  */
 288 static inline char *smk_of_inode(const struct inode *isp)
 289 {
 290         struct inode_smack *sip = isp->i_security;
 291         return sip->smk_inode;
 292 }
 293
 294 /*
 295  * Present a pointer to the smack label entry in an task blob.
 296  */
 297 static inline struct smack_known *smk_of_task(const struct task_smack *tsp)
 298 {
 299         return tsp->smk_task;
 300 }
 301
 302 /*
 303  * Present a pointer to the forked smack label entry in an task blob.
 304  */
 305 static inline struct smack_known *smk_of_forked(const struct task_smack *tsp)
 306 {
 307         return tsp->smk_forked;
 308 }
 309
 310 /*
 311  * Present a pointer to the smack label in the current task blob.
 312  */
 313 static inline struct smack_known *smk_of_current(void)
 314 {
 315         return smk_of_task(current_security());
 316 }
 317
 318 #ifdef CONFIG_SECURITY_SMACK_PERMISSIVE_MODE
 319 /*
 320  * permissive mode
 321  */
 322 #define SMACK_PERMISSIVE_DENIED 0x0
 323 #define SMACK_PERMISSIVE_ALLOWED 0x1
 324 extern int permissive_mode;
 325 #endif
 326
 327 /*
 328  * logging functions
 329  */
 330 #define SMACK_AUDIT_DENIED 0x1
 331 #define SMACK_AUDIT_ACCEPT 0x2
 332 extern int log_policy;
 333
 334 void smack_log(char *subject_label, char *object_label,
 335                 int request,
 336                 int result, struct smk_audit_info *auditdata);
 337
 338 #ifdef CONFIG_AUDIT
 339
 340 /*
 341  * some inline functions to set up audit data
 342  * they do nothing if CONFIG_AUDIT is not set
 343  *
 344  */
 345 static inline void smk_ad_init(struct smk_audit_info *a, const char *func,
 346                                char type)
 347 {
 348         memset(a, 0, sizeof(*a));
 349         a->a.type = type;
 350         a->a.smack_audit_data.function = func;
 351 }
 352
 353 static inline void smk_ad_setfield_u_tsk(struct smk_audit_info *a,
 354                                          struct task_struct *t)
 355 {
 356         a->a.u.tsk = t;
 357 }
 358 static inline void smk_ad_setfield_u_fs_path_dentry(struct smk_audit_info *a,
 359                                                     struct dentry *d)
 360 {
 361         a->a.u.dentry = d;
 362 }
 363 static inline void smk_ad_setfield_u_fs_inode(struct smk_audit_info *a,
 364                                               struct inode *i)
 365 {
 366         a->a.u.inode = i;
 367 }
 368 static inline void smk_ad_setfield_u_fs_path(struct smk_audit_info *a,
 369                                              struct path p)
 370 {
 371         a->a.u.path = p;
 372 }
 373 static inline void smk_ad_setfield_u_net_sk(struct smk_audit_info *a,
 374                                             struct sock *sk)
 375 {
 376         a->a.u.net.sk = sk;
 377 }
 378
 379 #else /* no AUDIT */
 380
 381 static inline void smk_ad_init(struct smk_audit_info *a, const char *func,
 382                                char type)
 383 {
 384 }
 385 static inline void smk_ad_setfield_u_tsk(struct smk_audit_info *a,
 386                                          struct task_struct *t)
 387 {
 388 }
 389 static inline void smk_ad_setfield_u_fs_path_dentry(struct smk_audit_info *a,
 390                                                     struct dentry *d)
 391 {
 392 }
 393 static inline void smk_ad_setfield_u_fs_path_mnt(struct smk_audit_info *a,
 394                                                  struct vfsmount *m)
 395 {
 396 }
 397 static inline void smk_ad_setfield_u_fs_inode(struct smk_audit_info *a,
 398                                               struct inode *i)
 399 {
 400 }
 401 static inline void smk_ad_setfield_u_fs_path(struct smk_audit_info *a,
 402                                              struct path p)
 403 {
 404 }
 405 static inline void smk_ad_setfield_u_net_sk(struct smk_audit_info *a,
 406                                             struct sock *sk)
 407 {
 408 }
 409 #endif
 410
 411 #endif  /* _SECURITY_SMACK_H */