Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit 0cf02d1

Browse files
committed
Adds token pass through to docs
Signed-off-by: JoshVanL <[email protected]>
1 parent d30a52a commit 0cf02d1

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,5 +125,8 @@ users:
125125
name: oidc
126126
```
127127

128+
## Configuration
129+
- [Token Passthrough](./docs/tasks/token-passthrough.md)
130+
128131
## Development
129132
*NOTE*: building kube-oidc-proxy requires Go version 1.12 or higher.

docs/tasks/token-passthrough.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Token Passthrough
2+
3+
kube-oidc-proxy can be configured to enable 'token passthrough' for tokens that
4+
fail OIDC authentication. If enabled, kube-oidc-proxy will perform a [token
5+
review](https://kubernetes.io/docs/reference/access-authn-authz/authentication/#webhook-token-authentication)
6+
API call to the configured target backend using the Kubernetes API. If
7+
successful, the request will be passed through as-is, with the token intact in
8+
the request and no other authentication used by kube-oidc-proxy.
9+
10+
To enable token passthrough, include the following flag:
11+
12+
```
13+
--token-passthrough
14+
```
15+
16+
In the case of the Kubernetes API server, the authenticator, if audience aware,
17+
will validate the audiences of tokens using the audience of the API server. A
18+
new set of audiences can also be given which will be used to validate the token
19+
against. At least one of these audiences need to be present in the audiences of
20+
the token to be successful:
21+
22+
```
23+
---token-passthrough-audiences=aud1.foo.bar,aud2.foo.bar
24+
```

0 commit comments

Comments
 (0)