git.iko.soy/typeable/oauth2-proxy
on master help sign in
Add support to ensure user belongs in required groups when using the OIDC provider
commit9d59519a96c5e57ac858473bcd4ca9d411a5f679 authorStefan Sedich <stefan.sedich@gmail.com> dateTue 28 Jul 2020, 11:42 (6 years ago) parenta87beab
10 files changed+281−18
CHANGELOG.md+3 docs/configuration/configuration.md+4−2 oauthproxy.go+44−1 oauthproxy_test.go+146−1 pkg/apis/options/options.go+5 pkg/apis/sessions/session_state.go+6−1 pkg/apis/sessions/session_state_test.go+11 pkg/validation/options.go+5 providers/oidc.go+23 providers/oidc_test.go+34−13
CHANGELOG.md+3
@@ -4,11 +4,14 @@
44
55## Important Notes
66
7+- [#616](https://github.com/oauth2-proxy/oauth2-proxy/pull/616) Ensure you have configured oauth2-proxy to use the `groups` scope. The user may be logged out initially as they may not currently have the `groups` claim however after going back through login process wil be authenticated.
8+
79## Breaking Changes
810
911## Changes since v6.1.1
1012
1113- [#764](https://github.com/oauth2-proxy/oauth2-proxy/pull/764) Document bcrypt encryption for htpasswd (and hide SHA) (@lentzi90)
14+- [#616](https://github.com/oauth2-proxy/oauth2-proxy/pull/616) Add support to ensure user belongs in required groups when using the OIDC provider (@stefansedich)
1215
1316# v6.1.1
1417
docs/configuration/configuration.md+4−2
@@ -78,12 +78,13 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
7878| `--insecure-oidc-skip-issuer-verification` | bool | allow the OIDC issuer URL to differ from the expected (currently required for Azure multi-tenant compatibility) | false |
7979| `--oidc-issuer-url` | string | the OpenID Connect issuer URL, e.g. `"https://accounts.google.com"` | |
8080| `--oidc-jwks-url` | string | OIDC JWKS URI for token verification; required if OIDC discovery is disabled | |
81+| `--oidc-groups-claim` | string | which claim contains the user groups | `"groups"` |
8182| `--pass-access-token` | bool | pass OAuth access_token to upstream via X-Forwarded-Access-Token header | false |
8283| `--pass-authorization-header` | bool | pass OIDC IDToken to upstream via Authorization Bearer header | false |
8384| `--pass-basic-auth` | bool | pass HTTP Basic Auth, X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
8485| `--prefer-email-to-user` | bool | Prefer to use the Email address as the Username when passing information to upstream. Will only use Username if Email is unavailable, e.g. htaccess authentication. Used in conjunction with `--pass-basic-auth` and `--pass-user-headers` | false |
8586| `--pass-host-header` | bool | pass the request Host Header to upstream | true |
86−| `--pass-user-headers` | bool | pass X-Forwarded-User, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
87+| `--pass-user-headers` | bool | pass X-Forwarded-User, X-Forwarded-Groups, X-Forwarded-Email and X-Forwarded-Preferred-Username information to upstream | true |
8788| `--profile-url` | string | Profile access endpoint | |
8889| `--prompt` | string | [OIDC prompt](https://openid.net/specs/openid-connect-core-1_0.html#AuthRequest); if present, `approval-prompt` is ignored | `""` |
8990| `--provider` | string | OAuth provider | google |
@@ -112,7 +113,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
112113| `--scope` | string | OAuth scope specification | |
113114| `--session-cookie-minimal` | bool | strip OAuth tokens from cookie session stores if they aren't needed (cookie session store only) | false |
114115| `--session-store-type` | string | [Session data storage backend](configuration/sessions); redis or cookie | cookie |
115−| `--set-xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode) | false |
116+| `--set-xauthrequest` | bool | set X-Auth-Request-User, X-Auth-Request-Groups, X-Auth-Request-Email and X-Auth-Request-Preferred-Username response headers (useful in Nginx auth_request mode) | false |
116117| `--set-authorization-header` | bool | set Authorization Bearer response header (useful in Nginx auth_request mode) | false |
117118| `--set-basic-auth` | bool | set HTTP Basic Auth information in response (useful in Nginx auth_request mode) | false |
118119| `--signature-key` | string | GAP-Signature request signature key (algorithm:secretkey) | |
@@ -131,6 +132,7 @@ An example [oauth2-proxy.cfg]({{ site.gitweb }}/contrib/oauth2-proxy.cfg.example
131132| `--tls-key-file` | string | path to private key file | |
132133| `--upstream` | string \| list | the http url(s) of the upstream endpoint, file:// paths for static files or `static://<status_code>` for static response. Routing is based on the path | |
133134| `--user-id-claim` | string | which claim contains the user ID | \["email"\] |
135+| `--allowed-group` | string \| list | restrict logins to members of this group (may be given multiple times) | |
134136| `--validate-url` | string | Access token validation endpoint | |
135137| `--version` | n/a | print version string | |
136138| `--whitelist-domain` | string \| list | allowed domains for redirection after authentication. Prefix domain with a `.` to allow subdomains (e.g. `.example.com`)&nbsp;\[[2](#footnote2)\] | |
oauthproxy.go+44−1
@@ -102,6 +102,7 @@ type OAuthProxy struct {
102102 trustedIPs *ip.NetSet
103103 Banner string
104104 Footer string
105+ AllowedGroups []string
105106
106107 sessionChain alice.Chain
107108}
@@ -215,6 +216,7 @@ func NewOAuthProxy(opts *options.Options, validator func(string) bool) (*OAuthPr
215216 Banner: opts.Banner,
216217 Footer: opts.Footer,
217218 SignInMessage: buildSignInMessage(opts),
219+ AllowedGroups: opts.AllowedGroups,
218220
219221 basicAuthValidator: basicAuthValidator,
220222 displayHtpasswdForm: basicAuthValidator != nil,
@@ -888,7 +890,10 @@ func (p *OAuthProxy) getAuthenticatedSession(rw http.ResponseWriter, req *http.R
888890 return nil, ErrNeedsLogin
889891 }
890892
891− if session != nil && session.Email != "" && !p.Validator(session.Email) {
893+ invalidEmail := session != nil && session.Email != "" && !p.Validator(session.Email)
894+ invalidGroups := session != nil && !p.validateGroups(session.Groups)
895+
896+ if invalidEmail || invalidGroups {
892897 logger.Printf(session.Email, req, logger.AuthFailure, "Invalid authentication via session: removing session %s", session)
893898 // Invalid session, clear it
894899 err := p.ClearSessionCookie(rw, req)
@@ -942,6 +947,14 @@ func (p *OAuthProxy) addHeadersForProxying(rw http.ResponseWriter, req *http.Req
942947 } else {
943948 req.Header.Del("X-Forwarded-Preferred-Username")
944949 }
950+
951+ if len(session.Groups) > 0 {
952+ for _, group := range session.Groups {
953+ req.Header.Add("X-Forwarded-Groups", group)
954+ }
955+ } else {
956+ req.Header.Del("X-Forwarded-Groups")
957+ }
945958 }
946959
947960 if p.SetXAuthRequest {
@@ -964,6 +977,14 @@ func (p *OAuthProxy) addHeadersForProxying(rw http.ResponseWriter, req *http.Req
964977 rw.Header().Del("X-Auth-Request-Access-Token")
965978 }
966979 }
980+
981+ if len(session.Groups) > 0 {
982+ for _, group := range session.Groups {
983+ rw.Header().Add("X-Auth-Request-Groups", group)
984+ }
985+ } else {
986+ rw.Header().Del("X-Auth-Request-Groups")
987+ }
967988 }
968989
969990 if p.PassAccessToken {
@@ -1012,6 +1033,7 @@ func (p *OAuthProxy) addHeadersForProxying(rw http.ResponseWriter, req *http.Req
10121033func (p *OAuthProxy) stripAuthHeaders(req *http.Request) {
10131034 if p.PassBasicAuth {
10141035 req.Header.Del("X-Forwarded-User")
1036+ req.Header.Del("X-Forwarded-Groups")
10151037 req.Header.Del("X-Forwarded-Email")
10161038 req.Header.Del("X-Forwarded-Preferred-Username")
10171039 req.Header.Del("Authorization")
@@ -1019,6 +1041,7 @@ func (p *OAuthProxy) stripAuthHeaders(req *http.Request) {
10191041
10201042 if p.PassUserHeaders {
10211043 req.Header.Del("X-Forwarded-User")
1044+ req.Header.Del("X-Forwarded-Groups")
10221045 req.Header.Del("X-Forwarded-Email")
10231046 req.Header.Del("X-Forwarded-Preferred-Username")
10241047 }
@@ -1049,3 +1072,23 @@ func (p *OAuthProxy) ErrorJSON(rw http.ResponseWriter, code int) {
10491072 rw.Header().Set("Content-Type", applicationJSON)
10501073 rw.WriteHeader(code)
10511074}
1075+
1076+func (p *OAuthProxy) validateGroups(groups []string) bool {
1077+ if len(p.AllowedGroups) == 0 {
1078+ return true
1079+ }
1080+
1081+ allowedGroups := map[string]struct{}{}
1082+
1083+ for _, group := range p.AllowedGroups {
1084+ allowedGroups[group] = struct{}{}
1085+ }
1086+
1087+ for _, group := range groups {
1088+ if _, ok := allowedGroups[group]; ok {
1089+ return true
1090+ }
1091+ }
1092+
1093+ return false
1094+}
oauthproxy_test.go+146−1
@@ -592,6 +592,37 @@ func TestPassUserHeadersWithEmail(t *testing.T) {
592592 }
593593}
594594
595+func TestPassGroupsHeadersWithGroups(t *testing.T) {
596+ opts := baseTestOptions()
597+ err := validation.Validate(opts)
598+ assert.NoError(t, err)
599+
600+ const emailAddress = "john.doe@example.com"
601+ const userName = "9fcab5c9b889a557"
602+
603+ groups := []string{"a", "b"}
604+ created := time.Now()
605+ session := &sessions.SessionState{
606+ User: userName,
607+ Groups: groups,
608+ Email: emailAddress,
609+ AccessToken: "oauth_token",
610+ CreatedAt: &created,
611+ }
612+ {
613+ rw := httptest.NewRecorder()
614+ req, _ := http.NewRequest("GET", opts.ProxyPrefix+"/testCase0", nil)
615+ proxy, err := NewOAuthProxy(opts, func(email string) bool {
616+ return email == emailAddress
617+ })
618+ if err != nil {
619+ t.Fatal(err)
620+ }
621+ proxy.addHeadersForProxying(rw, req, session)
622+ assert.Equal(t, groups, req.Header["X-Forwarded-Groups"])
623+ }
624+}
625+
595626func TestStripAuthHeaders(t *testing.T) {
596627 testCases := map[string]struct {
597628 SkipAuthStripHeaders bool
@@ -609,6 +640,7 @@ func TestStripAuthHeaders(t *testing.T) {
609640 PassAuthorization: false,
610641 StrippedHeaders: map[string]bool{
611642 "X-Forwarded-User": true,
643+ "X-Forwared-Groups": true,
612644 "X-Forwarded-Email": true,
613645 "X-Forwarded-Preferred-Username": true,
614646 "X-Forwarded-Access-Token": false,
@@ -623,6 +655,7 @@ func TestStripAuthHeaders(t *testing.T) {
623655 PassAuthorization: false,
624656 StrippedHeaders: map[string]bool{
625657 "X-Forwarded-User": true,
658+ "X-Forwared-Groups": true,
626659 "X-Forwarded-Email": true,
627660 "X-Forwarded-Preferred-Username": true,
628661 "X-Forwarded-Access-Token": true,
@@ -637,6 +670,7 @@ func TestStripAuthHeaders(t *testing.T) {
637670 PassAuthorization: false,
638671 StrippedHeaders: map[string]bool{
639672 "X-Forwarded-User": true,
673+ "X-Forwared-Groups": true,
640674 "X-Forwarded-Email": true,
641675 "X-Forwarded-Preferred-Username": true,
642676 "X-Forwarded-Access-Token": true,
@@ -651,6 +685,7 @@ func TestStripAuthHeaders(t *testing.T) {
651685 PassAuthorization: true,
652686 StrippedHeaders: map[string]bool{
653687 "X-Forwarded-User": false,
688+ "X-Forwared-Groups": false,
654689 "X-Forwarded-Email": false,
655690 "X-Forwarded-Preferred-Username": false,
656691 "X-Forwarded-Access-Token": false,
@@ -665,6 +700,7 @@ func TestStripAuthHeaders(t *testing.T) {
665700 PassAuthorization: false,
666701 StrippedHeaders: map[string]bool{
667702 "X-Forwarded-User": false,
703+ "X-Forwared-Groups": false,
668704 "X-Forwarded-Email": false,
669705 "X-Forwarded-Preferred-Username": false,
670706 "X-Forwarded-Access-Token": false,
@@ -679,6 +715,7 @@ func TestStripAuthHeaders(t *testing.T) {
679715 PassAuthorization: false,
680716 StrippedHeaders: map[string]bool{
681717 "X-Forwarded-User": false,
718+ "X-Forwared-Groups": false,
682719 "X-Forwarded-Email": false,
683720 "X-Forwarded-Preferred-Username": false,
684721 "X-Forwarded-Access-Token": false,
@@ -690,6 +727,7 @@ func TestStripAuthHeaders(t *testing.T) {
690727 initialHeaders := map[string]string{
691728 "X-Forwarded-User": "9fcab5c9b889a557",
692729 "X-Forwarded-Email": "john.doe@example.com",
730+ "X-Forwarded-Groups": "a,b,c",
693731 "X-Forwarded-Preferred-Username": "john.doe",
694732 "X-Forwarded-Access-Token": "AccessToken",
695733 "Authorization": "bearer IDToken",
@@ -1333,6 +1371,7 @@ func TestAuthOnlyEndpointSetXAuthRequestHeaders(t *testing.T) {
13331371
13341372 pcTest.opts = baseTestOptions()
13351373 pcTest.opts.SetXAuthRequest = true
1374+ pcTest.opts.AllowedGroups = []string{"oauth_groups"}
13361375 err := validation.Validate(pcTest.opts)
13371376 assert.NoError(t, err)
13381377
@@ -1354,13 +1393,14 @@ func TestAuthOnlyEndpointSetXAuthRequestHeaders(t *testing.T) {
13541393
13551394 created := time.Now()
13561395 startSession := &sessions.SessionState{
1357− User: "oauth_user", Email: "oauth_user@example.com", AccessToken: "oauth_token", CreatedAt: &created}
1396+ User: "oauth_user", Groups: []string{"oauth_groups"}, Email: "oauth_user@example.com", AccessToken: "oauth_token", CreatedAt: &created}
13581397 err = pcTest.SaveSession(startSession)
13591398 assert.NoError(t, err)
13601399
13611400 pcTest.proxy.ServeHTTP(pcTest.rw, pcTest.req)
13621401 assert.Equal(t, http.StatusAccepted, pcTest.rw.Code)
13631402 assert.Equal(t, "oauth_user", pcTest.rw.Header().Get("X-Auth-Request-User"))
1403+ assert.Equal(t, startSession.Groups, pcTest.rw.Header().Values("X-Auth-Request-Groups"))
13641404 assert.Equal(t, "oauth_user@example.com", pcTest.rw.Header().Get("X-Auth-Request-Email"))
13651405}
13661406
@@ -2199,3 +2239,108 @@ func TestTrustedIPs(t *testing.T) {
21992239 })
22002240 }
22012241}
2242+
2243+func TestProxyAllowedGroups(t *testing.T) {
2244+ tests := []struct {
2245+ name string
2246+ allowedGroups []string
2247+ groups []string
2248+ expectUnauthorized bool
2249+ }{
2250+ {"NoAllowedGroups", []string{}, []string{}, false},
2251+ {"NoAllowedGroupsUserHasGroups", []string{}, []string{"a", "b"}, false},
2252+ {"UserInAllowedGroup", []string{"a"}, []string{"a", "b"}, false},
2253+ {"UserNotInAllowedGroup", []string{"a"}, []string{"c"}, true},
2254+ }
2255+
2256+ for _, tt := range tests {
2257+ t.Run(tt.name, func(t *testing.T) {
2258+ emailAddress := "test"
2259+ created := time.Now()
2260+
2261+ session := &sessions.SessionState{
2262+ Groups: tt.groups,
2263+ Email: emailAddress,
2264+ AccessToken: "oauth_token",
2265+ CreatedAt: &created,
2266+ }
2267+
2268+ upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2269+ w.WriteHeader(200)
2270+ }))
2271+ t.Cleanup(upstream.Close)
2272+
2273+ test, err := NewProcessCookieTestWithOptionsModifiers(func(opts *options.Options) {
2274+ opts.AllowedGroups = tt.allowedGroups
2275+ opts.UpstreamServers = options.Upstreams{
2276+ {
2277+ ID: upstream.URL,
2278+ Path: "/",
2279+ URI: upstream.URL,
2280+ },
2281+ }
2282+ })
2283+ if err != nil {
2284+ t.Fatal(err)
2285+ }
2286+
2287+ test.req, _ = http.NewRequest("GET", "/", nil)
2288+
2289+ test.req.Header.Add("accept", applicationJSON)
2290+ test.SaveSession(session)
2291+ test.proxy.ServeHTTP(test.rw, test.req)
2292+
2293+ if tt.expectUnauthorized {
2294+ assert.Equal(t, http.StatusUnauthorized, test.rw.Code)
2295+ } else {
2296+ assert.Equal(t, http.StatusOK, test.rw.Code)
2297+ }
2298+ })
2299+ }
2300+}
2301+
2302+func TestAuthOnlyAllowedGroups(t *testing.T) {
2303+ tests := []struct {
2304+ name string
2305+ allowedGroups []string
2306+ groups []string
2307+ expectUnauthorized bool
2308+ }{
2309+ {"NoAllowedGroups", []string{}, []string{}, false},
2310+ {"NoAllowedGroupsUserHasGroups", []string{}, []string{"a", "b"}, false},
2311+ {"UserInAllowedGroup", []string{"a"}, []string{"a", "b"}, false},
2312+ {"UserNotInAllowedGroup", []string{"a"}, []string{"c"}, true},
2313+ }
2314+
2315+ for _, tt := range tests {
2316+ t.Run(tt.name, func(t *testing.T) {
2317+ emailAddress := "test"
2318+ created := time.Now()
2319+
2320+ session := &sessions.SessionState{
2321+ Groups: tt.groups,
2322+ Email: emailAddress,
2323+ AccessToken: "oauth_token",
2324+ CreatedAt: &created,
2325+ }
2326+
2327+ test, err := NewAuthOnlyEndpointTest(func(opts *options.Options) {
2328+ opts.AllowedGroups = tt.allowedGroups
2329+ })
2330+ if err != nil {
2331+ t.Fatal(err)
2332+ }
2333+
2334+ err = test.SaveSession(session)
2335+ assert.NoError(t, err)
2336+
2337+ test.proxy.ServeHTTP(test.rw, test.req)
2338+
2339+ if tt.expectUnauthorized {
2340+ assert.Equal(t, http.StatusUnauthorized, test.rw.Code)
2341+ } else {
2342+ assert.Equal(t, http.StatusAccepted, test.rw.Code)
2343+ }
2344+ })
2345+ }
2346+}
pkg/apis/options/options.go+5
@@ -93,6 +93,7 @@ type Options struct {
9393 InsecureOIDCSkipIssuerVerification bool `flag:"insecure-oidc-skip-issuer-verification" cfg:"insecure_oidc_skip_issuer_verification"`
9494 SkipOIDCDiscovery bool `flag:"skip-oidc-discovery" cfg:"skip_oidc_discovery"`
9595 OIDCJwksURL string `flag:"oidc-jwks-url" cfg:"oidc_jwks_url"`
96+ OIDCGroupsClaim string `flag:"oidc-groups-claim" cfg:"oidc_groups_claim"`
9697 LoginURL string `flag:"login-url" cfg:"login_url"`
9798 RedeemURL string `flag:"redeem-url" cfg:"redeem_url"`
9899 ProfileURL string `flag:"profile-url" cfg:"profile_url"`
@@ -102,6 +103,7 @@ type Options struct {
102103 Prompt string `flag:"prompt" cfg:"prompt"`
103104 ApprovalPrompt string `flag:"approval-prompt" cfg:"approval_prompt"` // Deprecated by OIDC 1.0
104105 UserIDClaim string `flag:"user-id-claim" cfg:"user_id_claim"`
106+ AllowedGroups []string `flag:"allowed-group" cfg:"allowed_groups"`
105107
106108 SignatureKey string `flag:"signature-key" cfg:"signature_key"`
107109 AcrValues string `flag:"acr-values" cfg:"acr_values"`
@@ -167,6 +169,7 @@ func NewOptions() *Options {
167169 InsecureOIDCAllowUnverifiedEmail: false,
168170 SkipOIDCDiscovery: false,
169171 Logging: loggingDefaults(),
172+ OIDCGroupsClaim: "groups",
170173 }
171174}
172175
@@ -248,6 +251,7 @@ func NewFlagSet() *pflag.FlagSet {
248251 flagSet.Bool("insecure-oidc-skip-issuer-verification", false, "Do not verify if issuer matches OIDC discovery URL")
249252 flagSet.Bool("skip-oidc-discovery", false, "Skip OIDC discovery and use manually supplied Endpoints")
250253 flagSet.String("oidc-jwks-url", "", "OpenID Connect JWKS URL (ie: https://www.googleapis.com/oauth2/v3/certs)")
254+ flagSet.String("oidc-groups-claim", "groups", "which claim contains the user groups")
251255 flagSet.String("login-url", "", "Authentication endpoint")
252256 flagSet.String("redeem-url", "", "Token redemption endpoint")
253257 flagSet.String("profile-url", "", "Profile access endpoint")
@@ -265,6 +269,7 @@ func NewFlagSet() *pflag.FlagSet {
265269 flagSet.Bool("gcp-healthchecks", false, "Enable GCP/GKE healthcheck endpoints")
266270
267271 flagSet.String("user-id-claim", "email", "which claim contains the user ID")
272+ flagSet.StringSlice("allowed-group", []string{}, "restrict logins to members of this group (may be given multiple times)")
268273
269274 flagSet.AddFlagSet(cookieFlagSet())
270275 flagSet.AddFlagSet(loggingFlagSet())
pkg/apis/sessions/session_state.go+6−1
@@ -7,6 +7,7 @@ import (
77 "fmt"
88 "io"
99 "io/ioutil"
10+ "reflect"
1011 "time"
1112 "unicode/utf8"
1213
@@ -24,6 +25,7 @@ type SessionState struct {
2425 RefreshToken string `json:",omitempty" msgpack:"rt,omitempty"`
2526 Email string `json:",omitempty" msgpack:"e,omitempty"`
2627 User string `json:",omitempty" msgpack:"u,omitempty"`
28+ Groups []string `json:",omitempty" msgpack:"g,omitempty"`
2729 PreferredUsername string `json:",omitempty" msgpack:"pu,omitempty"`
2830}
2931
@@ -61,6 +63,9 @@ func (s *SessionState) String() string {
6163 if s.RefreshToken != "" {
6264 o += " refresh_token:true"
6365 }
66+ if len(s.Groups) > 0 {
67+ o += fmt.Sprintf(" groups:%v", s.Groups)
68+ }
6469 return o + "}"
6570}
6671
@@ -233,7 +238,7 @@ func (s *SessionState) validate() error {
233238 }
234239
235240 empty := new(SessionState)
236− if *s == *empty {
241+ if reflect.DeepEqual(*s, *empty) {
237242 return errors.New("invalid empty session unmarshalled")
238243 }
239244
pkg/apis/sessions/session_state_test.go+11
@@ -186,6 +186,17 @@ func TestEncodeAndDecodeSessionState(t *testing.T) {
186186 IDToken: "IDToken.12349871293847fdsaihf9238h4f91h8fr.1349f831y98fd7",
187187 ExpiresOn: &expires,
188188 },
189+ "With groups": {
190+ Email: "username@example.com",
191+ User: "username",
192+ PreferredUsername: "preferred.username",
193+ AccessToken: "AccessToken.12349871293847fdsaihf9238h4f91h8fr.1349f831y98fd7",
194+ IDToken: "IDToken.12349871293847fdsaihf9238h4f91h8fr.1349f831y98fd7",
195+ CreatedAt: &created,
196+ ExpiresOn: &expires,
197+ RefreshToken: "RefreshToken.12349871293847fdsaihf9238h4f91h8fr.1349f831y98fd7",
198+ Groups: []string{"group-a", "group-b"},
199+ },
189200 }
190201
191202 for _, secretSize := range []int{16, 24, 32} {
pkg/validation/options.go+5
@@ -152,6 +152,10 @@ func Validate(o *options.Options) error {
152152 }
153153 if o.Scope == "" {
154154 o.Scope = "openid email profile"
155+
156+ if len(o.AllowedGroups) > 0 {
157+ o.Scope += " groups"
158+ }
155159 }
156160 }
157161
@@ -279,6 +283,7 @@ func parseProviderInfo(o *options.Options, msgs []string) []string {
279283 case *providers.OIDCProvider:
280284 p.AllowUnverifiedEmail = o.InsecureOIDCAllowUnverifiedEmail
281285 p.UserIDClaim = o.UserIDClaim
286+ p.GroupsClaim = o.OIDCGroupsClaim
282287 if o.GetOIDCVerifier() == nil {
283288 msgs = append(msgs, "oidc provider requires an oidc issuer URL")
284289 } else {
providers/oidc.go+23
@@ -22,6 +22,7 @@ type OIDCProvider struct {
2222 Verifier *oidc.IDTokenVerifier
2323 AllowUnverifiedEmail bool
2424 UserIDClaim string
25+ GroupsClaim string
2526}
2627
2728// NewOIDCProvider initiates a new OIDCProvider
@@ -123,6 +124,7 @@ func (p *OIDCProvider) redeemRefreshToken(ctx context.Context, s *sessions.Sessi
123124 s.IDToken = newSession.IDToken
124125 s.Email = newSession.Email
125126 s.User = newSession.User
127+ s.Groups = newSession.Groups
126128 s.PreferredUsername = newSession.PreferredUsername
127129 }
128130
@@ -204,6 +206,7 @@ func (p *OIDCProvider) createSessionStateInternal(ctx context.Context, idToken *
204206 newSession.Email = claims.UserID // TODO Rename SessionState.Email to .UserID in the near future
205207
206208 newSession.User = claims.Subject
209+ newSession.Groups = claims.Groups
207210 newSession.PreferredUsername = claims.PreferredUsername
208211
209212 verifyEmail := (p.UserIDClaim == emailClaim) && !p.AllowUnverifiedEmail
@@ -222,6 +225,7 @@ func (p *OIDCProvider) ValidateSessionState(ctx context.Context, s *sessions.Ses
222225
223226func (p *OIDCProvider) findClaimsFromIDToken(ctx context.Context, idToken *oidc.IDToken, token *oauth2.Token) (*OIDCClaims, error) {
224227 claims := &OIDCClaims{}
228+
225229 // Extract default claims.
226230 if err := idToken.Claims(&claims); err != nil {
227231 return nil, fmt.Errorf("failed to parse default id_token claims: %v", err)
@@ -236,6 +240,8 @@ func (p *OIDCProvider) findClaimsFromIDToken(ctx context.Context, idToken *oidc.
236240 claims.UserID = fmt.Sprint(userID)
237241 }
238242
243+ claims.Groups = p.extractGroupsFromRawClaims(claims.rawClaims)
244+
239245 // userID claim was not present or was empty in the ID Token
240246 if claims.UserID == "" {
241247 // BearerToken case, allow empty UserID
@@ -273,10 +279,27 @@ func (p *OIDCProvider) findClaimsFromIDToken(ctx context.Context, idToken *oidc.
273279 return claims, nil
274280}
275281
282+func (p *OIDCProvider) extractGroupsFromRawClaims(rawClaims map[string]interface{}) []string {
283+ groups := []string{}
284+
285+ rawGroups, ok := rawClaims[p.GroupsClaim].([]interface{})
286+ if rawGroups != nil && ok {
287+ for _, rawGroup := range rawGroups {
288+ group, ok := rawGroup.(string)
289+ if ok {
290+ groups = append(groups, group)
291+ }
292+ }
293+ }
294+
295+ return groups
296+}
297+
276298type OIDCClaims struct {
277299 rawClaims map[string]interface{}
278300 UserID string
279301 Subject string `json:"sub"`
280302 Verified *bool `json:"email_verified"`
281303 PreferredUsername string `json:"preferred_username"`
304+ Groups []string
282305}
providers/oidc_test.go+34−13
@@ -29,10 +29,12 @@ const clientID = "https://test.myapp.com"
2929const secret = "secret"
3030
3131type idTokenClaims struct {
32− Name string `json:"name,omitempty"`
33− Email string `json:"email,omitempty"`
34− Phone string `json:"phone_number,omitempty"`
35− Picture string `json:"picture,omitempty"`
32+ Name string `json:"name,omitempty"`
33+ Email string `json:"email,omitempty"`
34+ Phone string `json:"phone_number,omitempty"`
35+ Picture string `json:"picture,omitempty"`
36+ Groups []string `json:"groups,omitempty"`
37+ OtherGroups []string `json:"other_groups,omitempty"`
3638 jwt.StandardClaims
3739}
3840
@@ -49,6 +51,8 @@ var defaultIDToken idTokenClaims = idTokenClaims{
4951 "janed@me.com",
5052 "+4798765432",
5153 "http://mugbook.com/janed/me.jpg",
54+ []string{"test:a", "test:b"},
55+ []string{"test:c", "test:d"},
5256 jwt.StandardClaims{
5357 Audience: "https://test.myapp.com",
5458 ExpiresAt: time.Now().Add(time.Duration(5) * time.Minute).Unix(),
@@ -65,6 +69,8 @@ var minimalIDToken idTokenClaims = idTokenClaims{
6569 "",
6670 "",
6771 "",
72+ []string{},
73+ []string{},
6874 jwt.StandardClaims{
6975 Audience: "https://test.myapp.com",
7076 ExpiresAt: time.Now().Add(time.Duration(5) * time.Minute).Unix(),
@@ -273,25 +279,39 @@ func TestCreateSessionStateFromBearerToken(t *testing.T) {
273279 const profileURLEmail = "janed@me.com"
274280
275281 testCases := map[string]struct {
276− IDToken idTokenClaims
277− ExpectedUser string
278− ExpectedEmail string
282+ IDToken idTokenClaims
283+ GroupsClaim string
284+ ExpectedUser string
285+ ExpectedEmail string
286+ ExpectedGroups []string
279287 }{
280288 "Default IDToken": {
281− IDToken: defaultIDToken,
282− ExpectedUser: defaultIDToken.Subject,
283− ExpectedEmail: defaultIDToken.Email,
289+ IDToken: defaultIDToken,
290+ GroupsClaim: "groups",
291+ ExpectedUser: defaultIDToken.Subject,
292+ ExpectedEmail: defaultIDToken.Email,
293+ ExpectedGroups: []string{"test:a", "test:b"},
284294 },
285295 "Minimal IDToken with no email claim": {
286− IDToken: minimalIDToken,
287− ExpectedUser: minimalIDToken.Subject,
288− ExpectedEmail: minimalIDToken.Subject,
296+ IDToken: minimalIDToken,
297+ GroupsClaim: "groups",
298+ ExpectedUser: minimalIDToken.Subject,
299+ ExpectedEmail: minimalIDToken.Subject,
300+ ExpectedGroups: []string{},
301+ },
302+ "Custom Groups Claim": {
303+ IDToken: defaultIDToken,
304+ GroupsClaim: "other_groups",
305+ ExpectedUser: defaultIDToken.Subject,
306+ ExpectedEmail: defaultIDToken.Email,
307+ ExpectedGroups: []string{"test:c", "test:d"},
289308 },
290309 }
291310 for testName, tc := range testCases {
292311 t.Run(testName, func(t *testing.T) {
293312 jsonResp := []byte(fmt.Sprintf(`{"email":"%s"}`, profileURLEmail))
294313 server, provider := newTestSetup(jsonResp)
314+ provider.GroupsClaim = tc.GroupsClaim
295315 defer server.Close()
296316
297317 rawIDToken, err := newSignedTestIDToken(tc.IDToken)
@@ -311,6 +331,7 @@ func TestCreateSessionStateFromBearerToken(t *testing.T) {
311331 assert.Equal(t, tc.ExpectedEmail, ss.Email)
312332 assert.Equal(t, rawIDToken, ss.IDToken)
313333 assert.Equal(t, rawIDToken, ss.AccessToken)
334+ assert.Equal(t, tc.ExpectedGroups, ss.Groups)
314335 assert.Equal(t, "", ss.RefreshToken)
315336 })
316337 }