IPSec Protocol

IPSec (Internet Protocol Security) is a secure network protocol suite that authenticates and encrypts data packets to provide secure encrypted communication between two computers over an Internet Protocol network. Unified SDK is using system default IKEv2 device for IPSec VPN tunnel.

Adding IPSec protocol support

The Apple SDK provides IPSec support as a wrapper on the native Apple IPSec implementation using IKEv2. You can use IPSec either as a standalone single-protocol SDK or as part of the Unified SDK with multiple protocols.

Standalone IPSec SDK:

import VPNSDK
import VPNApplicationSDK


let groupData = VPNGroupData(
    groupID: "group.com.yourcompany.vpnsdk-demo",
    usesSystemExtension: false
)

let iPSecConfiguration = IPSecConfiguration(
    carrierID: "YOUR_CARRIER_ID",
    groupData: groupData,
    trafficCountersFetchInterval: 3.0,
    hostURLs: nil,
    profileName: "My VPN",
    onDemandConfiguration: OnDemandConfiguration.default,
    networkConfiguration: nil,
    modulesConfiguration: ModulesConfiguration.default,
    securityConfiguration: SecurityConfiguration.default,
    deviceType: nil,
    logsCryptographicCredentials: nil,
    externalDeviceID: nil,
    storageServiceName: nil,
    systemExtensionEncryptionKey: nil
)

let iPSecSDK = IPSecSDK(configuration: iPSecConfiguration)

Unified SDK with IPSec:

import VPNSDK
import VPNApplicationSDK


let groupData = VPNGroupData(
    groupID: "group.com.yourcompany.vpnsdk-demo",
    usesSystemExtension: false
)

let fireshieldConfig = FireshieldConfig(
    mode: .disabled,
    groupData: groupData
)

let configuration = ComposedConfiguration(
    availableTypes: [
        .hydra(extensionBundleID: "HYDRA_NETWORK_EXTENSION_BUNDLE_ID"),
        .ipsec
    ],
    carrierID: "CARRIER_ID",
    groupData: VPNGroupData(
        groupID: "group.GROUP_ID",
        usesSystemExtension: false
    ),
    trafficCountersFetchInterval: nil,
    profileName: "PROFILE_NAME",
    fireshieldConfig: fireshieldConfig,
    isVPNIconFixEnabled: true
)

let initialProtocolType = VPNProtocolType.ipsec // IPSec will be set as active after SDK init

let unifiedSDK = ManualSwitchingVPNSDK(configuration: configuration, initialProtocolType: initialProtocolType)

Note:

ComposedConfiguration requires at least 2 protocols, so the snippet includes both .hydra and .ipsec in availableTypes, with .ipsec set as the initialProtocolType.

To start using it, set the Protocol field to the IPSec value from the Core.Model.Enums.Protocol enum when starting the VPN.

var sdk = new SDK();

// ...

var getLocationsRequest = new GetLocationsRequest
{
    AccessToken = loginResponse.AccessToken,
    Protocol = Core.Model.Enums.Protocol.IPsec,
};

var getLocationsResponse = await sdk.GetLocationsAsync(getLocationsRequest).ConfigureAwait(false);
var selectedLocation = getLocationsResponse.VpnCustomLocations.FirstOrDefault();

var getCredentialsRequest = new GetCredentialsRequest
{
    AccessToken = loginResponse.AccessToken,
    VpnNode = selectedLocation,
    WithCertificate = true,
    Protocol = Core.Model.Enums.Protocol.IPsec,
};

var getCredentialsResponse = await sdk.GetCredentialsAsync(getCredentialsRequest).ConfigureAwait(false);
// ...

When changing the VPN protocol, it's important to call the GetLocations and GetCredentials methods before invoking StartVpn. This is necessary because by calling GetLocations and GetCredentials after changing the protocol and before starting the VPN, you ensure that your application has the necessary information (available nodes) and authentication details (credentials) to successfully establish a VPN connection using the desired protocol.

PreviousRetrieving Location Information NextDomain Bypass

Last updated 15 days ago

Was this helpful?

hashtagAdding IPSec protocol support

Adding IPSec protocol support