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.
34 * NB: definitions, etc., marked with "OpenSSH compatibility" were introduced
35 * solely to allow OpenSSH to compile; Darwin/Apple code should not use them.
38 #include <sys/types.h>
39 #include <sys/cdefs.h>
41 #include <inttypes.h> /* Required for audit.h. */
42 #include <time.h> /* Required for clock_t on Linux. */
44 #include <bsm/audit.h>
45 #include <bsm/audit_record.h>
50 #include <mach/mach.h> /* audit_token_t */
54 * Size parsed token vectors for execve(2) arguments and environmental
55 * variables. Note: changing these sizes affects the ABI of the token
56 * structure, and as the token structure is often placed in the caller stack,
57 * this is undesirable.
59 #define AUDIT_MAX_ARGS 128
60 #define AUDIT_MAX_ENV 128
63 * Arguments to au_preselect(3).
65 #define AU_PRS_USECACHE 0
66 #define AU_PRS_REREAD 1
68 #define AU_PRS_SUCCESS 1
69 #define AU_PRS_FAILURE 2
70 #define AU_PRS_BOTH (AU_PRS_SUCCESS|AU_PRS_FAILURE)
72 #define AUDIT_EVENT_FILE "/etc/security/audit_event"
73 #define AUDIT_CLASS_FILE "/etc/security/audit_class"
74 #define AUDIT_CONTROL_FILE "/etc/security/audit_control"
75 #define AUDIT_USER_FILE "/etc/security/audit_user"
77 #define DIR_CONTROL_ENTRY "dir"
78 #define DIST_CONTROL_ENTRY "dist"
79 #define FILESZ_CONTROL_ENTRY "filesz"
80 #define FLAGS_CONTROL_ENTRY "flags"
81 #define HOST_CONTROL_ENTRY "host"
82 #define MINFREE_CONTROL_ENTRY "minfree"
83 #define NA_CONTROL_ENTRY "naflags"
84 #define POLICY_CONTROL_ENTRY "policy"
85 #define EXPIRE_AFTER_CONTROL_ENTRY "expire-after"
86 #define QSZ_CONTROL_ENTRY "qsize"
88 #define AU_CLASS_NAME_MAX 8
89 #define AU_CLASS_DESC_MAX 72
90 #define AU_EVENT_NAME_MAX 30
91 #define AU_EVENT_DESC_MAX 50
92 #define AU_USER_NAME_MAX 50
93 #define AU_LINE_MAX 256
94 #define MAX_AUDITSTRING_LEN 256
95 #define BSM_TEXTBUFSZ MAX_AUDITSTRING_LEN /* OpenSSH compatibility */
97 #define USE_DEFAULT_QSZ -1 /* Use system default queue size */
100 * Arguments to au_close(3).
102 #define AU_TO_NO_WRITE 0 /* Abandon audit record. */
103 #define AU_TO_WRITE 1 /* Commit audit record. */
106 * Output format flags for au_print_flags_tok().
108 #define AU_OFLAG_NONE 0x0000 /* Default form. */
109 #define AU_OFLAG_RAW 0x0001 /* Raw, numeric form. */
110 #define AU_OFLAG_SHORT 0x0002 /* Short form. */
111 #define AU_OFLAG_XML 0x0004 /* XML form. */
112 #define AU_OFLAG_NORESOLVE 0x0008 /* No user/group name resolution. */
115 struct au_event_ent {
116 au_event_t ae_number;
121 typedef struct au_event_ent au_event_ent_t;
123 struct au_class_ent {
128 typedef struct au_class_ent au_class_ent_t;
135 typedef struct au_user_ent au_user_ent_t;
138 #define ADD_TO_MASK(m, c, sel) do { \
139 if (sel & AU_PRS_SUCCESS) \
140 (m)->am_success |= c; \
141 if (sel & AU_PRS_FAILURE) \
142 (m)->am_failure |= c; \
145 #define SUB_FROM_MASK(m, c, sel) do { \
146 if (sel & AU_PRS_SUCCESS) \
147 (m)->am_success &= ((m)->am_success ^ c); \
148 if (sel & AU_PRS_FAILURE) \
149 (m)->am_failure &= ((m)->am_failure ^ c); \
152 #define ADDMASK(m, v) do { \
153 (m)->am_success |= (v)->am_success; \
154 (m)->am_failure |= (v)->am_failure; \
157 #define SUBMASK(m, v) do { \
158 (m)->am_success &= ((m)->am_success ^ (v)->am_success); \
159 (m)->am_failure &= ((m)->am_failure ^ (v)->am_failure); \
164 typedef struct au_tid32 {
169 typedef struct au_tid64 {
174 typedef struct au_tidaddr32 {
180 typedef struct au_tidaddr64 {
188 * argument value 4 bytes/8 bytes (32-bit/64-bit value)
189 * text length 2 bytes
190 * text N bytes + 1 terminating NULL byte
207 * how to print 1 byte
210 * data items (depends on basic unit)
220 * file access mode 4 bytes
221 * owner user ID 4 bytes
222 * owner group ID 4 bytes
223 * file system ID 4 bytes
225 * device 4 bytes/8 bytes (32-bit/64-bit)
247 * text count null-terminated string(s)
251 char *text[AUDIT_MAX_ARGS];
256 * text count null-terminated string(s)
260 char *text[AUDIT_MAX_ENV];
265 * return value 4 bytes
273 * seconds of time 4 bytes
274 * milliseconds of time 4 bytes
275 * file name length 2 bytes
276 * file pathname N bytes + 1 terminating NULL byte
287 * number groups 2 bytes
288 * group list N * 4 bytes
292 u_int32_t list[AUDIT_MAX_GROUPS];
296 * record byte count 4 bytes
297 * version # 1 byte [2]
299 * event modifier 2 bytes
300 * seconds of time 4 bytes/8 bytes (32-bit/64-bit value)
301 * milliseconds of time 4 bytes/8 bytes (32-bit/64-bit value)
313 * record byte count 4 bytes
314 * version # 1 byte [2]
316 * event modifier 2 bytes
317 * address type/length 1 byte (XXX: actually, 4 bytes)
318 * machine address 4 bytes/16 bytes (IPv4/IPv6 address)
319 * seconds of time 4 bytes/8 bytes (32/64-bits)
320 * nanoseconds of time 4 bytes/8 bytes (32/64-bits)
354 * internet address 4 bytes
362 * internet address 16 bytes
370 * version and ihl 1 byte
371 * type of service 1 byte
378 * source address 4 bytes
379 * destination address 4 bytes
395 * object ID type 1 byte
404 * owner user ID 4 bytes
405 * owner group ID 4 bytes
406 * creator user ID 4 bytes
407 * creator group ID 4 bytes
408 * access mode 4 bytes
409 * slot sequence # 4 bytes
423 * port IP address 2 bytes
439 * path length 2 bytes
440 * path N bytes + 1 terminating NULL byte
449 * effective user ID 4 bytes
450 * effective group ID 4 bytes
451 * real user ID 4 bytes
452 * real group ID 4 bytes
456 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
457 * machine address 4 bytes
483 * effective user ID 4 bytes
484 * effective group ID 4 bytes
485 * real user ID 4 bytes
486 * real group ID 4 bytes
490 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
492 * machine address 16 bytes
517 * error status 1 byte
518 * return value 4 bytes/8 bytes (32-bit/64-bit value)
531 * sequence number 4 bytes
538 * socket type 2 bytes
540 * local Internet address 4 bytes
541 * remote port 2 bytes
542 * remote Internet address 4 bytes
553 * socket type 2 bytes
555 * address type/length 4 bytes
556 * local Internet address 4 bytes/16 bytes (IPv4/IPv6 address)
557 * remote port 4 bytes
558 * address type/length 4 bytes
559 * remote Internet address 4 bytes/16 bytes (IPv4/IPv6 address)
572 * socket family 2 bytes
574 * socket address 4 bytes/16 bytes (IPv4/IPv6 address)
580 } au_socketinet_ex32_t;
589 * socket family 2 bytes
599 * effective user ID 4 bytes
600 * effective group ID 4 bytes
601 * real user ID 4 bytes
602 * real group ID 4 bytes
606 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
607 * machine address 4 bytes
633 * effective user ID 4 bytes
634 * effective group ID 4 bytes
635 * real user ID 4 bytes
636 * real group ID 4 bytes
640 * port ID 4 bytes/8 bytes (32-bit/64-bit value)
642 * machine address 16 bytes
667 * text length 2 bytes
668 * text N bytes + 1 terminating NULL byte
676 * upriv status 1 byte
677 * privstr len 2 bytes
678 * privstr N bytes + 1 (\0 byte)
682 u_int16_t privstrlen;
688 * privtstrlen 2 bytes
689 * privtstr N Bytes + 1
691 * privstr N Bytes + 1
694 u_int16_t privtstrlen;
696 u_int16_t privstrlen;
701 * zonename length 2 bytes
702 * zonename text N bytes + 1 NULL terminator
723 * trailer magic number 2 bytes
724 * record byte count 4 bytes
741 au_execarg_t execarg;
742 au_execenv_t execenv;
747 au_header32_ex_t hdr32_ex;
749 au_header64_ex_t hdr64_ex;
751 au_inaddr_ex_t inaddr_ex;
754 au_ipcperm_t ipcperm;
759 au_proc32ex_t proc32_ex;
761 au_proc64ex_t proc64_ex;
766 au_socket_ex32_t socket_ex32;
767 au_socketinet_ex32_t sockinet_ex32;
768 au_socketunix_t sockunix;
769 au_subject32_t subj32;
770 au_subject32ex_t subj32_ex;
771 au_subject64_t subj64;
772 au_subject64ex_t subj64_ex;
775 au_invalid_t invalid;
777 au_zonename_t zonename;
779 au_privset_t privset;
780 } tt; /* The token is one of the above types */
783 typedef struct tokenstr tokenstr_t;
785 int audit_submit(short au_event, au_id_t auid,
786 char status, int reterr, const char *fmt, ...);
789 * Functions relating to querying audit class information.
791 void setauclass(void);
792 void endauclass(void);
793 struct au_class_ent *getauclassent(void);
794 struct au_class_ent *getauclassent_r(au_class_ent_t *class_int);
795 struct au_class_ent *getauclassnam(const char *name);
796 struct au_class_ent *getauclassnam_r(au_class_ent_t *class_int,
798 struct au_class_ent *getauclassnum(au_class_t class_number);
799 struct au_class_ent *getauclassnum_r(au_class_ent_t *class_int,
800 au_class_t class_number);
803 * Functions relating to querying audit control information.
807 int getacdir(char *name, int len);
809 int getacexpire(int *andflg, time_t *age, size_t *size);
810 int getacfilesz(size_t *size_val);
811 int getacqsize(int *size_val);
812 int getacflg(char *auditstr, int len);
813 int getachost(char *auditstr, size_t len);
814 int getacmin(int *min_val);
815 int getacna(char *auditstr, int len);
816 int getacpol(char *auditstr, size_t len);
817 int getauditflagsbin(char *auditstr, au_mask_t *masks);
818 int getauditflagschar(char *auditstr, au_mask_t *masks,
820 int au_preselect(au_event_t event, au_mask_t *mask_p,
822 ssize_t au_poltostr(int policy, size_t maxsize, char *buf);
823 int au_strtopol(const char *polstr, int *policy);
826 * Functions relating to querying audit event information.
828 void setauevent(void);
829 void endauevent(void);
830 struct au_event_ent *getauevent(void);
831 struct au_event_ent *getauevent_r(struct au_event_ent *e);
832 struct au_event_ent *getauevnam(const char *name);
833 struct au_event_ent *getauevnam_r(struct au_event_ent *e,
835 struct au_event_ent *getauevnum(au_event_t event_number);
836 struct au_event_ent *getauevnum_r(struct au_event_ent *e,
837 au_event_t event_number);
838 au_event_t *getauevnonam(const char *event_name);
839 au_event_t *getauevnonam_r(au_event_t *ev,
840 const char *event_name);
843 * Functions relating to querying audit user information.
845 void setauuser(void);
846 void endauuser(void);
847 struct au_user_ent *getauuserent(void);
848 struct au_user_ent *getauuserent_r(struct au_user_ent *u);
849 struct au_user_ent *getauusernam(const char *name);
850 struct au_user_ent *getauusernam_r(struct au_user_ent *u,
852 int au_user_mask(char *username, au_mask_t *mask_p);
853 int getfauditflags(au_mask_t *usremask,
854 au_mask_t *usrdmask, au_mask_t *lastmask);
857 * Functions for reading and printing records and tokens from audit trails.
859 int au_read_rec(FILE *fp, u_char **buf);
860 int au_fetch_tok(tokenstr_t *tok, u_char *buf, int len);
861 //XXX The following interface has different prototype from BSM
862 void au_print_tok(FILE *outfp, tokenstr_t *tok,
863 char *del, char raw, char sfrm);
864 void au_print_flags_tok(FILE *outfp, tokenstr_t *tok,
865 char *del, int oflags);
866 void au_print_tok_xml(FILE *outfp, tokenstr_t *tok,
867 char *del, char raw, char sfrm);
870 * Functions relating to XML output.
872 void au_print_xml_header(FILE *outfp);
873 void au_print_xml_footer(FILE *outfp);
875 const char *au_strerror(u_char bsm_error);
879 * The remaining APIs are associated with Apple's BSM implementation, in
880 * particular as relates to Mach IPC auditing and triggers passed via Mach
884 #include <sys/appleapiopts.h>
886 /**************************************************************************
887 **************************************************************************
888 ** The following definitions, functions, etc., are NOT officially
889 ** supported: they may be changed or removed in the future. Do not use
890 ** them unless you are prepared to cope with that eventuality.
891 **************************************************************************
892 **************************************************************************/
894 #ifdef __APPLE_API_PRIVATE
895 #define __BSM_INTERNAL_NOTIFY_KEY "com.apple.audit.change"
896 #endif /* __APPLE_API_PRIVATE */
899 * au_get_state() return values
900 * XXX use AUC_* values directly instead (<bsm/audit.h>); AUDIT_OFF and
901 * AUDIT_ON are deprecated and WILL be removed.
903 #ifdef __APPLE_API_PRIVATE
904 #define AUDIT_OFF AUC_NOAUDIT
905 #define AUDIT_ON AUC_AUDITING
906 #endif /* __APPLE_API_PRIVATE */
907 #endif /* !__APPLE__ */
910 * Error return codes for audit_set_terminal_id(), audit_write() and its
911 * brethren. We have 255 (not including kAUNoErr) to play with.
913 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
917 kAUBadParamErr = -66049,
921 kAUMakeSubjectTokErr,
922 kAUWriteSubjectTokErr,
923 kAUWriteCallerTokErr,
925 kAUWriteReturnTokErr,
933 * Error return codes for au_get_state() and/or its private support
934 * functions. These codes are designed to be compatible with the
935 * NOTIFY_STATUS_* codes defined in <notify.h> but non-overlapping.
936 * Any changes to notify(3) may cause these values to change in future.
938 * AU_UNIMPL should never happen unless you've changed your system software
939 * without rebooting. Shame on you.
941 #ifdef __APPLE_API_PRIVATE
942 #define AU_UNIMPL NOTIFY_STATUS_FAILED + 1 /* audit unimplemented */
943 #endif /* __APPLE_API_PRIVATE */
944 #endif /* !__APPLE__ */
948 * XXX This prototype should be in audit_record.h
952 * @summary - au_free_token() deallocates a token_t created by any of
953 * the au_to_*() BSM API functions.
955 * The BSM API generally manages deallocation of token_t objects. However,
956 * if au_write() is passed a bad audit descriptor, the token_t * parameter
957 * will be left untouched. In that case, the caller can deallocate the
958 * token_t using au_free_token() if desired. This is, in fact, what
959 * audit_write() does, in keeping with the existing memory management model
962 * @param tok - A token_t * generated by one of the au_to_*() BSM API
963 * calls. For convenience, tok may be NULL, in which case
964 * au_free_token() returns immediately.
966 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
968 void au_free_token(token_t *tok);
971 * Lightweight check to determine if auditing is enabled. If a client
972 * wants to use this to govern whether an entire series of audit calls
973 * should be made--as in the common case of a caller building a set of
974 * tokens, then writing them--it should cache the audit status in a local
975 * variable. This call always returns the current state of auditing.
977 * @return - AUC_AUDITING or AUC_NOAUDIT if no error occurred.
978 * Otherwise the function can return any of the errno values defined for
979 * setaudit(2), or AU_UNIMPL if audit does not appear to be supported by
982 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
984 int au_get_state(void);
987 * Initialize the audit notification. If it has not already been initialized
988 * it will automatically on the first call of au_get_state().
990 uint32_t au_notify_initialize(void);
993 * Cancel audit notification and free the resources associated with it.
994 * Responsible code that no longer needs to use au_get_state() should call
997 int au_notify_terminate(void);
1000 /* OpenSSH compatibility */
1001 int cannot_audit(int);
1005 * audit_set_terminal_id()
1007 * @summary - audit_set_terminal_id() fills in an au_tid_t struct, which is
1008 * used in audit session initialization by processes like /usr/bin/login.
1010 * @param tid - A pointer to an au_tid_t struct.
1012 * @return - kAUNoErr on success; kAUBadParamErr if tid is NULL, kAUStatErr
1013 * or kAUSysctlErr if one of the underlying system calls fails (a message
1014 * is sent to the system log in those cases).
1016 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1018 int audit_set_terminal_id(au_tid_t *tid);
1021 * BEGIN au_write() WRAPPERS
1023 * The following calls all wrap the existing BSM API. They use the
1024 * provided subject information, if any, to construct the subject token
1025 * required for every log message. They use the provided return/error
1026 * value(s), if any, to construct the success/failure indication required
1027 * for every log message. They only permit one "miscellaneous" token,
1028 * which should contain the event-specific logging information mandated by
1031 * All these calls assume the caller has previously determined that
1032 * auditing is enabled by calling au_get_state().
1038 * @summary - audit_write() is the basis for the other audit_write_*()
1039 * calls. Performs a basic write of an audit record (subject, additional
1040 * info, success/failure). Note that this call only permits logging one
1041 * caller-specified token; clients needing to log more flexibly must use
1042 * the existing BSM API (au_open(), et al.) directly.
1044 * Note on memory management: audit_write() guarantees that the token_t *s
1045 * passed to it will be deallocated whether or not the underlying write to
1046 * the audit log succeeded. This addresses an inconsistency in the
1047 * underlying BSM API in which token_t *s are usually but not always
1050 * @param event_code - The code for the event being logged. This should
1051 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1053 * @param subject - A token_t * generated by au_to_subject(),
1054 * au_to_subject32(), au_to_subject64(), or au_to_me(). If no subject is
1055 * required, subject should be NULL.
1057 * @param misctok - A token_t * generated by one of the au_to_*() BSM API
1058 * calls. This should correspond to the additional information required by
1059 * CAPP for the event being audited. If no additional information is
1060 * required, misctok should be NULL.
1062 * @param retval - The return value to be logged for this event. This
1063 * should be 0 (zero) for success, otherwise the value is event-specific.
1065 * @param errcode - Any error code associated with the return value (e.g.,
1066 * errno or h_errno). If there was no error, errcode should be 0 (zero).
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(short event_code, token_t *subject, token_t *misctok,
1074 char retval, int errcode);
1077 * audit_write_success()
1079 * @summary - audit_write_success() records an auditable event that did not
1080 * encounter an error. The interface is designed to require as little
1081 * direct use of the au_to_*() API as possible. It builds a subject token
1082 * from the information passed in and uses that to invoke audit_write().
1083 * A subject, as defined by CAPP, is a process acting on the user's behalf.
1085 * If the subject information is the same as the current process, use
1086 * au_write_success_self().
1088 * @param event_code - The code for the event being logged. This should
1089 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1091 * @param misctok - A token_t * generated by one of the au_to_*() BSM API
1092 * calls. This should correspond to the additional information required by
1093 * CAPP for the event being audited. If no additional information is
1094 * required, misctok should be NULL.
1096 * @param auid - The subject's audit ID.
1098 * @param euid - The subject's effective user ID.
1100 * @param egid - The subject's effective group ID.
1102 * @param ruid - The subject's real user ID.
1104 * @param rgid - The subject's real group ID.
1106 * @param pid - The subject's process ID.
1108 * @param sid - The subject's session ID.
1110 * @param tid - The subject's terminal ID.
1112 * @return - The status of the call: 0 (zero) on success, else one of the
1113 * kAU*Err values defined above.
1115 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1117 int audit_write_success(short event_code, token_t *misctok, au_id_t auid,
1118 uid_t euid, gid_t egid, uid_t ruid, gid_t rgid, pid_t pid,
1119 au_asid_t sid, au_tid_t *tid);
1122 * audit_write_success_self()
1124 * @summary - Similar to audit_write_success(), but used when the subject
1125 * (process) is owned and operated by the auditable user him/herself.
1127 * @param event_code - The code for the event being logged. This should
1128 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1130 * @param misctok - A token_t * generated by one of the au_to_*() BSM API
1131 * calls. This should correspond to the additional information required by
1132 * CAPP for the event being audited. If no additional information is
1133 * required, misctok should be NULL.
1135 * @return - The status of the call: 0 (zero) on success, else one of the
1136 * kAU*Err values defined above.
1138 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1140 int audit_write_success_self(short event_code, token_t *misctok);
1143 * audit_write_failure()
1145 * @summary - audit_write_failure() records an auditable event that
1146 * encountered an error. The interface is designed to require as little
1147 * direct use of the au_to_*() API as possible. It builds a subject token
1148 * from the information passed in and uses that to invoke audit_write().
1149 * A subject, as defined by CAPP, is a process acting on the user's behalf.
1151 * If the subject information is the same as the current process, use
1152 * au_write_failure_self().
1154 * @param event_code - The code for the event being logged. This should
1155 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1157 * @param errmsg - A text message providing additional information about
1158 * the event being audited.
1160 * @param errret - A numerical value providing additional information about
1161 * the error. This is intended to store the value of errno or h_errno if
1162 * it's relevant. This can be 0 (zero) if no additional information is
1165 * @param auid - The subject's audit ID.
1167 * @param euid - The subject's effective user ID.
1169 * @param egid - The subject's effective group ID.
1171 * @param ruid - The subject's real user ID.
1173 * @param rgid - The subject's real group ID.
1175 * @param pid - The subject's process ID.
1177 * @param sid - The subject's session ID.
1179 * @param tid - The subject's terminal ID.
1181 * @return - The status of the call: 0 (zero) on success, else one of the
1182 * kAU*Err values defined above.
1184 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1186 int audit_write_failure(short event_code, char *errmsg, int errret,
1187 au_id_t auid, uid_t euid, gid_t egid, uid_t ruid, gid_t rgid,
1188 pid_t pid, au_asid_t sid, au_tid_t *tid);
1191 * audit_write_failure_self()
1193 * @summary - Similar to audit_write_failure(), but used when the subject
1194 * (process) is owned and operated by the auditable user him/herself.
1196 * @param event_code - The code for the event being logged. This should
1197 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1199 * @param errmsg - A text message providing additional information about
1200 * the event being audited.
1202 * @param errret - A numerical value providing additional information about
1203 * the error. This is intended to store the value of errno or h_errno if
1204 * it's relevant. This can be 0 (zero) if no additional information is
1207 * @return - The status of the call: 0 (zero) on success, else one of the
1208 * kAU*Err values defined above.
1210 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1212 int audit_write_failure_self(short event_code, char *errmsg, int errret);
1215 * audit_write_failure_na()
1217 * @summary - audit_write_failure_na() records errors during login. Such
1218 * errors are implicitly non-attributable (i.e., not ascribable to any user).
1220 * @param event_code - The code for the event being logged. This should
1221 * be one of the AUE_ values in /usr/include/bsm/audit_uevents.h.
1223 * @param errmsg - A text message providing additional information about
1224 * the event being audited.
1226 * @param errret - A numerical value providing additional information about
1227 * the error. This is intended to store the value of errno or h_errno if
1228 * it's relevant. This can be 0 (zero) if no additional information is
1231 * @param euid - The subject's effective user ID.
1233 * @param egid - The subject's effective group ID.
1235 * @param pid - The subject's process ID.
1237 * @param tid - The subject's terminal ID.
1239 * @return - The status of the call: 0 (zero) on success, else one of the
1240 * kAU*Err values defined above.
1242 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1244 int audit_write_failure_na(short event_code, char *errmsg, int errret,
1245 uid_t euid, gid_t egid, pid_t pid, au_tid_t *tid);
1247 /* END au_write() WRAPPERS */
1251 * audit_token_to_au32()
1253 * @summary - Extract information from an audit_token_t, used to identify
1254 * Mach tasks and senders of Mach messages as subjects to the audit system.
1255 * audit_tokent_to_au32() is the only method that should be used to parse
1256 * an audit_token_t, since its internal representation may change over
1257 * time. A pointer parameter may be NULL if that information is not
1260 * @param atoken - the audit token containing the desired information
1262 * @param auidp - Pointer to a uid_t; on return will be set to the task or
1263 * sender's audit user ID
1265 * @param euidp - Pointer to a uid_t; on return will be set to the task or
1266 * sender's effective user ID
1268 * @param egidp - Pointer to a gid_t; on return will be set to the task or
1269 * sender's effective group ID
1271 * @param ruidp - Pointer to a uid_t; on return will be set to the task or
1272 * sender's real user ID
1274 * @param rgidp - Pointer to a gid_t; on return will be set to the task or
1275 * sender's real group ID
1277 * @param pidp - Pointer to a pid_t; on return will be set to the task or
1278 * sender's process ID
1280 * @param asidp - Pointer to an au_asid_t; on return will be set to the
1281 * task or sender's audit session ID
1283 * @param tidp - Pointer to an au_tid_t; on return will be set to the task
1284 * or sender's terminal ID
1286 * XXXRW: In Apple's bsm-8, these are marked __APPLE_API_PRIVATE.
1288 void audit_token_to_au32(
1289 audit_token_t atoken,
1298 #endif /* !__APPLE__ */
1301 * Wrapper functions to auditon(2).
1303 int audit_get_car(char *path, size_t sz);
1304 int audit_get_class(au_evclass_map_t *evc_map, size_t sz);
1305 int audit_set_class(au_evclass_map_t *evc_map, size_t sz);
1306 int audit_get_event(au_evname_map_t *evn_map, size_t sz);
1307 int audit_set_event(au_evname_map_t *evn_map, size_t sz);
1308 int audit_get_cond(int *cond);
1309 int audit_set_cond(int *cond);
1310 int audit_get_cwd(char *path, size_t sz);
1311 int audit_get_fsize(au_fstat_t *fstat, size_t sz);
1312 int audit_set_fsize(au_fstat_t *fstat, size_t sz);
1313 int audit_get_kmask(au_mask_t *kmask, size_t sz);
1314 int audit_set_kmask(au_mask_t *kmask, size_t sz);
1315 int audit_get_kaudit(auditinfo_addr_t *aia, size_t sz);
1316 int audit_set_kaudit(auditinfo_addr_t *aia, size_t sz);
1317 int audit_set_pmask(auditpinfo_t *api, size_t sz);
1318 int audit_get_pinfo(auditpinfo_t *api, size_t sz);
1319 int audit_get_pinfo_addr(auditpinfo_addr_t *apia, size_t sz);
1320 int audit_get_policy(int *policy);
1321 int audit_set_policy(int *policy);
1322 int audit_get_qctrl(au_qctrl_t *qctrl, size_t sz);
1323 int audit_set_qctrl(au_qctrl_t *qctrl, size_t sz);
1324 int audit_get_sinfo_addr(auditinfo_addr_t *aia, size_t sz);
1325 int audit_get_stat(au_stat_t *stats, size_t sz);
1326 int audit_set_stat(au_stat_t *stats, size_t sz);
1327 int audit_send_trigger(int *trigger);
1331 #endif /* !_LIBBSM_H_ */