Merge pull request #103 from yifan-gu/offline

return refresh token only when scope contains 'offline_access'

Documentation/oidc-notes.md

@@ -11,30 +11,22 @@ Sec. 2. [ID Token](http://openid.net/specs/openid-connect-core-1_0.html#IDToken)
 - None of the OPTIONAL claims  (`acr`, `amr`, `azp`, `auth_time`) are supported
 - dex signs using JWS but does not do the OPTIONAL encryption.
 
-
 Sec. 3. [Authentication](http://openid.net/specs/openid-connect-core-1_0.html#Authentication)
 - Only the authorization code flow (where `response_type` is `code`) is supported.
 
 Sec. 3.1.2. [Authorization Endpoint](http://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint)
 - In a production system TLS is required but the dex web-server only supports HTTP right now - it is expected that until HTTPS is supported, TLS termination will be handled outside of dex.
 
-
 Sec. 3.1.2.1. [Authentication Request](http://openid.net/specs/openid-connect-core-1_0.html#AuthRequest)
-- dex doesn't check the value of "scope" to make sure it contains "openid" in authentication requests.
 - max_age not implemented; it's OPTIONAL in the spec, but if it's present servers MUST include auth_time, which dex does not.
 - None of the other OPTIONAL parameters are implemented with the exception of:
   - state
   - nonce
 - dex also defines a non-standard `register` parameter; when this parameter is `1`, end-users are taken through a registration flow, which after completing successfully, lands them at the specified `redirect_uri`
 
-Sec. 3.1.2.2. [Authentication Request Validation](http://openid.net/specs/openid-connect-core-1_0.html#AuthRequestValidation)
-- As mentioned earlier, dex doesn't validate that the `openid` scope value is present.
-
-
 Sec. 3.2.2.3. [Authorization Server Authenticates End-User](http://openid.net/specs/openid-connect-core-1_0.html#ImplicitAuthenticates)
 - The spec states that the authentication server "MUST NOT interact with the End-User" when `prompt` is `none` We don't check the prompt parameter at all; similarly, dex MUST re-prompt when `prompt` is `login` - dex does not do this either.
 
-
 Sec. 3.1.3.2. [Token Request Validation](http://openid.net/specs/openid-connect-core-1_0.html#TokenRequestValidation)
 - In Token requests, dex chooses to proceed without error when `redirect_uri` is not present and there's only one registered valid URI (which is valid behavior)
 
@@ -64,8 +56,8 @@ Sec. 9. [Client Authentication](http://openid.net/specs/openid-connect-core-1_0.
 - dex only supports the `client_secret_basic` client authentication type.
 
 Sec. 11. [Offline Access](http://openid.net/specs/openid-connect-core-1_0.html#OfflineAccess)
-- dex does not implement this feature.
-
+- offline_access in 'scope' is supported, but as we haven't implemented 'prompt' yet, the
+  spec's requirement is not fully met yet.
 
 Sec. 15.1.  [Mandatory to Implement Features for All OpenID Providers](http://openid.net/specs/openid-connect-core-1_0.html#ImplementationConsiderations)
 - dex is missing the follow mandatory features (some are already noted elsewhere in this document):

db/migrations/0007_session_scope.sql

+-- +migrate Up
+ALTER TABLE session ADD COLUMN "scope" text;

db/session.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"fmt"
 	"net/url"
+	"strings"
 	"time"
 
 	"github.com/go-gorp/gorp"
@@ -42,6 +43,7 @@ type sessionModel struct {
 	UserID      string `db:"user_id"`
 	Register    bool   `db:"register"`
 	Nonce       string `db:"nonce"`
+	Scope       string `db:"scope"`
 }
 
 func (s *sessionModel) session() (*session.Session, error) {
@@ -71,6 +73,7 @@ func (s *sessionModel) session() (*session.Session, error) {
 		UserID:      s.UserID,
 		Register:    s.Register,
 		Nonce:       s.Nonce,
+		Scope:       strings.Fields(s.Scope),
 	}
 
 	if s.CreatedAt != 0 {
@@ -101,6 +104,7 @@ func newSessionModel(s *session.Session) (*sessionModel, error) {
 		UserID:      s.UserID,
 		Register:    s.Register,
 		Nonce:       s.Nonce,
+		Scope:       strings.Join(s.Scope, " "),
 	}
 
 	if !s.CreatedAt.IsZero() {

integration/oidc_test.go

@@ -196,7 +196,7 @@ func TestHTTPExchangeTokenRefreshToken(t *testing.T) {
 
 	// this will actually happen due to some interaction between the
 	// end-user and a remote identity provider
-	sessionID, err := sm.NewSession("bogus_idpc", ci.Credentials.ID, "bogus", url.URL{}, "", false)
+	sessionID, err := sm.NewSession("bogus_idpc", ci.Credentials.ID, "bogus", url.URL{}, "", false, []string{"openid", "offline_access"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}

server/http.go

@@ -330,9 +330,37 @@ func handleAuthFunc(srv OIDCServer, idpcs []connector.Connector, tpl *template.T
 			return
 		}
 
+		// Check scopes.
+		var scopes []string
+		foundOpenIDScope := false
+		for _, scope := range acr.Scope {
+			switch scope {
+			case "openid":
+				foundOpenIDScope = true
+				scopes = append(scopes, scope)
+			case "offline_access":
+				// According to the spec, for offline_access scope, the client must
+				// use a response_type value that would result in an Authorization Code.
+				// Currently oauth2.ResponseTypeCode is the only supported response type,
+				// and it's been checked above, so we don't need to check it again here.
+				//
+				// TODO(yifan): Verify that 'consent' should be in 'prompt'.
+				scopes = append(scopes, scope)
+			default:
+				// Pass all other scopes.
+				scopes = append(scopes, scope)
+			}
+		}
+
+		if !foundOpenIDScope {
+			log.Errorf("Invalid auth request: missing 'openid' in 'scope'")
+			writeAuthError(w, oauth2.NewError(oauth2.ErrorInvalidRequest), acr.State)
+			return
+		}
+
 		nonce := q.Get("nonce")
 
-		key, err := srv.NewSession(connectorID, acr.ClientID, acr.State, redirectURL, nonce, register)
+		key, err := srv.NewSession(connectorID, acr.ClientID, acr.State, redirectURL, nonce, register, acr.Scope)
 		if err != nil {
 			log.Errorf("Error creating new session: %v: ", err)
 			redirectAuthError(w, err, acr.State, redirectURL)

server/http_test.go

@@ -102,6 +102,7 @@ func TestHandleAuthFuncResponsesSingleRedirectURL(t *testing.T) {
 				"response_type": []string{"code"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode:     http.StatusTemporaryRedirect,
 			wantLocation: "http://fake.example.com",
@@ -114,6 +115,7 @@ func TestHandleAuthFuncResponsesSingleRedirectURL(t *testing.T) {
 				"redirect_uri":  []string{"http://client.example.com/callback"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode:     http.StatusTemporaryRedirect,
 			wantLocation: "http://fake.example.com",
@@ -126,6 +128,7 @@ func TestHandleAuthFuncResponsesSingleRedirectURL(t *testing.T) {
 				"redirect_uri":  []string{"http://unrecognized.example.com/callback"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode: http.StatusBadRequest,
 		},
@@ -137,6 +140,7 @@ func TestHandleAuthFuncResponsesSingleRedirectURL(t *testing.T) {
 				"redirect_uri":  []string{"http://client.example.com/callback"},
 				"client_id":     []string{"YYY"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode: http.StatusBadRequest,
 		},
@@ -147,10 +151,22 @@ func TestHandleAuthFuncResponsesSingleRedirectURL(t *testing.T) {
 				"response_type": []string{"token"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode:     http.StatusTemporaryRedirect,
 			wantLocation: "http://client.example.com/callback?error=unsupported_response_type&state=",
 		},
+
+		// no 'openid' in scope
+		{
+			query: url.Values{
+				"response_type": []string{"code"},
+				"redirect_uri":  []string{"http://client.example.com/callback"},
+				"client_id":     []string{"XXX"},
+				"connector_id":  []string{"fake"},
+			},
+			wantCode: http.StatusBadRequest,
+		},
 	}
 
 	for i, tt := range tests {
@@ -211,6 +227,7 @@ func TestHandleAuthFuncResponsesMultipleRedirectURLs(t *testing.T) {
 				"redirect_uri":  []string{"http://foo.example.com/callback"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode:     http.StatusTemporaryRedirect,
 			wantLocation: "http://fake.example.com",
@@ -223,6 +240,7 @@ func TestHandleAuthFuncResponsesMultipleRedirectURLs(t *testing.T) {
 				"redirect_uri":  []string{"http://bar.example.com/callback"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode:     http.StatusTemporaryRedirect,
 			wantLocation: "http://fake.example.com",
@@ -235,6 +253,7 @@ func TestHandleAuthFuncResponsesMultipleRedirectURLs(t *testing.T) {
 				"redirect_uri":  []string{"http://unrecognized.example.com/callback"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode: http.StatusBadRequest,
 		},
@@ -245,6 +264,7 @@ func TestHandleAuthFuncResponsesMultipleRedirectURLs(t *testing.T) {
 				"response_type": []string{"code"},
 				"client_id":     []string{"XXX"},
 				"connector_id":  []string{"fake"},
+				"scope":         []string{"openid"},
 			},
 			wantCode: http.StatusBadRequest,
 		},

server/password_test.go

@@ -245,7 +245,7 @@ func TestSendResetPasswordEmailHandler(t *testing.T) {
 			t.Fatalf("case %d: could not make test fixtures: %v", i, err)
 		}
 
-		_, err = f.srv.NewSession("local", "XXX", "", f.redirectURL, "", true)
+		_, err = f.srv.NewSession("local", "XXX", "", f.redirectURL, "", true, []string{"openid"})
 		if err != nil {
 			t.Fatalf("case %d: could not create new session: %v", i, err)
 		}

server/register_test.go

@@ -197,7 +197,7 @@ func TestHandleRegister(t *testing.T) {
 			t.Fatalf("case %d: could not make test fixtures: %v", i, err)
 		}
 
-		key, err := f.srv.NewSession(tt.connID, "XXX", "", f.redirectURL, "", true)
+		key, err := f.srv.NewSession(tt.connID, "XXX", "", f.redirectURL, "", true, []string{"openid"})
 		t.Logf("case %d: key for NewSession: %v", i, key)
 
 		if tt.attachRemote {

server/server.go

@@ -39,7 +39,7 @@ const (
 
 type OIDCServer interface {
 	ClientMetadata(string) (*oidc.ClientMetadata, error)
-	NewSession(connectorID, clientID, clientState string, redirectURL url.URL, nonce string, register bool) (string, error)
+	NewSession(connectorID, clientID, clientState string, redirectURL url.URL, nonce string, register bool, scope []string) (string, error)
 	Login(oidc.Identity, string) (string, error)
 	// CodeToken exchanges a code for an ID token and a refresh token string on success.
 	CodeToken(creds oidc.ClientCredentials, sessionKey string) (*jose.JWT, string, error)
@@ -263,8 +263,8 @@ func (s *Server) ClientMetadata(clientID string) (*oidc.ClientMetadata, error) {
 	return s.ClientIdentityRepo.Metadata(clientID)
 }
 
-func (s *Server) NewSession(ipdcID, clientID, clientState string, redirectURL url.URL, nonce string, register bool) (string, error) {
-	sessionID, err := s.SessionManager.NewSession(ipdcID, clientID, clientState, redirectURL, nonce, register)
+func (s *Server) NewSession(ipdcID, clientID, clientState string, redirectURL url.URL, nonce string, register bool, scope []string) (string, error) {
+	sessionID, err := s.SessionManager.NewSession(ipdcID, clientID, clientState, redirectURL, nonce, register, scope)
 	if err != nil {
 		return "", err
 	}
@@ -422,13 +422,14 @@ func (s *Server) CodeToken(creds oidc.ClientCredentials, sessionKey string) (*jo
 		return nil, "", oauth2.NewError(oauth2.ErrorServerError)
 	}
 
-	log.Infof("Session %s token sent: clientID=%s", sessionID, creds.ID)
+	// Generate refresh token when 'scope' contains 'offline_access'.
+	var refreshToken string
+
+	for _, scope := range ses.Scope {
+		if scope == "offline_access" {
+			log.Infof("Session %s requests offline access, will generate refresh token", sessionID)
 
-	// Generate refresh token.
-	//
-	// TODO(yifan): Return refresh token only when 'access_type == offline',
-	// or 'scope' == 'offline_access'.
-	refreshToken, err := s.RefreshTokenRepo.Create(ses.UserID, creds.ID)
+			refreshToken, err = s.RefreshTokenRepo.Create(ses.UserID, creds.ID)
 			switch err {
 			case nil:
 				break
@@ -436,6 +437,11 @@ func (s *Server) CodeToken(creds oidc.ClientCredentials, sessionKey string) (*jo
 				log.Errorf("Failed to generate refresh token: %v", err)
 				return nil, "", oauth2.NewError(oauth2.ErrorServerError)
 			}
+			break
+		}
+	}
+
+	log.Infof("Session %s token sent: clientID=%s", sessionID, creds.ID)
 	return jwt, refreshToken, nil
 }
 
@@ -487,7 +493,7 @@ func (s *Server) RefreshToken(creds oidc.ClientCredentials, token string) (*jose
 		return nil, oauth2.NewError(oauth2.ErrorServerError)
 	}
 
-	log.Infof("Token refreshed sent: clientID=%s", creds.ID)
+	log.Infof("New token sent: clientID=%s", creds.ID)
 
 	return jwt, nil
 }

server/server_test.go

@@ -2,6 +2,7 @@ package server
 
 import (
 	"errors"
+	"fmt"
 	"net/url"
 	"reflect"
 	"testing"
@@ -139,7 +140,7 @@ func TestServerNewSession(t *testing.T) {
 		},
 	}
 
-	key, err := srv.NewSession("bogus_idpc", ci.Credentials.ID, state, ci.Metadata.RedirectURLs[0], nonce, false)
+	key, err := srv.NewSession("bogus_idpc", ci.Credentials.ID, state, ci.Metadata.RedirectURLs[0], nonce, false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -195,7 +196,7 @@ func TestServerLogin(t *testing.T) {
 
 	sm := session.NewSessionManager(session.NewSessionRepo(), session.NewSessionKeyRepo())
 	sm.GenerateCode = staticGenerateCodeFunc("fakecode")
-	sessionID, err := sm.NewSession("test_connector_id", ci.Credentials.ID, "bogus", ci.Metadata.RedirectURLs[0], "", false)
+	sessionID, err := sm.NewSession("test_connector_id", ci.Credentials.ID, "bogus", ci.Metadata.RedirectURLs[0], "", false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -292,34 +293,52 @@ func TestServerCodeToken(t *testing.T) {
 		RefreshTokenRepo:   refreshTokenRepo,
 	}
 
-	sessionID, err := sm.NewSession("bogus_idpc", ci.Credentials.ID, "bogus", url.URL{}, "", false)
+	tests := []struct {
+		scope        []string
+		refreshToken string
+	}{
+		// No 'offline_access' in scope, should get empty refresh token.
+		{
+			scope:        []string{"openid"},
+			refreshToken: "",
+		},
+		// Have 'offline_access' in scope, should get non-empty refresh token.
+		{
+			scope:        []string{"openid", "offline_access"},
+			refreshToken: "0/refresh-1",
+		},
+	}
+
+	for i, tt := range tests {
+		sessionID, err := sm.NewSession("bogus_idpc", ci.Credentials.ID, "bogus", url.URL{}, "", false, tt.scope)
 		if err != nil {
-		t.Fatalf("Unexpected error: %v", err)
+			t.Fatalf("case %d: unexpected error: %v", i, err)
 		}
 		_, err = sm.AttachRemoteIdentity(sessionID, oidc.Identity{})
 		if err != nil {
-		t.Fatalf("Unexpected error: %v", err)
+			t.Fatalf("case %d: unexpected error: %v", i, err)
 		}
 
 		_, err = sm.AttachUser(sessionID, "testid-1")
 		if err != nil {
-		t.Fatalf("Unexpected error: %v", err)
+			t.Fatalf("case %d: unexpected error: %v", i, err)
 		}
 
 		key, err := sm.NewSessionKey(sessionID)
 		if err != nil {
-		t.Fatalf("Unexpected error: %v", err)
+			t.Fatalf("case %d: unexpected error: %v", i, err)
 		}
 
 		jwt, token, err := srv.CodeToken(ci.Credentials, key)
 		if err != nil {
-		t.Fatalf("Unexpected error: %v", err)
+			t.Fatalf("case %d: unexpected error: %v", i, err)
 		}
 		if jwt == nil {
-		t.Fatalf("Expected non-nil jwt")
+			t.Fatalf("case %d: expect non-nil jwt", i)
+		}
+		if token != tt.refreshToken {
+			t.Fatalf("case %d: expect refresh token %q, got %q", i, tt.refreshToken, token)
 		}
-	if token == "" {
-		t.Fatalf("Expected non-empty refresh token")
 	}
 }
 
@@ -343,7 +362,7 @@ func TestServerTokenUnrecognizedKey(t *testing.T) {
 		ClientIdentityRepo: ciRepo,
 	}
 
-	sessionID, err := sm.NewSession("connector_id", ci.Credentials.ID, "bogus", url.URL{}, "", false)
+	sessionID, err := sm.NewSession("connector_id", ci.Credentials.ID, "bogus", url.URL{}, "", false, []string{"openid", "offline_access"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -379,12 +398,24 @@ func TestServerTokenFail(t *testing.T) {
 		argCC        oidc.ClientCredentials
 		argKey       string
 		err          string
+		scope        []string
+		refreshToken string
 	}{
 		// control test case to make sure fixtures check out
 		{
 			signer:       signerFixture,
 			argCC:        ccFixture,
 			argKey:       keyFixture,
+			scope:        []string{"openid", "offline_access"},
+			refreshToken: "0/refresh-1",
+		},
+
+		// no 'offline_access' in 'scope', should get empty refresh token
+		{
+			signer: signerFixture,
+			argCC:  ccFixture,
+			argKey: keyFixture,
+			scope:  []string{"openid"},
 		},
 
 		// unrecognized key
@@ -393,6 +424,7 @@ func TestServerTokenFail(t *testing.T) {
 			argCC:  ccFixture,
 			argKey: "foo",
 			err:    oauth2.ErrorInvalidGrant,
+			scope:  []string{"openid", "offline_access"},
 		},
 
 		// unrecognized client
@@ -401,6 +433,7 @@ func TestServerTokenFail(t *testing.T) {
 			argCC:  oidc.ClientCredentials{ID: "YYY"},
 			argKey: keyFixture,
 			err:    oauth2.ErrorInvalidClient,
+			scope:  []string{"openid", "offline_access"},
 		},
 
 		// signing operation fails
@@ -409,6 +442,7 @@ func TestServerTokenFail(t *testing.T) {
 			argCC:  ccFixture,
 			argKey: keyFixture,
 			err:    oauth2.ErrorServerError,
+			scope:  []string{"openid", "offline_access"},
 		},
 	}
 
@@ -416,7 +450,7 @@ func TestServerTokenFail(t *testing.T) {
 		sm := session.NewSessionManager(session.NewSessionRepo(), session.NewSessionKeyRepo())
 		sm.GenerateCode = func() (string, error) { return keyFixture, nil }
 
-		sessionID, err := sm.NewSession("connector_id", ccFixture.ID, "bogus", url.URL{}, "", false)
+		sessionID, err := sm.NewSession("connector_id", ccFixture.ID, "bogus", url.URL{}, "", false, tt.scope)
 		if err != nil {
 			t.Fatalf("Unexpected error: %v", err)
 		}
@@ -435,7 +469,7 @@ func TestServerTokenFail(t *testing.T) {
 
 		_, err = sm.AttachUser(sessionID, "testid-1")
 		if err != nil {
-			t.Fatalf("case %d: Unexpected error: %v", i, err)
+			t.Fatalf("case %d: unexpected error: %v", i, err)
 		}
 
 		userRepo, err := makeNewUserRepo()
@@ -463,22 +497,22 @@ func TestServerTokenFail(t *testing.T) {
 		}
 
 		jwt, token, err := srv.CodeToken(tt.argCC, tt.argKey)
+		if token != tt.refreshToken {
+			fmt.Printf("case %d: expect refresh token %q, got %q\n", i, tt.refreshToken, token)
+			t.Fatalf("case %d: expect refresh token %q, got %q", i, tt.refreshToken, token)
+			panic("")
+		}
 		if tt.err == "" {
 			if err != nil {
 				t.Errorf("case %d: got non-nil error: %v", i, err)
 			} else if jwt == nil {
 				t.Errorf("case %d: got nil JWT", i)
-			} else if token == "" {
-				t.Errorf("case %d: got empty refresh token", i)
 			}
-
 		} else {
 			if err.Error() != tt.err {
 				t.Errorf("case %d: want err %q, got %q", i, tt.err, err.Error())
 			} else if jwt != nil {
 				t.Errorf("case %d: got non-nil JWT", i)
-			} else if token != "" {
-				t.Errorf("case %d: got non-empty refresh token", i)
 			}
 		}
 	}

session/manager.go

@@ -44,7 +44,7 @@ type SessionManager struct {
 	keys           SessionKeyRepo
 }
 
-func (m *SessionManager) NewSession(connectorID, clientID, clientState string, redirectURL url.URL, nonce string, register bool) (string, error) {
+func (m *SessionManager) NewSession(connectorID, clientID, clientState string, redirectURL url.URL, nonce string, register bool, scope []string) (string, error) {
 	sID, err := m.GenerateCode()
 	if err != nil {
 		return "", err
@@ -62,6 +62,7 @@ func (m *SessionManager) NewSession(connectorID, clientID, clientState string, r
 		RedirectURL: redirectURL,
 		Register:    register,
 		Nonce:       nonce,
+		Scope:       scope,
 	}
 
 	err = m.sessions.Create(s)

session/manager_test.go

@@ -16,7 +16,7 @@ func staticGenerateCodeFunc(code string) GenerateCodeFunc {
 func TestSessionManagerNewSession(t *testing.T) {
 	sm := NewSessionManager(NewSessionRepo(), NewSessionKeyRepo())
 	sm.GenerateCode = staticGenerateCodeFunc("boo")
-	got, err := sm.NewSession("bogus_idpc", "XXX", "bogus", url.URL{}, "", false)
+	got, err := sm.NewSession("bogus_idpc", "XXX", "bogus", url.URL{}, "", false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -27,7 +27,7 @@ func TestSessionManagerNewSession(t *testing.T) {
 
 func TestSessionAttachRemoteIdentityTwice(t *testing.T) {
 	sm := NewSessionManager(NewSessionRepo(), NewSessionKeyRepo())
-	sessionID, err := sm.NewSession("bogus_idpc", "XXX", "bogus", url.URL{}, "", false)
+	sessionID, err := sm.NewSession("bogus_idpc", "XXX", "bogus", url.URL{}, "", false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -44,7 +44,7 @@ func TestSessionAttachRemoteIdentityTwice(t *testing.T) {
 
 func TestSessionManagerExchangeKey(t *testing.T) {
 	sm := NewSessionManager(NewSessionRepo(), NewSessionKeyRepo())
-	sessionID, err := sm.NewSession("connector_id", "XXX", "bogus", url.URL{}, "", false)
+	sessionID, err := sm.NewSession("connector_id", "XXX", "bogus", url.URL{}, "", false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -80,7 +80,7 @@ func TestSessionManagerGetSessionInStateNoExist(t *testing.T) {
 
 func TestSessionManagerGetSessionInStateWrongState(t *testing.T) {
 	sm := NewSessionManager(NewSessionRepo(), NewSessionKeyRepo())
-	sessionID, err := sm.NewSession("connector_id", "XXX", "bogus", url.URL{}, "", false)
+	sessionID, err := sm.NewSession("connector_id", "XXX", "bogus", url.URL{}, "", false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}
@@ -95,7 +95,7 @@ func TestSessionManagerGetSessionInStateWrongState(t *testing.T) {
 
 func TestSessionManagerKill(t *testing.T) {
 	sm := NewSessionManager(NewSessionRepo(), NewSessionKeyRepo())
-	sessionID, err := sm.NewSession("connector_id", "XXX", "bogus", url.URL{}, "", false)
+	sessionID, err := sm.NewSession("connector_id", "XXX", "bogus", url.URL{}, "", false, []string{"openid"})
 	if err != nil {
 		t.Fatalf("Unexpected error: %v", err)
 	}

session/session.go

@@ -48,6 +48,9 @@ type Session struct {
 
 	// Nonce is optionally provided in the initial authorization request, and propogated in such cases to the generated claims.
 	Nonce string
+
+	// Scope is the 'scope' field in the authentication request. Example scopes are 'openid', 'email', 'offline', etc.
+	Scope []string
 }
 
 // Claims returns a new set of Claims for the current session.