skyscape-vpn 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a072a576f027e00aa7e7bf038869fea21d8d1db9
-  data.tar.gz: 44e3fb53bddf8988d1943f20e06d1f906a29e7b0
+  metadata.gz: 720bcec1ef57ecf8b0469df5d5ca8ffa165dc17f
+  data.tar.gz: 6cc1064bf36c23779dd4163a93bfad57bd49e9d6
 SHA512:
-  metadata.gz: 83c23fb510ec1d01e42825db7e5ff5c3fb8ecc1aed79dcd56287464eb12282f203fa1f4936d32fac4569b5fe9e4273eaadcb2aec6c4c10ee66e087ebc539135a
-  data.tar.gz: bb61d511315c1467cc06e76d27501c559d40843f10441557bac5d3d90a8b53c4f25738f12bb0d19b2b309314ac38a3e1eb1d4afd417657976254ee4a20702d88
+  metadata.gz: 396fad116c41556655d409130cde94edc9f8cc1d2af54f69d02df040f1340f565b6c770e47107761da61f2b76c75dd8b3cf1a657dc4bb09772cab1258d5e4bff
+  data.tar.gz: 926c0f5cbe2963086094748c0ce40801e00801c9272562897f245745210ec0ccae7d993a3b61930bcd19f11a5ef366af8a34a5cc45bd7303060db3711bdd3d8d

data/README.md

@@ -1,36 +1,149 @@
-# Skyscape::Vpn
+#Skyscape IPSec VPN Configuration Tool
+
+This command line tool allows Skyscape customers using vShield Edge firewalls to configure IPSec tunnels using a configuration file written in "YAML"
+For more information on YAML and it's syntax see: https://en.wikipedia.org/wiki/YAML
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/skyscape/vpn`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
-Add this line to your application's Gemfile:
+First ensure Ruby is installed on your machine. 
+
+To check you can run:
 
-```ruby
-gem 'skyscape-vpn'
+```batchfile
+>ruby -v
+ruby 2.0.0p247 (2013-06-27) [i386-mingw32]
 ```
 
-And then execute:
+The tool was built using Ruby 2.0.0p247 but other versions may work. 
 
-    $ bundle
+And then install the gem using:
+```batchfile
+>gem install skyscape-vpn
+```
 
-Or install it yourself as:
+## Usage
 
-    $ gem install skyscape-vpn
+Once installed the tool can be run by executing the following:
 
-## Usage
+```batchfile
+>skyscape-vpn apply <path to yaml file>
+```
+
+For example:
+
+```batchfile
+>skyscape-vpn apply c:\tmp\firewalls.yml
+```
+
+Or for Linux:
+
+```batchfile
+$ skyscape-vpn apply /tmp/firewalls.yml
+```
 
-TODO: Write usage instructions here
 
-## Development
+## Configuration File
+
+The configuration file uses YAML as a format and defines one or more vShield Edge Firewalls to be configured. 
+The file has the following syntax:
+
+```yaml
+Firewalls:
+  - Name: Firewall_1
+    Service:
+      IsEnabled: true
+    Creds:
+      User: xxx.xxxx.xxx
+      Password: xxxxxxxxxxxx
+      Org: x-x-xx-xxxx
+      Url: api.vcd.portal.skyscapecloud.com
+      Edge: nftxxxxxx-x
+    GatewayIpsecVpnService:
+      IsEnabled: true
+      Tunnel:
+      - Name: west-to-east
+        IpsecVpnLocalPeerId:
+        IpsecVpnLocalPeerName:
+        PeerIpAddress: 111.111.111.111
+        PeerId: 111.111.111.111
+        LocalIpAddress: 222.222.222.222
+        LocalId: 222.222.222.222
+        LocalSubnet:
+        - Name: DMZ
+          Gateway: 10.0.1.1
+          Netmask: 255.255.255.0
+        PeerSubnet:
+        - Name: DMZ
+          Gateway: 10.0.10.1
+          Netmask: 255.255.255.0
+        SharedSecret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+        EncryptionProtocol: AES256
+        Mtu: 1400
+        IsEnabled: true
+  - Name: Firewall_2
+    Creds:
+      User: xxx.xxxx.xxx
+      Password: xxxxxxxxxxxx
+      Org: x-x-xx-xxxx
+      Url: api.vcd.portal.skyscapecloud.com
+      Edge: nftxxxxxx-x    
+    GatewayIpsecVpnService:
+      IsEnabled: true
+      Tunnel:
+      - Name: east-to-west
+        IpsecVpnLocalPeerId:
+        IpsecVpnLocalPeerName:
+        PeerIpAddress: 222.222.222.222
+        PeerId: 222.222.222.222
+        LocalIpAddress: 111.111.111.111
+        LocalId: 111.111.111.111
+        PeerSubnet:
+        - Name: DMZ
+          Gateway: 10.0.1.1
+          Netmask: 255.255.255.0
+        LocalSubnet:
+        - Name: DMZ
+          Gateway: 10.0.10.1
+          Netmask: 255.255.255.0
+        SharedSecret: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
+        EncryptionProtocol: AES256
+        Mtu: 1400
+        IsEnabled: true
+```
+
+
+Note that a hyphen ( - ) in YAML represents an array item (an item which can appear one or more times). 
+Hopefully it is clear from the example file above the the file supports:
+ * One or more vShield firewalls per file
+ * One or more tunnels per vShield firewall
+ * One or more local subnet per tunnel
+ * One or more peer subnet per tunnel
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+**PeerIpAddress** & **PeerId** should be set to the public IP address of the remote vShield Firewall  
+**LocalIpAddress** & **LocalId** should be set to the public IP address of the local vShield Firewall
+
+
+The file can be created in any text editor (notepad etc) and is usually saved with a ".yml" file extension although this is not required by the tool.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/skyscape-vpn.
+Bug reports and pull requests are welcome on GitHub at https://github.com/skyscape-cloud-services/skyscape-vpn.
+Please ensure that the tests run successfully before creating a PR and consider increasing the coverage if adding new features.
+
+The project has unit tests using Rspec which can be run using:
+
+```batchfile
+>bundle exec rspec
+```
+
+The CLI tests are written using Cucumber & Aruba and can be run using:
+
+```batchfile
+>bundle exec cucumber
+```
+
+Note: Cucumber tests do not appear to work on Windows
 

data/Rakefile

@@ -1,13 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require 'cucumber'
-require 'cucumber/rake/task'
-
-RSpec::Core::RakeTask.new(:spec)
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format pretty"
-end
-
-task :default => :spec
-task :test => :spec
-task :test => :features
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'cucumber'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+task :default => :spec
+task :test => :spec
+task :test => :features

data/bin/skyscape-vpn

@@ -1,4 +1,4 @@
-#!/usr/bin/env ruby 
-$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
-require 'cli'
-Skyscape::Vcloud::Ipsec::Cli.start(ARGV)
+#!/usr/bin/env ruby 
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'cli'
+Skyscape::Vcloud::Ipsec::Cli.start(ARGV)

data/lib/cli.rb

@@ -1,28 +1,28 @@
-require 'thor'
-require 'main'
-require 'version'
-
-module Skyscape
-  module Vcloud
-    module Ipsec
-      class Cli < Thor
-	desc "version", "Print skyscape-vpn version" 
-
-
-        def version
-          puts Skyscape::Vcloud::Ipsec::VERSION
-        end
-
-
-        desc "apply <location>", "Begin configuration of IPSec tunnels"
-        def apply(path)
-          begin
-            Skyscape::Vcloud::Ipsec::Main.new(path)
-          rescue Exception => e
-            puts e.message
-          end
-        end
-      end
-    end
-  end
-end
+require 'thor'
+require 'main'
+require 'version'
+
+module Skyscape
+  module Vcloud
+    module Ipsec
+      class Cli < Thor
+	desc "version", "Print skyscape-vpn version" 
+
+
+        def version
+          puts Skyscape::Vcloud::Ipsec::VERSION
+        end
+
+
+        desc "apply <location>", "Begin configuration of IPSec tunnels"
+        def apply(path)
+          begin
+            Skyscape::Vcloud::Ipsec::Main.new(path)
+          rescue Exception => e
+            puts e.message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/configuration.rb

@@ -1,40 +1,51 @@
-require 'yaml'
-require 'active_support/hash_with_indifferent_access'
-
-
-module Skyscape
-  module Vcloud
-    module Ipsec
-      class Configuration
-        attr_accessor :file_location, :full_config, :firewalls
-        def initialize(file_location = "#{Dir.pwd}/firewalls.yml")
-          @file_location = file_location
-          raise("Configuration File Not Found At #{file_location}") unless File.exists?(file_location)
-          
-          @full_config = load_yaml
-          @firewalls = parse_config
-        end
-        
-        def load_yaml
-          file = File.open(@file_location)
-          conf = YAML.load(file)
-          file.close
-          
-          conf.deep_symbolize_keys! unless conf == false
-        end
-        
-        def parse_config
-          raise("No firewalls In Config File: #{@file_location}") unless @full_config.is_a?(Hash) && @full_config[:Firewalls]
-          raise("No firewalls In Config File: #{@file_location}") unless @full_config[:Firewalls].is_a?(Array) && @full_config[:Firewalls].length > 0
-          #To Do: Add Config Schema?  
-          @full_config[:Firewalls]
-          
-          
-        end
-        
-       
-        
-      end
-    end
-  end
+require 'yaml'
+
+module Skyscape
+  module Vcloud
+    module Ipsec
+      class Configuration
+        attr_accessor :file_location, :full_config, :firewalls
+        def initialize(file_location = "#{Dir.pwd}/firewalls.yml")
+          @file_location = file_location
+          raise("Configuration File Not Found At #{file_location}") unless File.exists?(file_location)
+          
+          @full_config = load_yaml
+          @firewalls = parse_config
+        end
+        
+        def load_yaml
+          file = File.open(@file_location)
+          conf = YAML.load(file)
+          file.close
+          
+          symbolize(conf) unless conf == false
+        end
+        
+        def parse_config
+          raise("No firewalls In Config File: #{@file_location}") unless @full_config.is_a?(Hash) && @full_config[:Firewalls]
+          raise("No firewalls In Config File: #{@file_location}") unless @full_config[:Firewalls].is_a?(Array) && @full_config[:Firewalls].length > 0
+          #To Do: Add Config Schema?  
+          @full_config[:Firewalls]
+          
+          
+        end
+        
+        private
+
+        def symbolize(obj)
+          return obj.reduce({}) do |memo, (k, v)|
+            memo.tap { |m| m[k.to_sym] = symbolize(v) }
+          end if obj.is_a? Hash
+    
+          return obj.reduce([]) do |memo, v| 
+            memo << symbolize(v); memo
+          end if obj.is_a? Array
+  
+          obj
+        end
+       
+        
+      end
+    end
+  end
 end

data/lib/main.rb

@@ -1,83 +1,83 @@
-require 'fog'
-require 'configuration'
-
-
-module Skyscape
-  module Vcloud
-    module Ipsec
-      class Main
-        attr_accessor :config
-        def initialize(config_file)
-          @config = Skyscape::Vcloud::Ipsec::Configuration.new(config_file)
-          configure_firewalls(@config.firewalls)
-        
-        end
-        
-        def configure_firewalls(firewalls)
-          firewalls.each do |firewall| 
-            configure_firewall(firewall)
-          end
-        end
-        
-        def configure_firewall(firewall)
-          creds = firewall[:Creds]
-          connection = vcloud_login(creds)
-          edge_id = get_edge_href(creds[:Edge],connection).split('/').last
-          
-          puts "Configuring VPN Service For Firewall: #{creds[:Edge]}"
-          task = connection.post_configure_edge_gateway_services(edge_id,firewall).body
-          monitor_task(task[:href].split('/').last,connection)
-          puts "Finished Configuring VPN Service For Firewall: #{creds[:Edge]}"
-          
-          #TO DO: SUPPORT MERGING CONFIG WITH EXISTING
-          #current_config = get_current_config(edge_href,connection)
-          #new_config = merge_configs(current_config, new_config)
-          
-        end
-        
-        def vcloud_login(creds)
-          puts "Connecting to vCloud Director API"
-          connection = Fog::Compute::VcloudDirector.new(
-            :vcloud_director_username => "#{creds[:User]}@#{creds[:Org]}",
-            :vcloud_director_password => creds[:Password],
-            :vcloud_director_host => creds[:Url],
-            :vcloud_director_show_progress => true, # task progress bar on/off
-            :connection_options => {
-              :omit_default_port => true
-              }
-            )
-          puts "Connected to vCloud Director API"
-            
-          connection
-        end
-        
-        def get_edge_href(edge_name, connection)
-          puts "Getting vShield Edge HREF From Query"
-          results = connection.get_execute_query(type="edgeGateway", :filter => "name==#{edge_name}").body
-          
-          raise "Edge #{edge_name} Not Found!" unless results[:total] == "1"
-          raise "Edge Name #{edge_name} Not Unique!" if results[:total].to_i > 1
-          puts "Finished Getting vShield Edge HREF From Query"
-          result = results[:EdgeGatewayRecord][:href]
-        end
-        
-        def get_current_config(edge_href,connection)
-          configuration = connection.get_edge_gateway(edge_href.split('/').last).body
-          
-          vpn_service =  configuration[:Configuration][:EdgeGatewayServiceConfiguration][:GatewayIpsecVpnService]
-        end
-        
-        def monitor_task(task_id,connection)
-          task = connection.get_task(task_id).body
-          while(task[:status] == "running") do
-            puts "  Task: #{task[:operation]} Still Running"
-            task = connection.get_task(task_id).body
-            sleep(3)
-          end
-          
-          puts "  Task: #{task[:operation]} Completed With Status: #{task[:status]}"
-        end
-      end
-    end
-  end
-end
+require 'fog'
+require 'configuration'
+
+
+module Skyscape
+  module Vcloud
+    module Ipsec
+      class Main
+        attr_accessor :config
+        def initialize(config_file)
+          @config = Skyscape::Vcloud::Ipsec::Configuration.new(config_file)
+          configure_firewalls(@config.firewalls)
+        
+        end
+        
+        def configure_firewalls(firewalls)
+          firewalls.each do |firewall| 
+            configure_firewall(firewall)
+          end
+        end
+        
+        def configure_firewall(firewall)
+          creds = firewall[:Creds]
+          connection = vcloud_login(creds)
+          edge_id = get_edge_href(creds[:Edge],connection).split('/').last
+          
+          puts "Configuring VPN Service For Firewall: #{creds[:Edge]}"
+          task = connection.post_configure_edge_gateway_services(edge_id,firewall).body
+          monitor_task(task[:href].split('/').last,connection)
+          puts "Finished Configuring VPN Service For Firewall: #{creds[:Edge]}"
+          
+          #TO DO: SUPPORT MERGING CONFIG WITH EXISTING
+          #current_config = get_current_config(edge_href,connection)
+          #new_config = merge_configs(current_config, new_config)
+          
+        end
+        
+        def vcloud_login(creds)
+          puts "Connecting to vCloud Director API"
+          connection = Fog::Compute::VcloudDirector.new(
+            :vcloud_director_username => "#{creds[:User]}@#{creds[:Org]}",
+            :vcloud_director_password => creds[:Password],
+            :vcloud_director_host => creds[:Url],
+            :vcloud_director_show_progress => true, # task progress bar on/off
+            :connection_options => {
+              :omit_default_port => true
+              }
+            )
+          puts "Connected to vCloud Director API"
+            
+          connection
+        end
+        
+        def get_edge_href(edge_name, connection)
+          puts "Getting vShield Edge HREF From Query"
+          results = connection.get_execute_query(type="edgeGateway", :filter => "name==#{edge_name}").body
+          
+          raise "Edge #{edge_name} Not Found!" unless results[:total] == "1"
+          raise "Edge Name #{edge_name} Not Unique!" if results[:total].to_i > 1
+          puts "Finished Getting vShield Edge HREF From Query"
+          result = results[:EdgeGatewayRecord][:href]
+        end
+        
+        def get_current_config(edge_href,connection)
+          configuration = connection.get_edge_gateway(edge_href.split('/').last).body
+          
+          vpn_service =  configuration[:Configuration][:EdgeGatewayServiceConfiguration][:GatewayIpsecVpnService]
+        end
+        
+        def monitor_task(task_id,connection)
+          task = connection.get_task(task_id).body
+          while(task[:status] == "running") do
+            puts "  Task: #{task[:operation]} Still Running"
+            task = connection.get_task(task_id).body
+            sleep(3)
+          end
+          
+          puts "  Task: #{task[:operation]} Completed With Status: #{task[:status]}"
+        end
+      end
+    end
+  end
+end

data/lib/version.rb

@@ -1,7 +1,7 @@
-module Skyscape
-  module Vcloud
-    module Ipsec
-      VERSION = "0.0.5"
-    end
-  end
-end
+module Skyscape
+  module Vcloud
+    module Ipsec
+      VERSION = "0.0.6"
+    end
+  end
+end

data/skyscape-vpn.gemspec

@@ -1,36 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "skyscape-vpn"
-  spec.version       = Skyscape::Vcloud::Ipsec::VERSION
-  spec.authors       = ["Tim Lawrence"]
-  spec.email         = ["tlawrence@skyscapecloud.com"]
-
-  spec.summary       = %q{Configure vCloud Director IPSec VPNs}
-  spec.homepage      = "https://github.com/skyscape-cloud-services"
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "aruba"
-  
-  spec.add_runtime_dependency 'fog', '>=1.26.0'
-  spec.add_runtime_dependency 'activesupport'
-  spec.add_runtime_dependency 'thor'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "skyscape-vpn"
+  spec.version       = Skyscape::Vcloud::Ipsec::VERSION
+  spec.authors       = ["Tim Lawrence"]
+  spec.email         = ["tlawrence@skyscapecloud.com"]
+
+  spec.summary       = %q{Configure vCloud Director IPSec VPNs}
+  spec.homepage      = "https://github.com/skyscape-cloud-services"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "aruba"
+  
+  spec.add_runtime_dependency 'fog', '>=1.26.0'
+  spec.add_runtime_dependency 'thor'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyscape-vpn
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Tim Lawrence
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.26.0
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -148,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Configure vCloud Director IPSec VPNs
 test_files: []
-has_rdoc: