fix: filter public ips (#97)

2color · web-flow · commit 77a814738460 · 2024-12-20T09:10:14.000+01:00
* fix: only return public ips in fallback iter * fix: sanitize last to ensure we only return public ips * docs: add coment about cached router * Revert "fix: only return public ips in fallback iter" This reverts commit bb2fd4c. * docs: update changelog --------- Co-authored-by: Daniel N <2color@users.noreply.github.com>
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,13 +15,14 @@ The following emojis are used to highlight certain changes:
 
 ### Added
 
-
 ### Changed
 
 ### Removed
 
 ### Fixed
 
+- Fix a bug whereby, cached peers with private multiaddrs were returned in `/routing/v1/providers` responses, as they were not passing through `sanitizeRouter`.
+
 ### Security
 
 ## [v0.7.0]
diff --git a/server.go b/server.go
@@ -246,7 +246,8 @@ func getCombinedRouting(endpoints []string, dht routing.Routing, cachedAddrBook
 	var dhtRouter router
 
 	if cachedAddrBook != nil {
-		dhtRouter = NewCachedRouter(sanitizeRouter{libp2pRouter{routing: dht}}, cachedAddrBook)
+		cachedRouter := NewCachedRouter(libp2pRouter{routing: dht}, cachedAddrBook)
+		dhtRouter = sanitizeRouter{cachedRouter}
 	} else {
 		dhtRouter = sanitizeRouter{libp2pRouter{routing: dht}}
 	}
diff --git a/server_cached_router.go b/server_cached_router.go
@@ -48,6 +48,7 @@ const (
 )
 
 // cachedRouter wraps a router with the cachedAddrBook to retrieve cached addresses for peers without multiaddrs in FindProviders
+// it will also dispatch a FindPeer when a provider has no multiaddrs using the cacheFallbackIter
 type cachedRouter struct {
 	router
 	cachedAddrBook *cachedAddrBook

Original file line number	Diff line number	Diff line change
`@@ -246,7 +246,8 @@ func getCombinedRouting(endpoints []string, dht routing.Routing, cachedAddrBook`
`246`	`246`	`var dhtRouter router`
`247`	`247`
`248`	`248`	`if cachedAddrBook != nil {`
`249`		`- dhtRouter = NewCachedRouter(sanitizeRouter{libp2pRouter{routing: dht}}, cachedAddrBook)`
	`249`	`+ cachedRouter := NewCachedRouter(libp2pRouter{routing: dht}, cachedAddrBook)`
	`250`	`+ dhtRouter = sanitizeRouter{cachedRouter}`
`250`	`251`	`} else {`
`251`	`252`	`dhtRouter = sanitizeRouter{libp2pRouter{routing: dht}}`
`252`	`253`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@ const (`
`48`	`48`	`)`
`49`	`49`
`50`	`50`	`// cachedRouter wraps a router with the cachedAddrBook to retrieve cached addresses for peers without multiaddrs in FindProviders`
	`51`	`+// it will also dispatch a FindPeer when a provider has no multiaddrs using the cacheFallbackIter`
`51`	`52`	`type cachedRouter struct {`
`52`	`53`	`router`
`53`	`54`	`cachedAddrBook *cachedAddrBook`