Warning This code is not ready to be used by the public. There's no guarantee of stability.

The Outline SDK helps developers:

• Create tools to protect against network-level interference
• Add network-level interference protection to existing apps, such as content or communication apps

The Outline SDK is written in Go. There are multiple ways to integrate the Outline SDK into your app:

• As a Go library (reference), in a Go application (CLI or graphical app with frameworks like Fyne.io, Wails, Qt for Go, or Go Mobile app)
• As a C library, generated using the appropriate Go build mode.
• As a native mobile library, using gomobile bind to generate Java and Objective-C bindings for Android, iOS and macOS.
• As a side service, built as a standalone Go binary that your main application talks to. Note that this is not possible on iOS, due to the limitation on starting sub-processes.

The Outline Client uses the mobile library approach on Android, iOS and macOS (based on Cordova) and the side service on Windows and Linux (based on Electron).

The launch will have two milestones: Alpha and Beta. We are currently in pre-Alpha. Note that most of the code is not new. It's the code being used by the production Outline Client and Server. The SDK work is repackaging code from outline-ss-server and outline-go-tun2socks in a way that is easier to reuse and extend.

The goal of the Alpha release is to make it available to potential developers early so they can provide feedback on the SDK and help shape the interfaces, processes and tools.

The code in this repository will move to https://github.com/Jigsaw-Code/outline-sdk and versions will be tagged.

Alpha tasks:

• Transport-level libraries

  • Add generic transport client primitives (StreamDialer, PacketListener and Endpoints)
  • Add TCP and UDP client implementations
  • Add Shadowsocks client implementations
  • Use transport libraries in the Outline Client
  • Use transport libraries in the Outline Server

• Network-level libraries

  • Add IP Device abstraction
  • Add IP Device implementation based on go-tun2socks (LWIP)
  • Add UDP handler to fallback to DNS-over-TCP
  • Add DelegatePacketProxy for runtime PacketProxy replacement

The goal of the Beta release is to communicate that the SDK is ready for broader consumption, after we believe the APIs are stable enough and we have all the supporting resources in place (website, documentation, examples, etc

Beta tasks:

• Network libraries

  • Use network libraries in the Outline Client
  • Add extensive testing

• Serverless transport libraries

  • Encrypted DNS
  • Packet splitting

• Proxy transport libraries

  • HTTP Connect
  • SOCKS5

• Add Resources

  • Website
  • Bindings
  • Integration documentation
  • Example command-line apps
  • Example graphical apps