Make Tor optional for blockchain watchdogs (#1958)

This change lets node operators disable the use of
Tor for blockchain watchdogs if they'd rather use
cleartext HTTP instead.

Author: rorp

docs/Tor.md

@@ -174,4 +174,10 @@ eclair.blockchain-watchdog.sources = [
   "blockstream.info",
   "mempool.space"
 ]
+```
+
+Also, you can disable Tor for all watchdog sources altogether using:
+
+```s
+eclair.socks5.use-for-watchdogs = false
 ```

eclair-core/src/main/resources/reference.conf

@@ -327,6 +327,7 @@ eclair {
     use-for-ipv4 = true
     use-for-ipv6 = true
     use-for-tor = true
+    use-for-watchdogs = true
     randomize-credentials = false // this allows tor stream isolation
   }
 

eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala

@@ -292,7 +292,8 @@ object NodeParams extends Logging {
         randomizeCredentials = config.getBoolean("socks5.randomize-credentials"),
         useForIPv4 = config.getBoolean("socks5.use-for-ipv4"),
         useForIPv6 = config.getBoolean("socks5.use-for-ipv6"),
-        useForTor = config.getBoolean("socks5.use-for-tor")
+        useForTor = config.getBoolean("socks5.use-for-tor"),
+        useForWatchdogs = config.getBoolean("socks5.use-for-watchdogs"),
       ))
     } else {
       None

eclair-core/src/main/scala/fr/acinq/eclair/blockchain/watchdogs/BlockchainWatchdog.scala

@@ -68,10 +68,9 @@ object BlockchainWatchdog {
    */
   def apply(nodeParams: NodeParams, maxRandomDelay: FiniteDuration, blockTimeout: FiniteDuration = 15 minutes): Behavior[Command] = {
     Behaviors.setup { context =>
-      implicit val sttpBackend = ExplorerApi.createSttpBackend(nodeParams.socksProxy_opt)
-
+      val socksProxy_opt = nodeParams.socksProxy_opt.flatMap(params => if (params.useForWatchdogs) Some(params) else None)
+      implicit val sttpBackend = ExplorerApi.createSttpBackend(socksProxy_opt)
       val chainHash = nodeParams.chainHash
-      val socksProxy_opt = nodeParams.socksProxy_opt
       val sources = nodeParams.blockchainWatchdogSources
 
       val explorers = Seq(

eclair-core/src/main/scala/fr/acinq/eclair/tor/Socks5Connection.scala

@@ -217,7 +217,7 @@ object Socks5Connection {
   def portToByteString(port: Int): ByteString = ByteString((port & 0x0000ff00) >> 8, port & 0x000000ff)
 }
 
-case class Socks5ProxyParams(address: InetSocketAddress, credentials_opt: Option[Credentials], randomizeCredentials: Boolean, useForIPv4: Boolean, useForIPv6: Boolean, useForTor: Boolean)
+case class Socks5ProxyParams(address: InetSocketAddress, credentials_opt: Option[Credentials], randomizeCredentials: Boolean, useForIPv4: Boolean, useForIPv6: Boolean, useForTor: Boolean, useForWatchdogs: Boolean)
 
 object Socks5ProxyParams {
 

eclair-core/src/test/scala/fr/acinq/eclair/blockchain/watchdogs/BlockchainWatchdogSpec.scala

@@ -106,7 +106,8 @@ class BlockchainWatchdogSpec extends ScalaTestWithActorTestKit(ConfigFactory.loa
       randomizeCredentials = true,
       useForIPv4 = true,
       useForIPv6 = true,
-      useForTor = true)
+      useForTor = true,
+      useForWatchdogs = true)
 
     if (proxyAcceptsConnections(proxyParams)) {
       val eventListener = TestProbe[DangerousBlocksSkew]()

eclair-core/src/test/scala/fr/acinq/eclair/tor/Socks5ConnectionSpec.scala

@@ -31,27 +31,27 @@ class Socks5ConnectionSpec extends AnyFunSuite {
 
     assert(Socks5ProxyParams.proxyAddress(
       socketAddress = new InetSocketAddress("1.2.3.4", 9735),
-      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = true)).contains(proxyAddress))
+      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = true, useForWatchdogs = true)).contains(proxyAddress))
 
     assert(Socks5ProxyParams.proxyAddress(
       socketAddress = new InetSocketAddress("1.2.3.4", 9735),
-      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = false, useForIPv6 = true, useForTor = true)).isEmpty)
+      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = false, useForIPv6 = true, useForTor = true, useForWatchdogs = true)).isEmpty)
 
     assert(Socks5ProxyParams.proxyAddress(
       socketAddress = new InetSocketAddress("[fc92:97a3:e057:b290:abd8:9bd6:135d:7e7]", 9735),
-      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = true)).contains(proxyAddress))
+      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = true, useForWatchdogs = true)).contains(proxyAddress))
 
     assert(Socks5ProxyParams.proxyAddress(
       socketAddress = new InetSocketAddress("[fc92:97a3:e057:b290:abd8:9bd6:135d:7e7]", 9735),
-      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = false, useForTor = true)).isEmpty)
+      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = false, useForTor = true, useForWatchdogs = true)).isEmpty)
 
     assert(Socks5ProxyParams.proxyAddress(
       socketAddress = new InetSocketAddress("iq7zhmhck54vcax2vlrdcavq2m32wao7ekh6jyeglmnuuvv3js57r4id.onion", 9735),
-      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = true)).contains(proxyAddress))
+      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = true, useForWatchdogs = true)).contains(proxyAddress))
 
     assert(Socks5ProxyParams.proxyAddress(
       socketAddress = new InetSocketAddress("iq7zhmhck54vcax2vlrdcavq2m32wao7ekh6jyeglmnuuvv3js57r4id.onion", 9735),
-      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = false)).isEmpty)
+      proxyParams = Socks5ProxyParams(address = proxyAddress, credentials_opt = None, randomizeCredentials = false, useForIPv4 = true, useForIPv6 = true, useForTor = false, useForWatchdogs = true)).isEmpty)
 
   }