outline-sdk

Outline SDK (Alpha)

⚠️ Warning: This code is in early stages and is not guaranteed to be stable. If you are interested in integrating with it, we'd love your feedback.

The Outline SDK allows you to:

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

Advantages

Integration Methods

Choose from one of the following methods to integrate the Outline SDK into your project:

• Generated Mobile Library: For Android, iOS, and macOS apps. Uses gomobile bind for generating Java and Objective-C bindings.
• Side Service: For desktop and Android apps. Runs a standalone Go binary that your application communicates with (not available on iOS due to subprocess limitations).
• Go Library: Directly import the SDK into your Go application. API Reference.
• Generated C Library: Generate C bindings using go build.

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

Below we provide more details on the integration approaches.

Generated Mobile Library

To integrate the SDK into a mobile app, follow these steps:

1. Create a Go library: Create a Go package that wraps the SDK functionalities you need.
2. Generate mobile library: Use gomobile bind to generate Android Archives (AAR) and Apple Frameworks with Java and Objective-C bindings.
   • Android examples: Outline Android Archive, Intra Android Archive.
   • Apple examples: Outline iOS Framework, Outline macOS Framework.
3. Integrate into your app: Add the generated library to your app. For more details, see Go Mobile's SDK applications and generating bindings.

Note: You must use gomobile bind on a package you create, not directly on the SDK packages.

Side Service

To integrate the SDK as a side service, follow these steps:

1. Define IPC mechanism: Choose an inter-process communication (IPC) mechanism (e.g., sockets, standard I/O).
2. Build the service: Create a Go binary that includes the server-side of the IPC and used the SDK.
   • Examples: Outline Electron backend code, Outline Windows Client backend build, Outline Linux Client backend build.
3. Bundle the service: Include the Go binary in your application bundle.
   • Examples: Outline Windows Client, Outline Linux Client
4. Start the service: Launch the Go binary as a subprocess from your application.
   • Example: Outline Electron Clients
5. Service Calls: Add code to your app for communication with the service.

Go Library

To integrate the Outline SDK as a Go library, you can directly import it into your Go application. See the API Reference for what's available.

This approach is suitable for both command-line and GUI-based applications. You can build GUI-based applications in Go with frameworks like Wails, Fyne.io, Qt for Go, or Go Mobile app.

For examples, see x/examples.

Generated C Library

For applications that require C bindings. This approach is similar to the Generated Mobile Library approach, where you need to first create a Go library to generate bindings for.

Steps:

1. Create a Go library: Create a Go package that wraps the SDK functionalities you need. Functions to be exported must be marked with //export, as per the cgo documentation.
2. Generate C library: Use go build with the appropriate -buildmode flag. Anternatively, you can use SWIG.
3. Integrate into your app: Add the generated C library to your application, according to your build system.

Tentative Roadmap

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

Alpha

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.

Alpha features:

• 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

Beta

The goal of the Beta release is to make the SDK available for broader consumption, once we no longer expect major changes to the APIs and we have all supporting resources in place (website, documentation, examples, and so on).

Beta features:

• Network libraries

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

• Transport client strategies

  • Proxyless strategies
    • Encrypted DNS
    • Packet splitting
  • Proxy-based strategies
    • HTTP Connect
    • SOCKS5 StreamDialer
    • SOCKS5 PacketDialer

• Integration resources

  • For Mobile apps
    • Library to run a local SOCKS5 or HTTP-Connect proxy
    • Documentation on how to integrate the SDK into mobile apps
    • Connectivity Test mobile app using Capacitor
  • For Go apps
    • Connectivity Test example Wails graphical app
    • Connectivity Test example command-line app (source)
    • Outline Client example command-line app
    • Page fetch example command-line app (source)
    • Local proxy example command-line app (source)

• Server-side libraries

  • To be defined

• Other Resources

  • Website
  • Bindings