gfwleak/zhangyang-libzt
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
25bb33aa388820b6f35aff1d0bb77ebd3d91def2
zhangyang-libzt/docs/api_discussion.md
Joseph Henry 25bb33aa38 LWIP 2.0.0 adaptations, formatted debug outputs
2016-09-13 14:17:30 -07:00

1.4 KiB
Raw Blame History

ZTSDK API Options

This document is under construction

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

The following APIs are available for this integration:

  • Direct Call: Consult src/SDK_Apple-Bridging-Header.h.
  • Hook of BSD-like sockets: Use BSD-like sockets as you normally would.
  • Proxy of NSStream: Create NSStream. Configure stream for SOCKS5 Proxy (127.0.0.1:PORT). Start Proxy. Use stream. An example of how to use the proxy can be found in the example iOS/OSX projects.