contrib/openbsm/libbsm/au_io.3

   1 .\"-
   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.
  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 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  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 .\"
  26 .\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_io.3#5 $
  27 .\"
  28 .Dd April 19, 2005
  29 .Dt AU_IO 3
  30 .Os
  31 .Sh NAME
  32 .Nm au_fetch_tok ,
  33 .Nm au_print_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
  46 .Ft int
  47 .Fn au_read_rec "FILE *fp" "u_char **buf"
  48 .Sh DESCRIPTION
  49 These interfaces support input and output (I/O) involving audit records,
  50 internalizing an audit record from a byte stream, converting a token to
  51 either a raw or default string, and reading a single record from a file.
  52 .Pp
  53 The
  54 .Fn au_fetch_tok
  55 function
  56 reads a token from the passed buffer
  57 .Fa buf
  58 of length
  59 .Fa len
  60 bytes, and returns a pointer to the token via
  61 .Fa tok .
  62 .Pp
  63 The
  64 .Fn au_print_tok
  65 function
  66 prints a string form of the token
  67 .Fa tok
  68 to the file output stream
  69 .Fa outfp ,
  70 either in default mode, or raw mode if
  71 .Fa raw
  72 is set non-zero.
  73 The delimiter
  74 .Fa del
  75 is used when printing.
  76 .Pp
  77 The
  78 .Fn au_read_rec
  79 function
  80 reads an audit record from the file stream
  81 .Fa fp ,
  82 and returns an allocated memory buffer containing the record via
  83 .Fa *buf ,
  84 which must be freed by the caller using
  85 .Xr free 3 .
  86 .Pp
  87 A typical use of these routines might open a file with
  88 .Xr fopen 3 ,
  89 then read records from the file sequentially by calling
  90 .Fn au_read_rec .
  91 Each record would be broken down into components tokens through sequential
  92 calls to
  93 .Fn au_fetch_tok
  94 on the buffer, and then invoking
  95 .Fn au_print_tok
  96 to print each token to an output stream such as
  97 .Dv stdout .
  98 On completion of the processing of each record, a call to
  99 .Xr free 3
 100 would be used to free the record buffer.
 101 Finally, the source stream would be closed by a call to
 102 .Xr fclose 3 .
 103 .Sh RETURN VALUES
 104 The
 105 .Fn au_fetch_tok
 106 and
 107 .Fn au_read_rec
 108 functions
 109 return 0 on success, or \-1 on failure along with additional error information
 110 returned via
 111 .Va errno .
 112 .Sh SEE ALSO
 113 .Xr free 3 ,
 114 .Xr libbsm 3
 115 .Sh HISTORY
 116 The OpenBSM implementation was created by McAfee Research, the security
 117 division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
 118 It was subsequently adopted by the TrustedBSD Project as the foundation for
 119 the OpenBSM distribution.
 120 .Sh AUTHORS
 121 .An -nosplit
 122 This software was created by
 123 .An Robert Watson ,
 124 .An Wayne Salamon ,
 125 and
 126 .An Suresh Krishnaswamy
 127 for McAfee Research, the security research division of McAfee,
 128 Inc., under contract to Apple Computer, Inc.
 129 .Pp
 130 The Basic Security Module (BSM) interface to audit records and audit event
 131 stream format were defined by Sun Microsystems.
 132 .Sh BUGS
 133 The
 134 .Va errno
 135 variable
 136 may not always be properly set in the event of an error.