miniupnpd: Update, revision, new network access control and UCI options…

[Self-Hosting-Group]

Commits

As this PR is extensive, the descriptions of the individual commits are collapsed here:

Update daemon to 2.3.9 to fix issues and refresh building

• Update daemon to 2.3.9 to fix removal of nftables rules in upnp_forward and return the correct client port. This also resulted in the excessive opening of new ports
• Build from GitHub releases to get a reliable HTTPS server, as the HTTP-only/HTTPS mirror were only available ~85%/77% over 3 months
  https://redirect.github.com/miniupnp/miniupnp/issues/770
  https://stats.uptimerobot.com/DwGDxUB914
• Not in: Build from HTTP-only mirror of the project, as building from the HTTPS mirror was recently and frequently impossible
• Not in: Build from GitHub tag archives, as release archive differ in code comments to the public repository, in project since 2012, makes backports more complex
• Build daemon with --disable-pppconn to remove the old/IGDv1-only extra SSDP WANPPPConnection announcements workaround not included in other implementations since >15y
• Build daemon with --vendorcfg to allow customisation of the router/friendly name (+5 potential options) displayed in Windows Explorer, 384 bytes extra required on ARMv7 (binary)
• Remove old (iptables variant) patches: 200-remove-default-cflags as it compiles/runs without it, and 300-macos... as seems no longer needed
• Remove clean_ruleset_interval/threshold UCI config options as not standard/working since OpenWrt 22.03, as nftables not supported

Fix: https://redirect.github.com/openwrt/openwrt/issues/18011
Fix: https://redirect.github.com/openwrt/luci/issues/7759

Patch for UPnP IGD compatibility with Microsoft/Apple clients

• Add workaround for listing port maps with Windows IGDv2-incompatible clients by returning an infinite (0) lease duration, so that listing and editing works via GUI (Explorer/Network) when daemon has been compiled with IGDv2
• Detect Microsoft clients more specifically and add Xbox
• Detect Apple IGDv2-incompatible clients and apply existing workaround Only caused problems if PCP/NAT-PMP (prioritised) was disabled

(proposed for inclusion)

Link: https://redirect.github.com/FreshTomato-Project/freshtomato-arm/issues/75

Patch to fix description filter option

To fix the non-working description regex filter option

(proposed for inclusion)

Link: https://redirect.github.com/miniupnp/miniupnp/pull/853

Package revision and new/updated UCI options

The following settings UCI options been added or changed, and the previous options are migrated on the service restart:

upnpd.config UCI options	Change	Previous name
enabled	Match default (1)
enabled_protocols=upnp-igd	Combined option	enable_upnp=1
enabled_protocols=pcp+nat-pmp	Combined option	enable_natpmp=1
allow_cgnat	Allow allow-filtered (2)	use_stun
stun_host	Allow port inclusion (3)
stun_port	Removed, included in host
allow_third_party_mapping=0	Inverted/extended to PCP	secure_mode=1
log_output	Allow info log level
lease_file	Set by default + IPv6 (4)	upnp_lease_file
upnp_igd_compat=igdv1	Renamed/match default (1)	igdv1=1
download_kbps	In kbit/s and renamed (5)	download
upload_kbps	In kbit/s and renamed (5)	upload
friendly_name	New option, router name
http_port	Renamed, rem. if default	port
notify_interval	Removed if <900s, minimum
internal_iface	Migrated, new section

internal_network UCI options	Change	Previous name
interface	New option
access_preset	New option (6)
accept_ports	New option (6)
reject_ports	New option (7)
custom_acl_before	New option (6)

Notes:

1. Init UCI default now matches LuCI and initial config file defaults for: enabled=0 and upnp_igd_compat=igdv1
2. Allow allow-filtered for IPv4 CGNAT use and migrate option from X-Wrt and only use STUN when necessary with a private/CGNAT external IPv4
3. Remove known incompatible STUN servers and set compatible by default
4. Configure undocumented daemon option lease_file6=${lease_file}-ipv6 so that active IPv6 port maps are not lost when service restarts, e.g. by deleting an active port map. Use /run path, symlinked and appeared in FHS 3.0 in 2015 and remove option if UCI default is set
5. Gets converted, config file now defaults to interface link speed instead of 8/4 Mbit/s, which is removed on migration
6. New options added to select a preset for all devices on the network and decide if the custom ACL should be checked before the preset. Extra ports can also be set that are accepted/rejected. Presets: accept-high-ports/accept-high-ports+web[+dns]/accept-all-ports or 0
7. Reject ports regardless of other settings. By default reject unsafe: 21 (FTP), 23 (Telnet), DCE/NetBIOS/SMB (135/137-139/445), RDP (3389)

Code refactoring:

• Add a function for logging and output to stderr, and extend logging
• Revise daemon init/config-gen slightly by declare all UCI options (incl. booleans) according to the same principle and remove upnpd_write_bool
• Document and reformat default /etc/config/upnpd UCI config file

Related LuCI PR: https://redirect.github.com/openwrt/luci/pull/7822

Close: https://redirect.github.com/openwrt/packages/pull/26531

Group/rearrange config-gen and refactoring

• Group and rearrange UCI option declaration and config-gen by function/LuCI UI, and comment
• Encode required XML entities of text UPnP IGD config options until the daemon does so using the created function xml_encode
• Only generate UPnP IGD config if the protocol is enabled

(to merge with prior)

New/updated custom ACL UCI options and migrate section

• Note that the custom ACL is now rejected by default, if it is alone used, with no preset or listed accepted ports. Add (ignored) custom ACL template entries on migration
• Migrate custom ACL entries to the new section name acl_entry
• The following custom ACL UCI options been added or changed, and the previous options are migrated on the service restart:

acl_entry UCI options	Change	Previous name
action	New/updated values (1)
int_port	Remove colon separator (2)	int_ports
ext_port	Remove colon separator (2)	ext_ports
descr_filter	New option (3)

1. Allow ignore, and update action option to use the nftables terms (allow/deny -> accept/reject). To avoid adding inverted actions when changing via LuCI, ensure any missing are set, as LuCI and UCI had not matching action defaults. Missing actions are now ignored/logged
2. Ensure that the hyphen (-) is only used as a port range separator by migration, as the colon (:) is not valid in LuCI
3. Add missing UCI option to set a regular expression to check for a UPnP IGD IPv4 port map description, and fix the current collision with the comment field which was not noticed due to a daemon bug
   https://redirect.github.com/openwrt/packages/pull/24495
   https://redirect.github.com/miniupnp/miniupnp/pull/853

Code refactoring:

• Add a more universal usable is_port_or_range function instead of upnpd_get_port_range and check if it has a valid range, and removes a shellcheck warning
• Rename conf_rule_add function to upnpd_add_custom_acl_entry

Rename UCI section name to `settings` (v2.0)

Inspired/address copilot's PR review for a clearer config by rename UCI section name config (v1.0) -> settings (v2.0), helps on migration and to distinguish the updated config from the previous one easily

(to merge with prior)

Refactoring by separate service start and config-gen

• Remove config_foreach upnpd "upnpd" and replace it with regular function call, as init was not designed for a multi-instance setup, as the same tmpconf will be used/overwritten, and non-anonymous section
• Move code to make the custom vs. config file generation decision earlier, and only perform external interface detection with the second one, and rename function upnpd to upnpd_generate_config
• Replace unnecessary if cases with elif in init/hotplug
• Exit with 1 on errors to get an inactive service status
• Do not restart daemon in hotplug when using a custom config file, as then this file will not be regenerated on restarts

(to merge with prior)

Rearrange init functions and format firewall3.include

• Arrange start_service and main init functions first
• Format firewall3.include using shfmt

(to merge with prior)

Add second CGNAT option as requested by AquanJSW

To test with Tailscale. Also adds the required daemon fix (No public IPv4 address detection; issues with multiple clients, e.g. PCP/NAT-PMP)

(proposed for inclusion, to merge with prior)

(The italic commits are intended to be merged with the prior ones after review.)

Screenshots

The new network-wide access control functionality… can best be described using the LuCI screenshots:

Enabled Networks / Access Control (new)

Edit network access control settings (new)

Advanced Settings tab with new CGNAT functionality

UPnP IGD Adjustments tab (new)

LuCI notification if the related package is not updated (new)

Full LuCI screenshot

Related LuCI PR: openwrt/luci#7822
Tested on: OpenWrt 24.10.4 and current snapshot

The Port Control Protocol (PCP) is the successor to NAT-PMP, shares similar protocol concepts and packet formats, but supports IPv6 port mapping and options/extensions. For more information, see:
Port Mapping Protocols Overview and Comparison 2025: About UPnP IGD & PCP/NAT-PMP
https://github.com/Self-Hosting-Group/wiki/wiki/Port-Mapping-Protocols-Overview

[Neustradamus]

@Self-Hosting-Group: Nice PR!

cc: @systemcrash

[systemcrash]

A downgrade included in a patchset won't get accepted, since a downgrade may subtly reintroducing bugs for existing users, if we assume that point releases fix bugs only. Better to wait for a new release, and bump to that version.

Migrations are probably a more serious matter: those must be carried basically 'forever'. The best way is simply to avoid those. One might introduce a new setting, and deprecate the old one, and change the UI over to use the new one. Still a bit of a bumpy road.

I think personally this is minor in the grand scheme of things (rather unimportant settings), but other reviewers may take a much firmer stance on it since you are, after all, changing setting names.

[systemcrash]

What do you think about backporting the commit?

Acceptable. It just breaks compile at the next release bump when it no longer applies. Minor, I guess.

[systemcrash]

Every single test-build failed: Dirty patches detected, please refresh and review the diff

[Self-Hosting-Group]

@1715173329 Thank you very much for your reviews, the comments were very constructive and helpful. You have helped me to make significant progress with this PR.

I think I have now addressed all your wishes, even the more cosmetic ones, as you gave me the helpful tip to fix the mips builds. Now the mips/mipsel CI checks are working too!

[1715173329]

LGTM - Thank you!

[GeorgeSapkin]

@Self-Hosting-Group consider marking commits meant to be squashed as fixups so it's easier to understand what goes where. Or alternatively squash them as needed yourself.

[Self-Hosting-Group]

@1715173329

LGTM - Thank you!

Wow, nice! But first, we would need to look at the corresponding LuCI PR, and there is also a problem with the PR description to be updated. Can you take a look at it?
openwrt/luci#7822

[Self-Hosting-Group]

@hnyman

But first, we would need to look at the corresponding LuCI PR, and there is also a problem with the PR description to be updated. Can you take a look at it? openwrt/luci#7822

[Neustradamus]

@Self-Hosting-Group team: Maybe good to do the missing steps before ;)

[1715173329]

Can you take a look at it? openwrt/luci#7822

Unfortunately it's locked and I cannot make any comments.
I'm not an expert in LuCI, and I don't have time to check it recently.

[Self-Hosting-Group]

Unfortunately it's locked and I cannot make any comments. I'm not an expert in LuCI, and I don't have time to check it recently.

Thank you very much for checking. Perhaps someone else with the necessary permissions could correct this.