1 '\" te
   2 .\" Copyright (c) 2008, Sun Microsystems, Inc.
   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 AUDIT_CLASS 4 "Mar 6, 2017"
   7 .SH NAME
   8 audit_class \- audit class definitions
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/etc/security/audit_class\fR
  13 .fi
  14 
  15 .SH DESCRIPTION
  16 .LP
  17 \fB/etc/security/audit_class\fR is a user-configurable ASCII system file that
  18 stores class definitions used in the audit system. Audit events in
  19 \fBaudit_event\fR(4) are mapped to one or more of the defined audit classes.
  20 \fBaudit_event\fR can be updated in conjunction with changes to
  21 \fBaudit_class\fR.
  22 Programs can use the \fBgetauclassent\fR(3BSM) routines to access audit
  23 class information.
  24 .sp
  25 .LP
  26 The fields for each class entry are separated by colons. Each class entry is a
  27 bitmap and is separated from each other by a newline.
  28 .sp
  29 .LP
  30 Each entry in the \fBaudit_class\fR file has the form:
  31 .sp
  32 .in +2
  33 .nf
  34 \fImask\fR:\fIname\fR:\fIdescription\fR
  35 .fi
  36 .in -2
  37 
  38 .sp
  39 .LP
  40 The fields are defined as follows:
  41 .sp
  42 .ne 2
  43 .na
  44 \fB\fImask\fR\fR
  45 .ad
  46 .RS 15n
  47 class mask
  48 .RE
  49 
  50 .sp
  51 .ne 2
  52 .na
  53 \fB\fIname\fR\fR
  54 .ad
  55 .RS 15n
  56 class name
  57 .RE
  58 
  59 .sp
  60 .ne 2
  61 .na
  62 \fB\fIdescription\fR\fR
  63 .ad
  64 .RS 15n
  65 class description
  66 .RE
  67 
  68 .sp
  69 .LP
  70 Each class is represented as a bit in the class mask which is an unsigned
  71 integer. Thus, there are 32 different classes available. Meta-classes can also
  72 be defined. These are supersets composed of multiple base classes, and thus
  73 will have more than 1 bit in its mask. See Examples. Two special meta-classes
  74 are also pre-defined: \fBall\fR, and \fBno\fR.
  75 .sp
  76 .ne 2
  77 .na
  78 \fB\fBall\fR\fR
  79 .ad
  80 .RS 7n
  81 Represents a conjunction of all allowed classes, and is provided as a shorthand
  82 method of specifying all classes.
  83 .RE
  84 
  85 .sp
  86 .ne 2
  87 .na
  88 \fB\fBno\fR\fR
  89 .ad
  90 .RS 7n
  91 Is the invalid class, and any event mapped solely to this class will not be
  92 audited. Turning auditing on to the \fBall\fR meta class will not cause events
  93 mapped solely to the \fBno\fR class to be written to the audit trail. This
  94 class is also used to map obsolete events which are no longer generated.
  95 Obsolete events are retained to process old audit trails files.
  96 .RE
  97 
  98 .SH EXAMPLES
  99 .LP
 100 \fBExample 1 \fRUsing an \fBaudit_class\fR File
 101 .sp
 102 .LP
 103 The following is an example of an \fBaudit_class\fR file:
 104 
 105 .sp
 106 .in +2
 107 .nf
 108 0x00000000:no:invalid class
 109 0x00000001:fr:file read
 110 0x00000002:fw:file write
 111 0x00000004:fa:file attribute access
 112 0x00000008:fm:file attribute modify
 113 0x00000010:fc:file create
 114 0x00000020:fd:file delete
 115 0x00000040:cl:file close
 116 0x00000100:nt:network
 117 0x00000200:ip:ipc
 118 0x00000400:na:non-attribute
 119 0x00001000:lo:login or logout
 120 0x00004000:ap:application
 121 0x000f0000:ad:old administrative (meta-class)
 122 0x00070000:am:administrative (meta-class)
 123 0x00010000:ss:change system state
 124 0x00020000:as:system-wide administration
 125 0x00040000:ua:user administration
 126 0x00080000:aa:audit utilization
 127 0x00300000:pc:process (meta-class)
 128 0x00100000:ps:process start/stop
 129 0x00200000:pm:process modify
 130 0x20000000:io:ioctl
 131 0x40000000:ex:exec
 132 0x80000000:ot:other
 133 0xffffffff:all:all classes (meta-class)
 134 .fi
 135 .in -2
 136 .sp
 137 
 138 .SH FILES
 139 .ne 2
 140 .na
 141 \fB\fB/etc/security/audit_class\fR\fR
 142 .ad
 143 .RS 29n
 144 
 145 .RE
 146 
 147 .SH ATTRIBUTES
 148 .LP
 149 See \fBattributes\fR(5) for descriptions of the following attributes:
 150 .sp
 151 
 152 .sp
 153 .TS
 154 box;
 155 c | c
 156 l | l .
 157 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 158 _
 159 Interface Stability      See below.
 160 .TE
 161 
 162 .sp
 163 .LP
 164 The file format stability is Committed. The file content is Uncommitted.
 165 .SH SEE ALSO
 166 .LP
 167 \fBau_preselect\fR(3BSM), \fBgetauclassent\fR(3BSM),
 168 \fBaudit_event\fR(4), \fBattributes\fR(5)
 169 .SH NOTES
 170 .LP
 171 It is possible to deliberately turn on the \fBno\fR class in the kernel, in
 172 which case the audit trail will be flooded with records for the audit event
 173 \fBAUE_NULL\fR.