sys/bsm/audit_record.h

   1 /*
   2  * Copyright (c) 2005 Apple Computer, Inc.
   3  * All rights reserved.
   4  *
   5  * @APPLE_BSD_LICENSE_HEADER_START@
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1.  Redistributions of source code must retain the above copyright
  12  *     notice, this list of conditions and the following disclaimer.
  13  * 2.  Redistributions in binary form must reproduce the above copyright
  14  *     notice, this list of conditions and the following disclaimer in the
  15  *     documentation and/or other materials provided with the distribution.
  16  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
  17  *     its contributors may be used to endorse or promote products derived
  18  *     from this software without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
  21  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  22  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  23  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
  24  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  25  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  27  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  29  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30  *
  31  * @APPLE_BSD_LICENSE_HEADER_END@
  32  *
  33  * $P4: //depot/projects/trustedbsd/audit3/sys/bsm/audit_record.h#21 $
  34  * $FreeBSD$
  35  */
  36
  37 #ifndef _BSM_AUDIT_RECORD_H_
  38 #define _BSM_AUDIT_RECORD_H_
  39
  40 #include <sys/time.h>                   /* struct timeval */
  41
  42 /*
  43  * Token type identifiers.
  44  */
  45 #define AUT_INVALID             0x00
  46 #define AUT_OTHER_FILE32        0x11
  47 #define AUT_OHEADER             0x12
  48 #define AUT_TRAILER             0x13
  49 #define AUT_HEADER32            0x14
  50 #define AUT_HEADER32_EX         0x15
  51 #define AUT_DATA                0x21
  52 #define AUT_IPC                 0x22
  53 #define AUT_PATH                0x23
  54 #define AUT_SUBJECT32           0x24
  55 #define AUT_SERVER32            0x25
  56 #define AUT_PROCESS32           0x26
  57 #define AUT_RETURN32            0x27
  58 #define AUT_TEXT                0x28
  59 #define AUT_OPAQUE              0x29
  60 #define AUT_IN_ADDR             0x2a
  61 #define AUT_IP                  0x2b
  62 #define AUT_IPORT               0x2c
  63 #define AUT_ARG32               0x2d
  64 #define AUT_SOCKET              0x2e
  65 #define AUT_SEQ                 0x2f
  66 #define AUT_ACL                 0x30
  67 #define AUT_ATTR                0x31
  68 #define AUT_IPC_PERM            0x32
  69 #define AUT_LABEL               0x33
  70 #define AUT_GROUPS              0x34
  71 #define AUT_ILABEL              0x35
  72 #define AUT_SLABEL              0x36
  73 #define AUT_CLEAR               0x37
  74 #define AUT_PRIV                0x38
  75 #define AUT_UPRIV               0x39
  76 #define AUT_LIAISON             0x3a
  77 #define AUT_NEWGROUPS           0x3b
  78 #define AUT_EXEC_ARGS           0x3c
  79 #define AUT_EXEC_ENV            0x3d
  80 #define AUT_ATTR32              0x3e
  81 /* #define      AUT_????        0x3f */
  82 #define AUT_XATOM               0x40
  83 #define AUT_XOBJ                0x41
  84 #define AUT_XPROTO              0x42
  85 #define AUT_XSELECT             0x43
  86 /* XXXRW: Additional X11 tokens not defined? */
  87 #define AUT_CMD                 0x51
  88 #define AUT_EXIT                0x52
  89 /* XXXRW: OpenBSM AUT_HOST 0x70? */
  90 #define AUT_ARG64               0x71
  91 #define AUT_RETURN64            0x72
  92 #define AUT_ATTR64              0x73
  93 #define AUT_HEADER64            0x74
  94 #define AUT_SUBJECT64           0x75
  95 #define AUT_SERVER64            0x76
  96 #define AUT_PROCESS64           0x77
  97 #define AUT_OTHER_FILE64        0x78
  98 #define AUT_HEADER64_EX         0x79
  99 #define AUT_SUBJECT32_EX        0x7a
 100 #define AUT_PROCESS32_EX        0x7b
 101 #define AUT_SUBJECT64_EX        0x7c
 102 #define AUT_PROCESS64_EX        0x7d
 103 #define AUT_IN_ADDR_EX          0x7e
 104 #define AUT_SOCKET_EX           0x7f
 105
 106 /*
 107  * Pre-64-bit BSM, 32-bit tokens weren't explicitly named as '32'.  We have
 108  * compatibility defines.
 109  */
 110 #define AUT_HEADER              AUT_HEADER32
 111 #define AUT_ARG                 AUT_ARG32
 112 #define AUT_RETURN              AUT_RETURN32
 113 #define AUT_SUBJECT             AUT_SUBJECT32
 114 #define AUT_SERVER              AUT_SERVER32
 115 #define AUT_PROCESS             AUT_PROCESS32
 116 #define AUT_OTHER_FILE          AUT_OTHER_FILE32
 117
 118 /*
 119  * Darwin's bsm distribution uses the following non-BSM token name defines.
 120  * We provide them for a single OpenBSM release for compatibility reasons.
 121  */
 122 #define AU_FILE_TOKEN           AUT_OTHER_FILE32
 123 #define AU_TRAILER_TOKEN        AUT_TRAILER
 124 #define AU_HEADER_32_TOKEN      AUT_HEADER32
 125 #define AU_DATA_TOKEN           AUT_DATA
 126 #define AU_ARB_TOKEN            AUT_DATA
 127 #define AU_IPC_TOKEN            AUT_IPC
 128 #define AU_PATH_TOKEN           AUT_PATH
 129 #define AU_SUBJECT_32_TOKEN     AUT_SUBJECT32
 130 #define AU_PROCESS_32_TOKEN     AUT_PROCESS32
 131 #define AU_RETURN_32_TOKEN      AUT_RETURN32
 132 #define AU_TEXT_TOKEN           AUT_TEXT
 133 #define AU_OPAQUE_TOKEN         AUT_OPAQUE
 134 #define AU_IN_ADDR_TOKEN        AUT_IN_ADDR
 135 #define AU_IP_TOKEN             AUT_IP
 136 #define AU_IPORT_TOKEN          AUT_IPORT
 137 #define AU_ARG32_TOKEN          AUT_ARG32
 138 #define AU_SOCK_TOKEN           AUT_SOCKET
 139 #define AU_SEQ_TOKEN            AUT_SEQ
 140 #define AU_ATTR_TOKEN           AUT_ATTR
 141 #define AU_IPCPERM_TOKEN        AUT_IPC_PERM
 142 #define AU_NEWGROUPS_TOKEN      AUT_NEWGROUPS
 143 #define AU_EXEC_ARG_TOKEN       AUT_EXEC_ARGS
 144 #define AU_EXEC_ENV_TOKEN       AUT_EXEC_ENV
 145 #define AU_ATTR32_TOKEN         AUT_ATTR32
 146 #define AU_CMD_TOKEN            AUT_CMD
 147 #define AU_EXIT_TOKEN           AUT_EXIT
 148 #define AU_ARG64_TOKEN          AUT_ARG64
 149 #define AU_RETURN_64_TOKEN      AUT_RETURN64
 150 #define AU_ATTR64_TOKEN         AUT_ATTR64
 151 #define AU_HEADER_64_TOKEN      AUT_HEADER64
 152 #define AU_SUBJECT_64_TOKEN     AUT_SUBJECT64
 153 #define AU_PROCESS_64_TOKEN     AUT_PROCESS64
 154 #define AU_HEADER_64_EX_TOKEN   AUT_HEADER64_EX
 155 #define AU_SUBJECT_32_EX_TOKEN  AUT_SUBJECT32_EX
 156 #define AU_PROCESS_32_EX_TOKEN  AUT_PROCESS32_EX
 157 #define AU_SUBJECT_64_EX_TOKEN  AUT_SUBJECT64_EX
 158 #define AU_PROCESS_64_EX_TOKEN  AUT_PROCESS64_EX
 159 #define AU_IN_ADDR_EX_TOKEN     AUT_IN_ADDR_EX
 160 #define AU_SOCK_32_EX_TOKEN     AUT_SOCKET_EX
 161
 162 /*
 163  * The values for the following token ids are not defined by BSM.
 164  *
 165  * XXXRW: Not sure how to handle these in OpenBSM yet, but I'll give them
 166  * names more consistent with Sun's BSM.  These originally came from Apple's
 167  * BSM.
 168  */
 169 #define AUT_SOCKINET32          0x80            /* XXX */
 170 #define AUT_SOCKINET128         0x81            /* XXX */
 171 #define AUT_SOCKUNIX            0x82            /* XXX */
 172 #define AU_SOCK_INET_32_TOKEN   AUT_SOCKINET32
 173 #define AU_SOCK_INET_128_TOKEN  AUT_SOCKINET128
 174 #define AU_SOCK_UNIX_TOKEN      AUT_SOCKUNIX
 175
 176 /* print values for the arbitrary token */
 177 #define AUP_BINARY      0
 178 #define AUP_OCTAL       1
 179 #define AUP_DECIMAL     2
 180 #define AUP_HEX         3
 181 #define AUP_STRING      4
 182
 183 /* data-types for the arbitrary token */
 184 #define AUR_BYTE        0
 185 #define AUR_CHAR        AUR_BYTE
 186 #define AUR_SHORT       1
 187 #define AUR_INT32       2
 188 #define AUR_INT         AUR_INT32
 189 #define AUR_INT64       3
 190
 191 /* ... and their sizes */
 192 #define AUR_BYTE_SIZE       sizeof(u_char)
 193 #define AUR_CHAR_SIZE       AUR_BYTE_SIZE
 194 #define AUR_SHORT_SIZE      sizeof(uint16_t)
 195 #define AUR_INT32_SIZE      sizeof(uint32_t)
 196 #define AUR_INT_SIZE        AUR_INT32_SIZE
 197 #define AUR_INT64_SIZE      sizeof(uint64_t)
 198
 199 /* Modifiers for the header token */
 200 #define PAD_NOTATTR  0x4000   /* nonattributable event */
 201 #define PAD_FAILURE  0x8000   /* fail audit event */
 202
 203 #define AUDIT_MAX_GROUPS      16
 204
 205 /*
 206  * A number of BSM versions are floating around and defined.  Here are
 207  * constants for them.  OpenBSM uses the same token types, etc, used in the
 208  * Solaris BSM version, but has a separate version number in order to
 209  * identify a potentially different event identifier name space.
 210  */
 211 #define AUDIT_HEADER_VERSION_OLDDARWIN  1       /* In retrospect, a mistake. */
 212 #define AUDIT_HEADER_VERSION_SOLARIS    2
 213 #define AUDIT_HEADER_VERSION_TSOL25     3
 214 #define AUDIT_HEADER_VERSION_TSOL       4
 215 #define AUDIT_HEADER_VERSION_OPENBSM    10
 216
 217 /*
 218  * BSM define is AUT_TRAILER_MAGIC; Apple BSM define is TRAILER_PAD_MAGIC; we
 219  * split the difference, will remove the Apple define for the next release.
 220  */
 221 #define AUT_TRAILER_MAGIC       0xb105
 222 #define TRAILER_PAD_MAGIC       AUT_TRAILER_MAGIC
 223
 224 /* BSM library calls */
 225
 226 __BEGIN_DECLS
 227
 228 struct in_addr;
 229 struct in6_addr;
 230 struct ip;
 231 struct ipc_perm;
 232 struct kevent;
 233 struct sockaddr_in;
 234 struct sockaddr_in6;
 235 struct sockaddr_un;
 236 #if defined(_KERNEL) || defined(KERNEL)
 237 struct vnode_au_info;
 238 #endif
 239
 240 int      au_open(void);
 241 int      au_write(int d, token_t *m);
 242 int      au_close(int d, int keep, short event);
 243 int      au_close_buffer(int d, short event, u_char *buffer, size_t *buflen);
 244 int      au_close_token(token_t *tok, u_char *buffer, size_t *buflen);
 245
 246 token_t *au_to_file(char *file, struct timeval tm);
 247
 248 token_t *au_to_header32_tm(int rec_size, au_event_t e_type, au_emod_t e_mod,
 249             struct timeval tm);
 250 #if !defined(KERNEL) && !defined(_KERNEL)
 251 token_t *au_to_header(int rec_size, au_event_t e_type, au_emod_t e_mod);
 252 token_t *au_to_header32(int rec_size, au_event_t e_type, au_emod_t e_mod);
 253 token_t *au_to_header64(int rec_size, au_event_t e_type, au_emod_t e_mod);
 254 #endif
 255
 256 token_t *au_to_me(void);
 257 token_t *au_to_arg(char n, char *text, uint32_t v);
 258 token_t *au_to_arg32(char n, char *text, uint32_t v);
 259 token_t *au_to_arg64(char n, char *text, uint64_t v);
 260
 261 #if defined(_KERNEL) || defined(KERNEL)
 262 token_t *au_to_attr(struct vnode_au_info *vni);
 263 token_t *au_to_attr32(struct vnode_au_info *vni);
 264 token_t *au_to_attr64(struct vnode_au_info *vni);
 265 #endif
 266
 267 token_t *au_to_data(char unit_print, char unit_type, char unit_count,
 268             char *p);
 269 token_t *au_to_exit(int retval, int err);
 270 token_t *au_to_groups(int *groups);
 271 token_t *au_to_newgroups(uint16_t n, gid_t *groups);
 272 token_t *au_to_in_addr(struct in_addr *internet_addr);
 273 token_t *au_to_in_addr_ex(struct in6_addr *internet_addr);
 274 token_t *au_to_ip(struct ip *ip);
 275 token_t *au_to_ipc(char type, int id);
 276 token_t *au_to_ipc_perm(struct ipc_perm *perm);
 277 token_t *au_to_iport(uint16_t iport);
 278 token_t *au_to_opaque(char *data, uint16_t bytes);
 279 token_t *au_to_path(char *path);
 280 token_t *au_to_process(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 281             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
 282 token_t *au_to_process32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 283             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
 284 token_t *au_to_process64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 285             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
 286 token_t *au_to_process_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 287             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid);
 288 token_t *au_to_process32_ex(au_id_t auid, uid_t euid, gid_t egid,
 289             uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
 290             au_tid_addr_t *tid);
 291 token_t *au_to_process64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 292             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid);
 293 token_t *au_to_return(char status, uint32_t ret);
 294 token_t *au_to_return32(char status, uint32_t ret);
 295 token_t *au_to_return64(char status, uint64_t ret);
 296 token_t *au_to_seq(long audit_count);
 297
 298 #if defined(_KERNEL) || defined(KERNEL)
 299 token_t *au_to_socket(struct socket *so);
 300 token_t *au_to_socket_ex_32(uint16_t lp, uint16_t rp, struct sockaddr *la,
 301             struct sockaddr *ta);
 302 token_t *au_to_socket_ex_128(uint16_t lp, uint16_t rp, struct sockaddr *la,
 303             struct sockaddr *ta);
 304 #endif
 305
 306 token_t *au_to_sock_inet(struct sockaddr_in *so);
 307 token_t *au_to_sock_inet32(struct sockaddr_in *so);
 308 token_t *au_to_sock_inet128(struct sockaddr_in6 *so);
 309 token_t *au_to_sock_unix(struct sockaddr_un *so);
 310 token_t *au_to_subject(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 311             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
 312 token_t *au_to_subject32(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 313             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
 314 token_t *au_to_subject64(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 315             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_t *tid);
 316 token_t *au_to_subject_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 317             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid);
 318 token_t *au_to_subject32_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 319             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid);
 320 token_t *au_to_subject64_ex(au_id_t auid, uid_t euid, gid_t egid, uid_t ruid,
 321             gid_t rgid, pid_t pid, au_asid_t sid, au_tid_addr_t *tid);
 322 #if defined(_KERNEL) || defined(KERNEL)
 323 token_t *au_to_exec_args(char *args, int argc);
 324 token_t *au_to_exec_env(char *envs, int envc);
 325 #else
 326 token_t *au_to_exec_args(char **argv);
 327 token_t *au_to_exec_env(char **envp);
 328 #endif
 329 token_t *au_to_text(char *text);
 330 token_t *au_to_kevent(struct kevent *kev);
 331 token_t *au_to_trailer(int rec_size);
 332
 333 __END_DECLS
 334
 335 #endif /* ! _BSM_AUDIT_RECORD_H_ */