Skip to content

Commit

Permalink
Adds token pass through to docs
Browse files Browse the repository at this point in the history
Signed-off-by: JoshVanL <[email protected]>
  • Loading branch information
JoshVanL committed Sep 12, 2019
1 parent d30a52a commit 0cf02d1
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,5 +125,8 @@ users:
name: oidc
```

## Configuration
- [Token Passthrough](./docs/tasks/token-passthrough.md)

## Development
*NOTE*: building kube-oidc-proxy requires Go version 1.12 or higher.
24 changes: 24 additions & 0 deletions docs/tasks/token-passthrough.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Token Passthrough

kube-oidc-proxy can be configured to enable 'token passthrough' for tokens that
fail OIDC authentication. If enabled, kube-oidc-proxy will perform a [token
review](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication)
API call to the configured target backend using the Kubernetes API. If
successful, the request will be passed through as-is, with the token intact in
the request and no other authentication used by kube-oidc-proxy.

To enable token passthrough, include the following flag:

```
--token-passthrough
```

In the case of the Kubernetes API server, the authenticator, if audience aware,
will validate the audiences of tokens using the audience of the API server. A
new set of audiences can also be given which will be used to validate the token
against. At least one of these audiences need to be present in the audiences of
the token to be successful:

```
---token-passthrough-audiences=aud1.foo.bar,aud2.foo.bar
```

0 comments on commit 0cf02d1

Please sign in to comment.