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.
29 * $P4: //depot/projects/trustedbsd/openbsm/libbsm/bsm_wrappers.c#32 $
33 #define _SYS_AUDIT_H /* Prevent include of sys/audit.h. */
36 #include <sys/param.h>
40 #include <sys/queue.h> /* Our bsm/audit.h doesn't include queue.h. */
43 #include <sys/sysctl.h>
45 #include <bsm/libbsm.h>
53 /* These are not advertised in libbsm.h */
54 int audit_set_terminal_port(dev_t *p);
55 int audit_set_terminal_host(uint32_t *m);
58 * General purpose audit submission mechanism for userspace.
61 audit_submit(short au_event, au_id_t auid, char status,
62 int reterr, const char *fmt, ...)
64 char text[MAX_AUDITSTRING_LEN];
69 int error, afd, subj_ex;
71 struct auditinfo_addr aia;
74 if (audit_get_cond(&acond) != 0) {
76 * If auditon(2) returns ENOSYS, then audit has not been
77 * compiled into the kernel, so just return.
82 syslog(LOG_AUTH | LOG_ERR, "audit: auditon failed: %s",
87 if (acond == AUC_NOAUDIT)
92 syslog(LOG_AUTH | LOG_ERR, "audit: au_open failed: %s",
98 * Try to use getaudit_addr(2) first. If this kernel does not support
99 * it, then fall back on to getaudit(2).
102 error = getaudit_addr(&aia, sizeof(aia));
103 if (error < 0 && errno == ENOSYS) {
104 error = getaudit(&ai);
107 syslog(LOG_AUTH | LOG_ERR, "audit: getaudit failed: %s",
113 * Convert this auditinfo_t to an auditinfo_addr_t to make the
114 * following code less complicated wrt to preselection and
115 * subject token generation.
117 aia.ai_auid = ai.ai_auid;
118 aia.ai_mask = ai.ai_mask;
119 aia.ai_asid = ai.ai_asid;
120 aia.ai_termid.at_type = AU_IPv4;
121 aia.ai_termid.at_addr[0] = ai.ai_termid.machine;
122 aia.ai_termid.at_port = ai.ai_termid.port;
123 } else if (error < 0) {
125 syslog(LOG_AUTH | LOG_ERR, "audit: getaudit_addr failed: %s",
131 * NB: We should be performing pre-selection here now that we have the
132 * masks for this process.
134 if (aia.ai_termid.at_type == AU_IPv6)
138 atid.port = aia.ai_termid.at_port;
139 atid.machine = aia.ai_termid.at_addr[0];
140 token = au_to_subject32(auid, geteuid(), getegid(),
141 getuid(), getgid(), pid, pid, &atid);
143 token = au_to_subject_ex(auid, geteuid(), getegid(),
144 getuid(), getgid(), pid, pid, &aia.ai_termid);
146 syslog(LOG_AUTH | LOG_ERR,
147 "audit: unable to build subject token");
148 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
152 if (au_write(afd, token) < 0) {
154 syslog(LOG_AUTH | LOG_ERR,
155 "audit: au_write failed: %s", strerror(errno));
156 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
162 (void) vsnprintf(text, MAX_AUDITSTRING_LEN, fmt, ap);
164 token = au_to_text(text);
166 syslog(LOG_AUTH | LOG_ERR,
167 "audit: failed to generate text token");
168 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
172 if (au_write(afd, token) < 0) {
174 syslog(LOG_AUTH | LOG_ERR,
175 "audit: au_write failed: %s", strerror(errno));
176 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
181 token = au_to_return32(au_errno_to_bsm(status), reterr);
183 syslog(LOG_AUTH | LOG_ERR,
184 "audit: unable to build return token");
185 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
189 if (au_write(afd, token) < 0) {
191 syslog(LOG_AUTH | LOG_ERR,
192 "audit: au_write failed: %s", strerror(errno));
193 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
197 if (au_close(afd, AU_TO_WRITE, au_event) < 0) {
199 syslog(LOG_AUTH | LOG_ERR, "audit: record not committed");
207 audit_set_terminal_port(dev_t *p)
212 return (kAUBadParamErr);
220 /* for /usr/bin/login, try fstat() first */
221 if (fstat(STDIN_FILENO, &st) != 0) {
222 if (errno != EBADF) {
223 syslog(LOG_ERR, "fstat() failed (%s)",
227 if (stat("/dev/console", &st) != 0) {
228 syslog(LOG_ERR, "stat() failed (%s)",
238 audit_set_terminal_host(uint32_t *m)
242 int name[2] = { CTL_KERN, KERN_HOSTID };
246 return (kAUBadParamErr);
249 if (sysctl(name, 2, m, &len, NULL, 0) != 0) {
250 syslog(LOG_ERR, "sysctl() failed (%s)", strerror(errno));
251 return (kAUSysctlErr);
261 audit_set_terminal_id(au_tid_t *tid)
266 return (kAUBadParamErr);
267 if ((ret = audit_set_terminal_port(&tid->port)) != kAUNoErr)
269 return (audit_set_terminal_host(&tid->machine));
273 * This is OK for those callers who have only one token to write. If you have
274 * multiple tokens that logically form part of the same audit record, you need
275 * to use the existing au_open()/au_write()/au_close() API:
278 * tok = au_to_random_token_1(...);
279 * au_write(aufd, tok);
280 * tok = au_to_random_token_2(...);
281 * au_write(aufd, tok);
283 * au_close(aufd, AU_TO_WRITE, AUE_your_event_type);
285 * Assumes, like all wrapper calls, that the caller has previously checked
286 * that auditing is enabled via the audit_get_state() call.
288 * XXX: Should be more robust against bad arguments.
291 audit_write(short event_code, token_t *subject, token_t *misctok, char retval,
295 char *func = "audit_write()";
298 if ((aufd = au_open()) == -1) {
299 au_free_token(subject);
300 au_free_token(misctok);
301 syslog(LOG_ERR, "%s: au_open() failed", func);
306 if (subject && au_write(aufd, subject) == -1) {
307 au_free_token(subject);
308 au_free_token(misctok);
309 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
310 syslog(LOG_ERR, "%s: write of subject failed", func);
311 return (kAUWriteSubjectTokErr);
314 /* Save the event-specific token. */
315 if (misctok && au_write(aufd, misctok) == -1) {
316 au_free_token(misctok);
317 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
318 syslog(LOG_ERR, "%s: write of caller token failed", func);
319 return (kAUWriteCallerTokErr);
322 /* Tokenize and save the return value. */
323 if ((rettok = au_to_return32(retval, errcode)) == NULL) {
324 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
325 syslog(LOG_ERR, "%s: au_to_return32() failed", func);
326 return (kAUMakeReturnTokErr);
329 if (au_write(aufd, rettok) == -1) {
330 au_free_token(rettok);
331 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
332 syslog(LOG_ERR, "%s: write of return code failed", func);
333 return (kAUWriteReturnTokErr);
337 * We assume the caller wouldn't have bothered with this
338 * function if it hadn't already decided to keep the record.
340 if (au_close(aufd, AU_TO_WRITE, event_code) < 0) {
341 syslog(LOG_ERR, "%s: au_close() failed", func);
342 return (kAUCloseErr);
349 * Same caveats as audit_write(). In addition, this function explicitly
350 * assumes success; use audit_write_failure() on error.
353 audit_write_success(short event_code, token_t *tok, au_id_t auid, uid_t euid,
354 gid_t egid, uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
357 char *func = "audit_write_success()";
358 token_t *subject = NULL;
360 /* Tokenize and save subject. */
361 subject = au_to_subject32(auid, euid, egid, ruid, rgid, pid, sid,
363 if (subject == NULL) {
364 syslog(LOG_ERR, "%s: au_to_subject32() failed", func);
365 return kAUMakeSubjectTokErr;
368 return (audit_write(event_code, subject, tok, 0, 0));
372 * Same caveats as audit_write(). In addition, this function explicitly
373 * assumes success; use audit_write_failure_self() on error.
376 audit_write_success_self(short event_code, token_t *tok)
379 char *func = "audit_write_success_self()";
381 if ((subject = au_to_me()) == NULL) {
382 syslog(LOG_ERR, "%s: au_to_me() failed", func);
383 return (kAUMakeSubjectTokErr);
386 return (audit_write(event_code, subject, tok, 0, 0));
390 * Same caveats as audit_write(). In addition, this function explicitly
391 * assumes failure; use audit_write_success() otherwise.
393 * XXX This should let the caller pass an error return value rather than
397 audit_write_failure(short event_code, char *errmsg, int errcode, au_id_t auid,
398 uid_t euid, gid_t egid, uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
401 char *func = "audit_write_failure()";
402 token_t *subject, *errtok;
404 subject = au_to_subject32(auid, euid, egid, ruid, rgid, pid, sid, tid);
405 if (subject == NULL) {
406 syslog(LOG_ERR, "%s: au_to_subject32() failed", func);
407 return (kAUMakeSubjectTokErr);
410 /* tokenize and save the error message */
411 if ((errtok = au_to_text(errmsg)) == NULL) {
412 au_free_token(subject);
413 syslog(LOG_ERR, "%s: au_to_text() failed", func);
414 return (kAUMakeTextTokErr);
417 return (audit_write(event_code, subject, errtok, -1, errcode));
421 * Same caveats as audit_write(). In addition, this function explicitly
422 * assumes failure; use audit_write_success_self() otherwise.
424 * XXX This should let the caller pass an error return value rather than
428 audit_write_failure_self(short event_code, char *errmsg, int errret)
430 char *func = "audit_write_failure_self()";
431 token_t *subject, *errtok;
433 if ((subject = au_to_me()) == NULL) {
434 syslog(LOG_ERR, "%s: au_to_me() failed", func);
435 return (kAUMakeSubjectTokErr);
437 /* tokenize and save the error message */
438 if ((errtok = au_to_text(errmsg)) == NULL) {
439 au_free_token(subject);
440 syslog(LOG_ERR, "%s: au_to_text() failed", func);
441 return (kAUMakeTextTokErr);
443 return (audit_write(event_code, subject, errtok, -1, errret));
447 * For auditing errors during login. Such errors are implicitly
448 * non-attributable (i.e., not ascribable to any user).
450 * Assumes, like all wrapper calls, that the caller has previously checked
451 * that auditing is enabled via the audit_get_state() call.
454 audit_write_failure_na(short event_code, char *errmsg, int errret, uid_t euid,
455 uid_t egid, pid_t pid, au_tid_t *tid)
458 return (audit_write_failure(event_code, errmsg, errret, -1, euid,
459 egid, -1, -1, pid, -1, tid));
462 /* END OF au_write() WRAPPERS */
466 audit_token_to_au32(audit_token_t atoken, uid_t *auidp, uid_t *euidp,
467 gid_t *egidp, uid_t *ruidp, gid_t *rgidp, pid_t *pidp, au_asid_t *asidp,
472 *auidp = (uid_t)atoken.val[0];
474 *euidp = (uid_t)atoken.val[1];
476 *egidp = (gid_t)atoken.val[2];
478 *ruidp = (uid_t)atoken.val[3];
480 *rgidp = (gid_t)atoken.val[4];
482 *pidp = (pid_t)atoken.val[5];
484 *asidp = (au_asid_t)atoken.val[6];
486 audit_set_terminal_host(&tidp->machine);
487 tidp->port = (dev_t)atoken.val[7];
490 #endif /* !__APPLE__ */
493 audit_get_cond(int *cond)
497 ret = auditon(A_GETCOND, cond, sizeof(*cond));
499 if ((0 != ret) && EINVAL == errno) {
502 ret = auditon(A_OLDGETCOND, &lcond, sizeof(lcond));
510 audit_set_cond(int *cond)
514 ret = auditon(A_SETCOND, cond, sizeof(*cond));
516 if ((0 != ret) && (EINVAL == errno)) {
517 long lcond = (long)*cond;
519 ret = auditon(A_OLDSETCOND, &lcond, sizeof(lcond));
527 audit_get_policy(int *policy)
531 ret = auditon(A_GETPOLICY, policy, sizeof(*policy));
532 #ifdef A_OLDGETPOLICY
533 if ((0 != ret) && (EINVAL == errno)){
534 long lpolicy = (long)*policy;
536 ret = auditon(A_OLDGETPOLICY, &lpolicy, sizeof(lpolicy));
537 *policy = (int)lpolicy;
544 audit_set_policy(int *policy)
548 ret = auditon(A_SETPOLICY, policy, sizeof(*policy));
549 #ifdef A_OLDSETPOLICY
550 if ((0 != ret) && (EINVAL == errno)){
551 long lpolicy = (long)*policy;
553 ret = auditon(A_OLDSETPOLICY, &lpolicy, sizeof(lpolicy));
554 *policy = (int)lpolicy;
561 audit_get_qctrl(au_qctrl_t *qctrl, size_t sz)
565 if (sizeof(*qctrl) != sz) {
570 ret = auditon(A_GETQCTRL, qctrl, sizeof(*qctrl));
572 if ((0 != ret) && (EINVAL == errno)){
581 oq.oq_hiwater = (size_t)qctrl->aq_hiwater;
582 oq.oq_lowater = (size_t)qctrl->aq_lowater;
583 oq.oq_bufsz = (size_t)qctrl->aq_bufsz;
584 oq.oq_delay = (clock_t)qctrl->aq_delay;
585 oq.oq_minfree = qctrl->aq_minfree;
587 ret = auditon(A_OLDGETQCTRL, &oq, sizeof(oq));
589 qctrl->aq_hiwater = (int)oq.oq_hiwater;
590 qctrl->aq_lowater = (int)oq.oq_lowater;
591 qctrl->aq_bufsz = (int)oq.oq_bufsz;
592 qctrl->aq_delay = (int)oq.oq_delay;
593 qctrl->aq_minfree = oq.oq_minfree;
595 #endif /* A_OLDGETQCTRL */
600 audit_set_qctrl(au_qctrl_t *qctrl, size_t sz)
604 if (sizeof(*qctrl) != sz) {
609 ret = auditon(A_SETQCTRL, qctrl, sz);
611 if ((0 != ret) && (EINVAL == errno)) {
620 oq.oq_hiwater = (size_t)qctrl->aq_hiwater;
621 oq.oq_lowater = (size_t)qctrl->aq_lowater;
622 oq.oq_bufsz = (size_t)qctrl->aq_bufsz;
623 oq.oq_delay = (clock_t)qctrl->aq_delay;
624 oq.oq_minfree = qctrl->aq_minfree;
626 ret = auditon(A_OLDSETQCTRL, &oq, sizeof(oq));
628 qctrl->aq_hiwater = (int)oq.oq_hiwater;
629 qctrl->aq_lowater = (int)oq.oq_lowater;
630 qctrl->aq_bufsz = (int)oq.oq_bufsz;
631 qctrl->aq_delay = (int)oq.oq_delay;
632 qctrl->aq_minfree = oq.oq_minfree;
634 #endif /* A_OLDSETQCTRL */
639 audit_send_trigger(int *trigger)
642 return (auditon(A_SENDTRIGGER, trigger, sizeof(*trigger)));
646 audit_get_kaudit(auditinfo_addr_t *aia, size_t sz)
649 if (sizeof(*aia) != sz) {
654 return (auditon(A_GETKAUDIT, aia, sz));
658 audit_set_kaudit(auditinfo_addr_t *aia, size_t sz)
661 if (sizeof(*aia) != sz) {
666 return (auditon(A_SETKAUDIT, aia, sz));
670 audit_get_class(au_evclass_map_t *evc_map, size_t sz)
673 if (sizeof(*evc_map) != sz) {
678 return (auditon(A_GETCLASS, evc_map, sz));
682 audit_set_class(au_evclass_map_t *evc_map, size_t sz)
685 if (sizeof(*evc_map) != sz) {
690 return (auditon(A_SETCLASS, evc_map, sz));
694 audit_get_kmask(au_mask_t *kmask, size_t sz)
696 if (sizeof(*kmask) != sz) {
701 return (auditon(A_GETKMASK, kmask, sz));
705 audit_set_kmask(au_mask_t *kmask, size_t sz)
707 if (sizeof(*kmask) != sz) {
712 return (auditon(A_SETKMASK, kmask, sz));
716 audit_get_fsize(au_fstat_t *fstat, size_t sz)
719 if (sizeof(*fstat) != sz) {
724 return (auditon(A_GETFSIZE, fstat, sz));
728 audit_set_fsize(au_fstat_t *fstat, size_t sz)
731 if (sizeof(*fstat) != sz) {
736 return (auditon(A_SETFSIZE, fstat, sz));
740 audit_set_pmask(auditpinfo_t *api, size_t sz)
743 if (sizeof(*api) != sz) {
748 return (auditon(A_SETPMASK, api, sz));
752 audit_get_pinfo(auditpinfo_t *api, size_t sz)
755 if (sizeof(*api) != sz) {
760 return (auditon(A_GETPINFO, api, sz));
764 audit_get_pinfo_addr(auditpinfo_addr_t *apia, size_t sz)
767 if (sizeof(*apia) != sz) {
772 return (auditon(A_GETPINFO_ADDR, apia, sz));
776 audit_get_sinfo_addr(auditinfo_addr_t *aia, size_t sz)
779 if (sizeof(*aia) != sz) {
784 return (auditon(A_GETSINFO_ADDR, aia, sz));
788 audit_get_stat(au_stat_t *stats, size_t sz)
791 if (sizeof(*stats) != sz) {
796 return (auditon(A_GETSTAT, stats, sz));
800 audit_set_stat(au_stat_t *stats, size_t sz)
803 if (sizeof(*stats) != sz) {
808 return (auditon(A_GETSTAT, stats, sz));
812 audit_get_cwd(char *path, size_t sz)
815 return (auditon(A_GETCWD, path, sz));
819 audit_get_car(char *path, size_t sz)
822 return (auditon(A_GETCAR, path, sz));