youngshingjun / vpnon

Turn On your VPN like a hero.

VPN On

Turning on a VPN is always a painful experience on an iOS device due to the deep nested menus. This App installs a Today Widget into Notification Center which make it possible to turn on a VPN in about 3 seconds(depends on the connection speed). Furthermore, by turning on On Demand feature, the VPN could be automatically connected when you visit any domain specified in this App.

Requirements

• An iPhone/iPad running iOS 10.3+
• An IPSec IKEv1 / IKEv2 VPN(create yours with my Ansible Playbook or deploy on DigitalOcean)
• Xcode 10.3+
• An Apple iOS develop account
• A MaxMind account for GeoIP resolving
• Carthage

Build with Xcode

To compile the project, you may temporarily modify the bundle_id after adding yours into the Apple Developer Center. And then activate the following capabilities of the container App and the Today extension:

1. Personal VPN
2. Keychain Sharing
3. App Groups

Meanwhile, provisioning profiles are required for testing on iPhone/iPad.

Usage

Once you add a VPN configuration you can activate the Today Widget in Notification Center, then turn on the VPN by tapping a switch or flag. You may be asked to allow the installation of a VPN profile for the first time.

Contribution

Issues and roadmap are listed here.

This project follows the gitflow workflow. You'd better create a branch called feature/sth_improved before any major improvements. Meanwhile minor bug fixes are welcomed in the develop branch.

Localization

Please contribute to the Transifex project.

URL Schemes

Add configuration

VPN service providers may list a link for their customers to efficiently add server configurations in VPN On. By register the vpnon:// protocol, it supports the following URL scheme:

vpnon://{account}:{password}@{server}/?title={title}&group={group}&secret={secret}&alwayson=[yes|no]&ikev2=[yes|no]

server and title are required, other fields are optional. The following URLs are valid:

• vpnon://jony:[email protected]/?title=Apple&group=Design&secret=iPhone
• vpnon://apple.com/?title=Apple
• vpnon://[email protected]/?title=Google&group=devops
• vpnon://[email protected]/?title=Yahoo&alwayson=no
• vpnon://jony:[email protected]/?title=Twitter&ikev2=yes
• vpnon://jony:[email protected]/?title=Twitter&ikev2=yes&remoteid=jetblack

Establish connection

• vpnon://VPNTitle/?connect
• vpnon://VPNTitle/?connect&callback=https://twitter.com

Disconnect

• vpnon://disconnect/

Credits

• Arabic(Saudi Arabia) - Mohsen Qaysi
• Japanese translation - Onevcat
• Polish translation - Seb Kaczorowski
• Turkish - Ozancan Karataş
• Dutch (Netherlands) translation - Niels Peen

This product includes GeoLite2 data created by MaxMind, available from http://www.maxmind.com. The GeoLite2 databases are distributed under the Creative Commons Attribution-ShareAlike 3.0 Unported License. In order to query the database, I created a wrapper for libmaxminddb called MMDB-Swift.

License

This code is distributed under the terms and conditions of the MIT license.

Copyright (C) 2020 lexrus.com

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.