-
Notifications
You must be signed in to change notification settings - Fork 27
/
service.go
346 lines (289 loc) · 9.33 KB
/
service.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
package otp
import (
"errors"
"time"
"github.com/authgear/authgear-server/pkg/lib/config"
"github.com/authgear/authgear-server/pkg/lib/ratelimit"
"github.com/authgear/authgear-server/pkg/util/clock"
"github.com/authgear/authgear-server/pkg/util/httputil"
"github.com/authgear/authgear-server/pkg/util/log"
"github.com/iawaknahc/jsonschema/pkg/jsonpointer"
)
type GenerateOptions struct {
UserID string
WebSessionID string
WorkflowID string
AuthenticationFlowWebsocketChannelName string
AuthenticationFlowType string
AuthenticationFlowName string
AuthenticationFlowJSONPointer jsonpointer.T
SkipRateLimits bool
}
type VerifyOptions struct {
UserID string
UseSubmittedCode bool
SkipConsume bool
}
type CodeStore interface {
Create(purpose Purpose, code *Code) error
Get(purpose Purpose, target string) (*Code, error)
Update(purpose Purpose, code *Code) error
Delete(purpose Purpose, target string) error
}
type LookupStore interface {
Create(purpose Purpose, code string, target string, expireAt time.Time) error
Get(purpose Purpose, code string) (string, error)
Delete(purpose Purpose, code string) error
}
type AttemptTracker interface {
ResetFailedAttempts(purpose Purpose, target string) error
GetFailedAttempts(purpose Purpose, target string) (int, error)
IncrementFailedAttempts(purpose Purpose, target string) (int, error)
}
type RateLimiter interface {
Allow(spec ratelimit.BucketSpec) error
Reserve(spec ratelimit.BucketSpec) *ratelimit.Reservation
ReserveN(spec ratelimit.BucketSpec, n int) *ratelimit.Reservation
Cancel(r *ratelimit.Reservation)
}
type Logger struct{ *log.Logger }
func NewLogger(lf *log.Factory) Logger { return Logger{lf.New("otp")} }
type Service struct {
Clock clock.Clock
AppID config.AppID
TestModeConfig *config.TestModeConfig
TestModeFeatureConfig *config.TestModeFeatureConfig
RemoteIP httputil.RemoteIP
CodeStore CodeStore
LookupStore LookupStore
AttemptTracker AttemptTracker
Logger Logger
RateLimiter RateLimiter
}
func (s *Service) getCode(purpose Purpose, target string) (*Code, error) {
return s.CodeStore.Get(purpose, target)
}
func (s *Service) deleteCode(kind Kind, target string) error {
if err := s.CodeStore.Delete(kind.Purpose(), target); err != nil {
return err
}
// No need delete from lookup store;
// lookup entry is invalidated since target is no longer exist.
return nil
}
func (s *Service) consumeCode(purpose Purpose, code *Code) error {
code.Consumed = true
if err := s.CodeStore.Update(purpose, code); err != nil {
return err
}
// No need delete from lookup store;
// lookup entry is invalidated since target is no longer exist.
return nil
}
func (s *Service) handleFailedAttemptsRevocation(kind Kind, target string) error {
failedAttempts, err := s.AttemptTracker.IncrementFailedAttempts(kind.Purpose(), target)
if err != nil {
return err
}
maxFailedAttempts := kind.RevocationMaxFailedAttempts()
if maxFailedAttempts != 0 && failedAttempts >= maxFailedAttempts {
return ErrTooManyAttempts
}
return nil
}
func (s *Service) checkFailedAttemptsRevocation(kind Kind, target string) error {
failedAttempts, err := s.AttemptTracker.GetFailedAttempts(kind.Purpose(), target)
if err != nil {
return err
}
maxFailedAttempts := kind.RevocationMaxFailedAttempts()
if maxFailedAttempts != 0 && failedAttempts >= maxFailedAttempts {
err = s.deleteCode(kind, target)
if err != nil {
s.Logger.WithError(err).Warn("failed to revoke OTP")
}
return ErrTooManyAttempts
}
return nil
}
func (s *Service) GenerateOTP(kind Kind, target string, form Form, opts *GenerateOptions) (string, error) {
if !opts.SkipRateLimits {
if err := s.RateLimiter.Allow(kind.RateLimitTriggerCooldown(target)); err != nil {
return "", err
}
if err := s.RateLimiter.Allow(kind.RateLimitTriggerPerIP(string(s.RemoteIP))); err != nil {
return "", err
}
if opts.UserID != "" {
if err := s.RateLimiter.Allow(kind.RateLimitTriggerPerUser(opts.UserID)); err != nil {
return "", err
}
}
}
code := &Code{
Target: target,
Purpose: kind.Purpose(),
Form: form,
Code: form.GenerateCode(s.TestModeConfig, s.TestModeFeatureConfig, target, opts.UserID),
ExpireAt: s.Clock.NowUTC().Add(kind.ValidPeriod()),
UserID: opts.UserID,
WorkflowID: opts.WorkflowID,
AuthenticationFlowWebsocketChannelName: opts.AuthenticationFlowWebsocketChannelName,
AuthenticationFlowType: opts.AuthenticationFlowType,
AuthenticationFlowName: opts.AuthenticationFlowName,
AuthenticationFlowJSONPointer: opts.AuthenticationFlowJSONPointer,
WebSessionID: opts.WebSessionID,
}
err := s.CodeStore.Create(kind.Purpose(), code)
if err != nil {
return "", err
}
if form.AllowLookupByCode() {
err := s.LookupStore.Create(code.Purpose, code.Code, code.Target, code.ExpireAt)
if err != nil {
return "", err
}
}
if err := s.AttemptTracker.ResetFailedAttempts(kind.Purpose(), target); err != nil {
// non-critical error; log and continue
s.Logger.WithError(err).Warn("failed to reset failed attempts counter")
}
return code.Code, nil
}
func (s *Service) VerifyOTP(kind Kind, target string, otp string, opts *VerifyOptions) error {
if err := s.checkFailedAttemptsRevocation(kind, target); err != nil {
return err
}
var reservations []*ratelimit.Reservation
isCodeValid := false
defer func() {
if isCodeValid {
for _, r := range reservations {
s.RateLimiter.Cancel(r)
}
}
}()
r1 := s.RateLimiter.Reserve(kind.RateLimitValidatePerIP(string(s.RemoteIP)))
if err := r1.Error(); err != nil {
return err
}
reservations = append(reservations, r1)
if opts.UserID != "" {
r2 := s.RateLimiter.Reserve(kind.RateLimitValidatePerUserPerIP(opts.UserID, string(s.RemoteIP)))
if err := r2.Error(); err != nil {
return err
}
reservations = append(reservations, r2)
}
code, err := s.getCode(kind.Purpose(), target)
if errors.Is(err, ErrCodeNotFound) {
return ErrInvalidCode
} else if err != nil {
return err
}
if code.Purpose != kind.Purpose() {
return ErrInvalidCode
}
if code.Consumed {
return ErrConsumedCode
}
codeToVerify := otp
if opts.UseSubmittedCode {
codeToVerify = code.UserInputtedCode
}
if !code.Form.VerifyCode(codeToVerify, code.Code) {
ferr := s.handleFailedAttemptsRevocation(kind, target)
if errors.Is(ferr, ErrTooManyAttempts) {
return ferr
} else if ferr != nil {
// log the error, and return original error
s.Logger.WithError(ferr).Warn("failed to handle failed attempts")
}
return ErrInvalidCode
}
// Set flag to return reserved rate limit tokens
isCodeValid = true
if !opts.SkipConsume {
if err := s.consumeCode(kind.Purpose(), code); err != nil {
return err
}
}
return nil
}
func (s *Service) ConsumeCode(purpose Purpose, target string) error {
code, err := s.getCode(purpose, target)
if errors.Is(err, ErrCodeNotFound) {
return nil
} else if err != nil {
return err
}
if code.Purpose != purpose {
return nil
}
if code.Consumed {
return nil
}
return s.consumeCode(purpose, code)
}
func (s *Service) SetSubmittedCode(kind Kind, target string, code string) (*State, error) {
codeModel, err := s.getCode(kind.Purpose(), target)
if err != nil {
return nil, err
}
codeModel.UserInputtedCode = code
if err := s.CodeStore.Update(kind.Purpose(), codeModel); err != nil {
return nil, err
}
return s.InspectState(kind, target)
}
func (s *Service) LookupCode(purpose Purpose, code string) (target string, err error) {
return s.LookupStore.Get(purpose, code)
}
func (s *Service) InspectCode(purpose Purpose, target string) (*Code, error) {
return s.getCode(purpose, target)
}
func (s *Service) InspectState(kind Kind, target string) (*State, error) {
ferr := s.checkFailedAttemptsRevocation(kind, target)
tooManyAttempts := false
if errors.Is(ferr, ErrTooManyAttempts) {
tooManyAttempts = true
} else if ferr != nil {
return nil, ferr
}
// Inspect rate limit state by reserving no tokens.
reservation := s.RateLimiter.ReserveN(kind.RateLimitTriggerCooldown(target), 0)
now := s.Clock.NowUTC()
canResendAt := reservation.GetTimeToAct()
s.RateLimiter.Cancel(reservation)
state := &State{
ExpireAt: now,
CanResendAt: canResendAt,
SubmittedCode: "",
TooManyAttempts: tooManyAttempts,
}
code, err := s.getCode(kind.Purpose(), target)
if errors.Is(err, ErrCodeNotFound) {
code = nil
} else if err != nil {
return nil, err
}
if code != nil && code.Purpose != kind.Purpose() {
return nil, ErrCodeNotFound
}
if code != nil && code.Consumed {
// Treat consumed code as not found.
code = nil
}
if code != nil {
state.ExpireAt = code.ExpireAt
state.SubmittedCode = code.UserInputtedCode
state.UserID = code.UserID
state.WorkflowID = code.WorkflowID
state.AuthenticationFlowWebsocketChannelName = code.AuthenticationFlowWebsocketChannelName
state.AuthenticationFlowJSONPointer = code.AuthenticationFlowJSONPointer
state.AuthenticationFlowName = code.AuthenticationFlowName
state.AuthenticationFlowType = code.AuthenticationFlowType
state.WebSessionID = code.WebSessionID
}
return state, nil
}