@@ -1,12 +1,26 @@
11# Vx.x.x (Pre-release)
22
3+## Changes since v4.0.0
4+
5+# v4.0.0
6+
7+## Release Highlights
8+- Documentation is now on a [microsite](https://pusher.github.io/oauth2_proxy/)
9+- Health check logging can now be disabled for quieter logs
10+- Authorization Header JWTs can now be verified by the proxy to skip authentication for machine users
11+- Sessions can now be stored in Redis. This reduces refresh failures and uses smaller cookies (Recommended for those using OIDC refreshing)
12+- Logging overhaul allows customisable logging formats
13+
14+## Important Notes
15+- This release includes a number of breaking changes that will require users to
16+reconfigure their proxies. Please read the Breaking Changes below thoroughly.
17+
318## Breaking Changes
419
5−- [#231](https://github.com/pusher/oauth2_proxy/pull/231) Rework GitLab provider (@Overv)
20+- [#231](https://github.com/pusher/oauth2_proxy/pull/231) Rework GitLab provider
621 - This PR changes the configuration options for the GitLab provider to use
722 a self-hosted instance. You now need to specify a `-oidc-issuer-url` rather than
823 explicit `-login-url`, `-redeem-url` and `-validate-url` parameters.
9−
1024- [#186](https://github.com/pusher/oauth2_proxy/pull/186) Make config consistent
1125 - This PR changes configuration options so that all flags have a config counterpart
1226 of the same name but with underscores (`_`) in place of hyphens (`-`).
@@ -23,8 +37,7 @@
2337 This change affects the following existing environment variables:
2438 - The `OAUTH2_SKIP_OIDC_DISCOVERY` environment variable is now `OAUTH2_PROXY_SKIP_OIDC_DISCOVERY`.
2539 - The `OAUTH2_OIDC_JWKS_URL` environment variable is now `OAUTH2_PROXY_OIDC_JWKS_URL`.
26−
27−- [#146](https://github.com/pusher/oauth2_proxy/pull/146) Use full email address as `User` if the auth response did not contain a `User` field (@gargath)
40+- [#146](https://github.com/pusher/oauth2_proxy/pull/146) Use full email address as `User` if the auth response did not contain a `User` field
2841 - This change modifies the contents of the `X-Forwarded-User` header supplied by the proxy for users where the auth response from the IdP did not contain
2942 a username.
3043 In that case, this header used to only contain the local part of the user's email address (e.g. `john.doe` for `john.doe@example.com`) but now contains
@@ -45,7 +58,7 @@
4558- [#186](https://github.com/pusher/oauth2_proxy/pull/186) Make config consistent (@JoelSpeed)
4659- [#187](https://github.com/pusher/oauth2_proxy/pull/187) Move root packages to pkg folder (@JoelSpeed)
4760- [#65](https://github.com/pusher/oauth2_proxy/pull/65) Improvements to authenticate requests with a JWT bearer token in the `Authorization` header via
48− the `-skip-jwt-bearer-token` options.
61+ the `-skip-jwt-bearer-token` options. (@brianv0)
4962 - Additional verifiers can be configured via the `-extra-jwt-issuers` flag if the JWT issuers is either an OpenID provider or has a JWKS URL
5063 (e.g. `https://example.com/.well-known/jwks.json`).
5164- [#180](https://github.com/pusher/oauth2_proxy/pull/180) Minor refactor of core proxying path (@aeijdenberg).
@@ -86,7 +99,6 @@
8699 - Implement two new flags to customize the logging format
87100 - `-standard-logging-format` Sets the format for standard logging
88101 - `-auth-logging-format` Sets the format for auth logging
89−
90102- [#111](https://github.com/pusher/oauth2_proxy/pull/111) Add option for telling where to find a login.gov JWT key file (@timothy-spencer)
91103- [#170](https://github.com/pusher/oauth2_proxy/pull/170) Restore binary tarball contents to be compatible with bitlys original tarballs (@zeha)
92104- [#185](https://github.com/pusher/oauth2_proxy/pull/185) Fix an unsupported protocol scheme error during token validation when using the Azure provider (@jonas)
@@ -94,7 +106,7 @@
94106 - Google Group membership is additionally checked via email address, allowing users outside a GSuite domain to be authorized.
95107- [#195](https://github.com/pusher/oauth2_proxy/pull/195) Add `-banner` flag for overriding the banner line that is displayed (@steakunderscore)
96108- [#198](https://github.com/pusher/oauth2_proxy/pull/198) Switch from gometalinter to golangci-lint (@steakunderscore)
97−- [#159](https://github.com/pusher/oauth2_proxy/pull/159) Add option to skip the OIDC provider verified email check: `--insecure-oidc-allow-unverified-email`
109+- [#159](https://github.com/pusher/oauth2_proxy/pull/159) Add option to skip the OIDC provider verified email check: `--insecure-oidc-allow-unverified-email` (@djfinlay)
98110- [#210](https://github.com/pusher/oauth2_proxy/pull/210) Update base image from Alpine 3.9 to 3.10 (@steakunderscore)
99111- [#201](https://github.com/pusher/oauth2_proxy/pull/201) Add Bitbucket as new OAuth2 provider, accepts email, team and repository permissions to determine authorization (@aledeganopix4d)
100112 - Implement flags to enable Bitbucket authentication: