public_git
/
oauth2-proxy
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
1,824 Commits 54 Branches 50 Tags 47 MiB
Go 98.3%
Makefile 0.8%
HTML 0.5%
Shell 0.2%
Dockerfile 0.2%
Go to file
Leandro Lafin ec2b5218b6
Fix oidc-issuer-url in example 		2024-07-12 10:38:50 -03:00
.github Docs: Add Search 2024-07-12 08:24:01 -03:00
build test 2023-03-29 10:14:30 +05:30
contrib Missing closing quotes on api_routes example 2024-07-12 09:53:47 -03:00
deploy removing Prometheus 2022-05-14 12:32:42 +05:30
docs Fix oidc-issuer-url in example 2024-07-12 10:38:50 -03:00
helm/hsd-oauth-proxy reviewcommentsfix 2023-03-21 14:15:20 +05:30
pkg Updated linters 2024-07-12 10:30:16 -03:00
providers Updated linters 2024-07-12 10:30:16 -03:00
static Embed static stylesheets and dependencies 2024-07-11 14:39:38 -03:00
testdata 100% passing tests 2023-10-02 10:27:46 -03:00
tools Generate reference page in configuration 2021-01-18 09:57:44 +00:00
.bumpversion.cfg Bump version 1.0.28 2023-03-30 04:57:02 +00:00
.dockerignore Merging 7.4.0 2023-09-01 08:09:44 -03:00
.editorconfig Adding editor config 2023-10-02 11:31:50 -03:00
.gitignore implement oidc singl sign on cookie refresher 2024-02-01 08:53:16 -03:00
.golangci.yml Updated linters 2024-07-12 10:30:16 -03:00
CHANGELOG.md Upgrade golang.org/x/net to v0.17.0 2024-07-12 09:57:53 -03:00
CONTRIBUTING.md
…
Directory.Build.props adding .proj files 2022-05-05 10:50:16 +05:30
Dockerfile Added arch types to Docker and binary releases 2024-07-11 18:09:16 -03:00
LICENSE
…
MAINTAINERS
…
Makefile Added arch types to Docker and binary releases 2024-07-11 18:09:16 -03:00
README.md Added arch types to Docker and binary releases 2024-07-11 18:09:16 -03:00
RELEASE.md
…
SECURITY.md Add Security Policy 2021-01-16 19:47:47 +00:00
VERSION Bump version 1.0.28 2023-03-30 04:57:02 +00:00
dist.sh Added arch types to Docker and binary releases 2024-07-11 18:09:16 -03:00
go.mod Update dependencies 2024-07-12 09:57:09 -03:00
go.sum Update dependencies 2024-07-12 09:57:09 -03:00
main.go Merging 7.4.0 2023-09-01 08:09:44 -03:00
main_suite_test.go Ensure errors in tests are logged to the GinkgoWriter 2021-02-10 19:50:04 +00:00
main_test.go fix unit tests 2024-02-01 11:55:09 -03:00
nsswitch.conf
…
oauthproxy.go Embed static stylesheets and dependencies 2024-07-11 14:39:38 -03:00
oauthproxy_test.go Updated linters 2024-07-12 10:30:16 -03:00
sonar-project.properties testing sonar 2023-02-17 13:01:04 +05:30
validator.go Merging 7.4.0 2023-09-01 08:09:44 -03:00
validator_test.go Merging 7.4.0 2023-09-01 08:09:44 -03:00
version.go
…

README.md

OAuth2 Proxy

Continuous Integration Go Report Card GoDoc MIT licensed Maintainability Test Coverage

A reverse proxy and static file server that provides authentication using Providers (Google, GitHub, and others) to validate accounts by email, domain or group.

Note: This repository was forked from bitly/OAuth2_Proxy on 27/11/2018. 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.

Note: This project was formerly hosted as pusher/oauth2_proxy but has been renamed as of 29/03/2020 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.

Sign In Page

Installation

  1. Choose how to deploy:

    a. Download Prebuilt Binary (current release is v7.5.0)

    b. Build with $ go install github.com/oauth2-proxy/oauth2-proxy/v7@latest which will put the binary in $GOROOT/bin

    c. Using the prebuilt docker image quay.io/oauth2-proxy/oauth2-proxy (AMD64, PPC64LE, ARMv6, ARMv7, and ARM64 available)

    Prebuilt binaries can be validated by extracting the file and verifying it against the sha256sum.txt checksum file provided for each release starting with version v3.0.0.

    sha256sum -c sha256sum.txt 2>&1 | grep OK
oauth2-proxy-x.y.z.linux-amd64: OK

  2. Select a Provider and Register an OAuth Application with a Provider

  3. Configure OAuth2 Proxy using config file, command line options, or environment variables

  4. Configure SSL or Deploy behind a SSL endpoint (example provided for Nginx)

Security

If you are running a version older than v6.0.0 we strongly recommend you please update to a current version. See open redirect vulnerability for details.

Docs

Read the docs on our Docs site.

OAuth2 Proxy Architecture

Configure OAuth Proxy Cookie as Session Cookie

OAuth Proxy Cookie can be configured as session cookie by setting cookie expire time (--cookie-expire) as 0.

This can also be set via environment variable:

  • OAUTH2_PROXY_COOKIE_EXPIRE = 0

Getting Involved

If you would like to reach out to the maintainers, come talk to us in the #oauth2-proxy channel in the Gophers slack.

Contributing

Please see our Contributing guidelines. For releasing see our release creation guide.