VPN client for Apple platforms.
Go to file
Davide De Rosa ebb34c5ab0 Update to latest API 2019-09-07 10:47:15 +02:00
.github Add sponsors 2019-08-24 23:02:16 +02:00
Libraries Symlink to submodules 2019-05-27 00:14:14 +02:00
Passepartout-iOS Reuse Issue from Core 2019-09-05 22:50:56 +02:00
Passepartout-iOS-Tunnel Bump version 2019-08-10 10:08:32 +02:00
Passepartout.xcodeproj Use TunnelKit 2.0.3 2019-09-07 00:14:01 +02:00
Passepartout.xcworkspace Initial commit 2018-10-11 09:13:19 +02:00
PassepartoutCore-iOS Bump version 2019-08-10 10:08:32 +02:00
Submodules Update to latest API 2019-09-07 10:47:15 +02:00
ci Add script to copy English release notes 2019-07-27 10:02:07 +02:00
fastlane Set beta release 2019-09-03 00:31:38 +02:00
res Add network settings snapshot to README 2019-05-14 11:39:41 +02:00
.env Set RC release 2018-11-01 15:26:28 +01:00
.env.beta-archive Initial commit 2018-10-11 09:13:19 +02:00
.env.beta-deploy Initial commit 2018-10-11 09:13:19 +02:00
.env.dev-archive Initial commit 2018-10-11 09:13:19 +02:00
.env.dev-deploy Submit dev builds to App Center 2019-03-21 22:20:53 +01:00
.env.template.secret-codesign Add secret env templates 2019-03-29 13:22:25 +01:00
.env.template.secret-deploy Add secret env templates 2019-03-29 13:22:25 +01:00
.gitignore Add local symlinks to metadata 2019-04-15 21:14:32 +02:00
.gitmodules Readd removed clones as submodules 2019-05-27 11:20:03 +02:00
CHANGELOG.md Set beta release 2019-09-03 00:31:38 +02:00
CLA.rst Initial commit 2018-10-11 09:13:19 +02:00
CONTRIBUTING.md Initial commit 2018-10-11 09:13:19 +02:00
Gemfile Use TunnelKit 2.0.3 2019-09-07 00:14:01 +02:00
LICENSE Initial commit 2018-10-11 09:13:19 +02:00
Podfile Use TunnelKit 2.0.3 2019-09-07 00:14:01 +02:00
Podfile.include Upgrade to TunnelKit 2.0 2019-05-25 18:29:10 +02:00
Podfile.lock Use TunnelKit 2.0.3 2019-09-07 00:14:01 +02:00
README.md Credit zh-Hans 2019-08-10 10:08:17 +02:00
swiftgen.yml Move app-related strings in 2019-06-23 00:11:56 +02:00

README.md

Passepartout

iOS 11+ TunnelKit 2.0.x License GPLv3 Join Reddit Join Telegram Tweet

Passepartout is a non-official, user-friendly OpenVPN® client for iOS.

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.

Override network settings

Override default gateway, DNS and proxy settings right from the app. Don't bother editing the .ovpn file or your pushed server settings. This is especially useful if you want to override your provider settings, e.g. to integrate your own DNS-based ad blocking.

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

Enter the directory and clone the submodules:

$ git submodule init
$ git submodule update

Assuming you have a working CocoaPods environment, setting up the app workspace only requires installing the pod dependencies:

$ pod install

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 update Passepartout-iOS/Config.xcconfig according to your developer account and your identifiers:

CFG_TEAM_ID = A1B2C3D4E5
CFG_APP_ID = com.example.ios.MyApp
CFG_GROUP_ID = com.example.MyAppGroup // omit the "group." prefix
CFG_APPSTORE_ID = 1234567890 // optional for development, can be bogus

After that, open Passepartout.xcworkspace in Xcode and run the Passepartout-iOS target.

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

  • Chinese (Simplified): OnlyThen - @OnlyThen
  • Dutch: Norbert de Vreede - @paxpacis
  • English: Davide De Rosa (author)
  • French: Julien Laniel - @linkjul
  • German: Christian Lederer
  • Greek: Konstantinos Koukoulakis
  • Italian: Davide De Rosa (author)
  • Portuguese: Helder Santana - @heldr
  • Russian: Alexander Korobynikov
  • Spanish: Davide De Rosa (author), Elena Vivó
  • Swedish: Henry Gross-Hellsen - @cowpod

Usage

You are strongly encouraged to read carefully both the disclaimer and privacy policy before using this software.

Contacts

Twitter: @keeshux

Website: passepartoutvpn.app