kernel/audit.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /* audit -- definition of audit_context structure and supporting types
   3  *
   4  * Copyright 2003-2004 Red Hat, Inc.
   5  * Copyright 2005 Hewlett-Packard Development Company, L.P.
   6  * Copyright 2005 IBM Corporation
   7  */
   8
   9 #include <linux/fs.h>
  10 #include <linux/audit.h>
  11 #include <linux/skbuff.h>
  12 #include <linux/security.h>
  13 #include <uapi/linux/mqueue.h>
  14 #include <linux/tty.h>
  15
  16 /* AUDIT_NAMES is the number of slots we reserve in the audit_context
  17  * for saving names from getname().  If we get more names we will allocate
  18  * a name dynamically and also add those to the list anchored by names_list. */
  19 #define AUDIT_NAMES     5
  20
  21 /* At task start time, the audit_state is set in the audit_context using
  22    a per-task filter.  At syscall entry, the audit_state is augmented by
  23    the syscall filter. */
  24 enum audit_state {
  25         AUDIT_DISABLED,         /* Do not create per-task audit_context.
  26                                  * No syscall-specific audit records can
  27                                  * be generated. */
  28         AUDIT_BUILD_CONTEXT,    /* Create the per-task audit_context,
  29                                  * and fill it in at syscall
  30                                  * entry time.  This makes a full
  31                                  * syscall record available if some
  32                                  * other part of the kernel decides it
  33                                  * should be recorded. */
  34         AUDIT_RECORD_CONTEXT    /* Create the per-task audit_context,
  35                                  * always fill it in at syscall entry
  36                                  * time, and always write out the audit
  37                                  * record at syscall exit time.  */
  38 };
  39
  40 /* Rule lists */
  41 struct audit_watch;
  42 struct audit_fsnotify_mark;
  43 struct audit_tree;
  44 struct audit_chunk;
  45
  46 struct audit_entry {
  47         struct list_head        list;
  48         struct rcu_head         rcu;
  49         struct audit_krule      rule;
  50 };
  51
  52 struct audit_cap_data {
  53         kernel_cap_t            permitted;
  54         kernel_cap_t            inheritable;
  55         union {
  56                 unsigned int    fE;             /* effective bit of file cap */
  57                 kernel_cap_t    effective;      /* effective set of process */
  58         };
  59         kernel_cap_t            ambient;
  60         kuid_t                  rootid;
  61 };
  62
  63 /* When fs/namei.c:getname() is called, we store the pointer in name and bump
  64  * the refcnt in the associated filename struct.
  65  *
  66  * Further, in fs/namei.c:path_lookup() we store the inode and device.
  67  */
  68 struct audit_names {
  69         struct list_head        list;           /* audit_context->names_list */
  70
  71         struct filename         *name;
  72         int                     name_len;       /* number of chars to log */
  73         bool                    hidden;         /* don't log this record */
  74
  75         unsigned long           ino;
  76         dev_t                   dev;
  77         umode_t                 mode;
  78         kuid_t                  uid;
  79         kgid_t                  gid;
  80         dev_t                   rdev;
  81         struct lsmblob          oblob;
  82         struct audit_cap_data   fcap;
  83         unsigned int            fcap_ver;
  84         unsigned char           type;           /* record type */
  85         /*
  86          * This was an allocated audit_names and not from the array of
  87          * names allocated in the task audit context.  Thus this name
  88          * should be freed on syscall exit.
  89          */
  90         bool                    should_free;
  91 };
  92
  93 struct audit_proctitle {
  94         int     len;    /* length of the cmdline field. */
  95         char    *value; /* the cmdline field */
  96 };
  97
  98 /* The per-task audit context. */
  99 struct audit_context {
 100         int                 dummy;      /* must be the first element */
 101         int                 in_syscall; /* 1 if task is in a syscall */
 102         enum audit_state    state, current_state;
 103         unsigned int        serial;     /* serial number for record */
 104         int                 major;      /* syscall number */
 105         struct timespec64   ctime;      /* time of syscall entry */
 106         unsigned long       argv[4];    /* syscall arguments */
 107         long                return_code;/* syscall return code */
 108         u64                 prio;
 109         int                 return_valid; /* return code is valid */
 110         /*
 111          * The names_list is the list of all audit_names collected during this
 112          * syscall.  The first AUDIT_NAMES entries in the names_list will
 113          * actually be from the preallocated_names array for performance
 114          * reasons.  Except during allocation they should never be referenced
 115          * through the preallocated_names array and should only be found/used
 116          * by running the names_list.
 117          */
 118         struct audit_names  preallocated_names[AUDIT_NAMES];
 119         int                 name_count; /* total records in names_list */
 120         struct list_head    names_list; /* struct audit_names->list anchor */
 121         char                *filterkey; /* key for rule that triggered record */
 122         struct path         pwd;
 123         struct audit_aux_data *aux;
 124         struct audit_aux_data *aux_pids;
 125         struct sockaddr_storage *sockaddr;
 126         size_t sockaddr_len;
 127                                 /* Save things to print about task_struct */
 128         pid_t               pid, ppid;
 129         kuid_t              uid, euid, suid, fsuid;
 130         kgid_t              gid, egid, sgid, fsgid;
 131         unsigned long       personality;
 132         int                 arch;
 133
 134         pid_t               target_pid;
 135         kuid_t              target_auid;
 136         kuid_t              target_uid;
 137         unsigned int        target_sessionid;
 138         struct lsmblob      target_lsm;
 139         char                target_comm[TASK_COMM_LEN];
 140
 141         struct audit_tree_refs *trees, *first_trees;
 142         struct list_head killed_trees;
 143         int tree_count;
 144
 145         int type;
 146         union {
 147                 struct {
 148                         int nargs;
 149                         long args[6];
 150                 } socketcall;
 151                 struct {
 152                         kuid_t                  uid;
 153                         kgid_t                  gid;
 154                         umode_t                 mode;
 155                         struct lsmblob          oblob;
 156                         int                     has_perm;
 157                         uid_t                   perm_uid;
 158                         gid_t                   perm_gid;
 159                         umode_t                 perm_mode;
 160                         unsigned long           qbytes;
 161                 } ipc;
 162                 struct {
 163                         mqd_t                   mqdes;
 164                         struct mq_attr          mqstat;
 165                 } mq_getsetattr;
 166                 struct {
 167                         mqd_t                   mqdes;
 168                         int                     sigev_signo;
 169                 } mq_notify;
 170                 struct {
 171                         mqd_t                   mqdes;
 172                         size_t                  msg_len;
 173                         unsigned int            msg_prio;
 174                         struct timespec64       abs_timeout;
 175                 } mq_sendrecv;
 176                 struct {
 177                         int                     oflag;
 178                         umode_t                 mode;
 179                         struct mq_attr          attr;
 180                 } mq_open;
 181                 struct {
 182                         pid_t                   pid;
 183                         struct audit_cap_data   cap;
 184                 } capset;
 185                 struct {
 186                         int                     fd;
 187                         int                     flags;
 188                 } mmap;
 189                 struct {
 190                         int                     argc;
 191                 } execve;
 192                 struct {
 193                         char                    *name;
 194                 } module;
 195         };
 196         int fds[2];
 197         struct audit_proctitle proctitle;
 198 };
 199
 200 extern bool audit_ever_enabled;
 201
 202 extern void audit_log_session_info(struct audit_buffer *ab);
 203
 204 extern int auditd_test_task(struct task_struct *task);
 205
 206 #define AUDIT_INODE_BUCKETS     32
 207 extern struct list_head audit_inode_hash[AUDIT_INODE_BUCKETS];
 208
 209 static inline int audit_hash_ino(u32 ino)
 210 {
 211         return (ino & (AUDIT_INODE_BUCKETS-1));
 212 }
 213
 214 /* Indicates that audit should log the full pathname. */
 215 #define AUDIT_NAME_FULL -1
 216
 217 extern int audit_match_class(int class, unsigned syscall);
 218 extern int audit_comparator(const u32 left, const u32 op, const u32 right);
 219 extern int audit_uid_comparator(kuid_t left, u32 op, kuid_t right);
 220 extern int audit_gid_comparator(kgid_t left, u32 op, kgid_t right);
 221 extern int parent_len(const char *path);
 222 extern int audit_compare_dname_path(const struct qstr *dname, const char *path, int plen);
 223 extern struct sk_buff *audit_make_reply(int seq, int type, int done, int multi,
 224                                         const void *payload, int size);
 225 extern void                 audit_panic(const char *message);
 226
 227 struct audit_netlink_list {
 228         __u32 portid;
 229         struct net *net;
 230         struct sk_buff_head q;
 231 };
 232
 233 int audit_send_list_thread(void *_dest);
 234
 235 extern int selinux_audit_rule_update(void);
 236
 237 extern struct mutex audit_filter_mutex;
 238 extern int audit_del_rule(struct audit_entry *entry);
 239 extern void audit_free_rule_rcu(struct rcu_head *head);
 240 extern struct list_head audit_filter_list[];
 241
 242 extern struct audit_entry *audit_dupe_rule(struct audit_krule *old);
 243
 244 extern void audit_log_d_path_exe(struct audit_buffer *ab,
 245                                  struct mm_struct *mm);
 246
 247 extern struct tty_struct *audit_get_tty(void);
 248 extern void audit_put_tty(struct tty_struct *tty);
 249
 250 /* audit watch/mark/tree functions */
 251 #ifdef CONFIG_AUDITSYSCALL
 252 extern unsigned int audit_serial(void);
 253 extern int auditsc_get_stamp(struct audit_context *ctx,
 254                               struct timespec64 *t, unsigned int *serial);
 255
 256 extern void audit_put_watch(struct audit_watch *watch);
 257 extern void audit_get_watch(struct audit_watch *watch);
 258 extern int audit_to_watch(struct audit_krule *krule, char *path, int len,
 259                           u32 op);
 260 extern int audit_add_watch(struct audit_krule *krule, struct list_head **list);
 261 extern void audit_remove_watch_rule(struct audit_krule *krule);
 262 extern char *audit_watch_path(struct audit_watch *watch);
 263 extern int audit_watch_compare(struct audit_watch *watch, unsigned long ino,
 264                                dev_t dev);
 265
 266 extern struct audit_fsnotify_mark *audit_alloc_mark(struct audit_krule *krule,
 267                                                     char *pathname, int len);
 268 extern char *audit_mark_path(struct audit_fsnotify_mark *mark);
 269 extern void audit_remove_mark(struct audit_fsnotify_mark *audit_mark);
 270 extern void audit_remove_mark_rule(struct audit_krule *krule);
 271 extern int audit_mark_compare(struct audit_fsnotify_mark *mark,
 272                               unsigned long ino, dev_t dev);
 273 extern int audit_dupe_exe(struct audit_krule *new, struct audit_krule *old);
 274 extern int audit_exe_compare(struct task_struct *tsk,
 275                              struct audit_fsnotify_mark *mark);
 276
 277 extern struct audit_chunk *audit_tree_lookup(const struct inode *inode);
 278 extern void audit_put_chunk(struct audit_chunk *chunk);
 279 extern bool audit_tree_match(struct audit_chunk *chunk,
 280                              struct audit_tree *tree);
 281 extern int audit_make_tree(struct audit_krule *rule, char *pathname, u32 op);
 282 extern int audit_add_tree_rule(struct audit_krule *rule);
 283 extern int audit_remove_tree_rule(struct audit_krule *rule);
 284 extern void audit_trim_trees(void);
 285 extern int audit_tag_tree(char *old, char *new);
 286 extern const char *audit_tree_path(struct audit_tree *tree);
 287 extern void audit_put_tree(struct audit_tree *tree);
 288 extern void audit_kill_trees(struct audit_context *context);
 289
 290 extern int audit_signal_info_syscall(struct task_struct *t);
 291 extern void audit_filter_inodes(struct task_struct *tsk,
 292                                 struct audit_context *ctx);
 293 extern struct list_head *audit_killed_trees(void);
 294 #else /* CONFIG_AUDITSYSCALL */
 295 #define auditsc_get_stamp(c, t, s) 0
 296 #define audit_put_watch(w) {}
 297 #define audit_get_watch(w) {}
 298 #define audit_to_watch(k, p, l, o) (-EINVAL)
 299 #define audit_add_watch(k, l) (-EINVAL)
 300 #define audit_remove_watch_rule(k) BUG()
 301 #define audit_watch_path(w) ""
 302 #define audit_watch_compare(w, i, d) 0
 303
 304 #define audit_alloc_mark(k, p, l) (ERR_PTR(-EINVAL))
 305 #define audit_mark_path(m) ""
 306 #define audit_remove_mark(m)
 307 #define audit_remove_mark_rule(k)
 308 #define audit_mark_compare(m, i, d) 0
 309 #define audit_exe_compare(t, m) (-EINVAL)
 310 #define audit_dupe_exe(n, o) (-EINVAL)
 311
 312 #define audit_remove_tree_rule(rule) BUG()
 313 #define audit_add_tree_rule(rule) -EINVAL
 314 #define audit_make_tree(rule, str, op) -EINVAL
 315 #define audit_trim_trees() (void)0
 316 #define audit_put_tree(tree) (void)0
 317 #define audit_tag_tree(old, new) -EINVAL
 318 #define audit_tree_path(rule) ""        /* never called */
 319 #define audit_kill_trees(context) BUG()
 320
 321 static inline int audit_signal_info_syscall(struct task_struct *t)
 322 {
 323         return 0;
 324 }
 325
 326 #define audit_filter_inodes(t, c) AUDIT_DISABLED
 327 #endif /* CONFIG_AUDITSYSCALL */
 328
 329 extern char *audit_unpack_string(void **bufp, size_t *remain, size_t len);
 330
 331 extern struct lsmblob audit_sig_lsm;
 332
 333 extern int audit_filter(int msgtype, unsigned int listtype);
 334
 335 extern void audit_ctl_lock(void);
 336 extern void audit_ctl_unlock(void);