This project contains an application for iOS and for macOS, as well as many components shared between the two of them. You may toggle between the two platforms by selecting the target from within Xcode.

• Clone this repo:

$ git clone https://git.zx2c4.com/wireguard-apple
$ cd wireguard-apple

• Rename and populate developer team ID file:

$ cp Sources/WireGuardApp/Config/Developer.xcconfig.template Sources/WireGuardApp/Config/Developer.xcconfig
$ vim Sources/WireGuardApp/Config/Developer.xcconfig

• Install swiftlint and go 1.15:

$ brew install swiftlint go

• Open project in Xcode:

$ open WireGuard.xcodeproj

• Flip switches, press buttons, and make whirling noises until Xcode builds it.

WireGuardKit.xcframework.zip is produced by the GH action, and integrated in the Package.swift using binaryTarget.

To trigger the action and release - push a new tag. Then update binaryTarget url and checksum in Package.swift.

To build WireGuardKitGo.xcframework manually and test it locally, run:

make wg-go-framework

and replace the binaryTarget url with path: "Sources/WireGuardKitGo/out/WireGuardKitGo.xcframework".

1. Open your Xcode project and add the Swift package with the following URL:

   https://git.zx2c4.com/wireguard-apple
   

2. In Xcode project settings, locate your main bundle app and switch to "Build Phases" tab. Locate the "Link with binary libraries" section and hit "+" to add WireGuardKit.

3. iOS only: Locate Bitcode settings under your application target, Build settings -> Enable Bitcode, change the corresponding value to "No".

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.