Как перенести сетевое расширение класса NEPacketTunnelProvider из Obj-C / Swift в Xamarin C #? - PullRequest
0 голосов
/ 09 февраля 2019

Я пытаюсь выяснить, как сделать сетевое расширение, чтобы мое приложение для iOS могло программно открывать пользовательский VPN-туннель в C #, но, глядя на некоторые похожие проекты Obj-C, я не уверен, возможно ли это в Xamarin(так как я не вижу проект сетевого расширения в Visual Studio) и как перенести то, что я собираю, является обязательным классом PacketTunnelProvider, который, я думаю, должен присутствовать и сначала быть указан как расширение в plist.info ...В частности, у меня больше всего проблем с тем, как портировать части этого класса, которые появляются в конце как расширение, и некоторые обработчики событий, называемые так: func Adapter (адаптер: Adapter, configureTunnelWithNetworkSettings networkSettings: NEPacketTunnelNetworkSettings, завершениеHandler: @escaping (AdapterPacketFlow?) -> Void) и func Adapter (адаптер: событие Adapter, handleEvent: AdapterEvent, message: String?) , поскольку они оба имеют другую сигнатуру, чем обработчик события в C #, который принимает отправителяи eventArgs (или что-то производноеed)… если бы кто-то делал это в C #, я хотел бы знать, по крайней мере, возможно ли, если нет, как портировать такой класс?

Я нашел этот один проект https://github.com/ss-abramchuk/OpenVPNAdapter (так каккажется, он выполняет большую часть того, что я хочу), который мне удалось перевести в библиотеку привязки Xamarin, но я не уверен, как и если включить ее класс PacketTunnelProvider в Xamarin (так как это то, что readme говорит, вы должны использовать для включения чего-то вродеэтот адаптер) ... я полагаю, что сначала нужно добавить в plist.info что-то вроде этого:

<key>NSExtension</key>
<dict>
    <key>NSExtensionPointIdentifier</key>
    <string>com.apple.networkextension.packet-tunnel</string>
    <key>NSExtensionPrincipalClass</key>
    <string>$(PRODUCT_MODULE_NAME).PacketTunnelProvider</string>
</dict>

но куда вы отправляетесь, чтобы использовать библиотеку связывания?Это код Obj-C, который говорит и, по-видимому, делает то, что я хочу сделать после того, как добавить этот туннель настраиваемого протокола VPN в приложение, используя библиотеку:

import NetworkExtension
import OpenVPNAdapter

class PacketTunnelProvider : NEPacketTunnelProvider
{

    lazy var vpnAdapter: OpenVPNAdapter = {
        let adapter = OpenVPNAdapter()
        adapter.delegate = self

        return adapter
    }
()

let vpnReachability = OpenVPNReachability()

    var startHandler: ((Error?) -> Void)?
    var stopHandler: (() -> Void)?

    override func startTunnel(options: [String: NSObject]?, completionHandler: @escaping (Error?) -> Void)
{
    // There are many ways to provide OpenVPN settings to the tunnel provider. For instance,
    // you can use `options` argument of `startTunnel(options:completionHandler:)` method or get
    // settings from `protocolConfiguration.providerConfiguration` property of `NEPacketTunnelProvider`
    // class. Also you may provide just content of a ovpn file or use key:value pairs
    // that may be provided exclusively or in addition to file content.

    // In our case we need providerConfiguration dictionary to retrieve content
    // of the OpenVPN configuration file. Other options related to the tunnel
    // provider also can be stored there.
    guard
        let protocolConfiguration = protocolConfiguration as? NETunnelProviderProtocol,
            let providerConfiguration = protocolConfiguration.providerConfiguration
        else
    {
        fatalError()
        }

    guard let ovpnFileContent: Data = providerConfiguration["ovpn"] as? Data else
    {
        fatalError()
        }

    let configuration = OpenVPNConfiguration()
        configuration.fileContent = ovpnFileContent
        configuration.settings = [
            // Additional parameters as key:value pairs may be provided here
        ]

        // Apply OpenVPN configuration
    let properties: OpenVPNProperties
        do
    {
        properties = try vpnAdapter.apply(configuration: configuration)
        }
        catch
        {
            completionHandler(error)
            return
        }

        // Provide credentials if needed
        if !properties.autologin {
            // If your VPN configuration requires user credentials you can provide them by
            // `protocolConfiguration.username` and `protocolConfiguration.passwordReference`
            // properties. It is recommended to use persistent keychain reference to a keychain
            // item containing the password.

            guard let username: String = protocolConfiguration.username else
            {
                fatalError()
            }

            // Retrieve a password from the keychain
            guard let password: String = ... {
                fatalError()
            }

            let credentials = OpenVPNCredentials()
            credentials.username = username
            credentials.password = password

            do
            {
                try vpnAdapter.provide(credentials: credentials)
            }
                catch
                {
                    completionHandler(error)
                  return
              }
            }

        // Checking reachability. In some cases after switching from cellular to
        // WiFi the adapter still uses cellular data. Changing reachability forces
        // reconnection so the adapter will use actual connection.
        vpnReachability.startTracking { [weak self] status in
            guard status != .notReachable else { return }
    self?.vpnAdapter.reconnect(interval: 5)
        }

// Establish connection and wait for .connected event
startHandler = completionHandler
vpnAdapter.connect()
    }

    override func stopTunnel(with reason: NEProviderStopReason, completionHandler: @escaping () -> Void)
{
    stopHandler = completionHandler

        if vpnReachability.isTracking {
        vpnReachability.stopTracking()
        }

    vpnAdapter.disconnect()
    }

}

extension PacketTunnelProvider: OpenVPNAdapterDelegate {

    // OpenVPNAdapter calls this delegate method to configure a VPN tunnel.
    // `completionHandler` callback requires an object conforming to `OpenVPNAdapterPacketFlow`
    // protocol if the tunnel is configured without errors. Otherwise send nil.
    // `OpenVPNAdapterPacketFlow` method signatures are similar to `NEPacketTunnelFlow` so
    // you can just extend that class to adopt `OpenVPNAdapterPacketFlow` protocol and
    // send `self.packetFlow` to `completionHandler` callback.
    func openVPNAdapter(_ openVPNAdapter: OpenVPNAdapter, configureTunnelWithNetworkSettings networkSettings: NEPacketTunnelNetworkSettings, completionHandler: @escaping (OpenVPNAdapterPacketFlow?) -> Void)
{
    setTunnelNetworkSettings(settings) {
        (error) in
            completionHandler(error == nil ? self.packetFlow : nil)
        }
}

// Process events returned by the OpenVPN library
func openVPNAdapter(_ openVPNAdapter: OpenVPNAdapter, handleEvent event: OpenVPNAdapterEvent, message: String?)
{
    switch event {
        case .connected:
        if reasserting {
            reasserting = false
            }

        guard let startHandler = startHandler else { return }

        startHandler(nil)
            self.startHandler = nil

        case .disconnected:
        guard let stopHandler = stopHandler else { return }

        if vpnReachability.isTracking {
            vpnReachability.stopTracking()
            }

        stopHandler()
            self.stopHandler = nil

        case .reconnecting:
        reasserting = true

        default:
            break
        }
}

// Handle errors thrown by the OpenVPN library
func openVPNAdapter(_ openVPNAdapter: OpenVPNAdapter, handleError error: Error)
{
    // Handle only fatal errors
    guard let fatal = (error as NSError).userInfo[OpenVPNAdapterErrorFatalKey] as? Bool, fatal == true else
    {
        return
        }

    if vpnReachability.isTracking {
        vpnReachability.stopTracking()
        }

    if let startHandler = startHandler {
        startHandler(error)
            self.startHandler = nil
        } else
    {
        cancelTunnelWithError(error)
        }
}

// Use this method to process any log message returned by OpenVPN library.
func openVPNAdapter(_ openVPNAdapter: OpenVPNAdapter, handleLogMessage logMessage: String)
{
    // Handle log messages
}

}

// Extend NEPacketTunnelFlow to adopt OpenVPNAdapterPacketFlow protocol so that
// `self.packetFlow` could be sent to `completionHandler` callback of OpenVPNAdapterDelegate
// method openVPNAdapter(openVPNAdapter:configureTunnelWithNetworkSettings:completionHandler).
extension NEPacketTunnelFlow: OpenVPNAdapterPacketFlow {}

Как мне портировать на C # илиможет быть, я все делаю неправильно (из-за комментария ниже - обязательная DLL больше 15 МБ - или это ограничение в отношении использования памяти, которое не связано с размером файла)?Должен ли я просто ссылаться на пользовательскую библиотеку VPN, чтобы открыть VPN-туннель непосредственно из кода и идти оттуда, как обычно, как обычно (как я также нашел проект / приложение https://github.com/passepartoutvpn, в котором используется Cocoapod TunnelKit,но библиотека этого приложения не будет работать с шулером для создания библиотеки привязки, и если это так, будет ли приложение, подобное этому, допустимо в AppStore)?Заранее благодарю за любую помощь.


В соответствии с советом @SushiHangover, я пытался связать TunnelKit, так как этот проект казался меньше и успешно, частично ... I 'Мне удалось собрать ~ 3 МБ dll, который кажется намного меньше, чем 21 МБ OpenVPNAdapter, и я думаю, что я почти нахожусь там с проектом NetworkExtension ... Мне нужно только выяснить, все ли у меня хорошо получилось с @escapingзавершение работы и как получить некоторые групповые константы, которые, как мне кажется, должны быть как-то установлены в приложении Host?

public override void StartTunnel(NSDictionary<NSString, NSObject> options, Action<NSError> completionHandler)
    {
        //appVersion = "\(GroupConstants.App.name) \(GroupConstants.App.versionString)";
        //dnsTimeout = GroupConstants.VPN.dnsTimeout;
        //logSeparator = GroupConstants.VPN.sessionMarker;
        base.StartTunnel(options, completionHandler);
    }

Я закомментировал групповые константы, но, по крайней мере, надеюсь, что это хорошодостаточно портирования Swift3:

override func startTunnel(options: [String : NSObject]?, completionHandler: @escaping (Error?) -> Void) {
    appVersion = "\(GroupConstants.App.name) \(GroupConstants.App.versionString)"
    dnsTimeout = GroupConstants.VPN.dnsTimeout
    logSeparator = GroupConstants.VPN.sessionMarker
    super.startTunnel(options: options, completionHandler: completionHandler)
}

Если кто-то еще знает о константах группы и как их получить, я был бы благодарен (но я также должен отметить, что sharpie pod не дал / выставил ни одно из тех полей, которые я должен был назначить. Возможно, я сделал это неправильно, поскольку TunnelKit - это полностью Swift3 проект в отличие от OpenVPNAdapter: /

1 Ответ

0 голосов
/ 09 февраля 2019

Должен ли я на самом деле использовать пользовательскую библиотеку VPN, чтобы открыть туннель VPN и перейти оттуда, но будет ли приложение приемлемым для AppStore?

Для iOS12+, вам абсолютно необходимо использовать платформу Network Extension, чтобы иметь право на Store.

Задача сборки Xamarin.iOS (ValidateAppBundle) правильно определяет com.apple.networkextension.packet-tunnel как действительное расширение (.appex), так что давы можете создать расширение NEPacketTunnelProvider.

Вы правы, что VS не имеет встроенных шаблонов для сетевого провайдера .appex для туннелей, DNS-прокси, управления фильтрами | данных, типов прокси, но это действительно так.не означает, что вы не можете просто использовать другой шаблон (или создать проект с нуля) и изменить его (я создаю проект Xcode iOS и начинаю добавлять цели расширения и просто отражаю эти изменения в VS).

(К вашему сведению: это код Swift в вашем примере, а не ObjC ...)

Теперь из-за ограничений в размере .appex (и проблем с производительностью в некоторых случаях), много расширенийЭто очень сложно сделать через Xamarin.iOS.Большинство разработчиков, которые сталкиваются с этим, используют родной язык, используя ObjC / Swift, по крайней мере, для разработки приложений ...

...