2 * Copyright (c) 2004-2008 Apple Inc.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
14 * its contributors may be used to endorse or promote products derived
15 * from this software without specific prior written permission.
17 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
21 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
25 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
26 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
27 * POSSIBILITY OF SUCH DAMAGE.
31 * Tool used to merge and select audit records from audit trail files
35 * XXX Currently we do not support merging of records from multiple
36 * XXX audit trail files
37 * XXX We assume that records are sorted chronologically - both wrt to
38 * XXX the records present within the file and between the files themselves
41 #include <config/config.h>
43 #define _GNU_SOURCE /* Required for strptime() on glibc2. */
45 #ifdef HAVE_FULL_QUEUE_H
46 #include <sys/queue.h>
48 #include <compat/queue.h>
51 #include <bsm/libbsm.h>
66 #include <compat/strlcpy.h>
69 #include "auditreduce.h"
71 static TAILQ_HEAD(tailhead, re_entry) re_head =
72 TAILQ_HEAD_INITIALIZER(re_head);
75 extern int optind, optopt, opterr,optreset;
77 static au_mask_t maskp; /* Class. */
78 static time_t p_atime; /* Created after this time. */
79 static time_t p_btime; /* Created before this time. */
80 static int p_auid; /* Audit id. */
81 static int p_euid; /* Effective user id. */
82 static int p_egid; /* Effective group id. */
83 static int p_rgid; /* Real group id. */
84 static int p_ruid; /* Real user id. */
85 static int p_subid; /* Subject id. */
88 * Maintain a dynamically sized array of events for -m
90 static uint16_t *p_evec; /* Event type list */
91 static int p_evec_used; /* Number of events used */
92 static int p_evec_alloc; /* Number of events allocated */
95 * Following are the objects (-o option) that we can select upon.
97 static char *p_fileobj = NULL;
98 static char *p_msgqobj = NULL;
99 static char *p_pidobj = NULL;
100 static char *p_semobj = NULL;
101 static char *p_shmobj = NULL;
102 static char *p_sockobj = NULL;
104 static uint32_t opttochk = 0;
107 parse_regexp(char *re_string)
109 char *orig, *copy, re_error[64];
110 struct re_entry *rep;
111 int error, nstrs, i, len;
113 copy = strdup(re_string);
116 for (nstrs = 0, i = 0; i < len; i++) {
117 if (copy[i] == ',' && i > 0) {
118 if (copy[i - 1] == '\\')
119 strlcpy(©[i - 1], ©[i], len);
126 TAILQ_INIT(&re_head);
127 for (i = 0; i < nstrs + 1; i++) {
128 rep = calloc(1, sizeof(*rep));
130 (void) fprintf(stderr, "calloc: %s\n",
138 rep->re_pattern = strdup(copy);
139 error = regcomp(&rep->re_regexp, rep->re_pattern,
140 REG_EXTENDED | REG_NOSUB);
142 regerror(error, &rep->re_regexp, re_error, 64);
143 (void) fprintf(stderr, "regcomp: %s\n", re_error);
146 TAILQ_INSERT_TAIL(&re_head, rep, re_glue);
154 usage(const char *msg)
156 fprintf(stderr, "%s\n", msg);
157 fprintf(stderr, "Usage: auditreduce [options] [file ...]\n");
158 fprintf(stderr, "\tOptions are : \n");
159 fprintf(stderr, "\t-A : all records\n");
160 fprintf(stderr, "\t-a YYYYMMDD[HH[[MM[SS]]] : after date\n");
161 fprintf(stderr, "\t-b YYYYMMDD[HH[[MM[SS]]] : before date\n");
162 fprintf(stderr, "\t-c <flags> : matching class\n");
163 fprintf(stderr, "\t-d YYYYMMDD : on date\n");
164 fprintf(stderr, "\t-e <uid|name> : effective user\n");
165 fprintf(stderr, "\t-f <gid|group> : effective group\n");
166 fprintf(stderr, "\t-g <gid|group> : real group\n");
167 fprintf(stderr, "\t-j <pid> : subject id \n");
168 fprintf(stderr, "\t-m <evno|evname> : matching event\n");
169 fprintf(stderr, "\t-o objecttype=objectvalue\n");
170 fprintf(stderr, "\t\t file=<pathname>\n");
171 fprintf(stderr, "\t\t msgqid=<ID>\n");
172 fprintf(stderr, "\t\t pid=<ID>\n");
173 fprintf(stderr, "\t\t semid=<ID>\n");
174 fprintf(stderr, "\t\t shmid=<ID>\n");
175 fprintf(stderr, "\t-r <uid|name> : real user\n");
176 fprintf(stderr, "\t-u <uid|name> : audit user\n");
177 fprintf(stderr, "\t-v : select non-matching records\n");
182 * Check if the given auid matches the selection criteria.
188 /* Check if we want to select on auid. */
189 if (ISOPTSET(opttochk, OPT_u)) {
197 * Check if the given euid matches the selection criteria.
200 select_euid(int euser)
203 /* Check if we want to select on euid. */
204 if (ISOPTSET(opttochk, OPT_e)) {
212 * Check if the given egid matches the selection criteria.
215 select_egid(int egrp)
218 /* Check if we want to select on egid. */
219 if (ISOPTSET(opttochk, OPT_f)) {
227 * Check if the given rgid matches the selection criteria.
233 /* Check if we want to select on rgid. */
234 if (ISOPTSET(opttochk, OPT_g)) {
242 * Check if the given ruid matches the selection criteria.
245 select_ruid(int user)
248 /* Check if we want to select on rgid. */
249 if (ISOPTSET(opttochk, OPT_r)) {
257 * Check if the given subject id (pid) matches the selection criteria.
260 select_subid(int subid)
263 /* Check if we want to select on subject uid. */
264 if (ISOPTSET(opttochk, OPT_j)) {
265 if (subid != p_subid)
273 * Check if object's pid maches the given pid.
276 select_pidobj(uint32_t pid)
279 if (ISOPTSET(opttochk, OPT_op)) {
280 if (pid != (uint32_t)strtol(p_pidobj, (char **)NULL, 10))
287 * Check if the given ipc object with the given type matches the selection
291 select_ipcobj(u_char type, uint32_t id, uint32_t *optchkd)
294 if (type == AT_IPC_MSG) {
295 SETOPT((*optchkd), OPT_om);
296 if (ISOPTSET(opttochk, OPT_om)) {
297 if (id != (uint32_t)strtol(p_msgqobj, (char **)NULL,
302 } else if (type == AT_IPC_SEM) {
303 SETOPT((*optchkd), OPT_ose);
304 if (ISOPTSET(opttochk, OPT_ose)) {
305 if (id != (uint32_t)strtol(p_semobj, (char **)NULL, 10))
309 } else if (type == AT_IPC_SHM) {
310 SETOPT((*optchkd), OPT_osh);
311 if (ISOPTSET(opttochk, OPT_osh)) {
312 if (id != (uint32_t)strtol(p_shmobj, (char **)NULL, 10))
318 /* Unknown type -- filter if *any* ipc filtering is required. */
319 if (ISOPTSET(opttochk, OPT_om) || ISOPTSET(opttochk, OPT_ose)
320 || ISOPTSET(opttochk, OPT_osh))
328 * Check if the file name matches selection criteria.
331 select_filepath(char *path, uint32_t *optchkd)
333 struct re_entry *rep;
336 SETOPT((*optchkd), OPT_of);
338 if (ISOPTSET(opttochk, OPT_of)) {
340 TAILQ_FOREACH(rep, &re_head, re_glue) {
341 if (regexec(&rep->re_regexp, path, 0, NULL,
343 return (!rep->re_negate);
350 * Returns 1 if the following pass the selection rules:
359 select_hdr32(tokenstr_t tok, uint32_t *optchkd)
364 SETOPT((*optchkd), (OPT_A | OPT_a | OPT_b | OPT_c | OPT_m | OPT_v));
366 /* The A option overrides a, b and d. */
367 if (!ISOPTSET(opttochk, OPT_A)) {
368 if (ISOPTSET(opttochk, OPT_a)) {
369 if (difftime((time_t)tok.tt.hdr32.s, p_atime) < 0) {
370 /* Record was created before p_atime. */
375 if (ISOPTSET(opttochk, OPT_b)) {
376 if (difftime(p_btime, (time_t)tok.tt.hdr32.s) < 0) {
377 /* Record was created after p_btime. */
383 if (ISOPTSET(opttochk, OPT_c)) {
385 * Check if the classes represented by the event matches
388 if (au_preselect(tok.tt.hdr32.e_type, &maskp, AU_PRS_BOTH,
389 AU_PRS_USECACHE) != 1)
393 /* Check if event matches. */
394 if (ISOPTSET(opttochk, OPT_m)) {
396 for (ev = p_evec; ev < &p_evec[p_evec_used]; ev++)
397 if (tok.tt.hdr32.e_type == *ev)
407 select_return32(tokenstr_t tok_ret32, tokenstr_t tok_hdr32, uint32_t *optchkd)
411 SETOPT((*optchkd), (OPT_c));
412 if (tok_ret32.tt.ret32.status == 0)
413 sorf = AU_PRS_SUCCESS;
415 sorf = AU_PRS_FAILURE;
416 if (ISOPTSET(opttochk, OPT_c)) {
417 if (au_preselect(tok_hdr32.tt.hdr32.e_type, &maskp, sorf,
418 AU_PRS_USECACHE) != 1)
425 * Return 1 if checks for the the following succeed
434 select_proc32(tokenstr_t tok, uint32_t *optchkd)
437 SETOPT((*optchkd), (OPT_u | OPT_e | OPT_f | OPT_g | OPT_r | OPT_op));
439 if (!select_auid(tok.tt.proc32.auid))
441 if (!select_euid(tok.tt.proc32.euid))
443 if (!select_egid(tok.tt.proc32.egid))
445 if (!select_rgid(tok.tt.proc32.rgid))
447 if (!select_ruid(tok.tt.proc32.ruid))
449 if (!select_pidobj(tok.tt.proc32.pid))
455 * Return 1 if checks for the the following succeed
464 select_subj32(tokenstr_t tok, uint32_t *optchkd)
467 SETOPT((*optchkd), (OPT_u | OPT_e | OPT_f | OPT_g | OPT_r | OPT_j));
469 if (!select_auid(tok.tt.subj32.auid))
471 if (!select_euid(tok.tt.subj32.euid))
473 if (!select_egid(tok.tt.subj32.egid))
475 if (!select_rgid(tok.tt.subj32.rgid))
477 if (!select_ruid(tok.tt.subj32.ruid))
479 if (!select_subid(tok.tt.subj32.pid))
485 * Read each record from the audit trail. Check if it is selected after
486 * passing through each of the options
489 select_records(FILE *fp)
491 tokenstr_t tok_hdr32_copy;
501 while ((reclen = au_read_rec(fp, &buf)) != -1) {
505 while ((selected == 1) && (bytesread < reclen)) {
506 if (-1 == au_fetch_tok(&tok, buf + bytesread,
507 reclen - bytesread)) {
508 /* Is this an incomplete record? */
514 * For each token type we have have different
515 * selection criteria.
519 selected = select_hdr32(tok,
521 bcopy(&tok, &tok_hdr32_copy,
526 selected = select_proc32(tok,
531 selected = select_subj32(tok,
536 selected = select_ipcobj(
537 tok.tt.ipc.type, tok.tt.ipc.id,
542 selected = select_filepath(
543 tok.tt.path.path, &optchkd);
547 selected = select_return32(tok,
548 tok_hdr32_copy, &optchkd);
554 bytesread += tok.len;
556 /* Check if all the options were matched. */
557 print = ((selected == 1) && (!err) && (!(opttochk & ~optchkd)));
558 if (ISOPTSET(opttochk, OPT_v))
561 (void) fwrite(buf, 1, reclen, stdout);
568 * The -o option has the form object_type=object_value. Identify the object
572 parse_object_type(char *name, char *val)
577 if (!strcmp(name, FILEOBJ)) {
580 SETOPT(opttochk, OPT_of);
581 } else if (!strcmp(name, MSGQIDOBJ)) {
583 SETOPT(opttochk, OPT_om);
584 } else if (!strcmp(name, PIDOBJ)) {
586 SETOPT(opttochk, OPT_op);
587 } else if (!strcmp(name, SEMIDOBJ)) {
589 SETOPT(opttochk, OPT_ose);
590 } else if (!strcmp(name, SHMIDOBJ)) {
592 SETOPT(opttochk, OPT_osh);
593 } else if (!strcmp(name, SOCKOBJ)) {
595 SETOPT(opttochk, OPT_oso);
597 usage("unknown value for -o");
601 main(int argc, char **argv)
609 char *objval, *converr;
617 while ((ch = getopt(argc, argv, "Aa:b:c:d:e:f:g:j:m:o:r:u:v")) != -1) {
620 SETOPT(opttochk, OPT_A);
624 if (ISOPTSET(opttochk, OPT_a)) {
625 usage("d is exclusive with a and b");
627 SETOPT(opttochk, OPT_a);
628 bzero(&tm, sizeof(tm));
629 strptime(optarg, "%Y%m%d%H%M%S", &tm);
630 strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S",
632 /* fprintf(stderr, "Time converted = %s\n", timestr); */
633 p_atime = mktime(&tm);
637 if (ISOPTSET(opttochk, OPT_b)) {
638 usage("d is exclusive with a and b");
640 SETOPT(opttochk, OPT_b);
641 bzero(&tm, sizeof(tm));
642 strptime(optarg, "%Y%m%d%H%M%S", &tm);
643 strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S",
645 /* fprintf(stderr, "Time converted = %s\n", timestr); */
646 p_btime = mktime(&tm);
650 if (0 != getauditflagsbin(optarg, &maskp)) {
651 /* Incorrect class */
652 usage("Incorrect class");
654 SETOPT(opttochk, OPT_c);
658 if (ISOPTSET(opttochk, OPT_b) || ISOPTSET(opttochk,
660 usage("'d' is exclusive with 'a' and 'b'");
661 SETOPT(opttochk, OPT_d);
662 bzero(&tm, sizeof(tm));
663 strptime(optarg, "%Y%m%d", &tm);
664 strftime(timestr, sizeof(timestr), "%Y%m%d", &tm);
665 /* fprintf(stderr, "Time converted = %s\n", timestr); */
666 p_atime = mktime(&tm);
670 strftime(timestr, sizeof(timestr), "%Y%m%d", &tm);
671 /* fprintf(stderr, "Time converted = %s\n", timestr); */
672 p_btime = mktime(&tm);
676 p_euid = strtol(optarg, &converr, 10);
677 if (*converr != '\0') {
678 /* Try the actual name */
679 if ((pw = getpwnam(optarg)) == NULL)
683 SETOPT(opttochk, OPT_e);
687 p_egid = strtol(optarg, &converr, 10);
688 if (*converr != '\0') {
689 /* Try actual group name. */
690 if ((grp = getgrnam(optarg)) == NULL)
692 p_egid = grp->gr_gid;
694 SETOPT(opttochk, OPT_f);
698 p_rgid = strtol(optarg, &converr, 10);
699 if (*converr != '\0') {
700 /* Try actual group name. */
701 if ((grp = getgrnam(optarg)) == NULL)
703 p_rgid = grp->gr_gid;
705 SETOPT(opttochk, OPT_g);
709 p_subid = strtol(optarg, (char **)NULL, 10);
710 SETOPT(opttochk, OPT_j);
714 if (p_evec == NULL) {
716 p_evec = malloc(sizeof(*etp) * p_evec_alloc);
719 } else if (p_evec_alloc == p_evec_used) {
721 p_evec = realloc(p_evec,
722 sizeof(*p_evec) * p_evec_alloc);
726 etp = &p_evec[p_evec_used++];
727 *etp = strtol(optarg, (char **)NULL, 10);
729 /* Could be the string representation. */
730 n = getauevnonam(optarg);
732 usage("Incorrect event name");
735 SETOPT(opttochk, OPT_m);
739 objval = strchr(optarg, '=');
740 if (objval != NULL) {
743 parse_object_type(optarg, objval);
748 p_ruid = strtol(optarg, &converr, 10);
749 if (*converr != '\0') {
750 if ((pw = getpwnam(optarg)) == NULL)
754 SETOPT(opttochk, OPT_r);
758 p_auid = strtol(optarg, &converr, 10);
759 if (*converr != '\0') {
760 if ((pw = getpwnam(optarg)) == NULL)
764 SETOPT(opttochk, OPT_u);
768 SETOPT(opttochk, OPT_v);
773 usage("Unknown option");
780 if (select_records(stdin) == -1)
782 "Couldn't select records from stdin");
787 * XXX: We should actually be merging records here.
789 for (i = 0; i < argc; i++) {
791 fp = fopen(fname, "r");
793 errx(EXIT_FAILURE, "Couldn't open %s", fname);
794 if (select_records(fp) == -1) {
795 errx(EXIT_FAILURE, "Couldn't select records %s",