1
0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2024-11-30 09:16:52 +02:00
A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
Go to file
Joel Speed 59aeefcd8b
Merge pull request #980 from neuralsandwich/add-metrics
Add Prometheus metrics endpoint
2021-02-15 15:01:37 +00:00
.github Ensure code is generated during CI 2021-01-18 09:56:07 +00:00
contrib Prepare for release v7.0.1 2021-02-10 18:25:39 +00:00
docs Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
pkg Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
providers Ensure errors in tests are logged to the GinkgoWriter 2021-02-10 19:50:04 +00:00
testdata Rename test directory to testdata 2020-10-06 21:37:25 +09:00
tools Generate reference page in configuration 2021-01-18 09:57:44 +00:00
.dockerignore Reduce docker context to improve build times 2020-07-07 20:51:43 +01:00
.gitignore Set up code coverage within Travis for Code Climate (#533) 2020-05-10 07:29:37 +01:00
.golangci.yml Skip gosec linting on tests 2020-08-09 07:55:41 -07:00
CHANGELOG.md Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00: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 Update release process to use makefile go version check (#1027) 2021-02-06 15:19:33 -08:00
Dockerfile Update alpine version to 3.13 (#1013) 2021-01-30 15:33:28 +00:00
Dockerfile.arm64 Update alpine version to 3.13 (#1013) 2021-01-30 15:33:28 +00:00
Dockerfile.armv6 Update alpine version to 3.13 (#1013) 2021-01-30 15:33:28 +00:00
go.mod Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
go.sum Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
http_test.go Fix import path for v7 (#800) 2020-09-29 17:44:42 +01:00
http.go Support TLS 1.3 (#923) 2020-11-19 10:25:53 +00:00
LICENSE add MIT license for google_auth_proxy 2014-06-09 16:25:26 -04:00
logging_handler_test.go Fix import path for v7 (#800) 2020-09-29 17:44:42 +01:00
logging_handler.go Fix import path for v7 (#800) 2020-09-29 17:44:42 +01: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 Introduce alpha configuration loading 2020-12-01 08:56:49 +00:00
main.go Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
MAINTAINERS Add NickMeves to MAINTAINERS 2021-01-10 10:56:01 -08:00
Makefile Update release process to use makefile go version check (#1027) 2021-02-06 15:19:33 -08:00
nsswitch.conf Add nsswitch.conf to Docker image (#400) 2020-02-23 18:16:18 +00:00
oauthproxy_test.go Allow users to choose detailed error messages on error pages 2021-02-12 21:12:28 +00:00
oauthproxy.go Add Prometheus metrics endpoint 2021-02-15 13:45:26 +00:00
README.md Prepare for release v7.0.1 2021-02-10 18:25:39 +00:00
RELEASE.md Migrate to oauth2-proxy/oauth2-proxy 2020-03-29 15:40:10 +01:00
SECURITY.md Add Security Policy 2021-01-16 19:47:47 +00:00
validator_test.go remove unnecessary validator tests (#288) 2019-10-18 08:49:33 -07:00
validator.go Fix import path for v7 (#800) 2020-09-29 17:44:42 +01:00
version.go Introduce Makefile 2019-01-04 10:58:30 +00:00
watcher_unsupported.go Fix import path for v7 (#800) 2020-09-29 17:44:42 +01:00
watcher.go Fix import path for v7 (#800) 2020-09-29 17:44:42 +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 will be named oauth2-proxy.

Sign In Page

Installation

  1. Choose how to deploy:

    a. Download Prebuilt Binary (current release is v7.0.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 v6.0.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.