miniupnp/miniupnpc
Yat Ho 542febeb95
miniupnpc: bump CMake version to 3.14
2024-05-13 16:21:28 +08:00
..
include miniupnpc: distinguish between not connected IGD and connected to a private IP 2024-05-08 17:37:17 +02:00
java JavaBridgeTest.java: follow UPNP_GetValidIGD() changes 2024-05-09 16:57:13 +02:00
man3 miniupnpc: distinguish between not connected IGD and connected to a private IP 2024-05-08 17:37:17 +02:00
msvc MS VS project: upnpc-shared.exe for exe using the .dll 2022-05-15 16:38:15 +02:00
src miniupnpcmodule.c: 2024 2024-05-09 17:11:42 +02:00
testdesc
testreplyparse
.gitignore .gitignore: wingenminiupnpcstrings 2020-11-30 01:59:15 +01:00
CMakeLists.txt miniupnpc: bump CMake version to 3.14 2024-05-13 16:21:28 +08:00
Changelog.txt miniupnpc: distinguish between not connected IGD and connected to a private IP 2024-05-08 17:37:17 +02:00
LICENSE Refine LICENSE so github can understand it ;) 2022-02-19 18:38:48 +01:00
MANIFEST.in update MANIFEST.in 2021-08-22 23:26:10 +02:00
Makefile Makefile: also build python wheel and source tgz 2024-05-09 18:22:05 +02:00
Makefile.mingw appveyor.yml: also build python module source tar.gz and upload it 2024-05-09 18:22:12 +02:00
README 2022 => 2023 2023-01-26 23:53:58 +01:00
VERSION miniupnpc version 2.2.7 2024-03-20 00:27:28 +01:00
apiversions.txt miniupnpc: distinguish between not connected IGD and connected to a private IP 2024-05-08 17:37:17 +02:00
external-ip.sh
mingw32make.bat
miniupnpc-config.cmake Install cmake config file 2020-11-27 18:49:51 +00:00
miniupnpc.def
miniupnpc.pc.in miniupnpc/CMakeLists.txt: use project VERSION/DESCRIPTION/HOMEPAGE_URL 2022-10-15 17:36:28 +02:00
miniupnpc.rc mingw32: build resources for .dll 2020-11-30 01:21:26 +01:00
miniupnpcstrings.h.cmake miniupnpcstrings.h.cmake: use PROJECT_VERSION 2024-02-03 12:10:26 +01:00
miniupnpcstrings.h.in minisoap.c: Content type with charset=utf-8 2024-01-04 01:13:31 +01:00
pymoduletest.py pymoduletest.py: migrate to python 3 2021-11-09 19:56:15 +01:00
pymoduletest3.py
setup.py setup*.py: 2024 2024-01-15 00:30:01 +01:00
setupmingw32.py setup*.py: 2024 2024-01-15 00:30:01 +01:00
testminiwget.sh miniupnpc/testminiwget.sh / testupnpreplyparse.sh: allow to define executables 2022-10-21 22:45:46 +02:00
testupnpigd.py miniupnpc: update *.py files headers 2020-04-06 12:25:34 +02:00
testupnpreplyparse.sh miniupnpc/testminiwget.sh / testupnpreplyparse.sh: allow to define executables 2022-10-21 22:45:46 +02:00
updateminiupnpcstrings.sh Fix the build on NixOS 2022-03-21 19:37:25 +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-2023 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