Consul Operator Audit

Command: consul operator audit

Consul Enterprise audit logging captures a list of authenticated events that Consul processes through its HTTP API. Use the operator audit command to interact with Consul's audit logging subsystem.

Fore information and workflow guidance, refer to the audit logging documentation.

Usage: consul operator audit <subcommand> [options]
  The Audit operator command is used to interact with Consul's Audit logging subsystem. The
  command can be used to calculate the audit log hash of a given string.

Subcommands:
    hash    Computes the audit hash of a string

If ACLs are enabled, the client must supply an ACL Token with operator read or write privileges to use these commands.

hash

Corresponding HTTP API Endpoint: [POST] /v1/operator/audit-hash

Computes the audit hash of a string. Optionally compare the computed hash to a specified hash.

The following table shows this command's required ACLs. Commands do not support configuration of blocking queries or agent caching, but the corresponding HTTP endpoint may support that configuration.

Usage: consul operator audit hash -input INPUT [options]

API options

• -ca-file=<value> - Path to a CA file to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CACERT environment variable.

• -ca-path=<value> - Path to a directory of CA certificates to use for TLS when communicating with Consul. This can also be specified via the CONSUL_CAPATH environment variable.

• -client-cert=<value> - Path to a client cert file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_CERT environment variable.

• -client-key=<value> - Path to a client key file to use for TLS when verify_incoming is enabled. This can also be specified via the CONSUL_CLIENT_KEY environment variable.

• -http-addr=<addr> - Address of the Consul agent with the port. This can be an IP address or DNS address, but it must include the port. This can also be specified via the CONSUL_HTTP_ADDR environment variable. In Consul 0.8 and later, the default value is http://127.0.0.1:8500, and https can optionally be used instead. The scheme can also be set to HTTPS by setting the environment variable CONSUL_HTTP_SSL=true. This may be a unix domain socket using unix:///path/to/socket if the agent is configured to listen that way.

• -tls-server-name=<value> - The server name to use as the SNI host when connecting via TLS. This can also be specified via the CONSUL_TLS_SERVER_NAME environment variable.

• -token=<value> - ACL token to use in the request. This can also be specified via the CONSUL_HTTP_TOKEN environment variable. If unspecified, the query will default to the token of the Consul agent at the HTTP address.

• -token-file=<value> - File containing the ACL token to use in the request instead of one specified via the -token argument or CONSUL_HTTP_TOKEN environment variable. This can also be specified via the CONSUL_HTTP_TOKEN_FILE environment variable.

• -datacenter=<name> - Name of the datacenter to query. If unspecified, the query will default to the datacenter of the Consul agent at the HTTP address.

• -stale - Permit any Consul server (non-leader) to respond to this request. This allows for lower latency and higher throughput, but can result in stale data. This option has no effect on non-read operations. The default value is false.

Command options

• -hash-to-match=<string> - Optional. If specified, the command outputs whether this value matches the computed hash of the 'input' value. Should be in the format: hmac_sha256:xxxx

• -input=<string> - Specifies the input string to hash. This flag is required.

Examples

This example displays the audit hash of the provided value.

$ consul operator audit hash -input="my-value"

This example compares the audit hash of a provided value.

$ consul operator audit hash -input="my-value" -hash-to-match="hmac_sha256:37ed9ed..."