ENFTUN - Xaptum ENF Tunnel Client

enftun is a tunnel client for connecting to the Xaptum Edge Network Fabric (ENF).

Installation

enftun is available for the following Linux distributions. It may also be built from source.

Debian (Stretch, Buster) and Ubuntu (Bionic)

DIST=$(lsb_release -cs)

# Install the Xaptum API repo GPG signing key.
sudo apt-get install dirmngr
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys c615bfaa7fe1b4ca

# Add the repository to your APT sources
echo "deb https://xaptum.jfrog.io/artifactory/debian ${DIST} main" | sudo tee /etc/apt/sources.list.d/xaptum.list
sudo apt-get update

# Install the library.
sudo apt-get install enftun

Installation from Source

Build Dependencies

• CMake (version 3.0 or higher)

• A C99-compliant compiler

• OpenSSL (version 1.1.0 or higher)

• LibUV (version 1.9 or higher)

• LibConfig (version 1.5 or higher)

• xtt (version 0.12.0 or higher)

  • If building with XTT and TPM support

• LibJansson

  • If building with keygen support

Building the Binary

# Create a subdirectory to hold the build
mkdir -p build
cd build

# Configure the build
cmake .. -DCMAKE_BUILD_TYPE=RelWithDebInfo

# Build the library
cmake --build .

# Install the libary
cmake --build . --target install

CMake Options

The following CMake configuration options are supported.

Option	Values	Default	Description
CMAKE_BUILD_TYPE	Release		With full optimizations.
	Debug		With debug symbols.
	RelWithDebInfo		With full optimizations and debug symbols.
	Dev		With warnings treated as errors and full optimizations.
	DevDebug		With warnings treated as errors and debug symbols.
CMAKE_INSTALL_PREFIX		/usr/local	The directory to install the library in.
BUILD_CACERT	ON, OFF	ON	Install the the ENF ca cert
BUILD_EXAMPLE	ON, OFF	ON	Build and install example configs
BUILD_SYSTEMD	ON, OFF	ON	Build with systemd support
BUILD_TEST	ON, OFF	ON	Build tests
BUILD_TPM	ON, OFF	ON	Build with TPM support
BUILD_XTT	ON, OFF	ON	Build with XTT support
BUILD_HSS	ON, OFF	OFF	Build with HSS support

Usage

Using Systemd

A systemd unit file to manage an enftun are included in this repo.

The example config files example/device.conf and example/server.conf are installed to /usr/share/doc/enftun/example/. First copy the desired starting config to /etc/enftun/enf0.conf and make any desired changes.

Then enable or start the enftun services.

# Enable enf0 to start on boot
systemctl enable enftun-setup@enf0
systemctl enable enftun@enf0

# Start enf0 manually
systemctl start enftun@enf0

Manual usage

An example configuration file is located in example/example.conf. See documentation in the example file for more information.

enftun-setup

The TUN device should be created must be created prior to starting enftun.

Additionally, any desired routes should be configured before other networking services start. This will ensure that traffic intended for the ENF cannot transit a different interface before the enftun is configured.

The enftun-setup script included in this package will perform this setup.

enftun-setup up <path_to_config_file>

enftun

After enftun-setup is complete, run the enftun.

enftun -c <path_to_config_file>

Development

An example server is available for testing and development. It responds to ICMPv6 echo requests from the client, so ping -6 ... can be used from the client to test the connection.

Python3 and the dependencies listed in test/requirements.txt must be installed.

To start the server run:

$ cd test
$ python3 router.py

In a separate terminal, run the tunnel.

$ cd build
$ ./enftun -c conf/example.conf

Virtual Environment

The required Python3 dependencies can be installed in a local virtual environment rather than in the global system directories.

$ cd test

# Create a virtual environment for python
$ python3 -m venv enftun-env
$ source enftun-env/bin/activate

# Install the dependencies
(enftun-env) $ pip3 install -r requirements.txt

# Run the router
(enftun-env) $ python3 router.py

License

Copyright 2018-2019 Xaptum, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License from the LICENSE.txt file or at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.