2 * Copyright (c) 2004 Apple Computer, 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 Computer, 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/bsm/libbsm.h#33 $
36 * NB: definitions, etc., marked with "OpenSSH compatibility" were introduced
37 * solely to allow OpenSSH to compile; Darwin/Apple code should not use them.
40 #include <sys/types.h>
41 #include <sys/cdefs.h>
43 #include <inttypes.h> /* Required for audit.h. */
44 #include <time.h> /* Required for clock_t on Linux. */
46 #include <bsm/audit.h>
47 #include <bsm/audit_record.h>
52 #include <mach/mach.h> /* audit_token_t */
56 * Size parsed token vectors for execve(2) arguments and environmental
57 * variables. Note: changing these sizes affects the ABI of the token
58 * structure, and as the token structure is often placed in the caller stack,
59 * this is undesirable.
61 #define AUDIT_MAX_ARGS 128
62 #define AUDIT_MAX_ENV 128
65 * Arguments to au_preselect(3).
67 #define AU_PRS_USECACHE 0
68 #define AU_PRS_REREAD 1
70 #define AU_PRS_SUCCESS 1
71 #define AU_PRS_FAILURE 2
72 #define AU_PRS_BOTH (AU_PRS_SUCCESS|AU_PRS_FAILURE)
74 #define AUDIT_EVENT_FILE "/etc/security/audit_event"
75 #define AUDIT_CLASS_FILE "/etc/security/audit_class"
76 #define AUDIT_CONTROL_FILE "/etc/security/audit_control"
77 #define AUDIT_USER_FILE "/etc/security/audit_user"
79 #define DIR_CONTROL_ENTRY "dir"
80 #define MINFREE_CONTROL_ENTRY "minfree"
81 #define FILESZ_CONTROL_ENTRY "filesz"
82 #define FLAGS_CONTROL_ENTRY "flags"
83 #define NA_CONTROL_ENTRY "naflags"
84 #define POLICY_CONTROL_ENTRY "policy"
86 #define AU_CLASS_NAME_MAX 8
87 #define AU_CLASS_DESC_MAX 72
88 #define AU_EVENT_NAME_MAX 30
89 #define AU_EVENT_DESC_MAX 50
90 #define AU_USER_NAME_MAX 50
91 #define AU_LINE_MAX 256
92 #define MAX_AUDITSTRING_LEN 256
93 #define BSM_TEXTBUFSZ MAX_AUDITSTRING_LEN /* OpenSSH compatibility */
96 * Arguments to au_close(3).
98 #define AU_TO_NO_WRITE 0 /* Abandon audit record. */
99 #define AU_TO_WRITE 1 /* Commit audit record. */
102 struct au_event_ent {
103 au_event_t ae_number;
108 typedef struct au_event_ent au_event_ent_t;
110 struct au_class_ent {
115 typedef struct au_class_ent au_class_ent_t;
122 typedef struct au_user_ent au_user_ent_t;
125 #define ADD_TO_MASK(m, c, sel) do { \
126 if (sel & AU_PRS_SUCCESS) \
127 (m)->am_success |= c; \
128 if (sel & AU_PRS_FAILURE) \
129 (m)->am_failure |= c; \
132 #define SUB_FROM_MASK(m, c, sel) do { \
133 if (sel & AU_PRS_SUCCESS) \
134 (m)->am_success &= ((m)->am_success ^ c); \
135 if (sel & AU_PRS_FAILURE) \
136 (m)->am_failure &= ((m)->am_failure ^ c); \
139 #define ADDMASK(m, v) do { \
140 (m)->am_success |= (v)->am_success; \
141 (m)->am_failure |= (v)->am_failure; \
144 #define SUBMASK(m, v) do { \
145 (m)->am_success &= ((m)->am_success ^ (v)->am_success); \
146 (m)->am_failure &= ((m)->am_failure ^ (v)->am_failure); \
151 typedef struct au_tid32 {
156 typedef struct au_tid64 {
161 typedef struct au_tidaddr32 {
167 typedef struct au_tidaddr64 {
175 * argument value 4 bytes/8 bytes (32-bit/64-bit value)
176 * text length 2 bytes
177 * text N bytes + 1 terminating NULL byte
194 * how to print 1 byte
197 * data items (depends on basic unit)
207 * file access mode 4 bytes
208 * owner user ID 4 bytes
209 * owner group ID 4 bytes
210 * file system ID 4 bytes
212 * device 4 bytes/8 bytes (32-bit/64-bit)
234 * text count null-terminated string(s)
238 char *text[AUDIT_MAX_ARGS];
243 * text count null-terminated string(s)
247 char *text[AUDIT_MAX_ENV];
252 * return value 4 bytes
260 * seconds of time 4 bytes
261 * milliseconds of time 4 bytes
262 * file name length 2 bytes
263 * file pathname N bytes + 1 terminating NULL byte
274 * number groups 2 bytes
275 * group list N * 4 bytes
279 u_int32_t list[AUDIT_MAX_GROUPS];
283 * record byte count 4 bytes
284 * version # 1 byte [2]
286 * event modifier 2 bytes
287 * seconds of time 4 bytes/8 bytes (32-bit/64-bit value)
288 * milliseconds of time 4 bytes/8 bytes (32-bit/64-bit value)
300 * record byte count 4 bytes
301 * version # 1 byte [2]
303 * event modifier 2 bytes
304 * address type/length 1 byte (XXX: actually, 4 bytes)
305 * machine address 4 bytes/16 bytes (IPv4/IPv6 address)
306 * seconds of time 4 bytes/8 bytes (32/64-bits)
307 * nanoseconds of time 4 bytes/8 bytes (32/64-bits)
341 * internet address 4 bytes
349 * internet address 16 bytes
357 * version and ihl 1 byte
358 * type of service 1 byte
365 * source address 4 bytes
366 * destination address 4 bytes
382 * object ID type 1 byte
391 * owner user ID 4 bytes
392 * owner group ID 4 bytes
393 * creator user ID 4 bytes
394 * creator group ID 4 bytes
395 * access mode 4 bytes
396 * slot sequence # 4 bytes
410 * port IP address 2 bytes
426 * path length 2 bytes
427 * path N bytes + 1 terminating NULL byte
436 * effective user ID 4 bytes
437 * effective group ID 4 bytes
438 * real user ID 4 bytes
439 * real group ID 4 bytes
443 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
444 * machine address 4 bytes
470 * effective user ID 4 bytes
471 * effective group ID 4 bytes
472 * real user ID 4 bytes
473 * real group ID 4 bytes
477 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
479 * machine address 16 bytes
504 * error status 1 byte
505 * return value 4 bytes/8 bytes (32-bit/64-bit value)
518 * sequence number 4 bytes
525 * socket type 2 bytes
527 * local Internet address 4 bytes
528 * remote port 2 bytes
529 * remote Internet address 4 bytes
540 * socket type 2 bytes
542 * address type/length 4 bytes
543 * local Internet address 4 bytes/16 bytes (IPv4/IPv6 address)
544 * remote port 4 bytes
545 * address type/length 4 bytes
546 * remote Internet address 4 bytes/16 bytes (IPv4/IPv6 address)
559 * socket family 2 bytes
561 * socket address 4 bytes/16 bytes (IPv4/IPv6 address)
570 * socket family 2 bytes
580 * effective user ID 4 bytes
581 * effective group ID 4 bytes
582 * real user ID 4 bytes
583 * real group ID 4 bytes
587 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
588 * machine address 4 bytes
614 * effective user ID 4 bytes
615 * effective group ID 4 bytes
616 * real user ID 4 bytes
617 * real group ID 4 bytes
621 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
623 * machine address 16 bytes
648 * text length 2 bytes
649 * text N bytes + 1 terminating NULL byte
657 * zonename length 2 bytes
658 * zonename text N bytes + 1 NULL terminator
679 * trailer magic number 2 bytes
680 * record byte count 4 bytes
697 au_execarg_t execarg;
698 au_execenv_t execenv;
703 au_header32_ex_t hdr32_ex;
705 au_header64_ex_t hdr64_ex;
707 au_inaddr_ex_t inaddr_ex;
710 au_ipcperm_t ipcperm;
715 au_proc32ex_t proc32_ex;
717 au_proc64ex_t proc64_ex;
722 au_socket_ex32_t socket_ex32;
723 au_socketinet32_t sockinet32;
724 au_socketunix_t sockunix;
725 au_subject32_t subj32;
726 au_subject32ex_t subj32_ex;
727 au_subject64_t subj64;
728 au_subject64ex_t subj64_ex;
731 au_invalid_t invalid;
733 au_zonename_t zonename;
734 } tt; /* The token is one of the above types */
737 typedef struct tokenstr tokenstr_t;
739 int audit_submit(short au_event, au_id_t auid,
740 char status, int reterr, const char *fmt, ...);
743 * Functions relating to querying audit class information.
745 void setauclass(void);
746 void endauclass(void);
747 struct au_class_ent *getauclassent(void);
748 struct au_class_ent *getauclassent_r(au_class_ent_t *class_int);
749 struct au_class_ent *getauclassnam(const char *name);
750 struct au_class_ent *getauclassnam_r(au_class_ent_t *class_int,
752 struct au_class_ent *getauclassnum(au_class_t class_number);
753 struct au_class_ent *getauclassnum_r(au_class_ent_t *class_int,
754 au_class_t class_number);
757 * Functions relating to querying audit control information.
761 int getacdir(char *name, int len);
762 int getacmin(int *min_val);
763 int getacfilesz(size_t *size_val);
764 int getacflg(char *auditstr, int len);
765 int getacna(char *auditstr, int len);
766 int getacpol(char *auditstr, size_t len);
767 int getauditflagsbin(char *auditstr, au_mask_t *masks);
768 int getauditflagschar(char *auditstr, au_mask_t *masks,
770 int au_preselect(au_event_t event, au_mask_t *mask_p,
772 ssize_t au_poltostr(long policy, size_t maxsize, char *buf);
773 int au_strtopol(const char *polstr, long *policy);
776 * Functions relating to querying audit event information.
778 void setauevent(void);
779 void endauevent(void);
780 struct au_event_ent *getauevent(void);
781 struct au_event_ent *getauevent_r(struct au_event_ent *e);
782 struct au_event_ent *getauevnam(const char *name);
783 struct au_event_ent *getauevnam_r(struct au_event_ent *e,
785 struct au_event_ent *getauevnum(au_event_t event_number);
786 struct au_event_ent *getauevnum_r(struct au_event_ent *e,
787 au_event_t event_number);
788 au_event_t *getauevnonam(const char *event_name);
789 au_event_t *getauevnonam_r(au_event_t *ev,
790 const char *event_name);
793 * Functions relating to querying audit user information.
795 void setauuser(void);
796 void endauuser(void);
797 struct au_user_ent *getauuserent(void);
798 struct au_user_ent *getauuserent_r(struct au_user_ent *u);
799 struct au_user_ent *getauusernam(const char *name);
800 struct au_user_ent *getauusernam_r(struct au_user_ent *u,
802 int au_user_mask(char *username, au_mask_t *mask_p);
803 int getfauditflags(au_mask_t *usremask,
804 au_mask_t *usrdmask, au_mask_t *lastmask);
807 * Functions for reading and printing records and tokens from audit trails.
809 int au_read_rec(FILE *fp, u_char **buf);
810 int au_fetch_tok(tokenstr_t *tok, u_char *buf, int len);
811 //XXX The following interface has different prototype from BSM
812 void au_print_tok(FILE *outfp, tokenstr_t *tok,
813 char *del, char raw, char sfrm);
814 void au_print_tok_xml(FILE *outfp, tokenstr_t *tok,
815 char *del, char raw, char sfrm);
818 * Functions relating to XML output.
820 void au_print_xml_header(FILE *outfp);
821 void au_print_xml_footer(FILE *outfp);
825 * The remaining APIs are associated with Apple's BSM implementation, in
826 * particular as relates to Mach IPC auditing and triggers passed via Mach
830 #include <sys/appleapiopts.h>
832 /**************************************************************************
833 **************************************************************************
834 ** The following definitions, functions, etc., are NOT officially
835 ** supported: they may be changed or removed in the future. Do not use
836 ** them unless you are prepared to cope with that eventuality.
837 **************************************************************************
838 **************************************************************************/
840 #ifdef __APPLE_API_PRIVATE
841 #define __BSM_INTERNAL_NOTIFY_KEY "com.apple.audit.change"
842 #endif /* __APPLE_API_PRIVATE */
845 * au_get_state() return values
846 * XXX use AUC_* values directly instead (<bsm/audit.h>); AUDIT_OFF and
847 * AUDIT_ON are deprecated and WILL be removed.
849 #ifdef __APPLE_API_PRIVATE
850 #define AUDIT_OFF AUC_NOAUDIT
851 #define AUDIT_ON AUC_AUDITING
852 #endif /* __APPLE_API_PRIVATE */
853 #endif /* !__APPLE__ */
856 * Error return codes for audit_set_terminal_id(), audit_write() and its
857 * brethren. We have 255 (not including kAUNoErr) to play with.
859 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
863 kAUBadParamErr = -66049,
867 kAUMakeSubjectTokErr,
868 kAUWriteSubjectTokErr,
869 kAUWriteCallerTokErr,
871 kAUWriteReturnTokErr,
879 * Error return codes for au_get_state() and/or its private support
880 * functions. These codes are designed to be compatible with the
881 * NOTIFY_STATUS_* codes defined in <notify.h> but non-overlapping.
882 * Any changes to notify(3) may cause these values to change in future.
884 * AU_UNIMPL should never happen unless you've changed your system software
885 * without rebooting. Shame on you.
887 #ifdef __APPLE_API_PRIVATE
888 #define AU_UNIMPL NOTIFY_STATUS_FAILED + 1 /* audit unimplemented */
889 #endif /* __APPLE_API_PRIVATE */
890 #endif /* !__APPLE__ */
894 * XXX This prototype should be in audit_record.h
898 * @summary - au_free_token() deallocates a token_t created by any of
899 * the au_to_*() BSM API functions.
901 * The BSM API generally manages deallocation of token_t objects. However,
902 * if au_write() is passed a bad audit descriptor, the token_t * parameter
903 * will be left untouched. In that case, the caller can deallocate the
904 * token_t using au_free_token() if desired. This is, in fact, what
905 * audit_write() does, in keeping with the existing memory management model
908 * @param tok - A token_t * generated by one of the au_to_*() BSM API
909 * calls. For convenience, tok may be NULL, in which case
910 * au_free_token() returns immediately.
912 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
914 void au_free_token(token_t *tok);
917 * Lightweight check to determine if auditing is enabled. If a client
918 * wants to use this to govern whether an entire series of audit calls
919 * should be made--as in the common case of a caller building a set of
920 * tokens, then writing them--it should cache the audit status in a local
921 * variable. This call always returns the current state of auditing.
923 * @return - AUC_AUDITING or AUC_NOAUDIT if no error occurred.
924 * Otherwise the function can return any of the errno values defined for
925 * setaudit(2), or AU_UNIMPL if audit does not appear to be supported by
928 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
930 int au_get_state(void);
933 /* OpenSSH compatibility */
934 int cannot_audit(int);
938 * audit_set_terminal_id()
940 * @summary - audit_set_terminal_id() fills in an au_tid_t struct, which is
941 * used in audit session initialization by processes like /usr/bin/login.
943 * @param tid - A pointer to an au_tid_t struct.
945 * @return - kAUNoErr on success; kAUBadParamErr if tid is NULL, kAUStatErr
946 * or kAUSysctlErr if one of the underlying system calls fails (a message
947 * is sent to the system log in those cases).
949 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
951 int audit_set_terminal_id(au_tid_t *tid);
954 * BEGIN au_write() WRAPPERS
956 * The following calls all wrap the existing BSM API. They use the
957 * provided subject information, if any, to construct the subject token
958 * required for every log message. They use the provided return/error
959 * value(s), if any, to construct the success/failure indication required
960 * for every log message. They only permit one "miscellaneous" token,
961 * which should contain the event-specific logging information mandated by
964 * All these calls assume the caller has previously determined that
965 * auditing is enabled by calling au_get_state().
971 * @summary - audit_write() is the basis for the other audit_write_*()
972 * calls. Performs a basic write of an audit record (subject, additional
973 * info, success/failure). Note that this call only permits logging one
974 * caller-specified token; clients needing to log more flexibly must use
975 * the existing BSM API (au_open(), et al.) directly.
977 * Note on memory management: audit_write() guarantees that the token_t *s
978 * passed to it will be deallocated whether or not the underlying write to
979 * the audit log succeeded. This addresses an inconsistency in the
980 * underlying BSM API in which token_t *s are usually but not always
983 * @param event_code - The code for the event being logged. This should
984 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
986 * @param subject - A token_t * generated by au_to_subject(),
987 * au_to_subject32(), au_to_subject64(), or au_to_me(). If no subject is
988 * required, subject should be NULL.
990 * @param misctok - A token_t * generated by one of the au_to_*() BSM API
991 * calls. This should correspond to the additional information required by
992 * CAPP for the event being audited. If no additional information is
993 * required, misctok should be NULL.
995 * @param retval - The return value to be logged for this event. This
996 * should be 0 (zero) for success, otherwise the value is event-specific.
998 * @param errcode - Any error code associated with the return value (e.g.,
999 * errno or h_errno). If there was no error, errcode should be 0 (zero).
1001 * @return - The status of the call: 0 (zero) on success, else one of the
1002 * kAU*Err values defined above.
1004 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1006 int audit_write(short event_code, token_t *subject, token_t *misctok,
1007 char retval, int errcode);
1010 * audit_write_success()
1012 * @summary - audit_write_success() records an auditable event that did not
1013 * encounter an error. The interface is designed to require as little
1014 * direct use of the au_to_*() API as possible. It builds a subject token
1015 * from the information passed in and uses that to invoke audit_write().
1016 * A subject, as defined by CAPP, is a process acting on the user's behalf.
1018 * If the subject information is the same as the current process, use
1019 * au_write_success_self().
1021 * @param event_code - The code for the event being logged. This should
1022 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1024 * @param misctok - A token_t * generated by one of the au_to_*() BSM API
1025 * calls. This should correspond to the additional information required by
1026 * CAPP for the event being audited. If no additional information is
1027 * required, misctok should be NULL.
1029 * @param auid - The subject's audit ID.
1031 * @param euid - The subject's effective user ID.
1033 * @param egid - The subject's effective group ID.
1035 * @param ruid - The subject's real user ID.
1037 * @param rgid - The subject's real group ID.
1039 * @param pid - The subject's process ID.
1041 * @param sid - The subject's session ID.
1043 * @param tid - The subject's terminal ID.
1045 * @return - The status of the call: 0 (zero) on success, else one of the
1046 * kAU*Err values defined above.
1048 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1050 int audit_write_success(short event_code, token_t *misctok, au_id_t auid,
1051 uid_t euid, gid_t egid, uid_t ruid, gid_t rgid, pid_t pid,
1052 au_asid_t sid, au_tid_t *tid);
1055 * audit_write_success_self()
1057 * @summary - Similar to audit_write_success(), but used when the subject
1058 * (process) is owned and operated by the auditable user him/herself.
1060 * @param event_code - The code for the event being logged. This should
1061 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1063 * @param misctok - A token_t * generated by one of the au_to_*() BSM API
1064 * calls. This should correspond to the additional information required by
1065 * CAPP for the event being audited. If no additional information is
1066 * required, misctok should be NULL.
1068 * @return - The status of the call: 0 (zero) on success, else one of the
1069 * kAU*Err values defined above.
1071 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1073 int audit_write_success_self(short event_code, token_t *misctok);
1076 * audit_write_failure()
1078 * @summary - audit_write_failure() records an auditable event that
1079 * encountered an error. The interface is designed to require as little
1080 * direct use of the au_to_*() API as possible. It builds a subject token
1081 * from the information passed in and uses that to invoke audit_write().
1082 * A subject, as defined by CAPP, is a process acting on the user's behalf.
1084 * If the subject information is the same as the current process, use
1085 * au_write_failure_self().
1087 * @param event_code - The code for the event being logged. This should
1088 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1090 * @param errmsg - A text message providing additional information about
1091 * the event being audited.
1093 * @param errret - A numerical value providing additional information about
1094 * the error. This is intended to store the value of errno or h_errno if
1095 * it's relevant. This can be 0 (zero) if no additional information is
1098 * @param auid - The subject's audit ID.
1100 * @param euid - The subject's effective user ID.
1102 * @param egid - The subject's effective group ID.
1104 * @param ruid - The subject's real user ID.
1106 * @param rgid - The subject's real group ID.
1108 * @param pid - The subject's process ID.
1110 * @param sid - The subject's session ID.
1112 * @param tid - The subject's terminal ID.
1114 * @return - The status of the call: 0 (zero) on success, else one of the
1115 * kAU*Err values defined above.
1117 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1119 int audit_write_failure(short event_code, char *errmsg, int errret,
1120 au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, gid_t rgid,
1121 pid_t pid, au_asid_t sid, au_tid_t *tid);
1124 * audit_write_failure_self()
1126 * @summary - Similar to audit_write_failure(), but used when the subject
1127 * (process) is owned and operated by the auditable user him/herself.
1129 * @param event_code - The code for the event being logged. This should
1130 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1132 * @param errmsg - A text message providing additional information about
1133 * the event being audited.
1135 * @param errret - A numerical value providing additional information about
1136 * the error. This is intended to store the value of errno or h_errno if
1137 * it's relevant. This can be 0 (zero) if no additional information is
1140 * @return - The status of the call: 0 (zero) on success, else one of the
1141 * kAU*Err values defined above.
1143 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1145 int audit_write_failure_self(short event_code, char *errmsg, int errret);
1148 * audit_write_failure_na()
1150 * @summary - audit_write_failure_na() records errors during login. Such
1151 * errors are implicitly non-attributable (i.e., not ascribable to any user).
1153 * @param event_code - The code for the event being logged. This should
1154 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1156 * @param errmsg - A text message providing additional information about
1157 * the event being audited.
1159 * @param errret - A numerical value providing additional information about
1160 * the error. This is intended to store the value of errno or h_errno if
1161 * it's relevant. This can be 0 (zero) if no additional information is
1164 * @param euid - The subject's effective user ID.
1166 * @param egid - The subject's effective group ID.
1168 * @param pid - The subject's process ID.
1170 * @param tid - The subject's terminal ID.
1172 * @return - The status of the call: 0 (zero) on success, else one of the
1173 * kAU*Err values defined above.
1175 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1177 int audit_write_failure_na(short event_code, char *errmsg, int errret,
1178 uid_t euid, gid_t egid, pid_t pid, au_tid_t *tid);
1180 /* END au_write() WRAPPERS */
1184 * audit_token_to_au32()
1186 * @summary - Extract information from an audit_token_t, used to identify
1187 * Mach tasks and senders of Mach messages as subjects to the audit system.
1188 * audit_tokent_to_au32() is the only method that should be used to parse
1189 * an audit_token_t, since its internal representation may change over
1190 * time. A pointer parameter may be NULL if that information is not
1193 * @param atoken - the audit token containing the desired information
1195 * @param auidp - Pointer to a uid_t; on return will be set to the task or
1196 * sender's audit user ID
1198 * @param euidp - Pointer to a uid_t; on return will be set to the task or
1199 * sender's effective user ID
1201 * @param egidp - Pointer to a gid_t; on return will be set to the task or
1202 * sender's effective group ID
1204 * @param ruidp - Pointer to a uid_t; on return will be set to the task or
1205 * sender's real user ID
1207 * @param rgidp - Pointer to a gid_t; on return will be set to the task or
1208 * sender's real group ID
1210 * @param pidp - Pointer to a pid_t; on return will be set to the task or
1211 * sender's process ID
1213 * @param asidp - Pointer to an au_asid_t; on return will be set to the
1214 * task or sender's audit session ID
1216 * @param tidp - Pointer to an au_tid_t; on return will be set to the task
1217 * or sender's terminal ID
1219 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1221 void audit_token_to_au32(
1222 audit_token_t atoken,
1231 #endif /* !__APPLE__ */
1235 #endif /* !_LIBBSM_H_ */