Table of Contents

Class IosDevice

Namespace
VpnHood.Core.Client.Devices.Ios
Assembly
VpnHood.Core.Client.Devices.Ios.dll

Represents an iPhone, iPad or Apple TV as the VPN app sees it: the VPN service runs in the app's Network Extension, its packet tunnel provider, which iOS starts.

public class IosDevice : IDevice, IDisposable
Inheritance
IosDevice
Implements
Inherited Members

Constructors

IosDevice(string, string, string)

Initializes a new instance of the IosDevice class, with the VPN service's folders in the shared container, the config folder marked to stay out of backups.

public IosDevice(string providerBundleId, string sharedContainerPath, string localizedDescription)

Parameters

providerBundleId string

The Network Extension's bundle identifier (the Packet Tunnel Provider appex bundle id).

sharedContainerPath string

The folder of the App Group's container the two processes share: the container itself, NSFileManager.DefaultManager.GetContainerUrl(appGroupId).Path, or on tvOS its Library/Caches, the only folder there an app may write. Resolved before VpnHoodApp.Init so it is stable for the whole session. The folders under it are forwarded verbatim to the Extension via ProviderConfiguration — an App-Group container is mounted at the same absolute path in both processes, so the Extension never needs the App Group id. No other folder will do: LocalApplicationData is a different path in each process.

localizedDescription string

The VPN configuration name shown in iOS Settings.

Exceptions

ArgumentException

sharedContainerPath or localizedDescription is empty.

ArgumentNullException

sharedContainerPath or localizedDescription is null.

Fields

VpnServiceConfigFolderName

The name of the VPN service's config folder in the shared container, the extension's too (IosVpnService): vpn-service-config.

public const string VpnServiceConfigFolderName = "vpn-service-config"

Field Value

string

Properties

IsAlwaysOnSupported

Gets a value indicating whether the app can keep the VPN always on itself, which its always-on setting then turns on, as a desktop's service that starts at boot does; false where the system does it, as on Android, whose setting the app only opens.

public bool IsAlwaysOnSupported { get; }

Property Value

bool

IsBindProcessToVpnSupported

Gets a value indicating whether BindProcessToVpn(bool) works on the device.

public bool IsBindProcessToVpnSupported { get; }

Property Value

bool

IsExcludeAppsSupported

Gets a value indicating whether the device can keep chosen apps out of the tunnel.

public bool IsExcludeAppsSupported { get; }

Property Value

bool

IsIncludeAppsSupported

Gets a value indicating whether the device can let only chosen apps into the tunnel.

public bool IsIncludeAppsSupported { get; }

Property Value

bool

IsQuicSupported

Gets a value indicating whether the device can make QUIC connections.

public bool IsQuicSupported { get; }

Property Value

bool

IsTv

Gets a value indicating whether the device is a TV.

public bool IsTv { get; }

Property Value

bool

IsWaitingForVpnPermission

Gets a value indicating whether RequestVpnService(IUiContext?, TimeSpan, CancellationToken) waits on the OS's prompt for the person's yes, so a UI elsewhere, as a browser driving a TV, can say where the connection waits.

public bool IsWaitingForVpnPermission { get; }

Property Value

bool

Remarks

RequestVpnService(IUiContext?, TimeSpan, CancellationToken) asks nothing here.

KillSwitch

Gets the kill switch's block, where the device has one, as a desktop's service; otherwise, null. The device holds it, as it outlives each connection's VPN service, whose host controls the same block through a controller of its own.

public IVpnKillSwitch? KillSwitch { get; }

Property Value

IVpnKillSwitch

MemInfo

Gets the device's memory as the platform reports it now, or null where it is not known; a desktop's comes from the .NET garbage collector's view.

public DeviceMemInfo? MemInfo { get; }

Property Value

DeviceMemInfo

Remarks

Not known here: null.

OsInfo

Gets a description of the device and its OS, as Google: Pixel 8, Android: 16.

public string OsInfo { get; }

Property Value

string

UserAgentInfo

Gets the parts of a browser's user agent on the device, which the app builds its own from.

public DeviceUserAgentInfo UserAgentInfo { get; }

Property Value

DeviceUserAgentInfo

Remarks

As Safari says it, which names no model; an Apple TV, which has no Safari, as its own media player says it.

VpnServiceConfigFolder

Gets the folder of the VPN service's own files: its options, status and log, and the split filters the app publishes for it, meant to stay on this device, out of backups and transfers to a new device.

public string VpnServiceConfigFolder { get; }

Property Value

string

Remarks

Where the device can, the folder is kept out of the OS's backups: Android's is its folder outside them, and on iOS a failure to exclude it is only logged. A desktop's is an ordinary folder.

Exceptions

InvalidOperationException

Android gives no folder outside its backups.

VpnServiceDataFolder

Gets the folder of what the app and the VPN service share that is the person's own, as the proxies they added, meant to travel with a backup where the OS backs it up; tvOS keeps it among its caches.

public string VpnServiceDataFolder { get; }

Property Value

string

Remarks

vpn-service in the shared container, which on tvOS is among the caches.

Methods

BindProcessToVpn(bool)

Binds the app's own connections to the system's default network, which is the VPN while one is connected, or, with false, to a network outside the VPN: on Android, the first of Ethernet, Wi-Fi, USB, satellite, Bluetooth and cellular.

public void BindProcessToVpn(bool value)

Parameters

value bool

true for the system's default network; false for a network outside the VPN.

Remarks

true throws NotSupportedException; false does nothing.

Exceptions

NotSupportedException

The device does not support it (IsBindProcessToVpnSupported).

Exception

Android found no network outside the VPN.

CreateMessageClient()

Creates a client of the VPN service's messages, through which the app commands it.

public IMessageClient CreateMessageClient()

Returns

IMessageClient

The client.

Remarks

It sends each request to the running tunnel as a provider message.

Dispose()

Does nothing: iOS owns the tunnel's lifetime.

public void Dispose()

GetInstalledApps(CancellationToken)

Gets the installed apps a split by app can pick from, each with its name and icon.

public Task<IReadOnlyList<DeviceAppInfo>> GetInstalledApps(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task<IReadOnlyList<DeviceAppInfo>>

A task whose result is the apps: on Android, by name; a Windows debug build gives test entries.

Remarks

iOS gives an ordinary VPN app no split by app, per-app VPN being for managed devices, so it always throws NotSupportedException.

Exceptions

NotSupportedException

The device cannot split by app.

InvalidOperationException

Android's package manager or an app's resources are not available.

Exception

Android could not encode an app's icon.

OperationCanceledException

cancellationToken was canceled.

RequestVpnService(IUiContext?, TimeSpan, CancellationToken)

Prepares the device to run the app's VPN service: on Android, it asks for the person's consent with the OS's prompt where the OS requires it now; on the Windows VPN plug-in, it prepares the VPN profile; elsewhere it may do nothing, as iOS configures the VPN when it starts.

public Task RequestVpnService(IUiContext? uiContext, TimeSpan timeout, CancellationToken cancellationToken)

Parameters

uiContext IUiContext

The UI to show a prompt in, or null; on Android, one given must be Android's own, and one is needed where the OS must ask.

timeout TimeSpan

How long to wait for the person's answer, where the device waits for one, as Android does.

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A task that completes once the device is prepared.

Remarks

iOS needs nothing here: it completes at once, and iOS asks the person, the first time, when the start saves the VPN configuration.

Exceptions

UserCanceledException

The person refused, on Android.

Exception

Android must ask, and no UI was given.

InvalidCastException

The UI given is not Android's own, on Android.

ArgumentOutOfRangeException

timeout is negative, other than -1 ms, or too long, on Android.

TimeoutException

The person did not answer in time, or the wait was canceled, on Android; or the Windows VPN plug-in's profile did not disconnect in time.

InvalidOperationException

The Windows VPN plug-in's profile could not be prepared.

OperationCanceledException

cancellationToken was canceled.

StartVpnService(CancellationToken)

Starts the VPN service, which then connects as its options in the config folder say. The task completes once the start is under way, not when the VPN is up; the app's service manager waits for that.

public Task StartVpnService(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

The token to monitor for cancellation requests.

Returns

Task

A task that represents the asynchronous operation.

Remarks

iOS fails it with an NSErrorException of its own.

Exceptions

VpnServiceException

Android could not start the service.

InvalidOperationException

A desktop's VPN host or the Windows VPN plug-in's profile is missing or failed.

ObjectDisposedException

A desktop's VPN host process was disposed.

TimeoutException

The Windows VPN plug-in did not start in time.

Win32Exception

Windows refused the VPN host's process.

OperationCanceledException

cancellationToken was canceled.

NSErrorException

iOS could not save the VPN configuration or start the tunnel.