-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathmain.go
More file actions
440 lines (394 loc) · 14.3 KB
/
Copy pathmain.go
File metadata and controls
440 lines (394 loc) · 14.3 KB
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
package main
import (
"context"
"flag"
"fmt"
"os"
"time"
"github.com/labyrinthdns/labyrinth/blocklist"
"github.com/labyrinthdns/labyrinth/cache"
"github.com/labyrinthdns/labyrinth/config"
"github.com/labyrinthdns/labyrinth/daemon"
applog "github.com/labyrinthdns/labyrinth/log"
"github.com/labyrinthdns/labyrinth/metrics"
"github.com/labyrinthdns/labyrinth/resolver"
"github.com/labyrinthdns/labyrinth/secondary"
"github.com/labyrinthdns/labyrinth/security"
"github.com/labyrinthdns/labyrinth/server"
"github.com/labyrinthdns/labyrinth/web"
)
var (
version = "dev"
buildTime = "unknown"
goVersion = "unknown"
daemonizeProcess = daemon.Daemonize
stopDaemonProcess = daemon.StopDaemon
statusDaemonProcess = daemon.StatusDaemon
startHTTPServicesFn = startHTTPServices
startDNSServersFn = startDNSServers
)
const (
infraCleanupInterval = 10 * time.Minute
infraEntryMaxAge = time.Hour
)
func main() {
os.Exit(run())
}
func run() int {
// Set version info for web package
web.Version = version
web.BuildTime = buildTime
web.GoVersion = goVersion
// CLI flags
listenAddr := flag.String("listen", "", "listen address (default :53)")
metricsAddr := flag.String("metrics", "", "metrics HTTP address")
webAddr := flag.String("web", "", "web dashboard address (overrides config)")
configPath := flag.String("config", "labyrinth.yaml", "config file path")
logLevel := flag.String("log-level", "", "log level: debug|info|warn|error")
logFormat := flag.String("log-format", "", "log format: json|text")
cacheSize := flag.Int("cache-size", 0, "max cache entries")
daemonMode := flag.Bool("daemon", false, "run as background daemon")
showVersion := flag.Bool("version", false, "print version and exit")
flag.Parse()
if *showVersion {
printVersion()
return 0
}
// Subcommands
if args := flag.Args(); len(args) > 0 {
switch args[0] {
case "version":
printVersion()
return 0
case "check":
_, err := config.Load(*configPath)
if err != nil {
fmt.Fprintf(os.Stderr, "config error: %v\n", err)
return 1
}
fmt.Println("configuration is valid")
return 0
case "hash":
if len(args) < 2 {
fmt.Fprintln(os.Stderr, "usage: labyrinth hash <password>")
fmt.Fprintf(os.Stderr, "\nGenerates a bcrypt hash for use in labyrinth.yaml web.auth.password_hash.\n")
fmt.Fprintf(os.Stderr, "Password must be at least %d characters.\n", web.MinPasswordLength)
fmt.Fprintf(os.Stderr, "\nExample:\n")
fmt.Fprintf(os.Stderr, " labyrinth hash MySecurePass123\n")
fmt.Fprintf(os.Stderr, "\nThen add to labyrinth.yaml:\n")
fmt.Fprintf(os.Stderr, " web:\n")
fmt.Fprintf(os.Stderr, " auth:\n")
fmt.Fprintf(os.Stderr, " username: admin\n")
fmt.Fprintf(os.Stderr, " password_hash: <paste hash here>\n")
return 1
}
hash, err := web.HashPassword(args[1])
if err != nil {
fmt.Fprintf(os.Stderr, "Error: %v\n", err)
return 1
}
fmt.Println(hash)
return 0
case "daemon":
return handleDaemonCommand(args[1:], *configPath)
default:
fmt.Fprintf(os.Stderr, "unknown command: %s\nUsage: labyrinth [flags] [check|version|hash|daemon]\n", args[0])
return 1
}
}
// Daemon mode
if *daemonMode {
cfg, err := config.Load(*configPath)
if err != nil {
fmt.Fprintf(os.Stderr, "config load error in daemon mode: %v\n", err)
return 1
}
pidFile := "/var/run/labyrinth.pid"
if cfg != nil && cfg.Daemon.PIDFile != "" {
pidFile = cfg.Daemon.PIDFile
}
isDaemon, err := daemonizeProcess(pidFile)
if err != nil {
fmt.Fprintf(os.Stderr, "daemon error: %v\n", err)
return 1
}
if !isDaemon {
return 0 // parent exits
}
// child continues
}
// Load configuration
cfg, err := config.Load(*configPath)
if err != nil {
fmt.Fprintf(os.Stderr, "config error: %v\n", err)
return 1
}
// Apply CLI overrides
if *listenAddr != "" {
cfg.Server.ListenAddr = *listenAddr
}
if *metricsAddr != "" {
cfg.Server.MetricsAddr = *metricsAddr
}
if *webAddr != "" {
cfg.Web.Addr = *webAddr
cfg.Web.Enabled = true
}
if *logLevel != "" {
cfg.Logging.Level = *logLevel
}
if *logFormat != "" {
cfg.Logging.Format = *logFormat
}
if *cacheSize > 0 {
cfg.Cache.MaxEntries = *cacheSize
}
// Initialize logger
logger := applog.NewLogger(cfg.Logging.Level, cfg.Logging.Format)
// Initialize components
m := metrics.NewMetrics()
c := cache.NewCacheWithStale(cfg.Cache.MaxEntries, cfg.Cache.MinTTL, cfg.Cache.MaxTTL, cfg.Cache.NegMaxTTL,
cfg.Cache.ServeStale, cfg.Cache.StaleTTL, m)
c.SetStaleMaxAge(cfg.Cache.StaleMaxAge)
var rl *security.RateLimiter
if cfg.Security.RateLimit.Enabled {
rl = security.NewRateLimiter(cfg.Security.RateLimit.Rate, cfg.Security.RateLimit.Burst)
}
var rrl *security.RRL
if cfg.Security.RRL.Enabled {
rrl = security.NewRRL(
cfg.Security.RRL.ResponsesPerSecond,
cfg.Security.RRL.SlipRatio,
cfg.Security.RRL.IPv4Prefix,
cfg.Security.RRL.IPv6Prefix,
)
}
var acl *security.ACL
if len(cfg.ACL.Allow) > 0 || len(cfg.ACL.Deny) > 0 || len(cfg.ACL.Zones) > 0 {
acl, err = security.NewACL(cfg.ACL.Allow, cfg.ACL.Deny)
if err != nil {
logger.Error("failed to parse ACL", "error", err)
return 1
}
for _, zc := range cfg.ACL.Zones {
if err := acl.AddZoneACL(security.ZoneACLConfig{
Zone: zc.Zone,
Allow: zc.Allow,
Deny: zc.Deny,
}); err != nil {
logger.Error("failed to parse zone ACL", "zone", zc.Zone, "error", err)
return 1
}
}
}
resCfg := resolver.ResolverConfig{
MaxDepth: cfg.Resolver.MaxDepth,
MaxCNAMEDepth: cfg.Resolver.MaxCNAMEDepth,
UpstreamTimeout: cfg.Resolver.UpstreamTimeout,
UpstreamRetries: cfg.Resolver.UpstreamRetries,
MaxQueriesPerRequest: cfg.Resolver.MaxQueriesPerRequest,
RequestTimeout: cfg.Resolver.RequestTimeout,
QMinEnabled: cfg.Resolver.QMinEnabled,
Caps0x20Enabled: cfg.Resolver.Caps0x20Enabled,
PreferIPv4: cfg.Resolver.PreferIPv4,
DNSSECEnabled: cfg.Resolver.DNSSECEnabled,
DNS64Enabled: cfg.Resolver.DNS64Enabled,
FallbackResolvers: cfg.Resolver.FallbackResolvers,
FallbackDebug: cfg.Logging.FallbackDebug,
FallbackLogPath: cfg.Logging.FallbackLog,
UpstreamUDPBufferSize: cfg.Resolver.UpstreamUDPBufferSize,
MaxNSNamesPerDelegation: cfg.Resolver.MaxNSNamesPerDelegation,
}
if cfg.Resolver.DNS64Enabled {
prefix, prefixErr := resolver.ParseDNS64Prefix(cfg.Resolver.DNS64Prefix)
if prefixErr != nil {
logger.Error("invalid dns64 prefix", "prefix", cfg.Resolver.DNS64Prefix, "error", prefixErr)
return 1
}
resCfg.DNS64Prefix = prefix
logger.Info("DNS64 enabled", "prefix", cfg.Resolver.DNS64Prefix)
}
if len(resCfg.FallbackResolvers) > 0 {
logger.Info("fallback resolvers configured", "addrs", resCfg.FallbackResolvers)
}
if cfg.Logging.FallbackDebug {
logger.Info("fallback debug log enabled", "path", cfg.Logging.FallbackLog)
}
res := resolver.NewResolver(c, resCfg, m, logger)
// Build local zones from config + default localhost zone. The static
// set is kept because the secondary-zone manager rebuilds the whole
// table after each transfer and must not drop them.
staticZones := buildStaticLocalZones(cfg, logger)
res.SetLocalZones(resolver.NewLocalZoneTable(staticZones))
// Build forward/stub zone table from config
if len(cfg.ForwardZones) > 0 || len(cfg.StubZones) > 0 {
res.SetForwardTable(buildForwardTable(cfg, logger))
}
handler := server.NewMainHandler(res, c, rl, rrl, acl, m, logger)
// Security: private address filtering
handler.SetPrivateFilter(cfg.Security.PrivateAddressFilter)
// Security: DNS Cookies (RFC 7873). Optional anti-amplification
// shield against spoofed UDP queries. Strict mode (§5.4) is a
// further opt-in for hostile networks — refuses cookie-less UDP.
if cfg.Security.DNSCookies {
if err := handler.EnableCookies(); err != nil {
logger.Warn("could not enable DNS cookies", "error", err)
} else {
handler.SetCookiesEnforce(cfg.Security.DNSCookiesEnforce)
logger.Info("DNS cookies enabled",
"enforce_strict_udp", cfg.Security.DNSCookiesEnforce)
}
}
// Security: advertise small EDNS0 buffer (RFC 9018 / DNS Flag Day 2020)
handler.SetDownstreamUDPBufferSize(cfg.Server.MaxUDPSize)
// EDNS Client Subnet forwarding (RFC 7871). Passthrough policy: only
// forward what the client itself sent, capped at per-family ceilings.
handler.SetECSPrefixes(cfg.Resolver.ECSEnabled, cfg.Resolver.ECSMaxPrefix, cfg.Resolver.ECSMaxPrefixV6)
// Name Server Identifier (RFC 5001). Empty by default — see the
// ServerConfig.NSID field comment for why we do not default to the
// hostname.
handler.SetNSID(cfg.Server.NSID)
// RFC 9567 outbound DNS error reporting. Off by default; see the
// ResolverConfig.ErrorReporting field comment.
res.SetErrorReporting(cfg.Resolver.ErrorReporting)
// RFC 9462 Discovery of Designated Resolvers. Which transports get
// advertised follows what is actually enabled — publishing a
// designation for a listener that is switched off would send clients
// to a closed port.
handler.SetDDR(buildDDRConfig(cfg))
// RFC 9606 RESINFO. The declared behaviour is read from the live config
// rather than hardcoded — a resolver that advertises QNAME minimisation
// it has switched off is worse than one that advertises nothing.
handler.SetResolverInfo(buildResolverInfo(cfg))
// Cache: harden-below-nxdomain (RFC 8020)
c.SetHardenBelowNX(cfg.Resolver.HardenBelowNXDomain)
// Cache: prefetch
c.SetPrefetchEnabled(cfg.Cache.Prefetch)
if cfg.Cache.Prefetch {
c.SetPrefetchFunc(func(name string, qtype, qclass uint16) {
_, _ = res.Resolve(name, qtype, qclass)
})
}
if len(cfg.Cache.NoCacheClients) > 0 {
handler.SetNoCacheClients(cfg.Cache.NoCacheClients)
}
// Context for graceful shutdown
ctx, cancel := context.WithCancel(context.Background())
defer cancel()
// Blocklist
var blocklistMgr *blocklist.Manager
if cfg.Blocklist.Enabled {
blocklistMgr = blocklist.NewManager(blocklist.ManagerConfig{
Lists: convertBlocklistEntries(cfg.Blocklist.Lists),
Whitelist: cfg.Blocklist.Whitelist,
BlockingMode: cfg.Blocklist.BlockingMode,
CustomIP: cfg.Blocklist.CustomIP,
RefreshInterval: cfg.Blocklist.RefreshInterval,
}, logger)
handler.SetBlocklist(blocklistMgr)
go blocklistMgr.Start(ctx)
}
// Start background tasks
go c.StartSweeper(ctx, cfg.Cache.SweepInterval)
if rl != nil {
go rl.StartCleanup(ctx)
}
if rrl != nil {
// RRL is created in NewRRL but its cleanup goroutine was never
// started until v0.8.6. Without this, the entries map only
// shed on the new MaxRRLEntries cap (1M) — the natural idle-
// entry pruning that bounds the steady-state working set was
// dormant, and the resolver paid a permanent ~hundreds-of-MB
// memory tax under any spoofed-source attack pattern.
go rrl.StartCleanup(ctx)
}
// Infra cache cleanup (stale NS RTT entries)
go res.InfraCache().StartCleanup(ctx, infraCleanupInterval, infraEntryMaxAge)
// RFC 7766 §6.2.3 — close idle upstream TCP connections rather than
// leaving them parked on the authoritative's side.
go res.StartTCPPoolCleanup(ctx)
// Secondary and catalog zones (RFC 5936 / RFC 1995 / RFC 9103 /
// RFC 8945 / RFC 9432). The manager transfers each zone, republishes
// the local zone table, refreshes on each zone's own SOA schedule, and
// provisions catalog members as the catalog changes.
secondaryZones := buildSecondaryZones(cfg, logger)
catalogZones := buildCatalogZones(cfg, logger)
if len(secondaryZones) > 0 || len(catalogZones) > 0 {
go secondary.NewManager(res, staticZones, secondaryZones, catalogZones, logger).Run(ctx)
}
// NTA store cleanup. NTAStore.Cleanup existed since v0.6.x but was
// never wired up — expired NTAs stayed resident, consuming slots
// in the MaxNTAEntries=10000 cap (v0.7.61) even though they had no
// effect on validation (Lookup checks expiry inline). An attacker
// or careless operator who installs 10k 1-minute-expiry NTAs fills
// the cap permanently until the resolver is restarted — no admin
// API exists to batch-prune. The goroutine ticks every minute; it
// no-ops when DNSSEC is disabled or the NTA store has not been
// lazily created yet (the validator might come up later, after
// PrimeRootHints, and the store is created on first install).
go func() {
ticker := time.NewTicker(time.Minute)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
return
case <-ticker.C:
if v := res.DNSSECValidator(); v != nil {
if store := v.NTAStore(); store != nil {
store.Cleanup()
}
}
}
}
}()
// Root hint priming (+ busy TLD NS so first .com/.net lookups skip a root RTT)
go func() {
if err := res.PrimeRootHints(); err != nil {
logger.Warn("root hint priming failed", "error", err)
} else {
res.PrimeCommonTLDs()
}
if cfg.Resolver.DNSSECEnabled {
res.EnableDNSSEC(logger)
res.SetDNSSECAllowSHA1(cfg.Resolver.DNSSECAllowSHA1)
// RFC 7646 Negative Trust Anchors. We surface the count and any
// parse failures so the operator can tell at startup whether
// their NTA list landed.
ntaFailed := res.SetDNSSECNegativeTrustAnchors(cfg.Resolver.DNSSECNegativeTrustAnchors)
for _, line := range ntaFailed {
logger.Warn("dnssec NTA entry rejected", "entry", line)
}
ntaActive := 0
if v := res.DNSSECValidator(); v != nil && v.NTAStore() != nil {
ntaActive = len(v.NTAStore().List())
}
logger.Info("DNSSEC validation enabled",
"allow_sha1", cfg.Resolver.DNSSECAllowSHA1,
"nta_count", ntaActive)
}
// Root hints auto-refresh (RFC 8109)
if cfg.Resolver.RootHintsRefresh > 0 {
go res.StartRootRefresh(ctx, cfg.Resolver.RootHintsRefresh)
}
}()
if err := startHTTPServicesFn(ctx, cfg, c, m, res, handler, logger, blocklistMgr, *configPath); err != nil {
return 1
}
errCh, err := startDNSServersFn(ctx, cfg, handler, logger)
if err != nil {
return 1
}
// DoH3 requires quic-go, which is also used by DoQ. Both share the
// same quic-go dependency already in go.mod.
// Setup SIGUSR1/SIGUSR2 handlers (Unix only, no-op on Windows)
setupUnixSignals(logger, c)
logger.Info("labyrinth started",
"listen", cfg.Server.ListenAddr,
"web", cfg.Web.Addr,
"web_enabled", cfg.Web.Enabled,
"cache_max", cfg.Cache.MaxEntries,
"qmin", cfg.Resolver.QMinEnabled,
)
return waitForShutdown(ctx, cancel, cfg, c, *daemonMode, errCh, logger)
}