google_auth_proxy ================= A reverse proxy that provides authentication using Google OAuth2 to validate individual accounts, or a whole google apps domain. [![Build Status](https://secure.travis-ci.org/bitly/google_auth_proxy.png?branch=master)](http://travis-ci.org/bitly/google_auth_proxy) ## Architecture ``` _______ ___________________ __________ |Nginx| ----> |google_auth_proxy| ----> |upstream| ------- ------------------- ---------- || \/ [google oauth2 api] ``` ## Installation 1. [Install Go](http://golang.org/doc/install) 2. install dependencies `$ go get github.com/bitly/go-simplejson` 3. clone the repository `$ git clone https://github.com/bitly/google_auth_proxy.git` 4. compile `$ cd google_auth_proxy && go build` 5. copy the built binary `google_auth_proxy` to `/usr/local/bin` (or wherever you want to run it from) ## OAuth Configuration You will need to register an OAuth application with google, and configure it with Redirect URI(s) for the domain you intend to run google_auth_proxy on. 1. Visit to Google Api Console https://code.google.com/apis/console/ 2. under "API Access", choose "Create an OAuth 2.0 Client ID" 3. Edit the application settings, and list the Redirect URI(s) where you will run your application. For example: `https://internalapp.yourcompany.com/oauth2/callback` 4. Make a note of the Client ID, and Client Secret and specify those values as command line arguments ## Command Line Options ``` Usage of ./google_auth_proxy: -authenticated-emails-file="": authenticate against emails via file (one per line) -client-id="": the Google OAuth Client ID: ie: "123456.apps.googleusercontent.com" -client-secret="": the OAuth Client Secret -cookie-domain="": an optional cookie domain to force cookies to -cookie-secret="": the seed string for secure cookies -google-apps-domain="": authenticate against the given google apps domain -htpasswd-file="": additionally authenticate against a htpasswd file. Entries must be created with "htpasswd -s" for SHA encryption -http-address="0.0.0.0:4180": : to listen on for HTTP clients -pass-basic-auth=true: pass HTTP Basic Auth information to upstream -redirect-url="": the OAuth Redirect URL. ie: "https://internalapp.yourcompany.com/oauth2/callback" -upstream=[]: the http url(s) of the upstream endpoint. If multiple, routing is based on path -version=false: print version string ``` ## Example Configuration To run `google_auth_proxy` as a reverse proxy on port `4180` authenticating requests for an application running on port `8080` at `http://internal.yourcompany.com/` you would use ```bash ./google_auth_proxy \ --redirect-url="https://internal.yourcompany.com/oauth2/callback" \ --google-apps-domain="yourcompany.com" \ --upstream=http://127.0.0.1:8080/ \ --cookie-secret=... \ --client-id=... \ --client-secret=... ``` An example Nginx config to listen on ssl (port 443) and forward requests to port google_auth_proxy on port 4180 would be ``` server { listen 443 default ssl; server_name internal.yourcompany.com; ssl_certificate /path/to/cert.pem; ssl_certificate_key /path/to/cert.key; add_header Strict-Transport-Security max-age=1209600; location / { proxy_pass http://127.0.0.1:4180; proxy_set_header Host $host; proxy_set_header X-Real-IP $remote_addr; proxy_set_header X-Scheme $scheme; proxy_connect_timeout 1; proxy_send_timeout 30; proxy_read_timeout 30; } } ``` ## Endpoint Documentation Google auth proxy responds directly to the following endpoints. All other endpoints will be authenticated. * /oauth2/sign_in - the login page, which also doubles as a sign out page (it clears cookies) * /oauth2/start - a URL that will redirect to start the oauth cycle * /oauth2/callback - the URL used at the end of the oauth cycle