oauth2-proxy

A reverse proxy that provides authentication with Google, Azure, OpenID Connect and many more identity providers.

cloud-infrastructure hacktoberfest oauth2-proxy ssl sso

Go to file

axel7083 601477a52c Feature: Allowing relative redirect url though an option (#2183 ) * Adding relative redirect url option * Updating CHANGELOG.md * tests: adding unit test for getOAuthRedirectURI --------- Co-authored-by: Joel Speed <Joel.speed@hotmail.co.uk>		2023-10-25 10:25:01 +01:00
.github	Docs: Add Search (#2228 )	2023-09-13 12:00:14 +01:00
contrib	Missing closing quotes on api_routes example (#2123 )	2023-09-22 14:42:44 +01:00
docs	Feature: Allowing relative redirect url though an option (#2183 )	2023-10-25 10:25:01 +01:00
pkg	Feature: Allowing relative redirect url though an option (#2183 )	2023-10-25 10:25:01 +01:00
providers	Fixed Google ADC functionality (#2282 )	2023-10-24 20:03:16 +01:00
static	Embed static stylesheets and dependencies	2023-08-24 20:50:17 -04:00
testdata	…
tools	…
.dockerignore	…
.gitignore	…
.golangci.yml	…
CHANGELOG.md	Feature: Allowing relative redirect url though an option (#2183 )	2023-10-25 10:25:01 +01:00
CONTRIBUTING.md	…
Dockerfile	Update alpine to 3.18	2023-09-08 18:22:46 +02:00
LICENSE	…
MAINTAINERS	…
Makefile	Update alpine to 3.18	2023-09-08 18:22:46 +02:00
README.md	Added arch types to Docker and binary releases (#2220 )	2023-09-08 17:18:20 +01:00
RELEASE.md	…
SECURITY.md	…
dist.sh	Added arch types to Docker and binary releases (#2220 )	2023-09-08 17:18:20 +01: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
main.go	…
main_suite_test.go	…
main_test.go	…
nsswitch.conf	…
oauthproxy.go	Feature: Allowing relative redirect url though an option (#2183 )	2023-10-25 10:25:01 +01:00
oauthproxy_test.go	Feature: Allowing relative redirect url though an option (#2183 )	2023-10-25 10:25:01 +01:00
validator.go	…
validator_test.go	…
version.go	…

README.md

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.

Installation

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
```
Select a Provider and Register an OAuth Application with a Provider
Configure OAuth2 Proxy using config file, command line options, or environment variables
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.

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.