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.
29 * $P4: //depot/projects/trustedbsd/openbsm/bin/auditreduce/auditreduce.c#28 $
33 * Tool used to merge and select audit records from audit trail files
37 * XXX Currently we do not support merging of records from multiple
38 * XXX audit trail files
39 * XXX We assume that records are sorted chronologically - both wrt to
40 * XXX the records present within the file and between the files themselves
43 #include <config/config.h>
44 #ifdef HAVE_FULL_QUEUE_H
45 #include <sys/queue.h>
47 #include <compat/queue.h>
50 #include <bsm/libbsm.h>
65 #include <compat/strlcpy.h>
68 #include "auditreduce.h"
70 static TAILQ_HEAD(tailhead, re_entry) re_head =
71 TAILQ_HEAD_INITIALIZER(re_head);
74 extern int optind, optopt, opterr,optreset;
76 static au_mask_t maskp; /* Class. */
77 static time_t p_atime; /* Created after this time. */
78 static time_t p_btime; /* Created before this time. */
79 static int p_auid; /* Audit id. */
80 static int p_euid; /* Effective user id. */
81 static int p_egid; /* Effective group id. */
82 static int p_rgid; /* Real group id. */
83 static int p_ruid; /* Real user id. */
84 static int p_subid; /* Subject id. */
87 * Maintain a dynamically sized array of events for -m
89 static uint16_t *p_evec; /* Event type list */
90 static int p_evec_used; /* Number of events used */
91 static int p_evec_alloc; /* Number of events allocated */
94 * Following are the objects (-o option) that we can select upon.
96 static char *p_fileobj = NULL;
97 static char *p_msgqobj = NULL;
98 static char *p_pidobj = NULL;
99 static char *p_semobj = NULL;
100 static char *p_shmobj = NULL;
101 static char *p_sockobj = NULL;
103 static uint32_t opttochk = 0;
106 parse_regexp(char *re_string)
108 char *orig, *copy, re_error[64];
109 struct re_entry *rep;
110 int error, nstrs, i, len;
112 copy = strdup(re_string);
115 for (nstrs = 0, i = 0; i < len; i++) {
116 if (copy[i] == ',' && i > 0) {
117 if (copy[i - 1] == '\\')
118 strlcpy(©[i - 1], ©[i], len);
125 TAILQ_INIT(&re_head);
126 for (i = 0; i < nstrs + 1; i++) {
127 rep = calloc(1, sizeof(*rep));
129 (void) fprintf(stderr, "calloc: %s\n",
137 rep->re_pattern = strdup(copy);
138 error = regcomp(&rep->re_regexp, rep->re_pattern,
139 REG_EXTENDED | REG_NOSUB);
141 regerror(error, &rep->re_regexp, re_error, 64);
142 (void) fprintf(stderr, "regcomp: %s\n", re_error);
145 TAILQ_INSERT_TAIL(&re_head, rep, re_glue);
153 usage(const char *msg)
155 fprintf(stderr, "%s\n", msg);
156 fprintf(stderr, "Usage: auditreduce [options] [file ...]\n");
157 fprintf(stderr, "\tOptions are : \n");
158 fprintf(stderr, "\t-A : all records\n");
159 fprintf(stderr, "\t-a YYYYMMDD[HH[[MM[SS]]] : after date\n");
160 fprintf(stderr, "\t-b YYYYMMDD[HH[[MM[SS]]] : before date\n");
161 fprintf(stderr, "\t-c <flags> : matching class\n");
162 fprintf(stderr, "\t-d YYYYMMDD : on date\n");
163 fprintf(stderr, "\t-e <uid|name> : effective user\n");
164 fprintf(stderr, "\t-f <gid|group> : effective group\n");
165 fprintf(stderr, "\t-g <gid|group> : real group\n");
166 fprintf(stderr, "\t-j <pid> : subject id \n");
167 fprintf(stderr, "\t-m <evno|evname> : matching event\n");
168 fprintf(stderr, "\t-o objecttype=objectvalue\n");
169 fprintf(stderr, "\t\t file=<pathname>\n");
170 fprintf(stderr, "\t\t msgqid=<ID>\n");
171 fprintf(stderr, "\t\t pid=<ID>\n");
172 fprintf(stderr, "\t\t semid=<ID>\n");
173 fprintf(stderr, "\t\t shmid=<ID>\n");
174 fprintf(stderr, "\t-r <uid|name> : real user\n");
175 fprintf(stderr, "\t-u <uid|name> : audit user\n");
176 fprintf(stderr, "\t-v : select non-matching records\n");
181 * Check if the given auid matches the selection criteria.
187 /* Check if we want to select on auid. */
188 if (ISOPTSET(opttochk, OPT_u)) {
196 * Check if the given euid matches the selection criteria.
199 select_euid(int euser)
202 /* Check if we want to select on euid. */
203 if (ISOPTSET(opttochk, OPT_e)) {
211 * Check if the given egid matches the selection criteria.
214 select_egid(int egrp)
217 /* Check if we want to select on egid. */
218 if (ISOPTSET(opttochk, OPT_f)) {
226 * Check if the given rgid matches the selection criteria.
232 /* Check if we want to select on rgid. */
233 if (ISOPTSET(opttochk, OPT_g)) {
241 * Check if the given ruid matches the selection criteria.
244 select_ruid(int user)
247 /* Check if we want to select on rgid. */
248 if (ISOPTSET(opttochk, OPT_r)) {
256 * Check if the given subject id (pid) matches the selection criteria.
259 select_subid(int subid)
262 /* Check if we want to select on subject uid. */
263 if (ISOPTSET(opttochk, OPT_j)) {
264 if (subid != p_subid)
272 * Check if object's pid maches the given pid.
275 select_pidobj(uint32_t pid)
278 if (ISOPTSET(opttochk, OPT_op)) {
279 if (pid != (uint32_t)strtol(p_pidobj, (char **)NULL, 10))
286 * Check if the given ipc object with the given type matches the selection
290 select_ipcobj(u_char type, uint32_t id, uint32_t *optchkd)
293 if (type == AT_IPC_MSG) {
294 SETOPT((*optchkd), OPT_om);
295 if (ISOPTSET(opttochk, OPT_om)) {
296 if (id != (uint32_t)strtol(p_msgqobj, (char **)NULL,
301 } else if (type == AT_IPC_SEM) {
302 SETOPT((*optchkd), OPT_ose);
303 if (ISOPTSET(opttochk, OPT_ose)) {
304 if (id != (uint32_t)strtol(p_semobj, (char **)NULL, 10))
308 } else if (type == AT_IPC_SHM) {
309 SETOPT((*optchkd), OPT_osh);
310 if (ISOPTSET(opttochk, OPT_osh)) {
311 if (id != (uint32_t)strtol(p_shmobj, (char **)NULL, 10))
317 /* Unknown type -- filter if *any* ipc filtering is required. */
318 if (ISOPTSET(opttochk, OPT_om) || ISOPTSET(opttochk, OPT_ose)
319 || ISOPTSET(opttochk, OPT_osh))
327 * Check if the file name matches selection criteria.
330 select_filepath(char *path, uint32_t *optchkd)
332 struct re_entry *rep;
335 SETOPT((*optchkd), OPT_of);
337 if (ISOPTSET(opttochk, OPT_of)) {
339 TAILQ_FOREACH(rep, &re_head, re_glue) {
340 if (regexec(&rep->re_regexp, path, 0, NULL,
342 return (!rep->re_negate);
349 * Returns 1 if the following pass the selection rules:
358 select_hdr32(tokenstr_t tok, uint32_t *optchkd)
363 SETOPT((*optchkd), (OPT_A | OPT_a | OPT_b | OPT_c | OPT_m | OPT_v));
365 /* The A option overrides a, b and d. */
366 if (!ISOPTSET(opttochk, OPT_A)) {
367 if (ISOPTSET(opttochk, OPT_a)) {
368 if (difftime((time_t)tok.tt.hdr32.s, p_atime) < 0) {
369 /* Record was created before p_atime. */
374 if (ISOPTSET(opttochk, OPT_b)) {
375 if (difftime(p_btime, (time_t)tok.tt.hdr32.s) < 0) {
376 /* Record was created after p_btime. */
382 if (ISOPTSET(opttochk, OPT_c)) {
384 * Check if the classes represented by the event matches
387 if (au_preselect(tok.tt.hdr32.e_type, &maskp, AU_PRS_BOTH,
388 AU_PRS_USECACHE) != 1)
392 /* Check if event matches. */
393 if (ISOPTSET(opttochk, OPT_m)) {
395 for (ev = p_evec; ev < &p_evec[p_evec_used]; ev++)
396 if (tok.tt.hdr32.e_type == *ev)
406 select_return32(tokenstr_t tok_ret32, tokenstr_t tok_hdr32, uint32_t *optchkd)
410 SETOPT((*optchkd), (OPT_c));
411 if (tok_ret32.tt.ret32.status == 0)
412 sorf = AU_PRS_SUCCESS;
414 sorf = AU_PRS_FAILURE;
415 if (ISOPTSET(opttochk, OPT_c)) {
416 if (au_preselect(tok_hdr32.tt.hdr32.e_type, &maskp, sorf,
417 AU_PRS_USECACHE) != 1)
424 * Return 1 if checks for the the following succeed
433 select_proc32(tokenstr_t tok, uint32_t *optchkd)
436 SETOPT((*optchkd), (OPT_u | OPT_e | OPT_f | OPT_g | OPT_r | OPT_op));
438 if (!select_auid(tok.tt.proc32.auid))
440 if (!select_euid(tok.tt.proc32.euid))
442 if (!select_egid(tok.tt.proc32.egid))
444 if (!select_rgid(tok.tt.proc32.rgid))
446 if (!select_ruid(tok.tt.proc32.ruid))
448 if (!select_pidobj(tok.tt.proc32.pid))
454 * Return 1 if checks for the the following succeed
463 select_subj32(tokenstr_t tok, uint32_t *optchkd)
466 SETOPT((*optchkd), (OPT_u | OPT_e | OPT_f | OPT_g | OPT_r | OPT_j));
468 if (!select_auid(tok.tt.subj32.auid))
470 if (!select_euid(tok.tt.subj32.euid))
472 if (!select_egid(tok.tt.subj32.egid))
474 if (!select_rgid(tok.tt.subj32.rgid))
476 if (!select_ruid(tok.tt.subj32.ruid))
478 if (!select_subid(tok.tt.subj32.pid))
484 * Read each record from the audit trail. Check if it is selected after
485 * passing through each of the options
488 select_records(FILE *fp)
490 tokenstr_t tok_hdr32_copy;
500 while ((reclen = au_read_rec(fp, &buf)) != -1) {
504 while ((selected == 1) && (bytesread < reclen)) {
505 if (-1 == au_fetch_tok(&tok, buf + bytesread,
506 reclen - bytesread)) {
507 /* Is this an incomplete record? */
513 * For each token type we have have different
514 * selection criteria.
518 selected = select_hdr32(tok,
520 bcopy(&tok, &tok_hdr32_copy,
525 selected = select_proc32(tok,
530 selected = select_subj32(tok,
535 selected = select_ipcobj(
536 tok.tt.ipc.type, tok.tt.ipc.id,
541 selected = select_filepath(
542 tok.tt.path.path, &optchkd);
546 selected = select_return32(tok,
547 tok_hdr32_copy, &optchkd);
553 bytesread += tok.len;
555 /* Check if all the options were matched. */
556 print = ((selected == 1) && (!err) && (!(opttochk & ~optchkd)));
557 if (ISOPTSET(opttochk, OPT_v))
560 (void) fwrite(buf, 1, reclen, stdout);
567 * The -o option has the form object_type=object_value. Identify the object
571 parse_object_type(char *name, char *val)
576 if (!strcmp(name, FILEOBJ)) {
579 SETOPT(opttochk, OPT_of);
580 } else if (!strcmp(name, MSGQIDOBJ)) {
582 SETOPT(opttochk, OPT_om);
583 } else if (!strcmp(name, PIDOBJ)) {
585 SETOPT(opttochk, OPT_op);
586 } else if (!strcmp(name, SEMIDOBJ)) {
588 SETOPT(opttochk, OPT_ose);
589 } else if (!strcmp(name, SHMIDOBJ)) {
591 SETOPT(opttochk, OPT_osh);
592 } else if (!strcmp(name, SOCKOBJ)) {
594 SETOPT(opttochk, OPT_oso);
596 usage("unknown value for -o");
600 main(int argc, char **argv)
608 char *objval, *converr;
616 while ((ch = getopt(argc, argv, "Aa:b:c:d:e:f:g:j:m:o:r:u:v")) != -1) {
619 SETOPT(opttochk, OPT_A);
623 if (ISOPTSET(opttochk, OPT_a)) {
624 usage("d is exclusive with a and b");
626 SETOPT(opttochk, OPT_a);
627 bzero(&tm, sizeof(tm));
628 strptime(optarg, "%Y%m%d%H%M%S", &tm);
629 strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S",
631 /* fprintf(stderr, "Time converted = %s\n", timestr); */
632 p_atime = mktime(&tm);
636 if (ISOPTSET(opttochk, OPT_b)) {
637 usage("d is exclusive with a and b");
639 SETOPT(opttochk, OPT_b);
640 bzero(&tm, sizeof(tm));
641 strptime(optarg, "%Y%m%d%H%M%S", &tm);
642 strftime(timestr, sizeof(timestr), "%Y%m%d%H%M%S",
644 /* fprintf(stderr, "Time converted = %s\n", timestr); */
645 p_btime = mktime(&tm);
649 if (0 != getauditflagsbin(optarg, &maskp)) {
650 /* Incorrect class */
651 usage("Incorrect class");
653 SETOPT(opttochk, OPT_c);
657 if (ISOPTSET(opttochk, OPT_b) || ISOPTSET(opttochk,
659 usage("'d' is exclusive with 'a' and 'b'");
660 SETOPT(opttochk, OPT_d);
661 bzero(&tm, sizeof(tm));
662 strptime(optarg, "%Y%m%d", &tm);
663 strftime(timestr, sizeof(timestr), "%Y%m%d", &tm);
664 /* fprintf(stderr, "Time converted = %s\n", timestr); */
665 p_atime = mktime(&tm);
669 strftime(timestr, sizeof(timestr), "%Y%m%d", &tm);
670 /* fprintf(stderr, "Time converted = %s\n", timestr); */
671 p_btime = mktime(&tm);
675 p_euid = strtol(optarg, &converr, 10);
676 if (*converr != '\0') {
677 /* Try the actual name */
678 if ((pw = getpwnam(optarg)) == NULL)
682 SETOPT(opttochk, OPT_e);
686 p_egid = strtol(optarg, &converr, 10);
687 if (*converr != '\0') {
688 /* Try actual group name. */
689 if ((grp = getgrnam(optarg)) == NULL)
691 p_egid = grp->gr_gid;
693 SETOPT(opttochk, OPT_f);
697 p_rgid = strtol(optarg, &converr, 10);
698 if (*converr != '\0') {
699 /* Try actual group name. */
700 if ((grp = getgrnam(optarg)) == NULL)
702 p_rgid = grp->gr_gid;
704 SETOPT(opttochk, OPT_g);
708 p_subid = strtol(optarg, (char **)NULL, 10);
709 SETOPT(opttochk, OPT_j);
713 if (p_evec == NULL) {
715 p_evec = malloc(sizeof(*etp) * p_evec_alloc);
718 } else if (p_evec_alloc == p_evec_used) {
720 p_evec = realloc(p_evec,
721 sizeof(*p_evec) * p_evec_alloc);
725 etp = &p_evec[p_evec_used++];
726 *etp = strtol(optarg, (char **)NULL, 10);
728 /* Could be the string representation. */
729 n = getauevnonam(optarg);
731 usage("Incorrect event name");
734 SETOPT(opttochk, OPT_m);
738 objval = strchr(optarg, '=');
739 if (objval != NULL) {
742 parse_object_type(optarg, objval);
747 p_ruid = strtol(optarg, &converr, 10);
748 if (*converr != '\0') {
749 if ((pw = getpwnam(optarg)) == NULL)
753 SETOPT(opttochk, OPT_r);
757 p_auid = strtol(optarg, &converr, 10);
758 if (*converr != '\0') {
759 if ((pw = getpwnam(optarg)) == NULL)
763 SETOPT(opttochk, OPT_u);
767 SETOPT(opttochk, OPT_v);
772 usage("Unknown option");
779 if (select_records(stdin) == -1)
781 "Couldn't select records from stdin");
786 * XXX: We should actually be merging records here.
788 for (i = 0; i < argc; i++) {
790 fp = fopen(fname, "r");
792 errx(EXIT_FAILURE, "Couldn't open %s", fname);
793 if (select_records(fp) == -1) {
794 errx(EXIT_FAILURE, "Couldn't select records %s",