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
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
package proxy
import (
"errors"
"fmt"
"net"
"net/http"
"net/url"
"sync"
"sync/atomic"
"time"
"github.com/armanlife/firefox-vpn-client/core/internal/guardian"
"github.com/armanlife/firefox-vpn-client/core/internal/logx"
)
const maxOpenTunnelRebuildRetries = 3
type managedSession struct {
session proxySession
rawToken string
expiresAt time.Time
refs int
accepting bool
// afterRefusal: the pass was fetched because Mozilla refused the one
// before (refusedAgain); a renewed pass clears it.
afterRefusal bool
// server is the address of the proxy server the session is on.
server string
}
type ControllerConfig struct {
Guardian string
ProxyURL *url.URL
Timeout time.Duration
Auth *runtimeAuth
Pass *guardian.ProxyPassInfo
UseH3 bool
Sessions int
StatusFile string
Accounts *AccountPool // optional; multi-account mode with threshold failover
// ChosenLocation is set when the user chose the location (a country,
// not the recommended location or the fastest one): a refusal that a
// new pass does not cure is then reported as LocationRefusedError.
ChosenLocation bool
// Server is the server ProxyURL points to, with its location data.
Server Candidate
// Location lists the servers of the selected location
// (LocationCandidates), and Failover moves the upstream among them
// when Server keeps failing. Both are unset for a server set by hand.
Location []Candidate
Failover *ServerFailover
}
type Controller struct {
// OnSessionRebuilt, when set, runs after a failed upstream session was
// replaced by a new one.
OnSessionRebuilt func()
// OnServerSwitched, when set, runs (renewMu held) after the failover
// moved the upstream to another server of the location.
OnServerSwitched func(Candidate)
guardian string
timeout time.Duration
// chosenLocation is ControllerConfig.ChosenLocation.
chosenLocation bool
// location and failover are ControllerConfig.Location and Failover.
location []Candidate
failover *ServerFailover
sessionFactory func(token string) (proxySession, error)
refreshSession func() error
accounts *AccountPool
// trafficSinceCheck counts tunnel bytes since the last quota check;
// crossing usageProbeBytes requests an early check on quotaCheckNow.
trafficSinceCheck atomic.Int64
// trafficSinceReading counts tunnel bytes since the quota in usage was
// read: setUsage resets it together with usage, under mu, and
// nearSwitch adds it to that reading.
trafficSinceReading atomic.Int64
quotaCheckNow chan struct{}
renewMu sync.Mutex
mu sync.Mutex
auth *runtimeAuth
current *managedSession
statusFile string
closed bool
done chan struct{}
// server is the proxy server new sessions are opened to (guarded by
// mu; sessionFactory dials proxyURL); the failover changes both.
server Candidate
proxyURL *url.URL
// Guarded by mu: the latest quota state and the outcome of the last
// renewal, reported in the status file without any secret.
usage *guardian.ProxyUsage
lastError string
lastRenewalErr error
nextAttemptAt time.Time
lastRenewalAt time.Time
// The spacing of tunnel-triggered rebuilds: redials with the current
// pass, and new passes.
redialBackoff rebuildBackoff
passBackoff rebuildBackoff
closeOnce sync.Once
closeErr error
}
func NewController(cfg ControllerConfig) (*Controller, error) {
var baseFactory func(target *url.URL, token string) (proxySession, error)
if cfg.UseH3 {
baseFactory = func(target *url.URL, token string) (proxySession, error) {
return newH3ProxySession(target, token, cfg.Timeout)
}
} else {
baseFactory = func(target *url.URL, token string) (proxySession, error) {
return newH2ProxySession(target, token, cfg.Timeout)
}
}
sessions := cfg.Sessions
if sessions < 1 {
sessions = defaultUpstreamConnections
}
// A pool stays on the server it was made for: after a failover, the
// slots it replenishes belong to a session being drained.
factory := func(target *url.URL, token string) (proxySession, error) {
if sessions == 1 {
return baseFactory(target, token)
}
var tokenMu sync.RWMutex
createToken := token
return newProxySessionPool(sessions, func() (proxySession, error) {
tokenMu.RLock()
currentToken := createToken
tokenMu.RUnlock()
return baseFactory(target, currentToken)
}, func(newToken string) {
tokenMu.Lock()
createToken = newToken
tokenMu.Unlock()
})
}
session, err := factory(cfg.ProxyURL, cfg.Pass.RawToken)
if err != nil {
return nil, err
}
server := cfg.Server
if server.Addr == "" {
server.Addr = cfg.ProxyURL.Host
}
controller := &Controller{
guardian: cfg.Guardian,
proxyURL: cfg.ProxyURL,
server: server,
timeout: cfg.Timeout,
auth: cfg.Auth,
statusFile: cfg.StatusFile,
accounts: cfg.Accounts,
chosenLocation: cfg.ChosenLocation,
location: cfg.Location,
failover: cfg.Failover,
quotaCheckNow: make(chan struct{}, 1),
done: make(chan struct{}),
usage: cfg.Pass.Usage,
current: &managedSession{
session: session,
rawToken: cfg.Pass.RawToken,
expiresAt: cfg.Pass.ExpiresAt(),
accepting: true,
server: server.Addr,
},
}
controller.sessionFactory = func(token string) (proxySession, error) {
controller.mu.Lock()
target := controller.proxyURL
controller.mu.Unlock()
return factory(target, token)
}
controller.writeStatus("startup")
return controller, nil
}
func (c *Controller) OpenTunnel(authority string) (net.Conn, error) {
return c.openTunnel(authority, "")
}
func (c *Controller) OpenTunnelForClient(authority, clientKey string) (net.Conn, error) {
return c.openTunnel(authority, clientKey)
}
func (c *Controller) openTunnel(authority, clientKey string) (net.Conn, error) {
// cause is the session's failure that rebuilds answer; lastErr may also
// be a rebuild's own error.
var lastErr, cause error
for attempt := 0; attempt <= maxOpenTunnelRebuildRetries; attempt++ {
var failedSession *managedSession
ms, session, release, err := c.acquireSession()
if err != nil {
if c.isClosed() {
return nil, err
}
if !errors.Is(err, ErrNoUsableSession) || lastErr == nil {
lastErr = err
}
if cause == nil {
cause = err
}
} else if !isSessionAlive(session) {
// The keepalive already saw this session die; rebuild it instead of
// spending a request to rediscover that.
lastErr = errProxySessionUnhealthy
cause = lastErr
failedSession = ms
c.markSessionUnusable(ms)
release()
} else {
var conn net.Conn
if affinitySession, ok := session.(clientAffinityTunnelOpener); ok {
conn, err = affinitySession.OpenTunnelForClient(authority, clientKey)
} else {
conn, err = session.OpenTunnel(authority)
}
if err == nil {
c.redialBackoff.opened()
c.passBackoff.opened()
c.failover.Worked(ms.server)
return &managedTunnelConn{
Conn: conn,
release: release,
traffic: c.noteTraffic,
}, nil
}
if !shouldRebuildProxySession(err) {
release()
return nil, err
}
if c.refusedAgain(ms, err) {
release()
if c.chosenLocation {
err = &LocationRefusedError{Err: err}
}
return nil, err
}
lastErr = err
cause = err
failedSession = ms
c.markSessionUnusable(ms)
release()
}
if attempt == maxOpenTunnelRebuildRetries || c.isClosed() {
break
}
logx.Warn("upstream tunnel open failed; rebuilding proxy session attempt=%d max=%d err=%s", attempt+1, maxOpenTunnelRebuildRetries, logx.Err(lastErr))
if err := c.rebuildSession(failedSession, cause); err != nil {
lastErr = fmt.Errorf("rebuilding upstream proxy session: %w", err)
}
}
return nil, lastErr
}
// refusedAgain reports a CONNECT 403 or 407 on a session whose pass was
// fetched because Mozilla refused the one before: a new pass would be
// refused too (a location the account may not use, or a refused
// destination), so the client gets the refusal and the session goes on
// serving the others.
func (c *Controller) refusedAgain(ms *managedSession, err error) bool {
var connectErr *proxyConnectHTTPError
if !errors.As(err, &connectErr) ||
(connectErr.statusCode != http.StatusForbidden && connectErr.statusCode != http.StatusProxyAuthRequired) {
return false
}
c.mu.Lock()
defer c.mu.Unlock()
return ms.afterRefusal
}
func (c *Controller) isClosed() bool {
c.mu.Lock()
defer c.mu.Unlock()
return c.closed
}
// acquireSession takes a reference to the current session. The session is
// read under the lock and returned with it: Reconnect and Close clear
// ms.session while references are held, and the caller then works on the
// value it got (a closed session fails its calls, it does not vanish).
func (c *Controller) acquireSession() (*managedSession, proxySession, func(), error) {
c.mu.Lock()
defer c.mu.Unlock()
if c.closed {
return nil, nil, nil, ErrNoUsableSession
}
if c.current == nil || !c.current.accepting || c.current.session == nil {
return nil, nil, nil, ErrNoUsableSession
}
if time.Now().After(c.current.expiresAt) {
c.current.accepting = false
c.maybeCloseLocked(c.current)
return nil, nil, nil, ErrNoUsableSession
}
ms := c.current
ms.refs++
return ms, ms.session, func() { c.releaseSession(ms) }, nil
}
func (c *Controller) releaseSession(ms *managedSession) {
c.mu.Lock()
defer c.mu.Unlock()
ms.refs--
c.maybeCloseLocked(ms)
}
func (c *Controller) markSessionUnusable(ms *managedSession) {
c.mu.Lock()
defer c.mu.Unlock()
if ms == nil || c.current != ms {
return
}
ms.accepting = false
c.maybeCloseLocked(ms)
}
func (c *Controller) maybeCloseLocked(ms *managedSession) {
if ms == nil || ms.accepting || ms.refs > 0 || ms.session == nil {
return
}
_ = ms.session.Close()
ms.session = nil
}
func (c *Controller) swapSession(newSession proxySession, rawToken string, expiresAt time.Time) bool {
c.mu.Lock()
if c.closed {
c.mu.Unlock()
_ = newSession.Close()
return false
}
old := c.current
c.current = &managedSession{
session: newSession,
rawToken: rawToken,
expiresAt: expiresAt,
accepting: true,
server: c.server.Addr,
}
if old != nil {
old.accepting = false
c.maybeCloseLocked(old)
}
c.mu.Unlock()
c.writeStatus("session_swapped")
return true
}
func (c *Controller) disableExpiredSession(now time.Time) {
c.mu.Lock()
changed := false
if c.current != nil && c.current.accepting && !now.Before(c.current.expiresAt) {
c.current.accepting = false
c.maybeCloseLocked(c.current)
changed = true
}
c.mu.Unlock()
if changed {
c.writeStatus("expired")
}
}
// RetryNow forgets the waits that failures left behind (the spacing of
// rebuilds, and a pass renewal that failed for want of a network or an
// answer), so the next tunnel tries at once: the network came back, or the
// user is looking.
func (c *Controller) RetryNow() {
c.renewMu.Lock()
c.redialBackoff.reset()
c.passBackoff.reset()
c.renewMu.Unlock()
c.mu.Lock()
if code := FailureCode(c.lastRenewalErr); code == FailureNoNetwork || code == FailureUnreachable {
c.nextAttemptAt = time.Time{}
}
c.mu.Unlock()
}
// Reconnect opens a new upstream session with the current pass and makes it
// current, closing the old one: after a network change the old session's
// connection belongs to a network that is gone, and finding that out
// request by request takes time. No new pass is needed.
func (c *Controller) Reconnect() error {
c.mu.Lock()
old := c.current
if c.closed || old == nil || old.rawToken == "" || !time.Now().Before(old.expiresAt) {
c.mu.Unlock()
return ErrNoUsableSession
}
token, expiresAt := old.rawToken, old.expiresAt
c.mu.Unlock()
session, err := c.sessionFactory(token)
if err != nil {
return err
}
// Swap only if nothing replaced or renewed the session meanwhile (a
// renewal, a rebuild, or a second Reconnect): the new session would
// otherwise carry an older pass than the one it replaces.
c.mu.Lock()
if c.closed || c.current != old || old.rawToken != token {
c.mu.Unlock()
_ = session.Close()
if c.isClosed() {
return ErrNoUsableSession
}
return nil
}
c.mu.Unlock()
if !c.swapSession(session, token, expiresAt) {
return ErrNoUsableSession
}
c.mu.Lock()
if old.session != nil {
_ = old.session.Close()
old.session = nil
}
c.mu.Unlock()
return nil
}
// currentServer returns the server new sessions are opened to.
func (c *Controller) currentServer() Candidate {
c.mu.Lock()
defer c.mu.Unlock()
return c.server
}
// failOver counts err, a failure to open or keep a session on the server
// from, against that server, and moves the controller to another server of
// the location when the failover says so (ServerFailover.Failed). It
// reports whether it moved. renewMu is held.
func (c *Controller) failOver(from Candidate, err error) bool {
if c.failover == nil || err == nil || c.isClosed() {
return false
}
next, ok := c.failover.Failed(c.location, from, err)
if !ok {
return false
}
target, parseErr := NormalizeURL(next.Addr)
if parseErr != nil {
logx.Warn("cannot switch to the next upstream server proxy=%s err=%s", next.Addr, logx.Err(parseErr))
return false
}
c.mu.Lock()
c.server, c.proxyURL = next, target
c.mu.Unlock()
// The new server starts with the quick redial steps.
c.redialBackoff.reset()
if c.OnServerSwitched != nil {
c.OnServerSwitched(next)
}
return true
}
// CurrentToken returns the proxy pass of the current session.
func (c *Controller) CurrentToken() string {
c.mu.Lock()
defer c.mu.Unlock()
if c.current == nil {
return ""
}
return c.current.rawToken
}
func (c *Controller) currentExpiry() time.Time {
c.mu.Lock()
defer c.mu.Unlock()
if c.current == nil {
return time.Time{}
}
return c.current.expiresAt
}
func (c *Controller) hasUsableSessionOtherThan(failedSession *managedSession, now time.Time) bool {
c.mu.Lock()
defer c.mu.Unlock()
if c.closed || c.current == nil || !c.current.accepting {
return false
}
if failedSession != nil && c.current == failedSession {
return false
}
return now.Before(c.current.expiresAt)
}
func (c *Controller) updateCurrentSessionToken(token string, expiresAt time.Time) error {
c.mu.Lock()
defer c.mu.Unlock()
if c.closed || c.current == nil || !c.current.accepting || !time.Now().Before(c.current.expiresAt) {
return ErrNoUsableSession
}
updater, ok := c.current.session.(proxySessionTokenUpdater)
if !ok {
return fmt.Errorf("upstream session does not support token update")
}
if err := updater.UpdateToken(token); err != nil {
return err
}
c.current.rawToken = token
c.current.expiresAt = expiresAt
c.current.afterRefusal = false
return nil
}
func (c *Controller) Close() error {
c.closeOnce.Do(func() {
if c.done != nil {
close(c.done)
}
c.mu.Lock()
defer c.mu.Unlock()
c.closed = true
if c.current != nil {
c.current.accepting = false
if c.current.session != nil {
c.closeErr = c.current.session.Close()
c.current.session = nil
}
}
})
c.writeStatus("closed")
return c.closeErr
}
// noteTraffic counts tunnel bytes toward the usage since the last quota
// reading and, near the switch point, requests an early quota check after
// every usageProbeBytes, so a heavy transfer cannot run far past the
// account switch threshold between pass renewals.
func (c *Controller) noteTraffic(n int) {
if n <= 0 {
return
}
c.trafficSinceReading.Add(int64(n))
if c.trafficSinceCheck.Add(int64(n)) < usageProbeBytes {
return
}
c.trafficSinceCheck.Store(0)
if !c.nearSwitch() {
return
}
select {
case c.quotaCheckNow <- struct{}{}:
default:
}
}
// nearSwitch reports whether the active account's usage, as last read plus
// the tunnel traffic since then, is within quotaProbeMargin of its switch
// point: the switch threshold with an account pool (the service always has
// one, also when no other account could take over), the end of the quota
// without one. Unknown and unlimited quotas are never near.
func (c *Controller) nearSwitch() bool {
c.mu.Lock()
usage, since := c.usage, c.trafficSinceReading.Load()
c.mu.Unlock()
if usage == nil || usage.Unlimited || usage.Limit <= 0 {
return false
}
switchAt := usage.Limit
if c.accounts != nil {
switchAt = int64(float64(usage.Limit) * c.accounts.mgr.Policy().ThresholdPercent / 100)
}
used := usage.Limit - usage.Remaining + since
return switchAt-used <= quotaProbeMargin
}
type managedTunnelConn struct {
net.Conn
release func()
traffic func(int)
once sync.Once
}
func (c *managedTunnelConn) Read(p []byte) (int, error) {
n, err := c.Conn.Read(p)
if c.traffic != nil {
c.traffic(n)
}
return n, err
}
func (c *managedTunnelConn) Write(p []byte) (int, error) {
n, err := c.Conn.Write(p)
if c.traffic != nil {
c.traffic(n)
}
return n, err
}
func (c *managedTunnelConn) Close() error {
var err error
c.once.Do(func() {
err = c.Conn.Close()
if c.release != nil {
c.release()
}
})
return err
}
func (c *managedTunnelConn) CloseRead() error {
if closeReader, ok := c.Conn.(interface{ CloseRead() error }); ok {
return closeReader.CloseRead()
}
return nil
}
func (c *managedTunnelConn) CloseWrite() error {
if closeWriter, ok := c.Conn.(interface{ CloseWrite() error }); ok {
return closeWriter.CloseWrite()
}
return nil
}