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.
15 .\" THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 .\" ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
19 .\" ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
23 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
24 .\" IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
27 .\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/audit_submit.3#19 $
34 .Nd "general purpose audit record submission"
41 .Fa "short au_event" "au_id_t auid" "char status"
42 .Fa "int reterr" "const char * restrict format" ...
47 function provides a generic programming interface for audit record submission.
48 This audit record will contain a header, subject token, an optional text token,
49 return token, and a trailer.
50 The header will contain the event class specified by
52 The subject token will be generated based on
54 The return token is dependent on the
58 arguments; unlike the argument to
61 should be a local rather than BSM error number.
62 Optionally, a text token will be created as a part of this record.
64 Text token output is under the control of a
66 string that specifies how subsequent arguments (or arguments accessed via the
67 variable-length argument facilities of
69 are converted for output.
74 then no text token is created in the audit record.
76 It should be noted that
82 has already been called.
83 As a direct result, the terminal ID for the
84 subject will be retrieved from the kernel via
92 Otherwise a -1 is returned and the global variable
94 is set to indicate the error.
96 .Bd -literal -offset indent
97 #include <bsm/audit.h>
98 #include <bsm/libbsm.h>
99 #include <bsm/audit_uevents.h>
106 audit_bad_su(char *from_login, char *to_login)
108 struct auditinfo_addr aia;
113 error = getaudit_addr(&aia, sizeof(aia));
114 if (error < 0 && errno == ENOSYS) {
115 error = getaudit(&ai);
119 } else if (error < 0)
120 err(1, "getaudit_addr");
123 error = audit_submit(AUE_su, aid, EPERM, 1,
124 "bad su from %s to %s", from_login, to_login);
126 err(1, "audit_submit");
130 Will generate the following audit record:
131 .Bd -literal -offset indent
132 header,94,1,su(1),0,Mon Apr 17 23:23:59 2006, + 271 msec
133 subject,root,root,wheel,root,wheel,652,652,0,0.0.0.0
134 text,bad su from from csjp to root
135 return,failure : Operation not permitted,1
146 function first appeared in OpenBSM version 1.0.
147 OpenBSM 1.0 was introduced in
152 function was written by
153 .An Christian S.J. Peron Aq csjp@FreeBSD.org .