Skip to content

Add option to disable sending remote address in init #2285

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
t-bast merged 1 commit into from
May 31, 2022
Merged

Add option to disable sending remote address in init #2285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions eclair-core/src/main/resources/reference.conf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,9 @@ eclair {
ping-interval = 30 seconds
ping-timeout = 20 seconds // will disconnect if peer takes longer than that to respond
ping-disconnect = true // disconnect if no answer to our pings
// When enabled, if we receive an incoming connection, we will echo the source IP address in our init message.
// This should be disabled if your node is behind a load balancer that doesn't preserve source IP addresses.
send-remote-address-init = true
}

auto-reconnect = true
Expand Down
3 changes: 2 additions & 1 deletion eclair-core/src/main/scala/fr/acinq/eclair/NodeParams.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,8 @@ object NodeParams extends Logging {
pingDisconnect = config.getBoolean("peer-connection.ping-disconnect"),
maxRebroadcastDelay = FiniteDuration(config.getDuration("router.broadcast-interval").getSeconds, TimeUnit.SECONDS), // it makes sense to not delay rebroadcast by more than the rebroadcast period
killIdleDelay = FiniteDuration(config.getDuration("onion-messages.kill-transient-connection-after").getSeconds, TimeUnit.SECONDS),
maxOnionMessagesPerSecond = config.getInt("onion-messages.max-per-peer-per-second")
maxOnionMessagesPerSecond = config.getInt("onion-messages.max-per-peer-per-second"),
sendRemoteAddressInit = config.getBoolean("peer-connection.send-remote-address-init"),
),
routerConf = RouterConf(
watchSpentWindow = watchSpentWindow,
Expand Down
7 changes: 4 additions & 3 deletions eclair-core/src/main/scala/fr/acinq/eclair/io/PeerConnection.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import fr.acinq.eclair.remote.EclairInternalsSerializer.RemoteTypes
import fr.acinq.eclair.router.Router._
import fr.acinq.eclair.wire.protocol
import fr.acinq.eclair.wire.protocol._
import fr.acinq.eclair.{FSMDiagnosticActorLogging, Feature, Features, InitFeature, Logs, TimestampMilli, TimestampSecond}
import fr.acinq.eclair.{FSMDiagnosticActorLogging, Features, InitFeature, Logs, TimestampMilli, TimestampSecond}
import scodec.Attempt
import scodec.bits.ByteVector

Expand Down Expand Up @@ -103,7 +103,7 @@ class PeerConnection(keyPair: KeyPair, conf: PeerConnection.Conf, switchboard: A
Metrics.PeerConnectionsConnecting.withTag(Tags.ConnectionState, Tags.ConnectionStates.Initializing).increment()
log.info(s"using features=$localFeatures")
val localInit = d.pendingAuth.address match {
case remoteAddress if !d.pendingAuth.outgoing && NodeAddress.isPublicIPAddress(remoteAddress) => protocol.Init(localFeatures, TlvStream(InitTlv.Networks(chainHash :: Nil), InitTlv.RemoteAddress(remoteAddress)))
case remoteAddress if !d.pendingAuth.outgoing && conf.sendRemoteAddressInit && NodeAddress.isPublicIPAddress(remoteAddress) => protocol.Init(localFeatures, TlvStream(InitTlv.Networks(chainHash :: Nil), InitTlv.RemoteAddress(remoteAddress)))
case _ => protocol.Init(localFeatures, TlvStream(InitTlv.Networks(chainHash :: Nil)))
}
d.transport ! localInit
Expand Down Expand Up @@ -528,7 +528,8 @@ object PeerConnection {
pingDisconnect: Boolean,
maxRebroadcastDelay: FiniteDuration,
killIdleDelay: FiniteDuration,
maxOnionMessagesPerSecond: Int)
maxOnionMessagesPerSecond: Int,
sendRemoteAddressInit: Boolean)

// @formatter:off

Expand Down
5 changes: 3 additions & 2 deletions eclair-core/src/main/scala/fr/acinq/eclair/remote/EclairInternalsSerializer.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ import fr.acinq.eclair.wire.protocol.CommonCodecs._
import fr.acinq.eclair.wire.protocol.LightningMessageCodecs._
import fr.acinq.eclair.wire.protocol.QueryChannelRangeTlv.queryFlagsCodec
import fr.acinq.eclair.wire.protocol._
import fr.acinq.eclair.{CltvExpiryDelta, Feature, Features, InitFeature}
import fr.acinq.eclair.{CltvExpiryDelta, Feature, Features}
import scodec._
import scodec.codecs._

Expand Down Expand Up @@ -108,7 +108,8 @@ object EclairInternalsSerializer {
("pingDisconnect" | bool(8)) ::
("maxRebroadcastDelay" | finiteDurationCodec) ::
("killIdleDelay" | finiteDurationCodec) ::
("maxOnionMessagesPerSecond" | int32)).as[PeerConnection.Conf]
("maxOnionMessagesPerSecond" | int32) ::
("sendRemoteAddressInit" | bool(8))).as[PeerConnection.Conf]
Copy link
Copy Markdown
Member

@pm47 pm47 May 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be bool8 but apparently we have other "violations" in that file.

Copy link
Copy Markdown
Member Author

@t-bast t-bast May 31, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I saw that, that's why I chose to be consistent instead of using bool8. I'll do a follow-up tiny refactoring to move to bool8 everywhere in another PR.


val peerConnectionDoSyncCodec: Codec[PeerConnection.DoSync] = bool(8).as[PeerConnection.DoSync]

Expand Down
6 changes: 4 additions & 2 deletions eclair-core/src/test/scala/fr/acinq/eclair/TestConstants.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,8 @@ object TestConstants {
pingDisconnect = true,
maxRebroadcastDelay = 5 seconds,
killIdleDelay = 1 seconds,
maxOnionMessagesPerSecond = 10
maxOnionMessagesPerSecond = 10,
sendRemoteAddressInit = true,
),
routerConf = RouterConf(
watchSpentWindow = 1 second,
Expand Down Expand Up @@ -294,7 +295,8 @@ object TestConstants {
pingDisconnect = true,
maxRebroadcastDelay = 5 seconds,
killIdleDelay = 10 seconds,
maxOnionMessagesPerSecond = 10
maxOnionMessagesPerSecond = 10,
sendRemoteAddressInit = true,
),
routerConf = RouterConf(
watchSpentWindow = 1 second,
Expand Down