passepartoutvpn
/
passepartout-apple
mirror of https://github.com/passepartoutvpn/passepartout-apple.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
passepartout-apple/README.md

5.6 KiB
Raw Blame History

Passepartout

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

Passepartout relies on TunnelKit for most VPN functionality.

Beta

Passepartout is in public beta. You can get early versions of the app via TestFlight.

By using a beta version of the app, you understand that the software might be unstable, unreliable or plain broken from time to time.

Overview

All profiles in one place

Passepartout lets you handle multiple profiles in one single place and quickly switch between them.

snap-home

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.

snap-profile

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.

snap-trusted

See your connection parameters

Passepartout strives for transparency, by showing a fairly detailed yet understandable resume of your connection parameters.

snap-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 only 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. Below are a few limitations worth mentioning.

Unsupported (yet):

  • TLS wrapping
    • --tls-auth
    • --tls-crypt
  • UDP fragmentation, i.e. --fragment

Unsupported (probably ever):

  • Compression
    • --comp-lzo other than no
    • --compress other than empty
  • External file references (inline <block> only)

Ignored:

  • MTU overrides
    • --*-mtu and variants
    • --mssfix
  • Multiple --remote (first wins)

Other flags are ignored too but planned to be implemented.

Installation

Requirements

  • iOS 11.0+
  • Xcode 10+ (Swift 4.2)
  • Git (preinstalled with Xcode Command Line Tools)
  • Ruby (preinstalled with macOS)
  • CocoaPods 1.4.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/keeshux/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.

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.

  • SwiftyBeaver - © 2015 Sebastian Kreutzberger
  • MBProgressHUD - © 2009-2016 Matej Bukovinski

© 2002-2018 OpenVPN Inc. - OpenVPN is a registered trademark of OpenVPN Inc.

Disclaimer

Passepartout is a VPN client based on independent work. As such, the developer -while making his best efforts to avoid it- takes no responsibility about any damage caused by the use of this software.

Additionally, the developer takes no responsibility about data usage, monitoring, logging etc. by the servers you connect to. Passepartout is not even involved in the above choices, as they're part of server-side policies.

For more information about data usage by third parties, please review the privacy policy of your VPN provider.

Contacts

Twitter: @keeshux

Website: passepartoutvpn.app

Donations

Passepartout is free software. If you like it, please support me on Patreon.