auditconfig subcommand...
auditconfig provides a command line interface to get and set kernel audit parameters.
Except for getting or setting the persistent audit service values, this functionality is available only if the Solaris Auditing feature has been enabled.
A zero (0) queue value indicates that the system default is in effect.
The setting of the perzone policy determines the scope of the audit setting controlled by auditconfig. If perzone is set, then the values reflect the local zone except as noted. Otherwise, the settings are for the entire system. Any restriction based on the perzone setting is noted for each option to which it applies.
A non-global zone administrator can set all audit policy options except perzone and ahlt. perzone and ahlt apply only to the global zone; setting these policies requires the privileges of a global zone administrator. perzone and ahlt are described under the –setpolicy option, below.
This command is available to administrators who have been granted the Audit Control Rights Profile.
The following option is supported:
Display or set the values on the running system in addition to the persistent values of the audit service.
This option is available only for the subcommands that list it below.
Set the configured non-attributable audit mask, kmask, to the configured non-attributable audit mask. For example:
# auditconfig -aconf Configured non-attributable event mask.
This command constructs an audit record for audit event event using the process's audit characteristics containing a text token string. The return token is constructed from the sorf (success/failure flag) and the retval (return value). The event is type char*, the sorf is 0/1 for success/failure, retval is an errno value, string is type *char. This command is useful for constructing an audit record with a shell script. An example of this option:
# auditconfig -audit AUE_ftpd 0 0 "test string"
#
audit record from audit trail:
header,76,2,ftp access,,Fri Dec 08 08:44:02 2000, + 669 msec
subject,abc,root,other,root,other,104449,102336,235 197121 elbow
text,test string
return,success,0
Checks the configuration of the non-attributable events set in the kernel against the entries configured in the audit service (–setnaflags). If the active class mask of a kernel audit event does not match the configured class mask, a mismatch is reported.
Check the configuration of kernel audit event to class mappings. If the runtime class mask of a kernel audit event does not match the configured class mask, a mismatch is reported.
Configure kernel audit event to class mappings. Runtime class mappings are changed to match those in the audit event to class database file.
Prints the audit session ID of the current process. For example:
# auditconfig -getasid audit session id = 102336
Returns the audit characteristics of the current process.
# auditconfig -getaudit audit id = abc(666) process preselection mask = lo(0x1000,0x1000) terminal id (maj,min,host) = 235,197121,elbow(172.146.89.77) audit session id = 102336
Prints the audit ID of the current process. For example:
# auditconfig -getauid audit id = abc(666)
Prints current active root location (anchored from root [or local zone root] at system boot). For example:
# auditconfig -getcar current active root = /
Display the preselection mask associated with the specified kernel audit event. event is the kernel event number or event name.
Display the kernel audit condition. The condition displayed is the literal string auditing meaning auditing is enabled and turned on (the kernel audit module is constructing and queuing audit records, audit daemon is running); noaudit, meaning auditing is enabled but turned off (the kernel audit module is not constructing and queuing audit records, audit daemon is not running); disabled, meaning that the audit module has not been enabled (the module has been excluded in system(4)). See auditd(1M) for further information.
For the specified event (string or event number), print out classes event has been assigned. For example:
# auditconfig -getestate 20 audit class mask for event AUE_REBOOT(20) = 0x800 # auditconfig -getestate AUE_RENAME audit class mask for event AUE_RENAME(42) = 0x30
Display the user default audit preselection flags.
Get audit characteristics of the current zone. For example:
# auditconfig -getkaudit audit id = unknown(-2) process preselection mask = lo,na(0x1400,0x1400) terminal id (maj,min,host) = 0,0,(0.0.0.0) audit session id = 0
If the audit policy perzone is not set, the terminal id is that of the global zone. Otherwise, it is the terminal id of the local zone.
Get non-attributable pre-selection mask for the current zone. For example:
# auditconfig -getkmask audit flags for non-attributable events = lo,na(0x1400,0x1400)
If the audit policy perzone is not set, the kernel mask is that of the global zone. Otherwise, it is that of the local zone.
Display the non-attributable audit flags.
Display the audit ID, preselection mask, terminal ID, and audit session ID for the specified process.
Display information about the plugin name. If name is not specified, display all plugins.
Display the kernel audit policy. The ahlt and perzone policies reflect the settings from the global zone. If perzone is set, all other policies reflect the local zone's settings. If perzone is not set, the policies are machine-wide.
Display the audit remote server-related information. If server option argument is used, only the common audit remote server configuration is displayed. If the option argument group is used, information about all configured connection groups is displayed. If, in addition to the group argument, the connection_group name is specified, information about only the respective connection group is displayed.
If no option arguments are used, information about common audit remote server configuration details and all connection groups are displayed.
Prints current working directory (anchored from zone root at system boot). For example:
# cd /usr/tmp # auditconfig -getcwd current working directory = /var/tmp
Get audit queue write buffer size. For example:
# auditconfig -getqbufsz no configured audit queue size audit queue buffer size (bytes) = 1024
Get audit queue write buffer size, audit queue hiwater mark, audit queue lowater mark, audit queue prod interval (ticks).
# auditconfig -getqctrl no configured audit queue lowater mark no configured audit queue hiwater mark no configured audit queue size no configured audit queue delay audit queue hiwater mark (records) = 100 audit queue lowater mark (records) = 10 audit queue buffer size (bytes) = 1024 audit queue delay (ticks) = 20 # auditconfig -setqbufsz 8192 # auditconfig -t -setqbufsz 12288 # auditconfig -setqdelay 20 # auditconfig -t -setqdelay 25 # auditconfig -getqctrl no configured audit queue lowater mark no configured audit queue hiwater mark configured audit queue buffer size (bytes) = 8192 configured audit queue delay (ticks) = 20 active audit queue hiwater mark (records) = 100 active audit queue lowater mark (records) = 10 active audit queue buffer size (bytes) = 12288 active audit queue delay (ticks) = 25
Get interval at which audit queue is prodded to start output. For example:
# auditconfig -getqdelay no configured audit queue delay audit queue delay (ticks) = 20
Get high water point in undelivered audit records when audit generation will block. For example:
# ./auditconfig -getqhiwater no configured audit queue hiwater mark audit queue hiwater mark (records) = 100
Get low water point in undelivered audit records where blocked processes will resume. For example:
# auditconfig -getqlowater no configured audit queue lowater mark audit queue lowater mark (records) = 10
Print current audit statistics information. For example:
# auditconfig -getstat gen nona kern aud ctl enq wrtn wblk rblk drop tot mem 910 1 725 184 0 910 910 0 231 0 88 48
See auditstat(1M) for a description of the headings in –getstat output.
Print audit terminal ID for current process. For example:
# auditconfig -gettid terminal id (maj,min,host) = 235,197121,elbow(172.146.89.77)
Display the currently configured (runtime) kernel and user level audit event information.
Display the kernel audit policies with a description of each policy.
Execute shell or cmd with specified session-ID. For example:
# ./auditconfig -setasid 2000 /bin/ksh # # ./auditconfig -getpinfo 104485 audit id = abc(666) process preselection mask = lo(0x1000,0x1000) terminal id (maj,min,host) = 235,197121,elbow(172.146.89.77) audit session id = 2000
Execute shell or cmd with the specified audit characteristics.
Execute shell or cmd with the specified audit–ID.
Map the kernel event event to the classes specified by audit_flag list. event is an event number or name. An audit_flag is a character string representing an audit class. See audit_flags(5) for further information. If perzone is not set, this option is valid only in the global zone.
Set the default user audit preselection flags; see audit_flags(5). The default preselection flags are combined with the user's specific audit flags to form the user's audit preselection mask.
Set IP address of machine to specified values. IP-address_type is ipv6 or ipv4.
If perzone is not set, this option is valid only in the global zone.
Set non-attributable preselection flags of machine.
If perzone is not set, this option is valid only in the global zone.
Set the non-attributable audit flags; see audit_flags(5). Non-attributable audit flags define which classes of events are to be audited when the action cannot be attributed to an authenticated user. Failed login is an example of an event that is non-attributable.
Set the preselection mask of the specified process. flags is the ASCII representation of the flags similar to that in audit_flags(5) .
If perzone is not set, this option is valid only in the global zone.
Configure the plugin plugin_name to be active or inactive. Optionally configure the attributes and number of unprocessed audit records to queue for the plugin. See the relevant audit plugin man pages and auditd(1M).
Set the kernel audit policy. A policy policy_flag is literal strings that denotes an audit policy. A prefix of + adds the policies specified to the current audit policies. A prefix of - removes the policies specified from the current audit policies. No policies can be set from a local zone unless the perzone policy is first set from the global zone. The following are the valid policy flag strings (auditconfig –lspolicy also lists the current valid audit policy flag strings):
Include all policies that apply to the current zone.
Panic is called and the system dumps core if an asynchronous audit event occurs that cannot be delivered because the audit queue has reached the high-water mark or because there are insufficient resources to construct an audit record. By default, records are dropped and a count is kept of the number of dropped records.
Include the execv(2) system call environment arguments to the audit record. This information is not included by default.
Include the execv(2) system call parameter arguments to the audit record. This information is not included by default.
Do not suspend processes when audit resources are exhausted. Instead, drop audit records and keep a count of the number of records dropped. By default, process are suspended until audit resources become available.
Include the supplementary group token in audit records. By default, the group token is not included.
Include no policies. If used in other than the global zone, the ahlt and perzone policies are not changed.
Add secondary path tokens to audit record. These are typically the pathnames of dynamically linked shared libraries or command interpreters for shell scripts. By default, they are not included.
Maintain separate configuration, queues, and logs for each zone and execute a separate version of auditd(1M) for each zone.
Audit public files. By default, read-type operations are not audited for certain files which meet public characteristics: owned by root, readable by all, and not writable by all.
Include the trailer token in every audit record. By default, the trailer token is not included.
Include the sequence token as part of every audit record. By default, the sequence token is not included. The sequence token attaches a sequence number to every audit record.
Include in an audit record any downgraded data moved between windows. This policy is available only if the system is configured with Trusted Extensions. By default, this information is not included.
Include in an audit record any upgraded data moved between windows. This policy is available only if the system is configured with Trusted Extensions. By default, this information is not included.
Include the zonename token as part of every audit record. By default, the zonename token is not included. The zonename token gives the name of the zone from which the audit record was generated.
Configure the main audit remote server switch to be active or inactive. If it is set to inactive, all configured connection groups are deemed inactive. Optionally configure the common audit remote server attributes. For more information, see ars(5).
Configure the audit remote server connection group group_name to be active or inactive. Optionally configure the respective connection group attributes. For more information, see ars(5) .
Create or destroy the audit remote server connection group group_name. For more information, see ars(5).
Set the audit queue write buffer size (bytes). Zero (0), indicates reset to no configured value.
Set the audit queue write buffer size (bytes), hiwater audit record count, lowater audit record count, and wakeup interval (ticks). Valid within a local zone only if perzone is set. Zero (0), indicates reset to no configured value.
Set the audit queue wakeup interval (ticks). This determines the interval at which the kernel pokes the audit queue, to write audit records to the audit trail. Valid within a local zone only if perzone is set. Zero (0), indicates reset to no configured value.
Set the number of undelivered audit records in the audit queue at which audit record generation blocks. Valid within a local zone only if perzone is set. Zero (0), indicates reset to no configured value.
Set the number of undelivered audit records in the audit queue at which blocked auditing processes unblock. Valid within a local zone only if perzone is set. Zero (0), indicates reset to no configured value.
Set the preselection mask of all processes with the specified audit session ID. Valid within a local zone only if perzone is set.
Reset audit statistics counters. Valid within a local zone only if perzone is set.
Set the preselection mask of all processes with the specified username or audit ID. Valid within a local zone only if perzone is set.
The following are examples of auditconfig commands.
# # Map kernel audit event number 10 to the "fr" audit class. # auditconfig -setclass 10 fr # # Turn on inclusion of exec arguments in exec audit records. # auditconfig -setpolicy +argvExample 2 Setting Only the Number of Unprocessed Audit Records
The following sequence of commands sets only the number of unprocessed audit records to queue for the audit_binfile plugin.
# See if audit_binfile is active. % auditconfig -getplugin audit_binfile # Set to queue 20 unprocessed audit records. # % auditconfig -setplugin audit_binfile "" 20Example 3 Resetting Queue Control Parameters
The following commands reset active and configured queue control parameters.
# Get the audit remote server configuration auditconfig -getremote # Change an audit remote server attribute auditconfig -setremote server \ "listen_address=10.0.0.1,max_startups=10:30:60" # Create an audit remote server (wild card) connection group auditconfig -setremote group create egg_farm # Get a specific audit remote server connection group information auditconfig -getremote group egg_farm # Set a connection group attribute, activate the connection group auditconfig -setremote group active egg_farm \ "hosts=tipo.cz.oracle.com,binfile_dir=/var/audit/ARS"Example 4 Configuring an Audit Remote Server
The following command configure an audit remote server.
# Get the audit remote server configuration auditconfig -getremote # Change an audit remote server attribute auditconfig -setremote server \ "listen_address=10.0.0.1,max_startups=10:30:60" # Create an audit remote server (wild card) connection group auditconfig -setremote group create egg_farm # Get a specific audit remote server connection group information auditconfig -getremote group egg_farm # Set a connection group attribute, activate the connection group auditconfig -setremote group active egg_farm \ "hosts=tipo.cz.oracle.com,binfile_dir=/var/audit/ARS"
Successful completion.
An error occurred.
Stores event definitions used in the audit system.
Stores class definitions used in the audit system.
See attributes(5) for descriptions of the following attributes:
|
audit(1M), auditd(1M), auditstat(1M), praudit(1M), execv(2), audit_class(4), audit_event(4), system(4), ars(5), attributes(5), audit_binfile(5), audit_flags(5) , audit_remote(5), audit_syslog (5)
See the section on Auditing in Securing Systems and Attached Devices in Oracle Solaris 11.2 .
If plugin output is selected using the –setplugin option, the behavior of the system with respect to the –setpolicy +cnt and the –setqhiwater options is modified slightly. If –setpolicy +cnt is set, data will continue to be sent to the selected plugin, even though output of the audit_binary plugin is stopped, pending the freeing of disk space. If –setpolicy –cnt is used, the blocking behavior is as described under SUBCOMMANDS , above. The queue high water mark value is used within auditd as the upper bound for its queue limits unless overridden by means of the qsize attribute, as described in the explanation of the –setplugin option, above.
The auditconfig options that modify or display process-based information are not affected by the perzone policy. Those that modify system audit data such as the terminal id and audit queue parameters are valid only in the global zone, unless the perzone policy is set. The display of a system audit reflects the local zone if perzone is set. Otherwise, it reflects the settings of the global zone.
The change to plugins (–setplugin) and audit remote server (–setremote) settings do not take effect (such as becoming active or inactive, or changing the respective attributes) until the audit service is refreshed. Use audit(1M) to refresh the audit service.