mirror of
https://github.com/nais/wonderwall.git
synced 2026-05-10 18:37:00 +00:00
130 lines
6.1 KiB
Markdown
130 lines
6.1 KiB
Markdown
# wonderwall
|
|
|
|
|
|
|
|
`wonderwall` is an application that implements _OpenID Connect_ (OIDC) in a way that makes it easy to plug into
|
|
Kubernetes as a sidecar. As such, this is OIDC as a sidecar, or OaaS, or to explain the joke: Oasis - Wonderwall
|
|
|
|
## Features
|
|
|
|
Wonderwall currently implements a client that
|
|
follows [ID-porten's preferred setup](https://docs.digdir.no/oidc_guide_idporten.html):
|
|
|
|
- OpenID Connect Authorization Code Flow with mandatory use of PKCE, state and nonce - aiming to be compliant with OAuth
|
|
2.1.
|
|
- Validation of `id_token` in accordance with the OpenID Connect Core specifications.
|
|
- Client authentication with the authorization server as
|
|
per [RFC 7523, Section 2.2](https://datatracker.ietf.org/doc/html/rfc7523).
|
|
- Support for [RP-initiated logout](https://openid.net/specs/openid-connect-rpinitiated-1_0.html).
|
|
- Support for [front-channel logout](https://openid.net/specs/openid-connect-frontchannel-1_0.html).
|
|
|
|
Wonderwall functions as an optionally intercepting reverse proxy that proxies requests to a downstream host.
|
|
|
|
By default, it does not actually intercept any requests other than to remove the `Authorization` header if the user
|
|
agent does not have a valid session with Wonderwall.
|
|
|
|
## Endpoints
|
|
|
|
Wonderwall exposes and owns these endpoints (which means they will never be proxied downstream):
|
|
|
|
* `/oauth2/login` redirects the user to the Identity Provider to perform the OpenID Connect Authorization Code Flow.
|
|
* `/oauth2/callback` handles callbacks from Identity Provider as part of the OpenID Connect Authorization Code Flow.
|
|
* `/oauth2/logout` triggers self-initiated/RP-initiated logout.
|
|
* `/oauth2/logout/frontchannel` implements front-channel logout.
|
|
|
|
## Usage
|
|
|
|
In order to initiate authenticated user sessions, the user must be redirected to the `/oauth2/login` endpoint, which
|
|
performs the OIDC Auth Code flow. The user will then be redirected back to the downstream application, with
|
|
the `Authorization` header containing a `Bearer`
|
|
access token. As long as the user has an active session with Wonderwall, all further requests to the downstream
|
|
application will have the `Authorization` header set.
|
|
|
|
### Configuration
|
|
|
|
Wonderwall can be configured using either command-line flags or equivalent environment variables (i.e. `-`, `.` -> `_`
|
|
and uppercase), with `WONDERWALL_` as prefix. E.g.:
|
|
|
|
```text
|
|
openid.client-id -> WONDERWALL_OPENID_CLIENT_ID
|
|
```
|
|
|
|
The following flags are available:
|
|
|
|
```shell
|
|
--auto-login Automatically redirect user to login if the user does not have a valid session for all proxied downstream requests.
|
|
--bind-address string Listen address for public connections. (default "127.0.0.1:3000")
|
|
--encryption-key string Base64 encoded 256-bit cookie encryption key; must be identical in instances that share session store.
|
|
--error-redirect-uri string URI to redirect user to on errors for custom error handling.
|
|
--ingress string Ingress used to access the main application.
|
|
--log-format string Log format, either 'json' or 'text'. (default "json")
|
|
--log-level string Logging verbosity level. (default "debug")
|
|
--metrics-bind-address string Listen address for metrics only. (default "127.0.0.1:3001")
|
|
--openid.acr-values string Space separated string that configures the default security level (acr_values) parameter for authorization requests.
|
|
--openid.client-id string Client ID for the OpenID client.
|
|
--openid.client-jwk string JWK containing the private key for the OpenID client in string format.
|
|
--openid.post-logout-redirect-uri string URI for redirecting the user after successful logout at the Identity Provider.
|
|
--openid.provider string Provider configuration to load and use, either 'openid', 'azure', 'idporten'. (default "openid")
|
|
--openid.scopes strings List of additional scopes (other than 'openid') that should be used during the login flow.
|
|
--openid.ui-locales string Space-separated string that configures the default UI locale (ui_locales) parameter for OAuth2 consent screen.
|
|
--openid.well-known-url string URI to the well-known OpenID Configuration metadata document.
|
|
--redis.address string Address of Redis. An empty value will use in-memory session storage.
|
|
--redis.password string Password for Redis.
|
|
--redis.tls Whether or not to use TLS for connecting to Redis. (default true)
|
|
--redis.username string Username for Redis.
|
|
--session-max-lifetime duration Max lifetime for user sessions. (default 1h0m0s)
|
|
--upstream-host string Address of upstream host. (default "127.0.0.1:8080")
|
|
```
|
|
|
|
At minimum, the following configuration must be provided:
|
|
|
|
- `openid.client-id`
|
|
- `openid.client-jwk`
|
|
- `openid.well-known-url`
|
|
- `ingress`
|
|
|
|
#### ID-porten
|
|
|
|
When the `openid.provider` flag is set to `idporten`, the following environment variables are bound to the required `openid`
|
|
flags described previously:
|
|
|
|
- `IDPORTEN_CLIENT_ID`
|
|
Client ID for the client at ID-porten.
|
|
- `IDPORTEN_CLIENT_JWK`
|
|
Private key belonging to the client in JWK format.
|
|
- `IDPORTEN_WELL_KNOWN_URL`
|
|
Well-known OpenID Configuration endpoint for ID-porten: <https://docs.digdir.no/oidc_func_wellknown.html>.
|
|
|
|
The default values for the following flags are also changed:
|
|
|
|
| Flag | Value |
|
|
| ---- | ----- |
|
|
| `openid.acr-values` | `Level4` |
|
|
| `openid.ui-locales` | `nb` |
|
|
|
|
#### Azure AD
|
|
|
|
When the `openid.provider` flag is set to `azure`, the following environment variables are bound to the required flags
|
|
described previously:
|
|
|
|
- `AZURE_APP_CLIENT_ID`
|
|
Client ID for the client at Azure AD.
|
|
- `AZURE_APP_CLIENT_JWK`
|
|
Private key belonging to the client in JWK format.
|
|
- `AZURE_APP_WELL_KNOWN_URL`
|
|
Well-known OpenID Configuration endpoint for Azure AD.
|
|
|
|
## Development
|
|
|
|
### Requirements
|
|
|
|
- Go 1.17
|
|
|
|
### Setup
|
|
|
|
`make wonderwall` and `./bin/wonderwall`
|
|
|
|
See [configuration](#configuration).
|
|
|
|
Optionally run the Redis server with `docker-compose up`.
|