a3dfde5cec
* conversion stage 1 * correct image paths * add sidebar title to frontmatter * docs/concepts and docs/internals * configuration docs and multi-level nav corrections * commands docs, index file corrections, small item nav correction * secrets converted * auth * add enterprise and agent docs * add extra dividers * secret section, wip * correct sidebar nav title in front matter for apu section, start working on api items * auth and backend, a couple directory structure fixes * remove old docs * intro side nav converted * reset sidebar styles, add hashi-global-styles * basic styling for nav sidebar * folder collapse functionality * patch up border length on last list item * wip restructure for content component * taking middleman hacking to the extreme, but its working * small css fix * add new mega nav * fix a small mistake from the rebase * fix a content resolution issue with middleman * title a couple missing docs pages * update deps, remove temporary markup * community page * footer to layout, community page css adjustments * wip downloads page * deps updated, downloads page ready * fix community page * homepage progress * add components, adjust spacing * docs and api landing pages * a bunch of fixes, add docs and api landing pages * update deps, add deploy scripts * add readme note * update deploy command * overview page, index title * Update doc fields Note this still requires the link fields to be populated -- this is solely related to copy on the description fields * Update api_basic_categories.yml Updated API category descriptions. Like the document descriptions you'll still need to update the link headers to the proper target pages. * Add bottom hero, adjust CSS, responsive friendly * Add mega nav title * homepage adjustments, asset boosts * small fixes * docs page styling fixes * meganav title * some category link corrections * Update API categories page updated to reflect the second level headings for api categories * Update docs_detailed_categories.yml Updated to represent the existing docs structure * Update docs_detailed_categories.yml * docs page data fix, extra operator page remove * api data fix * fix makefile * update deps, add product subnav to docs and api landing pages * Rearrange non-hands-on guides to _docs_ Since there is no place for these on learn.hashicorp, we'll put them under _docs_. * WIP Redirects for guides to docs * content and component updates * font weight hotfix, redirects * fix guides and intro sidenavs * fix some redirects * small style tweaks * Redirects to learn and internally to docs * Remove redirect to `/vault` * Remove `.html` from destination on redirects * fix incorrect index redirect * final touchups * address feedback from michell for makefile and product downloads
57 lines
1.8 KiB
Markdown
57 lines
1.8 KiB
Markdown
---
|
|
layout: "docs"
|
|
page_title: "Socket - Audit Devices"
|
|
sidebar_title: "Socket"
|
|
sidebar_current: "docs-audit-socket"
|
|
description: |-
|
|
The "socket" audit device writes audit writes to a TCP or UDP socket.
|
|
---
|
|
|
|
# Socket Audit Device
|
|
|
|
The `socket` audit device writes to a TCP, UDP, or UNIX socket.
|
|
|
|
~> **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
|
|
|
|
Enable at the default path:
|
|
|
|
```text
|
|
$ vault audit enable socket
|
|
```
|
|
|
|
Supply configuration parameters via K=V pairs:
|
|
|
|
```text
|
|
$ vault audit enable socket address=127.0.0.1:9090 socket_type=tcp
|
|
```
|
|
|
|
## Configuration
|
|
|
|
- `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 <a href="https://golang.org/pkg/net/#Dial">net.Dial</a> 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.
|