Update release notes for v3.1.0
This commit is contained in:
parent
402ce6f0cb
commit
5b95ed3552
19
CHANGELOG.md
19
CHANGELOG.md
@ -1,5 +1,24 @@
|
|||||||
# Vx.x.x (Pre-release)
|
# Vx.x.x (Pre-release)
|
||||||
|
|
||||||
|
## Changes since v3.1.0
|
||||||
|
|
||||||
|
# v3.1.0
|
||||||
|
|
||||||
|
## Release highlights
|
||||||
|
|
||||||
|
- Introduction of ARM releases and and general improvements to Docker builds
|
||||||
|
- Improvements to OIDC provider allowing pass-through of ID Tokens
|
||||||
|
- Multiple redirect domains can now be whitelisted
|
||||||
|
- Streamed responses are now flushed periodically
|
||||||
|
|
||||||
|
## Important notes
|
||||||
|
|
||||||
|
If you have been using [#bitly/621](https://github.com/bitly/oauth2_proxy/pull/621)
|
||||||
|
and have cookies larger than the 4kb limit,
|
||||||
|
the cookie splitting pattern has changed and now uses `_` in place of `-` when
|
||||||
|
indexing cookies.
|
||||||
|
This will force users to reauthenticate the first time they use `v3.1.0`.
|
||||||
|
|
||||||
## Changes since v3.0.0
|
## Changes since v3.0.0
|
||||||
|
|
||||||
- [#14](https://github.com/pusher/oauth2_proxy/pull/14) OIDC ID Token, Authorization Headers, Refreshing and Verification (@joelspeed)
|
- [#14](https://github.com/pusher/oauth2_proxy/pull/14) OIDC ID Token, Authorization Headers, Refreshing and Verification (@joelspeed)
|
||||||
|
16
README.md
16
README.md
@ -19,17 +19,17 @@ A list of changes can be seen in the [CHANGELOG](CHANGELOG.md).
|
|||||||
|
|
||||||
1. Choose how to deploy:
|
1. Choose how to deploy:
|
||||||
|
|
||||||
a. Download [Prebuilt Binary](https://github.com/pusher/oauth2_proxy/releases) (current release is `v3.0.0`)
|
a. Download [Prebuilt Binary](https://github.com/pusher/oauth2_proxy/releases) (current release is `v3.1.0`)
|
||||||
|
|
||||||
b. Build with `$ go get github.com/pusher/oauth2_proxy` which will put the binary in `$GOROOT/bin`
|
b. Build with `$ go get github.com/pusher/oauth2_proxy` which will put the binary in `$GOROOT/bin`
|
||||||
|
|
||||||
c. Using the prebuilt docker image [quay.io/pusher/oauth2_proxy](https://quay.io/pusher/oauth2_proxy)
|
c. Using the prebuilt docker image [quay.io/pusher/oauth2_proxy](https://quay.io/pusher/oauth2_proxy) (AMD64, ARMv6 and ARM64 tags available)
|
||||||
|
|
||||||
Prebuilt binaries can be validated by extracting the file and verifying it against the `sha256sum.txt` checksum file provided for each release starting with version `v3.0.0`.
|
Prebuilt binaries can be validated by extracting the file and verifying it against the `sha256sum.txt` checksum file provided for each release starting with version `v3.0.0`.
|
||||||
|
|
||||||
```
|
```
|
||||||
sha256sum -c sha256sum.txt 2>&1 | grep OK
|
sha256sum -c sha256sum.txt 2>&1 | grep OK
|
||||||
oauth2_proxy-3.0.0.linux-amd64: OK
|
oauth2_proxy-3.1.0.linux-amd64: OK
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Select a Provider and Register an OAuth Application with a Provider
|
2. Select a Provider and Register an OAuth Application with a Provider
|
||||||
@ -427,19 +427,19 @@ server {
|
|||||||
auth_request_set $auth_cookie $upstream_http_set_cookie;
|
auth_request_set $auth_cookie $upstream_http_set_cookie;
|
||||||
add_header Set-Cookie $auth_cookie;
|
add_header Set-Cookie $auth_cookie;
|
||||||
|
|
||||||
# When using the --set-authorization flag, some provider's cookies can exceed the 4kb
|
# When using the --set-authorization flag, some provider's cookies can exceed the 4kb
|
||||||
# limit and so the OAuth2 Proxy splits these into multiple parts.
|
# limit and so the OAuth2 Proxy splits these into multiple parts.
|
||||||
# Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
|
# Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
|
||||||
# so if your cookies are larger than 4kb, you will need to extract additional cookies manually.
|
# so if your cookies are larger than 4kb, you will need to extract additional cookies manually.
|
||||||
auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;
|
auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;
|
||||||
|
|
||||||
# Extract the Cookie attributes from the first Set-Cookie header and append them
|
# Extract the Cookie attributes from the first Set-Cookie header and append them
|
||||||
# to the second part ($upstream_cookie_* variables only contain the raw cookie content)
|
# to the second part ($upstream_cookie_* variables only contain the raw cookie content)
|
||||||
if ($auth_cookie ~* "(; .*)") {
|
if ($auth_cookie ~* "(; .*)") {
|
||||||
set $auth_cookie_name_0 $auth_cookie;
|
set $auth_cookie_name_0 $auth_cookie;
|
||||||
set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";
|
set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";
|
||||||
}
|
}
|
||||||
|
|
||||||
# Send both Set-Cookie headers now if there was a second part
|
# Send both Set-Cookie headers now if there was a second part
|
||||||
if ($auth_cookie_name_upstream_1) {
|
if ($auth_cookie_name_upstream_1) {
|
||||||
add_header Set-Cookie $auth_cookie_name_0;
|
add_header Set-Cookie $auth_cookie_name_0;
|
||||||
|
Loading…
Reference in New Issue
Block a user