forked from Psiphon-Labs/psiphon-tunnel-core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
services.go
582 lines (484 loc) · 15.9 KB
/
services.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
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
/*
* Copyright (c) 2016, Psiphon Inc.
* All rights reserved.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
// Package server implements the core tunnel functionality of a Psiphon server.
// The main function is RunServices, which runs one or all of a Psiphon API web server,
// a tunneling SSH server, and an Obfuscated SSH protocol server. The server configuration
// is created by the GenerateConfig function.
package server
import (
"fmt"
"math/rand"
"os"
"os/signal"
"runtime"
"runtime/debug"
"sync"
"syscall"
"time"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/buildinfo"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/errors"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/osl"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/packetman"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/tactics"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/common/tun"
"github.com/Psiphon-Labs/psiphon-tunnel-core/psiphon/server/psinet"
)
// RunServices initializes support functions including logging and GeoIP services;
// and then starts the server components and runs them until os.Interrupt or
// os.Kill signals are received. The config determines which components are run.
func RunServices(configJSON []byte) (retErr error) {
loggingInitialized := false
defer func() {
if retErr != nil && loggingInitialized {
log.WithTraceFields(LogFields{"error": retErr}).Error("RunServices failed")
}
}()
rand.Seed(int64(time.Now().Nanosecond()))
config, err := LoadConfig(configJSON)
if err != nil {
return errors.Trace(err)
}
err = InitLogging(config)
if err != nil {
return errors.Trace(err)
}
loggingInitialized = true
support, err := NewSupportServices(config)
if err != nil {
return errors.Trace(err)
}
startupFields := buildinfo.GetBuildInfo().ToMap()
startupFields["GODEBUG"] = os.Getenv("GODEBUG")
log.WithTraceFields(startupFields).Info("startup")
waitGroup := new(sync.WaitGroup)
shutdownBroadcast := make(chan struct{})
errorChannel := make(chan error, 1)
tunnelServer, err := NewTunnelServer(support, shutdownBroadcast)
if err != nil {
return errors.Trace(err)
}
support.TunnelServer = tunnelServer
if config.RunPacketTunnel {
packetTunnelServer, err := tun.NewServer(&tun.ServerConfig{
Logger: CommonLogger(log),
SudoNetworkConfigCommands: config.PacketTunnelSudoNetworkConfigCommands,
GetDNSResolverIPv4Addresses: support.DNSResolver.GetAllIPv4,
GetDNSResolverIPv6Addresses: support.DNSResolver.GetAllIPv6,
EgressInterface: config.PacketTunnelEgressInterface,
DownstreamPacketQueueSize: config.PacketTunnelDownstreamPacketQueueSize,
SessionIdleExpirySeconds: config.PacketTunnelSessionIdleExpirySeconds,
AllowBogons: config.AllowBogons,
})
if err != nil {
return errors.Trace(err)
}
support.PacketTunnelServer = packetTunnelServer
}
if config.RunPacketManipulator {
packetManipulatorConfig, err := makePacketManipulatorConfig(support)
if err != nil {
return errors.Trace(err)
}
packetManipulator, err := packetman.NewManipulator(packetManipulatorConfig)
if err != nil {
return errors.Trace(err)
}
support.PacketManipulator = packetManipulator
}
// After this point, errors should be delivered to the errors channel and
// orderly shutdown should flow through to the end of the function to ensure
// all workers are synchronously stopped.
if config.RunPacketTunnel {
support.PacketTunnelServer.Start()
waitGroup.Add(1)
go func() {
defer waitGroup.Done()
<-shutdownBroadcast
support.PacketTunnelServer.Stop()
}()
}
if config.RunPacketManipulator {
err := support.PacketManipulator.Start()
if err != nil {
select {
case errorChannel <- err:
default:
}
} else {
waitGroup.Add(1)
go func() {
defer waitGroup.Done()
<-shutdownBroadcast
support.PacketManipulator.Stop()
}()
}
}
if config.RunLoadMonitor() {
waitGroup.Add(1)
go func() {
waitGroup.Done()
ticker := time.NewTicker(time.Duration(config.LoadMonitorPeriodSeconds) * time.Second)
defer ticker.Stop()
for {
select {
case <-shutdownBroadcast:
return
case <-ticker.C:
logServerLoad(support)
}
}
}()
}
if config.RunPeriodicGarbageCollection() {
waitGroup.Add(1)
go func() {
waitGroup.Done()
ticker := time.NewTicker(config.periodicGarbageCollection)
defer ticker.Stop()
for {
select {
case <-shutdownBroadcast:
return
case <-ticker.C:
debug.FreeOSMemory()
}
}
}()
}
if config.RunWebServer() {
waitGroup.Add(1)
go func() {
defer waitGroup.Done()
err := RunWebServer(support, shutdownBroadcast)
select {
case errorChannel <- err:
default:
}
}()
}
// The tunnel server is always run; it launches multiple
// listeners, depending on which tunnel protocols are enabled.
waitGroup.Add(1)
go func() {
defer waitGroup.Done()
err := tunnelServer.Run()
select {
case errorChannel <- err:
default:
}
}()
// Shutdown doesn't wait for the outputProcessProfiles goroutine
// to complete, as it may be sleeping while running a "block" or
// CPU profile.
signalProcessProfiles := make(chan struct{}, 1)
go func() {
for {
select {
case <-signalProcessProfiles:
outputProcessProfiles(support.Config, "")
case <-shutdownBroadcast:
return
}
}
}()
// In addition to the actual signal handling here, there is
// a list of signals that need to be passed through panicwrap
// in 'github.com/Psiphon-Labs/psiphon-tunnel-core/Server/main.go'
// where 'panicwrap.Wrap' is called. The handled signals below, and the
// list there must be kept in sync to ensure proper signal handling
// An OS signal triggers an orderly shutdown
systemStopSignal := make(chan os.Signal, 1)
signal.Notify(systemStopSignal, os.Interrupt, syscall.SIGTERM)
// SIGUSR1 triggers a reload of support services
reloadSupportServicesSignal := make(chan os.Signal, 1)
signal.Notify(reloadSupportServicesSignal, syscall.SIGUSR1)
// SIGUSR2 triggers an immediate load log and optional process profile output
logServerLoadSignal := make(chan os.Signal, 1)
signal.Notify(logServerLoadSignal, syscall.SIGUSR2)
// SIGTSTP triggers tunnelServer to stop establishing new tunnels
stopEstablishingTunnelsSignal := make(chan os.Signal, 1)
signal.Notify(stopEstablishingTunnelsSignal, syscall.SIGTSTP)
// SIGCONT triggers tunnelServer to resume establishing new tunnels
resumeEstablishingTunnelsSignal := make(chan os.Signal, 1)
signal.Notify(resumeEstablishingTunnelsSignal, syscall.SIGCONT)
err = nil
loop:
for {
select {
case <-stopEstablishingTunnelsSignal:
tunnelServer.SetEstablishTunnels(false)
if config.DumpProfilesOnStopEstablishTunnels(
tunnelServer.GetEstablishedClientCount()) {
// Run the profile dump in a goroutine and don't block this loop. Shutdown
// doesn't wait for any running outputProcessProfiles to complete.
go func() {
outputProcessProfiles(support.Config, "stop_establish_tunnels")
}()
}
case <-resumeEstablishingTunnelsSignal:
tunnelServer.SetEstablishTunnels(true)
case <-reloadSupportServicesSignal:
support.Reload()
case <-logServerLoadSignal:
// Signal profiles writes first to ensure some diagnostics are
// available in case logServerLoad hangs (which has happened
// in the past due to a deadlock bug).
select {
case signalProcessProfiles <- struct{}{}:
default:
}
logServerLoad(support)
case <-systemStopSignal:
log.WithTrace().Info("shutdown by system")
break loop
case err = <-errorChannel:
break loop
}
}
// During any delayed or hung shutdown, periodically dump profiles to help
// diagnose the cause. Shutdown doesn't wait for any running
// outputProcessProfiles to complete.
signalProfileDumperStop := make(chan struct{})
go func() {
tickSeconds := 10
ticker := time.NewTicker(time.Duration(tickSeconds) * time.Second)
defer ticker.Stop()
for i := tickSeconds; i <= 60; i += tickSeconds {
select {
case <-signalProfileDumperStop:
return
case <-ticker.C:
filenameSuffix := fmt.Sprintf("delayed_shutdown_%ds", i)
outputProcessProfiles(support.Config, filenameSuffix)
}
}
}()
close(shutdownBroadcast)
waitGroup.Wait()
close(signalProfileDumperStop)
return err
}
func getRuntimeMetrics() LogFields {
numGoroutine := runtime.NumGoroutine()
var memStats runtime.MemStats
runtime.ReadMemStats(&memStats)
lastGC := ""
if memStats.LastGC > 0 {
lastGC = time.Unix(0, int64(memStats.LastGC)).UTC().Format(time.RFC3339)
}
return LogFields{
"num_goroutine": numGoroutine,
"heap_alloc": memStats.HeapAlloc,
"heap_sys": memStats.HeapSys,
"heap_idle": memStats.HeapIdle,
"heap_inuse": memStats.HeapInuse,
"heap_released": memStats.HeapReleased,
"heap_objects": memStats.HeapObjects,
"num_gc": memStats.NumGC,
"num_forced_gc": memStats.NumForcedGC,
"last_gc": lastGC,
}
}
func outputProcessProfiles(config *Config, filenameSuffix string) {
log.WithTraceFields(getRuntimeMetrics()).Info("runtime_metrics")
if config.ProcessProfileOutputDirectory != "" {
common.WriteRuntimeProfiles(
CommonLogger(log),
config.ProcessProfileOutputDirectory,
filenameSuffix,
config.ProcessBlockProfileDurationSeconds,
config.ProcessCPUProfileDurationSeconds)
}
}
func logServerLoad(support *SupportServices) {
serverLoad := getRuntimeMetrics()
serverLoad["event_name"] = "server_load"
establishTunnels, establishLimitedCount :=
support.TunnelServer.GetEstablishTunnelsMetrics()
serverLoad["establish_tunnels"] = establishTunnels
serverLoad["establish_tunnels_limited_count"] = establishLimitedCount
serverLoad.Add(support.ReplayCache.GetMetrics())
serverLoad.Add(support.ServerTacticsParametersCache.GetMetrics())
protocolStats, regionStats :=
support.TunnelServer.GetLoadStats()
for protocol, stats := range protocolStats {
serverLoad[protocol] = stats
}
log.LogRawFieldsWithTimestamp(serverLoad)
for region, regionProtocolStats := range regionStats {
serverLoad := LogFields{
"event_name": "server_load",
"region": region,
}
for protocol, stats := range regionProtocolStats {
serverLoad[protocol] = stats
}
log.LogRawFieldsWithTimestamp(serverLoad)
}
}
func logIrregularTunnel(
support *SupportServices,
listenerTunnelProtocol string,
listenerPort int,
clientIP string,
tunnelError error,
logFields LogFields) {
if logFields == nil {
logFields = make(LogFields)
}
logFields["event_name"] = "irregular_tunnel"
logFields["listener_protocol"] = listenerTunnelProtocol
logFields["listener_port_number"] = listenerPort
support.GeoIPService.Lookup(clientIP).SetLogFields(logFields)
logFields["tunnel_error"] = tunnelError.Error()
log.LogRawFieldsWithTimestamp(logFields)
}
// SupportServices carries common and shared data components
// across different server components. SupportServices implements a
// hot reload of traffic rules, psinet database, and geo IP database
// components, which allows these data components to be refreshed
// without restarting the server process.
type SupportServices struct {
Config *Config
TrafficRulesSet *TrafficRulesSet
OSLConfig *osl.Config
PsinetDatabase *psinet.Database
GeoIPService *GeoIPService
DNSResolver *DNSResolver
TunnelServer *TunnelServer
PacketTunnelServer *tun.Server
TacticsServer *tactics.Server
Blocklist *Blocklist
PacketManipulator *packetman.Manipulator
ReplayCache *ReplayCache
ServerTacticsParametersCache *ServerTacticsParametersCache
}
// NewSupportServices initializes a new SupportServices.
func NewSupportServices(config *Config) (*SupportServices, error) {
trafficRulesSet, err := NewTrafficRulesSet(config.TrafficRulesFilename)
if err != nil {
return nil, errors.Trace(err)
}
oslConfig, err := osl.NewConfig(config.OSLConfigFilename)
if err != nil {
return nil, errors.Trace(err)
}
psinetDatabase, err := psinet.NewDatabase(config.PsinetDatabaseFilename)
if err != nil {
return nil, errors.Trace(err)
}
geoIPService, err := NewGeoIPService(
config.GeoIPDatabaseFilenames, config.DiscoveryValueHMACKey)
if err != nil {
return nil, errors.Trace(err)
}
dnsResolver, err := NewDNSResolver(config.DNSResolverIPAddress)
if err != nil {
return nil, errors.Trace(err)
}
blocklist, err := NewBlocklist(config.BlocklistFilename)
if err != nil {
return nil, errors.Trace(err)
}
tacticsServer, err := tactics.NewServer(
CommonLogger(log),
getTacticsAPIParameterLogFieldFormatter(),
getTacticsAPIParameterValidator(config),
config.TacticsConfigFilename)
if err != nil {
return nil, errors.Trace(err)
}
support := &SupportServices{
Config: config,
TrafficRulesSet: trafficRulesSet,
OSLConfig: oslConfig,
PsinetDatabase: psinetDatabase,
GeoIPService: geoIPService,
DNSResolver: dnsResolver,
TacticsServer: tacticsServer,
Blocklist: blocklist,
}
support.ReplayCache = NewReplayCache(support)
support.ServerTacticsParametersCache =
NewServerTacticsParametersCache(support)
return support, nil
}
// Reload reinitializes traffic rules, psinet database, and geo IP database
// components. If any component fails to reload, an error is logged and
// Reload proceeds, using the previous state of the component.
func (support *SupportServices) Reload() {
reloaders := append(
[]common.Reloader{
support.TrafficRulesSet,
support.OSLConfig,
support.PsinetDatabase,
support.TacticsServer,
support.Blocklist},
support.GeoIPService.Reloaders()...)
// Note: established clients aren't notified when tactics change after a
// reload; new tactics will be obtained on the next client handshake or
// tactics request.
reloadTactics := func() {
// Don't use stale tactics.
support.ReplayCache.Flush()
support.ServerTacticsParametersCache.Flush()
if support.Config.RunPacketManipulator {
err := reloadPacketManipulationSpecs(support)
if err != nil {
log.WithTraceFields(
LogFields{"error": errors.Trace(err)}).Warning(
"failed to reload packet manipulation specs")
}
}
}
// Take these actions only after the corresponding Reloader has reloaded.
// In both the traffic rules and OSL cases, there is some impact from state
// reset, so the reset should be avoided where possible.
reloadPostActions := map[common.Reloader]func(){
support.TrafficRulesSet: func() { support.TunnelServer.ResetAllClientTrafficRules() },
support.OSLConfig: func() { support.TunnelServer.ResetAllClientOSLConfigs() },
support.TacticsServer: reloadTactics,
}
for _, reloader := range reloaders {
if !reloader.WillReload() {
// Skip logging
continue
}
// "reloaded" flag indicates if file was actually reloaded or ignored
reloaded, err := reloader.Reload()
if reloaded {
if action, ok := reloadPostActions[reloader]; ok {
action()
}
}
if err != nil {
log.WithTraceFields(
LogFields{
"reloader": reloader.LogDescription(),
"error": err}).Error("reload failed")
// Keep running with previous state
} else {
log.WithTraceFields(
LogFields{
"reloader": reloader.LogDescription(),
"reloaded": reloaded}).Info("reload success")
}
}
}