github
/
mysql-audit
mirror of https://github.com/mcafee-enterprise/mysql-audit
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated Configuration (markdown)

master
Guy Lichtman 2015-02-11 00:34:49 +02:00
parent c7e8bff732
commit daed0b74c7
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Configuration.md

@ -1,6 +1,6 @@
By default, after installation the AUDIT Plugin doesn't log activity. You must explicitly enable the type of logging desired. Configuration is done through the use of MySQL system variables. AUDIT Plugin system variables can be set at server startup using options on the command line or in the MySQL option file (my.cnf at the [mysqld] section). Additionally, most AUDIT Plugin system variables can be changed dynamically while the server is running by means of the SET statement. By default, after installation the AUDIT Plugin doesn't log activity. You must explicitly enable the type of logging desired. Configuration is done through the use of MySQL system variables. AUDIT Plugin system variables can be set at server startup using options on the command line or in the MySQL option file (my.cnf at the [mysqld] section). Additionally, most AUDIT Plugin system variables can be changed dynamically while the server is running by means of the SET statement.
Available AUDIT Plugin system varaibles: Available AUDIT Plugin system variables:
* **audit_json_log_file**: json log file name. If audit_json_file option is enabled will write audit trail to this file. Value may be either an absolute path or relative to the MySQL datadir. Default value: mysql-audit.json. * **audit_json_log_file**: json log file name. If audit_json_file option is enabled will write audit trail to this file. Value may be either an absolute path or relative to the MySQL datadir. Default value: mysql-audit.json.
* **audit_json_file**: json log file Enable|Disable. * **audit_json_file**: json log file Enable|Disable.
@ -15,6 +15,7 @@ Available AUDIT Plugin system varaibles:
* **audit_record_objs**: Comma separated list of objects (tables) to log to the audit trail. Table name should be specified as: `database.table`. Wild cards are supported and it is possible to specify: `*.mytable` or `mydb.*`. Specify: `{}` as part of the list to include the empty set to catch also cases where an activity has no objects (for example connect and quit). * **audit_record_objs**: Comma separated list of objects (tables) to log to the audit trail. Table name should be specified as: `database.table`. Wild cards are supported and it is possible to specify: `*.mytable` or `mydb.*`. Specify: `{}` as part of the list to include the empty set to catch also cases where an activity has no objects (for example connect and quit).
* **audit_whitelist_users**: Comma separated list of white-listed users whose queries are not recorded. Specify: `{}` as part of the list to include the empty user. * **audit_whitelist_users**: Comma separated list of white-listed users whose queries are not recorded. Specify: `{}` as part of the list to include the empty user.
* **audit_whitelist_cmds**: Comma separated list of white-listed cmds whose queries are not recorded. Introduced at version 1.0.6. * **audit_whitelist_cmds**: Comma separated list of white-listed cmds whose queries are not recorded. Introduced at version 1.0.6.
* **audit_force_record_logins**: Force logging: Connect, Quit and Failed Login commands, regardless of the settings in `audit_record_cmds` and `audit_record_objs` variables. Enable|Disable. Default value: disabled. Introduced at version 1.0.8.
* **audit_header_msg**: Header message logging ON|OFF. Default value: ON. Introduced at version 1.0.6. * **audit_header_msg**: Header message logging ON|OFF. Default value: ON. Introduced at version 1.0.6.
* **audit_password_masking_cmds**: Comma separated list of commands for which the password masking regex will be applied. Default value includes MySQL commands that may include a password clause: `CREATE_USER,GRANT,SET_OPTION,SLAVE_START,CREATE_SERVER,ALTER_SERVER,CHANGE_MASTER`. Introduced at version 1.0.6. * **audit_password_masking_cmds**: Comma separated list of commands for which the password masking regex will be applied. Default value includes MySQL commands that may include a password clause: `CREATE_USER,GRANT,SET_OPTION,SLAVE_START,CREATE_SERVER,ALTER_SERVER,CHANGE_MASTER`. Introduced at version 1.0.6.
* **audit_password_masking_regex**: PCRE complaint regular expression used for password masking. Regex will be applied only to statements with command type as specified at: `audit_password_masking_cmds`. Introduced at version 1.0.6. * **audit_password_masking_regex**: PCRE complaint regular expression used for password masking. Regex will be applied only to statements with command type as specified at: `audit_password_masking_cmds`. Introduced at version 1.0.6.