git.iko.soy/typeable/oauth2-proxy
on master help sign in
config: clarify skip-jwt-bearer-tokens needs (#851)

i.e. that the token must have a recognized `aud` field.

commit8b44ddd547fb28df0165fb184212fb4dd8fa851e authorJakub Holy <jakub.holy@telia.no> dateMon 19 Oct 2020, 20:14 (6 years ago) parent420a34f
1 file changed+2−2
docs/configuration/configuration.md+2−2
docs/configuration/configuration.md+2−2
@@ -46,7 +46,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
4646| `--display-htpasswd-form` | bool | display username / password login form if an htpasswd file is provided | true |
4747| `--email-domain` | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email | |
4848| `--errors-to-info-log` | bool | redirects error-level logging to default log channel instead of stderr | |
49−| `--extra-jwt-issuers` | string | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`) | |
49+| `--extra-jwt-issuers` | string | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`) | |
5050| `--exclude-logging-paths` | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` |`""` (no paths excluded) |
5151| `--flush-interval` | duration | period between flushing response buffers when streaming responses | `"1s"` |
5252| `--force-https` | bool | enforce https redirect | `false` |
@@ -122,7 +122,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
122122| `--skip-auth-regex` | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times) | |
123123| `--skip-auth-route` | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods | |
124124| `--skip-auth-strip-headers` | bool | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy for allowlisted requests (`--skip-auth-route`, `--skip-auth-regex`, `--skip-auth-preflight`, `--trusted-ip`) | false |
125−| `--skip-jwt-bearer-tokens` | bool | will skip requests that have verified JWT bearer tokens | false |
125+| `--skip-jwt-bearer-tokens` | bool | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`) | false |
126126| `--skip-oidc-discovery` | bool | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case | false |
127127| `--skip-provider-button` | bool | will skip sign-in-page to directly reach the next step: oauth/start | false |
128128| `--ssl-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS providers | false |