From 282413951068c7dd0dfee8a76b18c20e5688f555 Mon Sep 17 00:00:00 2001 From: Erik Hollensbe Date: Tue, 1 Jun 2021 09:27:05 -0700 Subject: [PATCH 1/4] Small dockerfile release fixes - Activate zerotier-one.port file (we'll do more with this later) - Add a better process trap Signed-off-by: Erik Hollensbe --- entrypoint.sh.release | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/entrypoint.sh.release b/entrypoint.sh.release index 1683ad4c4..92c57be7c 100644 --- a/entrypoint.sh.release +++ b/entrypoint.sh.release @@ -30,6 +30,16 @@ then mkztfile identity.secret 0600 "$ZEROTIER_IDENTITY_SECRET" fi +mkztfile zerotier-one.port 0600 "9993" + +killzerotier() { + echo "Killing zerotier" + kill $(cat /var/lib/zerotier-one/zerotier-one.pid) + exit 0 +} + +trap killzerotier INT TERM + echo "starting zerotier" setsid /usr/sbin/zerotier-one & From 5c508515c450a0a90990ba5e89e33c46bbfa6613 Mon Sep 17 00:00:00 2001 From: Erik Hollensbe Date: Tue, 1 Jun 2021 12:30:01 -0700 Subject: [PATCH 2/4] Fix issue requiring CAP_SYS_PTRACE Signed-off-by: Erik Hollensbe --- entrypoint.sh.release | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/entrypoint.sh.release b/entrypoint.sh.release index 92c57be7c..adc258194 100644 --- a/entrypoint.sh.release +++ b/entrypoint.sh.release @@ -1,7 +1,7 @@ #!/bin/sh grepzt() { - (find /proc -name exe | xargs -I{} readlink {}) 2>/dev/null | grep -q zerotier-one + [ ! -n "$(cat /var/lib/zerotier-one/zerotier-one.pid)" -a -d "/proc/$(cat /var/lib/zerotier-one/zerotier-one.pid)" ] return $? } @@ -41,7 +41,7 @@ killzerotier() { trap killzerotier INT TERM echo "starting zerotier" -setsid /usr/sbin/zerotier-one & +nohup /usr/sbin/zerotier-one & while ! grepzt do From 60c1fcbc482a673ba81e3f840aea8b6fb5ff1c22 Mon Sep 17 00:00:00 2001 From: Erik Hollensbe Date: Wed, 2 Jun 2021 14:31:34 -0700 Subject: [PATCH 3/4] Docker usage README Signed-off-by: Erik Hollensbe --- README.docker.md | 71 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) create mode 100644 README.docker.md diff --git a/README.docker.md b/README.docker.md new file mode 100644 index 000000000..e38762b90 --- /dev/null +++ b/README.docker.md @@ -0,0 +1,71 @@ +# ZeroTier One in a container! + +**NOTE:** _Most of this information pertains to the docker image only. For more information about ZeroTier, check out the repository_: [here](https://github.com/zerotier/ZeroTierOne) or the [commercial website](https://www.zerotier.com). + +[ZeroTier](https://www.zerotier.com) is a smart programmable Ethernet switch for planet Earth. It allows all networked devices, VMs, containers, and applications to communicate as if they all reside in the same physical data center or cloud region. + +This is accomplished by combining a cryptographically addressed and secure peer to peer network (termed VL1) with an Ethernet emulation layer somewhat similar to VXLAN (termed VL2). Our VL2 Ethernet virtualization layer includes advanced enterprise SDN features like fine grained access control rules for network micro-segmentation and security monitoring. + +All ZeroTier traffic is encrypted end-to-end using secret keys that only you control. Most traffic flows peer to peer, though we offer free (but slow) relaying for users who cannot establish peer to peer connections. + +The goals and design principles of ZeroTier are inspired by among other things the original [Google BeyondCorp](https://static.googleusercontent.com/media/research.google.com/en//pubs/archive/43231.pdf) paper and the [Jericho Forum](https://en.wikipedia.org/wiki/Jericho_Forum) with its notion of "deperimeterization." + +Visit [ZeroTier's site](https://www.zerotier.com/) for more information and [pre-built binary packages](https://www.zerotier.com/download/). Apps for Android and iOS are available for free in the Google Play and Apple app stores. + +ZeroTier is licensed under the [BSL version 1.1](https://mariadb.com/bsl11/). See [LICENSE.txt](LICENSE.txt) and the [ZeroTier pricing page](https://www.zerotier.com/pricing) for details. ZeroTier is free to use internally in businesses and academic institutions and for non-commercial purposes. Certain types of commercial use such as building closed-source apps and devices based on ZeroTier or offering ZeroTier network controllers and network management as a SaaS service require a commercial license. + +A small amount of third party code is also included in ZeroTier and is not subject to our BSL license. See [AUTHORS.md](AUTHORS.md) for a list of third party code, where it is included, and the licenses that apply to it. All of the third party code in ZeroTier is liberally licensed (MIT, BSD, Apache, public domain, etc.). + +## Building the docker image + +Due to the network being a substrate for most applications and not an application unto itself, it makes sense that many people would want to build their own image based on our formula. + +The image is based on `debian:buster`. + +The `Dockerfile.release` file contains build instructions for building the described image in the rest of the README. The build is multi-arch and multi-release capable. + +These build arguments power the build: + +- `PACKAGE_BASEURL`: The base URL of the package repository to fetch from. (default: `https://download.zerotier.com/debian/buster/pool/main/z/zerotier-one/`) +- `ARCH`: The architecture of the package, in debian format. Must match your image arch. (default: `amd64`) +- `VERSION`: **REQUIRED** the version of ZeroTier to fetch. + +You can build this image like so: + +``` +docker build -f Dockerfile.release -t mybuild --build-arg VERSION=1.6.5 . +``` + +## Using the docker image + +The `entrypoint.sh` in the docker image is a little different; zerotier will be spawned in the background and the "main process" is actually just a sleeping shell script. This allows `zerotier-one` to gracefully terminate in some situations largely unique to docker. + +The `zerotier/zerotier` image requires the `CAP_NET_ADMIN` capability and the `/dev/net/tun` device must be forwarded to it. + +To join a network, simply supply it on the command-line; you can supply multiple networks. + +``` +docker run --name myzerotier --rm --cap-add NET_ADMIN --device /dev/net/tun zerotier/zerotier:latest abcdefdeadbeef00 +``` + +Once joining all the networks you have provided, it will sleep until terminated. Note that in ZeroTier, joining a network does not necessarily mean you have an IP or can do anything, really. You will want to probe the control socket: + +``` +docker exec myzerotier zerotier-cli listnetworks +``` + +To ensure you have a network available before trying to listen on it. Without pre-configuring the identity, this usually means going to the central admin panel and clicking the checkmark against your zerotier identity. + +### Environment Variables + +You can control a few settings including the identity used and the authtoken used to interact with the control socket (which you can forward and access through `localhost:9993`). + +- `ZEROTIER_API_SECRET`: replaces the `authtoken.secret` before booting and allows you to manage the control socket's authentication key. +- `ZEROTIER_IDENTITY_PUBLIC`: the `identity.public` file for zerotier-one. Use `zerotier-idtool` to generate one of these for you. +- `ZEROTIER_IDENTITY_SECRET`: the `identity.secret` file for zerotier-one. Use `zerotier-idtool` to generate one of these for you. + +### Tips + +- Forwarding port `:9993` to somewhere outside is probably a good idea for highly trafficked services. +- Forwarding `localhost:9993` to a control network where you can drive it remotely might be a good idea, just be sure to set your authtoken properly through environment variables. +- Pre-generating your identities could be much simpler to do via our [terraform plugin](https://github.com/zerotier/terraform-provider-zerotier) From 788296ea29a982ce9ce12aea52a262bfe1794417 Mon Sep 17 00:00:00 2001 From: Erik Hollensbe Date: Wed, 2 Jun 2021 14:36:55 -0700 Subject: [PATCH 4/4] Expand links in a few spots since this'll be used in the docker image Signed-off-by: Erik Hollensbe --- README.docker.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.docker.md b/README.docker.md index e38762b90..17e3cf4b8 100644 --- a/README.docker.md +++ b/README.docker.md @@ -12,9 +12,9 @@ The goals and design principles of ZeroTier are inspired by among other things t Visit [ZeroTier's site](https://www.zerotier.com/) for more information and [pre-built binary packages](https://www.zerotier.com/download/). Apps for Android and iOS are available for free in the Google Play and Apple app stores. -ZeroTier is licensed under the [BSL version 1.1](https://mariadb.com/bsl11/). See [LICENSE.txt](LICENSE.txt) and the [ZeroTier pricing page](https://www.zerotier.com/pricing) for details. ZeroTier is free to use internally in businesses and academic institutions and for non-commercial purposes. Certain types of commercial use such as building closed-source apps and devices based on ZeroTier or offering ZeroTier network controllers and network management as a SaaS service require a commercial license. +ZeroTier is licensed under the [BSL version 1.1](https://mariadb.com/bsl11/). See [LICENSE.txt](https://github.com/zerotier/ZeroTierOne/blob/master/LICENSE.txt) and the [ZeroTier pricing page](https://www.zerotier.com/pricing) for details. ZeroTier is free to use internally in businesses and academic institutions and for non-commercial purposes. Certain types of commercial use such as building closed-source apps and devices based on ZeroTier or offering ZeroTier network controllers and network management as a SaaS service require a commercial license. -A small amount of third party code is also included in ZeroTier and is not subject to our BSL license. See [AUTHORS.md](AUTHORS.md) for a list of third party code, where it is included, and the licenses that apply to it. All of the third party code in ZeroTier is liberally licensed (MIT, BSD, Apache, public domain, etc.). +A small amount of third party code is also included in ZeroTier and is not subject to our BSL license. See [AUTHORS.md](https://github.com/zerotier/ZeroTierOne/blob/master/AUTHORS.md) for a list of third party code, where it is included, and the licenses that apply to it. All of the third party code in ZeroTier is liberally licensed (MIT, BSD, Apache, public domain, etc.). ## Building the docker image