net: Add NAT-PMP port forwarding support #18077

hebasto · 2020-02-05T21:02:12Z

Close #11902
This PR is an alternative to:

To compile with NAT-PMP support on Ubuntu libnatpmp-dev should be available.

Log excerpt:

2020-02-05T20:12:28Z [mapport] NAT-PMP: public address = 95.164.65.194
2020-02-05T20:12:28Z [mapport] AddLocal(95.164.65.194:18333,3)
2020-02-05T20:12:28Z [mapport] NAT-PMP: port mapping successful.

See: libnatpmp

Some follow-ups are out of this PR's scope:

mention NAT-PMP library in the version message
~~integrate NAT-PMP into the GUI~~ (already added)

DrahtBot · 2020-02-05T23:18:08Z

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

net: Move SocketSendData lock annotation to header #20864 (net: Move SocketSendData lock annotation to header by MarcoFalke)
Use std::filesystem. Remove Boost Filesystem & System #20744 ([POC] Use std::filesystem. Remove Boost Filesystem & System by fanquake)
Add syscall sandboxing using seccomp-bpf (Linux secure computing mode) #20487 (draft: Add syscall sandboxing using seccomp-bpf (Linux secure computing mode) by practicalswift)
build: pkg-config related cleanup #20201 (build: pkg-config related cleanup by hebasto)
net: fix GetListenPort() to derive the proper port #20196 (net: fix GetListenPort() to derive the proper port by vasild)
depends: Pin clang search paths for darwin host #19683 (depends: Pin clang search paths for darwin host by dongcarl)
refactor: Cleanup thread ctor calls #19064 (refactor: Cleanup thread ctor calls by hebasto)
guix: Build support for macOS #17920 (guix: Build support for macOS by dongcarl)
External signer support - Wallet Box edition #16546 (External signer support - Wallet Box edition by Sjors)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

laanwj · 2020-02-06T11:22:12Z

Thanks for picking this up again. I hope we manage to do this this time.

src/mapport.cpp

luke-jr · 2020-02-06T18:16:15Z

Concept ACK

hebasto · 2020-02-07T20:53:20Z

It is ready for reviewing now.

hebasto · 2020-02-07T21:49:43Z

Updated 4ff5349 -> cf94431 (pr18077.03 -> pr18077.04, compare):

added libnatpmp package to macOS 10.14 native Travis build.

hebasto · 2020-02-08T08:17:25Z

Updated cf94431 -> 88248a4 (pr18077.04 -> pr18077.05, compare):

added:

changes to docs
release notes

hebasto · 2020-02-10T17:20:14Z

Rebased after #17398 and #18081 have been merged.

dongcarl · 2020-02-10T19:26:14Z

Concept ACK, will test on my home router.

Sjors · 2020-02-11T17:57:03Z

Concept ACK. Lightly tested configure / build on macOS.

Unfortunately I'm behind a IPv6 DS-Lite router, I can't test the IPv4 port forward. Perhaps -7 could be replaced by something more readable.

2020-02-11T17:48:27Z natpmp thread start
2020-02-11T17:48:27Z Bound to [::]:8333
2020-02-11T17:48:27Z Bound to 0.0.0.0:8333
2020-02-11T17:48:27Z init message: Loading P2P addresses...
2020-02-11T17:48:27Z NAT-PMP: readnatpmpresponseorretry() for public address failed with -7 error.
2020-02-11T17:48:27Z NAT-PMP: readnatpmpresponseorretry() for port mapping failed with -7 error.

I looked up the error code, and it's what I would expect given my setup:

/* NATPMP_ERR_NOGATEWAYSUPPORT : the gateway does not support NAT-PMP */
#define NATPMP_ERR_NOGATEWAYSUPPORT (-7)

Two suggesitons for followups, or this PR:

add checkbox in QT Settings (above UPNP)
add support for IPv6 pinhole if the library supports it, see Add IPv6 pinhole support using UPnP / NAT-PMP #17012 (looks like it doesn't)

hebasto · 2020-02-11T19:11:03Z

@Sjors

Thank you for your review and testing.

I looked up the error code, and it's what I would expect given my setup:
/* NATPMP_ERR_NOGATEWAYSUPPORT : the gateway does not support NAT-PMP */
#define NATPMP_ERR_NOGATEWAYSUPPORT (-7)

Agree.
But in this initial PR I intentionally do not provide user-friendly error messages in order to keep ThreadNatpmp() dense and tight for easier reviewing ;)

In followups every library call (initnatpmp(), sendpublicaddressrequest() and sendnewportmappingrequest()) with the following readnatpmpresponseorretry() loops could be refactored out to separate functions with user-friendly error messages.

Two suggesitons for followups, or this PR:
* add checkbox in QT Settings (above UPNP)

Agree. From the OP:

Some follow-ups are out of this PR's scope:
* mention NAT-PMP library in the version message

* integrate NAT-PMP into the GUI

ryanofsky · 2021-01-19T18:09:43Z

src/qt/optionsdialog.cpp

@@ -50,6 +51,10 @@ OptionsDialog::OptionsDialog(QWidget *parent, bool enableWallet) :
 #ifndef USE_UPNP
    ui->mapPortUpnp->setEnabled(false);
 #endif
+    connect(this, &QDialog::accepted, [this](){
+        QSettings settings;
+        model->node().mapPort(settings.value("fUseUPnP").toBool());


In commit "gui: Apply port mapping changes on dialog exit" (58e8364)

@hebasto It seems like this commit has a bug and will incorrectly overwrite command line and config file -upnp and -natpmp options. I think this might have happened before, but previously only if these settings were changed, now if the dialog is just opened and closed.

Would you have an opinion on reverting this change? Aside from the bug, it seems simpler to go back to fully applying settings in OptionsModel, instead of using half-using OptionsModel to apply the setting, and then reading the setting later in a different code path and QSettings instance in dialog code outside of OptionsModel.

(Encountered this while rebasing #15936)

@ryanofsky

You are right.

It seems like this commit has a bug and will incorrectly overwrite command line and config file -upnp and -natpmp options.

The concerns about user-friendly and correct behavior were raised in #18184. Now users are able to switch -upnp and -natpmp on/off on-the-fly via the GUI. Should we drop this feature?

I think this might have happened before, but previously only if these settings were changed, now if the dialog is just opened and closed.

Exiting the dialog via the "Cancel" push button or pressing the "Esc" key should not trigger that code path.

Anyway, I'll happy to revert (or enhance) that change in a proper way.

c198797 build: compile libnatpmp with -DNATPMP_STATICLIB on Windows (Fuzzbawls) f2b62a3 build: use newer source for libnatpmp (fanquake) 8143139 GUI: Re-work port mapping saving (Fuzzbawls) c4300c0 Clang-Tidy up mapport.cpp (Fuzzbawls) f1951b5 Add libnatpmp to nightly snapcraft builds (Fuzzbawls) d48ef00 doc: Add release notes (Fuzzbawls) 7886374 doc: Add libnatpmp stuff (Fuzzbawls) cf992d0 ci: Add libnatpmp-dev package to some builds (Fuzzbawls) 5a5e3cf gui: Add NAT-PMP network option (Fuzzbawls) 9a4ba48 net: Add -natpmp command line option (Fuzzbawls) 9927296 net: Add NAT-PMP to port mapping loop (Hennadii Stepanov) 84cd118 net: Add initial libnatpmp support (Fuzzbawls) faed148 gui: Apply port mapping changes on save (Fuzzbawls) 266d322 scripted-diff: Rename UPnP stuff (Fuzzbawls) 06dc0dd net: Add flags for port mapping protocols (Fuzzbawls) 2abea67 net: Keep trying to use UPnP when -upnp=1 (Hennadii Stepanov) d2fa5c4 Make ThreadMapPort static (Fuzzbawls) 7532090 refactor: Replace magic number with named constant (Hennadii Stepanov) c481f62 refactor: Move port mapping code to its own module (Fuzzbawls) Pull request description: Built on top of #2330, this backports bitcoin#18077 and bitcoin#21209 to add NAT-PMP port forwarding support, which can function along side of or instead of UPnP. Similar to how UPnP is treated, NAT-PMP support will be compiled in if the library is found, but the functionality is disabled by default unless passing `--enable-natpmp-default` to `configure`, or by using the `-natpmp` command line option at startup. A checkbox has also been added to the settings area of the GUI that allows for on-the-fly enabling/disabling of the port mapping features when saving the settings. - [x] #2330 to be merged first. ACKs for top commit: furszy: upnp and code check ACK c198797. random-zebra: utACK c198797 after rebase, and merging... Tree-SHA512: e4b47dcd9589a1fd7a1bf3254c319d80af92c878e1657a17a169e49aa888aea33921a9428da3e8d6ee023d971143cf4a495e5a32957370174cff57e6cc6f2cc0

Details: Homebrew/discussions#691 bitcoin/bitcoin#21663 (1/1) Conflicts: .cirrus.yml; had to remove libnatpnp which was added upstream in bitcoin/bitcoin#18077 which is a much larger PR that we are NOT backporting.

merge bitcoin#18077...22397: Add NAT-PMP port forwarding support

This also effectively reverts 58e8364 from bitcoin#18077, applying upnp and natpmp settings from the optionsmodel class instead of the optionsdialog class. This makes sense because model code, not view code is responsible for applying all other settings, and because leaving these settings half-applied in optionsmodel seems error prone and could lead to bugs. (These things were discussed a little in bitcoin#18077 (comment))

This also effectively reverts 58e8364 from #18077, applying upnp and natpmp settings from the optionsmodel class instead of the optionsdialog class. This makes sense because model code, not view code is responsible for applying all other settings, and because leaving these settings half-applied in optionsmodel seems error prone and could lead to bugs. (These things were discussed a little in bitcoin/bitcoin#18077 (comment))

This also effectively reverts 58e8364dcdc4e57b0caac09f8402e6535301de9b from of the optionsdialog class. This makes sense because model code, not view code is responsible for applying all other settings, and because leaving these settings half-applied in optionsmodel seems error prone and could lead to bugs. (These things were discussed a little in bitcoin/bitcoin#18077 (comment))

DrahtBot added Build system GUI P2P labels Feb 5, 2020

hebasto force-pushed the 20200130-natpmp branch from 2a65212 to 60e2524 Compare February 6, 2020 17:28

luke-jr reviewed Feb 6, 2020

View reviewed changes

src/mapport.cpp Outdated Show resolved Hide resolved

hebasto force-pushed the 20200130-natpmp branch from 60e2524 to 4ff5349 Compare February 7, 2020 20:38

hebasto marked this pull request as ready for review February 7, 2020 20:40

hebasto changed the title ~~[WIP] net: Add NAT-PMP port forwarding support~~ net: Add NAT-PMP port forwarding support Feb 7, 2020

hebasto force-pushed the 20200130-natpmp branch from 4ff5349 to cf94431 Compare February 7, 2020 21:41

DrahtBot added the Needs rebase label Feb 10, 2020

hebasto force-pushed the 20200130-natpmp branch from 88248a4 to c7e90ca Compare February 10, 2020 17:18

DrahtBot removed the Needs rebase label Feb 10, 2020

dongcarl self-assigned this Feb 10, 2020

maflcko removed Build system GUI labels Feb 10, 2020

ryanofsky reviewed Jan 19, 2021

View reviewed changes

Fuzzbawls mentioned this pull request Apr 24, 2021

[Net] Add NAT-PMP port forwarding support PIVX-Project/PIVX#2338

Merged

1 task

fanquake mentioned this pull request Aug 6, 2021

build: deprecate UPnP support #22644

Closed

kwvg added a commit to kwvg/dash that referenced this pull request Feb 26, 2022

merge bitcoin#18077: Add NAT-PMP port forwarding support

687c7d4

PastaPastaPasta added a commit to dashpay/dash that referenced this pull request Mar 5, 2022

Merge pull request #4706 from kittywhiskers/libnatpmp

47ad9ab

merge bitcoin#18077...22397: Add NAT-PMP port forwarding support

bitcoin locked as resolved and limited conversation to collaborators Aug 16, 2022

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

net: Add NAT-PMP port forwarding support #18077

net: Add NAT-PMP port forwarding support #18077

hebasto commented Feb 5, 2020 •

edited

Loading

DrahtBot commented Feb 5, 2020 •

edited

Loading

laanwj commented Feb 6, 2020

luke-jr commented Feb 6, 2020

hebasto commented Feb 7, 2020 •

edited

Loading

hebasto commented Feb 7, 2020

hebasto commented Feb 8, 2020

hebasto commented Feb 10, 2020

dongcarl commented Feb 10, 2020

Sjors commented Feb 11, 2020 •

edited

Loading

hebasto commented Feb 11, 2020 •

edited

Loading

ryanofsky Jan 19, 2021

hebasto Jan 30, 2021

net: Add NAT-PMP port forwarding support #18077

net: Add NAT-PMP port forwarding support #18077

Conversation

hebasto commented Feb 5, 2020 • edited Loading

DrahtBot commented Feb 5, 2020 • edited Loading

Conflicts

laanwj commented Feb 6, 2020

luke-jr commented Feb 6, 2020

hebasto commented Feb 7, 2020 • edited Loading

hebasto commented Feb 7, 2020

hebasto commented Feb 8, 2020

hebasto commented Feb 10, 2020

dongcarl commented Feb 10, 2020

Sjors commented Feb 11, 2020 • edited Loading

hebasto commented Feb 11, 2020 • edited Loading

ryanofsky Jan 19, 2021

Choose a reason for hiding this comment

hebasto Jan 30, 2021

Choose a reason for hiding this comment

hebasto commented Feb 5, 2020 •

edited

Loading

DrahtBot commented Feb 5, 2020 •

edited

Loading

hebasto commented Feb 7, 2020 •

edited

Loading

Sjors commented Feb 11, 2020 •

edited

Loading

hebasto commented Feb 11, 2020 •

edited

Loading