This commit updates the API documentation for the system backend to
break things apart on a per-page basis and provide specific examples.
This pattern will give more flexibility for future documentation as
well.

2017-03-16 09:46:49 -07:00

1.7 KiB

Raw Blame History

layout	page_title	sidebar_current	description
http	/sys/audit-hash - HTTP API"	docs-http-system-audit-hash	The `/sys/audit-hash` endpoint is used to hash data using an audit backend's hash function and salt.

`/sys/audit-hash`

The /sys/audit-hash endpoint is used to calculate the hash of the data used by an audit backend's hash function and salt. This can be used to search audit logs for a hashed value when the original value is known.

Calculate Hash

This endpoint hashes the given input data with the specified audit backend's hash function and salt. This endpoint can be used to discover whether a given plaintext string (the input parameter) appears in the audit log in obfuscated form.

The audit log records requests and responses. Since the Vault API is JSON-based, any binary data returned from an API call (such as a DER-format certificate) is base64-encoded by the Vault server in the response. As a result such information should also be base64-encoded to supply into the input parameter.

Method	Path	Produces
`POST`	`/sys/audit-hash/:path`	`204 (empty body)`

Parameters

path (string: <required>) – Specifies the path of the audit backend to generate hashes for. This is part of the request URL.
input (string: <required>) – Specifies the input string to hash.

Sample Payload

{
  "input": "my-secret-vault"
}

Sample Request

$ curl \
    --header "X-Vault-Token: ..." \
    --request POST \
    --data @payload.json \
    https://vault.rocks/v1/sys/audit-hash/example-audit

Sample Response

{
  "hash": "hmac-sha256:08ba35..."
}

1.7 KiB Raw Blame History Unescape Escape

/sys/audit-hash