mirror of
https://github.com/hashicorp/vault.git
synced 2025-09-10 08:21:09 +02:00
0660ea6fac
* Update README Let contributors know that docs will now be located in UDR * Add comments to each mdx doc Comment has been added to all mdx docs that are not partials * chore: added changelog changelog check failure * wip: removed changelog * Fix content errors * Doc spacing * Update website/content/docs/deploy/kubernetes/vso/helm.mdx Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com> --------- Co-authored-by: jonathanfrappier <92055993+jonathanfrappier@users.noreply.github.com> Co-authored-by: Tu Nguyen <im2nguyen@users.noreply.github.com>
68 lines
2.1 KiB
Plaintext
68 lines
2.1 KiB
Plaintext
---
|
||
layout: api
|
||
page_title: /sys/audit-hash - HTTP API
|
||
description: |-
|
||
The `/sys/audit-hash` endpoint is used to hash data using an audit device's
|
||
hash function and salt.
|
||
---
|
||
|
||
> [!IMPORTANT]
|
||
> **Documentation Update:** Product documentation, which were located in this repository under `/website`, are now located in [`hashicorp/web-unified-docs`](https://github.com/hashicorp/web-unified-docs), colocated with all other product documentation. Contributions to this content should be done in the `web-unified-docs` repo, and not this one. Changes made to `/website` content in this repo will not be reflected on the developer.hashicorp.com website.
|
||
|
||
# `/sys/audit-hash`
|
||
|
||
@include 'alerts/restricted-admin.mdx'
|
||
|
||
The `/sys/audit-hash` endpoint is used to calculate the hash of the data used by
|
||
an audit device'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 device'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 |
|
||
| :----- | :---------------------- |
|
||
| `POST` | `/sys/audit-hash/:path` |
|
||
|
||
### Parameters
|
||
|
||
- `path` `(string: <required>)` – Specifies the path of the audit device to
|
||
generate hashes for. This is part of the request URL.
|
||
|
||
- `input` `(string: <required>)` – Specifies the input string to hash.
|
||
|
||
### Sample payload
|
||
|
||
```json
|
||
{
|
||
"input": "my-secret-vault"
|
||
}
|
||
```
|
||
|
||
### Sample request
|
||
|
||
```shell-session
|
||
$ curl \
|
||
--header "X-Vault-Token: ..." \
|
||
--request POST \
|
||
--data @payload.json \
|
||
http://127.0.0.1:8200/v1/sys/audit-hash/example-audit
|
||
```
|
||
|
||
### Sample response
|
||
|
||
```json
|
||
{
|
||
"hash": "hmac-sha256:08ba35..."
|
||
}
|
||
```
|