Class

NEVPNProtocol

Settings common to both IKEv2 and IPsec VPN configurations.

Declaration

class NEVPNProtocol : NSObject

Overview

The NEVPNProtocol class is an abstract base class, with one subclass for each type of supported tunneling protocol.

Instances of this class are thread safe.

Topics

Accessing Common Tunnel Properties

var serverAddress: String?

The address of the tunneling server.

var username: String?

The user name component of the tunneling protocol authentication credential.

var passwordReference: Data?

A persistent keychain reference to a keychain item containing the password component of the tunneling protocol authentication credential.

var identityReference: Data?

A persistent keychain reference to a keychain item containing the certificate and private key components of the tunneling protocol authentication credential.

var identityData: Data?

The certificate and private key components of the tunneling protocol authentication credential, in PKCS12 format.

var identityDataPassword: String?

The password to decrypt the PKCS12 data set in the identityData property.

var disconnectOnSleep: Bool

A flag indicating whether the VPN disconnects when the device sleeps.

var proxySettings: NEProxySettings?

The proxy settings to use for HTTP and HTTPS connections that route through the VPN.

var includeAllNetworks: Bool

A property that indicates that the system sends all network traffic over the tunnel.

var excludeLocalNetworks: Bool

A property that indicates that the system excludes all traffic destined for local networks from the tunnel.

Relationships

Inherits From

See Also

VPN Configuration

class NEVPNManager

An object to create and manage a Personal VPN configuration.

class NEVPNProtocolIKEv2

Settings for an IKEv2 VPN configuration.

class NEVPNProtocolIPSec

Settings for an IPsec VPN configuration.