| au_io.3 (168778) | au_io.3 (243750) |
|---|---|
| 1.\"- | 1.\"- |
| 2.\" Copyright (c) 2009 Apple, Inc. |
|
| 2.\" Copyright (c) 2005 Robert N. M. Watson 3.\" All rights reserved. 4.\" 5.\" Redistribution and use in source and binary forms, with or without 6.\" modification, are permitted provided that the following conditions 7.\" are met: 8.\" 1. Redistributions of source code must retain the above copyright 9.\" notice, this list of conditions and the following disclaimer. --- 8 unchanged lines hidden (view full) --- 18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24.\" SUCH DAMAGE. 25.\" | 3.\" Copyright (c) 2005 Robert N. M. Watson 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. --- 8 unchanged lines hidden (view full) --- 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 25.\" SUCH DAMAGE. 26.\" |
| 26.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_io.3#5 $ | 27.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_io.3#9 $ |
| 27.\" | 28.\" |
| 28.Dd April 19, 2005 | 29.Dd August 4, 2009 |
| 29.Dt AU_IO 3 30.Os 31.Sh NAME 32.Nm au_fetch_tok , 33.Nm au_print_tok , | 30.Dt AU_IO 3 31.Os 32.Sh NAME 33.Nm au_fetch_tok , 34.Nm au_print_tok , |
| 35.Nm au_print_flags_tok , |
|
| 34.Nm au_read_rec 35.Nd "perform I/O involving an audit record" 36.Sh LIBRARY 37.Lb libbsm 38.Sh SYNOPSIS 39.In bsm/libbsm.h 40.Ft int 41.Fn au_fetch_tok "tokenstr_t *tok" "u_char *buf" "int len" 42.Ft void 43.Fo au_print_tok 44.Fa "FILE *outfp" "tokenstr_t *tok" "char *del" "char raw" "char sfrm" 45.Fc | 36.Nm au_read_rec 37.Nd "perform I/O involving an audit record" 38.Sh LIBRARY 39.Lb libbsm 40.Sh SYNOPSIS 41.In bsm/libbsm.h 42.Ft int 43.Fn au_fetch_tok "tokenstr_t *tok" "u_char *buf" "int len" 44.Ft void 45.Fo au_print_tok 46.Fa "FILE *outfp" "tokenstr_t *tok" "char *del" "char raw" "char sfrm" 47.Fc |
| 48.Ft void 49.Fo au_print_flags_tok 50.Fa "FILE *outfp" "tokenstr_t *tok" "char *del" "int oflags" 51.Fc |
|
| 46.Ft int 47.Fn au_read_rec "FILE *fp" "u_char **buf" 48.Sh DESCRIPTION 49These interfaces support input and output (I/O) involving audit records, 50internalizing an audit record from a byte stream, converting a token to 51either a raw or default string, and reading a single record from a file. 52.Pp 53The --- 14 unchanged lines hidden (view full) --- 68to the file output stream 69.Fa outfp , 70either in default mode, or raw mode if 71.Fa raw 72is set non-zero. 73The delimiter 74.Fa del 75is used when printing. | 52.Ft int 53.Fn au_read_rec "FILE *fp" "u_char **buf" 54.Sh DESCRIPTION 55These interfaces support input and output (I/O) involving audit records, 56internalizing an audit record from a byte stream, converting a token to 57either a raw or default string, and reading a single record from a file. 58.Pp 59The --- 14 unchanged lines hidden (view full) --- 74to the file output stream 75.Fa outfp , 76either in default mode, or raw mode if 77.Fa raw 78is set non-zero. 79The delimiter 80.Fa del 81is used when printing. |
| 82The 83.Fn au_print_flags_tok 84function is a replacement for 85.Fn au_print_tok . 86The 87.Fa oflags 88controls how the output should be formatted and is specified by 89or'ing the following flags: |
|
| 76.Pp | 90.Pp |
| 91.Bl -tag -width AU_OFLAG_NORESOLVE -compact -offset indent 92.It Li AU_OFLAG_NONE 93Use the default form. 94.It Li AU_OFLAG_NORESOLVE 95Leave user and group IDs in their numeric form. 96.It Li AU_OFLAG_RAW 97Use the raw, numeric form. 98.It Li AU_OFLAG_SHORT 99Use the short form. 100.It Li AU_OFLAG_XML 101Use the XML form. 102.El 103.Pp 104The flags options AU_OFLAG_SHORT and AU_OFLAG_RAW are exclusive and 105should not be used together. 106.Pp |
|
| 77The 78.Fn au_read_rec 79function 80reads an audit record from the file stream 81.Fa fp , 82and returns an allocated memory buffer containing the record via 83.Fa *buf , 84which must be freed by the caller using 85.Xr free 3 . 86.Pp 87A typical use of these routines might open a file with 88.Xr fopen 3 , 89then read records from the file sequentially by calling 90.Fn au_read_rec . 91Each record would be broken down into components tokens through sequential 92calls to 93.Fn au_fetch_tok 94on the buffer, and then invoking | 107The 108.Fn au_read_rec 109function 110reads an audit record from the file stream 111.Fa fp , 112and returns an allocated memory buffer containing the record via 113.Fa *buf , 114which must be freed by the caller using 115.Xr free 3 . 116.Pp 117A typical use of these routines might open a file with 118.Xr fopen 3 , 119then read records from the file sequentially by calling 120.Fn au_read_rec . 121Each record would be broken down into components tokens through sequential 122calls to 123.Fn au_fetch_tok 124on the buffer, and then invoking |
| 95.Fn au_print_tok | 125.Fn au_print_flags_tok |
| 96to print each token to an output stream such as 97.Dv stdout . 98On completion of the processing of each record, a call to 99.Xr free 3 100would be used to free the record buffer. 101Finally, the source stream would be closed by a call to 102.Xr fclose 3 . 103.Sh RETURN VALUES --- 8 unchanged lines hidden (view full) --- 112.Sh SEE ALSO 113.Xr free 3 , 114.Xr libbsm 3 115.Sh HISTORY 116The OpenBSM implementation was created by McAfee Research, the security 117division of McAfee Inc., under contract to Apple Computer, Inc., in 2004. 118It was subsequently adopted by the TrustedBSD Project as the foundation for 119the OpenBSM distribution. | 126to print each token to an output stream such as 127.Dv stdout . 128On completion of the processing of each record, a call to 129.Xr free 3 130would be used to free the record buffer. 131Finally, the source stream would be closed by a call to 132.Xr fclose 3 . 133.Sh RETURN VALUES --- 8 unchanged lines hidden (view full) --- 142.Sh SEE ALSO 143.Xr free 3 , 144.Xr libbsm 3 145.Sh HISTORY 146The OpenBSM implementation was created by McAfee Research, the security 147division of McAfee Inc., under contract to Apple Computer, Inc., in 2004. 148It was subsequently adopted by the TrustedBSD Project as the foundation for 149the OpenBSM distribution. |
| 150.Pp 151The 152.Fn au_print_flags_tok 153function was added by Stacey Son as a replacement for the 154.Fn au_print_tok 155so new output formatting flags can be easily added without changing the API. 156The 157.Fn au_print_tok 158is obsolete but remains in the API to support legacy code. |
|
| 120.Sh AUTHORS 121.An -nosplit 122This software was created by 123.An Robert Watson , 124.An Wayne Salamon , 125and 126.An Suresh Krishnaswamy 127for McAfee Research, the security research division of McAfee, 128Inc., under contract to Apple Computer, Inc. 129.Pp 130The Basic Security Module (BSM) interface to audit records and audit event 131stream format were defined by Sun Microsystems. 132.Sh BUGS 133The 134.Va errno 135variable 136may not always be properly set in the event of an error. | 159.Sh AUTHORS 160.An -nosplit 161This software was created by 162.An Robert Watson , 163.An Wayne Salamon , 164and 165.An Suresh Krishnaswamy 166for McAfee Research, the security research division of McAfee, 167Inc., under contract to Apple Computer, Inc. 168.Pp 169The Basic Security Module (BSM) interface to audit records and audit event 170stream format were defined by Sun Microsystems. 171.Sh BUGS 172The 173.Va errno 174variable 175may not always be properly set in the event of an error. |