/Wireguardkit

Primary LanguageSwift

WireGuard Integration Guide

This guide aims to simplify the process of integrating WireGuard into your iOS application. I've tried to make this complex procedure easy.

Step 1: Create a New Project

Start by creating a new project in Xcode if you haven't already done so.

Step 2: Add Network Extension

  1. Add a new target to your project by selecting File > New > Target....
  2. Choose the Network Extension target type and click Next.
  3. Name your Network Extension, e.g., network-extension, and then click Finish.
  4. When prompted to activate the scheme for the network extension, select Cancel.

Step 3: External Build System Setup

  1. Add another new target by selecting File > New > Target... again. We are using this external build system for building wireguard.

  2. This time, select External Build System.

  3. Name this target WireguardGoBridge.

  4. In the Build Tool field, enter $(PROJECT_DIR)/script/build_wireguard_go_bridge.sh.

    • This script is responsible for building the WireGuard. You can find the script at script/build_wireguard_go_bridge.sh. Add script to your project.
    • Modify the Go path in the script at line 38 as necessary, according to your setup. Refer to this Stack Overflow answer for guidance.

Step 4: Add WireGuardKit Dependency

  1. To your project, add the WireGuardKit dependency by navigating to Project > Package Dependencies, then click the + button.
  2. Enter the URL https://git.zx2c4.com/wireguard-apple and select the exact version 1.0.15-26.
  3. When prompted, select the network-extension target for the package.

Step 5: Configure Targets

  1. For your Network Extension (NE) target:

    • Go to Build Phases > Target Dependencies and add WireguardGoBridge as a dependency.
    • Under Build Phases > Link Binary with Libraries, ensure WireguardKit and NetworkExtension.framework are available.

  2. Ensure WireguardKit targets the network-extension in its build phases.

Step 6: Add Configuration Extensions

In your Network Extension target, add TunnelConfiguration+wgQuickConfig and String+ArrayConversion extensions. These will help in configuring the tunnel and handling array conversions, respectively.

Dont forget to change identifier here Also edit the wireguard config here

Acknowledgements

Taken help from:

Contact

Feel free to open any issue or contact me if you face any issue.

Feel free to open any issue or contact me if you face any issue.

Platform Link
Email shahzainali93@gmail.com
LinkedIn LinkedIn Profile
StackOverflow StackOverflow Profile

I hope this guide facilitates a smoother integration process for you. Feedback and queries are always welcome.