2012-12-11 01:34:58 +00:00
|
|
|
google_auth_proxy
|
|
|
|
|
=================
|
|
|
|
|
|
2012-12-17 18:03:34 +00:00
|
|
|
|
|
|
|
|
A reverse proxy that provides authentication using Google OAuth2 to validate
|
2012-12-11 01:34:58 +00:00
|
|
|
individual accounts, or a whole google apps domain.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Structure
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
_______ ___________________ __________
|
|
|
|
|
|Nginx| ----> |google_auth_proxy| ----> |upstream|
|
|
|
|
|
------- ------------------- ----------
|
|
|
|
|
||
|
|
|
|
|
\/
|
|
|
|
|
[google oauth2 api]
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
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`
|
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
```
|
2012-12-11 01:59:23 +00:00
|
|
|
Usage of ./google_auth_proxy:
|
|
|
|
|
-authenticated-emails-file="": authenticate against emails via file (one per line)
|
2012-12-11 01:34:58 +00:00
|
|
|
-client-id="": the Google OAuth Client ID: ie: "123456.apps.googleusercontent.com"
|
2012-12-11 01:59:23 +00:00
|
|
|
-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": <addr>:<port> 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
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Unauthenticated requests will be redirected to `/oauth2/sign_in` to start the sign-in process.
|
2012-12-11 02:11:24 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
## Example
|
|
|
|
|
|
2012-12-17 18:03:34 +00:00
|
|
|
To run google_auth_proxy as a reverse proxy on port 4180 authenticating requests for an application running
|
2012-12-11 02:11:24 +00:00
|
|
|
on port 8080 at 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 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;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
