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 username 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, encoded in PKCS12 format.

var identityDataPassword: String?

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

var disconnectOnSleep: Bool

A flag indicating if the VPN should be disconnected when the device sleeps.

var proxySettings: NEProxySettings?

An NEProxySettings object containing the proxy settings to be used for HTTP and HTTPS connections which are routed through the VPN.

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.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software