| blob | da36b63862c4fbb56b630c853f4a0702e259eb75 |
1 '\" te
2 .\" Copyright (c) 2017 Peter Tribble
3 .\" Copyright (c) 2008, 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.
5 .\" 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.
6 .\" 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]
7 .TH AUDITD 8 "Mar 6, 2017"
8 .SH NAME
9 auditd \- audit daemon
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/usr/sbin/auditd\fR
14 .fi
16 .SH DESCRIPTION
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 its configuration,
20 stored in \fBsmf\fR(5) and managed using the \fBauditconfig\fR(8) command.
21 .sp
22 .LP
23 \fBaudit\fR(8) is used to control \fBauditd\fR. It can cause \fBauditd\fR to:
24 .RS +4
25 .TP
26 .ie t \(bu
27 .el o
28 close the current audit file and open a new one;
29 .RE
30 .RS +4
31 .TP
32 .ie t \(bu
33 .el o
34 close the current audit file, reread its configuration and
35 open a new audit file;
36 .RE
37 .RS +4
38 .TP
39 .ie t \(bu
40 .el o
41 close the audit trail and terminate auditing.
42 .RE
43 .SS "Auditing Conditions"
44 .LP
45 The audit daemon invokes the program \fBaudit_warn\fR(8) under the following
46 conditions with the indicated options:
47 .sp
48 .ne 2
49 .na
50 \fB\fBaudit_warn soft\fR \fIpathname\fR\fR
51 .ad
52 .sp .6
53 .RS 4n
54 The file system upon which \fIpathname\fR resides has exceeded the minimum free
55 space limit defined by the \fBp_minfree\fR attribute of the \fbaudit_binfile\fR
56 plugin. A new audit trail has been opened on another file system.
57 .RE
59 .sp
60 .ne 2
61 .na
62 \fB\fBaudit_warn allsoft\fR\fR
63 .ad
64 .sp .6
65 .RS 4n
66 All available file systems have been filled beyond the minimum free space
67 limit. A new audit trail has been opened anyway.
68 .RE
70 .sp
71 .ne 2
72 .na
73 \fB\fBaudit_warn hard\fR \fIpathname\fR\fR
74 .ad
75 .sp .6
76 .RS 4n
77 The file system upon which \fIpathname\fR resides has filled or for some reason
78 become unavailable. A new audit trail has been opened on another file system.
79 .RE
81 .sp
82 .ne 2
83 .na
84 \fB\fBaudit_warn allhard\fR \fIcount\fR\fR
85 .ad
86 .sp .6
87 .RS 4n
88 All available file systems have been filled or for some reason become
89 unavailable. The audit daemon will repeat this call to \fBaudit_warn\fR at
90 intervals of at least twenty seconds until space becomes available. \fIcount\fR
91 is the number of times that \fBaudit_warn\fR has been called since the problem
92 arose.
93 .RE
95 .sp
96 .ne 2
97 .na
98 \fB\fBaudit_warn tmpfile\fR\fR
99 .ad
100 .sp .6
101 .RS 4n
102 There was a problem creating a symlink from \fB/var/run/.audit.log\fR to the
103 current audit log file.
104 .RE
106 .sp
107 .ne 2
108 .na
109 \fB\fBaudit_warn nostart\fR\fR
110 .ad
111 .sp .6
112 .RS 4n
113 There was an internal error starting auditing.
114 .RE
116 .sp
117 .ne 2
118 .na
119 \fB\fBaudit_warn auditoff\fR\fR
120 .ad
121 .sp .6
122 .RS 4n
123 The internal system audit condition has been changed to not be
124 \fBAUC_AUDITING\fR by someone other than the audit daemon. This causes the
125 audit daemon to exit.
126 .RE
128 .SH ATTRIBUTES
129 .LP
130 See \fBattributes\fR(5) for descriptions of the following attributes:
131 .sp
133 .sp
134 .TS
135 box;
136 c | c
137 l | l .
138 ATTRIBUTE TYPE ATTRIBUTE VALUE
139 _
140 Interface Stability Committed
141 .TE
143 .SH SEE ALSO
144 .LP
145 \fBaudit\fR(8), \fBauditconfig\fR(8), \fBaudit_binfile\fR(5),
146 \fBaudit_warn\fR(8), \fBpraudit\fR(8), \fBauditon\fR(2), \fBaudit.log\fR(4),
147 \fBattributes\fR(5)
148 .SH NOTES
149 .LP
150 If the audit policy \fBperzone\fR is set, \fBauditd\fR runs in each zone,
151 starting automatically when the local zone boots. If a zone is running when the
152 \fBperzone\fR policy is set, auditing must be started manually in local zones.
153 It is not necessary to reboot the system or the local zone to start auditing in
154 a local zone. \fBauditd\fR can be started with "\fB/usr/sbin/audit\fR \fB-s\fR"
155 and will start automatically with future boots of the zone.
156 .sp
157 .LP
158 When \fBauditd\fR runs in a local zone, the configuration is taken from the
159 local zone's \fB/etc/security\fR directory's files:
160 \fBaudit_class\fR, and \fBaudit_event\fR.
161 .sp
162 .LP
163 Configuration changes do not affect audit sessions that are currently running,
164 as the changes do not modify a process's preselection mask. To change the
165 preselection mask on a running process, use the \fB-setpmask\fR option of the
166 \fBauditconfig\fR command (see \fBauditconfig\fR(8)). If the user logs out and
167 logs back in, the new configuration changes will be reflected in the next audit
168 session.
169 .sp
170 .LP
171 The \fBauditd\fR service is managed by the service management facility,
172 \fBsmf\fR(5), under the service identifier:
173 .sp
174 .in +2
175 .nf
176 svc:/system/auditd
177 .fi
178 .in -2
179 .sp
181 .sp
182 .LP
183 The service's status can be queried using the \fBsvcs\fR(1) command. While
184 administrative actions on this service, such as enabling, disabling, or
185 requesting restart, can be performed using \fBsvcadm\fR(8), the \fBaudit\fR(8)
186 command is the preferred administrative interface.