usr/src/man/man1m/auditd.1m

   1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" 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.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" 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 the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH AUDITD 1M "Apr 29, 2008"
   7 .SH NAME
   8 auditd \- audit daemon
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/auditd\fR
  13 .fi
  14
  15 .SH DESCRIPTION
  16 .sp
  17 .LP
  18 The audit daemon, \fBauditd\fR, controls the generation and location of audit
  19 trail files and the generation of syslog messages based on the definitions in
  20 \fBaudit_control\fR(4). If auditing is enabled, \fBauditd\fR reads the
  21 \fBaudit_control\fR file to do the following:
  22 .RS +4
  23 .TP
  24 .ie t \(bu
  25 .el o
  26 reads the path to a library module for realtime conversion of audit data into
  27 syslog messages;
  28 .RE
  29 .RS +4
  30 .TP
  31 .ie t \(bu
  32 .el o
  33 reads other parameters specific to the selected plugin or plugins;
  34 .RE
  35 .RS +4
  36 .TP
  37 .ie t \(bu
  38 .el o
  39 obtains a list of directories into which audit files can be written;
  40 .RE
  41 .RS +4
  42 .TP
  43 .ie t \(bu
  44 .el o
  45 obtains the percentage limit for how much space to reserve on each filesystem
  46 before changing to the next directory.
  47 .RE
  48 .sp
  49 .LP
  50 \fBaudit\fR(1M) is used to control \fBauditd\fR. It can cause \fBauditd\fR to:
  51 .RS +4
  52 .TP
  53 .ie t \(bu
  54 .el o
  55 close the current audit file and open a new one;
  56 .RE
  57 .RS +4
  58 .TP
  59 .ie t \(bu
  60 .el o
  61 close the current audit file, re-read \fB/etc/security/audit_control\fR and
  62 open a new audit file;
  63 .RE
  64 .RS +4
  65 .TP
  66 .ie t \(bu
  67 .el o
  68 close the audit trail and terminate auditing.
  69 .RE
  70 .SS "Auditing Conditions"
  71 .sp
  72 .LP
  73 The audit daemon invokes the program \fBaudit_warn\fR(1M) under the following
  74 conditions with the indicated options:
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBaudit_warn soft\fR \fIpathname\fR\fR
  79 .ad
  80 .sp .6
  81 .RS 4n
  82 The file system upon which \fIpathname\fR resides has exceeded the minimum free
  83 space limit defined in \fBaudit_control\fR(4). A new audit trail has been
  84 opened on another file system.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBaudit_warn allsoft\fR\fR
  91 .ad
  92 .sp .6
  93 .RS 4n
  94 All available file systems have been filled beyond the minimum free space
  95 limit. A new audit trail has been opened anyway.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBaudit_warn hard\fR \fIpathname\fR\fR
 102 .ad
 103 .sp .6
 104 .RS 4n
 105 The file system upon which \fIpathname\fR resides has filled or for some reason
 106 become unavailable. A new audit trail has been opened on another file system.
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBaudit_warn allhard\fR \fIcount\fR\fR
 113 .ad
 114 .sp .6
 115 .RS 4n
 116 All available file systems have been filled or for some reason become
 117 unavailable. The audit daemon will repeat this call to \fBaudit_warn\fR at
 118 intervals of at least twenty seconds until space becomes available. \fIcount\fR
 119 is the number of times that \fBaudit_warn\fR has been called since the problem
 120 arose.
 121 .RE
 122
 123 .sp
 124 .ne 2
 125 .na
 126 \fB\fBaudit_warn ebusy\fR\fR
 127 .ad
 128 .sp .6
 129 .RS 4n
 130 There is already an audit daemon running.
 131 .RE
 132
 133 .sp
 134 .ne 2
 135 .na
 136 \fB\fBaudit_warn tmpfile\fR\fR
 137 .ad
 138 .sp .6
 139 .RS 4n
 140 The file \fB/etc/security/audit/audit_tmp\fR exists, indicating a fatal error.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBaudit_warn nostart\fR\fR
 147 .ad
 148 .sp .6
 149 .RS 4n
 150 The internal system audit condition is \fBAUC_FCHDONE\fR. Auditing cannot be
 151 started without rebooting the system.
 152 .RE
 153
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fBaudit_warn auditoff\fR\fR
 158 .ad
 159 .sp .6
 160 .RS 4n
 161 The internal system audit condition has been changed to not be
 162 \fBAUC_AUDITING\fR by someone other than the audit daemon. This causes the
 163 audit daemon to exit.
 164 .RE
 165
 166 .sp
 167 .ne 2
 168 .na
 169 \fB\fBaudit_warn postsigterm\fR\fR
 170 .ad
 171 .sp .6
 172 .RS 4n
 173 An error occurred during the orderly shutdown of the auditing system.
 174 .RE
 175
 176 .sp
 177 .ne 2
 178 .na
 179 \fB\fBaudit_warn getacdir\fR\fR
 180 .ad
 181 .sp .6
 182 .RS 4n
 183 There is a problem getting the directory list from
 184 \fB/etc/security/audit/audit_control\fR.
 185 .sp
 186 The audit daemon will hang in a sleep loop until this file is fixed.
 187 .RE
 188
 189 .SH FILES
 190 .sp
 191 .LP
 192 \fB/etc/security/audit/audit_control\fR
 193 .SH ATTRIBUTES
 194 .sp
 195 .LP
 196 See \fBattributes\fR(5) for descriptions of the following attributes:
 197 .sp
 198
 199 .sp
 200 .TS
 201 box;
 202 c | c
 203 l | l .
 204 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 205 _
 206 Interface Stability     Committed
 207 .TE
 208
 209 .SH SEE ALSO
 210 .sp
 211 .LP
 212 \fBaudit\fR(1M), \fBaudit_warn\fR(1M), \fBbsmconv\fR(1M), \fBpraudit\fR(1M),
 213 \fBauditon\fR(2), \fBaudit.log\fR(4), \fBaudit_control\fR(4),
 214 \fBattributes\fR(5)
 215 .sp
 216 .LP
 217 See the section on Solaris Auditing in \fISystem Administration Guide: Security
 218 Services\fR.
 219 .SH NOTES
 220 .sp
 221 .LP
 222 The functionality described in this man page is available only if the Solaris
 223 Auditing feature has been enabled. See \fBbsmconv\fR(1M) for more information.
 224 .sp
 225 .LP
 226 \fBauditd\fR is loaded in the global zone at boot time if auditing is enabled.
 227 See \fBbsmconv\fR(1M).
 228 .sp
 229 .LP
 230 If the audit policy \fBperzone\fR is set, \fBauditd\fR runs in each zone,
 231 starting automatically when the local zone boots. If a zone is running when the
 232 \fBperzone\fR policy is set, auditing must be started manually in local zones.
 233 It is not necessary to reboot the system or the local zone to start auditing in
 234 a local zone. \fBauditd\fR can be started with "\fB/usr/sbin/audit\fR \fB-s\fR"
 235 and will start automatically with future boots of the zone.
 236 .sp
 237 .LP
 238 When \fBauditd\fR runs in a local zone, the configuration is taken from the
 239 local zone's \fB/etc/security\fR directory's files: \fBaudit_control\fR,
 240 \fBaudit_class\fR, \fBaudit_user\fR, \fBaudit_startup\fR, and
 241 \fBaudit_event\fR.
 242 .sp
 243 .LP
 244 Configuration changes do not affect audit sessions that are currently running,
 245 as the changes do not modify a process's preselection mask. To change the
 246 preselection mask on a running process, use the \fB-setpmask\fR option of the
 247 \fBauditconfig\fR command (see \fBauditconfig\fR(1M)). If the user logs out and
 248 logs back in, the new configuration changes will be reflected in the next audit
 249 session.