Skip to content

matiaskorhonen/vpn-config

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
exe
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

VPN Config

Build Status Gem Version Code Climate Test Coverage

Generate iOS/OS X configuration profiles for VPNs.

Only L2TP Private Internet Access VPNs are supported out of the box at the moment, but it's possible to provide your own data file (pull requests are also welcome, if you want to add support for your VPN provider).

Installation

A working Ruby is required (preferably Ruby 2.2.0 or above).

Install it in the usual manner:

gem install vpn-config

Usage

To get basic help, run: vpn-config help

For information on a specific command: vpn-config help COMMAND

Generate a signed configuration file

To generate a configuration file for the default VPN Provider (Private Internet Access), run:

vpn-config generate test.mobileconfig --username=foo --password=bar

To sign the configuration file, also give the --sign argument:

vpn-config generate test.mobileconfig --username=foo --password=bar --sign

To select specific endpoints, use the --endpoints option:

vpn-config generate test.mobileconfig --username=foo --password=bar --sign  \
--endpoints "US East" "Canada" "Hong Kong"

To sign with your own certificate, simply provide the path and passphrase (the certificate must be a PKCS12 file):

vpn-config generate test.mobileconfig --username=foo --password=bar --sign \
--certificate-path my.p12 --certificate-pass SuperSecret

Supply your own data file

If you wish, you can use your own VPN list instead of the built-in list:

vpn-config generate test.mobileconfig --username=foo --password=bar --sign \
--data-file mydata.yml --provider "My Provider"

Use the data/providers.yml file as an example of how to format your list.

Private Internet Access L2TP credentials

Don't try to use your PIA account credentials to log in to PIA VPNs. Instead you will find a separate set of credentials on the Client Control Panel:

PPTP/L2TP/SOCKS Username and Password

Generate the credentials if you haven't already…

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Unit tests

Run the Minitest/Minispec tests with: rake test

Contributing

  1. Fork it ( https://github.com/matiaskorhonen/vpn-config/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Copyright & License

Licensed under the MIT License. See the LICENSE.txt file for details.

Copyright (c) 2015 Matias Korhonen