-
Notifications
You must be signed in to change notification settings - Fork 39
Expand file tree
/
Copy pathkeycloak.go
More file actions
1332 lines (1200 loc) · 44.8 KB
/
Copy pathkeycloak.go
File metadata and controls
1332 lines (1200 loc) · 44.8 KB
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 fixtures
import (
"context"
"crypto/tls"
"encoding/json"
"errors"
"fmt"
"log/slog"
"math"
"net/http"
"strings"
"sync"
"time"
"github.com/Nerzal/gocloak/v13"
)
const (
kcErrNone = 0
kcErrUnknown = -1
standardTokenExchangeEnabledAttribute = "standard.token.exchange.enabled"
dpopBoundAccessTokensAttribute = "dpop.bound.access.tokens" //nolint:gosec // Keycloak client attribute name, not a credential.
keycloakBoolTrue = "true"
// Token refresh constants
defaultTokenBufferSeconds = 120 // 2 minutes before expiration
defaultFallbackExpiryMinutes = 5 // Fallback when token doesn't provide ExpiresIn
adaptiveBufferDivisor = 2 // Use 50% of token lifetime when buffer > lifetime
)
type KeycloakData struct {
Realms []RealmToCreate `yaml:"realms" json:"realms"`
}
type RealmToCreate struct {
RealmRepresentation gocloak.RealmRepresentation `yaml:"realm_repepresentation" json:"realm_repepresentation"`
Clients []Client `yaml:"clients,omitempty" json:"clients,omitempty"`
Users []User `yaml:"users,omitempty" json:"users,omitempty"`
CustomRealmRoles []gocloak.Role `yaml:"custom_realm_roles,omitempty" json:"custom_realm_roles,omitempty"`
CustomClientRoles map[string][]gocloak.Role `yaml:"custom_client_roles,omitempty" json:"custom_client_roles,omitempty"`
CustomGroups []gocloak.Group `yaml:"custom_groups,omitempty" json:"custom_groups,omitempty"`
TokenExchanges []TokenExchange `yaml:"token_exchanges,omitempty" json:"token_exchanges,omitempty"`
}
type User struct {
gocloak.User
Copies int `yaml:"copies,omitempty" json:"copies,omitempty"`
}
type Client struct {
Client gocloak.Client `yaml:"client" json:"client"`
SaRealmRoles []string `yaml:"sa_realm_roles,omitempty" json:"sa_realm_roles,omitempty"`
SaClientRoles map[string][]string `yaml:"sa_client_roles,omitempty" json:"sa_client_roles,omitempty"`
Copies int `yaml:"copies,omitempty" json:"copies,omitempty"`
}
type TokenExchange struct {
StartClientID string `yaml:"start_client" json:"start_client"`
TargetClientID string `yaml:"target_client" json:"target_client"`
}
// Extracts the HTTP status code from err if it is available
// as an http status code. Returns 0 for no error and -1 for
// invalid error; use const values kcErrNone and kcErrUnknown.
func kcErrCode(err error) int {
if err == nil {
return kcErrNone
}
var kcErr *gocloak.APIError
if errors.As(err, &kcErr) {
return kcErr.Code
}
return kcErrUnknown
}
type KeycloakConnectParams struct {
BasePath string
Username string
Password string
Realm string
Audience string
AllowInsecureTLS bool
}
// TokenManagerConfig allows configuring token refresh behavior
type TokenManagerConfig struct {
// TokenBuffer is duration before expiration to trigger preemptive refresh
// Default: 120s (2 minutes)
TokenBuffer time.Duration
}
// TokenManager manages automatic token refresh for Keycloak operations
type TokenManager struct {
connectParams KeycloakConnectParams
client *gocloak.GoCloak
token *gocloak.JWT
expiresAt time.Time
tokenBuffer time.Duration
mu sync.Mutex
}
func SetupKeycloak(ctx context.Context, kcConnectParams KeycloakConnectParams) error {
return SetupKeycloakWithConfig(ctx, kcConnectParams, nil)
}
func SetupKeycloakWithConfig(ctx context.Context, kcConnectParams KeycloakConnectParams, tmConfig *TokenManagerConfig) error {
return setupKeycloakWithConfig(ctx, kcConnectParams, tmConfig, keycloakSetupOptions{
includeCustomDPoPMapper: true,
includeCertExchange: true,
})
}
func SetupStandardKeycloak(ctx context.Context, kcConnectParams KeycloakConnectParams) error {
return SetupStandardKeycloakWithConfig(ctx, kcConnectParams, nil)
}
func SetupStandardKeycloakWithConfig(ctx context.Context, kcConnectParams KeycloakConnectParams, tmConfig *TokenManagerConfig) error {
return setupKeycloakWithConfig(ctx, kcConnectParams, tmConfig, keycloakSetupOptions{
includeCustomDPoPMapper: false,
includeCertExchange: false,
})
}
type keycloakSetupOptions struct {
includeCustomDPoPMapper bool
includeCertExchange bool
}
func setupKeycloakWithConfig(ctx context.Context, kcConnectParams KeycloakConnectParams, tmConfig *TokenManagerConfig, options keycloakSetupOptions) error {
// Create TokenManager
tm, err := NewTokenManager(ctx, &kcConnectParams, tmConfig)
if err != nil {
return fmt.Errorf("failed to create token manager: %w", err)
}
// Get token and client
token, err := tm.GetToken(ctx)
if err != nil {
return fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
// Create realm
realm, err := client.GetRealm(ctx, token.AccessToken, kcConnectParams.Realm)
if err != nil {
switch kcErrCode(err) {
case http.StatusConflict:
slog.Info("realm already exists, skipping create", slog.String("realm", kcConnectParams.Realm))
case http.StatusNotFound:
// yay!
default:
return err
}
}
//nolint:nestif // only create realm if it does not exist
if realm == nil {
realm := gocloak.RealmRepresentation{
Realm: gocloak.StringP(kcConnectParams.Realm),
Enabled: gocloak.BoolP(true),
}
if _, err := client.CreateRealm(ctx, token.AccessToken, realm); err != nil {
return err
}
//nolint:sloglint // allow existing emojis
slog.Info("✅ realm created", slog.String("realm", kcConnectParams.Realm))
// update realm users profile via upconfig
realmProfileURL := fmt.Sprintf("%s/admin/realms/%s/users/profile", kcConnectParams.BasePath, kcConnectParams.Realm)
realmUserProfileResp, err := client.GetRequestWithBearerAuth(ctx, token.AccessToken).Get(realmProfileURL)
if err != nil {
return err
}
var upConfig map[string]interface{}
err = json.Unmarshal([]byte(realmUserProfileResp.String()), &upConfig)
if err != nil {
return err
}
upConfig["unmanagedAttributePolicy"] = "ENABLED"
_, err = client.GetRequestWithBearerAuth(ctx, token.AccessToken).SetBody(upConfig).Put(realmProfileURL)
if err != nil {
return err
}
//nolint:sloglint // allow existing emojis
slog.Info("✅ realm users profile updated", slog.String("realm", kcConnectParams.Realm))
} else {
//nolint:sloglint // allow existing emojis
slog.Info("⏭️ realm already exists", slog.String("realm", kcConnectParams.Realm))
}
opentdfClientID := "opentdf"
opentdfSdkClientID := "opentdf-sdk"
opentdfAdminRoleName := "opentdf-admin"
opentdfStandardRoleName := "opentdf-standard"
testingOnlyRoleName := "opentdf-testing-role"
opentdfERSClientID := "tdf-entity-resolution"
opentdfAuthorizationClientID := "tdf-authorization-svc"
realmMangementClientName := "realm-management"
protocolMappers := defaultProtocolMappers(kcConnectParams.Audience, options.includeCustomDPoPMapper)
// Create Roles
roles := []string{opentdfAdminRoleName, opentdfStandardRoleName, testingOnlyRoleName}
for _, role := range roles {
_, err := client.CreateRealmRole(ctx, token.AccessToken, kcConnectParams.Realm, gocloak.Role{
Name: gocloak.StringP(role),
})
if err != nil {
switch kcErrCode(err) {
case http.StatusConflict:
//nolint:sloglint // allow existing emojis
slog.Warn("⏭️ role already exists", slog.String("role", role))
default:
return err
}
} else {
//nolint:sloglint // allow existing emojis
slog.Info("✅ role created", slog.String("role", role))
}
}
// Get the roles
var opentdfAdminRole *gocloak.Role
var opentdfStandardRole *gocloak.Role
var testingOnlyRole *gocloak.Role
realmRoles, err := client.GetRealmRoles(ctx, token.AccessToken, kcConnectParams.Realm, gocloak.GetRoleParams{
Search: gocloak.StringP("opentdf"),
})
if err != nil {
return err
}
//nolint:sloglint // allow existing emojis
slog.Info("✅ roles found", slog.Int("count", len(realmRoles)))
for _, role := range realmRoles {
switch *role.Name {
case opentdfAdminRoleName:
opentdfAdminRole = role
case opentdfStandardRoleName:
opentdfStandardRole = role
case testingOnlyRoleName:
testingOnlyRole = role
}
}
// Create OpenTDF Client
opentdfClient := gocloak.Client{
ClientID: gocloak.StringP(opentdfClientID),
Enabled: gocloak.BoolP(true),
Name: gocloak.StringP(opentdfClientID),
ServiceAccountsEnabled: gocloak.BoolP(true),
ClientAuthenticatorType: gocloak.StringP("client-secret"),
Secret: gocloak.StringP("secret"),
ProtocolMappers: &protocolMappers,
}
if !options.includeCustomDPoPMapper {
opentdfClient = withDPoPBoundAccessTokens(opentdfClient)
}
_, err = createClient(ctx, tm, &kcConnectParams, opentdfClient, []gocloak.Role{*opentdfAdminRole}, nil)
if err != nil {
return err
}
var (
testScopeID = "5787804c-cdd1-44db-ac74-c46fbda91ccc"
testScope *gocloak.ClientScope
)
// Try an get the test scope
switch _, err = client.GetClientScope(ctx, token.AccessToken, kcConnectParams.Realm, testScopeID); kcErrCode(err) {
case http.StatusNotFound:
testScope = &gocloak.ClientScope{
ID: gocloak.StringP(testScopeID),
Name: gocloak.StringP("testscope"),
Description: gocloak.StringP("a scope for testing"),
Protocol: gocloak.StringP("openid-connect"),
ClientScopeAttributes: &gocloak.ClientScopeAttributes{IncludeInTokenScope: gocloak.StringP("true")},
}
testScopeID, err = client.CreateClientScope(ctx, token.AccessToken, kcConnectParams.Realm, *testScope)
if err != nil {
return err
}
case kcErrNone:
break
case kcErrUnknown:
return err
default:
// This should never happen
}
// Create TDF SDK Client
opentdfSdkClient := gocloak.Client{
ClientID: gocloak.StringP(opentdfSdkClientID),
Enabled: gocloak.BoolP(true),
// OptionalClientScopes: &[]string{"testscope"},
Name: gocloak.StringP(opentdfSdkClientID),
ServiceAccountsEnabled: gocloak.BoolP(true),
ClientAuthenticatorType: gocloak.StringP("client-secret"),
Secret: gocloak.StringP("secret"),
DirectAccessGrantsEnabled: gocloak.BoolP(true),
ProtocolMappers: &protocolMappers,
}
if !options.includeCustomDPoPMapper {
opentdfSdkClient = withDPoPBoundAccessTokens(opentdfSdkClient)
}
sdkNumericID, err := createClient(ctx, tm, &kcConnectParams, opentdfSdkClient, []gocloak.Role{*opentdfStandardRole, *testingOnlyRole}, nil)
if err != nil {
return err
}
err = client.AddOptionalScopeToClient(ctx, token.AccessToken, kcConnectParams.Realm, sdkNumericID, testScopeID)
if err != nil {
slog.Error("error adding scope to client", slog.Any("error", err))
return err
}
err = client.CreateClientScopesScopeMappingsRealmRoles(ctx, token.AccessToken, kcConnectParams.Realm, testScopeID, []gocloak.Role{*testingOnlyRole})
if err != nil {
slog.Error("error creating a client scope mapping", slog.Any("error", err))
return err
}
// Create TDF Entity Resolution Client
realmManagementClientID, err := getIDOfClient(ctx, tm, &kcConnectParams, &realmMangementClientName)
if err != nil {
return err
}
clientRolesToAdd, addErr := getClientRolesByList(ctx, &kcConnectParams, tm, *realmManagementClientID, []string{"view-clients", "query-clients", "view-users", "query-users"})
if addErr != nil {
slog.Error("error getting client roles", slog.Any("error", err))
return err
}
_, err = createClient(ctx, tm, &kcConnectParams, gocloak.Client{
ClientID: gocloak.StringP(opentdfERSClientID),
Enabled: gocloak.BoolP(true),
Name: gocloak.StringP(opentdfERSClientID),
ServiceAccountsEnabled: gocloak.BoolP(true),
ClientAuthenticatorType: gocloak.StringP("client-secret"),
Secret: gocloak.StringP("secret"),
ProtocolMappers: &protocolMappers,
}, nil, map[string][]gocloak.Role{*realmManagementClientID: clientRolesToAdd})
if err != nil {
return err
}
// Create TDF Authorization Svc Client
_, err = createClient(ctx, tm, &kcConnectParams, gocloak.Client{
ClientID: gocloak.StringP(opentdfAuthorizationClientID),
Enabled: gocloak.BoolP(true),
Name: gocloak.StringP(opentdfAuthorizationClientID),
ServiceAccountsEnabled: gocloak.BoolP(true),
ClientAuthenticatorType: gocloak.StringP("client-secret"),
Secret: gocloak.StringP("secret"),
ProtocolMappers: &protocolMappers,
}, nil, nil)
if err != nil {
return err
}
// opentdfSdkClientNumericId, err := getIDOfClient(ctx, client, token, &kcConnectParams, &opentdfClientId)
// if err != nil {
// slog.Error("error getting the sdk id", slog.Any("error", err))
// return err
// }
user := gocloak.User{
FirstName: gocloak.StringP("sample"),
LastName: gocloak.StringP("user"),
Email: gocloak.StringP("sampleuser@sample.com"),
Enabled: gocloak.BoolP(true),
Username: gocloak.StringP("sampleuser"),
Attributes: &map[string][]string{"superhero_name": {"thor"}, "superhero_group": {"avengers"}},
}
_, err = createUser(ctx, tm, &kcConnectParams, user)
if err != nil {
panic("Oh no!, failed to create user :(")
}
// Enable standard token exchange for the requester client.
if err := createTokenExchange(ctx, &kcConnectParams, opentdfClientID); err != nil {
return err
}
if options.includeCertExchange {
if err := createCertExchange(ctx, &kcConnectParams, "x509-auth-flow", opentdfSdkClientID); err != nil {
return err
}
}
return nil
}
func defaultProtocolMappers(audience string, includeCustomDPoPMapper bool) []gocloak.ProtocolMapperRepresentation {
protocolMappers := []gocloak.ProtocolMapperRepresentation{
{
Name: gocloak.StringP("audience-mapper"),
Protocol: gocloak.StringP("openid-connect"),
ProtocolMapper: gocloak.StringP("oidc-audience-mapper"),
Config: &map[string]string{
"included.client.audience": audience,
"included.custom.audience": "custom_audience",
"access.token.claim": "true",
"id.token.claim": "true",
},
},
}
if includeCustomDPoPMapper {
protocolMappers = append(protocolMappers, gocloak.ProtocolMapperRepresentation{
Name: gocloak.StringP("dpop-mapper"),
Protocol: gocloak.StringP("openid-connect"),
ProtocolMapper: gocloak.StringP("virtru-oidc-protocolmapper"),
Config: &map[string]string{
"claim.name": "tdf_claims",
"client.dpop": "true",
"tdf_claims.enabled": "true",
"access.token.claim": "true",
"client.publickey": "X-VirtruPubKey",
},
})
}
return protocolMappers
}
func SetupCustomKeycloak(ctx context.Context, kcParams KeycloakConnectParams, keycloakData KeycloakData) error {
return SetupCustomKeycloakWithConfig(ctx, kcParams, keycloakData, nil)
}
func SetupCustomKeycloakWithConfig(ctx context.Context, kcParams KeycloakConnectParams, keycloakData KeycloakData, tmConfig *TokenManagerConfig) error {
// for each realm to create
for _, realmToCreate := range keycloakData.Realms {
// login and try to create the realm
if realmToCreate.RealmRepresentation.Realm == nil {
return errors.New("realm does not have name")
}
kcConnectParams := KeycloakConnectParams{
BasePath: kcParams.BasePath,
Username: kcParams.Username,
Password: kcParams.Password,
Realm: *realmToCreate.RealmRepresentation.Realm,
AllowInsecureTLS: true,
}
// Create TokenManager for this realm
tm, err := NewTokenManager(ctx, &kcConnectParams, tmConfig)
if err != nil {
return fmt.Errorf("failed to create token manager: %w", err)
}
err = createRealmWithTokenManager(ctx, kcConnectParams, realmToCreate.RealmRepresentation, tm)
if err != nil {
return err
}
// create the custom realm roles
if realmToCreate.CustomRealmRoles != nil {
for _, customRole := range realmToCreate.CustomRealmRoles {
err = createRealmRole(ctx, tm, *realmToCreate.RealmRepresentation.Realm, customRole)
if err != nil {
return err
}
}
}
// create the custom groups
if realmToCreate.CustomGroups != nil {
for _, customGroup := range realmToCreate.CustomGroups {
err = createGroup(ctx, tm, *realmToCreate.RealmRepresentation.Realm, customGroup)
if err != nil {
return err
}
}
}
// create the clients
if realmToCreate.Clients != nil { //nolint:nestif // need to create clients in order
for _, customClient := range realmToCreate.Clients {
realmRoles, err := getRealmRolesByList(ctx, kcConnectParams.Realm, tm, customClient.SaRealmRoles)
if err != nil {
return err
}
clientRoleMap := make(map[string][]gocloak.Role)
for clientID, roleString := range customClient.SaClientRoles {
longClientID, err := getIDOfClient(ctx, tm, &kcConnectParams, &clientID)
if err != nil {
return err
}
roleList, err := getClientRolesByList(ctx, &kcConnectParams, tm, *longClientID, roleString)
if err != nil {
return err
}
clientRoleMap[*longClientID] = roleList
}
_, err = createClient(ctx, tm, &kcConnectParams, customClient.Client, realmRoles, clientRoleMap)
if err != nil {
return err
}
if customClient.Copies < 1 {
continue
}
baseClientID := *customClient.Client.ClientID
baseClientName := *customClient.Client.Name
numDigits := int(math.Log10(float64(customClient.Copies-1))) + 1
padFormat := fmt.Sprintf("%%s-%%%dd", numDigits)
for i := 0; i < customClient.Copies; i++ {
customClient.Client.ClientID = gocloak.StringP(fmt.Sprintf(padFormat, baseClientID, i))
customClient.Client.Name = gocloak.StringP(fmt.Sprintf(padFormat, baseClientName, i))
_, err = createClient(ctx, tm, &kcConnectParams, customClient.Client, realmRoles, clientRoleMap)
if err != nil {
return err
}
}
}
}
// create the custom client roles
if realmToCreate.CustomClientRoles != nil {
for clientID, customRoles := range realmToCreate.CustomClientRoles {
for _, customRole := range customRoles {
err = createClientRole(ctx, tm, *realmToCreate.RealmRepresentation.Realm, clientID, customRole)
if err != nil {
return err
}
}
}
}
// create the users
if realmToCreate.Users != nil {
for _, customUser := range realmToCreate.Users {
_, err = createUser(ctx, tm, &kcConnectParams, customUser.User)
if err != nil {
return err
}
if customUser.Copies < 1 {
continue
}
baseUserName := *customUser.Username
baseEmail := *customUser.Email
numDigits := int(math.Log10(float64(customUser.Copies-1))) + 1
padFormat := fmt.Sprintf("%%s-%%%dd", numDigits)
for i := 0; i < customUser.Copies; i++ {
customUser.Username = gocloak.StringP(fmt.Sprintf(padFormat, baseUserName, i))
customUser.Email = gocloak.StringP(fmt.Sprintf("%d-%s", i, baseEmail))
_, err = createUser(ctx, tm, &kcConnectParams, customUser.User)
if err != nil {
return err
}
}
}
}
// create token exchanges
if realmToCreate.TokenExchanges != nil {
for _, tokenExchange := range realmToCreate.TokenExchanges {
err := createTokenExchangeWithTokenManager(ctx, &kcConnectParams, tm, tokenExchange.StartClientID)
if err != nil {
return err
}
}
}
}
return nil
}
// NewTokenManager creates a new TokenManager with initial login
func NewTokenManager(ctx context.Context, connectParams *KeycloakConnectParams, config *TokenManagerConfig) (*TokenManager, error) {
if connectParams == nil {
return nil, errors.New("connectParams cannot be nil")
}
// Set default token buffer if not provided
tokenBuffer := defaultTokenBufferSeconds * time.Second
if config != nil && config.TokenBuffer > 0 {
tokenBuffer = config.TokenBuffer
}
tm := &TokenManager{
connectParams: *connectParams,
tokenBuffer: tokenBuffer,
}
// Perform initial login
if err := tm.refreshToken(ctx); err != nil {
return nil, fmt.Errorf("initial login failed: %w", err)
}
return tm, nil
}
// GetToken returns a valid token, refreshing if necessary
func (tm *TokenManager) GetToken(ctx context.Context) (*gocloak.JWT, error) {
tm.mu.Lock()
defer tm.mu.Unlock()
// Check if token needs refresh
if tm.needsRefresh() {
slog.InfoContext(ctx, "keycloak token expired or expiring soon - refreshing")
if err := tm.refreshToken(ctx); err != nil {
return nil, fmt.Errorf("failed to refresh token: %w", err)
}
slog.InfoContext(ctx, "successfully refreshed keycloak token",
slog.Int("expires_in_seconds", tm.token.ExpiresIn))
}
return tm.token, nil
}
// GetClient returns the GoCloak client
func (tm *TokenManager) GetClient() *gocloak.GoCloak {
tm.mu.Lock()
defer tm.mu.Unlock()
return tm.client
}
// needsRefresh checks if the token needs to be refreshed
// Must be called with mutex locked
func (tm *TokenManager) needsRefresh() bool {
if tm.token == nil || tm.client == nil {
return true
}
return time.Now().After(tm.expiresAt.Add(-tm.tokenBuffer))
}
// refreshToken performs the actual token refresh
// Must be called with mutex locked
func (tm *TokenManager) refreshToken(ctx context.Context) error {
// Create client if needed
if tm.client == nil {
client := gocloak.NewClient(tm.connectParams.BasePath)
restyClient := client.RestyClient()
restyClient.SetTLSClientConfig(&tls.Config{
InsecureSkipVerify: tm.connectParams.AllowInsecureTLS, //nolint:gosec // need insecure TLS option for testing and development
})
tm.client = client
}
// Get new token from master realm
// Note: Admin tokens are ALWAYS obtained from the "master" realm in Keycloak,
// regardless of which realm is being managed. The token has admin permissions
// across all realms. This is standard Keycloak authentication behavior.
token, err := tm.client.LoginAdmin(ctx, tm.connectParams.Username, tm.connectParams.Password, "master")
if err != nil {
return fmt.Errorf("keycloak login failed: %w", err)
}
tm.token = token
// Use the token's expiration time if available, otherwise calculate from ExpiresIn
if token.ExpiresIn > 0 {
tm.expiresAt = time.Now().Add(time.Duration(token.ExpiresIn) * time.Second)
// Adaptive buffer: if token lifetime is shorter than buffer, use 50% of lifetime instead
tokenLifetime := time.Duration(token.ExpiresIn) * time.Second
if tm.tokenBuffer >= tokenLifetime {
tm.tokenBuffer = tokenLifetime / adaptiveBufferDivisor
slog.InfoContext(ctx, "adjusted token buffer for short token lifetime",
slog.Duration("token_lifetime", tokenLifetime),
slog.Duration("adjusted_buffer", tm.tokenBuffer))
}
} else {
// Fallback to a reasonable default if ExpiresIn is not set
tm.expiresAt = time.Now().Add(defaultFallbackExpiryMinutes * time.Minute)
}
return nil
}
func keycloakLogin(ctx context.Context, connectParams *KeycloakConnectParams) (*gocloak.GoCloak, *gocloak.JWT, error) {
client := gocloak.NewClient(connectParams.BasePath)
restyClient := client.RestyClient()
// TODO allow insecure TLS....
restyClient.SetTLSClientConfig(&tls.Config{InsecureSkipVerify: connectParams.AllowInsecureTLS}) //nolint:gosec // need insecure TLS option for testing and development
// Get Token from master
token, err := client.LoginAdmin(ctx, connectParams.Username, connectParams.Password, "master")
if err != nil {
slog.Error("error logging into keycloak", slog.Any("error", err))
}
return client, token, err
}
func createRealmWithTokenManager(ctx context.Context, kcConnectParams KeycloakConnectParams, realm gocloak.RealmRepresentation, tm *TokenManager) error {
// Get fresh token
token, err := tm.GetToken(ctx)
if err != nil {
return fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
// Create realm
r, err := client.GetRealm(ctx, token.AccessToken, *realm.Realm)
if err != nil {
var kcErr *gocloak.APIError
if errors.As(err, &kcErr) {
switch kcErr.Code {
case http.StatusNotFound:
// Realm doesn't exist, we'll create it below
case http.StatusConflict:
slog.Info("realm already exists, skipping create", slog.String("realm", *realm.Realm))
default:
return err
}
} else {
// Non-Keycloak error
return err
}
}
if r == nil {
if _, err := client.CreateRealm(ctx, token.AccessToken, realm); err != nil {
return err
}
//nolint:sloglint // allow existing emojis
slog.Info("✅ realm created", slog.String("realm", *realm.Realm))
} else {
//nolint:sloglint // allow existing emojis
slog.Info("⏭️ realm already exists", slog.String("realm", *realm.Realm))
}
// update realm users profile via upconfig
realmProfileURL := fmt.Sprintf("%s/admin/realms/%s/users/profile", kcConnectParams.BasePath, *realm.Realm)
realmUserProfileResp, err := client.GetRequestWithBearerAuth(ctx, token.AccessToken).Get(realmProfileURL)
if err != nil {
slog.Error("error retrieving realm users profile", slog.String("realm", *realm.Realm))
return err
}
var upConfig map[string]interface{}
err = json.Unmarshal([]byte(realmUserProfileResp.String()), &upConfig)
if err != nil {
return err
}
upConfig["unmanagedAttributePolicy"] = "ENABLED"
_, err = client.GetRequestWithBearerAuth(ctx, token.AccessToken).SetBody(upConfig).Put(realmProfileURL)
if err != nil {
return err
}
//nolint:sloglint // allow existing emojis
slog.Info("✅ realm users profile updated", slog.String("realm", *realm.Realm))
return nil
}
func createGroup(ctx context.Context, tm *TokenManager, realmName string, group gocloak.Group) error {
if group.Name == nil {
return errors.New("group does not have name")
}
// Get fresh token
token, err := tm.GetToken(ctx)
if err != nil {
return fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
_, err = client.CreateGroup(ctx, token.AccessToken, realmName, group)
if err != nil {
kcErr := err.(*gocloak.APIError) //nolint:errcheck,errorlint,forcetypeassert // kc error checked below
if kcErr.Code == http.StatusConflict {
//nolint:sloglint // allow existing emojis
slog.Warn("⏭️ group already exists", slog.String("group", *group.Name))
} else {
return err
}
} else {
//nolint:sloglint // allow existing emojis
slog.Info("✅ group created", slog.String("group", *group.Name))
}
return nil
}
func createRealmRole(ctx context.Context, tm *TokenManager, realmName string, role gocloak.Role) error {
if role.Name == nil {
return errors.New("realm role does not have name")
}
// Get fresh token
token, err := tm.GetToken(ctx)
if err != nil {
return fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
_, err = client.CreateRealmRole(ctx, token.AccessToken, realmName, role)
if err != nil {
kcErr := err.(*gocloak.APIError) //nolint:errcheck,errorlint,forcetypeassert // kc error checked below
if kcErr.Code == http.StatusConflict {
//nolint:sloglint // allow existing emojis
slog.Warn("⏭️ role already exists", slog.String("role", *role.Name))
} else {
return err
}
} else {
//nolint:sloglint // allow existing emojis
slog.Info("✅ role created", slog.String("role", *role.Name))
}
return nil
}
func createClientRole(ctx context.Context, tm *TokenManager, realmName string, clientID string, role gocloak.Role) error {
if role.Name == nil {
return errors.New("client role does not have name")
}
// Get fresh token
token, err := tm.GetToken(ctx)
if err != nil {
return fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
results, err := client.GetClients(ctx, token.AccessToken, realmName, gocloak.GetClientsParams{ClientID: &clientID})
if err != nil || len(results) == 0 {
slog.Error("error getting client",
slog.String("client_id", clientID),
slog.Any("error", err))
return err
}
idOfClient := results[0].ID
_, err = client.CreateClientRole(ctx, token.AccessToken, realmName, *idOfClient, role)
if err != nil {
kcErr := err.(*gocloak.APIError) //nolint:errcheck,errorlint,forcetypeassert // kc error checked below
if kcErr.Code == http.StatusConflict {
//nolint:sloglint // allow existing emojis
slog.Warn("⏭️ role already exists for client",
slog.String("role", *role.Name),
slog.String("client_id", clientID))
} else {
return err
}
} else {
//nolint:sloglint // allow existing emojis
slog.Info("✅ client role created",
slog.String("client_id", clientID),
slog.String("role", *role.Name))
}
return nil
}
func createClient(ctx context.Context, tm *TokenManager, connectParams *KeycloakConnectParams, newClient gocloak.Client, realmRoles []gocloak.Role, clientRoles map[string][]gocloak.Role) (string, error) {
// Get fresh token
token, err := tm.GetToken(ctx)
if err != nil {
return "", fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
var longClientID string
clientID := *newClient.ClientID
longClientID, err = client.CreateClient(ctx, token.AccessToken, connectParams.Realm, newClient)
if err != nil {
switch kcErrCode(err) {
case http.StatusConflict:
//nolint:sloglint // allow existing emojis
slog.Warn("⏭️ client already exists", slog.String("client_id", clientID))
clients, err := client.GetClients(ctx, token.AccessToken, connectParams.Realm, gocloak.GetClientsParams{ClientID: newClient.ClientID})
if err != nil {
return "", err
}
if len(clients) == 1 {
longClientID = *clients[0].ID
} else {
err = fmt.Errorf("❗️ error, %s client not found", clientID)
return "", err
}
default:
slog.Error("error creating client",
slog.String("client_id", clientID),
slog.Any("error", err))
return "", err
}
} else {
//nolint:sloglint // allow existing emojis
slog.Info("✅ client created",
slog.String("client_id", clientID),
slog.String("client_identifier", longClientID))
}
// if the client is not public
if newClient.ServiceAccountsEnabled != nil && *newClient.ServiceAccountsEnabled { //nolint:nestif // have to handle the different cases
// Get service account user
user, err := client.GetClientServiceAccount(ctx, token.AccessToken, connectParams.Realm, longClientID)
if err != nil {
slog.Error("error getting service account user for client",
slog.String("client_id", clientID),
slog.Any("error", err))
return "", err
}
slog.Info("ℹ️ service account user for client",
slog.String("client_id", clientID),
slog.String("username", *user.Username))
if realmRoles != nil {
//nolint:sloglint // allow existing emojis
slog.Info("⏭️ adding realm roles to client via service account",
slog.String("client_id", longClientID),
slog.String("username", *user.Username))
if err := client.AddRealmRoleToUser(ctx, token.AccessToken, connectParams.Realm, *user.ID, realmRoles); err != nil {
for _, role := range realmRoles {
slog.Warn("error adding role", slog.String("role", *role.Name))
}
return "", err
}
for _, role := range realmRoles {
//nolint:sloglint // allow existing emojis
slog.Info("✅ realm role added to client",
slog.String("role", *role.Name),
slog.String("client_id", longClientID))
}
}
if clientRoles != nil {
//nolint:sloglint // allow existing emojis
slog.Info("⏭️ adding client roles to client via service account",
slog.String("client_id", longClientID),
slog.String("username", *user.Username))
for clientIDRole, roles := range clientRoles {
if err := client.AddClientRolesToUser(ctx, token.AccessToken, connectParams.Realm, clientIDRole, *user.ID, roles); err != nil {
for _, role := range roles {
slog.Warn("error adding role", slog.String("role", *role.Name))
}
return "", err
}
for _, role := range roles {
//nolint:sloglint // allow existing emojis
slog.Info("✅ client role added to client",
slog.String("role", *role.Name),
slog.String("client_id", longClientID))
}
}
}
}
return longClientID, nil
}
func createUser(ctx context.Context, tm *TokenManager, connectParams *KeycloakConnectParams, newUser gocloak.User) (*string, error) { //nolint:unparam // return var to be used in future
// Get fresh token
token, err := tm.GetToken(ctx)
if err != nil {
return nil, fmt.Errorf("failed to get token: %w", err)
}
client := tm.GetClient()
username := *newUser.Username
longUserID, err := client.CreateUser(ctx, token.AccessToken, connectParams.Realm, newUser)
if err != nil {
if kcErrCode(err) != http.StatusConflict {
slog.Error("error creating user",
slog.String("username", username),
slog.Any("error", err))
return nil, err
}
slog.Warn("user already exists", slog.String("username", username))
users, err := client.GetUsers(ctx, token.AccessToken, connectParams.Realm, gocloak.GetUsersParams{
Username: newUser.Username,
Exact: gocloak.BoolP(true),
})
if err != nil {
return nil, err
}
switch len(users) {
case 1:
longUserID = *users[0].ID
case 0:
return nil, fmt.Errorf("error, %s user not found", username)
default:
return nil, fmt.Errorf("error, multiple users found with username %s", username)
}
} else {
//nolint:sloglint // allow existing emojis
slog.Info("✅ user created",
slog.String("username", username),
slog.String("user_identifier", longUserID))
}
// assign realm roles to user
// retrieve the roles by name
if newUser.RealmRoles != nil {
roles, err := getRealmRolesByList(ctx, connectParams.Realm, tm, *newUser.RealmRoles)
if err != nil {
return nil, err
}
err = client.AddRealmRoleToUser(ctx, token.AccessToken, connectParams.Realm, longUserID, roles)
if err != nil {
slog.Error("error adding realm roles to user",
slog.Any("roles", *newUser.RealmRoles),
slog.String("realm", connectParams.Realm))
return nil, err
}
}
// assign client roles to user
if newUser.ClientRoles != nil {
for clientID, roles := range *newUser.ClientRoles {
results, err := client.GetClients(ctx, token.AccessToken, connectParams.Realm, gocloak.GetClientsParams{ClientID: &clientID})
if err != nil || len(results) == 0 {
slog.Error("error getting client",
slog.String("client_id", clientID),
slog.Any("error", err))