Vouch Proxy

An SSO solution for Nginx using the authrequest module. Vouch Proxy can protect all of your websites at once.

Vouch Proxy supports many OAuth and OIDC login providers and can enforce authentication to...

• Google
• GitHub
• GitHub Enterprise
• IndieAuth
• Okta
• Slack
• ADFS
• Azure AD
• Alibaba / Aliyun iDaas
• AWS Cognito
• Twitch
• Discord
• SecureAuth
• Gitea
• Keycloak
• OAuth2 Server Library for PHP
• HomeAssistant
• OpenStax
• Ory Hydra
• Nextcloud
• Pocket ID
• most other OpenID Connect (OIDC) providers

If Vouch is running on the same host as the Nginx reverse proxy the response time from the /validate endpoint to Nginx should be less than 1ms.

Table of Contents

• What Vouch Proxy Does...
• Installation and Configuration

• Tips, Tricks and Advanced Configurations

• Running from Docker
• Kubernetes Nginx Ingress
• Compiling from source and running the binary
• /login and /logout endpoint redirection
• Troubleshooting, Support and Feature Requests

• Advanced Authorization Using OpenResty
• The flow of login and authentication using Google Oauth

What Vouch Proxy Does

Vouch Proxy (VP) forces visitors to login and authenticate with an IdP (such as one of the services listed above) before allowing them access to a website.

VP can also be used as a Single Sign On (SSO) solution to protect all web applications in the same domain.

After a visitor logs in Vouch Proxy allows access to the protected websites for several hours. Every request is checked by VP to ensure that it is valid.

VP can send the visitor's email, name and other information which the IdP provides (including access tokens) to the web application as HTTP headers. VP can be used to replace application user management entirely.

Installation and Configuration

Vouch Proxy relies on the ability to share a cookie between the Vouch Proxy server and the application it's protecting. Typically this will be done by running Vouch on a subdomain such as vouch.yourdomain.com with apps running at app1.yourdomain.com and app2.yourdomain.com. The protected domain is .yourdomain.com and the Vouch Proxy cookie must be set in this domain by setting vouch.domains to include yourdomain.com or sometimes by setting vouch.cookie.domain to yourdomain.com.

• cp ./config/config.ymlexample$OAUTH_PROVIDER ./config/config.yml
• create OAuth credentials for Vouch Proxy at google or github, etc

• configure Nginx...

• Nginx, vouch.yourdomain.com and protectedapp.yourdomain.com are running on the same server
• both domains are served as https and have valid certs (if not, change to listen 80 and set vouch.cookie.secure to false)

server {
    listen 443 ssl http2;
    server_name protectedapp.yourdomain.com;
    root /var/www/html/;
ssl_certificate /etc/letsencrypt/live/protectedapp.yourdomain.com/fullchain.pem;     sslcertificatekey /etc/letsencrypt/live/protectedapp.yourdomain.com/privkey.pem;
# send all requests to the /validate endpoint for authorization     auth_request /validate;
location = /validate {       # forward the /validate request to Vouch Proxy       proxy_pass http://127.0.0.1:9090/validate;       # be sure to pass the original host header       proxysetheader Host $http_host;
# Vouch Proxy only acts on the request headers       proxypassrequest_body off;       proxysetheader Content-Length "";
# optionally add X-Vouch-User as returned by Vouch Proxy along with the request       authrequestset $authrespxvouchuser $upstreamhttpxvouchuser;
# optionally add X-Vouch-IdP-Claims-* custom claims you are tracking       #    authrequestset $authrespxvouchidpclaimsgroups $upstreamhttpxvouchidpclaimsgroups;       #    authrequestset $authrespxvouchidpclaimsgivenname $upstreamhttpxvouchidpclaimsgivenname;       # optinally add X-Vouch-IdP-AccessToken or X-Vouch-IdP-IdToken       #    authrequestset $authrespxvouchidpaccesstoken $upstreamhttpxvouchidpaccesstoken;       #    authrequestset $authrespxvouchidpidtoken $upstreamhttpxvouchidpidtoken;
# these return values are used by the @error401 call       authrequestset $authrespjwt $upstreamhttpxvouchjwt;       authrequestset $authresperr $upstreamhttpxvoucherr;       authrequestset $authrespfailcount $upstreamhttpxvouchfailcount;
# Vouch Proxy can run behind the same Nginx reverse proxy       # may need to comply to "upstream" server naming       # proxy_pass http://vouch.yourdomain.com/validate;       # proxysetheader Host $http_host;     }
# if validate returns 401 not authorized then forward the request to the error401block     error_page 401 = @error401;
location @error401 {         # redirect to Vouch Proxy for login         return 302 https://vouch.yourdomain.com/login?url=$scheme://$httphost$requesturi&vouch-failcount=$authrespfailcount&X-Vouch-Token=$authrespjwt&error=$authresperr;         # you usually want to redirect to Vouch running behind the same Nginx config proteced by https         # but to get started you can just forward the end user to the port that vouch is running on         # return 302 http://vouch.yourdomain.com:9090/login?url=$scheme://$httphost$requesturi&vouch-failcount=$authrespfailcount&X-Vouch-Token=$authrespjwt&error=$authresperr;     }
location / {       # forward authorized requests to your service protectedapp.yourdomain.com       proxy_pass http://127.0.0.1:8080;       # you may need to set these variables in this block as per https://github.com/vouch/vouch-proxy/issues/26#issuecomment-425215810       #    authrequestset $authrespxvouchuser $upstreamhttpxvouchuser;       #    authrequestset $authrespxvouchidpclaimsgroups $upstreamhttpxvouchidpclaimsgroups;       #    authrequestset $authrespxvouchidpclaimsgivenname $upstreamhttpxvouchidpclaimsgivenname;
# set user header (usually an email)       proxysetheader X-Vouch-User $authrespxvouchuser;       # optionally pass any custom claims you are tracking       #     proxysetheader X-Vouch-IdP-Claims-Groups $authrespxvouchidpclaimsgroups;       #     proxysetheader X-Vouch-IdP-Claims-GivenName $authrespxvouchidpclaimsgivenname;       # optionally pass the accesstoken or idtoken       #     proxysetheader X-Vouch-IdP-AccessToken $authrespxvouchidp_accesstoken;       #     proxysetheader X-Vouch-IdP-IdToken $authrespxvouchidp_idtoken;     } }

If Vouch is configured behind the same nginx reverseproxy (perhaps so you can configure ssl) be sure to pass the Host header properly, otherwise the JWT cookie cannot be set into the domain

server {
    listen 443 ssl http2;
    server_name vouch.yourdomain.com;
    ssl_certificate /etc/letsencrypt/live/vouch.yourdomain.com/fullchain.pem;
    sslcertificatekey /etc/letsencrypt/live/vouch.yourdomain.com/privkey.pem;
location / {       proxy_pass http://127.0.0.1:9090;       # be sure to pass the original host header       proxysetheader Host $http_host;     } }

Vouch Proxy "in a path"

As of v0.33.0 Vouch Proxy can be served within an Nginx location (path) by configuring vouch.documentroot: /vpinapath

This avoids the need to setup a separate domain for Vouch Proxy such as vouch.yourdomain.com. For example VP login will be served from https://protectedapp.yourdomain.com/vpina_path/login

server {
    listen 443 ssl http2;
    server_name protectedapp.yourdomain.com;
ssl_certificate /etc/letsencrypt/live/protectedapp.yourdomain.com/fullchain.pem;     sslcertificatekey /etc/letsencrypt/live/protectedapp.yourdomain.com/privkey.pem;
# This location serves all Vouch Proxy endpoints as /vpina_path/$uri     #   including /vpinapath/validate, /vpinapath/login, /vpinapath/logout, /vpinapath/auth, /vpina_path/auth/$STATE, etc     location /vpina_path {       proxy_pass http://127.0.0.1:9090; # must not! have a slash at the end       proxysetheader Host $http_host;       proxypassrequest_body off;       proxysetheader Content-Length "";
# these return values are used by the @error401 call       authrequestset $authrespjwt $upstreamhttpxvouchjwt;       authrequestset $authresperr $upstreamhttpxvoucherr;       authrequestset $authrespfailcount $upstreamhttpxvouchfailcount;     }
# if /vpina_path/validate returns 401 not authorized then forward the request to the error401block     error_page 401 = @error401;
location @error401 {         # redirect to Vouch Proxy for login         return 302 https://protectedapp.yourdomain.com/vpinapath/login?url=$scheme://$httphost$requesturi&vouch-failcount=$authrespfailcount&X-Vouch-Token=$authrespjwt&error=$authresp_err;     }
location / {       authrequest /vpinapath/validate;       proxy_pass http://127.0.0.1:8080;       # see the Nginx config above for additional headers which can be set from Vouch Proxy     } }

Additional Nginx Configurations

Additional Nginx configurations can be found in the examples directory.

Configuring via Environmental Variables

Here's a minimal setup using Google's OAuth...

VOUCH_DOMAINS=yourdomain.com \
  OAUTH_PROVIDER=google \
  OAUTHCLIENTID=1234 \
  OAUTHCLIENTSECRET=secretsecret \
  OAUTHCALLBACKURL=https://vouch.yourdomain.com/auth \
  ./vouch-proxy

Environmental variable names are documented in config/config.yml_example

All lists with multiple values must be comma separated: VOUCH_DOMAINS="yourdomain.com,yourotherdomain.com"

The variable VOUCHCONFIG can be used to set an alternate location for the configuration file. VOUCHROOT can be used to set an alternate root directory for Vouch Proxy to look for support files.

Tips, Tricks and Advanced Configurations

All Vouch Proxy configuration items are documented in config/config.yml_example

• Cacheing of the Vouch Proxy /validate response in Nginx
• Handling OPTIONS requests when protecting an API with Vouch Proxy
• Validation by GitHub Team or GitHub Org
• Running VP on a Raspberry Pi using the ARM based Docker image
• Kubernetes architecture post ingress
• set HTTPPROXY to relay Vouch Proxy IdP requests through an outbound proxy server
• Reverse Proxy for Google Cloud Run Services
• Enable native TLS in Vouch Proxy
• FreeBSD support
• systemd startup of Vouch Proxy
• Using Node.js instead of Nginx to route requests
• Developing a Single Page App (SPA) while consuming a VP protected API
• Integrate Vouch Proxy into a server side application for User Authn and Authz
• Filter by IP address before VP validation by using satisfy any;

Scopes and Claims

With Vouch Proxy you can request various scopes (standard and custom) to obtain more information about the user or gain access to the provider's APIs. Internally, Vouch Proxy launches a requests to userinfourl after successful authentication. The required claims are extracted from the provider's response and stored in the VP cookie.

⚠️ Additional claims and tokens will be added to the VP cookie and can make it large

The VP cookie may be split into several cookies to accomdate browser cookie size limits. But if you need it, you need it. Large cookies and headers require Nginx to be configured with larger buffers. See largeclientheaderbuffers and proxybuffersize for more information.

Setup scopes and claims in Vouch Proxy with Nginx

• Configure Vouch Proxy for Nginx and your IdP as normal (See: Installation and Configuration)

• Set the necessary scopes in the oauth section of the vouch-proxy config.yml (example config)

• Set the necessary claims in the header section of the vouch-proxy config.yml

• Use authrequestset after authrequest inside the protected location in the nginx server.conf
• Consume the claim (example nginx config)

docker run -d \
    -p 9090:9090 \
    --name vouch-proxy \
    -v ${PWD}/config:/config \
    quay.io/vouch/vouch-proxy

docker run -d \
    -p 9090:9090 \
    --name vouch-proxy \
    -e VOUCH_DOMAINS=yourdomain.com \
    -e OAUTH_PROVIDER=google \
    -e OAUTHCLIENTID=1234 \
    -e OAUTHCLIENTSECRET=secretsecret \
    -e OAUTHCALLBACKURL=https://vouch.yourdomain.com/auth \
    quay.io/vouch/vouch-proxy

nginx.ingress.kubernetes.io/auth-signin: "https://vouch.yourdomain.com/login?url=$scheme://$httphost$requesturi&vouch-failcount=$authrespfailcount&X-Vouch-Token=$authrespjwt&error=$authresperr"
    nginx.ingress.kubernetes.io/auth-url: https://vouch.yourdomain.com/validate
    nginx.ingress.kubernetes.io/auth-response-headers: X-Vouch-User
    nginx.ingress.kubernetes.io/auth-snippet: |
      # these return values are used by the @error401 call
      authrequestset $authrespjwt $upstreamhttpxvouchjwt;
      authrequestset $authresperr $upstreamhttpxvoucherr;
      authrequestset $authrespfailcount $upstreamhttpxvouchfailcount;
      # when VP is hosted externally to k8s ensure the SSL cert is valid to avoid MITM risk
      # proxyssltrusted_certificate /etc/ssl/certs/ca-certificates.crt;
      # proxysslsession_reuse on;
      # proxysslverify_depth 2;
      # proxysslverify on;

./do.sh goget
  ./do.sh build
  ./vouch-proxy

The Vouch Proxy /logout endpoint accepts a url parameter in the query string which can be used to 302 redirect a user to your orignal OAuth provider/IDP/OIDC provider's revocationendpoint

https://vouch.oursites.com/logout?url=https://oauth2.googleapis.com/revoke

this url must be present in the configuration file on the list vouch.postlogoutredirect_uris

# in order to prevent redirection attacks all redirected URLs to /logout must be specified
the URL must still be passed to Vouch Proxy as https://vouch.yourdomain.com/logout?url=${ONE OF THE URLS BELOW}
postlogoutredirect_uris:
  # your apps login page
  - https://yourdomain.com/login
  # your IdPs logout enpoint
  # from https://accounts.google.com/.well-known/openid-configuration
  - https://oauth2.googleapis.com/revoke
  # you may be daisy chaining to your IdP
  - https://myorg.okta.com/oauth2/123serverid/v1/logout?postlogoutredirect_uri=http://myapp.yourdomain.com/login

Note that your IdP will likely carry their own, separate postlogoutredirect_uri list.

logout resources..

• Google
• Okta
• Auth0

Troubleshooting, Support and Feature Requests (Read this before submitting an issue at GitHub)

Getting the stars to align between Nginx, Vouch Proxy and your IdP can be tricky. We want to help you get up and running as quickly as possible. The most common problem is..

I'm getting an infinite redirect loop which returns me to my IdP (Google/Okta/GitHub/...)

Double check that you are running Vouch Proxy and your apps on a common domain that can share cookies. For example, vouch.yourdomain.com and app.yourdomain.com can share cookies on the .yourdomain.com domain. (It will not work if you are trying to use vouch.yourdomain.org and app.yourdomain.net.)

You may need to explicitly define the domain that the cookie should be set on. You can do this in the config file by setting the option:

vouch:
  cookie:
    # force the domain of the cookie to set
    domain: yourdomain.com

If you continue to have trouble, try the following:

• turn on vouch.testing: true. This will slow down the loop.
• set vouch.logLevel: debug.
• the Host: header in the http request, the oauth.callback_url and the configured vouch.domains must all align so that the cookie that carries the JWT can be placed properly into the browser and then returned on each request
• it helps to think like a cookie.

• please see the issues which have been closed that mention redirect

Okay, I looked at the issues and have tried some things with my configs but it's still not working

Please submit a new issue in the following fashion..

TLDR:

• set vouch.testing: true
• set vouch.logLevel: debug
• conduct two full round trips of ./vouch-proxy capturing the output..

• put all your logs and config in a gist.
• ./do.sh bug_report is your friend

But read this anyways because we'll ask you to read it if you don't follow these instruction. :)

• turn on vouch.testing: true and set vouch.logLevel: debug.
• use a gist or another paste service such as hasteb.in. DO NOT PUT YOUR LOGS AND CONFIG INTO THE GITHUB ISSUE. Using a paste service is important as it will maintain spacing and will provide line numbers and formatting. We are hunting for needles in haystacks with setups with several moving parts, these features help considerably. Paste services save your time and our time and help us to help you quickly. You're more likely to get good support from us in a timely manner by following this advice.
• run ./do.sh bug_report secretdomain.com secretpass [anothersecret..] which will create a redacted version of your config and logs removing each of those strings

• all of those go into a gist
• then open a new issue in this repository

!bash
docker run --name vouchproxy -v $PWD/config:/config -v $PWD/certs:/certs -it --rm --entrypoint /do.sh quay.io/vouch/vouch-proxy:alpine bugreport yourdomain.com anotherdomain.com someothersecret

Contributing

We'd love to have you contribute! Please refer to our contribution guidelines for details.

Advanced Authorization Using OpenResty

OpenResty® is a full-fledged web platform that integrates the standard Nginx core, LuaJIT, many carefully written Lua libraries, lots of high quality 3rd-party Nginx modules, and most of their external dependencies.

You can replace nginx with OpenResty fairly easily.

With OpenResty and Lua it is possible to provide customized and advanced authorization on any header or claims vouch passes down.

OpenResty and configs for a variety of scenarios are available in the examples directory.

The flow of login and authentication using Google Oauth

• Bob visits https://private.oursites.com
• the Nginx reverse proxy...

• Vouch Proxy https://vouch.oursites.com/validate

• Bob is first forwarded briefly to https://vouch.oursites.com/login?url=https://private.oursites.com

• Bob logs into his Google account using Oauth

• Bob is forwarded to https://vouch.oursites.com/auth?state=$STATE

Note that outside of some innocuos redirection, Bob only ever sees https://private.oursites.com and the Google Login screen in his browser. While Vouch does interact with Bob's browser several times, it is just to set cookies, and if the 302 redirects work properly Bob will log in quickly.

Once the JWT is set, Bob will be authorized for all other sites which are configured to use https://vouch.oursites.com/validate from the auth_request Nginx module.

The next time Bob is forwarded to google for login, since he has already authorized the Vouch Proxy OAuth app, Google immediately forwards him back and sets the cookie and sends him on his merry way. In some browsers such as Chrome, Bob may not even notice that he logged in using Vouch Proxy.