libp2p / go-libp2p

libp2p implementation in Go
MIT License
6.08k stars 1.07k forks source link

AutoRelay not detecting inaccessible node and updating addrs with relay addr on NAT'ed Network #2399

Closed MihaiSandor closed 1 year ago

MihaiSandor commented 1 year ago

Description:

I am facing an issue where AutoRelay does not detect that the node is not publicly accessible (NAT'ed), and it does not update the addrs with relay addr even after 10-20 minutes.

Environment:

How to Reproduce:

  1. Establish a 4G/5G network hotspot.
  2. Set up a static relay on a public instance (in this case, https://github.com/libp2p/go-libp2p-relay-daemon) using version 0.4.0.
  3. Run the following Go code:
package main

import (
    "github.com/libp2p/go-libp2p"
    "github.com/libp2p/go-libp2p/core/peer"
    "log"
    "time"
)

func main() {
    staticRelayAddrStr := "/ip4/5.5.5.5/udp/4001/quic/p2p/12D3KooWJ652XBsKKkR8KoDc2socwfMGYBTpVHC7CBeBUkD5jUz1"
    staticRelayAddr, err := peer.AddrInfoFromString(staticRelayAddrStr)
    if err != nil {
        log.Fatalf("Failed to parse static relay addr: %s\n", err.Error())
    }
    staticRelays := []peer.AddrInfo{*staticRelayAddr}
    host, err := libp2p.New(
        libp2p.NATPortMap(),
        libp2p.EnableHolePunching(),
        libp2p.EnableRelay(),
        libp2p.EnableAutoRelayWithStaticRelays(staticRelays),
    )
    if err != nil {
        log.Fatalf("Failed to create a new host: %s\n", err.Error())
    }
    defer host.Close()

    for {
        time.Sleep(10 * time.Second)
        log.Printf("Host ID: %s. Host Addrs: %v\n", host.ID(), host.Addrs())
    }

}

Expected Behavior:

AutoRelay should detect that the node is not publicly accessible and update the addrs with the relay addr.

Actual Behavior:

Even after 10-20 minutes of execution, AutoRelay does not detect that the node is not publicly accessible and it never updates the addrs with the relay addr.

Program Log Addr Output:

/ip4/127.0.0.1/tcp/50710
/ip4/127.0.0.1/udp/53743/quic
/ip4/127.0.0.1/udp/53743/quic-v1
/ip4/127.0.0.1/udp/64099/quic-v1/webtransport/certhash/...
/ip4/172.20.10.2/tcp/50710
/ip4/172.20.10.2/udp/53743/quic
/ip4/172.20.10.2/udp/53743/quic-v1
/ip4/172.20.10.2/udp/64099/quic-v1/webtransport/certhash/...
/ip6/::1/tcp/50713
/ip6/::1/udp/60149/quic-v1/webtransport/certhash/...
/ip6/::1/udp/62662/quic
/ip6/::1/udp/62662/quic-v1

Additional Context:

The static relay is set on a public instance. The relay used is from https://github.com/libp2p/go-libp2p-relay-daemon with version 0.4.0.

This is the first time I am facing such an issue, and I have followed the same steps as earlier without any issues.

Request:

I would greatly appreciate any guidance or insight on why this could be happening and how it can be rectified.

Version Information
cloud.google.com/go v0.65.0
cloud.google.com/go/bigquery v1.8.0
cloud.google.com/go/datastore v1.1.0
cloud.google.com/go/pubsub v1.3.1
cloud.google.com/go/storage v1.10.0
dmitri.shuralyov.com/app/changes v0.0.0-20180602232624-0a106ad413e3
dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9
dmitri.shuralyov.com/html/belt v0.0.0-20180602232347-f7d459c86be0
dmitri.shuralyov.com/service/change v0.0.0-20181023043359-a85b471d5412
dmitri.shuralyov.com/state v0.0.0-20180228185332-28bcc343414c
git.apache.org/thrift.git v0.0.0-20180902110319-2566ecd5d999
github.com/AndreasBriese/bbloom v0.0.0-20190825152654-46b345b51c96
github.com/BurntSushi/toml v0.3.1
github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802
github.com/alecthomas/template v0.0.0-20190718012654-fb15b899a751
github.com/alecthomas/units v0.0.0-20190924025748-f65c72e2690d
github.com/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239
github.com/benbjohnson/clock v1.3.5
github.com/beorn7/perks v1.0.1
github.com/bradfitz/go-smtpd v0.0.0-20170404230938-deb6d6237625
github.com/buger/jsonparser v0.0.0-20181115193947-bf1c66bbce23
github.com/census-instrumentation/opencensus-proto v0.2.1
github.com/cespare/xxhash v1.1.0
github.com/cespare/xxhash/v2 v2.2.0
github.com/chzyer/logex v1.1.10
github.com/chzyer/readline v1.5.1
github.com/chzyer/test v0.0.0-20180213035817-a1ea475d72b1
github.com/cilium/ebpf v0.9.1
github.com/client9/misspell v0.3.4
github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f
github.com/containerd/cgroups v1.1.0
github.com/coreos/go-systemd v0.0.0-20181012123002-c6f51f82210d
github.com/coreos/go-systemd/v22 v22.5.0
github.com/cpuguy83/go-md2man/v2 v2.0.0
github.com/davecgh/go-spew v1.1.1
github.com/davidlazar/go-crypto v0.0.0-20200604182044-b73af7476f6c
github.com/decred/dcrd/crypto/blake256 v1.0.1
github.com/decred/dcrd/dcrec/secp256k1/v4 v4.2.0
github.com/dgraph-io/badger v1.6.2
github.com/dgraph-io/ristretto v0.0.2
github.com/docker/go-units v0.5.0
github.com/dustin/go-humanize v1.0.0
github.com/elastic/gosigar v0.14.2
github.com/envoyproxy/go-control-plane v0.9.4
github.com/envoyproxy/protoc-gen-validate v0.1.0
github.com/flynn/go-shlex v0.0.0-20150515145356-3f9db97f8568
github.com/flynn/noise v1.0.0
github.com/francoispqt/gojay v1.2.13
github.com/fsnotify/fsnotify v1.5.4
github.com/ghodss/yaml v1.0.0
github.com/gliderlabs/ssh v0.1.1
github.com/go-errors/errors v1.0.1
github.com/go-gl/glfw v0.0.0-20190409004039-e6da0acd62b1
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4
github.com/go-kit/kit v0.9.0
github.com/go-kit/log v0.2.0
github.com/go-logfmt/logfmt v0.5.1
github.com/go-logr/logr v1.2.4
github.com/go-stack/stack v1.8.0
github.com/go-task/slim-sprig v0.0.0-20230315185526-52ccab3ef572
github.com/godbus/dbus/v5 v5.1.0
github.com/gogo/protobuf v1.3.2
github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b
github.com/golang/groupcache v0.0.0-20200121045136-8c9f03a8e57e
github.com/golang/lint v0.0.0-20180702182130-06c8688daad7
github.com/golang/mock v1.6.0
github.com/golang/protobuf v1.5.3
github.com/golang/snappy v0.0.0-20180518054509-2e65f85255db
github.com/google/btree v1.0.0
github.com/google/go-cmp v0.5.9
github.com/google/go-github v17.0.0+incompatible
github.com/google/go-querystring v1.0.0
github.com/google/gofuzz v1.0.0
github.com/google/gopacket v1.1.19
github.com/google/martian v2.1.0+incompatible
github.com/google/martian/v3 v3.0.0
github.com/google/pprof v0.0.0-20230602150820-91b7bce49751
github.com/google/renameio v0.1.0
github.com/google/uuid v1.3.0
github.com/googleapis/gax-go v2.0.0+incompatible
github.com/googleapis/gax-go/v2 v2.0.5
github.com/gopherjs/gopherjs v0.0.0-20181017120253-0766667cb4d1
github.com/gorilla/websocket v1.5.0
github.com/gregjones/httpcache v0.0.0-20180305231024-9cad4c3443a7
github.com/grpc-ecosystem/grpc-gateway v1.5.0
github.com/hashicorp/golang-lru v0.5.1
github.com/hashicorp/golang-lru/v2 v2.0.2
github.com/huin/goupnp v1.2.0
github.com/ianlancetaylor/demangle v0.0.0-20230524184225-eabc099b10ab
github.com/ipfs/go-cid v0.4.1
github.com/ipfs/go-datastore v0.6.0
github.com/ipfs/go-detect-race v0.0.1
github.com/ipfs/go-ds-badger v0.3.0
github.com/ipfs/go-ds-leveldb v0.5.0
github.com/ipfs/go-ipfs-util v0.0.2
github.com/ipfs/go-log/v2 v2.5.1
github.com/jackpal/go-nat-pmp v1.0.2
github.com/jbenet/go-temp-err-catcher v0.1.0
github.com/jbenet/goprocess v0.1.4
github.com/jellevandenhooff/dkim v0.0.0-20150330215556-f50fe3d243e1
github.com/jpillora/backoff v1.0.0
github.com/json-iterator/go v1.1.12
github.com/jstemmer/go-junit-report v0.9.1
github.com/julienschmidt/httprouter v1.3.0
github.com/kisielk/errcheck v1.5.0
github.com/kisielk/gotool v1.0.0
github.com/klauspost/compress v1.16.5
github.com/klauspost/cpuid/v2 v2.2.5
github.com/konsorten/go-windows-terminal-sequences v1.0.3
github.com/koron/go-ssdp v0.0.4
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515
github.com/kr/pretty v0.2.1
github.com/kr/pty v1.1.3
github.com/kr/text v0.1.0
github.com/libp2p/go-buffer-pool v0.1.0
github.com/libp2p/go-cidranger v1.1.0
github.com/libp2p/go-flow-metrics v0.1.0
github.com/libp2p/go-libp2p v0.28.1
github.com/libp2p/go-libp2p-asn-util v0.3.0
github.com/libp2p/go-libp2p-testing v0.12.0
github.com/libp2p/go-mplex v0.7.0
github.com/libp2p/go-msgio v0.3.0
github.com/libp2p/go-nat v0.2.0
github.com/libp2p/go-netroute v0.2.1
github.com/libp2p/go-reuseport v0.3.0
github.com/libp2p/go-yamux/v4 v4.0.0
github.com/libp2p/zeroconf/v2 v2.2.0
github.com/lunixbochs/vtclean v1.0.0
github.com/mailru/easyjson v0.0.0-20190312143242-1de009706dbe
github.com/marten-seemann/tcp v0.0.0-20210406111302-dfbc87cc63fd
github.com/mattn/go-isatty v0.0.19
github.com/matttproud/golang_protobuf_extensions v1.0.4
github.com/microcosm-cc/bluemonday v1.0.1
github.com/miekg/dns v1.1.54
github.com/mikioh/tcp v0.0.0-20190314235350-803a9b46060c
github.com/mikioh/tcpinfo v0.0.0-20190314235526-30a79bb1804b
github.com/mikioh/tcpopt v0.0.0-20190314235656-172688c1accc
github.com/minio/blake2b-simd v0.0.0-20160723061019-3f5f724cb5b1
github.com/minio/sha256-simd v1.0.1
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd
github.com/modern-go/reflect2 v1.0.2
github.com/mr-tron/base58 v1.2.0
github.com/multiformats/go-base32 v0.1.0
github.com/multiformats/go-base36 v0.2.0
github.com/multiformats/go-multiaddr v0.9.0
github.com/multiformats/go-multiaddr-dns v0.3.1
github.com/multiformats/go-multiaddr-fmt v0.1.0
github.com/multiformats/go-multibase v0.2.0
github.com/multiformats/go-multicodec v0.9.0
github.com/multiformats/go-multihash v0.2.2
github.com/multiformats/go-multistream v0.4.1
github.com/multiformats/go-varint v0.0.7
github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f
github.com/neelance/astrewrite v0.0.0-20160511093645-99348263ae86
github.com/neelance/sourcemap v0.0.0-20151028013722-8c68805598ab
github.com/onsi/ginkgo v1.16.5
github.com/onsi/ginkgo/v2 v2.9.7
github.com/onsi/gomega v1.27.7
github.com/opencontainers/runtime-spec v1.0.2
github.com/openzipkin/zipkin-go v0.1.1
github.com/pbnjay/memory v0.0.0-20210728143218-7b4eea64cf58
github.com/pkg/errors v0.9.1
github.com/pmezard/go-difflib v1.0.0
github.com/prometheus/client_golang v1.14.0
github.com/prometheus/client_model v0.4.0
github.com/prometheus/common v0.37.0
github.com/prometheus/procfs v0.8.0
github.com/quic-go/qpack v0.4.0
github.com/quic-go/qtls-go1-18 v0.2.0
github.com/quic-go/qtls-go1-19 v0.3.2
github.com/quic-go/qtls-go1-20 v0.2.2
github.com/quic-go/quic-go v0.33.0
github.com/quic-go/webtransport-go v0.5.3
github.com/raulk/go-watchdog v1.3.0
github.com/rogpeppe/go-internal v1.3.0
github.com/russross/blackfriday v1.5.2
github.com/russross/blackfriday/v2 v2.0.1
github.com/sergi/go-diff v1.0.0
github.com/shurcooL/component v0.0.0-20170202220835-f88ec8f54cc4
github.com/shurcooL/events v0.0.0-20181021180414-410e4ca65f48
github.com/shurcooL/github_flavored_markdown v0.0.0-20181002035957-2122de532470
github.com/shurcooL/go v0.0.0-20180423040247-9e1955d9fb6e
github.com/shurcooL/go-goon v0.0.0-20170922171312-37c2f522c041
github.com/shurcooL/gofontwoff v0.0.0-20180329035133-29b52fc0a18d
github.com/shurcooL/gopherjslib v0.0.0-20160914041154-feb6d3990c2c
github.com/shurcooL/highlight_diff v0.0.0-20170515013008-09bb4053de1b
github.com/shurcooL/highlight_go v0.0.0-20181028180052-98c3abbbae20
github.com/shurcooL/home v0.0.0-20181020052607-80b7ffcb30f9
github.com/shurcooL/htmlg v0.0.0-20170918183704-d01228ac9e50
github.com/shurcooL/httperror v0.0.0-20170206035902-86b7830d14cc
github.com/shurcooL/httpfs v0.0.0-20171119174359-809beceb2371
github.com/shurcooL/httpgzip v0.0.0-20180522190206-b1c53ac65af9
github.com/shurcooL/issues v0.0.0-20181008053335-6292fdc1e191
github.com/shurcooL/issuesapp v0.0.0-20180602232740-048589ce2241
github.com/shurcooL/notifications v0.0.0-20181007000457-627ab5aea122
github.com/shurcooL/octicon v0.0.0-20181028054416-fa4f57f9efb2
github.com/shurcooL/reactions v0.0.0-20181006231557-f2e0b4ca5b82
github.com/shurcooL/sanitized_anchor_name v1.0.0
github.com/shurcooL/users v0.0.0-20180125191416-49c67e49c537
github.com/shurcooL/webdavfs v0.0.0-20170829043945-18c3829fa133
github.com/sirupsen/logrus v1.8.1
github.com/sourcegraph/annotate v0.0.0-20160123013949-f4cad6c6324d
github.com/sourcegraph/syntaxhighlight v0.0.0-20170531221838-bd320f5d308e
github.com/spaolacci/murmur3 v1.1.0
github.com/stretchr/objx v0.1.1
github.com/stretchr/testify v1.8.2
github.com/syndtr/goleveldb v1.0.0
github.com/tarm/serial v0.0.0-20180830185346-98f6abe2eb07
github.com/urfave/cli v1.22.2
github.com/viant/assertly v0.4.8
github.com/viant/toolbox v0.24.0
github.com/yuin/goldmark v1.4.13
go.opencensus.io v0.22.4
go.uber.org/atomic v1.11.0
go.uber.org/dig v1.17.0
go.uber.org/fx v1.19.2
go.uber.org/goleak v1.1.12
go.uber.org/multierr v1.11.0
go.uber.org/zap v1.24.0
go4.org v0.0.0-20180809161055-417644f6feb5
golang.org/x/build v0.0.0-20190111050920-041ab4dc3f9d
golang.org/x/crypto v0.7.0
golang.org/x/exp v0.0.0-20230321023759-10a507213a29
golang.org/x/image v0.0.0-20190802002840-cff245a6509b
golang.org/x/lint v0.0.0-20200302205851-738671d3881b
golang.org/x/mobile v0.0.0-20190719004257-d2bd2a29d028
golang.org/x/mod v0.10.0
golang.org/x/net v0.10.0
golang.org/x/oauth2 v0.0.0-20220223155221-ee480838109b
golang.org/x/perf v0.0.0-20180704124530-6e6d33e29852
golang.org/x/sync v0.2.0
golang.org/x/sys v0.8.0
golang.org/x/term v0.8.0
golang.org/x/text v0.9.0
golang.org/x/time v0.0.0-20191024005414-555d28b269f0
golang.org/x/tools v0.9.1
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1
google.golang.org/api v0.30.0
google.golang.org/appengine v1.6.6
google.golang.org/genproto v0.0.0-20200825200019-8632dd797987
google.golang.org/grpc v1.31.0
google.golang.org/protobuf v1.30.0
gopkg.in/alecthomas/kingpin.v2 v2.2.6
gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c
gopkg.in/errgo.v2 v2.1.0
gopkg.in/inf.v0 v0.9.1
gopkg.in/yaml.v2 v2.4.0
gopkg.in/yaml.v3 v3.0.1
grpc.go4.org v0.0.0-20170609214715-11d0a25b4919
honnef.co/go/tools v0.0.1-2020.1.4
lukechampine.com/blake3 v1.2.1
rsc.io/binaryregexp v0.2.0
rsc.io/quote/v3 v3.1.0
rsc.io/sampler v1.3.0
sourcegraph.com/sourcegraph/go-diff v0.5.0
sourcegraph.com/sqs/pbtypes v0.0.0-20180604144634-d3ebe8f20ae4
marten-seemann commented 1 year ago

Have you taken a look at the dashboards? https://github.com/libp2p/go-libp2p/tree/master/dashboards

There's an AutoNAT and an AutoRelay dashboard that might give you some insight into what's going on.

MihaiSandor commented 1 year ago

Thank you for your response and suggestion.

I did take a look at the dashboards as suggested. Specifically, I examined both the AutoNAT and AutoRelay dashboards. I've also taken two screenshots for your reference:

Unfortunately, I was not able to gain much insight from these dashboards into why the AutoRelay is not detecting that the node is not publicly accessible and why it's not updating the addrs with the relay addr.

The metrics and visualizations provided in the dashboards were not very revealing or helpful to resolve the problem at hand.

marten-seemann commented 1 year ago

Looks like your node was only running for a few minutes, you need to give it some more time.

MihaiSandor commented 1 year ago

I understand your point about the runtime. However, even as we speak, my node has been running continuously for the past 30 minutes, and it's still facing the same issue.

Here are two new screenshots that illustrate the situation over this 30 minute interval:

Moreover, I would like to share that yesterday, I had the node running for more than 2 hours and the issue persisted. The AutoRelay still did not detect the node's inaccessibility and failed to update the addrs with the relay addr.

I am unsure of why this is happening and am hoping that there might be another reason for this issue that we haven't yet considered.

marten-seemann commented 1 year ago

Can you provide a screenshot of the swarm dashboard as well?

MihaiSandor commented 1 year ago

Certainly, I can provide a screenshot of the Swarm dashboard. Here it is:

Please note that in this screenshot, I've collapsed certain sections because they did not contain any data, and I wanted to focus on the sections that did contain data.

I'm still in the process of trying to fully understand this issue and appreciate your continued guidance and support. Let me know if there's anything else you'd like me to do or provide to help diagnose and rectify this problem.

marten-seemann commented 1 year ago

If the other sections don't contain any data, something is really going wrong. Apparently your node is not establishing any connections at all. Of course, AutoNAT and AutoRelay can't work then.

MihaiSandor commented 1 year ago

You're right, my node currently isn't establishing any connections. However, my main objective here is to validate and observe the functionality of AutoNAT and AutoRelay. I'm not trying to establish any additional connections to this node from other nodes at this moment.

From my understanding, even in the absence of other nodes attempting to connect, AutoNAT should be able to determine the node's accessibility. Since I'm on a network environment that is expected to make the node inaccessible, AutoNAT should fail and as a result, AutoRelay should automatically connect to the well-known relay that I've set up.

This has been the expected behaviour based on my understanding of the functionality. However, as seen from the dashboards and the node behaviour, this is not happening.

Could there be any other factors that I might be missing which are causing this issue? I'm eager to understand and fix this.

marten-seemann commented 1 year ago

AutoNAT uses existing connections to probe for your NAT status. If your node is just sitting idle and not establishing any connections, it won't have anything to work with.

MihaiSandor commented 1 year ago

That makes sense, and it provides a clearer picture of how AutoNAT operates. However, I've observed a different behaviour when I change that network to my home network. In that scenario, the list of addrs contains my public IP address and the respective port for each protocol. This occurs without making any extra connections to other nodes.

But when I switch to my 5G hotspot, this update does not occur. The node appears to behave differently in these two environments, despite no change in its connections.

Could this variation in behaviour between the ISP and hotspot environments point us towards any potential leads or explanations?