TorManager 0.4.0

TorManager 0.4.0

×

Maintained by Benjamin Erhart.

 
Depends on:
Tor/GeoIP~> 408.13
IPtProxyUI~> 4.7
OrbotKit~> 1.1
 

TorManager 0.4.0

TorManager

Version License Platform

The easiest way to integrate Tor and Pluggable Transports into your app.

This library bundles all building blocks to integrate Tor into your app:

  • Tor.framework using
    • C-Tor
    • GeoIP files
  • IPtProxyUI using
    • Lyrebird Pluggable Transport
    • Snowflake Pluggable Transport
    • Auto-configuration support via Moat/RdSys services
    • Auto-configuration support for IPv4/IPv6 cappable networks
  • OrbotKit to detect and interact with a running Orbot

For an easy, no-brainer integration, change your AppDelegate like this:

import TorManager

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?


    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
        // Override point for customization after application launch.

        TorManager.shared.start { error in
            print("[\(String(describing: type(of: self)))] error=\(error?.localizedDescription ?? "(nil)")")
        }

        return true
    }
}

extension TorManager {

   static let shared = TorManager(
    directory: FileManager.default.urls(
        for: .cachesDirectory, in: .userDomainMask).first!.appendingPathComponent("tor", isDirectory: true))
}

Then, when you instantiate a WKWebView:

    let webViewConfiguration = WKWebViewConfiguration()
    
    if #available(iOS 17.0, *), let proxy = TorManager.shared.torSocks5Endpoint {
        webViewConfiguration.websiteDataStore.proxyConfigurations.removeAll()
        webViewConfiguration.websiteDataStore.proxyConfigurations.append(ProxyConfiguration(socksv5Proxy: proxy))
    }

    let webView = WKWebView(frame: .zero, configuration: webViewConfiguration)

To configure a URLSession:

    let config = URLSessionConfiguration.default
    config.connectionProxyDictionary = TorManager.shared.torSocks5ProxyConf

    let session = URLSession(configuration: config)

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

C-Tor will be compiled on your machine, hence you need to have the necessary dependencies available:

brew install automake autoconf libtool gettext

For more details, see the Tor.framework README

iOS Orbot support

Please add the following to your Info.plist file for Orbot support to work:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>orbot</string>
</array>

Installation

TorManager is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'TorManager'

Build

pod trunk push --allow-warnings

Author

Benjamin Erhart, [email protected] for the Guardian Project

License

TorManager is available under the MIT license. See the LICENSE file for more info.