2 .\" Copyright (c) 2006 Christian S.J. Peron
3 .\" All rights reserved.
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
15 .\" its contributors may be used to endorse or promote products derived
16 .\" from this software without specific prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 .\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
22 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
27 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
30 .\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/audit_submit.3#17 $
37 .Nd "general purpose audit record submission"
44 .Fa "short au_event" "au_id_t auid" "char status"
45 .Fa "int reterr" "const char * restrict format" ...
50 function provides a generic programming interface for audit record submission.
51 This audit record will contain a header, subject token, an optional text token,
52 return token, and a trailer.
53 The header will contain the event class specified by
55 The subject token will be generated based on
57 The return token is dependent on the
61 arguments; unlike the argument to
64 should be a local rather than BSM error number.
65 Optionally, a text token will be created as a part of this record.
67 Text token output is under the control of a
69 string that specifies how subsequent arguments (or arguments accessed via the
70 variable-length argument facilities of
72 are converted for output.
77 then no text token is created in the audit record.
79 It should be noted that
85 has already been called.
86 As a direct result, the terminal ID for the
87 subject will be retrieved from the kernel via
92 .Bd -literal -offset indent
93 #include <bsm/audit.h>
94 #include <bsm/libbsm.h>
95 #include <bsm/audit_uevents.h>
102 audit_bad_su(char *from_login, char *to_login)
104 struct auditinfo_addr aia;
109 error = getaudit_addr(&aia, sizeof(aia));
110 if (error < 0 && errno == ENOSYS) {
111 error = getaudit(&ai);
115 } else if (error < 0)
116 err(1, "getaudit_addr");
119 error = audit_submit(AUE_su, aid, EPERM, 1,
120 "bad su from %s to %s", from_login, to_login);
122 err(1, "audit_submit");
126 Will generate the following audit record:
127 .Bd -literal -offset indent
128 header,94,1,su(1),0,Mon Apr 17 23:23:59 2006, + 271 msec
129 subject,root,root,wheel,root,wheel,652,652,0,0.0.0.0
130 text,bad su from from csjp to root
131 return,failure : Operation not permitted,1
138 Otherwise a -1 is returned and the global variable
140 is set to indicate the error.
149 function first appeared in OpenBSM version 1.0.
150 OpenBSM 1.0 was introduced in
155 function was written by
156 .An Christian S.J. Peron Aq csjp@FreeBSD.org .