usr/src/man/man5/audit_binfile.5

   1 '\" te
   2 .\" Copyright (c) 2017 Peter Tribble
   3 .\"  Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   5 .\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
   6 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH AUDIT_BINFILE 5 "Mar 6, 2017"
   8 .SH NAME
   9 audit_binfile \- generation of audit logs
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fB/usr/lib/security/audit_binfile.so\fR
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .LP
  18 The \fBaudit_binfile\fR plugin module for audit,
  19 \fB/usr/lib/security/audit_binfile.so\fR, writes binary audit data to files as
  20 specified in the plugin's attributes configured by \fBauditconfig\fR(1M); it
  21 is the default plugin for the audit daemon \fBauditd\fR(1M). Its output is
  22 described by \fBaudit.log\fR(4).
  23 .SH OBJECT ATTRIBUTES
  24 .LP
  25 The \fBp_dir\fR attribute specifies a comma-separated list of
  26 directories to be used for storing audit files.
  27 .sp
  28 .LP
  29 The \fBp_minfree\fR attribute specifies the percentage of free space required.
  30 If free space falls below this threshold, the audit daemon \fBauditd\fR(1M)
  31 invokes the shell script \fBaudit_warn\fR(1M). The default threshold is 0%.
  32 .sp
  33 .LP
  34 The \fBp_fsize\fR attribute defines the maximum size in bytes that an audit
  35 file can become before it is automatically closed and a new audit file opened.
  36 This is equivalent to an administrator issuing an \fBaudit\fR \fB-n\fR command
  37 when the audit file contains the specified number of bytes. The default size is
  38 zero (0), which allows the file to grow without bound. The value specified must
  39 be within the range of [512,000, 2,147,483,647].
  40 .SH EXAMPLES
  41 .LP
  42 The following commands cause \fBaudit_binfile.so\fR to be activated, specify the
  43 directories for writing audit logs, and specify the percentage of required free
  44 space per directory. Note that using \fBauditconfig\fR(1M) only allows one
  45 attribute to be set at a time.
  46 .sp
  47 .in +2
  48 .nf
  49 # auditconfig -setplugin audit_binfile active p_minfree=20
  50 # auditconfig -setplugin audit_binfile active \e
  51 p_dir=/var/audit/jedgar/eggplant,\e
  52 /var/audit/jedgar.aux/eggplant,\e
  53 /var/audit/global/eggplant
  54 .fi
  55 .in -2
  56 .sp
  57
  58 .SH ATTRIBUTES
  59 .LP
  60 See \fBattributes\fR(5) for a description of the following attributes:
  61 .sp
  62
  63 .sp
  64 .TS
  65 box;
  66 c | c
  67 l | l .
  68 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  69 _
  70 MT Level        MT-Safe
  71 _
  72 Interface Stability     Committed
  73 .TE
  74
  75 .SH SEE ALSO
  76 .LP
  77 \fBauditd\fR(1M), \fBauditconfig\fR(1M), \fBaudit.log\fR(4), \fBattributes\fR(5)