-
Notifications
You must be signed in to change notification settings - Fork 0
/
github.go
585 lines (513 loc) · 17.5 KB
/
github.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
/*
Copyright 2017 Gravitational, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package auth
import (
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"time"
"github.com/gravitational/teleport"
"github.com/gravitational/teleport/lib/defaults"
"github.com/gravitational/teleport/lib/events"
"github.com/gravitational/teleport/lib/modules"
"github.com/gravitational/teleport/lib/services"
"github.com/gravitational/teleport/lib/utils"
"github.com/coreos/go-oidc/oauth2"
"github.com/gravitational/trace"
"github.com/sirupsen/logrus"
)
// CreateGithubAuthRequest creates a new request for Github OAuth2 flow
func (s *AuthServer) CreateGithubAuthRequest(req services.GithubAuthRequest) (*services.GithubAuthRequest, error) {
connector, err := s.Identity.GetGithubConnector(req.ConnectorID, true)
if err != nil {
return nil, trace.Wrap(err)
}
client, err := s.getGithubOAuth2Client(connector)
if err != nil {
return nil, trace.Wrap(err)
}
req.StateToken, err = utils.CryptoRandomHex(TokenLenBytes)
if err != nil {
return nil, trace.Wrap(err)
}
req.RedirectURL = client.AuthCodeURL(req.StateToken, "", "")
log.WithFields(logrus.Fields{trace.Component: "github"}).Debugf(
"Redirect URL: %v.", req.RedirectURL)
req.SetTTL(s.GetClock(), defaults.GithubAuthRequestTTL)
err = s.Identity.CreateGithubAuthRequest(req)
if err != nil {
return nil, trace.Wrap(err)
}
return &req, nil
}
// GithubAuthResponse represents Github auth callback validation response
type GithubAuthResponse struct {
// Username is the name of authenticated user
Username string `json:"username"`
// Identity is the external identity
Identity services.ExternalIdentity `json:"identity"`
// Session is the created web session
Session services.WebSession `json:"session,omitempty"`
// Cert is the generated SSH client certificate
Cert []byte `json:"cert,omitempty"`
// TLSCert is PEM encoded TLS client certificate
TLSCert []byte `json:"tls_cert,omitempty"`
// Req is the original auth request
Req services.GithubAuthRequest `json:"req"`
// HostSigners is a list of signing host public keys
// trusted by proxy, used in console login
HostSigners []services.CertAuthority `json:"host_signers"`
}
// ValidateGithubAuthCallback validates Github auth callback redirect
func (a *AuthServer) ValidateGithubAuthCallback(q url.Values) (*GithubAuthResponse, error) {
re, err := a.validateGithubAuthCallback(q)
if err != nil {
a.EmitAuditEvent(events.UserSSOLoginFailure, events.EventFields{
events.LoginMethod: events.LoginMethodGithub,
events.AuthAttemptSuccess: false,
events.AuthAttemptErr: err.Error(),
})
} else {
a.EmitAuditEvent(events.UserSSOLogin, events.EventFields{
events.EventUser: re.Username,
events.AuthAttemptSuccess: true,
events.LoginMethod: events.LoginMethodGithub,
})
}
return re, err
}
// ValidateGithubAuthCallback validates Github auth callback redirect
func (s *AuthServer) validateGithubAuthCallback(q url.Values) (*GithubAuthResponse, error) {
logger := log.WithFields(logrus.Fields{trace.Component: "github"})
error := q.Get("error")
if error != "" {
return nil, trace.OAuth2(oauth2.ErrorInvalidRequest, error, q)
}
code := q.Get("code")
if code == "" {
return nil, trace.OAuth2(oauth2.ErrorInvalidRequest,
"code query param must be set", q)
}
stateToken := q.Get("state")
if stateToken == "" {
return nil, trace.OAuth2(oauth2.ErrorInvalidRequest,
"missing state query param", q)
}
req, err := s.Identity.GetGithubAuthRequest(stateToken)
if err != nil {
return nil, trace.Wrap(err)
}
connector, err := s.Identity.GetGithubConnector(req.ConnectorID, true)
if err != nil {
return nil, trace.Wrap(err)
}
if len(connector.GetTeamsToLogins()) == 0 {
logger.Warnf("Github connector %q has empty teams_to_logins mapping, cannot populate claims.",
connector.GetName())
return nil, trace.BadParameter(
"connector %q has empty teams_to_logins mapping", connector.GetName())
}
client, err := s.getGithubOAuth2Client(connector)
if err != nil {
return nil, trace.Wrap(err)
}
// exchange the authorization code received by the callback for an access token
token, err := client.RequestToken(oauth2.GrantTypeAuthCode, code)
if err != nil {
return nil, trace.Wrap(err)
}
logger.Debugf("Obtained OAuth2 token: Type=%v Expires=%v Scope=%v.",
token.TokenType, token.Expires, token.Scope)
// Github does not support OIDC so user claims have to be populated
// by making requests to Github API using the access token
claims, err := populateGithubClaims(&githubAPIClient{
token: token.AccessToken,
authServer: s,
})
if err != nil {
return nil, trace.Wrap(err)
}
// Calculate (figure out name, roles, traits, session TTL) of user and
// create the user in the backend.
params, err := s.calculateGithubUser(connector, claims, req)
if err != nil {
return nil, trace.Wrap(err)
}
user, err := s.createGithubUser(params)
if err != nil {
return nil, trace.Wrap(err)
}
// Auth was successful, return session, certificate, etc. to caller.
response := &GithubAuthResponse{
Req: *req,
Identity: services.ExternalIdentity{
ConnectorID: params.connectorName,
Username: params.username,
},
Username: user.GetName(),
}
response.Username = user.GetName()
// If the request is coming from a browser, create a web session.
if req.CreateWebSession {
session, err := s.createWebSession(user, params.sessionTTL)
if err != nil {
return nil, trace.Wrap(err)
}
response.Session = session
}
// If a public key was provided, sign it and return a certificate.
if len(req.PublicKey) != 0 {
sshCert, tlsCert, err := s.createSessionCert(user, params.sessionTTL, req.PublicKey, req.Compatibility)
if err != nil {
return nil, trace.Wrap(err)
}
response.Cert = sshCert
response.TLSCert = tlsCert
// Return the host CA for this cluster only.
authority, err := s.GetCertAuthority(services.CertAuthID{
Type: services.HostCA,
DomainName: s.clusterName.GetClusterName(),
}, false)
if err != nil {
return nil, trace.Wrap(err)
}
response.HostSigners = append(response.HostSigners, authority)
}
return response, nil
}
func (s *AuthServer) createWebSession(user services.User, sessionTTL time.Duration) (services.WebSession, error) {
session, err := s.NewWebSession(user.GetName())
if err != nil {
return nil, trace.Wrap(err)
}
// Session expiry time is the same as the user expiry time.
session.SetExpiryTime(s.clock.Now().UTC().Add(sessionTTL))
// Bearer tokens expire quicker than the overall session time and need to be refreshed.
bearerTTL := utils.MinTTL(BearerTokenTTL, sessionTTL)
session.SetBearerTokenExpiryTime(s.clock.Now().UTC().Add(bearerTTL))
err = s.UpsertWebSession(user.GetName(), session)
if err != nil {
return nil, trace.Wrap(err)
}
return session, nil
}
func (s *AuthServer) createSessionCert(user services.User, sessionTTL time.Duration, publicKey []byte, compatibility string) ([]byte, []byte, error) {
roles, err := services.FetchRoles(user.GetRoles(), s.Access, user.GetTraits())
if err != nil {
return nil, nil, trace.Wrap(err)
}
certs, err := s.generateUserCert(certRequest{
user: user,
roles: roles,
ttl: sessionTTL,
publicKey: publicKey,
compatibility: compatibility,
})
if err != nil {
return nil, nil, trace.Wrap(err)
}
return certs.ssh, certs.tls, nil
}
// createUserParams is a set of parameters used to create a user for an
// external identity provider.
type createUserParams struct {
// connectorName is the name of the connector for the identity provider.
connectorName string
// username is the Teleport user name .
username string
// logins is the list of *nix logins.
logins []string
// kubeGroups is the list of Kubernetes this user belongs to.
kubeGroups []string
// roles is the list of roles this user is assigned to.
roles []string
// traits is the list of traits for this user.
traits map[string][]string
// sessionTTL is how long this session will last.
sessionTTL time.Duration
}
func (s *AuthServer) calculateGithubUser(connector services.GithubConnector, claims *services.GithubClaims, request *services.GithubAuthRequest) (*createUserParams, error) {
p := createUserParams{
connectorName: connector.GetName(),
username: claims.Username,
}
// Calculate logins, kubegroups, roles, and traits.
p.logins, p.kubeGroups = connector.MapClaims(*claims)
if len(p.logins) == 0 {
return nil, trace.BadParameter(
"user %q does not belong to any teams configured in %q connector",
claims.Username, connector.GetName())
}
p.roles = modules.GetModules().RolesFromLogins(p.logins)
p.traits = modules.GetModules().TraitsFromLogins(p.logins, p.kubeGroups)
// Pick smaller for role: session TTL from role or requested TTL.
roles, err := services.FetchRoles(p.roles, s.Access, p.traits)
if err != nil {
return nil, trace.Wrap(err)
}
roleTTL := roles.AdjustSessionTTL(defaults.MaxCertDuration)
p.sessionTTL = utils.MinTTL(roleTTL, request.CertTTL)
return &p, nil
}
func (s *AuthServer) createGithubUser(p *createUserParams) (services.User, error) {
log.WithFields(logrus.Fields{trace.Component: "github"}).Debugf(
"Generating dynamic identity %v/%v with logins: %v.",
p.connectorName, p.username, p.logins)
expires := s.GetClock().Now().UTC().Add(p.sessionTTL)
user, err := services.GetUserMarshaler().GenerateUser(&services.UserV2{
Kind: services.KindUser,
Version: services.V2,
Metadata: services.Metadata{
Name: p.username,
Namespace: defaults.Namespace,
Expires: &expires,
},
Spec: services.UserSpecV2{
Roles: p.roles,
Traits: p.traits,
GithubIdentities: []services.ExternalIdentity{{
ConnectorID: p.connectorName,
Username: p.username,
}},
CreatedBy: services.CreatedBy{
User: services.UserRef{Name: "system"},
Time: s.GetClock().Now().UTC(),
Connector: &services.ConnectorRef{
Type: teleport.ConnectorGithub,
ID: p.connectorName,
Identity: p.username,
},
},
},
})
if err != nil {
return nil, trace.Wrap(err)
}
existingUser, err := s.GetUser(p.username)
if err != nil && !trace.IsNotFound(err) {
return nil, trace.Wrap(err)
}
if existingUser != nil {
ref := user.GetCreatedBy().Connector
if !ref.IsSameProvider(existingUser.GetCreatedBy().Connector) {
return nil, trace.AlreadyExists("user %q already exists and is not Github user",
existingUser.GetName())
}
}
err = s.UpsertUser(user)
if err != nil {
return nil, trace.Wrap(err)
}
return user, nil
}
// populateGithubClaims retrieves information about user and its team
// memberships by calling Github API using the access token
func populateGithubClaims(client githubAPIClientI) (*services.GithubClaims, error) {
// find out the username
user, err := client.getUser()
if err != nil {
return nil, trace.Wrap(err, "failed to query Github user info")
}
// build team memberships
teams, err := client.getTeams()
if err != nil {
return nil, trace.Wrap(err, "failed to query Github user teams")
}
log.Debugf("Retrieved %v teams for GitHub user %v.", len(teams), user.Login)
orgToTeams := make(map[string][]string)
for _, team := range teams {
orgToTeams[team.Org.Login] = append(
orgToTeams[team.Org.Login], team.Slug)
}
if len(orgToTeams) == 0 {
return nil, trace.AccessDenied(
"list of user teams is empty, did you grant access?")
}
claims := &services.GithubClaims{
Username: user.Login,
OrganizationToTeams: orgToTeams,
}
log.WithFields(logrus.Fields{trace.Component: "github"}).Debugf(
"Claims: %#v.", claims)
return claims, nil
}
func (s *AuthServer) getGithubOAuth2Client(connector services.GithubConnector) (*oauth2.Client, error) {
s.lock.Lock()
defer s.lock.Unlock()
config := oauth2.Config{
Credentials: oauth2.ClientCredentials{
ID: connector.GetClientID(),
Secret: connector.GetClientSecret(),
},
RedirectURL: connector.GetRedirectURL(),
Scope: GithubScopes,
AuthURL: GithubAuthURL,
TokenURL: GithubTokenURL,
}
cachedClient, ok := s.githubClients[connector.GetName()]
if ok && oauth2ConfigsEqual(cachedClient.config, config) {
return cachedClient.client, nil
}
delete(s.githubClients, connector.GetName())
client, err := oauth2.NewClient(http.DefaultClient, config)
if err != nil {
return nil, trace.Wrap(err)
}
s.githubClients[connector.GetName()] = &githubClient{
client: client,
config: config,
}
return client, nil
}
// githubAPIClientI defines an interface for Github API wrapper
// so it can be substituted in tests
type githubAPIClientI interface {
// getUser returns user information
getUser() (*userResponse, error)
// getTeams returns a list of user team memberships
getTeams() ([]teamResponse, error)
}
// githubAPIClient is a tiny wrapper around some of Github APIs
type githubAPIClient struct {
// token is the access token retrieved during OAuth2 flow
token string
// authServer points to the Auth Server.
authServer *AuthServer
}
// userResponse represents response from "user" API call
type userResponse struct {
// Login is the username
Login string `json:"login"`
}
// getEmails retrieves a list of emails for authenticated user
func (c *githubAPIClient) getUser() (*userResponse, error) {
// Ignore pagination links, we should never get more than a single user here.
bytes, _, err := c.get("/user")
if err != nil {
return nil, trace.Wrap(err)
}
var user userResponse
err = json.Unmarshal(bytes, &user)
if err != nil {
return nil, trace.Wrap(err)
}
return &user, nil
}
// teamResponse represents a single team entry in the "teams" API response
type teamResponse struct {
// Name is the team name
Name string `json:"name"`
// Slug is the team ID
Slug string `json:"slug"`
// Org describes the organization this team is a part of
Org orgResponse `json:"organization"`
}
// orgResponse represents a Github organization
type orgResponse struct {
// Login is the organization ID
Login string `json:"login"`
}
// getTeams retrieves a list of teams authenticated user belongs to.
func (c *githubAPIClient) getTeams() ([]teamResponse, error) {
var result []teamResponse
bytes, nextPage, err := c.get("/user/teams")
if err != nil {
return nil, trace.Wrap(err)
}
// Extract the first page of results and append them to the full result set.
var teams []teamResponse
err = json.Unmarshal(bytes, &teams)
if err != nil {
return nil, trace.Wrap(err)
}
result = append(result, teams...)
// If the response returned a next page link, continue following the next
// page links until all teams have been retrieved.
var count int
for nextPage != "" {
// To prevent this from looping forever, don't fetch more than a set number
// of pages, print an error when it does happen, and return the results up
// to that point.
if count > MaxPages {
warningMessage := "Truncating list of teams used to populate claims: " +
"hit maximum number pages that can be fetched from GitHub."
// Print warning to Teleport logs as well as the Audit Log.
log.Warnf(warningMessage)
c.authServer.EmitAuditEvent(events.UserSSOLoginFailure, events.EventFields{
events.LoginMethod: events.LoginMethodGithub,
events.AuthAttemptMessage: warningMessage,
})
return result, nil
}
u, err := url.Parse(nextPage)
if err != nil {
return nil, trace.Wrap(err)
}
bytes, nextPage, err = c.get(u.RequestURI())
if err != nil {
return nil, trace.Wrap(err)
}
err = json.Unmarshal(bytes, &teams)
if err != nil {
return nil, trace.Wrap(err)
}
// Append this page of teams to full result set.
result = append(result, teams...)
count = count + 1
}
return result, nil
}
// get makes a GET request to the provided URL using the client's token for auth
func (c *githubAPIClient) get(url string) ([]byte, string, error) {
request, err := http.NewRequest("GET", fmt.Sprintf("%v%v", GithubAPIURL, url), nil)
if err != nil {
return nil, "", trace.Wrap(err)
}
request.Header.Set("Authorization", fmt.Sprintf("token %v", c.token))
response, err := http.DefaultClient.Do(request)
if err != nil {
return nil, "", trace.Wrap(err)
}
defer response.Body.Close()
bytes, err := ioutil.ReadAll(response.Body)
if err != nil {
return nil, "", trace.Wrap(err)
}
if response.StatusCode != 200 {
return nil, "", trace.AccessDenied("bad response: %v %v",
response.StatusCode, string(bytes))
}
// Parse web links header to extract any pagination links. This is used to
// return the next link which can be used in a loop to pull back all data.
wls := utils.ParseWebLinks(response)
return bytes, wls.NextPage, nil
}
const (
// GithubAuthURL is the Github authorization endpoint
GithubAuthURL = "https://github.com/login/oauth/authorize"
// GithubTokenURL is the Github token exchange endpoint
GithubTokenURL = "https://github.com/login/oauth/access_token"
// GithubAPIURL is the Github base API URL
GithubAPIURL = "https://api.github.com"
// MaxPages is the maximum number of pagination links that will be followed.
MaxPages = 99
)
var (
// GithubScopes is a list of scopes requested during OAuth2 flow
GithubScopes = []string{
// read:org grants read-only access to user's team memberships
"read:org",
}
)