You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Joseph Henry b3d4410bbc intro tweaks 10 years ago
attic LWIP 2.0.0 adaptations, formatted debug outputs 10 years ago
build added blank readme for build dir 10 years ago
docs intro tweaks 10 years ago
ext picotcp/lwip ipv4/ipv6 fully functional, needs stress testing 10 years ago
integrations updated JNI build, added unit test targets to Jenkinsfile 10 years ago
prototypes upgrade to lwip 2.0.0, beginning support for IPV6 10 years ago
src added targets to J. fixed warnings 10 years ago
tests minor unit test check script update 10 years ago
zerotierone fixed netif_up flag bug, updated included ZTO src 10 years ago
.gitignore API and docs update 10 years ago
COPYING Rebuilt ZeroTierUnity-OSX bundle project 10 years ago
Jenkinsfile updated JNI build, added unit test targets to Jenkinsfile 10 years ago
LICENSE.GPL-2 Rebuilt ZeroTierUnity-OSX bundle project 10 years ago
LICENSE.GPL-3 Rebuilt ZeroTierUnity-OSX bundle project 10 years ago
Makefile docker test update + makefile update 10 years ago
README.md intro tweaks 10 years ago
check.sh minor unit test check script update 10 years ago
docker_demo.name added compilation sanity checks, unit test script, updated docs 10 years ago
increment.sh ios example app update 10 years ago
make-liblwip.mk picotcp/lwip ipv4/ipv6 fully functional, needs stress testing 10 years ago
make-linux.mk updated JNI build, added unit test targets to Jenkinsfile 10 years ago
make-mac.mk updated JNI build, added unit test targets to Jenkinsfile 10 years ago
objects.mk pre-release preparation (organization of source files, added readmes, etc) 10 years ago
test.sh minor ios/osx project updates 10 years ago

README.md

ZeroTier SDK

ZeroTier-enabled apps and devices.

Secure virtual network access embedded directly into applications, games, and devices. Imagine starting an instance of your application or game and having it automatically be a member of your virtual network without having to rewrite your networking layer. Check out our Integrations to learn how to integrate this into your application, device, or ecosystem.

How do I use it?

There are generally two ways one might want to use the service.

  • The first approach is a compile-time static linking of our service directly into your application. With this option you can bundle our entire functionality right into your app with no need to communicate with a service externally, it'll all be handled automatically. This is most typical for mobile applications, games, etc.

  • The second is a service-oriented approach where our network call "intercept" is dynamically-linked into your applications upon startup and will communicate to a single ZeroTier service on the host. This can be useful if you've already compiled your applications and can't perform a static linking.

Image

How does it work?

We've designed a background tap service that pairs the ZeroTier protocol with swappable user-space network stacks. We've provided drivers for Lightweight IP (lwIP) and picoTCP. The aim is to give you a new way to bring your applications onto your virtual network. For a more in-depth explanation of our technology take a look at our SDK Primer

APIs

Hook/Intercept

  • Uses dynamic loading of our library to allow function interposition or "hooking" to re-implement traditional socket API functions like socket(), connect(), bind(), etc.

SOCKS5 Proxy

  • Provides an integrated SOCKS5 server alongside the ZeroTier service to proxy connections from an application to resources on a ZeroTier network. For instance, a developer which has built an iOS app using the NSStreams API could add ZeroTier to their application and simply use the SOCKS5 support build into NSStreams to reach resources on their network. An Android developer could do the same using the SOCKS5 support provided in the Socket API.

Direct Call

  • Directly call the zt_ API specified in SDK.h. For this to work, just use one of the provided headers that specify the interface for your system/architecture and then either dynamically-load our library into your app or compile it right in.

Image