upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-03-21 18:10:12 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
vault/website/source/docs/http/sys-config-auditing.html.md
Brian Kassouf 590b5681cd Configure the request headers that are output to the audit log (#2321) 
* Add /sys/config/audited-headers endpoint for configuring the headers that will be audited

* Remove some debug lines

* Add a persistant layer and refactor a bit

* update the api endpoints to be more restful

* Add comments and clean up a few functions

* Remove unneeded hash structure functionaility

* Fix existing tests

* Add tests

* Add test for Applying the header config

* Add Benchmark for the ApplyConfig method

* ResetTimer on the benchmark:

* Update the headers comment

* Add test for audit broker

* Use hyphens instead of camel case

* Add size paramater to the allocation of the result map

* Fix the tests for the audit broker

* PR feedback

* update the path and permissions on config/* paths

* Add docs file

* Fix TestSystemBackend_RootPaths test
2017-02-02 11:49:20 -08:00

2.1 KiB
Raw Blame History

layout page_title sidebar_current description
http HTTP API: /sys/config/auditing docs-http-audits-audits The `/sys/config/auditing` endpoint is used to configure auditing settings.

/sys/config/auditing/request-headers

GET

Description
List the request headers that are configured to be audited. _This endpoint requires `sudo` capability._
Method
GET
Parameters
None
Returns
```javascript
{
    "headers":{
        "X-Forwarded-For": {
            "hmac":true
        }
    }
}
```

/sys/config/auditing/request-headers/

GET

Description
List the information for the given request header. _This endpoint requires `sudo` capability._
Method
GET
URL
`/sys/config/auditing/request-headers/`
Parameters
None
Returns
```javascript
{
    "X-Forwarded-For":{
        "hmac":true
    }
}
```

PUT

Description
Enable auditing of a header. _This endpoint requires `sudo` capability._
Method
PUT
URL
`/sys/config/auditing/request-headers/`
Parameters
  • hmac optional Bool, if this header's value should be hmac'ed in the audit logs. Defaults to false.
Returns
`204` response code.

DELETE

Description
Disable auditing of the given request header. _This endpoint requires `sudo` capability._
Method
DELETE
URL
`/sys/config/auditing/request-headers/`
Parameters
None
Returns
`204` response code.