2014-03-15 16:59:03 +00:00
|
|
|
Project: miniupnp
|
2023-12-30 16:35:35 +00:00
|
|
|
Project web page: http://miniupnp.free.fr/ or https://miniupnp.tuxfamily.org/
|
|
|
|
|
github: https://github.com/miniupnp/miniupnp
|
2014-03-15 16:59:03 +00:00
|
|
|
Author: Thomas Bernard
|
2023-12-30 16:35:35 +00:00
|
|
|
Copyright (c) 2005-2023 Thomas Bernard
|
2014-03-15 16:59:03 +00:00
|
|
|
This software is subject to the conditions detailed in the
|
|
|
|
|
LICENSE file provided within this distribution.
|
|
|
|
|
|
|
|
|
|
|
2023-12-30 16:35:35 +00:00
|
|
|
* miniUPnP Client - miniUPnPc *
|
2014-03-15 16:59:03 +00:00
|
|
|
|
|
|
|
|
To compile, simply run 'gmake' (could be 'make' on your system).
|
|
|
|
|
Under win32, to compile with MinGW, type "mingw32make.bat".
|
2023-12-30 16:35:35 +00:00
|
|
|
MS Visual C solution and project files are supplied in the msvc/ subdirectory.
|
|
|
|
|
The miniupnpc library is available as a static library or as a DLL :
|
|
|
|
|
define MINIUPNP_STATICLIB if you want to link against the static library.
|
|
|
|
|
|
2014-03-15 16:59:03 +00:00
|
|
|
The compilation is known to work under linux, FreeBSD,
|
|
|
|
|
OpenBSD, MacOS X, AmigaOS and cygwin.
|
|
|
|
|
The official AmigaOS4.1 SDK was used for AmigaOS4 and GeekGadgets for AmigaOS3.
|
|
|
|
|
upx (http://upx.sourceforge.net) is used to compress the win32 .exe files.
|
|
|
|
|
|
|
|
|
|
To install the library and headers on the system use :
|
|
|
|
|
> su
|
|
|
|
|
> make install
|
|
|
|
|
> exit
|
|
|
|
|
|
2023-12-30 16:35:35 +00:00
|
|
|
alternatively, to install into a specific location, use :
|
2014-03-15 16:59:03 +00:00
|
|
|
> INSTALLPREFIX=/usr/local make install
|
|
|
|
|
|
|
|
|
|
upnpc.c is a sample client using the libminiupnpc.
|
|
|
|
|
To use the libminiupnpc in your application, link it with
|
|
|
|
|
libminiupnpc.a (or .so) and use the following functions found in miniupnpc.h,
|
|
|
|
|
upnpcommands.h and miniwget.h :
|
|
|
|
|
- upnpDiscover()
|
2023-12-30 16:35:35 +00:00
|
|
|
- UPNP_GetValidIGD()
|
2014-03-15 16:59:03 +00:00
|
|
|
- miniwget()
|
|
|
|
|
- parserootdesc()
|
|
|
|
|
- GetUPNPUrls()
|
|
|
|
|
- UPNP_* (calling UPNP methods)
|
|
|
|
|
|
|
|
|
|
Note : use #include <miniupnpc/miniupnpc.h> etc... for the includes
|
|
|
|
|
and -lminiupnpc for the link
|
|
|
|
|
|
|
|
|
|
Discovery process is speeded up when MiniSSDPd is running on the machine.
|
|
|
|
|
|
2023-12-30 16:35:35 +00:00
|
|
|
|
2014-03-15 16:59:03 +00:00
|
|
|
* Python module *
|
|
|
|
|
|
2023-12-30 16:35:35 +00:00
|
|
|
you can build a python module with 'make pythonmodule'
|
2014-03-15 16:59:03 +00:00
|
|
|
and install it with 'make installpythonmodule'.
|
|
|
|
|
setup.py (and setupmingw32.py) are included in the distribution.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Feel free to contact me if you have any problem :
|
|
|
|
|
e-mail : miniupnp@free.fr
|
|
|
|
|
|
|
|
|
|
If you are using libminiupnpc in your application, please
|
|
|
|
|
send me an email !
|
|
|
|
|
|
|
|
|
|
For any question, you can use the web forum :
|
2023-12-30 16:35:35 +00:00
|
|
|
https://miniupnp.tuxfamily.org/forum/
|
|
|
|
|
|
|
|
|
|
Bugs should be reported on GitHub :
|
|
|
|
|
https://github.com/miniupnp/miniupnp/issues
|
|
|
|
|
|
|
|
|
|
* Linux firewall configuration for UPnP clients *
|
|
|
|
|
|
|
|
|
|
Due to how UPnP protocol is designed, unicast responses to UPnP multicast client
|
|
|
|
|
requests are not tracked by Linux netfilter. And therefore netfilter executes
|
|
|
|
|
default action for them (which is in most cases DROP response packet).
|
|
|
|
|
|
|
|
|
|
To workaround this limitation, custom ipset hash table can be used. It is
|
|
|
|
|
supported since Linux kernel >= 2.6.39.
|
|
|
|
|
|
|
|
|
|
Rules for IPv4:
|
|
|
|
|
$ ipset create upnp hash:ip,port timeout 3
|
|
|
|
|
$ iptables -A OUTPUT -d 239.255.255.250/32 -p udp -m udp --dport 1900 -j SET --add-set upnp src,src --exist
|
|
|
|
|
$ iptables -A INPUT -p udp -m set --match-set upnp dst,dst -j ACCEPT
|
|
|
|
|
$ iptables -A INPUT -d 239.255.255.250/32 -p udp -m udp --dport 1900 -j ACCEPT
|
|
|
|
|
|
|
|
|
|
Rules for IPv6:
|
|
|
|
|
$ ipset create upnp6 hash:ip,port timeout 3 family inet6
|
|
|
|
|
$ ip6tables -A OUTPUT -d ff02::c/128 -p udp -m udp --dport 1900 -j SET --add-set upnp6 src,src --exist
|
|
|
|
|
$ ip6tables -A OUTPUT -d ff05::c/128 -p udp -m udp --dport 1900 -j SET --add-set upnp6 src,src --exist
|
|
|
|
|
$ ip6tables -A INPUT -p udp -m set --match-set upnp6 dst,dst -j ACCEPT
|
|
|
|
|
$ ip6tables -A INPUT -d ff02::c/128 -p udp -m udp --dport 1900 -j ACCEPT
|
|
|
|
|
$ ip6tables -A INPUT -d ff05::c/128 -p udp -m udp --dport 1900 -j ACCEPT
|
2014-03-15 16:59:03 +00:00
|
|
|
|
2023-12-30 16:35:35 +00:00
|
|
|
Detailed description is available on:
|
|
|
|
|
https://serverfault.com/a/911286
|
|
|
|
|
https://unix.stackexchange.com/a/444804
|
