2 * Copyright (c) 2004-2009 Apple Inc.
3 * Copyright (c) 2016 Robert N. M. Watson
6 * Portions of this software were developed by BAE Systems, the University of
7 * Cambridge Computer Laboratory, and Memorial University under DARPA/AFRL
8 * contract FA8650-15-C-7558 ("CADETS"), as part of the DARPA Transparent
9 * Computing (TC) research program.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of Apple Inc. ("Apple") nor the names of
20 * its contributors may be used to endorse or promote products derived
21 * from this software without specific prior written permission.
23 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
31 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
32 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
37 #define _SYS_AUDIT_H /* Prevent include of sys/audit.h. */
40 #include <sys/param.h>
44 #include <sys/queue.h> /* Our bsm/audit.h doesn't include queue.h. */
47 #include <sys/sysctl.h>
49 #include <bsm/libbsm.h>
57 /* These are not advertised in libbsm.h */
58 int audit_set_terminal_port(dev_t *p);
59 int audit_set_terminal_host(uint32_t *m);
62 * General purpose audit submission mechanism for userspace.
65 audit_submit(short au_event, au_id_t auid, char status,
66 int reterr, const char *fmt, ...)
68 char text[MAX_AUDITSTRING_LEN];
73 int error, afd, subj_ex;
75 struct auditinfo_addr aia;
78 if (audit_get_cond(&acond) != 0) {
80 * If auditon(2) returns ENOSYS, then audit has not been
81 * compiled into the kernel, so just return.
86 syslog(LOG_AUTH | LOG_ERR, "audit: auditon failed: %s",
91 if (acond == AUC_NOAUDIT)
96 syslog(LOG_AUTH | LOG_ERR, "audit: au_open failed: %s",
102 * Try to use getaudit_addr(2) first. If this kernel does not support
103 * it, then fall back on to getaudit(2).
106 error = getaudit_addr(&aia, sizeof(aia));
107 if (error < 0 && errno == ENOSYS) {
108 error = getaudit(&ai);
111 syslog(LOG_AUTH | LOG_ERR, "audit: getaudit failed: %s",
117 * Convert this auditinfo_t to an auditinfo_addr_t to make the
118 * following code less complicated wrt to preselection and
119 * subject token generation.
121 aia.ai_auid = ai.ai_auid;
122 aia.ai_mask = ai.ai_mask;
123 aia.ai_asid = ai.ai_asid;
124 aia.ai_termid.at_type = AU_IPv4;
125 aia.ai_termid.at_addr[0] = ai.ai_termid.machine;
126 aia.ai_termid.at_port = ai.ai_termid.port;
127 } else if (error < 0) {
129 syslog(LOG_AUTH | LOG_ERR, "audit: getaudit_addr failed: %s",
135 * NB: We should be performing pre-selection here now that we have the
136 * masks for this process.
138 if (aia.ai_termid.at_type == AU_IPv6)
142 atid.port = aia.ai_termid.at_port;
143 atid.machine = aia.ai_termid.at_addr[0];
144 token = au_to_subject32(auid, geteuid(), getegid(),
145 getuid(), getgid(), pid, pid, &atid);
147 token = au_to_subject_ex(auid, geteuid(), getegid(),
148 getuid(), getgid(), pid, pid, &aia.ai_termid);
150 syslog(LOG_AUTH | LOG_ERR,
151 "audit: unable to build subject token");
152 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
156 if (au_write(afd, token) < 0) {
158 syslog(LOG_AUTH | LOG_ERR,
159 "audit: au_write failed: %s", strerror(errno));
160 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
166 (void) vsnprintf(text, MAX_AUDITSTRING_LEN, fmt, ap);
168 token = au_to_text(text);
170 syslog(LOG_AUTH | LOG_ERR,
171 "audit: failed to generate text token");
172 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
176 if (au_write(afd, token) < 0) {
178 syslog(LOG_AUTH | LOG_ERR,
179 "audit: au_write failed: %s", strerror(errno));
180 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
185 token = au_to_return32(au_errno_to_bsm(status), reterr);
187 syslog(LOG_AUTH | LOG_ERR,
188 "audit: unable to build return token");
189 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
193 if (au_write(afd, token) < 0) {
195 syslog(LOG_AUTH | LOG_ERR,
196 "audit: au_write failed: %s", strerror(errno));
197 (void) au_close(afd, AU_TO_NO_WRITE, au_event);
201 if (au_close(afd, AU_TO_WRITE, au_event) < 0) {
203 syslog(LOG_AUTH | LOG_ERR, "audit: record not committed");
211 audit_set_terminal_port(dev_t *p)
216 return (kAUBadParamErr);
224 /* for /usr/bin/login, try fstat() first */
225 if (fstat(STDIN_FILENO, &st) != 0) {
226 if (errno != EBADF) {
227 syslog(LOG_ERR, "fstat() failed (%s)",
231 if (stat("/dev/console", &st) != 0) {
232 syslog(LOG_ERR, "stat() failed (%s)",
242 audit_set_terminal_host(uint32_t *m)
246 int name[2] = { CTL_KERN, KERN_HOSTID };
250 return (kAUBadParamErr);
253 if (sysctl(name, 2, m, &len, NULL, 0) != 0) {
254 syslog(LOG_ERR, "sysctl() failed (%s)", strerror(errno));
255 return (kAUSysctlErr);
265 audit_set_terminal_id(au_tid_t *tid)
271 return (kAUBadParamErr);
272 if ((ret = audit_set_terminal_port(&port)) != kAUNoErr)
275 return (audit_set_terminal_host(&tid->machine));
279 * This is OK for those callers who have only one token to write. If you have
280 * multiple tokens that logically form part of the same audit record, you need
281 * to use the existing au_open()/au_write()/au_close() API:
284 * tok = au_to_random_token_1(...);
285 * au_write(aufd, tok);
286 * tok = au_to_random_token_2(...);
287 * au_write(aufd, tok);
289 * au_close(aufd, AU_TO_WRITE, AUE_your_event_type);
291 * Assumes, like all wrapper calls, that the caller has previously checked
292 * that auditing is enabled via the audit_get_state() call.
294 * XXX: Should be more robust against bad arguments.
297 audit_write(short event_code, token_t *subject, token_t *misctok, char retval,
301 char *func = "audit_write()";
304 if ((aufd = au_open()) == -1) {
305 au_free_token(subject);
306 au_free_token(misctok);
307 syslog(LOG_ERR, "%s: au_open() failed", func);
312 if (subject && au_write(aufd, subject) == -1) {
313 au_free_token(subject);
314 au_free_token(misctok);
315 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
316 syslog(LOG_ERR, "%s: write of subject failed", func);
317 return (kAUWriteSubjectTokErr);
320 /* Save the event-specific token. */
321 if (misctok && au_write(aufd, misctok) == -1) {
322 au_free_token(misctok);
323 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
324 syslog(LOG_ERR, "%s: write of caller token failed", func);
325 return (kAUWriteCallerTokErr);
328 /* Tokenize and save the return value. */
329 if ((rettok = au_to_return32(retval, errcode)) == NULL) {
330 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
331 syslog(LOG_ERR, "%s: au_to_return32() failed", func);
332 return (kAUMakeReturnTokErr);
335 if (au_write(aufd, rettok) == -1) {
336 au_free_token(rettok);
337 (void)au_close(aufd, AU_TO_NO_WRITE, event_code);
338 syslog(LOG_ERR, "%s: write of return code failed", func);
339 return (kAUWriteReturnTokErr);
343 * We assume the caller wouldn't have bothered with this
344 * function if it hadn't already decided to keep the record.
346 if (au_close(aufd, AU_TO_WRITE, event_code) < 0) {
347 syslog(LOG_ERR, "%s: au_close() failed", func);
348 return (kAUCloseErr);
355 * Same caveats as audit_write(). In addition, this function explicitly
356 * assumes success; use audit_write_failure() on error.
359 audit_write_success(short event_code, token_t *tok, au_id_t auid, uid_t euid,
360 gid_t egid, uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
363 char *func = "audit_write_success()";
364 token_t *subject = NULL;
366 /* Tokenize and save subject. */
367 subject = au_to_subject32(auid, euid, egid, ruid, rgid, pid, sid,
369 if (subject == NULL) {
370 syslog(LOG_ERR, "%s: au_to_subject32() failed", func);
371 return kAUMakeSubjectTokErr;
374 return (audit_write(event_code, subject, tok, 0, 0));
378 * Same caveats as audit_write(). In addition, this function explicitly
379 * assumes success; use audit_write_failure_self() on error.
382 audit_write_success_self(short event_code, token_t *tok)
385 char *func = "audit_write_success_self()";
387 if ((subject = au_to_me()) == NULL) {
388 syslog(LOG_ERR, "%s: au_to_me() failed", func);
389 return (kAUMakeSubjectTokErr);
392 return (audit_write(event_code, subject, tok, 0, 0));
396 * Same caveats as audit_write(). In addition, this function explicitly
397 * assumes failure; use audit_write_success() otherwise.
399 * XXX This should let the caller pass an error return value rather than
403 audit_write_failure(short event_code, char *errmsg, int errcode, au_id_t auid,
404 uid_t euid, gid_t egid, uid_t ruid, gid_t rgid, pid_t pid, au_asid_t sid,
407 char *func = "audit_write_failure()";
408 token_t *subject, *errtok;
410 subject = au_to_subject32(auid, euid, egid, ruid, rgid, pid, sid, tid);
411 if (subject == NULL) {
412 syslog(LOG_ERR, "%s: au_to_subject32() failed", func);
413 return (kAUMakeSubjectTokErr);
416 /* tokenize and save the error message */
417 if ((errtok = au_to_text(errmsg)) == NULL) {
418 au_free_token(subject);
419 syslog(LOG_ERR, "%s: au_to_text() failed", func);
420 return (kAUMakeTextTokErr);
423 return (audit_write(event_code, subject, errtok, -1, errcode));
427 * Same caveats as audit_write(). In addition, this function explicitly
428 * assumes failure; use audit_write_success_self() otherwise.
430 * XXX This should let the caller pass an error return value rather than
434 audit_write_failure_self(short event_code, char *errmsg, int errret)
436 char *func = "audit_write_failure_self()";
437 token_t *subject, *errtok;
439 if ((subject = au_to_me()) == NULL) {
440 syslog(LOG_ERR, "%s: au_to_me() failed", func);
441 return (kAUMakeSubjectTokErr);
443 /* tokenize and save the error message */
444 if ((errtok = au_to_text(errmsg)) == NULL) {
445 au_free_token(subject);
446 syslog(LOG_ERR, "%s: au_to_text() failed", func);
447 return (kAUMakeTextTokErr);
449 return (audit_write(event_code, subject, errtok, -1, errret));
453 * For auditing errors during login. Such errors are implicitly
454 * non-attributable (i.e., not ascribable to any user).
456 * Assumes, like all wrapper calls, that the caller has previously checked
457 * that auditing is enabled via the audit_get_state() call.
460 audit_write_failure_na(short event_code, char *errmsg, int errret, uid_t euid,
461 uid_t egid, pid_t pid, au_tid_t *tid)
464 return (audit_write_failure(event_code, errmsg, errret, -1, euid,
465 egid, -1, -1, pid, -1, tid));
468 /* END OF au_write() WRAPPERS */
472 audit_token_to_au32(audit_token_t atoken, uid_t *auidp, uid_t *euidp,
473 gid_t *egidp, uid_t *ruidp, gid_t *rgidp, pid_t *pidp, au_asid_t *asidp,
478 *auidp = (uid_t)atoken.val[0];
480 *euidp = (uid_t)atoken.val[1];
482 *egidp = (gid_t)atoken.val[2];
484 *ruidp = (uid_t)atoken.val[3];
486 *rgidp = (gid_t)atoken.val[4];
488 *pidp = (pid_t)atoken.val[5];
490 *asidp = (au_asid_t)atoken.val[6];
492 audit_set_terminal_host(&tidp->machine);
493 tidp->port = (dev_t)atoken.val[7];
496 #endif /* !__APPLE__ */
499 audit_get_cond(int *cond)
503 ret = auditon(A_GETCOND, cond, sizeof(*cond));
505 if ((0 != ret) && EINVAL == errno) {
508 ret = auditon(A_OLDGETCOND, &lcond, sizeof(lcond));
516 audit_set_cond(int *cond)
520 ret = auditon(A_SETCOND, cond, sizeof(*cond));
522 if ((0 != ret) && (EINVAL == errno)) {
523 long lcond = (long)*cond;
525 ret = auditon(A_OLDSETCOND, &lcond, sizeof(lcond));
533 audit_get_policy(int *policy)
537 ret = auditon(A_GETPOLICY, policy, sizeof(*policy));
538 #ifdef A_OLDGETPOLICY
539 if ((0 != ret) && (EINVAL == errno)){
540 long lpolicy = (long)*policy;
542 ret = auditon(A_OLDGETPOLICY, &lpolicy, sizeof(lpolicy));
543 *policy = (int)lpolicy;
550 audit_set_policy(int *policy)
554 ret = auditon(A_SETPOLICY, policy, sizeof(*policy));
555 #ifdef A_OLDSETPOLICY
556 if ((0 != ret) && (EINVAL == errno)){
557 long lpolicy = (long)*policy;
559 ret = auditon(A_OLDSETPOLICY, &lpolicy, sizeof(lpolicy));
560 *policy = (int)lpolicy;
567 audit_get_qctrl(au_qctrl_t *qctrl, size_t sz)
571 if (sizeof(*qctrl) != sz) {
576 ret = auditon(A_GETQCTRL, qctrl, sizeof(*qctrl));
578 if ((0 != ret) && (EINVAL == errno)){
587 oq.oq_hiwater = (size_t)qctrl->aq_hiwater;
588 oq.oq_lowater = (size_t)qctrl->aq_lowater;
589 oq.oq_bufsz = (size_t)qctrl->aq_bufsz;
590 oq.oq_delay = (clock_t)qctrl->aq_delay;
591 oq.oq_minfree = qctrl->aq_minfree;
593 ret = auditon(A_OLDGETQCTRL, &oq, sizeof(oq));
595 qctrl->aq_hiwater = (int)oq.oq_hiwater;
596 qctrl->aq_lowater = (int)oq.oq_lowater;
597 qctrl->aq_bufsz = (int)oq.oq_bufsz;
598 qctrl->aq_delay = (int)oq.oq_delay;
599 qctrl->aq_minfree = oq.oq_minfree;
601 #endif /* A_OLDGETQCTRL */
606 audit_set_qctrl(au_qctrl_t *qctrl, size_t sz)
610 if (sizeof(*qctrl) != sz) {
615 ret = auditon(A_SETQCTRL, qctrl, sz);
617 if ((0 != ret) && (EINVAL == errno)) {
626 oq.oq_hiwater = (size_t)qctrl->aq_hiwater;
627 oq.oq_lowater = (size_t)qctrl->aq_lowater;
628 oq.oq_bufsz = (size_t)qctrl->aq_bufsz;
629 oq.oq_delay = (clock_t)qctrl->aq_delay;
630 oq.oq_minfree = qctrl->aq_minfree;
632 ret = auditon(A_OLDSETQCTRL, &oq, sizeof(oq));
634 qctrl->aq_hiwater = (int)oq.oq_hiwater;
635 qctrl->aq_lowater = (int)oq.oq_lowater;
636 qctrl->aq_bufsz = (int)oq.oq_bufsz;
637 qctrl->aq_delay = (int)oq.oq_delay;
638 qctrl->aq_minfree = oq.oq_minfree;
640 #endif /* A_OLDSETQCTRL */
645 audit_send_trigger(int *trigger)
648 return (auditon(A_SENDTRIGGER, trigger, sizeof(*trigger)));
652 audit_get_kaudit(auditinfo_addr_t *aia, size_t sz)
655 if (sizeof(*aia) != sz) {
660 return (auditon(A_GETKAUDIT, aia, sz));
664 audit_set_kaudit(auditinfo_addr_t *aia, size_t sz)
667 if (sizeof(*aia) != sz) {
672 return (auditon(A_SETKAUDIT, aia, sz));
676 audit_get_class(au_evclass_map_t *evc_map, size_t sz)
679 if (sizeof(*evc_map) != sz) {
684 return (auditon(A_GETCLASS, evc_map, sz));
688 audit_set_class(au_evclass_map_t *evc_map, size_t sz)
691 if (sizeof(*evc_map) != sz) {
696 return (auditon(A_SETCLASS, evc_map, sz));
700 audit_get_event(au_evname_map_t *evn_map, size_t sz)
703 if (sizeof(*evn_map) != sz) {
708 return (auditon(A_GETEVENT, evn_map, sz));
712 audit_set_event(au_evname_map_t *evn_map, size_t sz)
715 if (sizeof(*evn_map) != sz) {
720 return (auditon(A_SETEVENT, evn_map, sz));
724 audit_get_kmask(au_mask_t *kmask, size_t sz)
726 if (sizeof(*kmask) != sz) {
731 return (auditon(A_GETKMASK, kmask, sz));
735 audit_set_kmask(au_mask_t *kmask, size_t sz)
737 if (sizeof(*kmask) != sz) {
742 return (auditon(A_SETKMASK, kmask, sz));
746 audit_get_fsize(au_fstat_t *fstat, size_t sz)
749 if (sizeof(*fstat) != sz) {
754 return (auditon(A_GETFSIZE, fstat, sz));
758 audit_set_fsize(au_fstat_t *fstat, size_t sz)
761 if (sizeof(*fstat) != sz) {
766 return (auditon(A_SETFSIZE, fstat, sz));
770 audit_set_pmask(auditpinfo_t *api, size_t sz)
773 if (sizeof(*api) != sz) {
778 return (auditon(A_SETPMASK, api, sz));
782 audit_get_pinfo(auditpinfo_t *api, size_t sz)
785 if (sizeof(*api) != sz) {
790 return (auditon(A_GETPINFO, api, sz));
794 audit_get_pinfo_addr(auditpinfo_addr_t *apia, size_t sz)
797 if (sizeof(*apia) != sz) {
802 return (auditon(A_GETPINFO_ADDR, apia, sz));
806 audit_get_sinfo_addr(auditinfo_addr_t *aia, size_t sz)
809 if (sizeof(*aia) != sz) {
814 return (auditon(A_GETSINFO_ADDR, aia, sz));
818 audit_get_stat(au_stat_t *stats, size_t sz)
821 if (sizeof(*stats) != sz) {
826 return (auditon(A_GETSTAT, stats, sz));
830 audit_set_stat(au_stat_t *stats, size_t sz)
833 if (sizeof(*stats) != sz) {
838 return (auditon(A_GETSTAT, stats, sz));
842 audit_get_cwd(char *path, size_t sz)
845 return (auditon(A_GETCWD, path, sz));
849 audit_get_car(char *path, size_t sz)
852 return (auditon(A_GETCAR, path, sz));