share/man/man4/auditpipe.4

   1 .\" Copyright (c) 2006 Robert N. M. Watson
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd May 5, 2006
  28 .Os
  29 .Dt AUDITPIPE 4
  30 .Sh NAME
  31 .Nm auditpipe
  32 .Nd Pseudo-device for live audit event tracking
  33 .Sh SYNOPSIS
  34 .Cd "options AUDIT"
  35 .Sh DESCRIPTION
  36 While audit trail files
  37 generated with
  38 .Xr audit 4
  39 and maintained by
  40 .Xr auditd 8
  41 provide a reliable long-term store for audit log information, current log
  42 files are owned by the audit daemon until terminated making them somewhat
  43 unwieldy for live monitoring applications such as host-based intrusion
  44 detection.
  45 For example, the log may be cycled and new records written to a new file
  46 without notice to applications that may be accessing the file.
  47 .Pp
  48 The audit facility provides an audit pipe facility for applications requiring
  49 direct access to live BSM audit data for the purposes of real-time
  50 monitoring.
  51 Audit pipes are available via a clonable special device,
  52 .Pa /dev/auditpipe ,
  53 subject to the permissions on the device node, and provide a
  54 .Qq tee
  55 of the audit event stream.
  56 As the device is clonable, more than one instance of the device may be opened
  57 at a time; each device instance will provide independent access to all
  58 records.
  59 .Pp
  60 The audit pipe device provides discrete BSM audit records; if the read buffer
  61 passed by the application is too small to hold the next record in the
  62 sequence, it will be dropped.
  63 Unlike audit data written to the audit trail, the reliability of record
  64 delivery is not guaranteed.
  65 In particular, when an audit pipe queue fills, records will be dropped.
  66 Audit pipe devices are blocking by default, but support non-blocking I/O,
  67 asynchronous I/O using SIGIO, and polled operation via
  68 .Xr select 2
  69 and
  70 .Xr poll 2 .
  71 .Pp
  72 Applications may choose to track the global audit trail, or configure local
  73 preselection parameters independent of the global audit trail parameters.
  74 .Ss Audit Pipe Queue Ioctls
  75 The following ioctls retrieve and set various audit pipe record queue
  76 properties:
  77 .Bl -tag -width AUDITPIPE_GET_MAXAUDITDATA
  78 .It AUDITPIPE_GET_QLEN
  79 Query the current number of records available for reading on the pipe.
  80 .It AUDITPIPE_GET_QLIMIT
  81 Retrieve the current maximum number of records that may be queued for reading
  82 on the pipe.
  83 .It AUDITPIPE_SET_QLIMIT
  84 Set the current maximum number of records that may be queued for reading on
  85 the pipe.
  86 The new limit must fall between the queue limit minimum and queue limit
  87 maximum queryable using the following two ioctls.
  88 .It AUDITPIPE_GET_QLIMIT_MIN
  89 Query the lowest possible maximum number of records that may be queued for
  90 reading on the pipe.
  91 .It AUDITPIPE_GET_QLIMIT_MAX
  92 Query the highest possible maximum number of records that may be queued for
  93 reading on the pipe.
  94 .It AUDITPIPE_FLUSH
  95 Flush all outstanding records on the audit pipe; useful after setting initial
  96 preselection properties to delete records queued during the configuration
  97 process which may not match the interests of the user process.
  98 .It AUDITPIPE_GET_MAXAUDITDATA
  99 Query the maximum size of an audit record, which is a useful minimum size for
 100 a user space buffer intended to hold audit records read from the audit pipe.
 101 .El
 102 .Ss Audit Pipe Preselection Mode Ioctls
 103 By default, the audit pipe facility configures pipes to present records
 104 matched by the system-wide audit trail, configured by
 105 .Xr auditd 8 .
 106 However, the preselection mechanism for audit pipes can be configured using
 107 alternative criteria, including pipe-local flags and naflags settings, as
 108 well as auid-specific selection masks.
 109 This allows applications to track events not captured in the global audit
 110 trail, as well as limit records presented to those of specific interest to
 111 the application.
 112 .Pp
 113 The following ioctls configure the preselection mode on an audit pipe:
 114 .Bl -tag -width AUDITPIPE_GET_PRESELECT_MODE
 115 .It AUDITPIPE_GET_PRESELECT_MODE
 116 Return the current preselect mode on the audit pipe.
 117 The ioctl argument should be of type
 118 .Vt int .
 119 .It AUDITPIPE_SET_PRESELECT_MODE
 120 Set the current preselection mode on the audit pipe.
 121 The ioctl argument should be of type
 122 .Vt int .
 123 .El
 124 .Pp
 125 Possible preselection mode values are:
 126 .Bl -tag -width AUDITPIPE_PRESELECT_MODE_TRAIL
 127 .It AUDITPIPE_PRESELECT_MODE_TRAIL
 128 Use the global audit trail preselection parameters to select records for the
 129 audit pipe.
 130 .It AUDITPIPE_PRESELECT_MODE_LOCAL
 131 Use local audit pipe preselection; this model is similar to the global audit
 132 trail configuration model, consisting of global flags and naflags parameters,
 133 as well as a set of per-auid masks.
 134 These parameters are configured using further ioctls.
 135 .El
 136 .Pp
 137 After changing the audit pipe preselection mode, records selected under
 138 earlier preselection configuration may still be in the audit pipe queue.
 139 The application may flush the current record queue after changing the
 140 configuration to remove possibly undesired records.
 141 .Ss Audit Pipe Local Preselection Mode Ioctls
 142 The following ioctls configure the preselection parameters used when an audit
 143 pipe is configured for the
 144 .Dv AUDITPIPE_PRESELECT_MODE_LOCAL
 145 preselection mode.
 146 .Bl -tag -width AUDITPIPE_GET_PRESELECT_NAFLAGS
 147 .It AUDITPIPE_GET_PRESELECT_FLAGS
 148 Retrieve the current default preselection flags for attributable events on
 149 the pipe.
 150 These flags correspond to the
 151 .Dv flags
 152 field in
 153 .Xr audit_control 5 .
 154 The ioctl argument should be of type
 155 .Vt u_int .
 156 .It AUDITPIPE_SET_PRESELECT_FLAGS
 157 Set the current default preselection flags for attributable events on the
 158 pipe.
 159 These flags correspond to the
 160 .Dv flags
 161 field in
 162 .Xr audit_control 5 .
 163 The ioctl argument should be of type
 164 .Vt u_int .
 165 .It AUDITPIPE_GET_PRESELECT_NAFLAGS
 166 Retrieve the current default preselection flags for non-attributable events
 167 on the pipe.
 168 These flags correspond to the
 169 .Dv naflags
 170 field in
 171 .Xr audit_control 5 .
 172 The ioctl argument should be of type
 173 .Vt u_int .
 174 .It AUDITPIPE_SET_PRESELECT_NAFLAGS
 175 Set the current default preselection flags for non-attributable events on the
 176 pipe.
 177 These flags correspond to the
 178 .Dv naflags
 179 field in
 180 .Xr audit_control 5 .
 181 The ioctl argument should be of type
 182 .Vt u_int .
 183 .It AUDITPIPE_GET_PRESELECT_AUID
 184 Query the current preselection masks for a specific auid on the pipe.
 185 The ioctl argument should be of type
 186 .Vt struct auditpipe_preselect .
 187 The auid to query is specified via the
 188 .Va ap_auid
 189 field of type
 190 .Vt au_id_t ;
 191 the mask will be returned via
 192 .Va ap_mask
 193 of type
 194 .Vt au_mask_t .
 195 .It AUDITPIPE_SET_PRESELECT_AUID
 196 Set the current preselection masks for a specific auid on the pipe.
 197 Arguments are identical to
 198 .Dv AUDITPIPE_GET_PRESELECT_AUID,
 199 except that the caller should properly initialize the
 200 .Va ap_mask
 201 field to hold the desired preselection mask.
 202 .It AUDITPIPE_DELETE_PRESELECT_AUID
 203 Delete the current preselection mask for a specific auid on the pipe.
 204 Once called, events associated with the specified auid will use the default
 205 flags mask.
 206 The ioctl argument should be of type
 207 .Vt au_id_t .
 208 .It AUDITPIPE_FLUSH_PRESELECT_AUID
 209 Delete all auid specific preselection specifications.
 210 .El
 211 .Sh EXAMPLES
 212 .Xr praudit 1
 213 may be directly executed on
 214 .Pa /dev/auditpipe
 215 to review the default audit trail.
 216 .Sh SEE ALSO
 217 .Xr poll 2 ,
 218 .Xr select 2 ,
 219 .Xr audit 4 ,
 220 .Xr audit_control 5 ,
 221 .Xr audit 8 ,
 222 .Xr auditd 8
 223 .Sh AUTHORS
 224 The audit pipe facility was designed and implemented by
 225 .An Robert Watson Aq rwatson@FreeBSD.org .
 226 .Pp
 227 The Basic Security Module (BSM) interface to audit records and audit event
 228 stream format were defined by Sun Microsystems.
 229 .Sh HISTORY
 230 The OpenBSM implementation was created by McAfee Research, the security
 231 division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
 232 It was subsequently adopted by the TrustedBSD Project as the foundation for
 233 the OpenBSM distribution.
 234 .Pp
 235 Support for kernel audit first appeared in
 236 .Fx 6.2 .
 237 .Sh BUGS
 238 See the
 239 .Xr audit 4
 240 manual page for information on audit-related bugs and limitations.
 241 .Pp
 242 The configurable preselection mechanism mirrors the selection model present
 243 for the global audit trail.
 244 It might be desirable to provided a more flexible selection model.
 245 .Pp
 246 The per-pipe audit event queue is fifo, with drops occuring if either the
 247 user thread provides in sufficient for the record on the queue head, or on
 248 enqueue if there is insufficient room.
 249 It might be desirable to support partial reads of records, which would be
 250 more compatible with buffered I/O as implemented in system libraries, and to
 251 allow applications to select which records are dropped, possibly in the style
 252 of preselection.