Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
D
dex
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
go
dex
Commits
7bd4071b
Unverified
Commit
7bd4071b
authored
Feb 05, 2019
by
Stephan Renatus
Committed by
GitHub
Feb 05, 2019
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #1396 from jtnord/useLoginId-dexidp
Use github login as the id
parents
815311fa
fe247b10
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
47 additions
and
1 deletion
+47
-1
github.md
Documentation/connectors/github.md
+3
-0
github.go
connector/github/github.go
+8
-0
github_test.go
connector/github/github_test.go
+36
-1
No files found.
Documentation/connectors/github.md
View file @
7bd4071b
...
...
@@ -67,6 +67,9 @@ connectors:
# - ['acme:site-reliability-engineers'] for 'slug'
# - ['acme:Site Reliability Engineers', 'acme:site-reliability-engineers'] for 'both'
teamNameField
:
slug
# flag which will switch from using the internal GitHub id to the users handle (@mention) as the user id.
# It is possible for a user to change their own user name but it is very rare for them to do so
useLoginAsID
:
false
```
## GitHub Enterprise
...
...
connector/github/github.go
View file @
7bd4071b
...
...
@@ -48,6 +48,7 @@ type Config struct {
RootCA
string
`json:"rootCA"`
TeamNameField
string
`json:"teamNameField"`
LoadAllGroups
bool
`json:"loadAllGroups"`
UseLoginAsID
bool
`json:"useLoginAsID"`
}
// Org holds org-team filters, in which teams are optional.
...
...
@@ -83,6 +84,7 @@ func (c *Config) Open(id string, logger logrus.FieldLogger) (connector.Connector
clientSecret
:
c
.
ClientSecret
,
apiURL
:
apiURL
,
logger
:
logger
,
useLoginAsID
:
c
.
UseLoginAsID
,
}
if
c
.
HostName
!=
""
{
...
...
@@ -148,6 +150,8 @@ type githubConnector struct {
teamNameField
string
// if set to true and no orgs are configured then connector loads all user claims (all orgs and team)
loadAllGroups
bool
// if set to true will use the users handle rather than their numeric id as the ID
useLoginAsID
bool
}
// groupsRequired returns whether dex requires GitHub's 'read:org' scope. Dex
...
...
@@ -260,12 +264,16 @@ func (c *githubConnector) HandleCallback(s connector.Scopes, r *http.Request) (i
if
username
==
""
{
username
=
user
.
Login
}
identity
=
connector
.
Identity
{
UserID
:
strconv
.
Itoa
(
user
.
ID
),
Username
:
username
,
Email
:
user
.
Email
,
EmailVerified
:
true
,
}
if
c
.
useLoginAsID
{
identity
.
UserID
=
user
.
Login
}
// Only set identity.Groups if 'orgs', 'org', or 'groups' scope are specified.
if
c
.
groupsRequired
(
s
.
Groups
)
{
...
...
connector/github/github_test.go
View file @
7bd4071b
...
...
@@ -124,10 +124,11 @@ func TestUserGroupsWithTeamNameAndSlugFieldConfig(t *testing.T) {
})
}
// tests that the users login is used as their username when they have no username set
func
TestUsernameIncludedInFederatedIdentity
(
t
*
testing
.
T
)
{
s
:=
newTestServer
(
map
[
string
]
testResponse
{
"/user"
:
{
data
:
user
{
Login
:
"some-login"
}},
"/user"
:
{
data
:
user
{
Login
:
"some-login"
,
ID
:
12345678
}},
"/user/emails"
:
{
data
:
[]
userEmail
{{
Email
:
"some@email.com"
,
Verified
:
true
,
...
...
@@ -154,6 +155,7 @@ func TestUsernameIncludedInFederatedIdentity(t *testing.T) {
expectNil
(
t
,
err
)
expectEquals
(
t
,
identity
.
Username
,
"some-login"
)
expectEquals
(
t
,
identity
.
UserID
,
"12345678"
)
expectEquals
(
t
,
0
,
len
(
identity
.
Groups
))
c
=
githubConnector
{
apiURL
:
s
.
URL
,
hostName
:
hostURL
.
Host
,
httpClient
:
newClient
(),
loadAllGroups
:
true
}
...
...
@@ -161,8 +163,41 @@ func TestUsernameIncludedInFederatedIdentity(t *testing.T) {
expectNil
(
t
,
err
)
expectEquals
(
t
,
identity
.
Username
,
"some-login"
)
expectEquals
(
t
,
identity
.
UserID
,
"12345678"
)
expectEquals
(
t
,
identity
.
Groups
,
[]
string
{
"org-1"
})
}
func
TestLoginUsedAsIDWhenConfigured
(
t
*
testing
.
T
)
{
s
:=
newTestServer
(
map
[
string
]
testResponse
{
"/user"
:
{
data
:
user
{
Login
:
"some-login"
,
ID
:
12345678
,
Name
:
"Joe Bloggs"
}},
"/user/emails"
:
{
data
:
[]
userEmail
{{
Email
:
"some@email.com"
,
Verified
:
true
,
Primary
:
true
,
}}},
"/login/oauth/access_token"
:
{
data
:
map
[
string
]
interface
{}{
"access_token"
:
"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9"
,
"expires_in"
:
"30"
,
}},
"/user/orgs"
:
{
data
:
[]
org
{{
Login
:
"org-1"
}},
},
})
defer
s
.
Close
()
hostURL
,
err
:=
url
.
Parse
(
s
.
URL
)
expectNil
(
t
,
err
)
req
,
err
:=
http
.
NewRequest
(
"GET"
,
hostURL
.
String
(),
nil
)
expectNil
(
t
,
err
)
c
:=
githubConnector
{
apiURL
:
s
.
URL
,
hostName
:
hostURL
.
Host
,
httpClient
:
newClient
(),
useLoginAsID
:
true
}
identity
,
err
:=
c
.
HandleCallback
(
connector
.
Scopes
{
Groups
:
true
},
req
)
expectNil
(
t
,
err
)
expectEquals
(
t
,
identity
.
UserID
,
"some-login"
)
expectEquals
(
t
,
identity
.
Username
,
"Joe Bloggs"
)
}
func
newTestServer
(
responses
map
[
string
]
testResponse
)
*
httptest
.
Server
{
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment