miniupnp/miniupnpc
scribam bcaee022a3 miniupnpc/cmake: add _WINSOCK_DEPRECATED_NO_WARNINGS definition 2022-01-04 19:32:39 +01:00
..
include miniupnpc version 2.2.3 2021-09-28 23:47:00 +02:00
java changes java sample according to change of upnpDiscover() 2015-09-04 18:15:07 +02:00
man3 miniupnpc: fix typo 2018-02-03 01:12:45 +08:00
msvc update VC++ projects 2021-08-22 23:26:09 +02:00
src pythonmodule: allow to specify root desc url as selectigd() argument 2021-11-09 19:55:22 +01:00
testdesc miniupnpc: Add linksys_WAG200G_desc.xml to test 2014-11-26 12:39:43 +01:00
testreplyparse miniupnpc: added test cases for XML parsing 2014-01-27 16:27:51 +01:00
.gitignore .gitignore: wingenminiupnpcstrings 2020-11-30 01:59:15 +01:00
CMakeLists.txt miniupnpc/cmake: add _WINSOCK_DEPRECATED_NO_WARNINGS definition 2022-01-04 19:32:39 +01:00
Changelog.txt pythonmodule: allow to specify root desc url as selectigd() argument 2021-11-09 19:55:22 +01:00
LICENSE LICENSE / README : 2021 2021-08-22 23:15:53 +02:00
MANIFEST.in update MANIFEST.in 2021-08-22 23:26:10 +02:00
Makefile Makefile: fix install rules to account for $(BUILD) 2021-09-29 08:28:27 +02:00
Makefile.mingw doc: add windres to mingw *nix build command 2022-01-03 10:08:45 +08:00
README LICENSE / README : 2021 2021-08-22 23:15:53 +02:00
VERSION miniupnpc version 2.2.3 2021-09-28 23:47:00 +02:00
apiversions.txt miniupnpc: increments API_VERSION to 17 2018-04-06 12:48:24 +02:00
external-ip.sh Update external-ip.sh, only output on success 2017-09-28 15:14:22 -07:00
mingw32make.bat Added miniupnpc 2011-09-27 22:25:35 +02:00
miniupnpc-config.cmake Install cmake config file 2020-11-27 18:49:51 +00:00
miniupnpc.def Fix and simplify Makefile.mingw for miniupnpc 2020-04-02 18:45:46 +02:00
miniupnpc.rc mingw32: build resources for .dll 2020-11-30 01:21:26 +01:00
miniupnpcstrings.h.cmake miniupnpc: use #define UPNP_VERSION_STRING "UPnP/1.1" 2014-11-05 06:34:51 +01:00
miniupnpcstrings.h.in miniupnpc: use #define UPNP_VERSION_STRING "UPnP/1.1" 2014-11-05 06:34:51 +01:00
pymoduletest.py pymoduletest.py: migrate to python 3 2021-11-09 19:56:15 +01:00
pymoduletest3.py fix typo 2018-01-09 09:33:31 +08:00
setup.py WIP. Reorganize src build directories 2021-08-22 23:26:04 +02:00
setupmingw32.py fix setupmingw32.py 2021-08-22 23:26:10 +02:00
testminiwget.sh WIP. Reorganize src build directories 2021-08-22 23:26:04 +02:00
testupnpigd.py miniupnpc: update *.py files headers 2020-04-06 12:25:34 +02:00
testupnpreplyparse.sh WIP. Reorganize src build directories 2021-08-22 23:26:04 +02:00
updateminiupnpcstrings.sh updateminiupnpcstrings.sh: fix. "rm -v" is nonstandard 2021-09-28 23:46:17 +02:00
wingenminiupnpcstrings.c wingenminiupnpcstrings.c: fix -Wsign-compare warning 2021-05-19 10:33:33 +02:00

README

Project: miniupnp
Project web page: http://miniupnp.free.fr/ or https://miniupnp.tuxfamily.org/
github: https://github.com/miniupnp/miniupnp
Author: Thomas Bernard
Copyright (c) 2005-2021 Thomas Bernard
This software is subject to the conditions detailed in the
LICENSE file provided within this distribution.


* miniUPnP Client - miniUPnPc *

To compile, simply run 'gmake' (could be 'make' on your system).
Under win32, to compile with MinGW, type "mingw32make.bat".
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.

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

alternatively, to install into a specific location, use :
> 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()
- UPNP_GetValidIGD()
- 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.


* Python module *

you can build a python module with 'make pythonmodule'
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 :
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

Detailed description is available on:
https://serverfault.com/a/911286
https://unix.stackexchange.com/a/444804