-
Notifications
You must be signed in to change notification settings - Fork 12
/
main.go
802 lines (729 loc) · 25.9 KB
/
main.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
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
package main
import (
"errors"
"fmt"
"io"
"io/fs"
"net/http"
_ "net/http/pprof"
"os"
"os/signal"
"path/filepath"
"regexp"
"runtime"
"strconv"
"strings"
"sync"
"syscall"
"time"
sddaemon "github.com/coreos/go-systemd/v22/daemon"
"github.com/ipfs/boxo/gateway"
logging "github.com/ipfs/go-log/v2"
"github.com/libp2p/go-libp2p/core/crypto"
peer "github.com/libp2p/go-libp2p/core/peer"
madns "github.com/multiformats/go-multiaddr-dns"
"github.com/urfave/cli/v2"
"go.opentelemetry.io/contrib/propagators/autoprop"
"go.opentelemetry.io/otel"
)
var goLog = logging.Logger("rainbow")
func main() {
app := cli.NewApp()
app.Name = "rainbow"
app.Usage = "The IPFS HTTP gateway daemon"
app.Version = version
app.Description = `
Rainbow runs an IPFS HTTP gateway.
An IPFS HTTP gateway is able to fetch content from the IPFS network and serve
it via HTTP, so that it becomes seamless to browse the web, when the web is
stored and provided by peers in the IPFS network.
HTTP gateways are also able to facilitate download of any IPFS content (not
only websites, but any supported content-addressed Merkle-DAG), in formats
that are suitable for verification client-side (i.e. CAR files).
Rainbow is optimized to perform the tasks of a gateway and only that, making
opinionated choices on the configuration and setup of internal
components. Rainbow aims to serve production environments, where gateways are
deployed as a public service meant to be accessible by anyone. Rainbow acts as
a client to the IPFS network and does not serve or provide content to
it. Rainbow cannot be used to store or pin IPFS content, other than that
temporarily served over HTTP. Rainbow is just a gateway.
Persistent configuration and data is stored in $RAINBOW_DATADIR (by default,
the folder in which rainbow is run).
EXAMPLES
Launch a gateway with randomly generated libp2p.key (will be written to
$RAINBOW_DATADIR/libp2p.key and used in subsequent runs):
$ rainbow
Generate an identity seed and launch a gateway:
$ rainbow gen-seed > $RAINBOW_DATADIR/seed
$ rainbow --seed-index 0
(other rainbow gateways can use the same seed with different indexes to
derivate their identities)
`
app.Flags = []cli.Flag{
&cli.StringFlag{
Name: "datadir",
Value: "",
EnvVars: []string{"RAINBOW_DATADIR"},
Usage: "Directory for persistent data (keys, blocks, denylists)",
},
&cli.StringFlag{
Name: "seed",
Value: "",
EnvVars: []string{"RAINBOW_SEED"},
Usage: "Seed to derive peerID from. Generate with gen-seed. Needs --seed-index. Best to use $CREDENTIALS_DIRECTORY/seed or $RAINBOW_DATADIR/seed",
},
&cli.IntFlag{
Name: "seed-index",
Value: -1,
EnvVars: []string{"RAINBOW_SEED_INDEX"},
Usage: "Index to derivate the peerID (needs --seed)",
},
&cli.BoolFlag{
Name: "seed-peering",
Value: false,
EnvVars: []string{"RAINBOW_SEED_PEERING"},
Usage: "Automatic peering with peers with the same seed (requires --seed and --seed-index). Runs a separate light DHT for peer routing with the main host if --dht-routing or --dht-shared-host are disabled",
Action: func(ctx *cli.Context, b bool) error {
if !b {
return nil
}
if !ctx.IsSet("seed") || !ctx.IsSet("seed-index") {
return errors.New("--seed and --seed-index must be explicitly defined when --seed-peering is enabled")
}
return nil
},
},
&cli.IntFlag{
Name: "seed-peering-max-index",
Value: 100,
EnvVars: []string{"RAINBOW_SEED_PEERING_MAX_INDEX"},
Usage: "Largest index to derive automatic peering peer IDs for",
},
&cli.StringSliceFlag{
Name: "gateway-domains",
Value: cli.NewStringSlice(),
EnvVars: []string{"RAINBOW_GATEWAY_DOMAINS"},
Usage: "Domains with flat path gateway, no Origin isolation (comma-separated)",
},
&cli.StringSliceFlag{
Name: "subdomain-gateway-domains",
Value: cli.NewStringSlice(),
EnvVars: []string{"RAINBOW_SUBDOMAIN_GATEWAY_DOMAINS"},
Usage: "Domains with subdomain-based Origin isolation (comma-separated)",
},
&cli.StringSliceFlag{
Name: "trustless-gateway-domains",
Value: cli.NewStringSlice(),
EnvVars: []string{"RAINBOW_TRUSTLESS_GATEWAY_DOMAINS"},
Usage: "Domains limited to trustless, verifiable response types (comma-separated)",
},
&cli.StringFlag{
Name: "gateway-listen-address",
Value: "127.0.0.1:8090",
EnvVars: []string{"RAINBOW_GATEWAY_LISTEN_ADDRESS"},
Usage: "Listen address for the gateway endpoint",
},
&cli.StringFlag{
Name: "ctl-listen-address",
Value: "127.0.0.1:8091",
EnvVars: []string{"RAINBOW_CTL_LISTEN_ADDRESS"},
Usage: "Listen address for the management api and metrics",
},
&cli.DurationFlag{
Name: "gc-interval",
Value: time.Minute * 60,
EnvVars: []string{"RAINBOW_GC_INTERVAL"},
Usage: "The interval between automatic GC runs. Set 0 to disable",
},
&cli.Float64Flag{
Name: "gc-threshold",
Value: 0.3,
EnvVars: []string{"RAINBOW_GC_THRESHOLD"},
Usage: "Percentage of how much of the disk free space must be available",
},
&cli.BoolFlag{
Name: "libp2p",
Value: true,
EnvVars: []string{"RAINBOW_LIBP2P"},
Usage: "Controls if a local libp2p node is used (useful for testing or when remote backend is used instead)",
},
&cli.IntFlag{
Name: "libp2p-connmgr-low",
Value: 100,
EnvVars: []string{"RAINBOW_LIBP2P_CONNMGR_LOW"},
Usage: "Number of connections that the connection manager will trim down to during GC",
},
&cli.IntFlag{
Name: "libp2p-connmgr-high",
Value: 3000,
EnvVars: []string{"RAINBOW_LIBP2P_CONNMGR_HIGH"},
Usage: "Number of libp2p connections that, when exceeded, will trigger a connection GC operation",
},
&cli.DurationFlag{
Name: "libp2p-connmgr-grace",
Value: time.Minute,
EnvVars: []string{"RAINBOW_LIBP2P_CONNMGR_GRACE_PERIOD"},
Usage: "How long new libp2p connections are immune from being closed by the connection manager",
},
&cli.IntFlag{
Name: "inmem-block-cache",
Value: 1 << 30,
EnvVars: []string{"RAINBOW_INMEM_BLOCK_CACHE"},
Usage: "Size of the in-memory block cache (currently only used for pebble and badger). 0 to disable (disables compression on disk too)",
},
&cli.Uint64Flag{
Name: "libp2p-max-memory",
Value: 0,
EnvVars: []string{"RAINBOW_LIBP2P_MAX_MEMORY"},
Usage: "Max memory to use for libp2p node. Defaults to 85% of the system's available RAM",
},
&cli.Uint64Flag{
Name: "libp2p-max-fd",
Value: 0,
EnvVars: []string{"RAINBOW_LIBP2P_MAX_FD"},
Usage: "Maximum number of file descriptors used by libp2p node. Defaults to 50% of the process' limit",
},
&cli.StringSliceFlag{
Name: "http-routers",
Value: cli.NewStringSlice(cidContactEndpoint),
EnvVars: []string{"RAINBOW_HTTP_ROUTERS"},
Usage: "HTTP servers with /routing/v1 endpoints to use for delegated routing (comma-separated)",
},
&cli.StringSliceFlag{
Name: "http-routers-filter-protocols",
Value: cli.NewStringSlice(httpRoutersFilterProtocols...),
EnvVars: []string{"RAINBOW_HTTP_ROUTERS_FILTER_PROTOCOLS"},
Usage: "IPIP-484 filter-protocols to apply to delegated routing requests (comma-separated)",
},
&cli.StringFlag{
Name: "dht-routing",
Value: "accelerated",
EnvVars: []string{"RAINBOW_DHT_ROUTING"},
Usage: "Use the Amino DHT for routing. Options are 'accelerated', 'standard' and 'off'",
Action: func(ctx *cli.Context, s string) error {
switch DHTRouting(s) {
case DHTAccelerated, DHTStandard, DHTOff:
return nil
default:
return errors.New("invalid value for --dht-routing: use 'accelerated', 'standard' or 'off'")
}
},
},
&cli.BoolFlag{
Name: "dht-shared-host",
Value: false,
EnvVars: []string{"RAINBOW_DHT_SHARED_HOST"},
Usage: "If false, DHT operations are run using an ephemeral peer, separate from the main one",
},
&cli.StringSliceFlag{
Name: "denylists",
Value: cli.NewStringSlice(),
EnvVars: []string{"RAINBOW_DENYLISTS"},
Usage: "Denylist HTTP subscriptions (comma-separated). Must be append-only denylists",
},
&cli.StringSliceFlag{
Name: "peering",
Value: cli.NewStringSlice(),
EnvVars: []string{"RAINBOW_PEERING"},
Usage: "(EXPERIMENTAL) Multiaddresses of peers to stay connected to and ask for missing blocks over Bitswap (comma-separated)",
},
&cli.BoolFlag{
Name: "peering-shared-cache",
Value: false,
EnvVars: []string{"RAINBOW_PEERING_SHARED_CACHE"},
Usage: "(EXPERIMENTAL: increased network I/O) Enable sharing of local cache to peers safe-listed with --peering. Rainbow will respond to Bitswap queries from these peers, serving locally cached data as needed (requires --bitswap=true).",
},
&cli.StringFlag{
Name: "blockstore",
Value: "flatfs",
EnvVars: []string{"RAINBOW_BLOCKSTORE"},
Usage: "Type of blockstore to use, such as flatfs or pebble. See https://github.com/ipfs/rainbow/blob/main/docs/blockstores.md for more details",
},
&cli.DurationFlag{
Name: "ipns-max-cache-ttl",
Value: 0,
EnvVars: []string{"RAINBOW_IPNS_MAX_CACHE_TTL"},
Usage: "Optional cap on caching duration for IPNS/DNSLink lookups. Set to 0 to respect original TTLs",
},
&cli.BoolFlag{
Name: "bitswap",
Value: true,
EnvVars: []string{"RAINBOW_BITSWAP"},
Usage: "Controls if Bitswap is enabled (useful for testing or when remote backend is used instead)",
},
&cli.IntFlag{
Name: "bitswap-wanthave-replace-size",
Value: 1024,
EnvVars: []string{"BITSWAP_WANTHAVE_REPLACE_SIZE"},
Usage: "Replace WantHave with WantBlock responses for small blocks up to this size, 0 to disable replacement",
},
&cli.StringSliceFlag{
Name: "remote-backends",
Value: cli.NewStringSlice(),
EnvVars: []string{"RAINBOW_REMOTE_BACKENDS"},
Usage: "(EXPERIMENTAL) Trustless gateways to use as backend instead of Bitswap (comma-separated urls)",
},
&cli.BoolFlag{
Name: "remote-backends-ipns",
Value: true,
EnvVars: []string{"RAINBOW_REMOTE_BACKENDS_IPNS"},
Usage: "(EXPERIMENTAL) Whether to fetch IPNS Records (application/vnd.ipfs.ipns-record) from the remote backends",
},
&cli.StringFlag{
Name: "remote-backends-mode",
Value: "block",
EnvVars: []string{"RAINBOW_REMOTE_BACKENDS_MODE"},
Usage: "(EXPERIMENTAL) Whether to fetch raw blocks or CARs from the remote backends. Options are 'block' or 'car'",
Action: func(ctx *cli.Context, s string) error {
switch RemoteBackendMode(s) {
case RemoteBackendBlock, RemoteBackendCAR:
return nil
default:
return errors.New("invalid value for --remote-backend-mode: use 'block' or 'car'")
}
},
},
&cli.StringSliceFlag{
Name: "libp2p-listen-addrs",
Value: cli.NewStringSlice("/ip4/0.0.0.0/tcp/4001",
"/ip4/0.0.0.0/udp/4001/quic-v1",
"/ip4/0.0.0.0/udp/4001/quic-v1/webtransport",
"/ip6/::/tcp/4001",
"/ip6/::/udp/4001/quic-v1",
"/ip6/::/udp/4001/quic-v1/webtransport"),
EnvVars: []string{"RAINBOW_LIBP2P_LISTEN_ADDRS"},
Usage: "Multiaddresses for libp2p bitswap client to listen on (comma-separated)",
},
&cli.StringFlag{
Name: "tracing-auth",
Value: "",
EnvVars: []string{"RAINBOW_TRACING_AUTH"},
Usage: "If set the key gates use of the Traceparent header by requiring the key to be passed in the Authorization header",
},
&cli.Float64Flag{
Name: "sampling-fraction",
Value: 0,
EnvVars: []string{"RAINBOW_SAMPLING_FRACTION"},
Usage: "Rate at which to sample gateway requests. Does not include traceheaders which will always sample",
},
&cli.IntFlag{
Name: "pebble-bytes-per-sync",
Value: 0,
EnvVars: []string{"PEBBLE_BYTES_PER_SYNC"},
Usage: "Sync sstables periodically in order to smooth out writes to disk",
},
&cli.BoolFlag{
Name: "pebble-disable-wal",
Value: false,
EnvVars: []string{"PEBBLE_DISABLE_WAL"},
Usage: "Disable the write-ahead log (WAL) at expense of prohibiting crash recoveryfg",
},
&cli.IntFlag{
Name: "pebble-l0-compaction-threshold",
Value: 0,
EnvVars: []string{"PEBBLE_L0_COMPACTION_THRESHOLD"},
Usage: "Count of L0 files necessary to trigger an L0 compaction",
},
&cli.IntFlag{
Name: "pebble-l0-stop-writes-threshold",
Value: 0,
EnvVars: []string{"PEBBLE_L0_STOP_WRITES_THRESHOLD"},
Usage: "Limit on L0 read-amplification, computed as the number of L0 sublevels",
},
&cli.Int64Flag{
Name: "pebble-lbase-max-bytes",
Value: 0,
EnvVars: []string{"PEBBLE_LBASE_MAX_BYTES"},
Usage: "Maximum number of bytes for LBase. The base level is the level which L0 is compacted into",
},
&cli.Uint64Flag{
Name: "pebble-mem-table-size",
Value: 0,
EnvVars: []string{"PEBBLE_MEM_TABLE_SIZE"},
Usage: "Size of a MemTable in steady state. The actual MemTable size starts at min(256KB, MemTableSize) and doubles for each subsequent MemTable up to MemTableSize",
},
&cli.IntFlag{
Name: "pebble-mem-table-stop-writes-threshold",
Value: 0,
EnvVars: []string{"PEBBLE_MEM_TABLE_STOP_WRITES_THRESHOLD"},
Usage: "Limit on the number of queued of MemTables",
},
&cli.IntFlag{
Name: "pebble-wal-bytes-per-sync",
Value: 0,
EnvVars: []string{"PEBBLE_WAL_BYTES_PER_SYNC"},
Usage: "Sets the number of bytes to write to a WAL before calling Sync on it in the background",
},
&cli.IntFlag{
Name: "pebble-max-concurrent-compactions",
Value: 0,
EnvVars: []string{"PEBBLE_MAX_CONCURRENT_COMPACTIONS"},
Usage: "Maximum number of concurrent compactions",
},
&cli.DurationFlag{
Name: "pebble-wal-min-sync-interval",
Value: 0,
EnvVars: []string{"PEBBLE_WAL_MIN_SYNC_INTERVAL"},
Usage: "Sets the minimum duration between syncs of the WAL",
},
&cli.IntFlag{
Name: "routing-max-requests",
Value: 16,
EnvVars: []string{"ROUTING_MAX_REQUESTS"},
Usage: "Maximum number of concurrent provider find requests, 0 for unlimited",
},
&cli.IntFlag{
Name: "routing-max-providers",
EnvVars: []string{"ROUTING_MAX_PROVIDERS"},
Value: 0,
Usage: "Maximum number of providers to return for each provider find request, 0 for unlimited",
},
&cli.DurationFlag{
Name: "routing-max-timeout",
Value: 10 * time.Second,
EnvVars: []string{"ROUTING_MAX_TIMEOUT"},
Usage: "Maximum time for routing to find the maximum number of providers",
},
&cli.StringSliceFlag{
Name: "dnslink-resolvers",
Value: cli.NewStringSlice(extraDNSLinkResolvers...),
EnvVars: []string{"RAINBOW_DNSLINK_RESOLVERS"},
Usage: "The DNSLink resolvers to use (comma-separated tuples that each look like `eth. : https://dns.eth.limo/dns-query`)",
},
}
app.Commands = []*cli.Command{
{
Name: "gen-seed",
Usage: "Generate a seed for key derivation",
Description: `
Running this command will generate a random seed and print it. The value can
be used with the RAINBOW_SEED env-var to use key-derivation from a single seed
to create libp2p identities for the gateway.
The seed can be provided to rainbow by:
- Storing it in $RAINBOW_DATADIR/seed
- Storing it in $CREDENTIALS_DIRECTORY/seed
- Passing the --seed flag
In all cases the --seed-index flag will be necessary. Multiple gateways can
share the same seed as long as the indexes are different.
`,
Flags: []cli.Flag{},
Action: func(c *cli.Context) error {
seed, err := newSeed()
if err != nil {
return err
}
fmt.Println(seed)
return nil
},
},
}
app.Action = func(cctx *cli.Context) error {
fmt.Printf("Starting %s %s\n", name, version)
ddir := cctx.String("datadir")
cdns := newCachedDNS(dnsCacheRefreshInterval)
defer cdns.Close()
var seed string
var priv crypto.PrivKey
var peeringAddrs []peer.AddrInfo
var index int
var err error
bitswap := cctx.Bool("bitswap")
dhtRouting := DHTRouting(cctx.String("dht-routing"))
seedPeering := cctx.Bool("seed-peering")
libp2p := cctx.Bool("libp2p")
// as a convenience to the end user, and to reduce confusion
// libp2p is disabled when remote backends are defined
remoteBackends := cctx.StringSlice("remote-backends")
if len(remoteBackends) > 0 {
fmt.Printf("RAINBOW_REMOTE_BACKENDS set, forcing RAINBOW_LIBP2P=false\n")
libp2p = false
bitswap = false
dhtRouting = DHTOff
}
// Only load secrets if we need Libp2p.
if libp2p {
credDir := os.Getenv("CREDENTIALS_DIRECTORY")
secretsDir := ddir
if len(credDir) > 0 {
secretsDir = credDir
}
// attempt to read seed from disk
seedBytes, err := os.ReadFile(filepath.Join(secretsDir, "seed"))
if err != nil {
if errors.Is(err, fs.ErrNotExist) {
// set seed from command line or env-var
seed = cctx.String("seed")
} else {
return fmt.Errorf("error reading seed credentials: %w", err)
}
} else {
seed = strings.TrimSpace(string(seedBytes))
}
index = cctx.Int("seed-index")
if len(seed) > 0 && index >= 0 {
fmt.Println("Deriving identity from seed")
priv, err = deriveKey(seed, deriveKeyInfo(index))
} else {
fmt.Println("Setting identity from libp2p.key")
keyFile := filepath.Join(secretsDir, "libp2p.key")
priv, err = loadOrInitPeerKey(keyFile)
}
if err != nil {
return err
}
for _, maStr := range cctx.StringSlice("peering") {
if len(seed) > 0 && index >= 0 {
maStr, err = replaceRainbowSeedWithPeer(maStr, seed)
if err != nil {
return err
}
} else if rainbowSeedRegex.MatchString(maStr) {
return fmt.Errorf("unable to peer with %q without defining --seed-index of this instance first", maStr)
}
ai, err := peer.AddrInfoFromString(maStr)
if err != nil {
return err
}
peeringAddrs = append(peeringAddrs, *ai)
}
}
customDNSResolvers := cctx.StringSlice("dnslink-resolvers")
dns, err := parseCustomDNSLinkResolvers(customDNSResolvers)
if err != nil {
return err
}
cfg := Config{
DataDir: ddir,
BlockstoreType: cctx.String("blockstore"),
GatewayDomains: cctx.StringSlice("gateway-domains"),
SubdomainGatewayDomains: cctx.StringSlice("subdomain-gateway-domains"),
TrustlessGatewayDomains: cctx.StringSlice("trustless-gateway-domains"),
ConnMgrLow: cctx.Int("libp2p-connmgr-low"),
ConnMgrHi: cctx.Int("libp2p-connmgr-high"),
ConnMgrGrace: cctx.Duration("libp2p-connmgr-grace"),
MaxMemory: cctx.Uint64("libp2p-max-memory"),
MaxFD: cctx.Int("libp2p-max-fd"),
InMemBlockCache: cctx.Int64("inmem-block-cache"),
RoutingV1Endpoints: cctx.StringSlice("http-routers"),
RoutingV1FilterProtocols: cctx.StringSlice("http-routers-filter-protocols"),
DHTRouting: dhtRouting,
DHTSharedHost: cctx.Bool("dht-shared-host"),
Bitswap: bitswap,
BitswapWantHaveReplaceSize: cctx.Int("bitswap-wanthave-replace-size"),
IpnsMaxCacheTTL: cctx.Duration("ipns-max-cache-ttl"),
DenylistSubs: cctx.StringSlice("denylists"),
Peering: peeringAddrs,
PeeringSharedCache: cctx.Bool("peering-shared-cache"),
Seed: seed,
SeedIndex: index,
SeedPeering: seedPeering,
SeedPeeringMaxIndex: cctx.Int("seed-peering-max-index"),
RemoteBackends: remoteBackends,
RemoteBackendsIPNS: cctx.Bool("remote-backends-ipns"),
RemoteBackendMode: RemoteBackendMode(cctx.String("remote-backends-mode")),
GCInterval: cctx.Duration("gc-interval"),
GCThreshold: cctx.Float64("gc-threshold"),
ListenAddrs: cctx.StringSlice("libp2p-listen-addrs"),
TracingAuthToken: cctx.String("tracing-auth"),
DNSLinkResolver: dns,
// Pebble config
BytesPerSync: cctx.Int("pebble-bytes-per-sync"),
DisableWAL: cctx.Bool("pebble-disable-wal"),
L0CompactionThreshold: cctx.Int("pebble-l0-compaction-threshold"),
L0StopWritesThreshold: cctx.Int("pebble-l0-stop-writes-threshold"),
LBaseMaxBytes: cctx.Int64("pebble-lbase-max-bytes"),
MemTableSize: cctx.Uint64("pebble-mem-table-size"),
MemTableStopWritesThreshold: cctx.Int("pebble-mem-table-stop-writes-threshold"),
WALBytesPerSync: cctx.Int("pebble-wal-Bytes-per-sync"),
MaxConcurrentCompactions: cctx.Int("pebble-max-concurrent-compactions"),
WALMinSyncInterval: time.Second * time.Duration(cctx.Int("pebble-wal-min-sync-interval-sec")),
// Routing ProviderQueryManager config
RoutingMaxRequests: cctx.Int("routing-max-requests"),
RoutingMaxProviders: cctx.Int("routing-max-providers"),
RoutingMaxTimeout: cctx.Duration("routing-max-timeout"),
}
var gnd *Node
goLog.Infof("Rainbow config: %+v", cfg)
if libp2p {
gnd, err = SetupWithLibp2p(cctx.Context, cfg, priv, cdns)
} else {
gnd, err = SetupNoLibp2p(cctx.Context, cfg, cdns)
}
if err != nil {
return err
}
gatewayListen := cctx.String("gateway-listen-address")
ctlListen := cctx.String("ctl-listen-address")
handler, err := setupGatewayHandler(cfg, gnd)
if err != nil {
return err
}
gatewaySrv := &http.Server{
Addr: gatewayListen,
Handler: handler,
}
fmt.Printf("Starting %s %s\n", name, version)
if priv != nil {
pid, err := peer.IDFromPublicKey(priv.GetPublic())
if err != nil {
return err
}
fmt.Printf("PeerID: %s\n\n", pid)
}
registerVersionMetric(version)
registerIpfsNodeCollector(gnd)
tp, shutdown, err := newTracerProvider(cctx.Context, cctx.Float64("sampling-fraction"))
if err != nil {
return err
}
defer func() {
_ = shutdown(cctx.Context)
}()
otel.SetTracerProvider(tp)
otel.SetTextMapPropagator(autoprop.NewTextMapPropagator())
apiMux := makeMetricsAndDebuggingHandler()
apiMux.HandleFunc("/mgr/gc", gcHandler(gnd))
apiMux.HandleFunc("/mgr/purge", purgePeerHandler(gnd.host))
apiMux.HandleFunc("/mgr/peers", showPeersHandler(gnd.host))
addLogHandlers(apiMux)
apiSrv := &http.Server{
Addr: ctlListen,
Handler: apiMux,
}
quit := make(chan os.Signal, 3)
signal.Notify(
quit,
syscall.SIGINT,
syscall.SIGTERM,
syscall.SIGHUP,
)
var wg sync.WaitGroup
wg.Add(2)
fmt.Printf("IPFS Gateway listening at %s\n\n", gatewayListen)
printIfListConfigured(" RAINBOW_GATEWAY_DOMAINS = ", cfg.GatewayDomains)
printIfListConfigured(" RAINBOW_SUBDOMAIN_GATEWAY_DOMAINS = ", cfg.SubdomainGatewayDomains)
printIfListConfigured(" RAINBOW_TRUSTLESS_GATEWAY_DOMAINS = ", cfg.TrustlessGatewayDomains)
printIfListConfigured(" RAINBOW_HTTP_ROUTERS = ", cfg.RoutingV1Endpoints)
printIfListConfigured(" RAINBOW_DNSLINK_RESOLVERS = ", customDNSResolvers)
printIfListConfigured(" RAINBOW_REMOTE_BACKENDS = ", cfg.RemoteBackends)
fmt.Printf("\n")
fmt.Printf("CTL endpoint listening at http://%s\n", ctlListen)
fmt.Printf(" Metrics: http://%s/debug/metrics/prometheus\n\n", ctlListen)
go func() {
defer wg.Done()
err := gatewaySrv.ListenAndServe()
if err != nil && !errors.Is(err, http.ErrServerClosed) {
fmt.Fprintf(os.Stderr, "Failed to start gateway: %s\n", err)
quit <- os.Interrupt
}
}()
_ = gnd.periodicGC(cctx.Context, cfg.GCThreshold)
go func() {
defer wg.Done()
err := apiSrv.ListenAndServe()
if err != nil && !errors.Is(err, http.ErrServerClosed) {
fmt.Fprintf(os.Stderr, "Failed to start metrics: %s\n", err)
quit <- os.Interrupt
}
}()
var gcTicker *time.Ticker
var gcTickerDone chan bool
if cfg.GCInterval > 0 {
gcTicker = time.NewTicker(cfg.GCInterval)
gcTickerDone = make(chan bool)
wg.Add(1)
go func() {
defer wg.Done()
for {
select {
case <-gcTickerDone:
return
case <-gcTicker.C:
err = gnd.periodicGC(cctx.Context, cfg.GCThreshold)
if err != nil {
goLog.Errorf("error when running periodic gc: %w", err)
}
}
}
}()
}
sddaemon.SdNotify(false, sddaemon.SdNotifyReady)
<-quit
sddaemon.SdNotify(false, sddaemon.SdNotifyStopping)
goLog.Info("Closing servers...")
go gatewaySrv.Close()
go apiSrv.Close()
if gcTicker != nil {
gcTicker.Stop()
gcTickerDone <- true
}
for _, sub := range gnd.denylistSubs {
sub.Stop()
}
wg.Wait()
return nil
}
if err := app.Run(os.Args); err != nil {
goLog.Error(err)
os.Exit(1)
}
}
func writeAllGoroutineStacks(w io.Writer) error {
buf := make([]byte, 64<<20)
for i := 0; ; i++ {
n := runtime.Stack(buf, true)
if n < len(buf) {
buf = buf[:n]
break
}
if len(buf) >= 1<<30 {
// Filled 1 GB - stop there.
break
}
buf = make([]byte, 2*len(buf))
}
_, err := w.Write(buf)
return err
}
func printIfListConfigured(message string, list []string) {
if len(list) > 0 {
fmt.Printf(message+"%v\n", strings.Join(list, ", "))
}
}
var rainbowSeedRegex = regexp.MustCompile(`/p2p/rainbow-seed/(\d+)`)
func replaceRainbowSeedWithPeer(addr string, seed string) (string, error) {
match := rainbowSeedRegex.FindStringSubmatch(addr)
if len(match) != 2 {
return addr, nil
}
index, err := strconv.Atoi(match[1])
if err != nil {
return "", err
}
priv, err := deriveKey(seed, deriveKeyInfo(index))
if err != nil {
return "", err
}
pid, err := peer.IDFromPublicKey(priv.GetPublic())
if err != nil {
return "", err
}
return strings.Replace(addr, match[0], "/p2p/"+pid.String(), 1), nil
}
func parseCustomDNSLinkResolvers(customDNSResolvers []string) (madns.BasicResolver, error) {
customDNSResolverMap := make(map[string]string)
for _, s := range customDNSResolvers {
split := strings.SplitN(s, ":", 2)
if len(split) != 2 {
return nil, fmt.Errorf("invalid DNS resolver: %s", s)
}
domain := strings.TrimSpace(split[0])
resolverUrl := strings.TrimSpace(split[1])
customDNSResolverMap[domain] = resolverUrl
}
dns, err := gateway.NewDNSResolver(customDNSResolverMap)
if err != nil {
return nil, err
}
return dns, nil
}