The macchina.io Remote Manager SDK - Secure Connectivity for IoT Devices
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
CppUnit
Crypto
Foundation
JSON
Net
NetSSL_OpenSSL
PageCompiler
Util
WebTunnel
XML
build
doc
.gitignore
DLLVersion.rc
LICENSE
Makefile
README.md
README_POCO
SDK.progen
SDK_vs100.sln
SDK_vs110.sln
SDK_vs120.sln
SDK_vs140.sln
SDK_vs150.sln
SDK_vs71.sln
SDK_vs80.sln
SDK_vs90.sln
SDK_x64_vs100.sln
SDK_x64_vs110.sln
SDK_x64_vs120.sln
SDK_x64_vs140.sln
SDK_x64_vs150.sln
SDK_x64_vs90.sln
VERSION
build_CE_vs90.cmd
build_vcexpress2008.cmd
build_vcexpress2010.cmd
build_vs100.cmd
build_vs110.cmd
build_vs120.cmd
build_vs140.cmd
build_vs150.cmd
build_vs90.cmd
buildsdk.sh
buildwin.cmd
components
configure
libversion

README.md

The macchina.io Remote Manager SDK

About macchina.io Remote Manager

macchina.io Remote Manager provides secure remote access to connected devices via HTTP or other TCP-based protocols and applications such as secure shell (SSH) or Virtual Network Computing (VNC). With macchina.io Remote Manager, any network-connected device running the Remote Manager Agent software (WebTunnelAgent, contained in this SDK) can be securely accessed remotely over the internet from browsers, mobile apps, desktop, server or cloud applications.

This even works if the device is behind a NAT router, firewall or proxy server. The device becomes just another host on the internet, addressable via its own URL and protected by the Remote Manager server against unauthorized or malicious access. macchina.io Remote Manager is a great solution for secure remote support and maintenance, as well as for providing secure remote access to devices for end-users via web or mobile apps.

Visit macchina.io to learn more and to register for a free account. Specifically, see the Getting Started page and the Frequently Asked Questions for information on how to use this SDK and the included WebTunnelAgent executable.

There is also a blog post showing step-by-step instructions to connect a Raspberry Pi.

About This SDK

The macchina.io Remote Manager SDK is based on the POCO C++ Libraries. You may want to read README_POCO first as it contains important information regarding the directory structure and the build system of the SDK.

The SDK contains the WebTunnel library, which implements the tunnel protocol used by Remote Manager. Furthermore, the following executables are included:

  • WebTunnelAgent: This executable runs on the device and creates the secure tunnel between the device and the Remote Manager server. This is the most important component of the Remote Manager SDK.
  • WebTunnelClient: This executable can run on a client PC to create a secure tunnel from the PC to the device, via the Remote Manager server. It is required for tunneling protocols like SSH or other TCP-based protocols not directly supported by the Remote Manager server.
  • WebTunnelSSH: This is a variant of WebTunnelClient that first creates a tunnel connection from your PC to the device, then launches a SSH client using that tunnel connection.
  • WebTunnelVNC: This is a variant of WebTunnelVNC that first creates a tunnel connection from your PC to the device, then launches a VNC viewer using that tunnel connection.

The macchina.io Remote Manager SDK is licensed under the Boost Software License.

External Dependecies

The macchina.io Remote Manager SDK requires OpenSSL 1.0 or newer. We recommend using at least OpenSSL 1.0.2.

Most Unix/Linux systems already have OpenSSL preinstalled. If your system does not have OpenSSL, please get it from http://www.openssl.org or another source. You do not have to build OpenSSL yourself - a binary distribution is fine (e.g., apt-get install openssl libssl-dev).

The easiest way to install OpenSSL on Windows is to use a binary (prebuild) release, for example the one from Shining Light Productions that comes with a Windows installer http://www.slproweb.com/products/Win32OpenSSL.html. Depending on where you have installed the OpenSSL libraries, you might have to edit the build script (buildwin.cmd), or add the necessary paths to the INCLUDE and LIB environment variables.

On Unix/Linux/OS X, GNU make 3.80 or newer is required.

Building on Linux and OS X

The Easy Way

The easy way to build the SDK on Linux or OS X is to run the buildsdk.sh script:

git clone https://github.com/my-devices/sdk.git
cd sdk
./buildsdk.sh

It will make the necessary invocations of the configure script and GNU make to build WebTunnelAgent and WebTunnelClient, along with the required libraries. With this build, the required POCO libraries (Foundation, Net, Util, WebTunnel, Crypto and NetSSL_OpenSSL) will be linked statically into the final applications. If you don't want this, because you want to use other parts of POCO in your project and link the shared libraries, you'll have to run the necessary commands manually. You'll also have to do a manual build if your target does not have OpenSSL.

The resulting executables will be located in the bin directory.

For cross-compiling for an embedded platform, pass the name of a build configuration to the buildsdk.sh script. For example, to build for Angstrom:

./buildsdk.sh Angstrom

See the build/config directory for available build configurations. If there's no build configuration that fits your target, you'll have to create one yourself. This is best done by copying an existing one, making the necessary changes (typically, changing the name of the compiler and linker executables to match your particular toolchain, and modifying compiler/linker settings if necessary). Specify the name of your new build configuration in the call to buildsdk.sh.

For more information regarding the build system, see the POCO C++ Libraries documentation at http://pocoproject.org/docs.

A final note: buildsdk.sh only builds the release configuration. If you need a debug build, see below.

Customizing The SDK Build

To customize the SDK build, invoke the configure script and GNU make manually, as described in README_POCO.

./configure --cflags=-DPOCO_UTIL_NO_XMLCONFIGURATION --no-tests --no-samples --static
make -s -j8 DEFAULT_TARGET=static_release
export POCO_BASE=`pwd`
cd WebTunnel/Agent
make -s DEFAULT_TARGET=shared_release

A few notes on the arguments:

  • --cflags=-DPOCO_UTIL_NO_XMLCONFIGURATION instructs the build system to omit support for XML configuration files. The result is that the PocoXML library does not need to be linked into the application, saving a few 100Ks of executable size.
  • --no-tests and --no-samples instruct the build system not to build the POCO sample applications and the testsuites.
  • --static instructs the build system to build static libraries.
  • DEFAULT_TARGET=static_release instructs the build system to only build the release configuration.
  • DEFAULT_TARGET=shared_release (in the second call to GNU make for building the WebTunnelAgent and WebTunnelClient executables) instructs the build system to link against the shared runtime libraries (C and C++ standard libraries, OpenSSL), but use the static POCO libraries (since only these are available).
  • WEBTUNNEL_ENABLE_TLS=1 enables SSL/TLS support for WebTunnelAgent and WebTunnelClient.

If your system does not have OpenSSL, run configure and GNU make as follows:

./configure --cflags=-DPOCO_UTIL_NO_XMLCONFIGURATION --omit=Crypto,NetSSL_OpenSSL --no-tests --no-samples --static
make -s -j8 DEFAULT_TARGET=static_release
export POCO_BASE=`pwd`
cd WebTunnel/Agent
make -s WEBTUNNEL_DISABLE_TLS=1 DEFAULT_TARGET=shared_release

For a cross-build for an embedded target, you must specify the build configuration in the call to ./configure and the final call to GNU make.

./configure --cflags=-DPOCO_UTIL_NO_XMLCONFIGURATION --no-tests --no-samples --static --config=Angstrom
make -s -j8 DEFAULT_TARGET=static_release
export POCO_BASE=`pwd`
cd WebTunnel/Agent
make -s POCO_CONFIG=Angstrom DEFAULT_TARGET=shared_release

Building on Windows

For Windows, you'll need Visual C++. Any version from 2008 to 2017 is fine.

The easiest way to build on Windows is to open the proper SDK_vsNNN.sln solution for you preferred version of Visual Studio. SDK_vs90.sln is for Visual Studio 2008, SDK_vs120.sln is for Visual Studio 2013, etc. Then, build the release_static_mt configuration, which will produce self-contained statically linked executables for WebTunnelAgent and the other programs.

Alternatively, you can run one of the build_vsNNN.cmd scripts. For Visual Studio 2008, run build_vs90.cmd, for Visual Studio 2013 run build_vs120.cmd, etc.:

git clone https://github.com/my-devices/sdk.git
cd sdk
build_vs120

The statically linked executables will be located in WebTunnel\WebTunnelAgent\bin\static_mt, WebTunnel\WebTunnelClient\bin\static_mt, etc.

You can also use the buildwin.cmd script for greater flexibility. Run it without arguments to see available options. Also, see README_POCO for more information.