ovpnmcgen.rb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c5cb5752cb5bbfd9b9db08e87949e0807c250c3
+  data.tar.gz: 349c51df8ade0b4d5aea93276068dd491c379c67
+SHA512:
+  metadata.gz: c37390ffe65b3b17a535aa0a434663e63fba3a8d8f2415e7e130dbb78acef5d6d98bf091d17ccfc9ef22ab33fb54801d8e552deb4745f91650a5976de328e67c
+  data.tar.gz: a7b2706e22de7978969a5327278978d869e7a5eb649f6c5b9e2c97c945a13723637c1e5a09f2dca2c1cfa426f284690a06b5bd75b4577ad8bf5d1c104401b4fd

data/.gitignore

@@ -0,0 +1,18 @@
+DS_Store
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+ovpnmcgen

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ovpnmcgen.rb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ronald Ip
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,30 @@
+# Ovpnmcgen.rb
+
+OpenVPN iOS Configuration Profile Utility
+
+This utility generates configuration profiles that enables VPN-on-Demand, as documented by Apple in <https://developer.apple.com/library/ios/featuredarticles/iPhoneConfigurationProfileRef/Introduction/Introduction.html#//apple_ref/doc/uid/TP40010206-CH1-SW27>.
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install ovpnmcgen.rb
+
+## Usage
+
+### Typical Usage
+	$ ovpnmcgen.rb gen --trusted-ssids home --host vpn.example.com --cafile path/to/ca.pem --tafile path/to/ta.key --p12file path/to/john-ipad.p12 --p12pass p12passphrase john ipad
+
+### Extended Usage
+	$ ovpnmcgen.rb gen --trusted-ssids home,school --untrusted-ssids virusnet --host vpn.example.com --cafile path/to/ca.pem --tafile path/to/ta.key --p12file path/to/john-ipad.p12 --p12pass p12passphrase john ipad
+
+### Using OpenSSL to generate a PKCS#12 file
+	openssl pkcs12 -export -out path/to/john-ipad.p12 -inkey path/to/john-ipad.key -in path/to/john-ipad.crt -passout pass:p12passphrase
+
+## Contributing
+
+1. Fork it (<http://github.com/iphoting/ovpnmcgen.rb/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/ovpnmcgen.rb

@@ -0,0 +1,64 @@
+#!/usr/bin/env ruby
+
+require 'ovpnmcgen'
+require 'commander/import'
+
+program :version, Ovpnmcgen::VERSION
+program :description, Ovpnmcgen::SUMMARY
+program :help, 'Usage', 'ovpnmcgen.rb <command> [options] <args...>'
+program :help_formatter, :compact
+default_command :help
+never_trace!
+#global_option '-c', '--config FILE', 'Specify path to config file' #not implemented yet
+ 
+command :generate do |c|
+  c.syntax = 'ovpnmcgen.rb generate [options] <user> <device>'
+  c.summary = 'Generates iOS Configuration Profiles'
+  c.description = 'Generates a .mobileconfig plist.'
+  c.example 'Typical Usage', 'ovpnmcgen.rb gen --trusted-ssids home --host vpn.example.com --cafile path/to/ca.pem --tafile path/to/ta.key --p12file path/to/john-ipad.p12 --p12pass p12passphrase john ipad'
+  c.example 'Extended Usage', 'ovpnmcgen.rb gen --trusted-ssids home,school --untrusted-ssids virusnet --host vpn.example.com --cafile path/to/ca.pem --tafile path/to/ta.key --p12file path/to/john-ipad.p12 --p12pass p12passphrase john ipad'
+  c.example 'Creating a .p12 file using OpenSSL', 'openssl pkcs12 -export -out path/to/john-ipad.p12 -inkey path/to/john-ipad.key -in path/to/john-ipad.crt -passout pass:p12passphrase'
+  c.option '--cafile FILE', 'Path to OpenVPN CA file. (Required)'
+  c.option '--tafile FILE', 'Path to TLS Key file. (Required)'
+  c.option '--host HOSTNAME', 'Hostname of OpenVPN server. (Required)'
+  c.option '--p12file FILE', 'Path to user PKCS#12 file. (Required)'
+  c.option '--p12pass PASSWORD', 'Password to unlock PKCS#12 file.'
+  c.option '--[no-]vod', 'Enable or Disable VPN-On-Demand. [Default: Enabled]'
+  c.option '--trusted-ssids SSIDS', Array, 'List of comma-separated trusted SSIDs.'
+  c.option '--untrusted-ssids SSIDS', Array, 'List of comma-separated untrusted SSIDs.'
+  c.option '-o', '--output FILE', 'Output to file. [Default: stdout]'
+  c.action do |args, options|
+  	raise ArgumentError.new "Invalid arguments. Run #{File.basename(__FILE__)} help for guidance." if args.nil? or args.length < 2
+  	raise ArgumentError.new "Host is required." unless options.host
+  	raise ArgumentError.new "cafile is required." unless options.cafile
+  	raise ArgumentError.new "tafile is required." unless options.tafile
+    raise ArgumentError.new "PKCS#12 file is required." unless options.p12file
+  	options.default :vod => true
+  	user, device, p12file, p12pass = args
+  	inputs = {
+  		:user => user,
+  		:device => device,
+  		:p12file => options.p12file,
+  		:p12pass => options.p12pass,
+  		:cafile => options.cafile,
+  		:tafile => options.tafile,
+  		:host => options.host,
+  		:enableVOD => options.vod,
+  		:trusted_ssids => options.trusted_ssids,
+  		:untrusted_ssids => options.untrusted_ssids
+  	}
+  	unless options.output
+    	puts Ovpnmcgen.generate(inputs)
+    else
+    	# write to file
+      begin
+        File.write(options.output, Ovpnmcgen.generate(inputs))
+      rescue Errno::ENOENT
+        puts "Error writing to: #{options.output}"
+      end
+    end
+  end
+end
+
+alias_command :g, :generate
+alias_command :gen, :generate

data/lib/ovpnmcgen.rb

@@ -0,0 +1,133 @@
+require "ovpnmcgen/version"
+require 'plist'
+require 'base64'
+
+module Ovpnmcgen
+  class StringData < String
+    def to_plist_node
+      return "<data>\n#{self}\n</data>"
+    end
+  end
+
+  def generate(inputs = {})
+    identifier = inputs[:identifier] || inputs[:host].split('.').reverse!.join('.')
+    port = inputs[:port] || 1194
+    certUUID = inputs[:certUUID] || `uuidgen`.chomp.upcase
+    user, device, domain, host = inputs[:user], inputs[:device], inputs[:host], inputs[:host]
+    enableVOD = inputs[:enableVOD]
+    p12pass = inputs[:p12pass] || ''
+    trusted_ssids = inputs[:trusted_ssids] || false
+    untrusted_ssids = inputs[:untrusted_ssids] || false
+
+    begin
+      ca_cert = File.readlines(inputs[:cafile]).map { |x| x.chomp }.join('\n')
+    rescue Errno::ENOENT
+      puts "CA file not found: #{inputs[:cafile]}!"
+      exit
+    end
+
+    begin
+      tls_auth = File.readlines(inputs[:tafile]).map { |x| x.chomp }.join('\n')
+    rescue Errno::ENOENT
+      puts "TLS file not found: #{inputs[:tafile]}!"
+      exit
+    end
+
+    begin
+      p12file = Base64.encode64(File.read(inputs[:p12file]))
+    rescue Errno::ENOENT
+      puts "PCKS#12 file not found: #{inputs[:p12file]}!"
+      exit
+    end
+
+    vpnOnDemandRules = Array.new
+    vodTrusted = { # Trust only Wifi SSID
+      'SSIDMatch' => trusted_ssids,
+      'Action' => 'Disconnect'
+    }
+    vodUntrusted = { # Untrust Wifi
+      'SSIDMatch' => untrusted_ssids,
+      'Action' => 'Connect'
+    }
+    vpnOnDemandRules << vodTrusted if trusted_ssids
+    vpnOnDemandRules << vodUntrusted if untrusted_ssids
+
+    vpnOnDemandRules << { # Untrust all Wifi
+      'InterfaceTypeMatch' => 'WiFi',
+      'Action' => 'Connect'
+    } << { # Trust Cellular
+      'InterfaceTypeMatch' => 'Cellular',
+      'Action' => 'Ignore'
+    } << { # Default catch-all
+      'Action' => 'Connect'
+    }
+
+    cert = {
+      'Password' => p12pass,
+      'PayloadCertificateFileName' => "#{user}-#{device}.p12",
+      'PayloadContent' => StringData.new(p12file),
+      'PayloadDescription' => 'Provides device authentication (certificate or identity).',
+      'PayloadDisplayName' => "#{user}-#{device}.p12",
+      'PayloadIdentifier' => "#{identifier}.#{user}-#{device}.credential",
+      'PayloadOrganization' => domain,
+      'PayloadType' => 'com.apple.security.pkcs12',
+      'PayloadUUID' => certUUID,
+      'PayloadVersion' => 1
+    }
+
+    vpn = {
+      'PayloadDescription' => "Configures VPN settings, including authentication.",
+      'PayloadDisplayName' => "VPN (#{host}/VoD)",
+      'PayloadIdentifier' => "#{identifier}.#{user}-#{device}.vpnconfig",
+      'PayloadOrganization' => domain,
+      'PayloadType' => 'com.apple.vpn.managed',
+      'PayloadUUID' => `uuidgen`.chomp.upcase,
+      'PayloadVersion' => 1,
+      'UserDefinedName' => "#{host}/VoD",
+      'VPN' => {
+        'AuthenticationMethod' => 'Certificate',
+        'OnDemandEnabled' => (enableVOD)? 1 : 0,
+        'OnDemandRules' => vpnOnDemandRules,
+        'PayloadCertificateUUID' => certUUID,
+        'RemoteAddress' => 'DEFAULT'
+      },
+      'VPNSubType' => 'net.openvpn.OpenVPN-Connect.vpnplugin',
+      'VPNType' => 'VPN',
+      'VendorConfig' => {
+        'ca' => ca_cert,
+        'client' => 'NOARGS',
+        'comp-lzo' => 'NOARGS',
+        'dev' => 'tun',
+        'key-direction' => '1',
+        'persist-key' => 'NOARGS',
+        'persist-tun' => 'NOARGS',
+        'proto' => 'udp',
+        'remote' => "#{host} #{port} udp",
+        'remote-cert-tls' => 'server',
+        'resolv-retry' => 'infinite',
+        'tls-auth' => tls_auth,
+        'verb' => '3'
+      }
+    }
+
+    plistPayloadContent = [vpn, cert] # to encrypt this array
+    #encPlistPayloadContent = cmsEncrypt([vpn, cert].to_plist).der_format
+
+    plist = {
+      'PayloadDescription' => "OpenVPN Configuration Payload for #{user}-#{device}@#{host}",
+      'PayloadDisplayName' => "#{host} OpenVPN #{user}@#{device}",
+      'PayloadIdentifier' => "#{identifier}.#{user}-#{device}",
+      'PayloadOrganization' => domain,
+      'PayloadRemovalDisallowed' => false,
+      'PayloadType' => 'Configuration',
+      'PayloadUUID' => `uuidgen`.chomp.upcase,
+      'PayloadVersion' => 1,
+      #'EncryptedPayloadContent' => StringData.new(encPlistPayloadContent)
+      'PayloadContent' => plistPayloadContent
+    }
+
+    return plist.to_plist
+  end
+
+  module_function :generate
+end

data/lib/ovpnmcgen/version.rb

@@ -0,0 +1,4 @@
+module Ovpnmcgen
+  VERSION = "0.0.1"
+  SUMMARY = "OpenVPN iOS Configuration Profile Utility"
+end

data/ovpnmcgen.rb.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ovpnmcgen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ovpnmcgen.rb"
+  spec.version       = Ovpnmcgen::VERSION
+  spec.authors       = ["Ronald Ip"]
+  spec.email         = ["myself@iphoting.com"]
+  spec.summary       = Ovpnmcgen::SUMMARY
+  spec.description   = "This utility generates configuration profiles that enables VPN-on-Demand, as documented by Apple in https://developer.apple.com/library/ios/featuredarticles/iPhoneConfigurationProfileRef/Introduction/Introduction.html#//apple_ref/doc/uid/TP40010206-CH1-SW27"
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.bindir = 'bin'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_runtime_dependency     "plist"
+  spec.add_runtime_dependency     "commander", "~> 4.1"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: ovpnmcgen.rb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ronald Ip
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: plist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: This utility generates configuration profiles that enables VPN-on-Demand,
+  as documented by Apple in https://developer.apple.com/library/ios/featuredarticles/iPhoneConfigurationProfileRef/Introduction/Introduction.html#//apple_ref/doc/uid/TP40010206-CH1-SW27
+email:
+- myself@iphoting.com
+executables:
+- ovpnmcgen.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ovpnmcgen.rb
+- lib/ovpnmcgen.rb
+- lib/ovpnmcgen/version.rb
+- ovpnmcgen.rb.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: OpenVPN iOS Configuration Profile Utility
+test_files: []