git.iko.soy/typeable/oauth2-proxy

on e25158d help sign in

from20d4e9c

swap

to0 ahead, 797 behind

compare

.devcontainer/Dockerfiledeleted−14

since splitsnapshots

unifiedsplit

@@ -1,14 +0,0 @@

1−FROM mcr.microsoft.com/vscode/devcontainers/go:1-1.26

2−

3−SHELL ["/bin/bash", "-o", "pipefail", "-c"]

4−

5−RUN apt-get update \

6− && apt-get install -y --no-install-recommends \

7− pre-commit \

8− vim \

9− && apt-get clean \

10− && rm -rf /var/lib/apt/lists/* \

11− && mkdir -p /go/pkg \

12− && chmod -R a+w /go/pkg

13−

14−WORKDIR /workspace

.devcontainer/devcontainer.jsondeleted−45

@@ -1,45 +0,0 @@

1−{

2− "name": "oauth2-proxy Dev",

3− "context": "..",

4− "dockerFile": "./Dockerfile",

5− "postCreateCommand": "pre-commit install && go mod download",

6− "containerEnv": { "DEVCONTAINER": "1" },

7− "appPort": ["4180:4180"],

8− "runArgs": ["-e", "GIT_EDITOR=code --wait"],

9− "customizations": {

10− "vscode": {

11− "extensions": [

12− "golang.go",

13− "ms-vscode.makefile-tools",

14− "visualstudioexptteam.vscodeintellicode",

15− "redhat.vscode-yaml",

16− "esbenp.prettier-vscode",

17− "GitHub.vscode-pull-request-github"

18− ],

19− "settings": {

20− "editor.formatOnPaste": false,

21− "editor.formatOnSave": true,

22− "editor.formatOnType": true,

23− "files.trimTrailingWhitespace": true,

24− "yaml.customTags": [

25− "!input scalar",

26− "!secret scalar",

27− "!include_dir_named scalar",

28− "!include_dir_list scalar",

29− "!include_dir_merge_list scalar",

30− "!include_dir_merge_named scalar"

31− ]

32− }

33− }

34− },

35− "features": {

36− "ghcr.io/devcontainers/features/docker-in-docker": {},

37− "ghcr.io/devcontainers/features/common-utils": {

38− "configureZshAsDefaultShell": true,

39− "username": "vscode",

40− "userUid": 1000,

41− "userGid": 1000

42− },

43− "ghcr.io/devcontainers/features/kubectl-helm-minikube": {}

44− }

45−}

.dockerignore−1

@@ -1,5 +1,4 @@

1Dockerfile.dev

1Dockerfile.dev

2−Dockerfile

3docs

2docs

4vendor

3vendor

5.git

4.git

.github/FUNDING.ymldeleted−15

@@ -1,15 +0,0 @@

1−# These are supported funding model platforms

2−

3−github: tuunit # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]

4−patreon: # Replace with a single Patreon username

5−open_collective: oauth2-proxy # Replace with a single Open Collective username

6−ko_fi: # Replace with a single Ko-fi username

7−tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel

8−community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry

9−liberapay: # Replace with a single Liberapay username

10−issuehunt: # Replace with a single IssueHunt username

11−lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry

12−polar: # Replace with a single Polar username

13−buy_me_a_coffee: # Replace with a single Buy Me a Coffee username

14−thanks_dev: # Replace with a single thanks.dev username

15−custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE.mdnew file+37

@@ -0,0 +1,37 @@

1+<!--- Provide a general summary of the issue in the Title above -->

2+

3+## Expected Behavior

4+

5+<!--- If you're describing a bug, tell us what should happen -->

6+<!--- If you're suggesting a change/improvement, tell us how it should work -->

7+

8+## Current Behavior

9+

10+<!--- If describing a bug, tell us what happens instead of the expected behavior -->

11+<!--- If suggesting a change/improvement, explain the difference from current behavior -->

12+

13+## Possible Solution

14+

15+<!--- Not obligatory, but suggest a fix/reason for the bug, -->

16+<!--- or ideas how to implement the addition or change -->

17+

18+## Steps to Reproduce (for bugs)

19+

20+<!--- Provide a link to a live example, or an unambiguous set of steps to -->

21+<!--- reproduce this bug. Include code to reproduce, if relevant -->

22+

23+1. <!--- Step 1 --->

24+2. <!--- Step 2 --->

25+3. <!--- Step 3 --->

26+4. <!--- Step 4 --->

27+

28+## Context

29+

30+<!--- How has this issue affected you? What are you trying to accomplish? -->

31+<!--- Providing context helps us come up with a solution that is most useful in the real world -->

32+

33+## Your Environment

34+

35+<!--- Include as many relevant details about the environment you experienced the bug in -->

36+

37+- Version used:

.github/ISSUE_TEMPLATE/bug-report.ymldeleted−73

@@ -1,73 +0,0 @@

1−name: Bug report

2−description: Bug descriptions or unexpected behaviour

3−title: "[Bug]: <Short description>"

4−labels: ["bug","help wanted"]

5−body:

6− - type: input

7− attributes:

8− label: OAuth2-Proxy Version

9− description: Which version of oauth2-proxy are you using?

10− validations:

11− required: true

12− - type: dropdown

13− attributes:

14− label: Provider

15− description: Which identity provider are you using?

16− options:

17− - adfs

18− - azure

19− - bitbucket

20− - digitalocean

21− - entra-id

22− - facebook

23− - gitea

24− - github

25− - gitlab

26− - google

27− - keycloak

28− - keycloak-oidc

29− - linkedin

30− - logingov

31− - nextcloud

32− - oidc

33− validations:

34− required: false

35− - type: textarea

36− attributes:

37− label: Expected Behaviour

38− description: Tell us what you expect to happen.

39− validations:

40− required: true

41− - type: textarea

42− attributes:

43− label: Current Behaviour

44− description: Tell us what happens instead of the expected behavior.

45− validations:

46− required: true

47− - type: textarea

48− attributes:

49− label: Steps To Reproduce

50− description: Steps to reproduce the behavior.

51− placeholder: |

52− 1. In this environment...

53− 1. With this config...

54− 1. Run '...'

55− 1. See error...

56− validations:

57− required: true

58− - type: textarea

59− attributes:

60− label: Possible Solutions

61− description: Not obligatory, but suggest a fix/reason for the bug.

62− validations:

63− required: false

64− - type: textarea

65− attributes:

66− label: Configuration details or additional information

67− description: |

68− Please share more details about your environment and how you configured oauth2-proxy.

69−

70− Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

71− validations:

72− required: false

73−

.github/ISSUE_TEMPLATE/config.ymldeleted−6

@@ -1,6 +0,0 @@

1−blank_issues_enabled: false

2−contact_links:

3− - name: OAuth2 Proxy Slack

4− url: https://cloud-native.slack.com/archives/C098Y5URZ2N

5− about: Feel free to ask any questions here.

6−

.github/ISSUE_TEMPLATE/configuration-support.ymldeleted−61

@@ -1,61 +0,0 @@

1−name: Configuration support

2−description: Configuration problems and overall requests on how to properly use oauth2-proxy.

3−title: "[Support]: <Short description>"

4−labels: ["configuration", "help wanted"]

5−body:

6− - type: input

7− attributes:

8− label: OAuth2-Proxy Version

9− description: Which version of oauth2-proxy are you using?

10− validations:

11− required: true

12− - type: dropdown

13− attributes:

14− label: Provider

15− description: Which identity provider are you using?

16− options:

17− - adfs

18− - azure

19− - bitbucket

20− - digitalocean

21− - entra-id

22− - facebook

23− - gitea

24− - github

25− - gitlab

26− - google

27− - keycloak

28− - keycloak-oidc

29− - linkedin

30− - logingov

31− - nextcloud

32− - oidc

33− validations:

34− required: true

35− - type: textarea

36− attributes:

37− label: Current Behaviour of your Problem

38− description: Tell us what you expect to happen and what happens instead.

39− validations:

40− required: true

41− - type: textarea

42− attributes:

43− label: Configuration details or additional information

44− description: |

45− Please share more details about your environment and how you configured oauth2-proxy.

46−

47− Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.

48− validations:

49− required: true

50− - type: textarea

51− attributes:

52− label: Steps To Reproduce

53− description: Steps to reproduce the behavior.

54− placeholder: |

55− 1. In this environment...

56− 1. With this config...

57− 1. Run '...'

58− 1. See error...

59− validations:

60− required: false

61−

.github/ISSUE_TEMPLATE/feature-request.ymldeleted−51

@@ -1,51 +0,0 @@

1−name: Feature request

2−description: Feature requests or proposals related to the overall project or specific providers

3−title: "[Feature]: <Short description>"

4−labels: ["enhancement"]

5−body:

6− - type: textarea

7− attributes:

8− label: Motivation

9− description: Tell us the motivation behind your feature request or proposal.

10− validations:

11− required: true

12− - type: textarea

13− attributes:

14− label: Possible solution

15− description: |

16− If you already have a possible solution in mind. Write some more details about it or add some pseudo code.

17−

18− Tip 1: You can attach images or log files by clicking this area to highlight it and then dragging files in.

19− Tip 2: You can add code snippets in triple backtiks like so:

20− \`\`\`golang

21− func hello() {

22− fmt.Println("world")

23− }

24− \`\`\`

25− validations:

26− required: false

27− - type: dropdown

28− attributes:

29− label: Provider

30− description: Is it a feature request for a specific provider. Not mandatory.

31− options:

32− - new provider

33− - adfs

34− - azure

35− - bitbucket

36− - digitalocean

37− - entra-id

38− - facebook

39− - gitea

40− - github

41− - gitlab

42− - google

43− - keycloak

44− - keycloak-oidc

45− - linkedin

46− - logingov

47− - nextcloud

48− - oidc

49− validations:

50− required: false

51−

.github/PULL_REQUEST_TEMPLATE.md+2−4

@@ -20,8 +20,6 @@

20<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->

20<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->

21<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

21<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

22

22

23−- [ ] I have added an entry for my changes to the [CHANGELOG.md](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/CHANGELOG.md).

23+- [ ] My change requires a change to the documentation or CHANGELOG.

24−- [ ] I have [signed off](https://github.com/apps/dco) all my commits.

24+- [ ] I have updated the documentation/CHANGELOG accordingly.

25- [ ] I have created a feature (non-master) branch for my PR.

25- [ ] I have created a feature (non-master) branch for my PR.

26−- [ ] I have used [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/#examples) for the PR title.

27−- [ ] I have written tests for my code changes.

.github/labeler.ymldeleted−35

@@ -1,35 +0,0 @@

1−go:

2− - changed-files:

3− - any-glob-to-any-file:

4− - '**/*.go'

5−

6−docs:

7− - changed-files:

8− - any-glob-to-any-file:

9− - '**/*.md'

10−

11−changelog:

12− - changed-files:

13− - any-glob-to-any-file:

14− - 'CHAGELOG.md'

15−

16−tests:

17− - changed-files:

18− - any-glob-to-any-file:

19− - '**/*_test.go'

20−

21−provider:

22− - changed-files:

23− - any-glob-to-any-file:

24− - 'providers/**/*'

25−

26−dependencies:

27−- changed-files:

28− - any-glob-to-any-file:

29− - 'go.mod'

30− - 'go.sum'

31−

32−docker:

33− - changed-files:

34− - any-glob-to-any-file:

35− - '**/Dockerfile'

.github/renovate.json5deleted−67

@@ -1,67 +0,0 @@

1−{

2− $schema: "https://docs.renovatebot.com/renovate-schema.json",

3− semanticCommits: "enabled",

4− schedule: [

5− "after 8am on sunday"

6− ],

7− prConcurrentLimit: 0,

8− prHourlyLimit: 0,

9− enabledManagers: [

10− "dockerfile",

11− "docker-compose",

12− "gomod",

13− "github-actions",

14− "helmv3",

15− "npm",

16− "regex",

17− ],

18− packageRules: [

19− {

20− matchManagers: [

21− "dockerfile",

22− "docker-compose",

23− "gomod",

24− "helmv3",

25− "npm",

26− ],

27− groupName: "{{{manager}}}",

28− },

29− {

30− matchDepNames: [

31− "docker.io/library/golang",

32− "mcr.microsoft.com/vscode/devcontainers/go",

33− ],

34− groupName: "golang",

35− },

36− ],

37− customManagers: [

38− {

39− customType: "regex",

40− fileMatch: [

41− "^Makefile",

42− ],

43− matchStrings: [

44− "DOCKER_BUILD_RUNTIME_IMAGE_ALPINE\\s+?\\?= alpine:(?<currentValue>.*)\\s"

45− ],

46− depNameTemplate: "alpine",

47− datasourceTemplate: "docker",

48− },

49− {

50− customType: "regex",

51− fileMatch: [

52− "^Makefile",

53− ],

54− matchStrings: [

55− "# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)\\s+?GOLANGCILINT_VERSION \\?= (?<currentValue>.*)\\s",

56− ],

57− },

58− {

59− customType: "regex",

60− fileMatch: ["(^|/)\\.github/workflows/[^/]+\\.ya?ml$"],

61− matchStrings: [

62− "# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s+?[\\w\\s-]*?version: (?<currentValue>.*)\\s",

63− "# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?\\s+?[\\w\\s]*?_VERSION: (?<currentValue>.*)\\s",

64− ],

65− },

66− ],

67−}

.github/workflows/ci.yamlnew file+69

@@ -0,0 +1,69 @@

1+name: Continuous Integration

2+

3+on:

4+ push:

5+ branches:

6+ - '**'

7+ # - $default-branch

8+ pull_request:

9+ branches:

10+ - '**'

11+ # - $default-branch

12+

13+jobs:

14+ build:

15+ env:

16+ COVER: true

17+ runs-on: ubuntu-20.04

18+ steps:

19+

20+ - name: Check out code

21+ uses: actions/checkout@v2

22+

23+ - name: Set up Go 1.16

24+ uses: actions/setup-go@v2

25+ with:

26+ go-version: 1.16.x

27+ id: go

28+

29+ - name: Get dependencies

30+ run: |

31+ curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(go env GOPATH)/bin v1.36.0

32+ curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

33+ chmod +x ./cc-test-reporter

34+

35+ - name: Verify Code Generation

36+ run: |

37+ make verify-generate

38+

39+ - name: Lint

40+ run: |

41+ make lint

42+

43+ - name: Build

44+ run: |

45+ make build

46+

47+ - name: Test

48+ env:

49+ CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}

50+ run: |

51+ ./.github/workflows/test.sh

52+

53+ docker:

54+ runs-on: ubuntu-20.04

55+ steps:

56+

57+ - name: Check out code

58+ uses: actions/checkout@v2

59+

60+ - name: Set up Docker Buildx

61+ id: buildx

62+ uses: crazy-max/ghaction-docker-buildx@v3

63+ with:

64+ buildx-version: latest

65+ qemu-version: latest

66+

67+ - name: Docker Build

68+ run: |

69+ make docker

.github/workflows/ci.ymldeleted−118

@@ -1,118 +0,0 @@

1−name: Continuous Integration

2−

3−on:

4− push:

5− branches:

6− - '**'

7− pull_request:

8− branches:

9− - '**'

10− workflow_dispatch:

11−

12−permissions:

13− contents: read

14− id-token: write

15− security-events: write

16−

17−jobs:

18− build:

19− runs-on: ubuntu-latest

20− steps:

21− - name: Check out code

22− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

23− with:

24− fetch-depth: 0

25−

26− - name: Get Go version

27− run: |

28− version=$(grep "^go " go.mod | cut -d' ' -f2 | cut -d. -f1,2)

29− echo "version=${version}" >> "$GITHUB_OUTPUT"

30− id: go-version

31−

32− - name: Set up Go

33− uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0

34− with:

35− go-version: ${{ steps.go-version.outputs.version }}

36− check-latest: true

37−

38− - name: Verify Code Generation

39− run: |

40− make verify-generate

41−

42− - name: Lint

43− run: |

44− make lint

45−

46− - name: Build

47− if: (!startsWith(github.head_ref, 'release'))

48− run: |

49− make build

50−

51− # For release testing

52− - name: Build All

53− if: github.base_ref == 'master' && startsWith(github.head_ref, 'release')

54− run: |

55− make release

56−

57− - name: Test

58− env:

59− COVER: true

60− run: |

61− make test

62−

63− - name: Generate Coverage Report

64− if: github.event_name == 'push'

65− run: |

66− go install github.com/jandelgado/gcov2lcov@25681830fb515e3d4c117e136b4f049e21efb4d0

67− gcov2lcov -infile=c.out -outfile=lcov.info

68−

69− - name: Upload Coverage Report

70− if: github.event_name == 'push'

71− uses: qltysh/qlty-action/coverage@08a0a862c159eae9b9003081da6663d96efef637 # v2.3.0

72− with:

73− oidc: true

74− files: lcov.info

75−

76− - name: Run Trivy vulnerability scanner

77− if: (!startsWith(github.head_ref, 'release'))

78− uses: aquasecurity/trivy-action@ed142fd0673e97e23eac54620cfb913e5ce36c25 # v0.36.0

79− with:

80− scan-type: 'rootfs'

81− scan-ref: './oauth2-proxy'

82− severity: 'CRITICAL,HIGH'

83− hide-progress: true

84− format: 'sarif'

85− output: 'trivy-results.sarif'

86− exit-code: '0'

87−

88− - name: Upload Trivy scan results

89− if: (!startsWith(github.head_ref, 'release'))

90− uses: github/codeql-action/upload-sarif@ff2f1c621b7f889edc0d3c761ac2e6a3f8cdb0dd # v4.37.7

91− with:

92− sarif_file: 'trivy-results.sarif'

93−

94− docker:

95− runs-on: ubuntu-latest

96− steps:

97− - name: Check out code

98− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

99− with:

100− fetch-depth: 0

101−

102− - name: Set up QEMU

103− uses: docker/setup-qemu-action@96fe6ef7f33517b61c61be40b68a1882f3264fb8 # v4.2.0

104−

105− - name: Set up Docker Buildx

106− id: buildx

107− uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0

108−

109− - name: Docker Build

110− if: (!startsWith(github.head_ref, 'release'))

111− run: |

112− make build-docker

113−

114− # For release testing

115− - name: Docker Build All

116− if: github.base_ref == 'master' && startsWith(github.head_ref, 'release')

117− run: |

118− make build-docker-all

.github/workflows/codeql.yml+15−18

@@ -2,22 +2,10 @@ name: "Code scanning - action"

2

2

3on:

3on:

4 push:

4 push:

5− branches:

5+ branches: [master, ]

6− - master

7− paths-ignore:

8− - '.devcontainer/**'

9− - '.vscode/**'

10− - 'contrib/**'

11− - 'docs/**'

12 pull_request:

6 pull_request:

13 # The branches below must be a subset of the branches above

7 # The branches below must be a subset of the branches above

14− branches:

8+ branches: [master]

15− - master

16− paths-ignore:

17− - '.devcontainer/**'

18− - '.vscode/**'

19− - 'contrib/**'

20− - 'docs/**'

21 schedule:

9 schedule:

22 - cron: '0 15 * * 2'

10 - cron: '0 15 * * 2'

23

11

@@ -32,18 +20,27 @@ jobs:

32

20

33 steps:

21 steps:

34 - name: Checkout repository

22 - name: Checkout repository

35− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

23+ uses: actions/checkout@v2

24+ with:

25+ # We must fetch at least the immediate parents so that if this is

26+ # a pull request then we can checkout the head.

27+ fetch-depth: 2

28+

29+ # If this run was triggered by a pull request event, then checkout

30+ # the head of the pull request instead of the merge commit.

31+ - run: git checkout HEAD^2

32+ if: ${{ github.event_name == 'pull_request' }}

36

33

37 # Initializes the CodeQL tools for scanning.

34 # Initializes the CodeQL tools for scanning.

38 - name: Initialize CodeQL

35 - name: Initialize CodeQL

39− uses: github/codeql-action/init@ff2f1c621b7f889edc0d3c761ac2e6a3f8cdb0dd # v4.37.7

36+ uses: github/codeql-action/init@v1

40 with:

37 with:

41 languages: go

38 languages: go

42

39

43 # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).

40 # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).

44 # If this step fails, then you should remove it and run the build manually (see below)

41 # If this step fails, then you should remove it and run the build manually (see below)

45 - name: Autobuild

42 - name: Autobuild

46− uses: github/codeql-action/autobuild@ff2f1c621b7f889edc0d3c761ac2e6a3f8cdb0dd # v4.37.7

43+ uses: github/codeql-action/autobuild@v1

47

44

48 # ℹ️ Command-line programs to run using the OS shell.

45 # ℹ️ Command-line programs to run using the OS shell.

49 # 📚 https://git.io/JvXDl

46 # 📚 https://git.io/JvXDl

@@ -57,4 +54,4 @@ jobs:

57 # make release

54 # make release

58

55

59 - name: Perform CodeQL Analysis

56 - name: Perform CodeQL Analysis

60− uses: github/codeql-action/analyze@ff2f1c621b7f889edc0d3c761ac2e6a3f8cdb0dd # v4.37.7

57+ uses: github/codeql-action/analyze@v1

.github/workflows/create-release.ymldeleted−119

@@ -1,119 +0,0 @@

1−name: Create Release

2−run-name: Create release ${{ inputs.version }}

3−

4−on:

5− workflow_dispatch:

6− inputs:

7− version:

8− description: 'Version for new release'

9− required: true

10−

11−permissions:

12− contents: write

13− pull-requests: write

14−

15−jobs:

16− release:

17− runs-on: ubuntu-latest

18− steps:

19− - name: Check out code

20− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

21− with:

22− ref: master

23− fetch-depth: 0

24− fetch-tags: true

25−

26− - name: Validate version

27− id: validate

28− run: |

29− function ver { printf "%03d%03d%03d%03d" $(echo "$1" | tr '.' ' '); }

30−

31− NEW_VERSION=${{ inputs.version }}

32− NEW_VERSION=${NEW_VERSION#v} # Remove v prefix

33−

34− LATEST_VERSION=$(git describe --abbrev=0 --tags)

35− LATEST_VERSION=${LATEST_VERSION#v} # Remove v prefix

36−

37− # check that new version can be parsed

38− if [ ! $(ver $NEW_VERSION ) -gt $(ver 0) ]; then

39− echo "::error::Entered version '${{ inputs.version }}' cannot be parsed"

40− exit 1

41− fi

42−

43− # check version continuity

44− if [ ! $(ver $LATEST_VERSION) -lt $(ver $NEW_VERSION) ]; then

45− echo "::error::Entered version '${{ inputs.version }}' is smaller then latest version $LATEST_VERSION"

46− exit 1

47− fi

48−

49− echo "version=${NEW_VERSION}" >> "$GITHUB_OUTPUT"

50−

51− - name: Prepare Github Actions Bot

52− run: |

53− git config --local user.name "github-actions[bot]"

54− git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"

55−

56− - name: Setup node

57− uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0

58− with:

59− node-version-file: docs/package.json

60−

61− - name: Update documentation

62− run: |

63− cd docs

64−

65− FULL_VERSION=${{ steps.validate.outputs.version }}

66− VERSION=${FULL_VERSION%.*}.x

67−

68− if [ ! -d "versioned_docs/version-${VERSION}" ]; then

69− npm install

70− npm run docusaurus docs:version ${VERSION}

71−

72− git add .

73− git commit -m "add new docs version ${VERSION}"

74− fi

75−

76− sed -i "s/(current release is .*)/(current release is \`v${FULL_VERSION}\`)/g" docs/installation.md

77− sed -i "s/(current release is .*)/(current release is \`v${FULL_VERSION}\`)/g" versioned_docs/version-${VERSION}/installation.md

78−

79− - name: Update Changelog

80− run: |

81− VERSION=${{ steps.validate.outputs.version }}

82−

83− sed -i "s/#.*(Pre-release)/# V${VERSION}/g" CHANGELOG.md

84−

85− cat << EOF > /tmp/CHANGELOG.prepend

86− # Vx.x.x (Pre-release)

87−

88− ## Release Highlights

89−

90− ## Important Notes

91−

92− ## Breaking Changes

93−

94− ## Changes since v${VERSION}

95− EOF

96−

97− echo -e "$(cat /tmp/CHANGELOG.prepend)\n\n$(cat CHANGELOG.md)" > CHANGELOG.md

98−

99− - name: Update development files

100− run: |

101− VERSION=${{ steps.validate.outputs.version }}

102− cd contrib

103− grep -rl "quay.io/oauth2-proxy/oauth2-proxy:" | \

104− 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"

105−

106− - name: Commit and push

107− run: |

108− VERSION=${{ steps.validate.outputs.version }}

109−

110− git checkout -b release/v${VERSION}

111− git commit -am "update to release version v${VERSION}"

112− git push -u origin release/v${VERSION}

113−

114− - name: Create PR

115− env:

116− GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

117− run: |

118− VERSION=v${{ steps.validate.outputs.version }}

119− 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."

.github/workflows/docs.yamlnew file+67

@@ -0,0 +1,67 @@

1+name: documentation

2+

3+on:

4+ pull_request:

5+ branches: [master]

6+ paths: ['docs/**']

7+ push:

8+ branches: [master]

9+ paths: ['docs/**']

10+

11+jobs:

12+ checks:

13+ if: github.event_name != 'push'

14+ runs-on: ubuntu-latest

15+ steps:

16+ - uses: actions/checkout@v1

17+ - uses: actions/setup-node@v1

18+ with:

19+ node-version: '12.x'

20+ - name: Test Build

21+ working-directory: ./docs

22+ run: |

23+ if [ -e yarn.lock ]; then

24+ yarn install --frozen-lockfile

25+ elif [ -e package-lock.json ]; then

26+ npm ci

27+ else

28+ npm i

29+ fi

30+ npm run build

31+ gh-release:

32+ if: github.event_name != 'pull_request'

33+ runs-on: ubuntu-latest

34+ steps:

35+ - uses: actions/checkout@v1

36+ - uses: actions/setup-node@v1

37+ with:

38+ node-version: '12.x'

39+ - name: Add key to allow access to repository

40+ env:

41+ SSH_AUTH_SOCK: /tmp/ssh_agent.sock

42+ run: |

43+ mkdir -p ~/.ssh

44+ ssh-keyscan github.com >> ~/.ssh/known_hosts

45+ echo "${{ secrets.GH_PAGES_DEPLOY }}" > ~/.ssh/id_rsa

46+ chmod 600 ~/.ssh/id_rsa

47+ cat <<EOT >> ~/.ssh/config

48+ Host github.com

49+ HostName github.com

50+ IdentityFile ~/.ssh/id_rsa

51+ EOT

52+ - name: Release to GitHub Pages

53+ working-directory: ./docs

54+ env:

55+ USE_SSH: true

56+ GIT_USER: git

57+ run: |

58+ git config --global user.email "actions@gihub.com"

59+ git config --global user.name "gh-actions"

60+ if [ -e yarn.lock ]; then

61+ yarn install --frozen-lockfile

62+ elif [ -e package-lock.json ]; then

63+ npm ci

64+ else

65+ npm i

66+ fi

67+ npx docusaurus deploy

.github/workflows/docs.ymldeleted−68

@@ -1,68 +0,0 @@

1−name: documentation

2−

3−on:

4− pull_request:

5− branches: [master]

6− paths: ['docs/**']

7− push:

8− branches: [master]

9− paths: ['docs/**']

10− workflow_dispatch:

11−

12−jobs:

13− pull-request-check:

14− if: github.event_name == 'pull_request'

15− runs-on: ubuntu-latest

16− steps:

17− - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

18−

19− - name: Setup Pages

20− id: pages

21− uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0

22−

23− - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0

24− with:

25− # renovate: datasource=node-version depName=node

26− node-version: 24

27−

28− - name: Test Build

29− working-directory: ./docs

30− run: |

31− npm install

32− npm run build

33−

34− build-docs:

35− if: github.event_name == 'push' || github.event_name == 'workflow_dispatch'

36− runs-on: ubuntu-latest

37− steps:

38− - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

39−

40− - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0

41− with:

42− # renovate: datasource=node-version depName=node

43− node-version: 24

44−

45− - name: Build docusaurus

46− working-directory: ./docs

47− run: |

48− npm install

49− npm run build

50−

51− - name: Upload artifact

52− uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0

53− with:

54− path: ./docs/build

55−

56− deploy-docs:

57− needs: build-docs

58− runs-on: ubuntu-latest

59− permissions:

60− pages: write # to deploy to Pages

61− id-token: write # to verify the deployment originates from an appropriate source

62− environment:

63− name: github-pages

64− url: ${{ steps.deployment.outputs.page_url }}

65− steps:

66− - name: Deploy to GitHub Pages

67− id: deployment

68− uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0

.github/workflows/e2e.ymldeleted−14

@@ -1,14 +0,0 @@

1−name: E2E

2−

3−on:

4− issue_comment:

5− types: [created]

6−

7−jobs:

8− e2e:

9− uses: oauth2-proxy/e2e-suite/.github/workflows/e2e.yml@main

10− permissions:

11− contents: read

12− statuses: write

13− issues: write

14− pull-requests: write

.github/workflows/labeler.ymldeleted−15

@@ -1,15 +0,0 @@

1−name: "Pull Request Labeler"

2−on:

3− pull_request_target:

4−

5−jobs:

6− triage:

7− permissions:

8− contents: read

9− pull-requests: write

10− runs-on: ubuntu-latest

11− steps:

12− - uses: actions/labeler@bf12e9b00b37c5c0ca2b87b79b2daf7891dbda13 # v7.0.0

13− with:

14− sync-labels: true

15− dot: true

.github/workflows/nightly.ymldeleted−41

@@ -1,41 +0,0 @@

1−name: Nightly builds

2−

3−on:

4− schedule: # Run every day at 03:00 UTC

5− - cron: '0 3 * * *'

6− workflow_dispatch:

7−

8−jobs:

9− build:

10− runs-on: ubuntu-latest

11− # only run this build in the main repository, not in forks

12− if: github.repository == 'oauth2-proxy/oauth2-proxy'

13− steps:

14− - name: Check out code

15− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

16− with:

17− ref: master

18− fetch-depth: 0

19− fetch-tags: true

20−

21− - name: Set up QEMU

22− uses: docker/setup-qemu-action@96fe6ef7f33517b61c61be40b68a1882f3264fb8 # v4.2.0

23−

24− - name: Set up Docker Buildx

25− id: buildx

26− uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0

27−

28− - name: Login to quay.io

29− uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0

30− with:

31− registry: quay.io/oauth2-proxy

32− username: ${{ secrets.REGISTRY_USERNAME_NIGHTLY }}

33− password: ${{ secrets.REGISTRY_PASSWORD_NIGHTLY }}

34−

35− - name: Build images

36− run: |

37− make nightly-build

38−

39− - name: Push images

40− run: |

41− make nightly-push

.github/workflows/publish-release.ymldeleted−129

@@ -1,129 +0,0 @@

1−name: Publish Release

2−run-name: ${{ github.event.pull_request.head.ref }}

3−

4−on:

5− pull_request_target:

6− branches:

7− - master

8− types:

9− - closed

10−

11−permissions:

12− contents: write

13− pull-requests: write

14−

15−jobs:

16− publish:

17− if: github.event.pull_request.merged && startsWith(github.event.pull_request.head.ref, 'release/') && github.event.pull_request.head.repo.full_name == github.repository

18− runs-on: ubuntu-latest

19− outputs:

20− tag: ${{ steps.tag.outputs.version }}

21− steps:

22− - name: Check out code

23− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

24− with:

25− ref: ${{ github.event.pull_request.merge_commit_sha }}

26− fetch-depth: 0

27− fetch-tags: true

28−

29− - name: Tag release

30− env:

31− BRANCH: ${{ github.event.pull_request.head.ref }}

32− run: |

33− # Set up github-actions[bot] user

34− git config --local user.name "github-actions[bot]"

35− git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"

36−

37− # Get the version from the branch name

38− version="${BRANCH#release/}"

39− echo ${version}

40−

41− # Tag and create release

42− git tag -a "${version}" -m "Release ${version}"

43− echo "version=${version}" >> $GITHUB_OUTPUT

44− id: tag

45−

46− - name: Get Go version

47− run: |

48− version=$(grep "^go " go.mod | cut -d' ' -f2 | cut -d. -f1,2)

49− echo "version=${version}" >> "$GITHUB_OUTPUT"

50− id: go-version

51−

52− - name: Set up Go

53− uses: actions/setup-go@b7ad1dad31e06c5925ef5d2fc7ad053ef454303e # v7.0.0

54− with:

55− go-version: ${{ steps.go-version.outputs.version }}

56− check-latest: true

57−

58− - name: Get go dependencies

59− run: |

60− go mod download

61−

62− - name: Build Artifacts

63− run: make release

64−

65− # Upload artifacts in case of workflow failure

66− - name: Upload Artifacts

67− uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1

68− with:

69− name: oauth2-proxy-artifacts

70− path: |

71− release/*.tar.gz

72− release/*.txt

73−

74− - name: Create release

75− env:

76− GH_TOKEN: ${{ github.token }}

77− run: |

78− # Get version from tag

79− version=$(git describe --tags --abbrev=0)

80−

81− # Extract CHANGELOG

82− numericVersion="${version#v}"

83− notes=$(sed -E "/^# (v|V)$numericVersion$/,/^# (v|V)/!d;//d" CHANGELOG.md)

84−

85− # Publish release tag

86− git push origin "${version}"

87−

88− # Create github release

89− gh release create "${version}" \

90− --title "${version}" \

91− --notes "${notes}" \

92− --prerelease

93−

94− # Upload artifacts

95− gh release upload "${version}" release/*.tar.gz

96− gh release upload "${version}" release/*.txt

97−

98− docker:

99− needs: publish

100− runs-on: ubuntu-latest

101− steps:

102− - name: Check out code

103− uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

104− with:

105− ref: ${{ needs.publish.outputs.tag }}

106− fetch-depth: 0

107− fetch-tags: true

108−

109− - name: Set up QEMU

110− uses: docker/setup-qemu-action@96fe6ef7f33517b61c61be40b68a1882f3264fb8 # v4.2.0

111−

112− - name: Set up Docker Buildx

113− id: buildx

114− uses: docker/setup-buildx-action@bb05f3f5519dd87d3ba754cc423b652a5edd6d2c # v4.2.0

115−

116− - name: Login to quay.io

117− uses: docker/login-action@dbcb813823bdd20940b903addbd779551569679f # v4.6.0

118− with:

119− registry: quay.io/oauth2-proxy

120− username: ${{ secrets.REGISTRY_USERNAME }}

121− password: ${{ secrets.REGISTRY_PASSWORD }}

122−

123− - name: Build images

124− run: |

125− make build-docker-all

126−

127− - name: Push images

128− run: |

129− make push-docker-all

.github/workflows/stale.yml+3−7

@@ -10,12 +10,8 @@ jobs:

10 runs-on: ubuntu-latest

10 runs-on: ubuntu-latest

11

11

12 steps:

12 steps:

13− - uses: actions/stale@4391f3da665fdf50b6810c1a66712fb9ba21aa93 # v11.0.0

13+ - uses: actions/stale@v1

14 with:

14 with:

15 repo-token: ${{ secrets.GITHUB_TOKEN }}

15 repo-token: ${{ secrets.GITHUB_TOKEN }}

16− days-before-stale: 180

17− days-before-close: 14

18− 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.'

16+ stale-issue-message: 'This issue has been inactive for 60 days. If the issue is still relevant please comment to re-activate the issue. If no action is taken within 7 days, the issue will be marked closed.'

19− 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.'

17+ stale-pr-message: 'This pull request has been inactive for 60 days. If the pull request is still relevant please comment to re-activate the pull request. If no action is taken within 7 days, the pull request will be marked closed.'

20− exempt-issue-labels: bug,high-priority

21− exempt-pr-labels: bug,high-priority

.github/workflows/test.shnew file+26

@@ -0,0 +1,26 @@

1+#!/bin/bash

2+# manually exiting from script, because after-build needs to run always

3+set +e

4+

5+if [ -z $CC_TEST_REPORTER_ID ]; then

6+ echo "1. CC_TEST_REPORTER_ID is unset, skipping"

7+else

8+ echo "1. Running before-build"

9+ ./cc-test-reporter before-build

10+fi

11+

12+echo "2. Running test"

13+make test

14+TEST_STATUS=$?

15+

16+if [ -z $CC_TEST_REPORTER_ID ]; then

17+ echo "3. CC_TEST_REPORTER_ID is unset, skipping"

18+else

19+ echo "3. Running after-build"

20+ ./cc-test-reporter after-build --exit-code $TEST_STATUS -t gocov --prefix $(go list -m)

21+fi

22+

23+if [ "$TEST_STATUS" -ne 0 ]; then

24+ echo "Test failed, status code: $TEST_STATUS"

25+ exit $TEST_STATUS

26+fi

.gitignore−3

@@ -17,10 +17,7 @@ c.out

17# Folders

17# Folders

18_obj

18_obj

19_test

19_test

20−.DS_Store

21.idea/

20.idea/

22−.vscode/*

23−!/.vscode/tasks.json

24

21

25# Architecture specific extensions/prefixes

22# Architecture specific extensions/prefixes

26*.[568vq]

23*.[568vq]

.golangci.yml+35−69

@@ -1,77 +1,43 @@

1−version: "2"

1+run:

2+ deadline: 120s

2linters:

3linters:

3− default: none

4 enable:

4 enable:

5+ - govet

6+ - golint

7+ - ineffassign

8+ - goconst

9+ - deadcode

10+ - gofmt

11+ - goimports

12+ - gosec

13+ - gosimple

14+ - staticcheck

15+ - structcheck

16+ - typecheck

17+ - unused

18+ - varcheck

5 - bodyclose

19 - bodyclose

6− - copyloopvar

7 - dogsled

20 - dogsled

8− - goconst

9− - gocritic

10 - goprintffuncname

21 - goprintffuncname

11− - gosec

12− - govet

13− - ineffassign

14 - misspell

22 - misspell

15 - prealloc

23 - prealloc

16− - revive

24+ - scopelint

17− - staticcheck

25+ - stylecheck

18 - unconvert

26 - unconvert

19− - unused

27+ - gocritic

20− exclusions:

28+ disable-all: true

21− generated: lax

29+issues:

22− presets:

23− - comments

24− - common-false-positives

25− - legacy

26− - std-error-handling

27− rules:

30+ exclude-rules:

28− - linters:

31+ - path: _test\.go

29− - bodyclose

32+ linters:

30− - goconst

31− - gocritic

32− - gosec

33− - revive

34− - scopelint

33+ - scopelint

34+ - bodyclose

35− - unconvert

35+ - unconvert

36− path: _test\.go

36+ - gocritic

37− - linters:

37+ - gosec

38− - revive

39− path: _test\.go

40− text: "dot-imports:"

41− # # If we have tests in shared test folders, these can be less strictly linted

38+ # If we have tests in shared test folders, these can be less strictly linted

42− - linters:

43− - bodyclose

44− - revive

45− - staticcheck

46− path: tests/.*_tests\.go

39+ - path: tests/.*_tests\.go

47− # See https://github.com/oauth2-proxy/oauth2-proxy/issues/3060

48− # https://staticcheck.dev/docs/checks/#QF1008

49− - linters:

40+ linters:

50− - staticcheck

41+ - golint

51− text: QF1008

42+ - bodyclose

52− - linters:

43+ - stylecheck

53− - revive

54− path: util/.*\.go$

55− text: "var-naming: avoid meaningless package names"

56− # pkg/version conflicts with go/version (added in Go 1.22)

57− - linters:

58− - revive

59− path: pkg/version/.*\.go$

60− text: "var-naming: avoid package names that conflict with"

61− - linters:

62− - prealloc

63− path: _test\.go

64− paths:

65− - third_party$

66− - builtin$

67− - examples$

68−formatters:

69− enable:

70− - gofmt

71− - goimports

72− exclusions:

73− generated: lax

74− paths:

75− - third_party$

76− - builtin$

77− - examples$

.pre-commit-config.yamldeleted−13

@@ -1,13 +0,0 @@

1−repos:

2− - repo: https://github.com/pre-commit/pre-commit-hooks

3− rev: v4.3.0

4− hooks:

5− - id: trailing-whitespace

6− - id: end-of-file-fixer

7− - id: check-yaml

8− - id: check-added-large-files

9− - repo: https://github.com/dnephin/pre-commit-golang

10− rev: v0.5.0

11− hooks:

12− - id: golangci-lint

13− - id: go-build

.vscode/launch.jsondeleted−36

@@ -1,36 +0,0 @@

1−{

2− "version": "0.2.0",

3− "configurations": [

4− {

5− "name": "OAuth2 Proxy for Dex",

6− "type": "go",

7− "request": "launch",

8− "mode": "auto",

9− "program": "${workspaceFolder}",

10− "args": [

11− "--config", "contrib/local-environment/oauth2-proxy.cfg"

12− ]

13− },

14− {

15− "name": "OAuth2 Proxy for Keycloak",

16− "type": "go",

17− "request": "launch",

18− "mode": "auto",

19− "program": "${workspaceFolder}",

20− "args": [

21− "--config", "contrib/local-environment/oauth2-proxy-keycloak.cfg"

22− ]

23− },

24− {

25− "name": "OAuth2 Proxy with Alpha Config",

26− "type": "go",

27− "request": "launch",

28− "mode": "auto",

29− "program": "${workspaceFolder}",

30− "args": [

31− "--config", "contrib/local-environment/oauth2-proxy-alpha-config.cfg",

32− "--alpha-config", "contrib/local-environment/oauth2-proxy-alpha-config.yaml"

33− ]

34− }

35− ]

36−}

.vscode/tasks.jsondeleted−76

@@ -1,76 +0,0 @@

1−{

2− "version": "2.0.0",

3− "tasks": [

4− {

5− "label": "Run oauth2-proxy",

6− "type": "shell",

7− "command": "./oauth2-proxy --config contrib/local-environment/oauth2-proxy.cfg --alpha-config contrib/local-environment/oauth2-proxy-alpha0config.cfg",

8− "dependsOn": ["Build"],

9− "group": {

10− "kind": "test",

11− "isDefault": true

12− },

13− "presentation": {

14− "reveal": "always",

15− "panel": "new"

16− },

17− "problemMatcher": []

18− },

19− {

20− "label": "Test",

21− "type": "shell",

22− "command": "make test",

23− "group": {

24− "kind": "test",

25− "isDefault": true

26− },

27− "presentation": {

28− "reveal": "always",

29− "panel": "new"

30− },

31− "problemMatcher": []

32− },

33− {

34− "label": "Ruff",

35− "type": "shell",

36− "command": "pre-commit run ruff --all-files",

37− "group": {

38− "kind": "test",

39− "isDefault": true

40− },

41− "presentation": {

42− "reveal": "always",

43− "panel": "new"

44− },

45− "problemMatcher": []

46− },

47− {

48− "label": "golint",

49− "type": "shell",

50− "command": "make lint",

51− "group": {

52− "kind": "test",

53− "isDefault": true

54− },

55− "presentation": {

56− "reveal": "always",

57− "panel": "new"

58− },

59− "problemMatcher": []

60− },

61− {

62− "label": "Build",

63− "type": "shell",

64− "command": "make build",

65− "group": {

66− "kind": "test",

67− "isDefault": true

68− },

69− "presentation": {

70− "reveal": "always",

71− "panel": "new"

72− },

73− "problemMatcher": []

74− }

75− ]

76−}

CHANGELOG.md+1−845

@@ -4,847 +4,11 @@

4

4

5## Important Notes

5## Important Notes

6

6

7−## Breaking Changes

8−

9−## Changes since v7.15.4

10−

11−# V7.15.4

12−

13−## Release Highlights

14−

15−- 🔵 Golang version upgrade to v1.26.7

16− - Upgrade of all dependencies to their latest versions

17−- 🕵️‍♀️ Vulnerabilities have been addressed

18− - [CVE-2026-33818](https://nvd.nist.gov/vuln/detail/CVE-2026-33818)

19− - [CVE-2026-39821](https://nvd.nist.gov/vuln/detail/CVE-2026-39821)

20− - [CVE-2026-39822](https://nvd.nist.gov/vuln/detail/CVE-2026-39822)

21− - [CVE-2026-42505](https://nvd.nist.gov/vuln/detail/CVE-2026-42505)

22− - [CVE-2026-46600](https://nvd.nist.gov/vuln/detail/CVE-2026-46600)

23− - [CVE-2026-56852](https://nvd.nist.gov/vuln/detail/CVE-2026-56852)

24− - [CVE-2026-56853](https://nvd.nist.gov/vuln/detail/CVE-2026-56853)

25− - [CVE-2026-56858](https://nvd.nist.gov/vuln/detail/CVE-2026-56858)

26− - [CVE-2026-56859](https://nvd.nist.gov/vuln/detail/CVE-2026-56859)

27− - [CVE-2026-56860](https://nvd.nist.gov/vuln/detail/CVE-2026-56860)

28− - [CVE-2026-56862](https://nvd.nist.gov/vuln/detail/CVE-2026-56862)

29−

30−## Important Notes

31−

32−## Breaking Changes

33−

34−## Changes since v7.15.3

35−

36−- [#3493](https://github.com/oauth2-proxy/oauth2-proxy/pull/3493) chore(deps): update gomod @tuunit

37−

38−# V7.15.3

39−

40−## Release Highlights

41−

42−- 🔵 Golang version upgrade to v1.26.4

43− - Upgrade of all dependencies to their latest versions

44−- 🕵️‍♀️ Vulnerabilities have ben addressed

45− - [CVE-2026-33811](https://nvd.nist.gov/vuln/detail/)

46− - [CVE-2026-33814](https://nvd.nist.gov/vuln/detail/)

47− - [CVE-2026-39820](https://nvd.nist.gov/vuln/detail/)

48− - [CVE-2026-39836](https://nvd.nist.gov/vuln/detail/)

49− - [CVE-2026-42499](https://nvd.nist.gov/vuln/detail/)

50− - [CVE-2026-42504](https://nvd.nist.gov/vuln/detail/)

51− - [CVE-2026-39823](https://nvd.nist.gov/vuln/detail/)

52− - [CVE-2026-39826](https://nvd.nist.gov/vuln/detail/)

53− - [CVE-2026-39825](https://nvd.nist.gov/vuln/detail/)

54− - [CVE-2026-27145](https://nvd.nist.gov/vuln/detail/)

55− - [CVE-2026-42507](https://nvd.nist.gov/vuln/detail/)

56−

57−## Important Notes

58−

59−## Breaking Changes

60−

61−## Changes since v7.15.2

62−

63−- [#3477](https://github.com/oauth2-proxy/oauth2-proxy/pull/3477) chore(dep): bump go to 1.26 and migrate of reverse proxy handling

64−

65−# V7.15.2

66−

67−## Release Highlights

68−

69−- 🔵 Golang version upgrade to v1.25.9

70− - Upgrade of all dependencies to their latest versions

71− - [CVE-2026-34986](https://nvd.nist.gov/vuln/detail/CVE-2026-34986)

72− - [CVE-2026-32281](https://nvd.nist.gov/vuln/detail/CVE-2026-32281)

73− - [CVE-2026-32289](https://nvd.nist.gov/vuln/detail/CVE-2026-32289)

74− - [CVE-2026-32288](https://nvd.nist.gov/vuln/detail/CVE-2026-32288)

75− - [CVE-2026-32280](https://nvd.nist.gov/vuln/detail/CVE-2026-32280)

76− - [CVE-2026-32282](https://nvd.nist.gov/vuln/detail/CVE-2026-32282)

77− - [CVE-2026-32283](https://nvd.nist.gov/vuln/detail/CVE-2026-32283)

78−- 🕵️‍♀️ Vulnerabilities have been addressed

79−

80−## Important Notes

81−

82−We have had security audits performed on OAuth2 Proxy in the past couple of weeks and as a result we have fixed

83−several CRITICAL vulnerabilities.

84−

85−The security vulnerabilities include multiple authentication bypasses and a potential session fixation attack.

86−For more details and to identify if you are effects, we urge all users of OAuth2 Proxy to read the security

87−disclosures.

88−

89−- (Critical) [GHSA-5hvv-m4w4-gf6v](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-5hvv-m4w4-gf6v) fix: health check user-agent authentication bypass

90−- (Critical) [GHSA-7x63-xv5r-3p2x](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-7x63-xv5r-3p2x) fix: authentication bypass via X-Forwarded-Uri header spoofing

91−- (High) [GHSA-pxq7-h93f-9jrg](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-pxq7-h93f-9jrg) fix: fragment evaluation as part of the allowed routes

92−- (Moderate) [GHSA-c5c4-8r6x-56w3](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-c5c4-8r6x-56w3) fix: email validation bypass via malformed multi-@ email claims

93−

94−Furthermore, for improving the security of OAuth2 Proxy we introduced a new flag `--trusted-proxy-ip` that allows users

95−to explicitly specify trusted reverse proxy IPs for the `X-Forwarded-*` headers. This is an important step to prevent

96−potential header spoofing attacks and to ensure that OAuth2 Proxy only trusts headers from known and trusted sources.

97−We highly recommend users to review their deployment architecture and consider using this flag to enhance the security

98−of their OAuth2 Proxy instances. Check the docs for more details: https://oauth2-proxy.github.io/oauth2-proxy/configuration/overview#proxy-options

99−

100−Furthermore, we want to thank everyone who contributed to the audits and reported potential issues to make open source

101−software like OAuth2 Proxy more secure for everyone.

102−

103−## Breaking Changes

104−

105−## Changes since v7.15.1

106−

107−- [#3411](https://github.com/oauth2-proxy/oauth2-proxy/pull/3411) chore(deps): update gomod dependencies (@tuunit)

108−- [#3333](https://github.com/oauth2-proxy/oauth2-proxy/pull/3333) fix: invalidate session on fatal OAuth2 refresh errors (@frhack)

109−- [GHSA-f24x-5g9q-753f](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-f24x-5g9q-753f) fix: clear session cookie at beginning of signinpage handler (@fnoehWM / @bella-WI / @tuunit)

110−- [GHSA-5hvv-m4w4-gf6v](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-5hvv-m4w4-gf6v) fix: health check user-agent authentication bypass (@tuunit)

111−- [GHSA-7x63-xv5r-3p2x](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-7x63-xv5r-3p2x) fix: authentication bypass via X-Forwarded-Uri header spoofing (@tuunit)

112−- [GHSA-pxq7-h93f-9jrg](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-pxq7-h93f-9jrg) fix: fragment evaluation as part of the allowed routes (@tuunit)

113−- [GHSA-c5c4-8r6x-56w3](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-c5c4-8r6x-56w3) fix: email validation bypass via malformed multi-@ email claims (@tuunit)

114−

115−# V7.15.1

116−

117−## Release Highlights

118−

119−- 🐛 Squashed some bugs

120−- 🕵️‍♀️ Vulnerabilities have been addressed

121− - [CVE-2026-33186](https://nvd.nist.gov/vuln/detail/CVE-2026-33186)

122− OAuth2 Proxy was not impacted by this vulnerability as it isn't in the path of execution

123−

124−## Important Notes

125−

126−## Breaking Changes

127−

128−## Changes since v7.15.0

129−

130−- [#3382](https://github.com/oauth2-proxy/oauth2-proxy/pull/3382) chore(deps): update gomod and golangci/golangci-lint to v2.11.4 (@tuunit)

131−- [#3374](https://github.com/oauth2-proxy/oauth2-proxy/pull/3374) fix: handle Unix socket RemoteAddr in IP resolution (@H1net)

132−- [#3381](https://github.com/oauth2-proxy/oauth2-proxy/pull/3381) fix: do not log error for backend logout 204 (@artificiosus)

133−- [#3327](https://github.com/oauth2-proxy/oauth2-proxy/pull/3327) fix: improve logging when session refresh token is missing (@yosri-brh)

134−- [#2767](https://github.com/oauth2-proxy/oauth2-proxy/pull/2767) fix: propagate errors during route building (@sybereal)

135−

136−# V7.15.0

137−

138−## Release Highlights

139−

140−- 🔒 OIDC JWT signing algorithms can now be configured

141−- 🍪 CSRF cookie improvements (SameSite option, proper expiration validation)

142−- 🧪 Configuration validation flag: --config-test

143−- 🔌 Unix socket file mode support

144−- 👤 Session state can now be extend with arbitrary claims from ID Token and upstream IDP user profiles endpoint

145− - This opens the door for multiple features like:

146− - Additional arbitrary header values for any claims your IDP provides

147− - Extended OAuth2 Proxy UserInfo endpoint with all additional claims

148− - Read the docs [here](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#how-to-utilize-arbitrary-claims-provided-by-your-identity-provider)

149−

150−## Important Notes

151−

152−CSRF cookie validation now correctly uses `CSRFExpire` instead of `Expire`. If you relied on the previous behavior, review your session timeout configuration.

153−Check the [documentation(https://oauth2-proxy.github.io/oauth2-proxy/configuration/overview#cookie-options) for `cookie-csrf-expire`.

154−

155−## Breaking Changes

156−

157−## Changes since v7.14.3

158−

159−- [#3352](https://github.com/oauth2-proxy/oauth2-proxy/pull/3352) fix: backend logout URL call on sign out (#3172)(@vsejpal)

160−- [#3332](https://github.com/oauth2-proxy/oauth2-proxy/pull/3332) ci: distribute windows binary with .exe extension (@igitur)

161−- [#2685](https://github.com/oauth2-proxy/oauth2-proxy/pull/2685) feat: allow arbitrary claims from the IDToken and IdentityProvider UserInfo endpoint to be added to the session state (@vegetablest)

162−- [#3278](https://github.com/oauth2-proxy/oauth2-proxy/pull/3278) feat: possibility to inject id_token in redirect url during sign out (@albanf)

163−- [#2851](https://github.com/oauth2-proxy/oauth2-proxy/pull/2851) feat: add support for specifying allowed OIDC JWT signing algorithms (#2753) (@andoks / @tuunit)

164−- [#3369](https://github.com/oauth2-proxy/oauth2-proxy/pull/3369) fix: use CSRFExpire instead of Expire for CSRF cookie validation (@Br1an67)

165−- [#3365](https://github.com/oauth2-proxy/oauth2-proxy/pull/3365) fix: filter empty strings from allowed groups (@Br1an67)

166−- [#3338](https://github.com/oauth2-proxy/oauth2-proxy/pull/3338) feat: add --config-test flag for validating configuration (@MayorFaj)

167−- [#3347](https://github.com/oauth2-proxy/oauth2-proxy/pull/3347) feat: add same site option for csrf cookies (@jvnoije)

168−- [#3376](https://github.com/oauth2-proxy/oauth2-proxy/pull/3376) feat: allow setting unix socket file mode when declaring listener (@Tristan971 / @tuunit)

169−

170−# V7.14.3

171−

172−## Release Highlights

173−

174−- 🔵 Go1.25.7 and upgrade of dependencies to latest versions

175− - Fixes [CVE-2025-68121](https://nvd.nist.gov/vuln/detail/cve-2025-68121)

176−- 🐛 Bug fixes

177− - Allow Redis URL parameters to configure username, password and max idle connection timeout if the matching configuration is empty.

178−

179−## Important Notes

180−

181−We improved our supply chain security by added additional checks to prevent potential command injection in the publish release workflow and to ensure that it can only be triggered from branches originating in the local repository. This potential issue was reported by automated systems as well as a couple of security researchers, and we want to thank everyone for their diligence in looking out for the security of the project. Especially Aastha Aggarwal for her detailed report and follow-up. @Aastha2602

182−

183−

184−## Breaking Changes

185−

186−## Changes since v7.14.2

187−

188−- [#3183](https://github.com/oauth2-proxy/oauth2-proxy/pull/3183) fix: allow URL parameters to configure username, password and max idle connection timeout if the matching configuration is empty.

189−

190−# V7.14.2

191−

192−## Release Highlights

193−

194−- Revert AuthOnly endpoint change from v7.14.1 that caused issues when using `skip-provider-button` enabled

195−

196−## Important Notes

197−

198−- This release reverts the change made in v7.14.1 that caused issues when using the `skip-provider-button` enabled. Now, when a session does not exist, the AuthOnly endpoint will send a 401 status code as expected instead of a 302 redirect. And instead we extended the documentation to clarify the behavior when using `nginx` with `auth_request` and `skip-provider-button` and how to properly configure redirects for browser and API routes.

199−

200−## Breaking Changes

201−

202−## Changes since v7.14.1

203−

204−- [#3314](https://github.com/oauth2-proxy/oauth2-proxy/pull/3314) revert: fix: skip provider button auth only redirect (#3309) (@StefanMarkmann / @tuunit)

205−- [#3315](https://github.com/oauth2-proxy/oauth2-proxy/pull/3315) docs: clarify browser vs API routes for nginx auth_request redirects (@StefanMarkmann)

206−

207−# V7.14.1

208−

209−## Release Highlights

210−

211−- 🔵 Go1.25.6 and upgrade of dependencies to latest versions

212−- 🐛 Bug fixes

213− - AuthOnly now starts the auth flow and send status code 302 if no session exists and skip-provider-button is true

214− - Fixed static upstream validation issue due to incorrect defaults

215−

216−## Important Notes

217−

218−## Breaking Changes

219−

220−## Changes since v7.14.0

221−

222−- [#3309](https://github.com/oauth2-proxy/oauth2-proxy/pull/3309) fix: Return 302 redirect from AuthOnly endpoint when skip-provider-button is true (@StefanMarkmann)

223−- [#3302](https://github.com/oauth2-proxy/oauth2-proxy/pull/3302) fix: static upstreams failing validation due to `passHostHeader` and `proxyWebSockets` defaults being set incorrectly (@sourava01 / @tuunit)

224−- [#3312](https://github.com/oauth2-proxy/oauth2-proxy/pull/3312) chore(deps): upgrade to go1.25.6 and latest dependencies (@tuunit)

225−

226−# V7.14.0

227−

228−## Release Highlights

229−

230−- 🕵️‍♀️ Vulnerabilities have been addressed

231− - [CVE-2025-61729](https://access.redhat.com/security/cve/cve-2025-61729)

232− - [CVE-2025-61727](https://access.redhat.com/security/cve/cve-2025-61727)

233− - [CVE-2025-47914](https://access.redhat.com/security/cve/cve-2025-47914)

234− - [CVE-2025-58181](https://access.redhat.com/security/cve/cve-2025-58181)

235−- 🗂️ AMajor Alpha Config YAML parsing revamped for better extensibility and preparing v8

236−- 🐛 Squashed some bugs

237−

238−## Important Notes

239−

240−This release introduces a breaking change for Alpha Config users and moves us significantly

241−closer to removing legacy configuration parameters, making the codebase of OAuth2 Proxy more

242−future proof and extensible.

243−

244−From v7.14.0 onward, header injection sources must be explicitly nested. If you

245−previously relied on squashed fields, update to the new structure before upgrading:

246−

247−```yaml

248−# before v7.14.0

249−injectRequestHeaders:

250−- name: X-Forwarded-User

251− values:

252− - claim: user

253−- name: X-Custom-Secret-header

254− values:

255− - value: my-super-secret

256−

257−# v7.14.0 and later

258−injectRequestHeaders:

259−- name: X-Forwarded-User

260− values:

261− - claimSource:

262− claim: user

263−- name: X-Custom-Secret-header

264− values:

265− - secretSource:

266− value: my-super-secret

267−```

268−

269−Furthermore, Alpha Config now fully supports configuring the `Server` struct using YAML.

270−

271−```yaml

272−// Server represents the configuration for the Proxy HTTP(S) configuration.

273−type Server struct {

274− // BindAddress is the address on which to serve traffic.

275− BindAddress string `yaml:"bindAddress,omitempty"`

276−

277− // SecureBindAddress is the address on which to serve secure traffic.

278− SecureBindAddress string `yaml:"secureBindAddress,omitempty"`

279−

280− // TLS contains the information for loading the certificate and key for the

281− // secure traffic and further configuration for the TLS server.

282− TLS *TLS `yaml:"tls,omitempty"`

283−}

284−

285−// TLS contains the information for loading a TLS certificate and key

286−// as well as an optional minimal TLS version that is acceptable.

287−type TLS struct {

288− // Key is the TLS key data to use.

289− Key *SecretSource `yaml:"key,omitempty"`

290− // Cert is the TLS certificate data to use.

291− Cert *SecretSource `yaml:"cert,omitempty"`

292− // MinVersion is the minimal TLS version that is acceptable.

293− MinVersion string `yaml:"minVersion,omitempty"`

294− // CipherSuites is a list of TLS cipher suites that are allowed.

295− CipherSuites []string `yaml:"cipherSuites,omitempty"`

296−}

297−```

298−

299−More about how to use Alpha Config can be found in the [documentation](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#server).

300−

301−We are committed to Semantic Versioning and usually avoid breaking changes without a major version release.

302−Advancing Alpha Config toward its Beta stage required this exception, and even for the Alpha Config we try

303−to keep breaking changes in v7 to a minium. Thank you for understanding the need for this step to prepare

304−the project for future maintainability and future improvements like structured logging.

305−

306−## Breaking Changes

307−

308−- Alpha Config: header injection no longer supports squashed claim/secret sources; they must now be set explicitly (see example above).

309−

310−## Changes since v7.13.0

311−

312−- [#2628](https://github.com/oauth2-proxy/oauth2-proxy/pull/2628) feat(structured config): revamp of yaml parsing using mapstructure decoder and custom decoders (@tuunit)

313−- [#3197](https://github.com/oauth2-proxy/oauth2-proxy/pull/3197) fix: NewRemoteKeySet is not using DefaultHTTPClient (@rsrdesarrollo / @tuunit)

314−- [#3292](https://github.com/oauth2-proxy/oauth2-proxy/pull/3292) chore(deps): upgrade gomod and bump to golang v1.25.5 (@tuunit)

315−- [#3304](https://github.com/oauth2-proxy/oauth2-proxy/pull/3304) fix: added conditional so default is not always set and env vars are honored fixes 3303 (@pixeldrew)

316−- [#3264](https://github.com/oauth2-proxy/oauth2-proxy/pull/3264) fix: more aggressively truncate logged access_token (@MartinNowak / @tuunit)

317−- [#3267](https://github.com/oauth2-proxy/oauth2-proxy/pull/3267) fix: Session refresh handling in OIDC provider (@gysel)

318−- [#3290](https://github.com/oauth2-proxy/oauth2-proxy/pull/3290) fix: WebSocket proxy to respect PassHostHeader setting (@UnsignedLong)

319−

320−# V7.13.0

321−

322−## Release Highlights

323−

324−- 🕵️‍♀️ Vulnerabilities have been addressd

325− - [CVE-2025-47912](https://nvd.nist.gov/vuln/detail/CVE-2025-47912)

326− - [CVE-2025-58183](https://nvd.nist.gov/vuln/detail/CVE-2025-58183)

327− - [CVE-2025-58186](https://nvd.nist.gov/vuln/detail/CVE-2025-58186)

328− - [CVE-2025-64484](https://nvd.nist.gov/vuln/detail/CVE-2025-64484)

329−- 🐛 Squashed some bugs

330−

331−## Important Notes

332−

333−By default all specified headers will now be normalized, meaning that both capitalization and the use of underscores (_) versus dashes (-) will be ignored when matching headers to be stripped. For example, both `X-Forwarded-For` and `X_Forwarded-for` will now be treated as equivalent and stripped away.

334−

335−Please read our security advisory for CVE-2025-64484: [GHSA-vjrc-mh2v-45x6](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-vjrc-mh2v-45x6)

336−

337−Furthermore, we now use the access_token for validating refreshed sessions in OIDC providers instead of the id_token. This is to align with the [OIDC specification](https://openid.net/specs/openid-connect-core-1_0.html#RefreshTokens) which states that id_tokens are not guaranteed to be issued when using refresh tokens. In future releases we might remove the id_token validation for sessions completely.

338−

339−## Breaking Changes

340−

341−## Changes since v7.12.0

342−

343−- [#3228](https://github.com/oauth2-proxy/oauth2-proxy/pull/3228) fix: use GetSecret() in ticket.go makeCookie to respect cookie-secret-file (@stagswtf)

344−- [#3244](https://github.com/oauth2-proxy/oauth2-proxy/pull/3244) chore(deps): upgrade to latest go1.25.3 (@tuunit)

345−- [#3238](https://github.com/oauth2-proxy/oauth2-proxy/pull/3238) chore: Replace pkg/clock with narrowly targeted stub clocks (@dsymonds)

346−- [#3237](https://github.com/oauth2-proxy/oauth2-proxy/pull/3237) - feat: add option to use organization id for preferred username in Google Provider (@pixeldrew)

347−- [GHSA-vjrc-mh2v-45x6](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-vjrc-mh2v-45x6) fix: request header smuggling by stripping all normalized header variants (@tuunit)

348−- [#1933](https://github.com/oauth2-proxy/oauth2-proxy/pull/1933) fix: validation of refreshed sessions using the access_token in the OIDC provider (@gysel / @tuunit)

349−- [#2841](https://github.com/oauth2-proxy/oauth2-proxy/pull/2841) feat: add allowed_* constraint option to proxy endpoint query string (@jacobalberty)

350−

351−# V7.12.0

352−

353−## Release Highlights

354−

355−- 🕵️‍♀️ Vulnerabilities have been addressed

356− - [CVE-2025-47907](https://pkg.go.dev/vuln/GO-2025-3849)

357−- 🦸 Support for Cidaas IDP

358−- 🐛 Squashed some bugs

359−

360−

361−## Important Notes

362−

363−## Breaking Changes

364−

365−## Changes since v7.11.0

366−

367−- [#2273](https://github.com/oauth2-proxy/oauth2-proxy/pull/2273) feat: add Cidaas provider (@Bibob7, @Teko012)

368−- [#3166](https://github.com/oauth2-proxy/oauth2-proxy/pull/3166) chore(dep): upgrade to latest golang 1.24.6 (@tuunit)

369−- [#3156](https://github.com/oauth2-proxy/oauth2-proxy/pull/3156) feat: allow disable-keep-alives configuration for upstream (@jet-go)

370−- [#3150](https://github.com/oauth2-proxy/oauth2-proxy/pull/3150) fix: Gitea team membership (@MagicRB, @tuunit)

371−

372−# V7.11.0

373−

374−## Release Highlights

375−

376−- 🏢 Support for SourceHut (sr.ht) provider

377−- 🔍️ Support for more fine-grained control over the google admin-sdk scopes and optional google groups

378−- 🐛 Squashed some bugs

379−

380−

381−## Important Notes

382−

383−Firstly, fixed critical vulnerability where `skip_auth_routes` regex patterns matched against the full request URI (path + query parameters) instead of just the path, allowing authentication bypass attacks.

384−

385−Secondly, fixed double-escaping of `$` in regexes for Alpha Config upstreams path and rewriteTargets:

386−

387−```yaml

388−# Before

389−upstreams:

390− - id: web

391− path: ^/(.*)$$

392− rewriteTarget: /$$1

393−

394−# After

395−upstreams:

396− - id: web

397− path: ^/(.*)$

398− rewriteTarget: /$1

399−```

400−

401−

402−## Breaking Changes

403−

404−If your configuration relies on matching query parameters in `skip_auth_routes` patterns, you must update your regex patterns to match paths only. Review all `skip_auth_routes` entries for potential impact.

405−

406−**Example of affected configuration:**

407−```yaml

408−# This pattern previously matched both:

409−# - /api/foo/status (intended)

410−# - /api/private/sensitive?path=/status (bypass - now fixed)

411−skip_auth_routes: ["^/api/.*/status"]

412−```

413−

414−For detailed information, migration guidance, and security implications, see the [security advisory](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-7rh7-c77v-6434).

415−

416−## Changes since v7.10.0

417−

418−- [#2615](https://github.com/oauth2-proxy/oauth2-proxy/pull/2615) feat(cookies): add option to set a limit on the number of per-request CSRF cookies oauth2-proxy sets (@bh-tt)

419−- [#2605](https://github.com/oauth2-proxy/oauth2-proxy/pull/2605) fix: show login page on broken cookie (@Primexz)

420−- [#2743](https://github.com/oauth2-proxy/oauth2-proxy/pull/2743) feat: allow use more possible google admin-sdk api scopes (@BobDu)

421−- [#2359](https://github.com/oauth2-proxy/oauth2-proxy/pull/2359) feat: add SourceHut (sr.ht) provider(@bitfehler)

422−- [#2524](https://github.com/oauth2-proxy/oauth2-proxy/pull/2524) fix: regex substitution for $ signs in upstream path handling before running envsubst (@dashkan / @tuunit)

423−- [#3104](https://github.com/oauth2-proxy/oauth2-proxy/pull/3104) feat(cookie): add feature support for cookie-secret-file (@sandy2008)

424−- [#3055](https://github.com/oauth2-proxy/oauth2-proxy/pull/3055) feat: support non-default authorization request response mode also for OIDC providers (@stieler-it)

425−- [#3138](https://github.com/oauth2-proxy/oauth2-proxy/pull/3138) feat: make google_groups argument optional when using google provider (@sourava01)

426−- [#3093](https://github.com/oauth2-proxy/oauth2-proxy/pull/3093) feat: differentiate between "no available key" and error for redis sessions (@nobletrout)

427−- [GHSA-7rh7-c77v-6434](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-7rh7-c77v-6434) fix: skip_auth_routes bypass through query parameter inclusion

428−

429−

430−# V7.10.0

431−

432−## Release Highlights

433−- 🏢 Support for multiple orgs using the GitHub / Gitea provider

434−- 🔵 Golang version upgrade to v1.24.5

435−- 🕵️‍♀️ Vulnerabilities have been addressed

436− - [CVE-2025-4673](https://access.redhat.com/security/cve/CVE-2025-4673)

437− - [CVE-2025-22872](https://access.redhat.com/security/cve/CVE-2025-22872)

438− - [CVE-2025-09130](https://nvd.nist.gov/vuln/detail/CVE-2025-09130)

439− - [CVE-2025-22871](https://access.redhat.com/security/cve/CVE-2025-22871)

440−- 🐛 Squashed some bugs

441−

442−## Important Notes

443−

444−## Breaking Changes

445−

446−## Changes since v7.9.0

447−

448−- [#3072](https://github.com/oauth2-proxy/oauth2-proxy/pull/3072) feat: support for multiple github orgs #3072 (@daniel-mersch)

449−- [#3116](https://github.com/oauth2-proxy/oauth2-proxy/pull/3116) feat: bump to go1.24.5 and full dependency update (@wardviaene / @dolmen)

450−- [#3097](https://github.com/oauth2-proxy/oauth2-proxy/pull/3097) chore(deps): update alpine base image to v3.22.0

451−- [#3101](https://github.com/oauth2-proxy/oauth2-proxy/pull/3101) fix: return error for empty Redis URL list (@dgivens)

452−

453−# V7.9.0

454−

455−## Release Highlights

456−- 📨 OAuth 2.0 Multiple Response Type Encoding

457−- 📦️ Support for JWT encoded profile claims

458−- 🔵 Golang version upgrade to v1.23.8

459−- 🕵️‍♀️ Vulnerabilities have been addressed

460− - [CVE-2025-22871](https://github.com/advisories/GHSA-g9pc-8g42-g6vq)

461−- 🐛 Squashed some bugs

462−

463−## Important Notes

464−

465−## Breaking Changes

466−

467−## Changes since v7.8.2

468−

469−- [#3031](https://github.com/oauth2-proxy/oauth2-proxy/pull/3031) Fixes Refresh Token bug with Entra ID and Workload Identity (#3027)[https://github.com/oauth2-proxy/oauth2-proxy/issues/3028] by using client assertion when redeeming the token (@richard87)

470−- [#3001](https://github.com/oauth2-proxy/oauth2-proxy/pull/3001) Allow to set non-default authorization request response mode (@stieler-it)

471−- [#3041](https://github.com/oauth2-proxy/oauth2-proxy/pull/3041) chore(deps): upgrade to latest golang v1.23.x release (@TheImplementer)

472−- [#1916](https://github.com/oauth2-proxy/oauth2-proxy/pull/1916) fix: role extraction from access token in keycloak oidc (@Elektordi / @tuunit)

473−- [#3014](https://github.com/oauth2-proxy/oauth2-proxy/pull/3014) feat: ability to parse JWT encoded profile claims (@ikarius)

474−

475−# V7.8.2

476−

477−## Release Highlights

478−- 🐛 Cookie Expiration bug has been squashed

479−- 🔵 Golang version upgrade to v1.23.7

480−- 🕵️‍♀️ Vulnerabilities have been addressed

481− - CVE-2025-30204

482− - CVE-2025-27144

483− - CVE-2024-45336

484− - CVE-2025-22866

485− - CVE-2025-22870

486− - CVE-2024-45341

487− - CVE-2025-29923

488− - CVE-2025-22866

489− - CVE-2024-34156

490−

491−## Important Notes

492−

493−## Breaking Changes

494−

495−## Changes since v7.8.1

496−

497−- [#2918](https://github.com/oauth2-proxy/oauth2-proxy/issues/2918) feat: add --bearer-token-login-fallback (@carillonator)

498−- [#2927](https://github.com/oauth2-proxy/oauth2-proxy/pull/2927) chore(deps/build): bump golang to 1.23 and use go.mod as single point of truth for all build files (@tuunit)

499−- [#2697](https://github.com/oauth2-proxy/oauth2-proxy/pull/2697) Use `Max-Age` instead of `Expires` for cookie expiration (@matpen-wi)

500−- [#2969](https://github.com/oauth2-proxy/oauth2-proxy/pull/2969) Update golang.org/x/oauth2 to v0.27.0 to address CVE-2025-22868 (@dsymonds)

501−- [#2977](https://github.com/oauth2-proxy/oauth2-proxy/pull/2977) Update golang.org/x/net to v0.36.0 to address CVE-2025-22870 (@dsymonds)

502−- [#2982](https://github.com/oauth2-proxy/oauth2-proxy/pull/2982) chore(deps): remove go:generate tool from go.mod (@dolmen)

503−- [#3011](https://github.com/oauth2-proxy/oauth2-proxy/pull/3011) chore(deps): update golang dependencies and pin to latest golang v1.23.x release (@tuunit)

504−- [#2967](https://github.com/oauth2-proxy/oauth2-proxy/pull/2967) Update HashNonce to use crypto/sha256 (@egibs)

505−

506−# V7.8.1

507−

508−## Release Highlights

509−

510−- 🐛 Two bugs have been squashed

511−

512−## Important Notes

513−

514−## Breaking Changes

515−

516−## Changes since v7.8.0

517−

518−- [#2887](https://github.com/oauth2-proxy/oauth2-proxy/issues/2887) fix: jwt regex validation error during skip-jwt-bearer-tokens flow

519−- [#2920](https://github.com/oauth2-proxy/oauth2-proxy/pull/2920) fix: missing oauth2-proxy version for docker builds

520−

521−# V7.8.0

522−

523−## Release Highlights

524−

525−- ☁️ Introducing support for Microsoft Entra ID

526− - Including Support for Azure Workload Identity as well

527− - Including full e2e testing using Azure Credits from MS sponsoring

528− - Deprecated old Azure AD provider

529−- 🪪 Static local JWKS file support

530−- Support for systemd sockets

531−- 🐛 Several bugs have been squashed

532−- 🕵️‍♀️ Vulnerabilities have been addressed

533− - CVE-2024-45338

534−

535−## Important Notes

536−

537−## Breaking Changes

538−

539−## Changes since v7.7.1

540−

541−- [#2390](https://github.com/oauth2-proxy/oauth2-proxy/pull/2390) feat: add Microsoft Entra ID provider (@jjlakis / @tuunit)

542−- [#2902](https://github.com/oauth2-proxy/oauth2-proxy/pull/2902) feat(entra): add Workload Identity support for Entra ID (@jjlakis)

543−- [#2800](https://github.com/oauth2-proxy/oauth2-proxy/pull/2800) doc: add some opencontainer labels to docker image (@halkeye)

544−- [#2755](https://github.com/oauth2-proxy/oauth2-proxy/pull/2755) feat: add X-Envoy-External-Address as supported header (@bjencks)

545−- [#1985](https://github.com/oauth2-proxy/oauth2-proxy/pull/1985) feat: add support for systemd socket (@isodude)

546−- [#2916](https://github.com/oauth2-proxy/oauth2-proxy/pull/2916) fix: systemd socket support build handling for windows (@tuunit)

547−- [#2300](https://github.com/oauth2-proxy/oauth2-proxy/pull/2300) fix: add fix for websocket path rewrite (@rekup)

548−- [#2821](https://github.com/oauth2-proxy/oauth2-proxy/pull/2821) feat: add CF-Connecting-IP as supported real ip header (@ondrejsika)

549−- [#2620](https://github.com/oauth2-proxy/oauth2-proxy/pull/2620) fix: update code_verifier to use recommended method (@vishvananda)

550−- [#2376](https://github.com/oauth2-proxy/oauth2-proxy/pull/2376) feat: static public keys file support for oidc provider (@axel7083 / @jjlakis)

551−- [#2392](https://github.com/oauth2-proxy/oauth2-proxy/pull/2392) chore: extend test cases for oidc provider and documentation regarding implicit setting of the groups scope when no scope was specified in the config (@jjlakis / @tuunit)

552−

553−# V7.7.1

554−

555−## Release Highlights

556−

557−- 🐛 Several bugs have been squashed

558−

559−## Important Notes

560−

561−## Breaking Changes

562−

563−## Changes since v7.7.0

564−

565−- [#2803](https://github.com/oauth2-proxy/oauth2-proxy/pull/2803) fix: self signed certificate handling in v7.7.0 (@tuunit)

566−- [#2619](https://github.com/oauth2-proxy/oauth2-proxy/pull/2619) fix: unable to use hyphen in JSON path for oidc-groups-claim option (@rd-danny-fleer)

567−- [#2311](https://github.com/oauth2-proxy/oauth2-proxy/pull/2311) fix: runtime error: index out of range (0) with length 0 (@miguelborges99 / @tuunit)

568−

569−# V7.7.0

570−

571−## Release Highlights

572−

573−- 🌐 Custom user agent "oauth2-proxy/<version>"

574−- 💾 Added s390x architecture support

575−- 🕵️‍♀️ Vulnerabilities have been addressed

576− - CVE-2024-24786

577− - CVE-2024-24791

578− - CVE-2024-24790

579− - CVE-2024-24784

580−- 📖 Improved docs

581−

582−## Important Notes

583−- Remove support of arm/v6 for distroless image runtime. Alpine tags still support arm/v6.

584−

585−## Breaking Changes

586−

587−## Changes since v7.6.0

588−

589−- [#2539](https://github.com/oauth2-proxy/oauth2-proxy/pull/2539) pkg/http: Fix leaky test (@isodude)

590−- [#4917](https://github.com/oauth2-proxy/oauth2-proxy/pull/4917) Upgraded all modules to the latest version (@pierluigilenoci)

591−- [#2570](https://github.com/oauth2-proxy/oauth2-proxy/pull/2570) Set default user agent to oauth2-proxy/$version (from default Golang one)

592−- [#2674](https://github.com/oauth2-proxy/oauth2-proxy/pull/2674) docs: additional notes about available claims for HeaderValue (@vegetablest)

593−- [#2459](https://github.com/oauth2-proxy/oauth2-proxy/pull/2459) chore(deps): Updated to ginkgo v2 (@kvanzuijlen, @tuunit)

594−- [#2112](https://github.com/oauth2-proxy/oauth2-proxy/pull/2112) docs: update list of providers which support refresh tokens (@mikefab-msf)

595−- [#2734](https://github.com/oauth2-proxy/oauth2-proxy/pull/2734) Added s390x architecture option support (@priby05)

596−- [#2589](https://github.com/oauth2-proxy/oauth2-proxy/pull/2589) Added support for regex path matching and rewriting when using a static `file:` upstream (@ianroberts)

597−- [#2790](https://github.com/oauth2-proxy/oauth2-proxy/pull/2790) chore(deps): update all golang dependencies (@tuunit)

598−- [#2607](https://github.com/oauth2-proxy/oauth2-proxy/pull/2607) fix(csrf): fix possible infinite loop (@Primexz)

599−

600−# V7.6.0

601−

602−## Release Highlights

603−

604−## Important Notes

605−

606−## Breaking Changes

607−

608−## Changes since v7.5.1

609−

610−- [#2381](https://github.com/oauth2-proxy/oauth2-proxy/pull/2381) Allow username authentication to Redis cluster (@rossigee)

611−- [#2345](https://github.com/oauth2-proxy/oauth2-proxy/pull/2345) Log error details when failed loading CSRF cookie (@charvadzo)

612−- [#2128](https://github.com/oauth2-proxy/oauth2-proxy/pull/2128) Update dependencies (@vllvll)

613−- [#2269](https://github.com/oauth2-proxy/oauth2-proxy/pull/2269) Added Azure China (and other air gaped cloud) support (@mblaschke)

614−- [#2237](https://github.com/oauth2-proxy/oauth2-proxy/pull/2237) adds an option to append CA certificates (@emsixteeen)

615−- [#2128](https://github.com/oauth2-proxy/oauth2-proxy/pull/2128) Update dependencies (@vllvll)

616−- [#2239](https://github.com/oauth2-proxy/oauth2-proxy/pull/2312) Add possibility to encode the state param as UrlEncodedBase64 (@brezinajn)

617−- [#2274](https://github.com/oauth2-proxy/oauth2-proxy/pull/2274) Upgrade golang.org/x/net to v0.17.0 (@pierluigilenoci)

618−- [#2278](https://github.com/oauth2-proxy/oauth2-proxy/pull/2278) Improve the Nginx auth_request example (@akunzai)

619−- [#2282](https://github.com/oauth2-proxy/oauth2-proxy/pull/2282) Fixed checking Google Groups membership using Google Application Credentials (@kvanzuijlen)

620−- [#2183](https://github.com/oauth2-proxy/oauth2-proxy/pull/2183) Allowing relative redirect url though an option (@axel7083)

621−- [#1866](https://github.com/oauth2-proxy/oauth2-proxy/pull/1866) Add support for unix socker as upstream (@babs)

622−- [#1876](https://github.com/oauth2-proxy/oauth2-proxy/pull/1876) Add `--backend-logout-url` with `{id_token}` placeholder (@babs)

623−- [#1949](https://github.com/oauth2-proxy/oauth2-proxy/pull/1949) Allow cookie names with dots in redis sessions (@miguelborges99)

624−- [#2297](https://github.com/oauth2-proxy/oauth2-proxy/pull/2297) Add nightly build and push (@tuunit)

625−- [#2329](https://github.com/oauth2-proxy/oauth2-proxy/pull/2329) Add an option to skip request to profile URL for resolving missing claims in id_token (@nilsgstrabo)

626−- [#2299](https://github.com/oauth2-proxy/oauth2-proxy/pull/2299) bugfix: OIDCConfig based providers are not respecting flags and configs (@tuunit)

627−- [#2343](https://github.com/oauth2-proxy/oauth2-proxy/pull/2343) chore: Added checksums for .tar.gz (@kvanzuijlen)

628−- [#2248](https://github.com/oauth2-proxy/oauth2-proxy/pull/2248) Added support for semicolons in query strings. (@timwsuqld)

629−- [#2196](https://github.com/oauth2-proxy/oauth2-proxy/pull/2196) Add GitHub groups (orgs/teams) support. Including `X-Forwarded-Groups` header (@tuunit)

630−- [#2371](https://github.com/oauth2-proxy/oauth2-proxy/pull/2371) Remove nsswitch DNS resolution workaround (@tuunit)

631−- [#2295](https://github.com/oauth2-proxy/oauth2-proxy/pull/2295) Change base-image to [GoogleContainerTools/distroless](https://github.com/GoogleContainerTools/distroless) (@kvanzuijlen)

632−- [#2356](https://github.com/oauth2-proxy/oauth2-proxy/pull/2356) Update go-jose dependency (@dasvh)

633−- [#2357](https://github.com/oauth2-proxy/oauth2-proxy/pull/2357) Update ojg to latest release (@bitfehler)

634−- [#1922](https://github.com/oauth2-proxy/oauth2-proxy/pull/1922) Added support for env variables in the alpha struct (@hevans-dglcom)

635−- [#2235](https://github.com/oauth2-proxy/oauth2-proxy/pull/2235) Bump golang to 1.21 and min allowed version to 1.20 (@tuunit)

636−

637−# V7.5.1

638−

639−## Release Highlights

640−- 🐛 Several bugs have been squashed

641−- 🕵️‍♀️ Vulnerabilities have been addressed

642−- 📖Improved docs

643−

644−## Important Notes

645−

646−- This release includes fixes for a number of CVEs, we recommend to upgrade as soon as possible.

647−- The environment variable OAUTH2_PROXY_GOOGLE_GROUP has been deprecated in favor of OAUTH2_PROXY_GOOGLE_GROUPS. Next major release

648−will remove this option. This change makes sure that the configuration options follow the documentation.

649−

650−## Breaking Changes

651−

652−N/A

653−

654−## Changes since v7.5.0

655−- [#2220](https://github.com/oauth2-proxy/oauth2-proxy/pull/2220) Added binary and docker release platforms (@kvanzuijlen)

656−- [#2221](https://github.com/oauth2-proxy/oauth2-proxy/pull/2221) Backwards compatible fix for wrong environment variable name (OAUTH2_PROXY_GOOGLE_GROUPS) (@kvanzuijlen)

657−- [#1989](https://github.com/oauth2-proxy/oauth2-proxy/pull/1989) Fix default scope for keycloak-oidc provider (@tuunit)

658−- [#2217](https://github.com/oauth2-proxy/oauth2-proxy/pull/2217) Upgrade alpine to version 3.18 (@polarctos)

659−- [#2208](https://github.com/oauth2-proxy/oauth2-proxy/pull/2208) Improved session documentation (@lathspell)

660−- [#2229](https://github.com/oauth2-proxy/oauth2-proxy/pull/2229) bugfix: default scopes for OIDCProvider based providers (@tuunit)

661−- [#2194](https://github.com/oauth2-proxy/oauth2-proxy/pull/2194) Fix Gitea token validation (@tuunit)

662−

663−# V7.5.0

664−

665−## Release Highlights

666−- 🐛 Several bugs have been squashed

667−- 🕵️‍♀️ Vulnerabilities have been addressed

668−- ⭐️ Added a readiness endpoint to check if the application is ready to receive traffic

669−- ⭐️ Google Application Default Credentials support (i.e. for running on Google Cloud Platform)

670−- ⭐ Session cookie support

671−

672−## Important Notes

673−

674−- This release includes fixes for a number of CVEs, we recommend to upgrade as soon as possible.

675−- This release was pushed with the wrong Docker platform type for arm64/armv8. Use v7.5.1 instead.

676−- This release introduced a bug with the Keycloak OIDC provider causing no scopes to be send along with the request. Use v7.5.1 instead.

677−

678−## Breaking Changes

679−The following PR introduces a change to how auth routes are evaluated using the flags `skip-auth-route`/`skip-auth-regex`. The new behaviour uses the regex you specify to evaluate the full path including query parameters. For more details please read the detailed description [#2271](https://github.com/oauth2-proxy/oauth2-proxy/issues/2271)

680−- [#2192](https://github.com/oauth2-proxy/oauth2-proxy/pull/2192) Use X-Forwarded-Uri if it exists for pathRegex match (@mzndr / @jawys)

681−

682−## Changes since v7.4.0

683−- [#2028](https://github.com/oauth2-proxy/oauth2-proxy/pull/2028) Update golang.org/x/net to v0.7.0 ato address GHSA-vvpx-j8f3-3w6h (@amrmahdi)

684−- [#1873](https://github.com/oauth2-proxy/oauth2-proxy/pull/1873) Fix empty users with some OIDC providers (@babs)

685−- [#1882](https://github.com/oauth2-proxy/oauth2-proxy/pull/1882) Make `htpasswd.GetUsers` racecondition safe (@babs)

686−- [#1883](https://github.com/oauth2-proxy/oauth2-proxy/pull/1883) Ensure v8 manifest variant is set on docker images (@braunsonm)

687−- [#1906](https://github.com/oauth2-proxy/oauth2-proxy/pull/1906) Fix PKCE code verifier generation to never use UTF-8 characters (@braunsonm)

688−- [#1839](https://github.com/oauth2-proxy/oauth2-proxy/pull/1839) Add readiness checks for deeper health checks (@kobim)

689−- [#1927](https://github.com/oauth2-proxy/oauth2-proxy/pull/1927) Fix default scope settings for none oidc providers (@tuunit)

690−- [#1713](https://github.com/oauth2-proxy/oauth2-proxy/pull/1713) Add session cookie support (@t-katsumura @tanuki884)

691−- [#1951](https://github.com/oauth2-proxy/oauth2-proxy/pull/1951) Fix validate URL, check if query string marker (?) or separator (&) needs to be appended (@miguelborges99)

692−- [#1920](https://github.com/oauth2-proxy/oauth2-proxy/pull/1920) Make sure emailClaim is not overriden if userIDClaim is not set (@mdreem)

693−- [#2010](https://github.com/oauth2-proxy/oauth2-proxy/pull/2010) Log the difference between invalid email and not authorized session (@omBratteng)

694−- [#1988](https://github.com/oauth2-proxy/oauth2-proxy/pull/1988) Ensure sign-in page background is uniform throughout the page (@corybolar)

695−- [#2013](https://github.com/oauth2-proxy/oauth2-proxy/pull/2013) Upgrade alpine to version 3.17.2 and library dependencies (@miguelborges99)

696−- [#2047](https://github.com/oauth2-proxy/oauth2-proxy/pull/2047) CVE-2022-41717: DoS in Go net/http may lead to DoS (@miguelborges99)

697−- [#2126](https://github.com/oauth2-proxy/oauth2-proxy/pull/2126) Added support for GKE Workload Identity (@kvanzuijlen)

698−- [#1921](https://github.com/oauth2-proxy/oauth2-proxy/pull/1921) Check jsonpath syntax before interpretation (@eloo-abi)

699−- [#2025](https://github.com/oauth2-proxy/oauth2-proxy/pull/2025) Embed static stylesheets and dependencies (@corybolar)

700−

701−# V7.4.0

702−

703−## Release Highlights

704−

705−- New Azure groups support for Azure OAuth2 v2.0

706−- Option to configure API routes - paths that will not redirect to login when unauthenticated

707−- CSRF and session cookies now have different timeouts

708−

709−## Important Notes

710−

711−- [#1708](https://github.com/oauth2-proxy/oauth2-proxy/pull/1708) Enable different CSRF cookies per request (@miguelborges99)

712− - Since the CSRF cookie name is now longer it could potentially break long cookie names (around 1000 characters).

713− - Having a unique CSRF cookie per request can lead to quite a number of cookies, in case an application performs a high number of parallel authentication requests. Each call will redirect to /oauth2/start, if the user is not authenticated, and a new cookie will be set. The successfully authenticated requests will have its CSRF cookies immediatly expired, however the failed ones will mantain its CSRF cookies until they expire (by default in 15 minutes).

714− - The user may redefine the CSRF cookie expiration time using flag "--cookie-csrf-expire" (e.g. --cookie-csrf-expire=5m). By default, it is 15 minutes, but you can fine tune to your environment.

715−- [#1574](https://github.com/oauth2-proxy/oauth2-proxy/pull/1574) Add Azure groups support and Azure OAuth v2.0 (@adriananeci)

716− - group membership check is now validated while using the the azure provider.

717− - Azure OAuth v2.0 (https://login.microsoftonline.com/{tenant_id}/v2.0) is now available along with Azure OAuth v1.0. See https://github.com/oauth2-proxy/oauth2-proxy/blob/master/docs/docs/configuration/auth.md#azure-auth-provider for more details

718− - 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.

719−- This release includes fixes for a number of CVEs, we recommend to upgrade as soon as possible.

720−

721−## Breaking Changes

722−

723−N/A

724−

725−## Changes since v7.3.0

726−

727−- [#1862](https://github.com/oauth2-proxy/oauth2-proxy/pull/1862) Update dependencies (@JoelSpeed)

728−- [#1828](https://github.com/oauth2-proxy/oauth2-proxy/pull/1828) call providerData.setProviderDefaults for oidc provider to achieve consistent behaviour (@centzilius)

729− - UserClaim will be set to sub instead of beeing empty from now on.

730−- [#1691](https://github.com/oauth2-proxy/oauth2-proxy/pull/1691) Fix Redis IdleTimeout when Redis timeout option is set to non-zero (@dimss)

731−- [#1669](https://github.com/oauth2-proxy/oauth2-proxy/pull/1699) Fix method deprecated error in lint (@t-katsumura)

732−- [#1701](https://github.com/oauth2-proxy/oauth2-proxy/pull/1701) Watch the htpasswd file for changes and update the htpasswdMap (@aiciobanu)

733−- [#1709](https://github.com/oauth2-proxy/oauth2-proxy/pull/1709) Show an alert message when basic auth credentials are invalid (@aiciobanu)

734−- [#1723](https://github.com/oauth2-proxy/oauth2-proxy/pull/1723) Added ability to specify allowed TLS cipher suites. (@crbednarz)

735−- [#1720](https://github.com/oauth2-proxy/oauth2-proxy/pull/1720) Extract roles from authToken, to allow using allowed roles with Keycloak. (@MrDeerly )

736−- [#1774](https://github.com/oauth2-proxy/oauth2-proxy/pull/1774) Fix vulnerabilities CVE-2022-27191, CVE-2021-44716 and CVE-2022-29526. (@felipeconti)

737−- [#1667](https://github.com/oauth2-proxy/oauth2-proxy/issues/1667) Rename configuration file flag for PKCE (@ChrisEke)

738−to remain consistent with CLI flags. You should specify `code_challenge_method` in your configuration instead of

739−`force_code_challenge_method`.

740−- [#1708](https://github.com/oauth2-proxy/oauth2-proxy/pull/1708) Enable different CSRF cookies per request (@miguelborges99)

741− - Add flag "--cookie-csrf-per-request" which activates an algorithm to name CSRF cookies differently per request.

742− This feature allows parallel callbacks and by default it is disabled.

743− - Add flag "--cookie-csrf-expire" to define a different expiration time for the CSRF cookie. By default, it is 15 minutes.

744−- [#1762](https://github.com/oauth2-proxy/oauth2-proxy/pull/1762) Support negating for skip auth routes (@ianldge)

745−- [#1788](https://github.com/oauth2-proxy/oauth2-proxy/pull/1788) Update base docker image to alpine 3.16 (@tooptoop4)

746−- [#1760](https://github.com/oauth2-proxy/oauth2-proxy/pull/1760) Option to configure API routes (@segfault16)

747−- [#1825](https://github.com/oauth2-proxy/oauth2-proxy/pull/1825) Fix vulnerabilities CVE-2022-32149 and CVE-2022-27664. (@crbednarz)

748−- [#1750](https://github.com/oauth2-proxy/oauth2-proxy/pull/1750) Fix Nextcloud provider (@n1tehawk)

749−- [#1574](https://github.com/oauth2-proxy/oauth2-proxy/pull/1574) Add Azure groups support and Azure OAuth v2.0 (@adriananeci)

750−- [#1851](https://github.com/oauth2-proxy/oauth2-proxy/pull/1851) Bump golang to 1.19 and min allowed version to 1.18 (@adriananeci)

751−- [#1815](https://github.com/oauth2-proxy/oauth2-proxy/pull/1815) Keycloak: save user and preferredUsername in session to populate headers for the backend (@babs)

752−- [#1847](https://github.com/oauth2-proxy/oauth2-proxy/pull/1847) Update go-redis/redis to v9 (@arhamGH)

753−-

754−# V7.3.0

755−

756−## Release Highlights

757−

758−- [#1361](https://github.com/oauth2-proxy/oauth2-proxy/pull/1541) PKCE Code Challenge Support - RFC-7636 (@braunsonm)

759− - At this time the `--code-challenge-method` flag can be used to enable it with the method of your choice.

760−- Parital support for OAuth2 Authorization Server Metadata for detecting code challenge methods (@braunsonm)

761− - A warning will be displayed when your provider advertises support for PKCE but you have not enabled it.

762−- Support for the ARMv8 and ppc64le architectures

763−- Configurable upstream request timeouts

764−

765−## Important Notes

766−

767−- [oauth2-proxy](https://quay.io/repository/oauth2-proxy/oauth2-proxy?tab=tags&tag=latest) separate image tags for each architecture is deprecated. Instead, images are cross compiled and pushed as the same tag for every platform.

768−If you are using an architecture specific tag (ex: v7.2.1-arm64) you should move to the generic tag instead (ex: v7.2.1 )

769−- [#1478](https://github.com/oauth2-proxy/oauth2-proxy/pull/1478) Changes the UID and GID of the runtime user to `65532`.

770− Which also is known as `nonroot` user in [distroless images](https://github.com/GoogleContainerTools/distroless).

771−- This release includes fixes for a number of CVEs, we recomend to upgrade as soon as possible.

772−

773−## Breaking Changes

774−

775−- [#1666](https://github.com/oauth2-proxy/oauth2-proxy/issues/1666) Azure provider breaks after upgrading to this version. Please see the issue for more details.

776−

777−## Changes since v7.2.1

778−

779−- [#1662](https://github.com/oauth2-proxy/oauth2-proxy/pull/1662) Discover signature algorithms from OIDC provider (@JoelSpeed)

780−- [#1651](https://github.com/oauth2-proxy/oauth2-proxy/pull/1651) Updated go-lang's text, crypto and prometheus dependencies to fix reported security vulnerabilities. (@rkkris75)

781−- [#1595](https://github.com/oauth2-proxy/oauth2-proxy/pull/1595) Add optional `allowed_emails` query parameter to the `auth_request`. (@zv0n)

782−- [#1478](https://github.com/oauth2-proxy/oauth2-proxy/pull/1478) Parameterise the runtime image (@omBratteng)

783−- [#1583](https://github.com/oauth2-proxy/oauth2-proxy/pull/1583) Add groups to session too when creating session from bearer token (@adriananeci)

784−- [#1418](https://github.com/oauth2-proxy/oauth2-proxy/pull/1418) Support for passing arbitrary query parameters through from `/oauth2/start` to the identity provider's login URL. Configuration settings control which parameters are passed by default and precisely which values can be overridden per-request (@ianroberts)

785−- [#1559](https://github.com/oauth2-proxy/oauth2-proxy/pull/1559) Introduce ProviderVerifier to clean up OIDC discovery code (@JoelSpeed)

786−- [#1561](https://github.com/oauth2-proxy/oauth2-proxy/pull/1561) Add ppc64le support (@mgiessing)

787−- [#1563](https://github.com/oauth2-proxy/oauth2-proxy/pull/1563) Ensure claim extractor does not attempt profile call when URL is empty (@JoelSpeed)

788−- [#1560](https://github.com/oauth2-proxy/oauth2-proxy/pull/1560) Fix provider data initialisation (@JoelSpeed)

789−- [#1555](https://github.com/oauth2-proxy/oauth2-proxy/pull/1555) Refactor provider configuration into providers package (@JoelSpeed)

790−- [#1394](https://github.com/oauth2-proxy/oauth2-proxy/pull/1394) Add generic claim extractor to get claims from ID Tokens (@JoelSpeed)

791−- [#1468](https://github.com/oauth2-proxy/oauth2-proxy/pull/1468) Implement session locking with session state lock (@JoelSpeed, @Bibob7)

792−- [#1489](https://github.com/oauth2-proxy/oauth2-proxy/pull/1489) Fix Docker Buildx push to include build version (@JoelSpeed)

793−- [#1477](https://github.com/oauth2-proxy/oauth2-proxy/pull/1477) Remove provider documentation for `Microsoft Azure AD` (@omBratteng)

794−- [#1204](https://github.com/oauth2-proxy/oauth2-proxy/pull/1204) Added configuration for audience claim (`--oidc-extra-audience`) and ability to specify extra audiences (`--oidc-extra-audience`) allowed passing audience verification. This enables support for AWS Cognito and other issuers that have custom audience claims. Also, this adds the ability to allow multiple audiences. (@kschu91)

795−- [#1509](https://github.com/oauth2-proxy/oauth2-proxy/pull/1509) Update LoginGovProvider ValidateSession to pass access_token in Header (@pksheldon4)

796−- [#1474](https://github.com/oauth2-proxy/oauth2-proxy/pull/1474) Support configuration of minimal acceptable TLS version (@polarctos)

797−- [#1545](https://github.com/oauth2-proxy/oauth2-proxy/pull/1545) Fix issue with query string allowed group panic on skip methods (@andytson)

798−- [#1286](https://github.com/oauth2-proxy/oauth2-proxy/pull/1286) Add the `allowed_email_domains` and the `allowed_groups` on the `auth_request` + support standard wildcard char for validation with sub-domain and email-domain. (@w3st3ry @armandpicard)

799−- [#1361](https://github.com/oauth2-proxy/oauth2-proxy/pull/1541) PKCE Code Challenge Support - RFC-7636 (@braunsonm)

800−- [#1594](https://github.com/oauth2-proxy/oauth2-proxy/pull/1594) Release ARMv8 docker images (@braunsonm)

801−- [#1649](https://github.com/oauth2-proxy/oauth2-proxy/pull/1649) Return a 400 instead of a 500 when a request contains an invalid redirect target (@niksko)

802−- [#1638](https://github.com/oauth2-proxy/oauth2-proxy/pull/1638) Implement configurable upstream timeout (@jacksgt)

803−- [#1650](https://github.com/oauth2-proxy/oauth2-proxy/pull/1650) Fixed 500 when checking if user has repo (@adamsong)

804−- [#1635](https://github.com/oauth2-proxy/oauth2-proxy/pull/1635) Added description and unit tests for ipv6 address (@t-katsumura)

805−- [#1502](https://github.com/oauth2-proxy/oauth2-proxy/pull/1502) Unbreak oauth2-proxy for keycloak provider after 2c668a (@ckwalsh)

806−

807−# V7.2.1

808−

809−## Release Highlights

810−

811−This release contains a number of bug and security fixes, but has no feature additions.

812−

813−## Important Notes

814−

815−N/A

816−

817−## Breaking Changes

818−

819−N/A

820−

821−## Changes since v7.2.0

822−

823−- [#1247](https://github.com/oauth2-proxy/oauth2-proxy/pull/1247) Use `upn` claim consistently in ADFSProvider (@NickMeves)

824−- [#1447](https://github.com/oauth2-proxy/oauth2-proxy/pull/1447) Fix docker build/push issues found during last release (@JoelSpeed)

825−- [#1433](https://github.com/oauth2-proxy/oauth2-proxy/pull/1433) Let authentication fail when session validation fails (@stippi2)

826−- [#1445](https://github.com/oauth2-proxy/oauth2-proxy/pull/1445) Fix docker container multi arch build issue by passing GOARCH details to make build (@jkandasa)

827−- [#1444](https://github.com/oauth2-proxy/oauth2-proxy/pull/1444) Update LinkedIn provider validate URL (@jkandasa)

828−- [#1471](https://github.com/oauth2-proxy/oauth2-proxy/pull/1471) Update alpine to 3.15 (@AlexanderBabel)

829−- [#1479](https://github.com/oauth2-proxy/oauth2-proxy/pull/1479) Update to Go 1.17 (@polarctos)

830−

831−# V7.2.0

832−

833−## Release Highlights

834−

835−- LinkedIn provider updated to support the new v2 API

836−- Introduce `--force-json-errors` to allow OAuth2 Proxy to protect JSON APIs and disable authentication redirection

837−- Add URL rewrite capabilities to the upstream proxy

838−- New ADFS provider integration

839−- New Keycloak OIDC provider integration

840−- Introduced Multiarch Docker images on the standard image tags

841−

842−## Important Notes

843−

844- [#1086](https://github.com/oauth2-proxy/oauth2-proxy/pull/1086) The extra validation to protect invalid session

7- [#1086](https://github.com/oauth2-proxy/oauth2-proxy/pull/1086) The extra validation to protect invalid session

845 deserialization from v6.0.0 (only) has been removed to improve performance. If you are on v6.0.0, either upgrade

8 deserialization from v6.0.0 (only) has been removed to improve performance. If you are on v6.0.0, either upgrade

846 to a version before this first and allow legacy sessions to expire gracefully or change your `cookie-secret`

9 to a version before this first and allow legacy sessions to expire gracefully or change your `cookie-secret`

847 value and force all sessions to reauthenticate.

10 value and force all sessions to reauthenticate.

11+

848- [#1210](https://github.com/oauth2-proxy/oauth2-proxy/pull/1210) A new `keycloak-oidc` provider has been added with support for role based authentication. The existing keycloak auth provider will eventually be deprecated and removed. Please switch to the new provider `keycloak-oidc`.

12- [#1210](https://github.com/oauth2-proxy/oauth2-proxy/pull/1210) A new `keycloak-oidc` provider has been added with support for role based authentication. The existing keycloak auth provider will eventually be deprecated and removed. Please switch to the new provider `keycloak-oidc`.

849

13

850## Breaking Changes

14## Breaking Changes

@@ -854,12 +18,6 @@ N/A

854

18

855## Changes since v7.1.3

19## Changes since v7.1.3

856

20

857−- [#1391](https://github.com/oauth2-proxy/oauth2-proxy/pull/1391) Improve build times by sharing cache and allowing platform selection (@JoelSpeed)

858−- [#1404](https://github.com/oauth2-proxy/oauth2-proxy/pull/1404) Improve error message when no cookie is found (@JoelSpeed)

859−- [#1315](https://github.com/oauth2-proxy/oauth2-proxy/pull/1315) linkedin: Update provider to v2 (@wuurrd)

860−- [#1348](https://github.com/oauth2-proxy/oauth2-proxy/pull/1348) Using the native httputil proxy code for websockets rather than yhat/wsutil to properly handle HTTP-level failures (@thetrime)

861−- [#1379](https://github.com/oauth2-proxy/oauth2-proxy/pull/1379) Fix the manual sign in with --htpasswd-user-group switch (@janrotter)

862−- [#1375](https://github.com/oauth2-proxy/oauth2-proxy/pull/1375) Added `--force-json-errors` flag (@bancek)

863- [#1337](https://github.com/oauth2-proxy/oauth2-proxy/pull/1337) Changing user field type to text when using htpasswd (@pburgisser)

21- [#1337](https://github.com/oauth2-proxy/oauth2-proxy/pull/1337) Changing user field type to text when using htpasswd (@pburgisser)

864- [#1239](https://github.com/oauth2-proxy/oauth2-proxy/pull/1239) Base GitLab provider implementation on OIDCProvider (@NickMeves)

22- [#1239](https://github.com/oauth2-proxy/oauth2-proxy/pull/1239) Base GitLab provider implementation on OIDCProvider (@NickMeves)

865- [#1276](https://github.com/oauth2-proxy/oauth2-proxy/pull/1276) Update crypto and switched to new github.com/golang-jwt/jwt (@JVecsei)

23- [#1276](https://github.com/oauth2-proxy/oauth2-proxy/pull/1276) Update crypto and switched to new github.com/golang-jwt/jwt (@JVecsei)

@@ -883,8 +41,6 @@ N/A

883- [#1357](https://github.com/oauth2-proxy/oauth2-proxy/pull/1357) Fix unsafe access to session variable (@harzallah)

41- [#1357](https://github.com/oauth2-proxy/oauth2-proxy/pull/1357) Fix unsafe access to session variable (@harzallah)

884- [#997](https://github.com/oauth2-proxy/oauth2-proxy/pull/997) Allow passing the raw url path when proxying upstream requests - e.g. /%2F/ (@FStelzer)

42- [#997](https://github.com/oauth2-proxy/oauth2-proxy/pull/997) Allow passing the raw url path when proxying upstream requests - e.g. /%2F/ (@FStelzer)

885- [#1147](https://github.com/oauth2-proxy/oauth2-proxy/pull/1147) Multiarch support for docker image (@goshlanguage)

43- [#1147](https://github.com/oauth2-proxy/oauth2-proxy/pull/1147) Multiarch support for docker image (@goshlanguage)

886−- [#1296](https://github.com/oauth2-proxy/oauth2-proxy/pull/1296) Fixed `panic` when connecting to Redis with TLS (@mstrzele)

887−- [#1403](https://github.com/oauth2-proxy/oauth2-proxy/pull/1403) Improve TLS handling for Redis to support non-standalone mode with TLS (@wadahiro)

888

44

889# V7.1.3

45# V7.1.3

890

46

CODE_OF_CONDUCT.mddeleted−112

@@ -1,112 +0,0 @@

1−## CNCF Community Code of Conduct v1.3

2−

3−Other languages available:

4−- [Arabic/العربية](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/ar.md)

5−- [Bengali/বাংলা](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/bn.md)

6−- [Bulgarian/Български](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/bg.md)

7−- [Chinese/中文](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/zh.md)

8−- [Czech/Česky](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/cs.md)

9−- [Farsi/فارسی](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/fa.md)

10−- [French/Français](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/fr.md)

11−- [German/Deutsch](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/de.md)

12−- [Hebrew/עברית](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/he.md)

13−- [Hindi/हिन्दी](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/hi.md)

14−- [Hungarian/Magyar](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/hu.md)

15−- [Indonesian/Bahasa Indonesia](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/id.md)

16−- [Italian/Italiano](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/it.md)

17−- [Japanese/日本語](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/ja.md)

18−- [Korean/한국어](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/ko.md)

19−- [Polish/Polski](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/pl.md)

20−- [Portuguese/Português](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/pt.md)

21−- [Russian/Русский](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/ru.md)

22−- [Spanish/Español](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/es.md)

23−- [Turkish/Türkçe](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/tr.md)

24−- [Ukrainian/Українська](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/uk.md)

25−- [Vietnamese/Tiếng Việt](https://github.com/cncf/foundation/blob/main/code-of-conduct-languages/vi.md)

26−

27−### Community Code of Conduct

28−

29−As contributors, maintainers, and participants in the CNCF community, and in the interest of fostering

30−an open and welcoming community, we pledge to respect all people who participate or contribute

31−through reporting issues, posting feature requests, updating documentation,

32−submitting pull requests or patches, attending conferences or events, or engaging in other community or project activities.

33−

34−We are committed to making participation in the CNCF community a harassment-free experience for everyone, regardless of age, body size, caste, disability, ethnicity, level of experience, family status, gender, gender identity and expression, marital status, military or veteran status, nationality, personal appearance, race, religion, sexual orientation, socioeconomic status, tribe, or any other dimension of diversity.

35−

36−## Scope

37−

38−This code of conduct applies:

39−* within project and community spaces,

40−* in other spaces when an individual CNCF community participant's words or actions are directed at or are about a CNCF project, the CNCF community, or another CNCF community participant in the context of a CNCF activity.

41−

42−### CNCF Events

43−

44−CNCF events that are produced by the Linux Foundation with professional events staff are governed by the Linux Foundation [Events Code of Conduct](https://events.linuxfoundation.org/code-of-conduct/) available on the event page. This is designed to be used in conjunction with the CNCF Code of Conduct.

45−

46−## Our Standards

47−

48−The CNCF Community is open, inclusive and respectful. Every member of our community has the right to have their identity respected.

49−

50−Examples of behavior that contributes to a positive environment include but are not limited to:

51−

52−* Demonstrating empathy and kindness toward other people

53−* Being respectful of differing opinions, viewpoints, and experiences

54−* Giving and gracefully accepting constructive feedback

55−* Accepting responsibility and apologizing to those affected by our mistakes,

56− and learning from the experience

57−* Focusing on what is best not just for us as individuals, but for the

58− overall community

59−* Using welcoming and inclusive language

60−

61−

62−Examples of unacceptable behavior include but are not limited to:

63−

64−* The use of sexualized language or imagery

65−* Trolling, insulting or derogatory comments, and personal or political attacks

66−* Public or private harassment in any form

67−* Publishing others' private information, such as a physical or email

68− address, without their explicit permission

69−* Violence, threatening violence, or encouraging others to engage in violent behavior

70−* Stalking or following someone without their consent

71−* Unwelcome physical contact

72−* Unwelcome sexual or romantic attention or advances

73−* Using CNCF projects or community spaces for political campaigning or promotion of political causes

74− that are unrelated to the advancement of cloud native technology. To clarify, this policy does not restrict individuals' personal attire, including attire that expresses personal beliefs or aspects of identity.

75−* Other conduct which could reasonably be considered inappropriate in a

76− professional setting

77−

78−The following behaviors are also prohibited:

79−* Providing knowingly false or misleading information in connection with a Code of Conduct investigation or otherwise intentionally tampering with an investigation.

80−* Retaliating against a person because they reported an incident or provided information about an incident as a witness.

81−

82−Project maintainers 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.

83−By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect

84−of managing a CNCF project.

85−Project maintainers who do not follow or enforce the Code of Conduct may be temporarily or permanently removed from the project team.

86−

87−## Reporting

88−

89−For incidents occurring in the Kubernetes community, contact the [Kubernetes Code of Conduct Committee](https://git.k8s.io/community/committee-code-of-conduct) via <conduct@kubernetes.io>. You can expect a response within three business days.

90−

91−For other projects, or for incidents that are project-agnostic or impact multiple CNCF projects, please contact the [CNCF Code of Conduct Committee](https://www.cncf.io/conduct/committee/) via <conduct@cncf.io>. Alternatively, you can contact any of the individual members of the [CNCF Code of Conduct Committee](https://www.cncf.io/conduct/committee/) to submit your report. For more detailed instructions on how to submit a report, including how to submit a report anonymously, please see our [Incident Resolution Procedures](https://github.com/cncf/foundation/blob/main/code-of-conduct/coc-incident-resolution-procedures.md). You can expect a response within three business days.

92−

93−For incidents occurring at CNCF event that is produced by the Linux Foundation, please contact <eventconduct@cncf.io>.

94−

95−## Frequently asked questions

96−For more information about this Code of Conduct, please see the [CNCF Code of Conduct Frequently Asked Questions](https://www.cncf.io/conduct/faq/).

97−

98−## Enforcement

99−

100−Upon review and investigation of a reported incident, the CoC response team that has jurisdiction will determine what action is appropriate based on this Code of Conduct and its related documentation.

101−

102−For information about which Code of Conduct incidents are handled by project leadership, which incidents are handled by the CNCF Code of Conduct Committee, and which incidents are handled by the Linux Foundation (including its events team), see our [Jurisdiction Policy](https://github.com/cncf/foundation/blob/main/code-of-conduct/coc-committee-jurisdiction-policy.md).

103−

104−## Amendments

105−

106−Consistent with the CNCF Charter, any substantive changes to this Code of Conduct must be approved by the Technical Oversight Committee.

107−

108−## Acknowledgements

109−

110−This Code of Conduct is adapted from the Contributor Covenant

111−(http://contributor-covenant.org), version 2.0 available at

112−http://contributor-covenant.org/version/2/0/code_of_conduct/

DCO.mddeleted−34

@@ -1,34 +0,0 @@

1−Developer Certificate of Origin

2−Version 1.1

3−

4−Copyright (C) 2004, 2006 The Linux Foundation and its contributors.

5−

6−Everyone is permitted to copy and distribute verbatim copies of this

7−license document, but changing it is not allowed.

8−

9−

10−Developer's Certificate of Origin 1.1

11−

12−By making a contribution to this project, I certify that:

13−

14−(a) The contribution was created in whole or in part by me and I

15− have the right to submit it under the open source license

16− indicated in the file; or

17−

18−(b) The contribution is based upon previous work that, to the best

19− of my knowledge, is covered under an appropriate open source

20− license and I have the right under that license to submit that

21− work with modifications, whether created in whole or in part

22− by me, under the same open source license (unless I am

23− permitted to submit under a different license), as indicated

24− in the file; or

25−

26−(c) The contribution was provided directly to me by some other

27− person who certified (a), (b) or (c) and I have not modified

28− it.

29−

30−(d) I understand and agree that this project and the contribution

31− are public and that a record of the contribution (including all

32− personal information I submit with it, including my sign-off) is

33− maintained indefinitely and may be redistributed consistent with

34− this project or the open source license(s) involved.

Dockerfile+8−50

@@ -1,35 +1,15 @@

1−# The image ARGs have to be at the top, otherwise the docker daemon cannot validate

1+FROM golang:1.16-buster AS builder

2−# the FROM statements and overall Dockerfile

3−#

4−# Argument for setting the build image

5−ARG BUILD_IMAGE=placeholder

6−# Argument for setting the runtime image

7−ARG RUNTIME_IMAGE=placeholder

8−# Argument for setting the oauth2-proxy build version

9−ARG VERSION

10−

11−# All builds should be done using the platform native to the build node to allow

12−# cache sharing of the go mod download step.

13−# Go cross compilation is also faster than emulation the go compilation across

14−# multiple platforms.

15−FROM --platform=${BUILDPLATFORM} ${BUILD_IMAGE} AS builder

16

2

17# Copy sources

3# Copy sources

18WORKDIR $GOPATH/src/github.com/oauth2-proxy/oauth2-proxy

4WORKDIR $GOPATH/src/github.com/oauth2-proxy/oauth2-proxy

19

5

20# Fetch dependencies

6# Fetch dependencies

21COPY go.mod go.sum ./

7COPY go.mod go.sum ./

22−RUN go mod download

8+RUN GO111MODULE=on go mod download

23

9

24# Now pull in our code

10# Now pull in our code

25COPY . .

11COPY . .

26

12

27−# Arguments go here so that the previous steps can be cached if no external sources

28−# have changed. These arguments are automatically set by the docker engine.

29−ARG TARGETPLATFORM

30−ARG BUILDPLATFORM

31−

32−# Reload version argument

33ARG VERSION

13ARG VERSION

34

14

35# Build binary and make sure there is at least an empty key file.

15# Build binary and make sure there is at least an empty key file.

@@ -38,37 +18,15 @@ ARG VERSION

38# build the key into the container and then tell it where it is

18# build the key into the container and then tell it where it is

39# by setting OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem

19# by setting OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem

40# in app.yaml instead.

20# in app.yaml instead.

41−# Set the cross compilation arguments based on the TARGETPLATFORM which is

42−# automatically set by the docker engine.

43−RUN case ${TARGETPLATFORM} in \

44− "linux/amd64") GOARCH=amd64 ;; \

45− # arm64 and arm64v8 are equivalent in go and do not require a goarm

46− # https://github.com/golang/go/wiki/GoArm

47− "linux/arm64" | "linux/arm/v8") GOARCH=arm64 ;; \

48− "linux/ppc64le") GOARCH=ppc64le ;; \

49− "linux/s390x") GOARCH=s390x ;; \

50− "linux/arm/v6") GOARCH=arm GOARM=6 ;; \

51− "linux/arm/v7") GOARCH=arm GOARM=7 ;; \

52− esac && \

53− printf "Building OAuth2 Proxy for arch ${GOARCH}\n" && \

54− GOARCH=${GOARCH} VERSION=${VERSION} make build && touch jwt_signing_key.pem

21+RUN VERSION=${VERSION} make build && touch jwt_signing_key.pem

55−

56−# Reload runtime image

57−ARG RUNTIME_IMAGE

58−# Copy binary to runtime image

59−FROM ${RUNTIME_IMAGE}

60−# Reload version

61−ARG VERSION

62

22

23+# Copy binary to alpine

24+FROM alpine:3.14

25+COPY nsswitch.conf /etc/nsswitch.conf

26+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt

63COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/oauth2-proxy /bin/oauth2-proxy

27COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/oauth2-proxy /bin/oauth2-proxy

64COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/jwt_signing_key.pem /etc/ssl/private/jwt_signing_key.pem

28COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/jwt_signing_key.pem /etc/ssl/private/jwt_signing_key.pem

65

29

66−LABEL org.opencontainers.image.licenses=MIT \

30+USER 2000:2000

67− org.opencontainers.image.description="A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers." \

68− org.opencontainers.image.documentation=https://oauth2-proxy.github.io/oauth2-proxy/ \

69− org.opencontainers.image.source=https://github.com/oauth2-proxy/oauth2-proxy \

70− org.opencontainers.image.url=https://quay.io/oauth2-proxy/oauth2-proxy \

71− org.opencontainers.image.title=oauth2-proxy \

72− org.opencontainers.image.version=${VERSION}

73

31

74ENTRYPOINT ["/bin/oauth2-proxy"]

32ENTRYPOINT ["/bin/oauth2-proxy"]

Dockerfile.arm64new file+32

@@ -0,0 +1,32 @@

1+FROM golang:1.16-buster AS builder

2+

3+# Copy sources

4+WORKDIR $GOPATH/src/github.com/oauth2-proxy/oauth2-proxy

5+

6+# Fetch dependencies

7+COPY go.mod go.sum ./

8+RUN GO111MODULE=on go mod download

9+

10+# Now pull in our code

11+COPY . .

12+

13+ARG VERSION

14+

15+# Build binary and make sure there is at least an empty key file.

16+# This is useful for GCP App Engine custom runtime builds, because

17+# you cannot use multiline variables in their app.yaml, so you have to

18+# build the key into the container and then tell it where it is

19+# by setting OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem

20+# in app.yaml instead.

21+RUN VERSION=${VERSION} GOARCH=arm64 make build && touch jwt_signing_key.pem

22+

23+# Copy binary to alpine

24+FROM arm64v8/alpine:3.14

25+COPY nsswitch.conf /etc/nsswitch.conf

26+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt

27+COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/oauth2-proxy /bin/oauth2-proxy

28+COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/jwt_signing_key.pem /etc/ssl/private/jwt_signing_key.pem

29+

30+USER 2000:2000

31+

32+ENTRYPOINT ["/bin/oauth2-proxy"]

Dockerfile.armv6new file+32

@@ -0,0 +1,32 @@

1+FROM golang:1.16-buster AS builder

2+

3+# Copy sources

4+WORKDIR $GOPATH/src/github.com/oauth2-proxy/oauth2-proxy

5+

6+# Fetch dependencies

7+COPY go.mod go.sum ./

8+RUN GO111MODULE=on go mod download

9+

10+# Now pull in our code

11+COPY . .

12+

13+ARG VERSION

14+

15+# Build binary and make sure there is at least an empty key file.

16+# This is useful for GCP App Engine custom runtime builds, because

17+# you cannot use multiline variables in their app.yaml, so you have to

18+# build the key into the container and then tell it where it is

19+# by setting OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem

20+# in app.yaml instead.

21+RUN VERSION=${VERSION} GOARCH=arm GOARM=6 make build && touch jwt_signing_key.pem

22+

23+# Copy binary to alpine

24+FROM arm32v6/alpine:3.14

25+COPY nsswitch.conf /etc/nsswitch.conf

26+COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ca-certificates.crt

27+COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/oauth2-proxy /bin/oauth2-proxy

28+COPY --from=builder /go/src/github.com/oauth2-proxy/oauth2-proxy/jwt_signing_key.pem /etc/ssl/private/jwt_signing_key.pem

29+

30+USER 2000:2000

31+

32+ENTRYPOINT ["/bin/oauth2-proxy"]

MAINTAINERS+3−2

@@ -1,2 +1,3 @@

1−

1+Joel Speed <joel.speed@hotmail.co.uk> (@JoelSpeed)

2−Moved to https://github.com/oauth2-proxy/oauth2-proxy/blob/master/MAINTAINERS.md

2+Henry Jenkins <henry@henryjenkins.name> (@steakunderscore)

3+Nick Meves <nick.meves@greenhouse.io> (@NickMeves)

MAINTAINERS.mddeleted−33

@@ -1,33 +0,0 @@

1−# Maintainers

2−

3−The table below lists all current maintainers for the oauth2-proxy as defined

4−by our [project governance](GOVERNANCE.md).

5−

6−| Name | GitHub Handle | Domains of reponsibility | Email Alias | Affiliation |

7−| ---------------- | ------------------------------------------------------ | ------------------------ | -------------------------- | ----------- |

8−| Joel Speed | [@JoelSpeed](https://github.com/joelspeed) | Governance, Core | joel@oauth2-proxy.dev | Red Hat |

9−| Jan Larwig | [@tuunit](https://github.com/tuunit) | Governance, Core | jan@oauth2-proxy.dev | STACKIT |

10−| JJ Łakis | [@jjlakis](https://github.com/jjlakis) | Provider | jj@oauth2-proxy.dev | - |

11−| Koen van Zuijlen | [@kvanzuijlen](https://github.com/kvanzuijlen) | CI | koen@oauth2-proxy.dev | - |

12−| Pierluigi Lenoci | [@pierluigilenoci](https://github.com/pierluigilenoci) | Helm | pierluigi@oauth2-proxy.dev | SAP |

13−

14−## Emeritus Maintainers

15−

16−We would like to highlight that this project does have prior maintainers and

17−core contributors that, if they so wished, could (and should) be granted the

18−status of emeritus maintainers.

19−

20−| Name | GitHub Handle |

21−| ------------- | ------------------------------------------------------ |

22−| Nick Meves | [@NickMeves](https://github.com/NickMeves) |

23−| Braunson | [@braunsonm](https://github.com/braunsonm) |

24−| Henry Jenkins | [@steakunderscore](https://github.com/steakunderscore) |

25−

26−

27−## Security Response Team and GitHub Organization Owners

28−

29−The following maintainers are members of the security response team and owners

30−of the GitHub organization.

31−

32−- Joel Speed

33−- Jan Larwig

Makefile+72−142

@@ -1,179 +1,109 @@

1−#!/usr/bin/env bash

2−

3−#

4−# Makefile with some common workflow for dev, build and test

5−#

6−

7−##@ General

8−

9−# The help target prints out all targets with their descriptions organized

10−# beneath their categories. The categories are represented by '##@' and the

11−# target descriptions by '##'. The awk command is responsible for reading the

12−# entire set of makefiles included in this invocation, looking for lines of the

13−# file as xyz: ## something, and then pretty-format the target and help. Then,

14−# if there's a line with ##@ something, that gets pretty-printed as a category.

15−# More info on the usage of ANSI control characters for terminal formatting:

16−# https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters

17−# More info on the awk command:

18−# http://linuxcommand.org/lc3_adv_awk.php

19−

20−# The following help command is Licensed under the Apache License, Version 2.0 (the "License")

21−# Copyright 2023 The Kubernetes Authors.

22−.PHONY: help

23−help: ## Display this help

24− @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)

25−

26−

27GO ?= go

1GO ?= go

28−# renovate: datasource=github-tags depName=golangci/golangci-lint

2+GOLANGCILINT ?= golangci-lint

29−GOLANGCILINT_VERSION ?= v2.11.4

30

3

31BINARY := oauth2-proxy

4BINARY := oauth2-proxy

32VERSION ?= $(shell git describe --always --dirty --tags 2>/dev/null || echo "undefined")

5VERSION ?= $(shell git describe --always --dirty --tags 2>/dev/null || echo "undefined")

33# Allow to override image registry.

6# Allow to override image registry.

34−REGISTRY ?= quay.io/oauth2-proxy

7+REGISTRY ?= quay.io/oauth2-proxy

35−REPOSITORY ?= oauth2-proxy

36−

37−DATE := $(shell date +"%Y%m%d")

38.NOTPARALLEL:

8.NOTPARALLEL:

39

9

40−# The go version in go.mod used for the Docker build toolchain, without the patch

10+GO_MAJOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f1)

41−GO_MOD_VERSION_MINOR := $(shell $(GO) list -f '{{printf "%.4s" .Module.GoVersion}}' )

11+GO_MINOR_VERSION = $(shell $(GO) version | cut -c 14- | cut -d' ' -f1 | cut -d'.' -f2)

42−

12+MINIMUM_SUPPORTED_GO_MAJOR_VERSION = 1

43−# From go1.21 go will transparently download the toolchain declared in go.mod. https://go.dev/doc/toolchain

13+MINIMUM_SUPPORTED_GO_MINOR_VERSION = 15

44−# We don't need to keep this message updated: the important info is in go.mod.

45−GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least go1.21

14+GO_VERSION_VALIDATION_ERR_MSG = Golang version is not supported, please update to at least $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION).$(MINIMUM_SUPPORTED_GO_MINOR_VERSION)

46

15

47ifeq ($(COVER),true)

16ifeq ($(COVER),true)

48TESTCOVER ?= -coverprofile c.out

17TESTCOVER ?= -coverprofile c.out

49endif

18endif

50

19

51−##@ Build

52−

53−.PHONY: build

20+.PHONY: all

54−build: validate-go-version clean $(BINARY) ## Build and create oauth2-proxy binary from current source code

21+all: lint $(BINARY)

55−

56−$(BINARY):

57− 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

58−

59−DOCKER_BUILDX_COMMON_ARGS ?= --build-arg BUILD_IMAGE=docker.io/library/golang:$(GO_MOD_VERSION_MINOR)-bookworm --build-arg VERSION=$(VERSION)

60−

61−DOCKER_BUILD_PLATFORM ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v7,linux/s390x

62−DOCKER_BUILD_RUNTIME_IMAGE ?= gcr.io/distroless/static:nonroot

63−DOCKER_BUILDX_ARGS ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE} ${DOCKER_BUILDX_COMMON_ARGS}

64−DOCKER_BUILDX := docker buildx build ${DOCKER_BUILDX_ARGS} --pull

65−DOCKER_BUILDX_X_PLATFORM := $(DOCKER_BUILDX) --platform ${DOCKER_BUILD_PLATFORM}

66−DOCKER_BUILDX_PUSH := $(DOCKER_BUILDX) --push

67−DOCKER_BUILDX_PUSH_X_PLATFORM := $(DOCKER_BUILDX_PUSH) --platform ${DOCKER_BUILD_PLATFORM}

68−

69−DOCKER_BUILD_PLATFORM_ALPINE ?= linux/amd64,linux/arm64,linux/ppc64le,linux/arm/v6,linux/arm/v7,linux/s390x

70−DOCKER_BUILD_RUNTIME_IMAGE_ALPINE ?= alpine:3.24.1

71−DOCKER_BUILDX_ARGS_ALPINE ?= --build-arg RUNTIME_IMAGE=${DOCKER_BUILD_RUNTIME_IMAGE_ALPINE} ${DOCKER_BUILDX_COMMON_ARGS}

72−DOCKER_BUILDX_X_PLATFORM_ALPINE := docker buildx build ${DOCKER_BUILDX_ARGS_ALPINE} --platform ${DOCKER_BUILD_PLATFORM_ALPINE}

73−DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE := $(DOCKER_BUILDX_X_PLATFORM_ALPINE) --push

74−

75−.PHONY: build-docker

76−build-docker: build-distroless build-alpine ## Build multi architecture docker images in both flavours (distroless / alpine)

77−

78−.PHONY: build-docker-local

79−build-docker-local: ## Build distroless docker image and locally load into docker images

80− $(DOCKER_BUILDX) --load -t $(REGISTRY)/$(REPOSITORY):${VERSION}-local .

81−

82−.PHONY: build-distroless

83−build-distroless: ## Build multi architecture distroless based docker image

84− $(DOCKER_BUILDX_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .

85−

86−.PHONY: build-alpine

87−build-alpine: ## Build multi architecture alpine based docker image

88− $(DOCKER_BUILDX_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .

89

22

90−.PHONY: build-docker-all

23+.PHONY: clean

91−build-docker-all: build-docker ## Build docker images for all supported architectures in both flavours (distroless / alpine)

24+clean:

92− $(DOCKER_BUILDX) --platform linux/amd64 -t $(REGISTRY)/$(REPOSITORY):latest-amd64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-amd64 .

25+ rm -rf release

93− $(DOCKER_BUILDX) --platform linux/arm64 -t $(REGISTRY)/$(REPOSITORY):latest-arm64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-arm64 .

26+ rm -f $(BINARY)

94− $(DOCKER_BUILDX) --platform linux/ppc64le -t $(REGISTRY)/$(REPOSITORY):latest-ppc64le -t $(REGISTRY)/$(REPOSITORY):${VERSION}-ppc64le .

95− $(DOCKER_BUILDX) --platform linux/arm/v7 -t $(REGISTRY)/$(REPOSITORY):latest-armv7 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv7 .

96− $(DOCKER_BUILDX) --platform linux/s390x -t $(REGISTRY)/$(REPOSITORY):latest-s390x -t $(REGISTRY)/$(REPOSITORY):${VERSION}-s390x .

97−

98−

99−##@ Publish

100−

101−.PHONY: push-docker

102−push-docker: push-distroless push-alpine ## Push multi architecture docker images for both flavours (distroless / alpine)

103−

104−.PHONY: push-distroless

105−push-distroless: ## Push multi architecture distroless based docker image

106− $(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY):latest -t $(REGISTRY)/$(REPOSITORY):${VERSION} .

107−

108−.PHONY: push-alpine

109−push-alpine: ## Push multi architecture alpine based docker image

110− $(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t $(REGISTRY)/$(REPOSITORY):latest-alpine -t $(REGISTRY)/$(REPOSITORY):${VERSION}-alpine .

111−

112−.PHONY: push-docker-all

113−push-docker-all: push-docker ## Push docker images for all supported architectures for both flavours (distroless / alpine)

114− $(DOCKER_BUILDX_PUSH) --platform linux/amd64 -t $(REGISTRY)/$(REPOSITORY):latest-amd64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-amd64 .

115− $(DOCKER_BUILDX_PUSH) --platform linux/arm64 -t $(REGISTRY)/$(REPOSITORY):latest-arm64 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-arm64 .

116− $(DOCKER_BUILDX_PUSH) --platform linux/ppc64le -t $(REGISTRY)/$(REPOSITORY):latest-ppc64le -t $(REGISTRY)/$(REPOSITORY):${VERSION}-ppc64le .

117− $(DOCKER_BUILDX_PUSH) --platform linux/arm/v7 -t $(REGISTRY)/$(REPOSITORY):latest-armv7 -t $(REGISTRY)/$(REPOSITORY):${VERSION}-armv7 .

118− $(DOCKER_BUILDX_PUSH) --platform linux/s390x -t $(REGISTRY)/$(REPOSITORY):latest-s390x -t $(REGISTRY)/$(REPOSITORY):${VERSION}-s390x .

119−

120−

121−##@ Nightly scheduling

122

27

123−.PHONY: nightly-build

28+.PHONY: distclean

124−nightly-build: ## Nightly build command for docker images in both flavours (distroless / alpine)

29+distclean: clean

125− $(DOCKER_BUILDX_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY)-nightly:latest -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE} .

30+ rm -rf vendor

126− $(DOCKER_BUILDX_X_PLATFORM_ALPINE) -t ${REGISTRY}/$(REPOSITORY)-nightly:latest-alpine -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE}-alpine .

127

31

128−.PHONY: nightly-push

32+.PHONY: lint

129−nightly-push: ## Nightly push command for docker images in both flavours (distroless / alpine)

33+lint: validate-go-version

130− $(DOCKER_BUILDX_PUSH_X_PLATFORM) -t $(REGISTRY)/$(REPOSITORY)-nightly:latest -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE} .

34+ GO111MODULE=on $(GOLANGCILINT) run

131− $(DOCKER_BUILDX_PUSH_X_PLATFORM_ALPINE) -t ${REGISTRY}/$(REPOSITORY)-nightly:latest-alpine -t $(REGISTRY)/$(REPOSITORY)-nightly:${DATE}-alpine .

132

35

36+.PHONY: build

37+build: validate-go-version clean $(BINARY)

133

38

134−##@ Docs

39+$(BINARY):

40+ GO111MODULE=on CGO_ENABLED=0 $(GO) build -a -installsuffix cgo -ldflags="-X main.VERSION=${VERSION}" -o $@ github.com/oauth2-proxy/oauth2-proxy/v7

41+

42+DOCKER_BUILD := docker build --build-arg VERSION=${VERSION}

43+DOCKER_BUILDX := docker buildx build --platform linux/amd64,linux/arm64,linux/arm/v6 --build-arg VERSION=${VERSION}

44+

45+.PHONY: docker

46+docker:

47+ $(DOCKER_BUILDX) -f Dockerfile -t $(REGISTRY)/oauth2-proxy:latest .

48+

49+.PHONY: docker-all

50+docker-all: docker

51+ $(DOCKER_BUILD) -f Dockerfile -t $(REGISTRY)/oauth2-proxy:latest-amd64 .

52+ $(DOCKER_BUILD) -f Dockerfile -t $(REGISTRY)/oauth2-proxy:${VERSION} .

53+ $(DOCKER_BUILD) -f Dockerfile -t $(REGISTRY)/oauth2-proxy:${VERSION}-amd64 .

54+ $(DOCKER_BUILD) -f Dockerfile.arm64 -t $(REGISTRY)/oauth2-proxy:latest-arm64 .

55+ $(DOCKER_BUILD) -f Dockerfile.arm64 -t $(REGISTRY)/oauth2-proxy:${VERSION}-arm64 .

56+ $(DOCKER_BUILD) -f Dockerfile.armv6 -t $(REGISTRY)/oauth2-proxy:latest-armv6 .

57+ $(DOCKER_BUILD) -f Dockerfile.armv6 -t $(REGISTRY)/oauth2-proxy:${VERSION}-armv6 .

58+

59+.PHONY: docker-push

60+docker-push:

61+ docker buildx build --push --platform linux/amd64,linux/arm64,linux/arm/v6 -t $(REGISTRY)/oauth2-proxy:latest .

62+

63+.PHONY: docker-push-all

64+docker-push-all: docker-push

65+ docker push $(REGISTRY)/oauth2-proxy:latest-amd64

66+ docker push $(REGISTRY)/oauth2-proxy:${VERSION}

67+ docker push $(REGISTRY)/oauth2-proxy:${VERSION}-amd64

68+ docker push $(REGISTRY)/oauth2-proxy:latest-arm64

69+ docker push $(REGISTRY)/oauth2-proxy:${VERSION}-arm64

70+ docker push $(REGISTRY)/oauth2-proxy:latest-armv6

71+ docker push $(REGISTRY)/oauth2-proxy:${VERSION}-armv6

135

72

136.PHONY: generate

73.PHONY: generate

137−generate: ## Generate alpha config docs from golang structs

74+generate:

138 go generate ./pkg/...

75 go generate ./pkg/...

139

76

140.PHONY: verify-generate

77.PHONY: verify-generate

141−verify-generate: generate ## Verify command to check if alpha config docs are in line with golang struct changes

78+verify-generate: generate

142 git diff --exit-code

79 git diff --exit-code

143

80

144−##@ Miscellaneous

145−

146.PHONY: test

81.PHONY: test

147−test: ## Run all Go tests

82+test: lint

148 GO111MODULE=on $(GO) test $(TESTCOVER) -v -race ./...

83 GO111MODULE=on $(GO) test $(TESTCOVER) -v -race ./...

149

84

150.PHONY: release

85.PHONY: release

151−release: validate-go-version ## Create a full release for all architectures (binaries and checksums)

86+release: validate-go-version lint test

152 BINARY=${BINARY} VERSION=${VERSION} ./dist.sh

87 BINARY=${BINARY} VERSION=${VERSION} ./dist.sh

153

88

154−.PHONY: clean

155−clean: ## Cleanup release and build files

156− -rm -rf release

157− -rm -f $(BINARY)

158−

159−.PHONY: lint

160−lint: validate-go-version ## Lint all files using golangci-lint

161− GO111MODULE=on $(GO) run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCILINT_VERSION) run --timeout 10m

162−

163−.PHONY: lint-fix

164−lint-fix: validate-go-version ## Lint all files and apply fixes using golangci-lint

165− GO111MODULE=on $(GO) run github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCILINT_VERSION) run --timeout 10m --fix

166−

167.PHONY: validate-go-version

89.PHONY: validate-go-version

168−validate-go-version: ## Validate Go environment requirements

90+validate-go-version:

91+ @if [ $(GO_MAJOR_VERSION) -gt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \

92+ exit 0 ;\

93+ elif [ $(GO_MAJOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MAJOR_VERSION) ]; then \

169− @$(GO) list . >/dev/null || { echo '$(GO_VERSION_VALIDATION_ERR_MSG)'; exit 1; }

94+ echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\

95+ exit 1; \

96+ elif [ $(GO_MINOR_VERSION) -lt $(MINIMUM_SUPPORTED_GO_MINOR_VERSION) ] ; then \

97+ echo '$(GO_VERSION_VALIDATION_ERR_MSG)';\

98+ exit 1; \

99+ fi

170

100

171# local-env can be used to interact with the local development environment

101# local-env can be used to interact with the local development environment

172# eg:

102# eg:

173−# make local-env-up # Bring up a basic test environment

103+# make local-env-up # Bring up a basic test environment

174−# make local-env-down # Tear down the basic test environment

104+# make local-env-down # Tear down the basic test environment

175−# make local-env-nginx-up # Bring up an nginx based test environment

105+# make local-env-nginx-up # Bring up an nginx based test environment

176−# make local-env-nginx-down # Tead down the nginx based test environment

106+# make local-env-nginx-down # Tead down the nginx based test environment

177.PHONY: local-env-%

107.PHONY: local-env-%

178local-env-%:

108local-env-%:

179 make -C contrib/local-environment $*

109 make -C contrib/local-environment $*

README.md+36−80

@@ -1,105 +1,61 @@

1−[](https://github.com/oauth2-proxy/oauth2-proxy/actions/workflows/ci.yml)

2−[](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy/v7)

3−[](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy/v7)

4−[](./LICENSE)

5−[](https://qlty.sh/gh/oauth2-proxy/projects/oauth2-proxy)

6−[](https://qlty.sh/gh/oauth2-proxy/projects/oauth2-proxy)

7−[](https://scorecard.dev/viewer/?uri=github.com/oauth2-proxy/oauth2-proxy)

8−[](https://www.bestpractices.dev/projects/11223)

9−[](https://app.fossa.com/projects/git%2Bgithub.com%2Foauth2-proxy%2Foauth2-proxy?ref=badge_shield)

10−

11−

1+

12−

13−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.

14−

15−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.

16−

17−

18−

19−## Get Started

20

2

21−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).

3+[](http://travis-ci.org/oauth2-proxy/oauth2-proxy)

22−

4+[](https://goreportcard.com/report/github.com/oauth2-proxy/oauth2-proxy)

23−## Releases

5+[](https://godoc.org/github.com/oauth2-proxy/oauth2-proxy)

24−

6+[](./LICENSE)

25−### Binaries

7+[](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/maintainability)

26−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`.

8+[](https://codeclimate.com/github/oauth2-proxy/oauth2-proxy/test_coverage)

27−

28−Check out the [latest release](https://github.com/oauth2-proxy/oauth2-proxy/releases/latest).

29−

30−### Images

31−

32−From `v7.6.0` and up the base image has been changed from Alpine to [GoogleContainerTools/distroless](https://github.com/GoogleContainerTools/distroless).

33−This image comes with even fewer installed dependencies and thus should improve security. The image therefore is also slightly smaller than Alpine.

34−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`.

35

9

36−Since 2023-11-18 we build nightly images directly from the `master` branch and provide them at `quay.io/oauth2-proxy/oauth2-proxy-nightly`.

10+A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others)

37−These images are considered unstable and therefore should **NOT** be used for production purposes unless you know what you're doing.

11+to validate accounts by email, domain or group.

38

12

39−## Sponsors

13+**Note:** This repository was forked from [bitly/OAuth2_Proxy](https://github.com/bitly/oauth2_proxy) on 27/11/2018.

40−Would you like to sponsor the project then please contact us at [sponsors@oauth2-proxy.dev](mailto:sponsors@oauth2-proxy.dev)

14+Versions v3.0.0 and up are from this fork and will have diverged from any changes in the original fork.

15+A list of changes can be seen in the [CHANGELOG](CHANGELOG.md).

41

16

42−

17+**Note:** This project was formerly hosted as `pusher/oauth2_proxy` but has been renamed as of 29/03/2020 to `oauth2-proxy/oauth2-proxy`.

18+Going forward, all images shall be available at `quay.io/oauth2-proxy/oauth2-proxy` and binaries will be named `oauth2-proxy`.

43

19

44−SAP Open Source Program

20+

45

21

46−## Former Sponsors

22+## Installation

47−

48

23

49−Microsoft Azure credits for open source projects

24+1. Choose how to deploy:

50

25

51−## Getting Involved

26+ a. Download [Prebuilt Binary](https://github.com/oauth2-proxy/oauth2-proxy/releases) (current release is `v7.1.3`)

52−[](https://cloud-native.slack.com/archives/C098Y5URZ2N)

53

27

54−Join the #oauth2-proxy [Slack channel](https://cloud-native.slack.com/archives/C098Y5URZ2N) to chat with other users of OAuth2 Proxy or reach out to the maintainers directly. Use the [public invite link](https://slack.cncf.io/) to get an invite for the CNCF space.

28+ b. Build with `$ go get github.com/oauth2-proxy/oauth2-proxy/v7` which will put the binary in `$GOROOT/bin`

55

29

56−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.

30+ c. Using the prebuilt docker image [quay.io/oauth2-proxy/oauth2-proxy](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, ARMv6 and ARM64 tags available)

57

31

58−If you want to contribute to the project. Please see our [Contributing](https://oauth2-proxy.github.io/oauth2-proxy/community/contribution) guide.

32+Prebuilt binaries can be validated by extracting the file and verifying it against the `sha256sum.txt` checksum file provided for each release starting with version `v3.0.0`.

59

33

60−Thanks to all the people who already contributed ❤

34+```

35+sha256sum -c sha256sum.txt 2>&1 | grep OK

36+oauth2-proxy-x.y.z.linux-amd64: OK

37+```

61

38

62−<a href="https://github.com/oauth2-proxy/oauth2-proxy/graphs/contributors">

39+2. [Select a Provider and Register an OAuth Application with a Provider](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/oauth_provider)

63− <img src="https://contrib.rocks/image?repo=oauth2-proxy/oauth2-proxy&columns=15&max=75" />

40+3. [Configure OAuth2 Proxy using config file, command line options, or environment variables](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview)

64− <img src="https://img.shields.io/github/contributors/oauth2-proxy/oauth2-proxy" />

41+4. [Configure SSL or Deploy behind a SSL endpoint](https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/tls) (example provided for Nginx)

65−</a>

66

42

67−Made with [contrib.rocks](https://contrib.rocks).

68

43

69## Security

44## Security

70

45

71−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.

72−

73−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.md](MAINTAINERS.md) file.

74−

75−For more details read our full [Security Docs](https://oauth2-proxy.github.io/oauth2-proxy/community/security#security-disclosures)

76−

77−### Security Notice for v6.0.0 and older

78−

79−If you are running a version older than v6.0.0 we **strongly recommend** to the current version.

46+If you are running a version older than v6.0.0 we **strongly recommend you please update** to a current version.

80−

81See [open redirect vulnerability](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-5m6c-jp6f-2vcv) for details.

47See [open redirect vulnerability](https://github.com/oauth2-proxy/oauth2-proxy/security/advisories/GHSA-5m6c-jp6f-2vcv) for details.

82

48

83−## Repository History

49+## Docs

84

50

85−**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).

51+Read the docs on our [Docs site](https://oauth2-proxy.github.io/oauth2-proxy/docs/).

86

52

87−**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`.

53+

88

54

89−## Code of Conduct

55+## Getting Involved

90−Participation in the OAuth2 Proxy project is governed by the [CNCF Code of Conduct](CODE_OF_CONDUCT.md).

91−

92−## License

93−

94−OAuth2 Proxy is distributed under [The MIT License](LICENSE).

95−

96−

97−[](https://app.fossa.com/projects/git%2Bgithub.com%2Foauth2-proxy%2Foauth2-proxy?ref=badge_large)

98−

99−## Trademarks

100

56

101−OAuth2 Proxy is a [Cloud Native Computing Foundation](https://cncf.io) Sandbox project.

57+If you would like to reach out to the maintainers, come talk to us in the `#oauth2-proxy` channel in the [Gophers slack](http://gophers.slack.com/).

102

58

103−

59+## Contributing

104

60

105−The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage).

61+Please see our [Contributing](CONTRIBUTING.md) guidelines. For releasing see our [release creation guide](RELEASE.md).

RELEASE.md+2−4

@@ -1,7 +1,5 @@

1# Release

1# Release

2

2

3−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`.

4−

5Here's how OAuth2 Proxy releases are created.

3Here's how OAuth2 Proxy releases are created.

6

4

7## Schedule

5## Schedule

@@ -41,8 +39,8 @@ Note this uses `v4.1.0` as an example release number.

4110. Publish release in Github

3910. Publish release in Github

4211. Make and push docker images to Quay

4011. Make and push docker images to Quay

43 ```

41 ```

44− make build-docker-all

42+ make docker-all

45− make push-docker-all

43+ make docker-push-all

46 ```

44 ```

47 Note: Ensure the docker tags don't include `-dirty`. This means you have uncommitted changes.

45 Note: Ensure the docker tags don't include `-dirty`. This means you have uncommitted changes.

48

46

SECURITY.md+1−1

@@ -1,3 +1,3 @@

1# Security Disclosures

1# Security Disclosures

2

2

3−Please see [our community docs](https://oauth2-proxy.github.io/oauth2-proxy/community/security) for our security policy.

3+Please see [our community docs](https://oauth2-proxy.github.io/oauth2-proxy/docs/community/security) for our security policy.

contrib/local-environment/Makefile+10−18

@@ -1,42 +1,34 @@

1.PHONY: up

1.PHONY: up

2up:

2up:

3− docker compose up -d

3+ docker-compose up -d

4

4

5.PHONY: %

5.PHONY: %

6%:

6%:

7− docker compose $*

7+ docker-compose $*

8

8

9.PHONY: alpha-config-up

9.PHONY: alpha-config-up

10alpha-config-up:

10alpha-config-up:

11− docker compose -f docker-compose.yaml -f docker-compose-alpha-config.yaml up -d

11+ docker-compose -f docker-compose.yaml -f docker-compose-alpha-config.yaml up -d

12

12

13.PHONY: alpha-config-%

13.PHONY: alpha-config-%

14alpha-config-%:

14alpha-config-%:

15− docker compose -f docker-compose.yaml -f docker-compose-alpha-config.yaml $*

15+ docker-compose -f docker-compose.yaml -f docker-compose-nginx.yaml $*

16

16

17.PHONY: nginx-up

17.PHONY: nginx-up

18nginx-up:

18nginx-up:

19− docker compose -f docker-compose.yaml -f docker-compose-nginx.yaml up -d

19+ docker-compose -f docker-compose.yaml -f docker-compose-nginx.yaml up -d

20

20

21.PHONY: nginx-%

21.PHONY: nginx-%

22nginx-%:

22nginx-%:

23− docker compose -f docker-compose.yaml -f docker-compose-nginx.yaml $*

23+ docker-compose -f docker-compose.yaml -f docker-compose-nginx.yaml $*

24

24

25.PHONY: keycloak-up

25.PHONY: keycloak-up

26keycloak-up:

26keycloak-up:

27− docker compose -f docker-compose-keycloak.yaml up -d

27+ docker-compose -f docker-compose-keycloak.yaml up -d

28

28

29.PHONY: keycloak-%

29.PHONY: keycloak-%

30keycloak-%:

30keycloak-%:

31− docker compose -f docker-compose-keycloak.yaml $*

31+ docker-compose -f docker-compose-keycloak.yaml $*

32−

33−.PHONY: gitea-up

34−gitea-up:

35− docker compose -f docker-compose-gitea.yaml up -d

36−

37−.PHONY: gitea-%

38−gitea-%:

39− docker compose -f docker-compose-gitea.yaml $*

40

32

41.PHONY: kubernetes-up

33.PHONY: kubernetes-up

42kubernetes-up:

34kubernetes-up:

@@ -49,8 +41,8 @@ kubernetes-down:

49

41

50.PHONY: traefik-up

42.PHONY: traefik-up

51traefik-up:

43traefik-up:

52− docker compose -f docker-compose-traefik.yaml up -d

44+ docker-compose -f docker-compose.yaml -f docker-compose-traefik.yaml up -d

53

45

54.PHONY: traefik-%

46.PHONY: traefik-%

55traefik-%:

47traefik-%:

56− docker compose -f docker-compose-traefik.yaml $*

48+ docker-compose -f docker-compose.yaml -f docker-compose-traefik.yaml $*

contrib/local-environment/dex-traefik.yamldeleted−25

@@ -1,25 +0,0 @@

1−# This configuration is intended to be used with the Traefik local environment.

2−# Dex uses in-memory storage because this environment is disposable.

3−issuer: http://dex.localtest.me/dex

4−storage:

5− type: memory

6−web:

7− http: 0.0.0.0:5556

8−oauth2:

9− skipApprovalScreen: true

10−expiry:

11− signingKeys: "4h"

12− idTokens: "1h"

13−staticClients:

14− - id: oauth2-proxy

15− redirectURIs:

16− - "http://oauth2-proxy.localtest.me/oauth2/callback"

17− name: "OAuth2 Proxy"

18− secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK

19−enablePasswordDB: true

20−staticPasswords:

21− - email: "admin@example.com"

22− # bcrypt hash of the string "password"

23− hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"

24− username: "admin"

25− userID: "08a8684b-db88-4b73-90a9-3cd1661f5466"

contrib/local-environment/dex.yaml+20−16

@@ -1,28 +1,32 @@

1# This configuration is intended to be used with the docker-compose testing

1# This configuration is intended to be used with the docker-compose testing

2# environment.

2# environment.

3−# This should configure Dex to run on port 5556 and provides a static login

3+# This should configure Dex to run on port 4190 and provides a static login

4−issuer: http://dex.localtest.me:5556/dex

4+issuer: http://dex.localhost:4190/dex

5storage:

5storage:

6− type: memory

6+ type: etcd

7+ config:

8+ endpoints:

9+ - http://etcd:2379

10+ namespace: dex/

7web:

11web:

8− http: 0.0.0.0:5556

12+ http: 0.0.0.0:4190

9oauth2:

13oauth2:

10 skipApprovalScreen: true

14 skipApprovalScreen: true

11expiry:

15expiry:

12 signingKeys: "4h"

16 signingKeys: "4h"

13 idTokens: "1h"

17 idTokens: "1h"

14staticClients:

18staticClients:

15− - id: oauth2-proxy

19+- id: oauth2-proxy

16− redirectURIs:

20+ redirectURIs:

17− # These redirect URIs point to the `--redirect-url` for OAuth2 proxy.

21+ # These redirect URIs point to the `--redirect-url` for OAuth2 proxy.

18− - "http://oauth2-proxy.localtest.me:4180/oauth2/callback" # For basic proxy example.

22+ - 'http://localhost:4180/oauth2/callback' # For basic proxy example.

19− - "http://oauth2-proxy.localtest.me:8080/oauth2/callback" # For nginx example.

23+ - 'http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback' # For nginx and traefik example.

20− name: "OAuth2 Proxy"

24+ name: 'OAuth2 Proxy'

21− secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK

25+ secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK

22enablePasswordDB: true

26enablePasswordDB: true

23staticPasswords:

27staticPasswords:

24− - email: "admin@example.com"

28+- email: "admin@example.com"

25− # bcrypt hash of the string "password"

29+ # bcrypt hash of the string "password"

26− hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"

30+ hash: "$2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W"

27− username: "admin"

31+ username: "admin"

28− userID: "08a8684b-db88-4b73-90a9-3cd1661f5466"

32+ userID: "08a8684b-db88-4b73-90a9-3cd1661f5466"

contrib/local-environment/docker-compose-alpha-config.yaml+2−37

@@ -1,7 +1,7 @@

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

2# for manual testing and exploration of features.

2# for manual testing and exploration of features.

3# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

3# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

4−# HTTPBin as an example upstream.

4+# etcd for storage for Dex and HTTPBin as an example upstream.

5# This file also uses alpha configuration when configuring OAuth2 Proxy.

5# This file also uses alpha configuration when configuring OAuth2 Proxy.

6#

6#

7# This file is an extension of the main compose file and must be used with it

7# This file is an extension of the main compose file and must be used with it

@@ -10,45 +10,10 @@

10# make alpha-config-<command> (eg make nginx-up, make nginx-down)

10# make alpha-config-<command> (eg make nginx-up, make nginx-down)

11#

11#

12# Access http://localhost:4180 to initiate a login cycle

12# Access http://localhost:4180 to initiate a login cycle

13−version: "3.0"

13+version: '3.0'

14services:

14services:

15 oauth2-proxy:

15 oauth2-proxy:

16− container_name: oauth2-proxy

17− image: quay.io/oauth2-proxy/oauth2-proxy:v7.15.4

18 command: --config /oauth2-proxy.cfg --alpha-config /oauth2-proxy-alpha-config.yaml

16 command: --config /oauth2-proxy.cfg --alpha-config /oauth2-proxy-alpha-config.yaml

19− hostname: oauth2-proxy

20 volumes:

17 volumes:

21 - "./oauth2-proxy-alpha-config.cfg:/oauth2-proxy.cfg"

18 - "./oauth2-proxy-alpha-config.cfg:/oauth2-proxy.cfg"

22 - "./oauth2-proxy-alpha-config.yaml:/oauth2-proxy-alpha-config.yaml"

19 - "./oauth2-proxy-alpha-config.yaml:/oauth2-proxy-alpha-config.yaml"

23− restart: unless-stopped

24− ports:

25− - 4180:4180/tcp

26− networks:

27− dex: {}

28− httpbin: {}

29− depends_on:

30− - dex

31− - httpbin

32− dex:

33− container_name: dex

34− image: ghcr.io/dexidp/dex:v2.45.1

35− command: dex serve /dex.yaml

36− hostname: dex

37− volumes:

38− - "./dex.yaml:/dex.yaml"

39− restart: unless-stopped

40− ports:

41− - 5556:5556/tcp

42− networks:

43− dex:

44− aliases:

45− - dex.localtest.me

46− httpbin:

47− container_name: httpbin

48− image: kennethreitz/httpbin

49− ports: []

50− networks:

51− httpbin: {}

52−networks:

53− dex: {}

54− httpbin: {}

contrib/local-environment/docker-compose-gitea.yamldeleted−62

@@ -1,62 +0,0 @@

1−# This docker-compose file can be used to bring up an example instance of oauth2-proxy

2−# for manual testing and exploration of features.

3−# Alongside OAuth2-Proxy, this file also starts Gitea to act as the identity provider,

4−# HTTPBin as an example upstream.

5−#

6−# This can either be created using docker-compose

7−# docker-compose -f docker-compose-gitea.yaml <command>

8−# Or:

9−# make gitea-<command> (eg. make gitea-up, make gitea-down)

10−#

11−# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle using user=admin@example.com, password=password

12−# Access http://gitea.localtest.me:3000 with the same credentials to check out the settings

13−version: '3.0'

14−services:

15− oauth2-proxy:

16− container_name: oauth2-proxy

17− image: quay.io/oauth2-proxy/oauth2-proxy:v7.15.4

18− command: --config /oauth2-proxy.cfg

19− hostname: oauth2-proxy

20− volumes:

21− - "./oauth2-proxy-gitea.cfg:/oauth2-proxy.cfg"

22− restart: unless-stopped

23− networks:

24− gitea: {}

25− httpbin: {}

26− oauth2-proxy: {}

27− depends_on:

28− - httpbin

29− - gitea

30− ports:

31− - 4180:4180/tcp

32−

33− httpbin:

34− container_name: httpbin

35− image: kennethreitz/httpbin:latest

36− hostname: httpbin

37− ports: []

38− networks:

39− httpbin: {}

40−

41− gitea:

42− image: gitea/gitea:1.27.2

43− container_name: gitea

44− environment:

45− - USER_UID=1000

46− - USER_GID=1000

47− restart: always

48− networks:

49− gitea:

50− aliases:

51− - gitea.localtest.me

52− volumes:

53− - /etc/timezone:/etc/timezone:ro

54− - /etc/localtime:/etc/localtime:ro

55− ports:

56− - "3000:3000"

57− - "222:22"

58−

59−networks:

60− httpbin: {}

61− gitea: {}

62− oauth2-proxy: {}

contrib/local-environment/docker-compose-keycloak.yaml+20−15

@@ -10,18 +10,17 @@

10#

10#

11# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle using user=admin@example.com, password=password

11# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle using user=admin@example.com, password=password

12# Access http://keycloak.localtest.me:9080 with the same credentials to check out the settings

12# Access http://keycloak.localtest.me:9080 with the same credentials to check out the settings

13−version: "3.0"

13+version: '3.0'

14services:

14services:

15+

15 oauth2-proxy:

16 oauth2-proxy:

16 container_name: oauth2-proxy

17 container_name: oauth2-proxy

17− image: quay.io/oauth2-proxy/oauth2-proxy:v7.15.4

18+ image: quay.io/oauth2-proxy/oauth2-proxy:v7.1.3

18 command: --config /oauth2-proxy.cfg

19 command: --config /oauth2-proxy.cfg

19 hostname: oauth2-proxy

20 hostname: oauth2-proxy

20 volumes:

21 volumes:

21 - "./oauth2-proxy-keycloak.cfg:/oauth2-proxy.cfg"

22 - "./oauth2-proxy-keycloak.cfg:/oauth2-proxy.cfg"

22 restart: unless-stopped

23 restart: unless-stopped

23− ports:

24− - 4180:4180/tcp

25 networks:

24 networks:

26 keycloak: {}

25 keycloak: {}

27 httpbin: {}

26 httpbin: {}

@@ -29,35 +28,41 @@ services:

29 depends_on:

28 depends_on:

30 - httpbin

29 - httpbin

31 - keycloak

30 - keycloak

31+ ports:

32+ - 4180:4180/tcp

32

33

33 httpbin:

34 httpbin:

34 container_name: httpbin

35 container_name: httpbin

35 image: kennethreitz/httpbin:latest

36 image: kennethreitz/httpbin:latest

36 hostname: httpbin

37 hostname: httpbin

37− ports: []

38 networks:

38 networks:

39 httpbin: {}

39 httpbin: {}

40

40

41 keycloak:

41 keycloak:

42 container_name: keycloak

42 container_name: keycloak

43− image: keycloak/keycloak:26.7

43+ image: jboss/keycloak:10.0.0

44 hostname: keycloak

44 hostname: keycloak

45 command:

45 command:

46− - "start-dev"

46+ [

47− - "--http-port=9080"

47+ '-b',

48− - "--import-realm"

48+ '0.0.0.0',

49+ '-Djboss.socket.binding.port-offset=1000',

50+ '-Dkeycloak.migration.action=import',

51+ '-Dkeycloak.migration.provider=dir',

52+ '-Dkeycloak.migration.dir=/realm-config',

53+ '-Dkeycloak.migration.strategy=IGNORE_EXISTING',

54+ ]

49 volumes:

55 volumes:

50− - ./keycloak:/opt/keycloak/data/import

56+ - ./keycloak:/realm-config

51 environment:

57 environment:

52− KC_HTTP_PORT: 9080

53− KEYCLOAK_ADMIN: admin@example.com

58+ KEYCLOAK_USER: admin@example.com

54− KEYCLOAK_ADMIN_PASSWORD: password

59+ KEYCLOAK_PASSWORD: password

55− ports:

56− - 9080:9080/tcp

57 networks:

60 networks:

58 keycloak:

61 keycloak:

59 aliases:

62 aliases:

60 - keycloak.localtest.me

63 - keycloak.localtest.me

64+ ports:

65+ - 9080:9080/tcp

61

66

62networks:

67networks:

63 httpbin: {}

68 httpbin: {}

contrib/local-environment/docker-compose-nginx.yaml+15−40

@@ -1,68 +1,43 @@

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

2# for manual testing and exploration of features.

2# for manual testing and exploration of features.

3# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

3# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

4−# nginx as a reverse proxy and other HTTP services for upstreams.

4+# etcd for storage for Dex, nginx as a reverse proxy and other http services for upstreams

5#

5#

6# This file is an extension of the main compose file and must be used with it

6# This file is an extension of the main compose file and must be used with it

7# docker-compose -f docker-compose.yaml -f docker-compose-nginx.yaml <command>

7# docker-compose -f docker-compose.yaml -f docker-compose-nginx.yaml <command>

8# Alternatively:

8# Alternatively:

9# make nginx-<command> (eg make nginx-up, make nginx-down)

9# make nginx-<command> (eg make nginx-up, make nginx-down)

10#

10#

11−# Access http://oauth2-proxy.localtest.me:8080 to initiate a login flow.

11+# Access one of the following URLs to initiate a login flow:

12+# - http://oauth2-proxy.localhost

13+# - http://httpbin.oauth2-proxy.localhost

14+#

15+# The OAuth2 Proxy itself is hosted at http://oauth2-proxy.oauth2-proxy.localhost

16+#

17+# Note, the above URLs should work with Chrome, but you may need to add hosts

18+# entries for other browsers

19+# 127.0.0.1 oauth2-proxy.localhost

20+# 127.0.0.1 httpbin.oauth2-proxy.localhost

21+# 127.0.0.1 oauth2-proxy.oauth2-proxy.localhost

12−version: "3.0"

22+version: '3.0'

13services:

23services:

14 oauth2-proxy:

24 oauth2-proxy:

15− image: quay.io/oauth2-proxy/oauth2-proxy:v7.15.4

16 ports: []

25 ports: []

17 hostname: oauth2-proxy

26 hostname: oauth2-proxy

18− container_name: oauth2-proxy

19− command: --config /oauth2-proxy.cfg

20− restart: unless-stopped

21 volumes:

27 volumes:

22 - "./oauth2-proxy-nginx.cfg:/oauth2-proxy.cfg"

28 - "./oauth2-proxy-nginx.cfg:/oauth2-proxy.cfg"

23 networks:

29 networks:

24 oauth2-proxy: {}

30 oauth2-proxy: {}

25− dex: {}

26− httpbin: {}

27− depends_on:

28− - dex

29− - httpbin

30 nginx:

31 nginx:

31− depends_on:

32− - oauth2-proxy

33 container_name: nginx

32 container_name: nginx

34− image: nginx:1.31

33+ image: nginx:1.18

35− restart: unless-stopped

36 ports:

34 ports:

37− - 8080:8080/tcp

35+ - 80:80/tcp

38 hostname: nginx

36 hostname: nginx

39 volumes:

37 volumes:

40 - "./nginx.conf:/etc/nginx/conf.d/default.conf"

38 - "./nginx.conf:/etc/nginx/conf.d/default.conf"

41 networks:

39 networks:

42 oauth2-proxy: {}

40 oauth2-proxy: {}

43− dex: {}

44− httpbin: {}

45− dex:

46− container_name: dex

47− image: ghcr.io/dexidp/dex:v2.45.1

48− command: dex serve /dex.yaml

49− hostname: dex

50− volumes:

51− - "./dex.yaml:/dex.yaml"

52− restart: unless-stopped

53− ports:

54− - 5556:5556/tcp

55− networks:

56− dex:

57− aliases:

58− - dex.localtest.me

59− httpbin:

60− container_name: httpbin

61− image: kennethreitz/httpbin

62− ports: []

63− networks:

64 httpbin: {}

41 httpbin: {}

65networks:

42networks:

66− dex: {}

67− httpbin: {}

68 oauth2-proxy: {}

43 oauth2-proxy: {}

contrib/local-environment/docker-compose-traefik.yaml+17−42

@@ -1,7 +1,7 @@

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

2# for manual testing and exploration of features.

2# for manual testing and exploration of features.

3−# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider

3+# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

4−# and HTTPBin as an example upstream.

4+# HTTPBin as an example upstream.

5#

5#

6# This can either be created using docker-compose

6# This can either be created using docker-compose

7# docker-compose -f docker-compose-traefik.yaml <command>

7# docker-compose -f docker-compose-traefik.yaml <command>

@@ -9,51 +9,31 @@

9# make traefik-<command> (eg. make traefik-up, make traefik-down)

9# make traefik-<command> (eg. make traefik-up, make traefik-down)

10#

10#

11# Access one of the following URLs to initiate a login flow:

11# Access one of the following URLs to initiate a login flow:

12−# - http://oauth2-proxy.localtest.me

12+# - http://oauth2-proxy.localhost

13−# - http://httpbin.localtest.me

13+# - http://httpbin.oauth2-proxy.localhost

14−# - http://dex.localtest.me/dex

15#

14#

16−# The OAuth2 Proxy itself is hosted at http://oauth2-proxy.localtest.me

15+# The OAuth2 Proxy itself is hosted at http://oauth2-proxy.oauth2-proxy.localhost

16+#

17+# Note, the above URLs should work with Chrome, but you may need to add hosts

18+# entries for other browsers

19+# 127.0.0.1 oauth2-proxy.localhost

20+# 127.0.0.1 httpbin.oauth2-proxy.localhost

21+# 127.0.0.1 oauth2-proxy.oauth2-proxy.localhost

22+version: '3.0'

17services:

23services:

18

24

19 oauth2-proxy:

25 oauth2-proxy:

20− container_name: oauth2-proxy

21− image: quay.io/oauth2-proxy/oauth2-proxy:v7.15.4

22− command: --config /oauth2-proxy.cfg

23 ports: []

26 ports: []

24 hostname: oauth2-proxy

27 hostname: oauth2-proxy

25 volumes:

28 volumes:

26 - "./oauth2-proxy-traefik.cfg:/oauth2-proxy.cfg"

29 - "./oauth2-proxy-traefik.cfg:/oauth2-proxy.cfg"

27− restart: unless-stopped

28− networks:

29− oauth2-proxy: {}

30− dex: {}

31− depends_on:

32− - dex

33− - httpbin

34−

35− dex:

36− container_name: dex

37− image: ghcr.io/dexidp/dex:v2.45.1

38− command: dex serve /dex.yaml

39− hostname: dex

40− volumes:

41− - "./dex-traefik.yaml:/dex.yaml"

42− restart: unless-stopped

43 networks:

30 networks:

44− dex: {}

31+ oauth2-proxy:

45−

46− httpbin:

47− container_name: httpbin

48− image: kennethreitz/httpbin

49− ports: []

50− networks:

51− httpbin: {}

52

32

53 # Reverse proxy

33 # Reverse proxy

54 gateway:

34 gateway:

55 container_name: traefik

35 container_name: traefik

56− image: traefik:v3.7.10

36+ image: traefik:2.4.2

57 volumes:

37 volumes:

58 - "./traefik:/etc/traefik"

38 - "./traefik:/etc/traefik"

59 ports:

39 ports:

@@ -62,13 +42,8 @@ services:

62 depends_on:

42 depends_on:

63 - oauth2-proxy

43 - oauth2-proxy

64 networks:

44 networks:

65− oauth2-proxy: {}

45+ oauth2-proxy:

66− httpbin: {}

46+ httpbin:

67− dex:

68− aliases:

69− - dex.localtest.me

70

47

71networks:

48networks:

72− dex: {}

73− httpbin: {}

74− oauth2-proxy: {}

49+ oauth2-proxy:

contrib/local-environment/docker-compose.yaml+24−12

@@ -1,26 +1,26 @@

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

1# This docker-compose file can be used to bring up an example instance of oauth2-proxy

2# for manual testing and exploration of features.

2# for manual testing and exploration of features.

3# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

3# Alongside OAuth2-Proxy, this file also starts Dex to act as the identity provider,

4−# HTTPBin as an example upstream.

4+# etcd for storage for Dex and HTTPBin as an example upstream.

5#

5#

6# This can either be created using docker-compose

6# This can either be created using docker-compose

7# docker-compose -f docker-compose.yaml <command>

7# docker-compose -f docker-compose.yaml <command>

8# Or:

8# Or:

9# make <command> (eg. make up, make down)

9# make <command> (eg. make up, make down)

10#

10#

11−# Access http://oauth2-proxy.localtest.me:4180 to initiate a login cycle

11+# Access http://localhost:4180 to initiate a login cycle

12−version: "3.0"

12+version: '3.0'

13services:

13services:

14 oauth2-proxy:

14 oauth2-proxy:

15 container_name: oauth2-proxy

15 container_name: oauth2-proxy

16− image: quay.io/oauth2-proxy/oauth2-proxy:v7.15.4

16+ image: quay.io/oauth2-proxy/oauth2-proxy:v7.1.3

17 command: --config /oauth2-proxy.cfg

17 command: --config /oauth2-proxy.cfg

18+ ports:

19+ - 4180:4180/tcp

18 hostname: oauth2-proxy

20 hostname: oauth2-proxy

19 volumes:

21 volumes:

20 - "./oauth2-proxy.cfg:/oauth2-proxy.cfg"

22 - "./oauth2-proxy.cfg:/oauth2-proxy.cfg"

21 restart: unless-stopped

23 restart: unless-stopped

22− ports:

23− - 4180:4180/tcp

24 networks:

24 networks:

25 dex: {}

25 dex: {}

26 httpbin: {}

26 httpbin: {}

@@ -29,24 +29,36 @@ services:

29 - httpbin

29 - httpbin

30 dex:

30 dex:

31 container_name: dex

31 container_name: dex

32− image: ghcr.io/dexidp/dex:v2.45.1

32+ image: quay.io/dexidp/dex:v2.23.0

33− command: dex serve /dex.yaml

33+ command: serve /dex.yaml

34+ ports:

35+ - 4190:4190/tcp

34 hostname: dex

36 hostname: dex

35 volumes:

37 volumes:

36 - "./dex.yaml:/dex.yaml"

38 - "./dex.yaml:/dex.yaml"

37 restart: unless-stopped

39 restart: unless-stopped

38− ports:

39− - 5556:5556/tcp

40 networks:

40 networks:

41 dex:

41 dex:

42 aliases:

42 aliases:

43− - dex.localtest.me

43+ - dex.localhost

44+ etcd: {}

45+ depends_on:

46+ - etcd

44 httpbin:

47 httpbin:

45 container_name: httpbin

48 container_name: httpbin

46 image: kennethreitz/httpbin

49 image: kennethreitz/httpbin

47− ports: []

48 networks:

50 networks:

49 httpbin: {}

51 httpbin: {}

52+ etcd:

53+ container_name: etcd

54+ image: gcr.io/etcd-development/etcd:v3.4.7

55+ entrypoint: /usr/local/bin/etcd

56+ command:

57+ - --listen-client-urls=http://0.0.0.0:2379

58+ - --advertise-client-urls=http://etcd:2379

59+ networks:

60+ etcd: {}

50networks:

61networks:

51 dex: {}

62 dex: {}

63+ etcd: {}

52 httpbin: {}

64 httpbin: {}

contrib/local-environment/keycloak/master-realm.jsonnew file+1684

@@ -0,0 +1,1684 @@

1+{

2+ "id" : "master",

3+ "realm" : "master",

4+ "displayName" : "Keycloak",

5+ "displayNameHtml" : "<div class=\"kc-logo-text\"><span>Keycloak</span></div>",

6+ "notBefore" : 0,

7+ "revokeRefreshToken" : false,

8+ "refreshTokenMaxReuse" : 0,

9+ "accessTokenLifespan" : 60,

10+ "accessTokenLifespanForImplicitFlow" : 900,

11+ "ssoSessionIdleTimeout" : 1800,

12+ "ssoSessionMaxLifespan" : 36000,

13+ "ssoSessionIdleTimeoutRememberMe" : 0,

14+ "ssoSessionMaxLifespanRememberMe" : 0,

15+ "offlineSessionIdleTimeout" : 2592000,

16+ "offlineSessionMaxLifespanEnabled" : false,

17+ "offlineSessionMaxLifespan" : 5184000,

18+ "clientSessionIdleTimeout" : 0,

19+ "clientSessionMaxLifespan" : 0,

20+ "accessCodeLifespan" : 60,

21+ "accessCodeLifespanUserAction" : 300,

22+ "accessCodeLifespanLogin" : 1800,

23+ "actionTokenGeneratedByAdminLifespan" : 43200,

24+ "actionTokenGeneratedByUserLifespan" : 300,

25+ "enabled" : true,

26+ "sslRequired" : "external",

27+ "registrationAllowed" : false,

28+ "registrationEmailAsUsername" : false,

29+ "rememberMe" : false,

30+ "verifyEmail" : false,

31+ "loginWithEmailAllowed" : true,

32+ "duplicateEmailsAllowed" : false,

33+ "resetPasswordAllowed" : false,

34+ "editUsernameAllowed" : false,

35+ "bruteForceProtected" : false,

36+ "permanentLockout" : false,

37+ "maxFailureWaitSeconds" : 900,

38+ "minimumQuickLoginWaitSeconds" : 60,

39+ "waitIncrementSeconds" : 60,

40+ "quickLoginCheckMilliSeconds" : 1000,

41+ "maxDeltaTimeSeconds" : 43200,

42+ "failureFactor" : 30,

43+ "roles" : {

44+ "realm" : [ {

45+ "id" : "32626c92-4327-40f1-b318-76a6b5c7eee5",

46+ "name" : "offline_access",

47+ "description" : "${role_offline-access}",

48+ "composite" : false,

49+ "clientRole" : false,

50+ "containerId" : "master",

51+ "attributes" : { }

52+ }, {

53+ "id" : "e36da570-7ae0-4323-8b39-73eb92ce722f",

54+ "name" : "admin",

55+ "description" : "${role_admin}",

56+ "composite" : true,

57+ "composites" : {

58+ "realm" : [ "create-realm" ],

59+ "client" : {

60+ "master-realm" : [ "query-groups", "create-client", "query-realms", "view-authorization", "view-realm", "manage-clients", "query-users", "manage-realm", "view-events", "manage-events", "view-identity-providers", "view-users", "manage-identity-providers", "manage-authorization", "manage-users", "view-clients", "query-clients", "impersonation" ]

61+ }

62+ },

63+ "clientRole" : false,

64+ "containerId" : "master",

65+ "attributes" : { }

66+ }, {

67+ "id" : "71aca46c-6fcf-4456-ba87-6374e70108a2",

68+ "name" : "uma_authorization",

69+ "description" : "${role_uma_authorization}",

70+ "composite" : false,

71+ "clientRole" : false,

72+ "containerId" : "master",

73+ "attributes" : { }

74+ }, {

75+ "id" : "6ca3fee8-1a3f-4068-a311-6e81223a884b",

76+ "name" : "create-realm",

77+ "description" : "${role_create-realm}",

78+ "composite" : false,

79+ "clientRole" : false,

80+ "containerId" : "master",

81+ "attributes" : { }

82+ } ],

83+ "client" : {

84+ "oauth2-proxy" : [ ],

85+ "security-admin-console" : [ ],

86+ "admin-cli" : [ ],

87+ "account-console" : [ ],

88+ "broker" : [ {

89+ "id" : "2cc5e40c-0a28-4c09-85eb-20cd47ac1351",

90+ "name" : "read-token",

91+ "description" : "${role_read-token}",

92+ "composite" : false,

93+ "clientRole" : true,

94+ "containerId" : "380985f1-61c7-4940-93ae-7a09458071ca",

95+ "attributes" : { }

96+ } ],

97+ "master-realm" : [ {

98+ "id" : "a8271c2c-6437-4ca5-ae83-49ea5fe1318d",

99+ "name" : "query-groups",

100+ "description" : "${role_query-groups}",

101+ "composite" : false,

102+ "clientRole" : true,

103+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

104+ "attributes" : { }

105+ }, {

106+ "id" : "5a7cb1ae-7dac-486b-bf7b-4d7fbc5adb31",

107+ "name" : "create-client",

108+ "description" : "${role_create-client}",

109+ "composite" : false,

110+ "clientRole" : true,

111+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

112+ "attributes" : { }

113+ }, {

114+ "id" : "a9e6a2fa-c31b-4959-bf8a-a46fcc9c65ec",

115+ "name" : "view-authorization",

116+ "description" : "${role_view-authorization}",

117+ "composite" : false,

118+ "clientRole" : true,

119+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

120+ "attributes" : { }

121+ }, {

122+ "id" : "1cef34e3-569a-4d2b-ba5c-aafe5c7ab423",

123+ "name" : "query-realms",

124+ "description" : "${role_query-realms}",

125+ "composite" : false,

126+ "clientRole" : true,

127+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

128+ "attributes" : { }

129+ }, {

130+ "id" : "efc46075-30cd-4600-aa92-2ae4a171d0c2",

131+ "name" : "view-realm",

132+ "description" : "${role_view-realm}",

133+ "composite" : false,

134+ "clientRole" : true,

135+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

136+ "attributes" : { }

137+ }, {

138+ "id" : "9ffacaf0-afc6-49e9-8708-ef35ac40f3f8",

139+ "name" : "manage-clients",

140+ "description" : "${role_manage-clients}",

141+ "composite" : false,

142+ "clientRole" : true,

143+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

144+ "attributes" : { }

145+ }, {

146+ "id" : "90662091-b3bc-4ae4-83c9-a4f53e7e9eeb",

147+ "name" : "query-users",

148+ "description" : "${role_query-users}",

149+ "composite" : false,

150+ "clientRole" : true,

151+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

152+ "attributes" : { }

153+ }, {

154+ "id" : "9a5fbc9d-6fae-4155-86f6-72fd399aa126",

155+ "name" : "manage-realm",

156+ "description" : "${role_manage-realm}",

157+ "composite" : false,

158+ "clientRole" : true,

159+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

160+ "attributes" : { }

161+ }, {

162+ "id" : "03f46127-9436-477d-8c7f-58569f45237c",

163+ "name" : "view-events",

164+ "description" : "${role_view-events}",

165+ "composite" : false,

166+ "clientRole" : true,

167+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

168+ "attributes" : { }

169+ }, {

170+ "id" : "f10eaea2-90ab-4310-9d5f-8d986564d061",

171+ "name" : "view-identity-providers",

172+ "description" : "${role_view-identity-providers}",

173+ "composite" : false,

174+ "clientRole" : true,

175+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

176+ "attributes" : { }

177+ }, {

178+ "id" : "2403e038-2cf7-4b06-b5cb-33a417a00d8d",

179+ "name" : "manage-events",

180+ "description" : "${role_manage-events}",

181+ "composite" : false,

182+ "clientRole" : true,

183+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

184+ "attributes" : { }

185+ }, {

186+ "id" : "677d057b-66f8-4163-9948-95fdbd06dfdc",

187+ "name" : "view-users",

188+ "description" : "${role_view-users}",

189+ "composite" : true,

190+ "composites" : {

191+ "client" : {

192+ "master-realm" : [ "query-groups", "query-users" ]

193+ }

194+ },

195+ "clientRole" : true,

196+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

197+ "attributes" : { }

198+ }, {

199+ "id" : "dc140fa6-bf2c-49f2-b8c9-fc34ef8a2c63",

200+ "name" : "manage-identity-providers",

201+ "description" : "${role_manage-identity-providers}",

202+ "composite" : false,

203+ "clientRole" : true,

204+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

205+ "attributes" : { }

206+ }, {

207+ "id" : "155bf234-4895-4855-95c2-a460518f57e8",

208+ "name" : "manage-authorization",

209+ "description" : "${role_manage-authorization}",

210+ "composite" : false,

211+ "clientRole" : true,

212+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

213+ "attributes" : { }

214+ }, {

215+ "id" : "5441ec71-3eac-4696-9e68-0de54fbdde98",

216+ "name" : "manage-users",

217+ "description" : "${role_manage-users}",

218+ "composite" : false,

219+ "clientRole" : true,

220+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

221+ "attributes" : { }

222+ }, {

223+ "id" : "2db0f052-cb91-4170-81fd-107756b162f7",

224+ "name" : "view-clients",

225+ "description" : "${role_view-clients}",

226+ "composite" : true,

227+ "composites" : {

228+ "client" : {

229+ "master-realm" : [ "query-clients" ]

230+ }

231+ },

232+ "clientRole" : true,

233+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

234+ "attributes" : { }

235+ }, {

236+ "id" : "e1d7f235-8bf2-40b8-be49-49aca70a5088",

237+ "name" : "query-clients",

238+ "description" : "${role_query-clients}",

239+ "composite" : false,

240+ "clientRole" : true,

241+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

242+ "attributes" : { }

243+ }, {

244+ "id" : "e743f66a-2f56-4b97-b34b-33f06ff1e739",

245+ "name" : "impersonation",

246+ "description" : "${role_impersonation}",

247+ "composite" : false,

248+ "clientRole" : true,

249+ "containerId" : "7174c175-1887-4e57-b95b-969fe040deff",

250+ "attributes" : { }

251+ } ],

252+ "account" : [ {

253+ "id" : "64d8f532-839e-4386-b2eb-fe8848b0a9de",

254+ "name" : "manage-consent",

255+ "description" : "${role_manage-consent}",

256+ "composite" : true,

257+ "composites" : {

258+ "client" : {

259+ "account" : [ "view-consent" ]

260+ }

261+ },

262+ "clientRole" : true,

263+ "containerId" : "a367038f-fe01-4459-9f91-7ad0cf498533",

264+ "attributes" : { }

265+ }, {

266+ "id" : "3ec22748-960f-4f96-a43e-50f54a02dc23",

267+ "name" : "view-profile",

268+ "description" : "${role_view-profile}",

269+ "composite" : false,

270+ "clientRole" : true,

271+ "containerId" : "a367038f-fe01-4459-9f91-7ad0cf498533",

272+ "attributes" : { }

273+ }, {

274+ "id" : "177d18e4-46b0-4ea3-8b70-327486ce5bb2",

275+ "name" : "view-applications",

276+ "description" : "${role_view-applications}",

277+ "composite" : false,

278+ "clientRole" : true,

279+ "containerId" : "a367038f-fe01-4459-9f91-7ad0cf498533",

280+ "attributes" : { }

281+ }, {

282+ "id" : "703643d6-0542-4e27-9737-7c442925c18c",

283+ "name" : "manage-account-links",

284+ "description" : "${role_manage-account-links}",

285+ "composite" : false,

286+ "clientRole" : true,

287+ "containerId" : "a367038f-fe01-4459-9f91-7ad0cf498533",

288+ "attributes" : { }

289+ }, {

290+ "id" : "c64f9f66-d762-4337-8833-cf31c316e8a7",

291+ "name" : "view-consent",

292+ "description" : "${role_view-consent}",

293+ "composite" : false,

294+ "clientRole" : true,

295+ "containerId" : "a367038f-fe01-4459-9f91-7ad0cf498533",

296+ "attributes" : { }

297+ }, {

298+ "id" : "611f568b-0fdd-4d2e-ba34-03136cd486c4",

299+ "name" : "manage-account",

300+ "description" : "${role_manage-account}",

301+ "composite" : true,

302+ "composites" : {

303+ "client" : {

304+ "account" : [ "manage-account-links" ]

305+ }

306+ },

307+ "clientRole" : true,

308+ "containerId" : "a367038f-fe01-4459-9f91-7ad0cf498533",

309+ "attributes" : { }

310+ } ]

311+ }

312+ },

313+ "groups" : [ ],

314+ "defaultRoles" : [ "offline_access", "uma_authorization" ],

315+ "requiredCredentials" : [ "password" ],

316+ "otpPolicyType" : "totp",

317+ "otpPolicyAlgorithm" : "HmacSHA1",

318+ "otpPolicyInitialCounter" : 0,

319+ "otpPolicyDigits" : 6,

320+ "otpPolicyLookAheadWindow" : 1,

321+ "otpPolicyPeriod" : 30,

322+ "otpSupportedApplications" : [ "FreeOTP", "Google Authenticator" ],

323+ "webAuthnPolicyRpEntityName" : "keycloak",

324+ "webAuthnPolicySignatureAlgorithms" : [ "ES256" ],

325+ "webAuthnPolicyRpId" : "",

326+ "webAuthnPolicyAttestationConveyancePreference" : "not specified",

327+ "webAuthnPolicyAuthenticatorAttachment" : "not specified",

328+ "webAuthnPolicyRequireResidentKey" : "not specified",

329+ "webAuthnPolicyUserVerificationRequirement" : "not specified",

330+ "webAuthnPolicyCreateTimeout" : 0,

331+ "webAuthnPolicyAvoidSameAuthenticatorRegister" : false,

332+ "webAuthnPolicyAcceptableAaguids" : [ ],

333+ "webAuthnPolicyPasswordlessRpEntityName" : "keycloak",

334+ "webAuthnPolicyPasswordlessSignatureAlgorithms" : [ "ES256" ],

335+ "webAuthnPolicyPasswordlessRpId" : "",

336+ "webAuthnPolicyPasswordlessAttestationConveyancePreference" : "not specified",

337+ "webAuthnPolicyPasswordlessAuthenticatorAttachment" : "not specified",

338+ "webAuthnPolicyPasswordlessRequireResidentKey" : "not specified",

339+ "webAuthnPolicyPasswordlessUserVerificationRequirement" : "not specified",

340+ "webAuthnPolicyPasswordlessCreateTimeout" : 0,

341+ "webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister" : false,

342+ "webAuthnPolicyPasswordlessAcceptableAaguids" : [ ],

343+ "scopeMappings" : [ {

344+ "clientScope" : "offline_access",

345+ "roles" : [ "offline_access" ]

346+ } ],

347+ "clientScopeMappings" : {

348+ "account" : [ {

349+ "client" : "account-console",

350+ "roles" : [ "manage-account" ]

351+ } ]

352+ },

353+ "clients" : [ {

354+ "id" : "a367038f-fe01-4459-9f91-7ad0cf498533",

355+ "clientId" : "account",

356+ "name" : "${client_account}",

357+ "rootUrl" : "${authBaseUrl}",

358+ "baseUrl" : "/realms/master/account/",

359+ "surrogateAuthRequired" : false,

360+ "enabled" : true,

361+ "alwaysDisplayInConsole" : false,

362+ "clientAuthenticatorType" : "client-secret",

363+ "secret" : "0896a464-da81-4454-bee9-b56bdbad9e7f",

364+ "defaultRoles" : [ "view-profile", "manage-account" ],

365+ "redirectUris" : [ "/realms/master/account/*" ],

366+ "webOrigins" : [ ],

367+ "notBefore" : 0,

368+ "bearerOnly" : false,

369+ "consentRequired" : false,

370+ "standardFlowEnabled" : true,

371+ "implicitFlowEnabled" : false,

372+ "directAccessGrantsEnabled" : false,

373+ "serviceAccountsEnabled" : false,

374+ "publicClient" : false,

375+ "frontchannelLogout" : false,

376+ "protocol" : "openid-connect",

377+ "attributes" : { },

378+ "authenticationFlowBindingOverrides" : { },

379+ "fullScopeAllowed" : false,

380+ "nodeReRegistrationTimeout" : 0,

381+ "defaultClientScopes" : [ "web-origins", "role_list", "roles", "profile", "email" ],

382+ "optionalClientScopes" : [ "address", "phone", "offline_access", "microprofile-jwt" ]

383+ }, {

384+ "id" : "72f75604-1e21-407c-b967-790aafd11534",

385+ "clientId" : "account-console",

386+ "name" : "${client_account-console}",

387+ "rootUrl" : "${authBaseUrl}",

388+ "baseUrl" : "/realms/master/account/",

389+ "surrogateAuthRequired" : false,

390+ "enabled" : true,

391+ "alwaysDisplayInConsole" : false,

392+ "clientAuthenticatorType" : "client-secret",

393+ "secret" : "91f85142-ee18-4e30-9949-e5acb701bdee",

394+ "redirectUris" : [ "/realms/master/account/*" ],

395+ "webOrigins" : [ ],

396+ "notBefore" : 0,

397+ "bearerOnly" : false,

398+ "consentRequired" : false,

399+ "standardFlowEnabled" : true,

400+ "implicitFlowEnabled" : false,

401+ "directAccessGrantsEnabled" : false,

402+ "serviceAccountsEnabled" : false,

403+ "publicClient" : true,

404+ "frontchannelLogout" : false,

405+ "protocol" : "openid-connect",

406+ "attributes" : {

407+ "pkce.code.challenge.method" : "S256"

408+ },

409+ "authenticationFlowBindingOverrides" : { },

410+ "fullScopeAllowed" : false,

411+ "nodeReRegistrationTimeout" : 0,

412+ "protocolMappers" : [ {

413+ "id" : "2772c101-0dba-49b7-9627-5aaddc666939",

414+ "name" : "audience resolve",

415+ "protocol" : "openid-connect",

416+ "protocolMapper" : "oidc-audience-resolve-mapper",

417+ "consentRequired" : false,

418+ "config" : { }

419+ } ],

420+ "defaultClientScopes" : [ "web-origins", "role_list", "roles", "profile", "email" ],

421+ "optionalClientScopes" : [ "address", "phone", "offline_access", "microprofile-jwt" ]

422+ }, {

423+ "id" : "b13fd0de-3be0-4a08-bc5d-d1de34421b1a",

424+ "clientId" : "admin-cli",

425+ "name" : "${client_admin-cli}",

426+ "surrogateAuthRequired" : false,

427+ "enabled" : true,

428+ "alwaysDisplayInConsole" : false,

429+ "clientAuthenticatorType" : "client-secret",

430+ "secret" : "4640af2e-b4a6-44eb-85ec-6278a62a4f01",

431+ "redirectUris" : [ ],

432+ "webOrigins" : [ ],

433+ "notBefore" : 0,

434+ "bearerOnly" : false,

435+ "consentRequired" : false,

436+ "standardFlowEnabled" : false,

437+ "implicitFlowEnabled" : false,

438+ "directAccessGrantsEnabled" : true,

439+ "serviceAccountsEnabled" : false,

440+ "publicClient" : true,

441+ "frontchannelLogout" : false,

442+ "protocol" : "openid-connect",

443+ "attributes" : { },

444+ "authenticationFlowBindingOverrides" : { },

445+ "fullScopeAllowed" : false,

446+ "nodeReRegistrationTimeout" : 0,

447+ "defaultClientScopes" : [ "web-origins", "role_list", "roles", "profile", "email" ],

448+ "optionalClientScopes" : [ "address", "phone", "offline_access", "microprofile-jwt" ]

449+ }, {

450+ "id" : "380985f1-61c7-4940-93ae-7a09458071ca",

451+ "clientId" : "broker",

452+ "name" : "${client_broker}",

453+ "surrogateAuthRequired" : false,

454+ "enabled" : true,

455+ "alwaysDisplayInConsole" : false,

456+ "clientAuthenticatorType" : "client-secret",

457+ "secret" : "65d2ba2b-bcae-49ff-9f56-77c818f55930",

458+ "redirectUris" : [ ],

459+ "webOrigins" : [ ],

460+ "notBefore" : 0,

461+ "bearerOnly" : false,

462+ "consentRequired" : false,

463+ "standardFlowEnabled" : true,

464+ "implicitFlowEnabled" : false,

465+ "directAccessGrantsEnabled" : false,

466+ "serviceAccountsEnabled" : false,

467+ "publicClient" : false,

468+ "frontchannelLogout" : false,

469+ "protocol" : "openid-connect",

470+ "attributes" : { },

471+ "authenticationFlowBindingOverrides" : { },

472+ "fullScopeAllowed" : false,

473+ "nodeReRegistrationTimeout" : 0,

474+ "defaultClientScopes" : [ "web-origins", "role_list", "roles", "profile", "email" ],

475+ "optionalClientScopes" : [ "address", "phone", "offline_access", "microprofile-jwt" ]

476+ }, {

477+ "id" : "7174c175-1887-4e57-b95b-969fe040deff",

478+ "clientId" : "master-realm",

479+ "name" : "master Realm",

480+ "surrogateAuthRequired" : false,

481+ "enabled" : true,

482+ "alwaysDisplayInConsole" : false,

483+ "clientAuthenticatorType" : "client-secret",

484+ "secret" : "40f73851-a94c-4091-90de-aeee8ca1acf8",

485+ "redirectUris" : [ ],

486+ "webOrigins" : [ ],

487+ "notBefore" : 0,

488+ "bearerOnly" : true,

489+ "consentRequired" : false,

490+ "standardFlowEnabled" : true,

491+ "implicitFlowEnabled" : false,

492+ "directAccessGrantsEnabled" : false,

493+ "serviceAccountsEnabled" : false,

494+ "publicClient" : false,

495+ "frontchannelLogout" : false,

496+ "attributes" : { },

497+ "authenticationFlowBindingOverrides" : { },

498+ "fullScopeAllowed" : true,

499+ "nodeReRegistrationTimeout" : 0,

500+ "defaultClientScopes" : [ "web-origins", "role_list", "roles", "profile", "email" ],

501+ "optionalClientScopes" : [ "address", "phone", "offline_access", "microprofile-jwt" ]

502+ },

503+ {

504+ "id": "0493c7c6-6e20-49ea-9acb-627c0b52d400",

505+ "clientId": "oauth2-proxy",

506+ "surrogateAuthRequired": false,

507+ "enabled": true,

508+ "alwaysDisplayInConsole": false,

509+ "clientAuthenticatorType": "client-secret",

510+ "secret": "72341b6d-7065-4518-a0e4-50ee15025608",

511+ "redirectUris": [

512+ "http://oauth2-proxy.localtest.me:4180/oauth2/callback"

513+ ],

514+ "webOrigins": [],

515+ "notBefore": 0,

516+ "bearerOnly": false,

517+ "consentRequired": false,

518+ "standardFlowEnabled": true,

519+ "implicitFlowEnabled": false,

520+ "directAccessGrantsEnabled": true,

521+ "serviceAccountsEnabled": false,

522+ "publicClient": false,

523+ "frontchannelLogout": false,

524+ "protocol": "openid-connect",

525+ "attributes": {

526+ "saml.assertion.signature": "false",

527+ "saml.force.post.binding": "false",

528+ "saml.multivalued.roles": "false",

529+ "saml.encrypt": "false",

530+ "saml.server.signature": "false",

531+ "saml.server.signature.keyinfo.ext": "false",

532+ "exclude.session.state.from.auth.response": "false",

533+ "saml_force_name_id_format": "false",

534+ "saml.client.signature": "false",

535+ "tls.client.certificate.bound.access.tokens": "false",

536+ "saml.authnstatement": "false",

537+ "display.on.consent.screen": "false",

538+ "saml.onetimeuse.condition": "false"

539+ },

540+ "authenticationFlowBindingOverrides": {},

541+ "fullScopeAllowed": true,

542+ "nodeReRegistrationTimeout": -1,

543+ "defaultClientScopes": [

544+ "web-origins",

545+ "role_list",

546+ "roles",

547+ "profile",

548+ "email"

549+ ],

550+ "optionalClientScopes": [

551+ "address",

552+ "phone",

553+ "offline_access",

554+ "microprofile-jwt"

555+ ]

556+ }, {

557+ "id" : "2a3ad1fd-a30d-4b72-89c4-bed12f178338",

558+ "clientId" : "security-admin-console",

559+ "name" : "${client_security-admin-console}",

560+ "rootUrl" : "${authAdminUrl}",

561+ "baseUrl" : "/admin/master/console/",

562+ "surrogateAuthRequired" : false,

563+ "enabled" : true,

564+ "alwaysDisplayInConsole" : false,

565+ "clientAuthenticatorType" : "client-secret",

566+ "secret" : "b234b7aa-8417-410f-b3fd-c57434d3aa4a",

567+ "redirectUris" : [ "/admin/master/console/*" ],

568+ "webOrigins" : [ "+" ],

569+ "notBefore" : 0,

570+ "bearerOnly" : false,

571+ "consentRequired" : false,

572+ "standardFlowEnabled" : true,

573+ "implicitFlowEnabled" : false,

574+ "directAccessGrantsEnabled" : false,

575+ "serviceAccountsEnabled" : false,

576+ "publicClient" : true,

577+ "frontchannelLogout" : false,

578+ "protocol" : "openid-connect",

579+ "attributes" : {

580+ "pkce.code.challenge.method" : "S256"

581+ },

582+ "authenticationFlowBindingOverrides" : { },

583+ "fullScopeAllowed" : false,

584+ "nodeReRegistrationTimeout" : 0,

585+ "protocolMappers" : [ {

586+ "id" : "5885b0d3-a917-4b52-8380-f37d0754a2ef",

587+ "name" : "locale",

588+ "protocol" : "openid-connect",

589+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

590+ "consentRequired" : false,

591+ "config" : {

592+ "userinfo.token.claim" : "true",

593+ "user.attribute" : "locale",

594+ "id.token.claim" : "true",

595+ "access.token.claim" : "true",

596+ "claim.name" : "locale",

597+ "jsonType.label" : "String"

598+ }

599+ } ],

600+ "defaultClientScopes" : [ "web-origins", "role_list", "roles", "profile", "email" ],

601+ "optionalClientScopes" : [ "address", "phone", "offline_access", "microprofile-jwt" ]

602+ } ],

603+ "clientScopes" : [ {

604+ "id" : "47ea3b67-4f0c-4c7e-8ac6-a33a3d655894",

605+ "name" : "address",

606+ "description" : "OpenID Connect built-in scope: address",

607+ "protocol" : "openid-connect",

608+ "attributes" : {

609+ "include.in.token.scope" : "true",

610+ "display.on.consent.screen" : "true",

611+ "consent.screen.text" : "${addressScopeConsentText}"

612+ },

613+ "protocolMappers" : [ {

614+ "id" : "4be0ca19-0ec7-4cc1-b263-845ea539ff12",

615+ "name" : "address",

616+ "protocol" : "openid-connect",

617+ "protocolMapper" : "oidc-address-mapper",

618+ "consentRequired" : false,

619+ "config" : {

620+ "user.attribute.formatted" : "formatted",

621+ "user.attribute.country" : "country",

622+ "user.attribute.postal_code" : "postal_code",

623+ "userinfo.token.claim" : "true",

624+ "user.attribute.street" : "street",

625+ "id.token.claim" : "true",

626+ "user.attribute.region" : "region",

627+ "access.token.claim" : "true",

628+ "user.attribute.locality" : "locality"

629+ }

630+ } ]

631+ }, {

632+ "id" : "aba72e57-540f-4825-95b7-2d143be028cc",

633+ "name" : "email",

634+ "description" : "OpenID Connect built-in scope: email",

635+ "protocol" : "openid-connect",

636+ "attributes" : {

637+ "include.in.token.scope" : "true",

638+ "display.on.consent.screen" : "true",

639+ "consent.screen.text" : "${emailScopeConsentText}"

640+ },

641+ "protocolMappers" : [ {

642+ "id" : "7fe82724-5748-4b6d-9708-a028f5d3b970",

643+ "name" : "email verified",

644+ "protocol" : "openid-connect",

645+ "protocolMapper" : "oidc-usermodel-property-mapper",

646+ "consentRequired" : false,

647+ "config" : {

648+ "userinfo.token.claim" : "true",

649+ "user.attribute" : "emailVerified",

650+ "id.token.claim" : "true",

651+ "access.token.claim" : "true",

652+ "claim.name" : "email_verified",

653+ "jsonType.label" : "boolean"

654+ }

655+ }, {

656+ "id" : "e42f334e-cfae-44a0-905d-c3ef215feaae",

657+ "name" : "email",

658+ "protocol" : "openid-connect",

659+ "protocolMapper" : "oidc-usermodel-property-mapper",

660+ "consentRequired" : false,

661+ "config" : {

662+ "userinfo.token.claim" : "true",

663+ "user.attribute" : "email",

664+ "id.token.claim" : "true",

665+ "access.token.claim" : "true",

666+ "claim.name" : "email",

667+ "jsonType.label" : "String"

668+ }

669+ } ]

670+ }, {

671+ "id" : "ec765598-bd71-4318-86c3-b3f81a41c99e",

672+ "name" : "microprofile-jwt",

673+ "description" : "Microprofile - JWT built-in scope",

674+ "protocol" : "openid-connect",

675+ "attributes" : {

676+ "include.in.token.scope" : "true",

677+ "display.on.consent.screen" : "false"

678+ },

679+ "protocolMappers" : [ {

680+ "id" : "90694036-4014-4672-a2c8-c68319e9308a",

681+ "name" : "upn",

682+ "protocol" : "openid-connect",

683+ "protocolMapper" : "oidc-usermodel-property-mapper",

684+ "consentRequired" : false,

685+ "config" : {

686+ "userinfo.token.claim" : "true",

687+ "user.attribute" : "username",

688+ "id.token.claim" : "true",

689+ "access.token.claim" : "true",

690+ "claim.name" : "upn",

691+ "jsonType.label" : "String"

692+ }

693+ }, {

694+ "id" : "f7b0fcc0-6139-4158-ac45-34fd9a58a5ef",

695+ "name" : "groups",

696+ "protocol" : "openid-connect",

697+ "protocolMapper" : "oidc-usermodel-realm-role-mapper",

698+ "consentRequired" : false,

699+ "config" : {

700+ "multivalued" : "true",

701+ "user.attribute" : "foo",

702+ "id.token.claim" : "true",

703+ "access.token.claim" : "true",

704+ "claim.name" : "groups",

705+ "jsonType.label" : "String"

706+ }

707+ } ]

708+ }, {

709+ "id" : "8a09267b-3634-4a9c-baab-6f2fb4137347",

710+ "name" : "offline_access",

711+ "description" : "OpenID Connect built-in scope: offline_access",

712+ "protocol" : "openid-connect",

713+ "attributes" : {

714+ "consent.screen.text" : "${offlineAccessScopeConsentText}",

715+ "display.on.consent.screen" : "true"

716+ }

717+ }, {

718+ "id" : "3a48c5dd-33a8-4be0-9d2e-30fd7f98363a",

719+ "name" : "phone",

720+ "description" : "OpenID Connect built-in scope: phone",

721+ "protocol" : "openid-connect",

722+ "attributes" : {

723+ "include.in.token.scope" : "true",

724+ "display.on.consent.screen" : "true",

725+ "consent.screen.text" : "${phoneScopeConsentText}"

726+ },

727+ "protocolMappers" : [ {

728+ "id" : "5427d1b4-ba79-412a-b23c-da640a98980c",

729+ "name" : "phone number",

730+ "protocol" : "openid-connect",

731+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

732+ "consentRequired" : false,

733+ "config" : {

734+ "userinfo.token.claim" : "true",

735+ "user.attribute" : "phoneNumber",

736+ "id.token.claim" : "true",

737+ "access.token.claim" : "true",

738+ "claim.name" : "phone_number",

739+ "jsonType.label" : "String"

740+ }

741+ }, {

742+ "id" : "31d4a53f-6503-40e8-bd9d-79a7c46c4fbe",

743+ "name" : "phone number verified",

744+ "protocol" : "openid-connect",

745+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

746+ "consentRequired" : false,

747+ "config" : {

748+ "userinfo.token.claim" : "true",

749+ "user.attribute" : "phoneNumberVerified",

750+ "id.token.claim" : "true",

751+ "access.token.claim" : "true",

752+ "claim.name" : "phone_number_verified",

753+ "jsonType.label" : "boolean"

754+ }

755+ } ]

756+ }, {

757+ "id" : "5921a9e9-7fec-4471-95e3-dd96eebdec58",

758+ "name" : "profile",

759+ "description" : "OpenID Connect built-in scope: profile",

760+ "protocol" : "openid-connect",

761+ "attributes" : {

762+ "include.in.token.scope" : "true",

763+ "display.on.consent.screen" : "true",

764+ "consent.screen.text" : "${profileScopeConsentText}"

765+ },

766+ "protocolMappers" : [ {

767+ "id" : "4fa92092-ee0d-4dc7-a63b-1e3b02d35ebb",

768+ "name" : "zoneinfo",

769+ "protocol" : "openid-connect",

770+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

771+ "consentRequired" : false,

772+ "config" : {

773+ "userinfo.token.claim" : "true",

774+ "user.attribute" : "zoneinfo",

775+ "id.token.claim" : "true",

776+ "access.token.claim" : "true",

777+ "claim.name" : "zoneinfo",

778+ "jsonType.label" : "String"

779+ }

780+ }, {

781+ "id" : "1a5cc2e2-c983-4150-8583-23a7f5c826bf",

782+ "name" : "family name",

783+ "protocol" : "openid-connect",

784+ "protocolMapper" : "oidc-usermodel-property-mapper",

785+ "consentRequired" : false,

786+ "config" : {

787+ "userinfo.token.claim" : "true",

788+ "user.attribute" : "lastName",

789+ "id.token.claim" : "true",

790+ "access.token.claim" : "true",

791+ "claim.name" : "family_name",

792+ "jsonType.label" : "String"

793+ }

794+ }, {

795+ "id" : "67931f77-722a-492d-b581-a953e26b7d44",

796+ "name" : "full name",

797+ "protocol" : "openid-connect",

798+ "protocolMapper" : "oidc-full-name-mapper",

799+ "consentRequired" : false,

800+ "config" : {

801+ "id.token.claim" : "true",

802+ "access.token.claim" : "true",

803+ "userinfo.token.claim" : "true"

804+ }

805+ }, {

806+ "id" : "10f6ac36-3a63-4e1c-ac69-c095588f5967",

807+ "name" : "locale",

808+ "protocol" : "openid-connect",

809+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

810+ "consentRequired" : false,

811+ "config" : {

812+ "userinfo.token.claim" : "true",

813+ "user.attribute" : "locale",

814+ "id.token.claim" : "true",

815+ "access.token.claim" : "true",

816+ "claim.name" : "locale",

817+ "jsonType.label" : "String"

818+ }

819+ }, {

820+ "id" : "205d9dce-b6c8-4b1d-9c9c-fa24788651cf",

821+ "name" : "picture",

822+ "protocol" : "openid-connect",

823+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

824+ "consentRequired" : false,

825+ "config" : {

826+ "userinfo.token.claim" : "true",

827+ "user.attribute" : "picture",

828+ "id.token.claim" : "true",

829+ "access.token.claim" : "true",

830+ "claim.name" : "picture",

831+ "jsonType.label" : "String"

832+ }

833+ }, {

834+ "id" : "638216c8-ea8c-40e3-9429-771e9278920e",

835+ "name" : "gender",

836+ "protocol" : "openid-connect",

837+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

838+ "consentRequired" : false,

839+ "config" : {

840+ "userinfo.token.claim" : "true",

841+ "user.attribute" : "gender",

842+ "id.token.claim" : "true",

843+ "access.token.claim" : "true",

844+ "claim.name" : "gender",

845+ "jsonType.label" : "String"

846+ }

847+ }, {

848+ "id" : "39c17eae-8ea7-422c-ae21-b8876bf12184",

849+ "name" : "birthdate",

850+ "protocol" : "openid-connect",

851+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

852+ "consentRequired" : false,

853+ "config" : {

854+ "userinfo.token.claim" : "true",

855+ "user.attribute" : "birthdate",

856+ "id.token.claim" : "true",

857+ "access.token.claim" : "true",

858+ "claim.name" : "birthdate",

859+ "jsonType.label" : "String"

860+ }

861+ }, {

862+ "id" : "01c559cf-94f2-46ad-b965-3b2e1db1a2a6",

863+ "name" : "updated at",

864+ "protocol" : "openid-connect",

865+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

866+ "consentRequired" : false,

867+ "config" : {

868+ "userinfo.token.claim" : "true",

869+ "user.attribute" : "updatedAt",

870+ "id.token.claim" : "true",

871+ "access.token.claim" : "true",

872+ "claim.name" : "updated_at",

873+ "jsonType.label" : "String"

874+ }

875+ }, {

876+ "id" : "1693b5ab-28eb-485d-835d-2ae070ccb3ba",

877+ "name" : "profile",

878+ "protocol" : "openid-connect",

879+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

880+ "consentRequired" : false,

881+ "config" : {

882+ "userinfo.token.claim" : "true",

883+ "user.attribute" : "profile",

884+ "id.token.claim" : "true",

885+ "access.token.claim" : "true",

886+ "claim.name" : "profile",

887+ "jsonType.label" : "String"

888+ }

889+ }, {

890+ "id" : "a0e08332-954c-46d2-9795-56eb31132580",

891+ "name" : "given name",

892+ "protocol" : "openid-connect",

893+ "protocolMapper" : "oidc-usermodel-property-mapper",

894+ "consentRequired" : false,

895+ "config" : {

896+ "userinfo.token.claim" : "true",

897+ "user.attribute" : "firstName",

898+ "id.token.claim" : "true",

899+ "access.token.claim" : "true",

900+ "claim.name" : "given_name",

901+ "jsonType.label" : "String"

902+ }

903+ }, {

904+ "id" : "cea0cd9c-d085-4d19-acc3-4bb41c891b68",

905+ "name" : "nickname",

906+ "protocol" : "openid-connect",

907+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

908+ "consentRequired" : false,

909+ "config" : {

910+ "userinfo.token.claim" : "true",

911+ "user.attribute" : "nickname",

912+ "id.token.claim" : "true",

913+ "access.token.claim" : "true",

914+ "claim.name" : "nickname",

915+ "jsonType.label" : "String"

916+ }

917+ }, {

918+ "id" : "3122097d-4cba-46c2-8b3b-5d87a4cc605e",

919+ "name" : "middle name",

920+ "protocol" : "openid-connect",

921+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

922+ "consentRequired" : false,

923+ "config" : {

924+ "userinfo.token.claim" : "true",

925+ "user.attribute" : "middleName",

926+ "id.token.claim" : "true",

927+ "access.token.claim" : "true",

928+ "claim.name" : "middle_name",

929+ "jsonType.label" : "String"

930+ }

931+ }, {

932+ "id" : "a3b97897-d913-4e0a-a4cf-033ce78f7d24",

933+ "name" : "username",

934+ "protocol" : "openid-connect",

935+ "protocolMapper" : "oidc-usermodel-property-mapper",

936+ "consentRequired" : false,

937+ "config" : {

938+ "userinfo.token.claim" : "true",

939+ "user.attribute" : "username",

940+ "id.token.claim" : "true",

941+ "access.token.claim" : "true",

942+ "claim.name" : "preferred_username",

943+ "jsonType.label" : "String"

944+ }

945+ }, {

946+ "id" : "a44eeb9d-410d-49c5-b0e0-5d84787627ad",

947+ "name" : "website",

948+ "protocol" : "openid-connect",

949+ "protocolMapper" : "oidc-usermodel-attribute-mapper",

950+ "consentRequired" : false,

951+ "config" : {

952+ "userinfo.token.claim" : "true",

953+ "user.attribute" : "website",

954+ "id.token.claim" : "true",

955+ "access.token.claim" : "true",

956+ "claim.name" : "website",

957+ "jsonType.label" : "String"

958+ }

959+ } ]

960+ }, {

961+ "id" : "651408a7-6704-4198-a60f-988821b633ea",

962+ "name" : "role_list",

963+ "description" : "SAML role list",

964+ "protocol" : "saml",

965+ "attributes" : {

966+ "consent.screen.text" : "${samlRoleListScopeConsentText}",

967+ "display.on.consent.screen" : "true"

968+ },

969+ "protocolMappers" : [ {

970+ "id" : "a8c56c7b-ccbc-4b01-8df5-3ecb6328755f",

971+ "name" : "role list",

972+ "protocol" : "saml",

973+ "protocolMapper" : "saml-role-list-mapper",

974+ "consentRequired" : false,

975+ "config" : {

976+ "single" : "false",

977+ "attribute.nameformat" : "Basic",

978+ "attribute.name" : "Role"

979+ }

980+ } ]

981+ }, {

982+ "id" : "13ec0fd3-e64a-4d6f-9be7-c8760f2c9d6b",

983+ "name" : "roles",

984+ "description" : "OpenID Connect scope for add user roles to the access token",

985+ "protocol" : "openid-connect",

986+ "attributes" : {

987+ "include.in.token.scope" : "false",

988+ "display.on.consent.screen" : "true",

989+ "consent.screen.text" : "${rolesScopeConsentText}"

990+ },

991+ "protocolMappers" : [ {

992+ "id" : "75e741f8-dcd5-49d2-815e-8604ec1d08a1",

993+ "name" : "realm roles",

994+ "protocol" : "openid-connect",

995+ "protocolMapper" : "oidc-usermodel-realm-role-mapper",

996+ "consentRequired" : false,

997+ "config" : {

998+ "user.attribute" : "foo",

999+ "access.token.claim" : "true",

1000+ "claim.name" : "realm_access.roles",

1001+ "jsonType.label" : "String",

1002+ "multivalued" : "true"

1003+ }

1004+ }, {

1005+ "id" : "06a2d506-4996-4a33-8c43-2cf64af6a630",

1006+ "name" : "client roles",

1007+ "protocol" : "openid-connect",

1008+ "protocolMapper" : "oidc-usermodel-client-role-mapper",

1009+ "consentRequired" : false,

1010+ "config" : {

1011+ "user.attribute" : "foo",

1012+ "access.token.claim" : "true",

1013+ "claim.name" : "resource_access.${client_id}.roles",

1014+ "jsonType.label" : "String",

1015+ "multivalued" : "true"

1016+ }

1017+ }, {

1018+ "id" : "3c3470df-d414-4e1c-87fc-3fb3cea34b8d",

1019+ "name" : "audience resolve",

1020+ "protocol" : "openid-connect",

1021+ "protocolMapper" : "oidc-audience-resolve-mapper",

1022+ "consentRequired" : false,

1023+ "config" : { }

1024+ } ]

1025+ }, {

1026+ "id" : "d85aba25-c74b-49e3-9ccb-77b4bb16efa5",

1027+ "name" : "web-origins",

1028+ "description" : "OpenID Connect scope for add allowed web origins to the access token",

1029+ "protocol" : "openid-connect",

1030+ "attributes" : {

1031+ "include.in.token.scope" : "false",

1032+ "display.on.consent.screen" : "false",

1033+ "consent.screen.text" : ""

1034+ },

1035+ "protocolMappers" : [ {

1036+ "id" : "86b3f64f-1525-4500-bcbc-9b889b25f995",

1037+ "name" : "allowed web origins",

1038+ "protocol" : "openid-connect",

1039+ "protocolMapper" : "oidc-allowed-origins-mapper",

1040+ "consentRequired" : false,

1041+ "config" : { }

1042+ } ]

1043+ } ],

1044+ "defaultDefaultClientScopes" : [ "roles", "profile", "role_list", "email", "web-origins" ],

1045+ "defaultOptionalClientScopes" : [ "phone", "address", "offline_access", "microprofile-jwt" ],

1046+ "browserSecurityHeaders" : {

1047+ "contentSecurityPolicyReportOnly" : "",

1048+ "xContentTypeOptions" : "nosniff",

1049+ "xRobotsTag" : "none",

1050+ "xFrameOptions" : "SAMEORIGIN",

1051+ "xXSSProtection" : "1; mode=block",

1052+ "contentSecurityPolicy" : "frame-src 'self'; frame-ancestors 'self'; object-src 'none';",

1053+ "strictTransportSecurity" : "max-age=31536000; includeSubDomains"

1054+ },

1055+ "smtpServer" : { },

1056+ "eventsEnabled" : false,

1057+ "eventsListeners" : [ "jboss-logging" ],

1058+ "enabledEventTypes" : [ ],

1059+ "adminEventsEnabled" : false,

1060+ "adminEventsDetailsEnabled" : false,

1061+ "components" : {

1062+ "org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy" : [ {

1063+ "id" : "59048b39-ad0f-4d12-8c52-7cfc2c43278a",

1064+ "name" : "Allowed Protocol Mapper Types",

1065+ "providerId" : "allowed-protocol-mappers",

1066+ "subType" : "authenticated",

1067+ "subComponents" : { },

1068+ "config" : {

1069+ "allowed-protocol-mapper-types" : [ "saml-user-attribute-mapper", "oidc-full-name-mapper", "oidc-sha256-pairwise-sub-mapper", "saml-user-property-mapper", "saml-role-list-mapper", "oidc-address-mapper", "oidc-usermodel-attribute-mapper", "oidc-usermodel-property-mapper" ]

1070+ }

1071+ }, {

1072+ "id" : "760559a6-a59f-4175-9ac5-6f3612e20129",

1073+ "name" : "Trusted Hosts",

1074+ "providerId" : "trusted-hosts",

1075+ "subType" : "anonymous",

1076+ "subComponents" : { },

1077+ "config" : {

1078+ "host-sending-registration-request-must-match" : [ "true" ],

1079+ "client-uris-must-match" : [ "true" ]

1080+ }

1081+ }, {

1082+ "id" : "24f4cb42-76bd-499e-812a-4e0d270c9e13",

1083+ "name" : "Full Scope Disabled",

1084+ "providerId" : "scope",

1085+ "subType" : "anonymous",

1086+ "subComponents" : { },

1087+ "config" : { }

1088+ }, {

1089+ "id" : "abbfc599-480a-44ef-8e33-73a83eaab166",

1090+ "name" : "Allowed Protocol Mapper Types",

1091+ "providerId" : "allowed-protocol-mappers",

1092+ "subType" : "anonymous",

1093+ "subComponents" : { },

1094+ "config" : {

1095+ "allowed-protocol-mapper-types" : [ "saml-user-attribute-mapper", "oidc-sha256-pairwise-sub-mapper", "oidc-full-name-mapper", "saml-role-list-mapper", "saml-user-property-mapper", "oidc-usermodel-property-mapper", "oidc-usermodel-attribute-mapper", "oidc-address-mapper" ]

1096+ }

1097+ }, {

1098+ "id" : "3c6450f0-4521-402b-a247-c8165854b1fa",

1099+ "name" : "Allowed Client Scopes",

1100+ "providerId" : "allowed-client-templates",

1101+ "subType" : "anonymous",

1102+ "subComponents" : { },

1103+ "config" : {

1104+ "allow-default-scopes" : [ "true" ]

1105+ }

1106+ }, {

1107+ "id" : "d9b64399-744b-498e-9d35-f68b1582bd7d",

1108+ "name" : "Consent Required",

1109+ "providerId" : "consent-required",

1110+ "subType" : "anonymous",

1111+ "subComponents" : { },

1112+ "config" : { }

1113+ }, {

1114+ "id" : "22f15f1f-3116-4348-a1e5-fc0d7576452a",

1115+ "name" : "Max Clients Limit",

1116+ "providerId" : "max-clients",

1117+ "subType" : "anonymous",

1118+ "subComponents" : { },

1119+ "config" : {

1120+ "max-clients" : [ "200" ]

1121+ }

1122+ }, {

1123+ "id" : "4ad7b291-ddbb-4674-8c3d-ab8fd76d4168",

1124+ "name" : "Allowed Client Scopes",

1125+ "providerId" : "allowed-client-templates",

1126+ "subType" : "authenticated",

1127+ "subComponents" : { },

1128+ "config" : {

1129+ "allow-default-scopes" : [ "true" ]

1130+ }

1131+ } ],

1132+ "org.keycloak.keys.KeyProvider" : [ {

1133+ "id" : "f71cc325-9907-4d27-a0e6-88fca7450e5e",

1134+ "name" : "aes-generated",

1135+ "providerId" : "aes-generated",

1136+ "subComponents" : { },

1137+ "config" : {

1138+ "kid" : [ "6c7d982e-372f-49c6-a4f3-5c451fb85eca" ],

1139+ "secret" : [ "yH6M3W7aOgh2_cKJ0srWbw" ],

1140+ "priority" : [ "100" ]

1141+ }

1142+ }, {

1143+ "id" : "7b50d0ab-dda5-4624-aa42-b4b397724ce1",

1144+ "name" : "hmac-generated",

1145+ "providerId" : "hmac-generated",

1146+ "subComponents" : { },

1147+ "config" : {

1148+ "kid" : [ "587f0fb5-845d-4b45-87a0-84145092aaef" ],

1149+ "secret" : [ "PuH8Lxh9GeNfGJRDk34SWIlBDdrJpC3U3SfcxqqQtlIf2DBzRKUu8VbDVrmMN5b5CoPsJhrQ2SVb-iE9Lzsb3A" ],

1150+ "priority" : [ "100" ],

1151+ "algorithm" : [ "HS256" ]

1152+ }

1153+ }, {

1154+ "id" : "547c1c71-9f97-4e12-801b-ed5c2cc61bba",

1155+ "name" : "rsa-generated",

1156+ "providerId" : "rsa-generated",

1157+ "subComponents" : { },

1158+ "config" : {

1159+ "privateKey" : [ "MIIEowIBAAKCAQEAjdo2HZ5ruNnIbkSeAfFYpbPvJw3vtz/VuKJerC4mUXYd7qRMhs3VLJZ3mFyeCuO8W81vkGrFiC9KQnX2lHj2dtA/RWEJw5bpz+JdOFr5pvXg0lQ0sa+hro9afWDygTU4FmLsEi5z98847TbH178RT6n7+JVqZ9jYU9rSpwVTC8E/4yxSuStmhGCcAkZ6dGhHNBdvGUgwxKYj7dYLRJiI+nilIdKuxPzxI/YZxZnXBHDdbNXJgDymTQPut99OnBxeZbH38CJ1MNo3VdV1fzOMGUHe+vn/EOD5E+pXC8PwvJnWU+XHUTFVZeyIXehh3pYLUsq/6bZ1MYsEaFIhznOkwwIDAQABAoIBAHB+64fVyUxRurhoRn737fuLlU/9p2xGfbHtYvNdrhnQeLB3MBGAT10K/1Gfsd6k+Q49AAsiAgGcr2HBt4nL3HohcOwOpvWsS0UIGjHFRFP6jw9+pEN+K9UJ7xObvPZnRFHMpbdNi76tYlINrbMV3h61ihR8OmSc/gKSeZjnihK5OkaNnlqGRaBM/koI+iAxUHuJPnBLBZmD4T8eIfE4S2TvUeVeQogI9Muvnb9tIPJ5XyP9iXWLdRjnek/+wTdxHHZuo06Tc0bMjRaTHiF6K9ntOM2EmQb6bS2J47zgzRLNFE22BWH7RJq659EzElkOn0C0k7dWDTur/3Lpx1+zxJECgYEA8t+J3J+9oGTFmY2VPH05Yr/R/iVDOyIOlO1CmgonOQ3KPhbfNBB3aTAJP20LOZChN4JoWuiZJg4UwzXOeY9DvdDkPO0YLlSjPAIwJNk+xcxFcp5hqMUul2db+cgEY8zp0Wg9kFOq3JmJjK4+1+fgsVnOB+B08ZYI6bZzsUVKzucCgYEAlYTrsxs6fQua0cvZNQPYNZzwF3LVwPBl/ntkdRBE3HGyZeCAhIj7e9pAUusCPsQJaCmW2UEmywD/aIxGrBkojzTKItshM3PN1PYKL8W0Zq+H67uF5KfdvsbabZWHfP/LGCpoKF8Ov7JVPPqGrZ03Z2SheeLZAtNeHN4OB1u9i8UCgYATkS7qN3Rvl67T0DRVy0D0U7/3Wckw2m2SUgsrneXLEvFYTz9sUmdMcjJMidx9pslWT4tYx6SPDFNf5tXbtU8f29SHlBJ+qRL9oq9+SIJmLS7rLRdxIXG/gPRIC3VPFRNBa8SJ/DOn0jbivqcRffz8TN/sgojpbc0KB0kK3ypHwQKBgCKVCcb1R0PgyUA4+9YNO5a647UotFPZxl1jwMpqpuKt0WtKz67X2AK/ah1DidNmmB5lcCRzsztE0c4mk7n+X6kvtoj1UeqKoFLfTV/bRGxzsOZPCxrl0J3tdFvgN+QrbZf7Rvf/dHPWFWzzLO8+66+YUNjWJQdIR/45Rdlh2KdZAoGBAMfF3ir+fe3KdQ6hAf9QyrLxJ5l+GO+IgtxXGbon7eeJBIZHHdMeDy4pC7DMcI214BmIntbyY+xS+gI3oM26EJUVmrZ6tkyIDFsCHm9rcXG9ogvffzQWM1Wqzm27hR/3s+EPWW9AOcIimiFV1UPp/mLjnrCuq58V2aJS/TT14oLe" ],

1160+ "certificate" : [ "MIICmzCCAYMCBgFygL/j4DANBgkqhkiG9w0BAQsFADARMQ8wDQYDVQQDDAZtYXN0ZXIwHhcNMjAwNjA0MTkxMDU4WhcNMzAwNjA0MTkxMjM4WjARMQ8wDQYDVQQDDAZtYXN0ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCN2jYdnmu42chuRJ4B8Vils+8nDe+3P9W4ol6sLiZRdh3upEyGzdUslneYXJ4K47xbzW+QasWIL0pCdfaUePZ20D9FYQnDlunP4l04Wvmm9eDSVDSxr6Guj1p9YPKBNTgWYuwSLnP3zzjtNsfXvxFPqfv4lWpn2NhT2tKnBVMLwT/jLFK5K2aEYJwCRnp0aEc0F28ZSDDEpiPt1gtEmIj6eKUh0q7E/PEj9hnFmdcEcN1s1cmAPKZNA+63306cHF5lsffwInUw2jdV1XV/M4wZQd76+f8Q4PkT6lcLw/C8mdZT5cdRMVVl7Ihd6GHelgtSyr/ptnUxiwRoUiHOc6TDAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAIAqydMYxa51kNEyfXyR2kStlglE4LDeLBLHDABeBPE0eN2awoH/mw3kXS4OA/C0e3c7bAwViOzOVERGeUNiBvP5rL1Amuu97nwFcxhkTaJH4ZwCGkxceaIo9LNDpAEesqHLQSdplFXIA4TbEFoKMem4k31KVU7i9/rUesrSRmxLptIOK7LLvRMYiY/t7tdAvoZAtoliuQlFKQywEuxXQrCkcoVEAARABWGt0rsWC2xK0tVxHRIrENwvMp/aUYd17sZ0403aaS9dlvfQ63ExnaHd+++RJtPku8P220Tw27YVmFAwzJgS0aUpEaDsgRNz6OMSyxEg/n7eKK08aU3szwQ=" ],

1161+ "priority" : [ "100" ]

1162+ }

1163+ } ]

1164+ },

1165+ "internationalizationEnabled" : false,

1166+ "supportedLocales" : [ ],

1167+ "authenticationFlows" : [ {

1168+ "id" : "3253f9b7-905d-4458-ad8a-8ada5e16d195",

1169+ "alias" : "Account verification options",

1170+ "description" : "Method with which to verity the existing account",

1171+ "providerId" : "basic-flow",

1172+ "topLevel" : false,

1173+ "builtIn" : true,

1174+ "authenticationExecutions" : [ {

1175+ "authenticator" : "idp-email-verification",

1176+ "requirement" : "ALTERNATIVE",

1177+ "priority" : 10,

1178+ "userSetupAllowed" : false,

1179+ "autheticatorFlow" : false

1180+ }, {

1181+ "requirement" : "ALTERNATIVE",

1182+ "priority" : 20,

1183+ "flowAlias" : "Verify Existing Account by Re-authentication",

1184+ "userSetupAllowed" : false,

1185+ "autheticatorFlow" : true

1186+ } ]

1187+ }, {

1188+ "id" : "75bd854e-ab99-46f1-90ed-a8bfc1559558",

1189+ "alias" : "Authentication Options",

1190+ "description" : "Authentication options.",

1191+ "providerId" : "basic-flow",

1192+ "topLevel" : false,

1193+ "builtIn" : true,

1194+ "authenticationExecutions" : [ {

1195+ "authenticator" : "basic-auth",

1196+ "requirement" : "REQUIRED",

1197+ "priority" : 10,

1198+ "userSetupAllowed" : false,

1199+ "autheticatorFlow" : false

1200+ }, {

1201+ "authenticator" : "basic-auth-otp",

1202+ "requirement" : "DISABLED",

1203+ "priority" : 20,

1204+ "userSetupAllowed" : false,

1205+ "autheticatorFlow" : false

1206+ }, {

1207+ "authenticator" : "auth-spnego",

1208+ "requirement" : "DISABLED",

1209+ "priority" : 30,

1210+ "userSetupAllowed" : false,

1211+ "autheticatorFlow" : false

1212+ } ]

1213+ }, {

1214+ "id" : "9b0e6cce-62c5-4fb6-a48d-e07c950e38c3",

1215+ "alias" : "Browser - Conditional OTP",

1216+ "description" : "Flow to determine if the OTP is required for the authentication",

1217+ "providerId" : "basic-flow",

1218+ "topLevel" : false,

1219+ "builtIn" : true,

1220+ "authenticationExecutions" : [ {

1221+ "authenticator" : "conditional-user-configured",

1222+ "requirement" : "REQUIRED",

1223+ "priority" : 10,

1224+ "userSetupAllowed" : false,

1225+ "autheticatorFlow" : false

1226+ }, {

1227+ "authenticator" : "auth-otp-form",

1228+ "requirement" : "REQUIRED",

1229+ "priority" : 20,

1230+ "userSetupAllowed" : false,

1231+ "autheticatorFlow" : false

1232+ } ]

1233+ }, {

1234+ "id" : "1c26fd14-ac06-4dc1-bdd8-8c34c1b41720",

1235+ "alias" : "Direct Grant - Conditional OTP",

1236+ "description" : "Flow to determine if the OTP is required for the authentication",

1237+ "providerId" : "basic-flow",

1238+ "topLevel" : false,

1239+ "builtIn" : true,

1240+ "authenticationExecutions" : [ {

1241+ "authenticator" : "conditional-user-configured",

1242+ "requirement" : "REQUIRED",

1243+ "priority" : 10,

1244+ "userSetupAllowed" : false,

1245+ "autheticatorFlow" : false

1246+ }, {

1247+ "authenticator" : "direct-grant-validate-otp",

1248+ "requirement" : "REQUIRED",

1249+ "priority" : 20,

1250+ "userSetupAllowed" : false,

1251+ "autheticatorFlow" : false

1252+ } ]

1253+ }, {

1254+ "id" : "254f7549-51ec-4565-a736-35c07b6e25f0",

1255+ "alias" : "First broker login - Conditional OTP",

1256+ "description" : "Flow to determine if the OTP is required for the authentication",

1257+ "providerId" : "basic-flow",

1258+ "topLevel" : false,

1259+ "builtIn" : true,

1260+ "authenticationExecutions" : [ {

1261+ "authenticator" : "conditional-user-configured",

1262+ "requirement" : "REQUIRED",

1263+ "priority" : 10,

1264+ "userSetupAllowed" : false,

1265+ "autheticatorFlow" : false

1266+ }, {

1267+ "authenticator" : "auth-otp-form",

1268+ "requirement" : "REQUIRED",

1269+ "priority" : 20,

1270+ "userSetupAllowed" : false,

1271+ "autheticatorFlow" : false

1272+ } ]

1273+ }, {

1274+ "id" : "b2413da8-3de9-4bfe-b77e-643fd1964c8f",

1275+ "alias" : "Handle Existing Account",

1276+ "description" : "Handle what to do if there is existing account with same email/username like authenticated identity provider",

1277+ "providerId" : "basic-flow",

1278+ "topLevel" : false,

1279+ "builtIn" : true,

1280+ "authenticationExecutions" : [ {

1281+ "authenticator" : "idp-confirm-link",

1282+ "requirement" : "REQUIRED",

1283+ "priority" : 10,

1284+ "userSetupAllowed" : false,

1285+ "autheticatorFlow" : false

1286+ }, {

1287+ "requirement" : "REQUIRED",

1288+ "priority" : 20,

1289+ "flowAlias" : "Account verification options",

1290+ "userSetupAllowed" : false,

1291+ "autheticatorFlow" : true

1292+ } ]

1293+ }, {

1294+ "id" : "f8392bfb-8dce-4a16-8af1-b2a4d1a0a273",

1295+ "alias" : "Reset - Conditional OTP",

1296+ "description" : "Flow to determine if the OTP should be reset or not. Set to REQUIRED to force.",

1297+ "providerId" : "basic-flow",

1298+ "topLevel" : false,

1299+ "builtIn" : true,

1300+ "authenticationExecutions" : [ {

1301+ "authenticator" : "conditional-user-configured",

1302+ "requirement" : "REQUIRED",

1303+ "priority" : 10,

1304+ "userSetupAllowed" : false,

1305+ "autheticatorFlow" : false

1306+ }, {

1307+ "authenticator" : "reset-otp",

1308+ "requirement" : "REQUIRED",

1309+ "priority" : 20,

1310+ "userSetupAllowed" : false,

1311+ "autheticatorFlow" : false

1312+ } ]

1313+ }, {

1314+ "id" : "fb69c297-b26e-44fa-aabd-d7b40eec3cd3",

1315+ "alias" : "User creation or linking",

1316+ "description" : "Flow for the existing/non-existing user alternatives",

1317+ "providerId" : "basic-flow",

1318+ "topLevel" : false,

1319+ "builtIn" : true,

1320+ "authenticationExecutions" : [ {

1321+ "authenticatorConfig" : "create unique user config",

1322+ "authenticator" : "idp-create-user-if-unique",

1323+ "requirement" : "ALTERNATIVE",

1324+ "priority" : 10,

1325+ "userSetupAllowed" : false,

1326+ "autheticatorFlow" : false

1327+ }, {

1328+ "requirement" : "ALTERNATIVE",

1329+ "priority" : 20,

1330+ "flowAlias" : "Handle Existing Account",

1331+ "userSetupAllowed" : false,

1332+ "autheticatorFlow" : true

1333+ } ]

1334+ }, {

1335+ "id" : "de3a41a9-7018-4931-9c4d-d04f9501b2ce",

1336+ "alias" : "Verify Existing Account by Re-authentication",

1337+ "description" : "Reauthentication of existing account",

1338+ "providerId" : "basic-flow",

1339+ "topLevel" : false,

1340+ "builtIn" : true,

1341+ "authenticationExecutions" : [ {

1342+ "authenticator" : "idp-username-password-form",

1343+ "requirement" : "REQUIRED",

1344+ "priority" : 10,

1345+ "userSetupAllowed" : false,

1346+ "autheticatorFlow" : false

1347+ }, {

1348+ "requirement" : "CONDITIONAL",

1349+ "priority" : 20,

1350+ "flowAlias" : "First broker login - Conditional OTP",

1351+ "userSetupAllowed" : false,

1352+ "autheticatorFlow" : true

1353+ } ]

1354+ }, {

1355+ "id" : "6526b0d1-b48e-46c6-bb08-11ebcf458def",

1356+ "alias" : "browser",

1357+ "description" : "browser based authentication",

1358+ "providerId" : "basic-flow",

1359+ "topLevel" : true,

1360+ "builtIn" : true,

1361+ "authenticationExecutions" : [ {

1362+ "authenticator" : "auth-cookie",

1363+ "requirement" : "ALTERNATIVE",

1364+ "priority" : 10,

1365+ "userSetupAllowed" : false,

1366+ "autheticatorFlow" : false

1367+ }, {

1368+ "authenticator" : "auth-spnego",

1369+ "requirement" : "DISABLED",

1370+ "priority" : 20,

1371+ "userSetupAllowed" : false,

1372+ "autheticatorFlow" : false

1373+ }, {

1374+ "authenticator" : "identity-provider-redirector",

1375+ "requirement" : "ALTERNATIVE",

1376+ "priority" : 25,

1377+ "userSetupAllowed" : false,

1378+ "autheticatorFlow" : false

1379+ }, {

1380+ "requirement" : "ALTERNATIVE",

1381+ "priority" : 30,

1382+ "flowAlias" : "forms",

1383+ "userSetupAllowed" : false,

1384+ "autheticatorFlow" : true

1385+ } ]

1386+ }, {

1387+ "id" : "92a653ba-8f2d-4283-8354-ca55f9d89181",

1388+ "alias" : "clients",

1389+ "description" : "Base authentication for clients",

1390+ "providerId" : "client-flow",

1391+ "topLevel" : true,

1392+ "builtIn" : true,

1393+ "authenticationExecutions" : [ {

1394+ "authenticator" : "client-secret",

1395+ "requirement" : "ALTERNATIVE",

1396+ "priority" : 10,

1397+ "userSetupAllowed" : false,

1398+ "autheticatorFlow" : false

1399+ }, {

1400+ "authenticator" : "client-jwt",

1401+ "requirement" : "ALTERNATIVE",

1402+ "priority" : 20,

1403+ "userSetupAllowed" : false,

1404+ "autheticatorFlow" : false

1405+ }, {

1406+ "authenticator" : "client-secret-jwt",

1407+ "requirement" : "ALTERNATIVE",

1408+ "priority" : 30,

1409+ "userSetupAllowed" : false,

1410+ "autheticatorFlow" : false

1411+ }, {

1412+ "authenticator" : "client-x509",

1413+ "requirement" : "ALTERNATIVE",

1414+ "priority" : 40,

1415+ "userSetupAllowed" : false,

1416+ "autheticatorFlow" : false

1417+ } ]

1418+ }, {

1419+ "id" : "e365be39-78db-46f0-b2e8-4e7001c2f5d0",

1420+ "alias" : "direct grant",

1421+ "description" : "OpenID Connect Resource Owner Grant",

1422+ "providerId" : "basic-flow",

1423+ "topLevel" : true,

1424+ "builtIn" : true,

1425+ "authenticationExecutions" : [ {

1426+ "authenticator" : "direct-grant-validate-username",

1427+ "requirement" : "REQUIRED",

1428+ "priority" : 10,

1429+ "userSetupAllowed" : false,

1430+ "autheticatorFlow" : false

1431+ }, {

1432+ "authenticator" : "direct-grant-validate-password",

1433+ "requirement" : "REQUIRED",

1434+ "priority" : 20,

1435+ "userSetupAllowed" : false,

1436+ "autheticatorFlow" : false

1437+ }, {

1438+ "requirement" : "CONDITIONAL",

1439+ "priority" : 30,

1440+ "flowAlias" : "Direct Grant - Conditional OTP",

1441+ "userSetupAllowed" : false,

1442+ "autheticatorFlow" : true

1443+ } ]

1444+ }, {

1445+ "id" : "dd61caf5-a40f-48b7-9e8c-a1f3b67041dd",

1446+ "alias" : "docker auth",

1447+ "description" : "Used by Docker clients to authenticate against the IDP",

1448+ "providerId" : "basic-flow",

1449+ "topLevel" : true,

1450+ "builtIn" : true,

1451+ "authenticationExecutions" : [ {

1452+ "authenticator" : "docker-http-basic-authenticator",

1453+ "requirement" : "REQUIRED",

1454+ "priority" : 10,

1455+ "userSetupAllowed" : false,

1456+ "autheticatorFlow" : false

1457+ } ]

1458+ }, {

1459+ "id" : "7a055643-62e1-4ac1-b126-9a8d6c299635",

1460+ "alias" : "first broker login",

1461+ "description" : "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account",

1462+ "providerId" : "basic-flow",

1463+ "topLevel" : true,

1464+ "builtIn" : true,

1465+ "authenticationExecutions" : [ {

1466+ "authenticatorConfig" : "review profile config",

1467+ "authenticator" : "idp-review-profile",

1468+ "requirement" : "REQUIRED",

1469+ "priority" : 10,

1470+ "userSetupAllowed" : false,

1471+ "autheticatorFlow" : false

1472+ }, {

1473+ "requirement" : "REQUIRED",

1474+ "priority" : 20,

1475+ "flowAlias" : "User creation or linking",

1476+ "userSetupAllowed" : false,

1477+ "autheticatorFlow" : true

1478+ } ]

1479+ }, {

1480+ "id" : "fe8bc7ee-6e8f-436e-8336-c60fcd350843",

1481+ "alias" : "forms",

1482+ "description" : "Username, password, otp and other auth forms.",

1483+ "providerId" : "basic-flow",

1484+ "topLevel" : false,

1485+ "builtIn" : true,

1486+ "authenticationExecutions" : [ {

1487+ "authenticator" : "auth-username-password-form",

1488+ "requirement" : "REQUIRED",

1489+ "priority" : 10,

1490+ "userSetupAllowed" : false,

1491+ "autheticatorFlow" : false

1492+ }, {

1493+ "requirement" : "CONDITIONAL",

1494+ "priority" : 20,

1495+ "flowAlias" : "Browser - Conditional OTP",

1496+ "userSetupAllowed" : false,

1497+ "autheticatorFlow" : true

1498+ } ]

1499+ }, {

1500+ "id" : "3646f08e-ab70-415b-a701-6ed2e2d214c9",

1501+ "alias" : "http challenge",

1502+ "description" : "An authentication flow based on challenge-response HTTP Authentication Schemes",

1503+ "providerId" : "basic-flow",

1504+ "topLevel" : true,

1505+ "builtIn" : true,

1506+ "authenticationExecutions" : [ {

1507+ "authenticator" : "no-cookie-redirect",

1508+ "requirement" : "REQUIRED",

1509+ "priority" : 10,

1510+ "userSetupAllowed" : false,

1511+ "autheticatorFlow" : false

1512+ }, {

1513+ "requirement" : "REQUIRED",

1514+ "priority" : 20,

1515+ "flowAlias" : "Authentication Options",

1516+ "userSetupAllowed" : false,

1517+ "autheticatorFlow" : true

1518+ } ]

1519+ }, {

1520+ "id" : "04176530-0972-47ad-83df-19d8534caac2",

1521+ "alias" : "registration",

1522+ "description" : "registration flow",

1523+ "providerId" : "basic-flow",

1524+ "topLevel" : true,

1525+ "builtIn" : true,

1526+ "authenticationExecutions" : [ {

1527+ "authenticator" : "registration-page-form",

1528+ "requirement" : "REQUIRED",

1529+ "priority" : 10,

1530+ "flowAlias" : "registration form",

1531+ "userSetupAllowed" : false,

1532+ "autheticatorFlow" : true

1533+ } ]

1534+ }, {

1535+ "id" : "fa0ed569-6746-439e-b07e-89f7ed918c07",

1536+ "alias" : "registration form",

1537+ "description" : "registration form",

1538+ "providerId" : "form-flow",

1539+ "topLevel" : false,

1540+ "builtIn" : true,

1541+ "authenticationExecutions" : [ {

1542+ "authenticator" : "registration-user-creation",

1543+ "requirement" : "REQUIRED",

1544+ "priority" : 20,

1545+ "userSetupAllowed" : false,

1546+ "autheticatorFlow" : false

1547+ }, {

1548+ "authenticator" : "registration-profile-action",

1549+ "requirement" : "REQUIRED",

1550+ "priority" : 40,

1551+ "userSetupAllowed" : false,

1552+ "autheticatorFlow" : false

1553+ }, {

1554+ "authenticator" : "registration-password-action",

1555+ "requirement" : "REQUIRED",

1556+ "priority" : 50,

1557+ "userSetupAllowed" : false,

1558+ "autheticatorFlow" : false

1559+ }, {

1560+ "authenticator" : "registration-recaptcha-action",

1561+ "requirement" : "DISABLED",

1562+ "priority" : 60,

1563+ "userSetupAllowed" : false,

1564+ "autheticatorFlow" : false

1565+ } ]

1566+ }, {

1567+ "id" : "03680917-28f3-4ccd-bdf6-4a516f7c0018",

1568+ "alias" : "reset credentials",

1569+ "description" : "Reset credentials for a user if they forgot their password or something",

1570+ "providerId" : "basic-flow",

1571+ "topLevel" : true,

1572+ "builtIn" : true,

1573+ "authenticationExecutions" : [ {

1574+ "authenticator" : "reset-credentials-choose-user",

1575+ "requirement" : "REQUIRED",

1576+ "priority" : 10,

1577+ "userSetupAllowed" : false,

1578+ "autheticatorFlow" : false

1579+ }, {

1580+ "authenticator" : "reset-credential-email",

1581+ "requirement" : "REQUIRED",

1582+ "priority" : 20,

1583+ "userSetupAllowed" : false,

1584+ "autheticatorFlow" : false

1585+ }, {

1586+ "authenticator" : "reset-password",

1587+ "requirement" : "REQUIRED",

1588+ "priority" : 30,

1589+ "userSetupAllowed" : false,

1590+ "autheticatorFlow" : false

1591+ }, {

1592+ "requirement" : "CONDITIONAL",

1593+ "priority" : 40,

1594+ "flowAlias" : "Reset - Conditional OTP",

1595+ "userSetupAllowed" : false,

1596+ "autheticatorFlow" : true

1597+ } ]

1598+ }, {

1599+ "id" : "19a9d9aa-2d2b-4701-807f-c384ab921c7e",

1600+ "alias" : "saml ecp",

1601+ "description" : "SAML ECP Profile Authentication Flow",

1602+ "providerId" : "basic-flow",

1603+ "topLevel" : true,

1604+ "builtIn" : true,

1605+ "authenticationExecutions" : [ {

1606+ "authenticator" : "http-basic-authenticator",

1607+ "requirement" : "REQUIRED",

1608+ "priority" : 10,

1609+ "userSetupAllowed" : false,

1610+ "autheticatorFlow" : false

1611+ } ]

1612+ } ],

1613+ "authenticatorConfig" : [ {

1614+ "id" : "534f01f4-45b3-43a0-91d1-238860cc126d",

1615+ "alias" : "create unique user config",

1616+ "config" : {

1617+ "require.password.update.after.registration" : "false"

1618+ }

1619+ }, {

1620+ "id" : "65bb9337-9633-4a21-8f6f-1d4129f664ac",

1621+ "alias" : "review profile config",

1622+ "config" : {

1623+ "update.profile.on.first.login" : "missing"

1624+ }

1625+ } ],

1626+ "requiredActions" : [ {

1627+ "alias" : "CONFIGURE_TOTP",

1628+ "name" : "Configure OTP",

1629+ "providerId" : "CONFIGURE_TOTP",

1630+ "enabled" : true,

1631+ "defaultAction" : false,

1632+ "priority" : 10,

1633+ "config" : { }

1634+ }, {

1635+ "alias" : "terms_and_conditions",

1636+ "name" : "Terms and Conditions",

1637+ "providerId" : "terms_and_conditions",

1638+ "enabled" : false,

1639+ "defaultAction" : false,

1640+ "priority" : 20,

1641+ "config" : { }

1642+ }, {

1643+ "alias" : "UPDATE_PASSWORD",

1644+ "name" : "Update Password",

1645+ "providerId" : "UPDATE_PASSWORD",

1646+ "enabled" : true,

1647+ "defaultAction" : false,

1648+ "priority" : 30,

1649+ "config" : { }

1650+ }, {

1651+ "alias" : "UPDATE_PROFILE",

1652+ "name" : "Update Profile",

1653+ "providerId" : "UPDATE_PROFILE",

1654+ "enabled" : true,

1655+ "defaultAction" : false,

1656+ "priority" : 40,

1657+ "config" : { }

1658+ }, {

1659+ "alias" : "VERIFY_EMAIL",

1660+ "name" : "Verify Email",

1661+ "providerId" : "VERIFY_EMAIL",

1662+ "enabled" : true,

1663+ "defaultAction" : false,

1664+ "priority" : 50,

1665+ "config" : { }

1666+ }, {

1667+ "alias" : "update_user_locale",

1668+ "name" : "Update User Locale",

1669+ "providerId" : "update_user_locale",

1670+ "enabled" : true,

1671+ "defaultAction" : false,

1672+ "priority" : 1000,

1673+ "config" : { }

1674+ } ],

1675+ "browserFlow" : "browser",

1676+ "registrationFlow" : "registration",

1677+ "directGrantFlow" : "direct grant",

1678+ "resetCredentialsFlow" : "reset credentials",

1679+ "clientAuthenticationFlow" : "clients",

1680+ "dockerAuthenticationFlow" : "docker auth",

1681+ "attributes" : { },

1682+ "keycloakVersion" : "10.0.0",

1683+ "userManagedAccessAllowed" : false

1684+}

contrib/local-environment/keycloak/master-users-0.jsonnew file+27

@@ -0,0 +1,27 @@

1+{

2+ "realm" : "master",

3+ "users" : [ {

4+ "id" : "3356c0a0-d4d5-4436-9c5a-2299c71c08ec",

5+ "createdTimestamp" : 1591297959169,

6+ "username" : "admin@example.com",

7+ "email" : "admin@example.com",

8+ "enabled" : true,

9+ "totp" : false,

10+ "emailVerified" : true,

11+ "credentials" : [ {

12+ "id" : "a1a06ecd-fdc0-4e67-92cd-2da22d724e32",

13+ "type" : "password",

14+ "createdDate" : 1591297959315,

15+ "secretData" : "{\"value\":\"6rt5zuqHVHopvd0FTFE0CYadXTtzY0mDY2BrqnNQGS51/7DfMJeGgj0roNnGMGvDv30imErNmiSOYl+cL9jiIA==\",\"salt\":\"LI0kqr09JB7J9wvr2Hxzzg==\"}",

16+ "credentialData" : "{\"hashIterations\":27500,\"algorithm\":\"pbkdf2-sha256\"}"

17+ } ],

18+ "disableableCredentialTypes" : [ ],

19+ "requiredActions" : [ ],

20+ "realmRoles" : [ "offline_access", "admin", "uma_authorization" ],

21+ "clientRoles" : {

22+ "account" : [ "view-profile", "manage-account" ]

23+ },

24+ "notBefore" : 0,

25+ "groups" : [ ]

26+ } ]

27+}

contrib/local-environment/keycloak/oauth2-proxy-realm.jsondeleted−2071

@@ -1,2071 +0,0 @@

1−{

2− "id": "oauth2-proxy",

3− "realm": "oauth2-proxy",

4− "displayName": "Keycloak",

5− "displayNameHtml": "<div class=\"kc-logo-text\"><span>Keycloak</span></div>",

6− "notBefore": 0,

7− "revokeRefreshToken": false,

8− "refreshTokenMaxReuse": 0,

9− "accessTokenLifespan": 60,

10− "accessTokenLifespanForImplicitFlow": 900,

11− "ssoSessionIdleTimeout": 1800,

12− "ssoSessionMaxLifespan": 36000,

13− "ssoSessionIdleTimeoutRememberMe": 0,

14− "ssoSessionMaxLifespanRememberMe": 0,

15− "offlineSessionIdleTimeout": 2592000,

16− "offlineSessionMaxLifespanEnabled": false,

17− "offlineSessionMaxLifespan": 5184000,

18− "clientSessionIdleTimeout": 0,

19− "clientSessionMaxLifespan": 0,

20− "accessCodeLifespan": 60,

21− "accessCodeLifespanUserAction": 300,

22− "accessCodeLifespanLogin": 1800,

23− "actionTokenGeneratedByAdminLifespan": 43200,

24− "actionTokenGeneratedByUserLifespan": 300,

25− "enabled": true,

26− "sslRequired": "external",

27− "registrationAllowed": false,

28− "registrationEmailAsUsername": false,

29− "rememberMe": false,

30− "verifyEmail": false,

31− "loginWithEmailAllowed": true,

32− "duplicateEmailsAllowed": false,

33− "resetPasswordAllowed": false,

34− "editUsernameAllowed": false,

35− "bruteForceProtected": false,

36− "permanentLockout": false,

37− "maxFailureWaitSeconds": 900,

38− "minimumQuickLoginWaitSeconds": 60,

39− "waitIncrementSeconds": 60,

40− "quickLoginCheckMilliSeconds": 1000,

41− "maxDeltaTimeSeconds": 43200,

42− "failureFactor": 30,

43− "roles": {

44− "realm": [

45− {

46− "id": "32626c92-4327-40f1-b318-76a6b5c7eee5",

47− "name": "offline_access",

48− "description": "${role_offline-access}",

49− "composite": false,

50− "clientRole": false,

51− "containerId": "oauth2-proxy",

52− "attributes": {}

53− },

54− {

55− "id": "e36da570-7ae0-4323-8b39-73eb92ce722f",

56− "name": "admin",

57− "description": "${role_admin}",

58− "composite": true,

59− "composites": {

60− "realm": [

61− "create-realm"

62− ],

63− "client": {

64− "oauth2-proxy-realm": [

65− "query-groups",

66− "create-client",

67− "query-realms",

68− "view-authorization",

69− "view-realm",

70− "manage-clients",

71− "query-users",

72− "manage-realm",

73− "view-events",

74− "manage-events",

75− "view-identity-providers",

76− "view-users",

77− "manage-identity-providers",

78− "manage-authorization",

79− "manage-users",

80− "view-clients",

81− "query-clients",

82− "impersonation"

83− ]

84− }

85− },

86− "clientRole": false,

87− "containerId": "oauth2-proxy",

88− "attributes": {}

89− },

90− {

91− "id": "71aca46c-6fcf-4456-ba87-6374e70108a2",

92− "name": "uma_authorization",

93− "description": "${role_uma_authorization}",

94− "composite": false,

95− "clientRole": false,

96− "containerId": "oauth2-proxy",

97− "attributes": {}

98− },

99− {

100− "id": "6ca3fee8-1a3f-4068-a311-6e81223a884b",

101− "name": "create-realm",

102− "description": "${role_create-realm}",

103− "composite": false,

104− "clientRole": false,

105− "containerId": "oauth2-proxy",

106− "attributes": {}

107− }

108− ],

109− "client": {

110− "oauth2-proxy": [],

111− "security-admin-console": [],

112− "admin-cli": [],

113− "account-console": [],

114− "broker": [

115− {

116− "id": "2cc5e40c-0a28-4c09-85eb-20cd47ac1351",

117− "name": "read-token",

118− "description": "${role_read-token}",

119− "composite": false,

120− "clientRole": true,

121− "containerId": "380985f1-61c7-4940-93ae-7a09458071ca",

122− "attributes": {}

123− }

124− ],

125− "oauth2-proxy-realm": [

126− {

127− "id": "a8271c2c-6437-4ca5-ae83-49ea5fe1318d",

128− "name": "query-groups",

129− "description": "${role_query-groups}",

130− "composite": false,

131− "clientRole": true,

132− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

133− "attributes": {}

134− },

135− {

136− "id": "5a7cb1ae-7dac-486b-bf7b-4d7fbc5adb31",

137− "name": "create-client",

138− "description": "${role_create-client}",

139− "composite": false,

140− "clientRole": true,

141− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

142− "attributes": {}

143− },

144− {

145− "id": "a9e6a2fa-c31b-4959-bf8a-a46fcc9c65ec",

146− "name": "view-authorization",

147− "description": "${role_view-authorization}",

148− "composite": false,

149− "clientRole": true,

150− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

151− "attributes": {}

152− },

153− {

154− "id": "1cef34e3-569a-4d2b-ba5c-aafe5c7ab423",

155− "name": "query-realms",

156− "description": "${role_query-realms}",

157− "composite": false,

158− "clientRole": true,

159− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

160− "attributes": {}

161− },

162− {

163− "id": "efc46075-30cd-4600-aa92-2ae4a171d0c2",

164− "name": "view-realm",

165− "description": "${role_view-realm}",

166− "composite": false,

167− "clientRole": true,

168− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

169− "attributes": {}

170− },

171− {

172− "id": "9ffacaf0-afc6-49e9-8708-ef35ac40f3f8",

173− "name": "manage-clients",

174− "description": "${role_manage-clients}",

175− "composite": false,

176− "clientRole": true,

177− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

178− "attributes": {}

179− },

180− {

181− "id": "90662091-b3bc-4ae4-83c9-a4f53e7e9eeb",

182− "name": "query-users",

183− "description": "${role_query-users}",

184− "composite": false,

185− "clientRole": true,

186− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

187− "attributes": {}

188− },

189− {

190− "id": "9a5fbc9d-6fae-4155-86f6-72fd399aa126",

191− "name": "manage-realm",

192− "description": "${role_manage-realm}",

193− "composite": false,

194− "clientRole": true,

195− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

196− "attributes": {}

197− },

198− {

199− "id": "03f46127-9436-477d-8c7f-58569f45237c",

200− "name": "view-events",

201− "description": "${role_view-events}",

202− "composite": false,

203− "clientRole": true,

204− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

205− "attributes": {}

206− },

207− {

208− "id": "f10eaea2-90ab-4310-9d5f-8d986564d061",

209− "name": "view-identity-providers",

210− "description": "${role_view-identity-providers}",

211− "composite": false,

212− "clientRole": true,

213− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

214− "attributes": {}

215− },

216− {

217− "id": "2403e038-2cf7-4b06-b5cb-33a417a00d8d",

218− "name": "manage-events",

219− "description": "${role_manage-events}",

220− "composite": false,

221− "clientRole": true,

222− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

223− "attributes": {}

224− },

225− {

226− "id": "677d057b-66f8-4163-9948-95fdbd06dfdc",

227− "name": "view-users",

228− "description": "${role_view-users}",

229− "composite": true,

230− "composites": {

231− "client": {

232− "oauth2-proxy-realm": [

233− "query-groups",

234− "query-users"

235− ]

236− }

237− },

238− "clientRole": true,

239− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

240− "attributes": {}

241− },

242− {

243− "id": "dc140fa6-bf2c-49f2-b8c9-fc34ef8a2c63",

244− "name": "manage-identity-providers",

245− "description": "${role_manage-identity-providers}",

246− "composite": false,

247− "clientRole": true,

248− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

249− "attributes": {}

250− },

251− {

252− "id": "155bf234-4895-4855-95c2-a460518f57e8",

253− "name": "manage-authorization",

254− "description": "${role_manage-authorization}",

255− "composite": false,

256− "clientRole": true,

257− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

258− "attributes": {}

259− },

260− {

261− "id": "5441ec71-3eac-4696-9e68-0de54fbdde98",

262− "name": "manage-users",

263− "description": "${role_manage-users}",

264− "composite": false,

265− "clientRole": true,

266− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

267− "attributes": {}

268− },

269− {

270− "id": "2db0f052-cb91-4170-81fd-107756b162f7",

271− "name": "view-clients",

272− "description": "${role_view-clients}",

273− "composite": true,

274− "composites": {

275− "client": {

276− "oauth2-proxy-realm": [

277− "query-clients"

278− ]

279− }

280− },

281− "clientRole": true,

282− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

283− "attributes": {}

284− },

285− {

286− "id": "e1d7f235-8bf2-40b8-be49-49aca70a5088",

287− "name": "query-clients",

288− "description": "${role_query-clients}",

289− "composite": false,

290− "clientRole": true,

291− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

292− "attributes": {}

293− },

294− {

295− "id": "e743f66a-2f56-4b97-b34b-33f06ff1e739",

296− "name": "impersonation",

297− "description": "${role_impersonation}",

298− "composite": false,

299− "clientRole": true,

300− "containerId": "7174c175-1887-4e57-b95b-969fe040deff",

301− "attributes": {}

302− }

303− ],

304− "account": [

305− {

306− "id": "64d8f532-839e-4386-b2eb-fe8848b0a9de",

307− "name": "manage-consent",

308− "description": "${role_manage-consent}",

309− "composite": true,

310− "composites": {

311− "client": {

312− "account": [

313− "view-consent"

314− ]

315− }

316− },

317− "clientRole": true,

318− "containerId": "a367038f-fe01-4459-9f91-7ad0cf498533",

319− "attributes": {}

320− },

321− {

322− "id": "3ec22748-960f-4f96-a43e-50f54a02dc23",

323− "name": "view-profile",

324− "description": "${role_view-profile}",

325− "composite": false,

326− "clientRole": true,

327− "containerId": "a367038f-fe01-4459-9f91-7ad0cf498533",

328− "attributes": {}

329− },

330− {

331− "id": "177d18e4-46b0-4ea3-8b70-327486ce5bb2",

332− "name": "view-applications",

333− "description": "${role_view-applications}",

334− "composite": false,

335− "clientRole": true,

336− "containerId": "a367038f-fe01-4459-9f91-7ad0cf498533",

337− "attributes": {}

338− },

339− {

340− "id": "703643d6-0542-4e27-9737-7c442925c18c",

341− "name": "manage-account-links",

342− "description": "${role_manage-account-links}",

343− "composite": false,

344− "clientRole": true,

345− "containerId": "a367038f-fe01-4459-9f91-7ad0cf498533",

346− "attributes": {}

347− },

348− {

349− "id": "c64f9f66-d762-4337-8833-cf31c316e8a7",

350− "name": "view-consent",

351− "description": "${role_view-consent}",

352− "composite": false,

353− "clientRole": true,

354− "containerId": "a367038f-fe01-4459-9f91-7ad0cf498533",

355− "attributes": {}

356− },

357− {

358− "id": "611f568b-0fdd-4d2e-ba34-03136cd486c4",

359− "name": "manage-account",

360− "description": "${role_manage-account}",

361− "composite": true,

362− "composites": {

363− "client": {

364− "account": [

365− "manage-account-links"

366− ]

367− }

368− },

369− "clientRole": true,

370− "containerId": "a367038f-fe01-4459-9f91-7ad0cf498533",

371− "attributes": {}

372− }

373− ]

374− }

375− },

376− "groups": [],

377− "defaultRoles": [

378− "offline_access",

379− "uma_authorization"

380− ],

381− "requiredCredentials": [

382− "password"

383− ],

384− "otpPolicyType": "totp",

385− "otpPolicyAlgorithm": "HmacSHA1",

386− "otpPolicyInitialCounter": 0,

387− "otpPolicyDigits": 6,

388− "otpPolicyLookAheadWindow": 1,

389− "otpPolicyPeriod": 30,

390− "otpSupportedApplications": [

391− "FreeOTP",

392− "Google Authenticator"

393− ],

394− "webAuthnPolicyRpEntityName": "keycloak",

395− "webAuthnPolicySignatureAlgorithms": [

396− "ES256"

397− ],

398− "webAuthnPolicyRpId": "",

399− "webAuthnPolicyAttestationConveyancePreference": "not specified",

400− "webAuthnPolicyAuthenticatorAttachment": "not specified",

401− "webAuthnPolicyRequireResidentKey": "not specified",

402− "webAuthnPolicyUserVerificationRequirement": "not specified",

403− "webAuthnPolicyCreateTimeout": 0,

404− "webAuthnPolicyAvoidSameAuthenticatorRegister": false,

405− "webAuthnPolicyAcceptableAaguids": [],

406− "webAuthnPolicyPasswordlessRpEntityName": "keycloak",

407− "webAuthnPolicyPasswordlessSignatureAlgorithms": [

408− "ES256"

409− ],

410− "webAuthnPolicyPasswordlessRpId": "",

411− "webAuthnPolicyPasswordlessAttestationConveyancePreference": "not specified",

412− "webAuthnPolicyPasswordlessAuthenticatorAttachment": "not specified",

413− "webAuthnPolicyPasswordlessRequireResidentKey": "not specified",

414− "webAuthnPolicyPasswordlessUserVerificationRequirement": "not specified",

415− "webAuthnPolicyPasswordlessCreateTimeout": 0,

416− "webAuthnPolicyPasswordlessAvoidSameAuthenticatorRegister": false,

417− "webAuthnPolicyPasswordlessAcceptableAaguids": [],

418− "scopeMappings": [

419− {

420− "clientScope": "offline_access",

421− "roles": [

422− "offline_access"

423− ]

424− }

425− ],

426− "clientScopeMappings": {

427− "account": [

428− {

429− "client": "account-console",

430− "roles": [

431− "manage-account"

432− ]

433− }

434− ]

435− },

436− "clients": [

437− {

438− "id": "a367038f-fe01-4459-9f91-7ad0cf498533",

439− "clientId": "account",

440− "name": "${client_account}",

441− "rootUrl": "${authBaseUrl}",

442− "baseUrl": "/realms/oauth2-proxy/account/",

443− "surrogateAuthRequired": false,

444− "enabled": true,

445− "alwaysDisplayInConsole": false,

446− "clientAuthenticatorType": "client-secret",

447− "secret": "0896a464-da81-4454-bee9-b56bdbad9e7f",

448− "defaultRoles": [

449− "view-profile",

450− "manage-account"

451− ],

452− "redirectUris": [

453− "/realms/oauth2-proxy/account/*"

454− ],

455− "webOrigins": [],

456− "notBefore": 0,

457− "bearerOnly": false,

458− "consentRequired": false,

459− "standardFlowEnabled": true,

460− "implicitFlowEnabled": false,

461− "directAccessGrantsEnabled": false,

462− "serviceAccountsEnabled": false,

463− "publicClient": false,

464− "frontchannelLogout": false,

465− "protocol": "openid-connect",

466− "attributes": {},

467− "authenticationFlowBindingOverrides": {},

468− "fullScopeAllowed": false,

469− "nodeReRegistrationTimeout": 0,

470− "defaultClientScopes": [

471− "web-origins",

472− "role_list",

473− "roles",

474− "profile",

475− "email"

476− ],

477− "optionalClientScopes": [

478− "address",

479− "phone",

480− "offline_access",

481− "microprofile-jwt"

482− ]

483− },

484− {

485− "id": "72f75604-1e21-407c-b967-790aafd11534",

486− "clientId": "account-console",

487− "name": "${client_account-console}",

488− "rootUrl": "${authBaseUrl}",

489− "baseUrl": "/realms/oauth2-proxy/account/",

490− "surrogateAuthRequired": false,

491− "enabled": true,

492− "alwaysDisplayInConsole": false,

493− "clientAuthenticatorType": "client-secret",

494− "secret": "91f85142-ee18-4e30-9949-e5acb701bdee",

495− "redirectUris": [

496− "/realms/oauth2-proxy/account/*"

497− ],

498− "webOrigins": [],

499− "notBefore": 0,

500− "bearerOnly": false,

501− "consentRequired": false,

502− "standardFlowEnabled": true,

503− "implicitFlowEnabled": false,

504− "directAccessGrantsEnabled": false,

505− "serviceAccountsEnabled": false,

506− "publicClient": true,

507− "frontchannelLogout": false,

508− "protocol": "openid-connect",

509− "attributes": {

510− "pkce.code.challenge.method": "S256"

511− },

512− "authenticationFlowBindingOverrides": {},

513− "fullScopeAllowed": false,

514− "nodeReRegistrationTimeout": 0,

515− "protocolMappers": [

516− {

517− "id": "2772c101-0dba-49b7-9627-5aaddc666939",

518− "name": "audience resolve",

519− "protocol": "openid-connect",

520− "protocolMapper": "oidc-audience-resolve-mapper",

521− "consentRequired": false,

522− "config": {}

523− }

524− ],

525− "defaultClientScopes": [

526− "web-origins",

527− "role_list",

528− "roles",

529− "profile",

530− "email"

531− ],

532− "optionalClientScopes": [

533− "address",

534− "phone",

535− "offline_access",

536− "microprofile-jwt"

537− ]

538− },

539− {

540− "id": "b13fd0de-3be0-4a08-bc5d-d1de34421b1a",

541− "clientId": "admin-cli",

542− "name": "${client_admin-cli}",

543− "surrogateAuthRequired": false,

544− "enabled": true,

545− "alwaysDisplayInConsole": false,

546− "clientAuthenticatorType": "client-secret",

547− "secret": "4640af2e-b4a6-44eb-85ec-6278a62a4f01",

548− "redirectUris": [],

549− "webOrigins": [],

550− "notBefore": 0,

551− "bearerOnly": false,

552− "consentRequired": false,

553− "standardFlowEnabled": false,

554− "implicitFlowEnabled": false,

555− "directAccessGrantsEnabled": true,

556− "serviceAccountsEnabled": false,

557− "publicClient": true,

558− "frontchannelLogout": false,

559− "protocol": "openid-connect",

560− "attributes": {},

561− "authenticationFlowBindingOverrides": {},

562− "fullScopeAllowed": false,

563− "nodeReRegistrationTimeout": 0,

564− "defaultClientScopes": [

565− "web-origins",

566− "role_list",

567− "roles",

568− "profile",

569− "email"

570− ],

571− "optionalClientScopes": [

572− "address",

573− "phone",

574− "offline_access",

575− "microprofile-jwt"

576− ]

577− },

578− {

579− "id": "380985f1-61c7-4940-93ae-7a09458071ca",

580− "clientId": "broker",

581− "name": "${client_broker}",

582− "surrogateAuthRequired": false,

583− "enabled": true,

584− "alwaysDisplayInConsole": false,

585− "clientAuthenticatorType": "client-secret",

586− "secret": "65d2ba2b-bcae-49ff-9f56-77c818f55930",

587− "redirectUris": [],

588− "webOrigins": [],

589− "notBefore": 0,

590− "bearerOnly": false,

591− "consentRequired": false,

592− "standardFlowEnabled": true,

593− "implicitFlowEnabled": false,

594− "directAccessGrantsEnabled": false,

595− "serviceAccountsEnabled": false,

596− "publicClient": false,

597− "frontchannelLogout": false,

598− "protocol": "openid-connect",

599− "attributes": {},

600− "authenticationFlowBindingOverrides": {},

601− "fullScopeAllowed": false,

602− "nodeReRegistrationTimeout": 0,

603− "defaultClientScopes": [

604− "web-origins",

605− "role_list",

606− "roles",

607− "profile",

608− "email"

609− ],

610− "optionalClientScopes": [

611− "address",

612− "phone",

613− "offline_access",

614− "microprofile-jwt"

615− ]

616− },

617− {

618− "id": "7174c175-1887-4e57-b95b-969fe040deff",

619− "clientId": "oauth2-proxy-realm",

620− "name": "oauth2-proxy Realm",

621− "surrogateAuthRequired": false,

622− "enabled": true,

623− "alwaysDisplayInConsole": false,

624− "clientAuthenticatorType": "client-secret",

625− "secret": "40f73851-a94c-4091-90de-aeee8ca1acf8",

626− "redirectUris": [],

627− "webOrigins": [],

628− "notBefore": 0,

629− "bearerOnly": true,

630− "consentRequired": false,

631− "standardFlowEnabled": true,

632− "implicitFlowEnabled": false,

633− "directAccessGrantsEnabled": false,

634− "serviceAccountsEnabled": false,

635− "publicClient": false,

636− "frontchannelLogout": false,

637− "attributes": {},

638− "authenticationFlowBindingOverrides": {},

639− "fullScopeAllowed": true,

640− "nodeReRegistrationTimeout": 0,

641− "defaultClientScopes": [

642− "web-origins",

643− "role_list",

644− "roles",

645− "profile",

646− "email"

647− ],

648− "optionalClientScopes": [

649− "address",

650− "phone",

651− "offline_access",

652− "microprofile-jwt"

653− ]

654− },

655− {

656− "id": "0493c7c6-6e20-49ea-9acb-627c0b52d400",

657− "clientId": "oauth2-proxy",

658− "surrogateAuthRequired": false,

659− "enabled": true,

660− "alwaysDisplayInConsole": false,

661− "clientAuthenticatorType": "client-secret",

662− "secret": "72341b6d-7065-4518-a0e4-50ee15025608",

663− "redirectUris": [

664− "http://oauth2-proxy.localtest.me:4180/oauth2/callback"

665− ],

666− "webOrigins": [],

667− "notBefore": 0,

668− "bearerOnly": false,

669− "consentRequired": false,

670− "standardFlowEnabled": true,

671− "implicitFlowEnabled": false,

672− "directAccessGrantsEnabled": true,

673− "serviceAccountsEnabled": false,

674− "publicClient": false,

675− "frontchannelLogout": false,

676− "protocol": "openid-connect",

677− "attributes": {

678− "saml.assertion.signature": "false",

679− "saml.force.post.binding": "false",

680− "saml.multivalued.roles": "false",

681− "saml.encrypt": "false",

682− "saml.server.signature": "false",

683− "saml.server.signature.keyinfo.ext": "false",

684− "exclude.session.state.from.auth.response": "false",

685− "saml_force_name_id_format": "false",

686− "saml.client.signature": "false",

687− "tls.client.certificate.bound.access.tokens": "false",

688− "saml.authnstatement": "false",

689− "display.on.consent.screen": "false",

690− "saml.onetimeuse.condition": "false"

691− },

692− "authenticationFlowBindingOverrides": {},

693− "fullScopeAllowed": true,

694− "nodeReRegistrationTimeout": -1,

695− "defaultClientScopes": [

696− "web-origins",

697− "role_list",

698− "roles",

699− "profile",

700− "email"

701− ],

702− "optionalClientScopes": [

703− "address",

704− "phone",

705− "offline_access",

706− "microprofile-jwt"

707− ]

708− },

709− {

710− "id": "2a3ad1fd-a30d-4b72-89c4-bed12f178338",

711− "clientId": "security-admin-console",

712− "name": "${client_security-admin-console}",

713− "rootUrl": "${authAdminUrl}",

714− "baseUrl": "/admin/oauth2-proxy/console/",

715− "surrogateAuthRequired": false,

716− "enabled": true,

717− "alwaysDisplayInConsole": false,

718− "clientAuthenticatorType": "client-secret",

719− "secret": "b234b7aa-8417-410f-b3fd-c57434d3aa4a",

720− "redirectUris": [

721− "/admin/oauth2-proxy/console/*"

722− ],

723− "webOrigins": [

724− "+"

725− ],

726− "notBefore": 0,

727− "bearerOnly": false,

728− "consentRequired": false,

729− "standardFlowEnabled": true,

730− "implicitFlowEnabled": false,

731− "directAccessGrantsEnabled": false,

732− "serviceAccountsEnabled": false,

733− "publicClient": true,

734− "frontchannelLogout": false,

735− "protocol": "openid-connect",

736− "attributes": {

737− "pkce.code.challenge.method": "S256"

738− },

739− "authenticationFlowBindingOverrides": {},

740− "fullScopeAllowed": false,

741− "nodeReRegistrationTimeout": 0,

742− "protocolMappers": [

743− {

744− "id": "5885b0d3-a917-4b52-8380-f37d0754a2ef",

745− "name": "locale",

746− "protocol": "openid-connect",

747− "protocolMapper": "oidc-usermodel-attribute-mapper",

748− "consentRequired": false,

749− "config": {

750− "userinfo.token.claim": "true",

751− "user.attribute": "locale",

752− "id.token.claim": "true",

753− "access.token.claim": "true",

754− "claim.name": "locale",

755− "jsonType.label": "String"

756− }

757− }

758− ],

759− "defaultClientScopes": [

760− "web-origins",

761− "role_list",

762− "roles",

763− "profile",

764− "email"

765− ],

766− "optionalClientScopes": [

767− "address",

768− "phone",

769− "offline_access",

770− "microprofile-jwt"

771− ]

772− }

773− ],

774− "clientScopes": [

775− {

776− "id": "47ea3b67-4f0c-4c7e-8ac6-a33a3d655894",

777− "name": "address",

778− "description": "OpenID Connect built-in scope: address",

779− "protocol": "openid-connect",

780− "attributes": {

781− "include.in.token.scope": "true",

782− "display.on.consent.screen": "true",

783− "consent.screen.text": "${addressScopeConsentText}"

784− },

785− "protocolMappers": [

786− {

787− "id": "4be0ca19-0ec7-4cc1-b263-845ea539ff12",

788− "name": "address",

789− "protocol": "openid-connect",

790− "protocolMapper": "oidc-address-mapper",

791− "consentRequired": false,

792− "config": {

793− "user.attribute.formatted": "formatted",

794− "user.attribute.country": "country",

795− "user.attribute.postal_code": "postal_code",

796− "userinfo.token.claim": "true",

797− "user.attribute.street": "street",

798− "id.token.claim": "true",

799− "user.attribute.region": "region",

800− "access.token.claim": "true",

801− "user.attribute.locality": "locality"

802− }

803− }

804− ]

805− },

806− {

807− "id": "aba72e57-540f-4825-95b7-2d143be028cc",

808− "name": "email",

809− "description": "OpenID Connect built-in scope: email",

810− "protocol": "openid-connect",

811− "attributes": {

812− "include.in.token.scope": "true",

813− "display.on.consent.screen": "true",

814− "consent.screen.text": "${emailScopeConsentText}"

815− },

816− "protocolMappers": [

817− {

818− "id": "7fe82724-5748-4b6d-9708-a028f5d3b970",

819− "name": "email verified",

820− "protocol": "openid-connect",

821− "protocolMapper": "oidc-usermodel-property-mapper",

822− "consentRequired": false,

823− "config": {

824− "userinfo.token.claim": "true",

825− "user.attribute": "emailVerified",

826− "id.token.claim": "true",

827− "access.token.claim": "true",

828− "claim.name": "email_verified",

829− "jsonType.label": "boolean"

830− }

831− },

832− {

833− "id": "e42f334e-cfae-44a0-905d-c3ef215feaae",

834− "name": "email",

835− "protocol": "openid-connect",

836− "protocolMapper": "oidc-usermodel-property-mapper",

837− "consentRequired": false,

838− "config": {

839− "userinfo.token.claim": "true",

840− "user.attribute": "email",

841− "id.token.claim": "true",

842− "access.token.claim": "true",

843− "claim.name": "email",

844− "jsonType.label": "String"

845− }

846− }

847− ]

848− },

849− {

850− "id": "ec765598-bd71-4318-86c3-b3f81a41c99e",

851− "name": "microprofile-jwt",

852− "description": "Microprofile - JWT built-in scope",

853− "protocol": "openid-connect",

854− "attributes": {

855− "include.in.token.scope": "true",

856− "display.on.consent.screen": "false"

857− },

858− "protocolMappers": [

859− {

860− "id": "90694036-4014-4672-a2c8-c68319e9308a",

861− "name": "upn",

862− "protocol": "openid-connect",

863− "protocolMapper": "oidc-usermodel-property-mapper",

864− "consentRequired": false,

865− "config": {

866− "userinfo.token.claim": "true",

867− "user.attribute": "username",

868− "id.token.claim": "true",

869− "access.token.claim": "true",

870− "claim.name": "upn",

871− "jsonType.label": "String"

872− }

873− },

874− {

875− "id": "f7b0fcc0-6139-4158-ac45-34fd9a58a5ef",

876− "name": "groups",

877− "protocol": "openid-connect",

878− "protocolMapper": "oidc-usermodel-realm-role-mapper",

879− "consentRequired": false,

880− "config": {

881− "multivalued": "true",

882− "user.attribute": "foo",

883− "id.token.claim": "true",

884− "access.token.claim": "true",

885− "claim.name": "groups",

886− "jsonType.label": "String"

887− }

888− }

889− ]

890− },

891− {

892− "id": "8a09267b-3634-4a9c-baab-6f2fb4137347",

893− "name": "offline_access",

894− "description": "OpenID Connect built-in scope: offline_access",

895− "protocol": "openid-connect",

896− "attributes": {

897− "consent.screen.text": "${offlineAccessScopeConsentText}",

898− "display.on.consent.screen": "true"

899− }

900− },

901− {

902− "id": "3a48c5dd-33a8-4be0-9d2e-30fd7f98363a",

903− "name": "phone",

904− "description": "OpenID Connect built-in scope: phone",

905− "protocol": "openid-connect",

906− "attributes": {

907− "include.in.token.scope": "true",

908− "display.on.consent.screen": "true",

909− "consent.screen.text": "${phoneScopeConsentText}"

910− },

911− "protocolMappers": [

912− {

913− "id": "5427d1b4-ba79-412a-b23c-da640a98980c",

914− "name": "phone number",

915− "protocol": "openid-connect",

916− "protocolMapper": "oidc-usermodel-attribute-mapper",

917− "consentRequired": false,

918− "config": {

919− "userinfo.token.claim": "true",

920− "user.attribute": "phoneNumber",

921− "id.token.claim": "true",

922− "access.token.claim": "true",

923− "claim.name": "phone_number",

924− "jsonType.label": "String"

925− }

926− },

927− {

928− "id": "31d4a53f-6503-40e8-bd9d-79a7c46c4fbe",

929− "name": "phone number verified",

930− "protocol": "openid-connect",

931− "protocolMapper": "oidc-usermodel-attribute-mapper",

932− "consentRequired": false,

933− "config": {

934− "userinfo.token.claim": "true",

935− "user.attribute": "phoneNumberVerified",

936− "id.token.claim": "true",

937− "access.token.claim": "true",

938− "claim.name": "phone_number_verified",

939− "jsonType.label": "boolean"

940− }

941− }

942− ]

943− },

944− {

945− "id": "5921a9e9-7fec-4471-95e3-dd96eebdec58",

946− "name": "profile",

947− "description": "OpenID Connect built-in scope: profile",

948− "protocol": "openid-connect",

949− "attributes": {

950− "include.in.token.scope": "true",

951− "display.on.consent.screen": "true",

952− "consent.screen.text": "${profileScopeConsentText}"

953− },

954− "protocolMappers": [

955− {

956− "id": "4fa92092-ee0d-4dc7-a63b-1e3b02d35ebb",

957− "name": "zoneinfo",

958− "protocol": "openid-connect",

959− "protocolMapper": "oidc-usermodel-attribute-mapper",

960− "consentRequired": false,

961− "config": {

962− "userinfo.token.claim": "true",

963− "user.attribute": "zoneinfo",

964− "id.token.claim": "true",

965− "access.token.claim": "true",

966− "claim.name": "zoneinfo",

967− "jsonType.label": "String"

968− }

969− },

970− {

971− "id": "1a5cc2e2-c983-4150-8583-23a7f5c826bf",

972− "name": "family name",

973− "protocol": "openid-connect",

974− "protocolMapper": "oidc-usermodel-property-mapper",

975− "consentRequired": false,

976− "config": {

977− "userinfo.token.claim": "true",

978− "user.attribute": "lastName",

979− "id.token.claim": "true",

980− "access.token.claim": "true",

981− "claim.name": "family_name",

982− "jsonType.label": "String"

983− }

984− },

985− {

986− "id": "67931f77-722a-492d-b581-a953e26b7d44",

987− "name": "full name",

988− "protocol": "openid-connect",

989− "protocolMapper": "oidc-full-name-mapper",

990− "consentRequired": false,

991− "config": {

992− "id.token.claim": "true",

993− "access.token.claim": "true",

994− "userinfo.token.claim": "true"

995− }

996− },

997− {

998− "id": "10f6ac36-3a63-4e1c-ac69-c095588f5967",

999− "name": "locale",

1000− "protocol": "openid-connect",

1001− "protocolMapper": "oidc-usermodel-attribute-mapper",

1002− "consentRequired": false,

1003− "config": {

1004− "userinfo.token.claim": "true",

1005− "user.attribute": "locale",

1006− "id.token.claim": "true",

1007− "access.token.claim": "true",

1008− "claim.name": "locale",

1009− "jsonType.label": "String"

1010− }

1011− },

1012− {

1013− "id": "205d9dce-b6c8-4b1d-9c9c-fa24788651cf",

1014− "name": "picture",

1015− "protocol": "openid-connect",

1016− "protocolMapper": "oidc-usermodel-attribute-mapper",

1017− "consentRequired": false,

1018− "config": {

1019− "userinfo.token.claim": "true",

1020− "user.attribute": "picture",

1021− "id.token.claim": "true",

1022− "access.token.claim": "true",

1023− "claim.name": "picture",

1024− "jsonType.label": "String"

1025− }

1026− },

1027− {

1028− "id": "638216c8-ea8c-40e3-9429-771e9278920e",

1029− "name": "gender",

1030− "protocol": "openid-connect",

1031− "protocolMapper": "oidc-usermodel-attribute-mapper",

1032− "consentRequired": false,

1033− "config": {

1034− "userinfo.token.claim": "true",

1035− "user.attribute": "gender",

1036− "id.token.claim": "true",

1037− "access.token.claim": "true",

1038− "claim.name": "gender",

1039− "jsonType.label": "String"

1040− }

1041− },

1042− {

1043− "id": "39c17eae-8ea7-422c-ae21-b8876bf12184",

1044− "name": "birthdate",

1045− "protocol": "openid-connect",

1046− "protocolMapper": "oidc-usermodel-attribute-mapper",

1047− "consentRequired": false,

1048− "config": {

1049− "userinfo.token.claim": "true",

1050− "user.attribute": "birthdate",

1051− "id.token.claim": "true",

1052− "access.token.claim": "true",

1053− "claim.name": "birthdate",

1054− "jsonType.label": "String"

1055− }

1056− },

1057− {

1058− "id": "01c559cf-94f2-46ad-b965-3b2e1db1a2a6",

1059− "name": "updated at",

1060− "protocol": "openid-connect",

1061− "protocolMapper": "oidc-usermodel-attribute-mapper",

1062− "consentRequired": false,

1063− "config": {

1064− "userinfo.token.claim": "true",

1065− "user.attribute": "updatedAt",

1066− "id.token.claim": "true",

1067− "access.token.claim": "true",

1068− "claim.name": "updated_at",

1069− "jsonType.label": "String"

1070− }

1071− },

1072− {

1073− "id": "1693b5ab-28eb-485d-835d-2ae070ccb3ba",

1074− "name": "profile",

1075− "protocol": "openid-connect",

1076− "protocolMapper": "oidc-usermodel-attribute-mapper",

1077− "consentRequired": false,

1078− "config": {

1079− "userinfo.token.claim": "true",

1080− "user.attribute": "profile",

1081− "id.token.claim": "true",

1082− "access.token.claim": "true",

1083− "claim.name": "profile",

1084− "jsonType.label": "String"

1085− }

1086− },

1087− {

1088− "id": "a0e08332-954c-46d2-9795-56eb31132580",

1089− "name": "given name",

1090− "protocol": "openid-connect",

1091− "protocolMapper": "oidc-usermodel-property-mapper",

1092− "consentRequired": false,

1093− "config": {

1094− "userinfo.token.claim": "true",

1095− "user.attribute": "firstName",

1096− "id.token.claim": "true",

1097− "access.token.claim": "true",

1098− "claim.name": "given_name",

1099− "jsonType.label": "String"

1100− }

1101− },

1102− {

1103− "id": "cea0cd9c-d085-4d19-acc3-4bb41c891b68",

1104− "name": "nickname",

1105− "protocol": "openid-connect",

1106− "protocolMapper": "oidc-usermodel-attribute-mapper",

1107− "consentRequired": false,

1108− "config": {

1109− "userinfo.token.claim": "true",

1110− "user.attribute": "nickname",

1111− "id.token.claim": "true",

1112− "access.token.claim": "true",

1113− "claim.name": "nickname",

1114− "jsonType.label": "String"

1115− }

1116− },

1117− {

1118− "id": "3122097d-4cba-46c2-8b3b-5d87a4cc605e",

1119− "name": "middle name",

1120− "protocol": "openid-connect",

1121− "protocolMapper": "oidc-usermodel-attribute-mapper",

1122− "consentRequired": false,

1123− "config": {

1124− "userinfo.token.claim": "true",

1125− "user.attribute": "middleName",

1126− "id.token.claim": "true",

1127− "access.token.claim": "true",

1128− "claim.name": "middle_name",

1129− "jsonType.label": "String"

1130− }

1131− },

1132− {

1133− "id": "a3b97897-d913-4e0a-a4cf-033ce78f7d24",

1134− "name": "username",

1135− "protocol": "openid-connect",

1136− "protocolMapper": "oidc-usermodel-property-mapper",

1137− "consentRequired": false,

1138− "config": {

1139− "userinfo.token.claim": "true",

1140− "user.attribute": "username",

1141− "id.token.claim": "true",

1142− "access.token.claim": "true",

1143− "claim.name": "preferred_username",

1144− "jsonType.label": "String"

1145− }

1146− },

1147− {

1148− "id": "a44eeb9d-410d-49c5-b0e0-5d84787627ad",

1149− "name": "website",

1150− "protocol": "openid-connect",

1151− "protocolMapper": "oidc-usermodel-attribute-mapper",

1152− "consentRequired": false,

1153− "config": {

1154− "userinfo.token.claim": "true",

1155− "user.attribute": "website",

1156− "id.token.claim": "true",

1157− "access.token.claim": "true",

1158− "claim.name": "website",

1159− "jsonType.label": "String"

1160− }

1161− }

1162− ]

1163− },

1164− {

1165− "id": "651408a7-6704-4198-a60f-988821b633ea",

1166− "name": "role_list",

1167− "description": "SAML role list",

1168− "protocol": "saml",

1169− "attributes": {

1170− "consent.screen.text": "${samlRoleListScopeConsentText}",

1171− "display.on.consent.screen": "true"

1172− },

1173− "protocolMappers": [

1174− {

1175− "id": "a8c56c7b-ccbc-4b01-8df5-3ecb6328755f",

1176− "name": "role list",

1177− "protocol": "saml",

1178− "protocolMapper": "saml-role-list-mapper",

1179− "consentRequired": false,

1180− "config": {

1181− "single": "false",

1182− "attribute.nameformat": "Basic",

1183− "attribute.name": "Role"

1184− }

1185− }

1186− ]

1187− },

1188− {

1189− "id": "13ec0fd3-e64a-4d6f-9be7-c8760f2c9d6b",

1190− "name": "roles",

1191− "description": "OpenID Connect scope for add user roles to the access token",

1192− "protocol": "openid-connect",

1193− "attributes": {

1194− "include.in.token.scope": "false",

1195− "display.on.consent.screen": "true",

1196− "consent.screen.text": "${rolesScopeConsentText}"

1197− },

1198− "protocolMappers": [

1199− {

1200− "id": "75e741f8-dcd5-49d2-815e-8604ec1d08a1",

1201− "name": "realm roles",

1202− "protocol": "openid-connect",

1203− "protocolMapper": "oidc-usermodel-realm-role-mapper",

1204− "consentRequired": false,

1205− "config": {

1206− "user.attribute": "foo",

1207− "access.token.claim": "true",

1208− "claim.name": "realm_access.roles",

1209− "jsonType.label": "String",

1210− "multivalued": "true"

1211− }

1212− },

1213− {

1214− "id": "06a2d506-4996-4a33-8c43-2cf64af6a630",

1215− "name": "client roles",

1216− "protocol": "openid-connect",

1217− "protocolMapper": "oidc-usermodel-client-role-mapper",

1218− "consentRequired": false,

1219− "config": {

1220− "user.attribute": "foo",

1221− "access.token.claim": "true",

1222− "claim.name": "resource_access.${client_id}.roles",

1223− "jsonType.label": "String",

1224− "multivalued": "true"

1225− }

1226− },

1227− {

1228− "id": "3c3470df-d414-4e1c-87fc-3fb3cea34b8d",

1229− "name": "audience resolve",

1230− "protocol": "openid-connect",

1231− "protocolMapper": "oidc-audience-resolve-mapper",

1232− "consentRequired": false,

1233− "config": {}

1234− }

1235− ]

1236− },

1237− {

1238− "id": "d85aba25-c74b-49e3-9ccb-77b4bb16efa5",

1239− "name": "web-origins",

1240− "description": "OpenID Connect scope for add allowed web origins to the access token",

1241− "protocol": "openid-connect",

1242− "attributes": {

1243− "include.in.token.scope": "false",

1244− "display.on.consent.screen": "false",

1245− "consent.screen.text": ""

1246− },

1247− "protocolMappers": [

1248− {

1249− "id": "86b3f64f-1525-4500-bcbc-9b889b25f995",

1250− "name": "allowed web origins",

1251− "protocol": "openid-connect",

1252− "protocolMapper": "oidc-allowed-origins-mapper",

1253− "consentRequired": false,

1254− "config": {}

1255− }

1256− ]

1257− }

1258− ],

1259− "defaultDefaultClientScopes": [

1260− "roles",

1261− "profile",

1262− "role_list",

1263− "email",

1264− "web-origins"

1265− ],

1266− "defaultOptionalClientScopes": [

1267− "phone",

1268− "address",

1269− "offline_access",

1270− "microprofile-jwt"

1271− ],

1272− "browserSecurityHeaders": {

1273− "contentSecurityPolicyReportOnly": "",

1274− "xContentTypeOptions": "nosniff",

1275− "xRobotsTag": "none",

1276− "xFrameOptions": "SAMEORIGIN",

1277− "xXSSProtection": "1; mode=block",

1278− "contentSecurityPolicy": "frame-src 'self'; frame-ancestors 'self'; object-src 'none';",

1279− "strictTransportSecurity": "max-age=31536000; includeSubDomains"

1280− },

1281− "smtpServer": {},

1282− "eventsEnabled": false,

1283− "eventsListeners": [

1284− "jboss-logging"

1285− ],

1286− "enabledEventTypes": [],

1287− "adminEventsEnabled": false,

1288− "adminEventsDetailsEnabled": false,

1289− "components": {

1290− "org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy": [

1291− {

1292− "id": "59048b39-ad0f-4d12-8c52-7cfc2c43278a",

1293− "name": "Allowed Protocol Mapper Types",

1294− "providerId": "allowed-protocol-mappers",

1295− "subType": "authenticated",

1296− "subComponents": {},

1297− "config": {

1298− "allowed-protocol-mapper-types": [

1299− "saml-user-attribute-mapper",

1300− "oidc-full-name-mapper",

1301− "oidc-sha256-pairwise-sub-mapper",

1302− "saml-user-property-mapper",

1303− "saml-role-list-mapper",

1304− "oidc-address-mapper",

1305− "oidc-usermodel-attribute-mapper",

1306− "oidc-usermodel-property-mapper"

1307− ]

1308− }

1309− },

1310− {

1311− "id": "760559a6-a59f-4175-9ac5-6f3612e20129",

1312− "name": "Trusted Hosts",

1313− "providerId": "trusted-hosts",

1314− "subType": "anonymous",

1315− "subComponents": {},

1316− "config": {

1317− "host-sending-registration-request-must-match": [

1318− "true"

1319− ],

1320− "client-uris-must-match": [

1321− "true"

1322− ]

1323− }

1324− },

1325− {

1326− "id": "24f4cb42-76bd-499e-812a-4e0d270c9e13",

1327− "name": "Full Scope Disabled",

1328− "providerId": "scope",

1329− "subType": "anonymous",

1330− "subComponents": {},

1331− "config": {}

1332− },

1333− {

1334− "id": "abbfc599-480a-44ef-8e33-73a83eaab166",

1335− "name": "Allowed Protocol Mapper Types",

1336− "providerId": "allowed-protocol-mappers",

1337− "subType": "anonymous",

1338− "subComponents": {},

1339− "config": {

1340− "allowed-protocol-mapper-types": [

1341− "saml-user-attribute-mapper",

1342− "oidc-sha256-pairwise-sub-mapper",

1343− "oidc-full-name-mapper",

1344− "saml-role-list-mapper",

1345− "saml-user-property-mapper",

1346− "oidc-usermodel-property-mapper",

1347− "oidc-usermodel-attribute-mapper",

1348− "oidc-address-mapper"

1349− ]

1350− }

1351− },

1352− {

1353− "id": "3c6450f0-4521-402b-a247-c8165854b1fa",

1354− "name": "Allowed Client Scopes",

1355− "providerId": "allowed-client-templates",

1356− "subType": "anonymous",

1357− "subComponents": {},

1358− "config": {

1359− "allow-default-scopes": [

1360− "true"

1361− ]

1362− }

1363− },

1364− {

1365− "id": "d9b64399-744b-498e-9d35-f68b1582bd7d",

1366− "name": "Consent Required",

1367− "providerId": "consent-required",

1368− "subType": "anonymous",

1369− "subComponents": {},

1370− "config": {}

1371− },

1372− {

1373− "id": "22f15f1f-3116-4348-a1e5-fc0d7576452a",

1374− "name": "Max Clients Limit",

1375− "providerId": "max-clients",

1376− "subType": "anonymous",

1377− "subComponents": {},

1378− "config": {

1379− "max-clients": [

1380− "200"

1381− ]

1382− }

1383− },

1384− {

1385− "id": "4ad7b291-ddbb-4674-8c3d-ab8fd76d4168",

1386− "name": "Allowed Client Scopes",

1387− "providerId": "allowed-client-templates",

1388− "subType": "authenticated",

1389− "subComponents": {},

1390− "config": {

1391− "allow-default-scopes": [

1392− "true"

1393− ]

1394− }

1395− }

1396− ],

1397− "org.keycloak.keys.KeyProvider": [

1398− {

1399− "id": "f71cc325-9907-4d27-a0e6-88fca7450e5e",

1400− "name": "aes-generated",

1401− "providerId": "aes-generated",

1402− "subComponents": {},

1403− "config": {

1404− "kid": [

1405− "6c7d982e-372f-49c6-a4f3-5c451fb85eca"

1406− ],

1407− "secret": [

1408− "yH6M3W7aOgh2_cKJ0srWbw"

1409− ],

1410− "priority": [

1411− "100"

1412− ]

1413− }

1414− },

1415− {

1416− "id": "7b50d0ab-dda5-4624-aa42-b4b397724ce1",

1417− "name": "hmac-generated",

1418− "providerId": "hmac-generated",

1419− "subComponents": {},

1420− "config": {

1421− "kid": [

1422− "587f0fb5-845d-4b45-87a0-84145092aaef"

1423− ],

1424− "secret": [

1425− "PuH8Lxh9GeNfGJRDk34SWIlBDdrJpC3U3SfcxqqQtlIf2DBzRKUu8VbDVrmMN5b5CoPsJhrQ2SVb-iE9Lzsb3A"

1426− ],

1427− "priority": [

1428− "100"

1429− ],

1430− "algorithm": [

1431− "HS256"

1432− ]

1433− }

1434− },

1435− {

1436− "id": "547c1c71-9f97-4e12-801b-ed5c2cc61bba",

1437− "name": "rsa-generated",

1438− "providerId": "rsa-generated",

1439− "subComponents": {},

1440− "config": {

1441− "privateKey": [

1442− "MIIEowIBAAKCAQEAjdo2HZ5ruNnIbkSeAfFYpbPvJw3vtz/VuKJerC4mUXYd7qRMhs3VLJZ3mFyeCuO8W81vkGrFiC9KQnX2lHj2dtA/RWEJw5bpz+JdOFr5pvXg0lQ0sa+hro9afWDygTU4FmLsEi5z98847TbH178RT6n7+JVqZ9jYU9rSpwVTC8E/4yxSuStmhGCcAkZ6dGhHNBdvGUgwxKYj7dYLRJiI+nilIdKuxPzxI/YZxZnXBHDdbNXJgDymTQPut99OnBxeZbH38CJ1MNo3VdV1fzOMGUHe+vn/EOD5E+pXC8PwvJnWU+XHUTFVZeyIXehh3pYLUsq/6bZ1MYsEaFIhznOkwwIDAQABAoIBAHB+64fVyUxRurhoRn737fuLlU/9p2xGfbHtYvNdrhnQeLB3MBGAT10K/1Gfsd6k+Q49AAsiAgGcr2HBt4nL3HohcOwOpvWsS0UIGjHFRFP6jw9+pEN+K9UJ7xObvPZnRFHMpbdNi76tYlINrbMV3h61ihR8OmSc/gKSeZjnihK5OkaNnlqGRaBM/koI+iAxUHuJPnBLBZmD4T8eIfE4S2TvUeVeQogI9Muvnb9tIPJ5XyP9iXWLdRjnek/+wTdxHHZuo06Tc0bMjRaTHiF6K9ntOM2EmQb6bS2J47zgzRLNFE22BWH7RJq659EzElkOn0C0k7dWDTur/3Lpx1+zxJECgYEA8t+J3J+9oGTFmY2VPH05Yr/R/iVDOyIOlO1CmgonOQ3KPhbfNBB3aTAJP20LOZChN4JoWuiZJg4UwzXOeY9DvdDkPO0YLlSjPAIwJNk+xcxFcp5hqMUul2db+cgEY8zp0Wg9kFOq3JmJjK4+1+fgsVnOB+B08ZYI6bZzsUVKzucCgYEAlYTrsxs6fQua0cvZNQPYNZzwF3LVwPBl/ntkdRBE3HGyZeCAhIj7e9pAUusCPsQJaCmW2UEmywD/aIxGrBkojzTKItshM3PN1PYKL8W0Zq+H67uF5KfdvsbabZWHfP/LGCpoKF8Ov7JVPPqGrZ03Z2SheeLZAtNeHN4OB1u9i8UCgYATkS7qN3Rvl67T0DRVy0D0U7/3Wckw2m2SUgsrneXLEvFYTz9sUmdMcjJMidx9pslWT4tYx6SPDFNf5tXbtU8f29SHlBJ+qRL9oq9+SIJmLS7rLRdxIXG/gPRIC3VPFRNBa8SJ/DOn0jbivqcRffz8TN/sgojpbc0KB0kK3ypHwQKBgCKVCcb1R0PgyUA4+9YNO5a647UotFPZxl1jwMpqpuKt0WtKz67X2AK/ah1DidNmmB5lcCRzsztE0c4mk7n+X6kvtoj1UeqKoFLfTV/bRGxzsOZPCxrl0J3tdFvgN+QrbZf7Rvf/dHPWFWzzLO8+66+YUNjWJQdIR/45Rdlh2KdZAoGBAMfF3ir+fe3KdQ6hAf9QyrLxJ5l+GO+IgtxXGbon7eeJBIZHHdMeDy4pC7DMcI214BmIntbyY+xS+gI3oM26EJUVmrZ6tkyIDFsCHm9rcXG9ogvffzQWM1Wqzm27hR/3s+EPWW9AOcIimiFV1UPp/mLjnrCuq58V2aJS/TT14oLe"

1443− ],

1444− "certificate": [

1445− "MIICmzCCAYMCBgFygL/j4DANBgkqhkiG9w0BAQsFADARMQ8wDQYDVQQDDAZtYXN0ZXIwHhcNMjAwNjA0MTkxMDU4WhcNMzAwNjA0MTkxMjM4WjARMQ8wDQYDVQQDDAZtYXN0ZXIwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCN2jYdnmu42chuRJ4B8Vils+8nDe+3P9W4ol6sLiZRdh3upEyGzdUslneYXJ4K47xbzW+QasWIL0pCdfaUePZ20D9FYQnDlunP4l04Wvmm9eDSVDSxr6Guj1p9YPKBNTgWYuwSLnP3zzjtNsfXvxFPqfv4lWpn2NhT2tKnBVMLwT/jLFK5K2aEYJwCRnp0aEc0F28ZSDDEpiPt1gtEmIj6eKUh0q7E/PEj9hnFmdcEcN1s1cmAPKZNA+63306cHF5lsffwInUw2jdV1XV/M4wZQd76+f8Q4PkT6lcLw/C8mdZT5cdRMVVl7Ihd6GHelgtSyr/ptnUxiwRoUiHOc6TDAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAIAqydMYxa51kNEyfXyR2kStlglE4LDeLBLHDABeBPE0eN2awoH/mw3kXS4OA/C0e3c7bAwViOzOVERGeUNiBvP5rL1Amuu97nwFcxhkTaJH4ZwCGkxceaIo9LNDpAEesqHLQSdplFXIA4TbEFoKMem4k31KVU7i9/rUesrSRmxLptIOK7LLvRMYiY/t7tdAvoZAtoliuQlFKQywEuxXQrCkcoVEAARABWGt0rsWC2xK0tVxHRIrENwvMp/aUYd17sZ0403aaS9dlvfQ63ExnaHd+++RJtPku8P220Tw27YVmFAwzJgS0aUpEaDsgRNz6OMSyxEg/n7eKK08aU3szwQ="

1446− ],

1447− "priority": [

1448− "100"

1449− ]

1450− }

1451− }

1452− ]

1453− },

1454− "internationalizationEnabled": false,

1455− "supportedLocales": [],

1456− "authenticationFlows": [

1457− {

1458− "id": "3253f9b7-905d-4458-ad8a-8ada5e16d195",

1459− "alias": "Account verification options",

1460− "description": "Method with which to verity the existing account",

1461− "providerId": "basic-flow",

1462− "topLevel": false,

1463− "builtIn": true,

1464− "authenticationExecutions": [

1465− {

1466− "authenticator": "idp-email-verification",

1467− "requirement": "ALTERNATIVE",

1468− "priority": 10,

1469− "userSetupAllowed": false,

1470− "autheticatorFlow": false

1471− },

1472− {

1473− "requirement": "ALTERNATIVE",

1474− "priority": 20,

1475− "flowAlias": "Verify Existing Account by Re-authentication",

1476− "userSetupAllowed": false,

1477− "autheticatorFlow": true

1478− }

1479− ]

1480− },

1481− {

1482− "id": "75bd854e-ab99-46f1-90ed-a8bfc1559558",

1483− "alias": "Authentication Options",

1484− "description": "Authentication options.",

1485− "providerId": "basic-flow",

1486− "topLevel": false,

1487− "builtIn": true,

1488− "authenticationExecutions": [

1489− {

1490− "authenticator": "basic-auth",

1491− "requirement": "REQUIRED",

1492− "priority": 10,

1493− "userSetupAllowed": false,

1494− "autheticatorFlow": false

1495− },

1496− {

1497− "authenticator": "basic-auth-otp",

1498− "requirement": "DISABLED",

1499− "priority": 20,

1500− "userSetupAllowed": false,

1501− "autheticatorFlow": false

1502− },

1503− {

1504− "authenticator": "auth-spnego",

1505− "requirement": "DISABLED",

1506− "priority": 30,

1507− "userSetupAllowed": false,

1508− "autheticatorFlow": false

1509− }

1510− ]

1511− },

1512− {

1513− "id": "9b0e6cce-62c5-4fb6-a48d-e07c950e38c3",

1514− "alias": "Browser - Conditional OTP",

1515− "description": "Flow to determine if the OTP is required for the authentication",

1516− "providerId": "basic-flow",

1517− "topLevel": false,

1518− "builtIn": true,

1519− "authenticationExecutions": [

1520− {

1521− "authenticator": "conditional-user-configured",

1522− "requirement": "REQUIRED",

1523− "priority": 10,

1524− "userSetupAllowed": false,

1525− "autheticatorFlow": false

1526− },

1527− {

1528− "authenticator": "auth-otp-form",

1529− "requirement": "REQUIRED",

1530− "priority": 20,

1531− "userSetupAllowed": false,

1532− "autheticatorFlow": false

1533− }

1534− ]

1535− },

1536− {

1537− "id": "1c26fd14-ac06-4dc1-bdd8-8c34c1b41720",

1538− "alias": "Direct Grant - Conditional OTP",

1539− "description": "Flow to determine if the OTP is required for the authentication",

1540− "providerId": "basic-flow",

1541− "topLevel": false,

1542− "builtIn": true,

1543− "authenticationExecutions": [

1544− {

1545− "authenticator": "conditional-user-configured",

1546− "requirement": "REQUIRED",

1547− "priority": 10,

1548− "userSetupAllowed": false,

1549− "autheticatorFlow": false

1550− },

1551− {

1552− "authenticator": "direct-grant-validate-otp",

1553− "requirement": "REQUIRED",

1554− "priority": 20,

1555− "userSetupAllowed": false,

1556− "autheticatorFlow": false

1557− }

1558− ]

1559− },

1560− {

1561− "id": "254f7549-51ec-4565-a736-35c07b6e25f0",

1562− "alias": "First broker login - Conditional OTP",

1563− "description": "Flow to determine if the OTP is required for the authentication",

1564− "providerId": "basic-flow",

1565− "topLevel": false,

1566− "builtIn": true,

1567− "authenticationExecutions": [

1568− {

1569− "authenticator": "conditional-user-configured",

1570− "requirement": "REQUIRED",

1571− "priority": 10,

1572− "userSetupAllowed": false,

1573− "autheticatorFlow": false

1574− },

1575− {

1576− "authenticator": "auth-otp-form",

1577− "requirement": "REQUIRED",

1578− "priority": 20,

1579− "userSetupAllowed": false,

1580− "autheticatorFlow": false

1581− }

1582− ]

1583− },

1584− {

1585− "id": "b2413da8-3de9-4bfe-b77e-643fd1964c8f",

1586− "alias": "Handle Existing Account",

1587− "description": "Handle what to do if there is existing account with same email/username like authenticated identity provider",

1588− "providerId": "basic-flow",

1589− "topLevel": false,

1590− "builtIn": true,

1591− "authenticationExecutions": [

1592− {

1593− "authenticator": "idp-confirm-link",

1594− "requirement": "REQUIRED",

1595− "priority": 10,

1596− "userSetupAllowed": false,

1597− "autheticatorFlow": false

1598− },

1599− {

1600− "requirement": "REQUIRED",

1601− "priority": 20,

1602− "flowAlias": "Account verification options",

1603− "userSetupAllowed": false,

1604− "autheticatorFlow": true

1605− }

1606− ]

1607− },

1608− {

1609− "id": "f8392bfb-8dce-4a16-8af1-b2a4d1a0a273",

1610− "alias": "Reset - Conditional OTP",

1611− "description": "Flow to determine if the OTP should be reset or not. Set to REQUIRED to force.",

1612− "providerId": "basic-flow",

1613− "topLevel": false,

1614− "builtIn": true,

1615− "authenticationExecutions": [

1616− {

1617− "authenticator": "conditional-user-configured",

1618− "requirement": "REQUIRED",

1619− "priority": 10,

1620− "userSetupAllowed": false,

1621− "autheticatorFlow": false

1622− },

1623− {

1624− "authenticator": "reset-otp",

1625− "requirement": "REQUIRED",

1626− "priority": 20,

1627− "userSetupAllowed": false,

1628− "autheticatorFlow": false

1629− }

1630− ]

1631− },

1632− {

1633− "id": "fb69c297-b26e-44fa-aabd-d7b40eec3cd3",

1634− "alias": "User creation or linking",

1635− "description": "Flow for the existing/non-existing user alternatives",

1636− "providerId": "basic-flow",

1637− "topLevel": false,

1638− "builtIn": true,

1639− "authenticationExecutions": [

1640− {

1641− "authenticatorConfig": "create unique user config",

1642− "authenticator": "idp-create-user-if-unique",

1643− "requirement": "ALTERNATIVE",

1644− "priority": 10,

1645− "userSetupAllowed": false,

1646− "autheticatorFlow": false

1647− },

1648− {

1649− "requirement": "ALTERNATIVE",

1650− "priority": 20,

1651− "flowAlias": "Handle Existing Account",

1652− "userSetupAllowed": false,

1653− "autheticatorFlow": true

1654− }

1655− ]

1656− },

1657− {

1658− "id": "de3a41a9-7018-4931-9c4d-d04f9501b2ce",

1659− "alias": "Verify Existing Account by Re-authentication",

1660− "description": "Reauthentication of existing account",

1661− "providerId": "basic-flow",

1662− "topLevel": false,

1663− "builtIn": true,

1664− "authenticationExecutions": [

1665− {

1666− "authenticator": "idp-username-password-form",

1667− "requirement": "REQUIRED",

1668− "priority": 10,

1669− "userSetupAllowed": false,

1670− "autheticatorFlow": false

1671− },

1672− {

1673− "requirement": "CONDITIONAL",

1674− "priority": 20,

1675− "flowAlias": "First broker login - Conditional OTP",

1676− "userSetupAllowed": false,

1677− "autheticatorFlow": true

1678− }

1679− ]

1680− },

1681− {

1682− "id": "6526b0d1-b48e-46c6-bb08-11ebcf458def",

1683− "alias": "browser",

1684− "description": "browser based authentication",

1685− "providerId": "basic-flow",

1686− "topLevel": true,

1687− "builtIn": true,

1688− "authenticationExecutions": [

1689− {

1690− "authenticator": "auth-cookie",

1691− "requirement": "ALTERNATIVE",

1692− "priority": 10,

1693− "userSetupAllowed": false,

1694− "autheticatorFlow": false

1695− },

1696− {

1697− "authenticator": "auth-spnego",

1698− "requirement": "DISABLED",

1699− "priority": 20,

1700− "userSetupAllowed": false,

1701− "autheticatorFlow": false

1702− },

1703− {

1704− "authenticator": "identity-provider-redirector",

1705− "requirement": "ALTERNATIVE",

1706− "priority": 25,

1707− "userSetupAllowed": false,

1708− "autheticatorFlow": false

1709− },

1710− {

1711− "requirement": "ALTERNATIVE",

1712− "priority": 30,

1713− "flowAlias": "forms",

1714− "userSetupAllowed": false,

1715− "autheticatorFlow": true

1716− }

1717− ]

1718− },

1719− {

1720− "id": "92a653ba-8f2d-4283-8354-ca55f9d89181",

1721− "alias": "clients",

1722− "description": "Base authentication for clients",

1723− "providerId": "client-flow",

1724− "topLevel": true,

1725− "builtIn": true,

1726− "authenticationExecutions": [

1727− {

1728− "authenticator": "client-secret",

1729− "requirement": "ALTERNATIVE",

1730− "priority": 10,

1731− "userSetupAllowed": false,

1732− "autheticatorFlow": false

1733− },

1734− {

1735− "authenticator": "client-jwt",

1736− "requirement": "ALTERNATIVE",

1737− "priority": 20,

1738− "userSetupAllowed": false,

1739− "autheticatorFlow": false

1740− },

1741− {

1742− "authenticator": "client-secret-jwt",

1743− "requirement": "ALTERNATIVE",

1744− "priority": 30,

1745− "userSetupAllowed": false,

1746− "autheticatorFlow": false

1747− },

1748− {

1749− "authenticator": "client-x509",

1750− "requirement": "ALTERNATIVE",

1751− "priority": 40,

1752− "userSetupAllowed": false,

1753− "autheticatorFlow": false

1754− }

1755− ]

1756− },

1757− {

1758− "id": "e365be39-78db-46f0-b2e8-4e7001c2f5d0",

1759− "alias": "direct grant",

1760− "description": "OpenID Connect Resource Owner Grant",

1761− "providerId": "basic-flow",

1762− "topLevel": true,

1763− "builtIn": true,

1764− "authenticationExecutions": [

1765− {

1766− "authenticator": "direct-grant-validate-username",

1767− "requirement": "REQUIRED",

1768− "priority": 10,

1769− "userSetupAllowed": false,

1770− "autheticatorFlow": false

1771− },

1772− {

1773− "authenticator": "direct-grant-validate-password",

1774− "requirement": "REQUIRED",

1775− "priority": 20,

1776− "userSetupAllowed": false,

1777− "autheticatorFlow": false

1778− },

1779− {

1780− "requirement": "CONDITIONAL",

1781− "priority": 30,

1782− "flowAlias": "Direct Grant - Conditional OTP",

1783− "userSetupAllowed": false,

1784− "autheticatorFlow": true

1785− }

1786− ]

1787− },

1788− {

1789− "id": "dd61caf5-a40f-48b7-9e8c-a1f3b67041dd",

1790− "alias": "docker auth",

1791− "description": "Used by Docker clients to authenticate against the IDP",

1792− "providerId": "basic-flow",

1793− "topLevel": true,

1794− "builtIn": true,

1795− "authenticationExecutions": [

1796− {

1797− "authenticator": "docker-http-basic-authenticator",

1798− "requirement": "REQUIRED",

1799− "priority": 10,

1800− "userSetupAllowed": false,

1801− "autheticatorFlow": false

1802− }

1803− ]

1804− },

1805− {

1806− "id": "7a055643-62e1-4ac1-b126-9a8d6c299635",

1807− "alias": "first broker login",

1808− "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account",

1809− "providerId": "basic-flow",

1810− "topLevel": true,

1811− "builtIn": true,

1812− "authenticationExecutions": [

1813− {

1814− "authenticatorConfig": "review profile config",

1815− "authenticator": "idp-review-profile",

1816− "requirement": "REQUIRED",

1817− "priority": 10,

1818− "userSetupAllowed": false,

1819− "autheticatorFlow": false

1820− },

1821− {

1822− "requirement": "REQUIRED",

1823− "priority": 20,

1824− "flowAlias": "User creation or linking",

1825− "userSetupAllowed": false,

1826− "autheticatorFlow": true

1827− }

1828− ]

1829− },

1830− {

1831− "id": "fe8bc7ee-6e8f-436e-8336-c60fcd350843",

1832− "alias": "forms",

1833− "description": "Username, password, otp and other auth forms.",

1834− "providerId": "basic-flow",

1835− "topLevel": false,

1836− "builtIn": true,

1837− "authenticationExecutions": [

1838− {

1839− "authenticator": "auth-username-password-form",

1840− "requirement": "REQUIRED",

1841− "priority": 10,

1842− "userSetupAllowed": false,

1843− "autheticatorFlow": false

1844− },

1845− {

1846− "requirement": "CONDITIONAL",

1847− "priority": 20,

1848− "flowAlias": "Browser - Conditional OTP",

1849− "userSetupAllowed": false,

1850− "autheticatorFlow": true

1851− }

1852− ]

1853− },

1854− {

1855− "id": "3646f08e-ab70-415b-a701-6ed2e2d214c9",

1856− "alias": "http challenge",

1857− "description": "An authentication flow based on challenge-response HTTP Authentication Schemes",

1858− "providerId": "basic-flow",

1859− "topLevel": true,

1860− "builtIn": true,

1861− "authenticationExecutions": [

1862− {

1863− "authenticator": "no-cookie-redirect",

1864− "requirement": "REQUIRED",

1865− "priority": 10,

1866− "userSetupAllowed": false,

1867− "autheticatorFlow": false

1868− },

1869− {

1870− "requirement": "REQUIRED",

1871− "priority": 20,

1872− "flowAlias": "Authentication Options",

1873− "userSetupAllowed": false,

1874− "autheticatorFlow": true

1875− }

1876− ]

1877− },

1878− {

1879− "id": "04176530-0972-47ad-83df-19d8534caac2",

1880− "alias": "registration",

1881− "description": "registration flow",

1882− "providerId": "basic-flow",

1883− "topLevel": true,

1884− "builtIn": true,

1885− "authenticationExecutions": [

1886− {

1887− "authenticator": "registration-page-form",

1888− "requirement": "REQUIRED",

1889− "priority": 10,

1890− "flowAlias": "registration form",

1891− "userSetupAllowed": false,

1892− "autheticatorFlow": true

1893− }

1894− ]

1895− },

1896− {

1897− "id": "fa0ed569-6746-439e-b07e-89f7ed918c07",

1898− "alias": "registration form",

1899− "description": "registration form",

1900− "providerId": "form-flow",

1901− "topLevel": false,

1902− "builtIn": true,

1903− "authenticationExecutions": [

1904− {

1905− "authenticator": "registration-user-creation",

1906− "requirement": "REQUIRED",

1907− "priority": 20,

1908− "userSetupAllowed": false,

1909− "autheticatorFlow": false

1910− },

1911− {

1912− "authenticator": "registration-profile-action",

1913− "requirement": "REQUIRED",

1914− "priority": 40,

1915− "userSetupAllowed": false,

1916− "autheticatorFlow": false

1917− },

1918− {

1919− "authenticator": "registration-password-action",

1920− "requirement": "REQUIRED",

1921− "priority": 50,

1922− "userSetupAllowed": false,

1923− "autheticatorFlow": false

1924− },

1925− {

1926− "authenticator": "registration-recaptcha-action",

1927− "requirement": "DISABLED",

1928− "priority": 60,

1929− "userSetupAllowed": false,

1930− "autheticatorFlow": false

1931− }

1932− ]

1933− },

1934− {

1935− "id": "03680917-28f3-4ccd-bdf6-4a516f7c0018",

1936− "alias": "reset credentials",

1937− "description": "Reset credentials for a user if they forgot their password or something",

1938− "providerId": "basic-flow",

1939− "topLevel": true,

1940− "builtIn": true,

1941− "authenticationExecutions": [

1942− {

1943− "authenticator": "reset-credentials-choose-user",

1944− "requirement": "REQUIRED",

1945− "priority": 10,

1946− "userSetupAllowed": false,

1947− "autheticatorFlow": false

1948− },

1949− {

1950− "authenticator": "reset-credential-email",

1951− "requirement": "REQUIRED",

1952− "priority": 20,

1953− "userSetupAllowed": false,

1954− "autheticatorFlow": false

1955− },

1956− {

1957− "authenticator": "reset-password",

1958− "requirement": "REQUIRED",

1959− "priority": 30,

1960− "userSetupAllowed": false,

1961− "autheticatorFlow": false

1962− },

1963− {

1964− "requirement": "CONDITIONAL",

1965− "priority": 40,

1966− "flowAlias": "Reset - Conditional OTP",

1967− "userSetupAllowed": false,

1968− "autheticatorFlow": true

1969− }

1970− ]

1971− },

1972− {

1973− "id": "19a9d9aa-2d2b-4701-807f-c384ab921c7e",

1974− "alias": "saml ecp",

1975− "description": "SAML ECP Profile Authentication Flow",

1976− "providerId": "basic-flow",

1977− "topLevel": true,

1978− "builtIn": true,

1979− "authenticationExecutions": [

1980− {

1981− "authenticator": "http-basic-authenticator",

1982− "requirement": "REQUIRED",

1983− "priority": 10,

1984− "userSetupAllowed": false,

1985− "autheticatorFlow": false

1986− }

1987− ]

1988− }

1989− ],

1990− "authenticatorConfig": [

1991− {

1992− "id": "534f01f4-45b3-43a0-91d1-238860cc126d",

1993− "alias": "create unique user config",

1994− "config": {

1995− "require.password.update.after.registration": "false"

1996− }

1997− },

1998− {

1999− "id": "65bb9337-9633-4a21-8f6f-1d4129f664ac",

2000− "alias": "review profile config",

2001− "config": {

2002− "update.profile.on.first.login": "missing"

2003− }

2004− }

2005− ],

2006− "requiredActions": [

2007− {

2008− "alias": "CONFIGURE_TOTP",

2009− "name": "Configure OTP",

2010− "providerId": "CONFIGURE_TOTP",

2011− "enabled": true,

2012− "defaultAction": false,

2013− "priority": 10,

2014− "config": {}

2015− },

2016− {

2017− "alias": "terms_and_conditions",

2018− "name": "Terms and Conditions",

2019− "providerId": "terms_and_conditions",

2020− "enabled": false,

2021− "defaultAction": false,

2022− "priority": 20,

2023− "config": {}

2024− },

2025− {

2026− "alias": "UPDATE_PASSWORD",

2027− "name": "Update Password",

2028− "providerId": "UPDATE_PASSWORD",

2029− "enabled": true,

2030− "defaultAction": false,

2031− "priority": 30,

2032− "config": {}

2033− },

2034− {

2035− "alias": "UPDATE_PROFILE",

2036− "name": "Update Profile",

2037− "providerId": "UPDATE_PROFILE",

2038− "enabled": true,

2039− "defaultAction": false,

2040− "priority": 40,

2041− "config": {}

2042− },

2043− {

2044− "alias": "VERIFY_EMAIL",

2045− "name": "Verify Email",

2046− "providerId": "VERIFY_EMAIL",

2047− "enabled": true,

2048− "defaultAction": false,

2049− "priority": 50,

2050− "config": {}

2051− },

2052− {

2053− "alias": "update_user_locale",

2054− "name": "Update User Locale",

2055− "providerId": "update_user_locale",

2056− "enabled": true,

2057− "defaultAction": false,

2058− "priority": 1000,

2059− "config": {}

2060− }

2061− ],

2062− "browserFlow": "browser",

2063− "registrationFlow": "registration",

2064− "directGrantFlow": "direct grant",

2065− "resetCredentialsFlow": "reset credentials",

2066− "clientAuthenticationFlow": "clients",

2067− "dockerAuthenticationFlow": "docker auth",

2068− "attributes": {},

2069− "keycloakVersion": "10.0.0",

2070− "userManagedAccessAllowed": false

2071−}

contrib/local-environment/keycloak/oauth2-proxy-users-0.jsondeleted−38

@@ -1,38 +0,0 @@

1−{

2− "realm": "oauth2-proxy",

3− "users": [

4− {

5− "id": "3356c0a0-d4d5-4436-9c5a-2299c71c08ec",

6− "createdTimestamp": 1591297959169,

7− "username": "admin@example.com",

8− "email": "admin@example.com",

9− "enabled": true,

10− "totp": false,

11− "emailVerified": true,

12− "credentials": [

13− {

14− "id": "a1a06ecd-fdc0-4e67-92cd-2da22d724e32",

15− "type": "password",

16− "createdDate": 1591297959315,

17− "secretData": "{\"value\":\"6rt5zuqHVHopvd0FTFE0CYadXTtzY0mDY2BrqnNQGS51/7DfMJeGgj0roNnGMGvDv30imErNmiSOYl+cL9jiIA==\",\"salt\":\"LI0kqr09JB7J9wvr2Hxzzg==\"}",

18− "credentialData": "{\"hashIterations\":27500,\"algorithm\":\"pbkdf2-sha256\"}"

19− }

20− ],

21− "disableableCredentialTypes": [],

22− "requiredActions": [],

23− "realmRoles": [

24− "offline_access",

25− "admin",

26− "uma_authorization"

27− ],

28− "clientRoles": {

29− "account": [

30− "view-profile",

31− "manage-account"

32− ]

33− },

34− "notBefore": 0,

35− "groups": []

36− }

37− ]

38−}

contrib/local-environment/kubernetes/Chart.lock+8−8

@@ -1,15 +1,15 @@

1dependencies:

1dependencies:

2- name: dex

2- name: dex

3− repository: https://charts.dexidp.io

3+ repository: https://charts.helm.sh/stable

4− version: 0.24.1

4+ version: 2.11.0

5- name: oauth2-proxy

5- name: oauth2-proxy

6− repository: https://oauth2-proxy.github.io/manifests

6+ repository: https://charts.helm.sh/stable

7− version: 7.18.0

7+ version: 3.1.0

8- name: httpbin

8- name: httpbin

9 repository: https://conservis.github.io/helm-charts

9 repository: https://conservis.github.io/helm-charts

10− version: 1.1.0

10+ version: 1.0.1

11- name: hello-world

11- name: hello-world

12 repository: https://conservis.github.io/helm-charts

12 repository: https://conservis.github.io/helm-charts

13− version: 1.1.0

13+ version: 1.0.1

14−digest: sha256:3fff8bf99cebcd20a73c984423d5f1c2dfa1e5a394f82a5dc60d9aaffe5361b7

14+digest: sha256:e325948ece1706bd9d9e439568985db41e9a0d57623d0f9638249cb0d23821b8

15−generated: "2026-08-18T07:33:03.791274914Z"

15+generated: "2020-11-23T11:45:07.908898-08:00"

contrib/local-environment/kubernetes/Chart.yaml+8−7

@@ -1,18 +1,19 @@

1apiVersion: v2

1apiVersion: v2

2description: K8S example based on https://kind.sigs.k8s.io

2description: K8S example based on https://kind.sigs.k8s.io

3name: kubernetes

3name: kubernetes

4+version: 5.1.1

5+appVersion: 5.1.1

4dependencies:

6dependencies:

5 - name: dex

7 - name: dex

6− version: 0.24.1

8+ version: 2.11.0

7− repository: https://charts.dexidp.io

9+ repository: https://charts.helm.sh/stable

8 - name: oauth2-proxy

10 - name: oauth2-proxy

9− version: &chartVersion 7.18.0

11+ version: 3.1.0

10− repository: https://oauth2-proxy.github.io/manifests

12+ repository: https://charts.helm.sh/stable

11 # https://github.com/postmanlabs/httpbin/issues/549 is still in progress, for now using a non-official chart

13 # https://github.com/postmanlabs/httpbin/issues/549 is still in progress, for now using a non-official chart

12 - name: httpbin

14 - name: httpbin

13− version: 1.1.0

15+ version: 1.0.1

14 repository: https://conservis.github.io/helm-charts

16 repository: https://conservis.github.io/helm-charts

15 - name: hello-world

17 - name: hello-world

16− version: 1.1.0

18+ version: 1.0.1

17 repository: https://conservis.github.io/helm-charts

19 repository: https://conservis.github.io/helm-charts

18−version: *chartVersion

contrib/local-environment/kubernetes/Makefile+10−2

@@ -30,13 +30,15 @@ delete-cluster:

30 kind delete cluster --name oauth2-proxy

30 kind delete cluster --name oauth2-proxy

31

31

32.PHONY: deploy

32.PHONY: deploy

33−deploy: helm-deploy

33+deploy:

34+ kubectl apply -f oauth2-proxy-example-full.yaml

34 kubectl rollout status --timeout 5m deployment/oauth2-proxy-example-oauth2-proxy-sample

35 kubectl rollout status --timeout 5m deployment/oauth2-proxy-example-oauth2-proxy-sample

35 kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-httpbin

36 kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-httpbin

36 kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-hello-world

37 kubectl rollout status --timeout 1m deployment/oauth2-proxy-example-hello-world

37

38

38.PHONY: undeploy

39.PHONY: undeploy

39−undeploy: helm-undeploy

40+undeploy:

41+ kubectl delete -f oauth2-proxy-example-full.yaml

40

42

41######################

43######################

42###### HELM CMDs #####

44###### HELM CMDs #####

@@ -57,3 +59,9 @@ helm-deploy: helm-init

57.PHONY: helm-undeploy

59.PHONY: helm-undeploy

58helm-undeploy:

60helm-undeploy:

59 helm del oauth2-proxy-example

61 helm del oauth2-proxy-example

62+

63+# creates K8S manifest from helm chart

64+.PHONY: helm-create-manifest

65+helm-create-manifest: helm-init

66+ echo "# WARNING: This file is auto-generated by 'make helm-create-manifest'! DO NOT EDIT MANUALLY!" > oauth2-proxy-example-full.yaml

67+ helm template --namespace default oauth2-proxy-example . >> oauth2-proxy-example-full.yaml

contrib/local-environment/kubernetes/README.md+4−3

@@ -8,15 +8,16 @@ Before you start:

8_Required_

8_Required_

9* install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)

9* install [kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)

10* install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)

10* install [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)

11+

12+_Optional_

11−* install [helm](https://helm.sh/docs/intro/quickstart/#install-helm).

13+* install [helm 3](https://helm.sh/docs/intro/quickstart/#install-helm).

12

14

13Then:

15Then:

14

16

15* `make create-cluster`

17* `make create-cluster`

16−* `make deploy`

18+* `make deploy` OR `make helm-deploy` for helm

17

19

18Visit http://httpbin.localtest.me or http://hello-world.localtest.me/

20Visit http://httpbin.localtest.me or http://hello-world.localtest.me/

19−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`.

20

21

21## Uninstall

22## Uninstall

22

23

contrib/local-environment/kubernetes/custom-dns.yaml+4−4

@@ -1,8 +1,4 @@

1apiVersion: v1

1apiVersion: v1

2−kind: ConfigMap

3−metadata:

4− name: coredns

5− namespace: kube-system

6data:

2data:

7 Corefile: |

3 Corefile: |

8 .:53 {

4 .:53 {

@@ -28,3 +24,7 @@ data:

28 fallthrough

24 fallthrough

29 }

25 }

30 }

26 }

27+kind: ConfigMap

28+metadata:

29+ name: coredns

30+ namespace: kube-system

contrib/local-environment/kubernetes/kind-cluster.yaml+1−1

@@ -1,5 +1,5 @@

1−apiVersion: kind.x-k8s.io/v1alpha4

2kind: Cluster

1kind: Cluster

2+apiVersion: kind.x-k8s.io/v1alpha4

3nodes:

3nodes:

4 - role: control-plane

4 - role: control-plane

5 kubeadmConfigPatches:

5 kubeadmConfigPatches:

contrib/local-environment/kubernetes/oauth2-proxy-example-full.yamlnew file+564

@@ -0,0 +1,564 @@

1+# WARNING: This file is auto-generated by 'make helm-create-manifest'! DO NOT EDIT MANUALLY!

2+---

3+# Source: kubernetes/charts/dex/templates/serviceaccount.yaml

4+apiVersion: v1

5+kind: ServiceAccount

6+metadata:

7+ labels:

8+ app.kubernetes.io/name: dex

9+ helm.sh/chart: dex-2.11.0

10+ app.kubernetes.io/instance: oauth2-proxy-example

11+ app.kubernetes.io/version: "2.23.0"

12+ app.kubernetes.io/managed-by: Helm

13+ name: oauth2-proxy-example-dex

14+---

15+# Source: kubernetes/charts/hello-world/templates/serviceaccount.yaml

16+apiVersion: v1

17+kind: ServiceAccount

18+metadata:

19+ name: oauth2-proxy-example-hello-world

20+ labels:

21+ helm.sh/chart: hello-world-1.0.1

22+ app.kubernetes.io/name: hello-world

23+ app.kubernetes.io/instance: oauth2-proxy-example

24+ app.kubernetes.io/version: "1.0.0"

25+ app.kubernetes.io/managed-by: Helm

26+---

27+# Source: kubernetes/charts/httpbin/templates/serviceaccount.yaml

28+apiVersion: v1

29+kind: ServiceAccount

30+metadata:

31+ name: oauth2-proxy-example-httpbin

32+ labels:

33+ helm.sh/chart: httpbin-1.0.1

34+ app.kubernetes.io/name: httpbin

35+ app.kubernetes.io/instance: oauth2-proxy-example

36+ app.kubernetes.io/version: "latest"

37+ app.kubernetes.io/managed-by: Helm

38+---

39+# Source: kubernetes/charts/oauth2-proxy/templates/serviceaccount.yaml

40+apiVersion: v1

41+kind: ServiceAccount

42+metadata:

43+ labels:

44+ app: oauth2-proxy-sample

45+ chart: oauth2-proxy-3.1.0

46+ release: oauth2-proxy-example

47+ heritage: Helm

48+ name: oauth2-proxy-example-oauth2-proxy-sample

49+---

50+# Source: kubernetes/charts/dex/templates/secret.yaml

51+apiVersion: v1

52+kind: Secret

53+metadata:

54+ labels:

55+ app.kubernetes.io/name: dex

56+ helm.sh/chart: dex-2.11.0

57+ app.kubernetes.io/instance: oauth2-proxy-example

58+ app.kubernetes.io/version: "2.23.0"

59+ app.kubernetes.io/managed-by: Helm

60+ name: oauth2-proxy-example-dex

61+stringData:

62+ config.yaml: |-

63+ issuer: http://dex.localtest.me

64+ storage:

65+ config:

66+ inCluster: true

67+ type: kubernetes

68+ logger:

69+ level: debug

70+ web:

71+ http: 0.0.0.0:5556

72+ oauth2:

73+ alwaysShowLoginScreen: false

74+ skipApprovalScreen: true

75+ staticClients:

76+ - id: oauth2-proxy

77+ name: OAuth2 Proxy

78+ redirectURIs:

79+ - http://oauth2-proxy.localtest.me/oauth2/callback

80+ secret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK

81+ enablePasswordDB: true

82+ staticPasswords:

83+ - email: admin@example.com

84+ hash: $2a$10$2b2cU8CPhOTaGrs1HRQuAueS7JTT5ZHsHSzYiFPm1leZck7Mc8T4W

85+ userID: 08a8684b-db88-4b73-90a9-3cd1661f5466

86+ username: admin

87+ expiry:

88+ idTokens: 1h

89+ signingKeys: 4h

90+---

91+# Source: kubernetes/charts/oauth2-proxy/templates/configmap.yaml

92+apiVersion: v1

93+kind: ConfigMap

94+metadata:

95+ labels:

96+ app: oauth2-proxy-sample

97+ chart: oauth2-proxy-3.1.0

98+ heritage: Helm

99+ release: oauth2-proxy-example

100+ name: oauth2-proxy-example-oauth2-proxy-sample

101+data:

102+ oauth2_proxy.cfg: "cookie_secret=\"OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w=\"\ncookie_domain=\".localtest.me\"\nwhitelist_domains=[\".localtest.me\"]\n# only users with this domain will be let in\nemail_domains=[\"example.com\"]\n\nclient_id=\"oauth2-proxy\"\nclient_secret=\"b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK\"\ncookie_secure=\"false\"\n\nredirect_url=\"http://oauth2-proxy.localtest.me/oauth2/callback\"\n\n# we don't want to proxy anything so pick a non-existent directory\nupstreams = [ \"file:///dev/null\" ]\n\n# return authenticated user to nginx\nset_xauthrequest = true\n# using http://dex.localtest.me/.well-known/openid-configuration oauth2-proxy will populate\n# login_url, redeem_url, and oidc_jwks_url\nprovider=\"oidc\"\noidc_issuer_url=\"http://dex.localtest.me\""

103+---

104+# Source: kubernetes/charts/dex/templates/clusterrole.yaml

105+apiVersion: rbac.authorization.k8s.io/v1

106+kind: ClusterRole

107+metadata:

108+ labels:

109+ app.kubernetes.io/name: dex

110+ helm.sh/chart: dex-2.11.0

111+ app.kubernetes.io/instance: oauth2-proxy-example

112+ app.kubernetes.io/version: "2.23.0"

113+ app.kubernetes.io/managed-by: Helm

114+ name: oauth2-proxy-example-dex

115+rules:

116+- apiGroups: ["dex.coreos.com"] # API group created by dex

117+ resources: ["*"]

118+ verbs: ["*"]

119+- apiGroups: ["apiextensions.k8s.io"]

120+ resources: ["customresourcedefinitions"]

121+ verbs: ["create"] # To manage its own resources, dex must be able to create customresourcedefinitions

122+---

123+# Source: kubernetes/charts/dex/templates/clusterrolebinding.yaml

124+apiVersion: rbac.authorization.k8s.io/v1

125+kind: ClusterRoleBinding

126+metadata:

127+ labels:

128+ app.kubernetes.io/name: dex

129+ helm.sh/chart: dex-2.11.0

130+ app.kubernetes.io/instance: oauth2-proxy-example

131+ app.kubernetes.io/version: "2.23.0"

132+ app.kubernetes.io/managed-by: Helm

133+ name: oauth2-proxy-example-dex

134+roleRef:

135+ apiGroup: rbac.authorization.k8s.io

136+ kind: ClusterRole

137+ name: oauth2-proxy-example-dex

138+subjects:

139+ - kind: ServiceAccount

140+ name: oauth2-proxy-example-dex

141+ namespace: default

142+---

143+# Source: kubernetes/charts/dex/templates/service.yaml

144+apiVersion: v1

145+kind: Service

146+metadata:

147+ name: oauth2-proxy-example-dex

148+ labels:

149+ app.kubernetes.io/name: dex

150+ helm.sh/chart: dex-2.11.0

151+ app.kubernetes.io/instance: oauth2-proxy-example

152+ app.kubernetes.io/version: "2.23.0"

153+ app.kubernetes.io/managed-by: Helm

154+spec:

155+ type: ClusterIP

156+ sessionAffinity: None

157+ ports:

158+ - name: http

159+ targetPort: http

160+ port: 32000

161+ selector:

162+ app.kubernetes.io/name: dex

163+ app.kubernetes.io/instance: oauth2-proxy-example

164+---

165+# Source: kubernetes/charts/hello-world/templates/service.yaml

166+apiVersion: v1

167+kind: Service

168+metadata:

169+ name: oauth2-proxy-example-hello-world

170+ labels:

171+ helm.sh/chart: hello-world-1.0.1

172+ app.kubernetes.io/name: hello-world

173+ app.kubernetes.io/instance: oauth2-proxy-example

174+ app.kubernetes.io/version: "1.0.0"

175+ app.kubernetes.io/managed-by: Helm

176+spec:

177+ type: ClusterIP

178+ ports:

179+ - port: 9080

180+ targetPort: http

181+ protocol: TCP

182+ name: http

183+ selector:

184+ app.kubernetes.io/name: hello-world

185+ app.kubernetes.io/instance: oauth2-proxy-example

186+---

187+# Source: kubernetes/charts/httpbin/templates/service.yaml

188+apiVersion: v1

189+kind: Service

190+metadata:

191+ name: oauth2-proxy-example-httpbin

192+ labels:

193+ helm.sh/chart: httpbin-1.0.1

194+ app.kubernetes.io/name: httpbin

195+ app.kubernetes.io/instance: oauth2-proxy-example

196+ app.kubernetes.io/version: "latest"

197+ app.kubernetes.io/managed-by: Helm

198+spec:

199+ type: ClusterIP

200+ ports:

201+ - port: 80

202+ targetPort: http

203+ protocol: TCP

204+ name: http

205+ selector:

206+ app.kubernetes.io/name: httpbin

207+ app.kubernetes.io/instance: oauth2-proxy-example

208+---

209+# Source: kubernetes/charts/oauth2-proxy/templates/service.yaml

210+apiVersion: v1

211+kind: Service

212+metadata:

213+ labels:

214+ app: oauth2-proxy-sample

215+ chart: oauth2-proxy-3.1.0

216+ release: oauth2-proxy-example

217+ heritage: Helm

218+ name: oauth2-proxy-example-oauth2-proxy-sample

219+spec:

220+ type: ClusterIP

221+ ports:

222+ - port: 80

223+ targetPort: http

224+ protocol: TCP

225+ name: http

226+ selector:

227+ app: oauth2-proxy-sample

228+ release: oauth2-proxy-example

229+---

230+# Source: kubernetes/charts/dex/templates/deployment.yaml

231+apiVersion: apps/v1

232+kind: Deployment

233+metadata:

234+ name: oauth2-proxy-example-dex

235+ labels:

236+ app.kubernetes.io/name: dex

237+ helm.sh/chart: dex-2.11.0

238+ app.kubernetes.io/instance: oauth2-proxy-example

239+ app.kubernetes.io/version: "2.23.0"

240+ app.kubernetes.io/managed-by: Helm

241+ app.kubernetes.io/component: dex

242+spec:

243+ replicas: 1

244+ strategy:

245+ rollingUpdate:

246+ maxSurge: 0

247+ maxUnavailable: 1

248+ type: RollingUpdate

249+ selector:

250+ matchLabels:

251+ app.kubernetes.io/name: dex

252+ app.kubernetes.io/instance: oauth2-proxy-example

253+ app.kubernetes.io/component: dex

254+ template:

255+ metadata:

256+ labels:

257+ app.kubernetes.io/name: dex

258+ app.kubernetes.io/instance: oauth2-proxy-example

259+ app.kubernetes.io/component: dex

260+ annotations:

261+ checksum/config: 185f32cfabdf4f7467868dc301d4bd33e68951e12eddeb69f23ebc1d0f91ba28

262+ spec:

263+ serviceAccountName: oauth2-proxy-example-dex

264+ nodeSelector:

265+ {}

266+ containers:

267+ - name: main

268+ image: "quay.io/dexidp/dex:v2.23.0"

269+ imagePullPolicy: IfNotPresent

270+ command:

271+ - /usr/local/bin/dex

272+ - serve

273+ - /etc/dex/cfg/config.yaml

274+ resources:

275+ null

276+ ports:

277+ - name: http

278+ containerPort: 5556

279+ protocol: TCP

280+ livenessProbe:

281+ httpGet:

282+ path: /healthz

283+ port: http

284+ initialDelaySeconds: 1

285+ periodSeconds: 10

286+ timeoutSeconds: 1

287+ failureThreshold: 1

288+ readinessProbe:

289+ httpGet:

290+ path: /healthz

291+ port: http

292+ initialDelaySeconds: 1

293+ periodSeconds: 10

294+ timeoutSeconds: 1

295+ failureThreshold: 1

296+ env:

297+ []

298+ volumeMounts:

299+ - mountPath: /etc/dex/cfg

300+ name: config

301+ volumes:

302+ - secret:

303+ defaultMode: 420

304+ items:

305+ - key: config.yaml

306+ path: config.yaml

307+ secretName: oauth2-proxy-example-dex

308+ name: config

309+---

310+# Source: kubernetes/charts/hello-world/templates/deployment.yaml

311+apiVersion: apps/v1

312+kind: Deployment

313+metadata:

314+ name: oauth2-proxy-example-hello-world

315+ labels:

316+ helm.sh/chart: hello-world-1.0.1

317+ app.kubernetes.io/name: hello-world

318+ app.kubernetes.io/instance: oauth2-proxy-example

319+ app.kubernetes.io/version: "1.0.0"

320+ app.kubernetes.io/managed-by: Helm

321+spec:

322+ replicas: 1

323+ selector:

324+ matchLabels:

325+ app.kubernetes.io/name: hello-world

326+ app.kubernetes.io/instance: oauth2-proxy-example

327+ template:

328+ metadata:

329+ labels:

330+ app.kubernetes.io/name: hello-world

331+ app.kubernetes.io/instance: oauth2-proxy-example

332+ spec:

333+ serviceAccountName: oauth2-proxy-example-hello-world

334+ securityContext:

335+ {}

336+ containers:

337+ - name: hello-world

338+ securityContext:

339+ {}

340+ image: "conservis/hello-world:1.0.0"

341+ imagePullPolicy: IfNotPresent

342+ ports:

343+ - name: http

344+ containerPort: 9080

345+ protocol: TCP

346+ livenessProbe:

347+ httpGet:

348+ path: /

349+ port: http

350+ readinessProbe:

351+ httpGet:

352+ path: /

353+ port: http

354+ resources:

355+ {}

356+---

357+# Source: kubernetes/charts/httpbin/templates/deployment.yaml

358+apiVersion: apps/v1

359+kind: Deployment

360+metadata:

361+ name: oauth2-proxy-example-httpbin

362+ labels:

363+ helm.sh/chart: httpbin-1.0.1

364+ app.kubernetes.io/name: httpbin

365+ app.kubernetes.io/instance: oauth2-proxy-example

366+ app.kubernetes.io/version: "latest"

367+ app.kubernetes.io/managed-by: Helm

368+spec:

369+ replicas: 1

370+ selector:

371+ matchLabels:

372+ app.kubernetes.io/name: httpbin

373+ app.kubernetes.io/instance: oauth2-proxy-example

374+ template:

375+ metadata:

376+ labels:

377+ app.kubernetes.io/name: httpbin

378+ app.kubernetes.io/instance: oauth2-proxy-example

379+ spec:

380+ serviceAccountName: oauth2-proxy-example-httpbin

381+ securityContext:

382+ {}

383+ containers:

384+ - name: httpbin

385+ securityContext:

386+ {}

387+ image: "kennethreitz/httpbin:latest"

388+ imagePullPolicy: IfNotPresent

389+ ports:

390+ - name: http

391+ containerPort: 80

392+ protocol: TCP

393+ livenessProbe:

394+ httpGet:

395+ path: /

396+ port: http

397+ readinessProbe:

398+ httpGet:

399+ path: /

400+ port: http

401+ resources:

402+ {}

403+---

404+# Source: kubernetes/charts/oauth2-proxy/templates/deployment.yaml

405+apiVersion: apps/v1

406+kind: Deployment

407+metadata:

408+ labels:

409+ app: oauth2-proxy-sample

410+ chart: oauth2-proxy-3.1.0

411+ heritage: Helm

412+ release: oauth2-proxy-example

413+ name: oauth2-proxy-example-oauth2-proxy-sample

414+spec:

415+ replicas: 1

416+ selector:

417+ matchLabels:

418+ app: oauth2-proxy-sample

419+ release: oauth2-proxy-example

420+ template:

421+ metadata:

422+ annotations:

423+ checksum/config: 5d8892a7b1d9eb03f9d59b787ce339b374fa2be51991e4e7533cb0a541984fac

424+ checksum/config-emails: 01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b

425+ checksum/secret: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

426+ checksum/google-secret: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

427+ labels:

428+ app: oauth2-proxy-sample

429+ release: "oauth2-proxy-example"

430+ spec:

431+ serviceAccountName: oauth2-proxy-example-oauth2-proxy-sample

432+ containers:

433+ - name: oauth2-proxy

434+ image: "quay.io/pusher/oauth2_proxy:v5.1.0"

435+ imagePullPolicy: IfNotPresent

436+ args:

437+ - --http-address=0.0.0.0:4180

438+ - --config=/etc/oauth2_proxy/oauth2_proxy.cfg

439+ ports:

440+ - containerPort: 4180

441+ name: http

442+ protocol: TCP

443+ livenessProbe:

444+ httpGet:

445+ path: /ping

446+ port: http

447+ scheme: HTTP

448+ initialDelaySeconds: 0

449+ timeoutSeconds: 1

450+ readinessProbe:

451+ httpGet:

452+ path: /ping

453+ port: http

454+ scheme: HTTP

455+ initialDelaySeconds: 0

456+ timeoutSeconds: 1

457+ successThreshold: 1

458+ periodSeconds: 10

459+ resources:

460+ {}

461+ volumeMounts:

462+ - mountPath: /etc/oauth2_proxy

463+ name: configmain

464+ volumes:

465+ - configMap:

466+ defaultMode: 420

467+ name: oauth2-proxy-example-oauth2-proxy-sample

468+ name: configmain

469+ tolerations:

470+ []

471+---

472+# Source: kubernetes/charts/dex/templates/ingress.yaml

473+apiVersion: extensions/v1beta1

474+kind: Ingress

475+metadata:

476+ name: oauth2-proxy-example-dex

477+ labels:

478+ app.kubernetes.io/name: dex

479+ helm.sh/chart: dex-2.11.0

480+ app.kubernetes.io/instance: oauth2-proxy-example

481+ app.kubernetes.io/version: "2.23.0"

482+ app.kubernetes.io/managed-by: Helm

483+spec:

484+ rules:

485+ - host: "dex.localtest.me"

486+ http:

487+ paths:

488+ - path: /

489+ backend:

490+ serviceName: oauth2-proxy-example-dex

491+ servicePort: 32000

492+---

493+# Source: kubernetes/charts/hello-world/templates/ingress.yaml

494+apiVersion: networking.k8s.io/v1beta1

495+kind: Ingress

496+metadata:

497+ name: oauth2-proxy-example-hello-world

498+ labels:

499+ helm.sh/chart: hello-world-1.0.1

500+ app.kubernetes.io/name: hello-world

501+ app.kubernetes.io/instance: oauth2-proxy-example

502+ app.kubernetes.io/version: "1.0.0"

503+ app.kubernetes.io/managed-by: Helm

504+ annotations:

505+ nginx.ingress.kubernetes.io/auth-response-headers: X-Auth-Request-User,X-Auth-Request-Email

506+ nginx.ingress.kubernetes.io/auth-signin: http://oauth2-proxy.localtest.me/oauth2/start

507+ nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy-example-oauth2-proxy-sample.default.svc.cluster.local/oauth2/auth

508+spec:

509+ rules:

510+ - host: hello-world.localtest.me

511+ http:

512+ paths:

513+ - path: /

514+ backend:

515+ serviceName: oauth2-proxy-example-hello-world

516+ servicePort: 9080

517+---

518+# Source: kubernetes/charts/httpbin/templates/ingress.yaml

519+apiVersion: networking.k8s.io/v1beta1

520+kind: Ingress

521+metadata:

522+ name: oauth2-proxy-example-httpbin

523+ labels:

524+ helm.sh/chart: httpbin-1.0.1

525+ app.kubernetes.io/name: httpbin

526+ app.kubernetes.io/instance: oauth2-proxy-example

527+ app.kubernetes.io/version: "latest"

528+ app.kubernetes.io/managed-by: Helm

529+ annotations:

530+ nginx.ingress.kubernetes.io/auth-response-headers: X-Auth-Request-User,X-Auth-Request-Email

531+ nginx.ingress.kubernetes.io/auth-signin: http://oauth2-proxy.localtest.me/oauth2/start

532+ nginx.ingress.kubernetes.io/auth-url: http://oauth2-proxy-example-oauth2-proxy-sample.default.svc.cluster.local/oauth2/auth

533+spec:

534+ rules:

535+ - host: httpbin.localtest.me

536+ http:

537+ paths:

538+ - path: /

539+ backend:

540+ serviceName: oauth2-proxy-example-httpbin

541+ servicePort: 80

542+---

543+# Source: kubernetes/charts/oauth2-proxy/templates/ingress.yaml

544+apiVersion: extensions/v1beta1

545+kind: Ingress

546+metadata:

547+ labels:

548+ app: oauth2-proxy-sample

549+ chart: oauth2-proxy-3.1.0

550+ heritage: Helm

551+ release: oauth2-proxy-example

552+ name: oauth2-proxy-example-oauth2-proxy-sample

553+ annotations:

554+ nginx.ingress.kubernetes.io/server-snippet: |

555+ large_client_header_buffers 4 32k;

556+spec:

557+ rules:

558+ - host: oauth2-proxy.localtest.me

559+ http:

560+ paths:

561+ - path: /

562+ backend:

563+ serviceName: oauth2-proxy-example-oauth2-proxy-sample

564+ servicePort: 80

contrib/local-environment/kubernetes/values.yaml+6−12

@@ -2,12 +2,8 @@ dex:

2 ingress:

2 ingress:

3 enabled: true

3 enabled: true

4 hosts:

4 hosts:

5− - host: dex.localtest.me

5+ - dex.localtest.me

6− paths:

7− - path: /

8− pathType: ImplementationSpecific

9− grpc:

6+ grpc: false

10− enabled: false

11 certs:

7 certs:

12 grpc:

8 grpc:

13 create: false

9 create: false

@@ -16,11 +12,6 @@ dex:

16

12

17 config:

13 config:

18 issuer: http://dex.localtest.me

14 issuer: http://dex.localtest.me

19− storage:

20− type: kubernetes

21− config:

22− inCluster: true

23− enablePasswordDB: true

24 expiry:

15 expiry:

25 signingKeys: "4h"

16 signingKeys: "4h"

26 idTokens: "1h"

17 idTokens: "1h"

@@ -44,12 +35,15 @@ oauth2-proxy:

44 enabled: true

35 enabled: true

45 hosts:

36 hosts:

46 - oauth2-proxy.localtest.me

37 - oauth2-proxy.localtest.me

38+ annotations:

39+ nginx.ingress.kubernetes.io/server-snippet: |

40+ large_client_header_buffers 4 32k;

47 # pick up client_id and client_secret from configFile as opposed to helm .Values.config.clientID and .Values.config.clientSecret

41 # pick up client_id and client_secret from configFile as opposed to helm .Values.config.clientID and .Values.config.clientSecret

48 proxyVarsAsSecrets: false

42 proxyVarsAsSecrets: false

49 config:

43 config:

50 configFile: |-

44 configFile: |-

51 cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

45 cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

52− cookie_domains=".localtest.me"

46+ cookie_domain=".localtest.me"

53 whitelist_domains=[".localtest.me"]

47 whitelist_domains=[".localtest.me"]

54 # only users with this domain will be let in

48 # only users with this domain will be let in

55 email_domains=["example.com"]

49 email_domains=["example.com"]

contrib/local-environment/nginx.conf+71−31

@@ -1,44 +1,84 @@

1+# Reverse proxy to oauth2-proxy

2+server {

3+ listen 80;

4+ server_name oauth2-proxy.oauth2-proxy.localhost;

5+

6+ location / {

7+ proxy_set_header Host $host;

8+ proxy_set_header X-Real-IP $remote_addr;

9+

10+ proxy_pass http://oauth2-proxy:4180/;

11+ }

12+}

13+

1# Reverse proxy to httpbin

14# Reverse proxy to httpbin

2server {

15server {

3− listen 8080;

16+ listen 80;

4− server_name oauth2-proxy.localtest.me;

17+ server_name httpbin.oauth2-proxy.localhost;

5−

18+

19+ auth_request /internal-auth/oauth2/auth;

20+

21+ # If the auth_request denies the request (401), redirect to the sign_in page

22+ # and include the final rd URL back to the user's original request.

23+ error_page 401 = http://oauth2-proxy.oauth2-proxy.localhost/oauth2/sign_in?rd=$scheme://$host$request_uri;

24+

25+ # Alternatively send the request to `start` to skip the provider button

26+ # error_page 401 = http://oauth2-proxy.oauth2-proxy.localhost/oauth2/start?rd=$scheme://$host$request_uri;

27+

6− location /oauth2/ {

28+ location / {

7− proxy_pass http://oauth2-proxy:4180;

29+ proxy_pass http://httpbin/;

8− proxy_set_header Host $host;

9− proxy_set_header X-Real-IP $remote_addr;

10− proxy_set_header X-Forwarded-Uri $request_uri;

11− proxy_set_header X-Auth-Request-Redirect $request_uri;

12 }

30 }

13

31

32+ # auth_request must be a URI so this allows an internal path to then proxy to

33+ # the real auth_request path.

34+ # The trailing /'s are required so that nginx strips the prefix before proxying.

14− location = /oauth2/auth {

35+ location /internal-auth/ {

15− proxy_pass http://oauth2-proxy:4180;

36+ internal; # Ensure external users can't access this path

37+

38+ # Make sure the OAuth2 Proxy knows where the original request came from.

16− proxy_set_header Host $host;

39+ proxy_set_header Host $host;

17− proxy_set_header X-Real-IP $remote_addr;

40+ proxy_set_header X-Real-IP $remote_addr;

18− proxy_set_header X-Forwarded-Uri $request_uri;

41+

19− # nginx auth_request includes headers but not body

42+ proxy_pass http://oauth2-proxy:4180/;

20− proxy_set_header Content-Length "";

21− proxy_pass_request_body off;

22 }

43 }

44+}

45+

46+# Statically serve the nginx welcome

47+server {

48+ listen 80;

49+ server_name oauth2-proxy.localhost;

23

50

24 location / {

51 location / {

25− auth_request /oauth2/auth;

52+ auth_request /internal-auth/oauth2/auth;

26− error_page 401 = @oauth2_signin;

27

53

28− # pass information via X-User and X-Email headers to backend,

54+ # If the auth_request denies the request (401), redirect to the sign_in page

29− # requires running with --set-xauthrequest flag

55+ # and include the final rd URL back to the user's original request.

30− auth_request_set $user $upstream_http_x_auth_request_user;

56+ error_page 401 = http://oauth2-proxy.oauth2-proxy.localhost/oauth2/sign_in?rd=$scheme://$host$request_uri;

31− auth_request_set $email $upstream_http_x_auth_request_email;

32− proxy_set_header X-User $user;

33− proxy_set_header X-Email $email;

34

57

35− proxy_pass http://httpbin/;

58+ # Alternatively send the request to `start` to skip the provider button

36− # or "root /path/to/site;" or "fastcgi_pass ..." etc

59+ # error_page 401 = http://oauth2-proxy.oauth2-proxy.localhost/oauth2/start?rd=$scheme://$host$request_uri;

60+

61+

62+ root /usr/share/nginx/html;

63+ index index.html index.htm;

64+ }

65+

66+ # redirect server error pages to the static page /50x.html

67+ error_page 500 502 503 504 /50x.html;

68+ location = /50x.html {

69+ root /usr/share/nginx/html;

37 }

70 }

38

71

39− # Named location for handling OAuth2 sign-in redirects

72+ # auth_request must be a URI so this allows an internal path to then proxy to

40− # This ensures the browser receives a proper 302 redirect that it will follow

73+ # the real auth_request path.

41− location @oauth2_signin {

74+ # The trailing /'s are required so that nginx strips the prefix before proxying.

42− return 302 /oauth2/sign_in?rd=$scheme://$http_host$request_uri;

75+ location /internal-auth/ {

76+ internal; # Ensure external users can't access this path

77+

78+ # Make sure the OAuth2 Proxy knows where the original request came from.

79+ proxy_set_header Host $host;

80+ proxy_set_header X-Real-IP $remote_addr;

81+

82+ proxy_pass http://oauth2-proxy:4180/;

43 }

83 }

44}

84}

contrib/local-environment/oauth2-proxy-alpha-config.cfg+2−1

@@ -1,4 +1,5 @@

1+http_address="0.0.0.0:4180"

1cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

2email_domains="example.com"

3email_domains="example.com"

3cookie_secure="false"

4cookie_secure="false"

4−redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"

5+redirect_url="http://localhost:4180/oauth2/callback"

contrib/local-environment/oauth2-proxy-alpha-config.yaml+21−21

@@ -1,23 +1,23 @@

1−server:

2− bindAddress: "0.0.0.0:4180"

3−upstreamConfig:

4− upstreams:

1+upstreams:

5− - id: httpbin

2+ - id: httpbin

6− path: /

3+ path: /

7− uri: http://httpbin

4+ uri: http://httpbin

8injectRequestHeaders:

5injectRequestHeaders:

6+- name: X-Forwarded-Groups

7+ values:

8+ - claim: groups

9− - name: X-Forwarded-User

9+- name: X-Forwarded-User

10− values:

10+ values:

11− - claimSource:

12− claim: user

11+ - claim: user

13− - name: X-Forwarded-Email

12+- name: X-Forwarded-Email

14− values:

13+ values:

15− - claimSource:

16− claim: email

14+ - claim: email

15+- name: X-Forwarded-Preferred-Username

16+ values:

17+ - claim: preferred_username

17providers:

18providers:

18− - id: oidc

19− provider: oidc

19+- provider: oidc

20− clientSecret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK

20+ clientSecret: b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK

21− clientID: oauth2-proxy

21+ clientID: oauth2-proxy

22− oidcConfig:

22+ oidcConfig:

23− issuerURL: http://dex.localtest.me:5556/dex

23+ oidcIssuerURL: http://dex.localhost:4190/dex

contrib/local-environment/oauth2-proxy-gitea.cfgdeleted−19

@@ -1,19 +0,0 @@

1−http_address="0.0.0.0:4180"

2−cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

3−email_domains=["localhost"]

4−cookie_secure="false"

5−upstreams="http://httpbin"

6−cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.

7−whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.

8−

9−client_id="ef0c2b91-2e38-4fa8-908d-067a35dbb71c"

10−client_secret="gto_qdppomn2p26su5x46tyixj7bcny5m5er2s67xhrponq2qtp66f3a"

11−redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"

12−

13−# gitea provider

14−provider="github"

15−provider_display_name="Gitea"

16−login_url="http://gitea.localtest.me:3000/login/oauth/authorize"

17−redeem_url="http://gitea.localtest.me:3000/login/oauth/access_token"

18−validate_url="http://gitea.localtest.me:3000/api/v1/user/emails"

19−

contrib/local-environment/oauth2-proxy-keycloak.cfg+6−4

@@ -1,9 +1,9 @@

1http_address="0.0.0.0:4180"

1http_address="0.0.0.0:4180"

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

3−email_domains="example.com"

3+email_domains=["example.com"]

4cookie_secure="false"

4cookie_secure="false"

5upstreams="http://httpbin"

5upstreams="http://httpbin"

6−cookie_domains=["oauth2-proxy.localtest.me:4080", "keycloak.localtest.me:9080"] # Required so cookie can be read on all subdomains.

6+cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.

7whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.

7whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.

8

8

9# keycloak provider

9# keycloak provider

@@ -12,7 +12,9 @@ client_id="oauth2-proxy"

12redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"

12redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"

13

13

14# in this case oauth2-proxy is going to visit

14# in this case oauth2-proxy is going to visit

15−# http://keycloak.localtest.me:9080/realms/oauth2-proxy/.well-known/openid-configuration for configuration

15+# http://keycloak.localtest.me:9080/auth/realms/master/.well-known/openid-configuration for configuration

16−oidc_issuer_url="http://keycloak.localtest.me:9080/realms/oauth2-proxy"

16+oidc_issuer_url="http://keycloak.localtest.me:9080/auth/realms/master"

17provider="oidc"

17provider="oidc"

18provider_display_name="Keycloak"

18provider_display_name="Keycloak"

19+

20+

contrib/local-environment/oauth2-proxy-nginx.cfg+6−13

@@ -1,19 +1,12 @@

1http_address="0.0.0.0:4180"

1http_address="0.0.0.0:4180"

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

3+provider="oidc"

3email_domains="example.com"

4email_domains="example.com"

4−cookie_secure="false"

5+oidc_issuer_url="http://dex.localhost:4190/dex"

5−upstreams="static://200"

6−cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.

7−whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.

8−

9−# dex provider

10client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"

6client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"

11client_id="oauth2-proxy"

7client_id="oauth2-proxy"

12−redirect_url="http://oauth2-proxy.localtest.me:8080/oauth2/callback"

8+cookie_secure="false"

13−

14−oidc_issuer_url="http://dex.localtest.me:5556/dex"

15−provider="oidc"

16−provider_display_name="Dex"

17

9

18−# Enables the use of `X-Forwarded-*` headers to determine request correctly

10+redirect_url="http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback"

19−reverse_proxy="true"

11+cookie_domains=".oauth2-proxy.localhost" # Required so cookie can be read on all subdomains.

12+whitelist_domains=".oauth2-proxy.localhost" # Required to allow redirection back to original requested target.

contrib/local-environment/oauth2-proxy-traefik.cfg+5−5

@@ -2,18 +2,18 @@ http_address="0.0.0.0:4180"

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

3provider="oidc"

3provider="oidc"

4email_domains=["example.com"]

4email_domains=["example.com"]

5−oidc_issuer_url="http://dex.localtest.me/dex"

5+oidc_issuer_url="http://dex.localhost:4190/dex"

6client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"

6client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"

7client_id="oauth2-proxy"

7client_id="oauth2-proxy"

8cookie_secure="false"

8cookie_secure="false"

9

9

10−redirect_url="http://oauth2-proxy.localtest.me/oauth2/callback"

10+redirect_url="http://oauth2-proxy.oauth2-proxy.localhost/oauth2/callback"

11−cookie_domains=".localtest.me" # Required so cookie can be read on all subdomains.

11+cookie_domains=".oauth2-proxy.localhost" # Required so cookie can be read on all subdomains.

12−whitelist_domains=".localtest.me" # Required to allow redirection back to original requested target.

12+whitelist_domains=".oauth2-proxy.localhost" # Required to allow redirection back to original requested target.

13

13

14# Mandatory option when using oauth2-proxy with traefik

14# Mandatory option when using oauth2-proxy with traefik

15reverse_proxy="true"

15reverse_proxy="true"

16−# Required for traefik with ForwardAuth and static upstream configuration

16+# Required for traefik with ForwardAuth and static upstream configuration

17upstreams="static://202"

17upstreams="static://202"

18# The following option skip the page requesting the user

18# The following option skip the page requesting the user

19# to click on a button to be redirected to the identity provider

19# to click on a button to be redirected to the identity provider

contrib/local-environment/oauth2-proxy.cfg+5−10

@@ -1,16 +1,11 @@

1http_address="0.0.0.0:4180"

1http_address="0.0.0.0:4180"

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

2cookie_secret="OQINaROshtE9TcZkNAm-5Zs2Pv3xaWytBmc5W7sPX7w="

3+provider="oidc"

3email_domains="example.com"

4email_domains="example.com"

4−cookie_secure="false"

5+oidc_issuer_url="http://dex.localhost:4190/dex"

5−upstreams="http://httpbin"

6−cookie_domains=[".localtest.me"] # Required so cookie can be read on all subdomains.

7−whitelist_domains=[".localtest.me"] # Required to allow redirection back to original requested target.

8−

9−# dex provider

10client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"

6client_secret="b2F1dGgyLXByb3h5LWNsaWVudC1zZWNyZXQK"

11client_id="oauth2-proxy"

7client_id="oauth2-proxy"

12−redirect_url="http://oauth2-proxy.localtest.me:4180/oauth2/callback"

8+cookie_secure="false"

13

9

14−oidc_issuer_url="http://dex.localtest.me:5556/dex"

10+redirect_url="http://localhost:4180/oauth2/callback"

15−provider="oidc"

11+upstreams="http://httpbin"

16−provider_display_name="Dex"

contrib/local-environment/traefik/dynamic.yaml+4−11

@@ -1,25 +1,22 @@

1http:

1http:

2 routers:

2 routers:

3 oauth2-proxy-route:

3 oauth2-proxy-route:

4− rule: "Host(`oauth2-proxy.localtest.me`)"

4+ rule: "Host(`oauth2-proxy.oauth2-proxy.localhost`)"

5 middlewares:

5 middlewares:

6 - auth-headers

6 - auth-headers

7 service: oauth-backend

7 service: oauth-backend

8− dex-route:

9− rule: "Host(`dex.localtest.me`)"

10− service: dex-service

11 httpbin-route:

8 httpbin-route:

12− rule: "Host(`httpbin.localtest.me`)"

9+ rule: "Host(`httpbin.oauth2-proxy.localhost`)"

13 service: httpbin-service

10 service: httpbin-service

14 middlewares:

11 middlewares:

15 - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin

12 - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin

16 httpbin-route-2:

13 httpbin-route-2:

17− rule: "Host(`httpbin.localtest.me`) && PathPrefix(`/no-auto-redirect`)"

14+ rule: "Host(`httpbin.oauth2-proxy.localhost`) && PathPrefix(`/no-auto-redirect`)"

18 service: httpbin-service

15 service: httpbin-service

19 middlewares:

16 middlewares:

20 - oauth-auth-wo-redirect # unauthenticated session will return a 401

17 - oauth-auth-wo-redirect # unauthenticated session will return a 401

21 services-oauth2-route:

18 services-oauth2-route:

22− rule: "Host(`httpbin.localtest.me`) && PathPrefix(`/oauth2/`)"

19+ rule: "Host(`httpbin.oauth2-proxy.localhost`) && PathPrefix(`/oauth2/`)"

23 middlewares:

20 middlewares:

24 - auth-headers

21 - auth-headers

25 service: oauth-backend

22 service: oauth-backend

@@ -33,10 +30,6 @@ http:

33 loadBalancer:

30 loadBalancer:

34 servers:

31 servers:

35 - url: http://oauth2-proxy:4180

32 - url: http://oauth2-proxy:4180

36− dex-service:

37− loadBalancer:

38− servers:

39− - url: http://dex:5556

40

33

41 middlewares:

34 middlewares:

42 auth-headers:

35 auth-headers:

contrib/local-environment/traefik/traefik.yaml−2

@@ -5,5 +5,3 @@ log:

5providers:

5providers:

6 file:

6 file:

7 filename: /etc/traefik/dynamic.yaml

7 filename: /etc/traefik/dynamic.yaml

8− # Routes are static for this example; disabling watch avoids host inotify limits.

9− watch: false

contrib/oauth2-proxy.cfg.example−9

@@ -52,10 +52,6 @@

52# client_id = "123456.apps.googleusercontent.com"

52# client_id = "123456.apps.googleusercontent.com"

53# client_secret = ""

53# client_secret = ""

54

54

55−## Scopes Added to the request

56−## It has the same behavior as the --scope flag

57−# scope = "openid email profile"

58−

59## Pass OAuth Access token to upstream via "X-Forwarded-Access-Token"

55## Pass OAuth Access token to upstream via "X-Forwarded-Access-Token"

60# pass_access_token = false

56# pass_access_token = false

61

57

@@ -73,11 +69,6 @@

73# "^/metrics"

69# "^/metrics"

74# ]

70# ]

75

71

76−## mark paths as API routes to get HTTP Status code 401 instead of redirect to login page

77−# api_routes = [

78−# "^/api"

79−# ]

80−

81## Templates

72## Templates

82## optional directory with custom sign_in.html and error.html

73## optional directory with custom sign_in.html and error.html

83# custom_templates_dir = ""

74# custom_templates_dir = ""

contrib/oauth2-proxy.service.example+14−25

@@ -1,33 +1,22 @@

1+# Systemd service file for oauth2-proxy daemon

2+#

3+# Date: Feb 9, 2016

4+# Author: Srdjan Grubor <sgnn7@sgnn7.org>

5+

1[Unit]

6[Unit]

2Description=oauth2-proxy daemon service

7Description=oauth2-proxy daemon service

3−After=network.target network-online.target nss-lookup.target basic.target

8+After=syslog.target network.target

4−Wants=network-online.target nss-lookup.target

5−StartLimitIntervalSec=30

6−StartLimitBurst=3

7

9

8[Service]

10[Service]

9−User=oauth2-proxy

11+# www-data group and user need to be created before using these lines

10−Group=oauth2-proxy

12+User=www-data

11−Restart=on-failure

13+Group=www-data

12−RestartSec=30

14+

13−WorkingDirectory=/etc/oauth2-proxy

14−ExecStart=/usr/bin/oauth2-proxy --config=/etc/oauth2-proxy/oauth2-proxy.cfg

15+ExecStart=/usr/local/bin/oauth2-proxy --config=/etc/oauth2-proxy.cfg

15ExecReload=/bin/kill -HUP $MAINPID

16ExecReload=/bin/kill -HUP $MAINPID

16−LimitNOFILE=65535

17+

17−NoNewPrivileges=true

18+KillMode=process

18−ProtectHome=true

19+Restart=always

19−ProtectSystem=full

20−ProtectHostname=true

21−ProtectControlGroups=true

22−ProtectKernelModules=true

23−ProtectKernelTunables=true

24−LockPersonality=true

25−RestrictRealtime=yes

26−RestrictNamespaces=yes

27−MemoryDenyWriteExecute=yes

28−PrivateDevices=yes

29−PrivateTmp=true

30−CapabilityBoundingSet=

31

20

32[Install]

21[Install]

33WantedBy=multi-user.target

22WantedBy=multi-user.target

contrib/oauth2-proxy_autocomplete.sh+1−1

@@ -24,7 +24,7 @@ _oauth2_proxy() {

24 COMPREPLY=( $(compgen -W 'X-Real-IP X-Forwarded-For X-ProxyUser-IP' -- ${cur}) )

24 COMPREPLY=( $(compgen -W 'X-Real-IP X-Forwarded-For X-ProxyUser-IP' -- ${cur}) )

25 return 0

25 return 0

26 ;;

26 ;;

27− --@(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))

27+ --@(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|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))

28 return 0

28 return 0

29 ;;

29 ;;

30 esac

30 esac

dist.sh+9−34

@@ -7,19 +7,7 @@ if [[ -z ${BINARY} ]] || [[ -z ${VERSION} ]]; then

7 exit 1

7 exit 1

8fi

8fi

9

9

10−ARCHS=(

10+ARCHS=(darwin-amd64 linux-amd64 linux-arm64 linux-armv6 freebsd-amd64 windows-amd64)

11− darwin-amd64

12− darwin-arm64

13− linux-amd64

14− linux-arm64

15− linux-armv5

16− linux-armv6

17− linux-armv7

18− linux-ppc64le

19− linux-s390x

20− freebsd-amd64

21− windows-amd64

22−)

23

11

24mkdir -p release

12mkdir -p release

25

13

@@ -30,35 +18,22 @@ for ARCH in "${ARCHS[@]}"; do

30 GO_OS=$(echo $ARCH | awk -F- '{print $1}')

18 GO_OS=$(echo $ARCH | awk -F- '{print $1}')

31 GO_ARCH=$(echo $ARCH | awk -F- '{print $2}')

19 GO_ARCH=$(echo $ARCH | awk -F- '{print $2}')

32

20

33− # Determine binary name based on OS

34− if [[ "${GO_OS}" == "windows" ]]; then

35− BINARY_NAME="${BINARY}.exe"

36− else

37− BINARY_NAME="${BINARY}"

38− fi

39−

40 # Create architecture specific binaries

21 # Create architecture specific binaries

41− if [[ ${GO_ARCH} == armv* ]]; then

22+ if [[ ${GO_ARCH} == "armv6" ]]; then

42− GO_ARM=$(echo $GO_ARCH | awk -Fv '{print $2}')

43− GO111MODULE=on GOOS=${GO_OS} GOARCH=arm GOARM=${GO_ARM} CGO_ENABLED=0 go build \

23+ GO111MODULE=on GOOS=${GO_OS} GOARCH=arm GOARM=6 CGO_ENABLED=0 go build -ldflags="-X main.VERSION=${VERSION}" \

44− -ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" \

45− -o release/${BINARY}-${VERSION}.${ARCH}/${BINARY_NAME} .

24+ -o release/${BINARY}-${VERSION}.${ARCH}/${BINARY} .

46 else

25 else

47− GO111MODULE=on GOOS=${GO_OS} GOARCH=${GO_ARCH} CGO_ENABLED=0 go build \

26+ GO111MODULE=on GOOS=${GO_OS} GOARCH=${GO_ARCH} CGO_ENABLED=0 go build -ldflags="-X main.VERSION=${VERSION}" \

48− -ldflags="-X github.com/oauth2-proxy/oauth2-proxy/v7/pkg/version.VERSION=${VERSION}" \

49− -o release/${BINARY}-${VERSION}.${ARCH}/${BINARY_NAME} .

27+ -o release/${BINARY}-${VERSION}.${ARCH}/${BINARY} .

50 fi

28 fi

51

29

52 cd release

30 cd release

53

31

32+ # Create sha256sum for architecture specific binary

33+ sha256sum ${BINARY}-${VERSION}.${ARCH}/${BINARY} > ${BINARY}-${VERSION}.${ARCH}-sha256sum.txt

34+

54 # Create tar file for architecture specific binary

35 # Create tar file for architecture specific binary

55 tar -czvf ${BINARY}-${VERSION}.${ARCH}.tar.gz ${BINARY}-${VERSION}.${ARCH}

36 tar -czvf ${BINARY}-${VERSION}.${ARCH}.tar.gz ${BINARY}-${VERSION}.${ARCH}

56

37

57− # Create sha256sum for architecture-specific tar

58− sha256sum ${BINARY}-${VERSION}.${ARCH}.tar.gz > ${BINARY}-${VERSION}.${ARCH}.tar.gz-sha256sum.txt

59−

60− # Create sha256sum for architecture specific binary

61− sha256sum ${BINARY}-${VERSION}.${ARCH}/${BINARY_NAME} > ${BINARY}-${VERSION}.${ARCH}-sha256sum.txt

62−

63 cd ..

38 cd ..

64done

39done

docs/.gitignore−3

@@ -1,8 +1,5 @@

1# Dependencies

1# Dependencies

2/node_modules

2/node_modules

3−package-lock.json

4−pnpm-lock.yaml

5−yarn.lock

6

3

7# Production

4# Production

8/build

5/build

docs/README.md+4−4

@@ -5,13 +5,13 @@ This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern

5## Installation

5## Installation

6

6

7```console

7```console

8−npm install

8+yarn install

9```

9```

10

10

11## Local Development

11## Local Development

12

12

13```console

13```console

14−npm start

14+yarn start

15```

15```

16

16

17This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

17This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

@@ -19,7 +19,7 @@ This command starts a local development server and open up a browser window. Mos

19## Build

19## Build

20

20

21```console

21```console

22−npm run build

22+yarn build

23```

23```

24

24

25This command generates static content into the `build` directory and can be served using any static contents hosting service.

25This command generates static content into the `build` directory and can be served using any static contents hosting service.

@@ -27,7 +27,7 @@ This command generates static content into the `build` directory and can be serv

27## Deployment

27## Deployment

28

28

29```console

29```console

30−GIT_USER=<Your GitHub username> USE_SSH=true npm deploy

30+GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

31```

31```

32

32

33If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

33If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docs/behaviour.md+5−20

@@ -3,24 +3,9 @@ id: behaviour

3title: Behaviour

3title: Behaviour

4---

4---

5

5

6−1. Authentication Requirement: All requests passing through the proxy to upstream applications require authentication, excluding default proxy endpoints.

6+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`).

7− - Exception: If the request matches a skipped route (configured via `--skip-auth-route`):

7+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)

8− - Authentication is not enforced, but the proxy will opportunistically attempt to validate a session cookie (`--cookie-name`) or JWT (`--skip-jwt-bearer-tokens`) if present in the request.

8+3. After returning from the authentication provider, the oauth tokens are stored in the configured session store (cookie, redis, ...) and a cookie is set

9− - Configured user info and authentication headers (e.g., `--pass-access-token`) are injected to upstream routes when validation succeeds.

9+4. The request is forwarded to the upstream server with added user info and authentication headers (depending on the configuration)

10

10

11−2. Unauthenticated Requests: When authentication is missing but required, the user is redirected to the configured Identity Provider (IdP) login page by default.

12− - Ajax Requests: If the request has `Accept: application/json` header:

13− - Returns `401 Unauthorized`.

14− - Invalid JWT Tokens: If `--skip-jwt-bearer-tokens` is set and the request includes an invalid JWT:

15− - Redirects to the login page by default.

16− - Returns `403 Forbidden` if `--bearer-token-login-fallback` is set to `false`.

17−

18−3. Post-Authentication: After successful authentication with the IdP, OAuth tokens are stored in the configured session store (cookie or Redis), and a cookie is set.

19−

20−4. Request Forwarding: The authenticated request is processed based on configuration:

21− - Forwarded to the configured upstream application with added user info and authentication headers, or

22− - Returns a valid status code for downstream processing by another proxy or load balancer (e.g., Nginx or Traefik).

23−

24−---

25−

26−Note: The proxy also provides a number of useful [endpoints](features/endpoints.md) for monitoring and management.

11+Notice that the proxy also provides a number of useful [endpoints](features/endpoints.md).

docs/docs/community/contribution.mddeleted−91

@@ -1,91 +0,0 @@

1−---

2−id: contribution

3−title: Contribution Guide

4−---

5−

6−We track bugs and issues using Github.

7−

8−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.

9−

10−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.

11−Please mention open bug issue number(s) within your PR if applicable.

12−

13−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.

14−

15−

16−# Go version

17−

18−See the `go.mod` file in the root of this repository for the version of Go used by this project.

19−You can follow [the installation guide for Go](https://go.dev/doc/install),

20−and you can find this specific Go version on [the Go downloads page](https://go.dev/dl/).

21−

22−# Preparing your fork

23−Clone your fork, create a feature branch and update the depedencies to get started.

24−```bash

25−git clone git@github.com:<YOUR_FORK>/oauth2-proxy

26−cd oauth2-proxy

27−git branch feature/<BRANCH_NAME>

28−git push --set-upstream origin feature/<BRANCH_NAME>

29−go mod download

30−```

31−

32−

33−# Testing / Debugging

34−For starting oauth2-proxy locally open the debugging tab and create the `launch.json` and select `Go: Launch Package`.

35−

36−

37−```json

38−{

39− "version": "0.2.0",

40− "configurations": [

41− {

42− "name": "Launch OAuth2 Proxy with Dex",

43− "type": "go",

44− "request": "launch",

45− "mode": "auto",

46− "program": "${workspaceFolder}",

47− "args": [

48− "--config",

49− // The following configuration contains settings for a locally deployed

50− // upstream and dex as an idetity provider

51− "contrib/local-environment/oauth2-proxy.cfg"

52− ]

53− },

54− {

55− "name": "Launch OAuth2 Proxy with Keycloak",

56− "type": "go",

57− "request": "launch",

58− "mode": "auto",

59− "program": "${workspaceFolder}",

60− "args": [

61− "--config",

62− // The following configuration contains settings for a locally deployed

63− // upstream and keycloak as an idetity provider

64− "contrib/local-environment/oauth2-proxy-keycloak.cfg"

65− ]

66− }

67− ]

68−}

69−```

70−

71−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.

72−

73−Inside the `contrib/local-environment` directory you can use the `Makefile` for

74−starting different example setups:

75−

76−- Dex as your IdP: `make up` or `make down`

77−- Dex as your IdP using the alpha-config: `make alpha-config-up`

78−- Keycloak as your IdP: `make keycloak-up`

79−- Dex as your IdP & nginx reverse proxy: `make nginx-up`

80−- and many more...

81−

82−Check out the `Makefile` to see what is available.

83−

84−The username and password for all setups is usually `admin@example.com` and `password`.

85−

86−The docker compose setups expose the services with a dynamic reverse DNS resolver: localtest.me

87−

88−- OAuth2 Proxy: http://oauth2-proxy.localtest.me:4180

89−- Upstream: http://httpbin.localtest.me:8080

90−- Dex: http://dex.localtest.me:5556

91−

docs/docs/community/security.md+1−1

@@ -21,7 +21,7 @@ any details publicly.

21Security disclosures MUST be done in private.

21Security disclosures MUST be done in private.

22If you have found an issue that you would like to bring to the attention of the

22If you have found an issue that you would like to bring to the attention of the

23maintenance team for OAuth2 Proxy, please compose an email and send it to the

23maintenance team for OAuth2 Proxy, please compose an email and send it to the

24−list of maintainers in our [MAINTAINERS.md](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/MAINTAINERS.md) file.

24+list of maintainers in our [MAINTAINERS](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/MAINTAINERS) file.

25

25

26Please include as much detail as possible.

26Please include as much detail as possible.

27Ideally, your disclosure should include:

27Ideally, your disclosure should include:

docs/docs/configuration/alpha_config.md+40−359

@@ -23,57 +23,18 @@ When using alpha configuration, your config file will look something like below:

23```yaml

23```yaml

24upstreams:

24upstreams:

25 - id: ...

25 - id: ...

26− ...: ...

26+ ...

27−providers:

28− - id: ...

29− ...: ...

30−cookie:

31− secret: ...

32− ...: ...

33injectRequestHeaders:

27injectRequestHeaders:

34− - secretSource:

28+ - name: ...

35− ...: ...

29+ ...

36injectResponseHeaders:

30injectResponseHeaders:

37− - claimSource:

31+ - name: ...

38− ...: ...

32+ ...

39```

33```

40

34

41Please browse the [reference](#configuration-reference) below for the structure

35Please browse the [reference](#configuration-reference) below for the structure

42of the new configuration format.

36of the new configuration format.

43

37

44−# Migration Guide

45−

46−This section details breaking changes and migration steps for moving to the new

47−alpha configuration format.

48−

49−## Migrating header injections in v7.14.0

50−

51−From v7.14.0 onward, header injection sources must be explicitly nested. If you

52−previously relied on squashed fields, update to the new structure before

53−upgrading:

54−

55−```yaml

56−# before v7.14.0

57−injectRequestHeaders:

58−- name: X-Forwarded-User

59− values:

60− - claim: user

61−- name: X-Custom-Secret-header

62− values:

63− - value: my-super-secret

64−

65−# v7.14.0 and later

66−injectRequestHeaders:

67−- name: X-Forwarded-User

68− values:

69− - claimSource:

70− claim: user

71−- name: X-Custom-Secret-header

72− values:

73− - secretSource:

74− value: my-super-secret

75−```

76−

77## Using Alpha Configuration

38## Using Alpha Configuration

78

39

79To use the new **alpha** configuration, generate a YAML file based on the format

40To use the new **alpha** configuration, generate a YAML file based on the format

@@ -106,134 +67,6 @@ the new config.

106oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg

67oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg

107```

68```

108

69

109−### Validating Alpha Configuration

110−

111−Use `--config-test` to validate your alpha configuration without starting the proxy:

112−

113−```bash

114−oauth2-proxy --config core.cfg --alpha-config alpha.yaml --config-test

115−```

116−

117−This is useful for CI/CD pipelines to catch configuration errors before deployment.

118−See the [Configuration Validation](./overview.md#configuration-validation) section for more details.

119−

120−### How to use environment variables

121−

122−The alpha package supports the use of environment variables in place of yaml values, allowing sensitive data to be pulled from somewhere other than the yaml file.

123−When using environment variables, your yaml will look like this:

124−

125−```yaml

126− providers:

127− - provider: azure

128− clientSecret: ${CLIENT_SECRET}

129− ...

130−```

131−Where CLIENT_SECRET is an environment variable.

132−More information and available patterns can be found [here](https://github.com/a8m/envsubst#docs)

133−

134−### How to inject custom headers

135−

136−Configure `injectRequestHeaders` and `injectResponseHeaders` in alpha config YAML.

137−

138−```yaml

139−injectRequestHeaders:

140− - name: "X-User-Email"

141− values:

142− - claimSource:

143− claim: "email" # extract the email claim contents from the id token

144− - name: "X-Static-Secret"

145− values:

146− # secrets need to be encoded with base64 when directly in the yaml config but will be send decoded

147− - secretSource:

148− value: "c3VwZXItc2VjcmV0"

149− - name: "X-Static-File-Secret"

150− - secretSource:

151− fromFile: "/path/to/my/secret"

152− - name: "X-Static-Env-Secret"

153− - secretSource:

154− value: "${MY_SECRET_ENV}" # content still needs to be base64 encoded

155−injectResponseHeaders:

156− # Following will result in a header "Authorization: Basic <user:password> (encoded)"

157− - name: "Authorization"

158− values:

159− - claimSource:

160− claim: user

161− prefix: "Basic "

162− basicAuthPassword:

163− value: c3VwZXItc2VjcmV0LXBhc3N3b3Jk # base64 encoded password

164−```

165−

166−**Value sources:**

167−* `claimSource` - `claim` (session claims either from id token or from profile URL)

168−* `secretSource` - `value` (base64), `fromFile` (file path)

169−

170−#### Claim value serialization

171−

172−`claimSource` converts the selected claim into one or more string header values. Scalars

173−produce one value, while arrays produce one value per element. Values that cannot be

174−converted directly to strings, such as objects, are JSON-encoded individually.

175−

176−Each non-empty value is added separately under the configured header name. An array of

177−objects therefore produces multiple header values containing one JSON object each, not a

178−single JSON array. HTTP libraries and intermediaries may expose repeated values as a

179−comma-joined string, so consumers should retrieve and parse each header value separately.

180−

181−**Request option:** `preserveRequestValue: true` retains existing header values

182−

183−**Incompatibility:** Remove legacy flags `pass-user-headers`, `set-xauthrequest`

184−

185−### How to utilize arbitrary claims provided by your Identity Provider

186−

187−With the additionalClaims attribute you can specify which claims you want to extract

188−from the ID Token or userinfo (ProfileURL) endpoint.

189−

190−Configure these on the relevant provider entry:

191−

192−```yaml

193−providers:

194− - id: my-oidc-provider

195− provider: oidc

196− clientID: ${OAUTH_CLIENT_ID}

197− clientSecret: ${OAUTH_CLIENT_SECRET}

198− oidcConfig:

199− issuerURL: https://issuer.example.com

200− profileURL: https://issuer.example.com/oauth2/userinfo

201− additionalClaims:

202− - department

203− - employee_id

204− - organization.name

205−```

206−

207−OAuth2 Proxy resolves each configured claim using the following order:

208−

209−1. The raw ID token is checked first.

210−2. If the claim is not present there and `profileURL` is configured, the userinfo endpoint is queried.

211−3. If `skipClaimsFromProfileURL: true` is set, only the ID token is used.

212−

213−Claims that are not found are ignored rather than causing authentication to fail.

214−

215−You can use dot-separated paths for nested JSON objects, for example `organization.name`.

216−Array indexes are not supported.

217−

218−Once loaded, these claims are stored in the session as `additionalClaims`. They can then be

219−used anywhere session claims are accepted, including header injection:

220−

221−```yaml

222−injectRequestHeaders:

223− - name: X-Department

224− values:

225− - claimSource:

226− claim: department

227− - name: X-Organization

228− values:

229− - claimSource:

230− claim: organization.name

231−```

232−

233−This is useful when your IdP exposes application-specific attributes such as department,

234−tenant, employee ID, entitlement, or other custom claims that are not part of the default

235−OAuth2 Proxy session fields.

236−

237## Removed options

70## Removed options

238

71

239The following flags/options and their respective environment variables are no

72The following flags/options and their respective environment variables are no

@@ -258,31 +91,7 @@ longer available when using alpha configuration:

258- `basic-auth-password`/`basic_auth_password`

91- `basic-auth-password`/`basic_auth_password`

259- `skip-auth-strip-headers`/`skip_auth_strip_headers`

92- `skip-auth-strip-headers`/`skip_auth_strip_headers`

260

93

261−<!-- Legacy provider FlagSet -->

262−- `client-id`/`client_id`

263−- `client-secret`/`client_secret`, and `client-secret-file`/`client_secret_file`

264−- `provider`

265−- `provider-display-name`/`provider_display_name`

266−- `provider-ca-file`/`provider_ca_files`

267−- `login-url`/`login_url`

268−- `redeem-url`/`redeem_url`

269−- `profile-url`/`profile_url`

270−- `resource`

271−- `validate-url`/`validate_url`

272−- `scope`

273−- `prompt`

274−- `approval-prompt`/`approval_prompt`

275−- `acr-values`/`acr_values`

276−- `user-id-claim`/`user_id_claim`

277−- `allowed-group`/`allowed_groups`

278−- `allowed-role`/`allowed_roles`

279−- `jwt-key`/`jwt_key`

280−- `jwt-key-file`/`jwt_key_file`

281−- `pubjwk-url`/`pubjwk_url`

282−

283−and all provider-specific options, i.e. any option whose name includes `oidc`,

284−`azure`, `bitbucket`, `github`, `gitlab`, `google` or `keycloak`. Attempting to

285−use any of these options via flags or via config when `--alpha-config` is

94+Attempting to use these options via flags or via config when `--alpha-config`

286set will result in an error.

95set will result in an error.

287

96

288:::important

97:::important

@@ -290,7 +99,6 @@ You must remove these options before starting OAuth2 Proxy with `--alpha-config`

290:::

99:::

291

100

292## Configuration Reference

101## Configuration Reference

293−

294<!--- THIS FILE IS AUTOGENERATED!!! DO NOT EDIT!!! -->

102<!--- THIS FILE IS AUTOGENERATED!!! DO NOT EDIT!!! -->

295

103

296### ADFSOptions

104### ADFSOptions

@@ -321,7 +129,7 @@ They may change between releases without notice.

321| `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. |

129| `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. |

322| `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. |

130| `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. |

323| `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. |

131| `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. |

324−| `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) |

132+| `providers` | _[Providers](#providers)_ | Providers is used to configure multiple providers. |

325

133

326### AzureOptions

134### AzureOptions

327

135

@@ -332,7 +140,6 @@ They may change between releases without notice.

332| Field | Type | Description |

140| Field | Type | Description |

333| ----- | ---- | ----------- |

141| ----- | ---- | ----------- |

334| `tenant` | _string_ | Tenant directs to a tenant-specific or common (tenant-independent) endpoint<br/>Default value is 'common' |

142| `tenant` | _string_ | Tenant directs to a tenant-specific or common (tenant-independent) endpoint<br/>Default value is 'common' |

335−| `graphGroupField` | _string_ | GraphGroupField configures the group field to be used when building the groups list from Microsoft Graph<br/>Default value is 'id' |

336

143

337### BitbucketOptions

144### BitbucketOptions

338

145

@@ -353,10 +160,21 @@ ClaimSource allows loading a header value from a claim within the session

353

160

354| Field | Type | Description |

161| Field | Type | Description |

355| ----- | ---- | ----------- |

162| ----- | ---- | ----------- |

356−| `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`. |

163+| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. |

357| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |

164| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |

358| `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. |

165| `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. |

359

166

167+### Duration

168+#### (`string` alias)

169+

170+(**Appears on:** [Upstream](#upstream))

171+

172+Duration is as string representation of a period of time.

173+A duration string is a is a possibly signed sequence of decimal numbers,

174+each with optional fraction and a unit suffix, such as "300ms", "-1.5h" or "2h45m".

175+Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".

176+

177+

360### GitHubOptions

178### GitHubOptions

361

179

362(**Appears on:** [Provider](#provider))

180(**Appears on:** [Provider](#provider))

@@ -380,7 +198,7 @@ ClaimSource allows loading a header value from a claim within the session

380| Field | Type | Description |

198| Field | Type | Description |

381| ----- | ---- | ----------- |

199| ----- | ---- | ----------- |

382| `group` | _[]string_ | Group sets restrict logins to members of this group |

200| `group` | _[]string_ | Group sets restrict logins to members of this group |

383−| `projects` | _[]string_ | Projects restricts logins to members of these projects |

201+| `projects` | _[]string_ | Projects restricts logins to members of any of these projects |

384

202

385### GoogleOptions

203### GoogleOptions

386

204

@@ -390,13 +208,9 @@ ClaimSource allows loading a header value from a claim within the session

390

208

391| Field | Type | Description |

209| Field | Type | Description |

392| ----- | ---- | ----------- |

210| ----- | ---- | ----------- |

393−| `group` | _[]string_ | Groups sets restrict logins to members of this Google group |

211+| `group` | _[]string_ | Groups sets restrict logins to members of this google group |

394−| `adminEmail` | _string_ | AdminEmail is the Google admin to impersonate for api calls |

212+| `adminEmail` | _string_ | AdminEmail is the google admin to impersonate for api calls |

395| `serviceAccountJson` | _string_ | ServiceAccountJSON is the path to the service account json credentials |

213| `serviceAccountJson` | _string_ | ServiceAccountJSON is the path to the service account json credentials |

396−| `useApplicationDefaultCredentials` | _bool_ | UseApplicationDefaultCredentials is a boolean whether to use Application Default Credentials instead of a ServiceAccountJSON |

397−| `targetPrincipal` | _string_ | TargetPrincipal is the Google Service Account used for Application Default Credentials |

398−| `useOrganizationID` | _bool_ | UseOrganizationId indicates whether to use the organization ID as the UserName claim |

399−| `adminAPIUserScope` | _string_ | admin scope needed for fetching user organization information from admin api, can be one of cloud, user or defaults to readonly |

400

214

401### Header

215### Header

402

216

@@ -409,7 +223,6 @@ response header.

409| ----- | ---- | ----------- |

223| ----- | ---- | ----------- |

410| `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. |

224| `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. |

411| `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). |

225| `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). |

412−| `InsecureSkipHeaderNormalization` | _bool_ | InsecureSkipHeaderNormalization disables normalizing the header name<br/>According to RFC 7230 Section 3.2 there aren't any rules about<br/>capitalization of header names, but the standard practice is to use<br/>Title-Case (e.g. X-Forwarded-For). By default, header names will be<br/>normalized to Title-Case and any incoming headers that match will be<br/>treated as the same header. Additionally underscores (_) in header names<br/>will be converted to dashes (-) when normalizing.<br/>Defaults to false (header names will be normalized). |

413| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |

226| `values` | _[[]HeaderValue](#headervalue)_ | Values contains the desired values for this header |

414

227

415### HeaderValue

228### HeaderValue

@@ -424,7 +237,7 @@ make up the header value

424| `value` | _[]byte_ | Value expects a base64 encoded string value. |

237| `value` | _[]byte_ | Value expects a base64 encoded string value. |

425| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |

238| `fromEnv` | _string_ | FromEnv expects the name of an environment variable. |

426| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |

239| `fromFile` | _string_ | FromFile expects a path to a file containing the secret value. |

427−| `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`. |

240+| `claim` | _string_ | Claim is the name of the claim in the session that the value should be<br/>loaded from. |

428| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |

241| `prefix` | _string_ | Prefix is an optional prefix that will be prepended to the value of the<br/>claim if it is non-empty. |

429| `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. |

242| `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. |

430

243

@@ -451,97 +264,6 @@ make up the header value

451| `jwtKeyFile` | _string_ | JWTKeyFile is a path to the private key file in PEM format used to sign the JWT |

264| `jwtKeyFile` | _string_ | JWTKeyFile is a path to the private key file in PEM format used to sign the JWT |

452| `pubjwkURL` | _string_ | PubJWKURL is the JWK pubkey access endpoint |

265| `pubjwkURL` | _string_ | PubJWKURL is the JWK pubkey access endpoint |

453

266

454−### LoginURLParameter

455−

456−(**Appears on:** [Provider](#provider))

457−

458−LoginURLParameter is the configuration for a single query parameter that

459−can be passed through from the `/oauth2/start` endpoint to the IdP login

460−URL. The "default" option specifies the default value or values (if any)

461−that will be passed to the IdP for this parameter, and "allow" is a list

462−of options for ways in which this parameter can be set or overridden via

463−the query string to `/oauth2/start`.

464−If _only_ a default is specified and no "allow" then the parameter is

465−effectively fixed - the default value will always be used and anything

466−passed to the start URL will be ignored. If _only_ "allow" is specified

467−but no default then the parameter will only be passed on to the IdP if

468−the caller provides it, and no value will be sent otherwise.

469−

470−Examples:

471−

472−# A parameter whose value is fixed

473−

474−```

475−name: organization

476−default:

477−- myorg

478−```

479−

480−A parameter that is not passed by default, but may be set to one of a

481−fixed set of values

482−

483−```

484−name: prompt

485−allow:

486−- value: login

487−- value: consent

488−- value: select_account

489−```

490−

491−A parameter that is passed by default but may be overridden by one of

492−a fixed set of values

493−

494−```

495−name: prompt

496−default: ["login"]

497−allow:

498−- value: consent

499−- value: select_account

500−```

501−

502−A parameter that may be overridden, but only by values that match a

503−regular expression. For example to restrict `login_hint` to email

504−addresses in your organization's domain:

505−

506−```

507−name: login_hint

508−allow:

509−- pattern: '^[^@]*@example\.com$'

510−# this allows at most one "@" sign, and requires "example.com" domain.

511−```

512−

513−Note that the YAML rules around exactly which characters are allowed

514−and/or require escaping in different types of string literals are

515−convoluted. For regular expressions the single quoted form is simplest

516−as backslash is not considered to be an escape character. Alternatively

517−use the "chomped block" format `|-`:

518−

519−```

520− - pattern: |-

521− ^[^@]*@example\.com$

522−

523−```

524−

525−The hyphen is important, a `|` block would have a trailing newline

526−character.

527−

528−| Field | Type | Description |

529−| ----- | ---- | ----------- |

530−| `name` | _string_ | Name specifies the name of the query parameter. |

531−| `default` | _[]string_ | _(Optional)_ Default specifies a default value or values that will be<br/>passed to the IdP if not overridden. |

532−| `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. |

533−

534−### MicrosoftEntraIDOptions

535−

536−(**Appears on:** [Provider](#provider))

537−

538−

539−

540−| Field | Type | Description |

541−| ----- | ---- | ----------- |

542−| `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). |

543−| `federatedTokenAuth` | _bool_ | FederatedTokenAuth enable oAuth2 client authentication with federated token projected<br/>by Entra Workload Identity plugin, instead of client secret. |

544−

545### OIDCOptions

267### OIDCOptions

546

268

547(**Appears on:** [Provider](#provider))

269(**Appears on:** [Provider](#provider))

@@ -556,13 +278,9 @@ character.

556| `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. |

278| `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. |

557| `skipDiscovery` | _bool_ | SkipDiscovery allows to skip OIDC discovery and use manually supplied Endpoints<br/>default set to 'false' |

279| `skipDiscovery` | _bool_ | SkipDiscovery allows to skip OIDC discovery and use manually supplied Endpoints<br/>default set to 'false' |

558| `jwksURL` | _string_ | JwksURL is the OpenID Connect JWKS URL<br/>eg: https://www.googleapis.com/oauth2/v3/certs |

280| `jwksURL` | _string_ | JwksURL is the OpenID Connect JWKS URL<br/>eg: https://www.googleapis.com/oauth2/v3/certs |

559−| `publicKeyFiles` | _[]string_ | PublicKeyFiles is a list of paths pointing to public key files in PEM format to use<br/>for verifying JWT tokens |

560| `emailClaim` | _string_ | EmailClaim indicates which claim contains the user email,<br/>default set to 'email' |

281| `emailClaim` | _string_ | EmailClaim indicates which claim contains the user email,<br/>default set to 'email' |

561| `groupsClaim` | _string_ | GroupsClaim indicates which claim contains the user groups<br/>default set to 'groups' |

282| `groupsClaim` | _string_ | GroupsClaim indicates which claim contains the user groups<br/>default set to 'groups' |

562| `userIDClaim` | _string_ | UserIDClaim indicates which claim contains the user ID<br/>default set to 'email' |

283| `userIDClaim` | _string_ | UserIDClaim indicates which claim contains the user ID<br/>default set to 'email' |

563−| `audienceClaims` | _[]string_ | AudienceClaim allows to define any claim that is verified against the client id<br/>By default `aud` claim is used for verification. |

564−| `extraAudiences` | _[]string_ | ExtraAudiences is a list of additional audiences that are allowed<br/>to pass verification in addition to the client id. |

565−| `enabledSigningAlgs` | _[]string_ | EnabledSigningAlgs is a list of allowed JWT signing algorithms.<br/>When discovery is enabled, the effective set is the intersection<br/>between this list and the provider's discovered supported algorithms.<br/>By default `RS256` is used if nothing has been discovered or specified. |

566

284

567### Provider

285### Provider

568

286

@@ -577,7 +295,6 @@ Provider holds all configuration for a single provider

577| `clientSecretFile` | _string_ | ClientSecretFile is the name of the file<br/>containing the OAuth Client Secret, it will be used if ClientSecret is not set. |

295| `clientSecretFile` | _string_ | ClientSecretFile is the name of the file<br/>containing the OAuth Client Secret, it will be used if ClientSecret is not set. |

578| `keycloakConfig` | _[KeycloakOptions](#keycloakoptions)_ | KeycloakConfig holds all configurations for Keycloak provider. |

296| `keycloakConfig` | _[KeycloakOptions](#keycloakoptions)_ | KeycloakConfig holds all configurations for Keycloak provider. |

579| `azureConfig` | _[AzureOptions](#azureoptions)_ | AzureConfig holds all configurations for Azure provider. |

297| `azureConfig` | _[AzureOptions](#azureoptions)_ | AzureConfig holds all configurations for Azure provider. |

580−| `microsoftEntraIDConfig` | _[MicrosoftEntraIDOptions](#microsoftentraidoptions)_ | MicrosoftEntraIDConfig holds all configurations for Entra ID provider. |

581| `ADFSConfig` | _[ADFSOptions](#adfsoptions)_ | ADFSConfig holds all configurations for ADFS provider. |

298| `ADFSConfig` | _[ADFSOptions](#adfsoptions)_ | ADFSConfig holds all configurations for ADFS provider. |

582| `bitbucketConfig` | _[BitbucketOptions](#bitbucketoptions)_ | BitbucketConfig holds all configurations for Bitbucket provider. |

299| `bitbucketConfig` | _[BitbucketOptions](#bitbucketoptions)_ | BitbucketConfig holds all configurations for Bitbucket provider. |

583| `githubConfig` | _[GitHubOptions](#githuboptions)_ | GitHubConfig holds all configurations for GitHubC provider. |

300| `githubConfig` | _[GitHubOptions](#githuboptions)_ | GitHubConfig holds all configurations for GitHubC provider. |

@@ -586,33 +303,19 @@ Provider holds all configuration for a single provider

586| `oidcConfig` | _[OIDCOptions](#oidcoptions)_ | OIDCConfig holds all configurations for OIDC provider<br/>or providers utilize OIDC configurations. |

303| `oidcConfig` | _[OIDCOptions](#oidcoptions)_ | OIDCConfig holds all configurations for OIDC provider<br/>or providers utilize OIDC configurations. |

587| `loginGovConfig` | _[LoginGovOptions](#logingovoptions)_ | LoginGovConfig holds all configurations for LoginGov provider. |

304| `loginGovConfig` | _[LoginGovOptions](#logingovoptions)_ | LoginGovConfig holds all configurations for LoginGov provider. |

588| `id` | _string_ | ID should be a unique identifier for the provider.<br/>This value is required for all providers. |

305| `id` | _string_ | ID should be a unique identifier for the provider.<br/>This value is required for all providers. |

589−| `provider` | _[ProviderType](#providertype)_ | Type is the OAuth provider<br/>must be set from the supported providers group,<br/>otherwise 'Google' is set as default |

306+| `provider` | _string_ | Type is the OAuth provider<br/>must be set from the supported providers group,<br/>otherwise 'Google' is set as default |

590| `name` | _string_ | Name is the providers display name<br/>if set, it will be shown to the users in the login page. |

307| `name` | _string_ | Name is the providers display name<br/>if set, it will be shown to the users in the login page. |

591| `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 |

308| `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 |

592−| `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. |

593| `loginURL` | _string_ | LoginURL is the authentication endpoint |

309| `loginURL` | _string_ | LoginURL is the authentication endpoint |

594−| `loginURLParameters` | _[[]LoginURLParameter](#loginurlparameter)_ | LoginURLParameters defines the parameters that can be passed from the start URL to the IdP login URL |

595−| `authRequestResponseMode` | _string_ | AuthRequestResponseMode defines the response mode to request during authorization request |

596| `redeemURL` | _string_ | RedeemURL is the token redemption endpoint |

310| `redeemURL` | _string_ | RedeemURL is the token redemption endpoint |

597| `profileURL` | _string_ | ProfileURL is the profile access endpoint |

311| `profileURL` | _string_ | ProfileURL is the profile access endpoint |

598−| `skipClaimsFromProfileURL` | _bool_ | SkipClaimsFromProfileURL allows to skip request to Profile URL for resolving claims not present in id_token<br/>default set to 'false' |

599| `resource` | _string_ | ProtectedResource is the resource that is protected (Azure AD and ADFS only) |

312| `resource` | _string_ | ProtectedResource is the resource that is protected (Azure AD and ADFS only) |

600| `validateURL` | _string_ | ValidateURL is the access token validation endpoint |

313| `validateURL` | _string_ | ValidateURL is the access token validation endpoint |

601| `scope` | _string_ | Scope is the OAuth scope specification |

314| `scope` | _string_ | Scope is the OAuth scope specification |

315+| `prompt` | _string_ | Prompt is OIDC prompt |

316+| `approvalPrompt` | _string_ | ApprovalPrompt is the OAuth approval_prompt<br/>default is set to 'force' |

602| `allowedGroups` | _[]string_ | AllowedGroups is a list of restrict logins to members of this group |

317| `allowedGroups` | _[]string_ | AllowedGroups is a list of restrict logins to members of this group |

603−| `code_challenge_method` | _string_ | The code challenge method |

318+| `acrValues` | _string_ | AcrValues is a string of acr values |

604−| `additionalClaims` | _[]string_ | Additional claims to be obtained from the upstream IDP, either from the id_token or from the userinfo endpoint if configured. |

605−| `backendLogoutURL` | _string_ | URL to call to perform backend logout, `{id_token}` would be replaced by the actual `id_token` if available in the session |

606−

607−### ProviderType

608−#### (`string` alias)

609−

610−(**Appears on:** [Provider](#provider))

611−

612−ProviderType is used to enumerate the different provider type options

613−Valid options are: adfs, azure, bitbucket, digitalocean facebook, github,

614−gitlab, google, keycloak, keycloak-oidc, linkedin, login.gov, nextcloud

615−and oidc.

616

319

617### Providers

320### Providers

618

321

@@ -620,11 +323,8 @@ and oidc.

620

323

621(**Appears on:** [AlphaOptions](#alphaoptions))

324(**Appears on:** [AlphaOptions](#alphaoptions))

622

325

623−The provider can be selected using the `provider` configuration value, or

326+Providers is a collection of definitions for providers.

624−set in the [`providers` array using

327+

625−AlphaConfig](https://oauth2-proxy.github.io/oauth2-proxy/configuration/alpha-config#providers).

626−However, [**the feature to implement multiple providers is not

627−complete**](https://github.com/oauth2-proxy/oauth2-proxy/issues/926).

628

328

629### SecretSource

329### SecretSource

630

330

@@ -647,37 +347,20 @@ Server represents the configuration for an HTTP(S) server

647

347

648| Field | Type | Description |

348| Field | Type | Description |

649| ----- | ---- | ----------- |

349| ----- | ---- | ----------- |

650−| `bindAddress` | _string_ | BindAddress is the address on which to serve traffic.<br/>Different types of bind addresses are supported:<br/>* `[http://]<addr>:<port>`<br/>* `fd:<int>` (case insensitive)<br/>* `unix://<path>`<br/>Unix sockets are created with default system umask mode, which can be overridden, e.g.: `unix://my-socket,mode=0777`<br/>Square brackets are required for ipv6 address, e.g. `http://[::1]:4180`<br/>Leave blank or set to "-" to disable. |

350+| `BindAddress` | _string_ | BindAddress is the address on which to serve traffic.<br/>Leave blank or set to "-" to disable. |

651−| `secureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic.<br/>Secure bind addresses need to respond with valid SSL and use the following format:<br/>* `[https://]<addr>:<port>`<br/>Square brackets are required for ipv6 address, e.g. `https://[::1]:4180`<br/>Leave blank or set to "-" to disable. |

351+| `SecureBindAddress` | _string_ | SecureBindAddress is the address on which to serve secure traffic.<br/>Leave blank or set to "-" to disable. |

652−| `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. |

352+| `TLS` | _[TLS](#tls)_ | TLS contains the information for loading the certificate and key for the<br/>secure traffic. |

653

353

654### TLS

354### TLS

655

355

656(**Appears on:** [Server](#server))

356(**Appears on:** [Server](#server))

657

357

658−TLS contains the information for loading a TLS certificate and key

358+TLS contains the information for loading a TLS certifcate and key.

659−as well as an optional minimal TLS version that is acceptable.

660−

661−| Field | Type | Description |

662−| ----- | ---- | ----------- |

663−| `key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use.<br/>Typically this will come from a file. |

664−| `cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |

665−| `minVersion` | _string_ | MinVersion is the minimal TLS version that is acceptable.<br/>E.g. Set to "TLS1.3" to select TLS version 1.3 |

666−| `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). |

667−

668−### URLParameterRule

669−

670−(**Appears on:** [LoginURLParameter](#loginurlparameter))

671−

672−URLParameterRule represents a rule by which query parameters

673−passed to the `/oauth2/start` endpoint are checked to determine whether

674−they are valid overrides for the given parameter passed to the IdP's

675−login URL. Either Value or Pattern should be supplied, not both.

676

359

677| Field | Type | Description |

360| Field | Type | Description |

678| ----- | ---- | ----------- |

361| ----- | ---- | ----------- |

679−| `value` | _string_ | A Value rule matches just this specific value |

362+| `Key` | _[SecretSource](#secretsource)_ | Key is the TLS key data to use.<br/>Typically this will come from a file. |

680−| `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 `$`. |

363+| `Cert` | _[SecretSource](#secretsource)_ | Cert is the TLS certificate data to use.<br/>Typically this will come from a file. |

681

364

682### Upstream

365### Upstream

683

366

@@ -689,17 +372,15 @@ Requests will be proxied to this upstream if the path matches the request path.

689| Field | Type | Description |

372| Field | Type | Description |

690| ----- | ---- | ----------- |

373| ----- | ---- | ----------- |

691| `id` | _string_ | ID should be a unique identifier for the upstream.<br/>This value is required for all upstreams. |

374| `id` | _string_ | ID should be a unique identifier for the upstream.<br/>This value is required for all upstreams. |

692−| `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/>Without RewriteTarget, Path follows gorilla/mux route syntax.<br/>Eg:<br/>- `/foo`: Match only the explicit path `/foo`<br/>- `/bar/`: Match any path prefixed with `/bar/`<br/>- `/baz/{path:.*}`: Match any path prefixed with `/baz/`<br/>When RewriteTarget is set, Path is treated as a regular expression.<br/>Eg: `^/baz/(.*)$` matches any path prefixed with `/baz` and captures the<br/>remaining path for use with RewriteTarget. |

375+| `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 |

693−| `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`. |

376+| `rewriteTarget` | _string_ | RewriteTarget allows users to rewrite the request path before it is sent to<br/>the upstream server.<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. |

694| `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". |

377| `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". |

695−| `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. |

378+| `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/>betweem OAuth2 Proxy and the usptream server.<br/>Defaults to false. |

696| `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. |

379| `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. |

697| `staticCode` | _int_ | StaticCode determines the response code for the Static response.<br/>This option can only be used with Static enabled. |

380| `staticCode` | _int_ | StaticCode determines the response code for the Static response.<br/>This option can only be used with Static enabled. |

698−| `flushInterval` | _duration_ | FlushInterval is the period between flushing the response buffer when<br/>streaming response from the upstream.<br/>Defaults to 1 second. |

381+| `flushInterval` | _[Duration](#duration)_ | FlushInterval is the period between flushing the response buffer when<br/>streaming response from the upstream.<br/>Defaults to 1 second. |

699| `passHostHeader` | _bool_ | PassHostHeader determines whether the request host header should be proxied<br/>to the upstream server.<br/>Defaults to true. |

382| `passHostHeader` | _bool_ | PassHostHeader determines whether the request host header should be proxied<br/>to the upstream server.<br/>Defaults to true. |

700| `proxyWebSockets` | _bool_ | ProxyWebSockets enables proxying of websockets to upstream servers<br/>Defaults to true. |

383| `proxyWebSockets` | _bool_ | ProxyWebSockets enables proxying of websockets to upstream servers<br/>Defaults to true. |

701−| `timeout` | _duration_ | Timeout is the maximum duration the server will wait for a response from the upstream server.<br/>Defaults to 30 seconds. |

702−| `disableKeepAlives` | _bool_ | DisableKeepAlives disables HTTP keep-alive connections to the upstream server.<br/>Defaults to false. |

703

384

704### UpstreamConfig

385### UpstreamConfig

705

386

@@ -709,5 +390,5 @@ UpstreamConfig is a collection of definitions for upstream servers.

709

390

710| Field | Type | Description |

391| Field | Type | Description |

711| ----- | ---- | ----------- |

392| ----- | ---- | ----------- |

712−| `proxyRawPath` | _bool_ | ProxyRawPath will pass the raw url path to upstream allowing for urls<br/>like: "/%2F/" which would otherwise be redirected to "/" |

393+| `proxyRawPath` | _bool_ | ProxyRawPath will pass the raw url path to upstream allowing for url's<br/>like: "/%2F/" which would otherwise be redirected to "/" |

713| `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. |

394| `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. |

docs/docs/configuration/alpha_config.md.tmpl+6−197

@@ -23,57 +23,18 @@ When using alpha configuration, your config file will look something like below:

23```yaml

23```yaml

24upstreams:

24upstreams:

25 - id: ...

25 - id: ...

26− ...: ...

26+ ...

27−providers:

28− - id: ...

29− ...: ...

30−cookie:

31− secret: ...

32− ...: ...

33injectRequestHeaders:

27injectRequestHeaders:

34− - secretSource:

28+ - name: ...

35− ...: ...

29+ ...

36injectResponseHeaders:

30injectResponseHeaders:

37− - claimSource:

31+ - name: ...

38− ...: ...

32+ ...

39```

33```

40

34

41Please browse the [reference](#configuration-reference) below for the structure

35Please browse the [reference](#configuration-reference) below for the structure

42of the new configuration format.

36of the new configuration format.

43

37

44−# Migration Guide

45−

46−This section details breaking changes and migration steps for moving to the new

47−alpha configuration format.

48−

49−## Migrating header injections in v7.14.0

50−

51−From v7.14.0 onward, header injection sources must be explicitly nested. If you

52−previously relied on squashed fields, update to the new structure before

53−upgrading:

54−

55−```yaml

56−# before v7.14.0

57−injectRequestHeaders:

58−- name: X-Forwarded-User

59− values:

60− - claim: user

61−- name: X-Custom-Secret-header

62− values:

63− - value: my-super-secret

64−

65−# v7.14.0 and later

66−injectRequestHeaders:

67−- name: X-Forwarded-User

68− values:

69− - claimSource:

70− claim: user

71−- name: X-Custom-Secret-header

72− values:

73− - secretSource:

74− value: my-super-secret

75−```

76−

77## Using Alpha Configuration

38## Using Alpha Configuration

78

39

79To use the new **alpha** configuration, generate a YAML file based on the format

40To use the new **alpha** configuration, generate a YAML file based on the format

@@ -106,134 +67,6 @@ the new config.

106oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg

67oauth2-proxy --alpha-config ./path/to/new/config.yaml --config ./path/to/existing/config.cfg

107```

68```

108

69

109−### Validating Alpha Configuration

110−

111−Use `--config-test` to validate your alpha configuration without starting the proxy:

112−

113−```bash

114−oauth2-proxy --config core.cfg --alpha-config alpha.yaml --config-test

115−```

116−

117−This is useful for CI/CD pipelines to catch configuration errors before deployment.

118−See the [Configuration Validation](./overview.md#configuration-validation) section for more details.

119−

120−### How to use environment variables

121−

122−The alpha package supports the use of environment variables in place of yaml values, allowing sensitive data to be pulled from somewhere other than the yaml file.

123−When using environment variables, your yaml will look like this:

124−

125−```yaml

126− providers:

127− - provider: azure

128− clientSecret: ${CLIENT_SECRET}

129− ...

130−```

131−Where CLIENT_SECRET is an environment variable.

132−More information and available patterns can be found [here](https://github.com/a8m/envsubst#docs)

133−

134−### How to inject custom headers

135−

136−Configure `injectRequestHeaders` and `injectResponseHeaders` in alpha config YAML.

137−

138−```yaml

139−injectRequestHeaders:

140− - name: "X-User-Email"

141− values:

142− - claimSource:

143− claim: "email" # extract the email claim contents from the id token

144− - name: "X-Static-Secret"

145− values:

146− # secrets need to be encoded with base64 when directly in the yaml config but will be send decoded

147− - secretSource:

148− value: "c3VwZXItc2VjcmV0"

149− - name: "X-Static-File-Secret"

150− - secretSource:

151− fromFile: "/path/to/my/secret"

152− - name: "X-Static-Env-Secret"

153− - secretSource:

154− value: "${MY_SECRET_ENV}" # content still needs to be base64 encoded

155−injectResponseHeaders:

156− # Following will result in a header "Authorization: Basic <user:password> (encoded)"

157− - name: "Authorization"

158− values:

159− - claimSource:

160− claim: user

161− prefix: "Basic "

162− basicAuthPassword:

163− value: c3VwZXItc2VjcmV0LXBhc3N3b3Jk # base64 encoded password

164−```

165−

166−**Value sources:**

167−* `claimSource` - `claim` (session claims either from id token or from profile URL)

168−* `secretSource` - `value` (base64), `fromFile` (file path)

169−

170−#### Claim value serialization

171−

172−`claimSource` converts the selected claim into one or more string header values. Scalars

173−produce one value, while arrays produce one value per element. Values that cannot be

174−converted directly to strings, such as objects, are JSON-encoded individually.

175−

176−Each non-empty value is added separately under the configured header name. An array of

177−objects therefore produces multiple header values containing one JSON object each, not a

178−single JSON array. HTTP libraries and intermediaries may expose repeated values as a

179−comma-joined string, so consumers should retrieve and parse each header value separately.

180−

181−**Request option:** `preserveRequestValue: true` retains existing header values

182−

183−**Incompatibility:** Remove legacy flags `pass-user-headers`, `set-xauthrequest`

184−

185−### How to utilize arbitrary claims provided by your Identity Provider

186−

187−With the additionalClaims attribute you can specify which claims you want to extract

188−from the ID Token or userinfo (ProfileURL) endpoint.

189−

190−Configure these on the relevant provider entry:

191−

192−```yaml

193−providers:

194− - id: my-oidc-provider

195− provider: oidc

196− clientID: ${OAUTH_CLIENT_ID}

197− clientSecret: ${OAUTH_CLIENT_SECRET}

198− oidcConfig:

199− issuerURL: https://issuer.example.com

200− profileURL: https://issuer.example.com/oauth2/userinfo

201− additionalClaims:

202− - department

203− - employee_id

204− - organization.name

205−```

206−

207−OAuth2 Proxy resolves each configured claim using the following order:

208−

209−1. The raw ID token is checked first.

210−2. If the claim is not present there and `profileURL` is configured, the userinfo endpoint is queried.

211−3. If `skipClaimsFromProfileURL: true` is set, only the ID token is used.

212−

213−Claims that are not found are ignored rather than causing authentication to fail.

214−

215−You can use dot-separated paths for nested JSON objects, for example `organization.name`.

216−Array indexes are not supported.

217−

218−Once loaded, these claims are stored in the session as `additionalClaims`. They can then be

219−used anywhere session claims are accepted, including header injection:

220−

221−```yaml

222−injectRequestHeaders:

223− - name: X-Department

224− values:

225− - claimSource:

226− claim: department

227− - name: X-Organization

228− values:

229− - claimSource:

230− claim: organization.name

231−```

232−

233−This is useful when your IdP exposes application-specific attributes such as department,

234−tenant, employee ID, entitlement, or other custom claims that are not part of the default

235−OAuth2 Proxy session fields.

236−

237## Removed options

70## Removed options

238

71

239The following flags/options and their respective environment variables are no

72The following flags/options and their respective environment variables are no

@@ -258,31 +91,7 @@ longer available when using alpha configuration:

258- `basic-auth-password`/`basic_auth_password`

91- `basic-auth-password`/`basic_auth_password`

259- `skip-auth-strip-headers`/`skip_auth_strip_headers`

92- `skip-auth-strip-headers`/`skip_auth_strip_headers`

260

93

261−<!-- Legacy provider FlagSet -->

262−- `client-id`/`client_id`

263−- `client-secret`/`client_secret`, and `client-secret-file`/`client_secret_file`

264−- `provider`

265−- `provider-display-name`/`provider_display_name`

266−- `provider-ca-file`/`provider_ca_files`

267−- `login-url`/`login_url`

268−- `redeem-url`/`redeem_url`

269−- `profile-url`/`profile_url`

270−- `resource`

271−- `validate-url`/`validate_url`

272−- `scope`

273−- `prompt`

274−- `approval-prompt`/`approval_prompt`

275−- `acr-values`/`acr_values`

276−- `user-id-claim`/`user_id_claim`

277−- `allowed-group`/`allowed_groups`

278−- `allowed-role`/`allowed_roles`

279−- `jwt-key`/`jwt_key`

280−- `jwt-key-file`/`jwt_key_file`

281−- `pubjwk-url`/`pubjwk_url`

282−

283−and all provider-specific options, i.e. any option whose name includes `oidc`,

284−`azure`, `bitbucket`, `github`, `gitlab`, `google` or `keycloak`. Attempting to

285−use any of these options via flags or via config when `--alpha-config` is

94+Attempting to use these options via flags or via config when `--alpha-config`

286set will result in an error.

95set will result in an error.

287

96

288:::important

97:::important

docs/versioned_docs/version-7.3.x/configuration/auth.md → docs/docs/configuration/auth.mdrenamed+17−37

@@ -106,7 +106,7 @@ Note: When using the ADFS Auth provider with nginx and the cookie session store

106

106

107### Facebook Auth Provider

107### Facebook Auth Provider

108

108

109−1. Create a new FB App from https://developers.facebook.com/

109+1. Create a new FB App from <https://developers.facebook.com/>

1102. Under FB Login, set your Valid OAuth redirect URIs to `https://internal.yourcompany.com/oauth2/callback`

1102. Under FB Login, set your Valid OAuth redirect URIs to `https://internal.yourcompany.com/oauth2/callback`

111

111

112### GitHub Auth Provider

112### GitHub Auth Provider

@@ -120,52 +120,38 @@ NOTE: When `--github-user` is set, the specified users are allowed to login even

120

120

121To restrict by organization only, include the following flag:

121To restrict by organization only, include the following flag:

122

122

123−```

124− --github-org="": restrict logins to members of this organisation

123+ -github-org="": restrict logins to members of this organisation

125−```

126

124

127To restrict within an organization to specific teams, include the following flag in addition to `-github-org`:

125To restrict within an organization to specific teams, include the following flag in addition to `-github-org`:

128

126

129−```

130− --github-team="": restrict logins to members of any of these teams (slug), separated by a comma

127+ -github-team="": restrict logins to members of any of these teams (slug), separated by a comma

131−```

132

128

133If 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:

129If 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:

134

130

135−```

136− --github-repo="": restrict logins to collaborators of this repository formatted as orgname/repo

131+ -github-repo="": restrict logins to collaborators of this repository formatted as orgname/repo

137−```

138

132

139If 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:

133If 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:

140

134

141−```

142− --github-token="": the token to use when verifying repository collaborators

135+ -github-token="": the token to use when verifying repository collaborators

143−```

144

136

145To allow a user to login with their username even if they do not belong to the specified org and team or collaborators, separated by a comma

137To allow a user to login with their username even if they do not belong to the specified org and team or collaborators, separated by a comma

146

138

147−```

148− --github-user="": allow logins by username, separated by a comma

139+ -github-user="": allow logins by username, separated by a comma

149−```

150

140

151If you are using GitHub enterprise, make sure you set the following to the appropriate url:

141If you are using GitHub enterprise, make sure you set the following to the appropriate url:

152

142

153−```

154− --login-url="http(s)://<enterprise github host>/login/oauth/authorize"

143+ -login-url="http(s)://<enterprise github host>/login/oauth/authorize"

155− --redeem-url="http(s)://<enterprise github host>/login/oauth/access_token"

144+ -redeem-url="http(s)://<enterprise github host>/login/oauth/access_token"

156− --validate-url="http(s)://<enterprise github host>/api/v3"

145+ -validate-url="http(s)://<enterprise github host>/api/v3"

157−```

158

146

159### Keycloak Auth Provider

147### Keycloak Auth Provider

160

148

161−:::note

162−This is the legacy provider for Keycloak, use [Keycloak OIDC Auth Provider](#keycloak-oidc-auth-provider) if possible.

163−:::

164−

1651. Create new client in your Keycloak realm with **Access Type** 'confidental' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'

1491. Create new client in your Keycloak realm with **Access Type** 'confidental' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'

1662. Take note of the Secret in the credential tab of the client

1502. Take note of the Secret in the credential tab of the client

1673. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.

1513. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.

168

152

153+:::note this is the legacy Keycloak Auth Prodiver, use `keycloak-oidc` if possible. :::

154+

169Make sure you set the following to the appropriate url:

155Make sure you set the following to the appropriate url:

170

156

171```

157```

@@ -204,7 +190,7 @@ Make sure you set the following to the appropriate url:

204 --client-id=<your client's id>

190 --client-id=<your client's id>

205 --client-secret=<your client's secret>

191 --client-secret=<your client's secret>

206 --redirect-url=https://myapp.com/oauth2/callback

192 --redirect-url=https://myapp.com/oauth2/callback

207− --oidc-issuer-url=https://<keycloak host>/realms/<your realm>

193+ --oidc-issuer-url=https://<keycloak host>/auth/<your realm>/basic

208 --allowed-role=<realm role name> // Optional, required realm role

194 --allowed-role=<realm role name> // Optional, required realm role

209 --allowed-role=<client id>:<client role name> // Optional, required client role

195 --allowed-role=<client id>:<client role name> // Optional, required client role

210```

196```

@@ -229,17 +215,11 @@ The following config should be set to ensure that the oauth will work properly.

229

215

230Restricting by group membership is possible with the following option:

216Restricting by group membership is possible with the following option:

231

217

232−```

233 --gitlab-group="mygroup,myothergroup": restrict logins to members of any of these groups (slug), separated by a comma

218 --gitlab-group="mygroup,myothergroup": restrict logins to members of any of these groups (slug), separated by a comma

234−```

235

219

236If you are using self-hosted GitLab, make sure you set the following to the appropriate URL:

220If you are using self-hosted GitLab, make sure you set the following to the appropriate URL:

237

221

238−```

239 --oidc-issuer-url="<your gitlab url>"

222 --oidc-issuer-url="<your gitlab url>"

240−```

241−

242−If your self-hosted GitLab is on a sub-directory (e.g. domain.tld/gitlab), as opposed to its own sub-domain (e.g. gitlab.domain.tld), you may need to add a redirect from domain.tld/oauth pointing at e.g. domain.tld/gitlab/oauth.

243

223

244### LinkedIn Auth Provider

224### LinkedIn Auth Provider

245

225

@@ -275,7 +255,7 @@ To configure the OIDC provider for Dex, perform the following steps:

275 go get github.com/dexidp/dex

255 go get github.com/dexidp/dex

276 ```

256 ```

277

257

278− See the [getting started guide](https://dexidp.io/docs/getting-started/) for more details.

258+ See the [getting started guide](https://github.com/coreos/dex/blob/master/Documentation/getting-started.md) for more details.

279

259

2802. Setup oauth2-proxy with the correct provider and using the default ports and callbacks. Add a configuration block to the `staticClients` section of `examples/config-dev.yaml`:

2602. Setup oauth2-proxy with the correct provider and using the default ports and callbacks. Add a configuration block to the `staticClients` section of `examples/config-dev.yaml`:

281

261

@@ -361,14 +341,14 @@ you may wish to configure an authorization server for each application. Otherwis

361

341

362The `oidc_issuer_url` is based on URL from your **Authorization Server**'s **Issuer** field in step 2, or simply https://corp.okta.com .

342The `oidc_issuer_url` is based on URL from your **Authorization Server**'s **Issuer** field in step 2, or simply https://corp.okta.com .

363The `client_id` and `client_secret` are configured in the application settings.

343The `client_id` and `client_secret` are configured in the application settings.

364−Generate a unique `cookie_secret` to encrypt the cookie.

344+Generate a unique `client_secret` to encrypt the cookie.

365

345

366Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/example.cfg`

346Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/example.cfg`

367

347

368#### Okta - localhost

348#### Okta - localhost

369

349

3701. Signup for developer account: https://developer.okta.com/signup/

3501. Signup for developer account: https://developer.okta.com/signup/

371−2. Create New `Web` Application: https://$\{your-okta-domain\}/dev/console/apps/new

351+2. Create New `Web` Application: https://${your-okta-domain}/dev/console/apps/new

3723. Example Application Settings for localhost:

3523. Example Application Settings for localhost:

373 * **Name:** My Web App

353 * **Name:** My Web App

374 * **Base URIs:** http://localhost:4180/

354 * **Base URIs:** http://localhost:4180/

@@ -377,12 +357,12 @@ Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/example.c

377 * **Group assignments:** `Everyone`

357 * **Group assignments:** `Everyone`

378 * **Grant type allowed:** `Authorization Code` and `Refresh Token`

358 * **Grant type allowed:** `Authorization Code` and `Refresh Token`

3794. Make note of the `Client ID` and `Client secret`, they are needed in a future step

3594. Make note of the `Client ID` and `Client secret`, they are needed in a future step

380−5. Make note of the **default** Authorization Server Issuer URI from: https://$\{your-okta-domain\}/admin/oauth2/as

360+5. Make note of the **default** Authorization Server Issuer URI from: https://${your-okta-domain}/admin/oauth2/as

3816. Example config file `/etc/localhost.cfg`

3616. Example config file `/etc/localhost.cfg`

382 ```

362 ```

383 provider = "oidc"

363 provider = "oidc"

384 redirect_url = "http://localhost:4180/oauth2/callback"

364 redirect_url = "http://localhost:4180/oauth2/callback"

385− oidc_issuer_url = "https://$\{your-okta-domain\}/oauth2/default"

365+ oidc_issuer_url = "https://${your-okta-domain}/oauth2/default"

386 upstreams = [

366 upstreams = [

387 "http://0.0.0.0:8080"

367 "http://0.0.0.0:8080"

388 ]

368 ]

docs/docs/configuration/integrations/caddy.mddeleted−63

@@ -1,63 +0,0 @@

1−---

2−id: caddy

3−title: Caddy

4−---

5−

6−Integrate OAuth2 Proxy with Caddy v2 using the `forward_auth` directive.

7−

8−**Key features:**

9−- Simple forward_auth setup

10−- Automatic header handling

11−- Custom error handling and redirects

12−

13−## Configuring for use with the Caddy (v2) `forward_auth` directive

14−

15−The [Caddy `forward_auth` directive](https://caddyserver.com/docs/caddyfile/directives/forward_auth) allows Caddy to authenticate requests via the `oauth2-proxy`'s `/auth`.

16−

17−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.

18−

19−**Following options need to be set on `oauth2-proxy`:**

20−- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly

21−

22−```nginx title="Caddyfile"

23−example.com {

24− # Requests to /oauth2/* are proxied to oauth2-proxy without authentication.

25− # You can't use `reverse_proxy /oauth2/* oauth2-proxy.internal:4180` here because the reverse_proxy directive has lower precedence than the handle directive.

26− handle /oauth2/* {

27− reverse_proxy oauth2-proxy.internal:4180 {

28− # oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.

29− # The reverse_proxy directive automatically sets X-Forwarded-{For,Proto,Host} headers.

30− header_up X-Real-IP {remote_host}

31− header_up X-Forwarded-Uri {uri}

32− }

33− }

34−

35− # Requests to other paths are first processed by oauth2-proxy for authentication.

36− handle {

37− forward_auth oauth2-proxy.internal:4180 {

38− uri /oauth2/auth

39−

40− # oauth2-proxy requires the X-Real-IP and X-Forwarded-{Proto,Host,Uri} headers.

41− # The forward_auth directive automatically sets the X-Forwarded-{For,Proto,Host,Method,Uri} headers.

42− header_up X-Real-IP {remote_host}

43−

44− # If needed, you can copy headers from the oauth2-proxy response to the request sent to the upstream.

45− # Make sure to configure the --set-xauthrequest flag to enable this feature.

46− #copy_headers X-Auth-Request-User X-Auth-Request-Email

47−

48− # If oauth2-proxy returns a 401 status, redirect the client to the sign-in page.

49− @error status 401

50− handle_response @error {

51− redir * /oauth2/sign_in?rd={scheme}://{host}{uri}

52− }

53− }

54−

55− # If oauth2-proxy returns a 2xx status, the request is then proxied to the upstream.

56− reverse_proxy upstream.internal:3000

57− }

58−}

59−```

60−

61−:::note

62−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.

63−:::

docs/docs/configuration/integrations/headlamp.mddeleted−105

@@ -1,105 +0,0 @@

1−---

2−id: headlamp

3−title: Headlamp

4−---

5−

6−Modern, actively maintained Kubernetes web UI with OAuth2 Proxy integration examples.

7−

8−**Key features:**

9−- Active development and maintenance

10−- Modern, intuitive interface

11−- Multi-cluster support

12−- Plugin system

13−- Works with all OAuth2 providers

14−

15−## Configuring for use with Headlamp

16−

17−[Headlamp](https://headlamp.dev/) is a modern, user-friendly Kubernetes web UI that can be integrated with OAuth2 Proxy for authentication. This is a recommended alternative to the deprecated Kubernetes Dashboard.

18−

19−### Architecture

20−

21−```

22−User → Ingress → OAuth2 Proxy → Authentication Provider (e.g., Azure Entra ID)

23− ↓

24− Headlamp

25−```

26−

27−### Prerequisites

28−

29−- Kubernetes cluster (e.g., AKS, EKS, GKE, or self-hosted)

30−- Headlamp installed in the cluster

31−- OAuth2 provider configured (Azure Entra ID, Google, GitHub, etc.)

32−- Ingress controller (Nginx, Traefik, etc.)

33−

34−### Configuration Overview

35−

36−When integrating Headlamp with OAuth2 Proxy, the OAuth2 Proxy acts as a reverse proxy in front of Headlamp:

37−

38−1. User requests access to Headlamp

39−2. Ingress forwards to OAuth2 Proxy

40−3. OAuth2 Proxy authenticates the user via the OAuth2 provider

41−4. After successful authentication, OAuth2 Proxy proxies requests to Headlamp

42−5. Headlamp receives the authenticated user information via headers

43−

44−### OAuth2 Proxy Configuration

45−

46−Configure OAuth2 Proxy to proxy to the Headlamp service:

47−

48−```yaml

49−upstreamConfig:

50− upstreams:

51− - id: headlamp

52− path: /

53− uri: http://headlamp-service.headlamp-namespace.svc.cluster.local:4466

54−```

55−

56−Enable the necessary headers:

57−

58−```yaml

59−extraArgs:

60− reverse-proxy: true

61− pass-authorization-header: true

62− set-xauthrequest: true

63− email-domain: "*" # Or restrict to your organization

64−```

65−

66−### Example with Azure Entra ID on AKS

67−

68−For detailed instructions on deploying Headlamp with OAuth2 Proxy on Azure Kubernetes Service using Azure Entra ID, see the official Headlamp documentation:

69−

70−https://headlamp.dev/docs/latest/installation/in-cluster/aks-cluster-oauth/

71−

72−Key steps include:

73−

74−1. **Set up AKS with OIDC**: Enable Microsoft Entra ID authentication with Kubernetes RBAC

75−2. **Create Azure App Registration**: Configure redirect URI and create client secret

76−3. **Deploy Headlamp**: Install Headlamp via Helm in your cluster

77−4. **Deploy OAuth2 Proxy**: Configure OAuth2 Proxy with Entra ID provider settings and upstream pointing to Headlamp

78−5. **Configure Ingress**: Set up Ingress to route traffic through OAuth2 Proxy to Headlamp

79−6. **Set RBAC Policies**: Apply Kubernetes RBAC bindings based on users or groups

80−

81−### Integration with Other Providers

82−

83−The same integration pattern works with other OAuth2 providers supported by OAuth2 Proxy:

84−

85−- **Google**: Use the Google provider configuration

86−- **GitHub**: Use the GitHub provider configuration

87−- **GitLab**: Use the GitLab provider configuration

88−- **Keycloak**: Use the Keycloak OIDC provider configuration

89−- **Any OIDC Provider**: Use the generic OIDC provider configuration

90−

91−For provider-specific configuration examples, see the [OAuth Provider Configuration](../providers/index.md) documentation.

92−

93−### Benefits Over Kubernetes Dashboard

94−

95−Headlamp offers several advantages:

96−

97−- **Active Development**: Headlamp is actively maintained and developed

98−- **Modern UI**: Clean, intuitive interface with better UX

99−- **Plugin System**: Extensible with custom plugins

100−- **Multi-cluster Support**: Built-in support for managing multiple clusters

101−- **Desktop App**: Available as both web UI and desktop application

102−

103−:::note

104−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.

105−:::

docs/docs/configuration/integrations/index.mddeleted−41

@@ -1,41 +0,0 @@

1−---

2−id: index

3−title: Integrations

4−---

5−

6−This section provides configuration examples for integrating OAuth2 Proxy with various reverse proxies, ingress controllers, and Kubernetes web UIs.

7−

8−## Reverse Proxies and Ingress Controllers

9−

10−OAuth2 Proxy can be integrated with popular reverse proxies and ingress controllers to add authentication to your applications:

11−

12−- [Nginx](nginx.md)

13−- [Traefik](traefik.md)

14−- [caddy](caddy.md)

15−

16−## Kubernetes Web UIs

17−

18−OAuth2 Proxy can also be used to add authentication to Kubernetes web user interfaces:

19−

20−- [Headlamp](headlamp.md) ✨ *Recommended*

21−- [Kubernetes Dashboard](kubernetes-dashboard.md) ⚠️ *Deprecated*

22−

23−:::tip

24−When integrating with Kubernetes web UIs, make sure to:

25−1. Configure the Ingress to pass the Authorization header with the bearer token

26−2. Increase buffer sizes for large OIDC tokens (especially with Azure Entra ID)

27−3. Set up appropriate Kubernetes RBAC permissions for your users or groups

28−:::

29−

30−## General Requirements

31−

32−Most integrations require the following OAuth2 Proxy configuration:

33−

34−- `--reverse-proxy=true`: Required to correctly handle `X-Forwarded-*` headers

35−- **Session storage**: For production deployments with large tokens due to a lot of claims like AD groups, use `--session-store-type=redis`

36−

37−For provider-specific configuration, see the [OAuth Provider Configuration](../providers/index.md) documentation.

38−

39−:::note

40−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.

41−:::

docs/docs/configuration/integrations/kubernetes-dashboard.mddeleted−289

@@ -1,289 +0,0 @@

1−---

2−id: kubernetes-dashboard

3−title: Kubernetes Dashboard

4−---

5−

6−:::warning Deprecated Project

7−Kubernetes Dashboard has been deprecated and discontinued as of January 2025. See the [official announcement](https://github.com/kubernetes/dashboard/commit/0ba796dce6916bb6ca5da5ca0b3ab22cecfd1e18) for more information.

8−

9−You may want to consider alternative solutions such as [Headlamp](./headlamp.md).

10−:::

11−

12−## Kubernetes Dashboard on AKS with Azure Entra ID

13−

14−Integration guide for the deprecated Kubernetes Dashboard, including comprehensive Azure Entra ID configuration on AKS with detailed troubleshooting and RBAC setup.

15−

16−### Architecture

17−

18−```

19−User → Nginx Ingress → OAuth2 Proxy → Entra ID

20− ↓

21− Kubernetes Dashboard

22−```

23−

24−The integration flow:

25−1. Unauthenticated requests to Dashboard are intercepted by Nginx Ingress

26−2. Nginx redirects to OAuth2 Proxy for authentication

27−3. OAuth2 Proxy redirects to Entra ID login

28−4. After successful authentication, OAuth2 Proxy receives ID token from Entra ID

29−5. OAuth2 Proxy sets Authorization header with the bearer token

30−6. Nginx forwards the request with token to Kubernetes Dashboard

31−7. Dashboard validates the token and grants access based on AKS RBAC configuration

32−

33−### Prerequisites

34−

35−- AKS cluster with Entra ID integration enabled

36−- Kubernetes Dashboard installed (version 7.x or later)

37−- NGINX Ingress Controller installed

38−- Entra ID App Registration configured with:

39− - Redirect URI: `https://your-oauth2-domain.com/oauth2/callback`

40− - API Permissions: `openid`, `email`, `profile`

41− - Groups claim enabled (if using group-based RBAC)

42−- Users or groups assigned appropriate Kubernetes RBAC permissions

43−

44−### Alpha Configuration Example

45−

46−Using [Alpha Configuration](../alpha_config.md) with the OAuth2 Proxy Helm chart:

47−

48−```yaml

49−alphaConfig:

50− enabled: true

51− configData:

52− providers:

53− - id: azure-entra

54− provider: entra-id

55− clientID: YOUR_CLIENT_ID

56− clientSecret: YOUR_CLIENT_SECRET

57− oidcConfig:

58− issuerURL: https://login.microsoftonline.com/YOUR_TENANT_ID/v2.0

59− audienceClaims:

60− - aud

61− emailClaim: email

62− groupsClaim: groups

63− userIDClaim: oid

64− scope: openid email profile

65−

66− upstreamConfig:

67− upstreams:

68− - id: static

69− path: /

70− static: true

71− staticCode: 200

72−

73− # Response headers passed to Dashboard via Nginx

74− injectResponseHeaders:

75− - name: Authorization

76− values:

77− - claim: id_token

78− prefix: "Bearer "

79− - name: X-Auth-Request-User

80− values:

81− - claim: email

82− - name: X-Auth-Request-Email

83− values:

84− - claim: email

85− - name: X-Auth-Request-Groups

86− values:

87− - claim: groups

88−

89− server:

90− BindAddress: "0.0.0.0:4180"

91−

92−extraArgs:

93− cookie-domain: ".your-domain.com"

94− whitelist-domain: ".your-domain.com"

95− email-domain: "*" # Or restrict to your organization

96− skip-provider-button: true

97− reverse-proxy: true

98− pass-authorization-header: true

99− set-xauthrequest: true

100−

101−sessionStorage:

102− type: redis

103−

104−redis:

105− enabled: true

106− auth:

107− enabled: true

108−

109−ingress:

110− enabled: true

111− className: nginx

112− hosts:

113− - OAuth2 Proxy.your-domain.com

114− path: /oauth2

115− pathType: Prefix

116−```

117−

118−### Kubernetes Dashboard Ingress

119−

120−**Critical**: The Ingress must include `Authorization` in the `auth-response-headers` annotation:

121−

122−```yaml

123−apiVersion: networking.k8s.io/v1

124−kind: Ingress

125−metadata:

126− name: kubernetes-dashboard

127− namespace: kubernetes-dashboard

128− annotations:

129− nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"

130− nginx.ingress.kubernetes.io/force-ssl-redirect: "true"

131−

132− # OAuth2 Proxy authentication

133− nginx.ingress.kubernetes.io/auth-url: "https://OAuth2 Proxy.your-domain.com/oauth2/auth"

134− nginx.ingress.kubernetes.io/auth-signin: "https://OAuth2 Proxy.your-domain.com/oauth2/start?rd=$scheme://$best_http_host$request_uri"

135−

136− # Include Authorization header with bearer token

137− nginx.ingress.kubernetes.io/auth-response-headers: "Authorization, X-Auth-Request-User, X-Auth-Request-Email"

138−

139− # Buffer sizes for large tokens (Entra tokens can exceed 4KB)

140− nginx.ingress.kubernetes.io/proxy-buffer-size: "256k"

141− nginx.ingress.kubernetes.io/proxy-buffers-number: "4"

142− nginx.ingress.kubernetes.io/proxy-busy-buffers-size: "256k"

143−spec:

144− ingressClassName: nginx

145− tls:

146− - hosts:

147− - dashboard.your-domain.com

148− secretName: dashboard-tls

149− rules:

150− - host: dashboard.your-domain.com

151− http:

152− paths:

153− - path: /

154− pathType: Prefix

155− backend:

156− service:

157− name: kubernetes-dashboard-kong-proxy

158− port:

159− number: 443

160−```

161−

162−### RBAC Configuration

163−

164−Assign Kubernetes permissions to Entra ID users or groups.

165−

166−**User-based:**

167−```yaml

168−apiVersion: rbac.authorization.k8s.io/v1

169−kind: ClusterRoleBinding

170−metadata:

171− name: dashboard-user-admin

172−roleRef:

173− apiGroup: rbac.authorization.k8s.io

174− kind: ClusterRole

175− name: cluster-admin

176−subjects:

177− - kind: User

178− name: "user@your-domain.com" # Email from Entra ID token

179− apiGroup: rbac.authorization.k8s.io

180−```

181−

182−**Group-based (recommended):**

183−```yaml

184−apiVersion: rbac.authorization.k8s.io/v1

185−kind: ClusterRoleBinding

186−metadata:

187− name: dashboard-admins-group

188−roleRef:

189− apiGroup: rbac.authorization.k8s.io

190− kind: ClusterRole

191− name: cluster-admin

192−subjects:

193− - kind: Group

194− name: "YOUR_ENTRA_GROUP_OBJECT_ID" # Entra ID Group Object ID

195− apiGroup: rbac.authorization.k8s.io

196−```

197−

198−For production, create custom roles with limited permissions instead of using `cluster-admin`.

199−

200−### Troubleshooting

201−

202−**Dashboard still asks for token after authentication**

203−

204−Verify that:

205−1. `injectResponseHeaders` in alphaConfig includes Authorization header with id_token claim

206−2. Dashboard Ingress includes `Authorization` in `auth-response-headers` annotation

207−3. Buffer sizes are sufficient for large tokens (set to 256k as shown above)

208−4. Check OAuth2 Proxy logs for successful token generation: `kubectl logs -n OAuth2 Proxy <pod-name>`

209−

210−**"Unauthorized" or "Invalid token" errors**

211−

212−Common causes:

213−1. User/group not configured in Kubernetes RBAC

214− - Check: `kubectl get clusterrolebindings | grep <user-email>`

215−2. Token validation failed

216− - Verify AKS Entra ID integration is enabled

217− - Check Dashboard logs: `kubectl logs -n kubernetes-dashboard <pod-name>`

218−3. Incorrect OAuth2 Proxy configuration

219− - Ensure `reverse-proxy: true` is set

220− - Verify issuer URL matches your tenant

221−

222−**Groups not included in token**

223−

224−To include groups in the token:

225−1. In Entra ID App Registration, go to **Token configuration**

226−2. Add **groups claim** and select security groups

227−3. Or edit the manifest and add: `"groupMembershipClaims": "SecurityGroup"`

228−4. For 200+ groups, ensure scope includes `User.Read` for group overage handling

229−5. Verify groups appear in token: check OAuth2 Proxy logs

230−

231−**Session expires too quickly**

232−

233−Configure cookie expiration:

234−```yaml

235−extraArgs:

236− cookie-expire: "24h"

237− cookie-refresh: "1h"

238−```

239−

240−### Using Workload Identity (Passwordless)

241−

242−For production environments, use Workload Identity instead of client secrets:

243−

244−```yaml

245−config:

246− clientID: "YOUR_CLIENT_ID"

247− secretKeys: # Exclude client-secret

248− - client-id

249− - cookie-secret

250− cookieSecret: "YOUR_COOKIE_SECRET"

251−

252−serviceAccount:

253− annotations:

254− azure.workload.identity/client-id: YOUR_CLIENT_ID

255− azure.workload.identity/tenant-id: YOUR_TENANT_ID

256−

257−podLabels:

258− azure.workload.identity/use: "true"

259−

260−alphaConfig:

261− enabled: true

262− configData:

263− providers:

264− - id: azure-entra

265− provider: entra-id

266− clientID: YOUR_CLIENT_ID

267− oidcConfig:

268− issuerURL: https://login.microsoftonline.com/YOUR_TENANT_ID/v2.0

269− # ... other config

270− entraIdConfig:

271− federatedTokenAuth: true

272−```

273−

274−This requires:

275−- AKS with OIDC issuer and Workload Identity enabled

276−- Federated identity credential configured in Entra ID App Registration

277−- Service account annotated with `azure.workload.identity/client-id`

278−

279−For detailed Workload Identity setup instructions, see the [Workload Identity section](../providers/ms_entra_id.md#workload-identity) in the Microsoft Entra ID provider documentation.

280−

281−## Integration with Other Providers

282−

283−While this guide focuses on Azure Entra ID, Kubernetes Dashboard can be integrated with other OAuth2 providers supported by OAuth2 Proxy. The key requirements remain the same:

284−

285−1. **Authorization Header**: Pass the bearer token via the `Authorization` header

286−2. **RBAC Configuration**: Configure Kubernetes RBAC for your authentication provider's users/groups

287−3. **Buffer Sizes**: Ensure adequate buffer sizes for tokens (especially important for OIDC providers)

288−

289−For provider-specific configuration examples, see the [OAuth Provider Configuration](../providers/index.md) documentation.

docs/docs/configuration/integrations/nginx.mddeleted−190

@@ -1,190 +0,0 @@

1−---

2−id: nginx

3−title: Nginx

4−---

5−

6−Configure OAuth2 Proxy with Nginx using the `auth_request` directive. Includes examples for both standalone Nginx configurations and Kubernetes ingress-nginx with annotations.

7−

8−**Key features:**

9−- Support for `auth_request` directive

10−- Kubernetes Ingress annotations

11−- Multi-part cookie handling for large tokens

12−- Session refresh support

13−

14−## Configuring for use with the Nginx `auth_request` directive

15−

16−**This option requires `--reverse-proxy` option to be set.**

17−

18−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:

19−

20−```nginx

21−server {

22− listen 443 ssl;

23− server_name ...;

24− include ssl/ssl.conf;

25−

26− location /oauth2/ {

27− proxy_pass http://127.0.0.1:4180;

28− proxy_set_header Host $host;

29− proxy_set_header X-Real-IP $remote_addr;

30− proxy_set_header X-Auth-Request-Redirect $request_uri;

31− # or, if you are handling multiple domains:

32− # proxy_set_header X-Auth-Request-Redirect $scheme://$host$request_uri;

33− }

34− location = /oauth2/auth {

35− proxy_pass http://127.0.0.1:4180;

36− proxy_set_header Host $host;

37− proxy_set_header X-Real-IP $remote_addr;

38− proxy_set_header X-Forwarded-Uri $request_uri;

39− # nginx auth_request includes headers but not body

40− proxy_set_header Content-Length "";

41− proxy_pass_request_body off;

42− }

43−

44− location / {

45− auth_request /oauth2/auth;

46− error_page 401 = @oauth2_signin;

47−

48− # pass information via X-User and X-Email headers to backend,

49− # requires running with --set-xauthrequest flag

50− auth_request_set $user $upstream_http_x_auth_request_user;

51− auth_request_set $email $upstream_http_x_auth_request_email;

52− proxy_set_header X-User $user;

53− proxy_set_header X-Email $email;

54−

55− # if you enabled --pass-access-token, this will pass the token to the backend

56− auth_request_set $token $upstream_http_x_auth_request_access_token;

57− proxy_set_header X-Access-Token $token;

58−

59− # if you enabled --cookie-refresh, this is needed for it to work with auth_request

60− auth_request_set $auth_cookie $upstream_http_set_cookie;

61− add_header Set-Cookie $auth_cookie;

62−

63− # Large OIDC tokens can make the session cookie exceed the 4KB limit,

64− # causing OAuth2 Proxy to split the cookie into multiple parts.

65− # Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,

66− # so extract the second part when using the default cookie name, `_oauth2_proxy`.

67− auth_request_set $auth_cookie_upstream_1 $upstream_cookie__oauth2_proxy_1;

68−

69− # Extract the Cookie attributes from the first Set-Cookie header and append them

70− # to the second part ($upstream_cookie_* variables only contain the raw cookie content)

71− if ($auth_cookie ~* "(; .*)") {

72− set $auth_cookie_0 $auth_cookie;

73− set $auth_cookie_1 "_oauth2_proxy_1=$auth_cookie_upstream_1$1";

74− }

75−

76− # Send both Set-Cookie headers now if there was a second part

77− if ($auth_cookie_upstream_1) {

78− add_header Set-Cookie $auth_cookie_0;

79− add_header Set-Cookie $auth_cookie_1;

80− }

81−

82− proxy_pass http://backend/;

83− # or "root /path/to/site;" or "fastcgi_pass ..." etc

84− }

85−

86− # Named location for handling OAuth2 sign-in redirects

87− # This ensures the browser receives a proper 302 redirect that it will follow

88− location @oauth2_signin {

89− return 302 /oauth2/sign_in?rd=$scheme://$host$request_uri;

90− }

91−}

92−```

93−

94−### Multi-part session cookies

95−

96−The example above is ready to use with the default `--cookie-name=_oauth2_proxy` setting and handles a session split into two cookies. If you configure a custom cookie name, update both references to the second cookie part:

97−

98−| Cookie configuration | Nginx upstream cookie variable | `Set-Cookie` name |

99−| --- | --- | --- |

100−| Default (`_oauth2_proxy`) | `$upstream_cookie__oauth2_proxy_1` | `_oauth2_proxy_1=` |

101−| `--cookie-name=my_cookie` | `$upstream_cookie_my_cookie_1` | `my_cookie_1=` |

102−

103−For example, with `--cookie-name=my_cookie`, change the relevant lines to:

104−

105−```nginx

106−auth_request_set $auth_cookie_upstream_1 $upstream_cookie_my_cookie_1;

107−set $auth_cookie_1 "my_cookie_1=$auth_cookie_upstream_1$1";

108−```

109−

110−If a session is split into more than two cookies, repeat the extraction for each additional numeric suffix. For consistently large sessions, prefer `--session-store-type=redis` so only a small session ticket is stored in the browser cookie.

111−

112−### Understanding the `error_page` redirect pattern

113−

114−The `auth_request` directive expects the authentication endpoint (`/oauth2/auth`) to return:

115−- **2xx**: Request is authenticated, allow access

116−- **401 or 403**: Request is not authenticated, deny access

117−

118−When a 401 is returned, nginx triggers the `error_page` directive. The recommended pattern uses a **named location** (`@oauth2_signin`) that returns a proper **302 redirect**:

119−

120−```nginx

121−error_page 401 = @oauth2_signin;

122−

123−location @oauth2_signin {

124− return 302 /oauth2/sign_in?rd=$scheme://$host$request_uri;

125−}

126−```

127−

128−:::warning Avoid `error_page 401 =403` with sign_in

129−Some older configurations use `error_page 401 =403 /oauth2/sign_in`. While this works for displaying the sign-in page, it returns a **403 status code** with a `Location` header. Browsers do not automatically follow redirects on 403 responses, which can cause issues when using `--skip-provider-button=true` (users see a "Found." link instead of being automatically redirected).

130−

131−The named location pattern above ensures the browser receives a standard **302 redirect** that works correctly with all oauth2-proxy configurations.

132−:::

133−

134−### Browser vs API Routes

135−

136−:::important When to use redirects

137−Redirecting authentication failures (302 to `/oauth2/sign_in`) should **only be used for browser-facing routes**. API or machine clients should receive a plain 401/403 response without redirect.

138−:::

139−

140−#### Browser-facing routes (HTML, UI)

141−

142−For interactive browser routes where users should be redirected to sign in:

143−

144−```nginx

145−location / {

146− auth_request /oauth2/auth;

147− error_page 401 = @oauth2_signin;

148− proxy_pass http://backend/;

149−}

150−

151−location @oauth2_signin {

152− return 302 /oauth2/sign_in?rd=$scheme://$host$request_uri;

153−}

154−```

155−

156−#### API / Machine routes (no redirect)

157−

158−For API endpoints where clients expect a 401/403 status code (not a redirect):

159−

160−```nginx

161−location /api/ {

162− auth_request /oauth2/auth;

163− error_page 401 =401; # Pass through the 401 status

164− proxy_pass http://backend/;

165−}

166−```

167−

168−This ensures:

169−- ✅ Browsers get a redirect and smooth login flow

170−- ✅ API clients fail fast with appropriate HTTP status codes

171−- ✅ `/oauth2/auth` remains a pure boolean oracle (2xx/401)

172−

173−When you use ingress-nginx in Kubernetes, you can configure the same behavior with the following annotations on your Ingress resource:

174−

175−```yaml

176−nginx.ingress.kubernetes.io/auth-url: "https://<oauth2-proxy-fqdn>/oauth2/auth"

177−nginx.ingress.kubernetes.io/auth-signin: "https://<oauth2-proxy-fqdn>/oauth2/start?rd=$escaped_request_uri"

178−```

179−

180−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/.

181−

182−It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).

183−

184−:::tip Kubernetes Dashboard with Azure Entra ID

185−For a complete example of integrating oauth2-proxy with Kubernetes Dashboard on AKS using Azure Entra ID, including RBAC configuration and troubleshooting, see the [Kubernetes Dashboard on AKS](../providers/ms_entra_id.md#kubernetes-dashboard-on-aks) section in the Microsoft Entra ID provider documentation.

186−:::

187−

188−:::note

189−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.

190−:::

docs/docs/configuration/integrations/traefik.mddeleted−192

@@ -1,192 +0,0 @@

1−---

2−id: traefik

3−title: Traefik

4−---

5−

6−Set up OAuth2 Proxy with Traefik v2 using the `ForwardAuth` middleware. Includes examples for both error-based redirects and static upstream configurations.

7−

8−**Key features:**

9−- ForwardAuth middleware integration

10−- Error middleware for 401 redirects

11−- Static upstream configuration (202 responses)

12−- Dynamic file configuration examples

13−

14−

15−## Configuring for use with the Traefik (v2) `ForwardAuth` middleware

16−

17−**This option requires `--reverse-proxy` option to be set.**

18−

19−### ForwardAuth with 401 errors middleware

20−

21−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:

22−

23−```yaml

24−http:

25− routers:

26− a-service:

27− rule: "Host(`a-service.example.com`)"

28− service: a-service-backend

29− middlewares:

30− - oauth-errors

31− - oauth-auth

32− tls:

33− certResolver: default

34− domains:

35− - main: "example.com"

36− sans:

37− - "*.example.com"

38− oauth:

39− rule: "Host(`a-service.example.com`, `oauth.example.com`) && PathPrefix(`/oauth2/`)"

40− middlewares:

41− - auth-headers

42− service: oauth-backend

43− tls:

44− certResolver: default

45− domains:

46− - main: "example.com"

47− sans:

48− - "*.example.com"

49−

50− services:

51− a-service-backend:

52− loadBalancer:

53− servers:

54− - url: http://172.16.0.2:7555

55− oauth-backend:

56− loadBalancer:

57− servers:

58− - url: http://172.16.0.1:4180

59−

60− middlewares:

61− auth-headers:

62− headers:

63− sslRedirect: true

64− stsSeconds: 315360000

65− browserXssFilter: true

66− contentTypeNosniff: true

67− forceSTSHeader: true

68− sslHost: example.com

69− stsIncludeSubdomains: true

70− stsPreload: true

71− frameDeny: true

72− oauth-auth:

73− forwardAuth:

74− address: https://oauth.example.com/oauth2/auth

75− trustForwardHeader: true

76− oauth-errors:

77− errors:

78− status:

79− - "401-403"

80− service: oauth-backend

81− query: "/oauth2/sign_in?rd={url}"

82− statusRewrites:

83− "401": 302

84−```

85−

86−:::caution Troubleshooting: Browser shows "Found." instead of redirecting

87−When using the Errors middleware without `statusRewrites`, the redirect response from oauth2-proxy can be served within the original 401/403 status context. This causes some browsers to display a "Found." link instead of automatically following the redirect to the identity provider.

88−

89−Adding `statusRewrites` to rewrite `401 -> 302` ensures the browser treats the response as a proper redirect and follows it automatically.

90−:::

91−

92−### ForwardAuth with static upstreams configuration

93−

94−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

95−

96−**Following options need to be set on `oauth2-proxy`:**

97−- `--upstream=static://202`: Configures a static response for authenticated sessions

98−- `--reverse-proxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly

99−

100−```yaml

101−http:

102− routers:

103− a-service-route-1:

104− rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/`)"

105− service: a-service-backend

106− middlewares:

107− - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin

108− tls:

109− certResolver: default

110− domains:

111− - main: "example.com"

112− sans:

113− - "*.example.com"

114− a-service-route-2:

115− rule: "Host(`a-service.example.com`) && PathPrefix(`/no-auto-redirect`)"

116− service: a-service-backend

117− middlewares:

118− - oauth-auth-wo-redirect # unauthenticated session will return a 401

119− tls:

120− certResolver: default

121− domains:

122− - main: "example.com"

123− sans:

124− - "*.example.com"

125− services-oauth2-route:

126− rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/oauth2/`)"

127− middlewares:

128− - auth-headers

129− service: oauth-backend

130− tls:

131− certResolver: default

132− domains:

133− - main: "example.com"

134− sans:

135− - "*.example.com"

136− oauth2-proxy-route:

137− rule: "Host(`oauth.example.com`) && PathPrefix(`/`)"

138− middlewares:

139− - auth-headers

140− service: oauth-backend

141− tls:

142− certResolver: default

143− domains:

144− - main: "example.com"

145− sans:

146− - "*.example.com"

147−

148− services:

149− a-service-backend:

150− loadBalancer:

151− servers:

152− - url: http://172.16.0.2:7555

153− b-service-backend:

154− loadBalancer:

155− servers:

156− - url: http://172.16.0.3:7555

157− oauth-backend:

158− loadBalancer:

159− servers:

160− - url: http://172.16.0.1:4180

161−

162− middlewares:

163− auth-headers:

164− headers:

165− sslRedirect: true

166− stsSeconds: 315360000

167− browserXssFilter: true

168− contentTypeNosniff: true

169− forceSTSHeader: true

170− sslHost: example.com

171− stsIncludeSubdomains: true

172− stsPreload: true

173− frameDeny: true

174− oauth-auth-redirect:

175− forwardAuth:

176− address: https://oauth.example.com/

177− trustForwardHeader: true

178− authResponseHeaders:

179− - X-Auth-Request-Access-Token

180− - Authorization

181− oauth-auth-wo-redirect:

182− forwardAuth:

183− address: https://oauth.example.com/oauth2/auth

184− trustForwardHeader: true

185− authResponseHeaders:

186− - X-Auth-Request-Access-Token

187− - Authorization

188−```

189−

190−:::note

191−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.

192−:::

docs/docs/configuration/overview.md+487−347

@@ -3,349 +3,227 @@ id: overview

3title: Overview

3title: Overview

4---

4---

5

5

6−`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).

6+`oauth2-proxy` can be configured via [config file](#config-file), [command line options](#command-line-options) or [environment variables](#environment-variables).

7

7

8−## Generating a Cookie Secret

8+### Generating a Cookie Secret

9

9

10To generate a strong cookie secret use one of the below commands:

10To generate a strong cookie secret use one of the below commands:

11

11

12import Tabs from '@theme/Tabs';

12import Tabs from '@theme/Tabs';

13import TabItem from '@theme/TabItem';

13import TabItem from '@theme/TabItem';

14

14

15+<Tabs

15−<Tabs defaultValue="python">

16+ defaultValue="python"

16− <TabItem value="python" label="Python">

17+ values={[

17−

18+ {label: 'Python', value: 'python'},

19+ {label: 'Bash', value: 'bash'},

20+ {label: 'OpenSSL', value: 'openssl'},

21+ {label: 'PowerShell', value: 'powershell'},

22+ {label: 'Terraform', value: 'terraform'},

23+ ]}>

24+ <TabItem value="python">

25+

18−```shell

26+ ```shell

19−python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).decode())'

27+ python -c 'import os,base64; print(base64.urlsafe_b64encode(os.urandom(32)).decode())'

20−```

28+ ```

21

29

22 </TabItem>

30 </TabItem>

23− <TabItem value="bash" label="Bash">

31+ <TabItem value="bash">

24

32

25−```shell

33+ ```shell

26−dd if=/dev/urandom bs=32 count=1 2>/dev/null | base64 | tr -d -- '\n' | tr -- '+/' '-_' ; echo

34+ cat /dev/urandom | tr -dc 'a-zA-Z0-9' | fold -w 32 | head -n 1 | base64

27−```

35+ ```

28

36

29 </TabItem>

37 </TabItem>

30− <TabItem value="openssl" label="OpenSSL">

38+ <TabItem value="openssl">

31

39

32−```shell

40+ ```shell

33−openssl rand -base64 32 | tr -- '+/' '-_'

41+ openssl rand -base64 32 | tr -- '+/' '-_'

34−```

42+ ```

35

43

36 </TabItem>

44 </TabItem>

37− <TabItem value="powershell" label="PowerShell">

45+ <TabItem value="powershell">

38

46

39−```powershell

47+ ```shell

40−# Add System.Web assembly to session, just in case

48+ # Add System.Web assembly to session, just in case

41−Add-Type -AssemblyName System.Web

49+ Add-Type -AssemblyName System.Web

42−[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes([System.Web.Security.Membership]::GeneratePassword(32,4))).Replace("+","-").Replace("/","_")

50+ [Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes([System.Web.Security.Membership]::GeneratePassword(32,4))).Replace("+","-").Replace("/","_")

43−```

51+ ```

44

52

45 </TabItem>

53 </TabItem>

46− <TabItem value="terraform" label="Terraform">

54+ <TabItem value="terraform">

47

55

48−```hcl

56+ ```shell

49−# Valid 32 Byte Base64 URL encoding set that will decode to 24 []byte AES-192 secret

57+ # Valid 32 Byte Base64 URL encoding set that will decode to 24 []byte AES-192 secret

50−resource "random_password" "cookie_secret" {

58+ resource "random_password" "cookie_secret" {

51− length = 32

59+ length = 32

52− override_special = "-_"

60+ override_special = "-_"

53−}

61+ }

54−```

62+ ```

55

63

56 </TabItem>

64 </TabItem>

57</Tabs>

65</Tabs>

58

66

59−## Config File

67+### Config File

60

68

61Every 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).

69Every 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).

62

70

63An 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`

71An 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`

64

72

65−## Config Options

66−

67### Command Line Options

73### Command Line Options

68

74

69−| Flag | Description |

75+| Option | Type | Description | Default |

70−| ---------------- | ------------------------------------------------------- |

76+| ------ | ---- | ----------- | ------- |

71−| `--config` | path to config file |

77+| `--acr-values` | string | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues) | `""` |

72−| `--config-test` | test configuration and exit (for CI/CD validation) |

78+| `--approval-prompt` | string | OAuth approval_prompt | `"force"` |

73−| `--version` | print version string |

79+| `--auth-logging` | bool | Log authentication attempts | true |

74−

80+| `--auth-logging-format` | string | Template for authentication log lines | see [Logging Configuration](#logging-configuration) |

75−### General Provider Options

81+| `--authenticated-emails-file` | string | authenticate against emails via file (one per line) | |

76−

82+| `--azure-tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |

77−Provider specific options can be found on their respective subpages.

83+| `--basic-auth-password` | string | the password to set when passing the HTTP Basic Auth header | |

78−

84+| `--client-id` | string | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"` | |

79−| Flag / Config Field | Type | Description | Default |

85+| `--client-secret` | string | the OAuth Client Secret | |

80−| --------------------------------------------------------------------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |

86+| `--client-secret-file` | string | the file with OAuth Client Secret | |

81−| flag: `--acr-values`<br/>toml: `acr_values` | string | optional, see [docs](https://openid.net/specs/openid-connect-eap-acr-values-1_0.html#acrValues) | `""` |

87+| `--config` | string | path to config file | |

82−| 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. | |

88+| `--cookie-domain` | 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). | |

83−| flag: `--approval-prompt`<br/>toml: `approval_prompt` | string | OAuth approval_prompt | `"force"` |

89+| `--cookie-expire` | duration | expire timeframe for cookie | 168h0m0s |

84−| 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 | |

90+| `--cookie-httponly` | bool | set HttpOnly cookie flag | true |

85−| flag: `--client-id`<br/>toml: `client_id` | string | the OAuth Client ID, e.g. `"123456.apps.googleusercontent.com"` | |

91+| `--cookie-name` | string | the name of the cookie that the oauth_proxy creates | `"_oauth2_proxy"` |

86−| flag: `--client-secret-file`<br/>toml: `client_secret_file` | string | the file with OAuth Client Secret. The file must contain the secret only, with no trailing newline | |

92+| `--cookie-path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |

87−| flag: `--client-secret`<br/>toml: `client_secret` | string | the OAuth Client Secret | |

93+| `--cookie-refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers&nbsp;\[[1](#footnote1)\] | |

88−| flag: `--code-challenge-method`<br/>toml: `code_challenge_method` | string | use PKCE code challenges with the specified method. Either 'plain' or 'S256' (recommended) | |

94+| `--cookie-secret` | string | the seed string for secure cookies (optionally base64 encoded) | |

89−| 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 |

95+| `--cookie-secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true |

90−| 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 |

96+| `--cookie-samesite` | string | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). | `""` |

91−| flag: `--insecure-oidc-skip-nonce`<br/>toml: `insecure_oidc_skip_nonce` | bool | skip verifying the OIDC ID Token's nonce claim | true |

97+| `--custom-templates-dir` | string | path to custom html templates | |

92−| 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 | |

98+| `--custom-sign-in-logo` | string | path or a URL to an custom image for the sign_in page logo. Use \"-\" to disable default logo. |

93−| 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 | |

99+| `--display-htpasswd-form` | bool | display username / password login form if an htpasswd file is provided | true |

94−| flag: `--login-url`<br/>toml: `login_url` | string | Authentication endpoint | |

100+| `--email-domain` | string \| list | authenticate emails with the specified domain (may be given multiple times). Use `*` to authenticate any email | |

95−| flag: `--auth-request-response-mode`<br/>toml: `auth-request-response-mode` | string | Response mode to ask for during authentication request | |

101+| `--errors-to-info-log` | bool | redirects error-level logging to default log channel instead of stderr | |

96−| flag: `--oidc-audience-claim`<br/>toml: `oidc_audience_claims` | string | which OIDC claim contains the audience | `"aud"` |

102+| `--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`) | |

97−| flag: `--oidc-email-claim`<br/>toml: `oidc_email_claim` | string | which OIDC claim contains the user's email | `"email"` |

103+| `--exclude-logging-paths` | string | comma separated list of paths to exclude from logging, e.g. `"/ping,/path2"` |`""` (no paths excluded) |

98−| flag: `--oidc-extra-audience`<br/>toml: `oidc_extra_audiences` | string \| list | additional audiences which are allowed to pass verification | `"[]"` |

104+| `--flush-interval` | duration | period between flushing response buffers when streaming responses | `"1s"` |

99−| flag: `--oidc-groups-claim`<br/>toml: `oidc_groups_claim` | string | which OIDC claim contains the user groups | `"groups"` |

105+| `--force-https` | bool | enforce https redirect | `false` |

100−| flag: `--oidc-issuer-url`<br/>toml: `oidc_issuer_url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |

106+| `--banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |

101−| 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 | |

107+| `--footer` | string | custom (html) footer string. Use `"-"` to disable default footer. | |

102−| 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 | |

108+| `--github-org` | string | restrict logins to members of this organisation | |

103−| flag: `--oidc-enabled-signing-alg`<br/>toml: `oidc_enabled_signing_algs` | string \| list | List of allowed JWT signing algorithms. When oidc discovery is enabled, the effective set is the intersection between this list and the provider's discovered supported algorithms. | |

109+| `--github-team` | string | restrict logins to members of any of these teams (slug), separated by a comma | |

104−| flag: `--profile-url`<br/>toml: `profile_url` | string | Profile access endpoint | |

110+| `--github-repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |

105−| 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 | `""` |

111+| `--github-token` | string | the token to use when verifying repository collaborators (must have push access to the repository) | |

106−| 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. | |

112+| `--github-user` | string \| list | To allow users to login by username even if they do not belong to the specified org and team or collaborators | |

107−| 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) |

113+| `--gitlab-group` | string \| list | restrict logins to members of any of these groups (slug), separated by a comma | |

108−| flag: `--provider`<br/>toml: `provider` | string | OAuth provider | google |

114+| `--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 | |

109−| flag: `--pubjwk-url`<br/>toml: `pubjwk_url` | string | JWK pubkey access endpoint: required by login.gov | |

115+| `--google-admin-email` | string | the google admin to impersonate for api calls | |

110−| flag: `--redeem-url`<br/>toml: `redeem_url` | string | Token redemption endpoint | |

116+| `--google-group` | string | restrict logins to members of this google group (may be given multiple times). | |

111−| 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. | |

117+| `--google-service-account-json` | string | the path to the service account json credentials | |

112−| 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 |

118+| `--htpasswd-file` | string | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption | |

113−| 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 |

119+| `--htpasswd-user-group` | string \| list | the groups to be set on sessions for htpasswd users | |

114−| 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 |

120+| `--http-address` | string | `[http://]<addr>:<port>` or `unix://<path>` to listen on for HTTP clients | `"127.0.0.1:4180"` |

115−| flag: `--validate-url`<br/>toml: `validate_url` | string | Access token validation endpoint | |

121+| `--https-address` | string | `<addr>:<port>` to listen on for HTTPS clients | `":443"` |

116−

122+| `--logging-compress` | bool | Should rotated log files be compressed using gzip | false |

117−### Cookie Options

123+| `--logging-filename` | string | File to log requests to, empty for `stdout` | `""` (stdout) |

118−

124+| `--logging-local-time` | bool | Use local time in log files and backup filenames instead of UTC | true (local time) |

119−| Flag / Config Field | Type | Description | Default |

125+| `--logging-max-age` | int | Maximum number of days to retain old log files | 7 |

120−| --------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |

126+| `--logging-max-backups` | int | Maximum number of old log files to retain; 0 to disable | 0 |

121−| flag: `--cookie-csrf-expire`<br/>toml: `cookie_csrf_expire` | duration | expire timeframe for CSRF cookie | 15m |

127+| `--logging-max-size` | int | Maximum size in megabytes of the log file before rotation | 100 |

122−| 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 |

128+| `--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 | |

123−| 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" |

129+| `--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 | |

124−| flag: `--cookie-csrf-samesite`<br/>toml: `cookie_csrf_samesite` | string | set SameSite CSRF cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). When using the default setting, the CSRF cookie samesite value is taken from the session cookie configuration. | `""` |

130+| `--login-url` | string | Authentication endpoint | |

125−| 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). | |

131+| `--insecure-oidc-allow-unverified-email` | bool | don't fail if an email address in an id_token is not verified | false |

126−| 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 |

132+| `--insecure-oidc-skip-issuer-verification` | bool | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility) | false |

127−| flag: `--cookie-httponly`<br/>toml: `cookie_httponly` | bool | set HttpOnly cookie flag | true |

133+| `--insecure-oidc-skip-nonce` | bool | skip verifying the OIDC ID Token's nonce claim | true |

128−| 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"` |

134+| `--oidc-issuer-url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |

129−| flag: `--cookie-path`<br/>toml: `cookie_path` | string | an optional cookie path to force cookies to (e.g. `/poc/`) | `"/"` |

135+| `--oidc-jwks-url` | string | OIDC JWKS URI for token verification; required if OIDC discovery is disabled | |

130−| flag: `--cookie-refresh`<br/>toml: `cookie_refresh` | duration | refresh the cookie after this duration; `0` to disable; not supported by all providers&nbsp;[^1] | |

136+| `--oidc-email-claim` | string | which OIDC claim contains the user's email | `"email"` |

131−| flag: `--cookie-samesite`<br/>toml: `cookie_samesite` | string | set SameSite cookie attribute (`"lax"`, `"strict"`, `"none"`, or `""`). | `""` |

137+| `--oidc-groups-claim` | string | which OIDC claim contains the user groups | `"groups"` |

132−| flag: `--cookie-secret`<br/>toml: `cookie_secret` | string | the seed string for secure cookies (optionally base64 encoded) | |

138+| `--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 |

133−| flag: `--cookie-secret-file`<br/>toml: `cookie_secret_file` | string | File containing the cookie secret (must be raw binary, exactly 16, 24, or 32 bytes). Use dd if=/dev/urandom bs=32 count=1 > cookie.secret to generate | |

139+| `--pass-authorization-header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |

134−| flag: `--cookie-secure`<br/>toml: `cookie_secure` | bool | set [secure (HTTPS only) cookie flag](https://owasp.org/www-community/controls/SecureFlag) | true |

140+| `--pass-basic-auth` | bool | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |

135−

141+| `--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 |

136−[^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)

142+| `--pass-host-header` | bool | pass the request Host Header to upstream | true |

137−

143+| `--pass-user-headers` | bool | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |

138−### Header Options

144+| `--profile-url` | string | Profile access endpoint | |

139−

145+| `--prompt` | string | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored | `""` |

140−| Flag / Config Field | Type | Description | Default |

146+| `--provider` | string | OAuth provider | google |

141−| ------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |

147+| `--provider-ca-file` | 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. |

142−| flag: `--basic-auth-password`<br/>toml: `basic_auth_password` | string | the password to set when passing the HTTP Basic Auth header | |

148+| `--provider-display-name` | string | Override the provider's name with the given string; used for the sign-in page | (depends on provider) |

143−| 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 |

149+| `--ping-path` | string | the ping endpoint that can be used for basic health checks | `"/ping"` |

144−| flag: `--set-authorization-header`<br/>toml: `set_authorization_header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |

150+| `--ping-user-agent` | string | a User-Agent that can be used for basic health checks | `""` (don't check user agent) |

145−| flag: `--set-basic-auth`<br/>toml: `set_basic_auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |

151+| `--metrics-address` | string | the address prometheus metrics will be scraped from | `""` |

146−| 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 |

152+| `--proxy-prefix` | string | the url root path that this proxy should be nested under (e.g. /`<oauth2>/sign_in`) | `"/oauth2"` |

147−| 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 |

153+| `--proxy-websockets` | bool | enables WebSocket proxying | true |

148−| flag: `--pass-authorization-header`<br/>toml: `pass_authorization_header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |

154+| `--pubjwk-url` | string | JWK pubkey access endpoint: required by login.gov | |

149−| 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 |

155+| `--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, or X-ProxyUser-IP) | X-Real-IP |

150−| 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 |

156+| `--redeem-url` | string | Token redemption endpoint | |

151−| 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 |

157+| `--redirect-url` | string | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"` | |

152−

158+| `--redis-cluster-connection-urls` | string \| list | List of Redis cluster connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-cluster` | |

153−### Logging Options

159+| `--redis-connection-url` | string | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`) | |

154−

160+| `--redis-password` | string | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url` | |

155−| Flag / Config Field | Type | Description | Default |

161+| `--redis-sentinel-password` | string | Redis sentinel password. Used only for sentinel connection; any redis node passwords need to use `--redis-password` | |

156−| --------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------- | --------------------------------------------------- |

162+| `--redis-sentinel-master-name` | string | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel` | |

157−| flag: `--auth-logging-format`<br/>toml: `auth_logging_format` | string | Template for authentication log lines | see [Logging Configuration](#logging-configuration) |

163+| `--redis-sentinel-connection-urls` | string \| list | List of Redis sentinel connection URLs (e.g. `redis://HOST[:PORT]`). Used in conjunction with `--redis-use-sentinel` | |

158−| flag: `--auth-logging`<br/>toml: `auth_logging` | bool | Log authentication attempts | true |

164+| `--redis-use-cluster` | bool | Connect to redis cluster. Must set `--redis-cluster-connection-urls` to use this feature | false |

159−| flag: `--errors-to-info-log`<br/>toml: `errors_to_info_log` | bool | redirects error-level logging to default log channel instead of stderr | false |

165+| `--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 |

160−| 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) |

166+| `--request-id-header` | string | Request header to use as the request ID in logging | X-Request-Id |

161−| flag: `--logging-compress`<br/>toml: `logging_compress` | bool | Should rotated log files be compressed using gzip | false |

167+| `--request-logging` | bool | Log requests | true |

162−| flag: `--logging-filename`<br/>toml: `logging_filename` | string | File to log requests to, empty for `stdout` | `""` (stdout) |

168+| `--request-logging-format` | string | Template for request log lines | see [Logging Configuration](#logging-configuration) |

163−| 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) |

169+| `--resource` | string | The resource that is protected (Azure AD only) | |

164−| flag: `--logging-max-age`<br/>toml: `logging_max_age` | int | Maximum number of days to retain old log files | 7 |

170+| `--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 |

165−| flag: `--logging-max-backups`<br/>toml: `logging_max_backups` | int | Maximum number of old log files to retain; 0 to disable | 0 |

171+| `--scope` | string | OAuth scope specification | |

166−| flag: `--logging-max-size`<br/>toml: `logging_max_size` | int | Maximum size in megabytes of the log file before rotation | 100 |

172+| `--session-cookie-minimal` | bool | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only) | false |

167−| flag: `--request-id-header`<br/>toml: `request_id_header` | string | Request header to use as the request ID in logging | X-Request-Id |

173+| `--session-store-type` | string | [Session data storage backend](sessions.md); redis or cookie | cookie |

168−| flag: `--request-logging-format`<br/>toml: `request_logging_format` | string | Template for request log lines | see [Logging Configuration](#logging-configuration) |

174+| `--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 |

169−| flag: `--request-logging`<br/>toml: `request_logging` | bool | Log requests | true |

175+| `--set-authorization-header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |

170−| flag: `--silence-ping-logging`<br/>toml: `silence_ping_logging` | bool | disable logging of requests to ping & ready endpoints | false |

176+| `--set-basic-auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |

171−| flag: `--standard-logging-format`<br/>toml: `standard_logging_format` | string | Template for standard log lines | see [Logging Configuration](#logging-configuration) |

177+| `--show-debug-on-error` | bool | show detailed error information on error pages (WARNING: this may contain sensitive information - do not use in production) | false |

172−| flag: `--standard-logging`<br/>toml: `standard_logging` | bool | Log standard runtime information | true |

178+| `--signature-key` | string | GAP-Signature request signature key (algorithm:secretkey) | |

173−

179+| `--silence-ping-logging` | bool | disable logging of requests to ping endpoint | false |

174−### Page Template Options

180+| `--skip-auth-preflight` | bool | will skip authentication for OPTIONS requests | false |

175−

181+| `--skip-auth-regex` | string \| list | (DEPRECATED for `--skip-auth-route`) bypass authentication for requests paths that match (may be given multiple times) | |

176−| Flag / Config Field | Type | Description | Default |

182+| `--skip-auth-route` | string \| list | bypass authentication for requests that match the method & path. Format: method=path_regex OR path_regex alone for all methods | |

177−| ----------------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- | ------- |

183+| `--skip-auth-strip-headers` | bool | strips `X-Forwarded-*` style authentication headers & `Authorization` header if they would be set by oauth2-proxy | true |

178−| flag: `--banner`<br/>toml: `banner` | string | custom (html) banner string. Use `"-"` to disable default banner. | |

184+| `--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 |

179−| 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. | |

185+| `--skip-oidc-discovery` | bool | bypass OIDC endpoint discovery. `--login-url`, `--redeem-url` and `--oidc-jwks-url` must be configured in this case | false |

180−| flag: `--custom-templates-dir`<br/>toml: `custom_templates_dir` | string | path to custom html templates | |

186+| `--skip-provider-button` | bool | will skip sign-in-page to directly reach the next step: oauth/start | false |

181−| flag: `--display-htpasswd-form`<br/>toml: `display_htpasswd_form` | bool | display username / password login form if an htpasswd file is provided | true |

187+| `--ssl-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS providers | false |

182−| flag: `--footer`<br/>toml: `footer` | string | custom (html) footer string. Use `"-"` to disable default footer. (Can be used to obfuscate the version) | |

188+| `--ssl-upstream-insecure-skip-verify` | bool | skip validation of certificates presented when using HTTPS upstreams | false |

183−| 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 |

189+| `--standard-logging` | bool | Log standard runtime information | true |

184−

190+| `--standard-logging-format` | string | Template for standard log lines | see [Logging Configuration](#logging-configuration) |

185−### Probe Options

191+| `--tls-cert-file` | string | path to certificate file | |

186−

192+| `--tls-key-file` | string | path to private key file | |

187−| Flag / Config Field | Type | Description | Default |

193+| `--upstream` | 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 | |

188−| ------------------------------------------------------- | ------ | ---------------------------------------------------------- | ----------------------------- |

194+| `--allowed-group` | string \| list | restrict logins to members of this group (may be given multiple times) | |

189−| flag: `--ping-path`<br/>toml: `ping_path` | string | the ping endpoint that can be used for basic health checks | `"/ping"` |

195+| `--allowed-role` | string \| list | restrict logins to users with this role (may be given multiple times). Only works with the keycloak-oidc provider. | |

190−| 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) |

196+| `--validate-url` | string | Access token validation endpoint | |

191−| flag: `--ready-path`<br/>toml: `ready_path` | string | the ready endpoint that can be used for deep health checks | `"/ready"` |

197+| `--version` | n/a | print version string | |

192−| flag: `--gcp-healthchecks`<br/>toml: `gcp_healthchecks` | bool | Enable GCP/GKE healthcheck endpoints (deprecated) | false |

198+| `--whitelist-domain` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` to allow subdomains (e.g. `.example.com`)&nbsp;\[[2](#footnote2)\] | |

193−

199+| `--trusted-ip` | 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. | |

194−### Proxy Options

200+

195−

201+\[<a name="footnote1">1</a>\]: Only these providers support `--cookie-refresh`: GitLab, Google and OIDC

196−:::warning

202+

197−When `--reverse-proxy` is enabled, configure `--trusted-proxy-ip` to the IPs or CIDR ranges of the reverse proxies that are allowed to send `X-Forwarded-*` headers. If you leave it unset, OAuth2 Proxy currently trusts all source IPs for backwards compatibility, which means a client that can reach OAuth2 Proxy directly may be able to spoof forwarded headers.

203+\[<a name="footnote2">2</a>\]: When using the `whitelist-domain` option, any domain prefixed with 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:*`.

198−:::

204+

199−

205+See below for provider specific options

200−| Flag / Config Field | Type | Description | Default |

206+

201−| ----------------------------------------------------------------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |

207+### Upstreams Configuration

202−| 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` |

208+

203−| 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 | |

209+`oauth2-proxy` supports having multiple upstreams, and has the option to pass requests on to HTTP(S) servers or serve static files from the file system. HTTP and HTTPS upstreams are configured by providing a URL such as `http://127.0.0.1:8080/` for the upstream parameter. This will forward all authenticated requests to the upstream server. If you instead provide `http://127.0.0.1:8080/some/path/` then it will only be requests that start with `/some/path/` which are forwarded to the upstream.

204−| flag: `--authenticated-emails-file`<br/>toml: `authenticated_emails_file` | string | authenticate against emails via file (one per line) | |

210+

205−| 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 |

211+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/`.

206−| 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 | |

207−| flag: `--encode-state`<br/>toml: `encode_state` | bool | encode the state parameter as UrlEncodedBase64 | false |

208−| 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`) | |

209−| flag: `--force-https`<br/>toml: `force_https` | bool | enforce https redirect | `false` |

210−| flag: `--force-json-errors`<br/>toml: `force_json_errors` | bool | force JSON errors instead of HTTP error pages or redirects | `false` |

211−| flag: `--htpasswd-file`<br/>toml: `htpasswd_file` | string | additionally authenticate against a htpasswd file. Entries must be created with `htpasswd -B` for bcrypt encryption | |

212−| flag: `--htpasswd-user-group`<br/>toml: `htpasswd_user_groups` | string \| list | the groups to be set on sessions for htpasswd users | |

213−| 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"` |

214−| 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 |

215−| flag: `--redirect-url`<br/>toml: `redirect_url` | string | the OAuth Redirect URL, e.g. `"https://internalapp.yourcompany.com/oauth2/callback"` | |

216−| flag: `--relative-redirect-url`<br/>toml: `relative_redirect_url` | bool | allow relative OAuth Redirect URL.` | false |

217−| 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 |

218−| flag: `--trusted-proxy-ip`<br/>toml: `trusted_proxy_ips` | string \| list | list of IPs or CIDR ranges allowed to supply `X-Forwarded-*` headers when `--reverse-proxy` is enabled. If not set, OAuth2 Proxy preserves backwards compatibility by trusting all source IPs (`0.0.0.0/0`, `::/0`) and logs a warning at startup. Configure this to your reverse proxy addresses to prevent forwarded header spoofing. | `"0.0.0.0/0", "::/0"` |

219−| flag: `--signature-key`<br/>toml: `signature_key` | string | GAP-Signature request signature key (algorithm:secretkey) | |

220−| flag: `--skip-auth-preflight`<br/>toml: `skip_auth_preflight` | bool | will skip authentication for OPTIONS requests | false |

221−| 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). Path matching is performed against the normalized path only; fragment identifiers (`#`) and their URL-encoded form (`%23`) are stripped before evaluation. | |

222−| 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. Path matching is performed against the normalized path only; fragment identifiers (`#`) and their URL-encoded form (`%23`) are stripped before evaluation. | |

223−| 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 |

224−| flag: `--skip-provider-button`<br/>toml: `skip_provider_button` | bool | will skip sign-in-page to directly reach the next step: oauth/start | false |

225−| flag: `--ssl-insecure-skip-verify`<br/>toml: `ssl_insecure_skip_verify` | bool | skip validation of certificates presented when using HTTPS providers | false |

226−| 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. | |

227−| 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`)&nbsp;[^2] | |

228−

229−[^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:*`.

230−

231−### Server Options

232−

233−| Flag / Config Field | Type | Description | Default |

234−| ------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |

235−| 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. Unix sockets are created with default system umask mode, which can be overridden, e.g. `unix://my-socket,mode=0777`. Square brackets are required for ipv6 address, e.g. `http://[::1]:4180` | `"127.0.0.1:4180"` |

236−| 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"` |

237−| flag: `--metrics-address`<br/>toml: `metrics_address` | string | the address prometheus metrics will be scraped from | `""` |

238−| flag: `--metrics-secure-address`<br/>toml: `metrics_secure_address` | string | the address prometheus metrics will be scraped from if using HTTPS | `""` |

239−| flag: `--metrics-tls-cert-file`<br/>toml: `metrics_tls_cert_file` | string | path to certificate file for secure metrics server | `""` |

240−| flag: `--metrics-tls-key-file`<br/>toml: `metrics_tls_key_file` | string | path to private key file for secure metrics server | `""` |

241−| flag: `--tls-cert-file`<br/>toml: `tls_cert_file` | string | path to certificate file | |

242−| flag: `--tls-key-file`<br/>toml: `tls_key_file` | string | path to private key file | |

243−| 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). | |

244−| flag: `--tls-min-version`<br/>toml: `tls_min_version` | string | minimum TLS version that is acceptable, either `"TLS1.2"` or `"TLS1.3"` | `"TLS1.2"` |

245−

246−### Session Options

247−

248−| Flag / Config Field | Type | Description | Default |

249−| ----------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |

250−| 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 |

251−| flag: `--session-store-type`<br/>toml: `session_store_type` | string | [Session data storage backend](sessions.md); redis or cookie | cookie |

252−| 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` | |

253−| flag: `--redis-connection-url`<br/>toml: `redis_connection_url` | string | URL of redis server for redis session storage (e.g. `redis://HOST[:PORT]`) | |

254−| flag: `--redis-ca-path`<br/>toml: `redis_ca_path` | string | Path to a CA certificates file that should be used when connecting to redis. If not specified, the system cert pool is used instead. | |

255−| flag: `--redis-insecure-skip-tls-verify`<br/>toml: `redis_insecure_skip_tls_verify` | bool | skip TLS verification when connecting to Redis | false |

256−| flag: `--redis-password`<br/>toml: `redis_password` | string | Redis password. Applicable for all Redis configurations. Will override any password set in `--redis-connection-url` | |

257−| 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` | |

258−| flag: `--redis-sentinel-master-name`<br/>toml: `redis_sentinel_master_name` | string | Redis sentinel master name. Used in conjunction with `--redis-use-sentinel` | |

259−| 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` | |

260−| 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 |

261−| 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 |

262−| 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 |

263−

264−### Upstream Options

265−

266−| Flag / Config Field | Type | Description | Default |

267−| ----------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- |

268−| flag: `--flush-interval`<br/>toml: `flush_interval` | duration | period between flushing response buffers when streaming responses | `"1s"` |

269−| flag: `--pass-host-header`<br/>toml: `pass_host_header` | bool | pass the request Host Header to upstream | true |

270−| flag: `--proxy-websockets`<br/>toml: `proxy_websockets` | bool | enables WebSocket proxying | true |

271−| flag: `--ssl-upstream-insecure-skip-verify`<br/>toml: `ssl_upstream_insecure_skip_verify` | bool | skip validation of certificates presented when using HTTPS upstreams | false |

272−| flag: `--disable-keep-alives`<br/>toml: `disable_keep_alives` | bool | disable HTTP keep-alive connections to the upstream server | false |

273−| flag: `--upstream-timeout`<br/>toml: `upstream_timeout` | duration | maximum amount of time the server will wait for a response from the upstream | 30s |

274−| 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 | |

275−

276−## Configuration Validation

277−

278−The `--config-test` flag validates your configuration file without starting the proxy server. This is useful for:

279−- **CI/CD pipelines**: Pre-deployment validation

280−- **Configuration management**: Testing before applying changes

281−- **Debugging**: Verifying syntax and required fields

282−

283−### Usage

284−

285−```bash

286−# Test legacy config

287−oauth2-proxy --config /etc/oauth2-proxy.cfg --config-test

288−

289−# Test alpha config

290−oauth2-proxy --config /etc/core.cfg --alpha-config /etc/alpha.yaml --config-test

291−

292−# CI/CD pre-deployment check

293−# Returns with exit code 1 if any validation errors occur

294−oauth2-proxy --config new-config.cfg --config-test

295−```

296−

297−### Exit Codes

298−

299−- **0**: Configuration is valid ✅

300−- **1**: Configuration is invalid (errors printed to stderr) ❌

301−

302−### Validation Coverage

303−

304−The `--config-test` flag performs the **same comprehensive validation** as normal startup, including:

305−- Required fields (client ID, client secret, cookie secret, etc.)

306−- Syntax validation (TOML/YAML parsing)

307−- Provider configuration

308−- Upstream server definitions

309−- Session store connectivity (e.g., Redis network checks if configured)

310−

311−**Note**: Cannot be combined with `--convert-config-to-alpha`.

312−

313−## Upstreams Configuration

314−

315−`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.

316−

317−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.

318−

319−* 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`.

320−* 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`.

321−

322−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.

323−

324−**Unix socket upstreams** are configured as `unix:///path/to/unix.sock`.

325−

326−**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/`.

327

212

328Multiple 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.

213Multiple 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.

329

214

330−## Environment variables

215+### Environment variables

331

216

332Every command line argument can be specified as an environment variable by

217Every command line argument can be specified as an environment variable by

333prefixing it with `OAUTH2_PROXY_`, capitalising it, and replacing hyphens (`-`)

218prefixing it with `OAUTH2_PROXY_`, capitalising it, and replacing hyphens (`-`)

334with underscores (`_`). If the argument can be specified multiple times, the

219with underscores (`_`). If the argument can be specified multiple times, the

335environment variable should be plural (trailing `S`).

220environment variable should be plural (trailing `S`).

336

221

337−This is particularly useful for storing secrets outside a configuration file

222+This is particularly useful for storing secrets outside of a configuration file

338or the command line.

223or the command line.

339

224

340−For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`.

225+For example, the `--cookie-secret` flag becomes `OAUTH2_PROXY_COOKIE_SECRET`,

341−If a flag has the type `string | list` like the `--email-domain` flag it is

342−available as an environment variable in plural form e.g. `OAUTH2_PROXY_EMAIL_DOMAINS`

226+and the `--email-domain` flag becomes `OAUTH2_PROXY_EMAIL_DOMAINS`.

343−

344−Values for type `string | list` usually have a plural environment variable name

345−and need to be seperated by `,` e.g.

346−`OAUTH2_PROXY_SKIP_AUTH_ROUTES="GET=^/api/status,POST=^/api/saved_objects/_import"`

347−

348−Please check the type for each [config option](#config-options) first.

349

227

350## Logging Configuration

228## Logging Configuration

351

229

@@ -355,16 +233,15 @@ If logging to a file you can also configure the maximum file size (`--logging-ma

355

233

356There 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`.

234There 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`.

357

235

358−Each type of logging has its own configurable format and variables. By default, these formats are similar to the Apache Combined Log.

236+Each type of logging has its own configurable format and variables. By default these formats are similar to the Apache Combined Log.

359−

360−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.

361

237

362−## Auth Log Format

238+Logging of requests to the `/ping` endpoint (or using `--ping-user-agent`) can be disabled with `--silence-ping-logging` reducing log volume. This flag appends the `--ping-path` to `--exclude-logging-paths`.

363

239

240+### Auth Log Format

364Authentication 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:

241Authentication 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:

365

242

366```

243```

367−<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [2015/03/19 17:20:19] [<STATUS>] <MESSAGE>

244+<REMOTE_ADDRESS> - <REQUEST ID> - <user@domain.com> [19/Mar/2015:17:20:19 -0400] [<STATUS>] <MESSAGE>

368```

245```

369

246

370The status block will contain one of the below strings:

247The status block will contain one of the below strings:

@@ -382,25 +259,24 @@ The default format is configured as follows:

382

259

383Available variables for auth logging:

260Available variables for auth logging:

384

261

385−| Variable | Example | Description |

262+| Variable | Example | Description |

386−| ------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |

263+| --- | --- | --- |

387−| 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. |

264+| 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. |

388−| Host | domain.com | The value of the Host header. |

265+| Host | domain.com | The value of the Host header. |

389−| Message | Authenticated via OAuth2 | The details of the auth attempt. |

266+| Message | Authenticated via OAuth2 | The details of the auth attempt. |

390−| Protocol | HTTP/1.0 | The request protocol. |

267+| Protocol | HTTP/1.0 | The request protocol. |

391−| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |

268+| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |

392−| RequestMethod | GET | The request method. |

269+| RequestMethod | GET | The request method. |

393−| Timestamp | 2015/03/19 17:20:19 | The date and time of the logging event. |

270+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |

394−| UserAgent | - | The full user agent as reported by the requesting client. |

271+| UserAgent | - | The full user agent as reported by the requesting client. |

395−| Username | username@email.com | The email or username of the auth request. |

272+| Username | username@email.com | The email or username of the auth request. |

396−| Status | AuthSuccess | The status of the auth request. See above for details. |

273+| Status | AuthSuccess | The status of the auth request. See above for details. |

397−

274+

398−## Request Log Format

275+### Request Log Format

399−

400HTTP request logs will output by default in the below format:

276HTTP request logs will output by default in the below format:

401

277

402```

278```

403−<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>

279+<REMOTE_ADDRESS> - <REQUEST ID> - <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>

404```

280```

405

281

406If you require a different format than that, you can configure it with the `--request-logging-format` flag.

282If you require a different format than that, you can configure it with the `--request-logging-format` flag.

@@ -412,28 +288,27 @@ The default format is configured as follows:

412

288

413Available variables for request logging:

289Available variables for request logging:

414

290

415−| Variable | Example | Description |

291+| Variable | Example | Description |

416−| --------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- |

292+| --- | --- | --- |

417−| 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. |

293+| 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. |

418−| Host | domain.com | The value of the Host header. |

294+| Host | domain.com | The value of the Host header. |

419−| Protocol | HTTP/1.0 | The request protocol. |

295+| Protocol | HTTP/1.0 | The request protocol. |

420−| RequestDuration | 0.001 | The time in seconds that a request took to process. |

296+| RequestDuration | 0.001 | The time in seconds that a request took to process. |

421−| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |

297+| RequestID | 00010203-0405-4607-8809-0a0b0c0d0e0f | The request ID pulled from the `--request-id-header`. Random UUID if empty |

422−| RequestMethod | GET | The request method. |

298+| RequestMethod | GET | The request method. |

423−| RequestURI | "/oauth2/auth" | The URI path of the request. |

299+| RequestURI | "/oauth2/auth" | The URI path of the request. |

424−| ResponseSize | 12 | The size in bytes of the response. |

300+| ResponseSize | 12 | The size in bytes of the response. |

425−| StatusCode | 200 | The HTTP status code of the response. |

301+| StatusCode | 200 | The HTTP status code of the response. |

426−| Timestamp | 2015/03/19 17:20:19 | The date and time of the logging event. |

302+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |

427−| Upstream | - | The upstream data of the HTTP request. |

303+| Upstream | - | The upstream data of the HTTP request. |

428−| UserAgent | - | The full user agent as reported by the requesting client. |

304+| UserAgent | - | The full user agent as reported by the requesting client. |

429−| Username | username@email.com | The email or username of the auth request. |

305+| Username | username@email.com | The email or username of the auth request. |

430−

306+

431−## Standard Log Format

307+### Standard Log Format

432−

433All 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:

308All 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:

434

309

435```

310```

436−[2015/03/19 17:20:19] [main.go:40] <MESSAGE>

311+[19/Mar/2015:17:20:19 -0400] [main.go:40] <MESSAGE>

437```

312```

438

313

439If you require a different format than that, you can configure it with the `--standard-logging-format` flag. The default format is configured as follows:

314If you require a different format than that, you can configure it with the `--standard-logging-format` flag. The default format is configured as follows:

@@ -444,8 +319,273 @@ If you require a different format than that, you can configure it with the `--st

444

319

445Available variables for standard logging:

320Available variables for standard logging:

446

321

447−| Variable | Example | Description |

322+| Variable | Example | Description |

448−| --------- | --------------------------------- | -------------------------------------------------- |

323+| --- | --- | --- |

449−| Timestamp | 2015/03/19 17:20:19 | The date and time of the logging event. |

324+| Timestamp | 19/Mar/2015:17:20:19 -0400 | The date and time of the logging event. |

450−| File | main.go:40 | The file and line number of the logging statement. |

325+| File | main.go:40 | The file and line number of the logging statement. |

451−| Message | HTTP: listening on 127.0.0.1:4180 | The details of the log statement. |

326+| Message | HTTP: listening on 127.0.0.1:4180 | The details of the log statement. |

327+

328+## Configuring for use with the Nginx `auth_request` directive

329+

330+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:

331+

332+```nginx

333+server {

334+ listen 443 ssl;

335+ server_name ...;

336+ include ssl/ssl.conf;

337+

338+ location /oauth2/ {

339+ proxy_pass http://127.0.0.1:4180;

340+ proxy_set_header Host $host;

341+ proxy_set_header X-Real-IP $remote_addr;

342+ proxy_set_header X-Scheme $scheme;

343+ proxy_set_header X-Auth-Request-Redirect $request_uri;

344+ # or, if you are handling multiple domains:

345+ # proxy_set_header X-Auth-Request-Redirect $scheme://$host$request_uri;

346+ }

347+ location = /oauth2/auth {

348+ proxy_pass http://127.0.0.1:4180;

349+ proxy_set_header Host $host;

350+ proxy_set_header X-Real-IP $remote_addr;

351+ proxy_set_header X-Scheme $scheme;

352+ # nginx auth_request includes headers but not body

353+ proxy_set_header Content-Length "";

354+ proxy_pass_request_body off;

355+ }

356+

357+ location / {

358+ auth_request /oauth2/auth;

359+ error_page 401 = /oauth2/sign_in;

360+

361+ # pass information via X-User and X-Email headers to backend,

362+ # requires running with --set-xauthrequest flag

363+ auth_request_set $user $upstream_http_x_auth_request_user;

364+ auth_request_set $email $upstream_http_x_auth_request_email;

365+ proxy_set_header X-User $user;

366+ proxy_set_header X-Email $email;

367+

368+ # if you enabled --pass-access-token, this will pass the token to the backend

369+ auth_request_set $token $upstream_http_x_auth_request_access_token;

370+ proxy_set_header X-Access-Token $token;

371+

372+ # if you enabled --cookie-refresh, this is needed for it to work with auth_request

373+ auth_request_set $auth_cookie $upstream_http_set_cookie;

374+ add_header Set-Cookie $auth_cookie;

375+

376+ # When using the --set-authorization-header flag, some provider's cookies can exceed the 4kb

377+ # limit and so the OAuth2 Proxy splits these into multiple parts.

378+ # Nginx normally only copies the first `Set-Cookie` header from the auth_request to the response,

379+ # so if your cookies are larger than 4kb, you will need to extract additional cookies manually.

380+ auth_request_set $auth_cookie_name_upstream_1 $upstream_cookie_auth_cookie_name_1;

381+

382+ # Extract the Cookie attributes from the first Set-Cookie header and append them

383+ # to the second part ($upstream_cookie_* variables only contain the raw cookie content)

384+ if ($auth_cookie ~* "(; .*)") {

385+ set $auth_cookie_name_0 $auth_cookie;

386+ set $auth_cookie_name_1 "auth_cookie_name_1=$auth_cookie_name_upstream_1$1";

387+ }

388+

389+ # Send both Set-Cookie headers now if there was a second part

390+ if ($auth_cookie_name_upstream_1) {

391+ add_header Set-Cookie $auth_cookie_name_0;

392+ add_header Set-Cookie $auth_cookie_name_1;

393+ }

394+

395+ proxy_pass http://backend/;

396+ # or "root /path/to/site;" or "fastcgi_pass ..." etc

397+ }

398+}

399+```

400+

401+When you use ingress-nginx in Kubernetes, you MUST use `kubernetes/ingress-nginx` (which includes the Lua module) and the following configuration snippet for your `Ingress`.

402+Variables set with `auth_request_set` are not `set`-able in plain nginx config when the location is processed via `proxy_pass` and then may only be processed by Lua.

403+Note that `nginxinc/kubernetes-ingress` does not include the Lua module.

404+

405+```yaml

406+nginx.ingress.kubernetes.io/auth-response-headers: Authorization

407+nginx.ingress.kubernetes.io/auth-signin: https://$host/oauth2/start?rd=$escaped_request_uri

408+nginx.ingress.kubernetes.io/auth-url: https://$host/oauth2/auth

409+nginx.ingress.kubernetes.io/configuration-snippet: |

410+ auth_request_set $name_upstream_1 $upstream_cookie_name_1;

411+

412+ access_by_lua_block {

413+ if ngx.var.name_upstream_1 ~= "" then

414+ ngx.header["Set-Cookie"] = "name_1=" .. ngx.var.name_upstream_1 .. ngx.var.auth_cookie:match("(; .*)")

415+ end

416+ }

417+```

418+It is recommended to use `--session-store-type=redis` when expecting large sessions/OIDC tokens (_e.g._ with MS Azure).

419+

420+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=".

421+

422+## Configuring for use with the Traefik (v2) `ForwardAuth` middleware

423+

424+**This option requires `--reverse-proxy` option to be set.**

425+

426+### ForwardAuth with 401 errors middleware

427+

428+The [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/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:

429+

430+```yaml

431+http:

432+ routers:

433+ a-service:

434+ rule: "Host(`a-service.example.com`)"

435+ service: a-service-backend

436+ middlewares:

437+ - oauth-errors

438+ - oauth-auth

439+ tls:

440+ certResolver: default

441+ domains:

442+ - main: "example.com"

443+ sans:

444+ - "*.example.com"

445+ oauth:

446+ rule: "Host(`a-service.example.com`, `oauth.example.com`) && PathPrefix(`/oauth2/`)"

447+ middlewares:

448+ - auth-headers

449+ service: oauth-backend

450+ tls:

451+ certResolver: default

452+ domains:

453+ - main: "example.com"

454+ sans:

455+ - "*.example.com"

456+

457+ services:

458+ a-service-backend:

459+ loadBalancer:

460+ servers:

461+ - url: http://172.16.0.2:7555

462+ oauth-backend:

463+ loadBalancer:

464+ servers:

465+ - url: http://172.16.0.1:4180

466+

467+ middlewares:

468+ auth-headers:

469+ headers:

470+ sslRedirect: true

471+ stsSeconds: 315360000

472+ browserXssFilter: true

473+ contentTypeNosniff: true

474+ forceSTSHeader: true

475+ sslHost: example.com

476+ stsIncludeSubdomains: true

477+ stsPreload: true

478+ frameDeny: true

479+ oauth-auth:

480+ forwardAuth:

481+ address: https://oauth.example.com/oauth2/auth

482+ trustForwardHeader: true

483+ oauth-errors:

484+ errors:

485+ status:

486+ - "401-403"

487+ service: oauth-backend

488+ query: "/oauth2/sign_in"

489+```

490+

491+### ForwardAuth with static upstreams configuration

492+

493+Redirect to sign_in functionality provided without the use of `errors` middleware with [Traefik v2 `ForwardAuth` middleware](https://doc.traefik.io/traefik/middlewares/forwardauth/) pointing to oauth2-proxy service's `/` endpoint

494+

495+**Following options need to be set on `oauth2-proxy`:**

496+- `--upstream=static://202`: Configures a static response for authenticated sessions

497+- `--reverseproxy=true`: Enables the use of `X-Forwarded-*` headers to determine redirects correctly

498+

499+```yaml

500+http:

501+ routers:

502+ a-service-route-1:

503+ rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/`)"

504+ service: a-service-backend

505+ middlewares:

506+ - oauth-auth-redirect # redirects all unauthenticated to oauth2 signin

507+ tls:

508+ certResolver: default

509+ domains:

510+ - main: "example.com"

511+ sans:

512+ - "*.example.com"

513+ a-service-route-2:

514+ rule: "Host(`a-service.example.com`) && PathPrefix(`/no-auto-redirect`)"

515+ service: a-service-backend

516+ middlewares:

517+ - oauth-auth-wo-redirect # unauthenticated session will return a 401

518+ tls:

519+ certResolver: default

520+ domains:

521+ - main: "example.com"

522+ sans:

523+ - "*.example.com"

524+ services-oauth2-route:

525+ rule: "Host(`a-service.example.com`, `b-service.example.com`) && PathPrefix(`/oauth2/`)"

526+ middlewares:

527+ - auth-headers

528+ service: oauth-backend

529+ tls:

530+ certResolver: default

531+ domains:

532+ - main: "example.com"

533+ sans:

534+ - "*.example.com"

535+ oauth2-proxy-route:

536+ rule: "Host(`oauth.example.com`) && PathPrefix(`/`)"

537+ middlewares:

538+ - auth-headers

539+ service: oauth-backend

540+ tls:

541+ certResolver: default

542+ domains:

543+ - main: "example.com"

544+ sans:

545+ - "*.example.com"

546+

547+ services:

548+ a-service-backend:

549+ loadBalancer:

550+ servers:

551+ - url: http://172.16.0.2:7555

552+ b-service-backend:

553+ loadBalancer:

554+ servers:

555+ - url: http://172.16.0.3:7555

556+ oauth-backend:

557+ loadBalancer:

558+ servers:

559+ - url: http://172.16.0.1:4180

560+

561+ middlewares:

562+ auth-headers:

563+ headers:

564+ sslRedirect: true

565+ stsSeconds: 315360000

566+ browserXssFilter: true

567+ contentTypeNosniff: true

568+ forceSTSHeader: true

569+ sslHost: example.com

570+ stsIncludeSubdomains: true

571+ stsPreload: true

572+ frameDeny: true

573+ oauth-auth-redirect:

574+ forwardAuth:

575+ address: https://oauth.example.com/

576+ trustForwardHeader: true

577+ authResponseHeaders:

578+ - X-Auth-Request-Access-Token

579+ - Authorization

580+ oauth-auth-wo-redirect:

581+ forwardAuth:

582+ address: https://oauth.example.com/oauth2/auth

583+ trustForwardHeader: true

584+ authResponseHeaders:

585+ - X-Auth-Request-Access-Token

586+ - Authorization

587+```

588+

589+:::note

590+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.

591+:::

docs/docs/configuration/providers/adfs.mddeleted−19

@@ -1,19 +0,0 @@

1−---

2−id: adfs

3−title: ADFS

4−---

5−

6−1. Open the ADFS administration console on your Windows Server and add a new Application Group

7−2. Provide a name for the integration, select Server Application from the Standalone applications section and click Next

8−3. Follow the wizard to get the client-id, client-secret and configure the application credentials

9−4. Configure the proxy with

10−

11−```

12− --provider=adfs

13− --client-id=<application ID from step 3>

14− --client-secret=<value from step 3>

15−```

16−

17−Note: When using the ADFS Auth provider with nginx and the cookie session store you may find the cookie is too large and

18−doesn't get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the

19−[redis session storage](../sessions.md#redis-storage) should resolve this.

docs/docs/configuration/providers/atlassian.mddeleted−26

@@ -1,26 +0,0 @@

1−---

2−id: atlassian

3−title: Atlassian Cloud

4−---

5−

6−1. Create an OAuth 2.0 integration in the [Atlassian developer console](https://developer.atlassian.com/console/myapps/).

7−2. Under **Permissions**, add the User identity API with the `read:me` scope.

8−3. Under **Authorization**, set the callback URL to `https://<proxy_host>/oauth2/callback`.

9−4. Copy the client ID and secret from **Settings**.

10−5. Run the proxy with:

11−

12−```shell

13− --provider=atlassian

14− --client-id=<client ID>

15− --client-secret=<secret>

16− --redirect-url=https://<proxy_host>/oauth2/callback

17− --cookie-secret=<cookie secret>

18−```

19−

20−A new app works only for the account that created it. Enable sharing under **Distribution** to let other users sign in.

21−Atlassian then admits only accounts with access to the Atlassian site the app is installed on; others are refused at

22−the consent screen.

23−

24−The proxy reads the user's email from `https://api.atlassian.com/me`. Restricting access further is supported by

25−[email](index.md#email-authentication). With `--cookie-refresh` set, the proxy re-validates the token against `/me` on

26−that interval.

docs/docs/configuration/providers/bitbucket.mddeleted−25

@@ -1,25 +0,0 @@

1−---

2−id: bitbucket

3−title: BitBucket

4−---

5−

6−1. [Add a new OAuth consumer](https://confluence.atlassian.com/bitbucket/oauth-on-bitbucket-cloud-238027431.html)

7− * In "Callback URL" use `https://<oauth2-proxy>/oauth2/callback`, substituting `<oauth2-proxy>` with the actual

8− hostname that oauth2-proxy is running on.

9− * In Permissions section select:

10− * Account -> Email

11− * Team membership -> Read

12− * Repositories -> Read

13−2. Note the Client ID and Client Secret.

14−

15−To use the provider, pass the following options:

16−

17−```

18− --provider=bitbucket

19− --client-id=<Client ID>

20− --client-secret=<Client Secret>

21−```

22−

23−The default configuration allows everyone with Bitbucket account to authenticate. To restrict the access to the team

24−members use additional configuration option: `--bitbucket-team=<Team name>`. To restrict the access to only these users

25−who have access to one selected repository use `--bitbucket-repository=<Repository name>`.

docs/docs/configuration/providers/cidaas.mddeleted−37

@@ -1,37 +0,0 @@

1−---

2−id: cidaas

3−title: Cidaas

4−---

5−

6−[Cidaas](https://www.cidaas.com/) is an Identity as a Service (IDaaS) solution that provides authentication and authorization services.

7−It supports various protocols including OpenID Connect, OAuth 2.0, and SAML.

8−

9−However, Cidaas provides groups and their roles as hierarchical claims, which are not supported by oauth2-proxy yet.

10−The Cidaas provider transforms the hierarchical claims into a flat list of groups, which can be used by oauth2-proxy.

11−

12−Example of groups and roles in Cidaas:

13−

14−```json

15−{

16− "groups": [

17− {

18− "groupId": "group1",

19− "roles": ["role1", "role2"]

20− },

21− {

22− "groupId": "group2",

23− "roles": ["role3"]

24− }

25− ]

26−}

27−```

28−

29−This will be transformed into a flat list of groups:

30−

31−```json

32−{

33− "groups": ["group1:role1", "group2:role2", "group2:role3"]

34−}

35−```

36−

37−Apart from that the Cidaas provider inherits all the features of the [OpenID Connect provider](openid_connect.md).

docs/docs/configuration/providers/cisco_duo.mddeleted−44

@@ -1,44 +0,0 @@

1−---

2−id: cisco_duo

3−title: Cisco Duo

4−---

5−

6−Cisco Duo SSO can be configured with OAuth2 Proxy using the OIDC provider.

7−

8−1. Create a new **Generic OIDC Relying Party - Single Sign-On** application in the Duo Admin Portal

9−2. Configure OAuth2 Proxy with the following options:

10−

11−```

12−provider = "oidc"

13−provider_display_name = "Duo SSO"

14−scope = "openid email profile"

15−pass_access_token = true

16−code_challenge_method = "S256"

17−```

18−

19−3. Configure Provider endpoints. Copy the following values from the corresponding fields in the Duo Admin Portal:

20−

21−```

22−# Copy from "Client ID" field

23−client_id = "XXXXXXXX"

24−

25−# Copy from "Client Secret" field

26−client_secret = "XXXXXXXX"

27−

28−# Copy from "Issuer" field

29−oidc_issuer_url = "https://sso-xxxxxxxx.sso.duosecurity.com/oidc/xxxxxxxx"

30−

31−# Copy from "JWKS URL" field

32−oidc_jwks_url = "https://sso-xxxxxxxx.sso.duosecurity.com/oidc/xxxxxxxx/jwks"

33−

34−# Copy from "Token Introspection URL" field

35−validate_url = "https://sso-xxxxxxxx.sso.duosecurity.com/oidc/xxxxxxxx/token_introspection"

36−

37−# Copy from "UserInfo" field

38−profile_url = "https://sso-xxxxxxxx.sso.duosecurity.com/oidc/xxxxxxxx/userinfo"

39−

40−# Copy from "Token URL" field

41−redeem_url = "https://sso-xxxxxxxx.sso.duosecurity.com/oidc/xxxxxxxx/token"

42−```

43−

44−4. Complete Configuration by filling in any remaining required fields and save your configuration.

docs/docs/configuration/providers/digitalocean.mddeleted−21

@@ -1,21 +0,0 @@

1−---

2−id: digitalocean

3−title: DigitalOcean

4−---

5−

6−1. [Create a new OAuth application](https://cloud.digitalocean.com/account/api/applications)

7− * You can fill in the name, homepage, and description however you wish.

8− * In the "Application callback URL" field, enter: `https://oauth-proxy/oauth2/callback`, substituting `oauth2-proxy`

9− with the actual hostname that oauth2-proxy is running on. The URL must match oauth2-proxy's configured redirect URL.

10−2. Note the Client ID and Client Secret.

11−

12−To use the provider, pass the following options:

13−

14−```

15− --provider=digitalocean

16− --client-id=<Client ID>

17− --client-secret=<Client Secret>

18−```

19−

20−Alternatively, set the equivalent options in the config file. The redirect URL defaults to

21−`https://<requested host header>/oauth2/callback`. If you need to change it, you can use the `--redirect-url` command-line option.

docs/docs/configuration/providers/dtt_sso.mddeleted−45

@@ -1,45 +0,0 @@

1−---

2−id: dtt_sso

3−title: DTT SSO

4−---

5−

6−Signs users in with the DTT SSO (auth-server) using the authorization code flow and its HS256 id_token.

7−

8−1. Register a client in the auth-server config, one per protected service, with the proxy's callback as its

9− only redirect URI:

10−

11− ```yaml

12− clients:

13− redash-gate:

14− secret: <random secret>

15− redirect_uri: https://redash.example.com/oauth2/callback

16− display_name: Redash

17− ```

18−

19−2. Run the proxy with:

20−

21− ```shell

22− --provider=dtt-sso

23− --client-id=redash-gate

24− --client-secret-file=/run/secrets/client_secret

25− --redirect-url=https://redash.example.com/oauth2/callback

26− --cookie-secret-file=/run/secrets/cookie_secret

27− --cookie-name=_dtt_sso_redash

28− --cookie-refresh=5m

29− ```

30−

31− Give each instance its own `--cookie-name`: another oauth2-proxy setting its cookie on a parent domain

32− (the Atlassian proxy uses `_oauth2_proxy` on `.thebestagent.pro`) would otherwise shadow this one.

33−

34−The endpoints default to `https://auth.thebestagent.pro`. For another SSO host set `--login-url`, `--redeem-url`

35−and `--validate-url` to its `/oauth/authorize`, `/oauth/token` and `/oauth/check_token`; the id_token issuer must

36−equal the login URL's origin (the SSO's `site_host`).

37−

38−The scope must stay `openid`, the only scope the SSO accepts.

39−

40−The session carries the SSO `email`, the user UUID as the user, and the SSO `role` as the only group, so

41−`--allowed-group=dtt_admin` restricts access by role. `--authenticated-emails-file` and `--email-domain` restrict

42−by email as usual.

43−

44−With `--cookie-refresh` set, the proxy refreshes the tokens on that interval and re-reads the email and role; a user

45−deleted or signed out in the SSO loses access at the next refresh.

docs/docs/configuration/providers/facebook.mddeleted−7

@@ -1,7 +0,0 @@

1−---

2−id: facebook

3−title: Facebook

4−---

5−

6−1. Create a new FB App from https://developers.facebook.com/

7−2. Under FB Login, set your Valid OAuth redirect URIs to `https://internal.yourcompany.com/oauth2/callback`

docs/docs/configuration/providers/gitea.mddeleted−24

@@ -1,24 +0,0 @@

1−---

2−id: gitea

3−title: Gitea / Forgejo

4−---

5−

6−:::note

7−This is not actually a fully serparate provider. For more details and options please refer to the [GitHub Provider Options](github.md)

8−:::

9−

10−1. Create a new application: `https://< your gitea host >/user/settings/applications`

11−2. Under `Redirect URI` enter the correct URL i.e. `https://<proxied host>/oauth2/callback`

12−3. Note the Client ID and Client Secret.

13−4. Pass the following options to the proxy:

14−

15−```

16− --provider="github"

17− --redirect-url="https://<proxied host>/oauth2/callback"

18− --provider-display-name="Gitea"

19− --client-id="< client_id as generated by Gitea >"

20− --client-secret="< client_secret as generated by Gitea >"

21− --login-url="https://< your gitea host >/login/oauth/authorize"

22− --redeem-url="https://< your gitea host >/login/oauth/access_token"

23− --validate-url="https://< your gitea host >/api/v1/user/emails"

24−```

docs/docs/configuration/providers/github.mddeleted−81

@@ -1,81 +0,0 @@

1−---

2−id: github

3−title: GitHub

4−---

5−

6−## Config Options

7−

8−| Flag | Toml Field | Type | Description | Default |

9−| ---------------- | -------------- | -------------- | ------------------------------------------------------------------------------------------------------------- | ------- |

10−| `--github-org` | `github_org` | string | restrict logins to members of this organisation | |

11−| `--github-team` | `github_team` | string | restrict logins to members of any of these teams (slug) or (org:team), comma separated | |

12−| `--github-repo` | `github_repo` | string | restrict logins to collaborators of this repository formatted as `orgname/repo` | |

13−| `--github-token` | `github_token` | string | the token to use when verifying repository collaborators (must have push access to the repository) | |

14−| `--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 | |

15−

16−## Usage

17−

18−1. Create a new project: https://github.com/settings/developers

19−2. Under `Authorization callback URL` enter the correct url ie `https://internal.yourcompany.com/oauth2/callback`

20−

21−The GitHub auth provider supports two additional ways to restrict authentication to either organization and optional

22−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`

23−

24−NOTE: When `--github-user` is set, the specified users are allowed to log in even if they do not belong to the specified

25−org and team or collaborators.

26−

27−To restrict access to your organization:

28−

29−```shell

30− # restrict logins to members of this organisation

31− --github-org="your-org"

32−```

33−

34−To restrict access to specific teams within an organization:

35−

36−```shell

37− --github-org="your-org"

38− # restrict logins to members of any of these teams (slug), comma separated

39− --github-team="team1,team2,team3"

40−```

41−

42−To restrict to teams within different organizations, keep the organization flag empty and use `--github-team` like so:

43−

44−```shell

45− # keep empty

46− --github-org=""

47− # restrict logins to members to any of the following teams (format <org>:<slug>, like octo:team1), comma separated

48− --github-team="org1:team1,org2:team1,org3:team42,octo:cat"

49−```

50−

51−If you would rather restrict access to collaborators of a repository, those users must either have push access to a

52−public repository or any access to a private repository:

53−

54−```shell

55− # restrict logins to collaborators of this repository formatted as orgname/repo

56− --github-repo=""

57−```

58−

59−If you'd like to allow access to users with **read only** access to a **public** repository you will need to provide a

60−[token](https://github.com/settings/tokens) for a user that has write access to the repository. The token must be

61−created with at least the `public_repo` scope:

62−

63−```shell

64− # the token to use when verifying repository collaborators

65− --github-token=""

66−```

67−

68−To allow a user to log in with their username even if they do not belong to the specified org and team or collaborators:

69−

70−```shell

71− # allow logins by username, comma separated

72− --github-user=""

73−```

74−

75−If you are using GitHub enterprise, make sure you set the following to the appropriate url:

76−

77−```shell

78− --login-url="http(s)://<enterprise github host>/login/oauth/authorize"

79− --redeem-url="http(s)://<enterprise github host>/login/oauth/access_token"

80− --validate-url="http(s)://<enterprise github host>/api/v3"

81−```

docs/docs/configuration/providers/gitlab.mddeleted−49

@@ -1,49 +0,0 @@

1−---

2−id: gitlab

3−title: GitLab

4−---

5−

6−## Config Options

7−

8−| Flag | Toml Field | Type | Description | Default |

9−| ------------------- | ----------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |

10−| `--gitlab-group` | `gitlab_groups` | string \| list | restrict logins to members of any of these groups (slug), separated by a comma | |

11−| `--gitlab-project` | `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 | |

12−

13−## Usage

14−

15−This auth provider has been tested against Gitlab version 12.X. Due to Gitlab API changes, it may not work for version

16−prior to 12.X (see [994](https://github.com/oauth2-proxy/oauth2-proxy/issues/994)).

17−

18−Whether you are using GitLab.com or self-hosting GitLab, follow

19−[these steps to add an application](https://docs.gitlab.com/integration/oauth_provider/). Make sure to enable at

20−least the `openid`, `profile` and `email` scopes, and set the redirect url to your application url e.g.

21−https://myapp.com/oauth2/callback.

22−

23−If you need projects filtering, add the extra `read_api` scope to your application.

24−

25−The following config should be set to ensure that the oauth will work properly. To get a cookie secret follow

26−[these steps](../overview.md#generating-a-cookie-secret)

27−

28−```

29− --provider="gitlab"

30− --redirect-url="https://myapp.com/oauth2/callback" // Should be the same as the redirect url for the application in gitlab

31− --client-id=GITLAB_CLIENT_ID

32− --client-secret=GITLAB_CLIENT_SECRET

33− --cookie-secret=COOKIE_SECRET

34−```

35−

36−Restricting by group membership is possible with the following option:

37−

38−```shell

39− --gitlab-group="mygroup,myothergroup" # restrict logins to members of any of these groups (slug), separated by a comma

40−```

41−

42−If you are using self-hosted GitLab, make sure you set the following to the appropriate URL:

43−

44−```shell

45− --oidc-issuer-url="<your gitlab url>"

46−```

47−

48−If your self-hosted GitLab is on a subdirectory (e.g. domain.tld/gitlab), as opposed to its own subdomain

49−(e.g. gitlab.domain.tld), you may need to add a redirect from domain.tld/oauth pointing at e.g. domain.tld/gitlab/oauth.

docs/docs/configuration/providers/google.mddeleted−84

@@ -1,84 +0,0 @@

1−---

2−id: google

3−title: Google (default)

4−---

5−

6−## Config Options

7−

8−| Flag | Toml Field | Type | Description | Default |

9−|-------------------------------------------------|----------------------------------------------| ------ |---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|

10−| `--google-admin-email` | `google_admin_email` | string | the google admin to impersonate for api calls | |

11−| `--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. | |

12−| `--google-service-account-json` | `google_service_account_json` | string | the path to the service account json credentials | |

13−| `--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) | |

14−| `--google-target-principal` | `google_target_principal` | bool | the target principal to impersonate when using ADC | defaults to the service account configured for ADC |

15−| `--google-use-organization-id` | `google_use_organization_id` | bool | use organization id as preferred username | false |

16−| `--google-admin-api-user-scope` | `google_admin_api_user_scope` | string | the OAuth scope to use when querying the Google Admin SDK for organization id, can be 'readonly', 'user' or 'cloud'<br/> | `readonly` |

17−

18−## Usage

19−

20−For Google, the registration steps are:

21−

22−1. Create a new project: https://console.developers.google.com/project

23−2. Choose the new project from the top right project dropdown (only if another project is selected)

24−3. In the project Dashboard center pane, choose **"APIs & Services"**

25−4. In the left Nav pane, choose **"Credentials"**

26−5. In the center pane, choose **"OAuth consent screen"** tab. Fill in **"Product name shown to users"** and hit save.

27−6. In the center pane, choose **"Credentials"** tab.

28− - Open the **"New credentials"** drop down

29− - Choose **"OAuth client ID"**

30− - Choose **"Web application"**

31− - Application name is freeform, choose something appropriate

32− - Authorized JavaScript origins is your domain ex: `https://internal.yourcompany.com`

33− - Authorized redirect URIs is the location of oauth2/callback ex: `https://internal.yourcompany.com/oauth2/callback`

34− - Choose **"Create"**

35−7. Take note of the **Client ID** and **Client Secret**

36−

37−It's recommended to refresh sessions on a short interval (1h) with `cookie-refresh` setting which validates that the

38−account is still authorized.

39−

40−#### Restrict auth to specific Google groups on your domain. (optional)

41−

42−1. Create a [service account](https://developers.google.com/identity/protocols/oauth2/service-account) and configure it

43− to use [Application Default Credentials / Workload Identity / Workload Identity Federation (recommended)](#using-application-default-credentials-adc--workload-identity--workload-identity-federation-recommended) or,

44− alternatively download the JSON.

45−2. Make note of the Client ID for a future step.

46−3. Under "APIs & Auth", choose APIs.

47−4. Click on Admin SDK and then Enable API.

48−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)

49− and give the client id from step 2 the following oauth scopes:

50−

51− ```

52− https://www.googleapis.com/auth/admin.directory.group.member.readonly

53− ```

54−

55−6. Follow the steps on https://support.google.com/a/answer/60757 to enable Admin API access.

56−7. Create or choose an existing administrative email address on the Gmail domain to assign to the `google-admin-email`

57− flag. This email will be impersonated by this client to make calls to the Admin SDK. See the note on the link from

58− step 5 for the reason why.

59−8. Create or choose an existing email group and set that email to the `google-group` flag. You can pass multiple instances

60− of this flag with different groups and the user will be checked against all the provided groups.

61−

62−(Only if using a JSON file (see step 1))

63−

64−9. Lock down the permissions on the json file downloaded from step 1 so only oauth2-proxy is able to read the file and

65− set the path to the file in the `google-service-account-json` flag.

66−10. Restart oauth2-proxy.

67−

68−Note: The user is checked against the group members list on initial authentication and every time the token is

69−refreshed ( about once an hour ).

70−

71−##### Using Application Default Credentials (ADC) / Workload Identity / Workload Identity Federation (recommended)

72−oauth2-proxy can make use of [Application Default Credentials](https://cloud.google.com/docs/authentication/application-default-credentials).

73−When deployed within GCP, this means that it can automatically use the service account attached to the resource. When deployed to GKE, ADC

74−can be leveraged through a feature called Workload Identity. Follow Google's [guide](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity)

75−to set up Workload Identity.

76−

77−When deployed outside of GCP, [Workload Identity Federation](https://cloud.google.com/docs/authentication/provide-credentials-adc#wlif) might be an option.

78−

79−##### Using Organization ID as Preferred Username (optional)

80−By default, the google provider uses the google id as username. If you would like to use an organization id instead, you can set the `google-use-organization-id` flag to true.

81−This requires that the service account used to query the Google Admin SDK has one of the following scopes granted in step 5 above:

82−- `https://www.googleapis.com/auth/admin.directory.user.readonly`,

83−- `https://www.googleapis.com/auth/admin.directory.user`

84−- `https://www.googleapis.com/auth/cloud-platform`

docs/docs/configuration/providers/index.mddeleted−48

@@ -1,48 +0,0 @@

1−---

2−id: index

3−title: OAuth Provider Configuration

4−---

5−

6−You will need to register an OAuth application with a Provider (Google, GitHub or another provider), and configure it

7−with Redirect URI(s) for the domain you intend to run `oauth2-proxy` on.

8−

9−Valid providers are :

10−

11−- [ADFS](adfs.md)

12−- [Atlassian Cloud](atlassian.md)

13−- [Bitbucket](bitbucket.md)

14−- [Cidaas](cidaas.md)

15−- [CiscoDuo](cisco_duo.md)

16−- [DigitalOcean](digitalocean.md)

17−- [DTT SSO](dtt_sso.md)

18−- [Facebook](facebook.md)

19−- [Gitea](gitea.md)

20−- [GitHub](github.md)

21−- [GitLab](gitlab.md)

22−- [Google](google.md) _default_

23−- [Keycloak](keycloak.md) (Deprecated)

24−- [Keycloak OIDC](keycloak_oidc.md)

25−- [LinkedIn](linkedin.md)

26−- [login.gov](login_gov.md)

27−- [Microsoft Azure](ms_azure_ad.md) (Deprecated)

28−- [Microsoft Entra ID](ms_entra_id.md)

29−- [Nextcloud](nextcloud.md)

30−- [OpenID Connect](openid_connect.md)

31−- [SourceHut](sourcehut.md)

32−

33−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).

34−

35−Please note that not all providers support all claims. The `preferred_username` claim is currently only supported by the

36−OpenID Connect provider.

37−

38−## Email Authentication

39−

40−To authorize a specific email-domain use `--email-domain=yourcompany.com`. To authorize individual email addresses use

41−`--authenticated-emails-file=/path/to/file` with one email per line. To authorize all email addresses use `--email-domain=*`.

42−

43−## Adding a new Provider

44−

45−Follow the examples in the [`providers` package](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/providers/) to define a new

46−`Provider` instance. Add a new `case` to

47−[`providers.New()`](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/providers/providers.go) to allow `oauth2-proxy` to use the

48−new `Provider`.

docs/docs/configuration/providers/keycloak.mddeleted−36

@@ -1,36 +0,0 @@

1−---

2−id: keycloak

3−title: Keycloak (Deprecated)

4−---

5−

6−:::note

7−This is the legacy and deprecated provider for Keycloak, use [Keycloak OIDC Auth Provider](keycloak_oidc.md) if possible.

8−:::

9−

10−1. Create new client in your Keycloak realm with **Access Type** 'confidential' and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'

11−2. Take note of the Secret in the credential tab of the client

12−3. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.

13−

14−Make sure you set the following to the appropriate url:

15−

16−```

17− --provider=keycloak

18− --client-id=<client you have created>

19− --client-secret=<your client's secret>

20− --login-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/auth"

21− --redeem-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/token"

22− --profile-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/userinfo"

23− --validate-url="http(s)://<keycloak host>/auth/realms/<your realm>/protocol/openid-connect/userinfo"

24− --keycloak-group=<first_allowed_user_group>

25− --keycloak-group=<second_allowed_user_group>

26−```

27−

28−For group based authorization, the optional `--keycloak-group` (legacy) or `--allowed-group` (global standard)

29−flags can be used to specify which groups to limit access to.

30−

31−If these are unset but a `groups` mapper is set up above in step (3), the provider will still

32−populate the `X-Forwarded-Groups` header to your upstream server with the `groups` data in the

33−Keycloak userinfo endpoint response.

34−

35−The group management in keycloak is using a tree. If you create a group named admin in keycloak

36−you should define the 'keycloak-group' value to /admin.

docs/docs/configuration/providers/keycloak_oidc.mddeleted−151

@@ -1,151 +0,0 @@

1−---

2−id: keycloak_oidc

3−title: Keycloak OIDC

4−---

5−

6−## Config Options

7−

8−| Flag | Toml Field | Type | Description | Default |

9−| ---------------- | --------------- | -------------- | ------------------------------------------------------------------------------------------------------------------ | ------- |

10−| `--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. | |

11−

12−## Usage

13−

14−```

15− --provider=keycloak-oidc

16− --client-id=<your client's id>

17− --client-secret=<your client's secret>

18− --redirect-url=https://internal.yourcompany.com/oauth2/callback

19− --oidc-issuer-url=https://<keycloak host>/realms/<your realm> // For Keycloak versions <17: --oidc-issuer-url=https://<keycloak host>/auth/realms/<your realm>

20− --email-domain=<yourcompany.com> // Validate email domain for users, see option documentation

21− --allowed-role=<realm role name> // Optional, required realm role

22− --allowed-role=<client id>:<client role name> // Optional, required client role

23− --allowed-group=</group name> // Optional, requires group client scope

24− --code-challenge-method=S256 // PKCE

25−```

26−

27−:::note

28−Keycloak has updated its admin console and as of version 19.0.0, the new admin console is enabled by default. The

29−legacy admin console has been announced for removal with the release of version 21.0.0.

30−:::

31−

32−**Keycloak legacy admin console**

33−

34−1. Create new client in your Keycloak realm with **Access Type** 'confidential', **Client protocol** 'openid-connect'

35− and **Valid Redirect URIs** 'https://internal.yourcompany.com/oauth2/callback'

36−2. Take note of the Secret in the credential tab of the client

37−3. Create a mapper with **Mapper Type** 'Group Membership' and **Token Claim Name** 'groups'.

38−4. Create a mapper with **Mapper Type** 'Audience' and **Included Client Audience** and **Included Custom Audience** set

39− to your client name.

40−

41−**Keycloak new admin console (default as of v19.0.0)**

42−

43−The following example shows how to create a simple OIDC client using the new Keycloak admin2 console. However, for best

44−practices, it is recommended to consult the Keycloak documentation.

45−

46−The OIDC client must be configured with an _audience mapper_ to include the client's name in the `aud` claim of the JWT token.

47−The `aud` claim specifies the intended recipient of the token, and OAuth2 Proxy expects a match against the values of

48−either `--client-id` or `--oidc-extra-audience`.

49−

50−_In Keycloak, claims are added to JWT tokens through the use of mappers at either the realm level using "client scopes" or

51−through "dedicated" client mappers._

52−

53−**Creating the client**

54−

55−1. Create a new OIDC client in your Keycloak realm by navigating to:

56− **Clients** -> **Create client**

57− * **Client Type** 'OpenID Connect'

58− * **Client ID** `<your client's id>`, please complete the remaining fields as appropriate and click **Next**.

59− * **Client authentication** 'On'

60− * **Authentication flow**

61− * **Standard flow** 'selected'

62− * **Direct access grants** 'deselect'

63− * _Save the configuration._

64− * **Settings / Access settings**:

65− * **Valid redirect URIs** `https://internal.yourcompany.com/oauth2/callback`

66− * _Save the configuration._

67− * Under the **Credentials** tab you will now be able to locate `<your client's secret>`.

68−2. Configure a dedicated *audience mapper* for your client by navigating to **Clients** -> **\<your client's id\>** -> **Client scopes**.

69−* Access the dedicated mappers pane by clicking **\<your client's id\>-dedicated**, located under *Assigned client scope*.

70− _(It should have a description of "Dedicated scope and mappers for this client")_

71− * Click **Configure a new mapper** and select **Audience**

72− * **Name** 'aud-mapper-\<your client's id\>'

73− * **Included Client Audience** select `<your client's id>` from the dropdown.

74− * _OAuth2 proxy can be set up to pass both the access and ID JWT tokens to your upstream services.

75− If you require additional audience entries, you can use the **Included Custom Audience** field in addition

76− to the "Included Client Audience" dropdown. Note that the "aud" claim of a JWT token should be limited and

77− only specify its intended recipients._

78− * **Add to ID token** 'On'

79− * **Add to access token** 'On' - [#1916](https://github.com/oauth2-proxy/oauth2-proxy/pull/1916)

80− * _Save the configuration._

81−* Any subsequent dedicated client mappers can be defined by clicking **Dedicated scopes** -> **Add mapper** ->

82− **By configuration** -> *Select mapper*

83−

84−You should now be able to create a test user in Keycloak and get access to the OAuth2 Proxy instance, make sure to set

85−an email address matching `<yourcompany.com>` and select _Email verified_.

86−

87−**Authorization**

88−

89−_OAuth2 Proxy will perform authorization by requiring a valid user, this authorization can be extended to take into

90−account a user's membership in Keycloak `groups`, `realm roles`, and `client roles` using the keycloak-oidc provider options

91−`--allowed-role` or `--allowed-group`_

92−

93−**Roles**

94−

95−_A standard Keycloak installation comes with the required mappers for **realm roles** and **client roles** through the

96−pre-defined client scope "roles". This ensures that any roles assigned to a user are included in the `JWT` tokens when

97−using an OIDC client that has the "Full scope allowed" feature activated, the feature is enabled by default._

98−

99−_Creating a realm role_

100−* Navigate to **Realm roles** -> **Create role**

101− * **Role name**, *`<realm role name>`* -> **save**

102−

103−_Creating a client role_

104−* Navigate to **Clients** -> `<your client's id>` -> **Roles** -> **Create role**

105− * **Role name**, *`<client role name>`* -> **save**

106−

107−

108−_Assign a role to a user_

109−

110−**Users** -> _Username_ -> **Role mapping** -> **Assign role** -> _filter by roles or clients and select_ -> **Assign**.

111−

112−Keycloak "realm roles" can be authorized using the `--allowed-role=<realm role name>` option, while "client roles" can be

113−evaluated using `--allowed-role=<your client's id>:<client role name>`.

114−

115−You may limit the _realm roles_ included in the JWT tokens for any given client by navigating to:

116−**Clients** -> `<your client's id>` -> **Client scopes** -> _\<your client's id\>-dedicated_ -> **Scope**

117−Disabling **Full scope allowed** activates the **Assign role** option, allowing you to select which roles, if assigned

118−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

119−want to reduce the size and impact of the JWT token.

120−

121−

122−**Groups**

123−

124−You may also do authorization on group memberships by using the OAuth2 Proxy option `--allowed-group`.

125−We will only do a brief description of creating the required _client scope_ **groups** and refer you to read the Keycloak

126−documentation.

127−

128−To summarize, the steps required to authorize Keycloak group membership with OAuth2 Proxy are as follows:

129−

130−* Create a new Client Scope with the name **groups** in Keycloak.

131− * Include a mapper of type **Group Membership**.

132− * Set the "Token Claim Name" to **groups** or customize by matching it to the `--oidc-groups-claim` option of OAuth2 Proxy.

133− * If the "Full group path" option is selected, you need to include a "/" separator in the group names defined in the

134− `--allowed-group` option of OAuth2 Proxy. Example: "/groupname" or "/groupname/child_group".

135−

136−After creating the _Client Scope_ named _groups_ you will need to attach it to your client.

137−**Clients** -> `<your client's id>` -> **Client scopes** -> **Add client scope** -> Select **groups** and choose Optional

138−and you should now have a client that maps group memberships into the JWT tokens so that Oauth2 Proxy may evaluate them.

139−

140−Create a group by navigating to **Groups** -> **Create group** and _add_ your test user as a member.

141−

142−The OAuth2 Proxy option `--allowed-group=/groupname` will now allow you to filter on group membership

143−

144−Keycloak also has the option of attaching roles to groups, please refer to the Keycloak documentation for more information.

145−

146−**Tip**

147−

148−To check if roles or groups are added to JWT tokens, you can preview a users token in the Keycloak console by following

149−these steps: **Clients** -> `<your client's id>` -> **Client scopes** -> **Evaluate**.

150−Select a _realm user_ and optional _scope parameters_ such as groups, and generate the JSON representation of an access

151−or id token to examine its contents.

docs/docs/configuration/providers/linkedin.mddeleted−13

@@ -1,13 +0,0 @@

1−---

2−id: linkedin

3−title: LinkedIn

4−---

5−

6−For LinkedIn, the registration steps are:

7−

8−1. Create a new project: https://www.linkedin.com/secure/developer

9−2. In the OAuth User Agreement section:

10− - In default scope, select r_basicprofile and r_emailaddress.

11− - In "OAuth 2.0 Redirect URLs", enter `https://internal.yourcompany.com/oauth2/callback`

12−3. Fill in the remaining required fields and Save.

13−4. Take note of the **Consumer Key / API Key** and **Consumer Secret / Secret Key**

docs/docs/configuration/providers/login_gov.mddeleted−79

@@ -1,79 +0,0 @@

1−---

2−id: login_gov

3−title: Login.gov

4−---

5−

6−login.gov is an OIDC provider for the US Government.

7−If you are a US Government agency, you can contact the login.gov team through the contact information

8−that you can find on https://login.gov/developers/ and work with them to understand how to get login.gov

9−accounts for integration/test and production access.

10−

11−A developer guide is available here: https://developers.login.gov/, though this proxy handles everything

12−but the data you need to create to register your application in the login.gov dashboard.

13−

14−As a demo, we will assume that you are running your application that you want to secure locally on

15−http://localhost:3000/, that you will be starting your proxy up on http://localhost:4180/, and that

16−you have an agency integration account for testing.

17−

18−First, register your application in the dashboard. The important bits are:

19−* Identity protocol: make this `Openid connect`

20−* Issuer: do what they say for OpenID Connect. We will refer to this string as `${LOGINGOV_ISSUER}`.

21−* Public key: This is a self-signed certificate in .pem format generated from a 2048-bit RSA private key.

22− A quick way to do this is

23− `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'`.

24− The contents of the `key.pem` shall be referred to as `${OAUTH2_PROXY_JWT_KEY}`.

25−* Return to App URL: Make this be `http://localhost:4180/`

26−* Redirect URIs: Make this be `http://localhost:4180/oauth2/callback`.

27−* Attribute Bundle: Make sure that email is selected.

28−

29−Now start the proxy up with the following options:

30−```

31−./oauth2-proxy -provider login.gov \

32− -client-id=${LOGINGOV_ISSUER} \

33− -redirect-url=http://localhost:4180/oauth2/callback \

34− -oidc-issuer-url=https://idp.int.identitysandbox.gov/ \

35− -cookie-secure=false \

36− -email-domain=gsa.gov \

37− -upstream=http://localhost:3000/ \

38− -cookie-secret=somerandomstring12341234567890AB \

39− -cookie-domain=localhost \

40− -skip-provider-button=true \

41− -pubjwk-url=https://idp.int.identitysandbox.gov/api/openid_connect/certs \

42− -profile-url=https://idp.int.identitysandbox.gov/api/openid_connect/userinfo \

43− -jwt-key="${OAUTH2_PROXY_JWT_KEY}"

44−```

45−You can also set all these options with environment variables, for use in cloud/docker environments.

46−One tricky thing that you may encounter is that some cloud environments will pass in environment

47−variables in a docker env-file, which does not allow multiline variables like a PEM file.

48−If you encounter this, then you can create a `jwt_signing_key.pem` file in the top level

49−directory of the repo which contains the key in PEM format and then do your docker build.

50−The docker build process will copy that file into your image which you can then access by

51−setting the `OAUTH2_PROXY_JWT_KEY_FILE=/etc/ssl/private/jwt_signing_key.pem`

52−environment variable, or by setting `--jwt-key-file=/etc/ssl/private/jwt_signing_key.pem` on the commandline.

53−

54−Once it is running, you should be able to go to `http://localhost:4180/` in your browser,

55−get authenticated by the login.gov integration server, and then get proxied on to your

56−application running on `http://localhost:3000/`. In a real deployment, you would secure

57−your application with a firewall or something so that it was only accessible from the

58−proxy, and you would use real hostnames everywhere.

59−

60−#### Skip OIDC discovery

61−

62−Some providers do not support OIDC discovery via their issuer URL, so oauth2-proxy cannot simply grab the authorization,

63−token and jwks URI endpoints from the provider's metadata.

64−

65−In this case, you can set the `--skip-oidc-discovery` option, and supply those required endpoints manually:

66−

67−```

68− -provider oidc

69− -client-id oauth2-proxy

70− -client-secret proxy

71− -redirect-url http://127.0.0.1:4180/oauth2/callback

72− -oidc-issuer-url http://127.0.0.1:5556

73− -skip-oidc-discovery

74− -login-url http://127.0.0.1:5556/authorize

75− -redeem-url http://127.0.0.1:5556/token

76− -oidc-jwks-url http://127.0.0.1:5556/keys

77− -cookie-secure=false

78− -email-domain example.com

79−```

docs/docs/configuration/providers/ms_azure_ad.mddeleted−59

@@ -1,59 +0,0 @@

1−---

2−id: azure

3−title: Azure (Deprecated)

4−---

5−

6−:::note

7−This is the legacy and deprecated provider for Azure, use [Microsoft Entra ID](ms_entra_id.md) if possible.

8−:::

9−

10−## Config Options

11−

12−| Flag | Toml Field | Type | Description | Default |

13−| ---------------- | -------------- | ------ | ---------------------------------------------------------------- | ---------- |

14−| `--azure-tenant` | `azure_tenant` | string | go to a tenant-specific or common (tenant-independent) endpoint. | `"common"` |

15−| `--resource` | `resource` | string | The resource that is protected (Azure AD only) | |

16−

17−## Usage

18−

19−1. Add an application: go to [https://portal.azure.com](https://portal.azure.com), choose **Azure Active Directory**, select

20− **App registrations** and then click on **New registration**.

21−2. Pick a name, check the supported account type(single-tenant, multi-tenant, etc). In the **Redirect URI** section create a new

22− **Web** platform entry for each app that you want to protect by the oauth2 proxy(e.g.

23− https://internal.yourcompanycom/oauth2/callback). Click **Register**.

24−3. Next we need to add group read permissions for the app registration, on the **API Permissions** page of the app, click on

25− **Add a permission**, select **Microsoft Graph**, then select **Application permissions**, then click on **Group** and select

26− **Group.Read.All**. Hit **Add permissions** and then on **Grant admin consent** (you might need an admin to do this).

27− <br/>**IMPORTANT**: Even if this permission is listed with **"Admin consent required=No"** the consent might actually

28− be required, due to AAD policies you won't be able to see. If you get a **"Need admin approval"** during login,

29− most likely this is what you're missing!

30−4. Next, if you are planning to use v2.0 Azure Auth endpoint, go to the **Manifest** page and set `"accessTokenAcceptedVersion": 2`

31− in the App registration manifest file.

32−5. On the **Certificates & secrets** page of the app, add a new client secret and note down the value after hitting **Add**.

33−6. Configure the proxy with:

34−- for V1 Azure Auth endpoint (Azure Active Directory Endpoints - https://login.microsoftonline.com/common/oauth2/authorize)

35−

36−```

37− --provider=azure

38− --client-id=<application ID from step 3>

39− --client-secret=<value from step 5>

40− --azure-tenant={tenant-id}

41− --oidc-issuer-url=https://sts.windows.net/{tenant-id}/

42−```

43−

44−- for V2 Azure Auth endpoint (Microsoft Identity Platform Endpoints - https://login.microsoftonline.com/common/oauth2/v2.0/authorize)

45−```

46− --provider=azure

47− --client-id=<application ID from step 3>

48− --client-secret=<value from step 5>

49− --azure-tenant={tenant-id}

50− --oidc-issuer-url=https://login.microsoftonline.com/{tenant-id}/v2.0

51−```

52−

53−***Notes***:

54−- When using v2.0 Azure Auth endpoint (`https://login.microsoftonline.com/{tenant-id}/v2.0`) as `--oidc_issuer_url`, in conjunction

55− with `--resource` flag, be sure to append `/.default` at the end of the resource name. See

56− https://docs.microsoft.com/en-us/azure/active-directory/develop/v2-permissions-and-consent#the-default-scope for more details.

57−- When using the Azure Auth provider with nginx and the cookie session store you may find the cookie is too large and doesn't

58− get passed through correctly. Increasing the proxy_buffer_size in nginx or implementing the

59− [redis session storage](../sessions.md#redis-storage) should resolve this.

docs/docs/configuration/providers/ms_entra_id.mddeleted−201

@@ -1,201 +0,0 @@

1−---

2−id: ms_entra_id

3−title: Microsoft Entra ID

4−---

5−

6−Provider for Microsoft Entra ID. Fully compliant with OIDC, with support for group overage and multi-tenant apps.

7−

8−## Config Options

9−

10−The provider is OIDC-compliant, so all the OIDC parameters are honored. Additional provider-specific configuration parameters are:

11−

12−| Flag | Toml Field | Type | Description | Default |

13−| --------------------------- | -------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- |

14−| `--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). | |

15−| `--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 |

16−

17−## Configure App registration

18−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.

19−

20−<details>

21− <summary>See Azure Portal example</summary>

22− <div class="videoBlock">

23− <iframe src="https://www.youtube.com/embed/IUNfxhOzr4E"></iframe>

24− </div>

25−</details>

26−

27−<details>

28− <summary>See Terraform example</summary>

29−```

30− resource "azuread_application" "auth" {

31− display_name = "oauth2-proxy"

32− sign_in_audience = "AzureADMyOrg" # Others are also supported

33−

34− web {

35− redirect_uris = [

36− "https://podinfo.lakis.tech/oauth2/callback",

37− ]

38− }

39− // We don't specify any required API permissions - we allow user consent only

40− }

41−

42− resource "azuread_service_principal" "sp" {

43− client_id = azuread_application.auth.client_id

44− app_role_assignment_required = false

45− }

46−

47− resource "azuread_service_principal_password" "pass" {

48− service_principal_id = azuread_service_principal.sp.id

49− }

50−

51−```

52−</details>

53−

54−### Configure groups

55−If you want to make use of groups, you can configure *groups claim* to be present in ID Tokens issued by the App registration.

56−<details>

57− <summary>See Azure Portal example</summary>

58− <div class="videoBlock">

59− <div class="videoBlock">

60− <iframe src="https://www.youtube.com/embed/QZmP5MKEJis"></iframe>

61− </div>

62− </div>

63−</details>

64−<details>

65− <summary>See Terraform example</summary>

66−```

67− resource "azuread_application" "auth" {

68− display_name = "oauth2-proxy"

69− sign_in_audience = "AzureADMyOrg"

70−

71− group_membership_claims = [

72− "SecurityGroup"

73− ]

74−

75− web {

76− redirect_uris = [

77− "https://podinfo.lakis.tech/oauth2/callback",

78− ]

79− }

80− }

81−

82− resource "azuread_service_principal" "sp" {

83− client_id = azuread_application.auth.client_id

84− app_role_assignment_required = false

85− }

86−

87− resource "azuread_service_principal_password" "pass" {

88− service_principal_id = azuread_service_principal.sp.id

89− }

90−

91−```

92−</details>

93−

94−### Scopes and claims

95−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)).

96−

97−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.

98−

99−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).

100−

101−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.

102−

103−For personal microsoft accounts, required scope is `openid profile email`.

104−

105−See: [Overview of permissions and consent in the Microsoft identity platform](https://learn.microsoft.com/en-us/entra/identity-platform/permissions-consent-overview).

106−

107−### Multi-tenant apps

108−To authenticate apps from multiple tenants (including personal Microsoft accounts), set the common OIDC issuer url and disable verification:

109−```toml

110−oidc_issuer_url=https://login.microsoftonline.com/common/v2.0

111−insecure_oidc_skip_issuer_verification=true

112−```

113−`insecure_oidc_skip_issuer_verification` setting is required to disable following checks:

114−* 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).

115−* 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).

116−

117−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.

118−

119−### Workload Identity

120−Provider supports authentication with federated token, without need of using client secret. Following conditions have to be met:

121−

122−* 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`.

123−* 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).

124−* Appropriate federated credential is added to application registration.

125−<details>

126− <summary>See federated credential terraform example</summary>

127−```

128− resource "azuread_application_federated_identity_credential" "fedcred" {

129− application_id = azuread_application.application.id # ID of your application

130− display_name = "federation-cred"

131− description = "Workload identity for oauth2-proxy"

132− audiences = ["api://AzureADTokenExchange"] # Fixed value

133− issuer = "https://cluster-oidc-issuer-url..."

134− subject = "system:serviceaccount:oauth2-proxy-namespace-name:oauth2-proxy-sa-name" # set proper NS and SA name

135− }

136−```

137−</details>

138−

139−* Kubernetes service account associated with oauth2-proxy deployment, is annotated with `azure.workload.identity/client-id: <app-registration-client-id>`

140−* oauth2-proxy pod is labeled with `azure.workload.identity/use: "true"`

141−* oauth2-proxy is configured with `entra_id_federated_token_auth` set to `true`.

142−

143−`client_secret` setting can be omitted when using federated token authentication.

144−

145−See: [Azure Workload Identity documentation](https://azure.github.io/azure-workload-identity/docs/).

146−

147−### Example configurations

148−Single-tenant app without groups (*groups claim* not enabled). Consider using generic OIDC provider:

149−```toml

150−provider="entra-id"

151−oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"

152−client_id="<client-id>"

153−client_secret="<client-secret>"

154−scope="openid"

155−```

156−

157−Single-tenant app with up to 200 groups (*groups claim* enabled). Consider using generic OIDC provider:

158−```toml

159−provider="entra-id"

160−oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"

161−client_id="<client-id>"

162−client_secret="<client-secret>"

163−scope="openid"

164−allowed_groups=["ac51800c-2679-4ecb-8130-636380a3b491"]

165−```

166−

167−Single-tenant app with more than 200 groups:

168−```toml

169−provider="entra-id"

170−oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"

171−client_id="<client-id>"

172−client_secret="<client-secret>"

173−scope="openid User.Read"

174−allowed_groups=["968b4844-d5e7-4e18-a834-59927959369f"]

175−```

176−

177−Single-tenant app with more than 200 groups and workload identity enabled:

178−```toml

179−provider="entra-id"

180−oidc_issuer_url="https://login.microsoftonline.com/<tenant-id>/v2.0"

181−client_id="<client-id>"

182−scope="openid User.Read"

183−allowed_groups=["968b4844-d5e7-4e18-a834-59927959369f"]

184−entra_id_federated_token_auth=true

185−```

186−

187−Multi-tenant app with Microsoft personal accounts & one Entra tenant allowed, with group overage considered:

188−```toml

189−provider="entra-id"

190−oidc_issuer_url="https://login.microsoftonline.com/common/v2.0"

191−client_id="<client-id>"

192−client_secret="<client-secret>"

193−insecure_oidc_skip_issuer_verification=true

194−scope="openid profile email User.Read"

195−entra_id_allowed_tenants=["9188040d-6c67-4c5b-b112-36a304b66dad","<my-tenant-id>"] # Allow only <my-tenant-id> and Personal MS Accounts tenant

196−email_domains="*"

197−```

198−

199−## Kubernetes Dashboard Integration

200−

201−For a complete guide on integrating oauth2-proxy with Kubernetes Dashboard on AKS using Azure Entra ID authentication, including detailed configuration examples, RBAC setup, troubleshooting, and Workload Identity setup, see the [Kubernetes Dashboard integration guide](../integrations/kubernetes-dashboard.md).

docs/docs/configuration/providers/nextcloud.mddeleted−28

@@ -1,28 +0,0 @@

1−---

2−id: nextcloud

3−title: NextCloud

4−---

5−

6−The Nextcloud provider allows you to authenticate against users in your

7−Nextcloud instance.

8−

9−When you are using the Nextcloud provider, you must specify the urls via

10−configuration, environment variable, or command line argument. Depending

11−on whether your Nextcloud instance is using pretty urls your urls may be of the

12−form `/index.php/apps/oauth2/*` or `/apps/oauth2/*`.

13−

14−Refer to the [OAuth2

15−documentation](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/oauth2.html)

16−to set up the client id and client secret. Your "Redirection URI" will be

17−`https://internalapp.yourcompany.com/oauth2/callback`.

18−

19−```

20− -provider nextcloud

21− -client-id <from nextcloud admin>

22− -client-secret <from nextcloud admin>

23− -login-url="<your nextcloud url>/index.php/apps/oauth2/authorize"

24− -redeem-url="<your nextcloud url>/index.php/apps/oauth2/api/v1/token"

25− -validate-url="<your nextcloud url>/ocs/v2.php/cloud/user?format=json"

26−```

27−

28−Note: in *all* cases the validate-url will *not* have the `index.php`.

docs/docs/configuration/providers/openid_connect.mddeleted−146

@@ -1,146 +0,0 @@

1−---

2−id: openid_connect

3−title: OpenID Connect

4−---

5−

6−OpenID Connect is a spec for OAUTH 2.0 + identity that is implemented by many major providers and several open source projects.

7−

8−This provider was originally built against CoreOS Dex, and we will use it as an example.

9−The OpenID Connect Provider (OIDC) can also be used to connect to other Identity Providers such as Okta, an example can be found below.

10−

11−#### Dex

12−

13−To configure the OIDC provider for Dex, perform the following steps:

14−

15−1. Download Dex:

16−

17− ```

18− go get github.com/dexidp/dex

19− ```

20−

21− See the [getting started guide](https://dexidp.io/docs/getting-started/) for more details.

22−

23−2. Setup oauth2-proxy with the correct provider and using the default ports and callbacks. Add a configuration block to

24− the `staticClients` section of `examples/config-dev.yaml`:

25−

26− ```

27− - id: oauth2-proxy

28− redirectURIs:

29− - 'http://127.0.0.1:4180/oauth2/callback'

30− name: 'oauth2-proxy'

31− secret: proxy

32− ```

33−

34−3. Launch Dex: from `$GOPATH/github.com/dexidp/dex`, run:

35−

36− ```

37− bin/dex serve examples/config-dev.yaml

38− ```

39−

40−4. In a second terminal, run the oauth2-proxy with the following args:

41−

42− ```shell

43− --provider oidc

44− --provider-display-name "My OIDC Provider"

45− --client-id oauth2-proxy

46− --client-secret proxy

47− --redirect-url http://127.0.0.1:4180/oauth2/callback

48− --oidc-issuer-url http://127.0.0.1:5556/dex

49− --cookie-secure=false

50− --cookie-secret=secret

51− --email-domain kilgore.trout

52− ```

53−

54− To serve the current working directory as a website under the `/static` endpoint, add:

55−

56− ```shell

57− --upstream file://$PWD/#/static/

58− ```

59−

60−5. Test the setup by visiting http://127.0.0.1:4180 or http://127.0.0.1:4180/static .

61−

62−See also [our local testing environment](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/contrib/local-environment) for a self-contained example using Docker and etcd as storage for Dex.

63−

64−#### Okta

65−

66−To configure the OIDC provider for Okta, perform the following steps:

67−

68−1. Log in to Okta using an administrative account. It is suggested you try this in preview first, `example.oktapreview.com`

69−2. (OPTIONAL) If you want to configure authorization scopes and claims to be passed on to multiple applications,

70− you may wish to configure an authorization server for each application. Otherwise, the provided `default` will work.

71− * Navigate to **Security** then select **API**

72− * Click **Add Authorization Server**, if this option is not available you may require an additional license for a custom

73− authorization server.

74− * Fill out the **Name** with something to describe the application you are protecting. e.g. 'Example App'.

75− * For **Audience**, pick the URL of the application you wish to protect: https://example.corp.com

76− * Fill out a **Description**

77− * Add any **Access Policies** you wish to configure to limit application access.

78− * The default settings will work for other options.

79− [See Okta documentation for more information on Authorization Servers](https://developer.okta.com/docs/guides/customize-authz-server/overview/)

80−3. Navigate to **Applications** then select **Add Application**.

81− * Select **Web** for the **Platform** setting.

82− * Select **OpenID Connect** and click **Create**

83− * Pick an **Application Name** such as `Example App`.

84− * Set the **Login redirect URI** to `https://example.corp.com`.

85− * Under **General** set the **Allowed grant types** to `Authorization Code` and `Refresh Token`.

86− * Leave the rest as default, taking note of the `Client ID` and `Client Secret`.

87− * Under **Assignments** select the users or groups you wish to access your application.

88−4. Create a configuration file like the following:

89−

90− ```

91− provider = "oidc"

92− redirect_url = "https://example.corp.com/oauth2/callback"

93− oidc_issuer_url = "https://corp.okta.com/oauth2/abCd1234"

94− upstreams = [

95− "https://example.corp.com"

96− ]

97− email_domains = [

98− "corp.com"

99− ]

100− client_id = "XXXXX"

101− client_secret = "YYYYY"

102− pass_access_token = true

103− cookie_secret = "ZZZZZ"

104− skip_provider_button = true

105− ```

106−

107−The `oidc_issuer_url` is based on URL from your **Authorization Server**'s **Issuer** field in step 2, or simply

108−https://corp.okta.com. The `client_id` and `client_secret` are configured in the application settings.

109−Generate a unique `cookie_secret` to encrypt the cookie.

110−

111−Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/example.cfg`

112−

113−#### Okta - localhost

114−

115−1. Signup for developer account: https://developer.okta.com/signup/

116−2. Create New `Web` Application: https://$\{your-okta-domain\}/dev/console/apps/new

117−3. Example Application Settings for localhost:

118− * **Name:** My Web App

119− * **Base URIs:** http://localhost:4180/

120− * **Login redirect URIs:** http://localhost:4180/oauth2/callback

121− * **Logout redirect URIs:** http://localhost:4180/

122− * **Group assignments:** `Everyone`

123− * **Grant type allowed:** `Authorization Code` and `Refresh Token`

124−4. Make note of the `Client ID` and `Client secret`, they are needed in a future step

125−5. Make note of the **default** Authorization Server Issuer URI from: https://$\{your-okta-domain\}/admin/oauth2/as

126−6. Example config file `/etc/localhost.cfg`

127− ```shell

128− provider = "oidc"

129− redirect_url = "http://localhost:4180/oauth2/callback"

130− oidc_issuer_url = "https://$\{your-okta-domain\}/oauth2/default"

131− upstreams = [

132− "http://0.0.0.0:8080"

133− ]

134− email_domains = [

135− "*"

136− ]

137− client_id = "XXX"

138− client_secret = "YYY"

139− pass_access_token = true

140− cookie_secret = "ZZZ"

141− cookie_secure = false

142− skip_provider_button = true

143− # Note: use the following for testing within a container

144− # http_address = "0.0.0.0:4180"

145− ```

146−7. Then you can start the oauth2-proxy with `./oauth2-proxy --config /etc/localhost.cfg`

docs/docs/configuration/providers/sourcehut.mddeleted−25

@@ -1,25 +0,0 @@

1−---

2−id: sourcehut

3−title: SourceHut

4−---

5−

6−1. Create a new OAuth client: https://meta.sr.ht/oauth2

7−2. Under `Redirection URI` enter the correct URL, i.e.

8− `https://internal.yourcompany.com/oauth2/callback`

9−

10−To use the provider, start with `--provider=sourcehut`.

11−

12−If you are hosting your own SourceHut instance, make sure you set the following

13−to the appropriate URLs:

14−

15−```shell

16− --login-url="https://<meta.your.instance>/oauth2/authorize"

17− --redeem-url="https://<meta.your.instance>/oauth2/access-token"

18− --profile-url="https://<meta.your.instance>/query"

19− --validate-url="https://<meta.your.instance>/profile"

20−```

21−

22−The default configuration allows everyone with an account to authenticate.

23−Restricting access is currently only supported by

24−[email](index.md#email-authentication).

25−

docs/docs/configuration/sessions.md+4−36

@@ -32,7 +32,7 @@ users to re-authenticate

32

32

33### Redis Storage

33### Redis Storage

34

34

35−The Redis Storage backend stores encrypted sessions in redis. Instead of sending all the information

35+The Redis Storage backend stores sessions, encrypted, in redis. Instead sending all the information

36back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

36back the client for storage, as in the [Cookie storage](#cookie-storage), a ticket is sent back

37to the user as the cookie value instead.

37to the user as the cookie value instead.

38

38

@@ -43,42 +43,14 @@ A ticket is composed as the following:

43Where:

43Where:

44

44

45- The `CookieName` is the OAuth2 cookie name (_oauth2_proxy by default)

45- The `CookieName` is the OAuth2 cookie name (_oauth2_proxy by default)

46−- The `ticketID` is a 128-bit random number, hex-encoded

46+- The `ticketID` is a 128 bit random number, hex-encoded

47−- The `secret` is a 128-bit random number, base64url encoded (no padding). The secret is unique for every session.

47+- The `secret` is a 128 bit random number, base64url encoded (no padding). The secret is unique for every session.

48- The pair of `{CookieName}-{ticketID}` comprises a ticket handle, and thus, the redis key

48- The pair of `{CookieName}-{ticketID}` comprises a ticket handle, and thus, the redis key

49to which the session is stored. The encoded session is encrypted with the secret and stored

49to which the session is stored. The encoded session is encrypted with the secret and stored

50in redis via the `SETEX` command.

50in redis via the `SETEX` command.

51

51

52Encrypting every session uniquely protects the refresh/access/id tokens stored in the session from

52Encrypting every session uniquely protects the refresh/access/id tokens stored in the session from

53−disclosure. Additionally, the browser only has to send a short Cookie with every request and not the whole JWT,

53+disclosure.

54−which can get quite big.

55−

56−Two settings are used to configure the OAuth2 Proxy cookie lifetime:

57−

58− --cookie-refresh duration refresh the cookie after this duration; 0 to disable

59− --cookie-expire duration expire timeframe for cookie 168h0m0s

60−

61−The "cookie-expire" value should be equal to the lifetime of the Refresh-Token that is issued by the OAuth2 authorization server.

62−If it expires earlier and is deleted by the browser, OAuth2 Proxy cannot find the stored Refresh-Tokens in Redis and thus cannot start

63−the refresh flow to get a new Access-Token. If it is longer, it might be that the old Refresh-Token will be found in Redis but has already

64−expired.

65−

66−The "cookie-refresh" value controls when OAuth2 Proxy tries to refresh an Access-Token. If it is set to "0", the

67−Access-Token will never be refreshed, even if it is already expired and a valid Refresh-Token is available. If set, OAuth2 Proxy will

68−refresh the Access-Token after this many seconds whether it is still valid or not. According to the official OAuth2.0 specification

69−Access-Tokens are not required to follow a specific format. Therefore OAuth2 Proxy cannot check for any expiry date without an

70−introspection endpoint. If an Access-Token expires and you have not set a corresponding "cookie-refresh" value, you will likely

71−encounter expiry issues.

72−

73−Caveat: It can happen that the Access-Token is valid for e.g. "1m" and a request happens after exactly "59s".

74−It would pass OAuth2 Proxy and be forwarded to the backend but is just expired when the backend tries to validate

75−it. This is especially relevant if the backend uses the JWT to make requests to other backends.

76−For this reason, it's advised to set the cookie-refresh a couple of seconds less than the Access-Token lifespan.

77−

78−Recommended settings:

79−

80−* cookie_refresh := Access-Token lifespan - 1m

81−* cookie_expire := Refresh-Token lifespan (i.e. Keycloak client_session_idle)

82

54

83#### Usage

55#### Usage

84

56

@@ -93,7 +65,3 @@ Redis Cluster is available to be the backend store as well. To leverage it, you

93`--redis-use-cluster=true` flag, and configure the flags `--redis-cluster-connection-urls` appropriately.

65`--redis-use-cluster=true` flag, and configure the flags `--redis-cluster-connection-urls` appropriately.

94

66

95Note that flags `--redis-use-sentinel=true` and `--redis-use-cluster=true` are mutually exclusive.

67Note that flags `--redis-use-sentinel=true` and `--redis-use-cluster=true` are mutually exclusive.

96−

97−Note, if Redis timeout option is set to non-zero, the `--redis-connection-idle-timeout`

98−must be less than [Redis timeout option](https://redis.io/docs/reference/clients/#client-timeouts). For example: if either redis.conf includes

99−`timeout 15` or using `CONFIG SET timeout 15` the `--redis-connection-idle-timeout` must be at least `--redis-connection-idle-timeout=14`

docs/docs/configuration/systemd_socket.mddeleted−51

@@ -1,51 +0,0 @@

1−---

2−id: systemd_socket

3−title: Systemd Socket Activation

4−---

5−

6−Pass an existing listener created by systemd.socket to oauth2-proxy.

7−

8−To do this create a socket:

9−

10−oauth2-proxy.socket

11−```

12−[Socket]

13−ListenStream=%t/oauth2.sock

14−SocketGroup=www-data

15−SocketMode=0660

16−```

17−

18−Now it's possible to call this socket from e.g. nginx:

19−```

20−server {

21− location /oauth2/ {

22− proxy_pass http://unix:/run/oauth2-proxy/oauth2.sock;

23−}

24−```

25−

26−The oauth2-proxy should have `--http-address=fd:3` as a parameter.

27−Here fd is case insensitive and means file descriptor. The number 3 refers to the first non-stdin/stdout/stderr file descriptor,

28−systemd-socket-activate (which is what systemd.socket uses), listens to what it is told and passes

29−the listener it created onto the process, starting with file descriptor 3.

30−

31−```

32−./oauth2-proxy \

33− --http-address="fd:3" \

34− --email-domain="yourcompany.com" \

35− --upstream=http://127.0.0.1:8080/ \

36− --cookie-secret=... \

37− --cookie-secure=true \

38− --provider=... \

39− --client-id=... \

40− --client-secret=...

41−```

42−

43−## Trusted IPs

44−

45−When listening on a Unix socket, Go sets `http.Request.RemoteAddr` to `"@"` instead of the usual `"host:port"` format. This means there is no client IP available from the connection itself.

46−

47−As a result, `--trusted-ip` entries cannot match against the direct connection address for Unix socket listeners. Requests arriving over a Unix socket will never be considered "trusted" based on their `RemoteAddr`. IP-based trust decisions will still work if a trusted reverse proxy sets `X-Forwarded-For` or `X-Real-IP` headers and `--reverse-proxy=true` is configured.

48−

49−## TLS

50−

51−Currently TLS is not supported (but it's doable).

docs/docs/configuration/tls.md+4−19

@@ -3,11 +3,7 @@ id: tls

3title: TLS Configuration

3title: TLS Configuration

4---

4---

5

5

6−There are two recommended configurations:

6+There are two recommended configurations.

7−- [At OAuth2 Proxy](#terminate-tls-at-oauth2-proxy)

8−- [At Reverse Proxy](#terminate-tls-at-reverse-proxy-eg-nginx)

9−

10−### Terminate TLS at OAuth2 Proxy

11

7

121. Configure SSL Termination with OAuth2 Proxy by providing a `--tls-cert-file=/path/to/cert.pem` and `--tls-key-file=/path/to/cert.key`.

81. Configure SSL Termination with OAuth2 Proxy by providing a `--tls-cert-file=/path/to/cert.pem` and `--tls-key-file=/path/to/cert.key`.

13

9

@@ -26,19 +22,7 @@ There are two recommended configurations:

26 --client-secret=...

22 --client-secret=...

27 ```

23 ```

28

24

29−2. With this configuration approach the customization of the TLS settings is limited.

30−

31− The minimal acceptable TLS version can be set with `--tls-min-version=TLS1.3`.

32− The defaults set `TLS1.2` as the minimal version.

33− Regardless of the minimum version configured, `TLS1.3` is currently always used as the maximal version.

34−

35− TLS server side cipher suites can be specified with `--tls-cipher-suite=TLS_RSA_WITH_RC4_128_SHA`.

36− If not specified, the defaults from [`crypto/tls`](https://pkg.go.dev/crypto/tls#CipherSuites) of the currently used `go` version for building `oauth2-proxy` will be used.

37− A complete list of valid TLS cipher suite names can be found in [`crypto/tls`](https://pkg.go.dev/crypto/tls#pkg-constants).

38−

39−### Terminate TLS at Reverse Proxy, e.g. Nginx

40−

41−1. Configure SSL Termination with [Nginx](http://nginx.org/) (example config below), Amazon ELB, Google Cloud Platform Load Balancing, or ...

25+2. Configure SSL Termination with [Nginx](http://nginx.org/) (example config below), Amazon ELB, Google Cloud Platform Load Balancing, or ....

42

26

43 Because `oauth2-proxy` listens on `127.0.0.1:4180` by default, to listen on all interfaces (needed when using an

27 Because `oauth2-proxy` listens on `127.0.0.1:4180` by default, to listen on all interfaces (needed when using an

44 external load balancer like Amazon ELB or Google Platform Load Balancing) use `--http-address="0.0.0.0:4180"` or

28 external load balancer like Amazon ELB or Google Platform Load Balancing) use `--http-address="0.0.0.0:4180"` or

@@ -63,6 +47,7 @@ There are two recommended configurations:

63 proxy_pass http://127.0.0.1:4180;

47 proxy_pass http://127.0.0.1:4180;

64 proxy_set_header Host $host;

48 proxy_set_header Host $host;

65 proxy_set_header X-Real-IP $remote_addr;

49 proxy_set_header X-Real-IP $remote_addr;

50+ proxy_set_header X-Scheme $scheme;

66 proxy_connect_timeout 1;

51 proxy_connect_timeout 1;

67 proxy_send_timeout 30;

52 proxy_send_timeout 30;

68 proxy_read_timeout 30;

53 proxy_read_timeout 30;

@@ -70,7 +55,7 @@ There are two recommended configurations:

70 }

55 }

71 ```

56 ```

72

57

73−2. The command line to run `oauth2-proxy` in this configuration would look like this:

58+ The command line to run `oauth2-proxy` in this configuration would look like this:

74

59

75 ```bash

60 ```bash

76 ./oauth2-proxy \

61 ./oauth2-proxy \

docs/docs/features/endpoints.md+4−41

@@ -5,22 +5,19 @@ title: Endpoints

5

5

6OAuth2 Proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated. The `/oauth2` prefix can be changed with the `--proxy-prefix` config variable.

6OAuth2 Proxy responds directly to the following endpoints. All other endpoints will be proxied upstream when authenticated. The `/oauth2` prefix can be changed with the `--proxy-prefix` config variable.

7

7

8−- / - the proxy endpoint provides authentication and returns the appropriate 40x error if not authenticated or authorized then passes the request upstream.

9- /robots.txt - returns a 200 OK response that disallows all User-agents from all paths; see [robotstxt.org](http://www.robotstxt.org/) for more info

8- /robots.txt - returns a 200 OK response that disallows all User-agents from all paths; see [robotstxt.org](http://www.robotstxt.org/) for more info

10- /ping - returns a 200 OK response, which is intended for use with health checks

9- /ping - returns a 200 OK response, which is intended for use with health checks

11−- /ready - returns a 200 OK response if all the underlying connections (e.g., Redis store) are connected

12- /metrics - Metrics endpoint for Prometheus to scrape, serve on the address specified by `--metrics-address`, disabled by default

10- /metrics - Metrics endpoint for Prometheus to scrape, serve on the address specified by `--metrics-address`, disabled by default

13−- /oauth2/sign_in - the login page, which also doubles as a sign-out page (it clears cookies)

11+- /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies)

14- /oauth2/sign_out - this URL is used to clear the session cookie

12- /oauth2/sign_out - this URL is used to clear the session cookie

15- /oauth2/start - a URL that will redirect to start the OAuth cycle

13- /oauth2/start - a URL that will redirect to start the OAuth cycle

16- /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.

14- /oauth2/callback - the URL used at the end of the OAuth cycle. The oauth app will be configured with this as the callback url.

17- /oauth2/userinfo - the URL is used to return user's email from the session in JSON format.

15- /oauth2/userinfo - the URL is used to return user's email from the session in JSON format.

18−- /oauth2/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](../configuration/integrations/nginx)

16+- /oauth2/auth - only returns a 202 Accepted response or a 401 Unauthorized response; for use with the [Nginx `auth_request` directive](../configuration/overview.md#configuring-for-use-with-the-nginx-auth_request-directive)

19−- /oauth2/static/\* - stylesheets and other dependencies used in the sign_in and error pages

20

17

21### Sign out

18### Sign out

22

19

23−To sign the user out, redirect them to `/oauth2/sign_out`. This endpoint only removes oauth2-proxy's own cookies, i.e. the user is still logged in with the authentication provider and may automatically re-login when accessing the application again. You will also need to redirect the user to the authentication provider's sign-out page afterward using the `rd` query parameter, i.e. redirect the user to something like (notice the url-encoding!):

20+To sign the user out, redirect them to `/oauth2/sign_out`. This endpoint only removes oauth2-proxy's own cookies, i.e. the user is still logged in with the authentication provider and may automatically re-login when accessing the application again. You will also need to redirect the user to the authentication provider's sign out page afterwards using the `rd` query parameter, i.e. redirect the user to something like (notice the url-encoding!):

24

21

25```

22```

26/oauth2/sign_out?rd=https%3A%2F%2Fmy-oidc-provider.example.com%2Fsign_out_page

23/oauth2/sign_out?rd=https%3A%2F%2Fmy-oidc-provider.example.com%2Fsign_out_page

@@ -36,38 +33,4 @@ X-Auth-Request-Redirect: https://my-oidc-provider/sign_out_page

36

33

37(The "sign_out_page" should be the [`end_session_endpoint`](https://openid.net/specs/openid-connect-session-1_0.html#rfc.section.2.1) from [the metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) if your OIDC provider supports Session Management and Discovery.)

34(The "sign_out_page" should be the [`end_session_endpoint`](https://openid.net/specs/openid-connect-session-1_0.html#rfc.section.2.1) from [the metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) if your OIDC provider supports Session Management and Discovery.)

38

35

39−BEWARE that the domain you want to redirect to (`my-oidc-provider.example.com` in the example) must be added to the [`--whitelist-domain`](../configuration/overview) configuration option otherwise the redirect will be ignored. Make sure to include the actual domain and port (if needed) and not the URL (e.g "localhost:8081" instead of "http://localhost:8081").

36+BEWARE that the domain you want to redirect to (`my-oidc-provider.example.com` in the example) must be added to the [`--whitelist-domain`](../configuration/overview) configuration option otherwise the redirect will be ignored.

40−

41−ID Token can be injected in the redirect url by using `{id_token}` placeholder. For example to redirect to `https://my-oidc-provider.example.com/sign_out_page?id_token_hint={id_token}&post_logout_redirect_uri=https://my-app.example.com`;

42−

43−```

44−/oauth2/sign_out?rd=https%3A%2F%2Fmy-oidc-provider.example.com%2Fsign_out_page%3Fid_token_hint%3D%7Bid_token%7D%26post_logout_redirect_uri%3Dhttps%3A%2F%2Fmy-app.example.com

45−```

46−

47−or alternatively in the header:

48−

49−```

50−GET /oauth2/sign_out HTTP/1.1

51−X-Auth-Request-Redirect: https://my-oidc-provider.example.com/sign_out_page?id_token_hint={id_token}&post_logout_redirect_uri=https://my-app.example.com

52−...

53−```

54−

55−### Auth

56−

57−This endpoint returns 202 Accepted response or a 401 Unauthorized response.

58−

59−It can be configured using the following query parameters:

60−- `allowed_groups`: comma separated list of allowed groups

61−- `allowed_email_domains`: comma separated list of allowed email domains

62−- `allowed_emails`: comma separated list of allowed emails

63−

64−### Proxy (/)

65−

66−This endpoint returns the upstream response if authenticated.

67−If unauthenticated it returns a 401 Unauthorized. If the authenticatd user

68−is not in one of the allowed groups, or emails then it returns a 403 forbidden

69−

70−It can be configured using the following query parameters:

71−- `allowed_groups`: comma separated list of allowed groups

72−- `allowed_email_domains`: comma separated list of allowed email domains

73−- `allowed_emails`: comma separated list of allowed emails

docs/docs/installation.md+12−18

@@ -1,32 +1,26 @@

1---

1---

2id: installation

2id: installation

3title: Installation

3title: Installation

4+slug: /

4---

5---

5

6

61. Choose how to deploy:

71. Choose how to deploy:

7

8

8− a. Using a [Prebuilt Binary](https://github.com/oauth2-proxy/oauth2-proxy/releases) (current release is `v7.15.4`)

9+ a. Download [Prebuilt Binary](https://github.com/oauth2-proxy/oauth2-proxy/releases) (current release is `v7.1.3`)

9

10

10− b. Using Go to install the latest release

11− ```bash

12− $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest

11+ b. Build with `$ go get github.com/oauth2-proxy/oauth2-proxy/v7` which will put the binary in `$GOPATH/bin`

13− ```

14− This will install the binary into `$GOPATH/bin`. Make sure you include `$GOPATH` in your `$PATH`. Otherwise your system won't find binaries installed via `go install`

15

12

16− c. Using a [Prebuilt Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, PPC64LE, S390x, ARMv6, ARMv7, and ARM64 available)

13+ c. Using the prebuilt docker image [quay.io/oauth2-proxy/oauth2-proxy](https://quay.io/oauth2-proxy/oauth2-proxy) (AMD64, ARMv6 and ARM64 tags available)

17

14

18− d. Using a [Pre-Release Nightly Docker Image](https://quay.io/oauth2-proxy/oauth2-proxy-nightly) (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)

15+ d. Using a [Kubernetes manifest](https://github.com/oauth2-proxy/manifests) (Helm)

19

16

20− e. Using the official [Kubernetes manifest](https://github.com/oauth2-proxy/manifests) (Helm)

17+Prebuilt binaries can be validated by extracting the file and verifying it against the `sha256sum.txt` checksum file provided for each release starting with version `v3.0.0`.

21

18

22− Prebuilt binaries can be validated by extracting the file and verifying it against the `sha256sum.txt` checksum file provided for each release starting with version `v3.0.0`.

23−

24− ```

19+```

25− $ sha256sum -c sha256sum.txt

20+$ sha256sum -c sha256sum.txt

26− oauth2-proxy-x.y.z.linux-amd64: OK

21+oauth2-proxy-x.y.z.linux-amd64: OK

27− ```

22+```

28

23

29−2. [Select a Provider and Register an OAuth Application with a Provider](configuration/providers/index.md)

24+2. [Select a Provider and Register an OAuth Application with a Provider](configuration/auth.md)

303. [Configure OAuth2 Proxy using config file, command line options, or environment variables](configuration/overview.md)

253. [Configure OAuth2 Proxy using config file, command line options, or environment variables](configuration/overview.md)

31−4. [Configure SSL or Deploy behind an SSL endpoint](configuration/tls.md) (example provided for Nginx)

26+4. [Configure SSL or Deploy behind a SSL endpoint](configuration/tls.md) (example provided for Nginx)

32−5. [Configure OAuth2 Proxy using systemd.socket](configuration/systemd_socket.md) (example provided for Nginx/Systemd)

docs/docs/welcome.mddeleted−33

@@ -1,33 +0,0 @@

1−---

2−id: welcome

3−title: Welcome

4−hide_table_of_contents: true

5−slug: /

6−---

7−

8−

9−

10−A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others)

11−to validate accounts by email, domain or group.

12−

13−:::note

14−This repository was forked from [bitly/OAuth2_Proxy](https://github.com/bitly/oauth2_proxy) on 27/11/2018.

15−Versions v3.0.0 and up are from this fork and will have diverged from any changes in the original fork.

16−A list of changes can be seen in the [CHANGELOG](https://github.com/oauth2-proxy/oauth2-proxy/blob/master/CHANGELOG.md).

17−:::

18−

19−

20−

21−## Architecture

22−

23−

24−

25−

26−## Cloud Native Computing Foundation

27−

28−OAuth2 Proxy is a [Cloud Native Computing Foundation](https://cncf.io) Sandbox project.

29−

30−

31−

32−The Linux Foundation® (TLF) has registered trademarks and uses trademarks. For a list of TLF trademarks, see [Trademark Usage](https://www.linuxfoundation.org/legal/trademark-usage).

33−

docs/docusaurus.config.js+37−111

@@ -1,131 +1,57 @@

1−// @ts-check

1+module.exports = {

2−// `@type` JSDoc annotations allow editor autocompletion and type checking

3−// (when paired with `@ts-check`).

4−// There are various equivalent ways to declare your Docusaurus config.

5−// See: https://docusaurus.io/docs/api/docusaurus-config

6−

7−import { themes as prismThemes } from 'prism-react-renderer';

8−

9−/** @type {import('@docusaurus/types').Config} */

10−const config = {

11 title: 'OAuth2 Proxy',

2 title: 'OAuth2 Proxy',

12 tagline: 'A lightweight authentication proxy written in Go',

3 tagline: 'A lightweight authentication proxy written in Go',

13− favicon: 'img/logos/OAuth2_Proxy_icon.svg',

14−

15− // Set the production url of your site here

16 url: 'https://oauth2-proxy.github.io',

4 url: 'https://oauth2-proxy.github.io',

17− // Set the /<baseUrl>/ pathname under which your site is served

18− // For GitHub pages deployment, it is often '/<projectName>/'

19 baseUrl: '/oauth2-proxy/',

5 baseUrl: '/oauth2-proxy/',

20−

6+ onBrokenLinks: 'throw',

21− // GitHub pages deployment config.

7+ favicon: 'img/logos/OAuth2_Proxy_icon.svg',

22− // If you aren't using GitHub pages, you don't need these.

23 organizationName: 'oauth2-proxy', // Usually your GitHub org/user name.

8 organizationName: 'oauth2-proxy', // Usually your GitHub org/user name.

24 projectName: 'oauth2-proxy', // Usually your repo name.

9 projectName: 'oauth2-proxy', // Usually your repo name.

25−

10+ themeConfig: {

26− onBrokenLinks: 'throw',

11+ navbar: {

27− onBrokenMarkdownLinks: 'warn',

12+ title: 'OAuth2 Proxy',

28−

13+ logo: {

29− // Even if you don't use internationalization, you can use this field to set

14+ alt: 'OAuth2 Proxy',

30− // useful metadata like html lang. For example, if your site is Chinese, you

15+ src: 'img/logos/OAuth2_Proxy_icon.svg',

31− // may want to replace "en" with "zh-Hans".

16+ },

32− i18n: {

17+ items: [

33− defaultLocale: 'en',

18+ {

34− locales: ['en'],

19+ to: 'docs/',

20+ activeBasePath: 'docs',

21+ label: 'Docs',

22+ position: 'left',

23+ },

24+ {

25+ type: 'docsVersionDropdown',

26+ position: 'right',

27+ dropdownActiveClassDisabled: true,

28+ },

29+ {

30+ href: 'https://github.com/oauth2-proxy/oauth2-proxy',

31+ label: 'GitHub',

32+ position: 'right',

33+ },

34+ ],

35+ },

36+ footer: {

37+ style: 'dark',

38+ copyright: `Copyright © ${new Date().getFullYear()} OAuth2 Proxy.`,

39+ },

35 },

40 },

36−

37 presets: [

41 presets: [

38 [

42 [

39− 'classic',

40− /** @type {import('@docusaurus/preset-classic').Options} */

43+ '@docusaurus/preset-classic',

41− ({

44+ {

42 docs: {

45 docs: {

43 sidebarPath: require.resolve('./sidebars.js'),

46 sidebarPath: require.resolve('./sidebars.js'),

44− routeBasePath: '/',

45 // Please change this to your repo.

47 // Please change this to your repo.

46− // Remove this to remove the "edit this page" links.

47 editUrl:

48 editUrl:

48 'https://github.com/oauth2-proxy/oauth2-proxy/edit/master/docs/',

49 'https://github.com/oauth2-proxy/oauth2-proxy/edit/master/docs/',

49 },

50 },

50− blog: false,

51 theme: {

51 theme: {

52− customCss: './src/css/custom.css',

52+ customCss: require.resolve('./src/css/custom.css'),

53 },

53 },

54− }),

54+ },

55 ],

55 ],

56 ],

56 ],

57−

58− themes: [

59− '@docusaurus/theme-mermaid',

60− [

61− require.resolve("@easyops-cn/docusaurus-search-local"),

62− /** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */

63− ({

64− hashed: true,

65− docsDir: "docs", // only index the latest docs

66− language: ["en"],

67− indexDocs: true,

68− indexBlog: false,

69− indexPages: false,

70− docsRouteBasePath: "/", // fix the default /docs path

71− searchResultLimits: 10,

72− searchBarShortcut: true,

73− removeDefaultStemmer: true, // allow for partial word matching

74− searchBarShortcutHint: true,

75− highlightSearchTermsOnTargetPage: true,

76− }),

77− ]

78− ],

79−

80− markdown: {

81− mermaid: true,

82− },

83−

84− themeConfig:

85− /** @type {import('@docusaurus/preset-classic').ThemeConfig} */

86− ({

87− // Replace with your project's social card

88− image: 'img/logos/OAuth2_Proxy_horizontal.png',

89− navbar: {

90− title: 'OAuth2 Proxy',

91− logo: {

92− alt: 'OAuth2 Proxy',

93− src: 'img/logos/OAuth2_Proxy_icon.svg',

94− },

95− items: [

96− {

97− type: 'docSidebar',

98− sidebarId: 'docs',

99− position: 'left',

100− label: 'Docs',

101− },

102− {

103− type: 'docsVersionDropdown',

104− position: 'right',

105− dropdownActiveClassDisabled: true,

106− },

107− {

108− href: 'https://cloud-native.slack.com/archives/C098Y5URZ2N',

109− label: 'Slack',

110− position: 'right',

111− },

112− {

113− href: 'https://github.com/oauth2-proxy/oauth2-proxy',

114− label: 'GitHub',

115− position: 'right',

116− },

117− ],

118− },

119− footer: {

120− style: 'dark',

121− copyright: `Copyright © ${new Date().getFullYear()} OAuth2 Proxy a Series of LF Projects, LLC.<br>For website terms of use, trademark policy and other project policies please see lfprojects.org/policies/`,

122− },

123− prism: {

124− theme: prismThemes.github,

125− darkTheme: prismThemes.dracula,

126− additionalLanguages: ['hcl', 'nginx', 'powershell'],

127− },

128− }),

129};

57};

130−

131−export default config;

docs/package-lock.jsonnew file+14114

This diff is too big to show here.

docs/package.json+12−28

This diff is too big to show here.

docs/sidebars.js+3−72

This diff is too big to show here.

docs/src/css/custom.css−14

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/welcome.md → docs/src/pages/index.mdrenamed+4−6

This diff is too big to show here.

docs/src/pages/styles.module.cssnew file+37

This diff is too big to show here.

docs/static/img/architecture.pngnew file

Binary file not shown.

docs/static/img/debug-tab.pngdeleted

Binary file not shown.

docs/static/img/sign-in-page.png

Binary file not shown.

docs/static/img/simplified-architecture.svgdeleted−4

This diff is too big to show here.

docs/versioned_docs/version-6.1.x/behaviour.mdnew file+11

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/community/security.md → docs/versioned_docs/version-6.1.x/community/security.mdrenamed+2−2

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/configuration/auth.md → docs/versioned_docs/version-6.1.x/configuration/auth.mdrenamed+76−183

This diff is too big to show here.

docs/versioned_docs/version-6.1.x/configuration/overview.mdnew file+412

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/configuration/sessions.md → docs/versioned_docs/version-6.1.x/configuration/sessions.mdrenamed

The content is the same.

docs/versioned_docs/version-7.2.x/configuration/tls.md → docs/versioned_docs/version-6.1.x/configuration/tls.mdrenamed

The content is the same.

docs/versioned_docs/version-7.2.x/features/endpoints.md → docs/versioned_docs/version-6.1.x/features/endpoints.mdrenamed−1

This diff is too big to show here.

docs/versioned_docs/version-6.1.x/features/request_signatures.mdnew file+20

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/installation.md → docs/versioned_docs/version-6.1.x/installation.mdrenamed+3−5

This diff is too big to show here.

docs/versioned_docs/version-7.0.x/behaviour.md+1−1

This diff is too big to show here.

docs/versioned_docs/version-7.0.x/configuration/auth.md+13−31

This diff is too big to show here.

docs/versioned_docs/version-7.0.x/configuration/overview.md+12−12

This diff is too big to show here.

docs/versioned_docs/version-7.1.x/behaviour.md+1−1

This diff is too big to show here.

docs/versioned_docs/version-7.1.x/configuration/auth.md+13−31

This diff is too big to show here.

docs/versioned_docs/version-7.1.x/configuration/overview.md+166−166

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/community/contribution.mddeleted−89

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/alpha_config.mddeleted−564

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/integration.mddeleted−386

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/overview.mddeleted−403

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/github.mddeleted−81

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/google.mddeleted−76

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/index.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.10.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/community/contribution.mddeleted−89

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/alpha_config.mddeleted−564

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/integration.mddeleted−386

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/overview.mddeleted−406

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/github.mddeleted−81

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/google.mddeleted−75

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/index.mddeleted−44

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/providers/sourcehut.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.11.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/community/contribution.mddeleted−89

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/alpha_config.mddeleted−565

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/integration.mddeleted−386

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/overview.mddeleted−407

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/cidaas.mddeleted−37

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/github.mddeleted−81

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/google.mddeleted−75

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/index.mddeleted−45

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/providers/sourcehut.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.12.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/community/contribution.mddeleted−91

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/alpha_config.mddeleted−568

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/integrations/caddy.mddeleted−63

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/integrations/headlamp.mddeleted−105

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/integrations/index.mddeleted−41

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/integrations/kubernetes-dashboard.mddeleted−289

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/integrations/nginx.mddeleted−174

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/integrations/traefik.mddeleted−192

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/overview.mddeleted−407

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/cidaas.mddeleted−37

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/cisco_duo.mddeleted−44

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/github.mddeleted−81

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/google.mddeleted−84

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/index.mddeleted−46

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/providers/sourcehut.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.13.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/community/contribution.mddeleted−91

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/alpha_config.mddeleted−637

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/alpha_config.md.tmpldeleted−218

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/integrations/caddy.mddeleted−63

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/integrations/headlamp.mddeleted−105

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/integrations/index.mddeleted−41

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/integrations/kubernetes-dashboard.mddeleted−289

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/integrations/nginx.mddeleted−174

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/integrations/traefik.mddeleted−192

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/overview.mddeleted−407

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/cidaas.mddeleted−37

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/cisco_duo.mddeleted−44

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/github.mddeleted−81

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/google.mddeleted−84

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/index.mddeleted−46

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/providers/sourcehut.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/features/endpoints.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.14.x/welcome.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/community/contribution.mddeleted−91

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/alpha_config.mddeleted−702

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/alpha_config.md.tmpldeleted−281

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/integrations/caddy.mddeleted−63

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/integrations/headlamp.mddeleted−105

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/integrations/index.mddeleted−41

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/integrations/kubernetes-dashboard.mddeleted−289

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/integrations/nginx.mddeleted−174

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/integrations/traefik.mddeleted−192

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/overview.mddeleted−451

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/cidaas.mddeleted−37

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/cisco_duo.mddeleted−44

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/github.mddeleted−81

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/google.mddeleted−84

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/index.mddeleted−46

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/ms_entra_id.mddeleted−201

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/providers/sourcehut.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/systemd_socket.mddeleted−51

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/features/endpoints.mddeleted−73

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.15.x/welcome.mddeleted−33

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/configuration/alpha_config.mddeleted−394

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/configuration/alpha_config.md.tmpldeleted−101

This diff is too big to show here.

docs/versioned_docs/version-7.2.x/configuration/overview.mddeleted−592

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/configuration/alpha_config.mddeleted−526

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/configuration/alpha_config.md.tmpldeleted−125

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/configuration/overview.mddeleted−597

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/configuration/sessions.mddeleted−67

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/features/endpoints.mddeleted−45

This diff is too big to show here.

docs/versioned_docs/version-7.3.x/installation.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/configuration/alpha_config.mddeleted−529

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/configuration/alpha_config.md.tmpldeleted−125

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/configuration/auth.mddeleted−593

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/configuration/overview.mddeleted−602

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/configuration/sessions.mddeleted−71

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/configuration/tls.mddeleted−86

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/features/endpoints.mddeleted−45

This diff is too big to show here.

docs/versioned_docs/version-7.4.x/installation.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/community/contribution.mddeleted−78

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/configuration/alpha_config.mddeleted−530

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/configuration/alpha_config.md.tmpldeleted−125

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/configuration/auth.mddeleted−707

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/configuration/overview.mddeleted−605

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/configuration/sessions.mddeleted−98

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/configuration/tls.mddeleted−86

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.5.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/community/contribution.mddeleted−78

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/alpha_config.mddeleted−548

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/integration.mddeleted−318

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/overview.mddeleted−391

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/azure.mddeleted−46

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/azure_ad.mddeleted−9

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/gitea.mddeleted−20

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/github.mddeleted−67

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/google.mddeleted−76

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/index.mddeleted−42

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/sessions.mddeleted−97

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/installation.mddeleted−31

This diff is too big to show here.

docs/versioned_docs/version-7.6.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/community/contribution.mddeleted−78

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/alpha_config.mddeleted−546

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/integration.mddeleted−318

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/overview.mddeleted−396

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/azure.mddeleted−55

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/azure_ad.mddeleted−18

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/gitea.mddeleted−20

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/github.mddeleted−67

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/google.mddeleted−76

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/index.mddeleted−42

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/installation.mddeleted−31

This diff is too big to show here.

docs/versioned_docs/version-7.7.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/community/contribution.mddeleted−89

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/alpha_config.mddeleted−563

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/integration.mddeleted−318

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/overview.mddeleted−401

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/github.mddeleted−67

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/google.mddeleted−76

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/index.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.8.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/behaviour.mddeleted−26

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/community/contribution.mddeleted−89

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/community/security.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/alpha_config.mddeleted−564

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/alpha_config.md.tmpldeleted−139

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/integration.mddeleted−318

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/overview.mddeleted−403

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/adfs.mddeleted−19

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/bitbucket.mddeleted−25

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/digitalocean.mddeleted−21

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/facebook.mddeleted−7

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/gitea.mddeleted−24

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/github.mddeleted−67

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/gitlab.mddeleted−49

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/google.mddeleted−76

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/index.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/keycloak.mddeleted−36

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/keycloak_oidc.mddeleted−151

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/linkedin.mddeleted−13

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/login_gov.mddeleted−79

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/ms_azure_ad.mddeleted−59

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/ms_entra_id.mddeleted−197

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/nextcloud.mddeleted−28

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/providers/openid_connect.mddeleted−146

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/sessions.mddeleted−99

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/systemd_socket.mddeleted−43

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/configuration/tls.mddeleted−85

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/features/endpoints.mddeleted−47

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/installation.mddeleted−32

This diff is too big to show here.

docs/versioned_docs/version-7.9.x/welcome.mddeleted−23

This diff is too big to show here.

docs/versioned_sidebars/version-6.1.x-sidebars.json+10−10

This diff is too big to show here.

docs/versioned_sidebars/version-7.0.x-sidebars.json+11−11

This diff is too big to show here.

docs/versioned_sidebars/version-7.1.x-sidebars.json+10−10

This diff is too big to show here.

docs/versioned_sidebars/version-7.10.x-sidebars.jsondeleted−83

This diff is too big to show here.

docs/versioned_sidebars/version-7.11.x-sidebars.jsondeleted−84

This diff is too big to show here.

docs/versioned_sidebars/version-7.12.x-sidebars.jsondeleted−84

This diff is too big to show here.

docs/versioned_sidebars/version-7.13.x-sidebars.jsondeleted−100

This diff is too big to show here.

docs/versioned_sidebars/version-7.14.x-sidebars.jsondeleted−100

This diff is too big to show here.

docs/versioned_sidebars/version-7.15.x-sidebars.jsondeleted−100

This diff is too big to show here.

docs/versioned_sidebars/version-7.2.x-sidebars.jsondeleted−61

This diff is too big to show here.

docs/versioned_sidebars/version-7.3.x-sidebars.jsondeleted−40

This diff is too big to show here.

docs/versioned_sidebars/version-7.4.x-sidebars.jsondeleted−40

This diff is too big to show here.

docs/versioned_sidebars/version-7.5.x-sidebars.jsondeleted−41

This diff is too big to show here.

docs/versioned_sidebars/version-7.6.x-sidebars.jsondeleted−83

This diff is too big to show here.

docs/versioned_sidebars/version-7.7.x-sidebars.jsondeleted−83

This diff is too big to show here.

docs/versioned_sidebars/version-7.8.x-sidebars.jsondeleted−83

This diff is too big to show here.

docs/versioned_sidebars/version-7.9.x-sidebars.jsondeleted−83

This diff is too big to show here.

docs/versions.json+2−15

This diff is too big to show here.

go.mod+34−76

This diff is too big to show here.

go.sum+634−233

This diff is too big to show here.

main.go+20−48

This diff is too big to show here.

main_suite_test.go+1−1

This diff is too big to show here.

main_test.go+58−180

This diff is too big to show here.

nsswitch.confnew file+1

This diff is too big to show here.

oauthproxy.go+123−435

This diff is too big to show here.

oauthproxy_test.go+98−1342

This diff is too big to show here.

pkg/apis/middleware/middleware_suite_test.go+1−1

This diff is too big to show here.

pkg/apis/middleware/scope.go+1−48

This diff is too big to show here.

pkg/apis/middleware/scope_test.go+1−35

This diff is too big to show here.

pkg/apis/middleware/session.go+5−11

This diff is too big to show here.

pkg/apis/options/alpha_options.go+16−25

This diff is too big to show here.

pkg/apis/options/common.gonew file+63

This diff is too big to show here.

pkg/apis/options/common_test.gonew file+88

This diff is too big to show here.

pkg/apis/options/cookie.go+19−51

This diff is too big to show here.

pkg/apis/options/cookie_test.godeleted−70

This diff is too big to show here.

pkg/apis/options/doc.go+1−2

This diff is too big to show here.

pkg/apis/options/header.go+9−54

This diff is too big to show here.

pkg/apis/options/hooks.godeleted−57

This diff is too big to show here.

pkg/apis/options/hooks_test.godeleted−96

This diff is too big to show here.

pkg/apis/options/legacy_options.go+85−215

This diff is too big to show here.

pkg/apis/options/legacy_options_test.go+63−209

This diff is too big to show here.

pkg/apis/options/load.go+28−99

This diff is too big to show here.

pkg/apis/options/load_test.go+29−79

This diff is too big to show here.

pkg/apis/options/logging.go+1−1

This diff is too big to show here.

pkg/apis/options/login_url_parameters.godeleted−102

This diff is too big to show here.

pkg/apis/options/options.go+48−85

This diff is too big to show here.

pkg/apis/options/options_suite_test.go+1−1

This diff is too big to show here.

pkg/apis/options/providers.go+73−315

This diff is too big to show here.

pkg/apis/options/secret_source.godeleted−19

This diff is too big to show here.

pkg/apis/options/server.go+7−29

This diff is too big to show here.

pkg/apis/options/sessions.go−2

This diff is too big to show here.

pkg/apis/options/testutil/options_matcher.godeleted−62

This diff is too big to show here.

pkg/apis/options/testutil/options_matcher_test.godeleted−70

This diff is too big to show here.

pkg/apis/options/upstreams.go+23−117

This diff is too big to show here.

pkg/apis/options/util/util.go+2−1

This diff is too big to show here.

pkg/apis/options/util/util_suite_test.go+1−1

This diff is too big to show here.

pkg/apis/options/util/util_test.go+4−3

This diff is too big to show here.

pkg/apis/sessions/interfaces.go−1

This diff is too big to show here.

pkg/apis/sessions/lock.go+4−4

This diff is too big to show here.

pkg/apis/sessions/session_state.go+16−38

This diff is too big to show here.

pkg/apis/sessions/session_state_test.go+19−110

This diff is too big to show here.

pkg/app/pagewriter/error.html+2−2

This diff is too big to show here.

pkg/app/pagewriter/error_page.go+3−1

This diff is too big to show here.

pkg/app/pagewriter/error_page_test.go+9−9

This diff is too big to show here.

pkg/app/pagewriter/pagewriter.go+4−4

This diff is too big to show here.

pkg/app/pagewriter/pagewriter_suite_test.go+1−1

This diff is too big to show here.

pkg/app/pagewriter/pagewriter_test.go+23−22

This diff is too big to show here.

pkg/app/pagewriter/sign_in.html+2−36

This diff is too big to show here.

pkg/app/pagewriter/sign_in_page.go+6−6

This diff is too big to show here.

pkg/app/pagewriter/sign_in_page_test.go+9−8

This diff is too big to show here.

pkg/app/pagewriter/static_pages_test.go+7−7

This diff is too big to show here.

pkg/app/pagewriter/templates_test.go+7−6

This diff is too big to show here.

pkg/app/redirect/director_test.go+14−45

This diff is too big to show here.

pkg/app/redirect/pagewriter_suite_test.go+1−1

This diff is too big to show here.

pkg/app/redirect/validator.go+58−4

This diff is too big to show here.

pkg/app/redirect/validator_test.go+4−21

This diff is too big to show here.

pkg/authentication/basic/basic_suite_test.go+1−1

This diff is too big to show here.

pkg/authentication/basic/htpasswd.go+23−90

This diff is too big to show here.

pkg/authentication/basic/htpasswd_test.go+2−83

This diff is too big to show here.

pkg/authentication/hmacauth/LICENSE.mddeleted−5

This diff is too big to show here.

pkg/authentication/hmacauth/hmacauth.godeleted−237

This diff is too big to show here.

pkg/authentication/hmacauth/hmacauth_test.godeleted−302

This diff is too big to show here.

pkg/clock/clock.gonew file+157

This diff is too big to show here.

pkg/providers/util/util_suite_test.go → pkg/clock/clock_suite_test.gorenamed+4−4

This diff is too big to show here.

pkg/clock/clock_test.gonew file+380

This diff is too big to show here.

pkg/cookies/cookies.go+6−21

This diff is too big to show here.

pkg/cookies/cookies_suite_test.go+8−5

This diff is too big to show here.

pkg/cookies/cookies_test.go+3−82

This diff is too big to show here.

pkg/cookies/csrf.go+42−172

This diff is too big to show here.

pkg/cookies/csrf_per_request_test.godeleted−278

This diff is too big to show here.

pkg/cookies/csrf_test.go+18−368

This diff is too big to show here.

pkg/encryption/cipher.go+2−2

This diff is too big to show here.

pkg/encryption/nonce.go+12−11

This diff is too big to show here.

pkg/encryption/utils.go+1−30

This diff is too big to show here.

pkg/encryption/utils_test.go−46

This diff is too big to show here.

pkg/header/header_suite_test.go+4−3

This diff is too big to show here.

pkg/header/injector.go+2−2

This diff is too big to show here.

pkg/header/injector_test.go+2−1

This diff is too big to show here.

pkg/http/http_suite_test.gonew file+88

This diff is too big to show here.

pkg/proxyhttp/server.go → pkg/http/server.gorenamed+7−118

This diff is too big to show here.

pkg/proxyhttp/server_group.go → pkg/http/server_group.gorenamed+1−1

This diff is too big to show here.

pkg/proxyhttp/server_group_test.go → pkg/http/server_group_test.gorenamed+2−2

This diff is too big to show here.

pkg/http/server_test.gonew file+472

This diff is too big to show here.

pkg/ip/parse_ip_net.go−16

This diff is too big to show here.

pkg/ip/parse_ip_net_test.godeleted−118

This diff is too big to show here.

pkg/ip/realclientip.go+2−15

This diff is too big to show here.

pkg/ip/realclientip_test.go−6

This diff is too big to show here.

pkg/middleware/basic_session_test.go+2−1

This diff is too big to show here.

pkg/middleware/headers.go+5−40

This diff is too big to show here.

pkg/middleware/headers_test.go+6−50

This diff is too big to show here.

pkg/middleware/healthcheck.go+4−7

This diff is too big to show here.

pkg/middleware/healthcheck_test.go+11−32

This diff is too big to show here.

pkg/middleware/jwt_session.go+10−16

This diff is too big to show here.

pkg/middleware/jwt_session_test.go+23−104

This diff is too big to show here.

pkg/middleware/metrics_test.go+2−1

This diff is too big to show here.

pkg/middleware/middleware_suite_test.go+1−1

This diff is too big to show here.

pkg/middleware/readynesscheck.godeleted−40

This diff is too big to show here.

pkg/middleware/readynesscheck_test.godeleted−83

This diff is too big to show here.

pkg/middleware/redirect_to_https_test.go+2−16

This diff is too big to show here.

pkg/middleware/request_logger_test.go+2−1

This diff is too big to show here.

pkg/middleware/scope.go+3−5

This diff is too big to show here.

pkg/middleware/scope_test.go+5−19

This diff is too big to show here.

pkg/middleware/session_utils_test.go+2−1

This diff is too big to show here.

pkg/middleware/stored_session.go+12−130

This diff is too big to show here.

pkg/middleware/stored_session_test.go+50−338

This diff is too big to show here.

pkg/providers/oidc/oidc_suite_test.godeleted−16

This diff is too big to show here.

pkg/providers/oidc/provider.godeleted−107

This diff is too big to show here.

pkg/providers/oidc/provider_test.godeleted−191

This diff is too big to show here.

pkg/providers/oidc/provider_verifier.godeleted−271

This diff is too big to show here.

pkg/providers/oidc/provider_verifier_test.godeleted−325

This diff is too big to show here.

pkg/providers/oidc/verifier.godeleted−109

This diff is too big to show here.

pkg/providers/oidc/verifier_test.godeleted−249

This diff is too big to show here.

pkg/providers/util/claim_extractor.godeleted−164

This diff is too big to show here.

pkg/providers/util/claim_extractor_test.godeleted−578

This diff is too big to show here.

pkg/proxyhttp/http_suite_test.godeleted−88

This diff is too big to show here.

pkg/proxyhttp/server_test.godeleted−1371

This diff is too big to show here.

pkg/proxyhttp/systemd_socket.godeleted−55

This diff is too big to show here.

pkg/proxyhttp/systemd_unsupported.godeleted−17

This diff is too big to show here.

pkg/requests/builder.go+4−3

This diff is too big to show here.

pkg/requests/builder_test.go+20−22

This diff is too big to show here.

pkg/requests/http.godeleted−31

This diff is too big to show here.

pkg/requests/requests_suite_test.go+3−3

This diff is too big to show here.

pkg/requests/result.go+3−3

This diff is too big to show here.

pkg/requests/result_test.go+5−4

This diff is too big to show here.

pkg/requests/util/util.go+11−45

This diff is too big to show here.

pkg/requests/util/util_suite_test.go+1−1

This diff is too big to show here.

pkg/requests/util/util_test.go+23−120

This diff is too big to show here.

pkg/sessions/cookie/session_store.go+24−50

This diff is too big to show here.

pkg/sessions/cookie/session_store_test.go+1−1

This diff is too big to show here.

pkg/sessions/persistence/interfaces.go−1

This diff is too big to show here.

pkg/sessions/persistence/manager.go−6

This diff is too big to show here.

pkg/sessions/persistence/manager_test.go+1−1

This diff is too big to show here.

pkg/sessions/persistence/persistence_suite_test.go+1−1

This diff is too big to show here.

pkg/sessions/persistence/ticket.go+28−90

This diff is too big to show here.

pkg/sessions/persistence/ticket_test.go+5−4

This diff is too big to show here.

pkg/sessions/redis/client.go+1−10

This diff is too big to show here.

pkg/sessions/redis/client_test.godeleted−159

This diff is too big to show here.

pkg/sessions/redis/lock.go+1−1

This diff is too big to show here.

pkg/sessions/redis/redis_store.go+17−95

This diff is too big to show here.

pkg/sessions/redis/redis_store_test.go+135−232

This diff is too big to show here.

pkg/sessions/redis/redis_store_tls_test.godeleted−169

This diff is too big to show here.

pkg/sessions/redis/redis_test.godeleted−68

This diff is too big to show here.

pkg/sessions/session_store_test.go+2−2

This diff is too big to show here.

pkg/sessions/tests/mock_lock.go+4−4

This diff is too big to show here.

pkg/sessions/tests/mock_store.go−4

This diff is too big to show here.

pkg/sessions/tests/session_store_tests.go+12−82

This diff is too big to show here.

pkg/upstream/file.go+5−39

This diff is too big to show here.

pkg/upstream/file_test.go+3−8

This diff is too big to show here.

pkg/upstream/http.go+35−133

This diff is too big to show here.

pkg/upstream/http_test.go+41−190

This diff is too big to show here.

pkg/upstream/proxy.go+20−21

This diff is too big to show here.

pkg/upstream/proxy_test.go+11−86

This diff is too big to show here.

pkg/upstream/rewrite.go−1

This diff is too big to show here.

pkg/upstream/rewrite_test.go+2−9

This diff is too big to show here.

pkg/upstream/static.go+11−3

This diff is too big to show here.

pkg/upstream/static_test.go+2−1

This diff is too big to show here.

pkg/upstream/upstream_suite_test.go+11−23

This diff is too big to show here.

pkg/util/ptr/ptr.godeleted−14

This diff is too big to show here.

pkg/util/ptr/ptr_test.godeleted−38

This diff is too big to show here.

pkg/util/util.go+4−236

This diff is too big to show here.

pkg/util/util_test.go+53−281

This diff is too big to show here.

pkg/validation/allowlist.go+14−37

This diff is too big to show here.

pkg/validation/allowlist_test.go+4−33

This diff is too big to show here.

pkg/validation/common_test.go+4−2

This diff is too big to show here.

pkg/validation/cookie.go+5−25

This diff is too big to show here.

pkg/validation/cookie_test.go+1−63

This diff is too big to show here.

pkg/validation/header.go+1−2

This diff is too big to show here.

pkg/validation/header_test.go+2−1

This diff is too big to show here.

pkg/validation/options.go+257−30

This diff is too big to show here.

pkg/validation/options_test.go+89−23

This diff is too big to show here.

pkg/validation/providers.go+21−114

This diff is too big to show here.

pkg/validation/providers_test.go+2−54

This diff is too big to show here.

pkg/validation/sessions.go+1−1

This diff is too big to show here.

pkg/validation/sessions_test.go+5−6

This diff is too big to show here.

pkg/validation/upstreams.go+9−11

This diff is too big to show here.

pkg/validation/upstreams_test.go+10−27

This diff is too big to show here.

pkg/validation/validation_suite_test.go+1−1

This diff is too big to show here.

pkg/watcher/watcher.godeleted−81

This diff is too big to show here.

providers/adfs.go+36−48

This diff is too big to show here.

providers/adfs_test.go+17−116

This diff is too big to show here.

providers/atlassian-cloud.godeleted−99

This diff is too big to show here.

providers/atlassian-cloud_test.godeleted−93

This diff is too big to show here.

providers/auth_test.go+1−12

This diff is too big to show here.

providers/azure.go+126−222

This diff is too big to show here.

providers/azure_test.go+47−103

This diff is too big to show here.

providers/bitbucket.go+6−16

This diff is too big to show here.

providers/bitbucket_test.go+11−10

This diff is too big to show here.

providers/cidaas.godeleted−144

This diff is too big to show here.

providers/cidaas_test.godeleted−493

This diff is too big to show here.

providers/digitalocean.go+1−3

This diff is too big to show here.

providers/dtt_sso.godeleted−202

This diff is too big to show here.

providers/dtt_sso_test.godeleted−237

This diff is too big to show here.

providers/facebook.go−1

This diff is too big to show here.

providers/gitea_test.godeleted−98

This diff is too big to show here.

providers/github.go+212−291

This diff is too big to show here.

providers/github_test.go+45−271

This diff is too big to show here.

providers/gitlab.go+11−19

This diff is too big to show here.

providers/gitlab_test.go+16−34

This diff is too big to show here.

providers/google.go+20−255

This diff is too big to show here.

providers/google_test.go+30−156

This diff is too big to show here.

providers/internal_util.go+2−17

This diff is too big to show here.

providers/internal_util_test.go+2−15

This diff is too big to show here.

providers/keycloak.go+4−27

This diff is too big to show here.

providers/keycloak_oidc.go+33−62

This diff is too big to show here.

providers/keycloak_oidc_test.go+25−79

This diff is too big to show here.

providers/keycloak_test.go+5−7

This diff is too big to show here.

providers/linkedin.go+9−17

This diff is too big to show here.

providers/linkedin_test.go+6−6

This diff is too big to show here.

providers/logingov.go+19−69

This diff is too big to show here.

providers/logingov_test.go+32−75

This diff is too big to show here.

providers/ms_entra_id.godeleted−326

This diff is too big to show here.

providers/ms_entra_id_test.godeleted−186

This diff is too big to show here.

providers/nextcloud.go+9−53

This diff is too big to show here.

providers/nextcloud_test.go+72

This diff is too big to show here.

providers/oidc.go+68−73

This diff is too big to show here.

providers/oidc_test.go+344−60

This diff is too big to show here.

providers/provider_data.go+101−216

This diff is too big to show here.

providers/provider_data_test.go+139−281

This diff is too big to show here.

providers/provider_default.go+4−16

This diff is too big to show here.

providers/provider_default_test.go+10−54

This diff is too big to show here.

providers/providers.go+34−183

This diff is too big to show here.

providers/providers_suite_test.go+1−1

This diff is too big to show here.

providers/providers_test.godeleted−404

This diff is too big to show here.

providers/srht.godeleted−109

This diff is too big to show here.

providers/srht_test.godeleted−77

This diff is too big to show here.

providers/util.go+24

This diff is too big to show here.

providers/util_test.go−33

This diff is too big to show here.

static/css/all.min.cssdeleted−9

This diff is too big to show here.

static/css/bulma.min.cssdeleted−1

This diff is too big to show here.

static/webfonts/fa-solid-900.woff2deleted

Binary file not shown.

tools/tools.gonew file+7

This diff is too big to show here.

validator.go+3−10

This diff is too big to show here.

validator_test.go+2−57

This diff is too big to show here.

pkg/version/version.go → version.gorenamed+1−1

This diff is too big to show here.

watcher.gonew file+80

This diff is too big to show here.

watcher_unsupported.gonew file+10

This diff is too big to show here.