24e3ca5ed7 | ||
---|---|---|
Passepartout | ||
Passepartout-Core | ||
Passepartout-CoreTests | ||
Passepartout-iOS | ||
Passepartout-iOS-Tunnel | ||
Passepartout.xcodeproj | ||
Passepartout.xcworkspace | ||
ci | ||
fastlane | ||
res | ||
.env | ||
.env.beta-archive | ||
.env.beta-deploy | ||
.env.dev-archive | ||
.env.dev-deploy | ||
.env.template.secret-codesign | ||
.env.template.secret-deploy | ||
.gitignore | ||
CHANGELOG.md | ||
CLA.rst | ||
CONTRIBUTING.md | ||
Gemfile | ||
LICENSE | ||
Podfile | ||
Podfile.lock | ||
README.md | ||
swiftgen.yml |
README.md
Passepartout
Passepartout is a non-official, user-friendly OpenVPN® client for iOS.
Beta
Passepartout betas are available for patrons on TestFlight.
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 .ovpn flags that are today obsolete or rarely used. With good approximation, it mimics the most relevant features you will find in OpenVPN 2.4.x.
Trusted networks
Trust cellular or Wi-Fi networks to fine-grain your connectivity. You can then choose to retain a VPN connection when entering a trusted network, or prevent it completely.
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:
In preset mode, you can pick pre-resolved IPv4 endpoints when DNS is problematic.
Import .ovpn profiles
Passepartout can import .ovpn configuration files. This way you can fine-tune encryption without tweaking and reimporting a new configuration.
You can find details on what may or may not work in the related section of the TunnelKit README.
Installation
Requirements
- iOS 11.0+
- Xcode 10+ (Swift 5)
- Git (preinstalled with Xcode Command Line Tools)
- Ruby (preinstalled with macOS)
- CocoaPods 1.6.0
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-ios.git
Assuming you have a working CocoaPods environment, setting up the app workspace only requires installing the pod dependencies:
$ pod install
After that, open Passepartout.xcworkspace
in Xcode and run the Passepartout-iOS
target.
For the VPN to work properly, the app requires:
- App Groups and Keychain Sharing capabilities
- App IDs with Packet Tunnel entitlements
both in the main app and the tunnel extension target.
Make sure to also update the following constants in Passepartout/Sources/GroupConstants.swift
according to your developer account and your target bundle identifiers:
public static let teamId
public static let appId
public static let appGroup
public static let tunnelIdentifier
License
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/
- MBProgressHUD - © 2009-2016 Matej Bukovinski
- PIATunnel - © 2018-Present Private Internet Access
- SSZipArchive - © 2010-2012 Sam Soffes
- SwiftGen - © 2018 SwiftGen
- SwiftyBeaver - © 2015 Sebastian Kreutzberger
- lzo - © 1996-2017 Markus F.X.J. Oberhumer
This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (https://www.openssl.org/)
© 2002-2018 OpenVPN Inc. - OpenVPN is a registered trademark of OpenVPN Inc.
Translations
- German: Christian Lederer
- Italian: Davide De Rosa (author) - @keeshux
- Portuguese: Helder Santana - @heldr
- Russian: Alexander Korobynikov
Usage
You are strongly encouraged to read carefully both the disclaimer and privacy policy before using this software.
Contacts
Twitter: @keeshux
Website: passepartoutvpn.app