Pango Platform
HomeConsole
  • What is Pango Developer Platform
  • Getting started
    • Sign up on the Management Console
    • Create a new project
    • Switch projects
    • Change console settings
    • Edit your profile
    • Try out the demo app
    • Keep exploring
    • Deprecation and Sunset
  • Console details
    • Dashboard
      • General
      • Location loading
    • Users
      • User page
    • Active sessions
    • Network
      • Countries
      • Locations
      • Pools
        • Optimal location
        • Location rules
    • Settings
      • General
        • Project config description (JSON format)
          • Server selector (JSON format)
          • Request selector (JSON format)
      • Authentication methods
        • Auth Plugin requirements
      • VPN
        • General
        • VPN Bypass list
        • Client Networks
      • Member
    • Export Data
    • Log
  • SDK
    • Unified VPN SDK for Android
      • Setup
        • Application Setup
        • Proguard Rules, Notification, and Analytics Configurations
        • Backend URL Configuration
      • Usage
        • Initialization
        • VPN Interface
        • Backend interface
      • Features
        • Hydra Protocol
          • Location profile (Hydra only)
        • Custom sdk dependencies
        • Deferred VPN Service Initialization
        • Authentication
        • Client Network List (CNL)
        • OpenVPN transport
        • Wireguard Transport
        • Reconnection strategy
        • Single Protocol SDK
        • Killswitch
        • Domain route via VPN
        • Process route via VPN
        • Process Bypass
        • Domain Bypass
        • Traffic rules
        • VPN Node DNS Configuration
        • Multihop
          • Optimal Location
      • Exceptions
      • Version migration
      • Changelog
    • Unified VPN SDK for Apple
      • Setup
        • Application Setup
        • Network Extension Setup
          • Network Extension Setup for tvOS
        • Backend URL Configuration
      • Usage
        • Single Protocol SDK
        • Unified SDK
        • Logging
        • Decoding Encoded VPN SDK Logs
      • Features
        • Deferred VPN Service Initialization
        • Authentication
        • Wireguard Transport
        • Reconnection strategy
        • Killswitch
        • Domain Bypass
        • Multihop
          • Optimal Location
        • Client Network List (CNL)
        • Domain route via VPN
      • Changelog
      • API Reference
    • IPSEC VPN SDK for Apple
    • Unified VPN SDK for Windows
      • Setup
        • Backend URL Configuration
        • Service command line arguments
        • ARM Platform Support
      • Usage
        • CoreAPI
        • Events
        • Generating a Unique Device Identifier
        • Error processing
        • Pipe Messaging
      • Features
        • Traffic protection
          • Killswitch
          • Prevent IP Leaks
          • Block Local Networks
        • Other
          • Firewall
            • DNS Monitor
            • Process Bypass
            • Domain Bypass
            • Process route via VPN
            • Domain route via VPN
          • Throttling
          • Optimal Location
          • Common issues
        • Hydra Protocol
          • CustomDNS, UserDNS, MultiHop, VpnProfiles
        • OpenVPN Protocol
        • Wireguard Protocol
        • IPSec Protocol
      • Collecting Debug Logs
      • Changelog
    • Unified VPN SDK for Routers
      • SDK. Shared library.
      • Configuration Interface (CI)
        • Unix Domain Sockets CI
        • REST API CI
    • Unified VPN SDK Feature Comparison By Platform
    • Unified VPN SDK
      • Features
        • Personal Bridge
    • Tunnel Vision and Tunnel Crack Prevention
  • REST API
    • Partner API
  • Sample applications
    • Unified VPN SDK demo for Windows
    • Hydra VPN SDK demo for iOS
    • IPSEC VPN SDK demo for iOS
    • Unified VPN SDK demo for Android
    • Hydra VPN SDK demo for OpenWRT
    • OpenVPN configuration file
  • Resources
    • Use cases
      • Public VPN
      • Business VPN
        • Creating a Business VPN Project
        • Wi-Fi Security for Business
      • Application anti-blocking
    • How-to
      • Create a Firebase project for User Authentication
      • AWS CloudFront Distribution of the Platform URL
      • How can I get Shared Secret key from iTunes Connect for In-App Purchase
  • FAQ
    • General
      • VPN Platform Flow
      • What data is collected by the Platform?
      • What analytic data is collected by your SDK?
      • How the Platform restricts access to our data?
      • Why DNS Leak tests often indicate positive result?
      • Do we need to perform endpoint health checks?
      • How is the VPN exit node found?
      • How are streams re-marked if VPN is enabled/disabled on an active flow?
      • Is there a maximum number of supported devices?
      • Are both IPv4 and IPv6 supported?
      • What is the MTU of the tunnel?
      • Are any redundancy measures in terms of reliability provided?
      • Is there any load balancing?
      • Do you block broadcast and multicast to/from the VPN?
    • List of Open Source libs
Powered by GitBook
On this page
  • General
  • Architectural Diagram
  • Prerequisites
  • Supported Protocols
  • Supported Features
  • API Documentation
  • Changelog
  • Support

Was this helpful?

  1. SDK

Unified VPN SDK for Apple

PreviousChangelogNextSetup

Last updated 7 months ago

Was this helpful?

General

The iOS and macOS SDK is part of the Pango Partner SDK, providing client-side libraries for implementing custom VPN infrastructure.

Architectural Diagram

For the unified SDK, the App interacts with the SDK Configuration, which connects to the VPN SDK. The VPN SDK consists of a VPN Core that utilizes Remote Host Provider services (Remote Config and Remote Host) and an API Service that fetches data from Credentials Source and passes it to the CNL (Cellular Network Layer). The VPN Core also includes config files that are used by the Interceptor and Analytics components. The Interceptor sends data through the VPN Transport layer.

In the tunnel SDK architecture, the Network Extension interacts with the API Service, which retrieves data from the Credentials Source and CNL. The Analytics component sends data through the Tunnel Transport layer to the Killswitch. The Tunnel Transport is connected to the Extension Delegate and VPN Node components. The VPN Node is likely responsible for managing the VPN connection.

Both SDKs share common components such as Remote Config, Credentials Source, CNL, and Analytics, but differ in their specific implementations. The unified SDK focuses on providing a VPN Core with interceptor capabilities, while the tunnel SDK utilizes a network extension and tunnel transport for VPN connectivity.

Data storage is shown as a separate component, used for storing configuration settings, logs, and other relevant data.

Overall, the architectural diagram illustrates the modular design of the SDKs, separating concerns and responsibilities among different components to provide a robust and flexible VPN solution for applications.

Prerequisites

The following prerequisites are required to use the SDK:

  • Requires iOS 13+ or macOS 10.15+

Additionally, in order to be able to use the SDK, the following steps have to be done:

  • Create a project and use a name for your project as a Public key. Private key is optional.

  • Use SDK where carrierId equals given Public Key and backend url equals default SDK url or url provided by Pango team.

Supported Protocols

  • Hydra

  • WireGuard

  • IPSec

  • Unlike most SDKs that require a two-step integration process, IPSecSDK offers a more streamlined approach. By leveraging Apple's built-in tunnel implementation, IPSecSDK eliminates the need to set up a separate network extension target. This simplifies the integration process and reduces the amount of configuration required.

Supported Features

Feature
Description

Provides a comprehensive set of features for integrating VPN functionality into your application, including configuring the SDK, connecting to VPN, handling errors, using the Fireshield categorization service, and sharing logs.

Allows using and switching between different VPN protocols (Hydra, IPSec, WireGuard) inside one app, with options for manual or automatic protocol switching.

API Documentation

Changelog

Support

Sign in at .

Note that at this time, it is not possible for users to create their own accounts directly if they do not already have an account established with us. Please contact your sales representative to initiate account creation as part of the project and client onboarding process or . We apologize for any inconvenience.

For detailed instructions on setting up IPSecSDK, please refer to our dedicated .

To view a complete list of of the available APIs, click the following link: .

The SDK version history and changes are documented .

If you encounter any issues or have questions regarding integrating the SDK, please visit our .

pango-cloud.com
contact us
IPSec setup guide
API reference
here
Github
Single protocol SDK
Composed SDK
The architectural diagram illustrates the components and data flow for providing unified and tunnel SDKs to applications.