diff --git a/website/source/docs/audit/file.html.md b/website/source/docs/audit/file.html.md index c4f76a2544..b2333de1b4 100644 --- a/website/source/docs/audit/file.html.md +++ b/website/source/docs/audit/file.html.md @@ -1,97 +1,56 @@ --- layout: "docs" -page_title: "Audit Backend: File" +page_title: "File - Audit Devices" sidebar_current: "docs-audit-file" description: |- - The "file" audit backend writes audit logs to a file. + The "file" audit device writes audit logs to a file. --- -# Audit Backend: File +# File Audit Device -The `file` audit backend writes audit logs to a file. This is a very simple audit -backend: it appends logs to a file. +The `file` audit device writes audit logs to a file. This is a very simple audit +device: it appends logs to a file. -## Rotation - -The backend does not currently assist with any log rotation. There are very +The device does not currently assist with any log rotation. There are very stable and feature-filled log rotation tools already, so we recommend using existing tools. -As of 0.6.2, sending a `SIGHUP` to the Vault process will cause `file` audit -backends to close and re-open their underlying file, which can assist with log -rotation needs. +Sending a `SIGHUP` to the Vault process will cause `file` audit devices to close +and re-open their underlying file, which can assist with log rotation needs. -## Format +## Examples -Each line in the audit log is a JSON object. The `type` field specifies what type of -object it is. Currently, only two types exist: `request` and `response`. The line contains -all of the information for any given request and response. By default, all the sensitive -information is first hashed before logging in the audit logs. +Enable at the default path: -## Enabling - -#### Via the CLI - -Audit `file` backend can be enabled by the following command. - -``` -$ vault audit-enable file file_path=/var/log/vault_audit.log +```text +$ vault audit enable file file_path=/var/log/vault_audit.log ``` -Any number of `file` audit logs can be created by enabling it with different `path`s. +Enable at a different path. It is possible to enable multiple copies of an audit +device: -``` -$ vault audit-enable -path="vault_audit_1" file file_path=/home/user/vault_audit.log +```text +$ vault audit enable -path="vault_audit_1" file file_path=/home/user/vault_audit.log ``` -Note the difference between `audit-enable` command options and the `file` backend -configuration options. Use `vault audit-enable -help` to see the command options. -Following are the configuration options available for the backend. +## Configuration -
-
Backend configuration options
-
- -
-
+- `file_path` `(string: "")` - The path to where the audit log will be written. + If this path exists, the audit device will append to it. Specify `"stdout"` to + write audit log to standard output. Specify `"discard"` to discard output + (useful in testing scenarios). +- `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. + +- `prefix` `(string: "")` - A customizable string prefix to write before the + actual log line. diff --git a/website/source/docs/audit/index.html.md b/website/source/docs/audit/index.html.md index 7e4aa607c0..dd1ba57e94 100644 --- a/website/source/docs/audit/index.html.md +++ b/website/source/docs/audit/index.html.md @@ -1,22 +1,29 @@ --- layout: "docs" -page_title: "Audit Backends" +page_title: "Audit Devices" sidebar_current: "docs-audit" description: |- - Audit backends are mountable backends that log requests and responses in Vault. + Audit devices are mountable devices that log requests and responses in Vault. --- -# Audit Backends +# Audit Devices -Audit backends are the components in Vault that keep a detailed log +Audit devices are the components in Vault that keep a detailed log of all requests and response to Vault. Because _every_ operation with Vault is an API request/response, the audit log contains _every_ interaction with Vault, including errors. -Vault ships with multiple audit backends, depending on the location you want -the logs sent to. Multiple audit backends can be enabled and Vault will send -the audit logs to both. This allows you to not only have a redundant copy, -but also a second copy in case the first is tampered with. +Multiple audit devices can be enabled and Vault will send the audit logs to +both. This allows you to not only have a redundant copy, but also a second copy +in case the first is tampered with. + +## Format + +Each line in the audit log is a JSON object. The `type` field specifies what +type of object it is. Currently, only two types exist: `request` and `response`. +The line contains all of the information for any given request and response. By +default, all the sensitive information is first hashed before logging in the +audit logs. ## Sensitive Information @@ -28,80 +35,47 @@ hashed with a salt using HMAC-SHA256. The purpose of the hash is so that secrets aren't in plaintext within your audit logs. However, you're still able to check the value of secrets by -generating HMACs yourself; this can be done with the audit backend's hash +generating HMACs yourself; this can be done with the audit device's hash function and salt by using the `/sys/audit-hash` API endpoint (see the documentation for more details). -## Enabling/Disabling Audit Backends +## Enabling/Disabling Audit Devices When a Vault server is first initialized, no auditing is enabled. Audit -backends must be enabled by a root user using `vault audit-enable`. +devices must be enabled by a root user using `vault audit-enable`. -When enabling an audit backend, options can be passed to it to configure it. -For example, the command below enables the file audit backend: +When enabling an audit device, options can be passed to it to configure it. +For example, the command below enables the file audit device: -``` -$ vault audit-enable file file_path=/var/log/vault_audit.log -... +```text +$ vault audit enable file file_path=/var/log/vault_audit.log ``` In the command above, we passed the "file_path" parameter to specify the path -where the audit log will be written to. Each audit backend has its own +where the audit log will be written to. Each audit device has its own set of parameters. See the documentation to the left for more details. -When an audit backend is disabled, it will stop receiving logs immediately. +When an audit device is disabled, it will stop receiving logs immediately. The existing logs that it did store are untouched. -## Blocked Audit Backends +## Blocked Audit Devices -If there are any audit backends enabled, Vault requires that at least +If there are any audit devices enabled, Vault requires that at least one be able to persist the log before completing a Vault request. -If you have only one audit backend enabled, and it is blocking (network -block, etc.), then Vault will be _unresponsive_. Vault _will not_ complete -any requests until the audit backend can write. +!> If you have only one audit device enabled, and it is blocking (network +block, etc.), then Vault will be _unresponsive_. Vault **will not** complete +any requests until the audit device can write. -If you have more than one audit backend, then Vault will complete the request -as long as one audit backend persists the log. +If you have more than one audit device, then Vault will complete the request +as long as one audit device persists the log. -Vault will not respond to requests if audit backends are blocked because +Vault will not respond to requests if audit devices are blocked because audit logs are critically important and ignoring blocked requests opens -an avenue for attack. Be absolutely certain that your audit backends cannot +an avenue for attack. Be absolutely certain that your audit devices cannot block. ## API -### /sys/audit/[path] -#### POST - -
-
Description
-
- Enables audit backend at the specified path. -
- -
Method
-
POST
- -
- -
-
+Audit devices also have a full HTTP API. Please see the [Audit device API +docs](/api/system/audit.html) for more details. diff --git a/website/source/docs/audit/socket.html.md b/website/source/docs/audit/socket.html.md index eb653d38a4..38782f0ae7 100644 --- a/website/source/docs/audit/socket.html.md +++ b/website/source/docs/audit/socket.html.md @@ -1,85 +1,55 @@ --- layout: "docs" -page_title: "Audit Backend: Socket" +page_title: "Socket - Audit Devices" sidebar_current: "docs-audit-socket" description: |- - The "socket" audit backend writes audit writes to a TCP or UDP socket. + The "socket" audit device writes audit writes to a TCP or UDP socket. --- -# Audit Backend: Socket +# Socket Audit Device -The `socket` audit backend writes to a TCP, UDP, or UNIX socket. +The `socket` audit device writes to a TCP, UDP, or UNIX socket. -~> **Warning:** Due to the nature of the underlying protocols used in this backend there exists a case when the connection to a socket is lost a single audit entry could be omitted from the logs and the request will still succeed. Using this backend in conjunction with another audit backend will help to improve accuracy, but the socket backend should not be used if strong guarantees are needed for audit logs. - -## Format - -Each line in the audit log is a JSON object. The `type` field specifies what type of -object it is. Currently, only two types exist: `request` and `response`. The line contains -all of the information for any given request and response. By default, all the sensitive -information is first hashed before logging in the audit logs. +~> **Warning:** Due to the nature of the underlying protocols used in this +device there exists a case when the connection to a socket is lost a single +audit entry could be omitted from the logs and the request will still succeed. +Using this device in conjunction with another audit device will help to improve +accuracy, but the socket device should not be used if strong guarantees are +needed for audit logs. ## Enabling -#### Via the CLI +Enable at the default path: -Audit `socket` backend can be enabled by the following command. - -``` -$ vault audit-enable socket +```text +$ vault audit enable socket ``` -Backend configuration options can also be provided from command-line. +Supply configuration parameters via K=V pairs: -``` -$ vault audit-enable socket address="127.0.0.1:9090" socket_type="tcp" +```text +$ vault audit enable socket address=127.0.0.1:9090 socket_type=tcp ``` -Following are the configuration options available for the backend. +## Configuration -
-
Backend configuration options
-
- -
-
+- `address` `(string: "")` - The socket server address to use. Example + `127.0.0.1:9090` or `/tmp/audit.sock`. + +- `socket_type` `(string: "tcp")` - The socket type to use, any type compatible + with net.Dial is acceptable. + +- `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. + +- `prefix` `(string: "")` - A customizable string prefix to write before the + actual log line. diff --git a/website/source/docs/audit/syslog.html.md b/website/source/docs/audit/syslog.html.md index 22fa39ce81..c0beac47ec 100644 --- a/website/source/docs/audit/syslog.html.md +++ b/website/source/docs/audit/syslog.html.md @@ -1,82 +1,50 @@ --- layout: "docs" -page_title: "Audit Backend: Syslog" +page_title: "Syslog - Audit Devices" sidebar_current: "docs-audit-syslog" description: |- - The "syslog" audit backend writes audit logs to syslog. + The "syslog" audit device writes audit logs to syslog. --- -# Audit Backend: Syslog +# Syslog Audit Device -The `syslog` audit backend writes audit logs to syslog. +The `syslog` audit device writes audit logs to syslog. It currently does not support a configurable syslog destination, and always -sends to the local agent. This backend is only supported on Unix systems, +sends to the local agent. This device is only supported on Unix systems, and should not be enabled if any standby Vault instances do not support it. -## Format +## Examples -Each line in the audit log is a JSON object. The `type` field specifies what type of -object it is. Currently, only two types exist: `request` and `response`. The line contains -all of the information for any given request and response. By default, all the sensitive -information is first hashed before logging in the audit logs. +Audit `syslog` device can be enabled by the following command: -## Enabling - -#### Via the CLI - -Audit `syslog` backend can be enabled by the following command. - -``` -$ vault audit-enable syslog +```text +$ vault audit enable syslog ``` -Backend configuration options can also be provided from command-line. +Supply configuration parameters via K=V pairs: -``` -$ vault audit-enable syslog tag="vault" facility="AUTH" +```text +$ vault audit enable syslog tag="vault" facility="AUTH" ``` -Following are the configuration options available for the backend. +## Configuration -
-
Backend configuration options
-
- -
-
+- `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. + +- `prefix` `(string: "")` - A customizable string prefix to write before the + actual log line. diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index 47659e6f1c..19288776e6 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -491,7 +491,7 @@ > - Audit Backends + Audit Devices