Compare commits
No commits in common. "master" and "v1.1" have entirely different histories.
|
|
@ -1,14 +0,0 @@
|
||||||
FROM mcr.microsoft.com/vscode/devcontainers/go:1-1.23
|
|
||||||
|
|
||||||
SHELL ["/bin/bash", "-o", "pipefail", "-c"]
|
|
||||||
|
|
||||||
RUN apt-get update \
|
|
||||||
&& apt-get install -y --no-install-recommends \
|
|
||||||
pre-commit \
|
|
||||||
vim \
|
|
||||||
&& apt-get clean \
|
|
||||||
&& rm -rf /var/lib/apt/lists/* \
|
|
||||||
&& mkdir -p /go/pkg \
|
|
||||||
&& chmod -R a+w /go/pkg
|
|
||||||
|
|
||||||
WORKDIR /workspace
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
{
|
|
||||||
"name": "oauth2-proxy Dev",
|
|
||||||
"context": "..",
|
|
||||||
"dockerFile": "./Dockerfile",
|
|
||||||
"postCreateCommand": "pre-commit install && go mod download",
|
|
||||||
"containerEnv": { "DEVCONTAINER": "1" },
|
|
||||||
"appPort": ["4180:4180"],
|
|
||||||
"runArgs": ["-e", "GIT_EDITOR=code --wait"],
|
|
||||||
"customizations": {
|
|
||||||
"vscode": {
|
|
||||||
"extensions": [
|
|
||||||
"golang.go",
|
|
||||||
"ms-vscode.makefile-tools",
|
|
||||||
"visualstudioexptteam.vscodeintellicode",
|
|
||||||
"redhat.vscode-yaml",
|
|
||||||
"esbenp.prettier-vscode",
|
|
||||||
"GitHub.vscode-pull-request-github"
|
|
||||||
],
|
|
||||||
"settings": {
|
|
||||||
"editor.formatOnPaste": false,
|
|
||||||
"editor.formatOnSave": true,
|
|
||||||
"editor.formatOnType": true,
|
|
||||||
"files.trimTrailingWhitespace": true,
|
|
||||||
"yaml.customTags": [
|
|
||||||
"!input scalar",
|
|
||||||
"!secret scalar",
|
|
||||||
"!include_dir_named scalar",
|
|
||||||
"!include_dir_list scalar",
|
|
||||||
"!include_dir_merge_list scalar",
|
|
||||||
"!include_dir_merge_named scalar"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"features": {
|
|
||||||
"ghcr.io/devcontainers/features/docker-in-docker": {},
|
|
||||||
"ghcr.io/devcontainers/features/common-utils": {
|
|
||||||
"configureZshAsDefaultShell": true,
|
|
||||||
"username": "vscode",
|
|
||||||
"userUid": 1000,
|
|
||||||
"userGid": 1000
|
|
||||||
},
|
|
||||||
"ghcr.io/devcontainers/features/kubectl-helm-minikube": {}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
Dockerfile.dev
|
|
||||||
Dockerfile
|
|
||||||
docs
|
|
||||||
vendor
|
|
||||||
.git
|
|
||||||
oauth2-proxy
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
# Default owner should be a core org reviewers unless overridden by later rules in this file
|
|
||||||
* @oauth2-proxy/reviewers
|
|
||||||
|
|
||||||
# login.gov provider
|
|
||||||
# Note: If @timothy-spencer terms out of his appointment, your best bet
|
|
||||||
# for finding somebody who can test the oauth2-proxy would be to ask somebody
|
|
||||||
# in the login.gov team (https://login.gov/developers/), the cloud.gov team
|
|
||||||
# (https://cloud.gov/docs/help/), or the 18F org (https://18f.gsa.gov/contact/
|
|
||||||
# or the public devops channel at https://chat.18f.gov/).
|
|
||||||
providers/logingov.go @timothy-spencer
|
|
||||||
providers/logingov_test.go @timothy-spencer
|
|
||||||
|
|
||||||
# Bitbucket provider
|
|
||||||
providers/bitbucket.go @aledeganopix4d
|
|
||||||
providers/bitbucket_test.go @aledeganopix4d
|
|
||||||
|
|
||||||
# Nextcloud provider
|
|
||||||
providers/nextcloud.go @Ramblurr
|
|
||||||
providers/nextcloud_test.go @Ramblurr
|
|
||||||
|
|
||||||
# DigitalOcean provider
|
|
||||||
providers/digitalocean.go @kamaln7
|
|
||||||
providers/digitalocean_test.go @kamaln7
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
# These are supported funding model platforms
|
|
||||||
|
|
||||||
github: tuunit # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
|
|
||||||
patreon: # Replace with a single Patreon username
|
|
||||||
open_collective: oauth2-proxy # Replace with a single Open Collective username
|
|
||||||
ko_fi: # Replace with a single Ko-fi username
|
|
||||||
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
|
|
||||||
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
|
||||||
liberapay: # Replace with a single Liberapay username
|
|
||||||
issuehunt: # Replace with a single IssueHunt username
|
|
||||||
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
|
||||||
polar: # Replace with a single Polar username
|
|
||||||
buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
|
|
||||||
thanks_dev: # Replace with a single thanks.dev username
|
|
||||||
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
|
||||||
|
|
@ -1,73 +0,0 @@
|
||||||
name: Bug report
|
|
||||||
description: Bug descriptions or unexpected behaviour
|
|
||||||
title: "[Bug]: <Short description>"
|
|
||||||
labels: ["bug","help wanted"]
|
|
||||||
body:
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: OAuth2-Proxy Version
|
|
||||||
description: Which version of oauth2-proxy are you using?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Provider
|
|
||||||
description: Which identity provider are you using?
|
|
||||||
options:
|
|
||||||
- adfs
|
|
||||||
- azure
|
|
||||||
- bitbucket
|
|
||||||
- digitalocean
|
|
||||||
- entra-id
|
|
||||||
- facebook
|
|
||||||
- gitea
|
|
||||||
- github
|
|
||||||
- gitlab
|
|
||||||
- google
|
|
||||||
- keycloak
|
|
||||||
- keycloak-oidc
|
|
||||||
- linkedin
|
|
||||||
- logingov
|
|
||||||
- nextcloud
|
|
||||||
- oidc
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Expected Behaviour
|
|
||||||
description: Tell us what you expect to happen.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Current Behaviour
|
|
||||||
description: Tell us what happens instead of the expected behavior.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Steps To Reproduce
|
|
||||||
description: Steps to reproduce the behavior.
|
|
||||||
placeholder: |
|
|
||||||
1. In this environment...
|
|
||||||
1. With this config...
|
|
||||||
1. Run '...'
|
|
||||||
1. See error...
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Possible Solutions
|
|
||||||
description: Not obligatory, but suggest a fix/reason for the bug.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Configuration details or additional information
|
|
||||||
description: |
|
|
||||||
Please share more details about your environment and how you configured oauth2-proxy.
|
|
||||||
|
|
||||||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
|
|
@ -1,6 +0,0 @@
|
||||||
blank_issues_enabled: false
|
|
||||||
contact_links:
|
|
||||||
- name: OAuth2-Proxy Slack
|
|
||||||
url: https://gophers.slack.com/messages/CM2RSS25N
|
|
||||||
about: Feel free to ask any questions here.
|
|
||||||
|
|
||||||
|
|
@ -1,61 +0,0 @@
|
||||||
name: Configuration support
|
|
||||||
description: Configuration problems and overall requests on how to properly use oauth2-proxy.
|
|
||||||
title: "[Support]: <Short description>"
|
|
||||||
labels: ["configuration", "help wanted"]
|
|
||||||
body:
|
|
||||||
- type: input
|
|
||||||
attributes:
|
|
||||||
label: OAuth2-Proxy Version
|
|
||||||
description: Which version of oauth2-proxy are you using?
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Provider
|
|
||||||
description: Which identity provider are you using?
|
|
||||||
options:
|
|
||||||
- adfs
|
|
||||||
- azure
|
|
||||||
- bitbucket
|
|
||||||
- digitalocean
|
|
||||||
- entra-id
|
|
||||||
- facebook
|
|
||||||
- gitea
|
|
||||||
- github
|
|
||||||
- gitlab
|
|
||||||
- google
|
|
||||||
- keycloak
|
|
||||||
- keycloak-oidc
|
|
||||||
- linkedin
|
|
||||||
- logingov
|
|
||||||
- nextcloud
|
|
||||||
- oidc
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Current Behaviour of your Problem
|
|
||||||
description: Tell us what you expect to happen and what happens instead.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Configuration details or additional information
|
|
||||||
description: |
|
|
||||||
Please share more details about your environment and how you configured oauth2-proxy.
|
|
||||||
|
|
||||||
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Steps To Reproduce
|
|
||||||
description: Steps to reproduce the behavior.
|
|
||||||
placeholder: |
|
|
||||||
1. In this environment...
|
|
||||||
1. With this config...
|
|
||||||
1. Run '...'
|
|
||||||
1. See error...
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
|
|
@ -1,51 +0,0 @@
|
||||||
name: Feature request
|
|
||||||
description: Feature requests or proposals related to the overall project or specific providers
|
|
||||||
title: "[Feature]: <Short description>"
|
|
||||||
labels: ["enhancement"]
|
|
||||||
body:
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Motivation
|
|
||||||
description: Tell us the motivation behind your feature request or proposal.
|
|
||||||
validations:
|
|
||||||
required: true
|
|
||||||
- type: textarea
|
|
||||||
attributes:
|
|
||||||
label: Possible solution
|
|
||||||
description: |
|
|
||||||
If you already have a possible solution in mind. Write some more details about it or add some pseudo code.
|
|
||||||
|
|
||||||
Tip 1: You can attach images or log files by clicking this area to highlight it and then dragging files in.
|
|
||||||
Tip 2: You can add code snippets in triple backtiks like so:
|
|
||||||
\`\`\`golang
|
|
||||||
func hello() {
|
|
||||||
fmt.Println("world")
|
|
||||||
}
|
|
||||||
\`\`\`
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
- type: dropdown
|
|
||||||
attributes:
|
|
||||||
label: Provider
|
|
||||||
description: Is it a feature request for a specific provider. Not mandatory.
|
|
||||||
options:
|
|
||||||
- new provider
|
|
||||||
- adfs
|
|
||||||
- azure
|
|
||||||
- bitbucket
|
|
||||||
- digitalocean
|
|
||||||
- entra-id
|
|
||||||
- facebook
|
|
||||||
- gitea
|
|
||||||
- github
|
|
||||||
- gitlab
|
|
||||||
- google
|
|
||||||
- keycloak
|
|
||||||
- keycloak-oidc
|
|
||||||
- linkedin
|
|
||||||
- logingov
|
|
||||||
- nextcloud
|
|
||||||
- oidc
|
|
||||||
validations:
|
|
||||||
required: false
|
|
||||||
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
<!--- Provide a general summary of your changes in the Title above -->
|
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
<!--- Describe your changes in detail -->
|
|
||||||
|
|
||||||
## Motivation and Context
|
|
||||||
|
|
||||||
<!--- Why is this change required? What problem does it solve? -->
|
|
||||||
<!--- If it fixes an open issue, please link to the issue here. -->
|
|
||||||
|
|
||||||
## How Has This Been Tested?
|
|
||||||
|
|
||||||
<!--- Please describe in detail how you tested your changes. -->
|
|
||||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
|
||||||
<!--- see how your change affects other areas of the code, etc. -->
|
|
||||||
|
|
||||||
## Checklist:
|
|
||||||
|
|
||||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
|
||||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
|
||||||
|
|
||||||
- [ ] My change requires a change to the documentation or CHANGELOG.
|
|
||||||
- [ ] I have updated the documentation/CHANGELOG accordingly.
|
|
||||||
- [ ] I have created a feature (non-master) branch for my PR.
|
|
||||||
- [ ] I have written tests for my code changes.
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
go:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- '**/*.go'
|
|
||||||
|
|
||||||
docs:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- '**/*.md'
|
|
||||||
|
|
||||||
changelog:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- 'CHAGELOG.md'
|
|
||||||
|
|
||||||
tests:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- '**/*_test.go'
|
|
||||||
|
|
||||||
provider:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- 'providers/**/*'
|
|
||||||
|
|
||||||
dependencies:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- 'go.mod'
|
|
||||||
- 'go.sum'
|
|
||||||
|
|
||||||
docker:
|
|
||||||
- changed-files:
|
|
||||||
- any-glob-to-any-file:
|
|
||||||
- '**/Dockerfile'
|
|
||||||
|
|
@ -1,58 +0,0 @@
|
||||||
{
|
|
||||||
$schema: "https://docs.renovatebot.com/renovate-schema.json",
|
|
||||||
semanticCommits: "enabled",
|
|
||||||
schedule: [
|
|
||||||
"after 8am on sunday"
|
|
||||||
],
|
|
||||||
prConcurrentLimit: 0,
|
|
||||||
prHourlyLimit: 0,
|
|
||||||
enabledManagers: [
|
|
||||||
"dockerfile",
|
|
||||||
"docker-compose",
|
|
||||||
"gomod",
|
|
||||||
"github-actions",
|
|
||||||
"helmv3",
|
|
||||||
"npm",
|
|
||||||
"regex",
|
|
||||||
],
|
|
||||||
packageRules: [
|
|
||||||
{
|
|
||||||
matchManagers: [
|
|
||||||
"dockerfile",
|
|
||||||
"docker-compose",
|
|
||||||
"gomod",
|
|
||||||
"helmv3",
|
|
||||||
"npm",
|
|
||||||
],
|
|
||||||
groupName: "{{{manager}}}",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
matchDepNames: [
|
|
||||||
"docker.io/library/golang",
|
|
||||||
"mcr.microsoft.com/vscode/devcontainers/go",
|
|
||||||
],
|
|
||||||
groupName: "golang",
|
|
||||||
},
|
|
||||||
],
|
|
||||||
customManagers: [
|
|
||||||
{
|
|
||||||
customType: "regex",
|
|
||||||
fileMatch: [
|
|
||||||
"^Makefile",
|
|
||||||
],
|
|
||||||
matchStrings: [
|
|
||||||
"DOCKER_BUILD_RUNTIME_IMAGE_ALPINE\\s+?\\?= alpine:(?<currentValue>.*)\\s"
|
|
||||||
],
|
|
||||||
depNameTemplate: "alpine",
|
|
||||||
datasourceTemplate: "docker",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
customType: "regex",
|
|
||||||
fileMatch: ["(^|/)\\.github/workflows/[^/]+\\.ya?ml$"],
|
|
||||||
matchStrings: [
|
|
||||||
"# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s+?[\\w\\s-]*?version: (?<currentValue>.*)\\s",
|
|
||||||
"# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s+?[\\w\\s]*?_VERSION: (?<currentValue>.*)\\s",
|
|
||||||
],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
@ -1,81 +0,0 @@
|
||||||
name: Continuous Integration
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- '**'
|
|
||||||
pull_request:
|
|
||||||
branches:
|
|
||||||
- '**'
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
env:
|
|
||||||
COVER: true
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
|
|
||||||
- name: Set up Go
|
|
||||||
uses: actions/setup-go@v6
|
|
||||||
with:
|
|
||||||
go-version-file: go.mod
|
|
||||||
id: go
|
|
||||||
|
|
||||||
- name: Get dependencies
|
|
||||||
env:
|
|
||||||
# renovate: datasource=github-tags depName=golangci/golangci-lint
|
|
||||||
GOLANGCI_LINT_VERSION: v2.5.0
|
|
||||||
run: |
|
|
||||||
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
|
|
||||||
chmod +x ./cc-test-reporter
|
|
||||||
|
|
||||||
- name: Verify Code Generation
|
|
||||||
run: |
|
|
||||||
make verify-generate
|
|
||||||
|
|
||||||
- name: Lint
|
|
||||||
run: |
|
|
||||||
make lint
|
|
||||||
|
|
||||||
- name: Build
|
|
||||||
if: (!startsWith(github.head_ref, 'release'))
|
|
||||||
run: |
|
|
||||||
make build
|
|
||||||
|
|
||||||
# For release testing
|
|
||||||
- name: Build All
|
|
||||||
if: github.base_ref == 'master' && startsWith(github.head_ref, 'release')
|
|
||||||
run: |
|
|
||||||
make release
|
|
||||||
|
|
||||||
- name: Test
|
|
||||||
env:
|
|
||||||
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
|
|
||||||
run: |
|
|
||||||
./.github/workflows/test.sh
|
|
||||||
|
|
||||||
docker:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
id: buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Docker Build
|
|
||||||
if: (!startsWith(github.head_ref, 'release'))
|
|
||||||
run: |
|
|
||||||
make build-docker
|
|
||||||
|
|
||||||
# For release testing
|
|
||||||
- name: Docker Build All
|
|
||||||
if: github.base_ref == 'master' && startsWith(github.head_ref, 'release')
|
|
||||||
run: |
|
|
||||||
make build-docker-all
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
name: "Code scanning - action"
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths-ignore:
|
|
||||||
- '.devcontainer/**'
|
|
||||||
- '.vscode/**'
|
|
||||||
- 'contrib/**'
|
|
||||||
- 'docs/**'
|
|
||||||
pull_request:
|
|
||||||
# The branches below must be a subset of the branches above
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
paths-ignore:
|
|
||||||
- '.devcontainer/**'
|
|
||||||
- '.vscode/**'
|
|
||||||
- 'contrib/**'
|
|
||||||
- 'docs/**'
|
|
||||||
schedule:
|
|
||||||
- cron: '0 15 * * 2'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
CodeQL-Build:
|
|
||||||
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
|
|
||||||
# CodeQL runs on ubuntu-latest and windows-latest
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: Checkout repository
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
|
|
||||||
# Initializes the CodeQL tools for scanning.
|
|
||||||
- name: Initialize CodeQL
|
|
||||||
uses: github/codeql-action/init@v3
|
|
||||||
with:
|
|
||||||
languages: go
|
|
||||||
|
|
||||||
# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
|
|
||||||
# If this step fails, then you should remove it and run the build manually (see below)
|
|
||||||
- name: Autobuild
|
|
||||||
uses: github/codeql-action/autobuild@v3
|
|
||||||
|
|
||||||
# ℹ️ Command-line programs to run using the OS shell.
|
|
||||||
# 📚 https://git.io/JvXDl
|
|
||||||
|
|
||||||
# ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
|
|
||||||
# and modify them (or add more) to build your code if your project
|
|
||||||
# uses a compiled language
|
|
||||||
|
|
||||||
#- run: |
|
|
||||||
# make bootstrap
|
|
||||||
# make release
|
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
|
||||||
uses: github/codeql-action/analyze@v3
|
|
||||||
|
|
@ -1,119 +0,0 @@
|
||||||
name: Create Release
|
|
||||||
run-name: Create release ${{ inputs.version }}
|
|
||||||
|
|
||||||
on:
|
|
||||||
workflow_dispatch:
|
|
||||||
inputs:
|
|
||||||
version:
|
|
||||||
description: 'Version for new release'
|
|
||||||
required: true
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
release:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
with:
|
|
||||||
ref: master
|
|
||||||
fetch-depth: 0
|
|
||||||
fetch-tags: true
|
|
||||||
|
|
||||||
- name: Validate version
|
|
||||||
id: validate
|
|
||||||
run: |
|
|
||||||
function ver { printf "%03d%03d%03d%03d" $(echo "$1" | tr '.' ' '); }
|
|
||||||
|
|
||||||
NEW_VERSION=${{ inputs.version }}
|
|
||||||
NEW_VERSION=${NEW_VERSION#v} # Remove v prefix
|
|
||||||
|
|
||||||
LATEST_VERSION=$(git describe --abbrev=0 --tags)
|
|
||||||
LATEST_VERSION=${LATEST_VERSION#v} # Remove v prefix
|
|
||||||
|
|
||||||
# check that new version can be parsed
|
|
||||||
if [ ! $(ver $NEW_VERSION ) -gt $(ver 0) ]; then
|
|
||||||
echo "::error::Entered version '${{ inputs.version }}' cannot be parsed"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
# check version continuity
|
|
||||||
if [ ! $(ver $LATEST_VERSION) -lt $(ver $NEW_VERSION) ]; then
|
|
||||||
echo "::error::Entered version '${{ inputs.version }}' is smaller then latest version $LATEST_VERSION"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "version=${NEW_VERSION}" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
- name: Prepare Github Actions Bot
|
|
||||||
run: |
|
|
||||||
git config --local user.name "github-actions[bot]"
|
|
||||||
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
||||||
|
|
||||||
- name: Setup node
|
|
||||||
uses: actions/setup-node@v6
|
|
||||||
with:
|
|
||||||
node-version-file: docs/package.json
|
|
||||||
|
|
||||||
- name: Update documentation
|
|
||||||
run: |
|
|
||||||
cd docs
|
|
||||||
|
|
||||||
FULL_VERSION=${{ steps.validate.outputs.version }}
|
|
||||||
VERSION=${FULL_VERSION%.*}.x
|
|
||||||
|
|
||||||
if [ ! -d "versioned_docs/version-${VERSION}" ]; then
|
|
||||||
npm install
|
|
||||||
npm run docusaurus docs:version ${VERSION}
|
|
||||||
|
|
||||||
git add .
|
|
||||||
git commit -m "add new docs version ${VERSION}"
|
|
||||||
fi
|
|
||||||
|
|
||||||
sed -i "s/(current release is .*)/(current release is \`v${FULL_VERSION}\`)/g" docs/installation.md
|
|
||||||
sed -i "s/(current release is .*)/(current release is \`v${FULL_VERSION}\`)/g" versioned_docs/version-${VERSION}/installation.md
|
|
||||||
|
|
||||||
- name: Update Changelog
|
|
||||||
run: |
|
|
||||||
VERSION=${{ steps.validate.outputs.version }}
|
|
||||||
|
|
||||||
sed -i "s/#.*(Pre-release)/# V${VERSION}/g" CHANGELOG.md
|
|
||||||
|
|
||||||
cat << EOF > /tmp/CHANGELOG.prepend
|
|
||||||
# Vx.x.x (Pre-release)
|
|
||||||
|
|
||||||
## Release Highlights
|
|
||||||
|
|
||||||
## Important Notes
|
|
||||||
|
|
||||||
## Breaking Changes
|
|
||||||
|
|
||||||
## Changes since v${VERSION}
|
|
||||||
EOF
|
|
||||||
|
|
||||||
echo -e "$(cat /tmp/CHANGELOG.prepend)\n\n$(cat CHANGELOG.md)" > CHANGELOG.md
|
|
||||||
|
|
||||||
- name: Update development files
|
|
||||||
run: |
|
|
||||||
VERSION=${{ steps.validate.outputs.version }}
|
|
||||||
cd contrib
|
|
||||||
grep -rl "quay.io/oauth2-proxy/oauth2-proxy:" | \
|
|
||||||
xargs sed -i "s#quay.io/oauth2-proxy/oauth2-proxy:v[0-9]\+\.[0-9]\+\.[0-9]\+#quay.io/oauth2-proxy/oauth2-proxy:v${VERSION}#g"
|
|
||||||
|
|
||||||
- name: Commit and push
|
|
||||||
run: |
|
|
||||||
VERSION=${{ steps.validate.outputs.version }}
|
|
||||||
|
|
||||||
git checkout -b release/v${VERSION}
|
|
||||||
git commit -am "update to release version v${VERSION}"
|
|
||||||
git push -u origin release/v${VERSION}
|
|
||||||
|
|
||||||
- name: Create PR
|
|
||||||
env:
|
|
||||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
run: |
|
|
||||||
VERSION=v${{ steps.validate.outputs.version }}
|
|
||||||
gh pr create -B master -H release/${VERSION} --title "release ${VERSION}" --body "Release branch and changes created by GitHub Actions. This PR should include changes to the docs, CHANGELOG and local environment files."
|
|
||||||
|
|
@ -1,68 +0,0 @@
|
||||||
name: documentation
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches: [master]
|
|
||||||
paths: ['docs/**']
|
|
||||||
push:
|
|
||||||
branches: [master]
|
|
||||||
paths: ['docs/**']
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
pull-request-check:
|
|
||||||
if: github.event_name == 'pull_request'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v5
|
|
||||||
|
|
||||||
- name: Setup Pages
|
|
||||||
id: pages
|
|
||||||
uses: actions/configure-pages@v5
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v6
|
|
||||||
with:
|
|
||||||
# renovate: datasource=node-version depName=node
|
|
||||||
node-version: 22
|
|
||||||
|
|
||||||
- name: Test Build
|
|
||||||
working-directory: ./docs
|
|
||||||
run: |
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
build-docs:
|
|
||||||
if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v5
|
|
||||||
|
|
||||||
- uses: actions/setup-node@v6
|
|
||||||
with:
|
|
||||||
# renovate: datasource=node-version depName=node
|
|
||||||
node-version: 22
|
|
||||||
|
|
||||||
- name: Build docusaurus
|
|
||||||
working-directory: ./docs
|
|
||||||
run: |
|
|
||||||
npm install
|
|
||||||
npm run build
|
|
||||||
|
|
||||||
- name: Upload artifact
|
|
||||||
uses: actions/upload-pages-artifact@v3
|
|
||||||
with:
|
|
||||||
path: ./docs/build
|
|
||||||
|
|
||||||
deploy-docs:
|
|
||||||
needs: build-docs
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
pages: write # to deploy to Pages
|
|
||||||
id-token: write # to verify the deployment originates from an appropriate source
|
|
||||||
environment:
|
|
||||||
name: github-pages
|
|
||||||
url: ${{ steps.deployment.outputs.page_url }}
|
|
||||||
steps:
|
|
||||||
- name: Deploy to GitHub Pages
|
|
||||||
id: deployment
|
|
||||||
uses: actions/deploy-pages@v4
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
name: E2E
|
|
||||||
|
|
||||||
on:
|
|
||||||
issue_comment:
|
|
||||||
types: [created]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
e2e:
|
|
||||||
uses: oauth2-proxy/e2e-suite/.github/workflows/e2e.yml@main
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
statuses: write
|
|
||||||
issues: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
name: "Pull Request Labeler"
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
triage:
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
pull-requests: write
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/labeler@v6
|
|
||||||
with:
|
|
||||||
sync-labels: true
|
|
||||||
dot: true
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
name: Nightly builds
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule: # Run every day at 03:00 UTC
|
|
||||||
- cron: '0 3 * * *'
|
|
||||||
workflow_dispatch:
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
# only run this build in the main repository, not in forks
|
|
||||||
if: github.repository == 'oauth2-proxy/oauth2-proxy'
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
with:
|
|
||||||
ref: master
|
|
||||||
fetch-depth: 0
|
|
||||||
fetch-tags: true
|
|
||||||
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
id: buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to quay.io
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
registry: quay.io/oauth2-proxy
|
|
||||||
username: ${{ secrets.REGISTRY_USERNAME_NIGHTLY }}
|
|
||||||
password: ${{ secrets.REGISTRY_PASSWORD_NIGHTLY }}
|
|
||||||
|
|
||||||
- name: Build images
|
|
||||||
run: |
|
|
||||||
make nightly-build
|
|
||||||
|
|
||||||
- name: Push images
|
|
||||||
run: |
|
|
||||||
make nightly-push
|
|
||||||
|
|
@ -1,129 +0,0 @@
|
||||||
name: Publish Release
|
|
||||||
run-name: ${{ github.event.pull_request.head.ref }}
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request_target:
|
|
||||||
branches:
|
|
||||||
- master
|
|
||||||
types:
|
|
||||||
- closed
|
|
||||||
|
|
||||||
permissions:
|
|
||||||
contents: write
|
|
||||||
pull-requests: write
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
publish:
|
|
||||||
if: github.event.pull_request.merged && startsWith(github.event.pull_request.head.ref, 'release/')
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
outputs:
|
|
||||||
tag: ${{ steps.tag.outputs.version }}
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.pull_request.merge_commit_sha }}
|
|
||||||
fetch-depth: 0
|
|
||||||
fetch-tags: true
|
|
||||||
|
|
||||||
- name: Tag release
|
|
||||||
run: |
|
|
||||||
# Set up github-actions[bot] user
|
|
||||||
git config --local user.name "github-actions[bot]"
|
|
||||||
git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
|
|
||||||
|
|
||||||
# Get the version from the branch name
|
|
||||||
branch="${{ github.event.pull_request.head.ref }}"
|
|
||||||
version="${branch#release/}"
|
|
||||||
echo ${version}
|
|
||||||
|
|
||||||
# Tag and create release
|
|
||||||
git tag -a "${version}" -m "Release ${version}"
|
|
||||||
echo "version=${version}" >> $GITHUB_OUTPUT
|
|
||||||
id: tag
|
|
||||||
|
|
||||||
- name: Set up go
|
|
||||||
uses: actions/setup-go@v6
|
|
||||||
with:
|
|
||||||
go-version-file: go.mod
|
|
||||||
|
|
||||||
- name: Get dependencies
|
|
||||||
env:
|
|
||||||
# renovate: datasource=github-tags depName=golangci/golangci-lint
|
|
||||||
GOLANGCI_LINT_VERSION: v2.5.0
|
|
||||||
run: |
|
|
||||||
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
|
|
||||||
chmod +x ./cc-test-reporter
|
|
||||||
|
|
||||||
# Install go dependencies
|
|
||||||
go mod download
|
|
||||||
|
|
||||||
- name: Build Artifacts
|
|
||||||
run: make release
|
|
||||||
|
|
||||||
# Upload artifacts in case of workflow failure
|
|
||||||
- name: Upload Artifacts
|
|
||||||
uses: actions/upload-artifact@v5
|
|
||||||
with:
|
|
||||||
name: oauth2-proxy-artifacts
|
|
||||||
path: |
|
|
||||||
release/*.tar.gz
|
|
||||||
release/*.txt
|
|
||||||
|
|
||||||
- name: Create release
|
|
||||||
env:
|
|
||||||
GH_TOKEN: ${{ github.token }}
|
|
||||||
run: |
|
|
||||||
# Get version from tag
|
|
||||||
version=$(git describe --tags --abbrev=0)
|
|
||||||
|
|
||||||
# Extract CHANGELOG
|
|
||||||
numericVersion="${version#v}"
|
|
||||||
notes=$(sed -E "/^# (v|V)$numericVersion$/,/^# (v|V)/!d;//d" CHANGELOG.md)
|
|
||||||
|
|
||||||
# Publish release tag
|
|
||||||
git push origin "${version}"
|
|
||||||
|
|
||||||
# Create github release
|
|
||||||
gh release create "${version}" \
|
|
||||||
--title "${version}" \
|
|
||||||
--notes "${notes}" \
|
|
||||||
--prerelease
|
|
||||||
|
|
||||||
# Upload artifacts
|
|
||||||
gh release upload "${version}" release/*.tar.gz
|
|
||||||
gh release upload "${version}" release/*.txt
|
|
||||||
|
|
||||||
docker:
|
|
||||||
needs: publish
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- name: Check out code
|
|
||||||
uses: actions/checkout@v5
|
|
||||||
with:
|
|
||||||
ref: ${{ needs.publish.outputs.tag }}
|
|
||||||
fetch-depth: 0
|
|
||||||
fetch-tags: true
|
|
||||||
|
|
||||||
- name: Set up QEMU
|
|
||||||
uses: docker/setup-qemu-action@v3
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
id: buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to quay.io
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
registry: quay.io/oauth2-proxy
|
|
||||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
|
||||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
|
||||||
|
|
||||||
- name: Build images
|
|
||||||
run: |
|
|
||||||
make build-docker-all
|
|
||||||
|
|
||||||
- name: Push images
|
|
||||||
run: |
|
|
||||||
make push-docker-all
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
name: Mark stale issues and pull requests
|
|
||||||
|
|
||||||
on:
|
|
||||||
schedule:
|
|
||||||
- cron: "0 0 * * *"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
stale:
|
|
||||||
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/stale@v10
|
|
||||||
with:
|
|
||||||
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
days-before-stale: 180
|
|
||||||
days-before-close: 14
|
|
||||||
stale-issue-message: 'This issue has been inactive for 180 days. If the issue is still relevant please comment to re-activate the issue. If no action is taken within 14 days, the issue will be marked closed.'
|
|
||||||
stale-pr-message: 'This pull request has been inactive for 180 days. If the pull request is still relevant please comment to re-activate the pull request. If no action is taken within 14 days, the pull request will be marked closed.'
|
|
||||||
exempt-issue-labels: bug,high-priority
|
|
||||||
exempt-pr-labels: bug,high-priority
|
|
||||||
|
|
@ -1,26 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
# manually exiting from script, because after-build needs to run always
|
|
||||||
set +e
|
|
||||||
|
|
||||||
if [ -z $CC_TEST_REPORTER_ID ]; then
|
|
||||||
echo "1. CC_TEST_REPORTER_ID is unset, skipping"
|
|
||||||
else
|
|
||||||
echo "1. Running before-build"
|
|
||||||
./cc-test-reporter before-build
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "2. Running test"
|
|
||||||
make test
|
|
||||||
TEST_STATUS=$?
|
|
||||||
|
|
||||||
if [ -z $CC_TEST_REPORTER_ID ]; then
|
|
||||||
echo "3. CC_TEST_REPORTER_ID is unset, skipping"
|
|
||||||
else
|
|
||||||
echo "3. Running after-build"
|
|
||||||
./cc-test-reporter after-build --exit-code $TEST_STATUS --prefix $(go list -m)
|
|
||||||
fi
|
|
||||||
|
|
||||||
if [ "$TEST_STATUS" -ne 0 ]; then
|
|
||||||
echo "Test failed, status code: $TEST_STATUS"
|
|
||||||
exit $TEST_STATUS
|
|
||||||
fi
|
|
||||||
|
|
@ -1,13 +1,4 @@
|
||||||
oauth2-proxy
|
google_auth_proxy
|
||||||
vendor
|
|
||||||
dist
|
|
||||||
release
|
|
||||||
.godeps
|
|
||||||
*.exe
|
|
||||||
.env
|
|
||||||
.bundle
|
|
||||||
c.out
|
|
||||||
|
|
||||||
# Go.gitignore
|
# Go.gitignore
|
||||||
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
||||||
*.o
|
*.o
|
||||||
|
|
@ -17,10 +8,6 @@ c.out
|
||||||
# Folders
|
# Folders
|
||||||
_obj
|
_obj
|
||||||
_test
|
_test
|
||||||
.DS_Store
|
|
||||||
.idea/
|
|
||||||
.vscode/*
|
|
||||||
!/.vscode/tasks.json
|
|
||||||
|
|
||||||
# Architecture specific extensions/prefixes
|
# Architecture specific extensions/prefixes
|
||||||
*.[568vq]
|
*.[568vq]
|
||||||
|
|
@ -34,12 +21,6 @@ _cgo_export.*
|
||||||
|
|
||||||
_testmain.go
|
_testmain.go
|
||||||
|
|
||||||
# Editor swap/temp files
|
*.exe
|
||||||
.*.swp
|
dist
|
||||||
|
.godeps
|
||||||
# Dockerfile.dev is ignored by both git and docker
|
|
||||||
# for faster development cycle of docker build
|
|
||||||
# cp Dockerfile Dockerfile.dev
|
|
||||||
# vi Dockerfile.dev
|
|
||||||
# docker build -f Dockerfile.dev .
|
|
||||||
Dockerfile.dev
|
|
||||||
|
|
|
||||||
|
|
@ -1,69 +0,0 @@
|
||||||
version: "2"
|
|
||||||
linters:
|
|
||||||
default: none
|
|
||||||
enable:
|
|
||||||
- bodyclose
|
|
||||||
- copyloopvar
|
|
||||||
- dogsled
|
|
||||||
- goconst
|
|
||||||
- gocritic
|
|
||||||
- goprintffuncname
|
|
||||||
- gosec
|
|
||||||
- govet
|
|
||||||
- ineffassign
|
|
||||||
- misspell
|
|
||||||
- prealloc
|
|
||||||
- revive
|
|
||||||
- staticcheck
|
|
||||||
- unconvert
|
|
||||||
- unused
|
|
||||||
exclusions:
|
|
||||||
generated: lax
|
|
||||||
presets:
|
|
||||||
- comments
|
|
||||||
- common-false-positives
|
|
||||||
- legacy
|
|
||||||
- std-error-handling
|
|
||||||
rules:
|
|
||||||
- linters:
|
|
||||||
- bodyclose
|
|
||||||
- goconst
|
|
||||||
- gocritic
|
|
||||||
- gosec
|
|
||||||
- revive
|
|
||||||
- scopelint
|
|
||||||
- unconvert
|
|
||||||
path: _test\.go
|
|
||||||
- linters:
|
|
||||||
- revive
|
|
||||||
path: _test\.go
|
|
||||||
text: 'dot-imports:'
|
|
||||||
# # If we have tests in shared test folders, these can be less strictly linted
|
|
||||||
- linters:
|
|
||||||
- bodyclose
|
|
||||||
- revive
|
|
||||||
- staticcheck
|
|
||||||
path: tests/.*_tests\.go
|
|
||||||
# See https://github.com/oauth2-proxy/oauth2-proxy/issues/3060
|
|
||||||
# https://staticcheck.dev/docs/checks/#QF1008
|
|
||||||
- linters:
|
|
||||||
- staticcheck
|
|
||||||
text: QF1008
|
|
||||||
- linters:
|
|
||||||
- revive
|
|
||||||
path: util/.*\.go$
|
|
||||||
text: "var-naming: avoid meaningless package names"
|
|
||||||
paths:
|
|
||||||
- third_party$
|
|
||||||
- builtin$
|
|
||||||
- examples$
|
|
||||||
formatters:
|
|
||||||
enable:
|
|
||||||
- gofmt
|
|
||||||
- goimports
|
|
||||||
exclusions:
|
|
||||||
generated: lax
|
|
||||||
paths:
|
|
||||||
- third_party$
|
|
||||||
- builtin$
|
|
||||||
- examples$
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
repos:
|
|
||||||
- repo: https://github.com/pre-commit/pre-commit-hooks
|
|
||||||
rev: v4.3.0
|
|
||||||
hooks:
|
|
||||||
- id: trailing-whitespace
|
|
||||||
- id: end-of-file-fixer
|
|
||||||
- id: check-yaml
|
|
||||||
- id: check-added-large-files
|
|
||||||
- repo: https://github.com/dnephin/pre-commit-golang
|
|
||||||
rev: v0.5.0
|
|
||||||
hooks:
|
|
||||||
- id: golangci-lint
|
|
||||||
- id: go-build
|
|
||||||
|
|
@ -0,0 +1,12 @@
|
||||||
|
language: go
|
||||||
|
go:
|
||||||
|
- 1.3.3
|
||||||
|
- 1.4.2
|
||||||
|
script:
|
||||||
|
- curl -s https://raw.githubusercontent.com/pote/gpm/v1.3.1/bin/gpm > gpm
|
||||||
|
- chmod +x gpm
|
||||||
|
- ./gpm install
|
||||||
|
- ./test.sh
|
||||||
|
notifications:
|
||||||
|
email: false
|
||||||
|
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "OAuth2 Proxy for Dex",
|
|
||||||
"type": "go",
|
|
||||||
"request": "launch",
|
|
||||||
"mode": "auto",
|
|
||||||
"program": "${workspaceFolder}",
|
|
||||||
"args": [
|
|
||||||
"--config", "contrib/local-environment/oauth2-proxy.cfg"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "OAuth2 Proxy for Keycloak",
|
|
||||||
"type": "go",
|
|
||||||
"request": "launch",
|
|
||||||
"mode": "auto",
|
|
||||||
"program": "${workspaceFolder}",
|
|
||||||
"args": [
|
|
||||||
"--config", "contrib/local-environment/oauth2-proxy-keycloak.cfg"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "OAuth2 Proxy with Alpha Config",
|
|
||||||
"type": "go",
|
|
||||||
"request": "launch",
|
|
||||||
"mode": "auto",
|
|
||||||
"program": "${workspaceFolder}",
|
|
||||||
"args": [
|
|
||||||
"--config", "contrib/local-environment/oauth2-proxy-alpha-config.cfg",
|
|
||||||
"--alpha-config", "contrib/local-environment/oauth2-proxy-alpha-config.yaml"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
@ -1,76 +0,0 @@
|
||||||
{
|
|
||||||
"version": "2.0.0",
|
|
||||||
"tasks": [
|
|
||||||
{
|
|
||||||
"label": "Run oauth2-proxy",
|
|
||||||
"type": "shell",
|
|
||||||
"command": "./oauth2-proxy --config contrib/local-environment/oauth2-proxy.cfg --alpha-config contrib/local-environment/oauth2-proxy-alpha0config.cfg",
|
|
||||||
"dependsOn": ["Build"],
|
|
||||||
"group": {
|
|
||||||
"kind": "test",
|
|
||||||
"isDefault": true
|
|
||||||
},
|
|
||||||
"presentation": {
|
|
||||||
"reveal": "always",
|
|
||||||
"panel": "new"
|
|
||||||
},
|
|
||||||
"problemMatcher": []
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"label": "Test",
|
|
||||||
"type": "shell",
|
|
||||||
"command": "make test",
|
|
||||||
"group": {
|
|
||||||
"kind": "test",
|
|
||||||
"isDefault": true
|
|
||||||
},
|
|
||||||
"presentation": {
|
|
||||||
"reveal": "always",
|
|
||||||
"panel": "new"
|
|
||||||
},
|
|
||||||
"problemMatcher": []
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"label": "Ruff",
|
|
||||||
"type": "shell",
|
|
||||||
"command": "pre-commit run ruff --all-files",
|
|
||||||
"group": {
|
|
||||||
"kind": "test",
|
|
||||||
"isDefault": true
|
|
||||||
},
|
|
||||||
"presentation": {
|
|
||||||
"reveal": "always",
|
|
||||||
"panel": "new"
|
|
||||||
},
|
|
||||||
"problemMatcher": []
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"label": "golint",
|
|
||||||
"type": "shell",
|
|
||||||
"command": "make lint",
|
|
||||||
"group": {
|
|
||||||
"kind": "test",
|
|
||||||
"isDefault": true
|
|
||||||
},
|
|
||||||
"presentation": {
|
|
||||||
"reveal": "always",
|
|
||||||
"panel": "new"
|
|
||||||
},
|
|
||||||
"problemMatcher": []
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"label": "Build",
|
|
||||||
"type": "shell",
|
|
||||||
"command": "make build",
|
|
||||||
"group": {
|
|
||||||
"kind": "test",
|
|
||||||
"isDefault": true
|
|
||||||
},
|
|
||||||
"presentation": {
|
|
||||||
"reveal": "always",
|
|
||||||
"panel": "new"
|
|
||||||
},
|
|
||||||
"problemMatcher": []
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
28
ADOPTERS.md
28
ADOPTERS.md
|
|
@ -1,28 +0,0 @@
|
||||||
# Adopters
|
|
||||||
|
|
||||||
This list showcases organizations that leverage OAuth2-Proxy within their
|
|
||||||
infrastructure. If your organization uses OAuth2-Proxy and isn't yet listed, we
|
|
||||||
encourage you to add it!
|
|
||||||
|
|
||||||
This list aims to be a comprehensive and trusted resource for the OAuth2-Proxy
|
|
||||||
community, demonstrating successful adoption across all kinds of industries.
|
|
||||||
|
|
||||||
Contributing to this list is a simple way to impact the project's growth,
|
|
||||||
maturity, and momentum. Thank you to all adopters and contributors of the
|
|
||||||
OAuth2-Proxy project!
|
|
||||||
|
|
||||||
## Updating this list
|
|
||||||
|
|
||||||
To add your organization to this list, you can just [open a PR](https://github.com/oauth2-proxy/oauth2-proxy/pulls)
|
|
||||||
to directly update this list.
|
|
||||||
|
|
||||||
Add your organization name, your github username and if you desire a short
|
|
||||||
description on how you utilize oauth2-proxy.
|
|
||||||
|
|
||||||
## OAuth2-Proxy Adopters
|
|
||||||
|
|
||||||
This list is sorted in the order that organizations were added to it.
|
|
||||||
|
|
||||||
| Organization | Contact | Description of Use |
|
|
||||||
| ------------ | ------- | ------------------ |
|
|
||||||
| | | |
|
|
||||||
1364
CHANGELOG.md
1364
CHANGELOG.md
File diff suppressed because it is too large
Load Diff
|
|
@ -1,134 +0,0 @@
|
||||||
# Contributor Covenant Code of Conduct
|
|
||||||
|
|
||||||
## Our Pledge
|
|
||||||
|
|
||||||
We as members, contributors, and leaders pledge to make participation in our
|
|
||||||
community a harassment-free experience for everyone, regardless of age, body
|
|
||||||
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
||||||
identity and expression, level of experience, education, socio-economic status,
|
|
||||||
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
||||||
identity and orientation.
|
|
||||||
|
|
||||||
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
||||||
diverse, inclusive, and healthy community.
|
|
||||||
|
|
||||||
## Our Standards
|
|
||||||
|
|
||||||
Examples of behavior that contributes to a positive environment for our
|
|
||||||
community include:
|
|
||||||
|
|
||||||
* Demonstrating empathy and kindness toward other people
|
|
||||||
* Being respectful of differing opinions, viewpoints, and experiences
|
|
||||||
* Giving and gracefully accepting constructive feedback
|
|
||||||
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
||||||
and learning from the experience
|
|
||||||
* Focusing on what is best not just for us as individuals, but for the overall
|
|
||||||
community
|
|
||||||
|
|
||||||
Examples of unacceptable behavior include:
|
|
||||||
|
|
||||||
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
||||||
any kind
|
|
||||||
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
||||||
* Public or private harassment
|
|
||||||
* Publishing others' private information, such as a physical or email address,
|
|
||||||
without their explicit permission
|
|
||||||
* Other conduct which could reasonably be considered inappropriate in a
|
|
||||||
professional setting
|
|
||||||
|
|
||||||
## Enforcement Responsibilities
|
|
||||||
|
|
||||||
Community leaders are responsible for clarifying and enforcing our standards of
|
|
||||||
acceptable behavior and will take appropriate and fair corrective action in
|
|
||||||
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
||||||
or harmful.
|
|
||||||
|
|
||||||
Community leaders have the right and responsibility to remove, edit, or reject
|
|
||||||
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
||||||
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
||||||
decisions when appropriate.
|
|
||||||
|
|
||||||
## Scope
|
|
||||||
|
|
||||||
This Code of Conduct applies within all community spaces, and also applies when
|
|
||||||
an individual is officially representing the community in public spaces.
|
|
||||||
Examples of representing our community include using an official email address,
|
|
||||||
posting via an official social media account, or acting as an appointed
|
|
||||||
representative at an online or offline event.
|
|
||||||
|
|
||||||
## Enforcement
|
|
||||||
|
|
||||||
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
||||||
reported to the community leaders responsible for enforcement at
|
|
||||||
https://gophers.slack.com/messages/CM2RSS25N or directly contacting one of the
|
|
||||||
maintainers from the MAINTAINERS file.
|
|
||||||
All complaints will be reviewed and investigated promptly and fairly.
|
|
||||||
|
|
||||||
All community leaders are obligated to respect the privacy and security of the
|
|
||||||
reporter of any incident.
|
|
||||||
|
|
||||||
## Enforcement Guidelines
|
|
||||||
|
|
||||||
Community leaders will follow these Community Impact Guidelines in determining
|
|
||||||
the consequences for any action they deem in violation of this Code of Conduct:
|
|
||||||
|
|
||||||
### 1. Correction
|
|
||||||
|
|
||||||
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
||||||
unprofessional or unwelcome in the community.
|
|
||||||
|
|
||||||
**Consequence**: A private, written warning from community leaders, providing
|
|
||||||
clarity around the nature of the violation and an explanation of why the
|
|
||||||
behavior was inappropriate. A public apology may be requested.
|
|
||||||
|
|
||||||
### 2. Warning
|
|
||||||
|
|
||||||
**Community Impact**: A violation through a single incident or series of
|
|
||||||
actions.
|
|
||||||
|
|
||||||
**Consequence**: A warning with consequences for continued behavior. No
|
|
||||||
interaction with the people involved, including unsolicited interaction with
|
|
||||||
those enforcing the Code of Conduct, for a specified period of time. This
|
|
||||||
includes avoiding interactions in community spaces as well as external channels
|
|
||||||
like social media. Violating these terms may lead to a temporary or permanent
|
|
||||||
ban.
|
|
||||||
|
|
||||||
### 3. Temporary Ban
|
|
||||||
|
|
||||||
**Community Impact**: A serious violation of community standards, including
|
|
||||||
sustained inappropriate behavior.
|
|
||||||
|
|
||||||
**Consequence**: A temporary ban from any sort of interaction or public
|
|
||||||
communication with the community for a specified period of time. No public or
|
|
||||||
private interaction with the people involved, including unsolicited interaction
|
|
||||||
with those enforcing the Code of Conduct, is allowed during this period.
|
|
||||||
Violating these terms may lead to a permanent ban.
|
|
||||||
|
|
||||||
### 4. Permanent Ban
|
|
||||||
|
|
||||||
**Community Impact**: Demonstrating a pattern of violation of community
|
|
||||||
standards, including sustained inappropriate behavior, harassment of an
|
|
||||||
individual, or aggression toward or disparagement of classes of individuals.
|
|
||||||
|
|
||||||
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
||||||
community.
|
|
||||||
|
|
||||||
## Attribution
|
|
||||||
|
|
||||||
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
||||||
version 2.1, available at
|
|
||||||
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
||||||
|
|
||||||
Community Impact Guidelines were inspired by
|
|
||||||
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
||||||
|
|
||||||
For answers to common questions about this code of conduct, see the FAQ at
|
|
||||||
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
||||||
[https://www.contributor-covenant.org/translations][translations].
|
|
||||||
|
|
||||||
[homepage]: https://www.contributor-covenant.org
|
|
||||||
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
||||||
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
||||||
[FAQ]: https://www.contributor-covenant.org/faq
|
|
||||||
[translations]: https://www.contributor-covenant.org/translations
|
|
||||||
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
# Contributing
|
|
||||||
|
|
||||||
To develop on this project, please fork the repo and clone into your `$GOPATH`.
|
|
||||||
|
|
||||||
Dependencies are **not** checked in so please download those separately.
|
|
||||||
Download the dependencies using `go mod download`.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
cd $GOPATH/src/github.com # Create this directory if it doesn't exist
|
|
||||||
git clone git@github.com:<YOUR_FORK>/oauth2-proxy oauth2-proxy/oauth2-proxy
|
|
||||||
cd oauth2-proxy/oauth2-proxy
|
|
||||||
go mod download
|
|
||||||
```
|
|
||||||
|
|
||||||
## Pull Requests and Issues
|
|
||||||
|
|
||||||
We track bugs and issues using Github.
|
|
||||||
|
|
||||||
If you find a bug, please open an Issue.
|
|
||||||
|
|
||||||
If you want to fix a bug, please fork, create a feature branch, fix the bug and
|
|
||||||
open a PR back to this repo.
|
|
||||||
Please mention the open bug issue number within your PR if applicable.
|
|
||||||
74
Dockerfile
74
Dockerfile
|
|
@ -1,74 +0,0 @@
|
||||||
# The image ARGs have to be at the top, otherwise the docker daemon cannot validate
|
|
||||||
# the FROM statements and overall Dockerfile
|
|
||||||
#
|
|
||||||
# Argument for setting the build image
|
|
||||||
ARG BUILD_IMAGE=placeholder
|
|
||||||
# Argument for setting the runtime image
|
|
||||||
ARG RUNTIME_IMAGE=placeholder
|
|
||||||
# Argument for setting the oauth2-proxy build version
|
|
||||||
ARG VERSION
|
|
||||||
|
|
||||||
# All builds should be done using the platform native to the build node to allow
|
|
||||||
# cache sharing of the go mod download step.
|
|
||||||
# Go cross compilation is also faster than emulation the go compilation across
|
|
||||||
# multiple platforms.
|
|
||||||
FROM --platform=${BUILDPLATFORM} ${BUILD_IMAGE} AS builder
|
|
||||||
|
|
||||||
# Copy sources
|
|
||||||
WORKDIR $GOPATH/src/github.com/oauth2-proxy/oauth2-proxy
|
|
||||||
|
|
||||||
# Fetch dependencies
|
|
||||||
COPY go.mod go.sum ./
|
|
||||||
RUN go mod download
|
|
||||||
|
|
||||||
# Now pull in our code
|
|
||||||
COPY . .
|
|
||||||
|
|
||||||
# Arguments go here so that the previous steps can be cached if no external sources
|
|
||||||
# have changed. These arguments are automatically set by the docker engine.
|
|
||||||
ARG TARGETPLATFORM
|
|
||||||
ARG BUILDPLATFORM
|
|
||||||
|
|
||||||
# Reload version argument
|
|
||||||
ARG VERSION
|
|
||||||
|
|
||||||
# Build binary and make sure there is at least an empty key file.
|
|
||||||
# This is useful for GCP App Engine custom runtime builds, because
|
|
||||||
# you cannot use multiline variables in their app.yaml, so you have to
|
|
||||||
# build the key into the container and then tell it where it is
|
|
||||||
# by setting OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem
|
|
||||||
# in app.yaml instead.
|
|
||||||
# Set the cross compilation arguments based on the TARGETPLATFORM which is
|
|
||||||
# automatically set by the docker engine.
|
|
||||||
RUN case ${TARGETPLATFORM} in \
|
|
||||||
"linux/amd64") GOARCH=amd64 ;; \
|
|
||||||
# arm64 and arm64v8 are equivalent in go and do not require a goarm
|
|
||||||
# https://github.com/golang/go/wiki/GoArm
|
|
||||||
"linux/arm64" | "linux/arm/v8") GOARCH=arm64 ;; \
|
|
||||||
"linux/ppc64le") GOARCH=ppc64le ;; \
|
|
||||||
"linux/s390x") GOARCH=s390x ;; \
|
|
||||||
"linux/arm/v6") GOARCH=arm GOARM=6 ;; \
|
|
||||||
"linux/arm/v7") GOARCH=arm GOARM=7 ;; \
|
|
||||||
esac && \
|
|
||||||
printf "Building OAuth2 Proxy for arch ${GOARCH}\n" && \
|
|
||||||
GOARCH=${GOARCH} VERSION=${VERSION} make build && touch jwt_signing_key.pem
|
|
||||||
|
|
||||||
# Reload runtime image
|
|
||||||
ARG RUNTIME_IMAGE
|
|
||||||
# Copy binary to runtime image
|
|
||||||
FROM ${RUNTIME_IMAGE}
|
|
||||||
# Reload version
|
|
||||||
ARG VERSION
|
|
||||||
|
|
||||||
COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/oauth2-proxy /bin/oauth2-proxy
|
|
||||||
COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/jwt_signing_key.pem /etc/ssl/private/jwt_signing_key.pem
|
|
||||||
|
|
||||||
LABEL org.opencontainers.image.licenses=MIT \
|
|
||||||
org.opencontainers.image.description="A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers." \
|
|
||||||
org.opencontainers.image.documentation=https://oauth2-proxy.github.io/oauth2-proxy/ \
|
|
||||||
org.opencontainers.image.source=https://github.com/oauth2-proxy/oauth2-proxy \
|
|
||||||
org.opencontainers.image.url=https://quay.io/oauth2-proxy/oauth2-proxy \
|
|
||||||
org.opencontainers.image.title=oauth2-proxy \
|
|
||||||
org.opencontainers.image.version=${VERSION}
|
|
||||||
|
|
||||||
ENTRYPOINT ["/bin/oauth2-proxy"]
|
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
github.com/BurntSushi/toml 3883ac1ce943878302255f538fce319d23226223
|
||||||
|
github.com/bitly/go-simplejson 3378bdcb5cebedcbf8b5750edee28010f128fe24
|
||||||
|
github.com/mreiferson/go-options ee94b57f2fbf116075426f853e5abbcdfeca8b3d
|
||||||
|
github.com/bmizerany/assert e17e99893cb6509f428e1728281c2ad60a6b31e3
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
Joel Speed <joel@oauth2-proxy.dev> (@JoelSpeed)
|
|
||||||
Nick Meves <nick@oauth2-proxy.dev> (@NickMeves)
|
|
||||||
Braunson <braunson@oauth2-proxy.dev> (@braunsonm)
|
|
||||||
Jan Larwig <jan@oauth2-proxy.dev> (@tuunit)
|
|
||||||
Koen van Zuijlen <koen@oauth2-proxy.dev> (@kvanzuijlen)
|
|
||||||
170
Makefile
170
Makefile
|
|
@ -1,170 +0,0 @@
|
||||||
#!/usr/bin/env bash
|
|
||||||
|
|
||||||
#
|
|
||||||
# Makefile with some common workflow for dev, build and test
|
|
||||||
#
|
|
||||||
|
|
||||||
##@ General
|
|
||||||
|
|
||||||
# The help target prints out all targets with their descriptions organized
|
|
||||||
# beneath their categories. The categories are represented by '##@' and the
|
|
||||||
# target descriptions by '##'. The awk command is responsible for reading the
|
|
||||||
# entire set of makefiles included in this invocation, looking for lines of the
|
|
||||||
# file as xyz: ## something, and then pretty-format the target and help. Then,
|
|
||||||
# if there's a line with ##@ something, that gets pretty-printed as a category.
|
|
||||||
# More info on the usage of ANSI control characters for terminal formatting:
|
|
||||||
# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
|
|
||||||
# More info on the awk command:
|
|
||||||
# http://linuxcommand.org/lc3_adv_awk.php
|
|
||||||
|
|
||||||
# The following help command is Licensed under the Apache License, Version 2.0 (the "License")
|
|
||||||
# Copyright 2023 The Kubernetes Authors.
|
|
||||||
.PHONY: help
|
|
||||||
help: ## Display this help
|
|
||||||
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
|
|
||||||
|
|
||||||
|
|
||||||
GO ?= go
|
|
||||||
GOLANGCILINT ?= golangci-lint
|
|
||||||
|
|
||||||
BINARY := oauth2-proxy
|
|
||||||
VERSION ?= $(shell git describe --always --dirty --tags 2>/dev/null || echo "undefined")
|
|
||||||
# Allow to override image registry.
|
|
||||||
REGISTRY ?= quay.io/oauth2-proxy
|
|
||||||
REPOSITORY ?= oauth2-proxy
|
|
||||||
|
|
||||||
DATE := $(shell date +"%Y%m%d")
|
|
||||||
.NOTPARALLEL:
|
|
||||||
|
|
||||||
# The go version in go.mod used for the Docker build toolchain, without the patch
|
|
||||||
GO_MOD_VERSION_MINOR := $(shell $(GO) list -f '{{printf "%.4s" .Module.GoVersion}}' )
|
|
||||||
|
|
||||||
# From go1.21 go will transparently download the toolchain declared in go.mod. https://go.dev/doc/toolchain
|
|
||||||
# We don't need to keep this message updated: the important info is in go.mod.
|
|
||||||
GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least go1.21
|
|
||||||
|
|
||||||
ifeq ($(COVER),true)
|
|
||||||
TESTCOVER ?= -coverprofile c.out
|
|
||||||
endif
|
|
||||||
|
|
||||||
##@ Build
|
|
||||||
|
|
||||||
.PHONY: build
|
|
||||||
build: validate-go-version clean $(BINARY) ## Build and create oauth2-proxy binary from current source code
|
|
||||||
|
|
||||||
$(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
|
|
||||||
|
|
||||||
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_RUNTIME_IMAGE ?= gcr.io/distroless/static:nonroot
|
|
||||||
DOCKER_BUILDX_ARGS ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE} ${DOCKER_BUILDX_COMMON_ARGS}
|
|
||||||
DOCKER_BUILDX := docker buildx build ${DOCKER_BUILDX_ARGS} --pull
|
|
||||||
DOCKER_BUILDX_X_PLATFORM := $(DOCKER_BUILDX) --platform ${DOCKER_BUILD_PLATFORM}
|
|
||||||
DOCKER_BUILDX_PUSH := $(DOCKER_BUILDX) --push
|
|
||||||
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_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_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
|
|
||||||
|
|
||||||
.PHONY: build-docker
|
|
||||||
build-docker: build-distroless build-alpine ## Build multi architecture docker images in both flavours (distroless / alpine)
|
|
||||||
|
|
||||||
.PHONY: build-distroless
|
|
||||||
build-distroless: ## Build multi architecture distroless based docker image
|
|
||||||
$(DOCKER_BUILDX_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .
|
|
||||||
|
|
||||||
.PHONY: build-alpine
|
|
||||||
build-alpine: ## Build multi architecture alpine based docker image
|
|
||||||
$(DOCKER_BUILDX_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .
|
|
||||||
|
|
||||||
.PHONY: build-docker-all
|
|
||||||
build-docker-all: build-docker ## Build docker images for all supported architectures in both flavours (distroless / alpine)
|
|
||||||
$(DOCKER_BUILDX) --platform linux/amd64 -t $(REGISTRY)/$(REPOSITORY):latest-amd64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-amd64 .
|
|
||||||
$(DOCKER_BUILDX) --platform linux/arm64 -t $(REGISTRY)/$(REPOSITORY):latest-arm64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-arm64 .
|
|
||||||
$(DOCKER_BUILDX) --platform linux/ppc64le -t $(REGISTRY)/$(REPOSITORY):latest-ppc64le -t $(REGISTRY)/$(REPOSITORY):${VERSION}-ppc64le .
|
|
||||||
$(DOCKER_BUILDX) --platform linux/arm/v7 -t $(REGISTRY)/$(REPOSITORY):latest-armv7 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv7 .
|
|
||||||
$(DOCKER_BUILDX) --platform linux/s390x -t $(REGISTRY)/$(REPOSITORY):latest-s390x -t $(REGISTRY)/$(REPOSITORY):${VERSION}-s390x .
|
|
||||||
|
|
||||||
|
|
||||||
##@ Publish
|
|
||||||
|
|
||||||
.PHONY: push-docker
|
|
||||||
push-docker: push-distroless push-alpine ## Push multi architecture docker images for both flavours (distroless / alpine)
|
|
||||||
|
|
||||||
.PHONY: push-distroless
|
|
||||||
push-distroless: ## Push multi architecture distroless based docker image
|
|
||||||
$(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .
|
|
||||||
|
|
||||||
.PHONY: push-alpine
|
|
||||||
push-alpine: ## Push multi architecture alpine based docker image
|
|
||||||
$(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .
|
|
||||||
|
|
||||||
.PHONY: push-docker-all
|
|
||||||
push-docker-all: push-docker ## Push docker images for all supported architectures for both flavours (distroless / alpine)
|
|
||||||
$(DOCKER_BUILDX_PUSH) --platform linux/amd64 -t $(REGISTRY)/$(REPOSITORY):latest-amd64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-amd64 .
|
|
||||||
$(DOCKER_BUILDX_PUSH) --platform linux/arm64 -t $(REGISTRY)/$(REPOSITORY):latest-arm64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-arm64 .
|
|
||||||
$(DOCKER_BUILDX_PUSH) --platform linux/ppc64le -t $(REGISTRY)/$(REPOSITORY):latest-ppc64le -t $(REGISTRY)/$(REPOSITORY):${VERSION}-ppc64le .
|
|
||||||
$(DOCKER_BUILDX_PUSH) --platform linux/arm/v7 -t $(REGISTRY)/$(REPOSITORY):latest-armv7 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv7 .
|
|
||||||
$(DOCKER_BUILDX_PUSH) --platform linux/s390x -t $(REGISTRY)/$(REPOSITORY):latest-s390x -t $(REGISTRY)/$(REPOSITORY):${VERSION}-s390x .
|
|
||||||
|
|
||||||
|
|
||||||
##@ Nightly scheduling
|
|
||||||
|
|
||||||
.PHONY: nightly-build
|
|
||||||
nightly-build: ## Nightly build command for docker images in both flavours (distroless / alpine)
|
|
||||||
$(DOCKER_BUILDX_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY)-nightly:latest -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE} .
|
|
||||||
$(DOCKER_BUILDX_X_PLATFORM_ALPINE) -t ${REGISTRY}/$(REPOSITORY)-nightly:latest-alpine -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE}-alpine .
|
|
||||||
|
|
||||||
.PHONY: nightly-push
|
|
||||||
nightly-push: ## Nightly push command for docker images in both flavours (distroless / alpine)
|
|
||||||
$(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY)-nightly:latest -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE} .
|
|
||||||
$(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t ${REGISTRY}/$(REPOSITORY)-nightly:latest-alpine -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE}-alpine .
|
|
||||||
|
|
||||||
|
|
||||||
##@ Docs
|
|
||||||
|
|
||||||
.PHONY: generate
|
|
||||||
generate: ## Generate alpha config docs from golang structs
|
|
||||||
go generate ./pkg/...
|
|
||||||
|
|
||||||
.PHONY: verify-generate
|
|
||||||
verify-generate: generate ## Verify command to check if alpha config docs are in line with golang struct changes
|
|
||||||
git diff --exit-code
|
|
||||||
|
|
||||||
##@ Miscellaneous
|
|
||||||
|
|
||||||
.PHONY: test
|
|
||||||
test: lint ## Run all Go tests
|
|
||||||
GO111MODULE=on $(GO) test $(TESTCOVER) -v -race ./...
|
|
||||||
|
|
||||||
.PHONY: release
|
|
||||||
release: validate-go-version lint test ## Create a full release for all architectures (binaries and checksums)
|
|
||||||
BINARY=${BINARY} VERSION=${VERSION} ./dist.sh
|
|
||||||
|
|
||||||
.PHONY: clean
|
|
||||||
clean: ## Cleanup release and build files
|
|
||||||
-rm -rf release
|
|
||||||
-rm -f $(BINARY)
|
|
||||||
|
|
||||||
.PHONY: lint
|
|
||||||
lint: validate-go-version ## Lint all files using golangci-lint
|
|
||||||
GO111MODULE=on $(GOLANGCILINT) run
|
|
||||||
|
|
||||||
.PHONY: validate-go-version
|
|
||||||
validate-go-version: ## Validate Go environment requirements
|
|
||||||
@$(GO) list . >/dev/null || { echo '$(GO_VERSION_VALIDATION_ERR_MSG)'; exit 1; }
|
|
||||||
|
|
||||||
# local-env can be used to interact with the local development environment
|
|
||||||
# eg:
|
|
||||||
# make local-env-up # Bring up a basic test environment
|
|
||||||
# make local-env-down # Tear down the basic test environment
|
|
||||||
# make local-env-nginx-up # Bring up an nginx based test environment
|
|
||||||
# make local-env-nginx-down # Tead down the nginx based test environment
|
|
||||||
.PHONY: local-env-%
|
|
||||||
local-env-%:
|
|
||||||
make -C contrib/local-environment $*
|
|
||||||
161
README.md
161
README.md
|
|
@ -1,86 +1,145 @@
|
||||||
[](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yml)
|
google_auth_proxy
|
||||||
[](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy)
|
=================
|
||||||
[](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy)
|
|
||||||
[](./LICENSE)
|
|
||||||
[](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/maintainability)
|
|
||||||
[](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/test_coverage)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
OAuth2-Proxy is a flexible, open-source tool that can act as either a standalone reverse proxy or a middleware component integrated into existing reverse proxy or load balancer setups. It provides a simple and secure way to protect your web applications with OAuth2 / OIDC authentication. As a reverse proxy, it intercepts requests to your application and redirects users to an OAuth2 provider for authentication. As a middleware, it can be seamlessly integrated into your existing infrastructure to handle authentication for multiple applications.
|
A reverse proxy that provides authentication using Google OAuth2 to validate
|
||||||
|
individual accounts, or a whole google apps domain.
|
||||||
|
|
||||||
OAuth2-Proxy supports a lot of OAuth2 as well as OIDC providers. Either through a generic OIDC client or a specific implementation for Google, Microsoft Entra ID, GitHub, login.gov and others. Through specialised provider implementations oauth2-proxy can extract more details about the user like preferred usernames and groups. Those details can then be forwarded as HTTP headers to your upstream applications.
|
[](http://travis-ci.org/bitly/google_auth_proxy)
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Get Started
|
|
||||||
|
|
||||||
OAuth2-Proxy's [Installation Docs](https://oauth2-proxy.github.io/oauth2-proxy/installation) cover how to install and configure your setup. Additionally you can take a further look at the [example setup files](https://github.com/oauth2-proxy/oauth2-proxy/tree/master/contrib/local-environment).
|
## Architecture
|
||||||
|
|
||||||
## Releases
|
```
|
||||||
|
_______ ___________________ __________
|
||||||
|
|Nginx| ----> |google_auth_proxy| ----> |upstream|
|
||||||
|
------- ------------------- ----------
|
||||||
|
||
|
||||||
|
\/
|
||||||
|
[google oauth2 api]
|
||||||
|
```
|
||||||
|
|
||||||
### Binaries
|
|
||||||
We publish oauth2-proxy as compiled binaries on GitHub for all major architectures as well as more exotic ones like `ppc64le` as well as `s390x`.
|
|
||||||
|
|
||||||
Check out the [latest release](https://github.com/oauth2-proxy/oauth2-proxy/releases/latest).
|
## Installation
|
||||||
|
|
||||||
### Images
|
1. Download [Prebuilt Binary](https://github.com/bitly/google_auth_proxy/releases) or build from `master` with `$ go get github.com/bitly/google_auth_proxy` which should put the binary in `$GOROOT/bin`
|
||||||
|
2. Register an OAuth Application with Google
|
||||||
|
3. Configure Google Auth Proxy using config file, command line options, or environment variables
|
||||||
|
4. Deploy behind a SSL endpoint (example provided for Nginx)
|
||||||
|
|
||||||
From `v7.6.0` and up the base image has been changed from Alpine to [GoogleContainerTools/distroless](https://github.com/GoogleContainerTools/distroless).
|
## OAuth Configuration
|
||||||
This image comes with even fewer installed dependencies and thus should improve security. The image therefore is also slightly smaller than Alpine.
|
|
||||||
For debugging purposes (and those who really need it. e.g. `armv6`) we still provide images based on Alpine. The tags of these images are suffixed with `-alpine`.
|
|
||||||
|
|
||||||
Since 2023-11-18 we build nightly images directly from the `master` branch and provide them at `quay.io/oauth2-proxy/oauth2-proxy-nightly`.
|
You will need to register an OAuth application with google, and configure it with Redirect URI(s) for the domain you
|
||||||
These images are considered unstable and therefore should **NOT** be used for production purposes unless you know what you're doing.
|
intend to run `google_auth_proxy` on.
|
||||||
|
|
||||||
## Sponsors
|
1. Create a new project: https://console.developers.google.com/project
|
||||||
|
2. Under "APIs & Auth", choose "Credentials"
|
||||||
|
3. Now, choose "Create new Client ID"
|
||||||
|
* The Application Type should be **Web application**
|
||||||
|
* Enter your domain in the Authorized Javascript Origins `https://internal.yourcompany.com`
|
||||||
|
* Enter the correct Authorized Redirect URL `https://internal.yourcompany.com/oauth2/callback`
|
||||||
|
* NOTE: `google_auth_proxy` will _only_ callback on the path `/oauth2/callback`
|
||||||
|
4. Under "APIs & Auth" choose "Consent Screen"
|
||||||
|
* Fill in the necessary fields and Save (this is _required_)
|
||||||
|
5. Take note of the **Client ID** and **Client Secret**
|
||||||
|
|
||||||
|
|
||||||
Microsoft Azure credits for open source projects
|
|
||||||
|
|
||||||
Would you like to sponsor the project then please contact us at [sponsors@oauth2-proxy.dev](mailto:sponsors@oauth2-proxy.dev)
|
## Configuration
|
||||||
|
|
||||||
## Getting Involved
|
`google_auth_proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).
|
||||||
[](https://gophers.slack.com/archives/CM2RSS25N)
|
|
||||||
|
|
||||||
Join the #oauth2-proxy [Slack channel](https://gophers.slack.com/archives/CM2RSS25N) to chat with other users of oauth2-proxy or reach out to the maintainers directly. Use the [public invite link](https://invite.slack.golangbridge.org/) to get an invite for the Gopher Slack space.
|
### Config File
|
||||||
|
|
||||||
OAuth2-Proxy is a community-driven project. We rely on the contribut️ions of our users to continually improve it. While review times can vary, we appreciate your patience and understanding. As a volunteer-driven project, we strive to keep this project stable and might take longer to merge changes.
|
An example [google_auth_proxy.cfg](contrib/google_auth_proxy.cfg.example) config file is in the contrib directory. It can be used by specifying `-config=/etc/google_auth_proxy.cfg`
|
||||||
|
|
||||||
If you want to contribute to the project. Please see our [Contributing](https://oauth2-proxy.github.io/oauth2-proxy/community/contribution) guide.
|
### Command Line Options
|
||||||
|
|
||||||
Who uses OAuth2-Proxy? Have a look at our new [ADOPTERS](ADOPTERS.md) file and
|
```
|
||||||
feel free to open a PR to add your organisation.
|
Usage of google_auth_proxy:
|
||||||
|
-authenticated-emails-file="": authenticate against emails via file (one per line)
|
||||||
|
-client-id="": the Google OAuth Client ID: ie: "123456.apps.googleusercontent.com"
|
||||||
|
-client-secret="": the OAuth Client Secret
|
||||||
|
-config="": path to config file
|
||||||
|
-cookie-domain="": an optional cookie domain to force cookies to (ie: .yourcompany.com)*
|
||||||
|
-cookie-expire=168h0m0s: expire timeframe for cookie
|
||||||
|
-cookie-httponly=true: set HttpOnly cookie flag
|
||||||
|
-cookie-https-only=true: set secure (HTTPS) cookies (deprecated. use --cookie-secure setting)
|
||||||
|
-cookie-secret="": the seed string for secure cookies
|
||||||
|
-cookie-secure=true: set secure (HTTPS) cookie flag
|
||||||
|
-custom-templates-dir="": path to custom html templates
|
||||||
|
-display-htpasswd-form=true: display username / password login form if an htpasswd file is provided
|
||||||
|
-google-apps-domain=: authenticate against the given Google apps domain (may be given multiple times)
|
||||||
|
-htpasswd-file="": additionally authenticate against a htpasswd file. Entries must be created with "htpasswd -s" for SHA encryption
|
||||||
|
-http-address="127.0.0.1:4180": [http://]<addr>:<port> or unix://<path> to listen on for HTTP clients
|
||||||
|
-pass-basic-auth=true: pass HTTP Basic Auth, X-Forwarded-User and X-Forwarded-Email information to upstream
|
||||||
|
-pass-host-header=true: pass the request Host Header to upstream
|
||||||
|
-redirect-url="": the OAuth Redirect URL. ie: "https://internalapp.yourcompany.com/oauth2/callback"
|
||||||
|
-skip-auth-regex=: bypass authentication for requests path's that match (may be given multiple times)
|
||||||
|
-upstream=: the http url(s) of the upstream endpoint. If multiple, routing is based on path
|
||||||
|
-version=false: print version string
|
||||||
|
```
|
||||||
|
|
||||||
Thanks to all the people who already contributed ❤
|
### Environment variables
|
||||||
|
|
||||||
<a href="https://github.com/oauth2-proxy/oauth2-proxy/graphs/contributors">
|
The environment variables `GOOGLE_AUTH_PROXY_CLIENT_ID`, `GOOGLE_AUTH_PROXY_CLIENT_SECRET`, `GOOGLE_AUTH_PROXY_COOKIE_SECRET`, `GOOGLE_AUTH_PROXY_COOKIE_DOMAIN` and `GOOGLE_AUTH_PROXY_COOKIE_EXPIRE` can be used in place of the corresponding command-line arguments.
|
||||||
<img src="https://contrib.rocks/image?repo=oauth2-proxy/oauth2-proxy&columns=15&max=75" />
|
|
||||||
<img src="https://img.shields.io/github/contributors/oauth2-proxy/oauth2-proxy" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
Made with [contrib.rocks](https://contrib.rocks).
|
### Example Nginx Configuration
|
||||||
|
|
||||||
## Security
|
This example has a [Nginx](http://nginx.org/) SSL endpoint proxying to `google_auth_proxy` on port `4180`.
|
||||||
|
`google_auth_proxy` then authenticates requests for an upstream application running on port `8080`. The external
|
||||||
|
endpoint for this example would be `https://internal.yourcompany.com/`.
|
||||||
|
|
||||||
If you believe you have found a vulnerability within OAuth2 Proxy or any of its dependencies, please do **NOT** open an issue or PR on GitHub, please do **NOT** post any details publicly.
|
An example Nginx config follows. Note the use of `Strict-Transport-Security` header to pin requests to SSL
|
||||||
|
via [HSTS](http://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security):
|
||||||
|
|
||||||
Security disclosures **MUST** be done in private. If you have found an issue that you would like to bring to the attention of the maintainers, please compose an email and send it to the list of people listed in our [MAINTAINERS](MAINTAINERS) file.
|
```
|
||||||
|
server {
|
||||||
|
listen 443 default ssl;
|
||||||
|
server_name internal.yourcompany.com;
|
||||||
|
ssl_certificate /path/to/cert.pem;
|
||||||
|
ssl_certificate_key /path/to/cert.key;
|
||||||
|
add_header Strict-Transport-Security max-age=1209600;
|
||||||
|
|
||||||
For more details read our full [Security Docs](https://oauth2-proxy.github.io/oauth2-proxy/community/security#security-disclosures)
|
location / {
|
||||||
|
proxy_pass http://127.0.0.1:4180;
|
||||||
|
proxy_set_header Host $host;
|
||||||
|
proxy_set_header X-Real-IP $remote_addr;
|
||||||
|
proxy_set_header X-Scheme $scheme;
|
||||||
|
proxy_connect_timeout 1;
|
||||||
|
proxy_send_timeout 30;
|
||||||
|
proxy_read_timeout 30;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
### Security Notice for v6.0.0 and older
|
The command line to run `google_auth_proxy` would look like this:
|
||||||
|
|
||||||
If you are running a version older than v6.0.0 we **strongly recommend** to the current version.
|
```bash
|
||||||
|
./google_auth_proxy \
|
||||||
|
--google-apps-domain="yourcompany.com" \
|
||||||
|
--upstream=http://127.0.0.1:8080/ \
|
||||||
|
--cookie-secret=... \
|
||||||
|
--cookie-secure=true \
|
||||||
|
--client-id=... \
|
||||||
|
--client-secret=...
|
||||||
|
```
|
||||||
|
|
||||||
See [open redirect vulnerability](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-5m6c-jp6f-2vcv) for details.
|
|
||||||
|
|
||||||
## Repository History
|
## Endpoint Documentation
|
||||||
|
|
||||||
**2018-11-27:** This repository was forked from [bitly/OAuth2_Proxy](https://github.com/bitly/oauth2_proxy). Versions v3.0.0 and up are from this fork and will have diverged from any changes in the original fork. A list of changes can be seen in the [CHANGELOG](CHANGELOG.md).
|
Google Auth Proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated.
|
||||||
|
|
||||||
**2020-03-29:** This project was formerly hosted as `pusher/oauth2_proxy` but has been renamed to `oauth2-proxy/oauth2-proxy`. Going forward, all images shall be available at `quay.io/oauth2-proxy/oauth2-proxy` and binaries will be named `oauth2-proxy`.
|
* /ping - returns an 200 OK response
|
||||||
|
* /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)
|
||||||
|
* /oauth2/start - a URL that will redirect to start the OAuth cycle
|
||||||
|
* /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this ass the callback url.
|
||||||
|
|
||||||
## License
|
## Logging Format
|
||||||
|
|
||||||
OAuth2-Proxy is distributed under [The MIT License](LICENSE).
|
Google Auth Proxy logs requests to stdout in a format similar to Apache Combined Log.
|
||||||
|
|
||||||
|
```
|
||||||
|
<REMOTE_ADDRESS> - <user@domain.com> [19/Mar/2015:17:20:19 -0400] <HOST_HEADER> GET <UPSTREAM_HOST> "/path/" HTTP/1.1 "<USER_AGENT>" <RESPONSE_CODE> <RESPONSE_BYTES> <REQUEST_DURATION>
|
||||||
|
````
|
||||||
|
|
|
||||||
49
RELEASE.md
49
RELEASE.md
|
|
@ -1,49 +0,0 @@
|
||||||
# Release
|
|
||||||
|
|
||||||
The is a legacy document to explain the manual process of creating and publishing a new release of oauth2-proxy. As of now the release process has been automated with GitHub Actions workflows. For more information have a look at the workflows `create-release.yml` and `publish-release.yml`.
|
|
||||||
|
|
||||||
Here's how OAuth2 Proxy releases are created.
|
|
||||||
|
|
||||||
## Schedule
|
|
||||||
|
|
||||||
Our aim is to release once a quarter, but bug fixes will be prioritised and might be released earlier.
|
|
||||||
|
|
||||||
## The Process
|
|
||||||
|
|
||||||
Note this uses `v4.1.0` as an example release number.
|
|
||||||
|
|
||||||
1. Create a draft Github release
|
|
||||||
* Use format `v4.1.0` for both the tag and title
|
|
||||||
2. Update [CHANGELOG.md](CHANGELOG.md)
|
|
||||||
* Write the release highlights
|
|
||||||
* Copy in headings ready for the next release
|
|
||||||
3. Create release commit
|
|
||||||
```
|
|
||||||
git checkout -b release-v4.1.0
|
|
||||||
```
|
|
||||||
4. Create pull request getting other maintainers to review
|
|
||||||
5. Copy the release notes in to the draft Github release, adding a link to [CHANGELOG.md](CHANGELOG.md)
|
|
||||||
6. Update you local master branch
|
|
||||||
```
|
|
||||||
git checkout master
|
|
||||||
git pull
|
|
||||||
```
|
|
||||||
7. Create & push the tag
|
|
||||||
```
|
|
||||||
git tag v4.1.0
|
|
||||||
git push --tags
|
|
||||||
```
|
|
||||||
8. Make the release artefacts
|
|
||||||
```
|
|
||||||
make release
|
|
||||||
```
|
|
||||||
9. Upload all the files (not the folders) from the `/release` folder to Github release as binary artefacts. There should be both the tarballs (`tar.gz`) and the checksum files (`sha256sum.txt`).
|
|
||||||
10. Publish release in Github
|
|
||||||
11. Make and push docker images to Quay
|
|
||||||
```
|
|
||||||
make build-docker-all
|
|
||||||
make push-docker-all
|
|
||||||
```
|
|
||||||
Note: Ensure the docker tags don't include `-dirty`. This means you have uncommitted changes.
|
|
||||||
|
|
||||||
12. Verify everything looks good at [quay](https://quay.io/repository/oauth2-proxy/oauth2-proxy?tag=latest&tab=tags) and [github](https://github.com/oauth2-proxy/oauth2-proxy/releases)
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# Security Disclosures
|
|
||||||
|
|
||||||
Please see [our community docs](https://oauth2-proxy.github.io/oauth2-proxy/community/security) for our security policy.
|
|
||||||
|
|
@ -0,0 +1,57 @@
|
||||||
|
## Google Auth Proxy Config File
|
||||||
|
## https://github.com/bitly/google_auth_proxy
|
||||||
|
|
||||||
|
## <addr>:<port> to listen on for HTTP clients
|
||||||
|
# http_address = "127.0.0.1:4180"
|
||||||
|
|
||||||
|
## the OAuth Redirect URL.
|
||||||
|
# defaults to the "https://" + requested host header + "/oauth2/callback"
|
||||||
|
# redirect_url = "https://internalapp.yourcompany.com/oauth2/callback"
|
||||||
|
|
||||||
|
## the http url(s) of the upstream endpoint. If multiple, routing is based on path
|
||||||
|
# upstreams = [
|
||||||
|
# "http://127.0.0.1:8080/"
|
||||||
|
# ]
|
||||||
|
|
||||||
|
## Log requests to stdout
|
||||||
|
# request_logging = true
|
||||||
|
|
||||||
|
## pass HTTP Basic Auth, X-Forwarded-User and X-Forwarded-Email information to upstream
|
||||||
|
# pass_basic_auth = true
|
||||||
|
## pass the request Host Header to upstream
|
||||||
|
## when disabled the upstream Host is used as the Host Header
|
||||||
|
# pass_host_header = true
|
||||||
|
|
||||||
|
## Google Apps Domains to allow authentication for
|
||||||
|
# google_apps_domains = [
|
||||||
|
# "yourcompany.com"
|
||||||
|
# ]
|
||||||
|
|
||||||
|
|
||||||
|
## The Google OAuth Client ID, Secret
|
||||||
|
# client_id = "123456.apps.googleusercontent.com"
|
||||||
|
# client_secret = ""
|
||||||
|
|
||||||
|
## Authenticated Email Addresses File (one email per line)
|
||||||
|
# authenticated_emails_file = ""
|
||||||
|
|
||||||
|
## Htpasswd File (optional)
|
||||||
|
## Additionally authenticate against a htpasswd file. Entries must be created with "htpasswd -s" for SHA encryption
|
||||||
|
## enabling exposes a username/login signin form
|
||||||
|
# htpasswd_file = ""
|
||||||
|
|
||||||
|
## Templates
|
||||||
|
## optional directory with custom sign_in.html and error.html
|
||||||
|
# custom_templates_dir = ""
|
||||||
|
|
||||||
|
|
||||||
|
## Cookie Settings
|
||||||
|
## Secret - the seed string for secure cookies
|
||||||
|
## Domain - optional cookie domain to force cookies to (ie: .yourcompany.com)
|
||||||
|
## Expire - expire timeframe for cookie
|
||||||
|
# cookie_secret = ""
|
||||||
|
# cookie_domain = ""
|
||||||
|
# cookie_expire = "168h"
|
||||||
|
# cookie_secure = true
|
||||||
|
# cookie_httponly = true
|
||||||
|
|
||||||
|
|
@ -1,56 +0,0 @@
|
||||||
.PHONY: up
|
|
||||||
up:
|
|
||||||
docker compose up -d
|
|
||||||
|
|
||||||
.PHONY: %
|
|
||||||
%:
|
|
||||||
docker compose $*
|
|
||||||
|
|
||||||
.PHONY: alpha-config-up
|
|
||||||
alpha-config-up:
|
|
||||||
docker compose -f docker-compose.yaml -f docker-compose-alpha-config.yaml up -d
|
|
||||||
|
|
||||||
.PHONY: alpha-config-%
|
|
||||||
alpha-config-%:
|
|
||||||
docker compose -f docker-compose.yaml -f docker-compose-alpha-config.yaml $*
|
|
||||||
|
|
||||||
.PHONY: nginx-up
|
|
||||||
nginx-up:
|
|
||||||
docker compose -f docker-compose.yaml -f docker-compose-nginx.yaml up -d
|
|
||||||
|
|
||||||
.PHONY: nginx-%
|
|
||||||
nginx-%:
|
|
||||||
docker compose -f docker-compose.yaml -f docker-compose-nginx.yaml $*
|
|
||||||
|
|
||||||
.PHONY: keycloak-up
|
|
||||||
keycloak-up:
|
|
||||||
docker compose -f docker-compose-keycloak.yaml up -d
|
|
||||||
|
|
||||||
.PHONY: keycloak-%
|
|
||||||
keycloak-%:
|
|
||||||
docker compose -f docker-compose-keycloak.yaml $*
|
|
||||||
|
|
||||||
.PHONY: gitea-up
|
|
||||||
gitea-up:
|
|
||||||
docker compose -f docker-compose-gitea.yaml up -d
|
|
||||||
|
|
||||||
.PHONY: gitea-%
|
|
||||||
gitea-%:
|
|
||||||
docker compose -f docker-compose-gitea.yaml $*
|
|
||||||
|
|
||||||
.PHONY: kubernetes-up
|
|
||||||
kubernetes-up:
|
|
||||||
make -C kubernetes create-cluster
|
|
||||||
make -C kubernetes deploy
|
|
||||||
|
|
||||||
.PHONY: kubernetes-down
|
|
||||||
kubernetes-down:
|
|
||||||
make -C kubernetes delete-cluster
|
|
||||||
|
|
||||||
.PHONY: traefik-up
|
|
||||||
traefik-up:
|
|
||||||
docker compose -f docker-compose.yaml -f docker-compose-traefik.yaml up -d
|
|
||||||
|
|
||||||
.PHONY: traefik-%
|
|
||||||
traefik-%:
|
|
||||||
docker compose -f docker-compose.yaml -f docker-compose-traefik.yaml $*
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
# oauth2-proxy: local-environment
|
|
||||||
|
|
||||||
Run `make up` to deploy local dex, etcd and oauth2-proxy instances in Docker containers. Review the [`Makefile`](Makefile) for additional deployment options.
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
# This configuration is intended to be used with the docker-compose testing
|
|
||||||
# environment.
|
|
||||||
# This should configure Dex to run on port 5556 and provides a static login
|
|
||||||
issuer: http://dex.localtest.me:5556/dex
|
|
||||||
storage:
|
|
||||||
type: etcd
|
|
||||||
config:
|
|
||||||
endpoints:
|
|
||||||
- http://etcd:2379
|
|
||||||
namespace: dex/
|
|
||||||
web:
|
|
||||||
http: 0.0.0.0:5556
|
|
||||||
oauth2:
|
|
||||||
skipApprovalScreen: true
|
|
||||||
expiry:
|
|
||||||
signingKeys: "4h"
|
|
||||||
idTokens: "1h"
|
|
||||||
staticClients:
|
|
||||||
- id: oauth2-proxy
|
|
||||||
redirectURIs:
|
|
||||||
# These redirect URIs point to the `--redirect-url` for OAuth2 proxy.
|
|
||||||
- 'http://oauth2-proxy.localtest.me:4180/oauth2/callback' # For basic proxy example.
|
|
||||||
- 'http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback' # For nginx and traefik example.
|
|
||||||
name: 'OAuth2 Proxy'
|
|
||||||
secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK
|
|
||||||
enablePasswordDB: true
|
|
||||||
staticPasswords:
|
|
||||||
- email: "admin@example.com"
|
|
||||||
# bcrypt hash of the string "password"
|
|
||||||
hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"
|
|
||||||
username: "admin"
|
|
||||||
userID: "08a8684b-db88-4b73-90a9-3cd1661f5466"
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
# This docker-compose file can be used to bring up an example instance of oauth2-proxy
|
|
||||||
# for manual testing and exploration of features.
|
|
||||||
# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,
|
|
||||||
# etcd for storage for Dex and HTTPBin as an example upstream.
|
|
||||||
# This file also uses alpha configuration when configuring OAuth2 Proxy.
|
|
||||||
#
|
|
||||||
# This file is an extension of the main compose file and must be used with it
|
|
||||||
# docker-compose -f docker-compose.yaml -f docker-compose-alpha-config.yaml <command>
|
|
||||||
# Alternatively:
|
|
||||||
# make alpha-config-<command> (eg make nginx-up, make nginx-down)
|
|
||||||
#
|
|
||||||
# Access http://localhost:4180 to initiate a login cycle
|
|
||||||
version: '3.0'
|
|
||||||
services:
|
|
||||||
oauth2-proxy:
|
|
||||||
image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
|
|
||||||
command: --config /oauth2-proxy.cfg --alpha-config /oauth2-proxy-alpha-config.yaml
|
|
||||||
volumes:
|
|
||||||
- "./oauth2-proxy-alpha-config.cfg:/oauth2-proxy.cfg"
|
|
||||||
- "./oauth2-proxy-alpha-config.yaml:/oauth2-proxy-alpha-config.yaml"
|
|
||||||
|
|
@ -1,62 +0,0 @@
|
||||||
# This docker-compose file can be used to bring up an example instance of oauth2-proxy
|
|
||||||
# for manual testing and exploration of features.
|
|
||||||
# Alongside OAuth2-Proxy, this file also starts Gitea to act as the identity provider,
|
|
||||||
# HTTPBin as an example upstream.
|
|
||||||
#
|
|
||||||
# This can either be created using docker-compose
|
|
||||||
# docker-compose -f docker-compose-gitea.yaml <command>
|
|
||||||
# Or:
|
|
||||||
# make gitea-<command> (eg. make gitea-up, make gitea-down)
|
|
||||||
#
|
|
||||||
# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle using user=admin@example.com, password=password
|
|
||||||
# Access http://gitea.localtest.me:3000 with the same credentials to check out the settings
|
|
||||||
version: '3.0'
|
|
||||||
services:
|
|
||||||
oauth2-proxy:
|
|
||||||
container_name: oauth2-proxy
|
|
||||||
image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
|
|
||||||
command: --config /oauth2-proxy.cfg
|
|
||||||
hostname: oauth2-proxy
|
|
||||||
volumes:
|
|
||||||
- "./oauth2-proxy-gitea.cfg:/oauth2-proxy.cfg"
|
|
||||||
restart: unless-stopped
|
|
||||||
networks:
|
|
||||||
gitea: {}
|
|
||||||
httpbin: {}
|
|
||||||
oauth2-proxy: {}
|
|
||||||
depends_on:
|
|
||||||
- httpbin
|
|
||||||
- gitea
|
|
||||||
ports:
|
|
||||||
- 4180:4180/tcp
|
|
||||||
|
|
||||||
httpbin:
|
|
||||||
container_name: httpbin
|
|
||||||
image: kennethreitz/httpbin:latest
|
|
||||||
hostname: httpbin
|
|
||||||
ports: []
|
|
||||||
networks:
|
|
||||||
httpbin: {}
|
|
||||||
|
|
||||||
gitea:
|
|
||||||
image: gitea/gitea:1.24.7
|
|
||||||
container_name: gitea
|
|
||||||
environment:
|
|
||||||
- USER_UID=1000
|
|
||||||
- USER_GID=1000
|
|
||||||
restart: always
|
|
||||||
networks:
|
|
||||||
gitea:
|
|
||||||
aliases:
|
|
||||||
- gitea.localtest.me
|
|
||||||
volumes:
|
|
||||||
- /etc/timezone:/etc/timezone:ro
|
|
||||||
- /etc/localtime:/etc/localtime:ro
|
|
||||||
ports:
|
|
||||||
- "3000:3000"
|
|
||||||
- "222:22"
|
|
||||||
|
|
||||||
networks:
|
|
||||||
httpbin: {}
|
|
||||||
gitea: {}
|
|
||||||
oauth2-proxy: {}
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# This docker-compose file can be used to bring up an example instance of oauth2-proxy
|
|
||||||
# for manual testing and exploration of features.
|
|
||||||
# Alongside OAuth2-Proxy, this file also starts Keycloak to act as the identity provider,
|
|
||||||
# HTTPBin as an example upstream.
|
|
||||||
#
|
|
||||||
# This can either be created using docker-compose
|
|
||||||
# docker-compose -f docker-compose-keycloak.yaml <command>
|
|
||||||
# Or:
|
|
||||||
# make keycloak-<command> (eg. make keycloak-up, make keycloak-down)
|
|
||||||
#
|
|
||||||
# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle using user=admin@example.com, password=password
|
|
||||||
# Access http://keycloak.localtest.me:9080 with the same credentials to check out the settings
|
|
||||||
version: '3.0'
|
|
||||||
services:
|
|
||||||
oauth2-proxy:
|
|
||||||
container_name: oauth2-proxy
|
|
||||||
image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
|
|
||||||
command: --config /oauth2-proxy.cfg
|
|
||||||
hostname: oauth2-proxy
|
|
||||||
volumes:
|
|
||||||
- "./oauth2-proxy-keycloak.cfg:/oauth2-proxy.cfg"
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- 4180:4180/tcp
|
|
||||||
networks:
|
|
||||||
keycloak: {}
|
|
||||||
httpbin: {}
|
|
||||||
oauth2-proxy: {}
|
|
||||||
depends_on:
|
|
||||||
- httpbin
|
|
||||||
- keycloak
|
|
||||||
|
|
||||||
httpbin:
|
|
||||||
container_name: httpbin
|
|
||||||
image: kennethreitz/httpbin:latest
|
|
||||||
hostname: httpbin
|
|
||||||
ports: []
|
|
||||||
networks:
|
|
||||||
httpbin: {}
|
|
||||||
|
|
||||||
keycloak:
|
|
||||||
container_name: keycloak
|
|
||||||
image: keycloak/keycloak:25.0
|
|
||||||
hostname: keycloak
|
|
||||||
command:
|
|
||||||
- 'start-dev'
|
|
||||||
- '--http-port=9080'
|
|
||||||
- '--import-realm'
|
|
||||||
volumes:
|
|
||||||
- ./keycloak:/opt/keycloak/data/import
|
|
||||||
environment:
|
|
||||||
KC_HTTP_PORT: 9080
|
|
||||||
KEYCLOAK_ADMIN: admin@example.com
|
|
||||||
KEYCLOAK_ADMIN_PASSWORD: password
|
|
||||||
ports:
|
|
||||||
- 9080:9080/tcp
|
|
||||||
networks:
|
|
||||||
keycloak:
|
|
||||||
aliases:
|
|
||||||
- keycloak.localtest.me
|
|
||||||
|
|
||||||
networks:
|
|
||||||
httpbin: {}
|
|
||||||
keycloak: {}
|
|
||||||
oauth2-proxy: {}
|
|
||||||
|
|
@ -1,92 +0,0 @@
|
||||||
# This docker-compose file can be used to bring up an example instance of oauth2-proxy
|
|
||||||
# for manual testing and exploration of features.
|
|
||||||
# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,
|
|
||||||
# etcd for storage for Dex, nginx as a reverse proxy and other http services for upstreams
|
|
||||||
#
|
|
||||||
# This file is an extension of the main compose file and must be used with it
|
|
||||||
# docker-compose -f docker-compose.yaml -f docker-compose-nginx.yaml <command>
|
|
||||||
# Alternatively:
|
|
||||||
# make nginx-<command> (eg make nginx-up, make nginx-down)
|
|
||||||
#
|
|
||||||
# Access one of the following URLs to initiate a login flow:
|
|
||||||
# - http://oauth2-proxy.localhost
|
|
||||||
# - http://httpbin.oauth2-proxy.localhost
|
|
||||||
#
|
|
||||||
# The OAuth2 Proxy itself is hosted at http://oauth2-proxy.oauth2-proxy.localhost
|
|
||||||
#
|
|
||||||
# Note, the above URLs should work with Chrome, but you may need to add hosts
|
|
||||||
# entries for other browsers
|
|
||||||
# 127.0.0.1 oauth2-proxy.localhost
|
|
||||||
# 127.0.0.1 httpbin.oauth2-proxy.localhost
|
|
||||||
# 127.0.0.1 oauth2-proxy.oauth2-proxy.localhost
|
|
||||||
version: '3.0'
|
|
||||||
services:
|
|
||||||
oauth2-proxy:
|
|
||||||
image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
|
|
||||||
ports: []
|
|
||||||
hostname: oauth2-proxy
|
|
||||||
container_name: oauth2-proxy
|
|
||||||
command: --config /oauth2-proxy.cfg
|
|
||||||
volumes:
|
|
||||||
- "./oauth2-proxy-nginx.cfg:/oauth2-proxy.cfg"
|
|
||||||
networks:
|
|
||||||
oauth2-proxy: {}
|
|
||||||
dex: {}
|
|
||||||
etcd: {}
|
|
||||||
httpbin: {}
|
|
||||||
depends_on:
|
|
||||||
- dex
|
|
||||||
- httpbin
|
|
||||||
nginx:
|
|
||||||
depends_on:
|
|
||||||
- oauth2-proxy
|
|
||||||
container_name: nginx
|
|
||||||
image: nginx:1.29
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- 80:80/tcp
|
|
||||||
hostname: nginx
|
|
||||||
volumes:
|
|
||||||
- "./nginx.conf:/etc/nginx/conf.d/default.conf"
|
|
||||||
networks:
|
|
||||||
oauth2-proxy: {}
|
|
||||||
dex: {}
|
|
||||||
etcd: {}
|
|
||||||
httpbin: {}
|
|
||||||
dex:
|
|
||||||
container_name: dex
|
|
||||||
image: ghcr.io/dexidp/dex:v2.44.0
|
|
||||||
command: dex serve /dex.yaml
|
|
||||||
hostname: dex
|
|
||||||
volumes:
|
|
||||||
- "./dex.yaml:/dex.yaml"
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- 5556:4181/tcp
|
|
||||||
networks:
|
|
||||||
dex:
|
|
||||||
aliases:
|
|
||||||
- dex.localtest.me
|
|
||||||
etcd: {}
|
|
||||||
depends_on:
|
|
||||||
- etcd
|
|
||||||
httpbin:
|
|
||||||
container_name: httpbin
|
|
||||||
image: kennethreitz/httpbin
|
|
||||||
ports: []
|
|
||||||
networks:
|
|
||||||
httpbin: {}
|
|
||||||
etcd:
|
|
||||||
container_name: etcd
|
|
||||||
image: gcr.io/etcd-development/etcd:v3.6.5
|
|
||||||
entrypoint: /usr/local/bin/etcd
|
|
||||||
command:
|
|
||||||
- --listen-client-urls=http://0.0.0.0:2379
|
|
||||||
- --advertise-client-urls=http://etcd:2379
|
|
||||||
networks:
|
|
||||||
etcd: {}
|
|
||||||
networks:
|
|
||||||
dex: {}
|
|
||||||
etcd: {}
|
|
||||||
httpbin: {}
|
|
||||||
oauth2-proxy: {}
|
|
||||||
|
|
@ -1,50 +0,0 @@
|
||||||
# This docker-compose file can be used to bring up an example instance of oauth2-proxy
|
|
||||||
# for manual testing and exploration of features.
|
|
||||||
# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,
|
|
||||||
# HTTPBin as an example upstream.
|
|
||||||
#
|
|
||||||
# This can either be created using docker-compose
|
|
||||||
# docker-compose -f docker-compose-traefik.yaml <command>
|
|
||||||
# Or:
|
|
||||||
# make traefik-<command> (eg. make traefik-up, make traefik-down)
|
|
||||||
#
|
|
||||||
# Access one of the following URLs to initiate a login flow:
|
|
||||||
# - http://oauth2-proxy.localhost
|
|
||||||
# - http://httpbin.oauth2-proxy.localhost
|
|
||||||
#
|
|
||||||
# The OAuth2 Proxy itself is hosted at http://oauth2-proxy.oauth2-proxy.localhost
|
|
||||||
#
|
|
||||||
# Note, the above URLs should work with Chrome, but you may need to add hosts
|
|
||||||
# entries for other browsers
|
|
||||||
# 127.0.0.1 oauth2-proxy.localhost
|
|
||||||
# 127.0.0.1 httpbin.oauth2-proxy.localhost
|
|
||||||
# 127.0.0.1 oauth2-proxy.oauth2-proxy.localhost
|
|
||||||
version: '3.0'
|
|
||||||
services:
|
|
||||||
|
|
||||||
oauth2-proxy:
|
|
||||||
image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
|
|
||||||
ports: []
|
|
||||||
hostname: oauth2-proxy
|
|
||||||
volumes:
|
|
||||||
- "./oauth2-proxy-traefik.cfg:/oauth2-proxy.cfg"
|
|
||||||
networks:
|
|
||||||
oauth2-proxy:
|
|
||||||
|
|
||||||
# Reverse proxy
|
|
||||||
gateway:
|
|
||||||
container_name: traefik
|
|
||||||
image: traefik:v2.11.29
|
|
||||||
volumes:
|
|
||||||
- "./traefik:/etc/traefik"
|
|
||||||
ports:
|
|
||||||
- "80:80"
|
|
||||||
- "9090:8080"
|
|
||||||
depends_on:
|
|
||||||
- oauth2-proxy
|
|
||||||
networks:
|
|
||||||
oauth2-proxy:
|
|
||||||
httpbin:
|
|
||||||
|
|
||||||
networks:
|
|
||||||
oauth2-proxy:
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# This docker-compose file can be used to bring up an example instance of oauth2-proxy
|
|
||||||
# for manual testing and exploration of features.
|
|
||||||
# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,
|
|
||||||
# etcd for storage for Dex and HTTPBin as an example upstream.
|
|
||||||
#
|
|
||||||
# This can either be created using docker-compose
|
|
||||||
# docker-compose -f docker-compose.yaml <command>
|
|
||||||
# Or:
|
|
||||||
# make <command> (eg. make up, make down)
|
|
||||||
#
|
|
||||||
# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle
|
|
||||||
version: '3.0'
|
|
||||||
services:
|
|
||||||
oauth2-proxy:
|
|
||||||
container_name: oauth2-proxy
|
|
||||||
image: quay.io/oauth2-proxy/oauth2-proxy:v7.12.0
|
|
||||||
command: --config /oauth2-proxy.cfg
|
|
||||||
hostname: oauth2-proxy
|
|
||||||
volumes:
|
|
||||||
- "./oauth2-proxy.cfg:/oauth2-proxy.cfg"
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- 4180:4180/tcp
|
|
||||||
networks:
|
|
||||||
dex: {}
|
|
||||||
httpbin: {}
|
|
||||||
depends_on:
|
|
||||||
- dex
|
|
||||||
- httpbin
|
|
||||||
dex:
|
|
||||||
container_name: dex
|
|
||||||
image: ghcr.io/dexidp/dex:v2.44.0
|
|
||||||
command: dex serve /dex.yaml
|
|
||||||
hostname: dex
|
|
||||||
volumes:
|
|
||||||
- "./dex.yaml:/dex.yaml"
|
|
||||||
restart: unless-stopped
|
|
||||||
ports:
|
|
||||||
- 5556:5556/tcp
|
|
||||||
networks:
|
|
||||||
dex:
|
|
||||||
aliases:
|
|
||||||
- dex.localtest.me
|
|
||||||
etcd: {}
|
|
||||||
depends_on:
|
|
||||||
- etcd
|
|
||||||
httpbin:
|
|
||||||
container_name: httpbin
|
|
||||||
image: kennethreitz/httpbin
|
|
||||||
ports: []
|
|
||||||
networks:
|
|
||||||
httpbin: {}
|
|
||||||
etcd:
|
|
||||||
container_name: etcd
|
|
||||||
image: gcr.io/etcd-development/etcd:v3.6.5
|
|
||||||
entrypoint: /usr/local/bin/etcd
|
|
||||||
command:
|
|
||||||
- --listen-client-urls=http://0.0.0.0:2379
|
|
||||||
- --advertise-client-urls=http://etcd:2379
|
|
||||||
networks:
|
|
||||||
etcd: {}
|
|
||||||
networks:
|
|
||||||
dex: {}
|
|
||||||
etcd: {}
|
|
||||||
httpbin: {}
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,38 +0,0 @@
|
||||||
{
|
|
||||||
"realm": "oauth2-proxy",
|
|
||||||
"users": [
|
|
||||||
{
|
|
||||||
"id": "3356c0a0-d4d5-4436-9c5a-2299c71c08ec",
|
|
||||||
"createdTimestamp": 1591297959169,
|
|
||||||
"username": "admin@example.com",
|
|
||||||
"email": "admin@example.com",
|
|
||||||
"enabled": true,
|
|
||||||
"totp": false,
|
|
||||||
"emailVerified": true,
|
|
||||||
"credentials": [
|
|
||||||
{
|
|
||||||
"id": "a1a06ecd-fdc0-4e67-92cd-2da22d724e32",
|
|
||||||
"type": "password",
|
|
||||||
"createdDate": 1591297959315,
|
|
||||||
"secretData": "{\"value\":\"6rt5zuqHVHopvd0FTFE0CYadXTtzY0mDY2BrqnNQGS51/7DfMJeGgj0roNnGMGvDv30imErNmiSOYl+cL9jiIA==\",\"salt\":\"LI0kqr09JB7J9wvr2Hxzzg==\"}",
|
|
||||||
"credentialData": "{\"hashIterations\":27500,\"algorithm\":\"pbkdf2-sha256\"}"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"disableableCredentialTypes": [],
|
|
||||||
"requiredActions": [],
|
|
||||||
"realmRoles": [
|
|
||||||
"offline_access",
|
|
||||||
"admin",
|
|
||||||
"uma_authorization"
|
|
||||||
],
|
|
||||||
"clientRoles": {
|
|
||||||
"account": [
|
|
||||||
"view-profile",
|
|
||||||
"manage-account"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"notBefore": 0,
|
|
||||||
"groups": []
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
@ -1 +0,0 @@
|
||||||
charts/
|
|
||||||
|
|
@ -1,15 +0,0 @@
|
||||||
dependencies:
|
|
||||||
- name: dex
|
|
||||||
repository: https://charts.dexidp.io
|
|
||||||
version: 0.24.0
|
|
||||||
- name: oauth2-proxy
|
|
||||||
repository: https://oauth2-proxy.github.io/manifests
|
|
||||||
version: 7.18.0
|
|
||||||
- name: httpbin
|
|
||||||
repository: https://conservis.github.io/helm-charts
|
|
||||||
version: 1.1.0
|
|
||||||
- name: hello-world
|
|
||||||
repository: https://conservis.github.io/helm-charts
|
|
||||||
version: 1.1.0
|
|
||||||
digest: sha256:fee913531bfb67e5555e995d8fb040c330e6eb4b5a8c777ceb9841135ea9bb84
|
|
||||||
generated: "2025-10-28T06:46:35.38300324Z"
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
apiVersion: v2
|
|
||||||
description: K8S example based on https://kind.sigs.k8s.io
|
|
||||||
name: kubernetes
|
|
||||||
dependencies:
|
|
||||||
- name: dex
|
|
||||||
version: 0.24.0
|
|
||||||
repository: https://charts.dexidp.io
|
|
||||||
- name: oauth2-proxy
|
|
||||||
version: &chartVersion 7.18.0
|
|
||||||
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
|
|
||||||
- name: httpbin
|
|
||||||
version: 1.1.0
|
|
||||||
repository: https://conservis.github.io/helm-charts
|
|
||||||
- name: hello-world
|
|
||||||
version: 1.1.0
|
|
||||||
repository: https://conservis.github.io/helm-charts
|
|
||||||
version: *chartVersion
|
|
||||||
|
|
@ -1,59 +0,0 @@
|
||||||
all:
|
|
||||||
@echo "Usage:"
|
|
||||||
@echo " make create-cluster"
|
|
||||||
@echo " make deploy"
|
|
||||||
|
|
||||||
# create kind cluster with nginx-ingress as the most popular ingress controller for K8S
|
|
||||||
.PHONY: deploy
|
|
||||||
create-cluster:
|
|
||||||
kind create cluster --name oauth2-proxy --config kind-cluster.yaml
|
|
||||||
make setup-dns
|
|
||||||
make setup-ingress
|
|
||||||
|
|
||||||
.PHONY: setup-ingress
|
|
||||||
setup-ingress:
|
|
||||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml
|
|
||||||
kubectl --namespace ingress-nginx rollout status --timeout 5m deployment/ingress-nginx-controller
|
|
||||||
|
|
||||||
# default Pod CIDR is 10.244.0.0/16 https://github.com/kubernetes-sigs/kind/blob/a6e8108025bc7a9440beedb8ef7714aec84fe87e/pkg/apis/config/v1alpha4/default.go#L52
|
|
||||||
# what makes cluster host IP equal to 10.244.0.1
|
|
||||||
# thus we add dex.localtest.me and oauth2-proxy.localtest.me stub hosts pointing to this IP
|
|
||||||
# NOT NEEDED IN REAL LIFE!
|
|
||||||
.PHONY: setup-dns
|
|
||||||
setup-dns:
|
|
||||||
kubectl apply -f custom-dns.yaml
|
|
||||||
kubectl -n kube-system rollout restart deployment/coredns
|
|
||||||
kubectl -n kube-system rollout status --timeout 5m deployment/coredns
|
|
||||||
|
|
||||||
.PHONY: delete-cluster
|
|
||||||
delete-cluster:
|
|
||||||
kind delete cluster --name oauth2-proxy
|
|
||||||
|
|
||||||
.PHONY: deploy
|
|
||||||
deploy: helm-deploy
|
|
||||||
kubectl rollout status --timeout 5m deployment/oauth2-proxy-example-oauth2-proxy-sample
|
|
||||||
kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-httpbin
|
|
||||||
kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-hello-world
|
|
||||||
|
|
||||||
.PHONY: undeploy
|
|
||||||
undeploy: helm-undeploy
|
|
||||||
|
|
||||||
######################
|
|
||||||
###### HELM CMDs #####
|
|
||||||
######################
|
|
||||||
.PHONY: helm-init
|
|
||||||
helm-init:
|
|
||||||
helm dep update
|
|
||||||
|
|
||||||
# unpacking is useful to be able to explore underlying helm charts
|
|
||||||
.PHONY: helm-unpack
|
|
||||||
helm-unpack:
|
|
||||||
cd charts; for f in *.tgz; do tar -zxf "$$f"; done
|
|
||||||
|
|
||||||
.PHONY: helm-deploy
|
|
||||||
helm-deploy: helm-init
|
|
||||||
helm upgrade --wait --debug --install --render-subchart-notes oauth2-proxy-example .
|
|
||||||
|
|
||||||
.PHONY: helm-undeploy
|
|
||||||
helm-undeploy:
|
|
||||||
helm del oauth2-proxy-example
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
# Kubernetes example
|
|
||||||
Based on [kind](https://kind.sigs.k8s.io) as a local Kubernetes cluster.
|
|
||||||
|
|
||||||
## Quick start
|
|
||||||
|
|
||||||
Before you start:
|
|
||||||
|
|
||||||
_Required_
|
|
||||||
* install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)
|
|
||||||
* install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
|
|
||||||
* install [helm](https://helm.sh/docs/intro/quickstart/#install-helm).
|
|
||||||
|
|
||||||
Then:
|
|
||||||
|
|
||||||
* `make create-cluster`
|
|
||||||
* `make deploy`
|
|
||||||
|
|
||||||
Visit http://httpbin.localtest.me or http://hello-world.localtest.me/
|
|
||||||
Note: When accessing the service for the first time you will need to authenticate with Dex. It is configured using static credentials for testing. With username `admin@example.com` and password set to `password`.
|
|
||||||
|
|
||||||
## Uninstall
|
|
||||||
|
|
||||||
* `make delete-cluster`
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
apiVersion: v1
|
|
||||||
kind: ConfigMap
|
|
||||||
metadata:
|
|
||||||
name: coredns
|
|
||||||
namespace: kube-system
|
|
||||||
data:
|
|
||||||
Corefile: |
|
|
||||||
.:53 {
|
|
||||||
errors
|
|
||||||
health {
|
|
||||||
lameduck 5s
|
|
||||||
}
|
|
||||||
ready
|
|
||||||
kubernetes cluster.local in-addr.arpa ip6.arpa {
|
|
||||||
pods insecure
|
|
||||||
fallthrough in-addr.arpa ip6.arpa
|
|
||||||
ttl 30
|
|
||||||
}
|
|
||||||
prometheus :9153
|
|
||||||
forward . /etc/resolv.conf
|
|
||||||
cache 30
|
|
||||||
loop
|
|
||||||
reload
|
|
||||||
loadbalance
|
|
||||||
hosts {
|
|
||||||
10.244.0.1 dex.localtest.me
|
|
||||||
10.244.0.1 oauth2-proxy.localtest.me
|
|
||||||
fallthrough
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,17 +0,0 @@
|
||||||
apiVersion: kind.x-k8s.io/v1alpha4
|
|
||||||
kind: Cluster
|
|
||||||
nodes:
|
|
||||||
- role: control-plane
|
|
||||||
kubeadmConfigPatches:
|
|
||||||
- |
|
|
||||||
kind: InitConfiguration
|
|
||||||
nodeRegistration:
|
|
||||||
kubeletExtraArgs:
|
|
||||||
node-labels: "ingress-ready=true"
|
|
||||||
extraPortMappings:
|
|
||||||
- containerPort: 80
|
|
||||||
hostPort: 80
|
|
||||||
protocol: TCP
|
|
||||||
- containerPort: 443
|
|
||||||
hostPort: 443
|
|
||||||
protocol: TCP
|
|
||||||
|
|
@ -1,97 +0,0 @@
|
||||||
dex:
|
|
||||||
ingress:
|
|
||||||
enabled: true
|
|
||||||
hosts:
|
|
||||||
- host: dex.localtest.me
|
|
||||||
paths:
|
|
||||||
- path: /
|
|
||||||
pathType: ImplementationSpecific
|
|
||||||
grpc:
|
|
||||||
enabled: false
|
|
||||||
certs:
|
|
||||||
grpc:
|
|
||||||
create: false
|
|
||||||
web:
|
|
||||||
create: false
|
|
||||||
|
|
||||||
config:
|
|
||||||
issuer: http://dex.localtest.me
|
|
||||||
storage:
|
|
||||||
type: kubernetes
|
|
||||||
config:
|
|
||||||
inCluster: true
|
|
||||||
enablePasswordDB: true
|
|
||||||
expiry:
|
|
||||||
signingKeys: "4h"
|
|
||||||
idTokens: "1h"
|
|
||||||
staticClients:
|
|
||||||
- id: oauth2-proxy
|
|
||||||
redirectURIs:
|
|
||||||
# These redirect URI points to the `--redirect-url` for OAuth2 proxy.
|
|
||||||
- 'http://oauth2-proxy.localtest.me/oauth2/callback'
|
|
||||||
name: 'OAuth2 Proxy'
|
|
||||||
secret: "b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
|
|
||||||
staticPasswords:
|
|
||||||
- email: "admin@example.com"
|
|
||||||
# bcrypt hash of the string "password"
|
|
||||||
hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"
|
|
||||||
username: "admin"
|
|
||||||
userID: "08a8684b-db88-4b73-90a9-3cd1661f5466"
|
|
||||||
|
|
||||||
oauth2-proxy:
|
|
||||||
nameOverride: oauth2-proxy-sample
|
|
||||||
ingress:
|
|
||||||
enabled: true
|
|
||||||
hosts:
|
|
||||||
- oauth2-proxy.localtest.me
|
|
||||||
# pick up client_id and client_secret from configFile as opposed to helm .Values.config.clientID and .Values.config.clientSecret
|
|
||||||
proxyVarsAsSecrets: false
|
|
||||||
config:
|
|
||||||
configFile: |-
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
cookie_domains=".localtest.me"
|
|
||||||
whitelist_domains=[".localtest.me"]
|
|
||||||
# only users with this domain will be let in
|
|
||||||
email_domains=["example.com"]
|
|
||||||
|
|
||||||
client_id="oauth2-proxy"
|
|
||||||
client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
|
|
||||||
cookie_secure="false"
|
|
||||||
|
|
||||||
redirect_url="http://oauth2-proxy.localtest.me/oauth2/callback"
|
|
||||||
|
|
||||||
# we don't want to proxy anything so pick a non-existent directory
|
|
||||||
upstreams = [ "file:///dev/null" ]
|
|
||||||
|
|
||||||
# return authenticated user to nginx
|
|
||||||
set_xauthrequest = true
|
|
||||||
# using http://dex.localtest.me/.well-known/openid-configuration oauth2-proxy will populate
|
|
||||||
# login_url, redeem_url, and oidc_jwks_url
|
|
||||||
provider="oidc"
|
|
||||||
oidc_issuer_url="http://dex.localtest.me"
|
|
||||||
|
|
||||||
httpbin:
|
|
||||||
ingress:
|
|
||||||
enabled: true
|
|
||||||
hosts:
|
|
||||||
- httpbin.localtest.me
|
|
||||||
annotations:
|
|
||||||
nginx.ingress.kubernetes.io/auth-signin: http://oauth2-proxy.localtest.me/oauth2/start
|
|
||||||
# That's what will be used in REAL LIFE
|
|
||||||
#nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy.localtest.me/oauth2/auth
|
|
||||||
# but because of https://github.com/kubernetes/ingress-nginx/issues/3665
|
|
||||||
nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy-example-oauth2-proxy-sample.default.svc.cluster.local/oauth2/auth
|
|
||||||
nginx.ingress.kubernetes.io/auth-response-headers: X-Auth-Request-User,X-Auth-Request-Email
|
|
||||||
|
|
||||||
hello-world:
|
|
||||||
ingress:
|
|
||||||
enabled: true
|
|
||||||
hosts:
|
|
||||||
- hello-world.localtest.me
|
|
||||||
annotations:
|
|
||||||
nginx.ingress.kubernetes.io/auth-signin: http://oauth2-proxy.localtest.me/oauth2/start
|
|
||||||
# That's what will be used in REAL LIFE
|
|
||||||
#nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy.localtest.me/oauth2/auth
|
|
||||||
# but because of https://github.com/kubernetes/ingress-nginx/issues/3665
|
|
||||||
nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy-example-oauth2-proxy-sample.default.svc.cluster.local/oauth2/auth
|
|
||||||
nginx.ingress.kubernetes.io/auth-response-headers: X-Auth-Request-User,X-Auth-Request-Email
|
|
||||||
|
|
@ -1,86 +0,0 @@
|
||||||
# Reverse proxy to oauth2-proxy
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
server_name oauth2-proxy.oauth2-proxy.localhost;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
|
|
||||||
proxy_pass http://oauth2-proxy:4180/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# Reverse proxy to httpbin
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
server_name httpbin.oauth2-proxy.localhost;
|
|
||||||
|
|
||||||
auth_request /internal-auth/oauth2/auth;
|
|
||||||
|
|
||||||
# If the auth_request denies the request (401), redirect to the sign_in page
|
|
||||||
# and include the final rd URL back to the user's original request.
|
|
||||||
error_page 401 =403 http://oauth2-proxy.oauth2-proxy.localhost/oauth2/sign_in?rd=$scheme://$host$request_uri;
|
|
||||||
|
|
||||||
# Alternatively send the request to `start` to skip the provider button
|
|
||||||
# error_page 401 = http://oauth2-proxy.oauth2-proxy.localhost/oauth2/start?rd=$scheme://$host$request_uri;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
proxy_pass http://httpbin/;
|
|
||||||
}
|
|
||||||
|
|
||||||
# auth_request must be a URI so this allows an internal path to then proxy to
|
|
||||||
# the real auth_request path.
|
|
||||||
# The trailing /'s are required so that nginx strips the prefix before proxying.
|
|
||||||
location /internal-auth/ {
|
|
||||||
internal; # Ensure external users can't access this path
|
|
||||||
|
|
||||||
# Make sure the OAuth2 Proxy knows where the original request came from.
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-Uri $request_uri;
|
|
||||||
|
|
||||||
proxy_pass http://oauth2-proxy:4180/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# Statically serve the nginx welcome
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
server_name oauth2-proxy.localhost;
|
|
||||||
|
|
||||||
location / {
|
|
||||||
auth_request /internal-auth/oauth2/auth;
|
|
||||||
|
|
||||||
# If the auth_request denies the request (401), redirect to the sign_in page
|
|
||||||
# and include the final rd URL back to the user's original request.
|
|
||||||
error_page 401 =403 http://oauth2-proxy.oauth2-proxy.localhost/oauth2/sign_in?rd=$scheme://$host$request_uri;
|
|
||||||
|
|
||||||
# Alternatively send the request to `start` to skip the provider button
|
|
||||||
# error_page 401 = http://oauth2-proxy.oauth2-proxy.localhost/oauth2/start?rd=$scheme://$host$request_uri;
|
|
||||||
|
|
||||||
|
|
||||||
root /usr/share/nginx/html;
|
|
||||||
index index.html index.htm;
|
|
||||||
}
|
|
||||||
|
|
||||||
# redirect server error pages to the static page /50x.html
|
|
||||||
error_page 500 502 503 504 /50x.html;
|
|
||||||
location = /50x.html {
|
|
||||||
root /usr/share/nginx/html;
|
|
||||||
}
|
|
||||||
|
|
||||||
# auth_request must be a URI so this allows an internal path to then proxy to
|
|
||||||
# the real auth_request path.
|
|
||||||
# The trailing /'s are required so that nginx strips the prefix before proxying.
|
|
||||||
location /internal-auth/ {
|
|
||||||
internal; # Ensure external users can't access this path
|
|
||||||
|
|
||||||
# Make sure the OAuth2 Proxy knows where the original request came from.
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-Uri $request_uri;
|
|
||||||
|
|
||||||
proxy_pass http://oauth2-proxy:4180/;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
@ -1,5 +0,0 @@
|
||||||
http_address="0.0.0.0:4180"
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
email_domains="example.com"
|
|
||||||
cookie_secure="false"
|
|
||||||
redirect_url="http://localhost:4180/oauth2/callback"
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
upstreams:
|
|
||||||
- id: httpbin
|
|
||||||
path: /
|
|
||||||
uri: http://httpbin
|
|
||||||
injectRequestHeaders:
|
|
||||||
- name: X-Forwarded-Groups
|
|
||||||
values:
|
|
||||||
- claim: groups
|
|
||||||
- name: X-Forwarded-User
|
|
||||||
values:
|
|
||||||
- claim: user
|
|
||||||
- name: X-Forwarded-Email
|
|
||||||
values:
|
|
||||||
- claim: email
|
|
||||||
- name: X-Forwarded-Preferred-Username
|
|
||||||
values:
|
|
||||||
- claim: preferred_username
|
|
||||||
providers:
|
|
||||||
- provider: oidc
|
|
||||||
clientSecret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK
|
|
||||||
clientID: oauth2-proxy
|
|
||||||
oidcConfig:
|
|
||||||
issuerURL: http://dex.localhost:5556/dex
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
http_address="0.0.0.0:4180"
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
email_domains=["localhost"]
|
|
||||||
cookie_secure="false"
|
|
||||||
upstreams="http://httpbin"
|
|
||||||
cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.
|
|
||||||
whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.
|
|
||||||
|
|
||||||
client_id="ef0c2b91-2e38-4fa8-908d-067a35dbb71c"
|
|
||||||
client_secret="gto_qdppomn2p26su5x46tyixj7bcny5m5er2s67xhrponq2qtp66f3a"
|
|
||||||
redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"
|
|
||||||
|
|
||||||
# gitea provider
|
|
||||||
provider="github"
|
|
||||||
provider_display_name="Gitea"
|
|
||||||
login_url="http://gitea.localtest.me:3000/login/oauth/authorize"
|
|
||||||
redeem_url="http://gitea.localtest.me:3000/login/oauth/access_token"
|
|
||||||
validate_url="http://gitea.localtest.me:3000/api/v1/user/emails"
|
|
||||||
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
http_address="0.0.0.0:4180"
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
email_domains="example.com"
|
|
||||||
cookie_secure="false"
|
|
||||||
upstreams="http://httpbin"
|
|
||||||
cookie_domains=["oauth2-proxy.localtest.me:4080", "keycloak.localtest.me:9080"] # Required so cookie can be read on all subdomains.
|
|
||||||
whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.
|
|
||||||
|
|
||||||
# keycloak provider
|
|
||||||
client_secret="72341b6d-7065-4518-a0e4-50ee15025608"
|
|
||||||
client_id="oauth2-proxy"
|
|
||||||
redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"
|
|
||||||
|
|
||||||
# in this case oauth2-proxy is going to visit
|
|
||||||
# http://keycloak.localtest.me:9080/realms/oauth2-proxy/.well-known/openid-configuration for configuration
|
|
||||||
oidc_issuer_url="http://keycloak.localtest.me:9080/realms/oauth2-proxy"
|
|
||||||
provider="oidc"
|
|
||||||
provider_display_name="Keycloak"
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
http_address="0.0.0.0:4180"
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
provider="oidc"
|
|
||||||
email_domains="example.com"
|
|
||||||
oidc_issuer_url="http://dex.localtest.me:5556/dex"
|
|
||||||
client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
|
|
||||||
client_id="oauth2-proxy"
|
|
||||||
cookie_secure="false"
|
|
||||||
|
|
||||||
redirect_url="http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback"
|
|
||||||
cookie_domains=".oauth2-proxy.localhost" # Required so cookie can be read on all subdomains.
|
|
||||||
whitelist_domains=".oauth2-proxy.localhost" # Required to allow redirection back to original requested target.
|
|
||||||
# Enables the use of `X-Forwarded-*` headers to determine request correctly
|
|
||||||
reverse_proxy="true"
|
|
||||||
|
|
@ -1,22 +0,0 @@
|
||||||
http_address="0.0.0.0:4180"
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
provider="oidc"
|
|
||||||
email_domains=["example.com"]
|
|
||||||
oidc_issuer_url="http://dex.localhost:5556/dex"
|
|
||||||
client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
|
|
||||||
client_id="oauth2-proxy"
|
|
||||||
cookie_secure="false"
|
|
||||||
|
|
||||||
redirect_url="http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback"
|
|
||||||
cookie_domains=".oauth2-proxy.localhost" # Required so cookie can be read on all subdomains.
|
|
||||||
whitelist_domains=".oauth2-proxy.localhost" # Required to allow redirection back to original requested target.
|
|
||||||
|
|
||||||
# Mandatory option when using oauth2-proxy with traefik
|
|
||||||
reverse_proxy="true"
|
|
||||||
# Required for traefik with ForwardAuth and static upstream configuration
|
|
||||||
upstreams="static://202"
|
|
||||||
# The following option skip the page requesting the user
|
|
||||||
# to click on a button to be redirected to the identity provider
|
|
||||||
# It can be activated only when traefik is not configure with
|
|
||||||
# the error redirection middleware as this example.
|
|
||||||
skip_provider_button="true"
|
|
||||||
|
|
@ -1,16 +0,0 @@
|
||||||
http_address="0.0.0.0:4180"
|
|
||||||
cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="
|
|
||||||
email_domains="example.com"
|
|
||||||
cookie_secure="false"
|
|
||||||
upstreams="http://httpbin"
|
|
||||||
cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.
|
|
||||||
whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.
|
|
||||||
|
|
||||||
# dex provider
|
|
||||||
client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"
|
|
||||||
client_id="oauth2-proxy"
|
|
||||||
redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"
|
|
||||||
|
|
||||||
oidc_issuer_url="http://dex.localtest.me:5556/dex"
|
|
||||||
provider="oidc"
|
|
||||||
provider_display_name="Dex"
|
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
http:
|
|
||||||
routers:
|
|
||||||
oauth2-proxy-route:
|
|
||||||
rule: "Host(`oauth2-proxy.oauth2-proxy.localhost`)"
|
|
||||||
middlewares:
|
|
||||||
- auth-headers
|
|
||||||
service: oauth-backend
|
|
||||||
httpbin-route:
|
|
||||||
rule: "Host(`httpbin.oauth2-proxy.localhost`)"
|
|
||||||
service: httpbin-service
|
|
||||||
middlewares:
|
|
||||||
- oauth-auth-redirect # redirects all unauthenticated to oauth2 signin
|
|
||||||
httpbin-route-2:
|
|
||||||
rule: "Host(`httpbin.oauth2-proxy.localhost`) && PathPrefix(`/no-auto-redirect`)"
|
|
||||||
service: httpbin-service
|
|
||||||
middlewares:
|
|
||||||
- oauth-auth-wo-redirect # unauthenticated session will return a 401
|
|
||||||
services-oauth2-route:
|
|
||||||
rule: "Host(`httpbin.oauth2-proxy.localhost`) && PathPrefix(`/oauth2/`)"
|
|
||||||
middlewares:
|
|
||||||
- auth-headers
|
|
||||||
service: oauth-backend
|
|
||||||
|
|
||||||
services:
|
|
||||||
httpbin-service:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://httpbin
|
|
||||||
oauth-backend:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://oauth2-proxy:4180
|
|
||||||
|
|
||||||
middlewares:
|
|
||||||
auth-headers:
|
|
||||||
headers:
|
|
||||||
stsSeconds: 315360000
|
|
||||||
browserXssFilter: true
|
|
||||||
contentTypeNosniff: true
|
|
||||||
forceSTSHeader: true
|
|
||||||
stsIncludeSubdomains: true
|
|
||||||
stsPreload: true
|
|
||||||
frameDeny: true
|
|
||||||
oauth-auth-redirect:
|
|
||||||
forwardAuth:
|
|
||||||
address: http://oauth2-proxy:4180
|
|
||||||
trustForwardHeader: true
|
|
||||||
authResponseHeaders:
|
|
||||||
- X-Auth-Request-Access-Token
|
|
||||||
- Authorization
|
|
||||||
oauth-auth-wo-redirect:
|
|
||||||
forwardAuth:
|
|
||||||
address: http://oauth2-proxy:4180/oauth2/auth
|
|
||||||
trustForwardHeader: true
|
|
||||||
authResponseHeaders:
|
|
||||||
- X-Auth-Request-Access-Token
|
|
||||||
- Authorization
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
api:
|
|
||||||
insecure: true
|
|
||||||
log:
|
|
||||||
level: INFO
|
|
||||||
providers:
|
|
||||||
file:
|
|
||||||
filename: /etc/traefik/dynamic.yaml
|
|
||||||
|
|
@ -1,108 +0,0 @@
|
||||||
## OAuth2 Proxy Config File
|
|
||||||
## https://github.com/oauth2-proxy/oauth2-proxy
|
|
||||||
|
|
||||||
## <addr>:<port> to listen on for HTTP/HTTPS clients
|
|
||||||
# http_address = "127.0.0.1:4180"
|
|
||||||
# https_address = ":443"
|
|
||||||
|
|
||||||
## Are we running behind a reverse proxy? Will not accept headers like X-Real-Ip unless this is set.
|
|
||||||
# reverse_proxy = true
|
|
||||||
|
|
||||||
## TLS Settings
|
|
||||||
# tls_cert_file = ""
|
|
||||||
# tls_key_file = ""
|
|
||||||
|
|
||||||
## the OAuth Redirect URL.
|
|
||||||
# defaults to the "https://" + requested host header + "/oauth2/callback"
|
|
||||||
# redirect_url = "https://internalapp.yourcompany.com/oauth2/callback"
|
|
||||||
|
|
||||||
## the http url(s) of the upstream endpoint. If multiple, routing is based on path
|
|
||||||
# upstreams = [
|
|
||||||
# "http://127.0.0.1:8080/"
|
|
||||||
# ]
|
|
||||||
|
|
||||||
## Logging configuration
|
|
||||||
#logging_filename = ""
|
|
||||||
#logging_max_size = 100
|
|
||||||
#logging_max_age = 7
|
|
||||||
#logging_local_time = true
|
|
||||||
#logging_compress = false
|
|
||||||
#standard_logging = true
|
|
||||||
#standard_logging_format = "[{{.Timestamp}}] [{{.File}}] {{.Message}}"
|
|
||||||
#request_logging = true
|
|
||||||
#request_logging_format = "{{.Client}} - {{.Username}} [{{.Timestamp}}] {{.Host}} {{.RequestMethod}} {{.Upstream}} {{.RequestURI}} {{.Protocol}} {{.UserAgent}} {{.StatusCode}} {{.ResponseSize}} {{.RequestDuration}}"
|
|
||||||
#auth_logging = true
|
|
||||||
#auth_logging_format = "{{.Client}} - {{.Username}} [{{.Timestamp}}] [{{.Status}}] {{.Message}}"
|
|
||||||
|
|
||||||
## pass HTTP Basic Auth, X-Forwarded-User and X-Forwarded-Email information to upstream
|
|
||||||
# pass_basic_auth = true
|
|
||||||
# pass_user_headers = true
|
|
||||||
## pass the request Host Header to upstream
|
|
||||||
## when disabled the upstream Host is used as the Host Header
|
|
||||||
# pass_host_header = true
|
|
||||||
|
|
||||||
## Email Domains to allow authentication for (this authorizes any email on this domain)
|
|
||||||
## for more granular authorization use `authenticated_emails_file`
|
|
||||||
## To authorize any email addresses use "*"
|
|
||||||
# email_domains = [
|
|
||||||
# "yourcompany.com"
|
|
||||||
# ]
|
|
||||||
|
|
||||||
## The OAuth Client ID, Secret
|
|
||||||
# client_id = "123456.apps.googleusercontent.com"
|
|
||||||
# client_secret = ""
|
|
||||||
|
|
||||||
## Scopes Added to the request
|
|
||||||
## It has the same behavior as the --scope flag
|
|
||||||
# scope = "openid email profile"
|
|
||||||
|
|
||||||
## Pass OAuth Access token to upstream via "X-Forwarded-Access-Token"
|
|
||||||
# pass_access_token = false
|
|
||||||
|
|
||||||
## Authenticated Email Addresses File (one email per line)
|
|
||||||
# authenticated_emails_file = ""
|
|
||||||
|
|
||||||
## Htpasswd File (optional)
|
|
||||||
## Additionally authenticate against a htpasswd file. Entries must be created with "htpasswd -B" for bcrypt encryption
|
|
||||||
## enabling exposes a username/login signin form
|
|
||||||
# htpasswd_file = ""
|
|
||||||
|
|
||||||
## bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods
|
|
||||||
# skip_auth_routes = [
|
|
||||||
# "GET=^/probe",
|
|
||||||
# "^/metrics"
|
|
||||||
# ]
|
|
||||||
|
|
||||||
## mark paths as API routes to get HTTP Status code 401 instead of redirect to login page
|
|
||||||
# api_routes = [
|
|
||||||
# "^/api"
|
|
||||||
# ]
|
|
||||||
|
|
||||||
## Templates
|
|
||||||
## optional directory with custom sign_in.html and error.html
|
|
||||||
# custom_templates_dir = ""
|
|
||||||
|
|
||||||
## skip SSL checking for HTTPS requests
|
|
||||||
# ssl_insecure_skip_verify = false
|
|
||||||
|
|
||||||
|
|
||||||
## Cookie Settings
|
|
||||||
## Name - the cookie name
|
|
||||||
## Secret - the seed string for secure cookies; should be 16, 24, or 32 bytes
|
|
||||||
## for use with an AES cipher when cookie_refresh or pass_access_token
|
|
||||||
## is set
|
|
||||||
## Domain - (optional) cookie domain to force cookies to (ie: .yourcompany.com)
|
|
||||||
## Expire - (duration) expire timeframe for cookie
|
|
||||||
## Refresh - (duration) refresh the cookie when duration has elapsed after cookie was initially set.
|
|
||||||
## Should be less than cookie_expire; set to 0 to disable.
|
|
||||||
## On refresh, OAuth token is re-validated.
|
|
||||||
## (ie: 1h means tokens are refreshed on request 1hr+ after it was set)
|
|
||||||
## Secure - secure cookies are only sent by the browser of a HTTPS connection (recommended)
|
|
||||||
## HttpOnly - httponly cookies are not readable by javascript (recommended)
|
|
||||||
# cookie_name = "_oauth2_proxy"
|
|
||||||
# cookie_secret = ""
|
|
||||||
# cookie_domains = ""
|
|
||||||
# cookie_expire = "168h"
|
|
||||||
# cookie_refresh = ""
|
|
||||||
# cookie_secure = true
|
|
||||||
# cookie_httponly = true
|
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
[Unit]
|
|
||||||
Description=oauth2-proxy daemon service
|
|
||||||
After=network.target network-online.target nss-lookup.target basic.target
|
|
||||||
Wants=network-online.target nss-lookup.target
|
|
||||||
StartLimitIntervalSec=30
|
|
||||||
StartLimitBurst=3
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
User=oauth2-proxy
|
|
||||||
Group=oauth2-proxy
|
|
||||||
Restart=on-failure
|
|
||||||
RestartSec=30
|
|
||||||
WorkingDirectory=/etc/oauth2-proxy
|
|
||||||
ExecStart=/usr/bin/oauth2-proxy --config=/etc/oauth2-proxy/oauth2-proxy.cfg
|
|
||||||
ExecReload=/bin/kill -HUP $MAINPID
|
|
||||||
LimitNOFILE=65535
|
|
||||||
NoNewPrivileges=true
|
|
||||||
ProtectHome=true
|
|
||||||
ProtectSystem=full
|
|
||||||
ProtectHostname=true
|
|
||||||
ProtectControlGroups=true
|
|
||||||
ProtectKernelModules=true
|
|
||||||
ProtectKernelTunables=true
|
|
||||||
LockPersonality=true
|
|
||||||
RestrictRealtime=yes
|
|
||||||
RestrictNamespaces=yes
|
|
||||||
MemoryDenyWriteExecute=yes
|
|
||||||
PrivateDevices=yes
|
|
||||||
PrivateTmp=true
|
|
||||||
CapabilityBoundingSet=
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
#
|
|
||||||
# Autocompletion for oauth2-proxy
|
|
||||||
#
|
|
||||||
# To install this, copy/move this file to /etc/bash.completion.d/
|
|
||||||
# or add a line to your ~/.bashrc | ~/.bash_profile that says ". /path/to/oauth2-proxy/contrib/oauth2-proxy_autocomplete.sh"
|
|
||||||
#
|
|
||||||
|
|
||||||
_oauth2_proxy() {
|
|
||||||
_oauth2_proxy_commands=$(oauth2-proxy -h 2>&1 | sed -n '/^\s*--/s/ \+/ /gp' | awk '{print $1}' | tr '\n' ' ')
|
|
||||||
local cur prev
|
|
||||||
COMPREPLY=()
|
|
||||||
cur="${COMP_WORDS[COMP_CWORD]}"
|
|
||||||
prev="${COMP_WORDS[COMP_CWORD-1]}"
|
|
||||||
case "$prev" in
|
|
||||||
--@(config|tls-cert-file|tls-key-file|authenticated-emails-file|htpasswd-file|custom-templates-dir|logging-filename|jwt-key-file))
|
|
||||||
_filedir
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
--provider)
|
|
||||||
COMPREPLY=( $(compgen -W "google azure facebook github keycloak gitlab linkedin login.gov digitalocean" -- ${cur}) )
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
--real-client-ip-header)
|
|
||||||
COMPREPLY=( $(compgen -W 'X-Real-IP X-Forwarded-For X-ProxyUser-IP' -- ${cur}) )
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
--@(http-address|https-address|redirect-url|upstream|basic-auth-password|skip-auth-regex|flush-interval|extra-jwt-issuers|email-domain|whitelist-domain|trusted-ip|keycloak-group|azure-tenant|bitbucket-team|bitbucket-repository|github-org|github-team|github-repo|github-token|gitlab-group|github-user|google-group|google-admin-email|google-service-account-json|client-id|client_secret|banner|footer|proxy-prefix|ping-path|ready-path|cookie-name|cookie-secret|cookie-domain|cookie-path|cookie-expire|cookie-refresh|cookie-samesite|redist-sentinel-master-name|redist-sentinel-connection-urls|redist-cluster-connection-urls|logging-max-size|logging-max-age|logging-max-backups|standard-logging-format|request-logging-format|exclude-logging-paths|auth-logging-format|oidc-issuer-url|oidc-jwks-url|login-url|redeem-url|profile-url|resource|validate-url|scope|approval-prompt|signature-key|acr-values|jwt-key|pubjwk-url|force-json-errors))
|
|
||||||
return 0
|
|
||||||
;;
|
|
||||||
esac
|
|
||||||
COMPREPLY=( $(compgen -W "${_oauth2_proxy_commands}" -- ${cur}) )
|
|
||||||
return 0;
|
|
||||||
}
|
|
||||||
complete -F _oauth2_proxy oauth2-proxy
|
|
||||||
|
|
@ -0,0 +1,61 @@
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"crypto/hmac"
|
||||||
|
"crypto/sha1"
|
||||||
|
"encoding/base64"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"strconv"
|
||||||
|
"strings"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func validateCookie(cookie *http.Cookie, seed string) (string, bool) {
|
||||||
|
// value, timestamp, sig
|
||||||
|
parts := strings.Split(cookie.Value, "|")
|
||||||
|
if len(parts) != 3 {
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
sig := cookieSignature(seed, cookie.Name, parts[0], parts[1])
|
||||||
|
if checkHmac(parts[2], sig) {
|
||||||
|
ts, err := strconv.Atoi(parts[1])
|
||||||
|
if err == nil && int64(ts) > time.Now().Add(time.Duration(24)*7*time.Hour*-1).Unix() {
|
||||||
|
// it's a valid cookie. now get the contents
|
||||||
|
rawValue, err := base64.URLEncoding.DecodeString(parts[0])
|
||||||
|
if err == nil {
|
||||||
|
return string(rawValue), true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return "", false
|
||||||
|
}
|
||||||
|
|
||||||
|
func signedCookieValue(seed string, key string, value string) string {
|
||||||
|
encodedValue := base64.URLEncoding.EncodeToString([]byte(value))
|
||||||
|
timeStr := fmt.Sprintf("%d", time.Now().Unix())
|
||||||
|
sig := cookieSignature(seed, key, encodedValue, timeStr)
|
||||||
|
cookieVal := fmt.Sprintf("%s|%s|%s", encodedValue, timeStr, sig)
|
||||||
|
return cookieVal
|
||||||
|
}
|
||||||
|
|
||||||
|
func cookieSignature(args ...string) string {
|
||||||
|
h := hmac.New(sha1.New, []byte(args[0]))
|
||||||
|
for _, arg := range args[1:] {
|
||||||
|
h.Write([]byte(arg))
|
||||||
|
}
|
||||||
|
var b []byte
|
||||||
|
b = h.Sum(b)
|
||||||
|
return base64.URLEncoding.EncodeToString(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
func checkHmac(input, expected string) bool {
|
||||||
|
inputMAC, err1 := base64.URLEncoding.DecodeString(input)
|
||||||
|
if err1 == nil {
|
||||||
|
expectedMAC, err2 := base64.URLEncoding.DecodeString(expected)
|
||||||
|
if err2 == nil {
|
||||||
|
return hmac.Equal(inputMAC, expectedMAC)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
75
dist.sh
75
dist.sh
|
|
@ -1,57 +1,30 @@
|
||||||
#!/usr/bin/env bash
|
#!/bin/bash
|
||||||
|
|
||||||
set -o errexit
|
# build binary distributions for linux/amd64 and darwin/amd64
|
||||||
|
set -e
|
||||||
|
|
||||||
if [[ -z ${BINARY} ]] || [[ -z ${VERSION} ]]; then
|
DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
||||||
echo "Missing required env var: BINARY=X VERSION=X $(basename $0)"
|
echo "working dir $DIR"
|
||||||
exit 1
|
mkdir -p $DIR/dist
|
||||||
fi
|
mkdir -p $DIR/.godeps
|
||||||
|
export GOPATH=$DIR/.godeps:$GOPATH
|
||||||
|
gpm install
|
||||||
|
|
||||||
ARCHS=(
|
os=$(go env GOOS)
|
||||||
darwin-amd64
|
arch=$(go env GOARCH)
|
||||||
darwin-arm64
|
version=$(cat $DIR/version.go | grep "const VERSION" | awk '{print $NF}' | sed 's/"//g')
|
||||||
linux-amd64
|
goversion=$(go version | awk '{print $3}')
|
||||||
linux-arm64
|
|
||||||
linux-armv5
|
|
||||||
linux-armv6
|
|
||||||
linux-armv7
|
|
||||||
linux-ppc64le
|
|
||||||
linux-s390x
|
|
||||||
freebsd-amd64
|
|
||||||
windows-amd64
|
|
||||||
)
|
|
||||||
|
|
||||||
mkdir -p release
|
echo "... running tests"
|
||||||
|
./test.sh || exit 1
|
||||||
|
|
||||||
# Create architecture specific release dirs
|
for os in linux darwin; do
|
||||||
for ARCH in "${ARCHS[@]}"; do
|
echo "... building v$version for $os/$arch"
|
||||||
mkdir -p release/${BINARY}-${VERSION}.${ARCH}
|
BUILD=$(mktemp -d -t google_auth_proxy)
|
||||||
|
TARGET="google_auth_proxy-$version.$os-$arch.$goversion"
|
||||||
GO_OS=$(echo $ARCH | awk -F- '{print $1}')
|
GOOS=$os GOARCH=$arch CGO_ENABLED=0 go build -o $BUILD/$TARGET/google_auth_proxy || exit 1
|
||||||
GO_ARCH=$(echo $ARCH | awk -F- '{print $2}')
|
pushd $BUILD
|
||||||
|
tar czvf $TARGET.tar.gz $TARGET
|
||||||
# Create architecture specific binaries
|
mv $TARGET.tar.gz $DIR/dist
|
||||||
if [[ ${GO_ARCH} == armv* ]]; then
|
popd
|
||||||
GO_ARM=$(echo $GO_ARCH | awk -Fv '{print $2}')
|
|
||||||
GO111MODULE=on GOOS=${GO_OS} GOARCH=arm GOARM=${GO_ARM} CGO_ENABLED=0 go build \
|
|
||||||
-ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" \
|
|
||||||
-o release/${BINARY}-${VERSION}.${ARCH}/${BINARY} .
|
|
||||||
else
|
|
||||||
GO111MODULE=on GOOS=${GO_OS} GOARCH=${GO_ARCH} CGO_ENABLED=0 go build \
|
|
||||||
-ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" \
|
|
||||||
-o release/${BINARY}-${VERSION}.${ARCH}/${BINARY} .
|
|
||||||
fi
|
|
||||||
|
|
||||||
cd release
|
|
||||||
|
|
||||||
# Create tar file for architecture specific binary
|
|
||||||
tar -czvf ${BINARY}-${VERSION}.${ARCH}.tar.gz ${BINARY}-${VERSION}.${ARCH}
|
|
||||||
|
|
||||||
# Create sha256sum for architecture-specific tar
|
|
||||||
sha256sum ${BINARY}-${VERSION}.${ARCH}.tar.gz > ${BINARY}-${VERSION}.${ARCH}.tar.gz-sha256sum.txt
|
|
||||||
|
|
||||||
# Create sha256sum for architecture specific binary
|
|
||||||
sha256sum ${BINARY}-${VERSION}.${ARCH}/${BINARY} > ${BINARY}-${VERSION}.${ARCH}-sha256sum.txt
|
|
||||||
|
|
||||||
cd ..
|
|
||||||
done
|
done
|
||||||
|
|
|
||||||
|
|
@ -1,23 +0,0 @@
|
||||||
# Dependencies
|
|
||||||
/node_modules
|
|
||||||
package-lock.json
|
|
||||||
pnpm-lock.yaml
|
|
||||||
yarn.lock
|
|
||||||
|
|
||||||
# Production
|
|
||||||
/build
|
|
||||||
|
|
||||||
# Generated files
|
|
||||||
.docusaurus
|
|
||||||
.cache-loader
|
|
||||||
|
|
||||||
# Misc
|
|
||||||
.DS_Store
|
|
||||||
.env.local
|
|
||||||
.env.development.local
|
|
||||||
.env.test.local
|
|
||||||
.env.production.local
|
|
||||||
|
|
||||||
npm-debug.log*
|
|
||||||
yarn-debug.log*
|
|
||||||
yarn-error.log*
|
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
# Website
|
|
||||||
|
|
||||||
This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```console
|
|
||||||
npm install
|
|
||||||
```
|
|
||||||
|
|
||||||
## Local Development
|
|
||||||
|
|
||||||
```console
|
|
||||||
npm start
|
|
||||||
```
|
|
||||||
|
|
||||||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
|
||||||
|
|
||||||
## Build
|
|
||||||
|
|
||||||
```console
|
|
||||||
npm run build
|
|
||||||
```
|
|
||||||
|
|
||||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
||||||
|
|
||||||
## Deployment
|
|
||||||
|
|
||||||
```console
|
|
||||||
GIT_USER=<Your GitHub username> USE_SSH=true npm deploy
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
|
||||||
|
|
@ -1,3 +0,0 @@
|
||||||
module.exports = {
|
|
||||||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
|
||||||
};
|
|
||||||
|
|
@ -1,11 +0,0 @@
|
||||||
---
|
|
||||||
id: behaviour
|
|
||||||
title: Behaviour
|
|
||||||
---
|
|
||||||
|
|
||||||
1. Any request passing through the proxy (and not matched by `--skip-auth-regex`) is checked for the proxy's session cookie (`--cookie-name`) (or, if allowed, a JWT token - see `--skip-jwt-bearer-tokens`).
|
|
||||||
2. If authentication is required but missing then the user is asked to log in and redirected to the authentication provider (unless it is an Ajax request, i.e. one with `Accept: application/json`, in which case 401 Unauthorized is returned)
|
|
||||||
3. After returning from the authentication provider, the oauth tokens are stored in the configured session store (cookie, redis, ...) and a cookie is set
|
|
||||||
4. The request is forwarded to the upstream server with added user info and authentication headers (depending on the configuration)
|
|
||||||
|
|
||||||
Notice that the proxy also provides a number of useful [endpoints](features/endpoints.md).
|
|
||||||
|
|
@ -1,91 +0,0 @@
|
||||||
---
|
|
||||||
id: contribution
|
|
||||||
title: Contribution Guide
|
|
||||||
---
|
|
||||||
|
|
||||||
We track bugs and issues using Github.
|
|
||||||
|
|
||||||
If you find a bug, please open an Issue. When opening an Issue or Pull Request please follow the preconfigured template and take special note of the checkboxes.
|
|
||||||
|
|
||||||
If you want to fix a bug, add a new feature or extend existing functionality, please create a fork, create a feature branch and open a PR back to this repo.
|
|
||||||
Please mention open bug issue number(s) within your PR if applicable.
|
|
||||||
|
|
||||||
We suggest using [Visual Studio Code](https://code.visualstudio.com/docs/languages/go) with the official [Go for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=golang.go) extension.
|
|
||||||
|
|
||||||
|
|
||||||
# Go version
|
|
||||||
|
|
||||||
See the `go.mod` file in the root of this repository for the version of Go used by this project.
|
|
||||||
You can follow [the installation guide for Go](https://go.dev/doc/install),
|
|
||||||
and you can find this specific Go version on [the Go downloads page](https://go.dev/dl/).
|
|
||||||
|
|
||||||
# Preparing your fork
|
|
||||||
Clone your fork, create a feature branch and update the depedencies to get started.
|
|
||||||
```bash
|
|
||||||
git clone git@github.com:<YOUR_FORK>/oauth2-proxy
|
|
||||||
cd oauth2-proxy
|
|
||||||
git branch feature/<BRANCH_NAME>
|
|
||||||
git push --set-upstream origin feature/<BRANCH_NAME>
|
|
||||||
go mod download
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
# Testing / Debugging
|
|
||||||
For starting oauth2-proxy locally open the debugging tab and create the `launch.json` and select `Go: Launch Package`.
|
|
||||||
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"version": "0.2.0",
|
|
||||||
"configurations": [
|
|
||||||
{
|
|
||||||
"name": "Launch OAuth2-Proxy with Dex",
|
|
||||||
"type": "go",
|
|
||||||
"request": "launch",
|
|
||||||
"mode": "auto",
|
|
||||||
"program": "${workspaceFolder}",
|
|
||||||
"args": [
|
|
||||||
"--config",
|
|
||||||
// The following configuration contains settings for a locally deployed
|
|
||||||
// upstream and dex as an idetity provider
|
|
||||||
"contrib/local-environment/oauth2-proxy.cfg"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"name": "Launch OAuth2-Proxy with Keycloak",
|
|
||||||
"type": "go",
|
|
||||||
"request": "launch",
|
|
||||||
"mode": "auto",
|
|
||||||
"program": "${workspaceFolder}",
|
|
||||||
"args": [
|
|
||||||
"--config",
|
|
||||||
// The following configuration contains settings for a locally deployed
|
|
||||||
// upstream and keycloak as an idetity provider
|
|
||||||
"contrib/local-environment/oauth2-proxy-keycloak.cfg"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Before you can start your local version of oauth2-proxy, you will have to use the provided docker compose files to start a local upstream service and identity provider. We suggest using [httpbin](https://hub.docker.com/r/kennethreitz/httpbin) as your upstream for testing as it allows for request and response introspection of all things HTTP.
|
|
||||||
|
|
||||||
Inside the `contrib/local-environment` directory you can use the `Makefile` for
|
|
||||||
starting different example setups:
|
|
||||||
|
|
||||||
- Dex as your IdP: `make up` or `make down`
|
|
||||||
- Dex as your IdP using the alpha-config: `make alpha-config-up`
|
|
||||||
- Keycloak as your IdP: `make keycloak-up`
|
|
||||||
- Dex as your IdP & nginx reverse proxy: `make nginx-up`
|
|
||||||
- and many more...
|
|
||||||
|
|
||||||
Check out the `Makefile` to see what is available.
|
|
||||||
|
|
||||||
The username and password for all setups is usually `admin@example.com` and `password`.
|
|
||||||
|
|
||||||
The docker compose setups expose the services with a dynamic reverse DNS resolver: localtest.me
|
|
||||||
|
|
||||||
- OAuth2-Proxy: http://oauth2-proxy.localtest.me:4180
|
|
||||||
- Upstream: http://httpbin.localtest.me:8080
|
|
||||||
- Dex: http://dex.localtest.me:5556
|
|
||||||
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
---
|
|
||||||
id: security
|
|
||||||
title: Security
|
|
||||||
---
|
|
||||||
|
|
||||||
:::note
|
|
||||||
OAuth2 Proxy is a community project.
|
|
||||||
Maintainers do not work on this project full time, and as such,
|
|
||||||
while we endeavour to respond to disclosures as quickly as possible,
|
|
||||||
this may take longer than in projects with corporate sponsorship.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Security Disclosures
|
|
||||||
|
|
||||||
:::important
|
|
||||||
If you believe you have found a vulnerability within OAuth2 Proxy or any of its
|
|
||||||
dependencies, please do NOT open an issue or PR on GitHub, please do NOT post
|
|
||||||
any details publicly.
|
|
||||||
:::
|
|
||||||
|
|
||||||
Security disclosures MUST be done in private.
|
|
||||||
If you have found an issue that you would like to bring to the attention of the
|
|
||||||
maintenance team for OAuth2 Proxy, please compose an email and send it to the
|
|
||||||
list of maintainers in our [MAINTAINERS](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/MAINTAINERS) file.
|
|
||||||
|
|
||||||
Please include as much detail as possible.
|
|
||||||
Ideally, your disclosure should include:
|
|
||||||
- A reproducible case that can be used to demonstrate the exploit
|
|
||||||
- How you discovered this vulnerability
|
|
||||||
- A potential fix for the issue (if you have thought of one)
|
|
||||||
- Versions affected (if not present in master)
|
|
||||||
- Your GitHub ID
|
|
||||||
|
|
||||||
### How will we respond to disclosures?
|
|
||||||
|
|
||||||
We use [GitHub Security Advisories](https://docs.github.com/en/github/managing-security-vulnerabilities/about-github-security-advisories)
|
|
||||||
to privately discuss fixes for disclosed vulnerabilities.
|
|
||||||
If you include a GitHub ID with your disclosure we will add you as a collaborator
|
|
||||||
for the advisory so that you can join the discussion and validate any fixes
|
|
||||||
we may propose.
|
|
||||||
|
|
||||||
For minor issues and previously disclosed vulnerabilities (typically for
|
|
||||||
dependencies), we may use regular PRs for fixes and forego the security advisory.
|
|
||||||
|
|
||||||
Once a fix has been agreed upon, we will merge the fix and create a new release.
|
|
||||||
If we have multiple security issues in flight simultaneously, we may delay
|
|
||||||
merging fixes until all patches are ready.
|
|
||||||
We may also backport the fix to previous releases,
|
|
||||||
but this will be at the discretion of the maintainers.
|
|
||||||
|
|
@ -1,565 +0,0 @@
|
||||||
---
|
|
||||||
id: alpha-config
|
|
||||||
title: Alpha Configuration
|
|
||||||
---
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
This page contains documentation for alpha features.
|
|
||||||
We reserve the right to make breaking changes to the features detailed within this page with no notice.
|
|
||||||
|
|
||||||
Options described in this page may be changed, removed, renamed or moved without prior warning.
|
|
||||||
Please beware of this before you use alpha configuration options.
|
|
||||||
:::
|
|
||||||
|
|
||||||
This page details a set of **alpha** configuration options in a new format.
|
|
||||||
Going forward we are intending to add structured configuration in YAML format to
|
|
||||||
replace the existing TOML based configuration file and flags.
|
|
||||||
|
|
||||||
Below is a reference for the structure of the configuration, with
|
|
||||||
[AlphaOptions](#alphaoptions) as the root of the configuration.
|
|
||||||
|
|
||||||
When using alpha configuration, your config file will look something like below:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
upstreams:
|
|
||||||
- id: ...
|
|
||||||
...: ...
|
|
||||||
injectRequestHeaders:
|
|
||||||
- name: ...
|
|
||||||
...: ...
|
|
||||||
injectResponseHeaders:
|
|
||||||
- name: ...
|
|
||||||
...: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
Please browse the [reference](#configuration-reference) below for the structure
|
|
||||||
of the new configuration format.
|
|
||||||
|
|
||||||
## Using Alpha Configuration
|
|
||||||
|
|
||||||
To use the new **alpha** configuration, generate a YAML file based on the format
|
|
||||||
described in the [reference](#configuration-reference) below.
|
|
||||||
|
|
||||||
Provide the path to this file using the `--alpha-config` flag.
|
|
||||||
|
|
||||||
:::note
|
|
||||||
When using the `--alpha-config` flag, some options are no longer available.
|
|
||||||
See [removed options](#removed-options) below for more information.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Converting configuration to the new structure
|
|
||||||
|
|
||||||
Before adding the new `--alpha-config` option, start OAuth2 Proxy using the
|
|
||||||
`convert-config-to-alpha` flag to convert existing configuration to the new format.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
oauth2-proxy --convert-config-to-alpha --config ./path/to/existing/config.cfg
|
|
||||||
```
|
|
||||||
|
|
||||||
This will convert any options supported by the new format to YAML and print the
|
|
||||||
new configuration to `STDOUT`.
|
|
||||||
|
|
||||||
Copy this to a new file, remove any options from your existing configuration
|
|
||||||
noted in [removed options](#removed-options) and then start OAuth2 Proxy using
|
|
||||||
the new config.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg
|
|
||||||
```
|
|
||||||
|
|
||||||
## Using ENV variables in the alpha configuration
|
|
||||||
|
|
||||||
The alpha package supports the use of environment variables in place of yaml keys, allowing sensitive values to be pulled from somewhere other than the yaml file.
|
|
||||||
When using environment variables, your yaml will look like this:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
providers:
|
|
||||||
- provider: azure
|
|
||||||
clientSecret: ${CLIENT_SECRET}
|
|
||||||
...
|
|
||||||
```
|
|
||||||
Where CLIENT_SECRET is an environment variable.
|
|
||||||
More information and available patterns can be found [here](https://github.com/a8m/envsubst#docs)
|
|
||||||
|
|
||||||
## Removed options
|
|
||||||
|
|
||||||
The following flags/options and their respective environment variables are no
|
|
||||||
longer available when using alpha configuration:
|
|
||||||
|
|
||||||
<!-- Legacy Upstream FlagSet -->
|
|
||||||
- `flush-interval`/`flush_interval`
|
|
||||||
- `pass-host-header`/`pass_host_header`
|
|
||||||
- `proxy-websockets`/`proxy_websockets`
|
|
||||||
- `ssl-upstream-insecure-skip-verify`/`ssl_upstream_insecure_skip_verify`
|
|
||||||
- `upstream`/`upstreams`
|
|
||||||
|
|
||||||
<!-- Legacy Headers FlagSet -->
|
|
||||||
- `pass-basic-auth`/`pass_basic_auth`
|
|
||||||
- `pass-access-token`/`pass_access_token`
|
|
||||||
- `pass-user-headers`/`pass_user_headers`
|
|
||||||
- `pass-authorization-header`/`pass_authorization_header`
|
|
||||||
- `set-basic-auth`/`set_basic_auth`
|
|
||||||
- `set-xauthrequest`/`set_xauthrequest`
|
|
||||||
- `set-authorization-header`/`set_authorization_header`
|
|
||||||
- `prefer-email-to-user`/`prefer_email_to_user`
|
|
||||||
- `basic-auth-password`/`basic_auth_password`
|
|
||||||
- `skip-auth-strip-headers`/`skip_auth_strip_headers`
|
|
||||||
|
|
||||||
<!-- Legacy provider FlagSet -->
|
|
||||||
- `client-id`/`client_id`
|
|
||||||
- `client-secret`/`client_secret`, and `client-secret-file`/`client_secret_file`
|
|
||||||
- `provider`
|
|
||||||
- `provider-display-name`/`provider_display_name`
|
|
||||||
- `provider-ca-file`/`provider_ca_files`
|
|
||||||
- `login-url`/`login_url`
|
|
||||||
- `redeem-url`/`redeem_url`
|
|
||||||
- `profile-url`/`profile_url`
|
|
||||||
- `resource`
|
|
||||||
- `validate-url`/`validate_url`
|
|
||||||
- `scope`
|
|
||||||
- `prompt`
|
|
||||||
- `approval-prompt`/`approval_prompt`
|
|
||||||
- `acr-values`/`acr_values`
|
|
||||||
- `user-id-claim`/`user_id_claim`
|
|
||||||
- `allowed-group`/`allowed_groups`
|
|
||||||
- `allowed-role`/`allowed_roles`
|
|
||||||
- `jwt-key`/`jwt_key`
|
|
||||||
- `jwt-key-file`/`jwt_key_file`
|
|
||||||
- `pubjwk-url`/`pubjwk_url`
|
|
||||||
|
|
||||||
and all provider-specific options, i.e. any option whose name includes `oidc`,
|
|
||||||
`azure`, `bitbucket`, `github`, `gitlab`, `google` or `keycloak`. Attempting to
|
|
||||||
use any of these options via flags or via config when `--alpha-config` is
|
|
||||||
set will result in an error.
|
|
||||||
|
|
||||||
:::important
|
|
||||||
You must remove these options before starting OAuth2 Proxy with `--alpha-config`
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Configuration Reference
|
|
||||||
|
|
||||||
<!--- THIS FILE IS AUTOGENERATED!!! DO NOT EDIT!!! -->
|
|
||||||
|
|
||||||
### ADFSOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `skipScope` | _bool_ | Skip adding the scope parameter in login request<br/>Default value is 'false' |
|
|
||||||
|
|
||||||
### AlphaOptions
|
|
||||||
|
|
||||||
AlphaOptions contains alpha structured configuration options.
|
|
||||||
Usage of these options allows users to access alpha features that are not
|
|
||||||
available as part of the primary configuration structure for OAuth2 Proxy.
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
The options within this structure are considered alpha.
|
|
||||||
They may change between releases without notice.
|
|
||||||
:::
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `upstreamConfig` | _[UpstreamConfig](#upstreamconfig)_ | UpstreamConfig is used to configure upstream servers.<br/>Once a user is authenticated, requests to the server will be proxied to<br/>these upstream servers based on the path mappings defined in this list. |
|
|
||||||
| `injectRequestHeaders` | _[[]Header](#header)_ | InjectRequestHeaders is used to configure headers that should be added<br/>to requests to upstream servers.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
|
|
||||||
| `injectResponseHeaders` | _[[]Header](#header)_ | InjectResponseHeaders is used to configure headers that should be added<br/>to responses from the proxy.<br/>This is typically used when using the proxy as an external authentication<br/>provider in conjunction with another proxy such as NGINX and its<br/>auth_request module.<br/>Headers may source values from either the authenticated user's session<br/>or from a static secret value. |
|
|
||||||
| `server` | _[Server](#server)_ | Server is used to configure the HTTP(S) server for the proxy application.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
|
|
||||||
| `metricsServer` | _[Server](#server)_ | MetricsServer is used to configure the HTTP(S) server for metrics.<br/>You may choose to run both HTTP and HTTPS servers simultaneously.<br/>This can be done by setting the BindAddress and the SecureBindAddress simultaneously.<br/>To use the secure server you must configure a TLS certificate and key. |
|
|
||||||
| `providers` | _[Providers](#providers)_ | Providers is used to configure your provider. **Multiple-providers is not<br/>yet working.** [This feature is tracked in<br/>#925](https://github.com/oauth2-proxy/oauth2-proxy/issues/926) |
|
|
||||||
|
|
||||||
### AzureOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `tenant` | _string_ | Tenant directs to a tenant-specific or common (tenant-independent) endpoint<br/>Default value is 'common' |
|
|
||||||
| `graphGroupField` | _string_ | GraphGroupField configures the group field to be used when building the groups list from Microsoft Graph<br/>Default value is 'id' |
|
|
||||||
|
|
||||||
### BitbucketOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `team` | _string_ | Team sets restrict logins to members of this team |
|
|
||||||
| `repository` | _string_ | Repository sets restrict logins to user with access to this repository |
|
|
||||||
|
|
||||||
### ClaimSource
|
|
||||||
|
|
||||||
(**Appears on:** [HeaderValue](#headervalue))
|
|
||||||
|
|
||||||
ClaimSource allows loading a header value from a claim within the session
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. Available claims: `access_token` `id_token` `created_at`<br/>`expires_on` `refresh_token` `email` `user` `groups` `preferred_username`. |
|
|
||||||
| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |
|
|
||||||
| `basicAuthPassword` | _[SecretSource](#secretsource)_ | BasicAuthPassword converts this claim into a basic auth header.<br/>Note the value of claim will become the basic auth username and the<br/>basicAuthPassword will be used as the password value. |
|
|
||||||
|
|
||||||
### Duration
|
|
||||||
#### (`string` alias)
|
|
||||||
|
|
||||||
(**Appears on:** [Upstream](#upstream))
|
|
||||||
|
|
||||||
Duration is as string representation of a period of time.
|
|
||||||
A duration string is a is a possibly signed sequence of decimal numbers,
|
|
||||||
each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".
|
|
||||||
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
|
|
||||||
|
|
||||||
### GitHubOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `org` | _string_ | Org sets restrict logins to members of this organisation |
|
|
||||||
| `team` | _string_ | Team sets restrict logins to members of this team |
|
|
||||||
| `repo` | _string_ | Repo sets restrict logins to collaborators of this repository |
|
|
||||||
| `token` | _string_ | Token is the token to use when verifying repository collaborators<br/>it must have push access to the repository |
|
|
||||||
| `users` | _[]string_ | Users allows users with these usernames to login<br/>even if they do not belong to the specified org and team or collaborators |
|
|
||||||
|
|
||||||
### GitLabOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `group` | _[]string_ | Group sets restrict logins to members of this group |
|
|
||||||
| `projects` | _[]string_ | Projects restricts logins to members of these projects |
|
|
||||||
|
|
||||||
### GoogleOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `group` | _[]string_ | Groups sets restrict logins to members of this Google group |
|
|
||||||
| `adminEmail` | _string_ | AdminEmail is the Google admin to impersonate for api calls |
|
|
||||||
| `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 |
|
|
||||||
| `targetPrincipal` | _string_ | TargetPrincipal is the Google Service Account used for Application Default Credentials |
|
|
||||||
|
|
||||||
### Header
|
|
||||||
|
|
||||||
(**Appears on:** [AlphaOptions](#alphaoptions))
|
|
||||||
|
|
||||||
Header represents an individual header that will be added to a request or
|
|
||||||
response header.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `name` | _string_ | Name is the header name to be used for this set of values.<br/>Names should be unique within a list of Headers. |
|
|
||||||
| `preserveRequestValue` | _bool_ | PreserveRequestValue determines whether any values for this header<br/>should be preserved for the request to the upstream server.<br/>This option only applies to injected request headers.<br/>Defaults to false (headers that match this header will be stripped). |
|
|
||||||
| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |
|
|
||||||
|
|
||||||
### HeaderValue
|
|
||||||
|
|
||||||
(**Appears on:** [Header](#header))
|
|
||||||
|
|
||||||
HeaderValue represents a single header value and the sources that can
|
|
||||||
make up the header value
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `value` | _[]byte_ | Value expects a base64 encoded string value. |
|
|
||||||
| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
|
|
||||||
| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
|
|
||||||
| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. Available claims: `access_token` `id_token` `created_at`<br/>`expires_on` `refresh_token` `email` `user` `groups` `preferred_username`. |
|
|
||||||
| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |
|
|
||||||
| `basicAuthPassword` | _[SecretSource](#secretsource)_ | BasicAuthPassword converts this claim into a basic auth header.<br/>Note the value of claim will become the basic auth username and the<br/>basicAuthPassword will be used as the password value. |
|
|
||||||
|
|
||||||
### KeycloakOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `groups` | _[]string_ | Group enables to restrict login to members of indicated group |
|
|
||||||
| `roles` | _[]string_ | Role enables to restrict login to users with role (only available when using the keycloak-oidc provider) |
|
|
||||||
|
|
||||||
### LoginGovOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `jwtKey` | _string_ | JWTKey is a private key in PEM format used to sign JWT, |
|
|
||||||
| `jwtKeyFile` | _string_ | JWTKeyFile is a path to the private key file in PEM format used to sign the JWT |
|
|
||||||
| `pubjwkURL` | _string_ | PubJWKURL is the JWK pubkey access endpoint |
|
|
||||||
|
|
||||||
### LoginURLParameter
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
LoginURLParameter is the configuration for a single query parameter that
|
|
||||||
can be passed through from the `/oauth2/start` endpoint to the IdP login
|
|
||||||
URL. The "default" option specifies the default value or values (if any)
|
|
||||||
that will be passed to the IdP for this parameter, and "allow" is a list
|
|
||||||
of options for ways in which this parameter can be set or overridden via
|
|
||||||
the query string to `/oauth2/start`.
|
|
||||||
If _only_ a default is specified and no "allow" then the parameter is
|
|
||||||
effectively fixed - the default value will always be used and anything
|
|
||||||
passed to the start URL will be ignored. If _only_ "allow" is specified
|
|
||||||
but no default then the parameter will only be passed on to the IdP if
|
|
||||||
the caller provides it, and no value will be sent otherwise.
|
|
||||||
|
|
||||||
Examples:
|
|
||||||
|
|
||||||
# A parameter whose value is fixed
|
|
||||||
|
|
||||||
```
|
|
||||||
name: organization
|
|
||||||
default:
|
|
||||||
- myorg
|
|
||||||
```
|
|
||||||
|
|
||||||
A parameter that is not passed by default, but may be set to one of a
|
|
||||||
fixed set of values
|
|
||||||
|
|
||||||
```
|
|
||||||
name: prompt
|
|
||||||
allow:
|
|
||||||
- value: login
|
|
||||||
- value: consent
|
|
||||||
- value: select_account
|
|
||||||
```
|
|
||||||
|
|
||||||
A parameter that is passed by default but may be overridden by one of
|
|
||||||
a fixed set of values
|
|
||||||
|
|
||||||
```
|
|
||||||
name: prompt
|
|
||||||
default: ["login"]
|
|
||||||
allow:
|
|
||||||
- value: consent
|
|
||||||
- value: select_account
|
|
||||||
```
|
|
||||||
|
|
||||||
A parameter that may be overridden, but only by values that match a
|
|
||||||
regular expression. For example to restrict `login_hint` to email
|
|
||||||
addresses in your organization's domain:
|
|
||||||
|
|
||||||
```
|
|
||||||
name: login_hint
|
|
||||||
allow:
|
|
||||||
- pattern: '^[^@]*@example\.com$'
|
|
||||||
# this allows at most one "@" sign, and requires "example.com" domain.
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that the YAML rules around exactly which characters are allowed
|
|
||||||
and/or require escaping in different types of string literals are
|
|
||||||
convoluted. For regular expressions the single quoted form is simplest
|
|
||||||
as backslash is not considered to be an escape character. Alternatively
|
|
||||||
use the "chomped block" format `|-`:
|
|
||||||
|
|
||||||
```
|
|
||||||
- pattern: |-
|
|
||||||
^[^@]*@example\.com$
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
||||||
The hyphen is important, a `|` block would have a trailing newline
|
|
||||||
character.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `name` | _string_ | Name specifies the name of the query parameter. |
|
|
||||||
| `default` | _[]string_ | _(Optional)_ Default specifies a default value or values that will be<br/>passed to the IdP if not overridden. |
|
|
||||||
| `allow` | _[[]URLParameterRule](#urlparameterrule)_ | _(Optional)_ Allow specifies rules about how the default (if any) may be<br/>overridden via the query string to `/oauth2/start`. Only<br/>values that match one or more of the allow rules will be<br/>forwarded to the IdP. |
|
|
||||||
|
|
||||||
### MicrosoftEntraIDOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `allowedTenants` | _[]string_ | AllowedTenants is a list of allowed tenants. In case of multi-tenant apps, incoming tokens are<br/>issued by different issuers and OIDC issuer verification needs to be disabled.<br/>When not specified, all tenants are allowed. Redundant for single-tenant apps<br/>(regular ID token validation matches the issuer). |
|
|
||||||
| `federatedTokenAuth` | _bool_ | FederatedTokenAuth enable oAuth2 client authentication with federated token projected<br/>by Entra Workload Identity plugin, instead of client secret. |
|
|
||||||
|
|
||||||
### OIDCOptions
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `issuerURL` | _string_ | IssuerURL is the OpenID Connect issuer URL<br/>eg: https://accounts.google.com |
|
|
||||||
| `insecureAllowUnverifiedEmail` | _bool_ | InsecureAllowUnverifiedEmail prevents failures if an email address in an id_token is not verified<br/>default set to 'false' |
|
|
||||||
| `insecureSkipIssuerVerification` | _bool_ | InsecureSkipIssuerVerification skips verification of ID token issuers. When false, ID Token Issuers must match the OIDC discovery URL<br/>default set to 'false' |
|
|
||||||
| `insecureSkipNonce` | _bool_ | InsecureSkipNonce skips verifying the ID Token's nonce claim that must match<br/>the random nonce sent in the initial OAuth flow. Otherwise, the nonce is checked<br/>after the initial OAuth redeem & subsequent token refreshes.<br/>default set to 'true'<br/>Warning: In a future release, this will change to 'false' by default for enhanced security. |
|
|
||||||
| `skipDiscovery` | _bool_ | SkipDiscovery allows to skip OIDC discovery and use manually supplied Endpoints<br/>default set to 'false' |
|
|
||||||
| `jwksURL` | _string_ | JwksURL is the OpenID Connect JWKS URL<br/>eg: https://www.googleapis.com/oauth2/v3/certs |
|
|
||||||
| `publicKeyFiles` | _[]string_ | PublicKeyFiles is a list of paths pointing to public key files in PEM format to use<br/>for verifying JWT tokens |
|
|
||||||
| `emailClaim` | _string_ | EmailClaim indicates which claim contains the user email,<br/>default set to 'email' |
|
|
||||||
| `groupsClaim` | _string_ | GroupsClaim indicates which claim contains the user groups<br/>default set to 'groups' |
|
|
||||||
| `userIDClaim` | _string_ | UserIDClaim indicates which claim contains the user ID<br/>default set to 'email' |
|
|
||||||
| `audienceClaims` | _[]string_ | AudienceClaim allows to define any claim that is verified against the client id<br/>By default `aud` claim is used for verification. |
|
|
||||||
| `extraAudiences` | _[]string_ | ExtraAudiences is a list of additional audiences that are allowed<br/>to pass verification in addition to the client id. |
|
|
||||||
|
|
||||||
### Provider
|
|
||||||
|
|
||||||
(**Appears on:** [Providers](#providers))
|
|
||||||
|
|
||||||
Provider holds all configuration for a single provider
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `clientID` | _string_ | ClientID is the OAuth Client ID that is defined in the provider<br/>This value is required for all providers. |
|
|
||||||
| `clientSecret` | _string_ | ClientSecret is the OAuth Client Secret that is defined in the provider<br/>This value is required for all providers. |
|
|
||||||
| `clientSecretFile` | _string_ | ClientSecretFile is the name of the file<br/>containing the OAuth Client Secret, it will be used if ClientSecret is not set. |
|
|
||||||
| `keycloakConfig` | _[KeycloakOptions](#keycloakoptions)_ | KeycloakConfig holds all configurations for Keycloak provider. |
|
|
||||||
| `azureConfig` | _[AzureOptions](#azureoptions)_ | AzureConfig holds all configurations for Azure provider. |
|
|
||||||
| `microsoftEntraIDConfig` | _[MicrosoftEntraIDOptions](#microsoftentraidoptions)_ | MicrosoftEntraIDConfig holds all configurations for Entra ID provider. |
|
|
||||||
| `ADFSConfig` | _[ADFSOptions](#adfsoptions)_ | ADFSConfig holds all configurations for ADFS provider. |
|
|
||||||
| `bitbucketConfig` | _[BitbucketOptions](#bitbucketoptions)_ | BitbucketConfig holds all configurations for Bitbucket provider. |
|
|
||||||
| `githubConfig` | _[GitHubOptions](#githuboptions)_ | GitHubConfig holds all configurations for GitHubC provider. |
|
|
||||||
| `gitlabConfig` | _[GitLabOptions](#gitlaboptions)_ | GitLabConfig holds all configurations for GitLab provider. |
|
|
||||||
| `googleConfig` | _[GoogleOptions](#googleoptions)_ | GoogleConfig holds all configurations for Google provider. |
|
|
||||||
| `oidcConfig` | _[OIDCOptions](#oidcoptions)_ | OIDCConfig holds all configurations for OIDC provider<br/>or providers utilize OIDC configurations. |
|
|
||||||
| `loginGovConfig` | _[LoginGovOptions](#logingovoptions)_ | LoginGovConfig holds all configurations for LoginGov provider. |
|
|
||||||
| `id` | _string_ | ID should be a unique identifier for the provider.<br/>This value is required for all providers. |
|
|
||||||
| `provider` | _[ProviderType](#providertype)_ | Type is the OAuth provider<br/>must be set from the supported providers group,<br/>otherwise 'Google' is set as default |
|
|
||||||
| `name` | _string_ | Name is the providers display name<br/>if set, it will be shown to the users in the login page. |
|
|
||||||
| `caFiles` | _[]string_ | CAFiles is a list of paths to CA certificates that should be used when connecting to the provider.<br/>If not specified, the default Go trust sources are used instead |
|
|
||||||
| `useSystemTrustStore` | _bool_ | UseSystemTrustStore determines if your custom CA files and the system trust store are used<br/>If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files. |
|
|
||||||
| `loginURL` | _string_ | LoginURL is the authentication endpoint |
|
|
||||||
| `loginURLParameters` | _[[]LoginURLParameter](#loginurlparameter)_ | LoginURLParameters defines the parameters that can be passed from the start URL to the IdP login URL |
|
|
||||||
| `authRequestResponseMode` | _string_ | AuthRequestResponseMode defines the response mode to request during authorization request |
|
|
||||||
| `redeemURL` | _string_ | RedeemURL is the token redemption endpoint |
|
|
||||||
| `profileURL` | _string_ | ProfileURL is the profile access endpoint |
|
|
||||||
| `skipClaimsFromProfileURL` | _bool_ | SkipClaimsFromProfileURL allows to skip request to Profile URL for resolving claims not present in id_token<br/>default set to 'false' |
|
|
||||||
| `resource` | _string_ | ProtectedResource is the resource that is protected (Azure AD and ADFS only) |
|
|
||||||
| `validateURL` | _string_ | ValidateURL is the access token validation endpoint |
|
|
||||||
| `scope` | _string_ | Scope is the OAuth scope specification |
|
|
||||||
| `allowedGroups` | _[]string_ | AllowedGroups is a list of restrict logins to members of this group |
|
|
||||||
| `code_challenge_method` | _string_ | The code challenge method |
|
|
||||||
| `backendLogoutURL` | _string_ | URL to call to perform backend logout, `{id_token}` would be replaced by the actual `id_token` if available in the session |
|
|
||||||
|
|
||||||
### ProviderType
|
|
||||||
#### (`string` alias)
|
|
||||||
|
|
||||||
(**Appears on:** [Provider](#provider))
|
|
||||||
|
|
||||||
ProviderType is used to enumerate the different provider type options
|
|
||||||
Valid options are: adfs, azure, bitbucket, digitalocean facebook, github,
|
|
||||||
gitlab, google, keycloak, keycloak-oidc, linkedin, login.gov, nextcloud
|
|
||||||
and oidc.
|
|
||||||
|
|
||||||
### Providers
|
|
||||||
|
|
||||||
#### ([[]Provider](#provider) alias)
|
|
||||||
|
|
||||||
(**Appears on:** [AlphaOptions](#alphaoptions))
|
|
||||||
|
|
||||||
The provider can be selected using the `provider` configuration value, or
|
|
||||||
set in the [`providers` array using
|
|
||||||
AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).
|
|
||||||
However, [**the feature to implement multiple providers is not
|
|
||||||
complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
|
|
||||||
|
|
||||||
### SecretSource
|
|
||||||
|
|
||||||
(**Appears on:** [ClaimSource](#claimsource), [HeaderValue](#headervalue), [TLS](#tls))
|
|
||||||
|
|
||||||
SecretSource references an individual secret value.
|
|
||||||
Only one source within the struct should be defined at any time.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `value` | _[]byte_ | Value expects a base64 encoded string value. |
|
|
||||||
| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |
|
|
||||||
| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |
|
|
||||||
|
|
||||||
### Server
|
|
||||||
|
|
||||||
(**Appears on:** [AlphaOptions](#alphaoptions))
|
|
||||||
|
|
||||||
Server represents the configuration for an HTTP(S) server
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `BindAddress` | _string_ | BindAddress is the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. |
|
|
||||||
| `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. |
|
|
||||||
| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic and further configuration for the TLS server. |
|
|
||||||
|
|
||||||
### TLS
|
|
||||||
|
|
||||||
(**Appears on:** [Server](#server))
|
|
||||||
|
|
||||||
TLS contains the information for loading a TLS certificate and key
|
|
||||||
as well as an optional minimal TLS version that is acceptable.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use.<br/>Typically this will come from a file. |
|
|
||||||
| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |
|
|
||||||
| `MinVersion` | _string_ | MinVersion is the minimal TLS version that is acceptable.<br/>E.g. Set to "TLS1.3" to select TLS version 1.3 |
|
|
||||||
| `CipherSuites` | _[]string_ | CipherSuites is a list of TLS cipher suites that are allowed.<br/>E.g.:<br/>- TLS_RSA_WITH_RC4_128_SHA<br/>- TLS_RSA_WITH_AES_256_GCM_SHA384<br/>If not specified, the default Go safe cipher list is used.<br/>List of valid cipher suites can be found in the [crypto/tls documentation](https://pkg.go.dev/crypto/tls#pkg-constants). |
|
|
||||||
|
|
||||||
### URLParameterRule
|
|
||||||
|
|
||||||
(**Appears on:** [LoginURLParameter](#loginurlparameter))
|
|
||||||
|
|
||||||
URLParameterRule represents a rule by which query parameters
|
|
||||||
passed to the `/oauth2/start` endpoint are checked to determine whether
|
|
||||||
they are valid overrides for the given parameter passed to the IdP's
|
|
||||||
login URL. Either Value or Pattern should be supplied, not both.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `value` | _string_ | A Value rule matches just this specific value |
|
|
||||||
| `pattern` | _string_ | A Pattern rule gives a regular expression that must be matched by<br/>some substring of the value. The expression is _not_ automatically<br/>anchored to the start and end of the value, if you _want_ to restrict<br/>the whole parameter value you must anchor it yourself with `^` and `$`. |
|
|
||||||
|
|
||||||
### Upstream
|
|
||||||
|
|
||||||
(**Appears on:** [UpstreamConfig](#upstreamconfig))
|
|
||||||
|
|
||||||
Upstream represents the configuration for an upstream server.
|
|
||||||
Requests will be proxied to this upstream if the path matches the request path.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `id` | _string_ | ID should be a unique identifier for the upstream.<br/>This value is required for all upstreams. |
|
|
||||||
| `path` | _string_ | Path is used to map requests to the upstream server.<br/>The closest match will take precedence and all Paths must be unique.<br/>Path can also take a pattern when used with RewriteTarget.<br/>Path segments can be captured and matched using regular experessions.<br/>Eg:<br/>- `^/foo$`: Match only the explicit path `/foo`<br/>- `^/bar/$`: Match any path prefixed with `/bar/`<br/>- `^/baz/(.*)$`: Match any path prefixed with `/baz` and capture the remaining path for use with RewriteTarget |
|
|
||||||
| `rewriteTarget` | _string_ | RewriteTarget allows users to rewrite the request path before it is sent to<br/>the upstream server (for an HTTP/HTTPS upstream) or mapped to the filesystem<br/>(for a `file:` upstream).<br/>Use the Path to capture segments for reuse within the rewrite target.<br/>Eg: With a Path of `^/baz/(.*)`, a RewriteTarget of `/foo/$1` would rewrite<br/>the request `/baz/abc/123` to `/foo/abc/123` before proxying to the<br/>upstream server. Or if the upstream were `file:///app`, a request for<br/>`/baz/info.html` would return the contents of the file `/app/foo/info.html`. |
|
|
||||||
| `uri` | _string_ | The URI of the upstream server. This may be an HTTP(S) server of a File<br/>based URL. It may include a path, in which case all requests will be served<br/>under that path.<br/>Eg:<br/>- http://localhost:8080<br/>- https://service.localhost<br/>- https://service.localhost/path<br/>- file://host/path<br/>If the URI's path is "/base" and the incoming request was for "/dir",<br/>the upstream request will be for "/base/dir". |
|
|
||||||
| `insecureSkipTLSVerify` | _bool_ | InsecureSkipTLSVerify will skip TLS verification of upstream HTTPS hosts.<br/>This option is insecure and will allow potential Man-In-The-Middle attacks<br/>between OAuth2 Proxy and the upstream server.<br/>Defaults to false. |
|
|
||||||
| `static` | _bool_ | Static will make all requests to this upstream have a static response.<br/>The response will have a body of "Authenticated" and a response code<br/>matching StaticCode.<br/>If StaticCode is not set, the response will return a 200 response. |
|
|
||||||
| `staticCode` | _int_ | StaticCode determines the response code for the Static response.<br/>This option can only be used with Static enabled. |
|
|
||||||
| `flushInterval` | _[Duration](#duration)_ | FlushInterval is the period between flushing the response buffer when<br/>streaming response from the upstream.<br/>Defaults to 1 second. |
|
|
||||||
| `passHostHeader` | _bool_ | PassHostHeader determines whether the request host header should be proxied<br/>to the upstream server.<br/>Defaults to true. |
|
|
||||||
| `proxyWebSockets` | _bool_ | ProxyWebSockets enables proxying of websockets to upstream servers<br/>Defaults to true. |
|
|
||||||
| `timeout` | _[Duration](#duration)_ | Timeout is the maximum duration the server will wait for a response from the upstream server.<br/>Defaults to 30 seconds. |
|
|
||||||
| `disableKeepAlives` | _bool_ | DisableKeepAlives disables HTTP keep-alive connections to the upstream server.<br/>Defaults to false. |
|
|
||||||
|
|
||||||
### UpstreamConfig
|
|
||||||
|
|
||||||
(**Appears on:** [AlphaOptions](#alphaoptions))
|
|
||||||
|
|
||||||
UpstreamConfig is a collection of definitions for upstream servers.
|
|
||||||
|
|
||||||
| Field | Type | Description |
|
|
||||||
| ----- | ---- | ----------- |
|
|
||||||
| `proxyRawPath` | _bool_ | ProxyRawPath will pass the raw url path to upstream allowing for urls<br/>like: "/%2F/" which would otherwise be redirected to "/" |
|
|
||||||
| `upstreams` | _[[]Upstream](#upstream)_ | Upstreams represents the configuration for the upstream servers.<br/>Requests will be proxied to this upstream if the path matches the request path. |
|
|
||||||
|
|
@ -1,139 +0,0 @@
|
||||||
---
|
|
||||||
id: alpha-config
|
|
||||||
title: Alpha Configuration
|
|
||||||
---
|
|
||||||
|
|
||||||
:::warning
|
|
||||||
This page contains documentation for alpha features.
|
|
||||||
We reserve the right to make breaking changes to the features detailed within this page with no notice.
|
|
||||||
|
|
||||||
Options described in this page may be changed, removed, renamed or moved without prior warning.
|
|
||||||
Please beware of this before you use alpha configuration options.
|
|
||||||
:::
|
|
||||||
|
|
||||||
This page details a set of **alpha** configuration options in a new format.
|
|
||||||
Going forward we are intending to add structured configuration in YAML format to
|
|
||||||
replace the existing TOML based configuration file and flags.
|
|
||||||
|
|
||||||
Below is a reference for the structure of the configuration, with
|
|
||||||
[AlphaOptions](#alphaoptions) as the root of the configuration.
|
|
||||||
|
|
||||||
When using alpha configuration, your config file will look something like below:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
upstreams:
|
|
||||||
- id: ...
|
|
||||||
...: ...
|
|
||||||
injectRequestHeaders:
|
|
||||||
- name: ...
|
|
||||||
...: ...
|
|
||||||
injectResponseHeaders:
|
|
||||||
- name: ...
|
|
||||||
...: ...
|
|
||||||
```
|
|
||||||
|
|
||||||
Please browse the [reference](#configuration-reference) below for the structure
|
|
||||||
of the new configuration format.
|
|
||||||
|
|
||||||
## Using Alpha Configuration
|
|
||||||
|
|
||||||
To use the new **alpha** configuration, generate a YAML file based on the format
|
|
||||||
described in the [reference](#configuration-reference) below.
|
|
||||||
|
|
||||||
Provide the path to this file using the `--alpha-config` flag.
|
|
||||||
|
|
||||||
:::note
|
|
||||||
When using the `--alpha-config` flag, some options are no longer available.
|
|
||||||
See [removed options](#removed-options) below for more information.
|
|
||||||
:::
|
|
||||||
|
|
||||||
### Converting configuration to the new structure
|
|
||||||
|
|
||||||
Before adding the new `--alpha-config` option, start OAuth2 Proxy using the
|
|
||||||
`convert-config-to-alpha` flag to convert existing configuration to the new format.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
oauth2-proxy --convert-config-to-alpha --config ./path/to/existing/config.cfg
|
|
||||||
```
|
|
||||||
|
|
||||||
This will convert any options supported by the new format to YAML and print the
|
|
||||||
new configuration to `STDOUT`.
|
|
||||||
|
|
||||||
Copy this to a new file, remove any options from your existing configuration
|
|
||||||
noted in [removed options](#removed-options) and then start OAuth2 Proxy using
|
|
||||||
the new config.
|
|
||||||
|
|
||||||
```bash
|
|
||||||
oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg
|
|
||||||
```
|
|
||||||
|
|
||||||
## Using ENV variables in the alpha configuration
|
|
||||||
|
|
||||||
The alpha package supports the use of environment variables in place of yaml keys, allowing sensitive values to be pulled from somewhere other than the yaml file.
|
|
||||||
When using environment variables, your yaml will look like this:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
providers:
|
|
||||||
- provider: azure
|
|
||||||
clientSecret: ${CLIENT_SECRET}
|
|
||||||
...
|
|
||||||
```
|
|
||||||
Where CLIENT_SECRET is an environment variable.
|
|
||||||
More information and available patterns can be found [here](https://github.com/a8m/envsubst#docs)
|
|
||||||
|
|
||||||
## Removed options
|
|
||||||
|
|
||||||
The following flags/options and their respective environment variables are no
|
|
||||||
longer available when using alpha configuration:
|
|
||||||
|
|
||||||
<!-- Legacy Upstream FlagSet -->
|
|
||||||
- `flush-interval`/`flush_interval`
|
|
||||||
- `pass-host-header`/`pass_host_header`
|
|
||||||
- `proxy-websockets`/`proxy_websockets`
|
|
||||||
- `ssl-upstream-insecure-skip-verify`/`ssl_upstream_insecure_skip_verify`
|
|
||||||
- `upstream`/`upstreams`
|
|
||||||
|
|
||||||
<!-- Legacy Headers FlagSet -->
|
|
||||||
- `pass-basic-auth`/`pass_basic_auth`
|
|
||||||
- `pass-access-token`/`pass_access_token`
|
|
||||||
- `pass-user-headers`/`pass_user_headers`
|
|
||||||
- `pass-authorization-header`/`pass_authorization_header`
|
|
||||||
- `set-basic-auth`/`set_basic_auth`
|
|
||||||
- `set-xauthrequest`/`set_xauthrequest`
|
|
||||||
- `set-authorization-header`/`set_authorization_header`
|
|
||||||
- `prefer-email-to-user`/`prefer_email_to_user`
|
|
||||||
- `basic-auth-password`/`basic_auth_password`
|
|
||||||
- `skip-auth-strip-headers`/`skip_auth_strip_headers`
|
|
||||||
|
|
||||||
<!-- Legacy provider FlagSet -->
|
|
||||||
- `client-id`/`client_id`
|
|
||||||
- `client-secret`/`client_secret`, and `client-secret-file`/`client_secret_file`
|
|
||||||
- `provider`
|
|
||||||
- `provider-display-name`/`provider_display_name`
|
|
||||||
- `provider-ca-file`/`provider_ca_files`
|
|
||||||
- `login-url`/`login_url`
|
|
||||||
- `redeem-url`/`redeem_url`
|
|
||||||
- `profile-url`/`profile_url`
|
|
||||||
- `resource`
|
|
||||||
- `validate-url`/`validate_url`
|
|
||||||
- `scope`
|
|
||||||
- `prompt`
|
|
||||||
- `approval-prompt`/`approval_prompt`
|
|
||||||
- `acr-values`/`acr_values`
|
|
||||||
- `user-id-claim`/`user_id_claim`
|
|
||||||
- `allowed-group`/`allowed_groups`
|
|
||||||
- `allowed-role`/`allowed_roles`
|
|
||||||
- `jwt-key`/`jwt_key`
|
|
||||||
- `jwt-key-file`/`jwt_key_file`
|
|
||||||
- `pubjwk-url`/`pubjwk_url`
|
|
||||||
|
|
||||||
and all provider-specific options, i.e. any option whose name includes `oidc`,
|
|
||||||
`azure`, `bitbucket`, `github`, `gitlab`, `google` or `keycloak`. Attempting to
|
|
||||||
use any of these options via flags or via config when `--alpha-config` is
|
|
||||||
set will result in an error.
|
|
||||||
|
|
||||||
:::important
|
|
||||||
You must remove these options before starting OAuth2 Proxy with `--alpha-config`
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Configuration Reference
|
|
||||||
|
|
@ -1,310 +0,0 @@
|
||||||
---
|
|
||||||
id: integration
|
|
||||||
title: Integration
|
|
||||||
---
|
|
||||||
|
|
||||||
## Configuring for use with the Nginx `auth_request` directive
|
|
||||||
|
|
||||||
**This option requires `--reverse-proxy` option to be set.**
|
|
||||||
|
|
||||||
The [Nginx `auth_request` directive](http://nginx.org/en/docs/http/ngx_http_auth_request_module.html) allows Nginx to authenticate requests via the oauth2-proxy's `/auth` endpoint, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the request through. For example:
|
|
||||||
|
|
||||||
```nginx
|
|
||||||
server {
|
|
||||||
listen 443 ssl;
|
|
||||||
server_name ...;
|
|
||||||
include ssl/ssl.conf;
|
|
||||||
|
|
||||||
location /oauth2/ {
|
|
||||||
proxy_pass http://127.0.0.1:4180;
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Auth-Request-Redirect $request_uri;
|
|
||||||
# or, if you are handling multiple domains:
|
|
||||||
# proxy_set_header X-Auth-Request-Redirect $scheme://$host$request_uri;
|
|
||||||
}
|
|
||||||
location = /oauth2/auth {
|
|
||||||
proxy_pass http://127.0.0.1:4180;
|
|
||||||
proxy_set_header Host $host;
|
|
||||||
proxy_set_header X-Real-IP $remote_addr;
|
|
||||||
proxy_set_header X-Forwarded-Uri $request_uri;
|
|
||||||
# nginx auth_request includes headers but not body
|
|
||||||
proxy_set_header Content-Length "";
|
|
||||||
proxy_pass_request_body off;
|
|
||||||
}
|
|
||||||
|
|
||||||
location / {
|
|
||||||
auth_request /oauth2/auth;
|
|
||||||
error_page 401 =403 /oauth2/sign_in;
|
|
||||||
|
|
||||||
# pass information via X-User and X-Email headers to backend,
|
|
||||||
# requires running with --set-xauthrequest flag
|
|
||||||
auth_request_set $user $upstream_http_x_auth_request_user;
|
|
||||||
auth_request_set $email $upstream_http_x_auth_request_email;
|
|
||||||
proxy_set_header X-User $user;
|
|
||||||
proxy_set_header X-Email $email;
|
|
||||||
|
|
||||||
# if you enabled --pass-access-token, this will pass the token to the backend
|
|
||||||
auth_request_set $token $upstream_http_x_auth_request_access_token;
|
|
||||||
proxy_set_header X-Access-Token $token;
|
|
||||||
|
|
||||||
# if you enabled --cookie-refresh, this is needed for it to work with auth_request
|
|
||||||
auth_request_set $auth_cookie $upstream_http_set_cookie;
|
|
||||||
add_header Set-Cookie $auth_cookie;
|
|
||||||
|
|
||||||
# When using the --set-authorization-header flag, some provider's cookies can exceed the 4kb
|
|
||||||
# limit and so the OAuth2 Proxy splits these into multiple parts.
|
|
||||||
# Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,
|
|
||||||
# so if your cookies are larger than 4kb, you will need to extract additional cookies manually.
|
|
||||||
auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;
|
|
||||||
|
|
||||||
# Extract the Cookie attributes from the first Set-Cookie header and append them
|
|
||||||
# to the second part ($upstream_cookie_* variables only contain the raw cookie content)
|
|
||||||
if ($auth_cookie ~* "(; .*)") {
|
|
||||||
set $auth_cookie_name_0 $auth_cookie;
|
|
||||||
set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";
|
|
||||||
}
|
|
||||||
|
|
||||||
# Send both Set-Cookie headers now if there was a second part
|
|
||||||
if ($auth_cookie_name_upstream_1) {
|
|
||||||
add_header Set-Cookie $auth_cookie_name_0;
|
|
||||||
add_header Set-Cookie $auth_cookie_name_1;
|
|
||||||
}
|
|
||||||
|
|
||||||
proxy_pass http://backend/;
|
|
||||||
# or "root /path/to/site;" or "fastcgi_pass ..." etc
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"
|
|
||||||
nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"
|
|
||||||
```
|
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
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=".
|
|
||||||
|
|
||||||
## Configuring for use with the Traefik (v2) `ForwardAuth` middleware
|
|
||||||
|
|
||||||
**This option requires `--reverse-proxy` option to be set.**
|
|
||||||
|
|
||||||
### ForwardAuth with 401 errors middleware
|
|
||||||
|
|
||||||
The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) allows Traefik to authenticate requests via the oauth2-proxy's `/oauth2/auth` endpoint on every request, which only returns a 202 Accepted response or a 401 Unauthorized response without proxying the whole request through. For example, on Dynamic File (YAML) Configuration:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
http:
|
|
||||||
routers:
|
|
||||||
a-service:
|
|
||||||
rule: "Host(`a-service.example.com`)"
|
|
||||||
service: a-service-backend
|
|
||||||
middlewares:
|
|
||||||
- oauth-errors
|
|
||||||
- oauth-auth
|
|
||||||
tls:
|
|
||||||
certResolver: default
|
|
||||||
domains:
|
|
||||||
- main: "example.com"
|
|
||||||
sans:
|
|
||||||
- "*.example.com"
|
|
||||||
oauth:
|
|
||||||
rule: "Host(`a-service.example.com`, `oauth.example.com`) && PathPrefix(`/oauth2/`)"
|
|
||||||
middlewares:
|
|
||||||
- auth-headers
|
|
||||||
service: oauth-backend
|
|
||||||
tls:
|
|
||||||
certResolver: default
|
|
||||||
domains:
|
|
||||||
- main: "example.com"
|
|
||||||
sans:
|
|
||||||
- "*.example.com"
|
|
||||||
|
|
||||||
services:
|
|
||||||
a-service-backend:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://172.16.0.2:7555
|
|
||||||
oauth-backend:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://172.16.0.1:4180
|
|
||||||
|
|
||||||
middlewares:
|
|
||||||
auth-headers:
|
|
||||||
headers:
|
|
||||||
sslRedirect: true
|
|
||||||
stsSeconds: 315360000
|
|
||||||
browserXssFilter: true
|
|
||||||
contentTypeNosniff: true
|
|
||||||
forceSTSHeader: true
|
|
||||||
sslHost: example.com
|
|
||||||
stsIncludeSubdomains: true
|
|
||||||
stsPreload: true
|
|
||||||
frameDeny: true
|
|
||||||
oauth-auth:
|
|
||||||
forwardAuth:
|
|
||||||
address: https://oauth.example.com/oauth2/auth
|
|
||||||
trustForwardHeader: true
|
|
||||||
oauth-errors:
|
|
||||||
errors:
|
|
||||||
status:
|
|
||||||
- "401-403"
|
|
||||||
service: oauth-backend
|
|
||||||
query: "/oauth2/sign_in?rd={url}"
|
|
||||||
```
|
|
||||||
|
|
||||||
### ForwardAuth with static upstreams configuration
|
|
||||||
|
|
||||||
Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/http/forwardauth/) pointing to oauth2-proxy service's `/` endpoint
|
|
||||||
|
|
||||||
**Following options need to be set on `oauth2-proxy`:**
|
|
||||||
- `--upstream=static://202`: Configures a static response for authenticated sessions
|
|
||||||
- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
http:
|
|
||||||
routers:
|
|
||||||
a-service-route-1:
|
|
||||||
rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/`)"
|
|
||||||
service: a-service-backend
|
|
||||||
middlewares:
|
|
||||||
- oauth-auth-redirect # redirects all unauthenticated to oauth2 signin
|
|
||||||
tls:
|
|
||||||
certResolver: default
|
|
||||||
domains:
|
|
||||||
- main: "example.com"
|
|
||||||
sans:
|
|
||||||
- "*.example.com"
|
|
||||||
a-service-route-2:
|
|
||||||
rule: "Host(`a-service.example.com`) && PathPrefix(`/no-auto-redirect`)"
|
|
||||||
service: a-service-backend
|
|
||||||
middlewares:
|
|
||||||
- oauth-auth-wo-redirect # unauthenticated session will return a 401
|
|
||||||
tls:
|
|
||||||
certResolver: default
|
|
||||||
domains:
|
|
||||||
- main: "example.com"
|
|
||||||
sans:
|
|
||||||
- "*.example.com"
|
|
||||||
services-oauth2-route:
|
|
||||||
rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/oauth2/`)"
|
|
||||||
middlewares:
|
|
||||||
- auth-headers
|
|
||||||
service: oauth-backend
|
|
||||||
tls:
|
|
||||||
certResolver: default
|
|
||||||
domains:
|
|
||||||
- main: "example.com"
|
|
||||||
sans:
|
|
||||||
- "*.example.com"
|
|
||||||
oauth2-proxy-route:
|
|
||||||
rule: "Host(`oauth.example.com`) && PathPrefix(`/`)"
|
|
||||||
middlewares:
|
|
||||||
- auth-headers
|
|
||||||
service: oauth-backend
|
|
||||||
tls:
|
|
||||||
certResolver: default
|
|
||||||
domains:
|
|
||||||
- main: "example.com"
|
|
||||||
sans:
|
|
||||||
- "*.example.com"
|
|
||||||
|
|
||||||
services:
|
|
||||||
a-service-backend:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://172.16.0.2:7555
|
|
||||||
b-service-backend:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://172.16.0.3:7555
|
|
||||||
oauth-backend:
|
|
||||||
loadBalancer:
|
|
||||||
servers:
|
|
||||||
- url: http://172.16.0.1:4180
|
|
||||||
|
|
||||||
middlewares:
|
|
||||||
auth-headers:
|
|
||||||
headers:
|
|
||||||
sslRedirect: true
|
|
||||||
stsSeconds: 315360000
|
|
||||||
browserXssFilter: true
|
|
||||||
contentTypeNosniff: true
|
|
||||||
forceSTSHeader: true
|
|
||||||
sslHost: example.com
|
|
||||||
stsIncludeSubdomains: true
|
|
||||||
stsPreload: true
|
|
||||||
frameDeny: true
|
|
||||||
oauth-auth-redirect:
|
|
||||||
forwardAuth:
|
|
||||||
address: https://oauth.example.com/
|
|
||||||
trustForwardHeader: true
|
|
||||||
authResponseHeaders:
|
|
||||||
- X-Auth-Request-Access-Token
|
|
||||||
- Authorization
|
|
||||||
oauth-auth-wo-redirect:
|
|
||||||
forwardAuth:
|
|
||||||
address: https://oauth.example.com/oauth2/auth
|
|
||||||
trustForwardHeader: true
|
|
||||||
authResponseHeaders:
|
|
||||||
- X-Auth-Request-Access-Token
|
|
||||||
- Authorization
|
|
||||||
```
|
|
||||||
|
|
||||||
## Configuring for use with the Caddy (v2) `forward_auth` directive
|
|
||||||
|
|
||||||
The [Caddy `forward_auth` directive](https://caddyserver.com/docs/caddyfile/directives/forward_auth) allows Caddy to authenticate requests via the `oauth2-proxy`'s `/auth`.
|
|
||||||
|
|
||||||
This example is for a simple reverse proxy setup where the `/oauth2/` path is kept under the same domain and failed auth requests (401 status returned) will be caught and redirected to the `sign_in` endpoint.
|
|
||||||
|
|
||||||
**Following options need to be set on `oauth2-proxy`:**
|
|
||||||
- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly
|
|
||||||
|
|
||||||
```nginx title="Caddyfile"
|
|
||||||
example.com {
|
|
||||||
# Requests to /oauth2/* are proxied to oauth2-proxy without authentication.
|
|
||||||
# You can't use `reverse_proxy /oauth2/* oauth2-proxy.internal:4180` here because the reverse_proxy directive has lower precedence than the handle directive.
|
|
||||||
handle /oauth2/* {
|
|
||||||
reverse_proxy oauth2-proxy.internal:4180 {
|
|
||||||
# oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.
|
|
||||||
# The reverse_proxy directive automatically sets X-Forwarded-{For,Proto,Host} headers.
|
|
||||||
header_up X-Real-IP {remote_host}
|
|
||||||
header_up X-Forwarded-Uri {uri}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# Requests to other paths are first processed by oauth2-proxy for authentication.
|
|
||||||
handle {
|
|
||||||
forward_auth oauth2-proxy.internal:4180 {
|
|
||||||
uri /oauth2/auth
|
|
||||||
|
|
||||||
# oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.
|
|
||||||
# The forward_auth directive automatically sets the X-Forwarded-{For,Proto,Host,Method,Uri} headers.
|
|
||||||
header_up X-Real-IP {remote_host}
|
|
||||||
|
|
||||||
# If needed, you can copy headers from the oauth2-proxy response to the request sent to the upstream.
|
|
||||||
# Make sure to configure the --set-xauthrequest flag to enable this feature.
|
|
||||||
#copy_headers X-Auth-Request-User X-Auth-Request-Email
|
|
||||||
|
|
||||||
# If oauth2-proxy returns a 401 status, redirect the client to the sign-in page.
|
|
||||||
@error status 401
|
|
||||||
handle_response @error {
|
|
||||||
redir * /oauth2/sign_in?rd={scheme}://{host}{uri}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# If oauth2-proxy returns a 2xx status, the request is then proxied to the upstream.
|
|
||||||
reverse_proxy upstream.internal:3000
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
:::note
|
|
||||||
If you set up your OAuth2 provider to rotate your client secret, you can use the `client-secret-file` option to reload the secret when it is updated.
|
|
||||||
:::
|
|
||||||
|
|
@ -1,406 +0,0 @@
|
||||||
---
|
|
||||||
id: overview
|
|
||||||
title: Overview
|
|
||||||
---
|
|
||||||
|
|
||||||
`oauth2-proxy` can be configured via [command line options](#command-line-options), [environment variables](#environment-variables) or [config file](#config-file) (in decreasing order of precedence, i.e. command line options will overwrite environment variables and environment variables will overwrite configuration file settings).
|
|
||||||
|
|
||||||
## Generating a Cookie Secret
|
|
||||||
|
|
||||||
To generate a strong cookie secret use one of the below commands:
|
|
||||||
|
|
||||||
import Tabs from '@theme/Tabs';
|
|
||||||
import TabItem from '@theme/TabItem';
|
|
||||||
|
|
||||||
<Tabs defaultValue="python">
|
|
||||||
<TabItem value="python" label="Python">
|
|
||||||
|
|
||||||
```shell
|
|
||||||
python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).decode())'
|
|
||||||
```
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="bash" label="Bash">
|
|
||||||
|
|
||||||
```shell
|
|
||||||
dd if=/dev/urandom bs=32 count=1 2>/dev/null | base64 | tr -d -- '\n' | tr -- '+/' '-_' ; echo
|
|
||||||
```
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="openssl" label="OpenSSL">
|
|
||||||
|
|
||||||
```shell
|
|
||||||
openssl rand -base64 32 | tr -- '+/' '-_'
|
|
||||||
```
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="powershell" label="PowerShell">
|
|
||||||
|
|
||||||
```powershell
|
|
||||||
# Add System.Web assembly to session, just in case
|
|
||||||
Add-Type -AssemblyName System.Web
|
|
||||||
[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes([System.Web.Security.Membership]::GeneratePassword(32,4))).Replace("+","-").Replace("/","_")
|
|
||||||
```
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
<TabItem value="terraform" label="Terraform">
|
|
||||||
|
|
||||||
```hcl
|
|
||||||
# Valid 32 Byte Base64 URL encoding set that will decode to 24 []byte AES-192 secret
|
|
||||||
resource "random_password" "cookie_secret" {
|
|
||||||
length = 32
|
|
||||||
override_special = "-_"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
</TabItem>
|
|
||||||
</Tabs>
|
|
||||||
|
|
||||||
## Config File
|
|
||||||
|
|
||||||
Every command line argument can be specified in a config file by replacing hyphens (-) with underscores (\_). If the argument can be specified multiple times, the config option should be plural (trailing s).
|
|
||||||
|
|
||||||
An example [oauth2-proxy.cfg](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/contrib/oauth2-proxy.cfg.example) config file is in the contrib directory. It can be used by specifying `--config=/etc/oauth2-proxy.cfg`
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
### Command Line Options
|
|
||||||
|
|
||||||
| Flag | Description |
|
|
||||||
| ----------- | -------------------- |
|
|
||||||
| `--config` | path to config file |
|
|
||||||
| `--version` | print version string |
|
|
||||||
|
|
||||||
|
|
||||||
### General Provider Options
|
|
||||||
|
|
||||||
Provider specific options can be found on their respective subpages.
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| --------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
|
|
||||||
| flag: `--acr-values`<br/>toml: `acr_values` | string | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues) | `""` |
|
|
||||||
| flag: `--allowed-group`<br/>toml: `allowed_groups` | string \| list | Restrict login to members of a group or list of groups. Furthermore, if you aren't setting the `scope` and use `allowed_groups` with the generic OIDC provider the scope `groups` gets added implicitly. | |
|
|
||||||
| flag: `--approval-prompt`<br/>toml: `approval_prompt` | string | OAuth approval_prompt | `"force"` |
|
|
||||||
| flag: `--backend-logout-url`<br/>toml: `backend_logout_url` | string | URL to perform backend logout, if you use `{id_token}` in the url it will be replaced by the actual `id_token` of the user session | |
|
|
||||||
| flag: `--client-id`<br/>toml: `client_id` | string | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"` | |
|
|
||||||
| flag: `--client-secret-file`<br/>toml: `client_secret_file` | string | the file with OAuth Client Secret | |
|
|
||||||
| flag: `--client-secret`<br/>toml: `client_secret` | string | the OAuth Client Secret | |
|
|
||||||
| flag: `--code-challenge-method`<br/>toml: `code_challenge_method` | string | use PKCE code challenges with the specified method. Either 'plain' or 'S256' (recommended) | |
|
|
||||||
| flag: `--insecure-oidc-allow-unverified-email`<br/>toml: `insecure_oidc_allow_unverified_email` | bool | don't fail if an email address in an id_token is not verified | false |
|
|
||||||
| flag: `--insecure-oidc-skip-issuer-verification`<br/>toml: `insecure_oidc_skip_issuer_verification` | bool | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility) | false |
|
|
||||||
| flag: `--insecure-oidc-skip-nonce`<br/>toml: `insecure_oidc_skip_nonce` | bool | skip verifying the OIDC ID Token's nonce claim | true |
|
|
||||||
| flag: `--jwt-key-file`<br/>toml: `jwt_key_file` | string | path to the private key file in PEM format used to sign the JWT so that you can say something like `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem`: required by login.gov | |
|
|
||||||
| flag: `--jwt-key`<br/>toml: `jwt_key` | string | private key in PEM format used to sign JWT, so that you can say something like `--jwt-key="${OAUTH2_PROXY_JWT_KEY}"`: required by login.gov | |
|
|
||||||
| flag: `--login-url`<br/>toml: `login_url` | string | Authentication endpoint | |
|
|
||||||
| flag: `--auth-request-response-mode`<br/>toml: `auth-request-response-mode` | string | Response mode to ask for during authentication request | |
|
|
||||||
| flag: `--oidc-audience-claim`<br/>toml: `oidc_audience_claims` | string | which OIDC claim contains the audience | `"aud"` |
|
|
||||||
| flag: `--oidc-email-claim`<br/>toml: `oidc_email_claim` | string | which OIDC claim contains the user's email | `"email"` |
|
|
||||||
| flag: `--oidc-extra-audience`<br/>toml: `oidc_extra_audiences` | string \| list | additional audiences which are allowed to pass verification | `"[]"` |
|
|
||||||
| flag: `--oidc-groups-claim`<br/>toml: `oidc_groups_claim` | string | which OIDC claim contains the user groups | `"groups"` |
|
|
||||||
| flag: `--oidc-issuer-url`<br/>toml: `oidc_issuer_url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |
|
|
||||||
| flag: `--oidc-jwks-url`<br/>toml: `oidc_jwks_url` | string | OIDC JWKS URI for token verification; required if OIDC discovery is disabled and public key files are not provided | |
|
|
||||||
| flag: `--oidc-public-key-file`<br/>toml: `oidc_public_key_files` | string | Path to public key file in PEM format to use for verifying JWT tokens (may be given multiple times). Required if OIDC discovery is disabled na JWKS URL isn't provided | string \| list |
|
|
||||||
| flag: `--profile-url`<br/>toml: `profile_url` | string | Profile access endpoint | |
|
|
||||||
| flag: `--prompt`<br/>toml: `prompt` | string | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored | `""` |
|
|
||||||
| flag: `--provider-ca-file`<br/>toml: `provider_ca_files` | string \| list | Paths to CA certificates that should be used when connecting to the provider. If not specified, the default Go trust sources are used instead. |
|
|
||||||
| flag: `--provider-display-name`<br/>toml: `provider_display_name` | string | Override the provider's name with the given string; used for the sign-in page | (depends on provider) |
|
|
||||||
| flag: `--provider`<br/>toml: `provider` | string | OAuth provider | google |
|
|
||||||
| flag: `--pubjwk-url`<br/>toml: `pubjwk_url` | string | JWK pubkey access endpoint: required by login.gov | |
|
|
||||||
| flag: `--redeem-url`<br/>toml: `redeem_url` | string | Token redemption endpoint | |
|
|
||||||
| flag: `--scope`<br/>toml:`scope` | string | OAuth scope specification. Every provider has a default list of scopes which will be used in case no scope is configured. | |
|
|
||||||
| flag: `--skip-claims-from-profile-url`<br/>toml: `skip_claims_from_profile_url` | bool | skip request to Profile URL for resolving claims not present in id_token | false |
|
|
||||||
| flag: `--skip-oidc-discovery`<br/>toml: `skip_oidc_discovery` | bool | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case | false |
|
|
||||||
| flag: `--use-system-trust-store`<br/>toml: `use_system_trust_store` | bool | Determines if `provider-ca-file` files and the system trust store are used. If set to true, your custom CA files and the system trust store are used otherwise only your custom CA files. | false |
|
|
||||||
| flag: `--validate-url`<br/>toml: `validate_url` | string | Access token validation endpoint | |
|
|
||||||
|
|
||||||
### Cookie Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| --------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
|
|
||||||
| flag: `--cookie-csrf-expire`<br/>toml: `cookie_csrf_expire` | duration | expire timeframe for CSRF cookie | 15m |
|
|
||||||
| flag: `--cookie-csrf-per-request`<br/>toml:`cookie_csrf_per_request` | bool | Enable having different CSRF cookies per request, making it possible to have parallel requests. | false |
|
|
||||||
| flag: `--cookie-csrf-per-request-limit`<br/>toml: `cookie_csrf_per_request_limit` | int | Sets a limit on the number of CSRF requests cookies that oauth2-proxy will create. The oldest cookie will be removed. Useful if users end up with 431 Request headers too large status codes. Only effective if --cookie-csrf-per-request is true | "infinite" |
|
|
||||||
| flag: `--cookie-domain`<br/>toml: `cookie_domains` | string \| list | Optional cookie domains to force cookies to (e.g. `.yourcompany.com`). The longest domain matching the request's host will be used (or the shortest cookie domain if there is no match). | |
|
|
||||||
| flag: `--cookie-expire`<br/>toml: `cookie_expire` | duration | expire timeframe for cookie. If set to 0, cookie becomes a session-cookie which will expire when the browser is closed. | 168h0m0s |
|
|
||||||
| flag: `--cookie-httponly`<br/>toml: `cookie_httponly` | bool | set HttpOnly cookie flag | true |
|
|
||||||
| flag: `--cookie-name`<br/>toml: `cookie_name` | string | the name of the cookie that the oauth_proxy creates. Should be changed to use a [cookie prefix](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#cookie_prefixes) (`__Host-` or `__Secure-`) if `--cookie-secure` is set. | `"_oauth2_proxy"` |
|
|
||||||
| flag: `--cookie-path`<br/>toml: `cookie_path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |
|
|
||||||
| flag: `--cookie-refresh`<br/>toml: `cookie_refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers [^1] | |
|
|
||||||
| flag: `--cookie-samesite`<br/>toml: `cookie_samesite` | string | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). | `""` |
|
|
||||||
| flag: `--cookie-secret`<br/>toml: `cookie_secret` | string | the seed string for secure cookies (optionally base64 encoded) | |
|
|
||||||
| flag: `--cookie-secret-file`<br/>toml: `cookie_secret_file` | string | For defining a separate cookie secret file to read the encryption key from | |
|
|
||||||
| flag: `--cookie-secure`<br/>toml: `cookie_secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true |
|
|
||||||
|
|
||||||
[^1]: The following providers support `--cookie-refresh`: ADFS, Azure, GitLab, Google, Keycloak and all other Identity Providers which support the full [OIDC specification](https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens)
|
|
||||||
|
|
||||||
### Header Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| flag: `--basic-auth-password`<br/>toml: `basic_auth_password` | string | the password to set when passing the HTTP Basic Auth header | |
|
|
||||||
| flag: `--set-xauthrequest`<br/>toml: `set_xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode). When used with `--pass-access-token`, X-Auth-Request-Access-Token is added to response headers. | false |
|
|
||||||
| flag: `--set-authorization-header`<br/>toml: `set_authorization_header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |
|
|
||||||
| flag: `--set-basic-auth`<br/>toml: `set_basic_auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |
|
|
||||||
| flag: `--skip-auth-strip-headers`<br/>toml: `skip_auth_strip_headers` | bool | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy | true |
|
|
||||||
| flag: `--pass-access-token`<br/>toml: `pass_access_token` | bool | pass OAuth access_token to upstream via X-Forwarded-Access-Token header. When used with `--set-xauthrequest` this adds the X-Auth-Request-Access-Token header to the response | false |
|
|
||||||
| flag: `--pass-authorization-header`<br/>toml: `pass_authorization_header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |
|
|
||||||
| flag: `--pass-basic-auth`<br/>toml: `pass_basic_auth` | bool | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
|
|
||||||
| flag: `--prefer-email-to-user`<br/>toml: `prefer_email_to_user` | bool | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers` | false |
|
|
||||||
| flag: `--pass-user-headers`<br/>toml: `pass_user_headers` | bool | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
|
|
||||||
|
|
||||||
### Logging Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| --------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------- | --------------------------------------------------- |
|
|
||||||
| flag: `--auth-logging-format`<br/>toml: `auth_logging_format` | string | Template for authentication log lines | see [Logging Configuration](#logging-configuration) |
|
|
||||||
| flag: `--auth-logging`<br/>toml: `auth_logging` | bool | Log authentication attempts | true |
|
|
||||||
| flag: `--errors-to-info-log`<br/>toml: `errors_to_info_log` | bool | redirects error-level logging to default log channel instead of stderr | false |
|
|
||||||
| flag: `--exclude-logging-path`<br/>toml: `exclude_logging_paths` | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` | `""` (no paths excluded) |
|
|
||||||
| flag: `--logging-compress`<br/>toml: `logging_compress` | bool | Should rotated log files be compressed using gzip | false |
|
|
||||||
| flag: `--logging-filename`<br/>toml: `logging_filename` | string | File to log requests to, empty for `stdout` | `""` (stdout) |
|
|
||||||
| flag: `--logging-local-time`<br/>toml: `logging_local_time` | bool | Use local time in log files and backup filenames instead of UTC | true (local time) |
|
|
||||||
| flag: `--logging-max-age`<br/>toml: `logging_max_age` | int | Maximum number of days to retain old log files | 7 |
|
|
||||||
| flag: `--logging-max-backups`<br/>toml: `logging_max_backups` | int | Maximum number of old log files to retain; 0 to disable | 0 |
|
|
||||||
| flag: `--logging-max-size`<br/>toml: `logging_max_size` | int | Maximum size in megabytes of the log file before rotation | 100 |
|
|
||||||
| flag: `--request-id-header`<br/>toml: `request_id_header` | string | Request header to use as the request ID in logging | X-Request-Id |
|
|
||||||
| flag: `--request-logging-format`<br/>toml: `request_logging_format` | string | Template for request log lines | see [Logging Configuration](#logging-configuration) |
|
|
||||||
| flag: `--request-logging`<br/>toml: `request_logging` | bool | Log requests | true |
|
|
||||||
| flag: `--silence-ping-logging`<br/>toml: `silence_ping_logging` | bool | disable logging of requests to ping & ready endpoints | false |
|
|
||||||
| flag: `--standard-logging-format`<br/>toml: `standard_logging_format` | string | Template for standard log lines | see [Logging Configuration](#logging-configuration) |
|
|
||||||
| flag: `--standard-logging`<br/>toml: `standard_logging` | bool | Log standard runtime information | true |
|
|
||||||
|
|
||||||
### Page Template Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ----------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| flag: `--banner`<br/>toml: `banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |
|
|
||||||
| flag: `--custom-sign-in-logo`<br/>toml: `custom_sign_in_logo` | string | path or a URL to an custom image for the sign_in page logo. Use `"-"` to disable default logo. |
|
|
||||||
| flag: `--custom-templates-dir`<br/>toml: `custom_templates_dir` | string | path to custom html templates | |
|
|
||||||
| flag: `--display-htpasswd-form`<br/>toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true |
|
|
||||||
| flag: `--footer`<br/>toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | |
|
|
||||||
| flag: `--show-debug-on-error`<br/>toml: `show_debug_on_error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false |
|
|
||||||
|
|
||||||
### Probe Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ------------------------------------------------------- | ------ | ---------------------------------------------------------- | ----------------------------- |
|
|
||||||
| flag: `--ping-path`<br/>toml: `ping_path` | string | the ping endpoint that can be used for basic health checks | `"/ping"` |
|
|
||||||
| flag: `--ping-user-agent`<br/>toml: `ping_user_agent` | string | a User-Agent that can be used for basic health checks | `""` (don't check user agent) |
|
|
||||||
| flag: `--ready-path`<br/>toml: `ready_path` | string | the ready endpoint that can be used for deep health checks | `"/ready"` |
|
|
||||||
| flag: `--gcp-healthchecks`<br/>toml: `gcp_healthchecks` | bool | Enable GCP/GKE healthcheck endpoints (deprecated) | false |
|
|
||||||
|
|
||||||
### Proxy Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ----------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
|
|
||||||
| flag: `--allow-query-semicolons`<br/>toml: `allow_query_semicolons` | bool | allow the use of semicolons in query args ([required for some legacy applications](https://github.com/golang/go/issues/25192)) | `false` |
|
|
||||||
| flag: `--api-route`<br/>toml: `api_routes` | string \| list | Requests to these paths must already be authenticated with a cookie, or a JWT if `--skip-jwt-bearer-tokens` is set. No redirect to login will be done. Return 401 if not. Format: path_regex | |
|
|
||||||
| flag: `--authenticated-emails-file`<br/>toml: `authenticated_emails_file` | string | authenticate against emails via file (one per line) | |
|
|
||||||
| flag: `--bearer-token-login-fallback`<br/>toml: `bearer_token_login_fallback` | bool | if `--skip-jwt-bearer-tokens` is set, if a request includes an invalid JWT (expired, malformed, missing required audiences, etc), fall back to normal login redirect as if the token were not sent at all. If false, respond 403 | true |
|
|
||||||
| flag: `--email-domain`<br/>toml: `email_domains` | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email | |
|
|
||||||
| flag: `--encode-state`<br/>toml: `encode_state` | bool | encode the state parameter as UrlEncodedBase64 | false |
|
|
||||||
| flag: `--extra-jwt-issuers`<br/>toml: `extra_jwt_issuers` | string | if `--skip-jwt-bearer-tokens` is set, a list of extra JWT `issuer=audience` (see a token's `iss`, `aud` fields) pairs (where the issuer URL has a `.well-known/openid-configuration` or a `.well-known/jwks.json`) | |
|
|
||||||
| flag: `--force-https`<br/>toml: `force_https` | bool | enforce https redirect | `false` |
|
|
||||||
| flag: `--force-json-errors`<br/>toml: `force_json_errors` | bool | force JSON errors instead of HTTP error pages or redirects | `false` |
|
|
||||||
| flag: `--htpasswd-file`<br/>toml: `htpasswd_file` | string | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption | |
|
|
||||||
| flag: `--htpasswd-user-group`<br/>toml: `htpasswd_user_groups` | string \| list | the groups to be set on sessions for htpasswd users | |
|
|
||||||
| flag: `--proxy-prefix`<br/>toml: `proxy_prefix` | string | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`) | `"/oauth2"` |
|
|
||||||
| flag: `--real-client-ip-header`<br/>toml: `real_client_ip_header` | string | Header used to determine the real IP of the client, requires `--reverse-proxy` to be set (one of: X-Forwarded-For, X-Real-IP, X-ProxyUser-IP, X-Envoy-External-Address, or CF-Connecting-IP) | X-Real-IP |
|
|
||||||
| flag: `--redirect-url`<br/>toml: `redirect_url` | string | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"` | |
|
|
||||||
| flag: `--relative-redirect-url`<br/>toml: `relative_redirect_url` | bool | allow relative OAuth Redirect URL.` | false |
|
|
||||||
| flag: `--reverse-proxy`<br/>toml: `reverse_proxy` | bool | are we running behind a reverse proxy, controls whether headers like X-Real-IP are accepted and allows X-Forwarded-\{Proto,Host,Uri\} headers to be used on redirect selection | false |
|
|
||||||
| flag: `--signature-key`<br/>toml: `signature_key` | string | GAP-Signature request signature key (algorithm:secretkey) | |
|
|
||||||
| flag: `--skip-auth-preflight`<br/>toml: `skip_auth_preflight` | bool | will skip authentication for OPTIONS requests | false |
|
|
||||||
| flag: `--skip-auth-regex`<br/>toml: `skip_auth_regex` | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times) | |
|
|
||||||
| flag: `--skip-auth-route`<br/>toml: `skip_auth_routes` | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR method!=path_regex. For all methods: path_regex OR !=path_regex | |
|
|
||||||
| flag: `--skip-jwt-bearer-tokens`<br/>toml: `skip_jwt_bearer_tokens` | bool | will skip requests that have verified JWT bearer tokens (the token must have [`aud`](https://en.wikipedia.org/wiki/JSON_Web_Token#Standard_fields) that matches this client id or one of the extras from `extra-jwt-issuers`) | false |
|
|
||||||
| flag: `--skip-provider-button`<br/>toml: `skip_provider_button` | bool | will skip sign-in-page to directly reach the next step: oauth/start | false |
|
|
||||||
| flag: `--ssl-insecure-skip-verify`<br/>toml: `ssl_insecure_skip_verify` | bool | skip validation of certificates presented when using HTTPS providers | false |
|
|
||||||
| flag: `--trusted-ip`<br/>toml: `trusted_ips` | string \| list | list of IPs or CIDR ranges to allow to bypass authentication (may be given multiple times). When combined with `--reverse-proxy` and optionally `--real-client-ip-header` this will evaluate the trust of the IP stored in an HTTP header by a reverse proxy rather than the layer-3/4 remote address. WARNING: trusting IPs has inherent security flaws, especially when obtaining the IP address from an HTTP header (reverse-proxy mode). Use this option only if you understand the risks and how to manage them. | |
|
|
||||||
| flag: `--whitelist-domain`<br/>toml: `whitelist_domains` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` or a `*.` to allow subdomains (e.g. `.example.com`, `*.example.com`) [^2] | |
|
|
||||||
|
|
||||||
[^2]: When using the `whitelist-domain` option, any domain prefixed with a `.` or a `*.` will allow any subdomain of the specified domain as a valid redirect URL. By default, only empty ports are allowed. This translates to allowing the default port of the URL's protocol (80 for HTTP, 443 for HTTPS, etc.) since browsers omit them. To allow only a specific port, add it to the whitelisted domain: `example.com:8080`. To allow any port, use `*`: `example.com:*`.
|
|
||||||
|
|
||||||
### Server Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
|
|
||||||
| flag: `--http-address`<br/>toml: `http_address` | string | `[http://]<addr>:<port>` or `unix://<path>` or `fd:<int>` (case insensitive) to listen on for HTTP clients. Square brackets are required for ipv6 address, e.g. `http://[::1]:4180` | `"127.0.0.1:4180"` |
|
|
||||||
| flag: `--https-address`<br/>toml: `https_address` | string | `[https://]<addr>:<port>` to listen on for HTTPS clients. Square brackets are required for ipv6 address, e.g. `https://[::1]:443` | `":443"` |
|
|
||||||
| flag: `--metrics-address`<br/>toml: `metrics_address` | string | the address prometheus metrics will be scraped from | `""` |
|
|
||||||
| flag: `--metrics-secure-address`<br/>toml: `metrics_secure_address` | string | the address prometheus metrics will be scraped from if using HTTPS | `""` |
|
|
||||||
| flag: `--metrics-tls-cert-file`<br/>toml: `metrics_tls_cert_file` | string | path to certificate file for secure metrics server | `""` |
|
|
||||||
| flag: `--metrics-tls-key-file`<br/>toml: `metrics_tls_key_file` | string | path to private key file for secure metrics server | `""` |
|
|
||||||
| flag: `--tls-cert-file`<br/>toml: `tls_cert_file` | string | path to certificate file | |
|
|
||||||
| flag: `--tls-key-file`<br/>toml: `tls_key_file` | string | path to private key file | |
|
|
||||||
| flag: `--tls-cipher-suite`<br/>toml: `tls_cipher_suites` | string \| list | Restricts TLS cipher suites used by server to those listed (e.g. TLS_RSA_WITH_RC4_128_SHA) (may be given multiple times). If not specified, the default Go safe cipher list is used. List of valid cipher suites can be found in the [crypto/tls documentation](https://pkg.go.dev/crypto/tls#pkg-constants). | |
|
|
||||||
| flag: `--tls-min-version`<br/>toml: `tls_min_version` | string | minimum TLS version that is acceptable, either `"TLS1.2"` or `"TLS1.3"` | `"TLS1.2"` |
|
|
||||||
|
|
||||||
### Session Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ----------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| flag: `--session-cookie-minimal`<br/>toml: `session_cookie_minimal` | bool | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only) | false |
|
|
||||||
| flag: `--session-store-type`<br/>toml: `session_store_type` | string | [Session data storage backend](sessions.md); redis or cookie | cookie |
|
|
||||||
| flag: `--redis-cluster-connection-urls`<br/>toml: `redis_cluster_connection_urls` | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster` | |
|
|
||||||
| flag: `--redis-connection-url`<br/>toml: `redis_connection_url` | string | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`) | |
|
|
||||||
| flag: `--redis-insecure-skip-tls-verify`<br/>toml: `redis_insecure_skip_tls_verify` | bool | skip TLS verification when connecting to Redis | false |
|
|
||||||
| flag: `--redis-password`<br/>toml: `redis_password` | string | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url` | |
|
|
||||||
| flag: `--redis-sentinel-password`<br/>toml: `redis_sentinel_password` | string | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password` | |
|
|
||||||
| flag: `--redis-sentinel-master-name`<br/>toml: `redis_sentinel_master_name` | string | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel` | |
|
|
||||||
| flag: `--redis-sentinel-connection-urls`<br/>toml: `redis_sentinel_connection_urls` | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel` | |
|
|
||||||
| flag: `--redis-use-cluster`<br/>toml: `redis_use_cluster` | bool | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature | false |
|
|
||||||
| flag: `--redis-use-sentinel`<br/>toml: `redis_use_sentinel` | bool | Connect to redis via sentinels. Must set `--redis-sentinel-master-name` and `--redis-sentinel-connection-urls` to use this feature | false |
|
|
||||||
| flag: `--redis-connection-idle-timeout`<br/>toml: `redis_connection_idle_timeout` | int | Redis connection idle timeout seconds. If Redis [timeout](https://redis.io/docs/reference/clients/#client-timeouts) option is set to non-zero, the `--redis-connection-idle-timeout` must be less than Redis timeout option. Example: if either redis.conf includes `timeout 15` or using `CONFIG SET timeout 15` the `--redis-connection-idle-timeout` must be at least `--redis-connection-idle-timeout=14` | 0 |
|
|
||||||
|
|
||||||
### Upstream Options
|
|
||||||
|
|
||||||
| Flag / Config Field | Type | Description | Default |
|
|
||||||
| ----------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |
|
|
||||||
| flag: `--flush-interval`<br/>toml: `flush_interval` | duration | period between flushing response buffers when streaming responses | `"1s"` |
|
|
||||||
| flag: `--pass-host-header`<br/>toml: `pass_host_header` | bool | pass the request Host Header to upstream | true |
|
|
||||||
| flag: `--proxy-websockets`<br/>toml: `proxy_websockets` | bool | enables WebSocket proxying | true |
|
|
||||||
| flag: `--ssl-upstream-insecure-skip-verify`<br/>toml: `ssl_upstream_insecure_skip_verify` | bool | skip validation of certificates presented when using HTTPS upstreams | false |
|
|
||||||
| flag: `--disable-keep-alives`<br/>toml: `disable_keep_alives` | bool | disable HTTP keep-alive connections to the upstream server | false |
|
|
||||||
| flag: `--upstream-timeout`<br/>toml: `upstream_timeout` | duration | maximum amount of time the server will wait for a response from the upstream | 30s |
|
|
||||||
| flag: `--upstream`<br/>toml: `upstreams` | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path | |
|
|
||||||
|
|
||||||
## Upstreams Configuration
|
|
||||||
|
|
||||||
`oauth2-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers, unix socket or serve static files from the file system.
|
|
||||||
|
|
||||||
To configure **HTTP and HTTPS upstreams**, provide such a URL in `--upstream=URL`. The scheme+host portion and the path portion are extracted to configure proxying behavior. When processing incoming requests, the path portion becomes a lookup key for selecting the destination server of the proxied request.
|
|
||||||
|
|
||||||
* Upstream URLs *without a trailing slash,* like in `--upstream=http://service2.internal/foo`, will match an incoming request exactly to `/foo` in `https://this.o2p.example.com/foo`, and forward the request on to service2.internal, but not match a request to `https://this.o2p.example.com/foo/more` nor ...`.com/food`.
|
|
||||||
* Upstream URLs *with a trailing slash,* like in `--upstream=http://service1.internal/foo/`, will match any incoming request to any incoming requests's path *starting with* `/foo/`, like `/foo/` and `/foo/more` and `/foo/lots/more?etc`.
|
|
||||||
|
|
||||||
If multiple `--upstream` URLs' paths match an incoming request, the one with the longest matching path (the most specific match) takes priority over shorter (less specific) ones.
|
|
||||||
|
|
||||||
**Unix socket upstreams** are configured as `unix:///path/to/unix.sock`.
|
|
||||||
|
|
||||||
**Static file paths** are configured as a file:// URL. `file:///var/www/static/` will serve the files from that directory at `http://[oauth2-proxy url]/var/www/static/`, which may not be what you want. You can provide the path to where the files should be available by adding a fragment to the configured URL. The value of the fragment will then be used to specify which path the files are available at, e.g. `file:///var/www/static/#/static/` will make `/var/www/static/` available at `http://[oauth2-proxy url]/static/`.
|
|
||||||
|
|
||||||
Multiple upstreams can either be configured by supplying a comma separated list to the `--upstream` parameter, supplying the parameter multiple times or providing a list in the [config file](#config-file). When multiple upstreams are used routing to them will be based on the path they are set up with.
|
|
||||||
|
|
||||||
## Environment variables
|
|
||||||
|
|
||||||
Every command line argument can be specified as an environment variable by
|
|
||||||
prefixing it with `OAUTH2_PROXY_`, capitalising it, and replacing hyphens (`-`)
|
|
||||||
with underscores (`_`). If the argument can be specified multiple times, the
|
|
||||||
environment variable should be plural (trailing `S`).
|
|
||||||
|
|
||||||
This is particularly useful for storing secrets outside a configuration file
|
|
||||||
or the command line.
|
|
||||||
|
|
||||||
For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.
|
|
||||||
If a flag has the type `string | list` like the `--email-domain` flag it is
|
|
||||||
available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS`
|
|
||||||
|
|
||||||
Values for type `string | list` usually have a plural environment variable name
|
|
||||||
and need to be seperated by `,` e.g.
|
|
||||||
`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"`
|
|
||||||
|
|
||||||
Please check the type for each [config option](#config-options) first.
|
|
||||||
|
|
||||||
## Logging Configuration
|
|
||||||
|
|
||||||
By default, OAuth2 Proxy logs all output to stdout. Logging can be configured to output to a rotating log file using the `--logging-filename` command.
|
|
||||||
|
|
||||||
If logging to a file you can also configure the maximum file size (`--logging-max-size`), age (`--logging-max-age`), max backup logs (`--logging-max-backups`), and if backup logs should be compressed (`--logging-compress`).
|
|
||||||
|
|
||||||
There are three different types of logging: standard, authentication, and HTTP requests. These can each be enabled or disabled with `--standard-logging`, `--auth-logging`, and `--request-logging`.
|
|
||||||
|
|
||||||
Each type of logging has its own configurable format and variables. By default, these formats are similar to the Apache Combined Log.
|
|
||||||
|
|
||||||
Logging of requests to the `/ping` endpoint (or using `--ping-user-agent`) and the `/ready` endpoint can be disabled with `--silence-ping-logging` reducing log volume.
|
|
||||||
|
|
||||||
## Auth Log Format
|
|
||||||
|
|
||||||
Authentication logs are logs which are guaranteed to contain a username or email address of a user attempting to authenticate. These logs are output by default in the below format:
|
|
||||||
|
|
||||||
```
|
|
||||||
<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] [<STATUS>] <MESSAGE>
|
|
||||||
```
|
|
||||||
|
|
||||||
The status block will contain one of the below strings:
|
|
||||||
|
|
||||||
- `AuthSuccess` If a user has authenticated successfully by any method
|
|
||||||
- `AuthFailure` If the user failed to authenticate explicitly
|
|
||||||
- `AuthError` If there was an unexpected error during authentication
|
|
||||||
|
|
||||||
If you require a different format than that, you can configure it with the `--auth-logging-format` flag.
|
|
||||||
The default format is configured as follows:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{.Client}} - {{.RequestID}} - {{.Username}} [{{.Timestamp}}] [{{.Status}}] {{.Message}}
|
|
||||||
```
|
|
||||||
|
|
||||||
Available variables for auth logging:
|
|
||||||
|
|
||||||
| Variable | Example | Description |
|
|
||||||
| ------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
||||||
| Client | 74.125.224.72 | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
|
|
||||||
| Host | domain.com | The value of the Host header. |
|
|
||||||
| Message | Authenticated via OAuth2 | The details of the auth attempt. |
|
|
||||||
| Protocol | HTTP/1.0 | The request protocol. |
|
|
||||||
| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |
|
|
||||||
| RequestMethod | GET | The request method. |
|
|
||||||
| Timestamp | 2015/03/19 17:20:19 | The date and time of the logging event. |
|
|
||||||
| UserAgent | - | The full user agent as reported by the requesting client. |
|
|
||||||
| Username | username@email.com | The email or username of the auth request. |
|
|
||||||
| Status | AuthSuccess | The status of the auth request. See above for details. |
|
|
||||||
|
|
||||||
## Request Log Format
|
|
||||||
|
|
||||||
HTTP request logs will output by default in the below format:
|
|
||||||
|
|
||||||
```
|
|
||||||
<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] <HOST_HEADER> GET <UPSTREAM_HOST> "/path/" HTTP/1.1 "<USER_AGENT>" <RESPONSE_CODE> <RESPONSE_BYTES> <REQUEST_DURATION>
|
|
||||||
```
|
|
||||||
|
|
||||||
If you require a different format than that, you can configure it with the `--request-logging-format` flag.
|
|
||||||
The default format is configured as follows:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{.Client}} - {{.RequestID}} - {{.Username}} [{{.Timestamp}}] {{.Host}} {{.RequestMethod}} {{.Upstream}} {{.RequestURI}} {{.Protocol}} {{.UserAgent}} {{.StatusCode}} {{.ResponseSize}} {{.RequestDuration}}
|
|
||||||
```
|
|
||||||
|
|
||||||
Available variables for request logging:
|
|
||||||
|
|
||||||
| Variable | Example | Description |
|
|
||||||
| --------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |
|
|
||||||
| Client | 74.125.224.72 | The client/remote IP address. Will use the X-Real-IP header it if exists & reverse-proxy is set to true. |
|
|
||||||
| Host | domain.com | The value of the Host header. |
|
|
||||||
| Protocol | HTTP/1.0 | The request protocol. |
|
|
||||||
| RequestDuration | 0.001 | The time in seconds that a request took to process. |
|
|
||||||
| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |
|
|
||||||
| RequestMethod | GET | The request method. |
|
|
||||||
| RequestURI | "/oauth2/auth" | The URI path of the request. |
|
|
||||||
| ResponseSize | 12 | The size in bytes of the response. |
|
|
||||||
| StatusCode | 200 | The HTTP status code of the response. |
|
|
||||||
| Timestamp | 2015/03/19 17:20:19 | The date and time of the logging event. |
|
|
||||||
| Upstream | - | The upstream data of the HTTP request. |
|
|
||||||
| UserAgent | - | The full user agent as reported by the requesting client. |
|
|
||||||
| Username | username@email.com | The email or username of the auth request. |
|
|
||||||
|
|
||||||
## Standard Log Format
|
|
||||||
|
|
||||||
All other logging that is not covered by the above two types of logging will be output in this standard logging format. This includes configuration information at startup and errors that occur outside of a session. The default format is below:
|
|
||||||
|
|
||||||
```
|
|
||||||
[2015/03/19 17:20:19] [main.go:40] <MESSAGE>
|
|
||||||
```
|
|
||||||
|
|
||||||
If you require a different format than that, you can configure it with the `--standard-logging-format` flag. The default format is configured as follows:
|
|
||||||
|
|
||||||
```
|
|
||||||
[{{.Timestamp}}] [{{.File}}] {{.Message}}
|
|
||||||
```
|
|
||||||
|
|
||||||
Available variables for standard logging:
|
|
||||||
|
|
||||||
| Variable | Example | Description |
|
|
||||||
| --------- | --------------------------------- | -------------------------------------------------- |
|
|
||||||
| Timestamp | 2015/03/19 17:20:19 | The date and time of the logging event. |
|
|
||||||
| File | main.go:40 | The file and line number of the logging statement. |
|
|
||||||
| Message | HTTP: listening on 127.0.0.1:4180 | The details of the log statement. |
|
|
||||||
|
|
@ -1,19 +0,0 @@
|
||||||
---
|
|
||||||
id: adfs
|
|
||||||
title: ADFS
|
|
||||||
---
|
|
||||||
|
|
||||||
1. Open the ADFS administration console on your Windows Server and add a new Application Group
|
|
||||||
2. Provide a name for the integration, select Server Application from the Standalone applications section and click Next
|
|
||||||
3. Follow the wizard to get the client-id, client-secret and configure the application credentials
|
|
||||||
4. Configure the proxy with
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider=adfs
|
|
||||||
--client-id=<application ID from step 3>
|
|
||||||
--client-secret=<value from step 3>
|
|
||||||
```
|
|
||||||
|
|
||||||
Note: When using the ADFS Auth provider with nginx and the cookie session store you may find the cookie is too large and
|
|
||||||
doesn't get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the
|
|
||||||
[redis session storage](../sessions.md#redis-storage) should resolve this.
|
|
||||||
|
|
@ -1,25 +0,0 @@
|
||||||
---
|
|
||||||
id: bitbucket
|
|
||||||
title: BitBucket
|
|
||||||
---
|
|
||||||
|
|
||||||
1. [Add a new OAuth consumer](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html)
|
|
||||||
* In "Callback URL" use `https://<oauth2-proxy>/oauth2/callback`, substituting `<oauth2-proxy>` with the actual
|
|
||||||
hostname that oauth2-proxy is running on.
|
|
||||||
* In Permissions section select:
|
|
||||||
* Account -> Email
|
|
||||||
* Team membership -> Read
|
|
||||||
* Repositories -> Read
|
|
||||||
2. Note the Client ID and Client Secret.
|
|
||||||
|
|
||||||
To use the provider, pass the following options:
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider=bitbucket
|
|
||||||
--client-id=<Client ID>
|
|
||||||
--client-secret=<Client Secret>
|
|
||||||
```
|
|
||||||
|
|
||||||
The default configuration allows everyone with Bitbucket account to authenticate. To restrict the access to the team
|
|
||||||
members use additional configuration option: `--bitbucket-team=<Team name>`. To restrict the access to only these users
|
|
||||||
who have access to one selected repository use `--bitbucket-repository=<Repository name>`.
|
|
||||||
|
|
@ -1,37 +0,0 @@
|
||||||
---
|
|
||||||
id: cidaas
|
|
||||||
title: Cidaas
|
|
||||||
---
|
|
||||||
|
|
||||||
[Cidaas](https://www.cidaas.com/) is an Identity as a Service (IDaaS) solution that provides authentication and authorization services.
|
|
||||||
It supports various protocols including OpenID Connect, OAuth 2.0, and SAML.
|
|
||||||
|
|
||||||
However, Cidaas provides groups and their roles as hierarchical claims, which are not supported by oauth2-proxy yet.
|
|
||||||
The Cidaas provider transforms the hierarchical claims into a flat list of groups, which can be used by oauth2-proxy.
|
|
||||||
|
|
||||||
Example of groups and roles in Cidaas:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"groups": [
|
|
||||||
{
|
|
||||||
"groupId": "group1",
|
|
||||||
"roles": ["role1", "role2"]
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"groupId": "group2",
|
|
||||||
"roles": ["role3"]
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
This will be transformed into a flat list of groups:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"groups": ["group1:role1", "group2:role2", "group2:role3"]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Apart from that the Cidaas provider inherits all the features of the [OpenID Connect provider](openid_connect.md).
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
---
|
|
||||||
id: digitalocean
|
|
||||||
title: DigitalOcean
|
|
||||||
---
|
|
||||||
|
|
||||||
1. [Create a new OAuth application](https://cloud.digitalocean.com/account/api/applications)
|
|
||||||
* You can fill in the name, homepage, and description however you wish.
|
|
||||||
* In the "Application callback URL" field, enter: `https://oauth-proxy/oauth2/callback`, substituting `oauth2-proxy`
|
|
||||||
with the actual hostname that oauth2-proxy is running on. The URL must match oauth2-proxy's configured redirect URL.
|
|
||||||
2. Note the Client ID and Client Secret.
|
|
||||||
|
|
||||||
To use the provider, pass the following options:
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider=digitalocean
|
|
||||||
--client-id=<Client ID>
|
|
||||||
--client-secret=<Client Secret>
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, set the equivalent options in the config file. The redirect URL defaults to
|
|
||||||
`https://<requested host header>/oauth2/callback`. If you need to change it, you can use the `--redirect-url` command-line option.
|
|
||||||
|
|
@ -1,7 +0,0 @@
|
||||||
---
|
|
||||||
id: facebook
|
|
||||||
title: Facebook
|
|
||||||
---
|
|
||||||
|
|
||||||
1. Create a new FB App from https://developers.facebook.com/
|
|
||||||
2. Under FB Login, set your Valid OAuth redirect URIs to `https://internal.yourcompany.com/oauth2/callback`
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
---
|
|
||||||
id: gitea
|
|
||||||
title: Gitea / Forgejo
|
|
||||||
---
|
|
||||||
|
|
||||||
:::note
|
|
||||||
This is not actually a fully serparate provider. For more details and options please refer to the [GitHub Provider Options](github.md)
|
|
||||||
:::
|
|
||||||
|
|
||||||
1. Create a new application: `https://< your gitea host >/user/settings/applications`
|
|
||||||
2. Under `Redirect URI` enter the correct URL i.e. `https://<proxied host>/oauth2/callback`
|
|
||||||
3. Note the Client ID and Client Secret.
|
|
||||||
4. Pass the following options to the proxy:
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider="github"
|
|
||||||
--redirect-url="https://<proxied host>/oauth2/callback"
|
|
||||||
--provider-display-name="Gitea"
|
|
||||||
--client-id="< client_id as generated by Gitea >"
|
|
||||||
--client-secret="< client_secret as generated by Gitea >"
|
|
||||||
--login-url="https://< your gitea host >/login/oauth/authorize"
|
|
||||||
--redeem-url="https://< your gitea host >/login/oauth/access_token"
|
|
||||||
--validate-url="https://< your gitea host >/api/v1/user/emails"
|
|
||||||
```
|
|
||||||
|
|
@ -1,81 +0,0 @@
|
||||||
---
|
|
||||||
id: github
|
|
||||||
title: GitHub
|
|
||||||
---
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
|
||||||
| ---------------- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| `--github-org` | `github_org` | string | restrict logins to members of this organisation | |
|
|
||||||
| `--github-team` | `github_team` | string | restrict logins to members of any of these teams (slug) or (org:team), comma separated | |
|
|
||||||
| `--github-repo` | `github_repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |
|
|
||||||
| `--github-token` | `github_token` | string | the token to use when verifying repository collaborators (must have push access to the repository) | |
|
|
||||||
| `--github-user` | `github_users` | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators | |
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
1. Create a new project: https://github.com/settings/developers
|
|
||||||
2. Under `Authorization callback URL` enter the correct url ie `https://internal.yourcompany.com/oauth2/callback`
|
|
||||||
|
|
||||||
The GitHub auth provider supports two additional ways to restrict authentication to either organization and optional
|
|
||||||
team level access, or to collaborators of a repository. Restricting by these options is normally accompanied with `--email-domain=*`. Additionally, all the organizations and teams a user belongs to are set as part of the `X-Forwarded-Groups` header. e.g. `org1:team1,org1:team2,org2:team1`
|
|
||||||
|
|
||||||
NOTE: When `--github-user` is set, the specified users are allowed to log in even if they do not belong to the specified
|
|
||||||
org and team or collaborators.
|
|
||||||
|
|
||||||
To restrict access to your organization:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# restrict logins to members of this organisation
|
|
||||||
--github-org="your-org"
|
|
||||||
```
|
|
||||||
|
|
||||||
To restrict access to specific teams within an organization:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
--github-org="your-org"
|
|
||||||
# restrict logins to members of any of these teams (slug), comma separated
|
|
||||||
--github-team="team1,team2,team3"
|
|
||||||
```
|
|
||||||
|
|
||||||
To restrict to teams within different organizations, keep the organization flag empty and use `--github-team` like so:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# keep empty
|
|
||||||
--github-org=""
|
|
||||||
# restrict logins to members to any of the following teams (format <org>:<slug>, like octo:team1), comma separated
|
|
||||||
--github-team="org1:team1,org2:team1,org3:team42,octo:cat"
|
|
||||||
```
|
|
||||||
|
|
||||||
If you would rather restrict access to collaborators of a repository, those users must either have push access to a
|
|
||||||
public repository or any access to a private repository:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# restrict logins to collaborators of this repository formatted as orgname/repo
|
|
||||||
--github-repo=""
|
|
||||||
```
|
|
||||||
|
|
||||||
If you'd like to allow access to users with **read only** access to a **public** repository you will need to provide a
|
|
||||||
[token](https://github.com/settings/tokens) for a user that has write access to the repository. The token must be
|
|
||||||
created with at least the `public_repo` scope:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# the token to use when verifying repository collaborators
|
|
||||||
--github-token=""
|
|
||||||
```
|
|
||||||
|
|
||||||
To allow a user to log in with their username even if they do not belong to the specified org and team or collaborators:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
# allow logins by username, comma separated
|
|
||||||
--github-user=""
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are using GitHub enterprise, make sure you set the following to the appropriate url:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
--login-url="http(s)://<enterprise github host>/login/oauth/authorize"
|
|
||||||
--redeem-url="http(s)://<enterprise github host>/login/oauth/access_token"
|
|
||||||
--validate-url="http(s)://<enterprise github host>/api/v3"
|
|
||||||
```
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
---
|
|
||||||
id: gitlab
|
|
||||||
title: GitLab
|
|
||||||
---
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
|
||||||
| ------------------- | ----------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| `--gitlab-group` | `gitlab_groups` | string \| list | restrict logins to members of any of these groups (slug), separated by a comma | |
|
|
||||||
| `--gitlab-projects` | `gitlab_projects` | string \| list | restrict logins to members of any of these projects (may be given multiple times) formatted as `orgname/repo=accesslevel`. Access level should be a value matching [Gitlab access levels](https://docs.gitlab.com/ee/api/members.html#valid-access-levels), defaulted to 20 if absent | |
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
This auth provider has been tested against Gitlab version 12.X. Due to Gitlab API changes, it may not work for version
|
|
||||||
prior to 12.X (see [994](https://github.com/oauth2-proxy/oauth2-proxy/issues/994)).
|
|
||||||
|
|
||||||
Whether you are using GitLab.com or self-hosting GitLab, follow
|
|
||||||
[these steps to add an application](https://docs.gitlab.com/integration/oauth_provider/). Make sure to enable at
|
|
||||||
least the `openid`, `profile` and `email` scopes, and set the redirect url to your application url e.g.
|
|
||||||
https://myapp.com/oauth2/callback.
|
|
||||||
|
|
||||||
If you need projects filtering, add the extra `read_api` scope to your application.
|
|
||||||
|
|
||||||
The following config should be set to ensure that the oauth will work properly. To get a cookie secret follow
|
|
||||||
[these steps](../overview.md#generating-a-cookie-secret)
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider="gitlab"
|
|
||||||
--redirect-url="https://myapp.com/oauth2/callback" // Should be the same as the redirect url for the application in gitlab
|
|
||||||
--client-id=GITLAB_CLIENT_ID
|
|
||||||
--client-secret=GITLAB_CLIENT_SECRET
|
|
||||||
--cookie-secret=COOKIE_SECRET
|
|
||||||
```
|
|
||||||
|
|
||||||
Restricting by group membership is possible with the following option:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
--gitlab-group="mygroup,myothergroup" # restrict logins to members of any of these groups (slug), separated by a comma
|
|
||||||
```
|
|
||||||
|
|
||||||
If you are using self-hosted GitLab, make sure you set the following to the appropriate URL:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
--oidc-issuer-url="<your gitlab url>"
|
|
||||||
```
|
|
||||||
|
|
||||||
If your self-hosted GitLab is on a subdirectory (e.g. domain.tld/gitlab), as opposed to its own subdomain
|
|
||||||
(e.g. gitlab.domain.tld), you may need to add a redirect from domain.tld/oauth pointing at e.g. domain.tld/gitlab/oauth.
|
|
||||||
|
|
@ -1,75 +0,0 @@
|
||||||
---
|
|
||||||
id: google
|
|
||||||
title: Google (default)
|
|
||||||
---
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
|
||||||
| ---------------------------------------------- | -------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
|
|
||||||
| `--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-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-target-principal` | `google_target_principal` | bool | the target principal to impersonate when using ADC | defaults to the service account configured for ADC |
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
For Google, the registration steps are:
|
|
||||||
|
|
||||||
1. Create a new project: https://console.developers.google.com/project
|
|
||||||
2. Choose the new project from the top right project dropdown (only if another project is selected)
|
|
||||||
3. In the project Dashboard center pane, choose **"APIs & Services"**
|
|
||||||
4. In the left Nav pane, choose **"Credentials"**
|
|
||||||
5. In the center pane, choose **"OAuth consent screen"** tab. Fill in **"Product name shown to users"** and hit save.
|
|
||||||
6. In the center pane, choose **"Credentials"** tab.
|
|
||||||
- Open the **"New credentials"** drop down
|
|
||||||
- Choose **"OAuth client ID"**
|
|
||||||
- Choose **"Web application"**
|
|
||||||
- Application name is freeform, choose something appropriate
|
|
||||||
- Authorized JavaScript origins is your domain ex: `https://internal.yourcompany.com`
|
|
||||||
- Authorized redirect URIs is the location of oauth2/callback ex: `https://internal.yourcompany.com/oauth2/callback`
|
|
||||||
- Choose **"Create"**
|
|
||||||
7. Take note of the **Client ID** and **Client Secret**
|
|
||||||
|
|
||||||
It's recommended to refresh sessions on a short interval (1h) with `cookie-refresh` setting which validates that the
|
|
||||||
account is still authorized.
|
|
||||||
|
|
||||||
#### Restrict auth to specific Google groups on your domain. (optional)
|
|
||||||
|
|
||||||
1. Create a [service account](https://developers.google.com/identity/protocols/oauth2/service-account) and configure it
|
|
||||||
to use [Application Default Credentials / Workload Identity / Workload Identity Federation (recommended)](#using-application-default-credentials-adc--workload-identity--workload-identity-federation-recommended) or,
|
|
||||||
alternatively download the JSON.
|
|
||||||
2. Make note of the Client ID for a future step.
|
|
||||||
3. Under "APIs & Auth", choose APIs.
|
|
||||||
4. Click on Admin SDK and then Enable API.
|
|
||||||
5. Follow the steps on [Set up domain-wide delegation for a service account](https://developers.google.com/workspace/guides/create-credentials#optional_set_up_domain-wide_delegation_for_a_service_account)
|
|
||||||
and give the client id from step 2 the following oauth scopes:
|
|
||||||
|
|
||||||
```
|
|
||||||
https://www.googleapis.com/auth/admin.directory.group.member.readonly
|
|
||||||
```
|
|
||||||
|
|
||||||
6. Follow the steps on https://support.google.com/a/answer/60757 to enable Admin API access.
|
|
||||||
7. Create or choose an existing administrative email address on the Gmail domain to assign to the `google-admin-email`
|
|
||||||
flag. This email will be impersonated by this client to make calls to the Admin SDK. See the note on the link from
|
|
||||||
step 5 for the reason why.
|
|
||||||
8. Create or choose an existing email group and set that email to the `google-group` flag. You can pass multiple instances
|
|
||||||
of this flag with different groups and the user will be checked against all the provided groups.
|
|
||||||
|
|
||||||
(Only if using a JSON file (see step 1))
|
|
||||||
|
|
||||||
9. Lock down the permissions on the json file downloaded from step 1 so only oauth2-proxy is able to read the file and
|
|
||||||
set the path to the file in the `google-service-account-json` flag.
|
|
||||||
10. Restart oauth2-proxy.
|
|
||||||
|
|
||||||
Note: The user is checked against the group members list on initial authentication and every time the token is
|
|
||||||
refreshed ( about once an hour ).
|
|
||||||
|
|
||||||
##### Using Application Default Credentials (ADC) / Workload Identity / Workload Identity Federation (recommended)
|
|
||||||
oauth2-proxy can make use of [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials).
|
|
||||||
When deployed within GCP, this means that it can automatically use the service account attached to the resource. When deployed to GKE, ADC
|
|
||||||
can be leveraged through a feature called Workload Identity. Follow Google's [guide](https://cloud.google.com/kubernetes-engine/docs/how-to/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.
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
---
|
|
||||||
id: index
|
|
||||||
title: OAuth Provider Configuration
|
|
||||||
---
|
|
||||||
|
|
||||||
You will need to register an OAuth application with a Provider (Google, GitHub or another provider), and configure it
|
|
||||||
with Redirect URI(s) for the domain you intend to run `oauth2-proxy` on.
|
|
||||||
|
|
||||||
Valid providers are :
|
|
||||||
|
|
||||||
- [ADFS](adfs.md)
|
|
||||||
- [Bitbucket](bitbucket.md)
|
|
||||||
- [Cidaas](cidaas.md)
|
|
||||||
- [DigitalOcean](digitalocean.md)
|
|
||||||
- [Facebook](facebook.md)
|
|
||||||
- [Gitea](gitea.md)
|
|
||||||
- [GitHub](github.md)
|
|
||||||
- [GitLab](gitlab.md)
|
|
||||||
- [Google](google.md) _default_
|
|
||||||
- [Keycloak](keycloak.md) (Deprecated)
|
|
||||||
- [Keycloak OIDC](keycloak_oidc.md)
|
|
||||||
- [LinkedIn](linkedin.md)
|
|
||||||
- [login.gov](login_gov.md)
|
|
||||||
- [Microsoft Azure](ms_azure_ad.md) (Deprecated)
|
|
||||||
- [Microsoft Entra ID](ms_entra_id.md)
|
|
||||||
- [Nextcloud](nextcloud.md)
|
|
||||||
- [OpenID Connect](openid_connect.md)
|
|
||||||
- [SourceHut](sourcehut.md)
|
|
||||||
|
|
||||||
The provider can be selected using the `provider` configuration value, or set in the [`providers` array using AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers). However, [**the feature to implement multiple providers is not complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).
|
|
||||||
|
|
||||||
Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the
|
|
||||||
OpenID Connect provider.
|
|
||||||
|
|
||||||
## Email Authentication
|
|
||||||
|
|
||||||
To authorize a specific email-domain use `--email-domain=yourcompany.com`. To authorize individual email addresses use
|
|
||||||
`--authenticated-emails-file=/path/to/file` with one email per line. To authorize all email addresses use `--email-domain=*`.
|
|
||||||
|
|
||||||
## Adding a new Provider
|
|
||||||
|
|
||||||
Follow the examples in the [`providers` package](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/providers/) to define a new
|
|
||||||
`Provider` instance. Add a new `case` to
|
|
||||||
[`providers.New()`](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/providers/providers.go) to allow `oauth2-proxy` to use the
|
|
||||||
new `Provider`.
|
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
---
|
|
||||||
id: keycloak
|
|
||||||
title: Keycloak (Deprecated)
|
|
||||||
---
|
|
||||||
|
|
||||||
:::note
|
|
||||||
This is the legacy and deprecated provider for Keycloak, use [Keycloak OIDC Auth Provider](keycloak_oidc.md) if possible.
|
|
||||||
:::
|
|
||||||
|
|
||||||
1. Create new client in your Keycloak realm with **Access Type** 'confidential' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'
|
|
||||||
2. Take note of the Secret in the credential tab of the client
|
|
||||||
3. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.
|
|
||||||
|
|
||||||
Make sure you set the following to the appropriate url:
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider=keycloak
|
|
||||||
--client-id=<client you have created>
|
|
||||||
--client-secret=<your client's secret>
|
|
||||||
--login-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/auth"
|
|
||||||
--redeem-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/token"
|
|
||||||
--profile-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/userinfo"
|
|
||||||
--validate-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/userinfo"
|
|
||||||
--keycloak-group=<first_allowed_user_group>
|
|
||||||
--keycloak-group=<second_allowed_user_group>
|
|
||||||
```
|
|
||||||
|
|
||||||
For group based authorization, the optional `--keycloak-group` (legacy) or `--allowed-group` (global standard)
|
|
||||||
flags can be used to specify which groups to limit access to.
|
|
||||||
|
|
||||||
If these are unset but a `groups` mapper is set up above in step (3), the provider will still
|
|
||||||
populate the `X-Forwarded-Groups` header to your upstream server with the `groups` data in the
|
|
||||||
Keycloak userinfo endpoint response.
|
|
||||||
|
|
||||||
The group management in keycloak is using a tree. If you create a group named admin in keycloak
|
|
||||||
you should define the 'keycloak-group' value to /admin.
|
|
||||||
|
|
@ -1,151 +0,0 @@
|
||||||
---
|
|
||||||
id: keycloak_oidc
|
|
||||||
title: Keycloak OIDC
|
|
||||||
---
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
|
||||||
| ---------------- | --------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ | ------- |
|
|
||||||
| `--allowed-role` | `allowed_roles` | string \| list | restrict logins to users with this role (may be given multiple times). Only works with the keycloak-oidc provider. | |
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider=keycloak-oidc
|
|
||||||
--client-id=<your client's id>
|
|
||||||
--client-secret=<your client's secret>
|
|
||||||
--redirect-url=https://internal.yourcompany.com/oauth2/callback
|
|
||||||
--oidc-issuer-url=https://<keycloak host>/realms/<your realm> // For Keycloak versions <17: --oidc-issuer-url=https://<keycloak host>/auth/realms/<your realm>
|
|
||||||
--email-domain=<yourcompany.com> // Validate email domain for users, see option documentation
|
|
||||||
--allowed-role=<realm role name> // Optional, required realm role
|
|
||||||
--allowed-role=<client id>:<client role name> // Optional, required client role
|
|
||||||
--allowed-group=</group name> // Optional, requires group client scope
|
|
||||||
--code-challenge-method=S256 // PKCE
|
|
||||||
```
|
|
||||||
|
|
||||||
:::note
|
|
||||||
Keycloak has updated its admin console and as of version 19.0.0, the new admin console is enabled by default. The
|
|
||||||
legacy admin console has been announced for removal with the release of version 21.0.0.
|
|
||||||
:::
|
|
||||||
|
|
||||||
**Keycloak legacy admin console**
|
|
||||||
|
|
||||||
1. Create new client in your Keycloak realm with **Access Type** 'confidential', **Client protocol** 'openid-connect'
|
|
||||||
and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'
|
|
||||||
2. Take note of the Secret in the credential tab of the client
|
|
||||||
3. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.
|
|
||||||
4. Create a mapper with **Mapper Type** 'Audience' and **Included Client Audience** and **Included Custom Audience** set
|
|
||||||
to your client name.
|
|
||||||
|
|
||||||
**Keycloak new admin console (default as of v19.0.0)**
|
|
||||||
|
|
||||||
The following example shows how to create a simple OIDC client using the new Keycloak admin2 console. However, for best
|
|
||||||
practices, it is recommended to consult the Keycloak documentation.
|
|
||||||
|
|
||||||
The OIDC client must be configured with an _audience mapper_ to include the client's name in the `aud` claim of the JWT token.
|
|
||||||
The `aud` claim specifies the intended recipient of the token, and OAuth2 Proxy expects a match against the values of
|
|
||||||
either `--client-id` or `--oidc-extra-audience`.
|
|
||||||
|
|
||||||
_In Keycloak, claims are added to JWT tokens through the use of mappers at either the realm level using "client scopes" or
|
|
||||||
through "dedicated" client mappers._
|
|
||||||
|
|
||||||
**Creating the client**
|
|
||||||
|
|
||||||
1. Create a new OIDC client in your Keycloak realm by navigating to:
|
|
||||||
**Clients** -> **Create client**
|
|
||||||
* **Client Type** 'OpenID Connect'
|
|
||||||
* **Client ID** `<your client's id>`, please complete the remaining fields as appropriate and click **Next**.
|
|
||||||
* **Client authentication** 'On'
|
|
||||||
* **Authentication flow**
|
|
||||||
* **Standard flow** 'selected'
|
|
||||||
* **Direct access grants** 'deselect'
|
|
||||||
* _Save the configuration._
|
|
||||||
* **Settings / Access settings**:
|
|
||||||
* **Valid redirect URIs** `https://internal.yourcompany.com/oauth2/callback`
|
|
||||||
* _Save the configuration._
|
|
||||||
* Under the **Credentials** tab you will now be able to locate `<your client's secret>`.
|
|
||||||
2. Configure a dedicated *audience mapper* for your client by navigating to **Clients** -> **\<your client's id\>** -> **Client scopes**.
|
|
||||||
* Access the dedicated mappers pane by clicking **\<your client's id\>-dedicated**, located under *Assigned client scope*.
|
|
||||||
_(It should have a description of "Dedicated scope and mappers for this client")_
|
|
||||||
* Click **Configure a new mapper** and select **Audience**
|
|
||||||
* **Name** 'aud-mapper-\<your client's id\>'
|
|
||||||
* **Included Client Audience** select `<your client's id>` from the dropdown.
|
|
||||||
* _OAuth2 proxy can be set up to pass both the access and ID JWT tokens to your upstream services.
|
|
||||||
If you require additional audience entries, you can use the **Included Custom Audience** field in addition
|
|
||||||
to the "Included Client Audience" dropdown. Note that the "aud" claim of a JWT token should be limited and
|
|
||||||
only specify its intended recipients._
|
|
||||||
* **Add to ID token** 'On'
|
|
||||||
* **Add to access token** 'On' - [#1916](https://github.com/oauth2-proxy/oauth2-proxy/pull/1916)
|
|
||||||
* _Save the configuration._
|
|
||||||
* Any subsequent dedicated client mappers can be defined by clicking **Dedicated scopes** -> **Add mapper** ->
|
|
||||||
**By configuration** -> *Select mapper*
|
|
||||||
|
|
||||||
You should now be able to create a test user in Keycloak and get access to the OAuth2 Proxy instance, make sure to set
|
|
||||||
an email address matching `<yourcompany.com>` and select _Email verified_.
|
|
||||||
|
|
||||||
**Authorization**
|
|
||||||
|
|
||||||
_OAuth2 Proxy will perform authorization by requiring a valid user, this authorization can be extended to take into
|
|
||||||
account a user's membership in Keycloak `groups`, `realm roles`, and `client roles` using the keycloak-oidc provider options
|
|
||||||
`--allowed-role` or `--allowed-group`_
|
|
||||||
|
|
||||||
**Roles**
|
|
||||||
|
|
||||||
_A standard Keycloak installation comes with the required mappers for **realm roles** and **client roles** through the
|
|
||||||
pre-defined client scope "roles". This ensures that any roles assigned to a user are included in the `JWT` tokens when
|
|
||||||
using an OIDC client that has the "Full scope allowed" feature activated, the feature is enabled by default._
|
|
||||||
|
|
||||||
_Creating a realm role_
|
|
||||||
* Navigate to **Realm roles** -> **Create role**
|
|
||||||
* **Role name**, *`<realm role name>`* -> **save**
|
|
||||||
|
|
||||||
_Creating a client role_
|
|
||||||
* Navigate to **Clients** -> `<your client's id>` -> **Roles** -> **Create role**
|
|
||||||
* **Role name**, *`<client role name>`* -> **save**
|
|
||||||
|
|
||||||
|
|
||||||
_Assign a role to a user_
|
|
||||||
|
|
||||||
**Users** -> _Username_ -> **Role mapping** -> **Assign role** -> _filter by roles or clients and select_ -> **Assign**.
|
|
||||||
|
|
||||||
Keycloak "realm roles" can be authorized using the `--allowed-role=<realm role name>` option, while "client roles" can be
|
|
||||||
evaluated using `--allowed-role=<your client's id>:<client role name>`.
|
|
||||||
|
|
||||||
You may limit the _realm roles_ included in the JWT tokens for any given client by navigating to:
|
|
||||||
**Clients** -> `<your client's id>` -> **Client scopes** -> _\<your client's id\>-dedicated_ -> **Scope**
|
|
||||||
Disabling **Full scope allowed** activates the **Assign role** option, allowing you to select which roles, if assigned
|
|
||||||
to a user, will be included in the user's JWT tokens. This can be useful when a user has many associated roles, and you
|
|
||||||
want to reduce the size and impact of the JWT token.
|
|
||||||
|
|
||||||
|
|
||||||
**Groups**
|
|
||||||
|
|
||||||
You may also do authorization on group memberships by using the OAuth2 Proxy option `--allowed-group`.
|
|
||||||
We will only do a brief description of creating the required _client scope_ **groups** and refer you to read the Keycloak
|
|
||||||
documentation.
|
|
||||||
|
|
||||||
To summarize, the steps required to authorize Keycloak group membership with OAuth2 Proxy are as follows:
|
|
||||||
|
|
||||||
* Create a new Client Scope with the name **groups** in Keycloak.
|
|
||||||
* Include a mapper of type **Group Membership**.
|
|
||||||
* Set the "Token Claim Name" to **groups** or customize by matching it to the `--oidc-groups-claim` option of OAuth2 Proxy.
|
|
||||||
* If the "Full group path" option is selected, you need to include a "/" separator in the group names defined in the
|
|
||||||
`--allowed-group` option of OAuth2 Proxy. Example: "/groupname" or "/groupname/child_group".
|
|
||||||
|
|
||||||
After creating the _Client Scope_ named _groups_ you will need to attach it to your client.
|
|
||||||
**Clients** -> `<your client's id>` -> **Client scopes** -> **Add client scope** -> Select **groups** and choose Optional
|
|
||||||
and you should now have a client that maps group memberships into the JWT tokens so that Oauth2 Proxy may evaluate them.
|
|
||||||
|
|
||||||
Create a group by navigating to **Groups** -> **Create group** and _add_ your test user as a member.
|
|
||||||
|
|
||||||
The OAuth2 Proxy option `--allowed-group=/groupname` will now allow you to filter on group membership
|
|
||||||
|
|
||||||
Keycloak also has the option of attaching roles to groups, please refer to the Keycloak documentation for more information.
|
|
||||||
|
|
||||||
**Tip**
|
|
||||||
|
|
||||||
To check if roles or groups are added to JWT tokens, you can preview a users token in the Keycloak console by following
|
|
||||||
these steps: **Clients** -> `<your client's id>` -> **Client scopes** -> **Evaluate**.
|
|
||||||
Select a _realm user_ and optional _scope parameters_ such as groups, and generate the JSON representation of an access
|
|
||||||
or id token to examine its contents.
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
---
|
|
||||||
id: linkedin
|
|
||||||
title: LinkedIn
|
|
||||||
---
|
|
||||||
|
|
||||||
For LinkedIn, the registration steps are:
|
|
||||||
|
|
||||||
1. Create a new project: https://www.linkedin.com/secure/developer
|
|
||||||
2. In the OAuth User Agreement section:
|
|
||||||
- In default scope, select r_basicprofile and r_emailaddress.
|
|
||||||
- In "OAuth 2.0 Redirect URLs", enter `https://internal.yourcompany.com/oauth2/callback`
|
|
||||||
3. Fill in the remaining required fields and Save.
|
|
||||||
4. Take note of the **Consumer Key / API Key** and **Consumer Secret / Secret Key**
|
|
||||||
|
|
@ -1,79 +0,0 @@
|
||||||
---
|
|
||||||
id: login_gov
|
|
||||||
title: Login.gov
|
|
||||||
---
|
|
||||||
|
|
||||||
login.gov is an OIDC provider for the US Government.
|
|
||||||
If you are a US Government agency, you can contact the login.gov team through the contact information
|
|
||||||
that you can find on https://login.gov/developers/ and work with them to understand how to get login.gov
|
|
||||||
accounts for integration/test and production access.
|
|
||||||
|
|
||||||
A developer guide is available here: https://developers.login.gov/, though this proxy handles everything
|
|
||||||
but the data you need to create to register your application in the login.gov dashboard.
|
|
||||||
|
|
||||||
As a demo, we will assume that you are running your application that you want to secure locally on
|
|
||||||
http://localhost:3000/, that you will be starting your proxy up on http://localhost:4180/, and that
|
|
||||||
you have an agency integration account for testing.
|
|
||||||
|
|
||||||
First, register your application in the dashboard. The important bits are:
|
|
||||||
* Identity protocol: make this `Openid connect`
|
|
||||||
* Issuer: do what they say for OpenID Connect. We will refer to this string as `${LOGINGOV_ISSUER}`.
|
|
||||||
* Public key: This is a self-signed certificate in .pem format generated from a 2048-bit RSA private key.
|
|
||||||
A quick way to do this is
|
|
||||||
`openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 3650 -nodes -subj '/C=US/ST=Washington/L=DC/O=GSA/OU=18F/CN=localhost'`.
|
|
||||||
The contents of the `key.pem` shall be referred to as `${OAUTH2_PROXY_JWT_KEY}`.
|
|
||||||
* Return to App URL: Make this be `http://localhost:4180/`
|
|
||||||
* Redirect URIs: Make this be `http://localhost:4180/oauth2/callback`.
|
|
||||||
* Attribute Bundle: Make sure that email is selected.
|
|
||||||
|
|
||||||
Now start the proxy up with the following options:
|
|
||||||
```
|
|
||||||
./oauth2-proxy -provider login.gov \
|
|
||||||
-client-id=${LOGINGOV_ISSUER} \
|
|
||||||
-redirect-url=http://localhost:4180/oauth2/callback \
|
|
||||||
-oidc-issuer-url=https://idp.int.identitysandbox.gov/ \
|
|
||||||
-cookie-secure=false \
|
|
||||||
-email-domain=gsa.gov \
|
|
||||||
-upstream=http://localhost:3000/ \
|
|
||||||
-cookie-secret=somerandomstring12341234567890AB \
|
|
||||||
-cookie-domain=localhost \
|
|
||||||
-skip-provider-button=true \
|
|
||||||
-pubjwk-url=https://idp.int.identitysandbox.gov/api/openid_connect/certs \
|
|
||||||
-profile-url=https://idp.int.identitysandbox.gov/api/openid_connect/userinfo \
|
|
||||||
-jwt-key="${OAUTH2_PROXY_JWT_KEY}"
|
|
||||||
```
|
|
||||||
You can also set all these options with environment variables, for use in cloud/docker environments.
|
|
||||||
One tricky thing that you may encounter is that some cloud environments will pass in environment
|
|
||||||
variables in a docker env-file, which does not allow multiline variables like a PEM file.
|
|
||||||
If you encounter this, then you can create a `jwt_signing_key.pem` file in the top level
|
|
||||||
directory of the repo which contains the key in PEM format and then do your docker build.
|
|
||||||
The docker build process will copy that file into your image which you can then access by
|
|
||||||
setting the `OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem`
|
|
||||||
environment variable, or by setting `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem` on the commandline.
|
|
||||||
|
|
||||||
Once it is running, you should be able to go to `http://localhost:4180/` in your browser,
|
|
||||||
get authenticated by the login.gov integration server, and then get proxied on to your
|
|
||||||
application running on `http://localhost:3000/`. In a real deployment, you would secure
|
|
||||||
your application with a firewall or something so that it was only accessible from the
|
|
||||||
proxy, and you would use real hostnames everywhere.
|
|
||||||
|
|
||||||
#### Skip OIDC discovery
|
|
||||||
|
|
||||||
Some providers do not support OIDC discovery via their issuer URL, so oauth2-proxy cannot simply grab the authorization,
|
|
||||||
token and jwks URI endpoints from the provider's metadata.
|
|
||||||
|
|
||||||
In this case, you can set the `--skip-oidc-discovery` option, and supply those required endpoints manually:
|
|
||||||
|
|
||||||
```
|
|
||||||
-provider oidc
|
|
||||||
-client-id oauth2-proxy
|
|
||||||
-client-secret proxy
|
|
||||||
-redirect-url http://127.0.0.1:4180/oauth2/callback
|
|
||||||
-oidc-issuer-url http://127.0.0.1:5556
|
|
||||||
-skip-oidc-discovery
|
|
||||||
-login-url http://127.0.0.1:5556/authorize
|
|
||||||
-redeem-url http://127.0.0.1:5556/token
|
|
||||||
-oidc-jwks-url http://127.0.0.1:5556/keys
|
|
||||||
-cookie-secure=false
|
|
||||||
-email-domain example.com
|
|
||||||
```
|
|
||||||
|
|
@ -1,59 +0,0 @@
|
||||||
---
|
|
||||||
id: azure
|
|
||||||
title: Azure (Deprecated)
|
|
||||||
---
|
|
||||||
|
|
||||||
:::note
|
|
||||||
This is the legacy and deprecated provider for Azure, use [Microsoft Entra ID](ms_entra_id.md) if possible.
|
|
||||||
:::
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
|
||||||
| ---------------- | -------------- | ------ | ---------------------------------------------------------------- | ---------- |
|
|
||||||
| `--azure-tenant` | `azure_tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |
|
|
||||||
| `--resource` | `resource` | string | The resource that is protected (Azure AD only) | |
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
1. Add an application: go to [https://portal.azure.com](https://portal.azure.com), choose **Azure Active Directory**, select
|
|
||||||
**App registrations** and then click on **New registration**.
|
|
||||||
2. Pick a name, check the supported account type(single-tenant, multi-tenant, etc). In the **Redirect URI** section create a new
|
|
||||||
**Web** platform entry for each app that you want to protect by the oauth2 proxy(e.g.
|
|
||||||
https://internal.yourcompanycom/oauth2/callback). Click **Register**.
|
|
||||||
3. Next we need to add group read permissions for the app registration, on the **API Permissions** page of the app, click on
|
|
||||||
**Add a permission**, select **Microsoft Graph**, then select **Application permissions**, then click on **Group** and select
|
|
||||||
**Group.Read.All**. Hit **Add permissions** and then on **Grant admin consent** (you might need an admin to do this).
|
|
||||||
<br/>**IMPORTANT**: Even if this permission is listed with **"Admin consent required=No"** the consent might actually
|
|
||||||
be required, due to AAD policies you won't be able to see. If you get a **"Need admin approval"** during login,
|
|
||||||
most likely this is what you're missing!
|
|
||||||
4. Next, if you are planning to use v2.0 Azure Auth endpoint, go to the **Manifest** page and set `"accessTokenAcceptedVersion": 2`
|
|
||||||
in the App registration manifest file.
|
|
||||||
5. On the **Certificates & secrets** page of the app, add a new client secret and note down the value after hitting **Add**.
|
|
||||||
6. Configure the proxy with:
|
|
||||||
- for V1 Azure Auth endpoint (Azure Active Directory Endpoints - https://login.microsoftonline.com/common/oauth2/authorize)
|
|
||||||
|
|
||||||
```
|
|
||||||
--provider=azure
|
|
||||||
--client-id=<application ID from step 3>
|
|
||||||
--client-secret=<value from step 5>
|
|
||||||
--azure-tenant={tenant-id}
|
|
||||||
--oidc-issuer-url=https://sts.windows.net/{tenant-id}/
|
|
||||||
```
|
|
||||||
|
|
||||||
- for V2 Azure Auth endpoint (Microsoft Identity Platform Endpoints - https://login.microsoftonline.com/common/oauth2/v2.0/authorize)
|
|
||||||
```
|
|
||||||
--provider=azure
|
|
||||||
--client-id=<application ID from step 3>
|
|
||||||
--client-secret=<value from step 5>
|
|
||||||
--azure-tenant={tenant-id}
|
|
||||||
--oidc-issuer-url=https://login.microsoftonline.com/{tenant-id}/v2.0
|
|
||||||
```
|
|
||||||
|
|
||||||
***Notes***:
|
|
||||||
- When using v2.0 Azure Auth endpoint (`https://login.microsoftonline.com/{tenant-id}/v2.0`) as `--oidc_issuer_url`, in conjunction
|
|
||||||
with `--resource` flag, be sure to append `/.default` at the end of the resource name. See
|
|
||||||
https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent#the-default-scope for more details.
|
|
||||||
- When using the Azure Auth provider with nginx and the cookie session store you may find the cookie is too large and doesn't
|
|
||||||
get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the
|
|
||||||
[redis session storage](../sessions.md#redis-storage) should resolve this.
|
|
||||||
|
|
@ -1,197 +0,0 @@
|
||||||
---
|
|
||||||
id: ms_entra_id
|
|
||||||
title: Microsoft Entra ID
|
|
||||||
---
|
|
||||||
|
|
||||||
Provider for Microsoft Entra ID. Fully compliant with OIDC, with support for group overage and multi-tenant apps.
|
|
||||||
|
|
||||||
## Config Options
|
|
||||||
|
|
||||||
The provider is OIDC-compliant, so all the OIDC parameters are honored. Additional provider-specific configuration parameters are:
|
|
||||||
|
|
||||||
| Flag | Toml Field | Type | Description | Default |
|
|
||||||
| --------------------------- | -------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |
|
|
||||||
| `--entra-id-allowed-tenant` | `entra_id_allowed_tenants` | string \| list | List of allowed tenants. In case of multi-tenant apps, incoming tokens are issued by different issuers and OIDC issuer verification needs to be disabled. When not specified, all tenants are allowed. Redundant for single-tenant apps (regular ID token validation matches the issuer). | |
|
|
||||||
| `--entra-id-federated-token-auth` | `entra_id_federated_token_auth` | boolean | Enable oAuth2 client authentication with federated token projected by Entra Workload Identity plugin, instead of client secret. | false |
|
|
||||||
|
|
||||||
## Configure App registration
|
|
||||||
To begin, create an App registration, set a redirect URI, and generate a secret. All account types are supported, including single-tenant, multi-tenant, multi-tenant with Microsoft accounts, and Microsoft accounts only.
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>See Azure Portal example</summary>
|
|
||||||
<div class="videoBlock">
|
|
||||||
<iframe src="https://www.youtube.com/embed/IUNfxhOzr4E"></iframe>
|
|
||||||
</div>
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>See Terraform example</summary>
|
|
||||||
```
|
|
||||||
resource "azuread_application" "auth" {
|
|
||||||
display_name = "oauth2-proxy"
|
|
||||||
sign_in_audience = "AzureADMyOrg" # Others are also supported
|
|
||||||
|
|
||||||
web {
|
|
||||||
redirect_uris = [
|
|
||||||
"https://podinfo.lakis.tech/oauth2/callback",
|
|
||||||
]
|
|
||||||
}
|
|
||||||
// We don't specify any required API permissions - we allow user consent only
|
|
||||||
}
|
|
||||||
|
|
||||||
resource "azuread_service_principal" "sp" {
|
|
||||||
client_id = azuread_application.auth.client_id
|
|
||||||
app_role_assignment_required = false
|
|
||||||
}
|
|
||||||
|
|
||||||
resource "azuread_service_principal_password" "pass" {
|
|
||||||
service_principal_id = azuread_service_principal.sp.id
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Configure groups
|
|
||||||
If you want to make use of groups, you can configure *groups claim* to be present in ID Tokens issued by the App registration.
|
|
||||||
<details>
|
|
||||||
<summary>See Azure Portal example</summary>
|
|
||||||
<div class="videoBlock">
|
|
||||||
<div class="videoBlock">
|
|
||||||
<iframe src="https://www.youtube.com/embed/QZmP5MKEJis"></iframe>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</details>
|
|
||||||
<details>
|
|
||||||
<summary>See Terraform example</summary>
|
|
||||||
```
|
|
||||||
resource "azuread_application" "auth" {
|
|
||||||
display_name = "oauth2-proxy"
|
|
||||||
sign_in_audience = "AzureADMyOrg"
|
|
||||||
|
|
||||||
group_membership_claims = [
|
|
||||||
"SecurityGroup"
|
|
||||||
]
|
|
||||||
|
|
||||||
web {
|
|
||||||
redirect_uris = [
|
|
||||||
"https://podinfo.lakis.tech/oauth2/callback",
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
resource "azuread_service_principal" "sp" {
|
|
||||||
client_id = azuread_application.auth.client_id
|
|
||||||
app_role_assignment_required = false
|
|
||||||
}
|
|
||||||
|
|
||||||
resource "azuread_service_principal_password" "pass" {
|
|
||||||
service_principal_id = azuread_service_principal.sp.id
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
### Scopes and claims
|
|
||||||
For single-tenant and multi-tenant apps without groups, the only required scope is `openid` (See: [Scopes and permissions](https://learn.microsoft.com/en-us/entra/identity-platform/scopes-oidc#the-openid-scope)).
|
|
||||||
|
|
||||||
To make use of groups - for example use `allowed_groups` setting or authorize based on groups inside your service - you need to enable *groups claims* in the App Registration. When enabled, list of groups is present in the issued ID token. No additional scopes are required besides `openid`. This works up to 200 groups.
|
|
||||||
|
|
||||||
When user has more than 200 group memberships, OAuth2-Proxy attempts to retrieve the complete list from Microsoft Graph API's [`transitiveMemberOf`](https://learn.microsoft.com/en-us/graph/api/user-list-transitivememberof). Endpoint requires `User.Read` scope (delegated permission). This permission can be by default consented by user during first login. Set scope to `openid User.Read` to request user consent. Without proper scope, user with 200+ groups will authenticate with 0 groups. See: [group overages](https://learn.microsoft.com/en-us/security/zero-trust/develop/configure-tokens-group-claims-app-roles#group-overages).
|
|
||||||
|
|
||||||
Alternatively to user consent, both `openid` and `User.Read` permissions can be consented by admistrator. Then, user is not asked for consent on the first login, and group overage works with `openid` scope only. Admin consent can also be required for some tenants. It can be granted with [azuread_service_principal_delegated_permission_grant](https://registry.terraform.io/providers/hashicorp/azuread/latest/docs/resources/service_principal_delegated_permission_grant) terraform resource.
|
|
||||||
|
|
||||||
For personal microsoft accounts, required scope is `openid profile email`.
|
|
||||||
|
|
||||||
See: [Overview of permissions and consent in the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/permissions-consent-overview).
|
|
||||||
|
|
||||||
### Multi-tenant apps
|
|
||||||
To authenticate apps from multiple tenants (including personal Microsoft accounts), set the common OIDC issuer url and disable verification:
|
|
||||||
```toml
|
|
||||||
oidc_issuer_url=https://login.microsoftonline.com/common/v2.0
|
|
||||||
insecure_oidc_skip_issuer_verification=true
|
|
||||||
```
|
|
||||||
`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).
|
|
||||||
* 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.
|
|
||||||
|
|
||||||
### Workload Identity
|
|
||||||
Provider supports authentication with federated token, without need of using client secret. Following conditions have to be met:
|
|
||||||
|
|
||||||
* Cluster has public OIDC provider URL. For major cloud providers, it can be enabled with a single flag, for example for [Azure Kubernetes Service deployed with Terraform](https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs/resources/kubernetes_cluster), it's `oidc_issuer_enabled`.
|
|
||||||
* Workload Identity admission webhook is deployed on the cluster. For AKS, it can be enabled with a flag (`workload_identity_enabled` in Terraform resource), for clusters outside of Azure, it can be installed from [helm chart](https://github.com/Azure/azure-workload-identity).
|
|
||||||
* Appropriate federated credential is added to application registration.
|
|
||||||
<details>
|
|
||||||
<summary>See federated credential terraform example</summary>
|
|
||||||
```
|
|
||||||
resource "azuread_application_federated_identity_credential" "fedcred" {
|
|
||||||
application_id = azuread_application.application.id # ID of your application
|
|
||||||
display_name = "federation-cred"
|
|
||||||
description = "Workload identity for oauth2-proxy"
|
|
||||||
audiences = ["api://AzureADTokenExchange"] # Fixed value
|
|
||||||
issuer = "https://cluster-oidc-issuer-url..."
|
|
||||||
subject = "system:serviceaccount:oauth2-proxy-namespace-name:oauth2-proxy-sa-name" # set proper NS and SA name
|
|
||||||
}
|
|
||||||
```
|
|
||||||
</details>
|
|
||||||
|
|
||||||
* Kubernetes service account associated with oauth2-proxy deployment, is annotated with `azure.workload.identity/client-id: <app-registration-client-id>`
|
|
||||||
* oauth2-proxy pod is labeled with `azure.workload.identity/use: "true"`
|
|
||||||
* oauth2-proxy is configured with `entra_id_federated_token_auth` set to `true`.
|
|
||||||
|
|
||||||
`client_secret` setting can be omitted when using federated token authentication.
|
|
||||||
|
|
||||||
See: [Azure Workload Identity documentation](https://azure.github.io/azure-workload-identity/docs/).
|
|
||||||
|
|
||||||
### Example configurations
|
|
||||||
Single-tenant app without groups (*groups claim* not enabled). Consider using generic OIDC provider:
|
|
||||||
```toml
|
|
||||||
provider="entra-id"
|
|
||||||
oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
|
|
||||||
client_id="<client-id>"
|
|
||||||
client_secret="<client-secret>"
|
|
||||||
scope="openid"
|
|
||||||
```
|
|
||||||
|
|
||||||
Single-tenant app with up to 200 groups (*groups claim* enabled). Consider using generic OIDC provider:
|
|
||||||
```toml
|
|
||||||
provider="entra-id"
|
|
||||||
oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
|
|
||||||
client_id="<client-id>"
|
|
||||||
client_secret="<client-secret>"
|
|
||||||
scope="openid"
|
|
||||||
allowed_groups=["ac51800c-2679-4ecb-8130-636380a3b491"]
|
|
||||||
```
|
|
||||||
|
|
||||||
Single-tenant app with more than 200 groups:
|
|
||||||
```toml
|
|
||||||
provider="entra-id"
|
|
||||||
oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
|
|
||||||
client_id="<client-id>"
|
|
||||||
client_secret="<client-secret>"
|
|
||||||
scope="openid User.Read"
|
|
||||||
allowed_groups=["968b4844-d5e7-4e18-a834-59927959369f"]
|
|
||||||
```
|
|
||||||
|
|
||||||
Single-tenant app with more than 200 groups and workload identity enabled:
|
|
||||||
```toml
|
|
||||||
provider="entra-id"
|
|
||||||
oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"
|
|
||||||
client_id="<client-id>"
|
|
||||||
scope="openid User.Read"
|
|
||||||
allowed_groups=["968b4844-d5e7-4e18-a834-59927959369f"]
|
|
||||||
entra_id_federated_token_auth=true
|
|
||||||
```
|
|
||||||
|
|
||||||
Multi-tenant app with Microsoft personal accounts & one Entra tenant allowed, with group overage considered:
|
|
||||||
```toml
|
|
||||||
provider="entra-id"
|
|
||||||
oidc_issuer_url="https://login.microsoftonline.com/common/v2.0"
|
|
||||||
client_id="<client-id>"
|
|
||||||
client_secret="<client-secret>"
|
|
||||||
insecure_oidc_skip_issuer_verification=true
|
|
||||||
scope="openid profile email User.Read"
|
|
||||||
entra_id_allowed_tenants=["9188040d-6c67-4c5b-b112-36a304b66dad","<my-tenant-id>"] # Allow only <my-tenant-id> and Personal MS Accounts tenant
|
|
||||||
email_domains="*"
|
|
||||||
```
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue