2015-04-24 18:44:16 +00:00
|
|
|
---
|
|
|
|
layout: "docs"
|
2017-09-08 02:38:47 +00:00
|
|
|
page_title: "Syslog - Audit Devices"
|
2015-04-24 18:44:16 +00:00
|
|
|
sidebar_current: "docs-audit-syslog"
|
|
|
|
description: |-
|
2017-09-08 02:38:47 +00:00
|
|
|
The "syslog" audit device writes audit logs to syslog.
|
2015-04-24 18:44:16 +00:00
|
|
|
---
|
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
# Syslog Audit Device
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
The `syslog` audit device writes audit logs to syslog.
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2016-03-12 02:14:39 +00:00
|
|
|
It currently does not support a configurable syslog destination, and always
|
2017-09-08 02:38:47 +00:00
|
|
|
sends to the local agent. This device is only supported on Unix systems,
|
2015-04-24 18:44:16 +00:00
|
|
|
and should not be enabled if any standby Vault instances do not support it.
|
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
## Examples
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
Audit `syslog` device can be enabled by the following command:
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
```text
|
|
|
|
$ vault audit enable syslog
|
|
|
|
```
|
2016-03-12 02:14:39 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
Supply configuration parameters via K=V pairs:
|
2016-03-12 02:14:39 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
```text
|
|
|
|
$ vault audit enable syslog tag="vault" facility="AUTH"
|
2016-03-12 02:14:39 +00:00
|
|
|
```
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
## Configuration
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
- `facility` `(string: "AUTH")` - The syslog facility to use.
|
|
|
|
|
|
|
|
- `tag` `(string: "vault")` - The syslog tag to use.
|
|
|
|
|
|
|
|
- `log_raw` `(bool: false)` - If enabled, logs the security sensitive
|
|
|
|
information without hashing, in the raw format.
|
|
|
|
|
|
|
|
- `hmac_accessor` `(bool: true)` - If enabled, enables the hashing of token
|
|
|
|
accessor.
|
|
|
|
|
|
|
|
- `mode` `(string: "0600")` - A string containing an octal number representing
|
|
|
|
the bit pattern for the file mode, similar to `chmod`.
|
|
|
|
|
|
|
|
- `format` `(string: "json")` - Allows selecting the output format. Valid values
|
|
|
|
are `"json"` and `"jsonx"`, which formats the normal log entries as XML.
|
2015-04-24 18:44:16 +00:00
|
|
|
|
2017-09-08 02:38:47 +00:00
|
|
|
- `prefix` `(string: "")` - A customizable string prefix to write before the
|
|
|
|
actual log line.
|