Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time

ENF Services

This repo contains Docker images to easily run some common, predefined services on the Xaptum ENF. Run them directly or use them as inspiration for your own.

The Xaptum ENF is a secure and scalable IPv6 overlay network for IoT that is isolated and protected from the public Internet. Docker containers are an easy way deploy backend services on your ENF.

Services

Images for each container are published to the Xaptum Docker Hub.

The source for each is contained in a subdirectory in this repo.

Usage

We recommend using cloud or physical servers running Linux to run Docker containers on your ENF network. For testing and development, a desktop may be more convenient.

This section walks through the three main steps for running Docker images on the ENF.

Configure Docker for IPv6

Docker images for the ENF require IPv6 support, which is not enabled by default in most Docker installations. To enable it, add the following options to the Docker daemon configuration file daemon.json.

  • "ipv6" : true
  • "fixed-cidr-v6" : "fd00:d0c::/64"

and restart the Docker daemon.

On Linux, daemon.json is located at /etc/docker/daemon.json. On Mac OS, change it via the Docker Preferences->Daemon->Advanced menu.

The fixed-cidr-v6 option is required due to a bug in Docker. The fd00:d0c::/64 prefix is arbitary. Replace it as desired.

Generate ENF Access Keys

Each Docker container is one endpoint (IPv6) on your ENF and requires its own credentials to connect to the ENF.

Create these credentials using the enftun-keygen utility included in the Docker image:

# Create a local directory on the host to store the credentials
mkdir -p enf0

# Create the credentials and register with the ENF
#
# Replace <USERNAME> with your ENF account username
# Replace <ADDRESS> with the desired ENF IPv6 address or ::/64 network
# for the container. If just the network is specified, a random
# address will be assigned.
docker run --volume $(pwd)/enf0:/data/enf0 -it --entrypoint /usr/bin/enftun-keygen xaptum/enftun:latest -c /etc/enftun/enf0.conf -u <USERNAME> -a <ADDRESS>

Pick a memorable IPv6 address for the container. For example, 2607:8f80::deb:1 would be a good choice for a Debian APT repo container.

Run the Docker Image

Run the Docker image using this command.

docker run --cap-add=NET_ADMIN --device /dev/net/tun:/dev/net/tun \
           --sysctl net.ipv6.conf.all.disable_ipv6=0              \
           --sysctl net.ipv6.conf.default.disable_ipv6=0          \
           --volume $(pwd)/enf0:/data/enf0:ro                     \
           --name <name> <image>

The following table explains these options.

Option Description
--cap-add=NET_ADMIN Manage ENF tunnel network interface
--device /dev/net/tun:/dev/net/tun Create a ENF tunnel network interface
--sysctl net.ipv6.conf.all.disable_ipv6=0 Enable IPv6 on network interfaces in the container
--sysctl net.ipv6.conf.default.disable_ipv6=0 Enable IPv6 on network interfaces in the container
--volume <path_to_credentials>:/data/enf0:ro Mount the ENF access credentials into the container

Additional Details

Remember to configure the ENF firewall to allow devices to communicate with this service.

For details on a specific service, see the README in its directory.

Troubleshooting

Repeated TLS Connection Attempts

Repeated TLS connection attempts are usually caused by an incorrect certificate or key.

<7>Loaded server TLS certificate /etc/enftun/enf.cacert.pem
<7>Loaded client TLS certificate /data/enf0/enf0.crt.pem
<7>Loaded client TLS private key /data/enf0/enf0.key.pem
<7>Validated client TLS cert and private key
<7>TCP: connecting to [23.147.128.112]:443
<6>TCP: Connected to [23.147.128.112]:443
<6>Completed TLS handshake
<6>Opened tun device enf0
<6>Started.
<6>Stopped.
<3>Failed to shutdown TLS connection0:(null):(null):(null)
<7>Loaded server TLS certificate /etc/enftun/enf.cacert.pem
<7>Loaded client TLS certificate /data/enf0/enf0.crt.pem
<7>Loaded client TLS private key /data/enf0/enf0.key.pem
<7>Validated client TLS cert and private key
<7>TCP: connecting to [23.147.128.112]:443
<6>TCP: Connected to [23.147.128.112]:443
<6>Completed TLS handshake
<6>Opened tun device enf0
<6>Started.
<6>Stopped.

Run

openssl x509 -in=enf0.crt.pem -noout -text

to verify that the CN= fields contain the intended IPv6 address.

Certificate:
<snip>
    Signature Algorithm: ecdsa-with-SHA256
        Issuer: CN=2607:8f80::deb:1
        Validity
            Not Before: Apr 23 21:21:02 2020 GMT
            Not After : Apr 23 21:21:02 2021 GMT
        Subject: CN=2607:8f80::deb:1
<snip>

If the IPv6 address is incorrect, recreate the certicate using the enfcli.

License

Copyright 2019–2020 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.