Documentation

Module: audit

Provides implementation for the Vault Audit APIs

Extends

  • Vaulted

Methods

<inner> disableAudit()

Disable a specific audit backend from the vault.

Parameters:
Name Type Argument Description
options.id string

unique identifier for the audit mount
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> enableAudit()

Enable a specific audit backend for use with the vault.

Parameters:
Name Type Argument Description
options.id string

unique identifier for the audit mount
options.body.type string

the type of audit ('file', 'syslog')
options.body.description string <optional>

a description of the audit backend for operators.
options.body.options Object <optional>

options for configuring a specific type of audit backend
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> enableFileAudit()

Convenience method to enable the file audit backend for use with the vault.

Parameters:
Name Type Argument Default Description
options.id string

unique identifier for the file audit mount
options.body.path string

the directory where to write the audit files
options.body.description string <optional>

a description of the file audit backend for operators.
options.body.log_raw boolean <optional>
 false

should security sensitive information be logged raw.
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> enableSyslogAudit()

Convenience method to enable the syslog audit backend for use with the vault.

Parameters:
Name Type Argument Default Description
options.id string

unique identifier for the syslog audit mount
options.body.description string <optional>

a description of the syslog audit backend for operators.
options.body.facility string <optional>
 AUTH

syslog facility to use.
options.body.tag string <optional>
 vault

syslog tag to use.
options.body.log_raw boolean <optional>
 false

should security sensitive information be logged raw.
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> getAuditHash()

Hash the given input data with the specified audit backend's hash function and salt.

Parameters:
Name Type Argument Description
options.id string

unique identifier for the syslog audit mount
options.body.input string

the input string to hash
options.token string <optional>

the authentication token
Returns:
Type
Promise

<inner> getAuditMounts()

Gets the list of mounted audit backends for the vault.

Parameters:
Name Type Argument Description
options.token string <optional>

the authentication token
Returns:
Type
Promise