chronograf/docs/auth.md

Chronograf with OAuth 2.0 (Github-style)

OAuth 2.0 Style Authentication

TL;DR

Github

export AUTH_DURATION=1h                                           # force login every hour
export TOKEN_SECRET=supersupersecret                              # Signing secret
export GH_CLIENT_ID=b339dd4fddd95abec9aa                          # Github client id
export GH_CLIENT_SECRET=260041897d3252c146ece6b46ba39bc1e54416dc  # Github client secret
export GH_ORGS=biffs-gang                                         # Restrict to GH orgs

Configuration

To use authentication in Chronograf, both the OAuth provider and JWT signature need to be configured.

Configuring JWT signature

Set a JWT signature to a random string. This is needed for all OAuth2 providers that you choose to configure. Keep this random string around!

You'll need it each time you start a chronograf server because it is used to verify user authorization. If you are running multiple chronograf servers in an HA configuration set the TOKEN_SECRET on each to allow users to stay logged in. If you want to log all users out every time the server restarts, change the value of TOKEN_SECRET to a different value on each restart.

export TOKEN_SECRET=supersupersecret

Github

Creating Github OAuth Application

To create a Github OAuth Application follow the Register your app instructions. Essentially, you'll register your application here

The Homepage URL should be Chronograf's full server name and port. If you are running it locally for example, make it http://localhost:8888

The Authorization callback URL must be the location of the Homepage URL plus /oauth/github/callback. For example, if Homepage URL was http://localhost:8888 then the Authorization callback URL should be http://localhost:8888/oauth/github/callback.

Github will provide a Client ID and Client Secret. To register these values with chronograf set the following environment variables:

• GH_CLIENT_ID
• GH_CLIENT_SECRET

For example:

export GH_CLIENT_ID=b339dd4fddd95abec9aa
export GH_CLIENT_SECRET=260041897d3252c146ece6b46ba39bc1e54416dc

Optional Github Organizations

To require an organization membership for a user, set the GH_ORGS environment variables

export GH_ORGS=biffs-gang

If the user is not a member, then the user will not be allowed access.

To support multiple organizations use a comma delimted list like so:

export GH_ORGS=hill-valley-preservation-sociey,the-pinheads

Google

Creating Google OAuth Application

You will need to obtain a client ID and an application secret by following the steps under "Basic Steps" here. Chronograf will also need to be publicly accessible via a fully qualified domain name so that Google properly redirects users back to the application.

This information should be set in the following ENVs:

• GOOGLE_CLIENT_ID
• GOOGLE_CLIENT_SECRET
• PUBLIC_URL

Alternatively, this can also be set using the command line switches:

• --google-client-id
• --google-client-secret
• --public-url

Optional Google Domains

Similar to Github's organization restriction, Google authentication can be restricted to permit access to Chronograf from only specific domains. These are configured using the GOOGLE_DOMAINS ENV or the --google-domains switch. Multiple domains are separated with a comma. For example, if we wanted to permit access only from biffspleasurepalace.com and savetheclocktower.com the ENV would be set as follows:

export GOOGLE_DOMAINS=biffspleasurepalance.com,savetheclocktower.com

Heroku

Creating Heroku Application

To obtain a client ID and application secret for Heroku, you will need to follow the guide posted here. Once your application has been created, those two values should be inserted into the following ENVs:

• HEROKU_CLIENT_ID
• HEROKU_SECRET

The equivalent command line switches are:

• --heroku-client-id
• --heroku-secret

Optional Heroku Organizations

Like the other OAuth2 providers, access to Chronograf via Heroku can be restricted to members of specific Heroku organizations. This is controlled using the HEROKU_ORGS ENV or the --heroku-organizations switch and is comma-separated. If we wanted to permit access from the hill-valley-preservation-society orgization and the-pinheads organization, we would use the following ENV:

export HEROKU_ORGS=hill-valley-preservation-sociey,the-pinheads

Generic OAuth2 Provider

Creating OAuth Application using your own provider

The generic OAuth2 provider is very similiar to the Github provider, but, you are able to set your own authentication, token and API URLs.

The callback URL path will be /oauth/generic/callback. So, if your chronograf is hosted at https://localhost:8888 then the full callback URL would be https://localhost:8888/oauth/generic/callback

The generic OAuth2 provider has many settings that are required.

• GENERIC_CLIENT_ID : this application's client identifier issued by the provider
• GENERIC_CLIENT_SECRET : this application's secret issued by the provider
• GENERIC_AUTH_URL : OAuth 2.0 provider's authorization endpoint URL
• GENERIC_TOKEN_URL : OAuth 2.0 provider's token endpoint endpoint is used by the client to obtain an access token
• TOKEN_SECRET : Used to validate OAuth state response. (see above)

Optional Scopes

By default chronograf will ask for the user:email scope of the client. If your provider scopes email access under a different scope or scopes provide them as comma separated values in the GENERIC_SCOPES environment variable.

export GENERIC_SCOPES="openid,email" # Requests access to openid and email scopes

Optional Email domains

Also, the generic OAuth2 provider has a few optional parameters as well.

• GENERIC_API_URL : URL that returns OpenID UserInfo JWT (specifically email address)
• GENERIC_DOMAINS : Email domains user's email address must use.

Configuring the look of the login page

To configure the copy of the login page button text, set GENERIC_NAME.

For example with

export GENERIC_NAME="Hill Valley Preservation Society"

the button text will be Login with Hill Valley Preservation Society.

Optional: Configuring Authentication Duration

By default, auth will remain valid for 30 days via a cookie stored in the browser. This duration can be changed with the environment variable AUTH_DURATION. For example, to change it to 1 hour, use:

export AUTH_DURATION=1h

The duration uses the golang time duration format, so the largest time unit is h (hours). So to change it to 45 days, use:

export AUTH_DURATION=1080h

Additionally, for greater security, if you want to require re-authentication every time the browser is closed, set AUTH_DURATION to 0. This will make the cookie transient (aka "in-memory").