Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
dex
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
hdacloud
dex
Commits
6ceb2650
Unverified
Commit
6ceb2650
authored
11 months ago
by
Márk Sági-Kazár
Committed by
GitHub
11 months ago
Browse files
Options
Downloads
Plain Diff
Merge pull request #3063 from jacksonargo/oidc-group-regex
add regex for oidc group matching
parents
36e6e081
5df16057
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
connector/oidc/oidc.go
+21
-0
21 additions, 0 deletions
connector/oidc/oidc.go
connector/oidc/oidc_test.go
+19
-0
19 additions, 0 deletions
connector/oidc/oidc_test.go
with
40 additions
and
0 deletions
connector/oidc/oidc.go
+
21
−
0
View file @
6ceb2650
...
...
@@ -9,6 +9,7 @@ import (
"log/slog"
"net/http"
"net/url"
"regexp"
"strings"
"time"
...
...
@@ -97,6 +98,7 @@ type Config struct {
// ClaimMutations holds all claim mutations options
ClaimMutations
struct
{
NewGroupFromClaims
[]
NewGroupFromClaims
`json:"newGroupFromClaims"`
FilterGroupClaims
FilterGroupClaims
`json:"filterGroupClaims"`
}
`json:"claimModifications"`
}
...
...
@@ -176,6 +178,12 @@ type NewGroupFromClaims struct {
Prefix
string
`json:"prefix"`
}
// FilterGroupClaims is a regex filter for to keep only the matching groups.
// This is useful when the groups list is too large to fit within an HTTP header.
type
FilterGroupClaims
struct
{
GroupsFilter
string
`json:"groupsFilter"`
}
// Domains that don't support basic auth. golang.org/x/oauth2 has an internal
// list, but it only matches specific URLs, not top level domains.
var
brokenAuthHeaderDomains
=
[]
string
{
...
...
@@ -252,6 +260,14 @@ func (c *Config) Open(id string, logger *slog.Logger) (conn connector.Connector,
promptType
=
*
c
.
PromptType
}
var
groupsFilter
*
regexp
.
Regexp
if
c
.
ClaimMutations
.
FilterGroupClaims
.
GroupsFilter
!=
""
{
groupsFilter
,
err
=
regexp
.
Compile
(
c
.
ClaimMutations
.
FilterGroupClaims
.
GroupsFilter
)
if
err
!=
nil
{
logger
.
Warnf
(
"ignoring invalid regex `%s`"
,
c
.
ClaimMutations
.
FilterGroupClaims
.
GroupsFilter
)
}
}
clientID
:=
c
.
ClientID
return
&
oidcConnector
{
provider
:
provider
,
...
...
@@ -283,6 +299,7 @@ func (c *Config) Open(id string, logger *slog.Logger) (conn connector.Connector,
emailKey
:
c
.
ClaimMapping
.
EmailKey
,
groupsKey
:
c
.
ClaimMapping
.
GroupsKey
,
newGroupFromClaims
:
c
.
ClaimMutations
.
NewGroupFromClaims
,
groupsFilter
:
groupsFilter
,
},
nil
}
...
...
@@ -312,6 +329,7 @@ type oidcConnector struct {
emailKey
string
groupsKey
string
newGroupFromClaims
[]
NewGroupFromClaims
groupsFilter
*
regexp
.
Regexp
}
func
(
c
*
oidcConnector
)
Close
()
error
{
...
...
@@ -518,6 +536,9 @@ func (c *oidcConnector) createIdentity(ctx context.Context, identity connector.I
if
found
{
for
_
,
v
:=
range
vs
{
if
s
,
ok
:=
v
.
(
string
);
ok
{
if
c
.
groupsFilter
!=
nil
&&
!
c
.
groupsFilter
.
MatchString
(
s
)
{
continue
}
groups
=
append
(
groups
,
s
)
}
else
{
return
identity
,
fmt
.
Errorf
(
"malformed
\"
%v
\"
claim"
,
groupsKey
)
...
...
This diff is collapsed.
Click to expand it.
connector/oidc/oidc_test.go
+
19
−
0
View file @
6ceb2650
...
...
@@ -64,6 +64,7 @@ func TestHandleCallback(t *testing.T) {
expectPreferredUsername
string
expectedEmailField
string
token
map
[
string
]
interface
{}
groupsRegex
string
newGroupFromClaims
[]
NewGroupFromClaims
}{
{
...
...
@@ -364,6 +365,23 @@ func TestHandleCallback(t *testing.T) {
"non-string-claim2"
:
666
,
},
},
{
name
:
"filterGroupClaims"
,
userIDKey
:
""
,
// not configured
userNameKey
:
""
,
// not configured
groupsRegex
:
`^.*\d$`
,
expectUserID
:
"subvalue"
,
expectUserName
:
"namevalue"
,
expectGroups
:
[]
string
{
"group1"
,
"group2"
},
expectedEmailField
:
"emailvalue"
,
token
:
map
[
string
]
interface
{}{
"sub"
:
"subvalue"
,
"name"
:
"namevalue"
,
"groups"
:
[]
string
{
"group1"
,
"group2"
,
"groupA"
,
"groupB"
},
"email"
:
"emailvalue"
,
"email_verified"
:
true
,
},
},
}
for
_
,
tc
:=
range
tests
{
...
...
@@ -400,6 +418,7 @@ func TestHandleCallback(t *testing.T) {
config
.
ClaimMapping
.
EmailKey
=
tc
.
emailKey
config
.
ClaimMapping
.
GroupsKey
=
tc
.
groupsKey
config
.
ClaimMutations
.
NewGroupFromClaims
=
tc
.
newGroupFromClaims
config
.
ClaimMutations
.
FilterGroupClaims
.
GroupsFilter
=
tc
.
groupsRegex
conn
,
err
:=
newConnector
(
config
)
if
err
!=
nil
{
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment