/
auth.go
2296 lines (2038 loc) · 73 KB
/
auth.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
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package rest
import (
"crypto/rsa"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
"io/ioutil"
"math"
mathRand "math/rand"
"net/http"
"strings"
"sync"
"time"
"github.com/dgrijalva/jwt-go"
"github.com/julienschmidt/httprouter"
log "github.com/sirupsen/logrus"
"github.com/neuvector/neuvector/controller/access"
"github.com/neuvector/neuvector/controller/api"
"github.com/neuvector/neuvector/controller/common"
"github.com/neuvector/neuvector/controller/rpc"
"github.com/neuvector/neuvector/share"
"github.com/neuvector/neuvector/share/cluster"
"github.com/neuvector/neuvector/share/global"
"github.com/neuvector/neuvector/share/utils"
)
type loginSession struct {
id string // For event log to correlate login and logout events. It's from token claim's id
mainSessionID string // From master token claim, i.e. master cluster login's id. Empty otherwise
mainSessionUser string // From master token claim, i.e. master cluster login's fullname. Empty otherwise
token string
fullname string
domain string
server string
timeout uint32
remote string
loginAt time.Time
lastAt time.Time
lastSyncTimerAt time.Time // last time calling other controllers for syncing the timer for the token with this login session
eolAt time.Time // end of life
timer *time.Timer
domainRoles access.DomainRole // map: domain -> role
nvPage string // could change in every request even in the same login session
}
type tokenClaim struct {
Remote string `json:"remote"`
Fullname string `json:"fullname"`
Username string `json:"username"`
Server string `json:"server"`
EMail string `json:"email"`
Locale string `json:"locale"`
MainSessionID string `json:"main_session_id"` // from id in master login token's claim. empty when the token is generated for local cluster login
MainSessionUser string `json:"main_session_user"` // from fullname in master login token's claim. empty when the token is generated for local cluster login
Timeout uint32 `json:"timeout"`
Roles access.DomainRole `json:"roles"`
jwt.StandardClaims
}
type joinToken struct {
MasterServer string `json:"s"`
MasterPort uint `json:"p"`
JoinTicket string `json:"t"`
}
type joinTicket struct {
Salt int `json:"s"`
ExpiresAt int64 `json:"e"`
}
var errTokenExpired error = errors.New("token expired")
var recordFedAuthSessions bool = false // set to true for testing: handlerDumpAuthData
var loginFedSessions map[string]utils.Set = make(map[string]utils.Set) // for testing: key is mainSessionID, value is a set of regular tokens
var loginSessions map[string]*loginSession = make(map[string]*loginSession) // key is the token
var loginUserAccounting map[string]int = make(map[string]int)
var userMutex sync.RWMutex
const idLength int = 6
const jwtTokenLife = time.Hour * 6
const jwtExpiredTokenSessionWindow = time.Minute * 5 // A heristic way to reduce session number
const jwtFedTokenLife = time.Minute * 60
const jwtFedJointTicketLife = time.Minute * 2 // for ticket used in requests from joint cluster to master cluster
const jwtIbmSaTokenLife = time.Minute * 30
const jwtImportStatusTokenLife = time.Minute * 10
const syncTokenTimerTimeout = time.Duration(120) * time.Second
var jwtPublicKey *rsa.PublicKey
var jwtPrivateKey *rsa.PrivateKey
var jwtLastExpiredTokenSession cluster.SessionInterface
var jwtLastExpiredTokenSessionCreatedAt time.Time
var jointPublicKey *rsa.PublicKey // joint cluster's public key, used on joint clusters only
var jointClustersKeyCache = make(map[string]*rsa.PrivateKey) // joint cluster's private key, used on master cluster only. map key is joint cluster id
var fedAuthMutex sync.RWMutex
const MaxPerDomainLoginUsers int = 32
const roleModDummyRole string = api.UserRoleReader
const _interactiveSessionID = ""
const _halfHourBefore = time.Duration(-30) * time.Minute
const (
userOK = iota
userInvalidRequest
userNotExist
userTimeout
userTooMany
userKeyError
)
const (
jwtRegularTokenType = iota
jwtFedMasterTokenType
)
// With userMutex locked when calling this because it does loginSession lookup first
func newLoginSessionFromToken(token string, claims *tokenClaim, now time.Time) (*loginSession, int) {
s := &loginSession{
id: claims.Id,
mainSessionID: claims.MainSessionID,
mainSessionUser: claims.MainSessionUser,
token: token,
fullname: claims.Fullname,
server: claims.Server,
timeout: claims.Timeout,
remote: claims.Remote,
loginAt: now,
lastAt: now,
eolAt: time.Unix(claims.ExpiresAt, 0),
domainRoles: claims.Roles,
}
if rc := _registerLoginSession(s); rc != userOK {
updateFedLoginSession(s)
return nil, rc
} else {
return s, rc
}
}
func newLoginSessionFromUser(user *share.CLUSUser, roles access.DomainRole, remote, mainSessionID, mainSessionUser string) (*loginSession, int) {
if jwtPrivateKey == nil || jwtPublicKey == nil {
if err := jwtReadKeys(); err != nil {
return nil, userKeyError
}
}
id, token, claims := jwtGenerateToken(user, roles, remote, mainSessionID, mainSessionUser)
now := user.LastLoginAt // Already updated
s := &loginSession{
id: id,
mainSessionID: mainSessionID,
mainSessionUser: mainSessionUser,
token: token,
fullname: user.Fullname,
server: user.Server,
timeout: user.Timeout,
remote: remote,
loginAt: now,
lastAt: now,
eolAt: time.Unix(claims.ExpiresAt, 0),
domainRoles: roles,
}
if mainSessionID != _interactiveSessionID { // for federal login, give it longer timeout so it doesn't time out as easily as interactive login
s.timeout = s.timeout * 8
}
if rc := registerLoginSession(s); rc != userOK {
return nil, rc
} else {
return s, rc
}
}
// with userMutex locked when calling this
func _registerLoginSession(login *loginSession) int {
if _, ok := loginUserAccounting[login.fullname]; ok {
if loginUserAccounting[login.fullname] == MaxPerDomainLoginUsers {
log.WithFields(log.Fields{"user": login.fullname}).Info("User login limit reached")
return userTooMany
}
loginUserAccounting[login.fullname]++ //-> TODO: do we need it for federal login?
} else {
loginUserAccounting[login.fullname] = 1
}
ibmsaSetup := false
importStatus := false
var timeout time.Duration
if r, ok := login.domainRoles[access.AccessDomainGlobal]; ok && (r == api.UserRoleIBMSA || r == api.UserRoleImportStatus) && len(login.domainRoles) == 1 {
if r == api.UserRoleIBMSA {
ibmsaSetup = true
timeout = time.Duration(jwtIbmSaTokenLife) // IBM Security Advisor has 30 minutes for setting up endpoint
} else {
importStatus = true
timeout = time.Duration(jwtImportStatusTokenLife)
}
} else {
timeout = getUserTimeout(login.timeout)
}
login.timer = time.AfterFunc(timeout, func() { login.expire() })
loginSessions[login.token] = login
log.WithFields(log.Fields{"id": login.id, "user": login.fullname, "ibmsaSetup": ibmsaSetup, "importStatus": importStatus}).Debug()
if !ibmsaSetup { // do not write auth log for ibmsa token
var userName string
var msg string
domainRoles := login.domainRoles
if login.mainSessionUser != "" {
userName = fmt.Sprintf("%s (master cluster)", login.mainSessionUser)
} else {
userName = login.fullname
}
if importStatus {
msg = fmt.Sprintf("User %s login (for retrieving import result)", login.fullname)
domainRoles = access.DomainRole{}
}
authLog(share.CLUSEvAuthLogin, userName, login.remote, login.id, domainRoles, msg)
}
return userOK
}
func registerLoginSession(login *loginSession) int {
userMutex.Lock()
defer userMutex.Unlock()
return _registerLoginSession(login)
}
func (s *loginSession) getToken() string {
return s.token
}
// with userMutex locked when calling this
func _deleteSessionToken(s *loginSession) {
if s.timer != nil {
s.timer.Stop()
}
if _, ok := loginSessions[s.token]; ok {
delete(loginSessions, s.token)
if n, ok := loginUserAccounting[s.fullname]; ok && n > 0 {
loginUserAccounting[s.fullname]--
}
}
now := time.Now()
if now.After(s.eolAt) {
return
}
// Add token to expired token blacklist
if jwtLastExpiredTokenSession == nil || time.Since(jwtLastExpiredTokenSessionCreatedAt) > jwtExpiredTokenSessionWindow {
if elts, err := cluster.NewSession("expired login token", s.eolAt.Sub(now)); err != nil {
log.WithFields(log.Fields{"error": err, "user": s.fullname}).Error("failed to create expired login token session")
return
} else {
jwtLastExpiredTokenSession = elts
jwtLastExpiredTokenSessionCreatedAt = time.Now()
}
}
key := share.CLUSExpiredTokenKey(s.token)
jwtLastExpiredTokenSession.Associate(key)
}
// with userMutex locked when calling this
func (s *loginSession) _delete() {
_deleteSessionToken(s)
}
// delete the calling fed login session/token from loginFedSessions cache, with userMutex locked when called
func (s *loginSession) _delFedSessionToken() {
if !recordFedAuthSessions {
return
}
// this function is called when a fed login session token expires
if s.mainSessionID != _interactiveSessionID {
if tokenSet, exist := loginFedSessions[s.mainSessionID]; exist && tokenSet.Contains(s.token) {
tokenSet.Remove(s.token)
if tokenSet.Cardinality() == 0 {
delete(loginFedSessions, s.mainSessionID)
}
}
}
}
// delete all fed login sessions/tokens that have the same mainSessionID as the calling login session, with userMutex locked when called
func (s *loginSession) _delFedSessionTokens() {
// this function is called when when a fed user logout from master cluster
if s.mainSessionID != _interactiveSessionID {
if recordFedAuthSessions {
if tokenSet, exist := loginFedSessions[s.mainSessionID]; exist && tokenSet.Cardinality() > 0 {
for _, token := range tokenSet.ToStringSlice() {
if s2, ok := loginSessions[token]; ok {
s2._delete()
}
}
delete(loginFedSessions, s.mainSessionID)
}
} else {
for _, s2 := range loginSessions {
if s2.mainSessionID == s.mainSessionID {
s2._delete()
}
}
}
}
}
// with userMutex locked when calling this
func (s *loginSession) _logout() {
log.WithFields(log.Fields{"id": s.id, "user": s.fullname}).Debug()
var msg string
var userName string
domainRoles := s.domainRoles
if s.mainSessionUser != "" {
userName = fmt.Sprintf("%s (master cluster)", s.mainSessionUser)
} else {
userName = s.fullname
}
if r, ok := s.domainRoles[access.AccessDomainGlobal]; ok && r == api.UserRoleImportStatus && len(s.domainRoles) == 1 {
msg = fmt.Sprintf("User %s logout (for retrieving import result)", userName)
domainRoles = access.DomainRole{}
}
authLog(share.CLUSEvAuthLogout, userName, s.remote, s.id, domainRoles, msg)
s._delete()
}
// with userMutex locked when calling this
func (s *loginSession) _logoutFedSession() {
s._delFedSessionTokens()
s._logout()
}
// with userMutex locked when calling this
func (s *loginSession) _expire() {
log.WithFields(log.Fields{"id": s.id, "user": s.fullname}).Debug()
if r, ok := s.domainRoles[access.AccessDomainGlobal]; ok && (r == api.UserRoleIBMSA || r == api.UserRoleImportStatus) && len(s.domainRoles) == 1 {
// do not write auth log for ibmsa/import_status token
} else {
var userName string
if s.mainSessionUser != "" {
userName = fmt.Sprintf("%s (master cluster)", s.mainSessionUser)
} else {
userName = s.fullname
}
authLog(share.CLUSEvAuthTimeout, userName, s.remote, s.id, s.domainRoles, "")
}
s._delFedSessionToken()
s._delete()
}
func (s *loginSession) expire() {
userMutex.Lock()
defer userMutex.Unlock()
s._expire()
}
// with userMutex locked when calling this
func (s *loginSession) _updateTimeout(tmo uint32) {
s.timeout = tmo
elapsed := time.Since(s.lastAt)
timeout := getUserTimeout(tmo)
if elapsed >= timeout {
// Timeout
s._expire()
} else {
log.WithFields(log.Fields{
"id": s.id, "user": s.fullname, "remain": timeout - elapsed,
}).Debug("Timer adjusted")
s.timer.Reset(timeout - elapsed)
}
}
// SAML idp pass username and group info together with the authentication token.
// - User's group membership is expected to be passed in "NVRoleGroup". In the case of Okta,
// the group filter should be set in a way to return all groups that the user is in,
// for example, "regex=.*". User's role is derived from the group membership.
// - Username is expected to be in "Username" attribute, if it cannot be found, "Email"
// attribute will be used as the username.
// - If role and username cannot be located, authentication will fail.
const (
samlNVGroupKey string = "NVRoleGroup"
samlMSGroupKey string = "http://schemas.microsoft.com/ws/2008/06/identity/claims/groups"
samlUserKey string = "Username"
samlEmailKey string = "Email"
)
const (
oidcNameKey string = "name"
oidcPreferredNameKey string = "preferred_username"
oldcEmailKey string = "email"
oidcGroupKey string = "groups"
oidcNVGroupKey string = "NVRoleGroup"
)
// with userMutex locked when calling this
func restReq2User(r *http.Request) (*loginSession, int) {
token, ok := r.Header[api.RESTTokenHeader]
if !ok || len(token) != 1 {
return nil, userInvalidRequest
}
if jwtPrivateKey == nil || jwtPublicKey == nil {
if err := jwtReadKeys(); err != nil {
return nil, userKeyError
}
}
// Validate token
claims, err := jwtValidateToken(token[0], "", nil)
if err != nil {
return nil, userInvalidRequest
}
// Check token end-of-life
now := time.Now()
if now.Unix() >= claims.ExpiresAt {
return nil, userTimeout
}
// Check whether the token has been kicked by another controller or expired
key := share.CLUSExpiredTokenKey(token[0])
if _, err := cluster.Get(key); err == nil {
if s, ok := loginSessions[token[0]]; ok {
if s != nil {
if s.timer != nil {
s.timer.Stop()
}
if n, ok := loginUserAccounting[s.fullname]; ok && n > 0 {
loginUserAccounting[s.fullname]--
}
}
delete(loginSessions, token[0])
}
log.Debug("Token already expired")
return nil, userTimeout
}
login, ok := loginSessions[token[0]]
if !ok {
if claims.MainSessionID == "" { // meaning it's not a master token issued by master cluster
// Check if the token is from the same "installation"
installID, _ := clusHelper.GetInstallationID()
if installID != claims.Subject {
log.Debug("Token from different installation")
return nil, userTimeout
}
}
// Create new login session
var rc int
login, rc = newLoginSessionFromToken(token[0], claims, now)
if rc != userOK {
return nil, rc
}
}
// For auth token generated for IBM SA setup, it has a fixed 30 minutes time-out
if role, _ := login.domainRoles[access.AccessDomainGlobal]; role != api.UserRoleIBMSA && role != api.UserRoleImportStatus {
login.timer.Reset(getUserTimeout(login.timeout))
login.lastAt = now
// on other controllers, if the token is already known, its login session timer is ticking based on the last request to other controllers.
// simply reset the login session timer on this controller cannot prevent the timer on other controllers from calling expire().
// so we need to notify other controllers who know this token to reset the timer for this token's login session.
// however, to avoid lots of grpc calls among controllers for "reset token timer", we slow it down so that no more than one within 60 seconds.
if login.lastSyncTimerAt.IsZero() {
login.lastSyncTimerAt = now
} else {
if elapsed := time.Since(login.lastSyncTimerAt); elapsed > syncTokenTimerTimeout {
tokenInfo := share.CLUSLoginTokenInfo{
CtrlerID: localDev.Ctrler.ID,
LoginID: login.id,
UserFullname: login.fullname,
LoginToken: token[0],
}
go resetLoginTokenTimer(tokenInfo)
login.lastSyncTimerAt = now
}
}
}
login.nvPage = ""
if nvPage, ok := r.Header[api.RESTNvPageHeader]; ok && len(nvPage) == 1 {
login.nvPage = nvPage[0]
}
return login, userOK
}
// op is derived by HTTP request method, but the caller can overwrite it.
func getAccessControl(w http.ResponseWriter, r *http.Request, op access.AccessOP) (*access.AccessControl, *loginSession) {
if op == "" {
if r.Method == http.MethodGet {
op = access.AccessOPRead
} else {
op = access.AccessOPWrite
}
}
userMutex.Lock()
defer userMutex.Unlock()
login, rc := restReq2User(r)
if rc != userOK {
if rc == userTimeout {
restRespError(w, http.StatusRequestTimeout, api.RESTErrUnauthorized)
} else {
restRespError(w, http.StatusUnauthorized, api.RESTErrUnauthorized)
}
return nil, nil
}
if login.domainRoles == nil || len(login.domainRoles) == 0 {
restRespAccessDenied(w, login)
return nil, login
}
acc := access.NewAccessControl(r, op, login.domainRoles)
return acc, login
}
func authLog(ev share.TLogEvent, fullname, remote, session string, roles map[string]string, msg string) {
clog := share.CLUSEventLog{
Event: ev,
HostID: localDev.Host.ID,
HostName: localDev.Host.Name,
ControllerID: localDev.Ctrler.ID,
ControllerName: localDev.Ctrler.Name,
ReportedAt: time.Now().UTC(),
User: fullname,
UserRoles: roles,
UserAddr: remote,
UserSession: session,
}
if msg != "" {
clog.Msg = msg
} else {
switch ev {
case share.CLUSEvAuthLogin:
clog.Msg = fmt.Sprintf("User %s login", fullname)
case share.CLUSEvAuthLogout:
clog.Msg = fmt.Sprintf("User %s logout", fullname)
case share.CLUSEvAuthTimeout:
clog.Msg = fmt.Sprintf("User %s login expires", fullname)
case share.CLUSEvAuthLoginFailed:
clog.Msg = fmt.Sprintf("User %s login failed", fullname)
case share.CLUSEvAuthAccessDenied:
clog.Msg = fmt.Sprintf("User %s resource access denied", fullname)
}
}
evqueue.Append(&clog)
}
func lookupShadowUser(server, username, email, role string, roleDomains map[string][]string) (*share.CLUSUser, bool) {
var newUser *share.CLUSUser
now := time.Now()
fullname := utils.MakeUserFullname(server, username)
retry := 0
for retry < retryClusterMax {
user, rev, _ := clusHelper.GetUserRev(fullname, access.NewReaderAccessControl())
if user == nil {
newUser = &share.CLUSUser{
Fullname: fullname,
Server: server,
Username: username,
EMail: email,
Role: role,
RoleDomains: roleDomains,
Timeout: common.DefaultIdleTimeout,
Locale: common.OEMDefaultUserLocale,
LoginCount: 1,
LastLoginAt: now,
}
user = newUser
} else {
user.LoginCount++
if now.After(user.LastLoginAt) {
user.LastLoginAt = now
}
if email != "" && email != user.EMail {
user.EMail = email
}
if !user.RoleOverride {
user.Role = role
user.RoleDomains = roleDomains
}
newUser = user
}
authz := (user.Role != api.UserRoleNone || len(user.RoleDomains) != 0)
if !authz {
return nil, false
}
user.FailedLoginCount = 0
user.BlockLoginSince = time.Time{}
if err := clusHelper.PutUserRev(user, rev); err != nil {
log.WithFields(log.Fields{"user": user.Fullname, "error": err, "rev": rev}).Error("")
retry++
} else {
log.WithFields(log.Fields{"user": user.Fullname}).Debug("Created/updated shadow user in cluster")
break
}
}
// Even update cluster fails, still return authorized user
if retry >= retryClusterMax {
log.WithFields(log.Fields{"user": newUser.Fullname}).Error("Failed to created/updated shadow user")
}
log.WithFields(log.Fields{"server": server, "user": newUser}).Debug()
return newUser, true
}
func loginUser(user *share.CLUSUser, masterRoles access.DomainRole, remote, mainSessionID, mainSessionUser, fedRole string) (*loginSession, int) {
// 1. When a cluster is promoted to master cluster, the default admin user is automatically assigned fedAdmin role
// 2. When a master cluster is demoted, users with fed role(fedAdmin) are downgraded to with admin/reader role
// 3. On master cluster, only users with fedAdmin role can assign fed roles to other users
// 4. On master cluster, only users with fedAdmin role can delete other users who have fed roles
// 5. users with fedAdmin role on master cluster can get/set all clusters' settings in the federation
// 6. users with admin/viewer role can read fed-scope rules settings
// 7. Only interactive login with fedAdmin role on master cluster can access joint clusters
// 8. when an interactive fedAdmin login on master cluster access joint clusters, the remote token on joint cluster has admin role
// 9. when federal rules are deployed to joint clusters, there is no access control checking on joint clusters
roles := make(map[string]string) // access.DomainRole
if mainSessionID != _interactiveSessionID { // meaning it's a remote federal login from master cluster
for d, r := range masterRoles {
roles[d] = r
}
roles[access.AccessDomainGlobal] = masterRoles[access.AccessDomainGlobal]
} else { // meaning it's an interactive local cluster login
// Convert role->domains to domain->role
for role, domains := range user.RoleDomains {
for _, d := range domains {
roles[d] = role
}
}
roles[access.AccessDomainGlobal] = user.Role
}
return newLoginSessionFromUser(user, roles, remote, mainSessionID, mainSessionUser)
}
func compareUserWithLogin(user *share.CLUSUser, login *loginSession) bool {
return login.fullname == user.Fullname
}
func getUserTimeout(timeout uint32) time.Duration {
return time.Second * time.Duration(timeout)
}
func deleteShadownUsersByServer(server string) {
if server == "" {
return
}
accReadAll := access.NewReaderAccessControl()
users := clusHelper.GetAllUsers(accReadAll)
for _, user := range users {
if user.Server == server {
if err := clusHelper.DeleteUser(user.Fullname); err != nil {
log.WithFields(log.Fields{"error": err, "user": user.Fullname}).Error("Failed to delete the user")
}
}
}
}
func _kickAllLoginSessionsByServer(server string) {
userMutex.Lock()
defer userMutex.Unlock()
for _, login := range loginSessions {
if server == "" || login.server == server {
login._logout()
}
}
}
func _kickFedLoginSessions() {
userMutex.Lock()
defer userMutex.Unlock()
fedRoles := utils.NewSet(api.UserRoleFedAdmin, api.UserRoleFedReader)
for _, login := range loginSessions {
if role, ok := login.domainRoles[access.AccessDomainGlobal]; ok && fedRoles.Contains(role) {
login._logout()
}
}
}
func _kickLoginSessions(user *share.CLUSUser) { // `user == nil` means kick all login sessions
userMutex.Lock()
defer userMutex.Unlock()
for _, login := range loginSessions {
if user == nil || compareUserWithLogin(user, login) {
login._logout()
}
}
}
func _kickLoginSessionByToken(tokenHash string) {
userMutex.Lock()
defer userMutex.Unlock()
for _, login := range loginSessions {
if tokenHash == utils.HashPassword(login.token) {
login._logout()
break
}
}
}
func kickLoginSessionsOnOtherCtrlers(kickInfo share.CLUSKickLoginSessionsRequest) {
eps := cacher.GetAllControllerRPCEndpoints(access.NewReaderAccessControl())
for _, ep := range eps {
if ep.ClusterIP != localDev.Ctrler.ClusterIP {
go rpc.KickLoginSessions(ep.ClusterIP, ep.RPCServerPort, kickInfo)
}
}
}
func resetLoginTokenTimer(tokenInfo share.CLUSLoginTokenInfo) {
eps := cacher.GetAllControllerRPCEndpoints(access.NewReaderAccessControl())
for _, ep := range eps {
if ep.ClusterIP != localDev.Ctrler.ClusterIP {
go rpc.ResetLoginTokenTimer(ep.ClusterIP, ep.RPCServerPort, tokenInfo)
}
}
}
func kickAllLoginSessionsByServer(server string) {
_kickAllLoginSessionsByServer(server)
kickInfo := share.CLUSKickLoginSessionsRequest{
Type: share.KickLoginSessionsType_KickByServer,
CtrlerID: localDev.Ctrler.ID,
Server: server,
}
kickLoginSessionsOnOtherCtrlers(kickInfo)
}
func kickFedLoginSessions() {
_kickFedLoginSessions()
kickInfo := share.CLUSKickLoginSessionsRequest{
Type: share.KickLoginSessionsType_KickByFed,
CtrlerID: localDev.Ctrler.ID,
}
kickLoginSessionsOnOtherCtrlers(kickInfo)
}
func kickLoginSessions(user *share.CLUSUser) { // `user == nil` means kick all login sessions
_kickLoginSessions(user)
kickInfo := share.CLUSKickLoginSessionsRequest{
Type: share.KickLoginSessionsType_KickByUser,
CtrlerID: localDev.Ctrler.ID,
}
if user != nil {
kickInfo.UserFullname = user.Fullname
kickInfo.UserServer = user.Server
kickInfo.UserName = user.Username
}
kickLoginSessionsOnOtherCtrlers(kickInfo)
}
func invalidateImportStatusToken(tempToken string) {
userMutex.Lock()
defer userMutex.Unlock()
claims, err := jwtValidateToken(tempToken, "", nil)
if err == nil {
s := &loginSession{
token: tempToken,
fullname: claims.Fullname,
eolAt: time.Unix(claims.ExpiresAt, 0),
}
_deleteSessionToken(s)
}
}
// for one controller to call other controllers' grpc service, which calls this function, to kick login sessions
func KickLoginSessions(kickInfo *share.CLUSKickLoginSessionsRequest) {
if kickInfo.CtrlerID != localDev.Ctrler.ID {
switch kickInfo.Type {
case share.KickLoginSessionsType_KickByServer:
_kickAllLoginSessionsByServer(kickInfo.Server)
case share.KickLoginSessionsType_KickByFed:
_kickFedLoginSessions()
case share.KickLoginSessionsType_KickByUser:
var user *share.CLUSUser
if kickInfo.UserFullname != "" {
user = &share.CLUSUser{
Fullname: kickInfo.UserFullname,
Server: kickInfo.UserServer,
Username: kickInfo.UserName,
}
}
_kickLoginSessions(user)
}
}
}
// for one controller to call other controllers' grpc service, which calls this function, to reset a login session
func ResetLoginTokenTimer(tokenInfo *share.CLUSLoginTokenInfo) {
if tokenInfo.CtrlerID != localDev.Ctrler.ID {
key := share.CLUSExpiredTokenKey(tokenInfo.LoginToken)
if _, err := cluster.Get(key); err == nil {
// one controller has set this token to be expired!
return
}
userMutex.Lock()
defer userMutex.Unlock()
if login, ok := loginSessions[tokenInfo.LoginToken]; ok {
// if this controller does know this token, reset its timer.
if tokenInfo.LoginID == login.id {
login.timer.Reset(getUserTimeout(login.timeout))
login.lastAt = time.Now()
}
} else {
// if this controller doesn't know this token yet, it's fine.
// later when a resp api request reaches this controller, if the token is still not in kv,
// this controller will accept it and start a new timer for this token
}
}
}
func KickLoginSessionsForRoleChange(name, domain string) {
server := global.ORCH.GetAuthServerAlias()
user := share.CLUSUser{
Fullname: utils.MakeUserFullname(server, name),
Server: server,
Username: name,
}
_kickLoginSessions(&user)
}
func changeTimeoutLoginSessions(user *share.CLUSUser) {
userMutex.Lock()
defer userMutex.Unlock()
for _, login := range loginSessions {
if compareUserWithLogin(user, login) {
login._updateTimeout(user.Timeout)
}
}
}
func rsaReadKeys(certFile, keyFile string) (error, *rsa.PublicKey, *rsa.PrivateKey) {
var rsaPublicKey *rsa.PublicKey
var rsaPrivateKey *rsa.PrivateKey
if certFile != "" {
if key, err := ioutil.ReadFile(certFile); err != nil {
return err, nil, nil
} else if rsaPublicKey, err = jwt.ParseRSAPublicKeyFromPEM(key); err != nil {
return err, nil, nil
}
}
if keyFile != "" {
if key, err := ioutil.ReadFile(keyFile); err != nil {
return err, nil, nil
} else if rsaPrivateKey, err = jwt.ParseRSAPrivateKeyFromPEM(key); err != nil {
return err, nil, nil
}
}
return nil, rsaPublicKey, rsaPrivateKey
}
func jwtReadKeys() error {
var err error
err, jwtPublicKey, jwtPrivateKey = rsaReadKeys(defaultSSLCertFile, defaultSSLKeyFile)
if err != nil {
return err
}
return nil
}
func resetFedJointKeys() {
fedClientPoolMutex.Lock()
_fedHttpClients = make(map[string]*tFedHttpClient)
fedClientPoolMutex.Unlock()
fedAuthMutex.Lock()
jointPublicKey = nil
jointClustersKeyCache = make(map[string]*rsa.PrivateKey)
fedAuthMutex.Unlock()
}
func setJointKeysInCache(callerFedRole string, jointCluster *share.CLUSFedJointClusterInfo) error {
var err error
var data []byte
var rsaPrivateKey *rsa.PrivateKey
var rsaPublicKey *rsa.PublicKey
if data, err = base64.StdEncoding.DecodeString(jointCluster.ClientKey); err == nil {
if rsaPrivateKey, err = jwt.ParseRSAPrivateKeyFromPEM(data); err == nil && rsaPrivateKey != nil {
if data, err = base64.StdEncoding.DecodeString(jointCluster.ClientCert); err == nil {
if rsaPublicKey, err = jwt.ParseRSAPublicKeyFromPEM(data); err == nil && rsaPublicKey != nil {
if token := jwtGenFedPingToken(callerFedRole, jointCluster.ID, jointCluster.Secret, rsaPrivateKey); token != "" {
if _, err := jwtValidateToken(token, jointCluster.Secret, rsaPublicKey); err == nil {
_setFedJointPrivateKey(jointCluster.ID, rsaPrivateKey)
if callerFedRole == api.FedRoleJoint {
_setFedJointPublicKey(rsaPublicKey)
}
return nil
} else {
log.WithFields(log.Fields{"role": callerFedRole, "err": err}).Error("validate")
}
}
}
}
}
}
return err
}
func reloadJointPubPrivKey(callerFedRole, clusterID string) {
var err error
var data []byte
log.WithFields(log.Fields{"clusterID": clusterID, "callerFedRole": callerFedRole}).Info("")
if callerFedRole == api.FedRoleJoint {
// meaning joint cluster wants to reload its public key
m := clusHelper.GetFedMembership()
if m != nil && m.FedRole == api.FedRoleJoint {
if data, err = base64.StdEncoding.DecodeString(m.JointCluster.ClientCert); err == nil {
var rsaPublicKey *rsa.PublicKey
if rsaPublicKey, err = jwt.ParseRSAPublicKeyFromPEM(data); err == nil && rsaPublicKey != nil {
_setFedJointPublicKey(rsaPublicKey)
}
}
}
} else if callerFedRole == api.FedRoleMaster {
// meaning master cluster wants to reload a joint cluster's private key
if jointCluster := clusHelper.GetFedJointCluster(clusterID); jointCluster != nil {
if data, err = base64.StdEncoding.DecodeString(jointCluster.ClientKey); err == nil {
var rsaPrivateKey *rsa.PrivateKey
if rsaPrivateKey, err = jwt.ParseRSAPrivateKeyFromPEM(data); err == nil && rsaPrivateKey != nil {
_setFedJointPrivateKey(jointCluster.ID, rsaPrivateKey)
}
}
}
}
if err != nil {
log.WithFields(log.Fields{"clusterID": clusterID, "callerFedRole": callerFedRole, "err": err}).Error("reload failed")
}
}
func jwtValidateToken(encryptedToken, secret string, rsaPublicKey *rsa.PublicKey) (*tokenClaim, error) {
// rsaPublicKey being non-nil is for validating new public/private keys purpose
var tokenString string
var publicKey *rsa.PublicKey
if secret == "" {
tokenString = utils.DecryptPasswordForURL(encryptedToken)
} else {
tokenString = utils.DecryptSensitiveForURL(encryptedToken, []byte(secret))
}
if tokenString == "" {
return nil, fmt.Errorf("unrecognized token")
}
if secret == "" {
publicKey = jwtPublicKey
} else {
if rsaPublicKey == nil {
if publicKey = _getFedJointPublicKey(); publicKey == nil {
if m := clusHelper.GetFedMembership(); m != nil && m.FedRole == api.FedRoleJoint {
log.Info("reload key")
if err := setJointKeysInCache(api.FedRoleJoint, &m.JointCluster); err == nil {
publicKey = _getFedJointPublicKey()
}
}
}
} else {
publicKey = rsaPublicKey
}
}
if publicKey == nil {
return nil, fmt.Errorf("empty public key")
}
token, err := jwt.ParseWithClaims(tokenString, &tokenClaim{}, func(token *jwt.Token) (interface{}, error) {
if _, ok := token.Method.(*jwt.SigningMethodRSA); !ok {
return nil, fmt.Errorf("Unexpected signing method: %v", token.Header["alg"])
}