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
451
package proxy
import (
"context"
"encoding/base64"
"errors"
"fmt"
"net/http"
"path/filepath"
"strconv"
"strings"
"sync/atomic"
"testing"
"time"
"github.com/armanlife/firefox-vpn-client/core/internal/accounts"
"github.com/armanlife/firefox-vpn-client/core/internal/fxa"
"github.com/armanlife/firefox-vpn-client/core/internal/guardian"
)
// All credentials in this file are local fixtures; the control plane
// transport rejects every request it does not recognise.
const testGiB = int64(1) << 30
var quotaReset = time.Now().Add(72 * time.Hour).UTC().Truncate(time.Second)
func accountJWT(sub string) string {
now := time.Now()
claims := fmt.Sprintf(`{"sub":%q,"aud":"https://vpn.mozilla.org","iss":"https://vpn.mozilla.org","iat":%d,"nbf":%d,"exp":%d}`, sub, now.Unix(), now.Unix(), now.Add(10*time.Minute).Unix())
return "e30." + base64.RawURLEncoding.EncodeToString([]byte(claims)) + ".local-only"
}
func quotaHeader(usedGiB int64) http.Header {
h := make(http.Header)
h.Set("X-Quota-Limit", strconv.FormatInt(50*testGiB, 10))
h.Set("X-Quota-Remaining", strconv.FormatInt((50-usedGiB)*testGiB, 10))
h.Set("X-Quota-Reset", quotaReset.Format(time.RFC3339))
return h
}
// newTestAccountPool stores one account per name with a valid access token
// "access-<name>" and refresh token "refresh-<name>".
func newTestAccountPool(t *testing.T, names ...string) (*AccountPool, map[string]accounts.Account) {
t.Helper()
dir := t.TempDir()
store, err := accounts.OpenStore(dir)
if err != nil {
t.Fatal(err)
}
byName := make(map[string]accounts.Account)
var order []string
for i, name := range names {
acc, _, err := store.Add(name+"@example.com", &fxa.SavedTokens{
AccessToken: "access-" + name, RefreshToken: "refresh-" + name, ObtainedAt: time.Now(), ExpiresIn: 3600,
}, time.Now().Add(time.Duration(i)*time.Second))
if err != nil {
t.Fatal(err)
}
byName[name] = acc
order = append(order, acc.ID)
}
mgr, err := accounts.NewManager(store, order, accounts.Policy{ThresholdPercent: 90}, filepath.Join(dir, "state.json"))
if err != nil {
t.Fatal(err)
}
return NewAccountPool(store, mgr), byName
}
func accountFromBearer(r *http.Request) string {
return strings.TrimPrefix(r.Header.Get("Authorization"), "Bearer access-")
}
func accountStatus(t *testing.T, pool *AccountPool, id string) accounts.Account {
t.Helper()
for _, acc := range pool.mgr.Accounts() {
if acc.ID == id {
return acc
}
}
t.Fatalf("account %s not found", id)
return accounts.Account{}
}
func TestAccountPoolSwitchesAtUsageThreshold(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b")
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
switch accountFromBearer(r) {
case "a":
return coreResponse(r, http.StatusOK, `{"token":"`+accountJWT("a")+`"}`, quotaHeader(46)), nil
case "b":
return coreResponse(r, http.StatusOK, `{"token":"`+accountJWT("b")+`"}`, quotaHeader(3)), nil
}
return nil, fmt.Errorf("unexpected request %s", r.URL)
})
auth, pass, err := pool.AcquirePass(context.Background(), "https://guardian.invalid")
if err != nil {
t.Fatal(err)
}
if auth.accountID != accs["b"].ID || !strings.Contains(pass.Claims.Sub, "b") {
t.Fatalf("expected account b to supply the pass, got account %s sub %s", auth.accountID, pass.Claims.Sub)
}
if active, _ := pool.mgr.Active(); active.ID != accs["b"].ID {
t.Fatalf("expected b to be active, got %+v", active)
}
if a := accountStatus(t, pool, accs["a"].ID); a.Status != accounts.StatusReserved || !a.RetryAt.Equal(quotaReset) {
t.Fatalf("expected a to be reserved until the quota reset, got %+v", a)
}
}
func TestAccountPoolSkipsExhaustedAndSignedOutAccounts(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b", "c")
// b's access token has expired and its refresh token was revoked.
if err := pool.store.SaveCredentials(accs["b"].ID, &fxa.SavedTokens{AccessToken: "access-b", RefreshToken: "refresh-b", ObtainedAt: time.Now().Add(-48 * time.Hour), ExpiresIn: 3600}); err != nil {
t.Fatal(err)
}
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
if r.URL.Host == "api.accounts.firefox.com" {
return coreResponse(r, http.StatusBadRequest, `{"code":400,"errno":110,"message":"Invalid token"}`, nil), nil
}
switch accountFromBearer(r) {
case "a":
h := quotaHeader(50)
h.Set("Retry-After", "3600")
return coreResponse(r, http.StatusTooManyRequests, "quota", h), nil
case "c":
return coreResponse(r, http.StatusOK, `{"token":"`+accountJWT("c")+`"}`, quotaHeader(1)), nil
}
return nil, fmt.Errorf("unexpected request %s", r.URL)
})
auth, _, err := pool.AcquirePass(context.Background(), "https://guardian.invalid")
if err != nil || auth.accountID != accs["c"].ID {
t.Fatalf("expected account c, got %+v %v", auth, err)
}
if a := accountStatus(t, pool, accs["a"].ID); a.Status != accounts.StatusReserved {
t.Fatalf("expected a reserved, got %+v", a)
}
if b := accountStatus(t, pool, accs["b"].ID); b.Status != accounts.StatusReauthRequired {
t.Fatalf("expected b to need a sign-in, got %+v", b)
}
}
// The active account past the threshold is set aside for b, which turns
// out unable to take over (its access token expired, its refresh token was
// revoked, and no password is stored): a goes on with the pass it supplied
// instead of the proxy stopping until a's quota reset.
func TestAccountPoolGoesOnWithTheAccountSetAsideWhenNoOtherTakesOver(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b")
if err := pool.mgr.Activate(accs["a"].ID); err != nil {
t.Fatal(err)
}
if err := pool.store.SaveCredentials(accs["b"].ID, &fxa.SavedTokens{AccessToken: "access-b", RefreshToken: "refresh-b", ObtainedAt: time.Now().Add(-48 * time.Hour), ExpiresIn: 3600}); err != nil {
t.Fatal(err)
}
passA := accountJWT("a")
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
if r.URL.Host == "api.accounts.firefox.com" {
return coreResponse(r, http.StatusBadRequest, `{"code":400,"errno":110,"message":"Invalid token"}`, nil), nil
}
if accountFromBearer(r) == "a" {
// 46 of 50 GiB: past the 90% threshold.
return coreResponse(r, http.StatusOK, `{"token":"`+passA+`"}`, quotaHeader(46)), nil
}
return nil, fmt.Errorf("unexpected request %s", r.URL)
})
auth, pass, err := pool.AcquirePass(context.Background(), "https://guardian.invalid")
if err != nil {
t.Fatalf("expected a's pass, got %v (the renewal would wait %s)", err, RenewalRetryDelay(err, time.Now()))
}
if auth.accountID != accs["a"].ID || pass.RawToken != passA {
t.Fatalf("expected account a's pass, got account %s", auth.accountID)
}
if active, _ := pool.mgr.Active(); active.ID != accs["a"].ID {
t.Fatalf("expected a to stay active, got %+v", active)
}
if a := accountStatus(t, pool, accs["a"].ID); a.Status != accounts.StatusReady || a.ReasonCode != "" || !a.RetryAt.IsZero() {
t.Fatalf("expected a to be usable, got %+v", a)
}
if b := accountStatus(t, pool, accs["b"].ID); b.Status != accounts.StatusReauthRequired {
t.Fatalf("expected b to need a sign-in, got %+v", b)
}
// With nothing to switch to, a goes on to the end of its quota.
if auth, _, err := pool.AcquirePass(context.Background(), "https://guardian.invalid"); err != nil || auth.accountID != accs["a"].ID {
t.Fatalf("expected the next renewal to stay on a, got %+v %v", auth, err)
}
}
// b's pass request fails in a way every account would meet (here the
// renewal runs out of time): a, set aside for b, goes on with its pass, and
// b, unchanged, is tried again at a later renewal.
func TestAccountPoolGoesOnWithTheAccountSetAsideAfterASharedFailure(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b")
if err := pool.mgr.Activate(accs["a"].ID); err != nil {
t.Fatal(err)
}
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
switch accountFromBearer(r) {
case "a":
return coreResponse(r, http.StatusOK, `{"token":"`+accountJWT("a")+`"}`, quotaHeader(46)), nil
case "b":
cancel()
return nil, context.Canceled
}
return nil, fmt.Errorf("unexpected request %s", r.URL)
})
auth, _, err := pool.AcquirePass(ctx, "https://guardian.invalid")
if err != nil || auth.accountID != accs["a"].ID {
t.Fatalf("expected a's pass, got %+v %v", auth, err)
}
if active, _ := pool.mgr.Active(); active.ID != accs["a"].ID || active.Status != accounts.StatusReady {
t.Fatalf("expected a to be active and ready, got %+v", active)
}
if b := accountStatus(t, pool, accs["b"].ID); b.Status != accounts.StatusReady {
t.Fatalf("a shared failure must not change b's status, got %+v", b)
}
}
func TestAccountPoolDoesNotSwitchOnSharedFailure(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b")
var requestsForB atomic.Int32
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
if accountFromBearer(r) == "b" {
requestsForB.Add(1)
}
return coreResponse(r, http.StatusUnavailableForLegalReasons, "region", nil), nil
})
_, _, err := pool.AcquirePass(context.Background(), "https://guardian.invalid")
if !errors.Is(err, guardian.ErrRegionUnavailable) || requestsForB.Load() != 0 {
t.Fatalf("expected a region error without trying b, got %v (b requests %d)", err, requestsForB.Load())
}
if a := accountStatus(t, pool, accs["a"].ID); a.Status != accounts.StatusReady {
t.Fatalf("a shared failure must not change the account status, got %+v", a)
}
}
func TestAccountPoolReportsWhenEveryAccountIsReserved(t *testing.T) {
pool, _ := newTestAccountPool(t, "a", "b")
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
// Spent: past the threshold alone, the last account would go on.
return coreResponse(r, http.StatusOK, `{"token":"`+accountJWT(accountFromBearer(r))+`"}`, quotaHeader(50)), nil
})
_, _, err := pool.AcquirePass(context.Background(), "https://guardian.invalid")
var noAccount *accounts.NoUsableAccountError
if !errors.As(err, &noAccount) || !noAccount.RetryAt.Equal(quotaReset) {
t.Fatalf("expected no usable account until the reset, got %v", err)
}
if renewalFailureCode(err) != "no_usable_account" {
t.Fatalf("unexpected failure code %q", renewalFailureCode(err))
}
// The reset is three days away, so the wait is capped.
if delay := RenewalRetryDelay(err, time.Now()); delay != maxQuotaResetWait {
t.Fatalf("expected the wait to be capped at %s, got %s", maxQuotaResetWait, delay)
}
}
func TestControllerQuotaCheckSwitchesAccountWithoutNewSession(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b")
if err := pool.mgr.Activate(accs["a"].ID); err != nil {
t.Fatal(err)
}
authA, err := pool.AuthFor(accs["a"])
if err != nil {
t.Fatal(err)
}
passB := accountJWT("b")
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
switch {
case r.Method == http.MethodHead && accountFromBearer(r) == "a":
return coreResponse(r, http.StatusOK, "", quotaHeader(46)), nil
case r.Method == http.MethodGet && accountFromBearer(r) == "a":
return coreResponse(r, http.StatusOK, `{"token":"`+accountJWT("a")+`"}`, quotaHeader(46)), nil
case r.Method == http.MethodGet && accountFromBearer(r) == "b":
return coreResponse(r, http.StatusOK, `{"token":"`+passB+`"}`, quotaHeader(2)), nil
}
return nil, fmt.Errorf("unexpected request %s %s", r.Method, r.URL)
})
session := &fakeProxySession{token: "pass-a"}
controller := &Controller{
guardian: "https://guardian.invalid",
accounts: pool,
auth: authA,
quotaCheckNow: make(chan struct{}, 1),
done: make(chan struct{}),
current: &managedSession{session: session, rawToken: "pass-a", expiresAt: time.Now().Add(10 * time.Minute), accepting: true},
sessionFactory: func(string) (proxySession, error) {
return nil, errors.New("an account switch must not rebuild the upstream session")
},
}
controller.checkQuota()
if got := session.currentToken(); got != passB {
t.Fatal("expected the existing upstream session to carry account b's pass")
}
if active, _ := pool.mgr.Active(); active.ID != accs["b"].ID {
t.Fatalf("expected b to be active, got %+v", active)
}
if status := controller.CurrentStatus("quota_checked"); status.ActiveAccount != "b@example.com" {
t.Fatalf("expected the status to name account b, got %q", status.ActiveAccount)
}
}
// A quota check sets a aside at the threshold, but b's pass request fails
// in a way every account would meet (Guardian answers HTTP 503): a goes on
// with its current pass instead of staying reserved until its quota reset,
// and the next renewal still gets a pass from a while b keeps failing.
func TestControllerQuotaCheckKeepsTheAccountSetAsideWhenTheNextFails(t *testing.T) {
pool, accs := newTestAccountPool(t, "a", "b")
if err := pool.mgr.Activate(accs["a"].ID); err != nil {
t.Fatal(err)
}
authA, err := pool.AuthFor(accs["a"])
if err != nil {
t.Fatal(err)
}
passA := accountJWT("a")
var passRequestsForA atomic.Int32
setCoreControlPlane(t, func(r *http.Request) (*http.Response, error) {
switch {
case r.Method == http.MethodHead && accountFromBearer(r) == "a":
return coreResponse(r, http.StatusOK, "", quotaHeader(46)), nil
case r.Method == http.MethodGet && accountFromBearer(r) == "a":
passRequestsForA.Add(1)
return coreResponse(r, http.StatusOK, `{"token":"`+passA+`"}`, quotaHeader(46)), nil
case r.Method == http.MethodGet && accountFromBearer(r) == "b":
// A Retry-After beyond the retry budget ends the retries at once.
h := make(http.Header)
h.Set("Retry-After", "3600")
return coreResponse(r, http.StatusServiceUnavailable, "unavailable", h), nil
}
return nil, fmt.Errorf("unexpected request %s %s", r.Method, r.URL)
})
session := &fakeProxySession{token: "pass-a"}
controller := &Controller{
guardian: "https://guardian.invalid",
accounts: pool,
auth: authA,
quotaCheckNow: make(chan struct{}, 1),
done: make(chan struct{}),
current: &managedSession{session: session, rawToken: "pass-a", expiresAt: time.Now().Add(10 * time.Minute), accepting: true},
sessionFactory: func(string) (proxySession, error) {
return nil, errors.New("a failed switch must not rebuild the upstream session")
},
}
controller.checkQuota()
if got := session.currentToken(); got != "pass-a" {
t.Fatalf("expected the upstream session to keep a's pass, got %q", got)
}
if active, _ := pool.mgr.Active(); active.ID != accs["a"].ID || active.Status != accounts.StatusReady || active.ReasonCode != "" || !active.RetryAt.IsZero() {
t.Fatalf("expected a to be active and usable again, got %+v", active)
}
if b := accountStatus(t, pool, accs["b"].ID); b.Status != accounts.StatusReady {
t.Fatalf("a shared failure must not change b's status, got %+v", b)
}
auth, pass, err := pool.AcquirePass(context.Background(), "https://guardian.invalid")
if err != nil || auth.accountID != accs["a"].ID || pass.RawToken != passA {
t.Fatalf("expected the next renewal to get a's pass, got %+v %v", auth, err)
}
if passRequestsForA.Load() != 1 {
t.Fatalf("expected one pass request for a, got %d", passRequestsForA.Load())
}
}
// Far from its end, traffic never reads the quota (the pass renewals carry
// it); within quotaProbeMargin it does, every usageProbeBytes.
func TestNoteTrafficRequestsEarlyQuotaCheck(t *testing.T) {
t.Parallel()
const gb = 1 << 30
controller := &Controller{quotaCheckNow: make(chan struct{}, 1)}
controller.setUsage(&guardian.ProxyUsage{Limit: 50 * gb, Remaining: 30 * gb})
controller.noteTraffic(usageProbeBytes)
select {
case <-controller.quotaCheckNow:
t.Fatal("no check expected far from the end of the quota")
default:
}
if controller.trafficSinceCheck.Load() != 0 {
t.Fatal("expected the traffic counter to reset")
}
controller.setUsage(&guardian.ProxyUsage{Limit: 50 * gb, Remaining: 4 * gb})
controller.noteTraffic(usageProbeBytes - 1)
select {
case <-controller.quotaCheckNow:
t.Fatal("no check expected below the probe size")
default:
}
controller.noteTraffic(1)
select {
case <-controller.quotaCheckNow:
default:
t.Fatal("expected an early quota check request")
}
if controller.trafficSinceCheck.Load() != 0 {
t.Fatal("expected the traffic counter to reset")
}
}
// The quota is read with each pass (about every 8 minutes), and a fast
// transfer moves many GiB in between: the traffic since the last reading
// counts toward the switch point, so the early checks start once the
// reading plus that traffic is within quotaProbeMargin of it, not before.
func TestNoteTrafficCountsTheTrafficSinceTheLastReading(t *testing.T) {
t.Parallel()
pool, _ := newTestAccountPool(t, "a")
pool.mgr.SetPolicy(accounts.Policy{ThresholdPercent: 95}) // switches at 47.5 GiB
controller := &Controller{accounts: pool, quotaCheckNow: make(chan struct{}, 1)}
reading := &guardian.ProxyUsage{Limit: 50 * testGiB, Remaining: 15 * testGiB}
controller.setUsage(reading)
// 35 GiB read plus 15 steps of 512 MiB is 42.5 GiB, 5 GiB from the
// switch point.
const firstCheck = 15
for step := 1; step <= 40; step++ { // 20 GiB in all
controller.noteTraffic(usageProbeBytes)
select {
case <-controller.quotaCheckNow:
if step < firstCheck {
t.Fatalf("early check after %d steps, before the margin", step)
}
default:
if step >= firstCheck {
t.Fatalf("no early check after %d steps", step)
}
}
}
// A new reading starts the count again: far from the switch point.
controller.setUsage(reading)
controller.noteTraffic(usageProbeBytes)
select {
case <-controller.quotaCheckNow:
t.Fatal("expected a new reading to reset the traffic since the last one")
default:
}
}