Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iphoting/ovpnmcgen.rb

An OpenVPN iOS Configuration Profile (.mobileconfig) Utility—Configures OpenVPN for use with VPN-on-Demand that are not exposed through Apple Configurator 2.
https://github.com/iphoting/ovpnmcgen.rb

ios mobileconfig openvpn openvpn-client openvpn-configuration ruby vpn

Last synced: 12 days ago
JSON representation

An OpenVPN iOS Configuration Profile (.mobileconfig) Utility—Configures OpenVPN for use with VPN-on-Demand that are not exposed through Apple Configurator 2.

Host: GitHub
URL: https://github.com/iphoting/ovpnmcgen.rb
Owner: iphoting
License: mit
Created: 2014-03-26T03:58:53.000Z (over 10 years ago)
Default Branch: develop
Last Pushed: 2020-09-11T06:32:19.000Z (about 4 years ago)
Last Synced: 2024-04-24T13:19:56.827Z (7 months ago)
Topics: ios, mobileconfig, openvpn, openvpn-client, openvpn-configuration, ruby, vpn
Language: Gherkin
Homepage: https://rubygems.org/gems/ovpnmcgen.rb
Size: 143 KB
Stars: 166
Watchers: 21
Forks: 28
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-network-stuff - **142**星 - on-Demand that are not exposed through Apple Configurator 2. (<a id="7cf7e8a30b73997985f20698eaf6b0c9"></a>OpenVPN / <a id="8ea8f890cf767c3801b5e7951fca3570"></a>公网访问局域网)

README

# Ovpnmcgen.rb

OpenVPN iOS Configuration Profile Utility

[![GitHub version](https://badge.fury.io/gh/iphoting%2Fovpnmcgen.rb.svg)](http://badge.fury.io/gh/iphoting%2Fovpnmcgen.rb)
[![Gem Version](https://badge.fury.io/rb/ovpnmcgen.rb.svg)](http://badge.fury.io/rb/ovpnmcgen.rb)
[![Build Status](https://travis-ci.org/iphoting/ovpnmcgen.rb.svg?branch=develop)](https://travis-ci.org/iphoting/ovpnmcgen.rb)

Generates iOS configuration profiles (.mobileconfig) that configures OpenVPN for use with VPN-on-Demand that are not accessible through the Apple Configurator or the iPhone Configuration Utility.

---

**OpenVPN Connect (iOS) v1.2.x**:
- Breaking changes: enable the `--v12compat` switch.
- Bug/workaround: enable the `--cert` & `--key` switches as necessary.

Refer to [known issues](#known-issues) below for more details.

---

Although there are many possible VPN-on-Demand (VoD) triggers, this utility currently only implements `SSIDMatch`, `InterfaceTypeMatch`, and optionally `URLStringProbe`. For 'high' (default) security level, the following algorithm is executed upon network changes, in order:

- If wireless SSID matches any specified with `--trusted-ssids`, tear down the VPN connection and do not reconnect on demand.
- Else if wireless SSID matches any specified with `--untrusted-ssids`, unconditionally bring up the VPN connection on the next network attempt.
- Else if the primary network interface becomes Wifi (any SSID except those above), unconditionally bring up the VPN connection on the next network attempt.
- Else if the primary network interface becomes Cellular, leave any existing VPN connection up, but do not reconnect on demand.
- Else, leave any existing VPN connection up, but do not reconnect on demand.

Note: The other match triggers, such as `DNSDomainMatch`, `DNSServerAddressMatch`, and per-connection domain inspection (`ActionParameters`), are not implemented. I reckon some kind of DSL will need to be built to support them; pull-requests are welcome.

## Installation

Install the production version from Rubygems.org:

$ gem install ovpnmcgen.rb

### Local Development

Clone the source:

$ git clone https://github.com/iphoting/ovpnmcgen.rb

Build and install the gem:

$ cd ovpnmcgen.rb/
$ bundle install # install dependencies
# Hack away...
$ rake install # build and install gem

## Usage

```
Usage: ovpnmcgen.rb generate [options]

Options:
-c, --config FILE Specify path to config file. [Default: .ovpnmcgen.rb.yml]
--cafile FILE Path to OpenVPN CA file. (Required)
--tafile FILE Path to TLS-Auth Key file.
--tlscryptfile FILE Path to TLS-Crypt Key file.
--cert FILE Path to Cert file.
--key FILE Path to Private Key file.
--host HOSTNAME Hostname of OpenVPN server. (Required)
--proto PROTO OpenVPN server protocol. [Default: udp]
-p, --port PORT OpenVPN server port. [Default: 1194]
--p12file FILE Path to user PKCS#12 file.
--p12pass PASSWORD Password to unlock PKCS#12 file.
--[no-]vod Enable or Disable VPN-On-Demand.
When Disabled, sets `vpn-on-demand: 0`, so that OpenVPN Connect can control this profile. [Default: Enabled]
--v12compat Enable OpenVPN Connect 1.2.x compatibility.
When Enabled, use updated `VPNSubType: net.openvpn.connect.app`
(changed since OpenVPN Connect 1.2.x). [Default: Disabled]
--security-level LEVEL Security level of VPN-On-Demand Behaviour: paranoid, high, medium. [Default: high]
--vpn-uuid UUID Override a VPN configuration payload UUID.
--vpn-name NAME Override a VPN configuration payload name displayed under
Settings.app > General > VPN.
--profile-uuid UUID Override a Profile UUID.
--cert-uuid UUID Override a Certificate payload UUID.
-t, --trusted-ssids SSIDS List of comma-separated trusted SSIDs.
-u, --untrusted-ssids SSIDS List of comma-separated untrusted SSIDs.
-d, --domains DOMAINS List of comma-separated domain names requiring VPN service.
--domain-probe-url PROBE An HTTP(S) URL to probe, using a GET request. If no HTTP response code is received from the server, a VPN connection is established in response.
--trusted-ssids-probe-url PROBE An HTTP(S) URL to probe, using a GET request. If no HTTP response code is received from the server, a VPN connection is established in response.
--url-probe URL This URL must return HTTP status 200, without redirection, before the VPN service will try establishing.
--remotes REMOTES List of comma-separated alternate remotes: " ".
--idle-timer TIME Disconnect from VPN when idle for a certain period of time (in seconds) scenarios. Requires disabling "Reconnect On Wakeup" on OpenVPN.app.
--ovpnconfigfile FILE Path to OpenVPN client config file.
-o, --output FILE Output to file. [Default: stdout]
```

### Configuration

Option flags can be set using environment variables or placed into a YAML formatted file. The default filename `.ovpnmcgen.rb.yml` will be searched for in `./`, and then `~/`.

Note: Only for YAML configuration files and environment variables, flags with hyphens (-) are replaced with underscores (_), i.e. `--trusted-ssids safe` should be `trusted_ssids: safe`.

Sample:

```
untrusted_ssids: [dangerous1, dangerous2]
trusted_ssids: [trust]
host: vpn.example.com
cafile: /etc/openvpn/ca.crt
tafile: /etc/openvpn/ta.key
url_probe: https://vpn.example.com/canVPN.php
```

### Security Levels

There are three different security levels to choose from, 'paranoid', 'high' (default), and 'medium'. The algorithm illustrated above is for 'high'.

For 'paranoid' security level, the following algorithm is executed upon network changes, in order:

- If wireless SSID matches any specified with `--trusted-ssids`, tear down the VPN connection and do not reconnect on demand.
- Else if wireless SSID matches any specified with `--untrusted-ssids`, unconditionally bring up the VPN connection on the next network attempt.
- Else if the primary network interface becomes Wifi (any SSID except those above), unconditionally bring up the VPN connection on the next network attempt.
- Else if the primary network interface becomes Cellular, unconditionally bring up the VPN connection on the next network attempt.
- Else, leave any existing VPN connection up, but do not reconnect on demand.

For 'medium' security level, the following algorithm is executed upon network changes, in order:

- If wireless SSID matches any specified with `--trusted-ssids`, tear down the VPN connection and do not reconnect on demand.
- Else if wireless SSID matches any specified with `--untrusted-ssids`, unconditionally bring up the VPN connection on the next network attempt.
- Else if the primary network interface becomes Wifi (any SSID except those above), leave any existing VPN connection up, but do not reconnect on demand.
- Else if the primary network interface becomes Cellular, leave any existing VPN connection up, but do not reconnect on demand.
- Else, leave any existing VPN connection up, but do not reconnect on demand.

### URL Probe

Apple provides a `URLStringProbe` test condition where a VPN connection will only be established, if and only if a specified URL is successfully fetched (returning a 200 HTTP status code) without redirection.

This feature can be enabled for statistical and maintenance-protection reasons. Otherwise, it can also workaround a circular limitation with unsecured wireless captive portals. See Known Issues below for further elaboration.

By enabling this option, you will need to reliably and quickly respond with HTTP status code 200 at the URL string supplied.

### Domain Matching
To require an iOS device to bring up the VPN when `example.com` is requested is not so easy, especially if it is has a publicly accessible DNS resolution.

Apple provides an `EvaluateConnection` and `ActionParameters` configuration options with the view that certain domains will have DNS resolution failures, and hence, require the VPN to be up. In most corporate cases with internal-facing hostnames, it works well. See the `--domains` option.

However, if there are certain sensitive public sites (or blocked sites) that you decide that a VPN should be brought up instead, you will need to additionally specify a `RequiredURLStringProbe` that returns a non-200 response. See the `--domain-probe-url` option.

## Examples

### Typical Usage
$ ovpnmcgen.rb gen --v12compat \
--trusted-ssids home \
--host vpn.example.com \
--cafile path/to/ca.pem \
--tafile path/to/ta.key \
--url-probe http://vpn.example.com/status \
--p12file path/to/john-ipad.p12 \
--p12pass p12passphrase \
john ipad

Output:

```

PayloadContent

PayloadDescription
Configures VPN settings, including authentication.
PayloadDisplayName
VPN (vpn.example.com/VoD)
PayloadIdentifier
com.example.vpn.john-ipad.vpnconfig
PayloadOrganization
vpn.example.com
PayloadType
com.apple.vpn.managed
PayloadUUID
...
PayloadVersion
1
UserDefinedName
vpn.example.com/VoD
VPN

AuthenticationMethod
Certificate
OnDemandEnabled
1
OnDemandRules

Action
Disconnect
SSIDMatch

home

URLStringProbe
http://vpn.example.com/status

Action
Connect
InterfaceTypeMatch
WiFi
URLStringProbe
http://vpn.example.com/status

Action
Ignore
InterfaceTypeMatch
Cellular
URLStringProbe
http://vpn.example.com/status

Action
Connect
URLStringProbe
http://vpn.example.com/status

PayloadCertificateUUID
...
RemoteAddress
DEFAULT

VPNSubType
net.openvpn.connect.app
VPNType
VPN
VendorConfig

ca
-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----
client
NOARGS
comp-lzo
NOARGS
dev
tun
key-direction
1
persist-key
NOARGS
persist-tun
NOARGS
proto
udp
remote
vpn.example.com 1194 udp
remote-cert-tls
server
resolv-retry
infinite
tls-auth
#\n# 2048 bit OpenVPN static key\n#\n-----BEGIN OpenVPN Static key V1-----\n...\n-----END OpenVPN Static key V1-----
verb
3

Password
p12passphrase
PayloadCertificateFileName
john-ipad.p12
PayloadContent

base64data

PayloadDescription
Provides device authentication (certificate or identity).
PayloadDisplayName
john-ipad.p12
PayloadIdentifier
com.example.vpn.john-ipad.credential
PayloadOrganization
vpn.example.com
PayloadType
com.apple.security.pkcs12
PayloadUUID
...
PayloadVersion
1

PayloadDescription
OpenVPN Configuration Payload for [email protected]
PayloadDisplayName
vpn.example.com OpenVPN iphoting@ipad
PayloadIdentifier
com.example.vpn.john-ipad
PayloadOrganization
vpn.example.com
PayloadRemovalDisallowed

PayloadType
Configuration
PayloadUUID
...
PayloadVersion
1

```

### Extended Usage
$ ovpnmcgen.rb gen --v12compat \
--trusted-ssids home,school \
--untrusted-ssids virusnet \
--host vpn.example.com \
--cafile path/to/ca.pem \
--tafile path/to/ta.key \
--url-probe http://vpn.example.com/status \
--p12file path/to/john-ipad.p12 \
--p12pass p12passphrase \
john ipad

Output similar to above:

```

PayloadContent

...
VPN

...
OnDemandRules

Action
Disconnect
SSIDMatch

home
school

Action
Connect
SSIDMatch

virusnet

URLStringProbe
http://vpn.example.com/status

Action
Connect
InterfaceTypeMatch
WiFi
URLStringProbe
http://vpn.example.com/status

Action
Ignore
InterfaceTypeMatch
Cellular
URLStringProbe
http://vpn.example.com/status

Action
Connect
URLStringProbe
http://vpn.example.com/status

...

...

...

...

```

### Using OpenSSL to convert files into PKCS#12 (.p12)
openssl pkcs12 -export -out path/to/john-ipad.p12 \
-inkey path/to/john-ipad.key -in path/to/john-ipad.crt \
-passout pass:p12passphrase -name [email protected]

### Using OpenSSL to convert from PKCS#12 (.p12) to Cert PEM file
openssl pkcs12 -in path/to/john-ipad.p12 -out path/to/john-ipad-cert.crt \
-nodes -nokeys

### Using OpenSSL to convert from PKCS#12 (.p12) to Key PEM file
openssl pkcs12 -in path/to/john-ipad.p12 -out path/to/john-ipad-key.pem \
-nodes -nocerts

## Known Issues

- OpenVPN Connect v1.2.5 breaking changes

*Diagnosis*: Certificates no longer found or VoD mobileconfig broken after OpenVPN Connect upgrade to v1.2.5.

The VPN switch in the Settings.app jumps rapidly from On to Off, status switches from Connecting... to Disconnected immediately. No logs produced within the OpernVPN Connect app log viewer.

This is caused by 1) a breaking change, where the `VPNSubType` has changed, and 2) a bug where the OpenVPN Connect is missing a keychain access entitlement from Apple.

*Solution + Workaround*: Enable the `--v12compat` switch to resolve (1), and use `--cert` and `--key` switches to workaround (2).

- "Not connected to Internet" error/behaviour when VPN should be established.

*Diagnosis*: Load any site in Safari. An error message "Safari cannot open the page because your iPhone is not connected to the Internet" will be presented.

There is a bug in the iOS/OS X network routing code that hangs the routing system, preventing the gateway or IP address from being set. This happens more frequently when the tunnel is brought up/down more frequently.

*Solution*: Upgrade to iOS 8.1. The new iOS update seems to have mostly solved issues surrounding the networking stack.

*Workaround*: Hard-restart iOS. Press and hold down both the home and sleep/wake buttons until iOS turns off and back on with the Apple boot up screen. Release when the Apple boot up screen appears.

- Weird Rapid Connecting…/Disconnected behaviour.

*Diagnosis*: VPN status in Settings.app rapid alternates between Connecting… and Disconnected.

Usually happens when the VoD component is stuck in an infinite loop. Not sure what triggers it.

*Solution*: Upgrade to iOS 8.1. The new iOS update seems to have mostly solved issues surrounding the networking stack.

*Workaround*: Hard-restart iOS. Press and hold down both the home and sleep/wake buttons until iOS turns off and back on with the Apple boot up screen. Release when the Apple boot up screen appears.

- Cannot load Captive Portals (Hotspots on unsecured Wireless networks).

Some unsecured hotspots require navigating certain webpages before full access to the internet is available. This requirement blocks VPN connections and iOS will also block captive portal access, waiting on the VPN connection. This circular dependency results in no internet access.

*Solution*: Implement `URLStringProbe` where, if and only if this URL is successfully fetched (returning a 200 HTTP status code) without redirection, will the VPN service be required, relied on, and brought up. Enable with the `--url-probe` flag.

*Workaround*: Manually disable VPN-on-Demand in Settings.app > VPN > Server (i) option screen. Reenable only after Internet access is available.

## TODO

- Config file to specify global options, such as `--cafile`, `--tafile`, `--host`, `--[un]trusted-ssids`.

See commit `#d9c015618` for feature.

- Batch-operation mode, with CSV-file as input, and a CSV UUID-index file to track generated profiles as output.

The same UUID should be used for profile updates, so that iOS knows which profile to replace, especially in MDM environments.

Custom UUID overrides now supported via `--{profile,vpn,cert}-uuid`.

- Adopt OpenVPN parameters from an OpenVPN-compatible client.conf input file.

Implemented, but does not support inline `` data enclosures, and command line flags (that are required) override config file values.

- Sign/Encrypt .mobileconfig.

Current workaround is to use a trusted MDM solution to securely push these unsigned, unencrypted profiles to iOS devices, through the encrypted MDM connected.

## References

- Apple, at .

## Contributing

1. Fork it ()
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 new Pull Request