Compare commits
16 Commits
1a32885dcf
...
4b6d7a2428
| Author | SHA1 | Date |
|---|---|---|
|
|
4b6d7a2428 | |
|
|
110d51d1d7 | |
|
|
8f687e4d0c | |
|
|
f950dc9942 | |
|
|
31b275f580 | |
|
|
ea1dc3f606 | |
|
|
51e80f24ef | |
|
|
c0a087d7f2 | |
|
|
4295f0c1f9 | |
|
|
a50bbcd6f6 | |
|
|
dea0d0cf44 | |
|
|
e693f4070a | |
|
|
5539e59002 | |
|
|
65ef2ca3c9 | |
|
|
bccc988366 | |
|
|
a3349add54 |
|
|
@ -17,7 +17,7 @@ jobs:
|
||||||
uses: actions/checkout@v5
|
uses: actions/checkout@v5
|
||||||
|
|
||||||
- name: Set up Go
|
- name: Set up Go
|
||||||
uses: actions/setup-go@v5
|
uses: actions/setup-go@v6
|
||||||
with:
|
with:
|
||||||
go-version-file: go.mod
|
go-version-file: go.mod
|
||||||
id: go
|
id: go
|
||||||
|
|
@ -25,7 +25,7 @@ jobs:
|
||||||
- name: Get dependencies
|
- name: Get dependencies
|
||||||
env:
|
env:
|
||||||
# renovate: datasource=github-tags depName=golangci/golangci-lint
|
# renovate: datasource=github-tags depName=golangci/golangci-lint
|
||||||
GOLANGCI_LINT_VERSION: v2.4.0
|
GOLANGCI_LINT_VERSION: v2.5.0
|
||||||
run: |
|
run: |
|
||||||
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
|
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
|
||||||
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ jobs:
|
||||||
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
||||||
|
|
||||||
- name: Setup node
|
- name: Setup node
|
||||||
uses: actions/setup-node@v4
|
uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
node-version-file: docs/package.json
|
node-version-file: docs/package.json
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,7 @@ jobs:
|
||||||
id: pages
|
id: pages
|
||||||
uses: actions/configure-pages@v5
|
uses: actions/configure-pages@v5
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
# renovate: datasource=node-version depName=node
|
# renovate: datasource=node-version depName=node
|
||||||
node-version: 22
|
node-version: 22
|
||||||
|
|
@ -37,7 +37,7 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v5
|
- uses: actions/checkout@v5
|
||||||
|
|
||||||
- uses: actions/setup-node@v4
|
- uses: actions/setup-node@v6
|
||||||
with:
|
with:
|
||||||
# renovate: datasource=node-version depName=node
|
# renovate: datasource=node-version depName=node
|
||||||
node-version: 22
|
node-version: 22
|
||||||
|
|
|
||||||
|
|
@ -9,7 +9,7 @@ jobs:
|
||||||
pull-requests: write
|
pull-requests: write
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/labeler@v5
|
- uses: actions/labeler@v6
|
||||||
with:
|
with:
|
||||||
sync-labels: true
|
sync-labels: true
|
||||||
dot: true
|
dot: true
|
||||||
|
|
|
||||||
|
|
@ -43,14 +43,14 @@ jobs:
|
||||||
id: tag
|
id: tag
|
||||||
|
|
||||||
- name: Set up go
|
- name: Set up go
|
||||||
uses: actions/setup-go@v5
|
uses: actions/setup-go@v6
|
||||||
with:
|
with:
|
||||||
go-version-file: go.mod
|
go-version-file: go.mod
|
||||||
|
|
||||||
- name: Get dependencies
|
- name: Get dependencies
|
||||||
env:
|
env:
|
||||||
# renovate: datasource=github-tags depName=golangci/golangci-lint
|
# renovate: datasource=github-tags depName=golangci/golangci-lint
|
||||||
GOLANGCI_LINT_VERSION: v2.4.0
|
GOLANGCI_LINT_VERSION: v2.5.0
|
||||||
run: |
|
run: |
|
||||||
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
|
curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin ${GOLANGCI_LINT_VERSION}
|
||||||
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
|
||||||
|
|
@ -64,7 +64,7 @@ jobs:
|
||||||
|
|
||||||
# Upload artifacts in case of workflow failure
|
# Upload artifacts in case of workflow failure
|
||||||
- name: Upload Artifacts
|
- name: Upload Artifacts
|
||||||
uses: actions/upload-artifact@v4
|
uses: actions/upload-artifact@v5
|
||||||
with:
|
with:
|
||||||
name: oauth2-proxy-artifacts
|
name: oauth2-proxy-artifacts
|
||||||
path: |
|
path: |
|
||||||
|
|
|
||||||
|
|
@ -10,7 +10,7 @@ jobs:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/stale@v9
|
- uses: actions/stale@v10
|
||||||
with:
|
with:
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
days-before-stale: 180
|
days-before-stale: 180
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,11 @@
|
||||||
|
|
||||||
## Changes since v7.12.0
|
## Changes since v7.12.0
|
||||||
|
|
||||||
|
- [#3228](https://github.com/oauth2-proxy/oauth2-proxy/pull/3228) fix: use GetSecret() in ticket.go makeCookie to respect cookie-secret-file (@stagswtf)
|
||||||
|
- [#3244](https://github.com/oauth2-proxy/oauth2-proxy/pull/3244) chore(deps): upgrade to latest go1.25.3 (@tuunit)
|
||||||
|
- [#3238](https://github.com/oauth2-proxy/oauth2-proxy/pull/3238) chore: Replace pkg/clock with narrowly targeted stub clocks (@dsymonds)
|
||||||
|
- [3237](https://github.com/oauth2-proxy/oauth2-proxy/pull/3237) - Option to use organization id for preferred username in Google Provider (@pixeldrew)
|
||||||
|
|
||||||
# V7.12.0
|
# V7.12.0
|
||||||
|
|
||||||
## Release Highlights
|
## Release Highlights
|
||||||
|
|
@ -119,7 +124,7 @@ For detailed information, migration guidance, and security implications, see the
|
||||||
- 🕵️♀️ Vulnerabilities have been addressed
|
- 🕵️♀️ Vulnerabilities have been addressed
|
||||||
- [CVE-2025-22871](https://github.com/advisories/GHSA-g9pc-8g42-g6vq)
|
- [CVE-2025-22871](https://github.com/advisories/GHSA-g9pc-8g42-g6vq)
|
||||||
- 🐛 Squashed some bugs
|
- 🐛 Squashed some bugs
|
||||||
|
|
||||||
## Important Notes
|
## Important Notes
|
||||||
|
|
||||||
## Breaking Changes
|
## Breaking Changes
|
||||||
|
|
|
||||||
25
Makefile
25
Makefile
|
|
@ -36,13 +36,12 @@ REPOSITORY ?= oauth2-proxy
|
||||||
DATE := $(shell date +"%Y%m%d")
|
DATE := $(shell date +"%Y%m%d")
|
||||||
.NOTPARALLEL:
|
.NOTPARALLEL:
|
||||||
|
|
||||||
GO_MAJOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f1)
|
# The go version in go.mod used for the Docker build toolchain, without the patch
|
||||||
GO_MINOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f2)
|
GO_MOD_VERSION_MINOR := $(shell $(GO) list -f '{{printf "%.4s" .Module.GoVersion}}' )
|
||||||
|
|
||||||
GO_MOD_VERSION = $(shell sed -En 's/^go ([[:digit:]]\.[[:digit:]]+)\.[[:digit:]]+/\1/p' go.mod)
|
# From go1.21 go will transparently download the toolchain declared in go.mod. https://go.dev/doc/toolchain
|
||||||
MINIMUM_SUPPORTED_GO_MAJOR_VERSION = $(shell echo ${GO_MOD_VERSION} | cut -d' ' -f1 | cut -d'.' -f1)
|
# We don't need to keep this message updated: the important info is in go.mod.
|
||||||
MINIMUM_SUPPORTED_GO_MINOR_VERSION = $(shell echo ${GO_MOD_VERSION} | cut -d' ' -f1 | cut -d'.' -f2)
|
GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least go1.21
|
||||||
GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION).$(MINIMUM_SUPPORTED_GO_MINOR_VERSION)
|
|
||||||
|
|
||||||
ifeq ($(COVER),true)
|
ifeq ($(COVER),true)
|
||||||
TESTCOVER ?= -coverprofile c.out
|
TESTCOVER ?= -coverprofile c.out
|
||||||
|
|
@ -56,7 +55,7 @@ build: validate-go-version clean $(BINARY) ## Build and create oauth2-proxy bina
|
||||||
$(BINARY):
|
$(BINARY):
|
||||||
CGO_ENABLED=0 $(GO) build -a -installsuffix cgo -ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" -o $@ github.com/oauth2-proxy/oauth2-proxy/v7
|
CGO_ENABLED=0 $(GO) build -a -installsuffix cgo -ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" -o $@ github.com/oauth2-proxy/oauth2-proxy/v7
|
||||||
|
|
||||||
DOCKER_BUILDX_COMMON_ARGS ?= --build-arg BUILD_IMAGE=docker.io/library/golang:${GO_MOD_VERSION}-bookworm --build-arg VERSION=${VERSION}
|
DOCKER_BUILDX_COMMON_ARGS ?= --build-arg BUILD_IMAGE=docker.io/library/golang:$(GO_MOD_VERSION_MINOR)-bookworm --build-arg VERSION=$(VERSION)
|
||||||
|
|
||||||
DOCKER_BUILD_PLATFORM ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v7,linux/s390x
|
DOCKER_BUILD_PLATFORM ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v7,linux/s390x
|
||||||
DOCKER_BUILD_RUNTIME_IMAGE ?= gcr.io/distroless/static:nonroot
|
DOCKER_BUILD_RUNTIME_IMAGE ?= gcr.io/distroless/static:nonroot
|
||||||
|
|
@ -67,7 +66,7 @@ DOCKER_BUILDX_PUSH := $(DOCKER_BUILDX) --push
|
||||||
DOCKER_BUILDX_PUSH_X_PLATFORM := $(DOCKER_BUILDX_PUSH) --platform ${DOCKER_BUILD_PLATFORM}
|
DOCKER_BUILDX_PUSH_X_PLATFORM := $(DOCKER_BUILDX_PUSH) --platform ${DOCKER_BUILD_PLATFORM}
|
||||||
|
|
||||||
DOCKER_BUILD_PLATFORM_ALPINE ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v6,linux/arm/v7,linux/s390x
|
DOCKER_BUILD_PLATFORM_ALPINE ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v6,linux/arm/v7,linux/s390x
|
||||||
DOCKER_BUILD_RUNTIME_IMAGE_ALPINE ?= alpine:3.22.1
|
DOCKER_BUILD_RUNTIME_IMAGE_ALPINE ?= alpine:3.22.2
|
||||||
DOCKER_BUILDX_ARGS_ALPINE ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE_ALPINE} ${DOCKER_BUILDX_COMMON_ARGS}
|
DOCKER_BUILDX_ARGS_ALPINE ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE_ALPINE} ${DOCKER_BUILDX_COMMON_ARGS}
|
||||||
DOCKER_BUILDX_X_PLATFORM_ALPINE := docker buildx build ${DOCKER_BUILDX_ARGS_ALPINE} --platform ${DOCKER_BUILD_PLATFORM_ALPINE}
|
DOCKER_BUILDX_X_PLATFORM_ALPINE := docker buildx build ${DOCKER_BUILDX_ARGS_ALPINE} --platform ${DOCKER_BUILD_PLATFORM_ALPINE}
|
||||||
DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE := $(DOCKER_BUILDX_X_PLATFORM_ALPINE) --push
|
DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE := $(DOCKER_BUILDX_X_PLATFORM_ALPINE) --push
|
||||||
|
|
@ -158,15 +157,7 @@ lint: validate-go-version ## Lint all files using golangci-lint
|
||||||
|
|
||||||
.PHONY: validate-go-version
|
.PHONY: validate-go-version
|
||||||
validate-go-version: ## Validate Go environment requirements
|
validate-go-version: ## Validate Go environment requirements
|
||||||
@if [ $(GO_MAJOR_VERSION) -gt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
|
@$(GO) list . >/dev/null || { echo '$(GO_VERSION_VALIDATION_ERR_MSG)'; exit 1; }
|
||||||
exit 0 ;\
|
|
||||||
elif [ $(GO_MAJOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \
|
|
||||||
echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
|
|
||||||
exit 1; \
|
|
||||||
elif [ $(GO_MINOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MINOR_VERSION) ] ; then \
|
|
||||||
echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\
|
|
||||||
exit 1; \
|
|
||||||
fi
|
|
||||||
|
|
||||||
# local-env can be used to interact with the local development environment
|
# local-env can be used to interact with the local development environment
|
||||||
# eg:
|
# eg:
|
||||||
|
|
|
||||||
|
|
@ -39,7 +39,7 @@ services:
|
||||||
httpbin: {}
|
httpbin: {}
|
||||||
|
|
||||||
gitea:
|
gitea:
|
||||||
image: gitea/gitea:1.24.5
|
image: gitea/gitea:1.24.7
|
||||||
container_name: gitea
|
container_name: gitea
|
||||||
environment:
|
environment:
|
||||||
- USER_UID=1000
|
- USER_UID=1000
|
||||||
|
|
|
||||||
|
|
@ -55,7 +55,7 @@ services:
|
||||||
httpbin: {}
|
httpbin: {}
|
||||||
dex:
|
dex:
|
||||||
container_name: dex
|
container_name: dex
|
||||||
image: ghcr.io/dexidp/dex:v2.43.1
|
image: ghcr.io/dexidp/dex:v2.44.0
|
||||||
command: dex serve /dex.yaml
|
command: dex serve /dex.yaml
|
||||||
hostname: dex
|
hostname: dex
|
||||||
volumes:
|
volumes:
|
||||||
|
|
@ -78,7 +78,7 @@ services:
|
||||||
httpbin: {}
|
httpbin: {}
|
||||||
etcd:
|
etcd:
|
||||||
container_name: etcd
|
container_name: etcd
|
||||||
image: gcr.io/etcd-development/etcd:v3.6.4
|
image: gcr.io/etcd-development/etcd:v3.6.5
|
||||||
entrypoint: /usr/local/bin/etcd
|
entrypoint: /usr/local/bin/etcd
|
||||||
command:
|
command:
|
||||||
- --listen-client-urls=http://0.0.0.0:2379
|
- --listen-client-urls=http://0.0.0.0:2379
|
||||||
|
|
|
||||||
|
|
@ -34,7 +34,7 @@ services:
|
||||||
# Reverse proxy
|
# Reverse proxy
|
||||||
gateway:
|
gateway:
|
||||||
container_name: traefik
|
container_name: traefik
|
||||||
image: traefik:v2.11.28
|
image: traefik:v2.11.29
|
||||||
volumes:
|
volumes:
|
||||||
- "./traefik:/etc/traefik"
|
- "./traefik:/etc/traefik"
|
||||||
ports:
|
ports:
|
||||||
|
|
|
||||||
|
|
@ -29,7 +29,7 @@ services:
|
||||||
- httpbin
|
- httpbin
|
||||||
dex:
|
dex:
|
||||||
container_name: dex
|
container_name: dex
|
||||||
image: ghcr.io/dexidp/dex:v2.43.1
|
image: ghcr.io/dexidp/dex:v2.44.0
|
||||||
command: dex serve /dex.yaml
|
command: dex serve /dex.yaml
|
||||||
hostname: dex
|
hostname: dex
|
||||||
volumes:
|
volumes:
|
||||||
|
|
@ -52,7 +52,7 @@ services:
|
||||||
httpbin: {}
|
httpbin: {}
|
||||||
etcd:
|
etcd:
|
||||||
container_name: etcd
|
container_name: etcd
|
||||||
image: gcr.io/etcd-development/etcd:v3.6.4
|
image: gcr.io/etcd-development/etcd:v3.6.5
|
||||||
entrypoint: /usr/local/bin/etcd
|
entrypoint: /usr/local/bin/etcd
|
||||||
command:
|
command:
|
||||||
- --listen-client-urls=http://0.0.0.0:2379
|
- --listen-client-urls=http://0.0.0.0:2379
|
||||||
|
|
|
||||||
|
|
@ -1,15 +1,15 @@
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: dex
|
- name: dex
|
||||||
repository: https://charts.dexidp.io
|
repository: https://charts.dexidp.io
|
||||||
version: 0.23.0
|
version: 0.24.0
|
||||||
- name: oauth2-proxy
|
- name: oauth2-proxy
|
||||||
repository: https://oauth2-proxy.github.io/manifests
|
repository: https://oauth2-proxy.github.io/manifests
|
||||||
version: 7.14.1
|
version: 7.18.0
|
||||||
- name: httpbin
|
- name: httpbin
|
||||||
repository: https://conservis.github.io/helm-charts
|
repository: https://conservis.github.io/helm-charts
|
||||||
version: 1.1.0
|
version: 1.1.0
|
||||||
- name: hello-world
|
- name: hello-world
|
||||||
repository: https://conservis.github.io/helm-charts
|
repository: https://conservis.github.io/helm-charts
|
||||||
version: 1.1.0
|
version: 1.1.0
|
||||||
digest: sha256:9b18e072db6863053c2967d023929ab4b9c03b6bd84f6529d90fe7a9ec5e315f
|
digest: sha256:fee913531bfb67e5555e995d8fb040c330e6eb4b5a8c777ceb9841135ea9bb84
|
||||||
generated: "2025-07-20T08:56:43.559585022Z"
|
generated: "2025-10-28T06:46:35.38300324Z"
|
||||||
|
|
|
||||||
|
|
@ -3,10 +3,10 @@ description: K8S example based on https://kind.sigs.k8s.io
|
||||||
name: kubernetes
|
name: kubernetes
|
||||||
dependencies:
|
dependencies:
|
||||||
- name: dex
|
- name: dex
|
||||||
version: 0.23.0
|
version: 0.24.0
|
||||||
repository: https://charts.dexidp.io
|
repository: https://charts.dexidp.io
|
||||||
- name: oauth2-proxy
|
- name: oauth2-proxy
|
||||||
version: &chartVersion 7.14.1
|
version: &chartVersion 7.18.0
|
||||||
repository: https://oauth2-proxy.github.io/manifests
|
repository: https://oauth2-proxy.github.io/manifests
|
||||||
# https://github.com/postmanlabs/httpbin/issues/549 is still in progress, for now using a non-official chart
|
# https://github.com/postmanlabs/httpbin/issues/549 is still in progress, for now using a non-official chart
|
||||||
- name: httpbin
|
- name: httpbin
|
||||||
|
|
|
||||||
|
|
@ -252,6 +252,8 @@ Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
|
||||||
| `serviceAccountJson` | _string_ | ServiceAccountJSON is the path to the service account json credentials |
|
| `serviceAccountJson` | _string_ | ServiceAccountJSON is the path to the service account json credentials |
|
||||||
| `useApplicationDefaultCredentials` | _bool_ | UseApplicationDefaultCredentials is a boolean whether to use Application Default Credentials instead of a ServiceAccountJSON |
|
| `useApplicationDefaultCredentials` | _bool_ | UseApplicationDefaultCredentials is a boolean whether to use Application Default Credentials instead of a ServiceAccountJSON |
|
||||||
| `targetPrincipal` | _string_ | TargetPrincipal is the Google Service Account used for Application Default Credentials |
|
| `targetPrincipal` | _string_ | TargetPrincipal is the Google Service Account used for Application Default Credentials |
|
||||||
|
| `useOrganizationId` | _bool_ | UseOrganizationId indicates whether to use the organization ID as the UserName claim |
|
||||||
|
| `adminApiUserScope` | _string_ | user scope needed for fetching user organization information from admin api, can be one of cloud, user or readonly |
|
||||||
|
|
||||||
### Header
|
### Header
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -77,23 +77,15 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
When you use ingress-nginx in Kubernetes, you MUST use `kubernetes/ingress-nginx` (which includes the Lua module) and the following configuration snippet for your `Ingress`.
|
When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
|
||||||
Variables set with `auth_request_set` are not `set`-able in plain nginx config when the location is processed via `proxy_pass` and then may only be processed by Lua.
|
|
||||||
Note that `nginxinc/kubernetes-ingress` does not include the Lua module.
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
nginx.ingress.kubernetes.io/auth-response-headers: Authorization
|
nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
|
||||||
nginx.ingress.kubernetes.io/auth-signin: https://$host/oauth2/start?rd=$escaped_request_uri
|
nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
|
||||||
nginx.ingress.kubernetes.io/auth-url: https://$host/oauth2/auth
|
|
||||||
nginx.ingress.kubernetes.io/configuration-snippet: |
|
|
||||||
auth_request_set $name_upstream_1 $upstream_cookie_name_1;
|
|
||||||
|
|
||||||
access_by_lua_block {
|
|
||||||
if ngx.var.name_upstream_1 ~= "" then
|
|
||||||
ngx.header["Set-Cookie"] = "name_1=" .. ngx.var.name_upstream_1 .. ngx.var.auth_cookie:match("(; .*)")
|
|
||||||
end
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This minimal configuration works for standard authentication flows. Lua/cookie handling is only needed for advanced scenarios (e.g., multi-part cookies, custom session logic). See the official ingress-nginx example: https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/.
|
||||||
|
|
||||||
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
||||||
|
|
||||||
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
||||||
|
|
|
||||||
|
|
@ -5,13 +5,15 @@ title: Google (default)
|
||||||
|
|
||||||
## Config Options
|
## Config Options
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
| Flag | Toml Field | Type | Description | Default |
|
||||||
| ---------------------------------------------- | -------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
|
|-------------------------------------------------|----------------------------------------------| ------ |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|
||||||
| `--google-admin-email` | `google_admin_email` | string | the google admin to impersonate for api calls | |
|
| `--google-admin-email` | `google_admin_email` | string | the google admin to impersonate for api calls | |
|
||||||
| `--google-group` | `google_groups` | string | restrict logins to members of this google group (may be given multiple times). If not specified and service account or default credentials are configured, all user groups will be allowed. | |
|
| `--google-group` | `google_groups` | string | restrict logins to members of this google group (may be given multiple times). If not specified and service account or default credentials are configured, all user groups will be allowed. | |
|
||||||
| `--google-service-account-json` | `google_service_account_json` | string | the path to the service account json credentials | |
|
| `--google-service-account-json` | `google_service_account_json` | string | the path to the service account json credentials | |
|
||||||
| `--google-use-application-default-credentials` | `google_use_application_default_credentials` | bool | use application default credentials instead of service account json (i.e. GKE Workload Identity) | |
|
| `--google-use-application-default-credentials` | `google_use_application_default_credentials` | bool | use application default credentials instead of service account json (i.e. GKE Workload Identity) | |
|
||||||
| `--google-target-principal` | `google_target_principal` | bool | the target principal to impersonate when using ADC | defaults to the service account configured for ADC |
|
| `--google-target-principal` | `google_target_principal` | bool | the target principal to impersonate when using ADC | defaults to the service account configured for ADC |
|
||||||
|
| `--google-use-organization-id` | `google_use_organization_id` | bool | use organization id as preferred username | false |
|
||||||
|
| `--google-admin-api-user-scope` | `google_admin_api_user_scope` | string | the OAuth scope to use when querying the Google Admin SDK for organization id, can be 'readonly', 'user' or 'cloud'<br/> | `readonly` |
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
|
@ -73,3 +75,10 @@ can be leveraged through a feature called Workload Identity. Follow Google's [gu
|
||||||
to set up Workload Identity.
|
to set up Workload Identity.
|
||||||
|
|
||||||
When deployed outside of GCP, [Workload Identity Federation](https://cloud.google.com/docs/authentication/provide-credentials-adc#wlif) might be an option.
|
When deployed outside of GCP, [Workload Identity Federation](https://cloud.google.com/docs/authentication/provide-credentials-adc#wlif) might be an option.
|
||||||
|
|
||||||
|
##### Using Organization ID as Preferred Username (optional)
|
||||||
|
By default, the google provider uses the google id as username. If you would like to use an organization id instead, you can set the `google-use-organization-id` flag to true.
|
||||||
|
This requires that the service account used to query the Google Admin SDK has one of the following scopes granted in step 5 above:
|
||||||
|
- `https://www.googleapis.com/auth/admin.directory.user.readonly`,
|
||||||
|
- `https://www.googleapis.com/auth/admin.directory.user`
|
||||||
|
- `https://www.googleapis.com/auth/cloud-platform`
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ insecure_oidc_skip_issuer_verification=true
|
||||||
```
|
```
|
||||||
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
||||||
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
||||||
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by diffrerent tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
||||||
|
|
||||||
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -77,23 +77,15 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
When you use ingress-nginx in Kubernetes, you MUST use `kubernetes/ingress-nginx` (which includes the Lua module) and the following configuration snippet for your `Ingress`.
|
When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
|
||||||
Variables set with `auth_request_set` are not `set`-able in plain nginx config when the location is processed via `proxy_pass` and then may only be processed by Lua.
|
|
||||||
Note that `nginxinc/kubernetes-ingress` does not include the Lua module.
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
nginx.ingress.kubernetes.io/auth-response-headers: Authorization
|
nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
|
||||||
nginx.ingress.kubernetes.io/auth-signin: https://$host/oauth2/start?rd=$escaped_request_uri
|
nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
|
||||||
nginx.ingress.kubernetes.io/auth-url: https://$host/oauth2/auth
|
|
||||||
nginx.ingress.kubernetes.io/configuration-snippet: |
|
|
||||||
auth_request_set $name_upstream_1 $upstream_cookie_name_1;
|
|
||||||
|
|
||||||
access_by_lua_block {
|
|
||||||
if ngx.var.name_upstream_1 ~= "" then
|
|
||||||
ngx.header["Set-Cookie"] = "name_1=" .. ngx.var.name_upstream_1 .. ngx.var.auth_cookie:match("(; .*)")
|
|
||||||
end
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This minimal configuration works for standard authentication flows. Lua/cookie handling is only needed for advanced scenarios (e.g., multi-part cookies, custom session logic). See the official ingress-nginx example: https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/.
|
||||||
|
|
||||||
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
||||||
|
|
||||||
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ insecure_oidc_skip_issuer_verification=true
|
||||||
```
|
```
|
||||||
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
||||||
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
||||||
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by diffrerent tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
||||||
|
|
||||||
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -77,23 +77,15 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
When you use ingress-nginx in Kubernetes, you MUST use `kubernetes/ingress-nginx` (which includes the Lua module) and the following configuration snippet for your `Ingress`.
|
When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
|
||||||
Variables set with `auth_request_set` are not `set`-able in plain nginx config when the location is processed via `proxy_pass` and then may only be processed by Lua.
|
|
||||||
Note that `nginxinc/kubernetes-ingress` does not include the Lua module.
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
nginx.ingress.kubernetes.io/auth-response-headers: Authorization
|
nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
|
||||||
nginx.ingress.kubernetes.io/auth-signin: https://$host/oauth2/start?rd=$escaped_request_uri
|
nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
|
||||||
nginx.ingress.kubernetes.io/auth-url: https://$host/oauth2/auth
|
|
||||||
nginx.ingress.kubernetes.io/configuration-snippet: |
|
|
||||||
auth_request_set $name_upstream_1 $upstream_cookie_name_1;
|
|
||||||
|
|
||||||
access_by_lua_block {
|
|
||||||
if ngx.var.name_upstream_1 ~= "" then
|
|
||||||
ngx.header["Set-Cookie"] = "name_1=" .. ngx.var.name_upstream_1 .. ngx.var.auth_cookie:match("(; .*)")
|
|
||||||
end
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This minimal configuration works for standard authentication flows. Lua/cookie handling is only needed for advanced scenarios (e.g., multi-part cookies, custom session logic). See the official ingress-nginx example: https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/.
|
||||||
|
|
||||||
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
||||||
|
|
||||||
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ insecure_oidc_skip_issuer_verification=true
|
||||||
```
|
```
|
||||||
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
||||||
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
||||||
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by diffrerent tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
||||||
|
|
||||||
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -77,23 +77,15 @@ server {
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
When you use ingress-nginx in Kubernetes, you MUST use `kubernetes/ingress-nginx` (which includes the Lua module) and the following configuration snippet for your `Ingress`.
|
When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
|
||||||
Variables set with `auth_request_set` are not `set`-able in plain nginx config when the location is processed via `proxy_pass` and then may only be processed by Lua.
|
|
||||||
Note that `nginxinc/kubernetes-ingress` does not include the Lua module.
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
nginx.ingress.kubernetes.io/auth-response-headers: Authorization
|
nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
|
||||||
nginx.ingress.kubernetes.io/auth-signin: https://$host/oauth2/start?rd=$escaped_request_uri
|
nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
|
||||||
nginx.ingress.kubernetes.io/auth-url: https://$host/oauth2/auth
|
|
||||||
nginx.ingress.kubernetes.io/configuration-snippet: |
|
|
||||||
auth_request_set $name_upstream_1 $upstream_cookie_name_1;
|
|
||||||
|
|
||||||
access_by_lua_block {
|
|
||||||
if ngx.var.name_upstream_1 ~= "" then
|
|
||||||
ngx.header["Set-Cookie"] = "name_1=" .. ngx.var.name_upstream_1 .. ngx.var.auth_cookie:match("(; .*)")
|
|
||||||
end
|
|
||||||
}
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
This minimal configuration works for standard authentication flows. Lua/cookie handling is only needed for advanced scenarios (e.g., multi-part cookies, custom session logic). See the official ingress-nginx example: https://kubernetes.github.io/ingress-nginx/examples/auth/oauth-external-auth/.
|
||||||
|
|
||||||
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).
|
||||||
|
|
||||||
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
You have to substitute *name* with the actual cookie name you configured via --cookie-name parameter. If you don't set a custom cookie name the variable should be "$upstream_cookie__oauth2_proxy_1" instead of "$upstream_cookie_name_1" and the new cookie-name should be "_oauth2_proxy_1=" instead of "name_1=".
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ insecure_oidc_skip_issuer_verification=true
|
||||||
```
|
```
|
||||||
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
||||||
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
||||||
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by diffrerent tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
||||||
|
|
||||||
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ insecure_oidc_skip_issuer_verification=true
|
||||||
```
|
```
|
||||||
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
||||||
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
||||||
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by diffrerent tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
||||||
|
|
||||||
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -112,7 +112,7 @@ insecure_oidc_skip_issuer_verification=true
|
||||||
```
|
```
|
||||||
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:
|
||||||
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
* Startup check for matching issuer URL returned from [discovery document](https://login.microsoftonline.com/common/v2.0/.well-known/openid-configuration) with `oidc_issuer_url` setting. Required, as document's `issuer` field doesn't equal to `https://login.microsoftonline.com/common/v2.0`. See [OIDC Discovery 4.3](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfigurationValidation).
|
||||||
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by diffrerent tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
* Matching ID token's `issuer` claim with `oidc_issuer_url` setting during ID token validation. Required to support tokens issued by different tenants. See [OIDC Core 3.1.3.7](https://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation).
|
||||||
|
|
||||||
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
To provide additional security, Entra ID provider performs check on the ID token's `issuer` claim to match the `https://login.microsoftonline.com/{tenant-id}/v2.0` template.
|
||||||
|
|
||||||
|
|
|
||||||
3
go.mod
3
go.mod
|
|
@ -1,13 +1,12 @@
|
||||||
module github.com/oauth2-proxy/oauth2-proxy/v7
|
module github.com/oauth2-proxy/oauth2-proxy/v7
|
||||||
|
|
||||||
go 1.24.6
|
go 1.25.3
|
||||||
|
|
||||||
require (
|
require (
|
||||||
cloud.google.com/go/compute/metadata v0.7.0
|
cloud.google.com/go/compute/metadata v0.7.0
|
||||||
github.com/Bose/minisentinel v0.0.0-20200130220412-917c5a9223bb
|
github.com/Bose/minisentinel v0.0.0-20200130220412-917c5a9223bb
|
||||||
github.com/a8m/envsubst v1.4.3
|
github.com/a8m/envsubst v1.4.3
|
||||||
github.com/alicebob/miniredis/v2 v2.35.0
|
github.com/alicebob/miniredis/v2 v2.35.0
|
||||||
github.com/benbjohnson/clock v1.3.5
|
|
||||||
github.com/bitly/go-simplejson v0.5.1
|
github.com/bitly/go-simplejson v0.5.1
|
||||||
github.com/bsm/redislock v0.9.4
|
github.com/bsm/redislock v0.9.4
|
||||||
github.com/coreos/go-oidc/v3 v3.14.1
|
github.com/coreos/go-oidc/v3 v3.14.1
|
||||||
|
|
|
||||||
36
go.sum
36
go.sum
|
|
@ -14,8 +14,6 @@ github.com/alicebob/gopher-json v0.0.0-20180125190556-5a6b3ba71ee6/go.mod h1:SGn
|
||||||
github.com/alicebob/miniredis/v2 v2.11.1/go.mod h1:UA48pmi7aSazcGAvcdKcBB49z521IC9VjTTRz2nIaJE=
|
github.com/alicebob/miniredis/v2 v2.11.1/go.mod h1:UA48pmi7aSazcGAvcdKcBB49z521IC9VjTTRz2nIaJE=
|
||||||
github.com/alicebob/miniredis/v2 v2.35.0 h1:QwLphYqCEAo1eu1TqPRN2jgVMPBweeQcR21jeqDCONI=
|
github.com/alicebob/miniredis/v2 v2.35.0 h1:QwLphYqCEAo1eu1TqPRN2jgVMPBweeQcR21jeqDCONI=
|
||||||
github.com/alicebob/miniredis/v2 v2.35.0/go.mod h1:TcL7YfarKPGDAthEtl5NBeHZfeUQj6OXMm/+iu5cLMM=
|
github.com/alicebob/miniredis/v2 v2.35.0/go.mod h1:TcL7YfarKPGDAthEtl5NBeHZfeUQj6OXMm/+iu5cLMM=
|
||||||
github.com/benbjohnson/clock v1.3.5 h1:VvXlSJBzZpA/zum6Sj74hxwYI2DIxRWuNIoXAzHZz5o=
|
|
||||||
github.com/benbjohnson/clock v1.3.5/go.mod h1:J11/hYXuz8f4ySSvYwY0FKfm+ezbsZBKZxNJlLklBHA=
|
|
||||||
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
github.com/beorn7/perks v1.0.1 h1:VlbKKnNfV8bJzeqoa4cOKqO6bYr3WgKZxO8Z16+hsOM=
|
||||||
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
github.com/beorn7/perks v1.0.1/go.mod h1:G2ZrVWU2WbWT9wwq4/hrbKbnv/1ERSJQ0ibhJ6rlkpw=
|
||||||
github.com/bitly/go-simplejson v0.5.1 h1:xgwPbetQScXt1gh9BmoJ6j9JMr3TElvuIyjR8pgdoow=
|
github.com/bitly/go-simplejson v0.5.1 h1:xgwPbetQScXt1gh9BmoJ6j9JMr3TElvuIyjR8pgdoow=
|
||||||
|
|
@ -61,12 +59,8 @@ github.com/go-logr/stdr v1.2.2 h1:hSWxHoqTgW2S2qGc0LTAI563KZ5YKYRhT3MFKZMbjag=
|
||||||
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
|
github.com/go-logr/stdr v1.2.2/go.mod h1:mMo/vtBO5dYbehREoey6XUKy/eSumjCCveDpRre4VKE=
|
||||||
github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI=
|
github.com/go-task/slim-sprig/v3 v3.0.0 h1:sUs3vkvUymDpBKi3qH1YSqBQk9+9D/8M2mN1vB6EwHI=
|
||||||
github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=
|
github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZiAzKg9hl15HA8=
|
||||||
github.com/go-viper/mapstructure/v2 v2.3.0 h1:27XbWsHIqhbdR5TIC911OfYvgSaW93HM+dX7970Q7jk=
|
|
||||||
github.com/go-viper/mapstructure/v2 v2.3.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
|
|
||||||
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
|
github.com/go-viper/mapstructure/v2 v2.4.0 h1:EBsztssimR/CONLSZZ04E8qAkxNYq4Qp9LvH92wZUgs=
|
||||||
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
|
github.com/go-viper/mapstructure/v2 v2.4.0/go.mod h1:oJDH3BJKyqBA2TXFhDsKDGDTlndYOZ6rGS0BRZIxGhM=
|
||||||
github.com/golang-jwt/jwt/v5 v5.2.2 h1:Rl4B7itRWVtYIHFrSNd7vhTiz9UpLdi6gZhZ3wEeDy8=
|
|
||||||
github.com/golang-jwt/jwt/v5 v5.2.2/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
|
||||||
github.com/golang-jwt/jwt/v5 v5.2.3 h1:kkGXqQOBSDDWRhWNXTFpqGSCMyh/PLnqUvMGJPDJDs0=
|
github.com/golang-jwt/jwt/v5 v5.2.3 h1:kkGXqQOBSDDWRhWNXTFpqGSCMyh/PLnqUvMGJPDJDs0=
|
||||||
github.com/golang-jwt/jwt/v5 v5.2.3/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
github.com/golang-jwt/jwt/v5 v5.2.3/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk=
|
||||||
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
|
github.com/golang/protobuf v1.5.4 h1:i7eJL8qZTpSEXOPTxNKhASYpMn+8e5Q6AdndVa1dWek=
|
||||||
|
|
@ -85,8 +79,6 @@ github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
|
||||||
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
|
||||||
github.com/googleapis/enterprise-certificate-proxy v0.3.6 h1:GW/XbdyBFQ8Qe+YAmFU9uHLo7OnF5tL52HFAgMmyrf4=
|
github.com/googleapis/enterprise-certificate-proxy v0.3.6 h1:GW/XbdyBFQ8Qe+YAmFU9uHLo7OnF5tL52HFAgMmyrf4=
|
||||||
github.com/googleapis/enterprise-certificate-proxy v0.3.6/go.mod h1:MkHOF77EYAE7qfSuSS9PU6g4Nt4e11cnsDUowfwewLA=
|
github.com/googleapis/enterprise-certificate-proxy v0.3.6/go.mod h1:MkHOF77EYAE7qfSuSS9PU6g4Nt4e11cnsDUowfwewLA=
|
||||||
github.com/googleapis/gax-go/v2 v2.14.2 h1:eBLnkZ9635krYIPD+ag1USrOAI0Nr0QYF3+/3GqO0k0=
|
|
||||||
github.com/googleapis/gax-go/v2 v2.14.2/go.mod h1:ON64QhlJkhVtSqp4v1uaK92VyZ2gmvDQsweuyLV+8+w=
|
|
||||||
github.com/googleapis/gax-go/v2 v2.15.0 h1:SyjDc1mGgZU5LncH8gimWo9lW1DtIfPibOG81vgd/bo=
|
github.com/googleapis/gax-go/v2 v2.15.0 h1:SyjDc1mGgZU5LncH8gimWo9lW1DtIfPibOG81vgd/bo=
|
||||||
github.com/googleapis/gax-go/v2 v2.15.0/go.mod h1:zVVkkxAQHa1RQpg9z2AUCMnKhi0Qld9rcmyfL1OZhoc=
|
github.com/googleapis/gax-go/v2 v2.15.0/go.mod h1:zVVkkxAQHa1RQpg9z2AUCMnKhi0Qld9rcmyfL1OZhoc=
|
||||||
github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
|
github.com/gorilla/mux v1.8.1 h1:TuBL49tXwgrFYWhqrNgrUNEY92u81SPhu7sTdzQEiWY=
|
||||||
|
|
@ -142,8 +134,6 @@ github.com/spf13/afero v1.14.0 h1:9tH6MapGnn/j0eb0yIXiLjERO8RB6xIVZRDCX7PtqWA=
|
||||||
github.com/spf13/afero v1.14.0/go.mod h1:acJQ8t0ohCGuMN3O+Pv0V0hgMxNYDlvdk+VTfyZmbYo=
|
github.com/spf13/afero v1.14.0/go.mod h1:acJQ8t0ohCGuMN3O+Pv0V0hgMxNYDlvdk+VTfyZmbYo=
|
||||||
github.com/spf13/cast v1.9.2 h1:SsGfm7M8QOFtEzumm7UZrZdLLquNdzFYfIbEXntcFbE=
|
github.com/spf13/cast v1.9.2 h1:SsGfm7M8QOFtEzumm7UZrZdLLquNdzFYfIbEXntcFbE=
|
||||||
github.com/spf13/cast v1.9.2/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo=
|
github.com/spf13/cast v1.9.2/go.mod h1:jNfB8QC9IA6ZuY2ZjDp0KtFO2LZZlg4S/7bzP6qqeHo=
|
||||||
github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
|
|
||||||
github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
|
||||||
github.com/spf13/pflag v1.0.7 h1:vN6T9TfwStFPFM5XzjsvmzZkLuaLX+HS+0SeFLRgU6M=
|
github.com/spf13/pflag v1.0.7 h1:vN6T9TfwStFPFM5XzjsvmzZkLuaLX+HS+0SeFLRgU6M=
|
||||||
github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
github.com/spf13/pflag v1.0.7/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||||
github.com/spf13/viper v1.20.1 h1:ZMi+z/lvLyPSCoNtFCpqjy0S4kPbirhpTMwl8BkW9X4=
|
github.com/spf13/viper v1.20.1 h1:ZMi+z/lvLyPSCoNtFCpqjy0S4kPbirhpTMwl8BkW9X4=
|
||||||
|
|
@ -186,8 +176,6 @@ go.uber.org/multierr v1.11.0/go.mod h1:20+QtiLqy0Nd6FdQB9TLXag12DsQkrbs3htMFfDN8
|
||||||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
|
||||||
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
|
||||||
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU=
|
||||||
golang.org/x/crypto v0.39.0 h1:SHs+kF4LP+f+p14esP5jAoDpHU8Gu/v9lFRK6IT5imM=
|
|
||||||
golang.org/x/crypto v0.39.0/go.mod h1:L+Xg3Wf6HoL4Bn4238Z6ft6KfEpN0tJGo53AAPC632U=
|
|
||||||
golang.org/x/crypto v0.40.0 h1:r4x+VvoG5Fm+eJcxMaY8CQM7Lb0l1lsmjGBQ6s8BfKM=
|
golang.org/x/crypto v0.40.0 h1:r4x+VvoG5Fm+eJcxMaY8CQM7Lb0l1lsmjGBQ6s8BfKM=
|
||||||
golang.org/x/crypto v0.40.0/go.mod h1:Qr1vMER5WyS2dfPHAlsOj01wgLbsyWtFn/aY+5+ZdxY=
|
golang.org/x/crypto v0.40.0/go.mod h1:Qr1vMER5WyS2dfPHAlsOj01wgLbsyWtFn/aY+5+ZdxY=
|
||||||
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
|
||||||
|
|
@ -197,8 +185,6 @@ golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v
|
||||||
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
|
||||||
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
|
golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs=
|
||||||
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
|
golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg=
|
||||||
golang.org/x/net v0.41.0 h1:vBTly1HeNPEn3wtREYfy4GZ/NECgw2Cnl+nK6Nz3uvw=
|
|
||||||
golang.org/x/net v0.41.0/go.mod h1:B/K4NNqkfmg07DQYrbwvSluqCJOOXwUjeb/5lOisjbA=
|
|
||||||
golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs=
|
golang.org/x/net v0.42.0 h1:jzkYrhi3YQWD6MLBJcsklgQsoAcw89EcZbJw8Z614hs=
|
||||||
golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8=
|
golang.org/x/net v0.42.0/go.mod h1:FF1RA5d3u7nAYA4z2TkclSCKh68eSXtiFwcWQpPXdt8=
|
||||||
golang.org/x/oauth2 v0.30.0 h1:dnDm7JmhM45NNpd8FDDeLhK6FwqbOf4MLCM9zb1BOHI=
|
golang.org/x/oauth2 v0.30.0 h1:dnDm7JmhM45NNpd8FDDeLhK6FwqbOf4MLCM9zb1BOHI=
|
||||||
|
|
@ -206,8 +192,6 @@ golang.org/x/oauth2 v0.30.0/go.mod h1:B++QgG3ZKulg6sRPGD/mqlHQs5rB3Ml9erfeDY7xKl
|
||||||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
||||||
golang.org/x/sync v0.15.0 h1:KWH3jNZsfyT6xfAfKiz6MRNmd46ByHDYaZ7KSkCtdW8=
|
|
||||||
golang.org/x/sync v0.15.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
|
|
||||||
golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw=
|
golang.org/x/sync v0.16.0 h1:ycBJEhp9p4vXvUZNszeOq0kGTPghopOL8q0fq3vstxw=
|
||||||
golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
|
golang.org/x/sync v0.16.0/go.mod h1:1dzgHSNfp02xaA81J2MS99Qcpr2w7fw1gpm99rleRqA=
|
||||||
golang.org/x/sys v0.0.0-20190204203706-41f3e6584952/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
golang.org/x/sys v0.0.0-20190204203706-41f3e6584952/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
|
||||||
|
|
@ -219,8 +203,6 @@ golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBc
|
||||||
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
|
||||||
golang.org/x/sys v0.33.0 h1:q3i8TbbEz+JRD9ywIRlyRAQbM0qF7hu24q3teo2hbuw=
|
|
||||||
golang.org/x/sys v0.33.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
|
|
||||||
golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
|
golang.org/x/sys v0.34.0 h1:H5Y5sJ2L2JRdyv7ROF1he/lPdvFsd0mJHFw2ThKHxLA=
|
||||||
golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
|
golang.org/x/sys v0.34.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
|
||||||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
|
||||||
|
|
@ -234,8 +216,6 @@ golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
|
||||||
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
|
golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
|
||||||
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
|
golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
|
||||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
||||||
golang.org/x/text v0.26.0 h1:P42AVeLghgTYr4+xUnTRKDMqpar+PtX7KWuNQL21L8M=
|
|
||||||
golang.org/x/text v0.26.0/go.mod h1:QK15LZJUUQVJxhz7wXgxSy/CJaTFjd0G+YLonydOVQA=
|
|
||||||
golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4=
|
golang.org/x/text v0.27.0 h1:4fGWRpyh641NLlecmyl4LOe6yDdfaYNrGb2zdfo4JV4=
|
||||||
golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU=
|
golang.org/x/text v0.27.0/go.mod h1:1D28KMCvyooCX9hBiosv5Tz/+YLxj0j7XhWjpSUF7CU=
|
||||||
golang.org/x/time v0.12.0 h1:ScB/8o8olJvc+CQPWrK3fPZNfh7qgwCrY0zJmoEQLSE=
|
golang.org/x/time v0.12.0 h1:ScB/8o8olJvc+CQPWrK3fPZNfh7qgwCrY0zJmoEQLSE=
|
||||||
|
|
@ -244,25 +224,15 @@ golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGm
|
||||||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
|
||||||
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
|
||||||
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
|
golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU=
|
||||||
golang.org/x/tools v0.34.0 h1:qIpSLOxeCYGg9TrcJokLBG4KFA6d795g0xkBkiESGlo=
|
|
||||||
golang.org/x/tools v0.34.0/go.mod h1:pAP9OwEaY1CAW3HOmg3hLZC5Z0CCmzjAF2UQMSqNARg=
|
|
||||||
golang.org/x/tools v0.35.0 h1:mBffYraMEf7aa0sB+NuKnuCy8qI/9Bughn8dC2Gu5r0=
|
golang.org/x/tools v0.35.0 h1:mBffYraMEf7aa0sB+NuKnuCy8qI/9Bughn8dC2Gu5r0=
|
||||||
golang.org/x/tools v0.35.0/go.mod h1:NKdj5HkL/73byiZSJjqJgKn3ep7KjFkBOkR/Hps3VPw=
|
golang.org/x/tools v0.35.0/go.mod h1:NKdj5HkL/73byiZSJjqJgKn3ep7KjFkBOkR/Hps3VPw=
|
||||||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
|
||||||
google.golang.org/api v0.240.0 h1:PxG3AA2UIqT1ofIzWV2COM3j3JagKTKSwy7L6RHNXNU=
|
|
||||||
google.golang.org/api v0.240.0/go.mod h1:cOVEm2TpdAGHL2z+UwyS+kmlGr3bVWQQ6sYEqkKje50=
|
|
||||||
google.golang.org/api v0.241.0 h1:QKwqWQlkc6O895LchPEDUSYr22Xp3NCxpQRiWTB6avE=
|
|
||||||
google.golang.org/api v0.241.0/go.mod h1:cOVEm2TpdAGHL2z+UwyS+kmlGr3bVWQQ6sYEqkKje50=
|
|
||||||
google.golang.org/api v0.242.0 h1:7Lnb1nfnpvbkCiZek6IXKdJ0MFuAZNAJKQfA1ws62xg=
|
google.golang.org/api v0.242.0 h1:7Lnb1nfnpvbkCiZek6IXKdJ0MFuAZNAJKQfA1ws62xg=
|
||||||
google.golang.org/api v0.242.0/go.mod h1:cOVEm2TpdAGHL2z+UwyS+kmlGr3bVWQQ6sYEqkKje50=
|
google.golang.org/api v0.242.0/go.mod h1:cOVEm2TpdAGHL2z+UwyS+kmlGr3bVWQQ6sYEqkKje50=
|
||||||
google.golang.org/genproto v0.0.0-20250505200425-f936aa4a68b2 h1:1tXaIXCracvtsRxSBsYDiSBN0cuJvM7QYW+MrpIRY78=
|
|
||||||
google.golang.org/genproto v0.0.0-20250505200425-f936aa4a68b2/go.mod h1:49MsLSx0oWMOZqcpB3uL8ZOkAh1+TndpJ8ONoCBWiZk=
|
|
||||||
google.golang.org/genproto v0.0.0-20250603155806-513f23925822 h1:rHWScKit0gvAPuOnu87KpaYtjK5zBMLcULh7gxkCXu4=
|
google.golang.org/genproto v0.0.0-20250603155806-513f23925822 h1:rHWScKit0gvAPuOnu87KpaYtjK5zBMLcULh7gxkCXu4=
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20250505200425-f936aa4a68b2 h1:vPV0tzlsK6EzEDHNNH5sa7Hs9bd7iXR7B1tSiPepkV0=
|
google.golang.org/genproto v0.0.0-20250603155806-513f23925822/go.mod h1:HubltRL7rMh0LfnQPkMH4NPDFEWp0jw3vixw7jEM53s=
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20250505200425-f936aa4a68b2/go.mod h1:pKLAc5OolXC3ViWGI62vvC0n10CpwAtRcTNCFwTKBEw=
|
|
||||||
google.golang.org/genproto/googleapis/api v0.0.0-20250603155806-513f23925822 h1:oWVWY3NzT7KJppx2UKhKmzPq4SRe0LdCijVRwvGeikY=
|
google.golang.org/genproto/googleapis/api v0.0.0-20250603155806-513f23925822 h1:oWVWY3NzT7KJppx2UKhKmzPq4SRe0LdCijVRwvGeikY=
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250603155806-513f23925822 h1:fc6jSaCT0vBduLYZHYrBBNY4dsWuvgyff9noRNDdBeE=
|
google.golang.org/genproto/googleapis/api v0.0.0-20250603155806-513f23925822/go.mod h1:h3c4v36UTKzUiuaOKQ6gr3S+0hovBtUrXzTG/i3+XEc=
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250603155806-513f23925822/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
|
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250707201910-8d1bb00bc6a7 h1:pFyd6EwwL2TqFf8emdthzeX+gZE1ElRq3iM8pui4KBY=
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20250707201910-8d1bb00bc6a7 h1:pFyd6EwwL2TqFf8emdthzeX+gZE1ElRq3iM8pui4KBY=
|
||||||
google.golang.org/genproto/googleapis/rpc v0.0.0-20250707201910-8d1bb00bc6a7/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
|
google.golang.org/genproto/googleapis/rpc v0.0.0-20250707201910-8d1bb00bc6a7/go.mod h1:qQ0YXyHHx3XkvlzUtpXDkS29lDSafHMZBAZDc03LQ3A=
|
||||||
google.golang.org/grpc v1.73.0 h1:VIWSmpI2MegBtTuFt5/JWy2oXxtjJ/e89Z70ImfD2ok=
|
google.golang.org/grpc v1.73.0 h1:VIWSmpI2MegBtTuFt5/JWy2oXxtjJ/e89Z70ImfD2ok=
|
||||||
|
|
@ -280,7 +250,5 @@ gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
k8s.io/apimachinery v0.33.2 h1:IHFVhqg59mb8PJWTLi8m1mAoepkUNYmptHsV+Z1m5jY=
|
|
||||||
k8s.io/apimachinery v0.33.2/go.mod h1:BHW0YOu7n22fFv/JkYOEfkUYNRN0fj0BlvMFWA7b+SM=
|
|
||||||
k8s.io/apimachinery v0.33.3 h1:4ZSrmNa0c/ZpZJhAgRdcsFcZOw1PQU1bALVQ0B3I5LA=
|
k8s.io/apimachinery v0.33.3 h1:4ZSrmNa0c/ZpZJhAgRdcsFcZOw1PQU1bALVQ0B3I5LA=
|
||||||
k8s.io/apimachinery v0.33.3/go.mod h1:BHW0YOu7n22fFv/JkYOEfkUYNRN0fj0BlvMFWA7b+SM=
|
k8s.io/apimachinery v0.33.3/go.mod h1:BHW0YOu7n22fFv/JkYOEfkUYNRN0fj0BlvMFWA7b+SM=
|
||||||
|
|
|
||||||
|
|
@ -510,6 +510,8 @@ type LegacyProvider struct {
|
||||||
GoogleServiceAccountJSON string `flag:"google-service-account-json" cfg:"google_service_account_json"`
|
GoogleServiceAccountJSON string `flag:"google-service-account-json" cfg:"google_service_account_json"`
|
||||||
GoogleUseApplicationDefaultCredentials bool `flag:"google-use-application-default-credentials" cfg:"google_use_application_default_credentials"`
|
GoogleUseApplicationDefaultCredentials bool `flag:"google-use-application-default-credentials" cfg:"google_use_application_default_credentials"`
|
||||||
GoogleTargetPrincipal string `flag:"google-target-principal" cfg:"google_target_principal"`
|
GoogleTargetPrincipal string `flag:"google-target-principal" cfg:"google_target_principal"`
|
||||||
|
GoogleUseOrganizationId bool `flag:"google-use-organization-id" cfg:"google_use_organization_id"`
|
||||||
|
GoogleAdminApiUserScope string `flag:"google-admin-api-user-scope" cfg:"google_admin_api_user_scope"`
|
||||||
|
|
||||||
// These options allow for other providers besides Google, with
|
// These options allow for other providers besides Google, with
|
||||||
// potential overrides.
|
// potential overrides.
|
||||||
|
|
@ -623,6 +625,8 @@ func legacyGoogleFlagSet() *pflag.FlagSet {
|
||||||
flagSet.String("google-service-account-json", "", "the path to the service account json credentials")
|
flagSet.String("google-service-account-json", "", "the path to the service account json credentials")
|
||||||
flagSet.String("google-use-application-default-credentials", "", "use application default credentials instead of service account json (i.e. GKE Workload Identity)")
|
flagSet.String("google-use-application-default-credentials", "", "use application default credentials instead of service account json (i.e. GKE Workload Identity)")
|
||||||
flagSet.String("google-target-principal", "", "the target principal to impersonate when using ADC")
|
flagSet.String("google-target-principal", "", "the target principal to impersonate when using ADC")
|
||||||
|
flagSet.String("google-use-organization-id", "", "use organization id as preferred username")
|
||||||
|
flagSet.String("google-admin-api-user-scope", "", "authorization scope required to call users.get, can be one of ")
|
||||||
|
|
||||||
return flagSet
|
return flagSet
|
||||||
}
|
}
|
||||||
|
|
@ -770,6 +774,8 @@ func (l *LegacyProvider) convert() (Providers, error) {
|
||||||
ServiceAccountJSON: l.GoogleServiceAccountJSON,
|
ServiceAccountJSON: l.GoogleServiceAccountJSON,
|
||||||
UseApplicationDefaultCredentials: l.GoogleUseApplicationDefaultCredentials,
|
UseApplicationDefaultCredentials: l.GoogleUseApplicationDefaultCredentials,
|
||||||
TargetPrincipal: l.GoogleTargetPrincipal,
|
TargetPrincipal: l.GoogleTargetPrincipal,
|
||||||
|
UseOrganizationId: l.GoogleUseOrganizationId,
|
||||||
|
AdminApiUserScope: l.GoogleAdminApiUserScope,
|
||||||
}
|
}
|
||||||
case "entra-id":
|
case "entra-id":
|
||||||
provider.MicrosoftEntraIDConfig = MicrosoftEntraIDOptions{
|
provider.MicrosoftEntraIDConfig = MicrosoftEntraIDOptions{
|
||||||
|
|
|
||||||
|
|
@ -230,6 +230,10 @@ type GoogleOptions struct {
|
||||||
UseApplicationDefaultCredentials bool `json:"useApplicationDefaultCredentials,omitempty"`
|
UseApplicationDefaultCredentials bool `json:"useApplicationDefaultCredentials,omitempty"`
|
||||||
// TargetPrincipal is the Google Service Account used for Application Default Credentials
|
// TargetPrincipal is the Google Service Account used for Application Default Credentials
|
||||||
TargetPrincipal string `json:"targetPrincipal,omitempty"`
|
TargetPrincipal string `json:"targetPrincipal,omitempty"`
|
||||||
|
// UseOrganizationId indicates whether to use the organization ID as the UserName claim
|
||||||
|
UseOrganizationId bool `json:"useOrganizationId,omitempty"`
|
||||||
|
// admin scope needed for fetching user organization information from admin api, can be one of cloud, user or defaults to readonly
|
||||||
|
AdminApiUserScope string `json:"adminApiUserScope,omitempty"`
|
||||||
}
|
}
|
||||||
|
|
||||||
type OIDCOptions struct {
|
type OIDCOptions struct {
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,6 @@ import (
|
||||||
"io"
|
"io"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/clock"
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/encryption"
|
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/encryption"
|
||||||
"github.com/pierrec/lz4/v4"
|
"github.com/pierrec/lz4/v4"
|
||||||
"github.com/vmihailenco/msgpack/v5"
|
"github.com/vmihailenco/msgpack/v5"
|
||||||
|
|
@ -30,8 +29,15 @@ type SessionState struct {
|
||||||
PreferredUsername string `msgpack:"pu,omitempty"`
|
PreferredUsername string `msgpack:"pu,omitempty"`
|
||||||
|
|
||||||
// Internal helpers, not serialized
|
// Internal helpers, not serialized
|
||||||
Clock clock.Clock `msgpack:"-"`
|
Clock func() time.Time `msgpack:"-"` // override for time.Now, for testing
|
||||||
Lock Lock `msgpack:"-"`
|
Lock Lock `msgpack:"-"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (s *SessionState) now() time.Time {
|
||||||
|
if s.Clock != nil {
|
||||||
|
return s.Clock()
|
||||||
|
}
|
||||||
|
return time.Now()
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *SessionState) ObtainLock(ctx context.Context, expiration time.Duration) error {
|
func (s *SessionState) ObtainLock(ctx context.Context, expiration time.Duration) error {
|
||||||
|
|
@ -64,7 +70,7 @@ func (s *SessionState) PeekLock(ctx context.Context) (bool, error) {
|
||||||
|
|
||||||
// CreatedAtNow sets a SessionState's CreatedAt to now
|
// CreatedAtNow sets a SessionState's CreatedAt to now
|
||||||
func (s *SessionState) CreatedAtNow() {
|
func (s *SessionState) CreatedAtNow() {
|
||||||
now := s.Clock.Now()
|
now := s.now()
|
||||||
s.CreatedAt = &now
|
s.CreatedAt = &now
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -85,7 +91,7 @@ func (s *SessionState) ExpiresIn(d time.Duration) {
|
||||||
|
|
||||||
// IsExpired checks whether the session has expired
|
// IsExpired checks whether the session has expired
|
||||||
func (s *SessionState) IsExpired() bool {
|
func (s *SessionState) IsExpired() bool {
|
||||||
if s.ExpiresOn != nil && !s.ExpiresOn.IsZero() && s.ExpiresOn.Before(s.Clock.Now()) {
|
if s.ExpiresOn != nil && !s.ExpiresOn.IsZero() && s.ExpiresOn.Before(s.now()) {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
return false
|
return false
|
||||||
|
|
@ -94,7 +100,7 @@ func (s *SessionState) IsExpired() bool {
|
||||||
// Age returns the age of a session
|
// Age returns the age of a session
|
||||||
func (s *SessionState) Age() time.Duration {
|
func (s *SessionState) Age() time.Duration {
|
||||||
if s.CreatedAt != nil && !s.CreatedAt.IsZero() {
|
if s.CreatedAt != nil && !s.CreatedAt.IsZero() {
|
||||||
return s.Clock.Now().Truncate(time.Second).Sub(*s.CreatedAt)
|
return s.now().Truncate(time.Second).Sub(*s.CreatedAt)
|
||||||
}
|
}
|
||||||
return 0
|
return 0
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -22,7 +22,7 @@ func TestCreatedAtNow(t *testing.T) {
|
||||||
ss := &SessionState{}
|
ss := &SessionState{}
|
||||||
|
|
||||||
now := time.Unix(1234567890, 0)
|
now := time.Unix(1234567890, 0)
|
||||||
ss.Clock.Set(now)
|
ss.Clock = func() time.Time { return now }
|
||||||
|
|
||||||
ss.CreatedAtNow()
|
ss.CreatedAtNow()
|
||||||
g.Expect(*ss.CreatedAt).To(Equal(now))
|
g.Expect(*ss.CreatedAt).To(Equal(now))
|
||||||
|
|
@ -33,9 +33,9 @@ func TestExpiresIn(t *testing.T) {
|
||||||
ss := &SessionState{}
|
ss := &SessionState{}
|
||||||
|
|
||||||
now := time.Unix(1234567890, 0)
|
now := time.Unix(1234567890, 0)
|
||||||
ss.Clock.Set(now)
|
ss.Clock = func() time.Time { return now }
|
||||||
|
|
||||||
ttl := time.Duration(743) * time.Second
|
ttl := 743 * time.Second
|
||||||
ss.ExpiresIn(ttl)
|
ss.ExpiresIn(ttl)
|
||||||
|
|
||||||
g.Expect(*ss.ExpiresOn).To(Equal(ss.CreatedAt.Add(ttl)))
|
g.Expect(*ss.ExpiresOn).To(Equal(ss.CreatedAt.Add(ttl)))
|
||||||
|
|
|
||||||
|
|
@ -1,157 +0,0 @@
|
||||||
package clock
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
clockapi "github.com/benbjohnson/clock"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
globalClock = clockapi.New()
|
|
||||||
mu sync.Mutex
|
|
||||||
)
|
|
||||||
|
|
||||||
// Set the global clock to a clockapi.Mock with the given time.Time
|
|
||||||
func Set(t time.Time) {
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
mock, ok := globalClock.(*clockapi.Mock)
|
|
||||||
if !ok {
|
|
||||||
mock = clockapi.NewMock()
|
|
||||||
}
|
|
||||||
mock.Set(t)
|
|
||||||
globalClock = mock
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add moves the mocked global clock forward the given duration. It will error
|
|
||||||
// if the global clock is not mocked.
|
|
||||||
func Add(d time.Duration) error {
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
mock, ok := globalClock.(*clockapi.Mock)
|
|
||||||
if !ok {
|
|
||||||
return errors.New("time not mocked")
|
|
||||||
}
|
|
||||||
mock.Add(d)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset sets the global clock to a pure time implementation. Returns any
|
|
||||||
// existing Mock if set in case lingering time operations are attached to it.
|
|
||||||
func Reset() *clockapi.Mock {
|
|
||||||
mu.Lock()
|
|
||||||
defer mu.Unlock()
|
|
||||||
existing := globalClock
|
|
||||||
globalClock = clockapi.New()
|
|
||||||
|
|
||||||
mock, ok := existing.(*clockapi.Mock)
|
|
||||||
if !ok {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return mock
|
|
||||||
}
|
|
||||||
|
|
||||||
// Clock is a non-package level wrapper around time that supports stubbing.
|
|
||||||
// It will use its localized stubs (allowing for parallelized unit tests
|
|
||||||
// where package level stubbing would cause issues). It falls back to any
|
|
||||||
// package level time stubs for non-parallel, cross-package integration
|
|
||||||
// testing scenarios.
|
|
||||||
//
|
|
||||||
// If nothing is stubbed, it defaults to default time behavior in the time
|
|
||||||
// package.
|
|
||||||
type Clock struct {
|
|
||||||
mock *clockapi.Mock
|
|
||||||
}
|
|
||||||
|
|
||||||
// Set sets the Clock to a clock.Mock at the given time.Time
|
|
||||||
func (c *Clock) Set(t time.Time) {
|
|
||||||
if c.mock == nil {
|
|
||||||
c.mock = clockapi.NewMock()
|
|
||||||
}
|
|
||||||
c.mock.Set(t)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add moves clock forward time.Duration if it is mocked. It will error
|
|
||||||
// if the clock is not mocked.
|
|
||||||
func (c *Clock) Add(d time.Duration) error {
|
|
||||||
if c.mock == nil {
|
|
||||||
return errors.New("clock not mocked")
|
|
||||||
}
|
|
||||||
c.mock.Add(d)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Reset removes local clock.Mock. Returns any existing Mock if set in case
|
|
||||||
// lingering time operations are attached to it.
|
|
||||||
func (c *Clock) Reset() *clockapi.Mock {
|
|
||||||
existing := c.mock
|
|
||||||
c.mock = nil
|
|
||||||
return existing
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) After(d time.Duration) <-chan time.Time {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.After(d)
|
|
||||||
}
|
|
||||||
return m.After(d)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) AfterFunc(d time.Duration, f func()) *clockapi.Timer {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.AfterFunc(d, f)
|
|
||||||
}
|
|
||||||
return m.AfterFunc(d, f)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) Now() time.Time {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.Now()
|
|
||||||
}
|
|
||||||
return m.Now()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) Since(t time.Time) time.Duration {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.Since(t)
|
|
||||||
}
|
|
||||||
return m.Since(t)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) Sleep(d time.Duration) {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
globalClock.Sleep(d)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
m.Sleep(d)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) Tick(d time.Duration) <-chan time.Time {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.Tick(d)
|
|
||||||
}
|
|
||||||
return m.Tick(d)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) Ticker(d time.Duration) *clockapi.Ticker {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.Ticker(d)
|
|
||||||
}
|
|
||||||
return m.Ticker(d)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *Clock) Timer(d time.Duration) *clockapi.Timer {
|
|
||||||
m := c.mock
|
|
||||||
if m == nil {
|
|
||||||
return globalClock.Timer(d)
|
|
||||||
}
|
|
||||||
return m.Timer(d)
|
|
||||||
}
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
package clock_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/logger"
|
|
||||||
. "github.com/onsi/ginkgo/v2"
|
|
||||||
. "github.com/onsi/gomega"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestClockSuite(t *testing.T) {
|
|
||||||
logger.SetOutput(GinkgoWriter)
|
|
||||||
logger.SetErrOutput(GinkgoWriter)
|
|
||||||
|
|
||||||
RegisterFailHandler(Fail)
|
|
||||||
RunSpecs(t, "Clock")
|
|
||||||
}
|
|
||||||
|
|
@ -1,380 +0,0 @@
|
||||||
package clock_test
|
|
||||||
|
|
||||||
import (
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/clock"
|
|
||||||
. "github.com/onsi/ginkgo/v2"
|
|
||||||
. "github.com/onsi/gomega"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
testGlobalEpoch = 1000000000
|
|
||||||
testLocalEpoch = 1234567890
|
|
||||||
)
|
|
||||||
|
|
||||||
var _ = Describe("Clock suite", func() {
|
|
||||||
var testClock = clock.Clock{}
|
|
||||||
|
|
||||||
AfterEach(func() {
|
|
||||||
clock.Reset()
|
|
||||||
testClock.Reset()
|
|
||||||
})
|
|
||||||
|
|
||||||
Context("Global time not overridden", func() {
|
|
||||||
It("errors when trying to Add", func() {
|
|
||||||
err := clock.Add(123 * time.Hour)
|
|
||||||
Expect(err).To(HaveOccurred())
|
|
||||||
})
|
|
||||||
|
|
||||||
Context("Clock not mocked via Set", func() {
|
|
||||||
const (
|
|
||||||
outsideTolerance = int32(0)
|
|
||||||
withinTolerance = int32(1)
|
|
||||||
)
|
|
||||||
|
|
||||||
It("uses time.After for After", func() {
|
|
||||||
var tolerance int32
|
|
||||||
go func() {
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, withinTolerance)
|
|
||||||
}()
|
|
||||||
go func() {
|
|
||||||
time.Sleep(30 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, outsideTolerance)
|
|
||||||
}()
|
|
||||||
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
|
|
||||||
<-testClock.After(20 * time.Millisecond)
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
|
|
||||||
<-testClock.After(20 * time.Millisecond)
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses time.AfterFunc for AfterFunc", func() {
|
|
||||||
var tolerance int32
|
|
||||||
go func() {
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, withinTolerance)
|
|
||||||
}()
|
|
||||||
go func() {
|
|
||||||
time.Sleep(30 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, outsideTolerance)
|
|
||||||
}()
|
|
||||||
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
wg.Add(1)
|
|
||||||
testClock.AfterFunc(20*time.Millisecond, func() {
|
|
||||||
wg.Done()
|
|
||||||
})
|
|
||||||
wg.Wait()
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
|
|
||||||
wg.Add(1)
|
|
||||||
testClock.AfterFunc(20*time.Millisecond, func() {
|
|
||||||
wg.Done()
|
|
||||||
})
|
|
||||||
wg.Wait()
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses time.Now for Now", func() {
|
|
||||||
a := time.Now()
|
|
||||||
b := testClock.Now()
|
|
||||||
Expect(b.Sub(a).Round(10 * time.Millisecond)).To(Equal(0 * time.Millisecond))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses time.Since for Since", func() {
|
|
||||||
past := time.Now().Add(-60 * time.Second)
|
|
||||||
Expect(time.Since(past).Round(10 * time.Millisecond)).
|
|
||||||
To(Equal(60 * time.Second))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses time.Sleep for Sleep", func() {
|
|
||||||
var tolerance int32
|
|
||||||
go func() {
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, withinTolerance)
|
|
||||||
}()
|
|
||||||
go func() {
|
|
||||||
time.Sleep(30 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, outsideTolerance)
|
|
||||||
}()
|
|
||||||
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
|
|
||||||
testClock.Sleep(20 * time.Millisecond)
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
|
|
||||||
testClock.Sleep(20 * time.Millisecond)
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses time.Tick for Tick", func() {
|
|
||||||
var tolerance int32
|
|
||||||
go func() {
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, withinTolerance)
|
|
||||||
}()
|
|
||||||
go func() {
|
|
||||||
time.Sleep(50 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, outsideTolerance)
|
|
||||||
}()
|
|
||||||
|
|
||||||
ch := testClock.Tick(20 * time.Millisecond)
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
<-ch
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
<-ch
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
<-ch
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses time.Ticker for Ticker", func() {
|
|
||||||
var tolerance int32
|
|
||||||
go func() {
|
|
||||||
time.Sleep(10 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, withinTolerance)
|
|
||||||
}()
|
|
||||||
go func() {
|
|
||||||
time.Sleep(50 * time.Millisecond)
|
|
||||||
atomic.StoreInt32(&tolerance, outsideTolerance)
|
|
||||||
}()
|
|
||||||
|
|
||||||
ticker := testClock.Ticker(20 * time.Millisecond)
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
<-ticker.C
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
<-ticker.C
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(withinTolerance))
|
|
||||||
<-ticker.C
|
|
||||||
Expect(atomic.LoadInt32(&tolerance)).To(Equal(outsideTolerance))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("errors if Add is used", func() {
|
|
||||||
err := testClock.Add(100 * time.Second)
|
|
||||||
Expect(err).To(HaveOccurred())
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
Context("Clock mocked via Set", func() {
|
|
||||||
var now = time.Unix(testLocalEpoch, 0)
|
|
||||||
|
|
||||||
BeforeEach(func() {
|
|
||||||
testClock.Set(now)
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks After", func() {
|
|
||||||
var after int32
|
|
||||||
ready := make(chan struct{})
|
|
||||||
ch := testClock.After(10 * time.Second)
|
|
||||||
go func(ch <-chan time.Time) {
|
|
||||||
close(ready)
|
|
||||||
<-ch
|
|
||||||
atomic.StoreInt32(&after, 1)
|
|
||||||
}(ch)
|
|
||||||
<-ready
|
|
||||||
|
|
||||||
err := testClock.Add(9 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err = testClock.Add(1 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(1)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks AfterFunc", func() {
|
|
||||||
var after int32
|
|
||||||
testClock.AfterFunc(10*time.Second, func() {
|
|
||||||
atomic.StoreInt32(&after, 1)
|
|
||||||
})
|
|
||||||
|
|
||||||
err := testClock.Add(9 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err = testClock.Add(1 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(1)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks AfterFunc with a stopped timer", func() {
|
|
||||||
var after int32
|
|
||||||
timer := testClock.AfterFunc(10*time.Second, func() {
|
|
||||||
atomic.StoreInt32(&after, 1)
|
|
||||||
})
|
|
||||||
timer.Stop()
|
|
||||||
|
|
||||||
err := testClock.Add(11 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(0)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks Now", func() {
|
|
||||||
Expect(testClock.Now()).To(Equal(now))
|
|
||||||
err := testClock.Add(123 * time.Hour)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(testClock.Now()).To(Equal(now.Add(123 * time.Hour)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks Since", func() {
|
|
||||||
Expect(testClock.Since(time.Unix(testLocalEpoch-100, 0))).
|
|
||||||
To(Equal(100 * time.Second))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks Sleep", func() {
|
|
||||||
var after int32
|
|
||||||
ready := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
close(ready)
|
|
||||||
testClock.Sleep(10 * time.Second)
|
|
||||||
atomic.StoreInt32(&after, 1)
|
|
||||||
}()
|
|
||||||
<-ready
|
|
||||||
|
|
||||||
err := testClock.Add(9 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err = testClock.Add(1 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(1)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks Tick", func() {
|
|
||||||
var ticks int32
|
|
||||||
ready := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
close(ready)
|
|
||||||
tick := testClock.Tick(10 * time.Second)
|
|
||||||
for ticks < 5 {
|
|
||||||
<-tick
|
|
||||||
atomic.AddInt32(&ticks, 1)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
<-ready
|
|
||||||
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err := testClock.Add(9 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err = testClock.Add(1 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(1)))
|
|
||||||
|
|
||||||
err = testClock.Add(30 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(4)))
|
|
||||||
|
|
||||||
err = testClock.Add(10 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(5)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks Ticker", func() {
|
|
||||||
var ticks int32
|
|
||||||
ready := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
ticker := testClock.Ticker(10 * time.Second)
|
|
||||||
close(ready)
|
|
||||||
for ticks < 5 {
|
|
||||||
<-ticker.C
|
|
||||||
atomic.AddInt32(&ticks, 1)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
<-ready
|
|
||||||
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err := testClock.Add(9 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err = testClock.Add(1 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(1)))
|
|
||||||
|
|
||||||
err = testClock.Add(30 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(4)))
|
|
||||||
|
|
||||||
err = testClock.Add(10 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&ticks)).To(Equal(int32(5)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("mocks Timer", func() {
|
|
||||||
var after int32
|
|
||||||
ready := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
timer := testClock.Timer(10 * time.Second)
|
|
||||||
close(ready)
|
|
||||||
<-timer.C
|
|
||||||
atomic.AddInt32(&after, 1)
|
|
||||||
}()
|
|
||||||
<-ready
|
|
||||||
|
|
||||||
err := testClock.Add(9 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(0)))
|
|
||||||
|
|
||||||
err = testClock.Add(1 * time.Second)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(atomic.LoadInt32(&after)).To(Equal(int32(1)))
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
Context("Global time overridden", func() {
|
|
||||||
var (
|
|
||||||
globalNow = time.Unix(testGlobalEpoch, 0)
|
|
||||||
localNow = time.Unix(testLocalEpoch, 0)
|
|
||||||
)
|
|
||||||
|
|
||||||
BeforeEach(func() {
|
|
||||||
clock.Set(globalNow)
|
|
||||||
})
|
|
||||||
|
|
||||||
Context("Clock not mocked via Set", func() {
|
|
||||||
It("uses globally mocked Now", func() {
|
|
||||||
Expect(testClock.Now()).To(Equal(globalNow))
|
|
||||||
err := clock.Add(123 * time.Hour)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
Expect(testClock.Now()).To(Equal(globalNow.Add(123 * time.Hour)))
|
|
||||||
})
|
|
||||||
|
|
||||||
It("errors when Add is called on the local Clock", func() {
|
|
||||||
err := testClock.Add(100 * time.Hour)
|
|
||||||
Expect(err).To(HaveOccurred())
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
||||||
Context("Clock is mocked via Set", func() {
|
|
||||||
BeforeEach(func() {
|
|
||||||
testClock.Set(localNow)
|
|
||||||
})
|
|
||||||
|
|
||||||
It("uses the local mock and ignores the global", func() {
|
|
||||||
Expect(testClock.Now()).To(Equal(localNow))
|
|
||||||
|
|
||||||
err := clock.Add(456 * time.Hour)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
|
|
||||||
err = testClock.Add(123 * time.Hour)
|
|
||||||
Expect(err).ToNot(HaveOccurred())
|
|
||||||
|
|
||||||
Expect(testClock.Now()).To(Equal(localNow.Add(123 * time.Hour)))
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
})
|
|
||||||
|
|
@ -10,7 +10,6 @@ import (
|
||||||
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/options"
|
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/options"
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
|
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/clock"
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/encryption"
|
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/encryption"
|
||||||
"github.com/vmihailenco/msgpack/v5"
|
"github.com/vmihailenco/msgpack/v5"
|
||||||
)
|
)
|
||||||
|
|
@ -47,7 +46,7 @@ type csrf struct {
|
||||||
CodeVerifier string `msgpack:"cv,omitempty"`
|
CodeVerifier string `msgpack:"cv,omitempty"`
|
||||||
|
|
||||||
cookieOpts *options.Cookie
|
cookieOpts *options.Cookie
|
||||||
time clock.Clock
|
clock func() time.Time
|
||||||
}
|
}
|
||||||
|
|
||||||
// csrtStateTrim will indicate the length of the state trimmed for the name of the csrf cookie
|
// csrtStateTrim will indicate the length of the state trimmed for the name of the csrf cookie
|
||||||
|
|
@ -70,6 +69,7 @@ func NewCSRF(opts *options.Cookie, codeVerifier string) (CSRF, error) {
|
||||||
CodeVerifier: codeVerifier,
|
CodeVerifier: codeVerifier,
|
||||||
|
|
||||||
cookieOpts: opts,
|
cookieOpts: opts,
|
||||||
|
clock: time.Now,
|
||||||
}, nil
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
@ -187,7 +187,7 @@ func ClearExtraCsrfCookies(opts *options.Cookie, rw http.ResponseWriter, req *ht
|
||||||
|
|
||||||
// delete the X oldest cookies
|
// delete the X oldest cookies
|
||||||
slices.SortStableFunc(decodedCookies, func(a, b *csrf) int {
|
slices.SortStableFunc(decodedCookies, func(a, b *csrf) int {
|
||||||
return a.time.Now().Compare(b.time.Now())
|
return a.clock().Compare(b.clock())
|
||||||
})
|
})
|
||||||
|
|
||||||
for i := 0; i < len(decodedCookies)-opts.CSRFPerRequestLimit; i++ {
|
for i := 0; i < len(decodedCookies)-opts.CSRFPerRequestLimit; i++ {
|
||||||
|
|
@ -223,7 +223,7 @@ func (c *csrf) encodeCookie() (string, error) {
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", fmt.Errorf("error getting cookie secret: %v", err)
|
return "", fmt.Errorf("error getting cookie secret: %v", err)
|
||||||
}
|
}
|
||||||
return encryption.SignedValue(secret, c.cookieName(), encrypted, c.time.Now())
|
return encryption.SignedValue(secret, c.cookieName(), encrypted, c.clock())
|
||||||
}
|
}
|
||||||
|
|
||||||
// decodeCSRFCookie validates the signature then decrypts and decodes a CSRF
|
// decodeCSRFCookie validates the signature then decrypts and decodes a CSRF
|
||||||
|
|
@ -249,10 +249,10 @@ func decodeCSRFCookie(cookie *http.Cookie, opts *options.Cookie) (*csrf, error)
|
||||||
|
|
||||||
// unmarshalCSRF unmarshals decrypted data into a CSRF struct
|
// unmarshalCSRF unmarshals decrypted data into a CSRF struct
|
||||||
func unmarshalCSRF(decrypted []byte, opts *options.Cookie, csrfTime time.Time) (*csrf, error) {
|
func unmarshalCSRF(decrypted []byte, opts *options.Cookie, csrfTime time.Time) (*csrf, error) {
|
||||||
clock := clock.Clock{}
|
csrf := &csrf{
|
||||||
clock.Set(csrfTime)
|
cookieOpts: opts,
|
||||||
|
clock: func() time.Time { return csrfTime },
|
||||||
csrf := &csrf{cookieOpts: opts, time: clock}
|
}
|
||||||
if err := msgpack.Unmarshal(decrypted, csrf); err != nil {
|
if err := msgpack.Unmarshal(decrypted, csrf); err != nil {
|
||||||
return nil, fmt.Errorf("error unmarshalling data to CSRF: %v", err)
|
return nil, fmt.Errorf("error unmarshalling data to CSRF: %v", err)
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -128,7 +128,7 @@ var _ = Describe("CSRF Cookie with non-fixed name Tests", func() {
|
||||||
testNow := time.Unix(nowEpoch, 0)
|
testNow := time.Unix(nowEpoch, 0)
|
||||||
|
|
||||||
BeforeEach(func() {
|
BeforeEach(func() {
|
||||||
privateCSRF.time.Set(testNow)
|
privateCSRF.clock = func() time.Time { return testNow }
|
||||||
|
|
||||||
req = &http.Request{
|
req = &http.Request{
|
||||||
Method: http.MethodGet,
|
Method: http.MethodGet,
|
||||||
|
|
@ -144,7 +144,7 @@ var _ = Describe("CSRF Cookie with non-fixed name Tests", func() {
|
||||||
})
|
})
|
||||||
|
|
||||||
AfterEach(func() {
|
AfterEach(func() {
|
||||||
privateCSRF.time.Reset()
|
privateCSRF.clock = time.Now
|
||||||
})
|
})
|
||||||
|
|
||||||
Context("SetCookie", func() {
|
Context("SetCookie", func() {
|
||||||
|
|
@ -200,17 +200,17 @@ var _ = Describe("CSRF Cookie with non-fixed name Tests", func() {
|
||||||
publicCSRF1, err := NewCSRF(cookieOpts, "verifier")
|
publicCSRF1, err := NewCSRF(cookieOpts, "verifier")
|
||||||
Expect(err).ToNot(HaveOccurred())
|
Expect(err).ToNot(HaveOccurred())
|
||||||
privateCSRF1 := publicCSRF1.(*csrf)
|
privateCSRF1 := publicCSRF1.(*csrf)
|
||||||
privateCSRF1.time.Set(testNow)
|
privateCSRF1.clock = func() time.Time { return testNow }
|
||||||
|
|
||||||
publicCSRF2, err := NewCSRF(cookieOpts, "verifier")
|
publicCSRF2, err := NewCSRF(cookieOpts, "verifier")
|
||||||
Expect(err).ToNot(HaveOccurred())
|
Expect(err).ToNot(HaveOccurred())
|
||||||
privateCSRF2 := publicCSRF2.(*csrf)
|
privateCSRF2 := publicCSRF2.(*csrf)
|
||||||
privateCSRF2.time.Set(testNow.Add(time.Minute))
|
privateCSRF2.clock = func() time.Time { return testNow.Add(time.Minute) }
|
||||||
|
|
||||||
publicCSRF3, err := NewCSRF(cookieOpts, "verifier")
|
publicCSRF3, err := NewCSRF(cookieOpts, "verifier")
|
||||||
Expect(err).ToNot(HaveOccurred())
|
Expect(err).ToNot(HaveOccurred())
|
||||||
privateCSRF3 := publicCSRF3.(*csrf)
|
privateCSRF3 := publicCSRF3.(*csrf)
|
||||||
privateCSRF3.time.Set(testNow.Add(time.Minute * 2))
|
privateCSRF3.clock = func() time.Time { return testNow.Add(time.Minute * 2) }
|
||||||
|
|
||||||
cookies := []string{}
|
cookies := []string{}
|
||||||
for _, csrf := range []*csrf{privateCSRF1, privateCSRF2, privateCSRF3} {
|
for _, csrf := range []*csrf{privateCSRF1, privateCSRF2, privateCSRF3} {
|
||||||
|
|
|
||||||
|
|
@ -130,7 +130,7 @@ var _ = Describe("CSRF Cookie Tests", func() {
|
||||||
testNow := time.Unix(nowEpoch, 0)
|
testNow := time.Unix(nowEpoch, 0)
|
||||||
|
|
||||||
BeforeEach(func() {
|
BeforeEach(func() {
|
||||||
privateCSRF.time.Set(testNow)
|
privateCSRF.clock = func() time.Time { return testNow }
|
||||||
|
|
||||||
req = &http.Request{
|
req = &http.Request{
|
||||||
Method: http.MethodGet,
|
Method: http.MethodGet,
|
||||||
|
|
@ -146,7 +146,7 @@ var _ = Describe("CSRF Cookie Tests", func() {
|
||||||
})
|
})
|
||||||
|
|
||||||
AfterEach(func() {
|
AfterEach(func() {
|
||||||
privateCSRF.time.Reset()
|
privateCSRF.clock = time.Now
|
||||||
})
|
})
|
||||||
|
|
||||||
Context("SetCookie", func() {
|
Context("SetCookie", func() {
|
||||||
|
|
@ -173,7 +173,7 @@ var _ = Describe("CSRF Cookie Tests", func() {
|
||||||
Context("LoadCSRFCookie", func() {
|
Context("LoadCSRFCookie", func() {
|
||||||
BeforeEach(func() {
|
BeforeEach(func() {
|
||||||
// we need to reset the time to ensure the cookie is valid
|
// we need to reset the time to ensure the cookie is valid
|
||||||
privateCSRF.time.Reset()
|
privateCSRF.clock = time.Now
|
||||||
})
|
})
|
||||||
|
|
||||||
It("should return error when no cookie is set", func() {
|
It("should return error when no cookie is set", func() {
|
||||||
|
|
|
||||||
|
|
@ -11,7 +11,6 @@ import (
|
||||||
|
|
||||||
middlewareapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/middleware"
|
middlewareapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/middleware"
|
||||||
sessionsapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
|
sessionsapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/pkg/clock"
|
|
||||||
"github.com/oauth2-proxy/oauth2-proxy/v7/providers"
|
"github.com/oauth2-proxy/oauth2-proxy/v7/providers"
|
||||||
. "github.com/onsi/ginkgo/v2"
|
. "github.com/onsi/ginkgo/v2"
|
||||||
. "github.com/onsi/gomega"
|
. "github.com/onsi/gomega"
|
||||||
|
|
@ -95,6 +94,7 @@ var _ = Describe("Stored Session Suite", func() {
|
||||||
now := time.Now()
|
now := time.Now()
|
||||||
createdPast := now.Add(-5 * time.Minute)
|
createdPast := now.Add(-5 * time.Minute)
|
||||||
createdFuture := now.Add(5 * time.Minute)
|
createdFuture := now.Add(5 * time.Minute)
|
||||||
|
clock := func() time.Time { return now }
|
||||||
|
|
||||||
var defaultRefreshFunc = func(_ context.Context, ss *sessionsapi.SessionState) (bool, error) {
|
var defaultRefreshFunc = func(_ context.Context, ss *sessionsapi.SessionState) (bool, error) {
|
||||||
switch ss.RefreshToken {
|
switch ss.RefreshToken {
|
||||||
|
|
@ -120,6 +120,7 @@ var _ = Describe("Stored Session Suite", func() {
|
||||||
RefreshToken: noRefresh,
|
RefreshToken: noRefresh,
|
||||||
CreatedAt: &createdPast,
|
CreatedAt: &createdPast,
|
||||||
ExpiresOn: &createdFuture,
|
ExpiresOn: &createdFuture,
|
||||||
|
Clock: clock,
|
||||||
}, nil
|
}, nil
|
||||||
case "_oauth2_proxy=InvalidNoRefreshSession":
|
case "_oauth2_proxy=InvalidNoRefreshSession":
|
||||||
return &sessionsapi.SessionState{
|
return &sessionsapi.SessionState{
|
||||||
|
|
@ -127,24 +128,28 @@ var _ = Describe("Stored Session Suite", func() {
|
||||||
RefreshToken: noRefresh,
|
RefreshToken: noRefresh,
|
||||||
CreatedAt: &createdPast,
|
CreatedAt: &createdPast,
|
||||||
ExpiresOn: &createdFuture,
|
ExpiresOn: &createdFuture,
|
||||||
|
Clock: clock,
|
||||||
}, nil
|
}, nil
|
||||||
case "_oauth2_proxy=ExpiredNoRefreshSession":
|
case "_oauth2_proxy=ExpiredNoRefreshSession":
|
||||||
return &sessionsapi.SessionState{
|
return &sessionsapi.SessionState{
|
||||||
RefreshToken: noRefresh,
|
RefreshToken: noRefresh,
|
||||||
CreatedAt: &createdPast,
|
CreatedAt: &createdPast,
|
||||||
ExpiresOn: &createdPast,
|
ExpiresOn: &createdPast,
|
||||||
|
Clock: clock,
|
||||||
}, nil
|
}, nil
|
||||||
case "_oauth2_proxy=RefreshSession":
|
case "_oauth2_proxy=RefreshSession":
|
||||||
return &sessionsapi.SessionState{
|
return &sessionsapi.SessionState{
|
||||||
RefreshToken: refresh,
|
RefreshToken: refresh,
|
||||||
CreatedAt: &createdPast,
|
CreatedAt: &createdPast,
|
||||||
ExpiresOn: &createdFuture,
|
ExpiresOn: &createdFuture,
|
||||||
|
Clock: clock,
|
||||||
}, nil
|
}, nil
|
||||||
case "_oauth2_proxy=RefreshError":
|
case "_oauth2_proxy=RefreshError":
|
||||||
return &sessionsapi.SessionState{
|
return &sessionsapi.SessionState{
|
||||||
RefreshToken: "RefreshError",
|
RefreshToken: "RefreshError",
|
||||||
CreatedAt: &createdPast,
|
CreatedAt: &createdPast,
|
||||||
ExpiresOn: &createdFuture,
|
ExpiresOn: &createdFuture,
|
||||||
|
Clock: clock,
|
||||||
}, nil
|
}, nil
|
||||||
case "_oauth2_proxy=NonExistent":
|
case "_oauth2_proxy=NonExistent":
|
||||||
return nil, fmt.Errorf("invalid cookie")
|
return nil, fmt.Errorf("invalid cookie")
|
||||||
|
|
@ -154,14 +159,6 @@ var _ = Describe("Stored Session Suite", func() {
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
BeforeEach(func() {
|
|
||||||
clock.Set(now)
|
|
||||||
})
|
|
||||||
|
|
||||||
AfterEach(func() {
|
|
||||||
clock.Reset()
|
|
||||||
})
|
|
||||||
|
|
||||||
type storedSessionLoaderTableInput struct {
|
type storedSessionLoaderTableInput struct {
|
||||||
requestHeaders http.Header
|
requestHeaders http.Header
|
||||||
existingSession *sessionsapi.SessionState
|
existingSession *sessionsapi.SessionState
|
||||||
|
|
@ -200,7 +197,15 @@ var _ = Describe("Stored Session Suite", func() {
|
||||||
}))
|
}))
|
||||||
handler.ServeHTTP(rw, req)
|
handler.ServeHTTP(rw, req)
|
||||||
|
|
||||||
Expect(gotSession).To(Equal(in.expectedSession))
|
// Compare, ignoring testing Clock.
|
||||||
|
if in.expectedSession == nil {
|
||||||
|
Expect(gotSession).To(BeNil())
|
||||||
|
return
|
||||||
|
}
|
||||||
|
Expect(gotSession).ToNot(BeNil())
|
||||||
|
got := *gotSession
|
||||||
|
got.Clock = nil
|
||||||
|
Expect(&got).To(Equal(in.expectedSession))
|
||||||
},
|
},
|
||||||
Entry("with no cookie", storedSessionLoaderTableInput{
|
Entry("with no cookie", storedSessionLoaderTableInput{
|
||||||
requestHeaders: http.Header{},
|
requestHeaders: http.Header{},
|
||||||
|
|
|
||||||
|
|
@ -233,12 +233,17 @@ func (t *ticket) clearCookie(rw http.ResponseWriter, req *http.Request) {
|
||||||
// makeCookie makes a cookie, signing the value if present
|
// makeCookie makes a cookie, signing the value if present
|
||||||
func (t *ticket) makeCookie(req *http.Request, value string, expires time.Duration, now time.Time) (*http.Cookie, error) {
|
func (t *ticket) makeCookie(req *http.Request, value string, expires time.Duration, now time.Time) (*http.Cookie, error) {
|
||||||
if value != "" {
|
if value != "" {
|
||||||
var err error
|
secret, err := t.options.GetSecret()
|
||||||
value, err = encryption.SignedValue(t.options.Secret, t.options.Name, []byte(value), now)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return nil, err
|
return nil, fmt.Errorf("retrieving secret failed: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
value, err = encryption.SignedValue(secret, t.options.Name, []byte(value), now)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("signing cookie value failed: %w", err)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return cookies.MakeCookieFromOptions(
|
return cookies.MakeCookieFromOptions(
|
||||||
req,
|
req,
|
||||||
t.options.Name,
|
t.options.Name,
|
||||||
|
|
|
||||||
|
|
@ -4,6 +4,7 @@ import (
|
||||||
"crypto/rand"
|
"crypto/rand"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/http/httptest"
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"time"
|
"time"
|
||||||
|
|
@ -133,6 +134,42 @@ func RunSessionStoreTests(newSS NewSessionStoreFunc, persistentFastForward Persi
|
||||||
PersistentSessionStoreInterfaceTests(&input)
|
PersistentSessionStoreInterfaceTests(&input)
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
|
|
||||||
|
Context("with cookie secret file", func() {
|
||||||
|
var tmpfile *os.File
|
||||||
|
var err error
|
||||||
|
BeforeEach(func() {
|
||||||
|
tmpfile, err = os.CreateTemp("", "cookie-secret-test")
|
||||||
|
secretBytes := make([]byte, 32)
|
||||||
|
tmpfile.Write(secretBytes)
|
||||||
|
tmpfile.Close()
|
||||||
|
|
||||||
|
input.cookieOpts = &options.Cookie{
|
||||||
|
Name: "_oauth2_proxy_file",
|
||||||
|
Path: "/",
|
||||||
|
Expire: time.Duration(168) * time.Hour,
|
||||||
|
Refresh: time.Duration(1) * time.Hour,
|
||||||
|
Secure: true,
|
||||||
|
HTTPOnly: true,
|
||||||
|
SameSite: "",
|
||||||
|
Secret: "",
|
||||||
|
SecretFile: tmpfile.Name(),
|
||||||
|
}
|
||||||
|
ss, err = newSS(opts, input.cookieOpts)
|
||||||
|
Expect(err).ToNot(HaveOccurred())
|
||||||
|
})
|
||||||
|
|
||||||
|
AfterEach(func() {
|
||||||
|
if tmpfile != nil {
|
||||||
|
os.Remove(tmpfile.Name())
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
SessionStoreInterfaceTests(&input)
|
||||||
|
if persistentFastForward != nil {
|
||||||
|
PersistentSessionStoreInterfaceTests(&input)
|
||||||
|
}
|
||||||
|
})
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -40,6 +40,8 @@ type GoogleProvider struct {
|
||||||
// Refresh. `Authorize` uses the results of this saved in `session.Groups`
|
// Refresh. `Authorize` uses the results of this saved in `session.Groups`
|
||||||
// Since it is called on every request.
|
// Since it is called on every request.
|
||||||
groupValidator func(*sessions.SessionState) bool
|
groupValidator func(*sessions.SessionState) bool
|
||||||
|
|
||||||
|
setPreferredUsername func(s *sessions.SessionState) error
|
||||||
}
|
}
|
||||||
|
|
||||||
var _ Provider = (*GoogleProvider)(nil)
|
var _ Provider = (*GoogleProvider)(nil)
|
||||||
|
|
@ -100,17 +102,59 @@ func NewGoogleProvider(p *ProviderData, opts options.GoogleOptions) (*GoogleProv
|
||||||
groupValidator: func(*sessions.SessionState) bool {
|
groupValidator: func(*sessions.SessionState) bool {
|
||||||
return true
|
return true
|
||||||
},
|
},
|
||||||
|
|
||||||
|
setPreferredUsername: func(state *sessions.SessionState) error {
|
||||||
|
return nil
|
||||||
|
},
|
||||||
}
|
}
|
||||||
|
|
||||||
if opts.ServiceAccountJSON != "" || opts.UseApplicationDefaultCredentials {
|
if opts.UseOrganizationId || opts.ServiceAccountJSON != "" || opts.UseApplicationDefaultCredentials {
|
||||||
provider.configureGroups(opts)
|
|
||||||
}
|
|
||||||
|
|
||||||
|
// reuse admin service to avoid multiple calls for token
|
||||||
|
var adminService *admin.Service
|
||||||
|
|
||||||
|
if opts.UseOrganizationId {
|
||||||
|
// add user scopes to admin api
|
||||||
|
userScope := getAdminApiUserScope(opts.AdminApiUserScope)
|
||||||
|
for index, scope := range possibleScopesList {
|
||||||
|
possibleScopesList[index] = scope + " " + userScope
|
||||||
|
}
|
||||||
|
|
||||||
|
adminService = getAdminService(opts)
|
||||||
|
|
||||||
|
provider.setPreferredUsername = func(s *sessions.SessionState) error {
|
||||||
|
userName, err := getUserInfo(adminService, s.Email)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
s.PreferredUsername = userName
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if opts.ServiceAccountJSON != "" || opts.UseApplicationDefaultCredentials {
|
||||||
|
if adminService == nil {
|
||||||
|
adminService = getAdminService(opts)
|
||||||
|
}
|
||||||
|
provider.configureGroups(opts, adminService)
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
return provider, nil
|
return provider, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (p *GoogleProvider) configureGroups(opts options.GoogleOptions) {
|
// by default can be readonly user scope
|
||||||
adminService := getAdminService(opts)
|
func getAdminApiUserScope(adminApiUserScope string) string {
|
||||||
|
switch adminApiUserScope {
|
||||||
|
case "cloud":
|
||||||
|
return admin.CloudPlatformScope
|
||||||
|
case "user":
|
||||||
|
return admin.AdminDirectoryUserScope
|
||||||
|
}
|
||||||
|
return admin.AdminDirectoryUserReadonlyScope
|
||||||
|
}
|
||||||
|
|
||||||
|
func (p *GoogleProvider) configureGroups(opts options.GoogleOptions, adminService *admin.Service) {
|
||||||
// Backwards compatibility with `--google-group` option
|
// Backwards compatibility with `--google-group` option
|
||||||
if len(opts.Groups) > 0 {
|
if len(opts.Groups) > 0 {
|
||||||
p.setAllowedGroups(opts.Groups)
|
p.setAllowedGroups(opts.Groups)
|
||||||
|
|
@ -204,6 +248,7 @@ func (p *GoogleProvider) Redeem(ctx context.Context, redirectURL, code, codeVeri
|
||||||
|
|
||||||
// EnrichSession checks the listed Google Groups configured and adds any
|
// EnrichSession checks the listed Google Groups configured and adds any
|
||||||
// that the user is a member of to session.Groups.
|
// that the user is a member of to session.Groups.
|
||||||
|
// if preferred username is configured to be organization ID, it sets that as well.
|
||||||
func (p *GoogleProvider) EnrichSession(_ context.Context, s *sessions.SessionState) error {
|
func (p *GoogleProvider) EnrichSession(_ context.Context, s *sessions.SessionState) error {
|
||||||
// TODO (@NickMeves) - Move to pure EnrichSession logic and stop
|
// TODO (@NickMeves) - Move to pure EnrichSession logic and stop
|
||||||
// reusing legacy `groupValidator`.
|
// reusing legacy `groupValidator`.
|
||||||
|
|
@ -212,7 +257,7 @@ func (p *GoogleProvider) EnrichSession(_ context.Context, s *sessions.SessionSta
|
||||||
// populating logic.
|
// populating logic.
|
||||||
p.groupValidator(s)
|
p.groupValidator(s)
|
||||||
|
|
||||||
return nil
|
return p.setPreferredUsername(s)
|
||||||
}
|
}
|
||||||
|
|
||||||
// SetGroupRestriction configures the GoogleProvider to restrict access to the
|
// SetGroupRestriction configures the GoogleProvider to restrict access to the
|
||||||
|
|
@ -262,7 +307,7 @@ func getOauth2TokenSource(ctx context.Context, opts options.GoogleOptions, scope
|
||||||
if opts.UseApplicationDefaultCredentials {
|
if opts.UseApplicationDefaultCredentials {
|
||||||
ts, err := impersonate.CredentialsTokenSource(ctx, impersonate.CredentialsConfig{
|
ts, err := impersonate.CredentialsTokenSource(ctx, impersonate.CredentialsConfig{
|
||||||
TargetPrincipal: getTargetPrincipal(ctx, opts),
|
TargetPrincipal: getTargetPrincipal(ctx, opts),
|
||||||
Scopes: []string{scope},
|
Scopes: strings.Split(scope, " "),
|
||||||
Subject: opts.AdminEmail,
|
Subject: opts.AdminEmail,
|
||||||
})
|
})
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|
@ -364,6 +409,30 @@ func getTargetPrincipal(ctx context.Context, opts options.GoogleOptions) (target
|
||||||
return targetPrincipal
|
return targetPrincipal
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func getUserInfo(service *admin.Service, email string) (string, error) {
|
||||||
|
req := service.Users.Get(email)
|
||||||
|
user, err := req.Do()
|
||||||
|
if err != nil {
|
||||||
|
return "", fmt.Errorf("failed to get user details for %s: %v", email, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
ext, _ := user.ExternalIds.([]interface{})
|
||||||
|
for _, v := range ext {
|
||||||
|
m, _ := v.(map[string]interface{})
|
||||||
|
if m == nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if t, _ := m["type"].(string); t != "organization" {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if val, _ := m["value"].(string); val != "" {
|
||||||
|
return val, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return "", fmt.Errorf("failed to get organization id for %s", email)
|
||||||
|
}
|
||||||
|
|
||||||
// getUserGroups retrieves all groups that a user is a member of using the Google Admin Directory API
|
// getUserGroups retrieves all groups that a user is a member of using the Google Admin Directory API
|
||||||
func getUserGroups(service *admin.Service, email string) ([]string, error) {
|
func getUserGroups(service *admin.Service, email string) ([]string, error) {
|
||||||
var allGroups []string
|
var allGroups []string
|
||||||
|
|
|
||||||
|
|
@ -325,3 +325,83 @@ func TestGoogleProvider_getUserGroups(t *testing.T) {
|
||||||
assert.NoError(t, err)
|
assert.NoError(t, err)
|
||||||
assert.Equal(t, []string{"group1@example.com", "group2@example.com"}, groups)
|
assert.Equal(t, []string{"group1@example.com", "group2@example.com"}, groups)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
func TestGoogleProvider_getUserInfo(t *testing.T) {
|
||||||
|
ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
if r.URL.Path == "/admin/directory/v1/users/test@example.com" {
|
||||||
|
response := `{
|
||||||
|
"kind": "admin#directory#user",
|
||||||
|
"id": "",
|
||||||
|
"etag": "\"\"",
|
||||||
|
"primaryEmail": "test@example.com",
|
||||||
|
"name": {
|
||||||
|
"givenName": "Test",
|
||||||
|
"familyName": "User",
|
||||||
|
"fullName": "Test User"
|
||||||
|
},
|
||||||
|
"isAdmin": false,
|
||||||
|
"isDelegatedAdmin": false,
|
||||||
|
"lastLoginTime": "",
|
||||||
|
"creationTime": "",
|
||||||
|
"agreedToTerms": true,
|
||||||
|
"suspended": false,
|
||||||
|
"archived": false,
|
||||||
|
"changePasswordAtNextLogin": false,
|
||||||
|
"ipWhitelisted": false,
|
||||||
|
"emails": [
|
||||||
|
{
|
||||||
|
"address": "test@example.com",
|
||||||
|
"primary": true
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"externalIds": [
|
||||||
|
{
|
||||||
|
"value": "test.user",
|
||||||
|
"type": "organization"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"organizations": [
|
||||||
|
],
|
||||||
|
"phones": [
|
||||||
|
],
|
||||||
|
"languages": [
|
||||||
|
{
|
||||||
|
"languageCode": "en",
|
||||||
|
"preference": "preferred"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"aliases": [
|
||||||
|
"test.user@example.com"
|
||||||
|
],
|
||||||
|
"nonEditableAliases": [
|
||||||
|
"test.user@example.com"
|
||||||
|
],
|
||||||
|
"gender": {
|
||||||
|
"type": "male"
|
||||||
|
},
|
||||||
|
"customerId": "",
|
||||||
|
"orgUnitPath": "/",
|
||||||
|
"isMailboxSetup": true,
|
||||||
|
"isEnrolledIn2Sv": true,
|
||||||
|
"isEnforcedIn2Sv": false,
|
||||||
|
"includeInGlobalAddressList": true,
|
||||||
|
"thumbnailPhotoUrl": "",
|
||||||
|
"thumbnailPhotoEtag": "\"\"",
|
||||||
|
"recoveryEmail": "test.user@gmail.com",
|
||||||
|
"recoveryPhone": "+55555555555"
|
||||||
|
}`
|
||||||
|
fmt.Fprintln(w, response)
|
||||||
|
} else {
|
||||||
|
http.NotFound(w, r)
|
||||||
|
}
|
||||||
|
}))
|
||||||
|
defer ts.Close()
|
||||||
|
|
||||||
|
client := &http.Client{}
|
||||||
|
adminService, err := admin.NewService(context.Background(), option.WithHTTPClient(client), option.WithEndpoint(ts.URL))
|
||||||
|
assert.NoError(t, err)
|
||||||
|
|
||||||
|
info, err := getUserInfo(adminService, "test@example.com")
|
||||||
|
assert.NoError(t, err)
|
||||||
|
assert.Equal(t, "test.user", info)
|
||||||
|
}
|
||||||
|
|
|
||||||
|
|
@ -17,8 +17,9 @@ func TestRefresh(t *testing.T) {
|
||||||
now := time.Unix(1234567890, 10)
|
now := time.Unix(1234567890, 10)
|
||||||
expires := time.Unix(1234567890, 0)
|
expires := time.Unix(1234567890, 0)
|
||||||
|
|
||||||
ss := &sessions.SessionState{}
|
ss := &sessions.SessionState{
|
||||||
ss.Clock.Set(now)
|
Clock: func() time.Time { return now },
|
||||||
|
}
|
||||||
ss.SetExpiresOn(expires)
|
ss.SetExpiresOn(expires)
|
||||||
|
|
||||||
refreshed, err := p.RefreshSession(context.Background(), ss)
|
refreshed, err := p.RefreshSession(context.Background(), ss)
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue