// Copyright 2019 The Waku Library Authors. // // The Waku library is free software: you can redistribute it and/or modify // it under the terms of the GNU Lesser General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // The Waku library is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty off // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU Lesser General Public License for more details. // // You should have received a copy of the GNU Lesser General Public License // along with the Waku library. If not, see . // // This software uses the go-ethereum library, which is licensed // under the GNU Lesser General Public Library, version 3 or any later. package wakuv2 import ( "context" "crypto/ecdsa" "crypto/sha256" "database/sql" "errors" "fmt" "math" "net" "runtime" "sort" "strings" "sync" "time" "github.com/libp2p/go-libp2p/core/peer" "github.com/libp2p/go-libp2p/p2p/protocol/identify" "github.com/multiformats/go-multiaddr" "go.uber.org/zap" mapset "github.com/deckarep/golang-set" "golang.org/x/crypto/pbkdf2" gethcommon "github.com/ethereum/go-ethereum/common" "github.com/ethereum/go-ethereum/common/hexutil" "github.com/ethereum/go-ethereum/crypto" "github.com/ethereum/go-ethereum/event" "github.com/ethereum/go-ethereum/p2p" "github.com/ethereum/go-ethereum/p2p/enode" "github.com/ethereum/go-ethereum/rpc" "github.com/libp2p/go-libp2p" pubsub "github.com/libp2p/go-libp2p-pubsub" "github.com/libp2p/go-libp2p/core/metrics" "github.com/waku-org/go-waku/waku/v2/dnsdisc" "github.com/waku-org/go-waku/waku/v2/peers" "github.com/waku-org/go-waku/waku/v2/protocol" "github.com/waku-org/go-waku/waku/v2/protocol/filter" "github.com/waku-org/go-waku/waku/v2/protocol/peer_exchange" "github.com/waku-org/go-waku/waku/v2/protocol/relay" "github.com/status-im/status-go/connection" "github.com/status-im/status-go/eth-node/types" "github.com/status-im/status-go/signal" "github.com/status-im/status-go/timesource" "github.com/status-im/status-go/wakuv2/common" "github.com/status-im/status-go/wakuv2/persistence" node "github.com/waku-org/go-waku/waku/v2/node" "github.com/waku-org/go-waku/waku/v2/protocol/pb" "github.com/waku-org/go-waku/waku/v2/protocol/store" storepb "github.com/waku-org/go-waku/waku/v2/protocol/store/pb" ) const messageQueueLimit = 1024 const requestTimeout = 30 * time.Second const bootnodesQueryBackoffMs = 200 const bootnodesMaxRetries = 7 type settings struct { LightClient bool // Indicates if the node is a light client MinPeersForRelay int // Indicates the minimum number of peers required for using Relay Protocol MinPeersForFilter int // Indicates the minimum number of peers required for using Filter Protocol MaxMsgSize uint32 // Maximal message length allowed by the waku node EnableConfirmations bool // Enable sending message confirmations PeerExchange bool // Enable peer exchange DiscoveryLimit int // Indicates the number of nodes to discover Nameserver string // Optional nameserver to use for dns discovery EnableDiscV5 bool // Indicates whether discv5 is enabled or not Options []node.WakuNodeOption } // Waku represents a dark communication interface through the Ethereum // network, using its very own P2P communication layer. type Waku struct { node *node.WakuNode // reference to a libp2p waku node identifyService identify.IDService appDB *sql.DB dnsAddressCache map[string][]dnsdisc.DiscoveredNode // Map to store the multiaddresses returned by dns discovery dnsAddressCacheLock *sync.RWMutex // lock to handle access to the map // Filter-related filters *common.Filters // Message filters installed with Subscribe function filterSubscriptions map[*common.Filter]map[string]*filter.SubscriptionDetails // wakuv2 filter subscription details filterPeerDisconnectMap map[peer.ID]int64 isFilterSubAlive func(sub *filter.SubscriptionDetails) error privateKeys map[string]*ecdsa.PrivateKey // Private key storage symKeys map[string][]byte // Symmetric key storage keyMu sync.RWMutex // Mutex associated with key stores envelopes map[gethcommon.Hash]*common.ReceivedMessage // Pool of envelopes currently tracked by this node expirations map[uint32]mapset.Set // Message expiration pool poolMu sync.RWMutex // Mutex to sync the message and expiration pools bandwidthCounter *metrics.BandwidthCounter sendQueue chan *protocol.Envelope msgQueue chan *common.ReceivedMessage // Message queue for waku messages that havent been decoded quit chan struct{} // Channel used for graceful exit wg sync.WaitGroup cfg *Config settings settings // Holds configuration settings that can be dynamically changed settingsMu sync.RWMutex // Mutex to sync the settings access envelopeFeed event.Feed storeMsgIDs map[gethcommon.Hash]bool // Map of the currently processing ids storeMsgIDsMu sync.RWMutex connStatusChan chan node.ConnStatus connStatusSubscriptions map[string]*types.ConnStatusSubscription connStatusMu sync.Mutex logger *zap.Logger // NTP Synced timesource timesource *timesource.NTPTimeSource // seededBootnodesForDiscV5 indicates whether we manage to retrieve discovery // bootnodes successfully seededBootnodesForDiscV5 bool // offline indicates whether we have detected connectivity offline bool // connectionChanged is channel that notifies when connectivity has changed connectionChanged chan struct{} // discV5BootstrapNodes is the ENR to be used to fetch bootstrap nodes for discovery discV5BootstrapNodes []string } func getUsableUDPPort() (int, error) { conn, err := net.ListenUDP("udp", &net.UDPAddr{ IP: net.IPv4zero, Port: 0, }) if err != nil { return 0, err } defer conn.Close() return conn.LocalAddr().(*net.UDPAddr).Port, nil } // New creates a WakuV2 client ready to communicate through the LibP2P network. func New(nodeKey string, fleet string, cfg *Config, logger *zap.Logger, appDB *sql.DB, ts *timesource.NTPTimeSource) (*Waku, error) { var err error if logger == nil { logger, err = zap.NewDevelopment() if err != nil { return nil, err } } if ts == nil { ts = timesource.Default() } cfg = setDefaults(cfg) if cfg.UDPPort == 0 { cfg.UDPPort, err = getUsableUDPPort() if err != nil { return nil, err } } logger.Debug("starting wakuv2 with config", zap.Any("config", cfg)) waku := &Waku{ appDB: appDB, cfg: cfg, privateKeys: make(map[string]*ecdsa.PrivateKey), symKeys: make(map[string][]byte), envelopes: make(map[gethcommon.Hash]*common.ReceivedMessage), expirations: make(map[uint32]mapset.Set), msgQueue: make(chan *common.ReceivedMessage, messageQueueLimit), sendQueue: make(chan *protocol.Envelope, 1000), connStatusChan: make(chan node.ConnStatus, 100), connStatusSubscriptions: make(map[string]*types.ConnStatusSubscription), wg: sync.WaitGroup{}, dnsAddressCache: make(map[string][]dnsdisc.DiscoveredNode), dnsAddressCacheLock: &sync.RWMutex{}, storeMsgIDs: make(map[gethcommon.Hash]bool), filterPeerDisconnectMap: make(map[peer.ID]int64), filterSubscriptions: make(map[*common.Filter]map[string]*filter.SubscriptionDetails), timesource: ts, storeMsgIDsMu: sync.RWMutex{}, logger: logger, discV5BootstrapNodes: cfg.DiscV5BootstrapNodes, } // This fn is being mocked in test waku.isFilterSubAlive = func(sub *filter.SubscriptionDetails) error { return waku.node.FilterLightnode().IsSubscriptionAlive(context.Background(), sub) } waku.settings = settings{ MaxMsgSize: cfg.MaxMessageSize, LightClient: cfg.LightClient, MinPeersForRelay: cfg.MinPeersForRelay, MinPeersForFilter: cfg.MinPeersForFilter, PeerExchange: cfg.PeerExchange, DiscoveryLimit: cfg.DiscoveryLimit, Nameserver: cfg.Nameserver, EnableDiscV5: cfg.EnableDiscV5, } waku.filters = common.NewFilters() waku.bandwidthCounter = metrics.NewBandwidthCounter() var privateKey *ecdsa.PrivateKey if nodeKey != "" { privateKey, err = crypto.HexToECDSA(nodeKey) } else { // If no nodekey is provided, create an ephemeral key privateKey, err = crypto.GenerateKey() } if err != nil { return nil, fmt.Errorf("failed to setup the go-waku private key: %v", err) } hostAddr, err := net.ResolveTCPAddr("tcp", fmt.Sprint(cfg.Host, ":", cfg.Port)) if err != nil { return nil, fmt.Errorf("failed to setup the network interface: %v", err) } if cfg.KeepAliveInterval == 0 { cfg.KeepAliveInterval = DefaultConfig.KeepAliveInterval } libp2pOpts := node.DefaultLibP2POptions libp2pOpts = append(libp2pOpts, libp2p.BandwidthReporter(waku.bandwidthCounter)) libp2pOpts = append(libp2pOpts, libp2p.NATPortMap()) opts := []node.WakuNodeOption{ node.WithLibP2POptions(libp2pOpts...), node.WithPrivateKey(privateKey), node.WithHostAddress(hostAddr), node.WithConnectionStatusChannel(waku.connStatusChan), node.WithKeepAlive(time.Duration(cfg.KeepAliveInterval) * time.Second), node.WithDiscoverParams(cfg.DiscoveryLimit), node.WithLogger(logger), } if cfg.EnableDiscV5 { bootnodes, err := waku.getDiscV5BootstrapNodes(context.Background(), cfg.DiscV5BootstrapNodes) if err != nil { logger.Error("failed to get bootstrap nodes", zap.Error(err)) return nil, err } opts = append(opts, node.WithDiscoveryV5(uint(cfg.UDPPort), bootnodes, cfg.AutoUpdate)) } if cfg.LightClient { opts = append(opts, node.WithWakuFilterLightNode()) } else { relayOpts := []pubsub.Option{ pubsub.WithMaxMessageSize(int(waku.settings.MaxMsgSize)), } opts = append(opts, node.WithWakuRelayAndMinPeers(waku.settings.MinPeersForRelay, relayOpts...)) } if cfg.EnableStore { opts = append(opts, node.WithWakuStore()) dbStore, err := persistence.NewDBStore(logger, persistence.WithDB(appDB), persistence.WithRetentionPolicy(cfg.StoreCapacity, time.Duration(cfg.StoreSeconds)*time.Second)) if err != nil { return nil, err } opts = append(opts, node.WithMessageProvider(dbStore)) } waku.settings.Options = opts waku.logger.Info("setup the go-waku node successfully") return waku, nil } func (w *Waku) SubscribeToConnStatusChanges() *types.ConnStatusSubscription { w.connStatusMu.Lock() defer w.connStatusMu.Unlock() subscription := types.NewConnStatusSubscription() w.connStatusSubscriptions[subscription.ID] = subscription return subscription } func (w *Waku) getDiscV5BootstrapNodes(ctx context.Context, addresses []string) ([]*enode.Node, error) { wg := sync.WaitGroup{} mu := sync.Mutex{} var result []*enode.Node retrieveENR := func(d dnsdisc.DiscoveredNode, wg *sync.WaitGroup) { mu.Lock() defer mu.Unlock() defer wg.Done() if d.ENR != nil { result = append(result, d.ENR) } } for _, addrString := range addresses { if addrString == "" { continue } if strings.HasPrefix(addrString, "enrtree://") { // Use DNS Discovery wg.Add(1) go func(addr string) { defer wg.Done() w.dnsDiscover(ctx, addr, retrieveENR) }(addrString) } else { // It's a normal enr bootnode, err := enode.Parse(enode.ValidSchemes, addrString) if err != nil { return nil, err } result = append(result, bootnode) } } wg.Wait() w.seededBootnodesForDiscV5 = len(result) > 0 return result, nil } type fnApplyToEachPeer func(d dnsdisc.DiscoveredNode, wg *sync.WaitGroup) func (w *Waku) dnsDiscover(ctx context.Context, enrtreeAddress string, apply fnApplyToEachPeer) { w.logger.Info("retrieving nodes", zap.String("enr", enrtreeAddress)) ctx, cancel := context.WithTimeout(ctx, requestTimeout) defer cancel() w.dnsAddressCacheLock.Lock() defer w.dnsAddressCacheLock.Unlock() discNodes, ok := w.dnsAddressCache[enrtreeAddress] if !ok { w.settingsMu.RLock() nameserver := w.settings.Nameserver w.settingsMu.RUnlock() var opts []dnsdisc.DnsDiscoveryOption if nameserver != "" { opts = append(opts, dnsdisc.WithNameserver(nameserver)) } discoveredNodes, err := dnsdisc.RetrieveNodes(ctx, enrtreeAddress, opts...) if err != nil { w.logger.Warn("dns discovery error ", zap.Error(err)) return } if len(discoveredNodes) != 0 { w.dnsAddressCache[enrtreeAddress] = append(w.dnsAddressCache[enrtreeAddress], discoveredNodes...) discNodes = w.dnsAddressCache[enrtreeAddress] } } wg := &sync.WaitGroup{} wg.Add(len(discNodes)) for _, d := range discNodes { apply(d, wg) } wg.Wait() } func (w *Waku) addWakuV2Peers(ctx context.Context, cfg *Config) error { fnApply := func(d dnsdisc.DiscoveredNode, wg *sync.WaitGroup) { if len(d.PeerInfo.Addrs) != 0 { go func(ma multiaddr.Multiaddr) { w.identifyAndConnect(ctx, w.settings.LightClient, ma) wg.Done() }(d.PeerInfo.Addrs[0]) } } identifyWg := &sync.WaitGroup{} identifyWg.Add(len(cfg.WakuNodes)) for _, addrString := range cfg.WakuNodes { addrString := addrString if strings.HasPrefix(addrString, "enrtree://") { // Use DNS Discovery go func() { w.dnsDiscover(ctx, addrString, fnApply) identifyWg.Done() }() } else { // It is a normal multiaddress addr, err := multiaddr.NewMultiaddr(addrString) if err != nil { w.logger.Warn("invalid peer multiaddress", zap.String("ma", addrString), zap.Error(err)) continue } go func(ma multiaddr.Multiaddr) { w.identifyAndConnect(ctx, cfg.LightClient, ma) identifyWg.Done() }(addr) } } identifyWg.Wait() return nil } func (w *Waku) identifyAndConnect(ctx context.Context, isLightClient bool, ma multiaddr.Multiaddr) { peerInfo, err := peer.AddrInfoFromP2pAddr(ma) if err != nil { w.logger.Warn("invalid peer multiaddress", zap.String("addr", ma.String()), zap.Error(err)) return } ctx, cancel := context.WithTimeout(ctx, 3*time.Second) defer cancel() err = w.node.Host().Connect(ctx, *peerInfo) if err != nil { w.logger.Error("could not extract peerinfo", zap.String("ma", ma.String()), zap.Error(err)) return } conns := w.node.Host().Network().ConnsToPeer(peerInfo.ID) if len(conns) == 0 { return // No connection } w.identifyService.IdentifyConn(conns[0]) if isLightClient { err = w.node.Host().Network().ClosePeer(peerInfo.ID) if err != nil { w.logger.Error("could not close connections to peer", zap.Any("peer", peerInfo.ID), zap.Error(err)) } return } supportedProtocols, err := w.node.Host().Peerstore().SupportsProtocols(peerInfo.ID, relay.WakuRelayID_v200) if err != nil { w.logger.Error("could not obtain protocols", zap.Any("peer", peerInfo.ID), zap.Error(err)) return } if len(supportedProtocols) == 0 { err = w.node.Host().Network().ClosePeer(peerInfo.ID) if err != nil { w.logger.Error("could not close connections to peer", zap.Any("peer", peerInfo.ID), zap.Error(err)) } } } func (w *Waku) telemetryBandwidthStats(telemetryServerURL string) { if telemetryServerURL == "" { return } telemetry := NewBandwidthTelemetryClient(w.logger, telemetryServerURL) ticker := time.NewTicker(time.Second * 20) defer ticker.Stop() today := time.Now() for { select { case <-w.quit: return case now := <-ticker.C: // Reset totals when day changes if now.Day() != today.Day() { today = now w.bandwidthCounter.Reset() } storeStats := w.bandwidthCounter.GetBandwidthForProtocol(store.StoreID_v20beta4) relayStats := w.bandwidthCounter.GetBandwidthForProtocol(relay.WakuRelayID_v200) go telemetry.PushProtocolStats(relayStats, storeStats) } } } func (w *Waku) GetStats() types.StatsSummary { stats := w.bandwidthCounter.GetBandwidthTotals() return types.StatsSummary{ UploadRate: uint64(stats.RateOut), DownloadRate: uint64(stats.RateIn), } } func (w *Waku) runPeerExchangeLoop() { defer w.wg.Done() if !w.settings.PeerExchange || !w.settings.LightClient { // Currently peer exchange is only used for full nodes // TODO: should it be used for lightpush? or lightpush nodes // are only going to be selected from a specific set of peers? return } ticker := time.NewTicker(time.Second * 5) defer ticker.Stop() for { select { case <-w.quit: return case <-ticker.C: w.logger.Debug("Running peer exchange loop") connectedPeers := w.node.Host().Network().Peers() peersWithRelay := 0 for _, p := range connectedPeers { supportedProtocols, err := w.node.Host().Peerstore().SupportsProtocols(p, relay.WakuRelayID_v200) if err != nil { continue } if len(supportedProtocols) != 0 { peersWithRelay++ } } peersToDiscover := w.settings.DiscoveryLimit - peersWithRelay if peersToDiscover <= 0 { continue } // We select only the nodes discovered via DNS Discovery that support peer exchange w.dnsAddressCacheLock.RLock() var withThesePeers []peer.ID for _, record := range w.dnsAddressCache { for _, discoveredNode := range record { if len(discoveredNode.PeerInfo.Addrs) == 0 { continue } // Obtaining peer ID peerIDString, err := discoveredNode.PeerInfo.Addrs[0].ValueForProtocol(multiaddr.P_P2P) if err != nil { w.logger.Warn("multiaddress does not contain peerID", zap.String("multiaddr", discoveredNode.PeerInfo.Addrs[0].String())) continue // No peer ID available somehow } peerID, err := peer.Decode(peerIDString) if err != nil { w.logger.Warn("couldnt decode peerID", zap.String("peerIDString", peerIDString)) continue // Couldnt decode the peerID for some reason? } supportsProtocol, _ := w.node.Host().Peerstore().SupportsProtocols(peerID, peer_exchange.PeerExchangeID_v20alpha1) if len(supportsProtocol) != 0 { withThesePeers = append(withThesePeers, peerID) } } } w.dnsAddressCacheLock.RUnlock() if len(withThesePeers) == 0 { continue // No peers with peer exchange have been discovered via DNS Discovery so far, skip this iteration } err := w.node.PeerExchange().Request(context.Background(), peersToDiscover, peer_exchange.WithAutomaticPeerSelection(withThesePeers...)) if err != nil { w.logger.Error("couldnt request peers via peer exchange", zap.Error(err)) } } } } func (w *Waku) runRelayMsgLoop() { defer w.wg.Done() if w.settings.LightClient { return } sub, err := w.node.Relay().Subscribe(context.Background()) if err != nil { fmt.Println("Could not subscribe:", err) return } for { select { case <-w.quit: sub.Unsubscribe() return case env := <-sub.Ch: envelopeErrors, err := w.OnNewEnvelopes(env, common.RelayedMessageType) if err != nil { w.logger.Error("onNewEnvelope error", zap.Error(err)) } // TODO: should these be handled? _ = envelopeErrors _ = err } } } func (w *Waku) runFilterSubscriptionLoop(sub *filter.SubscriptionDetails) { for { select { case <-w.quit: return case env, ok := <-sub.C: if ok { envelopeErrors, err := w.OnNewEnvelopes(env, common.RelayedMessageType) // TODO: should these be handled? _ = envelopeErrors _ = err } else { return } } } } func (w *Waku) runFilterMsgLoop() { defer w.wg.Done() if !w.settings.LightClient { return } // Use it to ping filter peer(s) periodically ticker := time.NewTicker(time.Duration(w.cfg.KeepAliveInterval) * time.Second) defer ticker.Stop() for { select { case <-w.quit: return case <-ticker.C: for f, subMap := range w.filterSubscriptions { if len(subMap) == 0 { // All peers have disconnected on previous iteration, // attempt full reconnect err := w.subscribeToFilter(f) if err != nil { w.logger.Error("Failed to subscribe to filter") } break } for id, sub := range subMap { err := w.isFilterSubAlive(sub) if err != nil { // Unsubscribe on light node contentFilter := w.buildContentFilter(f.Topics) // TODO Better return value handling for WakuFilterPushResult _, err := w.node.FilterLightnode().Unsubscribe(context.Background(), contentFilter, filter.Peer(sub.PeerID)) if err != nil { w.logger.Warn("could not unsubscribe wakuv2 filter for peer", zap.Any("peer", sub.PeerID)) continue } // Remove entry from maps w.filterPeerDisconnectMap[sub.PeerID] = time.Now().Unix() delete(subMap, id) // Re-subscribe peers := w.findFilterPeers() if len(peers) > 0 && len(subMap) < w.settings.MinPeersForFilter { subDetails, err := w.node.FilterLightnode().Subscribe(context.Background(), contentFilter, filter.WithPeer(peers[0])) if err != nil { w.logger.Warn("could not add wakuv2 filter for peer", zap.Any("peer", peers[0])) break } subMap[subDetails.ID] = subDetails go w.runFilterSubscriptionLoop(subDetails) break } } } } } } } func (w *Waku) buildContentFilter(topics [][]byte) filter.ContentFilter { contentFilter := filter.ContentFilter{ Topic: relay.DefaultWakuTopic, } for _, topic := range topics { contentFilter.ContentTopics = append(contentFilter.ContentTopics, common.BytesToTopic(topic).ContentTopic()) } return contentFilter } // MaxMessageSize returns the maximum accepted message size. func (w *Waku) MaxMessageSize() uint32 { w.settingsMu.RLock() defer w.settingsMu.RUnlock() return w.settings.MaxMsgSize } // ConfirmationsEnabled returns true if message confirmations are enabled. func (w *Waku) ConfirmationsEnabled() bool { w.settingsMu.RLock() defer w.settingsMu.RUnlock() return w.settings.EnableConfirmations } // CurrentTime returns current time. func (w *Waku) CurrentTime() time.Time { return w.timesource.Now() } // APIs returns the RPC descriptors the Waku implementation offers func (w *Waku) APIs() []rpc.API { return []rpc.API{ { Namespace: Name, Version: VersionStr, Service: NewPublicWakuAPI(w), Public: false, }, } } // Protocols returns the waku sub-protocols ran by this particular client. func (w *Waku) Protocols() []p2p.Protocol { return []p2p.Protocol{} } func (w *Waku) SendEnvelopeEvent(event common.EnvelopeEvent) int { return w.envelopeFeed.Send(event) } // SubscribeEnvelopeEvents subscribes to envelopes feed. // In order to prevent blocking waku producers events must be amply buffered. func (w *Waku) SubscribeEnvelopeEvents(events chan<- common.EnvelopeEvent) event.Subscription { return w.envelopeFeed.Subscribe(events) } // NewKeyPair generates a new cryptographic identity for the client, and injects // it into the known identities for message decryption. Returns ID of the new key pair. func (w *Waku) NewKeyPair() (string, error) { key, err := crypto.GenerateKey() if err != nil || !validatePrivateKey(key) { key, err = crypto.GenerateKey() // retry once } if err != nil { return "", err } if !validatePrivateKey(key) { return "", fmt.Errorf("failed to generate valid key") } id, err := toDeterministicID(hexutil.Encode(crypto.FromECDSAPub(&key.PublicKey)), common.KeyIDSize) if err != nil { return "", err } w.keyMu.Lock() defer w.keyMu.Unlock() if w.privateKeys[id] != nil { return "", fmt.Errorf("failed to generate unique ID") } w.privateKeys[id] = key return id, nil } // DeleteKeyPair deletes the specified key if it exists. func (w *Waku) DeleteKeyPair(key string) bool { deterministicID, err := toDeterministicID(key, common.KeyIDSize) if err != nil { return false } w.keyMu.Lock() defer w.keyMu.Unlock() if w.privateKeys[deterministicID] != nil { delete(w.privateKeys, deterministicID) return true } return false } // AddKeyPair imports a asymmetric private key and returns it identifier. func (w *Waku) AddKeyPair(key *ecdsa.PrivateKey) (string, error) { id, err := makeDeterministicID(hexutil.Encode(crypto.FromECDSAPub(&key.PublicKey)), common.KeyIDSize) if err != nil { return "", err } if w.HasKeyPair(id) { return id, nil // no need to re-inject } w.keyMu.Lock() w.privateKeys[id] = key w.keyMu.Unlock() return id, nil } // SelectKeyPair adds cryptographic identity, and makes sure // that it is the only private key known to the node. func (w *Waku) SelectKeyPair(key *ecdsa.PrivateKey) error { id, err := makeDeterministicID(hexutil.Encode(crypto.FromECDSAPub(&key.PublicKey)), common.KeyIDSize) if err != nil { return err } w.keyMu.Lock() defer w.keyMu.Unlock() w.privateKeys = make(map[string]*ecdsa.PrivateKey) // reset key store w.privateKeys[id] = key return nil } // DeleteKeyPairs removes all cryptographic identities known to the node func (w *Waku) DeleteKeyPairs() error { w.keyMu.Lock() defer w.keyMu.Unlock() w.privateKeys = make(map[string]*ecdsa.PrivateKey) return nil } // HasKeyPair checks if the waku node is configured with the private key // of the specified public pair. func (w *Waku) HasKeyPair(id string) bool { deterministicID, err := toDeterministicID(id, common.KeyIDSize) if err != nil { return false } w.keyMu.RLock() defer w.keyMu.RUnlock() return w.privateKeys[deterministicID] != nil } // GetPrivateKey retrieves the private key of the specified identity. func (w *Waku) GetPrivateKey(id string) (*ecdsa.PrivateKey, error) { deterministicID, err := toDeterministicID(id, common.KeyIDSize) if err != nil { return nil, err } w.keyMu.RLock() defer w.keyMu.RUnlock() key := w.privateKeys[deterministicID] if key == nil { return nil, fmt.Errorf("invalid id") } return key, nil } // GenerateSymKey generates a random symmetric key and stores it under id, // which is then returned. Will be used in the future for session key exchange. func (w *Waku) GenerateSymKey() (string, error) { key, err := common.GenerateSecureRandomData(common.AESKeyLength) if err != nil { return "", err } else if !common.ValidateDataIntegrity(key, common.AESKeyLength) { return "", fmt.Errorf("error in GenerateSymKey: crypto/rand failed to generate random data") } id, err := common.GenerateRandomID() if err != nil { return "", fmt.Errorf("failed to generate ID: %s", err) } w.keyMu.Lock() defer w.keyMu.Unlock() if w.symKeys[id] != nil { return "", fmt.Errorf("failed to generate unique ID") } w.symKeys[id] = key return id, nil } // AddSymKey stores the key with a given id. func (w *Waku) AddSymKey(id string, key []byte) (string, error) { deterministicID, err := toDeterministicID(id, common.KeyIDSize) if err != nil { return "", err } w.keyMu.Lock() defer w.keyMu.Unlock() if w.symKeys[deterministicID] != nil { return "", fmt.Errorf("key already exists: %v", id) } w.symKeys[deterministicID] = key return deterministicID, nil } // AddSymKeyDirect stores the key, and returns its id. func (w *Waku) AddSymKeyDirect(key []byte) (string, error) { if len(key) != common.AESKeyLength { return "", fmt.Errorf("wrong key size: %d", len(key)) } id, err := common.GenerateRandomID() if err != nil { return "", fmt.Errorf("failed to generate ID: %s", err) } w.keyMu.Lock() defer w.keyMu.Unlock() if w.symKeys[id] != nil { return "", fmt.Errorf("failed to generate unique ID") } w.symKeys[id] = key return id, nil } // AddSymKeyFromPassword generates the key from password, stores it, and returns its id. func (w *Waku) AddSymKeyFromPassword(password string) (string, error) { id, err := common.GenerateRandomID() if err != nil { return "", fmt.Errorf("failed to generate ID: %s", err) } if w.HasSymKey(id) { return "", fmt.Errorf("failed to generate unique ID") } // kdf should run no less than 0.1 seconds on an average computer, // because it's an once in a session experience derived := pbkdf2.Key([]byte(password), nil, 65356, common.AESKeyLength, sha256.New) w.keyMu.Lock() defer w.keyMu.Unlock() // double check is necessary, because deriveKeyMaterial() is very slow if w.symKeys[id] != nil { return "", fmt.Errorf("critical error: failed to generate unique ID") } w.symKeys[id] = derived return id, nil } // HasSymKey returns true if there is a key associated with the given id. // Otherwise returns false. func (w *Waku) HasSymKey(id string) bool { w.keyMu.RLock() defer w.keyMu.RUnlock() return w.symKeys[id] != nil } // DeleteSymKey deletes the key associated with the name string if it exists. func (w *Waku) DeleteSymKey(id string) bool { w.keyMu.Lock() defer w.keyMu.Unlock() if w.symKeys[id] != nil { delete(w.symKeys, id) return true } return false } // GetSymKey returns the symmetric key associated with the given id. func (w *Waku) GetSymKey(id string) ([]byte, error) { w.keyMu.RLock() defer w.keyMu.RUnlock() if w.symKeys[id] != nil { return w.symKeys[id], nil } return nil, fmt.Errorf("non-existent key ID") } // Subscribe installs a new message handler used for filtering, decrypting // and subsequent storing of incoming messages. func (w *Waku) Subscribe(f *common.Filter) (string, error) { s, err := w.filters.Install(f) if err != nil { return s, err } if w.settings.LightClient { go func() { ticker := time.NewTicker(1 * time.Second) for range ticker.C { err := w.subscribeToFilter(f) if err == nil { break } } }() } return s, nil } // Unsubscribe removes an installed message handler. func (w *Waku) Unsubscribe(id string) error { f := w.filters.Get(id) if f != nil && w.settings.LightClient { contentFilter := w.buildContentFilter(f.Topics) if _, err := w.node.FilterLightnode().Unsubscribe(context.Background(), contentFilter); err != nil { return fmt.Errorf("failed to unsubscribe: %w", err) } } ok := w.filters.Uninstall(id) if !ok { return fmt.Errorf("failed to unsubscribe: invalid ID '%s'", id) } return nil } // GetFilter returns the filter by id. func (w *Waku) GetFilter(id string) *common.Filter { return w.filters.Get(id) } // Unsubscribe removes an installed message handler. func (w *Waku) UnsubscribeMany(ids []string) error { for _, id := range ids { w.logger.Debug("cleaning up filter", zap.String("id", id)) ok := w.filters.Uninstall(id) if !ok { w.logger.Warn("could not remove filter with id", zap.String("id", id)) } } return nil } func (w *Waku) broadcast() { for { select { case envelope := <-w.sendQueue: var err error if w.settings.LightClient { w.logger.Info("publishing message via lightpush", zap.String("envelopeHash", hexutil.Encode(envelope.Hash()))) _, err = w.node.Lightpush().Publish(context.Background(), envelope.Message()) } else { w.logger.Info("publishing message via relay", zap.String("envelopeHash", hexutil.Encode(envelope.Hash()))) _, err = w.node.Relay().Publish(context.Background(), envelope.Message()) } if err != nil { w.logger.Error("could not send message", zap.String("envelopeHash", hexutil.Encode(envelope.Hash())), zap.Error(err)) w.envelopeFeed.Send(common.EnvelopeEvent{ Hash: gethcommon.BytesToHash(envelope.Hash()), Event: common.EventEnvelopeExpired, }) continue } event := common.EnvelopeEvent{ Event: common.EventEnvelopeSent, Hash: gethcommon.BytesToHash(envelope.Hash()), } w.SendEnvelopeEvent(event) case <-w.quit: return } } } // Send injects a message into the waku send queue, to be distributed in the // network in the coming cycles. func (w *Waku) Send(msg *pb.WakuMessage) ([]byte, error) { envelope := protocol.NewEnvelope(msg, msg.Timestamp, relay.DefaultWakuTopic) // TODO: once sharding is defined, use the correct pubsub topic w.sendQueue <- envelope w.poolMu.Lock() _, alreadyCached := w.envelopes[gethcommon.BytesToHash(envelope.Hash())] w.poolMu.Unlock() if !alreadyCached { recvMessage := common.NewReceivedMessage(envelope, common.RelayedMessageType) w.postEvent(recvMessage) // notify the local node about the new message w.addEnvelope(recvMessage) } return envelope.Hash(), nil } func (w *Waku) query(ctx context.Context, peerID peer.ID, topics []common.TopicType, from uint64, to uint64, opts []store.HistoryRequestOption) (*store.Result, error) { strTopics := make([]string, len(topics)) for i, t := range topics { strTopics[i] = t.ContentTopic() } opts = append(opts, store.WithPeer(peerID)) query := store.Query{ StartTime: int64(from) * int64(time.Second), EndTime: int64(to) * int64(time.Second), ContentTopics: strTopics, Topic: relay.DefaultWakuTopic, } return w.node.Store().Query(ctx, query, opts...) } func (w *Waku) Query(ctx context.Context, peerID peer.ID, topics []common.TopicType, from uint64, to uint64, opts []store.HistoryRequestOption) (cursor *storepb.Index, err error) { requestID := protocol.GenerateRequestId() opts = append(opts, store.WithRequestId(requestID)) result, err := w.query(ctx, peerID, topics, from, to, opts) if err != nil { w.logger.Error("error querying storenode", zap.String("requestID", hexutil.Encode(requestID)), zap.String("peerID", peerID.String()), zap.Error(err)) signal.SendHistoricMessagesRequestFailed(requestID, peerID, err) return nil, err } for _, msg := range result.Messages { // Temporarily setting RateLimitProof to nil so it matches the WakuMessage protobuffer we are sending // See https://github.com/vacp2p/rfc/issues/563 msg.RateLimitProof = nil envelope := protocol.NewEnvelope(msg, msg.Timestamp, relay.DefaultWakuTopic) w.logger.Info("received waku2 store message", zap.Any("envelopeHash", hexutil.Encode(envelope.Hash()))) _, err = w.OnNewEnvelopes(envelope, common.StoreMessageType) if err != nil { return nil, err } } if !result.IsComplete() { cursor = result.Cursor() } return } // Start implements node.Service, starting the background data propagation thread // of the Waku protocol. func (w *Waku) Start() error { var err error if w.node, err = node.New(w.settings.Options...); err != nil { return fmt.Errorf("failed to create a go-waku node: %v", err) } w.quit = make(chan struct{}) w.connectionChanged = make(chan struct{}) ctx := context.Background() if err = w.node.Start(ctx); err != nil { return fmt.Errorf("failed to start go-waku node: %v", err) } idService, err := identify.NewIDService(w.node.Host()) if err != nil { return err } w.identifyService = idService if err = w.addWakuV2Peers(ctx, w.cfg); err != nil { return fmt.Errorf("failed to add wakuv2 peers: %v", err) } if w.cfg.EnableDiscV5 { err := w.node.DiscV5().Start(ctx) if err != nil { return err } } w.wg.Add(4) go func() { defer w.wg.Done() isConnected := false for { select { case <-w.quit: return case c := <-w.connStatusChan: w.connStatusMu.Lock() latestConnStatus := formatConnStatus(w.node, c) for k, subs := range w.connStatusSubscriptions { if subs.Active() { subs.C <- latestConnStatus } else { delete(w.connStatusSubscriptions, k) } } w.connStatusMu.Unlock() signal.SendPeerStats(latestConnStatus) if w.cfg.EnableDiscV5 { // Restarting DiscV5 if !latestConnStatus.IsOnline && isConnected { w.logger.Debug("Restarting DiscV5: offline and is connected") isConnected = false w.node.DiscV5().Stop() } else if latestConnStatus.IsOnline && !isConnected { w.logger.Debug("Restarting DiscV5: online and is not connected") isConnected = true if !w.node.DiscV5().IsStarted() { err := w.node.DiscV5().Start(ctx) if err != nil { w.logger.Error("Could not start DiscV5", zap.Error(err)) } } } } } } }() go w.telemetryBandwidthStats(w.cfg.TelemetryServerURL) go w.runFilterMsgLoop() go w.runRelayMsgLoop() go w.runPeerExchangeLoop() numCPU := runtime.NumCPU() for i := 0; i < numCPU; i++ { go w.processQueue() } go w.broadcast() go w.seedBootnodesForDiscV5() return nil } // Stop implements node.Service, stopping the background data propagation thread // of the Waku protocol. func (w *Waku) Stop() error { close(w.quit) w.identifyService.Close() w.node.Stop() close(w.connectionChanged) w.wg.Wait() return nil } func (w *Waku) OnNewEnvelopes(envelope *protocol.Envelope, msgType common.MessageType) ([]common.EnvelopeError, error) { if envelope == nil { return nil, nil } recvMessage := common.NewReceivedMessage(envelope, msgType) if recvMessage == nil { return nil, nil } envelopeErrors := make([]common.EnvelopeError, 0) logger := w.logger.With(zap.String("hash", recvMessage.Hash().Hex())) logger.Debug("received new envelope") trouble := false _, err := w.add(recvMessage) if err != nil { logger.Info("invalid envelope received", zap.Error(err)) trouble = true } common.EnvelopesValidatedCounter.Inc() if trouble { return envelopeErrors, errors.New("received invalid envelope") } return envelopeErrors, nil } // addEnvelope adds an envelope to the envelope map, used for sending func (w *Waku) addEnvelope(envelope *common.ReceivedMessage) { hash := envelope.Hash() w.poolMu.Lock() w.envelopes[hash] = envelope w.poolMu.Unlock() } func (w *Waku) add(recvMessage *common.ReceivedMessage) (bool, error) { common.EnvelopesReceivedCounter.Inc() hash := recvMessage.Hash() w.poolMu.Lock() _, alreadyCached := w.envelopes[hash] w.poolMu.Unlock() if !alreadyCached { w.addEnvelope(recvMessage) } if alreadyCached { w.logger.Debug("w envelope already cached", zap.String("envelopeHash", recvMessage.Hash().Hex())) common.EnvelopesCachedCounter.WithLabelValues("hit").Inc() } else { w.logger.Debug("cached w envelope", zap.String("envelopeHash", recvMessage.Hash().Hex())) common.EnvelopesCachedCounter.WithLabelValues("miss").Inc() common.EnvelopesSizeMeter.Observe(float64(len(recvMessage.Envelope.Message().Payload))) w.postEvent(recvMessage) // notify the local node about the new message } return true, nil } // postEvent queues the message for further processing. func (w *Waku) postEvent(envelope *common.ReceivedMessage) { w.msgQueue <- envelope } // processQueue delivers the messages to the watchers during the lifetime of the waku node. func (w *Waku) processQueue() { for { select { case <-w.quit: return case e := <-w.msgQueue: if e.MsgType == common.StoreMessageType { // We need to insert it first, and then remove it if not matched, // as messages are processed asynchronously w.storeMsgIDsMu.Lock() w.storeMsgIDs[e.Hash()] = true w.storeMsgIDsMu.Unlock() } matched := w.filters.NotifyWatchers(e) // If not matched we remove it if !matched { w.logger.Debug("filters did not match", zap.String("hash", e.Hash().String()), zap.String("contentTopic", e.Topic.ContentTopic())) w.storeMsgIDsMu.Lock() delete(w.storeMsgIDs, e.Hash()) w.storeMsgIDsMu.Unlock() } w.envelopeFeed.Send(common.EnvelopeEvent{ Topic: e.Topic, Hash: e.Hash(), Event: common.EventEnvelopeAvailable, }) } } } // Envelopes retrieves all the messages currently pooled by the node. func (w *Waku) Envelopes() []*common.ReceivedMessage { w.poolMu.RLock() defer w.poolMu.RUnlock() all := make([]*common.ReceivedMessage, 0, len(w.envelopes)) for _, envelope := range w.envelopes { all = append(all, envelope) } return all } // GetEnvelope retrieves an envelope from the message queue by its hash. // It returns nil if the envelope can not be found. func (w *Waku) GetEnvelope(hash gethcommon.Hash) *common.ReceivedMessage { w.poolMu.RLock() defer w.poolMu.RUnlock() return w.envelopes[hash] } // isEnvelopeCached checks if envelope with specific hash has already been received and cached. func (w *Waku) IsEnvelopeCached(hash gethcommon.Hash) bool { w.poolMu.Lock() defer w.poolMu.Unlock() _, exist := w.envelopes[hash] return exist } func (w *Waku) PeerCount() int { return w.node.PeerCount() } func (w *Waku) Peers() map[string]types.WakuV2Peer { return FormatPeerStats(w.node, w.node.PeerStats()) } func (w *Waku) ListenAddresses() []string { addrs := w.node.ListenAddresses() var result []string for _, addr := range addrs { result = append(result, addr.String()) } return result } func (w *Waku) StartDiscV5() error { if w.node.DiscV5() == nil { return errors.New("discv5 is not setup") } return w.node.DiscV5().Start(context.Background()) } func (w *Waku) StopDiscV5() error { if w.node.DiscV5() == nil { return errors.New("discv5 is not setup") } w.node.DiscV5().Stop() return nil } func (w *Waku) ConnectionChanged(state connection.State) { if !state.Offline && w.offline { select { case w.connectionChanged <- struct{}{}: default: w.logger.Warn("could not write on connection changed channel") } } w.offline = !state.Offline } // seedBootnodesForDiscV5 tries to fetch bootnodes // from an ENR periodically. // It backs off exponentially until maxRetries, at which point it restarts from 0 // It also restarts if there's a connection change signalled from the client func (w *Waku) seedBootnodesForDiscV5() { if !w.settings.EnableDiscV5 || w.node.DiscV5() == nil { return } ticker := time.NewTicker(200 * time.Millisecond) defer ticker.Stop() var lastTry = time.Now().UnixNano() / int64(time.Millisecond) var retries = 0 for { select { case <-ticker.C: if w.seededBootnodesForDiscV5 { w.logger.Info("stopped querying bootnodes") return } now := time.Now().UnixNano() / int64(time.Millisecond) backoff := bootnodesQueryBackoffMs * int64(math.Exp2(float64(retries))) if lastTry+backoff < now { err := w.restartDiscV5() if err != nil { w.logger.Warn("failed to restart discv5", zap.Error(err)) } lastTry = now retries++ // We reset the retries after a while and restart if retries > bootnodesMaxRetries { retries = 0 } } // If we go online, trigger immediately case <-w.connectionChanged: now := time.Now().UnixNano() / int64(time.Millisecond) backoff := bootnodesQueryBackoffMs * int64(math.Exp2(float64(retries))) // check we haven't run too eagerly, in case connection // is flapping if lastTry+backoff < now { err := w.restartDiscV5() if err != nil { w.logger.Warn("failed to restart discv5", zap.Error(err)) } } retries = 0 lastTry = now case <-w.quit: return } } } // Restart discv5, re-retrieving bootstrap nodes func (w *Waku) restartDiscV5() error { ctx, cancel := context.WithTimeout(context.Background(), 30*time.Second) defer cancel() bootnodes, err := w.getDiscV5BootstrapNodes(ctx, w.discV5BootstrapNodes) if err != nil { return err } if len(bootnodes) == 0 { return errors.New("failed to fetch bootnodes") } w.logger.Info("restarting discv5 with nodes", zap.Any("nodes", bootnodes)) return w.node.SetDiscV5Bootnodes(bootnodes) } func (w *Waku) AddStorePeer(address string) (peer.ID, error) { addr, err := multiaddr.NewMultiaddr(address) if err != nil { return "", err } peerID, err := w.node.AddPeer(addr, peers.Static, store.StoreID_v20beta4) if err != nil { return "", err } return peerID, nil } func (w *Waku) timestamp() int64 { return w.timesource.Now().UnixNano() } func (w *Waku) AddRelayPeer(address string) (peer.ID, error) { addr, err := multiaddr.NewMultiaddr(address) if err != nil { return "", err } peerID, err := w.node.AddPeer(addr, peers.Static, relay.WakuRelayID_v200) if err != nil { return "", err } return peerID, nil } func (w *Waku) DialPeer(address string) error { ctx, cancel := context.WithTimeout(context.Background(), requestTimeout) defer cancel() return w.node.DialPeer(ctx, address) } func (w *Waku) DialPeerByID(peerID string) error { ctx, cancel := context.WithTimeout(context.Background(), requestTimeout) defer cancel() pid, err := peer.Decode(peerID) if err != nil { return err } return w.node.DialPeerByID(ctx, pid) } func (w *Waku) DropPeer(peerID string) error { pid, err := peer.Decode(peerID) if err != nil { return err } return w.node.ClosePeerById(pid) } func (w *Waku) ProcessingP2PMessages() bool { w.storeMsgIDsMu.Lock() defer w.storeMsgIDsMu.Unlock() return len(w.storeMsgIDs) != 0 } func (w *Waku) MarkP2PMessageAsProcessed(hash gethcommon.Hash) { w.storeMsgIDsMu.Lock() defer w.storeMsgIDsMu.Unlock() delete(w.storeMsgIDs, hash) } // validatePrivateKey checks the format of the given private key. func validatePrivateKey(k *ecdsa.PrivateKey) bool { if k == nil || k.D == nil || k.D.Sign() == 0 { return false } return common.ValidatePublicKey(&k.PublicKey) } // makeDeterministicID generates a deterministic ID, based on a given input func makeDeterministicID(input string, keyLen int) (id string, err error) { buf := pbkdf2.Key([]byte(input), nil, 4096, keyLen, sha256.New) if !common.ValidateDataIntegrity(buf, common.KeyIDSize) { return "", fmt.Errorf("error in GenerateDeterministicID: failed to generate key") } id = gethcommon.Bytes2Hex(buf) return id, err } // toDeterministicID reviews incoming id, and transforms it to format // expected internally be private key store. Originally, public keys // were used as keys, now random keys are being used. And in order to // make it easier to consume, we now allow both random IDs and public // keys to be passed. func toDeterministicID(id string, expectedLen int) (string, error) { if len(id) != (expectedLen * 2) { // we received hex key, so number of chars in id is doubled var err error id, err = makeDeterministicID(id, expectedLen) if err != nil { return "", err } } return id, nil } func FormatPeerStats(wakuNode *node.WakuNode, peers node.PeerStats) map[string]types.WakuV2Peer { p := make(map[string]types.WakuV2Peer) for k, v := range peers { peerInfo := wakuNode.Host().Peerstore().PeerInfo(k) wakuV2Peer := types.WakuV2Peer{} wakuV2Peer.Protocols = v hostInfo, _ := multiaddr.NewMultiaddr(fmt.Sprintf("/p2p/%s", k.Pretty())) for _, addr := range peerInfo.Addrs { wakuV2Peer.Addresses = append(wakuV2Peer.Addresses, addr.Encapsulate(hostInfo).String()) } p[k.Pretty()] = wakuV2Peer } return p } func formatConnStatus(wakuNode *node.WakuNode, c node.ConnStatus) types.ConnStatus { return types.ConnStatus{ IsOnline: c.IsOnline, HasHistory: c.HasHistory, Peers: FormatPeerStats(wakuNode, c.Peers), } } // Find suitable peer(s). For this we use a peerDisconnectMap, it works so that // peers that have been recently disconnected from have lower priority func (w *Waku) findFilterPeers() []peer.ID { allPeers := w.node.Host().Peerstore().Peers() var peers peer.IDSlice for _, peer := range allPeers { protocols, err := w.node.Host().Peerstore().SupportsProtocols(peer, filter.FilterSubscribeID_v20beta1, relay.WakuRelayID_v200) if err != nil { continue } if len(protocols) == 2 { peers = append(peers, peer) } } if len(peers) > 0 { sort.Slice(peers, func(i, j int) bool { // If element not found in map, [] operator will return 0 return w.filterPeerDisconnectMap[peers[i]] < w.filterPeerDisconnectMap[peers[j]] }) } var peerLen = len(peers) if w.settings.MinPeersForFilter < peerLen { peerLen = w.settings.MinPeersForFilter } peers = peers[0:peerLen] return peers } func (w *Waku) subscribeToFilter(f *common.Filter) error { peers := w.findFilterPeers() if len(peers) > 0 { contentFilter := w.buildContentFilter(f.Topics) for i := 0; i < len(peers) && i < w.settings.MinPeersForFilter; i++ { subDetails, err := w.node.FilterLightnode().Subscribe(context.Background(), contentFilter, filter.WithPeer(peers[i])) if err != nil { w.logger.Warn("could not add wakuv2 filter for peer", zap.Any("peer", peers[i])) continue } subMap := w.filterSubscriptions[f] if subMap == nil { subMap = make(map[string]*filter.SubscriptionDetails) w.filterSubscriptions[f] = subMap } subMap[subDetails.ID] = subDetails go w.runFilterSubscriptionLoop(subDetails) } } else { return errors.New("could not select a suitable peer for filter") } return nil }