contrib/openbsm/libbsm/libbsm.3

   1 .\"-
   2 .\" Copyright (c) 2005-2007 Robert N. M. Watson
   3 .\" Copyright (c) 2008-2009 Apple Inc.
   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.
  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 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS 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 AUTHORS 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
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .Dd March 5, 2009
  28 .Dt LIBBSM 3
  29 .Os
  30 .Sh NAME
  31 .Nm libbsm
  32 .Nd "Basic Security Module (BSM) Audit API"
  33 .Sh LIBRARY
  34 .Lb libbsm
  35 .Sh SYNOPSIS
  36 .In bsm/libbsm.h
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 library routines provide an interface to BSM audit record streams, allowing
  41 both the parsing of existing audit streams, as well as the creation of new
  42 audit records and streams.
  43 .Sh INTERFACES
  44 The
  45 .Nm
  46 library
  47 provides a large number of Audit programming interfaces in several classes:
  48 event stream interfaces, class interfaces, control interfaces, event
  49 interfaces, I/O interfaces, mask interfaces, notification interfaces, token
  50 interfaces, and user interfaces.
  51 These are described respectively in the
  52 .Xr au_class 3 ,
  53 .Xr au_control 3 ,
  54 .Xr au_event 3 ,
  55 .Xr au_mask 3 ,
  56 .Xr au_notify 3 ,
  57 .Xr au_stream 3 ,
  58 .Xr au_token 3 ,
  59 and
  60 .Xr au_user 3
  61 manual pages.
  62 .Ss Audit Event Stream Interfaces
  63 Audit event stream interfaces support interaction with file-backed audit
  64 event streams:
  65 .Xr au_close 3 ,
  66 .Xr au_close_buffer 3 ,
  67 .Xr au_free_token 3 ,
  68 .Xr au_open 3 ,
  69 .Xr au_write 3 ,
  70 .Xr audit_submit 3 .
  71 .Ss Audit Class Interfaces
  72 Audit class interfaces support the look up of information from the
  73 .Xr audit_class 5
  74 database:
  75 .Xr endauclass 3 ,
  76 .Xr getauclassent 3 ,
  77 .Xr getauclassent_r 3 ,
  78 .Xr getauclassnam 3 ,
  79 .Xr getauclassnam_r 3 ,
  80 .Xr setauclass 3 .
  81 .Ss Audit Control Interfaces
  82 Audit control interfaces support the look up of information from the
  83 .Xr audit_control 5
  84 database:
  85 .Xr endac 3 ,
  86 .Xr setac 3 ,
  87 .Xr getacdir 3 ,
  88 .Xr getacfilesz 3 ,
  89 .Xr getacflg 3 ,
  90 .Xr getacmin 3 ,
  91 .Xr getacna 3 ,
  92 .Xr getacpol 3 ,
  93 .Xr au_poltostr 3 ,
  94 .Xr au_strtopol 3 .
  95 .Ss Audit Event Interfaces
  96 Audit event interfaces support the look up of information from the
  97 .Xr audit_event 5
  98 database:
  99 .Xr endauevent 3 ,
 100 .Xr setauevent 3 ,
 101 .Xr getauevent 3 ,
 102 .Xr getauevent_r 3 ,
 103 .Xr getauevnam 3 ,
 104 .Xr getauevnam_r 3 ,
 105 .Xr getauevnonam 3 ,
 106 .Xr getauevnonam_r 3 ,
 107 .Xr getauevnum 3 ,
 108 .Xr getauevnum_r 3 .
 109 .Ss Audit I/O Interfaces
 110 Audit I/O interfaces support the processing and printing of tokens, as well
 111 as the reading of audit records:
 112 .Xr au_fetch_tok 3 ,
 113 .Xr au_print_tok 3 ,
 114 .Xr au_read_rec 3 .
 115 .Ss Audit Mask Interfaces
 116 Audit mask interfaces convert support the conversion between strings and
 117 .Vt au_mask_t
 118 values.
 119 They may also be used to determine if a particular audit event is matched
 120 by a mask:
 121 .Xr au_preselect 3 ,
 122 .Xr getauditflagsbin 3 ,
 123 .Xr getauditflagschar 3 .
 124 .Ss Audit Notification Interfaces
 125 Audit notification routines track audit state in a form permitting efficient
 126 update, avoiding frequent system calls to check the kernel audit state:
 127 .Xr au_get_state 3 ,
 128 .Xr au_notify_initialize 3 ,
 129 .Xr au_notify_terminate 3 .
 130 These interfaces are implemented only for Darwin/Mac OS X.
 131 .Ss Audit Token Interface
 132 Audit token interfaces permit the creation of tokens for use in creating
 133 audit records for submission to event streams.
 134 Each interface converts a C type to its
 135 .Vt token_t
 136 representation:
 137 .Xr au_to_arg 3 ,
 138 .Xr au_to_arg32 3 ,
 139 .Xr au_to_arg64 3 ,
 140 .Xr au_to_attr64 3 ,
 141 .Xr au_to_data 3 ,
 142 .Xr au_to_exec_args 3 ,
 143 .Xr au_to_exec_env 3 ,
 144 .Xr au_to_exit 3 ,
 145 .Xr au_to_file 3 ,
 146 .Xr au_to_groups 3 ,
 147 .Xr au_to_header32 3 ,
 148 .Xr au_to_header64 3 ,
 149 .Xr au_to_in_addr 3 ,
 150 .Xr au_to_in_addr_ex 3 ,
 151 .Xr au_to_ip 3 ,
 152 .Xr au_to_ipc 3 ,
 153 .Xr au_to_ipc_perm 3 ,
 154 .Xr au_to_iport 3 ,
 155 .Xr au_to_me 3 ,
 156 .Xr au_to_newgroups 3 ,
 157 .Xr au_to_opaque 3 ,
 158 .Xr au_to_path 3 ,
 159 .Xr au_to_process 3 ,
 160 .Xr au_to_process32 3 ,
 161 .Xr au_to_process64 3 ,
 162 .Xr au_to_process_ex 3 ,
 163 .Xr au_to_process32_ex 3 ,
 164 .Xr au_to_process64_ex 3 ,
 165 .Xr au_to_return 3 ,
 166 .Xr au_to_return32 3 ,
 167 .Xr au_to_return64 3 ,
 168 .Xr au_to_seq 3 ,
 169 .Xr au_to_sock_inet 3 ,
 170 .Xr au_to_sock_inet32 3 ,
 171 .Xr au_to_sock_inet128 3 ,
 172 .Xr au_to_socket_ex 3 ,
 173 .Xr au_to_subject 3 ,
 174 .Xr au_to_subject32 3 ,
 175 .Xr au_to_subject64 3 ,
 176 .Xr au_to_subject_ex 3 ,
 177 .Xr au_to_subject32_ex 3 ,
 178 .Xr au_to_subject64_ex 3 ,
 179 .Xr au_to_text 3 ,
 180 .Xr au_to_trailer 3 ,
 181 .Xr au_to_zonename 3 .
 182 .Ss Audit User Interfaces
 183 Audit user interfaces support the look up of information from the
 184 .Xr audit_user 5
 185 database:
 186 .Xr au_user_mask 3 ,
 187 .Xr endauuser 3 ,
 188 .Xr setauuser 3 ,
 189 .Xr getauuserent 3 ,
 190 .Xr getauuserent_r 3 ,
 191 .Xr getauusernam 3 ,
 192 .Xr getauusernam_r 3 ,
 193 .Xr getfauditflags 3 .
 194 .Ss Audit Constant Conversion Interfaces
 195 These functions convert between BSM and local constants, including the
 196 .Xr errno 2
 197 number, socket type, and protocol famil spaces, and must be used to generate
 198 and interpret BSM return and extended socket tokens:
 199 .Xr au_bsm_to_domain 3 ,
 200 .Xr au_bsm_to_errno 3 ,
 201 .Xr au_bsm_to_fcntl_cmd 3 ,
 202 .Xr au_bsm_to_socket_type 3 ,
 203 .Xr au_domain_to_bsm 3 ,
 204 .Xr au_errno_to_bsm 3 ,
 205 .Xr au_fcntl_cmd_to_bsm 3 ,
 206 .Xr au_socket_type_to_bsm 3 .
 207 .Sh SEE ALSO
 208 .Xr au_class 3 ,
 209 .Xr au_domain 3 ,
 210 .Xr au_errno 3 ,
 211 .Xr au_mask 3 ,
 212 .Xr au_notify 3 ,
 213 .Xr au_socket_type 3 ,
 214 .Xr au_stream 3 ,
 215 .Xr au_token 3 ,
 216 .Xr au_user 3 ,
 217 .Xr audit_submit 3 ,
 218 .Xr audit_class 5 ,
 219 .Xr audit_control 5
 220 .Sh HISTORY
 221 The OpenBSM implementation was created by McAfee Research, the security
 222 division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
 223 It was subsequently adopted by the TrustedBSD Project as the foundation for
 224 the OpenBSM distribution.
 225 .Sh AUTHORS
 226 .An -nosplit
 227 This software was created by
 228 .An Robert Watson ,
 229 .An Wayne Salamon ,
 230 and
 231 .An Suresh Krishnaswamy
 232 for McAfee Research, the security research division of McAfee,
 233 Inc., under contract to Apple Computer, Inc.
 234 .Pp
 235 The Basic Security Module (BSM) interface to audit records and audit event
 236 stream format were defined by Sun Microsystems.
 237 .Sh BUGS
 238 Bugs would not be unlikely.
 239 .Pp
 240 The
 241 .Nm
 242 library implementations are generally thread-safe, but not reentrant.
 243 .Pp
 244 The assignment of routines to classes could use some work, as it is
 245 decidely ad hoc.
 246 For example,
 247 .Fn au_read_rec
 248 should probably be considered a stream routine.