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 /*
 141  * Mount options
 142  */
 143 #define SMK_FSDEFAULT   "smackfsdef="
 144 #define SMK_FSFLOOR     "smackfsfloor="
 145 #define SMK_FSHAT       "smackfshat="
 146 #define SMK_FSROOT      "smackfsroot="
 147 #define SMK_FSTRANS     "smackfstransmute="
 148
 149 #define SMACK_CIPSO_OPTION      "-CIPSO"
 150
 151 /*
 152  * How communications on this socket are treated.
 153  * Usually it's determined by the underlying netlabel code
 154  * but there are certain cases, including single label hosts
 155  * and potentially single label interfaces for which the
 156  * treatment can not be known in advance.
 157  *
 158  * The possibility of additional labeling schemes being
 159  * introduced in the future exists as well.
 160  */
 161 #define SMACK_UNLABELED_SOCKET  0
 162 #define SMACK_CIPSO_SOCKET      1
 163
 164 /*
 165  * smackfs magic number
 166  */
 167 #define SMACK_MAGIC     0x43415d53 /* "SMAC" */
 168
 169 /*
 170  * CIPSO defaults.
 171  */
 172 #define SMACK_CIPSO_DOI_DEFAULT         3       /* Historical */
 173 #define SMACK_CIPSO_DOI_INVALID         -1      /* Not a DOI */
 174 #define SMACK_CIPSO_DIRECT_DEFAULT      250     /* Arbitrary */
 175 #define SMACK_CIPSO_MAPPED_DEFAULT      251     /* Also arbitrary */
 176 #define SMACK_CIPSO_MAXLEVEL            255     /* CIPSO 2.2 standard */
 177 /*
 178  * CIPSO 2.2 standard is 239, but Smack wants to use the
 179  * categories in a structured way that limits the value to
 180  * the bits in 23 bytes, hence the unusual number.
 181  */
 182 #define SMACK_CIPSO_MAXCATNUM           184     /* 23 * 8 */
 183
 184 /*
 185  * Flags for untraditional access modes.
 186  * It shouldn't be necessary to avoid conflicts with definitions
 187  * in fs.h, but do so anyway.
 188  */
 189 #define MAY_TRANSMUTE   0x00001000      /* Controls directory labeling */
 190 #define MAY_LOCK        0x00002000      /* Locks should be writes, but ... */
 191
 192 /*
 193  * Just to make the common cases easier to deal with
 194  */
 195 #define MAY_ANYREAD     (MAY_READ | MAY_EXEC)
 196 #define MAY_READWRITE   (MAY_READ | MAY_WRITE)
 197 #define MAY_NOT         0
 198
 199 /*
 200  * Number of access types used by Smack (rwxatl)
 201  */
 202 #define SMK_NUM_ACCESS_TYPE 6
 203
 204 /*
 205  * Smack audit data; is empty if CONFIG_AUDIT not set
 206  * to save some stack
 207  */
 208 struct smk_audit_info {
 209 #ifdef CONFIG_AUDIT
 210         struct common_audit_data a;
 211 #endif
 212 };
 213
 214 struct smack_master_list {
 215         struct list_head        list;
 216         struct smack_rule       *smk_rule;
 217 };
 218
 219 /*
 220  * These functions are in smack_lsm.c
 221  */
 222 struct inode_smack *new_inode_smack(char *);
 223
 224 /*
 225  * These functions are in smack_access.c
 226  */
 227 int smk_access_entry(char *, char *, struct list_head *);
 228 int smk_access(struct smack_known *, char *, int, struct smk_audit_info *);
 229 int smk_curacc(char *, u32, struct smk_audit_info *);
 230 struct smack_known *smack_from_secid(const u32);
 231 char *smk_parse_smack(const char *string, int len);
 232 int smk_netlbl_mls(int, char *, struct netlbl_lsm_secattr *, int);
 233 char *smk_import(const char *, int);
 234 struct smack_known *smk_import_entry(const char *, int);
 235 void smk_insert_entry(struct smack_known *skp);
 236 struct smack_known *smk_find_entry(const char *);
 237 u32 smack_to_secid(const char *);
 238
 239 /*
 240  * Shared data.
 241  */
 242 extern int smack_cipso_direct;
 243 extern int smack_cipso_mapped;
 244 extern struct smack_known *smack_net_ambient;
 245 extern char *smack_onlycap;
 246 extern const char *smack_cipso_option;
 247
 248 extern struct smack_known smack_known_floor;
 249 extern struct smack_known smack_known_hat;
 250 extern struct smack_known smack_known_huh;
 251 extern struct smack_known smack_known_invalid;
 252 extern struct smack_known smack_known_star;
 253 extern struct smack_known smack_known_web;
 254
 255 extern struct mutex     smack_known_lock;
 256 extern struct list_head smack_known_list;
 257 extern struct list_head smk_netlbladdr_list;
 258
 259 /* Cache for fast and thrifty allocations */
 260 extern struct kmem_cache *smack_rule_cache;
 261 extern struct kmem_cache *smack_master_list_cache;
 262
 263 extern struct security_operations smack_ops;
 264
 265 #define SMACK_HASH_SLOTS 16
 266 extern struct hlist_head smack_known_hash[SMACK_HASH_SLOTS];
 267
 268 /*
 269  * Is the directory transmuting?
 270  */
 271 static inline int smk_inode_transmutable(const struct inode *isp)
 272 {
 273         struct inode_smack *sip = isp->i_security;
 274         return (sip->smk_flags & SMK_INODE_TRANSMUTE) != 0;
 275 }
 276
 277 /*
 278  * Present a pointer to the smack label in an inode blob.
 279  */
 280 static inline char *smk_of_inode(const struct inode *isp)
 281 {
 282         struct inode_smack *sip = isp->i_security;
 283         return sip->smk_inode;
 284 }
 285
 286 /*
 287  * Present a pointer to the smack label entry in an task blob.
 288  */
 289 static inline struct smack_known *smk_of_task(const struct task_smack *tsp)
 290 {
 291         return tsp->smk_task;
 292 }
 293
 294 /*
 295  * Present a pointer to the forked smack label entry in an task blob.
 296  */
 297 static inline struct smack_known *smk_of_forked(const struct task_smack *tsp)
 298 {
 299         return tsp->smk_forked;
 300 }
 301
 302 /*
 303  * Present a pointer to the smack label in the current task blob.
 304  */
 305 static inline struct smack_known *smk_of_current(void)
 306 {
 307         return smk_of_task(current_security());
 308 }
 309
 310 /*
 311  * Is the task privileged and allowed to be privileged
 312  * by the onlycap rule.
 313  */
 314 static inline int smack_privileged(int cap)
 315 {
 316         struct smack_known *skp = smk_of_current();
 317
 318         if (!capable(cap))
 319                 return 0;
 320         if (smack_onlycap == NULL || smack_onlycap == skp->smk_known)
 321                 return 1;
 322         return 0;
 323 }
 324
 325 #ifdef CONFIG_SECURITY_SMACK_PERMISSIVE_MODE
 326 /*
 327  * permissive mode
 328  */
 329 #define SMACK_PERMISSIVE_DENIED 0x0
 330 #define SMACK_PERMISSIVE_ALLOWED 0x1
 331 extern int permissive_mode;
 332 #endif
 333
 334 /*
 335  * logging functions
 336  */
 337 #define SMACK_AUDIT_DENIED 0x1
 338 #define SMACK_AUDIT_ACCEPT 0x2
 339 extern int log_policy;
 340
 341 void smack_log(char *subject_label, char *object_label,
 342                 int request,
 343                 int result, struct smk_audit_info *auditdata);
 344
 345 #ifdef CONFIG_AUDIT
 346
 347 /*
 348  * some inline functions to set up audit data
 349  * they do nothing if CONFIG_AUDIT is not set
 350  *
 351  */
 352 static inline void smk_ad_init(struct smk_audit_info *a, const char *func,
 353                                char type)
 354 {
 355         memset(a, 0, sizeof(*a));
 356         a->a.type = type;
 357         a->a.smack_audit_data.function = func;
 358 }
 359
 360 static inline void smk_ad_setfield_u_tsk(struct smk_audit_info *a,
 361                                          struct task_struct *t)
 362 {
 363         a->a.u.tsk = t;
 364 }
 365 static inline void smk_ad_setfield_u_fs_path_dentry(struct smk_audit_info *a,
 366                                                     struct dentry *d)
 367 {
 368         a->a.u.dentry = d;
 369 }
 370 static inline void smk_ad_setfield_u_fs_inode(struct smk_audit_info *a,
 371                                               struct inode *i)
 372 {
 373         a->a.u.inode = i;
 374 }
 375 static inline void smk_ad_setfield_u_fs_path(struct smk_audit_info *a,
 376                                              struct path p)
 377 {
 378         a->a.u.path = p;
 379 }
 380 static inline void smk_ad_setfield_u_net_sk(struct smk_audit_info *a,
 381                                             struct sock *sk)
 382 {
 383         a->a.u.net.sk = sk;
 384 }
 385
 386 #else /* no AUDIT */
 387
 388 static inline void smk_ad_init(struct smk_audit_info *a, const char *func,
 389                                char type)
 390 {
 391 }
 392 static inline void smk_ad_setfield_u_tsk(struct smk_audit_info *a,
 393                                          struct task_struct *t)
 394 {
 395 }
 396 static inline void smk_ad_setfield_u_fs_path_dentry(struct smk_audit_info *a,
 397                                                     struct dentry *d)
 398 {
 399 }
 400 static inline void smk_ad_setfield_u_fs_path_mnt(struct smk_audit_info *a,
 401                                                  struct vfsmount *m)
 402 {
 403 }
 404 static inline void smk_ad_setfield_u_fs_inode(struct smk_audit_info *a,
 405                                               struct inode *i)
 406 {
 407 }
 408 static inline void smk_ad_setfield_u_fs_path(struct smk_audit_info *a,
 409                                              struct path p)
 410 {
 411 }
 412 static inline void smk_ad_setfield_u_net_sk(struct smk_audit_info *a,
 413                                             struct sock *sk)
 414 {
 415 }
 416 #endif
 417
 418 #endif  /* _SECURITY_SMACK_H */