Instance Property

serverAddress

The address of the tunneling server

Declaration

var serverAddress: String? { get set }

Discussion

The format of the value of this property depends on the type of tunneling protocol being used. For example, for IPSec the value should be a hostname or an IP address. For a custom SSL-VPN protocol the value may be a URL. The only requirement imposed by the Network Extension framework is that this property must be set to a non-nil string before the protocol configuration is considered valid.

See Also

Accessing Common Tunnel Properties

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.

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