2 * Copyright (c) 2004-2009 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 #define _SYS_AUDIT_H /* Prevent include of sys/audit.h. */
34 #include <sys/param.h>
38 #include <sys/queue.h> /* Our bsm/audit.h doesn't include queue.h. */
41 #include <sys/sysctl.h>
43 #include <bsm/libbsm.h>
51 /* These are not advertised in libbsm.h */
52 int audit_set_terminal_port(dev_t *p);
53 int audit_set_terminal_host(uint32_t *m);
56 * General purpose audit submission mechanism for userspace.
59 audit_submit(short au_event, au_id_t auid, char status,
60 int reterr, const char *fmt, ...)
62 char text[MAX_AUDITSTRING_LEN];
67 int error, afd, subj_ex;
69 struct auditinfo_addr aia;
72 if (audit_get_cond(&acond) != 0) {
74 * If auditon(2) returns ENOSYS, then audit has not been
75 * compiled into the kernel, so just return.
80 syslog(LOG_AUTH | LOG_ERR, "audit: auditon failed: %s",
85 if (acond == AUC_NOAUDIT)
90 syslog(LOG_AUTH | LOG_ERR, "audit: au_open failed: %s",
96 * Try to use getaudit_addr(2) first. If this kernel does not support
97 * it, then fall back on to getaudit(2).
100 error = getaudit_addr(&aia, sizeof(aia));
101 if (error < 0 && errno == ENOSYS) {
102 error = getaudit(&ai);
105 syslog(LOG_AUTH | LOG_ERR, "audit: getaudit failed: %s",
111 * Convert this auditinfo_t to an auditinfo_addr_t to make the
112 * following code less complicated wrt to preselection and
113 * subject token generation.
115 aia.ai_auid = ai.ai_auid;
116 aia.ai_mask = ai.ai_mask;
117 aia.ai_asid = ai.ai_asid;
118 aia.ai_termid.at_type = AU_IPv4;
119 aia.ai_termid.at_addr[0] = ai.ai_termid.machine;
120 aia.ai_termid.at_port = ai.ai_termid.port;
121 } else if (error < 0) {
123 syslog(LOG_AUTH | LOG_ERR, "audit: getaudit_addr failed: %s",
129 * NB: We should be performing pre-selection here now that we have the
130 * masks for this process.
132 if (aia.ai_termid.at_type == AU_IPv6)
136 atid.port = aia.ai_termid.at_port;
137 atid.machine = aia.ai_termid.at_addr[0];
138 token = au_to_subject32(auid, geteuid(), getegid(),
139 getuid(), getgid(), pid, pid, &atid);
141 token = au_to_subject_ex(auid, geteuid(), getegid(),
142 getuid(), getgid(), pid, pid, &aia.ai_termid);
144 syslog(LOG_AUTH | LOG_ERR,
145 "audit: unable to build subject token");
146 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
150 if (au_write(afd, token) < 0) {
152 syslog(LOG_AUTH | LOG_ERR,
153 "audit: au_write failed: %s", strerror(errno));
154 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
160 (void) vsnprintf(text, MAX_AUDITSTRING_LEN, fmt, ap);
162 token = au_to_text(text);
164 syslog(LOG_AUTH | LOG_ERR,
165 "audit: failed to generate text token");
166 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
170 if (au_write(afd, token) < 0) {
172 syslog(LOG_AUTH | LOG_ERR,
173 "audit: au_write failed: %s", strerror(errno));
174 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
179 token = au_to_return32(au_errno_to_bsm(status), reterr);
181 syslog(LOG_AUTH | LOG_ERR,
182 "audit: unable to build return token");
183 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
187 if (au_write(afd, token) < 0) {
189 syslog(LOG_AUTH | LOG_ERR,
190 "audit: au_write failed: %s", strerror(errno));
191 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
195 if (au_close(afd, AU_TO_WRITE, au_event) < 0) {
197 syslog(LOG_AUTH | LOG_ERR, "audit: record not committed");
205 audit_set_terminal_port(dev_t *p)
210 return (kAUBadParamErr);
218 /* for /usr/bin/login, try fstat() first */
219 if (fstat(STDIN_FILENO, &st) != 0) {
220 if (errno != EBADF) {
221 syslog(LOG_ERR, "fstat() failed (%s)",
225 if (stat("/dev/console", &st) != 0) {
226 syslog(LOG_ERR, "stat() failed (%s)",
236 audit_set_terminal_host(uint32_t *m)
240 int name[2] = { CTL_KERN, KERN_HOSTID };
244 return (kAUBadParamErr);
247 if (sysctl(name, 2, m, &len, NULL, 0) != 0) {
248 syslog(LOG_ERR, "sysctl() failed (%s)", strerror(errno));
249 return (kAUSysctlErr);
259 audit_set_terminal_id(au_tid_t *tid)
264 return (kAUBadParamErr);
265 if ((ret = audit_set_terminal_port(&tid->port)) != kAUNoErr)
267 return (audit_set_terminal_host(&tid->machine));
271 * This is OK for those callers who have only one token to write. If you have
272 * multiple tokens that logically form part of the same audit record, you need
273 * to use the existing au_open()/au_write()/au_close() API:
276 * tok = au_to_random_token_1(...);
277 * au_write(aufd, tok);
278 * tok = au_to_random_token_2(...);
279 * au_write(aufd, tok);
281 * au_close(aufd, AU_TO_WRITE, AUE_your_event_type);
283 * Assumes, like all wrapper calls, that the caller has previously checked
284 * that auditing is enabled via the audit_get_state() call.
286 * XXX: Should be more robust against bad arguments.
289 audit_write(short event_code, token_t *subject, token_t *misctok, char retval,
293 char *func = "audit_write()";
296 if ((aufd = au_open()) == -1) {
297 au_free_token(subject);
298 au_free_token(misctok);
299 syslog(LOG_ERR, "%s: au_open() failed", func);
304 if (subject && au_write(aufd, subject) == -1) {
305 au_free_token(subject);
306 au_free_token(misctok);
307 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
308 syslog(LOG_ERR, "%s: write of subject failed", func);
309 return (kAUWriteSubjectTokErr);
312 /* Save the event-specific token. */
313 if (misctok && au_write(aufd, misctok) == -1) {
314 au_free_token(misctok);
315 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
316 syslog(LOG_ERR, "%s: write of caller token failed", func);
317 return (kAUWriteCallerTokErr);
320 /* Tokenize and save the return value. */
321 if ((rettok = au_to_return32(retval, errcode)) == NULL) {
322 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
323 syslog(LOG_ERR, "%s: au_to_return32() failed", func);
324 return (kAUMakeReturnTokErr);
327 if (au_write(aufd, rettok) == -1) {
328 au_free_token(rettok);
329 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
330 syslog(LOG_ERR, "%s: write of return code failed", func);
331 return (kAUWriteReturnTokErr);
335 * We assume the caller wouldn't have bothered with this
336 * function if it hadn't already decided to keep the record.
338 if (au_close(aufd, AU_TO_WRITE, event_code) < 0) {
339 syslog(LOG_ERR, "%s: au_close() failed", func);
340 return (kAUCloseErr);
347 * Same caveats as audit_write(). In addition, this function explicitly
348 * assumes success; use audit_write_failure() on error.
351 audit_write_success(short event_code, token_t *tok, au_id_t auid, uid_t euid,
352 gid_t egid, uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
355 char *func = "audit_write_success()";
356 token_t *subject = NULL;
358 /* Tokenize and save subject. */
359 subject = au_to_subject32(auid, euid, egid, ruid, rgid, pid, sid,
361 if (subject == NULL) {
362 syslog(LOG_ERR, "%s: au_to_subject32() failed", func);
363 return kAUMakeSubjectTokErr;
366 return (audit_write(event_code, subject, tok, 0, 0));
370 * Same caveats as audit_write(). In addition, this function explicitly
371 * assumes success; use audit_write_failure_self() on error.
374 audit_write_success_self(short event_code, token_t *tok)
377 char *func = "audit_write_success_self()";
379 if ((subject = au_to_me()) == NULL) {
380 syslog(LOG_ERR, "%s: au_to_me() failed", func);
381 return (kAUMakeSubjectTokErr);
384 return (audit_write(event_code, subject, tok, 0, 0));
388 * Same caveats as audit_write(). In addition, this function explicitly
389 * assumes failure; use audit_write_success() otherwise.
391 * XXX This should let the caller pass an error return value rather than
395 audit_write_failure(short event_code, char *errmsg, int errcode, au_id_t auid,
396 uid_t euid, gid_t egid, uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
399 char *func = "audit_write_failure()";
400 token_t *subject, *errtok;
402 subject = au_to_subject32(auid, euid, egid, ruid, rgid, pid, sid, tid);
403 if (subject == NULL) {
404 syslog(LOG_ERR, "%s: au_to_subject32() failed", func);
405 return (kAUMakeSubjectTokErr);
408 /* tokenize and save the error message */
409 if ((errtok = au_to_text(errmsg)) == NULL) {
410 au_free_token(subject);
411 syslog(LOG_ERR, "%s: au_to_text() failed", func);
412 return (kAUMakeTextTokErr);
415 return (audit_write(event_code, subject, errtok, -1, errcode));
419 * Same caveats as audit_write(). In addition, this function explicitly
420 * assumes failure; use audit_write_success_self() otherwise.
422 * XXX This should let the caller pass an error return value rather than
426 audit_write_failure_self(short event_code, char *errmsg, int errret)
428 char *func = "audit_write_failure_self()";
429 token_t *subject, *errtok;
431 if ((subject = au_to_me()) == NULL) {
432 syslog(LOG_ERR, "%s: au_to_me() failed", func);
433 return (kAUMakeSubjectTokErr);
435 /* tokenize and save the error message */
436 if ((errtok = au_to_text(errmsg)) == NULL) {
437 au_free_token(subject);
438 syslog(LOG_ERR, "%s: au_to_text() failed", func);
439 return (kAUMakeTextTokErr);
441 return (audit_write(event_code, subject, errtok, -1, errret));
445 * For auditing errors during login. Such errors are implicitly
446 * non-attributable (i.e., not ascribable to any user).
448 * Assumes, like all wrapper calls, that the caller has previously checked
449 * that auditing is enabled via the audit_get_state() call.
452 audit_write_failure_na(short event_code, char *errmsg, int errret, uid_t euid,
453 uid_t egid, pid_t pid, au_tid_t *tid)
456 return (audit_write_failure(event_code, errmsg, errret, -1, euid,
457 egid, -1, -1, pid, -1, tid));
460 /* END OF au_write() WRAPPERS */
464 audit_token_to_au32(audit_token_t atoken, uid_t *auidp, uid_t *euidp,
465 gid_t *egidp, uid_t *ruidp, gid_t *rgidp, pid_t *pidp, au_asid_t *asidp,
470 *auidp = (uid_t)atoken.val[0];
472 *euidp = (uid_t)atoken.val[1];
474 *egidp = (gid_t)atoken.val[2];
476 *ruidp = (uid_t)atoken.val[3];
478 *rgidp = (gid_t)atoken.val[4];
480 *pidp = (pid_t)atoken.val[5];
482 *asidp = (au_asid_t)atoken.val[6];
484 audit_set_terminal_host(&tidp->machine);
485 tidp->port = (dev_t)atoken.val[7];
488 #endif /* !__APPLE__ */
491 audit_get_cond(int *cond)
495 ret = auditon(A_GETCOND, cond, sizeof(*cond));
497 if ((0 != ret) && EINVAL == errno) {
500 ret = auditon(A_OLDGETCOND, &lcond, sizeof(lcond));
508 audit_set_cond(int *cond)
512 ret = auditon(A_SETCOND, cond, sizeof(*cond));
514 if ((0 != ret) && (EINVAL == errno)) {
515 long lcond = (long)*cond;
517 ret = auditon(A_OLDSETCOND, &lcond, sizeof(lcond));
525 audit_get_policy(int *policy)
529 ret = auditon(A_GETPOLICY, policy, sizeof(*policy));
530 #ifdef A_OLDGETPOLICY
531 if ((0 != ret) && (EINVAL == errno)){
532 long lpolicy = (long)*policy;
534 ret = auditon(A_OLDGETPOLICY, &lpolicy, sizeof(lpolicy));
535 *policy = (int)lpolicy;
542 audit_set_policy(int *policy)
546 ret = auditon(A_SETPOLICY, policy, sizeof(*policy));
547 #ifdef A_OLDSETPOLICY
548 if ((0 != ret) && (EINVAL == errno)){
549 long lpolicy = (long)*policy;
551 ret = auditon(A_OLDSETPOLICY, &lpolicy, sizeof(lpolicy));
552 *policy = (int)lpolicy;
559 audit_get_qctrl(au_qctrl_t *qctrl, size_t sz)
563 if (sizeof(*qctrl) != sz) {
568 ret = auditon(A_GETQCTRL, qctrl, sizeof(*qctrl));
570 if ((0 != ret) && (EINVAL == errno)){
579 oq.oq_hiwater = (size_t)qctrl->aq_hiwater;
580 oq.oq_lowater = (size_t)qctrl->aq_lowater;
581 oq.oq_bufsz = (size_t)qctrl->aq_bufsz;
582 oq.oq_delay = (clock_t)qctrl->aq_delay;
583 oq.oq_minfree = qctrl->aq_minfree;
585 ret = auditon(A_OLDGETQCTRL, &oq, sizeof(oq));
587 qctrl->aq_hiwater = (int)oq.oq_hiwater;
588 qctrl->aq_lowater = (int)oq.oq_lowater;
589 qctrl->aq_bufsz = (int)oq.oq_bufsz;
590 qctrl->aq_delay = (int)oq.oq_delay;
591 qctrl->aq_minfree = oq.oq_minfree;
593 #endif /* A_OLDGETQCTRL */
598 audit_set_qctrl(au_qctrl_t *qctrl, size_t sz)
602 if (sizeof(*qctrl) != sz) {
607 ret = auditon(A_SETQCTRL, qctrl, sz);
609 if ((0 != ret) && (EINVAL == errno)) {
618 oq.oq_hiwater = (size_t)qctrl->aq_hiwater;
619 oq.oq_lowater = (size_t)qctrl->aq_lowater;
620 oq.oq_bufsz = (size_t)qctrl->aq_bufsz;
621 oq.oq_delay = (clock_t)qctrl->aq_delay;
622 oq.oq_minfree = qctrl->aq_minfree;
624 ret = auditon(A_OLDSETQCTRL, &oq, sizeof(oq));
626 qctrl->aq_hiwater = (int)oq.oq_hiwater;
627 qctrl->aq_lowater = (int)oq.oq_lowater;
628 qctrl->aq_bufsz = (int)oq.oq_bufsz;
629 qctrl->aq_delay = (int)oq.oq_delay;
630 qctrl->aq_minfree = oq.oq_minfree;
632 #endif /* A_OLDSETQCTRL */
637 audit_send_trigger(int *trigger)
640 return (auditon(A_SENDTRIGGER, trigger, sizeof(*trigger)));
644 audit_get_kaudit(auditinfo_addr_t *aia, size_t sz)
647 if (sizeof(*aia) != sz) {
652 return (auditon(A_GETKAUDIT, aia, sz));
656 audit_set_kaudit(auditinfo_addr_t *aia, size_t sz)
659 if (sizeof(*aia) != sz) {
664 return (auditon(A_SETKAUDIT, aia, sz));
668 audit_get_class(au_evclass_map_t *evc_map, size_t sz)
671 if (sizeof(*evc_map) != sz) {
676 return (auditon(A_GETCLASS, evc_map, sz));
680 audit_set_class(au_evclass_map_t *evc_map, size_t sz)
683 if (sizeof(*evc_map) != sz) {
688 return (auditon(A_SETCLASS, evc_map, sz));
692 audit_get_kmask(au_mask_t *kmask, size_t sz)
694 if (sizeof(*kmask) != sz) {
699 return (auditon(A_GETKMASK, kmask, sz));
703 audit_set_kmask(au_mask_t *kmask, size_t sz)
705 if (sizeof(*kmask) != sz) {
710 return (auditon(A_SETKMASK, kmask, sz));
714 audit_get_fsize(au_fstat_t *fstat, size_t sz)
717 if (sizeof(*fstat) != sz) {
722 return (auditon(A_GETFSIZE, fstat, sz));
726 audit_set_fsize(au_fstat_t *fstat, size_t sz)
729 if (sizeof(*fstat) != sz) {
734 return (auditon(A_SETFSIZE, fstat, sz));
738 audit_set_pmask(auditpinfo_t *api, size_t sz)
741 if (sizeof(*api) != sz) {
746 return (auditon(A_SETPMASK, api, sz));
750 audit_get_pinfo(auditpinfo_t *api, size_t sz)
753 if (sizeof(*api) != sz) {
758 return (auditon(A_GETPINFO, api, sz));
762 audit_get_pinfo_addr(auditpinfo_addr_t *apia, size_t sz)
765 if (sizeof(*apia) != sz) {
770 return (auditon(A_GETPINFO_ADDR, apia, sz));
774 audit_get_sinfo_addr(auditinfo_addr_t *aia, size_t sz)
777 if (sizeof(*aia) != sz) {
782 return (auditon(A_GETSINFO_ADDR, aia, sz));
786 audit_get_stat(au_stat_t *stats, size_t sz)
789 if (sizeof(*stats) != sz) {
794 return (auditon(A_GETSTAT, stats, sz));
798 audit_set_stat(au_stat_t *stats, size_t sz)
801 if (sizeof(*stats) != sz) {
806 return (auditon(A_GETSTAT, stats, sz));
810 audit_get_cwd(char *path, size_t sz)
813 return (auditon(A_GETCWD, path, sz));
817 audit_get_car(char *path, size_t sz)
820 return (auditon(A_GETCAR, path, sz));