-
Notifications
You must be signed in to change notification settings - Fork 72
/
keycloak_connection.go
410 lines (334 loc) · 11.9 KB
/
keycloak_connection.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
package connection
import (
"context"
"crypto/x509"
"fmt"
"github.com/redhat-developer/app-services-cli/internal/build"
"net"
"net/http"
"net/url"
kafkainstance "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal"
kafkainstanceclient "github.com/redhat-developer/app-services-sdk-go/kafkainstance/apiv1internal/client"
kafkamgmt "github.com/redhat-developer/app-services-sdk-go/kafkamgmt/apiv1"
kafkamgmtclient "github.com/redhat-developer/app-services-sdk-go/kafkamgmt/apiv1/client"
registryinstance "github.com/redhat-developer/app-services-sdk-go/registryinstance/apiv1internal"
registryinstanceclient "github.com/redhat-developer/app-services-sdk-go/registryinstance/apiv1internal/client"
registrymgmt "github.com/redhat-developer/app-services-sdk-go/registrymgmt/apiv1"
registrymgmtclient "github.com/redhat-developer/app-services-sdk-go/registrymgmt/apiv1/client"
"golang.org/x/oauth2"
"github.com/redhat-developer/app-services-cli/pkg/api/ams/amsclient"
"github.com/redhat-developer/app-services-cli/pkg/api/kas"
"github.com/redhat-developer/app-services-cli/pkg/api/rbac"
"github.com/redhat-developer/app-services-cli/pkg/kafka/kafkaerr"
"github.com/redhat-developer/app-services-cli/internal/config"
"github.com/redhat-developer/app-services-cli/pkg/api"
"github.com/redhat-developer/app-services-cli/pkg/logging"
"github.com/Nerzal/gocloak/v7"
"github.com/redhat-developer/app-services-cli/pkg/auth/token"
)
var DefaultScopes = []string{
"openid",
}
// KeycloakConnection contains the data needed to connect to the `api.openshift.com`. Don't create instances
// of this type directly, use the builder instead
type KeycloakConnection struct {
trustedCAs *x509.CertPool
insecure bool
defaultHTTPClient *http.Client
clientID string
Token *token.Token
MASToken *token.Token
scopes []string
keycloakClient gocloak.GoCloak
masKeycloakClient gocloak.GoCloak
apiURL *url.URL
consoleURL *url.URL
defaultRealm string
masRealm string
logger logging.Logger
Config config.IConfig
connectionConfig *Config
}
// RefreshTokens will fetch a refreshed copy of the access token and refresh token from the authentication server
// The new tokens will have an increased expiry time and are persisted in the config and connection
func (c *KeycloakConnection) RefreshTokens(ctx context.Context) (err error) {
c.logger.Debug("Refreshing tokens")
cfg, err := c.Config.Load()
if err != nil {
return err
}
// track if we need to update the config with new token values
var cfgChanged bool
if c.connectionConfig.RequireAuth {
// nolint:govet
refreshedTk, err := c.keycloakClient.RefreshToken(ctx, c.Token.RefreshToken, c.clientID, "", c.defaultRealm)
if err != nil {
return &AuthError{err}
}
if refreshedTk.AccessToken != c.Token.AccessToken {
c.Token.AccessToken = refreshedTk.AccessToken
cfg.AccessToken = refreshedTk.AccessToken
cfgChanged = true
}
if refreshedTk.RefreshToken != c.Token.RefreshToken {
c.Token.RefreshToken = refreshedTk.RefreshToken
cfg.RefreshToken = refreshedTk.RefreshToken
cfgChanged = true
}
}
if c.connectionConfig.RequireMASAuth {
// nolint:govet
refreshedMasTk, err := c.masKeycloakClient.RefreshToken(ctx, c.MASToken.RefreshToken, c.clientID, "", c.masRealm)
if err != nil {
return &MasAuthError{err}
}
if refreshedMasTk.AccessToken != c.MASToken.AccessToken {
c.MASToken.AccessToken = refreshedMasTk.AccessToken
cfg.MasAccessToken = refreshedMasTk.AccessToken
cfgChanged = true
}
if refreshedMasTk.RefreshToken != c.MASToken.RefreshToken {
c.MASToken.RefreshToken = refreshedMasTk.RefreshToken
cfg.MasRefreshToken = refreshedMasTk.RefreshToken
cfgChanged = true
}
}
if !cfgChanged {
return nil
}
if err = c.Config.Save(cfg); err != nil {
return err
}
c.logger.Debug("Tokens refreshed")
return nil
}
// Logout logs the user out from the authentication server
// Invalidating and removing the access and refresh tokens
// The user will have to log in again to access the API
func (c *KeycloakConnection) Logout(ctx context.Context) (err error) {
err = c.keycloakClient.Logout(ctx, c.clientID, "", c.defaultRealm, c.Token.RefreshToken)
if err != nil {
return &AuthError{err}
}
if c.MASToken.RefreshToken != "" {
err = c.masKeycloakClient.Logout(ctx, c.clientID, "", c.masRealm, c.MASToken.RefreshToken)
if err != nil {
return &AuthError{err}
}
}
c.Token.AccessToken = ""
c.Token.RefreshToken = ""
c.MASToken.AccessToken = ""
c.MASToken.RefreshToken = ""
cfg, err := c.Config.Load()
if err != nil {
return err
}
cfg.AccessToken = ""
cfg.RefreshToken = ""
cfg.MasAccessToken = ""
cfg.MasRefreshToken = ""
return c.Config.Save(cfg)
}
// API Creates a new API type which is a single type for multiple APIs
// nolint:funlen
func (c *KeycloakConnection) API() *api.API {
amsAPIFunc := func() amsclient.DefaultApi {
amsAPIClient := c.createAmsAPIClient()
return amsAPIClient.DefaultApi
}
kafkaAPIFunc := func() kafkamgmtclient.DefaultApi {
// create the client
kafkaAPIClient := c.createKafkaAPIClient()
return kafkaAPIClient.DefaultApi
}
serviceAccountAPIFunc := func() kafkamgmtclient.SecurityApi {
apiClient := c.createKafkaAPIClient()
return apiClient.SecurityApi
}
registryAPIFunc := func() registrymgmtclient.RegistriesApi {
srsAPIClient := c.createServiceRegistryAPIClient()
return srsAPIClient.RegistriesApi
}
rbacAPI := rbac.RbacAPI{
PrincipalAPI: func() rbac.PrincipalAPI {
cl := c.createOAuthTransport(c.Token.AccessToken)
cfg := rbac.Config{
HTTPClient: cl,
Debug: c.logger.DebugEnabled(),
BaseURL: c.consoleURL,
}
return rbac.NewPrincipalAPIClient(&cfg)
},
}
kafkaAdminAPIFunc := func(kafkaID string) (*kafkainstanceclient.APIClient, *kafkamgmtclient.KafkaRequest, error) {
kafkaAPI := kafkaAPIFunc()
kafkaInstance, resp, err := kafkaAPI.GetKafkaById(context.Background(), kafkaID).Execute()
defer resp.Body.Close()
if kas.IsErr(err, kas.ErrorNotFound) {
return nil, nil, kafkaerr.NotFoundByIDError(kafkaID)
} else if err != nil {
return nil, nil, fmt.Errorf("%w", err)
}
kafkaStatus := kafkaInstance.GetStatus()
switch kafkaStatus {
case "provisioning", "accepted":
err = fmt.Errorf(`Kafka instance "%v" is not ready yet`, kafkaInstance.GetName())
return nil, nil, err
case "failed":
err = fmt.Errorf(`Kafka instance "%v" has failed`, kafkaInstance.GetName())
return nil, nil, err
case "deprovision":
err = fmt.Errorf(`Kafka instance "%v" is being deprovisioned`, kafkaInstance.GetName())
return nil, nil, err
case "deleting":
err = fmt.Errorf(`Kafka instance "%v" is being deleted`, kafkaInstance.GetName())
return nil, nil, err
}
bootstrapURL := kafkaInstance.GetBootstrapServerHost()
if bootstrapURL == "" {
err = fmt.Errorf(`bootstrap URL is missing for Kafka instance "%v"`, kafkaInstance.GetName())
return nil, nil, err
}
// create the client
client := c.createKafkaAdminAPI(bootstrapURL)
return client, &kafkaInstance, nil
}
registryInstanceAPIFunc := func(registryID string) (*registryinstanceclient.APIClient, *registrymgmtclient.Registry, error) {
registryAPI := registryAPIFunc()
instance, resp, err := registryAPI.GetRegistry(context.Background(), registryID).Execute()
defer resp.Body.Close()
if err != nil {
return nil, nil, fmt.Errorf("%w", err)
}
status := instance.GetStatus()
// nolint
switch status {
case "provisioning", "accepted":
err = fmt.Errorf(`service registry instance "%v" is not ready yet`, instance.GetName())
return nil, nil, err
case "failed":
err = fmt.Errorf(`service registry instance "%v" has failed`, instance.GetName())
return nil, nil, err
case "deprovision":
err = fmt.Errorf(`service registry instance "%v" is being deprovisioned`, instance.GetName())
return nil, nil, err
case "deleting":
err = fmt.Errorf(`service registry instance "%v" is being deleted`, instance.GetName())
return nil, nil, err
}
registryUrl := instance.GetRegistryUrl()
if registryUrl == "" {
err = fmt.Errorf(`URL is missing for Service Registry instance "%v"`, instance.GetName())
return nil, nil, err
}
// create the client
client := c.createServiceRegistryInstanceAPI(registryUrl)
return client, &instance, nil
}
return &api.API{
Kafka: kafkaAPIFunc,
ServiceAccount: serviceAccountAPIFunc,
KafkaAdmin: kafkaAdminAPIFunc,
ServiceRegistryInstance: registryInstanceAPIFunc,
AccountMgmt: amsAPIFunc,
ServiceRegistryMgmt: registryAPIFunc,
RBAC: rbacAPI,
}
}
// Create a new Kafka API client
func (c *KeycloakConnection) createKafkaAPIClient() *kafkamgmtclient.APIClient {
tc := c.createOAuthTransport(c.Token.AccessToken)
client := kafkamgmt.NewAPIClient(&kafkamgmt.Config{
BaseURL: c.apiURL.String(),
Debug: c.logger.DebugEnabled(),
HTTPClient: tc,
UserAgent: build.DefaultUserAgentPrefix + build.Version,
})
return client
}
// Create a new Registry API client
func (c *KeycloakConnection) createServiceRegistryAPIClient() *registrymgmtclient.APIClient {
tc := c.createOAuthTransport(c.Token.AccessToken)
client := registrymgmt.NewAPIClient(®istrymgmt.Config{
BaseURL: c.apiURL.String(),
Debug: c.logger.DebugEnabled(),
HTTPClient: tc,
UserAgent: build.DefaultUserAgentPrefix + build.Version,
})
return client
}
// Create a new KafkaAdmin API client
func (c *KeycloakConnection) createKafkaAdminAPI(bootstrapURL string) *kafkainstanceclient.APIClient {
host, port, _ := net.SplitHostPort(bootstrapURL)
var apiURL *url.URL
if host == "localhost" {
apiURL = &url.URL{
Scheme: "http",
Host: fmt.Sprintf("localhost:%v", port),
}
apiURL.Scheme = "http"
apiURL.Path = "/data/kafka"
} else {
apiHost := fmt.Sprintf("admin-server-%v", host)
apiURL, _ = url.Parse(apiHost)
apiURL.Scheme = "https"
apiURL.Path = "/rest"
apiURL.Host = fmt.Sprintf("admin-server-%v", host)
}
c.logger.Debugf("Making request to %v", apiURL.String())
client := kafkainstance.NewAPIClient(&kafkainstance.Config{
BaseURL: apiURL.String(),
Debug: c.logger.DebugEnabled(),
HTTPClient: c.createOAuthTransport(c.MASToken.AccessToken),
UserAgent: build.DefaultUserAgentPrefix + build.Version,
})
return client
}
// Create a new RegistryInstance API client
func (c *KeycloakConnection) createServiceRegistryInstanceAPI(registryUrl string) *registryinstanceclient.APIClient {
host, port, _ := net.SplitHostPort(registryUrl)
var baseURL string
if host == "localhost" {
var apiURL = &url.URL{
Scheme: "http",
Host: fmt.Sprintf("localhost:%v", port),
}
apiURL.Scheme = "http"
apiURL.Path = "/data/registry"
baseURL = apiURL.String()
} else {
baseURL = registryUrl + "/apis/registry/v2"
}
c.logger.Debugf("Making request to %v", baseURL)
client := registryinstance.NewAPIClient(®istryinstance.Config{
BaseURL: baseURL,
Debug: c.logger.DebugEnabled(),
HTTPClient: c.createOAuthTransport(c.MASToken.AccessToken),
UserAgent: build.DefaultUserAgentPrefix + build.Version,
})
return client
}
func (c *KeycloakConnection) createAmsAPIClient() *amsclient.APIClient {
cfg := amsclient.NewConfiguration()
cfg.Scheme = c.apiURL.Scheme
cfg.Host = c.apiURL.Host
cfg.UserAgent = build.DefaultUserAgentPrefix + build.Version
cfg.HTTPClient = c.createOAuthTransport(c.Token.AccessToken)
apiClient := amsclient.NewAPIClient(cfg)
return apiClient
}
// wraps the HTTP client with an OAuth2 Transport layer to provide automatic token refreshing
func (c *KeycloakConnection) createOAuthTransport(accessToken string) *http.Client {
ts := oauth2.StaticTokenSource(
&oauth2.Token{
AccessToken: accessToken,
},
)
return &http.Client{
Transport: &oauth2.Transport{
Base: c.defaultHTTPClient.Transport,
Source: oauth2.ReuseTokenSource(nil, ts),
},
}
}