d7f14aa3b4
Coming from a "will" publisher, the value in ProfileRepository is not up-to-date. Use the function argument instead. Fixes #367 |
||
---|---|---|
.github | ||
Passepartout | ||
Passepartout.xcodeproj | ||
PassepartoutLibrary | ||
PassepartoutTests | ||
ci | ||
fastlane | ||
res | ||
scripts | ||
.beta-base | ||
.beta-build | ||
.env | ||
.env.beta | ||
.env.ios | ||
.env.mac | ||
.gitignore | ||
.gitmodules | ||
.ruby-version | ||
.swiftlint.yml | ||
API | ||
CHANGELOG.1.ios.md | ||
CHANGELOG.1.mac.md | ||
CHANGELOG.md | ||
CLA.rst | ||
CONTRIBUTING.md | ||
Config.xcconfig | ||
Gemfile | ||
Gemfile.lock | ||
LICENSE | ||
Passepartout.xctestplan | ||
README.md | ||
swiftgen.yml |
README.md
Passepartout
Passepartout is a user-friendly OpenVPN® and WireGuard® client for iOS and macOS. The OpenVPN stack also implements the Tunnelblick XOR patch.
Overview
All profiles in one place
Passepartout lets you handle multiple profiles in one single place and quickly switch between them.
Ease of use
With its native look & feel, Passepartout focuses on ease of use. It does so by stripping the flags that are today obsolete or rarely used. With good approximation, it mimics the most relevant features you will find in the official OpenVPN and WireGuard clients.
Not to mention iCloud support, which makes your VPN profiles available on all your devices without any additional effort!
On demand
Define rules for Wi-Fi, cellular (iOS) or wired (macOS) networks to fine-grain how you automate your VPN connectivity.
Siri shortcuts
Enjoy the convenience of Siri shortcuts to automate frequent VPN actions.
Override network settings
Override default gateway, DNS (plus DoH/DoT), proxy and MTU settings right from the app. Don't bother editing the configuration file or your server settings. This is especially useful if you want to override your provider settings, e.g. to integrate your own DNS-based ad blocking.
See your connection parameters
Passepartout strives for transparency, by showing a fairly detailed yet understandable resume of your connection parameters.
Disconnect on sleep
Keeping the VPN active in the background provides smoother operation, but may be tough for the battery. You might want to use this feature if you're concerned about battery life. When the device goes to sleep, the VPN will disconnect to then reconnect on device wake-up.
No unrequested activity
Passepartout is a VPN client and does absolutely nothing else without your consent. The providers infrastructures are obtained via a static GitHub API if and only if you manually refresh them.
Presets for major providers
Passepartout can connect to a few well-known VPN providers with an existing account:
- Hide.me
- Mullvad
- NordVPN
- Oeck
- Private Internet Access
- ProtonVPN
- SurfShark
- TorGuard
- TunnelBear
- VyprVPN
- Windscribe
In preset mode, you can pick pre-resolved IPv4 endpoints when DNS is problematic.
Import configuration files
Passepartout can import .ovpn (OpenVPN) and .conf/.wg (WireGuard) configuration files as is. You can find details on what may or may not work in the related section of the TunnelKit README.
Installation
Requirements
- iOS 15+ / macOS 12+
- Xcode 13+ (SwiftPM 5.3)
- Git (preinstalled with Xcode Command Line Tools)
- Ruby (preinstalled with macOS)
- golang
It's highly recommended to use the Git and Ruby packages provided by Homebrew.
Testing
Download the app codebase locally:
$ git clone https://github.com/passepartoutvpn/passepartout-apple.git
Enter the directory and clone the submodules:
$ git submodule init
$ git submodule update
For everything to work properly, make sure to comply with all the capabilities/entitlements, both in the main app and the tunnel extension target.
Make sure to update Config.xcconfig
according to your developer account and your identifiers:
CFG_TEAM_ID = A1B2C3D4E5
CFG_APP_ID = com.example.MyApp
CFG_APP_LAUNCHER_ID = com.example.MyApp.Launcher // macOS only
CFG_GROUP_ID = com.example.MyAppGroup // omit the "group." prefix
CFG_APPSTORE_ID = 1234567890 // optional for development, can be bogus
Also, PATH
must include your golang installation in order to compile WireGuardKit:
PATH = $(PATH):/path/to/golang
To eventually test the app, open Passepartout.xcodeproj
in Xcode and run the Passepartout
target.
License
Copyright (c) 2023 Davide De Rosa. All rights reserved.
This project is licensed under the GPLv3.
Contributing
By contributing to this project you are agreeing to the terms stated in the Contributor License Agreement (CLA). For more details please see CONTRIBUTING.
Credits
The logo is taken from the awesome Circle Icons set by Nick Roach.
The country flags are taken from: https://github.com/lipis/flag-icon-css/
- Kvitto - Copyright (c) 2015 Oliver Drobnik
- lzo - Copyright (c) 1996-2017 Markus F.X.J. Oberhumer
- PIATunnel - Copyright (c) 2018-Present Private Internet Access
- SwiftGen - Copyright (c) 2018 SwiftGen
- SwiftyBeaver - Copyright (c) 2015 Sebastian Kreutzberger
OpenVPN
© Copyright 2022 OpenVPN | OpenVPN is a registered trademark of OpenVPN, Inc.
WireGuard
© Copyright 2015-2022 Jason A. Donenfeld. All Rights Reserved. "WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld.
OpenSSL
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (https://www.openssl.org/)
Community
A huge credit goes to:
- My tiny group of 3 private beta testers
- The 3600+ public testers using the beta on a daily basis
- The continued support and feedback from the Passepartout community on Reddit
- The overall patience of users affected by my bugs that actively collaborate in resolving them
- All those who contributed to the amazingly high rating on the App Store
Translations
- Chinese (Simplified): OnlyThen - @OnlyThen
- Dutch: Norbert de Vreede - @paxpacis
- English: Davide De Rosa (author)
- French: Julien Laniel - @linkjul
- German: Christian Lederer, Theodor Tietze
- Greek: Konstantinos Koukoulakis
- Italian: Davide De Rosa (author)
- Polish: Piotr Książek
- Portuguese: Helder Santana - @heldr
- Russian: Alexander Korobynikov
- Spanish: Davide De Rosa (author), Elena Vivó
- Swedish: Henry Gross-Hellsen - @cowpod
- Ukranian: Dmitry Chirkin - @josser
Usage
You are strongly encouraged to read carefully both the disclaimer and privacy policy before using this software.
Contacts
Twitter: @keeshux
Website: passepartoutvpn.app (FAQ)