Go to file
Joel Speed 160bbaf98e
Fallback to UserInfo is User ID claim not present (#560)
Co-authored-by: Henry Jenkins <henry@henryjenkins.name>
2020-06-04 17:41:29 +01:00
.github Remove Syscll as a maintainer (#540) 2020-05-10 11:51:15 +01:00
contrib Support new option "github-user" (#421) 2020-06-01 20:02:07 +01:00
docs Support new option "github-user" (#421) 2020-06-01 20:02:07 +01:00
pkg Support new option "github-user" (#421) 2020-06-01 20:02:07 +01:00
providers Fallback to UserInfo is User ID claim not present (#560) 2020-06-04 17:41:29 +01:00
.dockerignore Ignore Dockerfile.dev 2019-01-22 02:54:17 +09:00
.gitignore Set up code coverage within Travis for Code Climate (#533) 2020-05-10 07:29:37 +01:00
.golangci.yml Add new linters (#486) 2020-04-14 09:36:44 +01:00
.travis.yml Set up code coverage within Travis for Code Climate (#533) 2020-05-10 07:29:37 +01:00
CHANGELOG.md Fallback to UserInfo is User ID claim not present (#560) 2020-06-04 17:41:29 +01:00
CONTRIBUTING.md Drop configure script in favour of native Makefile env and checks (#515) 2020-05-09 16:07:46 +01:00
dist.sh Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
Dockerfile Drop configure script in favour of native Makefile env and checks (#515) 2020-05-09 16:07:46 +01:00
Dockerfile.arm64 Drop configure script in favour of native Makefile env and checks (#515) 2020-05-09 16:07:46 +01:00
Dockerfile.armv6 Drop configure script in favour of native Makefile env and checks (#515) 2020-05-09 16:07:46 +01:00
go.mod Parse Redis cluster and sentinel urls (#573) 2020-05-27 18:40:50 +01:00
go.sum Parse Redis cluster and sentinel urls (#573) 2020-05-27 18:40:50 +01:00
htpasswd_test.go Lint for non-comment linter errors 2018-11-29 14:26:41 +00:00
htpasswd.go Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
http_test.go Move Options and Validation to package 2020-05-21 22:43:42 +01:00
http.go Move Options and Validation to package 2020-05-21 22:43:42 +01:00
LICENSE add MIT license for google_auth_proxy 2014-06-09 16:25:26 -04:00
logging_handler_test.go Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
logging_handler.go Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
main.go Move FlagSet to Options package 2020-05-21 22:43:42 +01:00
MAINTAINERS Remove Syscll as a maintainer (#540) 2020-05-10 11:51:15 +01:00
Makefile Add nginx test environment to demonstrate protecting multiple subdomains 2020-05-12 16:06:17 +01:00
nsswitch.conf Add nsswitch.conf to Docker image (#400) 2020-02-23 18:16:18 +00:00
oauthproxy_test.go Improvements to Session State code (#536) 2020-05-30 08:53:38 +01:00
oauthproxy.go render error page on 502 proxy status (#574) 2020-05-24 21:09:00 +01:00
README.md Set up code coverage within Travis for Code Climate (#533) 2020-05-10 07:29:37 +01:00
RELEASE.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
templates_test.go Add basic string functions to templates (#514) 2020-05-09 21:05:51 +01:00
templates.go Add basic string functions to templates (#514) 2020-05-09 21:05:51 +01:00
validator_test.go remove unnecessary validator tests (#288) 2019-10-18 08:49:33 -07:00
validator.go Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
version.go Introduce Makefile 2019-01-04 10:58:30 +00:00
watcher_unsupported.go Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
watcher.go Add new linters (#486) 2020-04-14 09:36:44 +01:00

OAuth2 Proxy

Build Status 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 wiil been named oauth2-proxy.

Sign In Page

Installation

  1. Choose how to deploy:

    a. Download Prebuilt Binary (current release is v5.1.1)

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

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

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

sha256sum -c sha256sum.txt 2>&1 | grep OK
oauth2-proxy-x.y.z.linux-amd64: OK
  1. Select a Provider and Register an OAuth Application with a Provider
  2. Configure OAuth2 Proxy using config file, command line options, or environment variables
  3. Configure SSL or Deploy behind a SSL endpoint (example provided for Nginx)

Security

If you are running a version older than v5.1.0 we strongly recommend you please update to a current version. See open redirect vulnverability for details.

Docs

Read the docs on our Docs site.

OAuth2 Proxy Architecture

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.