2 .\" Copyright (c) 2009 Apple, Inc.
3 .\" Copyright (c) 2005 Robert N. M. Watson
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" 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 THE AUTHOR AND 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 THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 .\" FOR 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, STRICT
23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 .\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_io.3#9 $
35 .Nm au_print_flags_tok ,
37 .Nd "perform I/O involving an audit record"
43 .Fn au_fetch_tok "tokenstr_t *tok" "u_char *buf" "int len"
46 .Fa "FILE *outfp" "tokenstr_t *tok" "char *del" "char raw" "char sfrm"
49 .Fo au_print_flags_tok
50 .Fa "FILE *outfp" "tokenstr_t *tok" "char *del" "int oflags"
53 .Fn au_read_rec "FILE *fp" "u_char **buf"
55 These interfaces support input and output (I/O) involving audit records,
56 internalizing an audit record from a byte stream, converting a token to
57 either a raw or default string, and reading a single record from a file.
62 reads a token from the passed buffer
66 bytes, and returns a pointer to the token via
72 prints a string form of the token
74 to the file output stream
76 either in default mode, or raw mode if
81 is used when printing.
83 .Fn au_print_flags_tok
84 function is a replacement for
88 controls how the output should be formatted and is specified by
89 or'ing the following flags:
91 .Bl -tag -width AU_OFLAG_NORESOLVE -compact -offset indent
94 .It Li AU_OFLAG_NORESOLVE
95 Leave user and group IDs in their numeric form.
97 Use the raw, numeric form.
104 The flags options AU_OFLAG_SHORT and AU_OFLAG_RAW are exclusive and
105 should not be used together.
110 reads an audit record from the file stream
112 and returns an allocated memory buffer containing the record via
114 which must be freed by the caller using
117 A typical use of these routines might open a file with
119 then read records from the file sequentially by calling
121 Each record would be broken down into components tokens through sequential
124 on the buffer, and then invoking
125 .Fn au_print_flags_tok
126 to print each token to an output stream such as
128 On completion of the processing of each record, a call to
130 would be used to free the record buffer.
131 Finally, the source stream would be closed by a call to
139 return 0 on success, or \-1 on failure along with additional error information
146 The OpenBSM implementation was created by McAfee Research, the security
147 division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
148 It was subsequently adopted by the TrustedBSD Project as the foundation for
149 the OpenBSM distribution.
152 .Fn au_print_flags_tok
153 function was added by Stacey Son as a replacement for the
155 so new output formatting flags can be easily added without changing the API.
158 is obsolete but remains in the API to support legacy code.
161 This software was created by
165 .An Suresh Krishnaswamy
166 for McAfee Research, the security research division of McAfee,
167 Inc., under contract to Apple Computer, Inc.
169 The Basic Security Module (BSM) interface to audit records and audit event
170 stream format were defined by Sun Microsystems.
175 may not always be properly set in the event of an error.