go/oauth2-proxy
1
0
Fork 0
mirror of https://github.com/oauth2-proxy/oauth2-proxy.git synced 2024-11-28 09:08:44 +02:00
Code Issues Releases Activity
A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.
1,846 Commits 27 Branches 34 Tags 79 MiB
Go 98.2%
Makefile 0.7%
HTML 0.5%
Shell 0.3%
Dockerfile 0.3%
76bc2cf73f
Go to file
Koen van Zuijlen 76bc2cf73f
Refactored docs (#2284) 
* Refactored documentation for providers

* Lots of fixes
- Fixed grammar/typos
- Fixed sidebar config
- Enabled additional prism languages

* Removed useless spaces

* Fixed leftover typos

* Fixes for verify-generate

* Updated package-lock.json
2023-10-31 19:32:59 +00:00
.github Additional labels (#2293) 2023-10-26 10:57:34 +01:00
contrib Missing closing quotes on api_routes example (#2123) 2023-09-22 14:42:44 +01:00
docs Refactored docs (#2284) 2023-10-31 19:32:59 +00:00
pkg Refactored docs (#2284) 2023-10-31 19:32:59 +00:00
providers Merge pull request #2283 from kvanzuijlen/golint 2023-10-25 11:36:44 +01:00
static Embed static stylesheets and dependencies 2023-08-24 20:50:17 -04: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 Parameterise runtime image (#1478) 2022-04-14 14:10:59 +01:00
.gitignore PKCE Support (#1541) 2022-03-13 10:08:33 +00:00
.golangci.yml Updated linters 2023-10-24 16:37:57 +02:00
CHANGELOG.md Add support for unix socket as upstream (#1866) 2023-10-26 10:57:00 +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 Added arch types to Docker and binary releases (#2220) 2023-09-08 17:18:20 +01:00
Dockerfile Update alpine to 3.18 2023-09-08 18:22:46 +02:00
go.mod Fixed Google ADC functionality (#2282) 2023-10-24 20:03:16 +01:00
go.sum Fixed Google ADC functionality (#2282) 2023-10-24 20:03:16 +01:00
LICENSE add MIT license for google_auth_proxy 2014-06-09 16:25:26 -04: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 Linting Errors (#1835) 2022-10-21 11:57:51 +01:00
main.go main: fix typo "convert-config-to-alpha" 2022-02-24 08:59:45 +01:00
MAINTAINERS Add NickMeves to MAINTAINERS 2021-01-10 10:56:01 -08:00
Makefile Update alpine to 3.18 2023-09-08 18:22:46 +02:00
nsswitch.conf Add nsswitch.conf to Docker image (#400) 2020-02-23 18:16:18 +00:00
oauthproxy_test.go Merge pull request #2283 from kvanzuijlen/golint 2023-10-25 11:36:44 +01:00
oauthproxy.go Feature: Allowing relative redirect url though an option (#2183) 2023-10-25 10:25:01 +01:00
README.md Added arch types to Docker and binary releases (#2220) 2023-09-08 17:18:20 +01: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 Fix Linting Errors (#1835) 2022-10-21 11:57:51 +01:00
validator.go Watch the htpasswd file for changes and update the htpasswdMap (#1701) 2022-09-01 19:46:00 +01:00
version.go Introduce Makefile 2019-01-04 10:58:30 +00:00

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

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.