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
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
package service
import (
"encoding/json"
"errors"
"fmt"
"net"
"net/http"
"runtime"
"sort"
"strconv"
"strings"
"time"
"github.com/armanlife/firefox-vpn-client/core/internal/accounts"
"github.com/armanlife/firefox-vpn-client/core/internal/config"
"github.com/armanlife/firefox-vpn-client/core/internal/logx"
"github.com/armanlife/firefox-vpn-client/core/internal/netstate"
"github.com/armanlife/firefox-vpn-client/core/internal/proxy"
"github.com/armanlife/firefox-vpn-client/core/internal/serverlist"
"github.com/armanlife/firefox-vpn-client/core/internal/update"
"github.com/armanlife/firefox-vpn-client/core/internal/version"
)
type proxyView struct {
Listen string `json:"listen"`
Upstream string `json:"upstream"`
CountryCode string `json:"country_code"`
CountryName string `json:"country_name"`
CityName string `json:"city_name"`
SelectionSource string `json:"selection_source"`
Transport string `json:"transport"`
StartedAt time.Time `json:"started_at"`
// LoginRequired is set when SOCKS clients must authenticate.
LoginRequired bool `json:"login_required"`
// SleepingSince is set while the proxy holds no upstream session:
// from its start until it is first used, and after proxy.idle_sleep.
// Zero while connected to Mozilla.
SleepingSince time.Time `json:"sleeping_since,omitzero"`
// WakeError is why the last attempt to connect to Mozilla for a
// connection or a test failed (at WakeFailedAt); empty after a
// successful one.
WakeError string `json:"wake_error,omitempty"`
// WakeErrorCode is the proxy.Failure code of WakeError.
WakeErrorCode string `json:"wake_error_code,omitempty"`
WakeFailedAt time.Time `json:"wake_failed_at,omitzero"`
}
type exitView struct {
IPv4 string `json:"ipv4,omitempty"`
IPv6 string `json:"ipv6,omitempty"`
CountryCode string `json:"country_code"`
// CountryName is the name the server list gives the country code.
CountryName string `json:"country_name,omitempty"`
City string `json:"city,omitempty"`
Network string `json:"network,omitempty"`
ProbeHost string `json:"probe_host"`
LatencyMS int64 `json:"latency_ms"`
}
// exitMismatchView is a public IP in another country than the one the user
// chose.
type exitMismatchView struct {
// ChosenCountryCode is the chosen location's country code, and
// ChosenCountryName the server list's name for it.
ChosenCountryCode string `json:"chosen_country_code"`
ChosenCountryName string `json:"chosen_country_name,omitempty"`
// ExitCountryCode is the public IP's country code from the exit probe,
// and ExitCountryName the server list's name for it, if it has one.
ExitCountryCode string `json:"exit_country_code"`
ExitCountryName string `json:"exit_country_name,omitempty"`
}
// exitMismatch reports the chosen country and the public IP's country when
// they differ. Only a country the user chose counts (chosenCountry): the
// recommended location and the fastest one have no country to match. It is
// nil while either country is unknown.
func exitMismatch(p config.Proxy, selected proxy.Candidate, exit *exitView) *exitMismatchView {
if exit == nil || !chosenCountry(p) || selected.IsRecommended() {
return nil
}
chosen := strings.ToUpper(strings.TrimSpace(selected.CountryCode))
got := strings.ToUpper(strings.TrimSpace(exit.CountryCode))
if len(chosen) != 2 || len(got) != 2 || chosen == got {
return nil
}
exitName := exit.CountryName
if strings.EqualFold(exitName, got) {
exitName = "" // the server list does not name it
}
return &exitMismatchView{ChosenCountryCode: chosen, ChosenCountryName: selected.CountryName, ExitCountryCode: got, ExitCountryName: exitName}
}
type AccountView struct {
ID string `json:"id"`
Name string `json:"name"`
Email string `json:"email"`
Position int `json:"position"`
Enabled bool `json:"enabled"`
Active bool `json:"active"`
Status string `json:"status"`
Reason string `json:"reason,omitempty"`
// ReasonCode and ReasonDetail say the same for the apps, which put it
// in their own words (accounts.Why).
ReasonCode string `json:"reason_code,omitempty"`
ReasonDetail string `json:"reason_detail,omitempty"`
RetryAt time.Time `json:"retry_at,omitzero"`
AddedAt time.Time `json:"added_at"`
Usage *accounts.Usage `json:"usage,omitempty"`
UsedPercent float64 `json:"used_percent"`
// HasPassword is set when the password is stored (never the password).
HasPassword bool `json:"has_password"`
DeviceRegistered bool `json:"device_registered"`
}
type StatusView struct {
State engineState `json:"state"`
Proxy *proxyView `json:"proxy,omitempty"`
// Selection is the chosen location even while the proxy is off:
// proxy.country ("" recommended, "fastest", or a country), and
// SelectionName the server list's name for a country.
Selection string `json:"selection"`
// NetworkChangedAt is when the phone last reported a network change:
// a connection test before it says nothing about the connection now.
NetworkChangedAt time.Time `json:"network_changed_at,omitzero"`
// NoNetwork: the phone reported that no network is connected, so the
// app says so at once instead of waiting for a test to fail.
NoNetwork bool `json:"no_network,omitempty"`
SelectionName string `json:"selection_name,omitempty"`
Pass *proxy.RuntimeStatus `json:"pass,omitempty"`
ActiveAccount *AccountView `json:"active_account,omitempty"`
Exit *exitView `json:"exit,omitempty"`
// ExitMismatch is set when the user chose a country (not the
// recommended location or the fastest one) and the public IP is in
// another country (exitMismatch).
ExitMismatch *exitMismatchView `json:"exit_mismatch,omitempty"`
LastTest *proxy.ConnectionTestResult `json:"last_test,omitempty"`
Accounts map[string]int `json:"accounts"`
Threshold float64 `json:"switch_threshold_percent"`
Dashboard map[string]any `json:"dashboard"`
DataDir string `json:"data_dir"`
DNS string `json:"dns"`
Version string `json:"version"`
// CanExit is set when POST /app/exit can end the hosting process.
CanExit bool `json:"can_exit"`
// SystemProxy mirrors system_proxy.mode; SystemProxySupported is set
// on Windows, where the tray icon applies it.
SystemProxy string `json:"system_proxy"`
SystemProxySupported bool `json:"system_proxy_supported"`
// SystemProxyByHost: the process hosting the service applies
// system_proxy.mode itself (the tray, the app mode, the status
// screen), so a tray that only controls it leaves the setting alone.
SystemProxyByHost bool `json:"system_proxy_by_host"`
// SystemProxyTaken: another program (another VPN or proxy) replaced
// this program's system proxy, so applications no longer use it; set
// by the process applying the mode. SystemProxyRetake counts the user's
// requests to set it again.
SystemProxyTaken *SystemProxyTaken `json:"system_proxy_taken,omitempty"`
SystemProxyRetake uint64 `json:"system_proxy_retake"`
// TunSupported: system_proxy.mode can be "tun" (the desktop app's
// core on Windows); Tun is then the TUN mode's state.
TunSupported bool `json:"tun_supported,omitempty"`
Tun *TunStatus `json:"tun,omitempty"`
// Update is the desktop app's update (update.go), when this copy
// updates itself.
Update *update.Status `json:"update,omitempty"`
// AutoConnecting: the app's auto-connect tests the connection, and the
// system proxy waits for a passed test (autoconnect.go).
AutoConnecting bool `json:"auto_connecting,omitempty"`
// ConnectFailure is why the user's last connect was given up, a
// failure code (connect.go); empty after a connect that worked.
ConnectFailure string `json:"connect_failure,omitempty"`
// OpenFolderRequest counts the dashboard's requests to open the data
// folder, for the tray to carry out.
OpenFolderRequest uint64 `json:"open_folder_request"`
// Traffic is what clients sent and received since the proxy started,
// and the current speed.
Traffic *proxy.Traffic `json:"traffic,omitempty"`
// Notices are requests refused in the last noticeWindow because of a
// limit (a port, UDP), for the dashboard to explain.
Notices []proxy.Notice `json:"notices,omitempty"`
}
// noticeWindow is how long the dashboard shows a refused request.
const noticeWindow = 5 * time.Minute
func (s *dashboardServer) handleStatus(w http.ResponseWriter, r *http.Request) {
view, err := s.d.StatusView()
if err != nil {
writeError(w, http.StatusInternalServerError, err.Error())
return
}
writeJSON(w, http.StatusOK, view)
}
// StatusView summarizes the service for the dashboard and the terminal
// screen.
func (d *Daemon) StatusView() (StatusView, error) {
cfg := d.config()
d.mu.Lock()
view := StatusView{State: d.state, LastTest: d.lastTest, DataDir: d.paths.Dir, Threshold: cfg.Accounts.SwitchThresholdPercent}
view.DNS = dnsDescription(cfg.DNS)
view.Version = version.Current
view.CanExit = d.ExitApp != nil
view.OpenFolderRequest = d.folderRequests.Load()
view.SystemProxy = cfg.SystemProxy.Mode
view.AutoConnecting = d.autoConnect != nil
view.ConnectFailure = d.connectFailure
view.Selection = cfg.Proxy.Country
view.NetworkChangedAt = d.networkChangedAt
view.NoNetwork = netstate.ReportedDown()
if code := strings.ToUpper(cfg.Proxy.Country); len(code) == 2 {
view.SelectionName = d.countryNameLocked(code)
}
view.SystemProxySupported = runtime.GOOS == "windows" || d.SystemProxySupported
view.SystemProxyByHost = d.SystemProxySupported
view.SystemProxyTaken = d.systemProxyTaken.Load()
view.SystemProxyRetake = d.systemProxyRetakes.Load()
view.TunSupported = d.TunSupported
view.Tun = d.tunStatus(cfg)
if d.Updater != nil {
status := d.Updater.Status()
view.Update = &status
}
view.Notices = d.notices.Since(time.Now().Add(-noticeWindow))
engine := d.engine
if engine != nil {
traffic := engine.routed.Traffic()
view.Traffic = &traffic
}
if d.exit != nil && engine != nil {
view.Exit = &exitView{IPv4: d.exit.IPv4, IPv6: d.exit.IPv6, CountryCode: d.exit.CountryCode, CountryName: d.countryNameLocked(d.exit.CountryCode), City: d.exit.City, Network: d.exit.Network, ProbeHost: d.exit.ProbeHost, LatencyMS: d.exit.Latency.Milliseconds()}
}
d.mu.Unlock()
if engine != nil {
if controller := engine.currentController(); controller != nil {
status := controller.CurrentStatus("")
view.Pass = &status
}
selected, source := engine.selection()
view.Proxy = &proxyView{
SleepingSince: engine.asleepSince(),
Listen: engine.listener.Addr().String(),
Upstream: selected.Addr,
CountryCode: selected.CountryCode,
CountryName: selected.CountryName,
CityName: selected.CityName,
SelectionSource: source,
Transport: engine.currentTransport(),
StartedAt: engine.startedAt,
LoginRequired: cfg.Proxy.Username != "",
}
view.ExitMismatch = exitMismatch(engine.cfg.Proxy, selected, view.Exit)
if at, code, err := engine.wakeFailure(); err != nil {
view.Proxy.WakeError, view.Proxy.WakeFailedAt = err.Error(), at
view.Proxy.WakeErrorCode = code
if hint := proxy.GuardianFailureHint(err); hint != "" {
view.Proxy.WakeError += ". " + hint
}
}
}
list, err := d.accountViews()
if err != nil {
return StatusView{}, err
}
view.Accounts = map[string]int{"total": len(list)}
for i := range list {
acc := list[i]
if !acc.Enabled {
view.Accounts["disabled"]++
continue
}
view.Accounts[acc.Status]++
if acc.Active {
view.ActiveAccount = &list[i]
}
}
view.Dashboard = map[string]any{
"listen": cfg.Dashboard.Listen,
"login_required": cfg.Dashboard.Username != "" || d.tokenOnly.Load(),
"exposed_without_login": dashboardExposedWithoutLogin(cfg),
"plaintext_over_network": !hostIsLoopbackListen(cfg.Dashboard.Listen),
"socks_exposed_without_login": cfg.Proxy.Username == "" && !hostIsLoopbackListen(cfg.Proxy.Listen),
}
return view, nil
}
// accountViews lists every stored account in priority order.
func (d *Daemon) accountViews() ([]AccountView, error) {
list, err := d.store.List()
if err != nil {
return nil, err
}
byID := make(map[string]accounts.Account, len(list))
for _, acc := range list {
byID[acc.ID] = acc
}
active, hasActive := d.mgr.Active()
cfg := d.config()
views := make([]AccountView, 0, len(cfg.Accounts.Order))
for i, ref := range cfg.Accounts.Order {
acc, ok := byID[ref.ID]
if !ok {
continue
}
v := AccountView{
ID: acc.ID, Name: acc.Name(), Email: acc.Email, Position: i + 1, Enabled: ref.Enabled,
HasPassword: d.store.HasPassword(acc.ID), DeviceRegistered: acc.DeviceID != "",
Active: hasActive && active.ID == acc.ID && ref.Enabled, Status: string(acc.Status),
Reason: acc.Reason, ReasonCode: acc.ReasonCode, ReasonDetail: acc.ReasonDetail,
RetryAt: acc.RetryAt, AddedAt: acc.AddedAt, Usage: acc.Usage,
}
if acc.Usage != nil && !acc.Usage.Unlimited && acc.Usage.LimitBytes > 0 {
v.UsedPercent = float64(acc.Usage.UsedBytes()) * 100 / float64(acc.Usage.LimitBytes)
}
views = append(views, v)
}
return views, nil
}
func (s *dashboardServer) handleAccounts(w http.ResponseWriter, r *http.Request) {
list, err := s.d.accountViews()
if err != nil {
writeError(w, http.StatusInternalServerError, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]any{
"accounts": list,
"switch_threshold_percent": s.d.config().Accounts.SwitchThresholdPercent,
})
}
func (s *dashboardServer) handleAccountOrder(w http.ResponseWriter, r *http.Request) {
var in struct {
IDs []string `json:"ids"`
}
if !readJSON(w, r, &in) {
return
}
respondResult(w, s.d.setAccountOrder(in.IDs))
}
func (s *dashboardServer) handleAccountActivate(w http.ResponseWriter, r *http.Request) {
respondResult(w, s.d.activateAccount(r.PathValue("id")))
}
func (s *dashboardServer) handleAccountEnabled(w http.ResponseWriter, r *http.Request) {
var in struct {
Enabled bool `json:"enabled"`
}
if !readJSON(w, r, &in) {
return
}
respondResult(w, s.d.setAccountEnabled(r.PathValue("id"), in.Enabled))
}
func (s *dashboardServer) handleAccountRefresh(w http.ResponseWriter, r *http.Request) {
respondResult(w, s.d.refreshAccountUsage(r.PathValue("id")))
}
func (s *dashboardServer) handleAccountRemove(w http.ResponseWriter, r *http.Request) {
respondResult(w, s.d.removeAccount(r.PathValue("id")))
}
func (s *dashboardServer) handleSignInStart(w http.ResponseWriter, r *http.Request) {
var in struct {
Email string `json:"email"`
Password string `json:"password"`
// AccountID signs an existing account in again with its stored
// password, so only a confirmation code may be asked for.
AccountID string `json:"account_id"`
}
if !readJSON(w, r, &in) {
return
}
if in.AccountID != "" {
acc, err := s.d.store.Get(in.AccountID)
if err != nil {
writeError(w, http.StatusNotFound, "unknown account")
return
}
password, err := s.d.store.Password(acc.ID)
if err != nil {
writeError(w, http.StatusConflict, "no stored password for this account; enter it")
return
}
in.Email, in.Password = acc.Email, password
}
view, err := s.d.signins.start(in.Email, in.Password)
if err != nil {
writeError(w, http.StatusBadRequest, err.Error())
return
}
writeJSON(w, http.StatusAccepted, view)
}
func (s *dashboardServer) handleSignInGet(w http.ResponseWriter, r *http.Request) {
session, ok := s.d.signins.get(r.PathValue("id"))
if !ok {
writeError(w, http.StatusNotFound, "unknown sign-in")
return
}
writeJSON(w, http.StatusOK, session.snapshot())
}
func (s *dashboardServer) handleSignInAnswer(w http.ResponseWriter, r *http.Request) {
session, ok := s.d.signins.get(r.PathValue("id"))
if !ok {
writeError(w, http.StatusNotFound, "unknown sign-in")
return
}
var in struct {
Value string `json:"value"`
}
if !readJSON(w, r, &in) {
return
}
if err := session.answer(in.Value); err != nil {
writeError(w, http.StatusConflict, err.Error())
return
}
writeJSON(w, http.StatusOK, session.snapshot())
}
func (s *dashboardServer) handleSignInCancel(w http.ResponseWriter, r *http.Request) {
if session, ok := s.d.signins.get(r.PathValue("id")); ok {
session.cancel()
}
writeJSON(w, http.StatusOK, map[string]bool{"cancelled": true})
}
type settingsView struct {
Config config.Config `json:"config"`
LoginRequired bool `json:"dashboard_login_required"`
DataDir string `json:"data_dir"`
// ProgramDir is the program's folder (the desktop app's, when the core
// belongs to it).
ProgramDir string `json:"program_dir,omitempty"`
}
// handleTunPrograms lists the running programs, for the TUN settings; only
// the desktop app's core has the list (it shows what runs on the computer).
func (s *dashboardServer) handleTunPrograms(w http.ResponseWriter, r *http.Request) {
if s.d.RunningPrograms == nil || !s.d.TunSupported {
writeError(w, http.StatusNotFound, "the programs that skip the VPN are not chosen here")
return
}
programs, err := s.d.RunningPrograms()
if err != nil {
writeError(w, http.StatusInternalServerError, err.Error())
return
}
if programs == nil {
programs = []RunningProgram{}
}
writeJSON(w, http.StatusOK, map[string][]RunningProgram{"programs": programs})
}
func (s *dashboardServer) handleSettingsGet(w http.ResponseWriter, r *http.Request) {
cfg := s.d.config()
required := cfg.Dashboard.Username != "" || s.d.tokenOnly.Load()
cfg.Dashboard.PasswordHash = ""
cfg.Accounts.Order = nil
writeJSON(w, http.StatusOK, settingsView{Config: cfg, LoginRequired: required, DataDir: s.d.paths.Dir, ProgramDir: config.ProgramDir()})
}
func (s *dashboardServer) handleSettingsPut(w http.ResponseWriter, r *http.Request) {
var in struct {
Config config.Config `json:"config"`
DashboardPassword *string `json:"dashboard_password"`
}
if !readJSON(w, r, &in) {
return
}
change, err := s.d.updateSettings(in.Config, in.DashboardPassword)
if err != nil {
writeError(w, http.StatusBadRequest, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]bool{"saved": true, "proxy_restarted": change.restartEngine, "dashboard_moved": change.restartDashboard})
if change.restartDashboard {
listen := in.Config.Dashboard.Listen
go func() {
time.Sleep(500 * time.Millisecond)
s.moveTo(listen)
}()
}
}
type locationView struct {
Code string `json:"code"`
Name string `json:"name"`
City string `json:"city,omitempty"`
Server string `json:"server,omitempty"`
Recommended bool `json:"recommended"`
PingMS int64 `json:"ping_ms,omitempty"`
PingError string `json:"ping_error,omitempty"`
}
func (s *dashboardServer) handleLocations(w http.ResponseWriter, r *http.Request) {
s.d.mu.Lock()
countries := s.d.countries
s.d.mu.Unlock()
if len(countries) == 0 {
countries = s.d.refreshLocations(s.d.config())
}
seen := make(map[string]bool)
var out []locationView
for _, candidate := range proxy.ConnectCandidates(countries) {
code := strings.ToUpper(candidate.CountryCode)
if code == "" || seen[code] {
continue
}
seen[code] = true
out = append(out, locationView{Code: code, Name: candidate.CountryName, City: candidate.CityName, Server: candidate.Addr, Recommended: candidate.IsRecommended()})
}
sort.SliceStable(out, func(i, j int) bool {
if out[i].Recommended != out[j].Recommended {
return out[i].Recommended
}
return out[i].Name < out[j].Name
})
pings, pingedAt := s.d.lastPings()
byCode := make(map[string]proxy.LocationPing, len(pings))
for _, p := range pings {
byCode[p.Code] = p
}
for i := range out {
if p, ok := byCode[out[i].Code]; ok {
out[i].PingMS, out[i].PingError = p.PingMS, p.Error
}
}
writeJSON(w, http.StatusOK, map[string]any{"locations": out, "pinged_at": pingedAt, "firefox_version": s.d.knownFirefoxVersion()})
}
// handleLocationPing measures every location's latency; the result is
// sorted by latency and kept for GET /locations.
func (s *dashboardServer) handleLocationPing(w http.ResponseWriter, r *http.Request) {
var in struct {
// Codes limits the test to these locations (the dashboard's tab).
Codes []string `json:"codes"`
}
if !readJSON(w, r, &in) {
return
}
pings, pingedAt, err := s.d.PingAll(r.Context(), in.Codes)
if err != nil {
writeError(w, http.StatusConflict, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]any{"locations": pings, "pinged_at": pingedAt, "target": proxy.PingTarget})
}
func (s *dashboardServer) handleConnectionTest(w http.ResponseWriter, r *http.Request) {
result, err := s.d.ConnectionTest()
if err != nil {
writeError(w, http.StatusConflict, err.Error())
return
}
writeJSON(w, http.StatusOK, result)
}
// countryNameLocked names a country code from the server list, or returns
// the code; d.mu is held.
func (d *Daemon) countryNameLocked(code string) string {
for _, c := range d.countries {
if strings.EqualFold(c.Code, code) && c.Name != "" {
return c.Name
}
}
return code
}
// errProxyNotRunning reports an action that needs the running proxy.
var errProxyNotRunning = errors.New("the proxy is not running")
// ConnectionTest runs the connection test through the running engine,
// waking it when it sleeps, and keeps the result for the status view.
func (d *Daemon) ConnectionTest() (proxy.ConnectionTestResult, error) {
engine := d.currentEngine()
if engine == nil {
return proxy.ConnectionTestResult{}, errProxyNotRunning
}
controller, release, err := d.useController(engine, wakeForTest)
if err != nil {
return proxy.ConnectionTestResult{}, err
}
defer release()
return d.runConnectionTest(engine, controller, "requested"), nil
}
// autoTest runs the connection test by itself when the proxy first
// connected to Mozilla or its upstream session was replaced, so Overview
// has a current result and public IP. One runs at a time; a test for an engine that has
// stopped meanwhile is skipped.
func (d *Daemon) autoTest(engine *proxyEngine, why string) {
if !d.autoTesting.CompareAndSwap(false, true) {
return
}
defer d.autoTesting.Store(false)
if d.currentEngine() != engine {
return
}
// An automatic test never wakes a sleeping proxy.
controller := engine.reserve()
if controller == nil {
return
}
defer engine.releaseFunc()()
d.runConnectionTest(engine, controller, why)
}
// exitCheckTimeout and connectTimeout are config.ExitCheckTimeout and
// config.ConnectTimeout; tests change them (0 skips the public IP check).
var (
exitCheckTimeout = config.ExitCheckTimeout
connectTimeout = config.ConnectTimeout
)
// runConnectionTest tests engine and records the result and, from it, the
// public IP.
func (d *Daemon) runConnectionTest(engine *proxyEngine, controller *proxy.Controller, why string) proxy.ConnectionTestResult {
result := proxy.RunConnectionTest(controller, proxy.ConnectionTestURL, exitCheckTimeout, proxy.ConnectionTestTimeout)
// The session under the test was replaced while it ran (a reconnect on
// a new network, a renewal): that says nothing about the connection, so
// the test runs again at once on the session in place now.
if !result.OK && proxy.SessionReplaced(result.Error) {
if again := engine.reserve(); again != nil {
result = proxy.RunConnectionTest(again, proxy.ConnectionTestURL, exitCheckTimeout, proxy.ConnectionTestTimeout)
engine.releaseFunc()()
}
}
if !result.OK {
result.ErrorCode = checkedFailure(result.ErrorCode)
}
exit := result.Exit()
d.mu.Lock()
d.lastTest = &result
if result.OK {
d.lastConnected = time.Now()
}
if exit.IP() != "" {
d.exit = &exit
}
d.mu.Unlock()
if !result.OK {
logx.Warn("connection test failed reason=%s err=%s", why, result.Error)
return result
}
logx.Info("connection test passed reason=%s total_ms=%d tunnel_ms=%d ipv4=%s ipv6=%s place=%q", why, result.TotalMS, result.TunnelMS, result.ExitIPv4, result.ExitIPv6, exit.Place())
if selected, _ := engine.selection(); selected.CountryCode != "" && exit.CountryCode != "" && !strings.EqualFold(selected.CountryCode, exit.CountryCode) && !selected.IsRecommended() {
code := selected.CountryCode
logx.Warn("public IP country differs from the selected location configured_country_code=%s public_ip_country_code=%s", code, exit.CountryCode)
}
return result
}
// handleAppExit stops the proxy and ends the process hosting it (the tray).
// Only local clients holding the local token may call it, so a browser on
// another device cannot shut down a dashboard it would then lose.
func (s *dashboardServer) handleAppExit(w http.ResponseWriter, r *http.Request) {
if !s.d.hasLocalToken(r) {
writeError(w, http.StatusForbidden, "only the program on this computer can exit it")
return
}
if s.d.ExitApp == nil {
writeError(w, http.StatusConflict, "this copy is not hosted by the tray or the desktop app; stop it where it runs (its terminal, or systemd)")
return
}
writeJSON(w, http.StatusOK, map[string]bool{"exiting": true})
go s.d.ExitApp()
}
// handleSystemProxy sets system_proxy.mode (set or clear; config validation
// refuses anything else); the tray icon or the app mode applies it to
// Windows.
func (s *dashboardServer) handleSystemProxy(w http.ResponseWriter, r *http.Request) {
var in struct {
Mode string `json:"mode"`
}
if !readJSON(w, r, &in) {
return
}
if err := s.d.SetSystemProxy(in.Mode); err != nil {
writeError(w, http.StatusBadRequest, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]string{"mode": in.Mode})
}
// handleRetry drops the waits after failures (Daemon.RetryNow): the app
// came to the front.
func (s *dashboardServer) handleRetry(w http.ResponseWriter, r *http.Request) {
s.d.RetryNow()
writeJSON(w, http.StatusOK, map[string]bool{"retrying": true})
}
// handlePower turns the proxy on or off (Daemon.SetOn): off closes its
// port and, with the system proxy set, gives Windows its previous setting
// back (systemProxySync); the API keeps running. It is not stored. "auto"
// with on is the app's auto-connect at startup (Daemon.AutoConnect).
func (s *dashboardServer) handlePower(w http.ResponseWriter, r *http.Request) {
var in struct {
On bool `json:"on"`
Auto bool `json:"auto"`
}
if !readJSON(w, r, &in) {
return
}
switch {
case in.On && in.Auto:
s.d.AutoConnect()
case in.On && s.d.hasLocalToken(r):
// The app's button: given up if it never reaches Mozilla. A
// browser (a server's dashboard) turns the proxy on for good.
s.d.Connect()
default:
s.d.SetOn(in.On)
}
writeJSON(w, http.StatusOK, map[string]bool{"on": in.On})
}
// handleOpenFolder shows the data folder in the file manager of this
// computer's desktop. Only a browser on this computer may ask: from
// another device it would open on a screen nobody sees.
func (s *dashboardServer) handleOpenFolder(w http.ResponseWriter, r *http.Request) {
if host, _, err := net.SplitHostPort(r.RemoteAddr); err != nil || !net.ParseIP(host).IsLoopback() {
writeError(w, http.StatusForbidden, "the folder can only be opened from a browser on this computer")
return
}
if open := s.d.OpenFolder; open != nil {
if err := open(s.d.paths.Dir); err != nil {
writeError(w, http.StatusInternalServerError, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]string{"result": "opened"})
return
}
s.d.folderRequests.Add(1)
writeJSON(w, http.StatusOK, map[string]string{"result": "asked the tray icon"})
}
// SystemProxyTaken is another program's setting in place of this program's
// system proxy: By is the proxy address or setup script it points at, ""
// when it turned the system proxy off.
type SystemProxyTaken struct {
By string `json:"by"`
}
// SetSystemProxyTaken records another program's setting in place of this
// program's system proxy, or nil once this program's is back; the process
// applying the mode reports it.
func (d *Daemon) SetSystemProxyTaken(t *SystemProxyTaken) {
d.systemProxyTaken.Store(t)
}
// SetSystemProxy stores system_proxy.mode. Set again while set asks to take
// the system proxy back from a program that replaced it. The TUN mode only
// where the process runs it.
func (d *Daemon) SetSystemProxy(mode string) error {
if mode == config.SystemProxyTun && !d.TunSupported {
return errors.New("the TUN mode is not available here")
}
d.endAutoConnect()
cfg := d.config()
if cfg.SystemProxy.Mode == mode {
if mode == config.SystemProxySet {
d.systemProxyRetakes.Add(1)
}
return nil
}
d.systemProxyTaken.Store(nil)
cfg.SystemProxy.Mode = mode
if _, err := d.updateSettings(cfg, nil); err != nil {
return err
}
logx.Info("system proxy mode changed mode=%s", mode)
return nil
}
// handleSetLocation selects a location: a country code, "fastest", or ""
// for the recommended location. It clears an exact server.
func (s *dashboardServer) handleSetLocation(w http.ResponseWriter, r *http.Request) {
var in struct {
Country string `json:"country"`
}
if !readJSON(w, r, &in) {
return
}
if err := s.d.SetLocation(in.Country); err != nil {
writeError(w, http.StatusBadRequest, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]bool{"saved": true})
}
// SetLocation stores proxy.country and restarts the engine when it changed.
// A given-up connect's failure (connect_failure) was about the location
// before, so another location clears it.
func (d *Daemon) SetLocation(country string) error {
prev := d.config()
cfg := prev
cfg.Proxy.Country = strings.TrimSpace(country)
if strings.EqualFold(cfg.Proxy.Country, serverlist.RecommendedCountryCode) {
cfg.Proxy.Country = ""
}
cfg.Proxy.Server = ""
if _, err := d.updateSettings(cfg, nil); err != nil {
return err
}
if cfg.Proxy != prev.Proxy {
d.mu.Lock()
d.connectFailure = ""
d.mu.Unlock()
}
return nil
}
func (s *dashboardServer) handleProxyRestart(w http.ResponseWriter, r *http.Request) {
s.d.RequestRestart()
writeJSON(w, http.StatusOK, map[string]bool{"restarting": true})
}
func (s *dashboardServer) handleLogs(w http.ResponseWriter, r *http.Request) {
after, _ := strconv.ParseUint(r.URL.Query().Get("after"), 10, 64)
writeJSON(w, http.StatusOK, map[string]any{"entries": logx.Logs.Since(after)})
}
// handleLogStream streams new log entries as server-sent events.
func (s *dashboardServer) handleLogStream(w http.ResponseWriter, r *http.Request) {
flusher, ok := w.(http.Flusher)
if !ok {
writeError(w, http.StatusInternalServerError, "streaming unsupported")
return
}
entries, unsubscribe := logx.Logs.Subscribe()
defer unsubscribe()
w.Header().Set("Content-Type", "text/event-stream")
w.Header().Set("X-Accel-Buffering", "no")
w.WriteHeader(http.StatusOK)
flusher.Flush()
keepalive := time.NewTicker(25 * time.Second)
defer keepalive.Stop()
for {
select {
case <-r.Context().Done():
return
case <-keepalive.C:
fmt.Fprint(w, ": keepalive\n\n")
flusher.Flush()
case entry := <-entries:
data, _ := json.Marshal(entry)
fmt.Fprintf(w, "id: %d\ndata: %s\n\n", entry.ID, data)
flusher.Flush()
}
}
}
func respondResult(w http.ResponseWriter, err error) {
if err != nil {
writeError(w, http.StatusBadRequest, err.Error())
return
}
writeJSON(w, http.StatusOK, map[string]bool{"ok": true})
}
func hostIsLoopbackListen(addr string) bool {
host, _, err := net.SplitHostPort(addr)
if err != nil {
return false
}
if host == "localhost" {
return true
}
ip := net.ParseIP(host)
return ip != nil && ip.IsLoopback()
}