VERSION 1.0.3: public preview release

After many months of intense development, ZeroTier is proud to release version
1.0.3 of ZeroTier One.

This version focuses on under-the-hood and network level improvements to
prepare the way for more user-facing improvements in the months to come, as
well as new products built around the ZeroTier core.

1.0.3 contains a large number of changes, so we're not going to push it out
via our auto-update mechanism yet. We're going to update the download links
on the web site and let users try it out for a while first. If problems are
found, we'll do a 1.0.4 before we push it out to existing installations.

--
Important note for Linux users: we've decided to stop pushing auto-updates for
Linux, and this version's official Linux binaries are built without update
checking enabled. Linux is used mostly on servers, and based on user feedback
we've found that most users don't like anything auto-updating outside of the
normal package management channels. Instead, we'll be working over the next
few months to get ZeroTier One included in a number of upstream Linux
distributions. That way you'll be able to 'apt-get' or 'yum' install it and
stay up to date that way. Auto-updates will remain for Macintosh and Windows
users until/unless we can move to 'app store' deployment on those platforms.
--

Now for the change list. It's a big one!

NEW FEATURES and IMPROVEMENTS

 * Client support is in place for preferred relays on a per-network basis.
   This allows you to define statically assigned nodes that act as relays for
   indirect communication and connection setup for communication between peers
   on a given virtual network. If defined, they'll be used in preference to
   supernodes for this purpose. If they're offline, ZeroTier will fall back to
   global supernodes. This will require support on the web control panel for
   most users to use.

 * This version sends NAT "keepalive" packets every 20 seconds, which is
   similar to the behavior of most SIP phones. This should improve reliability
   behind NATs with short timeouts and certain cheap consumer NAT devices.

 * Improvements have been made to NAT traversal to traverse more symmetric
   NAT configurations, and to rate limit traversal attempts to avoid looking
   like a port scan.

 * New direct paths are now confirmed prior to use. This should improve
   reliability in cases where a NAT traversal attempt "half succeeds" by
   preventing the use of direct links that aren't actually usable.

 * A new geo-located TCP tunneling fallback implementation should improve
   performance for heavily firewalled users who can't use UDP.

 * ZeroTier now uses remotely reported accounts of your external IP address
   to detect changes in your network connectivity instead of relying on
   "fingerprinting" of the OS-level local network environment. This should
   improve reliability in cases where external routers have dynamic IPs or
   when changing between networks with different external IPs but similar
   internal addressing schemes. This should also improve reliability for
   use within virtual machines, since the external link address might change
   but the VM's link addresses will not.

 * We've eliminated the old Unix domain socket (or named pipe on Windows)
   control bus in favor of a local HTTP JSON API. It runs on 127.0.0.1
   port 9993 and can be accessed via standard HTTP. This improves
   interoperability with scripts and other tools and allows us to use
   HTML5 for the desktop UI component. See README.md in the service/
   subfolder of the source tree for JSON API documentation.

 * The old Qt GUI has been dropped in favor of a React-based HTML5 UI. The
   code for this is found in ui/, and if ui/ is present in the ZeroTier
   home folder the JSON API HTTP server will serve it on 127.0.0.1/9993.
   The Windows and Mac UIs are now web control wrappers which access this
   UI locally and automate the process of token lookup and login.

PACKAGING / INSTALLATION IMPROVEMENTS

 * The Macintosh version is now packaged as a .pkg file instead of the old
   .app that would download its components and bootstrap itself. Several
   Mac users had problems with this, so we made it a package instead.

 * The Windows installer now includes a cleaner driver installation module
   that installs the driver as part of the main MSI file instead of spawning
   a subprocess.

BUG FIXES

 * Windows now comes with an updated NDIS6 Ethernet tap device driver.
   If you still have the old NDIS5 driver installed you'll keep using it,
   so if you want to switch to the NDIS6 driver uninstall your old version
   and do a fresh install of the new one. NDIS5 is deprecated, so we are
   hoping an NDIS6 driver will fix a number of difficult to reproduce
   issues that some Windows users have reported. It will also likely
   improve performance.

 * Fixed a "pseudo" memory leak related to the old auto-update code. The
   amount of "committed" (but not used) memory would increase over time.
   Since this was not actual used memory it didn't cause real problems,
   but the issue is gone now.

 * A very rare threading deadlock was fixed.

 * Fix for Linux installer that would falsely recognize systemd on some
   Ubuntu systems.

DEEP UNDER THE HOOD

 * This version has been heavily refactored at the source code level! The
   node/ subfolder now contains the core ZeroTier network virtualization
   engine without any OS-specific or transport-specific code. This is in
   preparation for future plans around embedded devices, etc. There is now
   a public C-level API in include/ZeroTierOne.h that defines an interface
   to the node core.

 * A new network controller implementation is in 1.0.3 based on SQLite and
   the local JSON API control bus. IT HAS NOT BEEN HEAVILY TESTED YET, so we
   do not recommend using it in production until the next version. You are
   welcome to experiment with it.

.gitignore

@@ -1,8 +1,73 @@
-zerotier-*
-/Makefile
-*.o
+# Main binaries created in *nix builds
+/zerotier-*
+
+# OS-created garbage files from various platforms
 .DS_Store
 .Apple*
-*.dSYM
-mac-tap/tuntap/src/tap/tap
-mac-tap/tuntap/tap.kext
+Thumbs.db
+
+# Windows build droppings
+/windows/ZeroTierOne.sdf
+/windows/ZeroTierOne.v11.suo
+/windows/x64
+/windows/Win32
+/windows/*/x64
+/windows/*/Win32
+/windows/ZeroTierOne/Release
+/windows/ZeroTierOneService/obj
+/windows/ZeroTierOneService/bin
+/windows/Build
+/windows/Debug
+/windows/Release
+/windows/WebUIWrapper/bin
+/windows/WebUIWrapper/obj
+/ext/installfiles/windows/ZeroTier One-SetupFiles
+/ext/installfiles/windows/Prerequisites
+/ext/installfiles/windows/*-cache
+/ZeroTier One.msi
+
+# *nix/Mac build droppings
+/build-*
+/ZeroTierOneInstaller-*
+
+# Miscellaneous file types that we don't want to check in
+*.log
+*.opensdf
+*.user
+*.cache
+*.obj
+*.tlog
+*.pid
+*.pkg
+*.o
+*.core
+*.deb
+*.rpm
+*.autosave
+*.tmp
+
+# Root topology build files, temporaries, and never check in secrets
+/root-topology/bin2c
+/root-topology/mktopology
+/root-topology/*.secret
+/root-topology/test/supernodes
+/root-topology/test/test-root-topology
+
+# MacGap wrapper build files
+/ext/mac-ui-macgap1-wrapper/src/MacGap.xcodeproj/project.xcworkspace/xcuserdata/*
+/ext/mac-ui-macgap1-wrapper/src/MacGap.xcodeproj/xcuserdata/*
+/ext/mac-ui-macgap1-wrapper/src/build
+
+# Web UI dev temporaries
+/ui/.module-cache
+node_modules
+
+# Java/Android/JNI build droppings
+java/obj/
+java/libs/
+java/bin/
+java/classes/
+java/doc/
+java/build_win64/
+java/build_win32/
+/java/mac32_64/

AUTHORS.txt

@@ -1,26 +1,27 @@
-This file will track authors and contributors to ZeroTier's code base.
-People who contribute new code or bug fixes that are accepted into
-the master (trunk) branch will be credited here.
+ZeroTier One is designed and written by Adam Ierymenko, with a few bug
+fixes and other contributions from other users. Information about all
+contributors can be found on the GitHub home page at:
 
---
+https://github.com/zerotier/ZeroTierOne
 
-Adam Ierymenko [adam.ierymenko@zerotier.com]
- * Principal author and maintainer of ZeroTier One, author of all
-   code prior to ZeroTier's open source release.
- * Maintainer of master branch, release manager.
-
---
-
-ZeroTier One includes or links with the following third party software:
+ZeroTier One includes the following third party code:
 
  * LZ4 compression algorithm by Yann Collet (BSD license)
    http://code.google.com/p/lz4/
 
- * OpenSSL libcrypto (BSD-style OpenSSL license)
-   http://www.openssl.org/
+ * http-parser by many authors (MIT license)
+   https://github.com/joyent/http-parser
 
- * TunTapOSX by Mattias Nissler (with tiny modifications) (BSD license)
+ * json-parser by James McLaughlin (BSD license)
+   https://github.com/udp/json-parser
+
+ * TunTapOSX by Mattias Nissler (forked for ZT1) (BSD license)
    http://tuntaposx.sourceforge.net
 
- * Salsa20 stream cipher by D. J. Bernstein (public domain)
-   http://cr.yp.to/snuffle.html
+ * tap-windows by the OpenVPN project (forked for ZT1) (GPL)
+   https://github.com/OpenVPN/tap-windows
+
+ * Salsa20 stream cipher, Curve25519 elliptic curve cipher, Ed25519
+   digital signature algorithm, and Poly1305 MAC algorithm, all by
+   Daniel J. Bernstein (public domain)
+   http://cr.yp.to/

BUILDING.txt

@@ -1,23 +0,0 @@
-Building ZeroTier One on different platforms:
-
-(See RUNNING.txt for what to do next.)
-
-Developers note: there is currently no management of dependencies on *nix
-platforms, so you should make clean ; make if you change a header. Will
-do this eventually.
-
--- MacOS
-
-make -f Makefile.mac
-
-Edit Makefile.mac if you want to change between debug or release build.
-
--- Linux
-
-make -f Makefile.linux
-
-Edit Makefile.linux if you want to change between debug or release build.
-
--- Windows
-
-TBD

Makefile

@@ -0,0 +1,18 @@
+# Common makefile -- loads make rules for each platform
+
+OSTYPE=$(shell uname -s)
+
+ifeq ($(OSTYPE),Darwin)
+	include make-mac.mk
+endif
+
+ifeq ($(OSTYPE),Linux)
+	include make-linux.mk
+endif
+
+ifeq ($(OSTYPE),FreeBSD)
+	include make-freebsd.mk
+endif
+ifeq ($(OSTYPE),OpenBSD)
+	include make-freebsd.mk
+endif

Makefile.linux

@@ -1,54 +0,0 @@
-CC=gcc
-CXX=g++
-
-INCLUDES=-Iext/bin/libcrypto/include -Iext/jsoncpp/include
-ARCH=$(shell uname -m)
-DEFS=-DZT_ARCH="$(ARCH)" -DZT_OSNAME="linux" -DZT_TRACE
-
-# Uncomment for a release optimized build
-#CFLAGS=-Wall -O3 -fno-unroll-loops -fstack-protector -pthread $(INCLUDES) -DNDEBUG $(DEFS)
-#STRIP=strip --strip-all
-
-# Uncomment for a debug build
-CFLAGS=-Wall -g -pthread $(INCLUDES) -DZT_TRACE $(DEFS)
-STRIP=echo
-
-CXXFLAGS=$(CFLAGS) -fno-rtti
-
-# We statically link against libcrypto because RedHat-derived distributions do
-# not ship the elliptic curve algorithms. If we didn't we'd have to build
-# separate binaries for the RedHat and Debian universes to distribute via
-# auto-update. This way we get one Linux binary for all systems of a given
-# architecture.
-LIBS=ext/bin/libcrypto/linux-$(ARCH)/libcrypto.a -lm -ldl
-
-include objects.mk
-
-all:	one cli launcher
-
-one:	$(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-one main.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-one
-
-cli:	$(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-cli cli.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-cli
-
-selftest:	$(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-selftest selftest.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-selftest
-
-idtool:	$(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-idtool idtool.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-idtool
-
-launcher:
-	$(CC) -Os -o zerotier-launcher launcher.c
-	$(STRIP) zerotier-launcher
-
-launcher-fakebin:
-	$(CC) $(CFLAGS) -DZEROTIER_FAKE_VERSION_MAJOR=1 -DZEROTIER_FAKE_VERSION_MINOR=2 -DZEROTIER_FAKE_VERSION_REVISION=3 -o zerotier-launcher-fakebin-123 launcher-fakebin.c
-	$(CC) $(CFLAGS) -DZEROTIER_FAKE_VERSION_MAJOR=1 -DZEROTIER_FAKE_VERSION_MINOR=2 -DZEROTIER_FAKE_VERSION_REVISION=4 -o zerotier-launcher-fakebin-124 launcher-fakebin.c
-
-clean:
-	rm -f $(OBJS) zerotier-*

Makefile.mac

@@ -1,63 +0,0 @@
-CC=gcc
-CXX=g++
-
-INCLUDES=-Iext/bin/libcrypto/include -Iext/jsoncpp/include
-DEFS=-DZT_ARCH="x86_combined" -DZT_OSNAME="mac" -DZT_TRACE
-
-# Uncomment for a release optimized universal binary build
-CFLAGS=-arch i386 -arch x86_64 -Wall -O3 -ftree-vectorize -fstack-protector -pthread -mmacosx-version-min=10.6 -DNDEBUG $(INCLUDES) $(DEFS)
-STRIP=strip
-
-# Uncomment for a debug build
-#CFLAGS=-Wall -g -pthread -DZT_TRACE -DZT_LOG_STDOUT $(INCLUDES) $(DEFS)
-#STRIP=echo
-
-CXXFLAGS=$(CFLAGS) -fno-rtti
-LIBS=-lcrypto -lm
-
-include objects.mk
-
-all: one cli launcher mac-tap
-
-one:	$(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-one main.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-one
-
-cli:	$(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-cli cli.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-cli
-
-selftest: $(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-selftest selftest.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-selftest
-
-idtool: $(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-idtool idtool.cpp $(OBJS) $(LIBS)
-	$(STRIP) zerotier-idtool
-
-mac-tap: FORCE
-	cd mac-tap/tuntap ; make tap.kext
-
-install-mac-tap: FORCE
-	mkdir -p /Library/Application\ Support/ZeroTier/One
-	rm -rf /Library/Application\ Support/ZeroTier/One/tap.kext
-	cp -R mac-tap/tuntap/tap.kext /Library/Application\ Support/ZeroTier/One
-	chown -R root:wheel /Library/Application\ Support/ZeroTier/One/tap.kext
-
-launcher: FORCE
-	$(CC) -Os -arch i386 -arch x86_64 -o zerotier-launcher launcher.c
-	$(STRIP) zerotier-launcher
-
-launcher-fakebin:
-	$(CC) $(CFLAGS) -DZEROTIER_FAKE_VERSION_MAJOR=1 -DZEROTIER_FAKE_VERSION_MINOR=2 -DZEROTIER_FAKE_VERSION_REV
-	$(CC) $(CFLAGS) -DZEROTIER_FAKE_VERSION_MAJOR=1 -DZEROTIER_FAKE_VERSION_MINOR=2 -DZEROTIER_FAKE_VERSION_REV
-
-makekeypair: $(OBJS)
-	$(CXX) $(CXXFLAGS) -o zerotier-makekeypair makekeypair.cpp $(OBJS) $(LIBS)
-
-clean:
-	rm -rf *.dSYM
-	rm -f $(OBJS) zerotier-*
-	cd mac-tap/tuntap ; make clean
-
-FORCE:

README.md

@@ -1,95 +1,171 @@
 ZeroTier One
 ======
 
-ZeroTier One creates flat virtual Ethernet networks of almost unlimited size. [Visit ZeroTier on the web](https://www.zerotier.com/) for more information.
+ZeroTier is a software defined networking layer for Earth.
 
-This code is presently in **ALPHA** testing. That means that the protocol spec may change in incompatible ways, and it certainly has bugs. Testers should "git pull," rebuild, and restart fairly often. If things mysteriously stop working, do that.
+It can be used for on-premise network virtualization, as a peer to peer VPN for mobile teams, for hybrid or multi-data-center cloud deployments, or just about anywhere else secure software defined virtual networking is useful.
 
-See BUILDING.txt and RUNNING.txt for instructions. It currently builds on Mac and Linux. A Windows port is coming soon. Nice packages/installers and auto-update are also coming when alpha transitions to beta.
+ZeroTier One is our OS-level client service. It allows Mac, Linux, Windows, FreeBSD, and soon other types of clients to join ZeroTier virtual networks like conventional VPNs or VLANs. It can run on native systems, VMs, or containers (Docker, OpenVZ, etc.).
 
-Note that this won't work if your firewall does not allow outbound UDP. It must allow UDP conversations on port 8993 at a minimum.
+Visit [ZeroTier's site](https://www.zerotier.com/) for more information. You can also download professionally packaged binary installers/packages for a variety of supported OSes there if you don't want to build ZeroTier One from source.
 
-At present there is only one virtual LAN and you are dumped there by default. It's called Earth, and is exactly what it sounds like. The ability to create and join additional networks is coming soon. Once you're on, visit [earth.zerotier.net](http://earth.zerotier.net/) to see your Earth LAN IP address and other information.
+### Building from Source
 
-**Security warning:** You read that right. ZeroTier One places your computer on an absolutely open global Ethernet party line. Please ensure that you are up to date on your OS patches and we recommend turning off unnecessary services. Also be sure that anything else you are sharing is password protected provided you don't want to share it: printers, iPhoto and iTunes shares, etc.
+For Mac, Linux, and BSD, just type "make" (or "gmake" on BSD). You won't need much installed; here are the requirements for various platforms:
 
-ZeroTier One is licensed under the GNU General Public License version 3. You are free to use, modify, or redistribute it under the terms of that license. If you would like to embed ZeroTier One in a closed source product or create a closed source derivative product, contact ZeroTier Networks LLC.
+ * Mac: Xcode command line tools, and [Packages](http://s.sudre.free.fr/Software/Packages/about.html) if you want to build an OSX .pkg installer ("make mac-dist-pkg"). It should build on OSX 10.7 or newer.
+ * Linux: gcc/g++ or clang/clang++ (Makefile will use clang by default if available.)
+ * FreeBSD (and other BSD): C++ compiler (G++ usually) and GNU make (gmake).
 
-Check out the [blog](http://blog.zerotier.com/) for announcements, in-depth articles, and related thoughts. There is also a [Google group](https://groups.google.com/forum/#!forum/zerotier-one-users) for questions and discussion.
+Each supported platform has its own *make-XXX.mk* file that contains the actual make rules for the platform. The right .mk file is included by the main Makefile based on the GNU make *OSTYPE* variable. Take a look at the .mk file for your platform for other targets, debug build rules, etc.
 
-----
-**FAQ**
+Windows, of course, is special. We build for Windows with Microsoft Visual Studio 2012 on Windows 7. A solution file is located in the *windows* subfolder. Newer versions of Visual Studio (and Windows) may work but haven't been tested. Older versions almost certainly will not, since they lack things like *stdint.h* and certain STL features. MinGW or other ports of gcc/clang to Windows should also work but haven't been tested. Build steps for Windows are a bit more complicated. For the moment you are on your own there.
 
-**Q:** What can I do with this?  
-**A:** For starters, try opening iTunes if you have it installed. If others are also online and sharing their collections, you might see them. If you have any games that run over a LAN (except those that require IPX), try those. What else can you think of to do on a completely flat, open network? Games? Collaborative software development? Remote debugging? Transferring files using simple drive shares? Sharing your desktop printer to someone on another continent? Use your imagination.
+Mobile versions are in progress. They don't work yet, and in any case only the glue code will be included in this repository. The full mobile apps are in private repositories on our own git server.
 
-**Q:** Why do I get an IP address in the 27.0.0.0 or 28.0.0.0 range? And why does a lookup claim these addresses belong to the U.S. Department of Defense?  
-**A:** Short answer: because IPv4 needs to die. Long answer: the Earth network assigns IPv4 IPs from these ranges. They do in fact belong to the DOD, but they are *not* routed to the open Internet. The DOD owns them but uses them internally for private networks. As a result, there is nothing *technically* wrong with "bogarting" these for our own private network. It's considered bad practice, but if you want a private address space in IPv4 that is unlikely to overlap other private address spaces (like 10/8 and 192.168/16), it's the only way. [Cellular carriers](http://www.androidcentral.com/sprint-internet-dept-defense-and-you)  and [cable companies](http://www.dslreports.com/forum/r25679029-Why-is-my-first-hop-to-a-DoD-assigned-IP-address-) frequently do the same thing.
+### Supported Platforms
 
-**Q:** Is IPv6 supported?  
-**A:** Yes. IPv6 link-local addresses (those in the fe80::/10 block) are auto-assigned and should work fine. No other IPv6 addresses are assigned *yet*, but there are plans to do interesting things in this area in the future.
+CPU architecture shouldn't matter unless it's smaller than 32-bit or something really bizarre like a "middle-endian" processor. We have reports of ZeroTier One running on arm32, arm64, and MIPS. It builds and runs out of the box on Raspberry Pi, BeagleBone, BananaPi, and other ARM-based developer/hobbyist boards.
 
-**Q:** I don't want a giant Ethernet party line. Can I leave it and create private LANs instead?  
-**A:** Yes, soon. A GUI to configure such things is in development. But for now there's only Earth.
+ZeroTier is written in C and C++ (C++03 / ISO/IEC 14882:2003) and uses data structures and algorithms from the C++03 STL. We do not use any C++11 features (yet), since we want to support a few old and embedded platforms that don't have C++11 compilers. You *will* require a compiler and headers new enough to support 64-bit integers (long long) and the *stdint.h* header. The latter could also be faked by adding defines for things like *uint32\_t*, *int64\_t*, etc.
 
-**Q:** Are you going to charge for this?  
-**A:** Public virtual LANs will remain free. We intend to charge for private networks in some way, but the exact model is TBD. Other cloud-supported paid features are also TBD.
+Typing "make selftest" will build a *zerotier-selftest* binary which unit tests various internals and reports on a few aspects of the build environment. It's a good idea to try this on novel platforms or architectures.
 
-**Q:** What's a supernode?  
-**A:** Supernodes are nodes run by ZeroTier Networks that orindary users use to find one another and communicate until/unless they can perform NAT traversal and connect directly. They run the exact same software as everyone else. The only thing that really makes a supernode special is that it's designated as such.
+### Running
 
-**Q:** Can I run a supernode?  
-**A:** No, not at the moment, and there would be no benefit to doing so.
+Running *zerotier-one* with -h will show help.
 
-**Q:** Will my local firewall rules apply to ZeroTier One traffic?  
-**A:** ZeroTier creates a virtual Ethernet tap device (zt# on Mac and Linux) that emulates a wired Ethernet port. If your firewall applies to *all* network ports, it will filter traffic through this port as well. If it applies only to the primary interface, it may not. See your OS's firewall documentation, as different OSes and flavors thereof have slightly different configurations in this regard.
+On Linux and BSD you can start the service with:
 
-**Q:** Can you see my traffic? What about other users? Can you sniff the LAN?  
-**A:** No. All unicast (direct computer to computer) traffic is encrypted end-to-end (even if it's being relayed), and the ZeroTier virtual LAN behaves like a LAN with a secure enterprise-grade switch that does not allow unicast conversations to be sniffed. Multicast and broadcast traffic will of course be seen by many recipients, but that's the idea.
+    sudo ./zerotier-one -d
 
-**Q:** What about privacy? Does this hide my location on the network?  
-**A:** ZeroTier is not a connection anonymizer. Other than encryption, it doesn't do anything special to hide your identity or network location. If you want strong privacy protection there are already very advanced tools like [Tor](https://www.torproject.org) for that, and this isn't trying to duplicate their functionality. At the same time, ZT does not do anything special to harm your privacy either. It's not spyware or snoop-ware.
+A home folder for your system will automatically be created.
 
-**Q:** Is this designed to replace IP, BGP, IPv6, routers, etc.?  
-**A:** No. Its purpose is to act as a collaboration tool, a VPN alternative, a network mobility tool, a testbed for the development of software that takes advantage of fully open networking, a virtual LAN party for gamers, and so on, but it's not intended (or able) to replace the core of the Internet.
+The service is controlled via the JSON API, which by default is available at 127.0.0.1 port 9993. We include a *zerotier-cli* command line utility to make API calls for standard things like joining and leaving networks. The *authtoken.secret* file in the home folder contains the secret token for accessing this API. See README.md in [service/](service/) for API documentation.
 
-**Q:** Can I bridge this to a physical port and plug in an Xbox, PlayStation, etc.?  
-**A:** Not currently, as foreign Ethernet frames are not forwarded. This may be possible in a future version.
+Here's where home folders live (by default) on each OS:
 
-----
-**Status**
+ * Linux: /var/lib/zerotier-one
+ * BSD: /var/db/zerotier-one
+ * Mac: /Library/Application Support/ZeroTier/One
+ * Windows: \\ProgramData\\ZeroTier\\One (That's for Windows 7. The base 'shared app data' folder might be different on different Windows versions.)
 
-*What works:*
- * Network auto-configuration via JSON API with identity based authentication and encryption
- * End-to-end encryption with automatic key exchange
- * Ethernet multicast with implicit social propagation (though the algorithm will certainly be getting tweaked as we go)
-   * IPv4 ARP works (see MulticastGroup.hpp for details)
-   * IPv6 neighbor discovery protocol works, thus IPv6 link-local addressing on the ZeroTier device also works
-   * mDNS (though if the LAN gets big you will not see everyone, just people nearby on your implicit social graph)
-   * IP-level multicast ought to "just work," though it may take up to a minute or so for a new join to propagate
- * NAT traversal works pretty well, at least behind relatively sane unrestrictive firewalls/routers. You can see this by pinging another node and watching, after a few seconds, the latency drop dramatically since you're no longer relaying. If it doesn't your firewall might block such things. Additional NAT traversal strategies are coming.
- * Changes in your local network configuration are generally detected and will cause peers to be re-acquired.
+Running ZeroTier One on a Mac is the same, but OSX requires a kernel extension. We ship a signed binary build of the ZeroTier tap device driver, which can be installed on Mac with:
 
-*Known immediate issues:*
- * Multiple network support is in but there is no interface to configure it, hence it is useless. But in alpha it'll be nice to shove everyone onto "Earth" in order to stress test that little "almost unlimited size" boast.
- * There is no multiple-launch protection yet and multiple instances on the same system do not work well due to route conflicts. Take care that zerotier-one is not running before launching it again. The command "sudo killall zerotier-one" is helpful.
- * Sometimes ZeroTier One doesn't like to terminate when asked nicely. This is related to issues with the tap device closing down properly. If it hangs around after a TERM signal, send it a KILL (9) signal.
- * The locally bound UDP port isn't configurable yet. It's 8993 by default.
- * Known security issues:
-   * There is no rate limit for multicast. Please be nice during alpha testing and don't flood.
-   * There is no filtering. Whether or not to try to do port-level filtering is not yet decided, as technically the local OS firewall and OS service configuration should do this and ZeroTier is not about re-inventing wheels. But certain things *will*need to be filtered by ZT1 itself. These include certain ICMP and ICMPv6 messages: router advertisement, router solicitation, source redirect, etc. DHCP and BOOTP should probably also be filtered at a minimum.
-   * ARP and IPv6 NDP want extra security measures to prevent poisoning and spoofing. The best mechanism is being researched.
- * If a supernode goes down, this takes quite a while to be detected and things will go dead. Fast recovery from relay failure is in the works.
- * If by a one in 2^40 chance two people generate the same ZeroTier address, this is currently not handled. It's unlikely and also hard (as in cryptographically hard) to do intentionally. See comments in Identity.cpp for details.
+    sudo make install-mac-tap
 
-*What doesn't work and might not work for a while, if ever:*
- * Only ARP, IPv4, and IPv6 frames are allowed. The ability to permit other ethertypes on user-created networks may be added later to allow things like old games that use IPX or private networks to remote administer weird hardware.
- * Bridging of the ZeroTier device to other networks will not work, and may never. This is TBD.
- * VLAN tagged frames will not work and probably never will, as higher level network provisioning handles that concept.
+This will create the home folder for Mac, place *tap.kext* there, and set its modes correctly to enable ZeroTier One to manage it with *kextload* and *kextunload*.
 
-----
+We recommend using our binary packages on Windows, since there are several prerequisites such as a tap driver that must be installed on the system *and* in the home folder.
 
-<a href="http://flattr.com/thing/1611614/ZeroTier-Networks" target="_blank"><img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0" /></a>  
-[![githalytics.com alpha](https://cruel-carlota.pagodabox.com/59b2cbb9c154bf84bddb4b714402e548 "githalytics.com")](http://githalytics.com/zerotier/ZeroTierOne)
+### Joining A Network
 
-(c)2012-2013 [ZeroTier Networks LLC](https://www.zerotier.com/)
+ZeroTier virtual networks are identified by 16-digit hexadecimal network IDs, while devices are identified by 10-digit addresses. To get your address run:
+
+    sudo zerotier-cli status
+
+(Use ./zerotier-cli if you're running it right from your build folder.)
+
+You should see something like:
+
+    200 info ########## ONLINE #.#.#
+
+That 10-digit hex code is you. It's derived via a one-way proof of work function from your cryptographic public key. Your public key can be found in *identity.public* in ZeroTier's home folder, while *identity.secret* contains your full identity including the secret portion of the key pair.
+
+(The identity files define your device's *identity*. Moving them to another system will move that identity. Be careful when cloning virtual machines that have identities stored on them. If two devices have the same identity, they'll "fight" over it and you won't know which device will receive network packets.)
+
+If you want to do a quick test, you can join [Earth](https://www.zerotier.com/earth.html). It's a global public network that anyone can join. Type:
+
+    sudo zerotier-cli join 8056c2e21c000001
+
+Then:
+
+    sudo zerotier-cli listnetworks
+
+At first it'll be in *REQUESTING\_CONFIGURATION* state. In a few seconds to a minute you should see something like:
+
+    200 listnetworks 8056c2e21c000001 earth.zerotier.net ##:##:##:##:##:## OK PUBLIC zt0 ##.##.##.##/##
+
+Earth will assign you an IP address in the "unofficially available" globally unrouted 28.0.0.0/7 IP block so as to avoid conflicts with local networks. (Your networks can use any IP scheme, or can even leave IP addresses unmanaged.) Once you get an IP, you should be able to ping something:
+
+    ping earth.zerotier.net
+
+Go to [http://earth.zerotier.net/](http://earth.zerotier.net/) to see a short little welcome page that will tell you your IP and Ethernet MAC address.
+
+Earth is a public place. If you don't want to stick around run:
+
+    sudo zerotier-cli leave 8056c2e21c000001
+
+The network (and associated interface) should be gone.
+
+Networks are created and administrated by network controllers. Most users will want to use our hosted controllers. Visit [our web site](https://www.zerotier.com/) for more information. Later in this README there are brief instructions about building ZeroTier One with network controller support for those who want to try running their own.
+
+Macintosh and Windows installers also install a GUI application.
+
+### Installing
+
+We don't have a "make install" rule quite yet. On Linux you can type:
+
+    make installer
+
+This will build a binary that, when run, will install ZeroTier One on most current Linux distributions. We also have RPM and DEB build files in *ext/installfiles/linux* that wrap this installer in packages for RedHat/CentOS and Debian/Ubuntu derived distributions. If *rpmbuild* is present on the system, the RPM will be built. If *dpkg-deb* is present, the DEB package will be built.
+
+On Mac the best way is to install [Packages](http://s.sudre.free.fr/Software/Packages/about.html) and use:
+
+    make mac-dist-pkg
+
+This builds a .pkg file that can be installed.
+
+BSD has no installer yet. We're working on it.
+
+Linux/BSD and Mac installations have an *uninstall.sh* file in their ZeroTier home folder that cleanly removes ZeroTier One from the system. Run this with:
+
+    sudo /path/to/ZeroTier/home/folder/uninstall.sh
+
+Windows installers are insane. We build our .MSI installers with [Advanced Installer Enterprise](http://www.advancedinstaller.com). The Advanced Installer project file is in *ext/installfiles/windows*. To avoid lasting psychological trauma we recommend leaving Windows installers alone and using the pre-built Windows binaries on our web site.
+
+### Using ZeroTier One in Docker Containers
+
+To run the ZeroTier One service in a Docker container, run it with "--device=/dev/net/tun --cap-add=NET_ADMIN". This will allow ZeroTier One to open a "tap" virtual network port inside the container.
+
+Alternately, you can use Ethernet bridging to bridge the *docker0* device on your system to a ZeroTier virtual network. This allows you to run ZeroTier One on the host and bridge the entire Docker network backplane to a virtual network or other hosts.
+
+We're working on better "official" Docker support. In the meantime there is a [user-contributed project here](https://github.com/davide/docker-zerotier).
+
+### Building with Network Controller Support
+
+**Warning: as of beta version 1.0.3 the new network controller is not heavily tested. We recommend waiting for 1.0.4 to deploy this in production.**
+
+Network controllers are nodes responsible for issuing configurations and certificates to members of ZeroTier virtual networks. Most users won't need to run their own, so this code is by default not included in the ZeroTier One binary.
+
+You can build a network controller on Linux or Mac with:
+
+    make ZT_ENABLE_NETWORK_CONTROLLER=1
+
+This will build a version that contains the Sqlite-backed network controller and associated extensions to the JSON local service control API. You will need the development headers for sqlite3 installed. On Mac these ship as part of Xcode, while on Linux they'll be found in packages for the various distributions.
+
+See the JSON API documentation in [service/](service/) for more information about how to control controllers.
+
+### Troubleshooting
+
+For most users, it just works.
+
+If you are running a local system firewall, we recommend adding a rule permitting UDP port 9993 inbound and outbound. If you installed binaries for Windows this should be done automatically. Other platforms might require manual editing of local firewall rules depending on your configuration.
+
+The Mac firewall can be founder under "Security" in System Preferences. Linux has a variety of firewall configuration systems and tools. If you're using Ubuntu's *ufw*, you can do this:
+
+    sudo ufw allow 9993/udp
+
+On CentOS check */etc/sysconfig/iptables* for IPTables rules. For other distributions consult your distribution's documentation. You'll also have to check the UIs or documentation for commercial third party firewall applications like Little Snitch (Mac), McAfee Firewall Enterprise (Windows), etc. if you are running any of those. Some corporate environments might have centrally managed firewall software, so you might also have to contact IT.
+
+ZeroTier One peers will automatically locate each other and communicate directly over a local wired LAN *if UDP port 9993 inbound is open*. If that port is filtered, they won't be able to see each others' LAN announcement packets. If you're experiencing poor performance between devices on the same physical network, check their firewall settings. Without LAN auto-location peers must attempt "loopback" NAT traversal, which sometimes fails and in any case requires that every packet traverse your external router twice.
+
+Users behind certain types of firewalls and "symmetric" NAT devices may not able able to connect to external peers directly at all. ZeroTier has limited support for port prediction and will *attempt* to traverse symmetric NATs, but this doesn't always work. If P2P connectivity fails you'll be bouncing UDP packets off our relay servers resulting in slower performance. Some NAT router(s) have a configurable NAT mode, and setting this to "full cone" will eliminate this problem. If you do this you may also see a magical improvement for things like VoIP phones, Skype, BitTorrent, WebRTC, certain games, etc., since all of these use NAT traversal techniques similar to ours.
+
+If you're interested, there's a [technical deep dive about NAT traversal on our blog](https://www.zerotier.com/blog/?p=226). A troubleshooting tool to help you diagnose NAT issues is planned for the future as are uPnP/IGD/NAT-PMP and IPv6 transport.
+
+If a firewall between you and the Internet blocks ZeroTier's UDP traffic, you will fall back to last-resort TCP tunneling to supernodes over port 443 (https impersonation). This will work almost anywhere but is *very slow* compared to UDP or direct peer to peer connectivity.
+
+### License
+
+The ZeroTier source code is open source and is licensed under the GNU GPL v3 (not LGPL). If you'd like to embed it in a closed-source commercial product or appliance, please e-mail [contact@zerotier.com](mailto:contact@zerotier.com) to discuss commercial licensing. Otherwise it can be used for free.

RUNNING.txt

@@ -1,47 +0,0 @@
-Running ZeroTier One from a source build:
-
--- MacOS
-
-By convention, ZeroTier One will keep its state here on mac:
-
-/Library/Application Support/ZeroTier/One
-
-ZeroTier ships with a kernel extension for its own tap device, which it
-stores in the above directory. To install this from source, type:
-
-sudo make -f Makefile.mac install-mac-tap
-
-This will create the ZeroTier One home above if it does not exist and install
-the kext there. Note that the kext must be owned by root:wheel. The make
-rule for install-mac-tap takes care of that.
-
-Next, simply run the binary. It must be run as root to open the tap device.
-
-sudo ./zerotier-one '/Library/Application Support/ZeroTier/One' &
-
-Type "ifconfig" and look for the new interface, which should be called
-"zt0." The strange IPv4 address it has is your "zero4" address. Visit
-http://zerotier.net/ to check your connection.
-
-Kill it with something like:
-
-sudo killall zerotier-one
-
--- Linux
-
-On Linux, the default ZeroTier home is:
-
-/var/lib/zerotier-one
-
-We use the Linux native tap driver, so no special drivers are needed. Just
-type:
-
-sudo mkdir /var/lib/zerotier-one
-sudo ./zerotier-one /var/lib/zerotier-one &
-
-Type ifconfig and you should see an interface like "zt0." Then try
-http://zerotier.net or ping zerotier.net to check your connection.
-
--- Windows
-
-TBD

artwork/logo.html

@@ -0,0 +1,37 @@
+<html>
+<head>
+<style type="text/css">
+html,body {
+	background: #aaaaaa;
+	margin: 0;
+	padding: 0;
+	font-family: "Helvetica";
+	font-weight: bold;
+	font-size: 12pt;
+	height: 100%;
+	width: 100%;
+}
+div.icon {
+	background: #ffb354;
+	color: #000000;
+	font-size: 150pt;
+	border-radius: 2.5rem;
+	display: inline-block;
+	width: 1.3em;
+	height: 1.3em;
+	padding: 0;
+	margin: 0;
+	line-height: 1.4em;
+	vertical-align: middle;
+	text-align: center;
+}
+</style>
+</head>
+<body>
+<br><br><br><br><br><br>
+<!-- Yes, our logo is a Unicode character. It sort of just turned out that way. -->
+<center>
+<div class="icon">&#x23c1;</div>
+</center>
+</body>
+</html>

attic/Filter.cpp

@@ -1,6 +1,6 @@
 /*
- * ZeroTier One - Global Peer to Peer Ethernet
- * Copyright (C) 2012-2013  ZeroTier Networks LLC
+ * ZeroTier One - Network Virtualization Everywhere
+ * Copyright (C) 2011-2015  ZeroTier, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,6 +30,8 @@
 #include <string.h>
 #include <stdint.h>
 
+#include <algorithm>
+
 #include "RuntimeEnvironment.hpp"
 #include "Logger.hpp"
 #include "Filter.hpp"
@@ -40,6 +42,61 @@ namespace ZeroTier {
 const char *const Filter::UNKNOWN_NAME = "(unknown)";
 const Range<unsigned int> Filter::ANY;
 
+static inline Range<unsigned int> __parseRange(char *r)
+	throw(std::invalid_argument)
+{
+	char *saveptr = (char *)0;
+	unsigned int a = 0;
+	unsigned int b = 0;
+	unsigned int fn = 0;
+	for(char *f=Utils::stok(r,"-",&saveptr);(f);f=Utils::stok((char *)0,"-",&saveptr)) {
+		if (*f) {
+			switch(fn++) {
+				case 0:
+					if (*f != '*')
+						a = b = (unsigned int)strtoul(f,(char **)0,10);
+					break;
+				case 1:
+					if (*f != '*')
+						b = (unsigned int)strtoul(f,(char **)0,10);
+					break;
+				default:
+					throw std::invalid_argument("rule range must be <int>, <int>-<int>, or *");
+			}
+		}
+	}
+	return Range<unsigned int>(a,b);
+}
+
+Filter::Rule::Rule(const char *s)
+	throw(std::invalid_argument)
+{
+	char *saveptr = (char *)0;
+	char tmp[256];
+	if (!Utils::scopy(tmp,sizeof(tmp),s))
+		throw std::invalid_argument("rule string too long");
+	unsigned int fn = 0;
+	for(char *f=Utils::stok(tmp,";",&saveptr);(f);f=Utils::stok((char *)0,";",&saveptr)) {
+		if (*f) {
+			switch(fn++) {
+				case 0:
+					_etherType = __parseRange(f);
+					break;
+				case 1:
+					_protocol = __parseRange(f);
+					break;
+				case 2:
+					_port = __parseRange(f);
+					break;
+				default:
+					throw std::invalid_argument("rule string has unknown extra fields");
+			}
+		}
+	}
+	if (fn != 3)
+		throw std::invalid_argument("rule string must contain 3 fields");
+}
+
 bool Filter::Rule::operator()(unsigned int etype,const void *data,unsigned int len) const
 	throw(std::invalid_argument)
 {
@@ -129,7 +186,7 @@ bool Filter::Rule::operator()(unsigned int etype,const void *data,unsigned int l
 								break;
 							default: {
 								char foo[128];
-								sprintf(foo,"unrecognized IPv6 header type %d",(int)nextHeader);
+								Utils::snprintf(foo,sizeof(foo),"unrecognized IPv6 header type %d",(int)nextHeader);
 								throw std::invalid_argument(foo);
 							}
 						}
@@ -158,39 +215,39 @@ std::string Filter::Rule::toString() const
 			s.push_back('*');
 			break;
 		case 1:
-			sprintf(buf,"%u",_etherType.start);
+			Utils::snprintf(buf,sizeof(buf),"%u",_etherType.start);
 			s.append(buf);
 			break;
 		default:
-			sprintf(buf,"%u-%u",_etherType.start,_etherType.end);
+			Utils::snprintf(buf,sizeof(buf),"%u-%u",_etherType.start,_etherType.end);
 			s.append(buf);
 			break;
 	}
-	s.push_back('/');
+	s.push_back(';');
 	switch(_protocol.magnitude()) {
 		case 0:
 			s.push_back('*');
 			break;
 		case 1:
-			sprintf(buf,"%u",_protocol.start);
+			Utils::snprintf(buf,sizeof(buf),"%u",_protocol.start);
 			s.append(buf);
 			break;
 		default:
-			sprintf(buf,"%u-%u",_protocol.start,_protocol.end);
+			Utils::snprintf(buf,sizeof(buf),"%u-%u",_protocol.start,_protocol.end);
 			s.append(buf);
 			break;
 	}
-	s.push_back('/');
+	s.push_back(';');
 	switch(_port.magnitude()) {
 		case 0:
 			s.push_back('*');
 			break;
 		case 1:
-			sprintf(buf,"%u",_port.start);
+			Utils::snprintf(buf,sizeof(buf),"%u",_port.start);
 			s.append(buf);
 			break;
 		default:
-			sprintf(buf,"%u-%u",_port.start,_port.end);
+			Utils::snprintf(buf,sizeof(buf),"%u-%u",_port.start,_port.end);
 			s.append(buf);
 			break;
 	}
@@ -198,37 +255,50 @@ std::string Filter::Rule::toString() const
 	return s;
 }
 
-void Filter::add(const Rule &r,const Action &a)
+Filter::Filter(const char *s)
+	throw(std::invalid_argument)
 {
-	Mutex::Lock _l(_chain_m);
-	for(std::vector<Entry>::iterator i(_chain.begin());i!=_chain.end();++i) {
-		if (i->rule == r) {
-			_chain.erase(i);
-			break;
+	char tmp[16384];
+	if (!Utils::scopy(tmp,sizeof(tmp),s))
+		throw std::invalid_argument("filter string too long");
+	char *saveptr = (char *)0;
+	unsigned int fn = 0;
+	for(char *f=Utils::stok(tmp,",",&saveptr);(f);f=Utils::stok((char *)0,",",&saveptr)) {
+		try {
+			_rules.push_back(Rule(f));
+			++fn;
+		} catch (std::invalid_argument &exc) {
+			char tmp[256];
+			Utils::snprintf(tmp,sizeof(tmp),"invalid rule at index %u: %s",fn,exc.what());
+			throw std::invalid_argument(tmp);
 		}
 	}
-	_chain.push_back(Entry(r,a));
+	std::sort(_rules.begin(),_rules.end());
 }
 
-std::string Filter::toString(const char *sep) const
+std::string Filter::toString() const
 {
-	if (!sep)
-		sep = ",";
-
 	std::string s;
 
-	bool first = true;
-	Mutex::Lock _l(_chain_m);
-	for(std::vector<Entry>::const_iterator i(_chain.begin());i!=_chain.end();++i) {
-		s.append(i->rule.toString());
-		if (first)
-			first = false;
-		else s.append(sep);
+	for(std::vector<Rule>::const_iterator r(_rules.begin());r!=_rules.end();++r) {
+		if (s.length() > 0)
+			s.push_back(',');
+		s.append(r->toString());
 	}
 
 	return s;
 }
 
+void Filter::add(const Rule &r)
+{
+	for(std::vector<Rule>::iterator rr(_rules.begin());rr!=_rules.end();++rr) {
+		if (r == *rr)
+			return;
+	}
+	_rules.push_back(r);
+	std::sort(_rules.begin(),_rules.end());
+}
+
 const char *Filter::etherTypeName(const unsigned int etherType)
 	throw()
 {
@@ -335,38 +405,4 @@ const char *Filter::icmp6TypeName(const unsigned int icmp6Type)
 	return UNKNOWN_NAME;
 }
 
-Filter::Action Filter::operator()(const RuntimeEnvironment *_r,unsigned int etherType,const void *frame,unsigned int len) const
-{
-	Mutex::Lock _l(_chain_m);
-
-	TRACE("starting match against %d rules",(int)_chain.size());
-
-	int ruleNo = 0;
-	for(std::vector<Entry>::const_iterator r(_chain.begin());r!=_chain.end();++r,++ruleNo) {
-		try {
-			if (r->rule(etherType,frame,len)) {
-				TRACE("match: %s",r->rule.toString().c_str());
-
-				switch(r->action) {
-					case ACTION_ALLOW:
-					case ACTION_DENY:
-						return r->action;
-					default:
-						break;
-				}
-			} else {
-				TRACE("no match: %s",r->rule.toString().c_str());
-			}
-		} catch (std::invalid_argument &exc) {
-			LOG("filter: unable to parse packet on rule %s (%d): %s",r->rule.toString().c_str(),ruleNo,exc.what());
-			return ACTION_UNPARSEABLE;
-		} catch ( ... ) {
-			LOG("filter: unable to parse packet on rule %s (%d): unknown exception",r->rule.toString().c_str(),ruleNo);
-			return ACTION_UNPARSEABLE;
-		}
-	}
-
-	return ACTION_ALLOW;
-}
-
 } // namespace ZeroTier

attic/Filter.hpp

@@ -1,6 +1,6 @@
 /*
- * ZeroTier One - Global Peer to Peer Ethernet
- * Copyright (C) 2012-2013  ZeroTier Networks LLC
+ * ZeroTier One - Network Virtualization Everywhere
+ * Copyright (C) 2011-2015  ZeroTier, Inc.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -29,13 +29,14 @@
 #define _ZT_FILTER_HPP
 
 #include <stdio.h>
+#include <stdlib.h>
 #include <string.h>
+
 #include <string>
 #include <vector>
 #include <utility>
 #include <stdexcept>
 
-#include "Mutex.hpp"
 #include "Range.hpp"
 
 /* Ethernet frame types that might be relevant to us */
@@ -125,7 +126,11 @@ namespace ZeroTier {
 class RuntimeEnvironment;
 
 /**
- * A simple Ethernet frame level filter supporting basic IP port DENY
+ * A simple Ethernet frame level filter
+ *
+ * This doesn't specify actions, since it's used as a deny filter. The rule
+ * in ZT1 is "that which is not explicitly prohibited is allowed." (Except for
+ * ethertypes, which are handled by a whitelist.)
  */
 class Filter
 {
@@ -145,8 +150,6 @@ public:
 
 	/**
 	 * A filter rule
-	 *
-	 * This behaves as an immutable value object.
 	 */
 	class Rule
 	{
@@ -159,6 +162,15 @@ public:
 		{
 		}
 
+		/**
+		 * Construct a rule from a string-serialized value
+		 *
+		 * @param s String formatted rule, such as returned by toString()
+		 * @throws std::invalid_argument String formatted rule is not valid
+		 */
+		Rule(const char *s)
+			throw(std::invalid_argument);
+
 		/**
 		 * Construct a new rule
 		 *
@@ -191,6 +203,8 @@ public:
 			throw(std::invalid_argument);
 
 		/**
+		 * Serialize rule as string
+		 *
 		 * @return Human readable representation of rule
 		 */
 		std::string toString() const;
@@ -222,105 +236,36 @@ public:
 		Range<unsigned int> _port;
 	};
 
-	/**
-	 * Action if a rule matches
-	 */
-	enum Action
-	{
-		ACTION_DENY = 0,
-		ACTION_ALLOW = 1,
-		ACTION_UNPARSEABLE = 2
-	};
+	Filter() {}
 
 	/**
-	 * Entry in filter chain
+	 * @param s String-serialized filter representation
 	 */
-	struct Entry
+	Filter(const char *s)
+		throw(std::invalid_argument);
+
+	/**
+	 * @return Comma-delimited list of string-format rules
+	 */
+	std::string toString() const;
+
+	/**
+	 * Add a rule to this filter
+	 *
+	 * @param r Rule to add to filter
+	 */
+	void add(const Rule &r);
+
+	inline bool operator()(unsigned int etype,const void *data,unsigned int len) const
+		throw(std::invalid_argument)
 	{
-		Entry() {}
-		Entry(const Rule &r,const Action &a) :
-			rule(r),
-			action(a)
-		{
+		for(std::vector<Rule>::const_iterator r(_rules.begin());r!=_rules.end();++r) {
+			if ((*r)(etype,data,len))
+				return true;
 		}
-
-		Rule rule;
-		Action action;
-	};
-
-	Filter() :
-		_chain(),
-		_chain_m()
-	{
+		return false;
 	}
 
-	Filter(const Filter &f) :
-		_chain(),
-		_chain_m()
-	{
-		Mutex::Lock _l(f._chain_m);
-		_chain = f._chain;
-	}
-
-	inline Filter &operator=(const Filter &f)
-	{
-		Mutex::Lock _l1(_chain_m);
-		Mutex::Lock _l2(f._chain_m);
-		_chain = f._chain;
-		return *this;
-	}
-
-	/**
-	 * Remove all filter entries
-	 */
-	inline void clear()
-	{
-		Mutex::Lock _l(_chain_m);
-		_chain.clear();
-	}
-
-	/**
-	 * Append a rule/action pair to this chain
-	 *
-	 * If an identical rule already exists it is removed and a new entry is
-	 * added to the end with the new action. (Two identical rules with the
-	 * same action wouldn't make sense.)
-	 *
-	 * @param r Rule to add
-	 * @param a Action if rule matches
-	 */
-	void add(const Rule &r,const Action &a);
-
-	/**
-	 * @return Number of rules in filter chain
-	 */
-	inline unsigned int length() const
-		throw()
-	{
-		Mutex::Lock _l(_chain_m);
-		return _chain.size();
-	}
-
-	/**
-	 * @return Entry in filter chain or null entry if out of bounds
-	 */
-	inline Entry operator[](const unsigned int i) const
-		throw()
-	{
-		Mutex::Lock _l(_chain_m);
-		if (i < _chain.size())
-			return _chain[i];
-		return Entry();
-	}
-
-	/**
-	 * Get a string representation of this filter
-	 *
-	 * @param sep Separator between filter rules, or NULL for comma (default)
-	 * @return Human-readable string
-	 */
-	std::string toString(const char *sep = (const char *)0) const;
-
 	static const char *etherTypeName(const unsigned int etherType)
 		throw();
 	static const char *ipProtocolName(const unsigned int ipp)
@@ -330,20 +275,8 @@ public:
 	static const char *icmp6TypeName(const unsigned int icmp6Type)
 		throw();
 
-	/**
-	 * Match against an Ethernet frame
-	 *
-	 * @param _r Runtime environment
-	 * @param etherType Ethernet frame type
-	 * @param frame Ethernet frame data
-	 * @param len Length of frame in bytes
-	 * @return Action if matched or ACTION_ALLOW if not matched
-	 */
-	Action operator()(const RuntimeEnvironment *_r,unsigned int etherType,const void *frame,unsigned int len) const;
-
 private:
-	std::vector<Entry> _chain;
-	Mutex _chain_m;
+	std::vector<Rule> _rules;
 };
 
 } // namespace ZeroTier

attic/README.md

@@ -0,0 +1,4 @@
+Retired Code and Miscellaneous Junk
+======
+
+This directory is for old code that isn't used but we don't want to lose track of, and for anything else random like debug scripts.

attic/decrypt

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+export PATH=/bin:/usr/bin
+
+if [ ! -e /usr/bin/openssl ]; then
+	echo $0: requires /usr/bin/openssl, please install openssl tools
+	exit 1
+fi
+
+if [ "$#" -lt 1 ]; then
+	echo $0: Usage: $0 '<input>' '[output]'
+	exit 1
+fi
+
+if [ ! -r "$1" ]; then
+	echo $0: $1 does not exist or is not readable.
+	exit 1
+fi
+
+outpath=`echo "$1" | sed 's/[.]aes$//'`
+if [ "$#" -ge 2 ]; then
+	outpath="$2"
+fi
+
+if [ -f "$outpath" ]; then
+	echo $0: $outpath already exists, delete or rename first.
+	exit 1
+fi
+
+openssl aes-256-cbc -d -salt -in "$1" -out "$outpath"
+
+echo $0: wrote "$outpath"

attic/encrypt

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+export PATH=/bin:/usr/bin
+
+if [ ! -e /usr/bin/openssl ]; then
+	echo $0: requires /usr/bin/openssl, please install openssl tools
+	exit 1
+fi
+
+if [ "$#" -lt 1 ]; then
+	echo $0: Usage: $0 '<input>' '[output]'
+	exit 1
+fi
+
+if [ ! -r "$1" ]; then
+	echo $0: $1 does not exist or is not readable.
+	exit 1
+fi
+
+outpath="$1.aes"
+if [ "$#" -ge 2 ]; then
+	outpath="$2"
+fi
+
+if [ -f "$outpath" ]; then
+	echo $0: $outpath already exists, delete or rename first.
+	exit 1
+fi
+
+openssl aes-256-cbc -salt -in "$1" -out "$outpath"
+
+echo $0: wrote "$outpath"

attic/rtbl/BSDRoutingTable.cpp

@@ -0,0 +1,331 @@
+/*
+ * ZeroTier One - Network Virtualization Everywhere
+ * Copyright (C) 2011-2015  ZeroTier, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * --
+ *
+ * ZeroTier may be used and distributed under the terms of the GPLv3, which
+ * are available at: http://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * If you would like to embed ZeroTier into a commercial application or
+ * redistribute it in a modified binary form, please contact ZeroTier Networks
+ * LLC. Start here: http://www.zerotier.com/
+ */
+
+#include <stdint.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+#include <unistd.h>
+#include <sys/param.h>
+#include <sys/sysctl.h>
+#include <sys/socket.h>
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <netinet/in.h>
+#include <arpa/inet.h>
+#include <net/route.h>
+#include <net/if.h>
+#include <net/if_dl.h>
+#include <ifaddrs.h>
+
+#include <algorithm>
+#include <utility>
+
+#include "../node/Constants.hpp"
+#include "BSDRoutingTable.hpp"
+
+// All I wanted was the bloody rounting table. I didn't expect the Spanish inquisition.
+
+#define ZT_BSD_ROUTE_CMD "/sbin/route"
+
+namespace ZeroTier {
+
+BSDRoutingTable::BSDRoutingTable()
+{
+}
+
+BSDRoutingTable::~BSDRoutingTable()
+{
+}
+
+std::vector<RoutingTable::Entry> BSDRoutingTable::get(bool includeLinkLocal,bool includeLoopback) const
+{
+	std::vector<RoutingTable::Entry> entries;
+	int mib[6];
+	size_t needed;
+
+	mib[0] = CTL_NET;
+	mib[1] = PF_ROUTE;
+	mib[2] = 0;
+	mib[3] = 0;
+	mib[4] = NET_RT_DUMP;
+	mib[5] = 0;
+	if (!sysctl(mib,6,NULL,&needed,NULL,0)) {
+		if (needed <= 0)
+			return entries;
+
+		char *buf = (char *)::malloc(needed);
+		if (buf) {
+			if (!sysctl(mib,6,buf,&needed,NULL,0)) {
+		    struct rt_msghdr *rtm;
+				for(char *next=buf,*end=buf+needed;next<end;) {
+					rtm = (struct rt_msghdr *)next;
+					char *saptr = (char *)(rtm + 1);
+					char *saend = next + rtm->rtm_msglen;
+
+					if (((rtm->rtm_flags & RTF_LLINFO) == 0)&&((rtm->rtm_flags & RTF_HOST) == 0)&&((rtm->rtm_flags & RTF_UP) != 0)&&((rtm->rtm_flags & RTF_MULTICAST) == 0)) {
+						RoutingTable::Entry e;
+						e.deviceIndex = -9999; // unset
+
+						int which = 0;
+						while (saptr < saend) {
+							struct sockaddr *sa = (struct sockaddr *)saptr;
+							unsigned int salen = sa->sa_len;
+							if (!salen)
+								break;
+
+							// Skip missing fields in rtm_addrs bit field
+							while ((rtm->rtm_addrs & 1) == 0) {
+								rtm->rtm_addrs >>= 1;
+								++which;
+								if (which > 6)
+									break;
+							}
+							if (which > 6)
+								break;
+
+							rtm->rtm_addrs >>= 1;
+							switch(which++) {
+								case 0:
+									//printf("RTA_DST\n");
+									if (sa->sa_family == AF_INET6) {
+										struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sa;
+										// Nobody expects the Spanish inquisition!
+										if ((sin6->sin6_addr.s6_addr[0] == 0xfe)&&((sin6->sin6_addr.s6_addr[1] & 0xc0) == 0x80)) {
+											// Our chief weapon is... in-band signaling!
+											// Seriously who in the living fuck thought this was a good idea and
+											// then had the sadistic idea to not document it anywhere? Of course it's
+											// not like there is any documentation on BSD sysctls anyway.
+											unsigned int interfaceIndex = ((((unsigned int)sin6->sin6_addr.s6_addr[2]) << 8) & 0xff) | (((unsigned int)sin6->sin6_addr.s6_addr[3]) & 0xff);
+											sin6->sin6_addr.s6_addr[2] = 0;
+											sin6->sin6_addr.s6_addr[3] = 0;
+											if (!sin6->sin6_scope_id)
+												sin6->sin6_scope_id = interfaceIndex;
+										}
+									}
+									e.destination.set(sa);
+									break;
+								case 1:
+									//printf("RTA_GATEWAY\n");
+									switch(sa->sa_family) {
+										case AF_LINK:
+											e.deviceIndex = (int)((const struct sockaddr_dl *)sa)->sdl_index;
+											break;
+										case AF_INET:
+										case AF_INET6:
+											e.gateway.set(sa);
+											break;
+									}
+									break;
+								case 2: {
+									if (e.destination.isV6()) {
+										salen = sizeof(struct sockaddr_in6); // Confess!
+										unsigned int bits = 0;
+										for(int i=0;i<16;++i) {
+											unsigned char c = (unsigned char)((const struct sockaddr_in6 *)sa)->sin6_addr.s6_addr[i];
+											if (c == 0xff)
+												bits += 8;
+											else break;
+											/* must they be multiples of 8? Most of the BSD source I can find says yes..?
+											else {
+												while ((c & 0x80) == 0x80) {
+													++bits;
+													c <<= 1;
+												}
+												break;
+											}
+											*/
+										}
+										e.destination.setPort(bits);
+									} else {
+										salen = sizeof(struct sockaddr_in); // Confess!
+										e.destination.setPort((unsigned int)Utils::countBits((uint32_t)((const struct sockaddr_in *)sa)->sin_addr.s_addr));
+									}
+									//printf("RTA_NETMASK\n");
+								}	break;
+								/*
+								case 3:
+									//printf("RTA_GENMASK\n");
+									break;
+								case 4:
+									//printf("RTA_IFP\n");
+									break;
+								case 5:
+									//printf("RTA_IFA\n");
+									break;
+								case 6:
+									//printf("RTA_AUTHOR\n");
+									break;
+								*/
+							}
+
+							saptr += salen;
+						}
+
+						e.metric = (int)rtm->rtm_rmx.rmx_hopcount;
+						if (e.metric < 0)
+							e.metric = 0;
+
+						if (((includeLinkLocal)||(!e.destination.isLinkLocal()))&&((includeLoopback)||((!e.destination.isLoopback())&&(!e.gateway.isLoopback()))))
+							entries.push_back(e);
+					}
+
+					next = saend;
+				}
+			}
+
+			::free(buf);
+		}
+	}
+
+	for(std::vector<ZeroTier::RoutingTable::Entry>::iterator e1(entries.begin());e1!=entries.end();++e1) {
+		if ((!e1->device[0])&&(e1->deviceIndex >= 0))
+			if_indextoname(e1->deviceIndex,e1->device);
+	}
+	for(std::vector<ZeroTier::RoutingTable::Entry>::iterator e1(entries.begin());e1!=entries.end();++e1) {
+		if ((!e1->device[0])&&(e1->gateway)) {
+			int bestMetric = 9999999;
+			for(std::vector<ZeroTier::RoutingTable::Entry>::iterator e2(entries.begin());e2!=entries.end();++e2) {
+				if ((e1->gateway.within(e2->destination))&&(e2->metric <= bestMetric)) {
+					bestMetric = e2->metric;
+					Utils::scopy(e1->device,sizeof(e1->device),e2->device);
+				}
+			}
+		}
+	}
+
+	std::sort(entries.begin(),entries.end());
+
+	return entries;
+}
+
+RoutingTable::Entry BSDRoutingTable::set(const InetAddress &destination,const InetAddress &gateway,const char *device,int metric)
+{
+	if ((!gateway)&&((!device)||(!device[0])))
+		return RoutingTable::Entry();
+
+	std::vector<RoutingTable::Entry> rtab(get(true,true));
+
+	for(std::vector<RoutingTable::Entry>::iterator e(rtab.begin());e!=rtab.end();++e) {
+		if (e->destination == destination) {
+			if (((!device)||(!device[0]))||(!strcmp(device,e->device))) {
+				long p = (long)fork();
+				if (p > 0) {
+					int exitcode = -1;
+					::waitpid(p,&exitcode,0);
+				} else if (p == 0) {
+					::close(STDOUT_FILENO);
+					::close(STDERR_FILENO);
+					::execl(ZT_BSD_ROUTE_CMD,ZT_BSD_ROUTE_CMD,"delete",(destination.isV6() ? "-inet6" : "-inet"),destination.toString().c_str(),(const char *)0);
+					::_exit(-1);
+				}
+			}
+		}
+	}
+
+	if (metric < 0)
+		return RoutingTable::Entry();
+
+	{
+		char hcstr[64];
+		Utils::snprintf(hcstr,sizeof(hcstr),"%d",metric);
+		long p = (long)fork();
+		if (p > 0) {
+			int exitcode = -1;
+			::waitpid(p,&exitcode,0);
+		} else if (p == 0) {
+			::close(STDOUT_FILENO);
+			::close(STDERR_FILENO);
+			if (gateway) {
+				::execl(ZT_BSD_ROUTE_CMD,ZT_BSD_ROUTE_CMD,"add",(destination.isV6() ? "-inet6" : "-inet"),destination.toString().c_str(),gateway.toIpString().c_str(),"-hopcount",hcstr,(const char *)0);
+			} else if ((device)&&(device[0])) {
+				::execl(ZT_BSD_ROUTE_CMD,ZT_BSD_ROUTE_CMD,"add",(destination.isV6() ? "-inet6" : "-inet"),destination.toString().c_str(),"-interface",device,"-hopcount",hcstr,(const char *)0);
+			}
+			::_exit(-1);
+		}
+	}
+
+	rtab = get(true,true);
+	std::vector<RoutingTable::Entry>::iterator bestEntry(rtab.end());
+	for(std::vector<RoutingTable::Entry>::iterator e(rtab.begin());e!=rtab.end();++e) {
+		if ((e->destination == destination)&&(e->gateway.ipsEqual(gateway))) {
+			if ((device)&&(device[0])) {
+				if (!strcmp(device,e->device)) {
+					if (metric == e->metric)
+						bestEntry = e;
+				}
+			}
+			if (bestEntry == rtab.end())
+				bestEntry = e;
+		}
+	}
+	if (bestEntry != rtab.end())
+		return *bestEntry;
+
+	return RoutingTable::Entry();
+}
+
+} // namespace ZeroTier
+
+// Enable and build to test routing table interface
+#if 0
+using namespace ZeroTier;
+int main(int argc,char **argv)
+{
+	BSDRoutingTable rt;
+
+	printf("<destination> <gateway> <interface> <metric>\n");
+	std::vector<RoutingTable::Entry> ents(rt.get());
+	for(std::vector<RoutingTable::Entry>::iterator e(ents.begin());e!=ents.end();++e)
+		printf("%s\n",e->toString().c_str());
+	printf("\n");
+
+	printf("adding 1.1.1.0 and 2.2.2.0...\n");
+	rt.set(InetAddress("1.1.1.0",24),InetAddress("1.2.3.4",0),(const char *)0,1);
+	rt.set(InetAddress("2.2.2.0",24),InetAddress(),"en0",1);
+	printf("\n");
+
+	printf("<destination> <gateway> <interface> <metric>\n");
+	ents = rt.get();
+	for(std::vector<RoutingTable::Entry>::iterator e(ents.begin());e!=ents.end();++e)
+		printf("%s\n",e->toString().c_str());
+	printf("\n");
+
+	printf("deleting 1.1.1.0 and 2.2.2.0...\n");
+	rt.set(InetAddress("1.1.1.0",24),InetAddress("1.2.3.4",0),(const char *)0,-1);
+	rt.set(InetAddress("2.2.2.0",24),InetAddress(),"en0",-1);
+	printf("\n");
+
+	printf("<destination> <gateway> <interface> <metric>\n");
+	ents = rt.get();
+	for(std::vector<RoutingTable::Entry>::iterator e(ents.begin());e!=ents.end();++e)
+		printf("%s\n",e->toString().c_str());
+	printf("\n");
+
+	return 0;
+}
+#endif

attic/rtbl/BSDRoutingTable.hpp

@@ -0,0 +1,51 @@
+/*
+ * ZeroTier One - Network Virtualization Everywhere
+ * Copyright (C) 2011-2015  ZeroTier, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * --
+ *
+ * ZeroTier may be used and distributed under the terms of the GPLv3, which
+ * are available at: http://www.gnu.org/licenses/gpl-3.0.html
+ *
+ * If you would like to embed ZeroTier into a commercial application or
+ * redistribute it in a modified binary form, please contact ZeroTier Networks
+ * LLC. Start here: http://www.zerotier.com/
+ */
+
+#ifndef ZT_BSDROUTINGTABLE_HPP
+#define ZT_BSDROUTINGTABLE_HPP
+
+#include "../node/RoutingTable.hpp"
+
+namespace ZeroTier {
+
+/**
+ * Routing table interface for BSD with sysctl() and BSD /sbin/route
+ *
+ * Has currently only been tested on OSX/Darwin.
+ */
+class BSDRoutingTable : public RoutingTable
+{
+public:
+	BSDRoutingTable();
+	virtual ~BSDRoutingTable();
+	virtual std::vector<RoutingTable::Entry> get(bool includeLinkLocal = false,bool includeLoopback = false) const;
+	virtual RoutingTable::Entry set(const InetAddress &destination,const InetAddress &gateway,const char *device,int metric);
+};
+
+} // namespace ZeroTier
+
+#endif