-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fetch groups in a Google Connector #1185
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
97ffa21
Create separate Google connector
JoelSpeed 36370f8
No need to configure issuer
JoelSpeed 3f55e2d
Get groups from directory api
JoelSpeed c03c98b
Check config before getting groups
JoelSpeed 6a9bc88
Update comments
JoelSpeed 9d9a101
Add documentation for google connector
JoelSpeed 94bee18
vendor: make revendor
JoelSpeed 554870c
Add todo for configurable groups key
JoelSpeed 658a2cc
Make directory service during init
JoelSpeed File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
# Authentication through Google | ||
|
||
## Overview | ||
|
||
Dex is able to use Google's OpenID Connect provider as an authentication source. | ||
|
||
The connector uses the same authentication flow as the OpenID Connect provider but adds Google specific features such as Hosted domain support and reading groups using a service account. | ||
|
||
## Configuration | ||
|
||
```yaml | ||
connectors: | ||
- type: google | ||
id: google | ||
name: Google | ||
config: | ||
|
||
# Connector config values starting with a "$" will read from the environment. | ||
clientID: $GOOGLE_CLIENT_ID | ||
clientSecret: $GOOGLE_CLIENT_SECRET | ||
|
||
# Dex's issuer URL + "/callback" | ||
redirectURI: http://127.0.0.1:5556/callback | ||
|
||
# Google supports whitelisting allowed domains when using G Suite | ||
# (Google Apps). The following field can be set to a list of domains | ||
# that can log in: | ||
# | ||
# hostedDomains: | ||
# - example.com | ||
|
||
# Google does not support the OpenID Connect groups claim and only supports | ||
# fetching a user's group membership with a service account. | ||
# This service account requires an authentication JSON file and the email | ||
# of a G Suite admin to impersonate: | ||
# | ||
#serviceAccountFilePath: googleAuth.json | ||
#adminEmail: super-user@example.com | ||
``` | ||
|
||
## Fetching groups from Google | ||
To allow Dex to fetch group information from Google, you will need to configure a service account for Dex to use. | ||
This account needs Domain-Wide Delegation and permission to access the `https://www.googleapis.com/auth/admin.directory.group.readonly` API scope. | ||
|
||
To get group fetching set up: | ||
|
||
1. Follow the [instructions](https://developers.google.com/admin-sdk/directory/v1/guides/delegation) to set up a service account with Domain-Wide Delegation | ||
- During service account creation, a JSON key file will be created that contains authentication information for the service account. This needs storing in a location accessible by Dex and you will set the `serviceAccountFilePath` to point at it. | ||
- When delegating the API scopes to the service account, delegate the `https://www.googleapis.com/auth/admin.directory.group.readonly` scope and only this scope. If you delegate more scopes to the service account, it will not be able to access the API. | ||
2. Enable the [Admin SDK](https://console.developers.google.com/apis/library/admin.googleapis.com/) | ||
3. Add the `serviceAccountFilePath` and `adminEmail` configuration options to your Dex config. | ||
- `serviceAccountFilePath` should point to the location of the service account JSON key file | ||
- `adminEmail` should be the email of a G Suite super user. The service account you created earlier will impersonate this user when making calls to the admin API. A valid user should be able to retrieve a list of groups when [testing the API](https://developers.google.com/admin-sdk/directory/v1/reference/groups/list#try-it). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,269 @@ | ||
// Package google implements logging in through Google's OpenID Connect provider. | ||
package google | ||
|
||
import ( | ||
"context" | ||
"errors" | ||
"fmt" | ||
"io/ioutil" | ||
"net/http" | ||
"time" | ||
|
||
"github.com/coreos/go-oidc" | ||
"golang.org/x/oauth2" | ||
|
||
"github.com/dexidp/dex/connector" | ||
"github.com/dexidp/dex/pkg/log" | ||
"golang.org/x/oauth2/google" | ||
"google.golang.org/api/admin/directory/v1" | ||
) | ||
|
||
const ( | ||
issuerURL = "https://accounts.google.com" | ||
) | ||
|
||
// Config holds configuration options for Google logins. | ||
type Config struct { | ||
ClientID string `json:"clientID"` | ||
ClientSecret string `json:"clientSecret"` | ||
RedirectURI string `json:"redirectURI"` | ||
|
||
Scopes []string `json:"scopes"` // defaults to "profile" and "email" | ||
|
||
// Optional list of whitelisted domains | ||
// If this field is nonempty, only users from a listed domain will be allowed to log in | ||
HostedDomains []string `json:"hostedDomains"` | ||
|
||
// Optional path to service account json | ||
// If nonempty, and groups claim is made, will use authentication from file to | ||
// check groups with the admin directory api | ||
ServiceAccountFilePath string `json:"serviceAccountFilePath"` | ||
|
||
// Required if ServiceAccountFilePath | ||
// The email of a GSuite super user which the service account will impersonate | ||
// when listing groups | ||
AdminEmail string | ||
} | ||
|
||
// Open returns a connector which can be used to login users through Google. | ||
func (c *Config) Open(id string, logger log.Logger) (conn connector.Connector, err error) { | ||
ctx, cancel := context.WithCancel(context.Background()) | ||
|
||
provider, err := oidc.NewProvider(ctx, issuerURL) | ||
if err != nil { | ||
cancel() | ||
return nil, fmt.Errorf("failed to get provider: %v", err) | ||
} | ||
|
||
scopes := []string{oidc.ScopeOpenID} | ||
if len(c.Scopes) > 0 { | ||
scopes = append(scopes, c.Scopes...) | ||
} else { | ||
scopes = append(scopes, "profile", "email") | ||
} | ||
|
||
srv, err := createDirectoryService(c.ServiceAccountFilePath, c.AdminEmail) | ||
if err != nil { | ||
cancel() | ||
return nil, fmt.Errorf("could not create directory service: %v", err) | ||
} | ||
|
||
clientID := c.ClientID | ||
return &googleConnector{ | ||
redirectURI: c.RedirectURI, | ||
oauth2Config: &oauth2.Config{ | ||
ClientID: clientID, | ||
ClientSecret: c.ClientSecret, | ||
Endpoint: provider.Endpoint(), | ||
Scopes: scopes, | ||
RedirectURL: c.RedirectURI, | ||
}, | ||
verifier: provider.Verifier( | ||
&oidc.Config{ClientID: clientID}, | ||
), | ||
logger: logger, | ||
cancel: cancel, | ||
hostedDomains: c.HostedDomains, | ||
serviceAccountFilePath: c.ServiceAccountFilePath, | ||
adminEmail: c.AdminEmail, | ||
adminSrv: srv, | ||
}, nil | ||
} | ||
|
||
var ( | ||
_ connector.CallbackConnector = (*googleConnector)(nil) | ||
_ connector.RefreshConnector = (*googleConnector)(nil) | ||
) | ||
|
||
type googleConnector struct { | ||
redirectURI string | ||
oauth2Config *oauth2.Config | ||
verifier *oidc.IDTokenVerifier | ||
ctx context.Context | ||
cancel context.CancelFunc | ||
logger log.Logger | ||
hostedDomains []string | ||
serviceAccountFilePath string | ||
adminEmail string | ||
adminSrv *admin.Service | ||
} | ||
|
||
func (c *googleConnector) Close() error { | ||
c.cancel() | ||
return nil | ||
} | ||
|
||
func (c *googleConnector) LoginURL(s connector.Scopes, callbackURL, state string) (string, error) { | ||
if c.redirectURI != callbackURL { | ||
return "", fmt.Errorf("expected callback URL %q did not match the URL in the config %q", callbackURL, c.redirectURI) | ||
} | ||
|
||
var opts []oauth2.AuthCodeOption | ||
if len(c.hostedDomains) > 0 { | ||
preferredDomain := c.hostedDomains[0] | ||
if len(c.hostedDomains) > 1 { | ||
preferredDomain = "*" | ||
} | ||
opts = append(opts, oauth2.SetAuthURLParam("hd", preferredDomain)) | ||
} | ||
|
||
if s.OfflineAccess { | ||
opts = append(opts, oauth2.AccessTypeOffline, oauth2.SetAuthURLParam("prompt", "consent")) | ||
} | ||
return c.oauth2Config.AuthCodeURL(state, opts...), nil | ||
} | ||
|
||
type oauth2Error struct { | ||
error string | ||
errorDescription string | ||
} | ||
|
||
func (e *oauth2Error) Error() string { | ||
if e.errorDescription == "" { | ||
return e.error | ||
} | ||
return e.error + ": " + e.errorDescription | ||
} | ||
|
||
func (c *googleConnector) HandleCallback(s connector.Scopes, r *http.Request) (identity connector.Identity, err error) { | ||
q := r.URL.Query() | ||
if errType := q.Get("error"); errType != "" { | ||
return identity, &oauth2Error{errType, q.Get("error_description")} | ||
} | ||
token, err := c.oauth2Config.Exchange(r.Context(), q.Get("code")) | ||
if err != nil { | ||
return identity, fmt.Errorf("google: failed to get token: %v", err) | ||
} | ||
|
||
return c.createIdentity(r.Context(), identity, s, token) | ||
} | ||
|
||
func (c *googleConnector) Refresh(ctx context.Context, s connector.Scopes, identity connector.Identity) (connector.Identity, error) { | ||
t := &oauth2.Token{ | ||
RefreshToken: string(identity.ConnectorData), | ||
Expiry: time.Now().Add(-time.Hour), | ||
} | ||
token, err := c.oauth2Config.TokenSource(ctx, t).Token() | ||
if err != nil { | ||
return identity, fmt.Errorf("google: failed to get token: %v", err) | ||
} | ||
|
||
return c.createIdentity(ctx, identity, s, token) | ||
} | ||
|
||
func (c *googleConnector) createIdentity(ctx context.Context, identity connector.Identity, s connector.Scopes, token *oauth2.Token) (connector.Identity, error) { | ||
rawIDToken, ok := token.Extra("id_token").(string) | ||
if !ok { | ||
return identity, errors.New("google: no id_token in token response") | ||
} | ||
idToken, err := c.verifier.Verify(ctx, rawIDToken) | ||
if err != nil { | ||
return identity, fmt.Errorf("google: failed to verify ID Token: %v", err) | ||
} | ||
|
||
var claims struct { | ||
Username string `json:"name"` | ||
Email string `json:"email"` | ||
EmailVerified bool `json:"email_verified"` | ||
HostedDomain string `json:"hd"` | ||
} | ||
if err := idToken.Claims(&claims); err != nil { | ||
return identity, fmt.Errorf("oidc: failed to decode claims: %v", err) | ||
} | ||
|
||
if len(c.hostedDomains) > 0 { | ||
found := false | ||
for _, domain := range c.hostedDomains { | ||
if claims.HostedDomain == domain { | ||
found = true | ||
break | ||
} | ||
} | ||
|
||
if !found { | ||
return identity, fmt.Errorf("oidc: unexpected hd claim %v", claims.HostedDomain) | ||
} | ||
} | ||
|
||
var groups []string | ||
if s.Groups && c.adminEmail != "" && c.serviceAccountFilePath != "" { | ||
groups, err = c.getGroups(claims.Email) | ||
if err != nil { | ||
return identity, fmt.Errorf("google: could not retrieve groups: %v", err) | ||
} | ||
} | ||
|
||
identity = connector.Identity{ | ||
UserID: idToken.Subject, | ||
Username: claims.Username, | ||
Email: claims.Email, | ||
EmailVerified: claims.EmailVerified, | ||
ConnectorData: []byte(token.RefreshToken), | ||
Groups: groups, | ||
} | ||
return identity, nil | ||
} | ||
|
||
// getGroups creates a connection to the admin directory service and lists | ||
// all groups the user is a member of | ||
func (c *googleConnector) getGroups(email string) ([]string, error) { | ||
groupsList, err := c.adminSrv.Groups.List().UserKey(email).Do() | ||
if err != nil { | ||
return nil, fmt.Errorf("could not list groups: %v", err) | ||
} | ||
|
||
var userGroups []string | ||
for _, group := range groupsList.Groups { | ||
// TODO (joelspeed): Make desried group key configurable | ||
userGroups = append(userGroups, group.Email) | ||
JoelSpeed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
} | ||
|
||
return userGroups, nil | ||
} | ||
|
||
// createDirectoryService loads a google service account credentials file, | ||
// sets up super user impersonation and creates an admin client for calling | ||
// the google admin api | ||
func createDirectoryService(serviceAccountFilePath string, email string) (*admin.Service, error) { | ||
jsonCredentials, err := ioutil.ReadFile(serviceAccountFilePath) | ||
if err != nil { | ||
return nil, fmt.Errorf("error reading credentials from file: %v", err) | ||
} | ||
|
||
config, err := google.JWTConfigFromJSON(jsonCredentials, admin.AdminDirectoryGroupReadonlyScope) | ||
if err != nil { | ||
return nil, fmt.Errorf("unable to parse client secret file to config: %v", err) | ||
} | ||
|
||
// Impersonate an admin. This is mandatory for the admin APIs. | ||
config.Subject = email | ||
|
||
ctx := context.Background() | ||
client := config.Client(ctx) | ||
|
||
srv, err := admin.New(client) | ||
if err != nil { | ||
return nil, fmt.Errorf("unable to create directory service %v", err) | ||
} | ||
return srv, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: can this be optionally read from a file? e.g.
ClientSecretFile
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't see this being done in any of the other connectors but could add this. I assume the
ClientSecretFile
would just contain a single string? Or is there a format for files from Google containing theClientSecret
?