VERSION 1.1.0: Win/Mac UI improvements, improved NAT-t, CIRCUIT_TEST, and more!

ZeroTier 1.1.0 introduces a number of fixes and improvements in several areas.
We incremented the secondary version to indicate the significance of this release.

Version numbering has been a bit ad-hoc in the past. In future versions we will
adopt the following scheme: odd-numbered revision numbers like 1.1.1 will indicate
development versions, while even numbered ones like 1.1.2 will indicate tagged
releases. The public git repo branching has also been revised: master will always
be the latest tagged release, dev will be usually-working development, and edge
will host maybe-broken "bleeding edge" development. Pull requests on GitHub should
generally be made against dev, not master or edge. Other branches that may appear
from time to time may be feature or experimental branches. Only master is confirmed
good, with dev usually being okay but not guaranteed to be such. (To the extent
that any software is ever guaranteed to be anything.)

Change summary:

User-facing changes and improvements:

 - Windows now has a new .NET-based native UI, which replaces the old WebControl
   wrapper around the React UI. This just didn't work well on older Windows systems,
   and we did not want to bundle 40+ megabytes of web browser with our app just for
   its very simple UI.
 - The web UI (still used for Mac and usable in Linux as well) is updated with
   improved look and simplifications.
 - Both UIs no longer have the "Peers" tab, since several users reported that non-
   technical users found this confusing and even alarming (does this mean people
   can access my system?). This information is visibile with "listpeers" from the
   command line (zerotier-cli).

New features:

 - Virtual networks that use our RFC4193-based IPv6 numbering scheme now emulate
   IPv6 NDP for queries that target these addresses within the same network. This
   allows for faster multicast-free connection init and improved security since
   the address is now hard-wired to the device ID (which is a crypto token). This
   does not affect IPv6 NDP for other IPv6 addresses or link-local, which will
   continue to work normally. This also opens the potential for a reduced footprint
   multicast-free build for embedded applications.
 - This version includes beta support for a feature called CIRCUIT_TEST. Network
   controllers for networks you have joined can now send a special message called
   CIRCUIT_TEST which allows for ZeroTier-layer link testing and remote diagnosis
   of link issues. Any operator of a network controller can do this; more
   documentation will be forthcoming. The only information that may be gathered
   in this way is IP addressing info and very basic system info (OS, 32/64 bit,
   ZeroTier version). No personal information, hard drive data, location, or other
   private info is available. This can only be ordered by a controller of a network
   you have joined and is secured using cryptographic signatures.
 - This version includes an alpha version of clustering a.k.a. multi-homing! This
   powerful feature allows for a single ZeroTier device to be run from multiple
   endpoints, with connecting peers being handed off to endpoints that are closer
   via GeoIP lookup and/or are more lightly loaded. Currently this is only suitable
   for use in our soon-to-be-upgraded root server infrastructure (details will be
   blogged soon), but in the future it will be capable of hosting multi-homed
   devices on user networks. This will allow things like (for example) a geo-
   clustered Cassandra server that appears behind a single IP on a virtual LAN.
   This feature must be enabled with the ZT_ENABLE_CLUSTER=1 build option.

Bug fixes and other improvements (including performance!):

 - A faster version of the Poly1305 cryptographic MAC function was substituted
   for sometimes greatly improved performance.
 - C++ STL std::map was replaced throughout the entire core with a hand-rolled
   Hashtable implementation for improved performance and in some cases a reduced
   memory footprint. Some maps are still used in peripheral code that is not
   performance critical or where ordered keys are needed.
 - The zerotier-cli and zerotier-idtool symbolic links are now created in
   /usr/local/bin on OSX to comply with El Capitan file security restrictions.
 - The OSX tap device driver has been updated. This update may fix issues that
   some users have reported with bridging on OSX. This new tap device driver
   drops 32-bit support, but if you have a 32-bit system you can manually install
   the old driver from ext/bin/tap-mac.
 - Mac users could experience a problem with the UI if they installed ZeroTier,
   then uninstalled it, then installed again. This is now fixed.
 - UPnP port mappings should work better on some routers, and a different local
   port is now used for UPnP mapped traffic vs. NAT-t'd traffic to get around
   a bug in several popular mid-tier routers where using UPnP mapping alongside
   traditional NAT traversal made a port unreachable.
 - Debian package now builds with the right arch label on armv7l systems (Pi 2)
 - The old "root topology" has been replaced with a similar but better thought
   out concept called a World. The World defines the root servers and possibly
   in the future other things, and can be updated in-band from trusted peers
   allowing for software-upgrade-free network upgrades to keep up with growing
   demand. See node/World.hpp for details.
 - A fix was made to "self-awareness," which keeps track of your external IP
   info and adapts to changes, to eliminate a problem that could cause "link
   thrashing" behind some symmetric NATs.
 - Escalating UDP TTLs was re-introduced to better transit some port-restricted
   cone NATs such as Linux IP MASQ (used for Docker).
 - An otherwise harmless crash-on-exit bug in the network controller was fixed.
 - All new direct links are now confirmed in both directions. This adds a very
   small amount of initial HELLO/OK traffic but fixes some edge cases where an
   incomplete or unidirectional path might be used.
 - [SECURITY] Better rate limiting was put in place for VERB_PUSH_DIRECT_PATHS
   to prevent potential abuse for amplification attacks.
 - [SECURITY] Build flags were tweaked on OSX to ensure that all code including
   dependency libraries are built with full stack canary protection and ASLR
   support.

Visit https://www.zerotier.com/blog or follow @ZeroTier on Twitter for updates
and announcements!

.gitignore

@@ -1,38 +1,78 @@
-/ext/llvm-g++-Xcode4.6.2
-/ext/llvm-g++-Xcode4.6.2.tar.bz2
+# Main binaries created in *nix builds
 /zerotier-*
-/build-ZeroTierUI-*
-/ZeroTierUI/*.user
-*.o
+
+# OS-created garbage files from various platforms
 .DS_Store
 .Apple*
-*.dSYM
-netconf-service/netconf-test
-netconf-service/netconf.service
-mac-tap/tuntap/src/tap/tap
-mac-tap/tuntap/tap.kext
-/ipch
-/ZeroTierOne.sdf
-/ZeroTierOne.v11.suo
-/vsprojects/SelfTest/Debug
-/vsprojects/SelfTest/Release
-/vsprojects/ZeroTierOne/Debug
-/vsprojects/ZeroTierOne/Release
-/vsprojects/ZeroTierOne/x64
-/vsprojects/TapDriver/Win32
-/vsprojects/TapDriver/x64
-/vsprojects/InstallerUpdater/obj
-/vsprojects/Service/obj
-/vsprojects/SelfTest/SelfTest.aps
-/Build/*
+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-*
+/examples/docker/zerotier-one
+/examples/docker/test-*.env
+/world/mkworld
+/world/*.c25519
+
+# Miscellaneous temporaries, build files, etc.
 *.log
 *.opensdf
 *.user
 *.cache
 *.obj
 *.tlog
-/installer-build
-/zt1-*-install
-/file2lz4c
-.qmake.stash
+*.pid
+*.pkg
+*.o
+*.a
+*.dylib
+*.so
+*.o-*
+*.core
+*.deb
+*.rpm
 *.autosave
+*.tmp
+node_modules
+cluster-geo/cluster-geo/config.js
+cluster-geo/cluster-geo/cache.*
+tests/http/zerotier-one
+tests/http/big-test-hosts
+
+# 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
+
+# Java/Android/JNI build droppings
+java/obj/
+java/libs/
+java/bin/
+java/classes/
+java/doc/
+java/build_win64/
+java/build_win32/
+/java/mac32_64/
+windows/WinUI/obj/
+windows/WinUI/bin/
+windows/ZeroTierOne/Debug/

AUTHORS.md

@@ -0,0 +1,44 @@
+## Authors
+
+ * ZeroTier protocol design and core network virtualization engine, ZeroTier One service, React web UI, packaging for most platforms, kitchen sink...<br>
+   Adam Ierymenko / adam.ierymenko@zerotier.com
+
+ * Java JNI Interface to enable Android application development, and Android app itself (code for that is elsewhere)<br>
+   Grant Limberg / glimberg@gmail.com
+
+## Contributors
+
+ * A number of fixes and improvements to the new controller, other stuff.<br>
+   Kees Bos / https://github.com/keesbos
+
+ * Debugging and testing, OpenWRT support fixes.<br>
+   Moritz Warning / moritzwarning@web.de
+
+ * Several others made smaller contributions, which GitHub tracks here:<br>
+   https://github.com/zerotier/ZeroTierOne/graphs/contributors
+
+## Third Party Code
+
+ * LZ4 compression algorithm by Yann Collet (BSD license)<br>
+   http://code.google.com/p/lz4/
+
+ * http-parser by many authors (MIT license)<br>
+   https://github.com/joyent/http-parser
+
+ * json-parser by James McLaughlin (BSD license)<br>
+   https://github.com/udp/json-parser
+
+ * TunTapOSX by Mattias Nissler (BSD license)<br>
+   http://tuntaposx.sourceforge.net
+
+ * tap-windows and tap-windows6 by the OpenVPN project (GPL)<br>
+   https://github.com/OpenVPN/tap-windows<br>
+   https://github.com/OpenVPN/tap-windows6
+
+ * Salsa20 stream cipher, Curve25519 elliptic curve cipher, Ed25519
+   digital signature algorithm, and Poly1305 MAC algorithm, all by
+   Daniel J. Bernstein (public domain)<br>
+   http://cr.yp.to/
+
+ * MiniUPNPC by Thomas Bernard [BSD]
+   http://miniupnp.free.fr

AUTHORS.txt

@@ -1,21 +0,0 @@
-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
-
-ZeroTier One includes the following third party code:
-
- * LZ4 compression algorithm by Yann Collet (BSD license)
-   http://code.google.com/p/lz4/
-
- * TunTapOSX by Mattias Nissler (forked for ZT1) (BSD license)
-   http://tuntaposx.sourceforge.net
-
- * 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,45 +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.
-
--- Linux
-
-make
-
-That's it. Add ZT_AUTO_UPDATE=1 to the make command line to build an
-auto-update-enabled version that will update from ZeroTier's servers.
-This is disabled by default since such a build will automatically
-replace itself with our binary distributions.
-
--- MacOS
-
-make
-
-The same ZT_AUTO_UPDATE=1 option as Linux supports can be used here to
-build an auto-update-enabled version. By default auto-updates are not
-enabled.
-
-If you are building ext/tap-mac you will need a different version of the
-OSX gcc compiler chain than what currently ships (clang). We've got a copy
-available here:
-
-http://download.zerotier.com/dev/llvm-g++-Xcode4.6.2.tar.bz2
-
-Un-tar this into ext/ (it's excluded in .gitignore) and then 'make' in
-ext/tap-mac/tuntap/src/tap.
-
-Most users should not need to build tap-mac, since a binary is included
-in ext/bin.
-
-To build the UI you will need Qt version 5.0 or later. The Qt home must
-be symbolically linked into "Qt" in the parent directory of the ZeroTier
-One source tree. Then you can type "make mac-ui" and the UI should build.
-You can also load the UI in Qt Creator and build/test it that way.
-
--- Windows
-
-Here be dragons.

Makefile

@@ -9,3 +9,10 @@ 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

README.md

@@ -1,18 +1,175 @@
 ZeroTier One
 ======
 
-ZeroTier One creates flat virtual Ethernet networks of almost unlimited size. [Visit ZeroTier Networks on the web](https://www.zerotier.com/) for more information.
+ZeroTier is a software defined networking layer for Earth.
 
-This project is now in beta, which means that major incompatible protocol shifts should now become considerably more rare. You should still update very often if you plan to use it. Binary packages with auto-update are coming very soon.
+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.
 
-Follow the [ZeroTier blog](http://blog.zerotier.com/) and the [GitHub project](https://github.com/zerotier/ZeroTierOne) to stay up to date.
+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.).
 
-See BUILDING.txt and RUNNING.txt for instructions. It currently runs on Mac and Linux. A Windows port is well along the way to completion. If you're brave you can load the Visual Studio 2012 solution and play around.
+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.
 
-Once you have it running you can join the Earth network -- a LAN for the planet -- by using the 'zerotier-cli' tool: 'sudo zerotier-cli join 8056c2e21c000001'. Right now Earth is the only network. Ability to create private networks, as well as some additional special-purpose public ones, will be coming soon. (Note: previous alpha versions auto-joined Earth, but since 0.5.0 it no longer does this.)
+### Building from Source
 
-Note that this won't work if your firewall does not allow outbound UDP. It must allow two way UDP conversations on port 9993 at a minimum.
+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).
 
-(c)2012-2013 [ZeroTier Networks LLC](https://www.zerotier.com/)
+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.
+
+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.
+
+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.
+
+### Supported Platforms
+
+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.
+
+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.
+
+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.
+
+### Running
+
+Running *zerotier-one* with -h will show help.
+
+On Linux and BSD you can start the service with:
+
+    sudo ./zerotier-one -d
+
+A home folder for your system will automatically be created.
+
+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.
+
+Here's where home folders live (by default) on each OS:
+
+ * 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.)
+
+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:
+
+    sudo make install-mac-tap
+
+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.
+
+### Joining A Network
+
+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.
+
+In FreeBSD there is now an official .pkg in the FreeBSD repository. Type "pkg install zerotier". It can also be built and installed from source.
+
+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 rootservers over port 443 (https impersonation). This will work almost anywhere but is *very slow* compared to UDP or direct peer to peer connectivity.
+
+### Contributing
+
+There are three main branches: **edge**, **test**, and **master**. Other branches may be for specific features, tests, or use cases. In general **edge** is "bleeding" and may or may not work, while **test** should be relatively stable and **master** is the latest tagged release. Pull requests should generally be done against **test** or **edge**, since pull requests against **master** may be working against a branch that is somewhat out of date.
+
+### 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,78 +0,0 @@
-First build it -- see BUILDING.txt -- then...
-
--- 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, 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.
-If run with no options, it will use the default home directory above.
-
-sudo ./zerotier-one &
-
-Finally, join the Earth network (the big public LAN and the only net for now):
-
-sudo zerotier-cli join 8056c2e21c000001
-
-Try pinging earth.zerotier.net and going to http://earth.zerotier.net/ in a
-browser to see if you're online.
-
--- Linux
-
-On Linux, the default ZeroTier home is:
-
-/var/lib/zerotier-one
-
-Just type:
-
-sudo mkdir /var/lib/zerotier-one
-sudo ./zerotier-one &
-
-When run with no options, ZT1 uses its default home path on the current
-platform. Note that ZT1 requires the Linux tap driver, so it must be
-available in the kernel or as a module. In most Linux distributions it's
-included out of the box and should just work.
-
-Finally, join the Earth network (the big public LAN and the only net for now):
-
-sudo zerotier-cli join bc8f9a8ee3000001
-
-Try pinging earth.zerotier.net and going to http://earth.zerotier.net/ in a
-browser to see if you're online.
-
--- Windows
-
-Port in progress, and it's going to pretty much always be more painful to
-build than *nix systems. Just wait for the binary release unless you're
-brave, in which case you can load the VS2012 solution and play around.
-
--- Open UDP port 9993
-
-As noted in README.md, to actually function properly, you need to open
-UDP port 9993 in your firewall. Following are instructions to open UDP port
-9993 for specific operating systems.
-
---- Ubuntu (version 12.04 and possibly other versions, too)
-
-Follow the Ubuntu documentation about UFW https://help.ubuntu.com/community/UFW
-
-Check if your UFW is active.
-
-sudo ufw status verbose
-
-If it is active, open UDP port 9993
-
-sudo ufw allow 9993/udp
-
-You should now be able to ping and browse earth.zerotier.net
-

ZeroTierUI/Info.plist

@@ -1,20 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist SYSTEM "file://localhost/System/Library/DTDs/PropertyList.dtd">
-<plist version="0.9">
-<dict>
-	<key>NSPrincipalClass</key>
-	<string>NSApplication</string>
-	<key>CFBundleIconFile</key>
-	<string>zt1icon.icns</string>
-	<key>CFBundlePackageType</key>
-	<string>APPL</string>
-	<key>CFBundleGetInfoString</key>
-	<string>ZeroTier One (Mac GUI)</string>
-	<key>CFBundleSignature</key>
-	<string>????</string>
-	<key>CFBundleExecutable</key>
-	<string>ZeroTier One</string>
-	<key>CFBundleIdentifier</key>
-	<string>com.zerotier.ZeroTierOne</string>
-</dict>
-</plist>

ZeroTierUI/ZeroTierUI.pro

@@ -1,98 +0,0 @@
-QT       += core gui widgets
-TARGET = "ZeroTier One"
-TEMPLATE = app
-
-win32:RC_FILE = ZeroTierUI.rc
-mac:ICON = zt1icon.icns
-mac:QMAKE_MACOSX_DEPLOYMENT_TARGET = 10.6
-mac:QMAKE_INFO_PLIST = Info.plist
-
-SOURCES += main.cpp\
-				mainwindow.cpp \
-		aboutwindow.cpp \
-		../node/C25519.cpp \
-		../node/CertificateOfMembership.cpp \
-		../node/Defaults.cpp \
-		../node/Demarc.cpp \
-		../node/EthernetTap.cpp \
-		../node/HttpClient.cpp \
-		../node/Identity.cpp \
-		../node/InetAddress.cpp \
-		../node/Logger.cpp \
-		../node/Multicaster.cpp \
-		../node/Network.cpp \
-		../node/NetworkConfig.cpp \
-		../node/Node.cpp \
-		../node/NodeConfig.cpp \
-		../node/Packet.cpp \
-		../node/PacketDecoder.cpp \
-		../node/Peer.cpp \
-		../node/Poly1305.cpp \
-		../node/Salsa20.cpp \
-		../node/Service.cpp \
-		../node/SHA512.cpp \
-		../node/SoftwareUpdater.cpp \
-		../node/Switch.cpp \
-		../node/SysEnv.cpp \
-		../node/Topology.cpp \
-		../node/UdpSocket.cpp \
-		../node/Utils.cpp \
-    ../ext/lz4/lz4.c \
-    ../ext/lz4/lz4hc.c \
-    networkwidget.cpp
-
-HEADERS  += mainwindow.h \
-		aboutwindow.h \
-		../node/Node.hpp \
-		../node/Utils.hpp \
-		../node/Defaults.hpp \
-		../node/Address.hpp \
-		../node/Array.hpp \
-		../node/AtomicCounter.hpp \
-		../node/BandwidthAccount.hpp \
-		../node/Buffer.hpp \
-		../node/C25519.hpp \
-		../node/CertificateOfMembership.hpp \
-		../node/CMWC4096.hpp \
-		../node/Condition.hpp \
-		../node/Constants.hpp \
-		../node/Demarc.hpp \
-		../node/Dictionary.hpp \
-		../node/EthernetTap.hpp \
-		../node/HttpClient.hpp \
-		../node/Identity.hpp \
-		../node/InetAddress.hpp \
-		../node/Logger.hpp \
-		../node/MAC.hpp \
-		../node/Multicaster.hpp \
-		../node/MulticastGroup.hpp \
-		../node/Mutex.hpp \
-		../node/Network.hpp \
-		../node/NetworkConfig.hpp \
-		../node/NodeConfig.hpp \
-		../node/NonCopyable.hpp \
-		../node/Packet.hpp \
-		../node/PacketDecoder.hpp \
-		../node/Peer.hpp \
-		../node/Poly1305.hpp \
-		../node/RuntimeEnvironment.hpp \
-		../node/Salsa20.hpp \
-		../node/Service.hpp \
-		../node/SHA512.hpp \
-		../node/SharedPtr.hpp \
-		../node/SoftwareUpdater.hpp \
-		../node/Switch.hpp \
-		../node/SysEnv.hpp \
-		../node/Thread.hpp \
-		../node/Topology.hpp \
-		../node/UdpSocket.hpp \
-    ../ext/lz4/lz4.h \
-    ../ext/lz4/lz4hc.h \
-    networkwidget.h
-
-FORMS    += mainwindow.ui \
-		aboutwindow.ui \
-    networkwidget.ui
-
-RESOURCES += \
-		resources.qrc

ZeroTierUI/ZeroTierUI.rc

@@ -1 +0,0 @@
-IDI_ICON1 ICON DISCARDABLE "zt1icon.ico"

ZeroTierUI/aboutwindow.cpp

@@ -1,17 +0,0 @@
-#include "aboutwindow.h"
-#include "ui_aboutwindow.h"
-
-#include <QMessageBox>
-#include "../node/Defaults.hpp"
-
-AboutWindow::AboutWindow(QWidget *parent) :
-	QDialog(parent),
-	ui(new Ui::AboutWindow)
-{
-	ui->setupUi(this);
-}
-
-AboutWindow::~AboutWindow()
-{
-	delete ui;
-}

ZeroTierUI/aboutwindow.h

@@ -1,22 +0,0 @@
-#ifndef AboutWindow_H
-#define AboutWindow_H
-
-#include <QDialog>
-
-namespace Ui {
-class AboutWindow;
-}
-
-class AboutWindow : public QDialog
-{
-	Q_OBJECT
-
-public:
-	explicit AboutWindow(QWidget *parent = 0);
-	virtual ~AboutWindow();
-
-private:
-	Ui::AboutWindow *ui;
-};
-
-#endif // AboutWindow_H

ZeroTierUI/aboutwindow.ui

@@ -1,261 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<ui version="4.0">
- <class>AboutWindow</class>
- <widget class="QDialog" name="AboutWindow">
-  <property name="geometry">
-   <rect>
-    <x>0</x>
-    <y>0</y>
-    <width>508</width>
-    <height>261</height>
-   </rect>
-  </property>
-  <property name="windowTitle">
-   <string>About ZeroTier One</string>
-  </property>
-  <property name="windowIcon">
-   <iconset resource="resources.qrc">
-    <normaloff>:/img/zt1icon.png</normaloff>:/img/zt1icon.png</iconset>
-  </property>
-  <property name="sizeGripEnabled">
-   <bool>true</bool>
-  </property>
-  <layout class="QVBoxLayout" name="verticalLayout">
-   <property name="leftMargin">
-    <number>6</number>
-   </property>
-   <property name="topMargin">
-    <number>6</number>
-   </property>
-   <property name="rightMargin">
-    <number>6</number>
-   </property>
-   <property name="bottomMargin">
-    <number>6</number>
-   </property>
-   <item>
-    <widget class="QFrame" name="frame">
-     <property name="frameShape">
-      <enum>QFrame::StyledPanel</enum>
-     </property>
-     <property name="frameShadow">
-      <enum>QFrame::Raised</enum>
-     </property>
-     <layout class="QHBoxLayout" name="horizontalLayout">
-      <property name="leftMargin">
-       <number>6</number>
-      </property>
-      <property name="topMargin">
-       <number>6</number>
-      </property>
-      <property name="rightMargin">
-       <number>6</number>
-      </property>
-      <property name="bottomMargin">
-       <number>6</number>
-      </property>
-      <item>
-       <widget class="QWidget" name="widget" native="true">
-        <layout class="QVBoxLayout" name="verticalLayout_3">
-         <property name="leftMargin">
-          <number>0</number>
-         </property>
-         <property name="topMargin">
-          <number>0</number>
-         </property>
-         <property name="rightMargin">
-          <number>0</number>
-         </property>
-         <property name="bottomMargin">
-          <number>0</number>
-         </property>
-         <item>
-          <widget class="QLabel" name="iconLabel">
-           <property name="sizePolicy">
-            <sizepolicy hsizetype="Minimum" vsizetype="Minimum">
-             <horstretch>0</horstretch>
-             <verstretch>0</verstretch>
-            </sizepolicy>
-           </property>
-           <property name="minimumSize">
-            <size>
-             <width>128</width>
-             <height>128</height>
-            </size>
-           </property>
-           <property name="maximumSize">
-            <size>
-             <width>128</width>
-             <height>128</height>
-            </size>
-           </property>
-           <property name="text">
-            <string/>
-           </property>
-           <property name="textFormat">
-            <enum>Qt::PlainText</enum>
-           </property>
-           <property name="pixmap">
-            <pixmap resource="resources.qrc">:/img/zt1icon.png</pixmap>
-           </property>
-           <property name="scaledContents">
-            <bool>true</bool>
-           </property>
-           <property name="textInteractionFlags">
-            <set>Qt::NoTextInteraction</set>
-           </property>
-          </widget>
-         </item>
-         <item>
-          <spacer name="verticalSpacer">
-           <property name="orientation">
-            <enum>Qt::Vertical</enum>
-           </property>
-           <property name="sizeHint" stdset="0">
-            <size>
-             <width>20</width>
-             <height>40</height>
-            </size>
-           </property>
-          </spacer>
-         </item>
-        </layout>
-       </widget>
-      </item>
-      <item>
-       <widget class="QFrame" name="frame_2">
-        <property name="sizePolicy">
-         <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
-          <horstretch>0</horstretch>
-          <verstretch>0</verstretch>
-         </sizepolicy>
-        </property>
-        <property name="frameShape">
-         <enum>QFrame::StyledPanel</enum>
-        </property>
-        <property name="frameShadow">
-         <enum>QFrame::Raised</enum>
-        </property>
-        <layout class="QVBoxLayout" name="verticalLayout_2">
-         <item>
-          <widget class="QLabel" name="aboutTextLabel">
-           <property name="sizePolicy">
-            <sizepolicy hsizetype="Expanding" vsizetype="Expanding">
-             <horstretch>0</horstretch>
-             <verstretch>0</verstretch>
-            </sizepolicy>
-           </property>
-           <property name="font">
-            <font>
-             <weight>50</weight>
-             <bold>false</bold>
-            </font>
-           </property>
-           <property name="text">
-            <string>ZeroTier One GUI
-(c)2012-2013 ZeroTier Networks LLC
-
-Author(s): Adam Ierymenko
-Version: 1.0</string>
-           </property>
-           <property name="textFormat">
-            <enum>Qt::PlainText</enum>
-           </property>
-           <property name="alignment">
-            <set>Qt::AlignHCenter|Qt::AlignTop</set>
-           </property>
-           <property name="textInteractionFlags">
-            <set>Qt::NoTextInteraction</set>
-           </property>
-          </widget>
-         </item>
-         <item>
-          <widget class="QWidget" name="widget_2" native="true">
-           <layout class="QHBoxLayout" name="horizontalLayout_2">
-            <property name="leftMargin">
-             <number>0</number>
-            </property>
-            <property name="topMargin">
-             <number>0</number>
-            </property>
-            <property name="rightMargin">
-             <number>0</number>
-            </property>
-            <property name="bottomMargin">
-             <number>0</number>
-            </property>
-            <item>
-             <spacer name="horizontalSpacer">
-              <property name="orientation">
-               <enum>Qt::Horizontal</enum>
-              </property>
-              <property name="sizeHint" stdset="0">
-               <size>
-                <width>40</width>
-                <height>20</height>
-               </size>
-              </property>
-             </spacer>
-            </item>
-           </layout>
-          </widget>
-         </item>
-        </layout>
-       </widget>
-      </item>
-     </layout>
-    </widget>
-   </item>
-   <item>
-    <widget class="QDialogButtonBox" name="buttonBox">
-     <property name="orientation">
-      <enum>Qt::Horizontal</enum>
-     </property>
-     <property name="standardButtons">
-      <set>QDialogButtonBox::Ok</set>
-     </property>
-     <property name="centerButtons">
-      <bool>true</bool>
-     </property>
-    </widget>
-   </item>
-  </layout>
- </widget>
- <resources>
-  <include location="resources.qrc"/>
- </resources>
- <connections>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>accepted()</signal>
-   <receiver>AboutWindow</receiver>
-   <slot>accept()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>248</x>
-     <y>254</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>157</x>
-     <y>274</y>
-    </hint>
-   </hints>
-  </connection>
-  <connection>
-   <sender>buttonBox</sender>
-   <signal>rejected()</signal>
-   <receiver>AboutWindow</receiver>
-   <slot>reject()</slot>
-   <hints>
-    <hint type="sourcelabel">
-     <x>316</x>
-     <y>260</y>
-    </hint>
-    <hint type="destinationlabel">
-     <x>286</x>
-     <y>274</y>
-    </hint>
-   </hints>
-  </connection>
- </connections>
-</ui>

ZeroTierUI/helpers/mac/ZeroTier One (Authenticate).app/Contents/Info.plist

@@ -1,50 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
-<plist version="1.0">
-<dict>
-	<key>CFBundleAllowMixedLocalizations</key>
-	<true/>
-	<key>CFBundleDevelopmentRegion</key>
-	<string>English</string>
-	<key>CFBundleExecutable</key>
-	<string>applet</string>
-	<key>CFBundleIconFile</key>
-	<string>applet</string>
-	<key>CFBundleIdentifier</key>
-	<string>com.zerotier.one.ZeroTierOneMacAuthenticateScript</string>
-	<key>CFBundleInfoDictionaryVersion</key>
-	<string>6.0</string>
-	<key>CFBundleName</key>
-	<string>ZeroTier One (Authenticate)</string>
-	<key>CFBundlePackageType</key>
-	<string>APPL</string>
-	<key>CFBundleShortVersionString</key>
-	<string>1.0</string>
-	<key>CFBundleSignature</key>
-	<string>aplt</string>
-	<key>LSMinimumSystemVersionByArchitecture</key>
-	<dict>
-		<key>x86_64</key>
-		<string>10.6</string>
-	</dict>
-	<key>LSRequiresCarbon</key>
-	<true/>
-	<key>NSHumanReadableCopyright</key>
-	<string>(c) 2013 ZeroTier Networks LLC</string>
-	<key>WindowState</key>
-	<dict>
-		<key>dividerCollapsed</key>
-		<false/>
-		<key>eventLogLevel</key>
-		<integer>-1</integer>
-		<key>name</key>
-		<string>ScriptWindowState</string>
-		<key>positionOfDivider</key>
-		<real>333</real>
-		<key>savedFrame</key>
-		<string>7 181 602 597 0 0 1280 778 </string>
-		<key>selectedTabView</key>
-		<string>result</string>
-	</dict>
-</dict>
-</plist>

ZeroTierUI/helpers/mac/ZeroTier One (Authenticate).app/Contents/PkgInfo

@@ -1 +0,0 @@
-APPLaplt

ZeroTierUI/helpers/mac/ZeroTier One (Authenticate).app/Contents/Resources/description.rtfd/TXT.rtf

@@ -1,4 +0,0 @@
-{\rtf1\ansi\ansicpg1252\cocoartf1265
-{\fonttbl}
-{\colortbl;\red255\green255\blue255;}
-}