-
Notifications
You must be signed in to change notification settings - Fork 13
/
provider.go
450 lines (390 loc) · 13 KB
/
provider.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
package oauth
import (
"encoding/json"
"fmt"
"net/http"
"strings"
"time"
coreapi "github.com/Axway/agent-sdk/pkg/api"
corecfg "github.com/Axway/agent-sdk/pkg/config"
"github.com/Axway/agent-sdk/pkg/util/log"
)
// ProviderType - type of provider
type ProviderType int
// Provider - interface for external IdP provider
type Provider interface {
GetName() string
GetTitle() string
GetIssuer() string
GetTokenEndpoint() string
GetMTLSTokenEndpoint() string
GetAuthorizationEndpoint() string
GetSupportedScopes() []string
GetSupportedGrantTypes() []string
GetSupportedTokenAuthMethods() []string
GetSupportedResponseMethod() []string
RegisterClient(clientMetadata ClientMetadata) (ClientMetadata, error)
UnregisterClient(clientID string) error
}
type provider struct {
logger log.FieldLogger
cfg corecfg.IDPConfig
metadataURL string
extraProperties map[string]string
apiClient coreapi.Client
authServerMetadata *AuthorizationServerMetadata
authClient AuthClient
idpType typedIDP
}
type typedIDP interface {
getAuthorizationHeaderPrefix() string
preProcessClientRequest(clientRequest *clientMetadata)
}
// NewProvider - create a new IdP provider
func NewProvider(idp corecfg.IDPConfig, tlsCfg corecfg.TLSConfig, proxyURL string, clientTimeout time.Duration) (Provider, error) {
logger := log.NewFieldLogger().
WithComponent("provider").
WithPackage("sdk.agent.authz.oauth")
apiClient := coreapi.NewClient(tlsCfg, proxyURL, coreapi.WithTimeout(clientTimeout))
var idpType typedIDP
switch idp.GetIDPType() {
case TypeOkta:
idpType = &okta{}
default: // keycloak, generic
idpType = &genericIDP{}
}
p := &provider{
logger: logger,
metadataURL: idp.GetMetadataURL(),
cfg: idp,
extraProperties: idp.GetExtraProperties(),
apiClient: apiClient,
idpType: idpType,
}
metadata, err := p.fetchMetadata()
if err != nil {
p.logger.
WithField("name", p.cfg.GetIDPName()).
WithField("type", p.cfg.GetIDPType()).
WithField("metadata-url", p.metadataURL).
WithError(err).
Error("unable to fetch OAuth authorization server metadata")
return nil, err
}
p.authServerMetadata = metadata
// No OAuth client is needed to request token for access token based authentication to IdP
if p.cfg.GetAuthConfig() != nil && p.cfg.GetAuthConfig().GetType() != corecfg.AccessToken {
p.authClient, err = p.createAuthClient()
if err != nil {
return nil, err
}
}
return p, nil
}
func (p *provider) fetchMetadata() (*AuthorizationServerMetadata, error) {
request := coreapi.Request{
Method: coreapi.GET,
URL: p.metadataURL,
}
response, err := p.apiClient.Send(request)
if err != nil {
return nil, err
}
if response.Code == http.StatusOK {
authSrvMetadata := &AuthorizationServerMetadata{}
err = json.Unmarshal(response.Body, authSrvMetadata)
return authSrvMetadata, err
}
return nil, fmt.Errorf("error fetching metadata status code: %d, body: %s", response.Code, string(response.Body))
}
func (p *provider) createAuthClient() (AuthClient, error) {
switch p.cfg.GetAuthConfig().GetType() {
case corecfg.Client:
fallthrough
case corecfg.ClientSecretPost:
return p.createClientSecretPostAuthClient()
case corecfg.ClientSecretBasic:
return p.createClientSecretBasicAuthClient()
case corecfg.ClientSecretJWT:
return p.createClientSecretJWTAuthClient()
case corecfg.PrivateKeyJWT:
return p.createPrivateKeyJWTAuthClient()
case corecfg.TLSClientAuth:
fallthrough
case corecfg.SelfSignedTLSClientAuth:
return p.createTLSAuthClient()
default:
return nil, fmt.Errorf("%s", "unknown IdP auth type")
}
}
func (p *provider) createClientSecretPostAuthClient() (AuthClient, error) {
return NewAuthClient(p.GetTokenEndpoint(), p.apiClient,
WithServerName(p.cfg.GetIDPName()),
WithClientSecretPostAuth(p.cfg.GetAuthConfig().GetClientID(), p.cfg.GetAuthConfig().GetClientSecret(), p.cfg.GetAuthConfig().GetClientScope()))
}
func (p *provider) createClientSecretBasicAuthClient() (AuthClient, error) {
return NewAuthClient(p.GetTokenEndpoint(), p.apiClient,
WithServerName(p.cfg.GetIDPName()),
WithClientSecretBasicAuth(p.cfg.GetAuthConfig().GetClientID(), p.cfg.GetAuthConfig().GetClientSecret(), p.cfg.GetAuthConfig().GetClientScope()))
}
func (p *provider) createClientSecretJWTAuthClient() (AuthClient, error) {
return NewAuthClient(p.GetTokenEndpoint(), p.apiClient,
WithServerName(p.cfg.GetIDPName()),
WithClientSecretJwtAuth(
p.cfg.GetAuthConfig().GetClientID(),
p.cfg.GetAuthConfig().GetClientSecret(),
p.cfg.GetAuthConfig().GetClientScope(),
p.cfg.GetAuthConfig().GetClientID(),
p.authServerMetadata.Issuer,
p.cfg.GetAuthConfig().GetTokenSigningMethod(),
))
}
func (p *provider) createPrivateKeyJWTAuthClient() (AuthClient, error) {
keyReader := NewKeyReader(
p.cfg.GetAuthConfig().GetPrivateKey(),
p.cfg.GetAuthConfig().GetPublicKey(),
p.cfg.GetAuthConfig().GetKeyPassword(),
)
privateKey, keyErr := keyReader.GetPrivateKey()
if keyErr != nil {
return nil, keyErr
}
publicKey, keyErr := keyReader.GetPublicKey()
if keyErr != nil {
return nil, keyErr
}
return NewAuthClient(p.GetTokenEndpoint(), p.apiClient,
WithServerName(p.cfg.GetIDPName()),
WithKeyPairAuth(
p.cfg.GetAuthConfig().GetClientID(),
p.cfg.GetAuthConfig().GetClientID(),
p.authServerMetadata.Issuer,
privateKey,
publicKey,
p.cfg.GetAuthConfig().GetClientScope(),
p.cfg.GetAuthConfig().GetTokenSigningMethod(),
),
)
}
func (p *provider) createTLSAuthClient() (AuthClient, error) {
return NewAuthClient(p.GetMTLSTokenEndpoint(), p.apiClient,
WithServerName(p.cfg.GetIDPName()),
WithTLSClientAuth(p.cfg.GetAuthConfig().GetClientID(), p.cfg.GetAuthConfig().GetClientScope()))
}
// GetName - returns the name of the provider
func (p *provider) GetName() string {
return p.cfg.GetIDPName()
}
// GetTitle - returns the friendly name of the provider
func (p *provider) GetTitle() string {
return p.cfg.GetIDPTitle()
}
// GetIssuer - returns the issuer for the provider
func (p *provider) GetIssuer() string {
if p.authServerMetadata != nil {
return p.authServerMetadata.Issuer
}
return ""
}
func (p *provider) useTLSAuth() bool {
if p.cfg.GetAuthConfig() == nil {
return false
}
return p.cfg.GetAuthConfig().GetType() == corecfg.TLSClientAuth || p.cfg.GetAuthConfig().GetType() == corecfg.SelfSignedTLSClientAuth
}
// GetTokenEndpoint - return the token endpoint URL
func (p *provider) GetTokenEndpoint() string {
return p.authServerMetadata.TokenEndpoint
}
func (p *provider) GetMTLSTokenEndpoint() string {
if p.authServerMetadata != nil {
if p.authServerMetadata.MTLSEndPointAlias != nil && p.authServerMetadata.MTLSEndPointAlias.TokenEndpoint != "" {
return p.authServerMetadata.MTLSEndPointAlias.TokenEndpoint
}
return p.authServerMetadata.TokenEndpoint
}
return ""
}
// GetAuthorizationEndpoint - return authorization endpoint
func (p *provider) GetAuthorizationEndpoint() string {
if p.authServerMetadata != nil {
return p.authServerMetadata.AuthorizationEndpoint
}
return ""
}
// GetSupportedScopes - returns the global scopes supported by provider
func (p *provider) GetSupportedScopes() []string {
if p.authServerMetadata != nil {
return p.authServerMetadata.ScopesSupported
}
return []string{""}
}
// GetSupportedGrantTypes - returns the grant type supported by provider
func (p *provider) GetSupportedGrantTypes() []string {
if p.authServerMetadata != nil {
return p.authServerMetadata.GrantTypesSupported
}
return []string{""}
}
// GetSupportedTokenAuthMethods - returns the token auth method supported by provider
func (p *provider) GetSupportedTokenAuthMethods() []string {
if p.authServerMetadata != nil {
return p.authServerMetadata.TokenEndpointAuthMethodSupported
}
return []string{""}
}
// GetSupportedResponseMethod - returns the token response method supported by provider
func (p *provider) GetSupportedResponseMethod() []string {
if p.authServerMetadata != nil {
return p.authServerMetadata.ResponseTypesSupported
}
return []string{""}
}
func (p *provider) getClientRegistraionEndpoint() string {
registrationEndpoint := p.authServerMetadata.RegistrationEndpoint
if p.useTLSAuth() &&
p.authServerMetadata.MTLSEndPointAlias != nil && p.authServerMetadata.MTLSEndPointAlias.RegistrationEndpoint != "" {
registrationEndpoint = p.authServerMetadata.MTLSEndPointAlias.RegistrationEndpoint
}
return registrationEndpoint
}
// RegisterClient - register the OAuth client with IDP
func (p *provider) RegisterClient(clientReq ClientMetadata) (ClientMetadata, error) {
authPrefix := p.idpType.getAuthorizationHeaderPrefix()
err := p.enrichClientReq(clientReq)
if err != nil {
return nil, err
}
clientBuffer, err := json.Marshal(clientReq)
if err != nil {
return nil, err
}
token, err := p.getClientToken()
if err != nil {
return nil, err
}
header := map[string]string{
hdrAuthorization: authPrefix + " " + token,
hdrContentType: mimeApplicationJSON,
}
request := coreapi.Request{
Method: coreapi.POST,
URL: p.getClientRegistraionEndpoint(),
Headers: header,
Body: clientBuffer,
}
response, err := p.apiClient.Send(request)
if err != nil {
return nil, err
}
if response.Code == http.StatusCreated || response.Code == http.StatusOK {
clientRes := &clientMetadata{}
err = json.Unmarshal(response.Body, clientRes)
p.logger.
WithField("provider", p.cfg.GetIDPName()).
WithField("client-name", clientReq.GetClientName()).
WithField("grant-type", clientReq.GetGrantTypes()).
WithField("token-auth-method", clientReq.GetTokenEndpointAuthMethod()).
WithField("response-type", clientReq.GetResponseTypes()).
WithField("redirect-url", clientReq.GetRedirectURIs()).
Info("registered client")
return clientRes, err
}
err = fmt.Errorf("error status code: %d, body: %s", response.Code, string(response.Body))
p.logger.
WithField("client-name", clientReq.GetClientName()).
WithField("grant-type", clientReq.GetGrantTypes()).
WithField("token-auth-method", clientReq.GetTokenEndpointAuthMethod()).
WithField("response-type", clientReq.GetResponseTypes()).
WithField("redirect-url", clientReq.GetRedirectURIs()).
Error(err.Error())
return nil, err
}
func (p *provider) enrichClientReq(clientReq ClientMetadata) error {
clientRequest, ok := clientReq.(*clientMetadata)
if !ok {
return fmt.Errorf("unrecognized client request metadata")
}
p.applyClientDefaults(clientRequest)
clientRequest.extraProperties = p.extraProperties
p.idpType.preProcessClientRequest(clientRequest)
p.preProcessResponseType(clientRequest)
return nil
}
func (p *provider) applyClientDefaults(clientRequest *clientMetadata) {
// Default the values from config if not set on the request
if len(clientRequest.GetScopes()) == 0 {
clientRequest.Scope = strings.Split(p.cfg.GetClientScopes(), " ")
}
if len(clientRequest.GetGrantTypes()) == 0 {
clientRequest.GrantTypes = []string{p.cfg.GetGrantType()}
}
if clientRequest.TokenEndpointAuthMethod == "" {
clientRequest.TokenEndpointAuthMethod = p.cfg.GetAuthMethod()
}
if len(clientRequest.ResponseTypes) == 0 {
defaultAuthResponseType := p.cfg.GetAuthResponseType()
if defaultAuthResponseType == "" {
defaultAuthResponseType = AuthResponseToken
}
clientRequest.ResponseTypes = []string{defaultAuthResponseType}
}
}
func (p *provider) preProcessResponseType(clientRequest *clientMetadata) {
for _, grantTypes := range clientRequest.GrantTypes {
if grantTypes == GrantTypeAuthorizationCode {
if !p.hasCodeResponseMethod(clientRequest) {
clientRequest.ResponseTypes = []string{AuthResponseCode}
}
}
}
}
func (p *provider) hasCodeResponseMethod(clientRequest *clientMetadata) bool {
for _, authResponseMethod := range clientRequest.ResponseTypes {
if authResponseMethod == AuthResponseCode {
return true
}
}
return false
}
// UnregisterClient - removes the OAuth client from IDP
func (p *provider) UnregisterClient(clientID string) error {
authPrefix := p.idpType.getAuthorizationHeaderPrefix()
token, err := p.getClientToken()
if err != nil {
return err
}
header := map[string]string{
hdrAuthorization: authPrefix + " " + token,
hdrContentType: mimeApplicationJSON,
}
request := coreapi.Request{
Method: coreapi.DELETE,
URL: p.getClientRegistraionEndpoint() + "/" + clientID,
Headers: header,
}
response, err := p.apiClient.Send(request)
if err != nil {
return err
}
if response.Code != http.StatusNoContent {
err := fmt.Errorf("error status code: %d, body: %s", response.Code, string(response.Body))
p.logger.
WithField("provider", p.cfg.GetIDPName()).
WithField("client-name", clientID).
Error(err.Error())
return err
}
p.logger.
WithField("provider", p.cfg.GetIDPName()).
WithField("client-name", clientID).
Info("unregistered client")
return nil
}
func (p *provider) getClientToken() (string, error) {
if p.authClient != nil {
useTokenCache := p.cfg.GetAuthConfig().UseTokenCache()
return p.authClient.FetchToken(useTokenCache)
}
return p.cfg.GetAuthConfig().GetAccessToken(), nil
}