Skip to content

Add docs for oathkeeper log.redact_header feature #2310

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs for oathkeeper log.redact_header feature #2310

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/oathkeeper/configure-deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,24 @@ EOF
This configuration file will run the proxy at port 4455, the api at port 4456, and enable the anonymous authenticator, the allow
and deny authorizers, and the noop and id_token mutators.

### Secure logging

Ory Oathkeeper logs request information including headers. By default, sensitive headers like `authorization`, `cookie`,
`set-cookie`, and `x-session-token` are automatically redacted in logs.

If your application uses custom authentication headers (for example, `x-custom-authorization` or `x-api-key`), configure
Oathkeeper to redact these headers in log output:

```yaml
log:
redact_headers:
- x-custom-authorization
- x-api-key
- x-secret-token
```

You can also use the `LOG_REDACT_HEADERS` environment variable with a comma-separated list.

### Access rules

We will be using [httpbin.org](https://httpbin.org) as the upstream server. The service echoes incoming HTTP Requests and is
Expand Down
Loading