-
Notifications
You must be signed in to change notification settings - Fork 3
/
flow_refresh.go
307 lines (247 loc) · 11.8 KB
/
flow_refresh.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
// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package oauth2
import (
"context"
"errors"
"fmt"
"strings"
"time"
"authelia.com/provider/oauth2"
"authelia.com/provider/oauth2/internal/consts"
"authelia.com/provider/oauth2/storage"
"authelia.com/provider/oauth2/x/errorsx"
)
// RefreshTokenGrantHandler handles access requests for the Refresh Token Flow.
type RefreshTokenGrantHandler struct {
AccessTokenStrategy AccessTokenStrategy
RefreshTokenStrategy RefreshTokenStrategy
TokenRevocationStorage TokenRevocationStorage
Config interface {
oauth2.AccessTokenLifespanProvider
oauth2.RefreshTokenLifespanProvider
oauth2.ScopeStrategyProvider
oauth2.AudienceStrategyProvider
oauth2.RefreshTokenScopesProvider
}
}
var (
_ oauth2.TokenEndpointHandler = (*RefreshTokenGrantHandler)(nil)
)
// HandleTokenEndpointRequest implements https://datatracker.ietf.org/doc/html/rfc6749#section-6
//
// TODO: Refactor time permitting.
//
//nolint:gocyclo
func (c *RefreshTokenGrantHandler) HandleTokenEndpointRequest(ctx context.Context, request oauth2.AccessRequester) error {
if !c.CanHandleTokenEndpointRequest(ctx, request) {
return errorsx.WithStack(oauth2.ErrUnknownRequest)
}
if !request.GetClient().GetGrantTypes().Has(consts.GrantTypeRefreshToken) {
return errorsx.WithStack(oauth2.ErrUnauthorizedClient.WithHint("The OAuth 2.0 Client is not allowed to use authorization grant 'refresh_token'."))
}
refresh := request.GetRequestForm().Get(consts.FormParameterRefreshToken)
signature := c.RefreshTokenStrategy.RefreshTokenSignature(ctx, refresh)
orequest, err := c.TokenRevocationStorage.GetRefreshTokenSession(ctx, signature, request.GetSession())
switch {
case err == nil:
if err = c.RefreshTokenStrategy.ValidateRefreshToken(ctx, orequest, refresh); err != nil {
// The authorization server MUST ... validate the refresh token.
// This needs to happen after store retrieval for the session to be hydrated properly.
if errors.Is(err, oauth2.ErrTokenExpired) {
return errorsx.WithStack(oauth2.ErrInvalidGrant.WithWrap(err).WithDebugError(err))
}
return errorsx.WithStack(oauth2.ErrInvalidRequest.WithWrap(err).WithDebugError(err))
}
case errors.Is(err, oauth2.ErrInactiveToken):
// Detected refresh token reuse.
if e := c.handleRefreshTokenReuse(ctx, signature, orequest); e != nil {
return errorsx.WithStack(e)
}
return errorsx.WithStack(oauth2.ErrInvalidGrant.WithWrap(err).WithDebugError(err))
case errors.Is(err, oauth2.ErrNotFound):
return errorsx.WithStack(oauth2.ErrInvalidGrant.WithWrap(err).WithDebugf("The refresh token has not been found: %s", oauth2.ErrorToDebugRFC6749Error(err).Error()))
default:
return errorsx.WithStack(oauth2.ErrServerError.WithWrap(err).WithDebugError(err))
}
if !(len(c.Config.GetRefreshTokenScopes(ctx)) == 0 || orequest.GetGrantedScopes().HasOneOf(c.Config.GetRefreshTokenScopes(ctx)...)) {
scopeNames := strings.Join(c.Config.GetRefreshTokenScopes(ctx), " or ")
hint := fmt.Sprintf("The OAuth 2.0 Client was not granted scope %s and may thus not perform the 'refresh_token' authorization grant.", scopeNames)
return errorsx.WithStack(oauth2.ErrScopeNotGranted.WithHint(hint))
}
// The authorization server MUST ... and ensure that the refresh token was issued to the authenticated client
if orequest.GetClient().GetID() != request.GetClient().GetID() {
return errorsx.WithStack(oauth2.ErrInvalidGrant.WithHint("The OAuth 2.0 Client ID from this request does not match the ID during the initial token issuance."))
}
request.SetID(orequest.GetID())
request.SetSession(orequest.GetSession().Clone())
/*
There are two key points in the following spec section this addresses:
1. If omitted the scope param should be treated as the same as the scope originally granted by the resource owner.
2. The REQUESTED scope MUST NOT include any scope not originally granted.
scope
OPTIONAL. The scope of the access request as described by Section 3.3. The requested scope MUST NOT
include any scope not originally granted by the resource owner, and if omitted is treated as equal to
the scope originally granted by the resource owner.
See https://datatracker.ietf.org/doc/html/rfc6749#section-6
*/
scopes := orequest.GetGrantedScopes()
oscopes := false
// Addresses point 1 of the text in RFC6749 Section 6.
if len(request.GetRequestedScopes()) == 0 {
request.SetRequestedScopes(scopes)
oscopes = true
}
if len(request.GetRequestedAudience()) == 0 {
request.SetRequestedAudience(orequest.GetGrantedAudience())
}
strategy := c.Config.GetScopeStrategy(ctx)
for _, scope := range request.GetRequestedScopes() {
if !oscopes && !scopes.Has(scope) {
if client, ok := request.GetClient().(oauth2.RefreshFlowScopeClient); ok && client.GetRefreshFlowIgnoreOriginalGrantedScopes(ctx) {
// Skips addressing point 2 of the text in RFC6749 Section 6 and instead just prevents the scope
// requested from being granted.
continue
}
// Addresses point 2 of the text in RFC6749 Section 6.
return errorsx.WithStack(oauth2.ErrInvalidScope.WithHintf("The requested scope '%s' was not originally granted by the resource owner.", scope))
}
if !strategy(request.GetClient().GetScopes(), scope) {
return errorsx.WithStack(oauth2.ErrInvalidScope.WithHintf("The OAuth 2.0 Client is not allowed to request scope '%s'.", scope))
}
request.GrantScope(scope)
}
if err = c.Config.GetAudienceStrategy(ctx)(request.GetClient().GetAudience(), request.GetRequestedAudience()); err != nil {
return err
}
for _, audience := range request.GetRequestedAudience() {
request.GrantAudience(audience)
}
atLifespan := oauth2.GetEffectiveLifespan(request.GetClient(), oauth2.GrantTypeRefreshToken, oauth2.AccessToken, c.Config.GetAccessTokenLifespan(ctx))
request.GetSession().SetExpiresAt(oauth2.AccessToken, time.Now().UTC().Add(atLifespan).Round(time.Second))
rtLifespan := oauth2.GetEffectiveLifespan(request.GetClient(), oauth2.GrantTypeRefreshToken, oauth2.RefreshToken, c.Config.GetRefreshTokenLifespan(ctx))
if rtLifespan > -1 {
request.GetSession().SetExpiresAt(oauth2.RefreshToken, time.Now().UTC().Add(rtLifespan).Round(time.Second))
}
return nil
}
// PopulateTokenEndpointResponse implements https://datatracker.ietf.org/doc/html/rfc6749#section-6
func (c *RefreshTokenGrantHandler) PopulateTokenEndpointResponse(ctx context.Context, requester oauth2.AccessRequester, responder oauth2.AccessResponder) (err error) {
if !c.CanHandleTokenEndpointRequest(ctx, requester) {
return errorsx.WithStack(oauth2.ErrUnknownRequest)
}
var (
accessToken, refreshToken string
accessSignature, refreshSignature string
)
if accessToken, accessSignature, err = c.AccessTokenStrategy.GenerateAccessToken(ctx, requester); err != nil {
return errorsx.WithStack(oauth2.ErrServerError.WithWrap(err).WithDebugError(err))
}
if refreshToken, refreshSignature, err = c.RefreshTokenStrategy.GenerateRefreshToken(ctx, requester); err != nil {
return errorsx.WithStack(oauth2.ErrServerError.WithWrap(err).WithDebugError(err))
}
signature := c.RefreshTokenStrategy.RefreshTokenSignature(ctx, requester.GetRequestForm().Get(consts.FormParameterRefreshToken))
if ctx, err = storage.MaybeBeginTx(ctx, c.TokenRevocationStorage); err != nil {
return errorsx.WithStack(oauth2.ErrServerError.WithWrap(err).WithDebugError(err))
}
defer func() {
err = c.handleRefreshTokenEndpointStorageError(ctx, err)
}()
var orequester oauth2.Requester
if orequester, err = c.TokenRevocationStorage.GetRefreshTokenSession(ctx, signature, nil); err != nil {
return err
}
if err = c.TokenRevocationStorage.RevokeAccessToken(ctx, orequester.GetID()); err != nil {
return err
}
if err = c.TokenRevocationStorage.RevokeRefreshTokenMaybeGracePeriod(ctx, orequester.GetID(), signature); err != nil {
return err
}
srequester := requester.Sanitize(nil)
srequester.SetID(orequester.GetID())
if err = c.TokenRevocationStorage.CreateAccessTokenSession(ctx, accessSignature, srequester); err != nil {
return err
}
if rtrequester, ok := requester.(oauth2.RefreshTokenAccessRequester); ok {
srtrequester := rtrequester.SanitizeRestoreRefreshTokenOriginalRequester(orequester)
srtrequester.SetSession(requester.GetSession().Clone())
if err = c.TokenRevocationStorage.CreateRefreshTokenSession(ctx, refreshSignature, srtrequester); err != nil {
return err
}
} else {
if err = c.TokenRevocationStorage.CreateRefreshTokenSession(ctx, refreshSignature, srequester); err != nil {
return err
}
}
responder.SetAccessToken(accessToken)
responder.SetTokenType(oauth2.BearerAccessToken)
responder.SetExpiresIn(getExpiresIn(requester, oauth2.AccessToken, oauth2.GetEffectiveLifespan(requester.GetClient(), oauth2.GrantTypeRefreshToken, oauth2.AccessToken, c.Config.GetAccessTokenLifespan(ctx)), time.Now().UTC()))
responder.SetScopes(requester.GetGrantedScopes())
responder.SetExtra(consts.AccessResponseRefreshToken, refreshToken)
if err = storage.MaybeCommitTx(ctx, c.TokenRevocationStorage); err != nil {
return err
}
return nil
}
// Reference: https://datatracker.ietf.org/doc/html/rfc6819#section-5.2.2.3
//
// The basic idea is to change the refresh token
// value with every refresh request in order to detect attempts to
// obtain access tokens using old refresh tokens. Since the
// authorization server cannot determine whether the attacker or the
// legitimate client is trying to access, in case of such an access
// attempt the valid refresh token and the access authorization
// associated with it are both revoked.
func (c *RefreshTokenGrantHandler) handleRefreshTokenReuse(ctx context.Context, signature string, req oauth2.Requester) (err error) {
ctx, err = storage.MaybeBeginTx(ctx, c.TokenRevocationStorage)
if err != nil {
return errorsx.WithStack(oauth2.ErrServerError.WithWrap(err).WithDebugError(err))
}
defer func() {
err = c.handleRefreshTokenEndpointStorageError(ctx, err)
}()
if err = c.TokenRevocationStorage.DeleteRefreshTokenSession(ctx, signature); err != nil {
return err
} else if err = c.TokenRevocationStorage.RevokeRefreshToken(
ctx, req.GetID(),
); err != nil && !errors.Is(err, oauth2.ErrNotFound) {
return err
} else if err = c.TokenRevocationStorage.RevokeAccessToken(
ctx, req.GetID(),
); err != nil && !errors.Is(err, oauth2.ErrNotFound) {
return err
}
if err = storage.MaybeCommitTx(ctx, c.TokenRevocationStorage); err != nil {
return err
}
return nil
}
func (c *RefreshTokenGrantHandler) handleRefreshTokenEndpointStorageError(ctx context.Context, storageErr error) (err error) {
if storageErr == nil {
return nil
}
defer func() {
if rollBackTxnErr := storage.MaybeRollbackTx(ctx, c.TokenRevocationStorage); rollBackTxnErr != nil {
err = errorsx.WithStack(oauth2.ErrServerError.WithWrap(err).WithDebugf("error: %s; rollback error: %s", err, rollBackTxnErr))
}
}()
if errors.Is(storageErr, oauth2.ErrSerializationFailure) {
return errorsx.WithStack(oauth2.ErrInvalidRequest.
WithDebugf(storageErr.Error()).
WithHint("Failed to refresh token because of multiple concurrent requests using the same token which is not allowed."))
}
if errors.Is(storageErr, oauth2.ErrNotFound) || errors.Is(storageErr, oauth2.ErrInactiveToken) {
return errorsx.WithStack(oauth2.ErrInvalidRequest.
WithDebugf(storageErr.Error()).
WithHint("Failed to refresh token because of multiple concurrent requests using the same token which is not allowed."))
}
return errorsx.WithStack(oauth2.ErrServerError.WithWrap(storageErr).WithDebugError(storageErr))
}
func (c *RefreshTokenGrantHandler) CanSkipClientAuth(ctx context.Context, requester oauth2.AccessRequester) bool {
return false
}
func (c *RefreshTokenGrantHandler) CanHandleTokenEndpointRequest(ctx context.Context, requester oauth2.AccessRequester) bool {
// grant_type REQUIRED.
// Value MUST be set to "refresh_token".
return requester.GetGrantTypes().ExactOne(consts.GrantTypeRefreshToken)
}