-
Notifications
You must be signed in to change notification settings - Fork 120
/
token.go
403 lines (364 loc) · 12 KB
/
token.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
/*
Copyright (c) 2018 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
// This file contains the implementations of the methods of the connection that handle OpenID
// authentication tokens.
package sdk
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io/ioutil"
"net/http"
"net/url"
"strconv"
"strings"
"time"
"github.com/dgrijalva/jwt-go"
"github.com/openshift-online/ocm-sdk-go/internal"
)
// Tokens returns the access and refresh tokens that is currently in use by the connection. If it is
// necessary to request a new token because it wasn't requested yet, or because it is expired, this
// method will do it and will return an error if it fails.
//
// This operation is potentially lengthy, as it may require network communication. Consider using a
// context and the TokensContext method.
func (c *Connection) Tokens() (access, refresh string, err error) {
return c.TokensContext(context.Background())
}
// TokensContext returns the access and refresh tokens that is currently in use by the connection.
// If it is necessary to request a new token because it wasn't requested yet, or because it is
// expired, this method will do it and will return an error if it fails.
func (c *Connection) TokensContext(ctx context.Context) (access, refresh string, err error) {
// We need to make sure that this method isn't execute concurrently, as we will be updating
// multiple attributes of the connection:
c.tokenMutex.Lock()
defer c.tokenMutex.Unlock()
// Check the expiration times of the tokens:
now := time.Now()
var accessExpires bool
var accessLeft time.Duration
if c.accessToken != nil {
accessExpires, accessLeft, err = tokenExpiry(c.accessToken, now)
if err != nil {
return
}
}
var refreshExpires bool
var refreshLeft time.Duration
if c.refreshToken != nil {
refreshExpires, refreshLeft, err = tokenExpiry(c.refreshToken, now)
if err != nil {
return
}
}
if c.logger.DebugEnabled() {
c.debugExpiry(ctx, "Bearer", c.accessToken, accessExpires, accessLeft)
c.debugExpiry(ctx, "Refresh", c.refreshToken, refreshExpires, refreshLeft)
}
// If the access token is available and it isn't expired or about to expire then we can
// return the current tokens directly:
if c.accessToken != nil && (!accessExpires || accessLeft >= 1*time.Minute) {
access, refresh = c.currentTokens()
return
}
// At this point we know that the access token is unavailable, expired or about to expire.
// So we need to check if we can use the refresh token to request a new one.
if c.refreshToken != nil && (!refreshExpires || refreshLeft >= 1*time.Minute) {
_, _, err = c.sendRefreshTokenForm(ctx)
if err != nil {
return
}
access, refresh = c.currentTokens()
return
}
// Now we know that both the access and refresh tokens are unavailable, expired or about to
// expire. So we need to check if we have other credentials that can be used to request a
// new token, and use them.
if c.haveCredentials() {
_, _, err = c.sendRequestTokenForm(ctx)
if err != nil {
return
}
access, refresh = c.currentTokens()
return
}
// Here we know that the access and refresh tokens are unavailable, expired or about to
// expire. We also know that we don't have credentials to request new ones. But we could
// still use the refresh token if it isn't completely expired.
if c.refreshToken != nil && refreshLeft > 0 {
c.logger.Warn(
ctx,
"Refresh token expires in only %s, but there is no other mechanism to "+
"obtain a new token, so will try to use it anyhow",
refreshLeft,
)
_, _, err = c.sendRefreshTokenForm(ctx)
if err != nil {
return
}
access, refresh = c.currentTokens()
return
}
// At this point we know that the access token is expired or about to expire. We know also
// that the refresh token is unavailable or completely expired. And we know that we don't
// have credentials to request new tokens. But we can still use the access token if it isn't
// expired.
if c.accessToken != nil && accessLeft > 0 {
c.logger.Warn(
ctx,
"Access token expires in only %s, but there is no other mechanism to "+
"obtain a new token, so will try to use it anyhow",
accessLeft,
)
access, refresh = c.currentTokens()
return
}
// There is no way to get a valid access token, so all we can do is report the failure:
err = fmt.Errorf(
"access and refresh tokens are unavailable or expired, and there are no " +
"password or client secret to request new ones",
)
return
}
// currentTokens returns the current tokens without trying to send any request to refresh them, and
// checking that they are actually available. If they aren't available then it will return empty
// strings.
func (c *Connection) currentTokens() (access, refresh string) {
if c.accessToken != nil {
access = c.accessToken.Raw
}
if c.refreshToken != nil {
refresh = c.refreshToken.Raw
}
return
}
func (c *Connection) sendRequestTokenForm(ctx context.Context) (code int,
result *internal.TokenResponse, err error) {
form := url.Values{}
if c.havePassword() {
c.logger.Debug(ctx, "Requesting new token using the password grant")
form.Set("grant_type", "password")
form.Set("client_id", c.clientID)
form.Set("username", c.user)
form.Set("password", c.password)
} else if c.haveSecret() {
c.logger.Debug(ctx, "Requesting new token using the client credentials grant")
form.Set("grant_type", "client_credentials")
form.Set("client_id", c.clientID)
form.Set("client_secret", c.clientSecret)
} else {
err = fmt.Errorf(
"either password or client secret must be provided",
)
return
}
form.Set("scope", strings.Join(c.scopes, " "))
return c.sendTokenForm(ctx, form)
}
func (c *Connection) sendRefreshTokenForm(ctx context.Context) (code int,
result *internal.TokenResponse, err error) {
// Send the refresh token grant form:
c.logger.Debug(ctx, "Requesting new token using the refresh token grant")
form := url.Values{}
form.Set("grant_type", "refresh_token")
form.Set("client_id", c.clientID)
form.Set("client_secret", c.clientSecret)
form.Set("refresh_token", c.refreshToken.Raw)
code, result, err = c.sendTokenForm(ctx, form)
// If the server returns an 'invalid_grant' error response then it may be that the
// session has expired even if the tokens have not expired. This may happen when the SSO
// server has been restarted or its session caches have been cleared. In theory that should
// not happen, but in practice it happens from time to time, specially when using the client
// credentials grant. To handle that smoothly we request new tokens if we have credentials
// to do so.
if err != nil && result != nil {
var errorCode string
if result.Error != nil {
errorCode = *result.Error
}
var errorDescription string
if result.ErrorDescription != nil {
errorDescription = *result.ErrorDescription
}
if errorCode == "invalid_grant" && c.haveCredentials() {
c.logger.Info(
ctx,
"Server returned error code '%s' and error description '%s' "+
"when the refresh token isn't expired",
errorCode, errorDescription,
)
return c.sendRequestTokenForm(ctx)
}
}
return
}
func (c *Connection) sendTokenForm(ctx context.Context,
form url.Values) (code int, result *internal.TokenResponse, err error) {
// Measure the time that it takes to send the request and receive the response:
before := time.Now()
code, result, err = c.sendTokenFormTimed(ctx, form)
after := time.Now()
elapsed := after.Sub(before)
// Update the metrics:
if c.tokenCountMetric != nil || c.tokenDurationMetric != nil {
labels := map[string]string{
metricsCodeLabel: strconv.Itoa(code),
}
if c.tokenCountMetric != nil {
c.tokenCountMetric.With(labels).Inc()
}
if c.tokenDurationMetric != nil {
c.tokenDurationMetric.With(labels).Observe(elapsed.Seconds())
}
}
// Return the original error:
return
}
func (c *Connection) sendTokenFormTimed(ctx context.Context, form url.Values) (code int,
result *internal.TokenResponse, err error) {
// Create the HTTP request:
body := []byte(form.Encode())
request, err := http.NewRequest(http.MethodPost, c.tokenURL.String(), bytes.NewReader(body))
request.Close = true
header := request.Header
if c.agent != "" {
header.Set("User-Agent", c.agent)
}
header.Set("Content-Type", "application/x-www-form-urlencoded")
header.Set("Accept", "application/json")
if err != nil {
err = fmt.Errorf("can't create request: %v", err)
return
}
// Set the context:
if ctx != nil {
request = request.WithContext(ctx)
}
// Send the HTTP request:
response, err := c.client.Do(request)
if err != nil {
err = fmt.Errorf("can't send request: %v", err)
return
}
defer response.Body.Close()
// Check that the response content type is JSON:
err = c.checkContentType(response)
if err != nil {
return
}
// Read the response body:
body, err = ioutil.ReadAll(response.Body)
if err != nil {
err = fmt.Errorf("can't read response: %v", err)
return
}
// Parse the response body:
result = &internal.TokenResponse{}
err = json.Unmarshal(body, result)
if err != nil {
err = fmt.Errorf("can't parse JSON response: %v", err)
return
}
if result.Error != nil {
if result.ErrorDescription != nil {
err = fmt.Errorf("%s: %s", *result.Error, *result.ErrorDescription)
return
}
err = fmt.Errorf("%s", *result.Error)
return
}
if response.StatusCode != http.StatusOK {
err = fmt.Errorf("token response status is: %s", response.Status)
return
}
if result.TokenType != nil && *result.TokenType != "bearer" {
err = fmt.Errorf("expected 'bearer' token type but got '%s", *result.TokenType)
return
}
if result.AccessToken == nil {
err = fmt.Errorf("no access token was received")
return
}
accessToken, _, err := c.tokenParser.ParseUnverified(*result.AccessToken, jwt.MapClaims{})
if err != nil {
return
}
if result.RefreshToken == nil {
err = fmt.Errorf("no refresh token was received")
return
}
refreshToken, _, err := c.tokenParser.ParseUnverified(*result.RefreshToken, jwt.MapClaims{})
if err != nil {
return
}
// Save the new tokens:
c.accessToken = accessToken
c.refreshToken = refreshToken
return
}
// haveCredentials returns true if the connection has credentials that can be used to request new
// tokens.
func (c *Connection) haveCredentials() bool {
return c.havePassword() || c.haveSecret()
}
func (c *Connection) havePassword() bool {
return c.user != "" && c.password != ""
}
func (c *Connection) haveSecret() bool {
return c.clientID != "" && c.clientSecret != ""
}
// debugExpiry sends to the log information about the expiration of the given token.
func (c *Connection) debugExpiry(ctx context.Context, typ string, token *jwt.Token, expires bool,
left time.Duration) {
if token != nil {
if expires {
if left < 0 {
c.logger.Debug(ctx, "%s token expired %s ago", typ, -left)
} else if left > 0 {
c.logger.Debug(ctx, "%s token expires in %s", typ, left)
} else {
c.logger.Debug(ctx, "%s token expired just now", typ)
}
}
} else {
c.logger.Debug(ctx, "%s token isn't available", typ)
}
}
// tokenExpiry determines if the given token expires, and the time that remains till it expires.
func tokenExpiry(token *jwt.Token, now time.Time) (expires bool,
left time.Duration, err error) {
claims, ok := token.Claims.(jwt.MapClaims)
if !ok {
err = fmt.Errorf("expected map claims bug got %T", claims)
return
}
claim, ok := claims["exp"]
if !ok {
err = fmt.Errorf("token doesn't contain the 'exp' claim")
return
}
exp, ok := claim.(float64)
if !ok {
err = fmt.Errorf("expected floating point 'exp' but got %T", claim)
return
}
if exp == 0 {
expires = false
left = 0
} else {
expires = true
left = time.Unix(int64(exp), 0).Sub(now)
}
return
}