Speedify SDK

Welcome

This SDK lets you build the Speedify VPN engine right into your own iOS app.

Tools

This SDK was built with Xcode Version 11.4 (11E146) , iOS 13.3 and Swift 5.2 . We highly recommend that you use the same (or later).

Getting Started

To get started copy the sample project SpeedifySDK to the directory you wish to run it in.

A few provisioning profiles are needed in order to run the sample application and integrate the SDK into your app. For the sample application, first go to Apple Developer and create the following two App IDs, replacing com.mycompany with a domain you associate with your Developer Program:

com.mycompany.SpeedifySampleApp com.mycompany.SpeedifySampleApp.PacketTunnel

For the SDK, first create the App ID, again replacing com.mycompany with your Developer Program domain and replacing myapp with your application name:

com.mycompany.myapp.PacketTunnel

And then create a provisioning profile for this new App ID, again including the NetworkExtension entitlements if you have them.

Important note: You must run the app on a device and not on a simulator.

After your profiles are set up, open with Xcode and press run. Upon opening the app you will be requested to give VPN Permissions. The SDK will not run without these permissions. Once permissions are granted you will be presented with a list of command buttons. If you wish to change the directory URL please to do that first.

All users will start out in a logged out state. You will need to log in to perform the majority of the commands. If you need a Speedify license when running the sample application please contact support@speedify.com

API Docs

The API Documents are provided as convenient HTML in the docs/index.html directory.

Licensing

The use of this SDK is dependent on you having a licensing agreement with Connectify, Inc.

This SDK uses a number of third party, open source libraries. Information on them and their licenses can be found here.

Support

We are here to support our developers! If you have any issues, questions or concerns, please email us at support@speedify.com

ChangeLog

Speedify 9.9

New Function

  • public func loginAutoAccount(completionHandler:@escaping (_ message: State?, _ error: ErrorType?)->Void)
  • The Local Proxy API now supports matching by TCP and UDP port: setLocalProxyPorts

Function changes

These all change a non-optional ErrorType to an option ErrorType?
  • public func connectAuto(connectOption: AutoConnectMethod, completionHandler:@escaping (_ serverInformation: ServerInformation?, _ error: ErrorType?)->Void)
  • public func connectByCity(country: String, city: String,completionHandler:@escaping (_ message: ServerInformation?, _ error: ErrorType?)->Void)
  • public func connectByCountry(country: String, completionHandler:@escaping (_ message: ServerInformation?, _ error: ErrorType?)->Void)
  • public func connectByServer(country: String, city: String, num: Int, completionHandler:@escaping (_ message: ServerInformation?, _ error: ErrorType?)->Void)
  • public func login(username: String, password: String, completionHandler:@escaping (_ message: State?, _ error: ErrorType?)->Void)
  • public func loginOauth(oauthAccessToken: String, completionHandler:@escaping (_ error: ErrorType?)->Void)

Speedify 9.8

SDK now supports building with iOS Simulators.

setVendorUserData - can be used to provide a string of user data for an account.

StreamingStats has new property fields

  • totalRedundantSaves - Total number of redundant saves per session. Please see StreamStats.redundantSaves
  • totalSpeedSaves - Total number of speed saves per session. Please see StreamStats.speedSaves
  • totalStreams - Total number of streams per session
  • uniqueSaves - A stream can be saved multiple times, but the unique save count will only go up by one #### Function changes
  • func startTunnel() is now func startTunnel(shouldStart:Bool) pass in a bool to tell the SDK whether to start the tunnel or just ask permissions and save the profile. The default before this change was true. ### New Protocol *SpeedifyTunnelDelegate this allows a callback to trigger when a user denies permission or cannot save the profile. When these errors occur you MUST restart the tunnel by calling func startTunnel(shouldStart:Bool). Please see LoginViewController in the sample app for more information.

StreamStats has new property fields.

  • downloadSpeed - Download speed of the stream
  • averageDownloadSpeed - Average download speed of this stream, in megabits per second
  • averageUploadSpeed - Average upload speed of this stream, in megabits per second
  • groupID - Unique identifier of this stream
  • name - Name of app/service in use *redundantSaves - When a stream has switched to redundant mode
  • speedSaves - When the network speed dips below the speed of the stream and speedify bonds the connection for more speed

Speedify 9.7

  • No new features, this is a stability and performance release

Speedify 9.6

  • Speedify has a new Streaming Mode to better support video streamers. This can be set via setMode with BondingMode.streaming. Statistics on individual streams are available from refreshStreamingStats, and are provided once per second when enabling enableConnectionStatUpdates.

Speedify 9.5

  • Session stats in sessionPeriodStatsDidUpdate are now tracked over multiple time periods, including current session, last day, last week, last month, and total.

Speedify 9.3

  • The Local Proxy API now supports Domain Watchlists. Watchlists are lists of domains grouped by the service they represent, configurable via setLocalProxyDomainWatchlist. When an attempt to access a watched domain is seen,domainWatchListDelegate is triggered. setLocalProxyDomainWatchlistEnable can then be used to enable that service’s domains to be sent through the local proxy instead of the VPN

Speedify 9.2

  • Speedify SDK provides setLocalVendorSettings for saving a custom JSON object for later consumption.

Speedify 8.2

  • Port forwarding has been added. Call setForwardPorts to forward ports on a dedicated server to the client device.

Speedify 8.0.2

  • setExcludedIPRanges can be set to false to allow private IP ranges to be routed over the tunnel.

Speedify 7.5

  • serverInformationDidUpdate now sends a ServerInformation object with more information on the connect server..

Speedify 7.4

  • You can now set DNS servers used by the VPN via setDNSServers

Speedify 7.0

  • ConnectionStats now shows download and upload speeds, as well as download and upload maximum speed estimates for connections.

Speedify 6.3.4

  • New function func loginOauth(oauthAccessToken: String) which allows clients to login with JWT.

Speedify 6.3

  • New PrivacySettings struct
  • New delegate function privacySettingsDidUpdate(privacy: PrivacySettings)
  • New function setReportingEncryptionKey(key128bit: String)

Speedify 6.2.1

  • New AccountingData property -> bytesAvailable
  • New AccountingData property -> bytesUsed

Speedify 6.2

  • New function disableAdapterMonthlyDataLimit(adapterID: String)
  • New function disableAdapterDailyDataLimit(adapterID: String)

Speedify 6.1

  • New AccountingData struct
  • Deprecated - setUserUniqueID(uniqueID:String) please use loginAutoAccount()
  • New generateLogs method to help you send files from the Speedify Daemon *Require App Group Capabilities

Speedify 6.0

  • ValidationError is now ErrorType which gives you errors on login and when connecting to servers.
  • New property in the AdapterUsageData -> overlimitRatelimit
  • New functions for connecting now with an ErrorType parameter in the closure
  • New function setAdapterOverlimitRatelimit(adapterID: String, bps: Int64)
  • New function setUserUniqueID(uniqueID:String)
  • New Class UUIDProvider. This will help get a unique Id of the device

Speedify 5.9

  • You may now Enable or Disable use of ChaCha for connection encryption.
    • Just call func setChaChaEncrypted(encrypted: Bool) from the SpeedifySDK and listen for updates inside of the protocol func adapterDataDidUpdate(adapterData: [AdapterData])
  • New AdapterUsageData struct which gives information about the data usage and limits for a network adapter. You can watch for changes inside of the protocol func adapterDataDidUpdate(adapterData: [AdapterData]) which falls into a new property of the AdapterData struct named var dataUsage: AdapterUsageData
  • New Speedify Properties. Now you can simply refer to these referenced value types instead of subscribing to a protocol.
    • private(set) public var state: State?
    • private(set) public var version: Version?
    • private(set) public var adapterData: [AdapterData]?
    • private(set) public var serverInformation: ServerInformation?
    • private(set) public var settings: Settings?
    • private(set) public var stats: [ConnectionStats]?
  • Unit Testing. Navigate to SpeedifySDKTests.swift and change the username/password then inside of Xcode press cmd+u to start the tests.


Speedify 5.7.1 -> 5.8 Migration

5.7.1 5.8
ConnectionData AdapterData
ConnectionData.connectionID AdapterData.adapterID
ConnectionData.usageDaily AdapterUsageData.usageDaily
ConnectionData.usageMonthly AdapterUsageData.usageMonthly
NetworkState NetworkType
   
func setMode(mode: BondingMode,completionHandler:@escaping (_ message: [ConnectionData]?)->Void) func setMode(mode: BondingMode)
   
func setConnectionPriorities(connection: String, priority: ConnectionPriority, completionHandler:@escaping (_ message: SessionStats)->Void) func setConnectionPriorities(connection: String, priority: ConnectionPriority)
   
func setConnectionEncryption(connection: String, encrypt: Bool, completionHandler:@escaping (_ message: [ConnectionData]?)->Void) func setConnectionEncryption(adapterID: String, encrypt: Bool)
   
func setTunnelEncrypted(encrypted: Bool, completionHandler:@escaping (_ message: [ConnectionData]?)->Void) func setTunnelEncrypted(encrypted: Bool)
   
func setOverflowThreshold(bps: Double, completionHandler:@escaping (_ message: Dictionary<String, Any>)->Void func setOverflowThreshold(bps: Int64)
   
func addAdapterDailyDataLimitBoost(adapterID: String, additionalBytes: Double, completionHandler:@escaping (_ message: Dictionary<String, Any>)->Void) func addAdapterDailyDataLimitBoost(adapterID: String, additionalBytes: Int64)
   
func setAdapterDailyDataLimit(adapterID: String, allowedBytes: Double, completionHandler:@escaping (_ message: Dictionary<String, Any>)->Void) func setAdapterDailyDataLimit(adapterID: String, allowedBytes: Int64)
   
func setAdapterMonthlyDataLimit(adapterID: String, allowedBytes: Double, resetDay: Double, completionHandler:@escaping (_ message: Dictionary<String, Any>)->Void) func setAdapterMonthlyDataLimit(adapterID: String, allowedBytes: Int64, resetDay: Int64)

All rights reserved, Connectify, Inc.
Proprietary and Confidential