{"id":13484891,"url":"https://github.com/WireGuard/wireguard-apple","last_synced_at":"2025-03-27T16:31:30.085Z","repository":{"id":32896907,"uuid":"134215655","full_name":"WireGuard/wireguard-apple","owner":"WireGuard","description":"Mirror only. Official repository is at https://git.zx2c4.com/wireguard-apple","archived":false,"fork":false,"pushed_at":"2024-08-09T18:44:27.000Z","size":5426,"stargazers_count":1084,"open_issues_count":20,"forks_count":469,"subscribers_count":43,"default_branch":"master","last_synced_at":"2025-03-24T21:12:07.232Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/WireGuard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-05-21T03:56:22.000Z","updated_at":"2025-03-24T20:04:59.000Z","dependencies_parsed_at":"2024-10-30T18:42:20.296Z","dependency_job_id":null,"html_url":"https://github.com/WireGuard/wireguard-apple","commit_stats":null,"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WireGuard%2Fwireguard-apple","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WireGuard%2Fwireguard-apple/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WireGuard%2Fwireguard-apple/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/WireGuard%2Fwireguard-apple/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/WireGuard","download_url":"https://codeload.github.com/WireGuard/wireguard-apple/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245882427,"owners_count":20687886,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T17:01:37.838Z","updated_at":"2025-03-27T16:31:29.458Z","avatar_url":"https://github.com/WireGuard.png","language":"Swift","readme":"# [WireGuard](https://www.wireguard.com/) for iOS and macOS\n\nThis 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.\n\n## Building\n\n- Clone this repo:\n\n```\n$ git clone https://git.zx2c4.com/wireguard-apple\n$ cd wireguard-apple\n```\n\n- Rename and populate developer team ID file:\n\n```\n$ cp Sources/WireGuardApp/Config/Developer.xcconfig.template Sources/WireGuardApp/Config/Developer.xcconfig\n$ vim Sources/WireGuardApp/Config/Developer.xcconfig\n```\n\n- Install swiftlint and go 1.19:\n\n```\n$ brew install swiftlint go\n```\n\n- Open project in Xcode:\n\n```\n$ open WireGuard.xcodeproj\n```\n\n- Flip switches, press buttons, and make whirling noises until Xcode builds it.\n\n## WireGuardKit integration\n\n1. Open your Xcode project and add the Swift package with the following URL:\n   \n   ```\n   https://git.zx2c4.com/wireguard-apple\n   ```\n   \n2. `WireGuardKit` links against `wireguard-go-bridge` library, but it cannot build it automatically\n   due to Swift package manager limitations. So it needs a little help from a developer. \n   Please follow the instructions below to create a build target(s) for `wireguard-go-bridge`.\n   \n   - In Xcode, click File -\u003e New -\u003e Target. Switch to \"Other\" tab and choose \"External Build \n     System\".\n   - Type in `WireGuardGoBridge\u003cPLATFORM\u003e` under the \"Product name\", replacing the `\u003cPLATFORM\u003e` \n     placeholder with the name of the platform. For example, when targeting macOS use `macOS`, or \n     when targeting iOS use `iOS`.\n     Make sure the build tool is set to: `/usr/bin/make` (default).\n   - In the appeared \"Info\" tab of a newly created target, type in the \"Directory\" path under \n     the \"External Build Tool Configuration\":\n     \n     ```\n     ${BUILD_DIR%Build/*}SourcePackages/checkouts/wireguard-apple/Sources/WireGuardKitGo\n     ```\n     \n   - Switch to \"Build Settings\" and find `SDKROOT`.\n     Type in `macosx` if you target macOS, or type in `iphoneos` if you target iOS.\n   \n3. Go to Xcode project settings and locate your network extension target and switch to \n   \"Build Phases\" tab.\n   \n   - Locate \"Dependencies\" section and hit \"+\" to add `WireGuardGoBridge\u003cPLATFORM\u003e` replacing \n     the `\u003cPLATFORM\u003e` placeholder with the name of platform matching the network extension \n     deployment target (i.e macOS or iOS).\n     \n   - Locate the \"Link with binary libraries\" section and hit \"+\" to add `WireGuardKit`.\n   \n4. In Xcode project settings, locate your main bundle app and switch to \"Build Phases\" tab. \n   Locate the \"Link with binary libraries\" section and hit \"+\" to add `WireGuardKit`.\n   \n5. iOS only: Locate Bitcode settings under your application target, Build settings -\u003e Enable Bitcode, \n   change the corresponding value to \"No\".\n   \nNote that if you ship your app for both iOS and macOS, make sure to repeat the steps 2-4 twice, \nonce per platform.\n\n## MIT License\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of\nthis software and associated documentation files (the \"Software\"), to deal in\nthe Software without restriction, including without limitation the rights to\nuse, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\nof the Software, and to permit persons to whom the Software is furnished to do\nso, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","funding_links":[],"categories":["Swift","Security"],"sub_categories":["RSS"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWireGuard%2Fwireguard-apple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FWireGuard%2Fwireguard-apple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FWireGuard%2Fwireguard-apple/lists"}