knife-cisco_asa 0.1.4 → 0.2.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.0
+
+* Backend class refactoring
+
 ## v0.1.4
 
 * Bumped version only.

data/README.md

@@ -2,6 +2,10 @@
 
 A knife plugin for managing Cisco ASA devices.
 
+[![Gem Version](https://badge.fury.io/rb/knife-cisco_asa.png)](http://badge.fury.io/rb/knife-cisco_asa)
+ 
+[![Code Climate](https://codeclimate.com/github/bflad/knife-cisco_asa.png)](https://codeclimate.com/github/bflad/knife-cisco_asa)
+
 ## Installation
 
 Uses [cisco rubygem](https://github.com/jtimberman/ruby-cisco) for the backend.

data/lib/chef/knife/cisco_asa_base.rb

@@ -0,0 +1,109 @@
+#
+# Author:: Brian Flad (<bflad417@gmail.com>)
+# License:: Apache License, Version 2.0
+#
+
+require 'chef/knife'
+require 'cisco'
+require 'highline/import'
+
+class Chef
+  class Knife
+    module CiscoAsaBase
+
+      def self.included(includer)
+        includer.class_eval do
+
+          deps do
+            require 'readline'
+            require 'chef/json_compat'
+          end
+
+          unless defined? $default
+            $default = Hash.new
+          end
+
+          option :cisco_asa_enable_password,
+            :short => "-E PASSWORD",
+            :long => "--cisco-asa-enable-password PASSWORD",
+            :description => "Enable password for Cisco ASA"
+
+          option :cisco_asa_hostname,
+            :short => "-h HOSTNAME",
+            :long => "--cisco-asa-hostname HOSTNAME",
+            :description => "The hostname for Cisco ASA"
+
+          option :cisco_asa_password,
+            :short => "-p PASSWORD",
+            :long => "--cisco-asa-password PASSWORD",
+            :description => "The password for Cisco ASA"
+
+          option :cisco_asa_username,
+            :short => "-u USERNAME",
+            :long => "--cisco-asa-username USERNAME",
+            :description => "The username for Cisco ASA"
+          $default[:cisco_asa_username] = ENV['USER']
+
+          option :noop,
+            :long => "--noop",
+            :description => "Perform no modifying operations",
+            :boolean => false
+        end
+      end
+
+      def get_config(key)
+        key = key.to_sym
+        rval = config[key] || Chef::Config[:knife][key] || $default[key]
+        Chef::Log.debug("value for config item #{key}: #{rval}")
+        rval
+      end
+
+      def get_cisco_asa_config
+        config[:cisco_asa_password] = ask("Cisco Password for #{get_config(:cisco_asa_username)}: ") { |q| q.echo = "*" } unless get_config(:cisco_asa_password)
+        config[:cisco_asa_enable_password] = ask("Enable Password for #{get_config(:cisco_asa_hostname)}: ") { |q| q.echo = "*" } unless get_config(:cisco_asa_enable_password)
+      end
+
+      def run_config_commands(commands)
+        asa = Cisco::Base.new(:host => get_config(:cisco_asa_hostname), :user => get_config(:cisco_asa_username), :password => get_config(:cisco_asa_password), :transport => :ssh)
+        asa.enable(get_config(:cisco_asa_enable_password))
+        asa.cmd("conf t")
+        commands.each do |command|
+          asa.cmd(command)
+        end
+        asa.cmd("end")
+        asa.cmd("write mem")
+        unless get_config(:noop)
+          output = asa.run
+          output.each do |line|
+            Chef::Log.debug(line)
+          end
+        end
+        output
+      end
+
+      def tcp_test_port(hostname,port)
+        tcp_socket = TCPSocket.new(hostname, port)
+        readable = IO.select([tcp_socket], nil, nil, 5)
+        if readable
+          Chef::Log.debug("sshd accepting connections on #{hostname}, banner is #{tcp_socket.gets}") if port == 22
+          true
+        else
+          false
+        end
+        rescue Errno::ETIMEDOUT
+          false
+        rescue Errno::EPERM
+          false
+        rescue Errno::ECONNREFUSED
+          sleep 2
+          false
+        rescue Errno::EHOSTUNREACH, Errno::ENETUNREACH
+          sleep 2
+          false
+        ensure
+          tcp_socket && tcp_socket.close
+      end
+      
+    end
+  end
+end

data/lib/chef/knife/cisco_asa_host_add.rb

@@ -3,98 +3,100 @@
 # License:: Apache License, Version 2.0
 #
 
-module CiscoAsaKnifePlugin
+require 'chef/knife/cisco_asa_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class CiscoAsaHostAdd < Knife
 
-  class CiscoAsaHostAdd < BaseCiscoAsaCommand
+      include Knife::CiscoAsaBase
 
-    banner "knife cisco asa host add NAME IP (options)"
-    category "cisco asa"
+      banner "knife cisco asa host add NAME IP (options)"
+      category "cisco asa"
 
-    get_common_options
+      option :description, 
+        :long => "--description DESCRIPTION",
+        :description => "Description of host"
 
-    option :description, 
-      :long => "--description DESCRIPTION",
-      :description => "Description of host"
-
-    option :groups, 
-      :long => "--groups GROUP1[,GROUP2]",
-      :description => "Groups for host"
-    
-    option :nat,
-      :long => "--nat IP",
-      :description => "NAT IP"
-
-    option :nat_dns,
-      :long => "--nat-dns",
-      :description => "Enable NAT DNS translation",
-      :boolean => false
-
-    def run
+      option :groups, 
+        :long => "--groups GROUP1[,GROUP2]",
+        :description => "Groups for host"
       
-      hostname = name_args.first
+      option :nat,
+        :long => "--nat IP",
+        :description => "NAT IP"
+
+      option :nat_dns,
+        :long => "--nat-dns",
+        :description => "Enable NAT DNS translation",
+        :boolean => false
+
+      def run
+        $stdout.sync = true
+        
+        hostname = name_args.first
+
+        if hostname.nil?
+          ui.fatal "You need a host name!"
+          show_usage
+          exit 1
+        end
 
-      if hostname.nil?
-        ui.fatal "You need a host name!"
-        show_usage
-        exit 1
-      end
+        ip = name_args[1]
 
-      ip = name_args[1]
+        if ip.nil?
+          ui.fatal "You need an IP!"
+          show_usage
+          exit 1
+        end
 
-      if ip.nil?
-        ui.fatal "You need an IP!"
-        show_usage
-        exit 1
-      end
+        args = name_args[2]
+        if args.nil?
+          args = ""
+        end
 
-      args = name_args[2]
-      if args.nil?
-        args = ""
-      end
+        get_cisco_asa_config
+        commands = []
 
-      get_cisco_asa_config
-      commands = []
+        ui.info "Adding host to Cisco ASA:"
+        ui.info "#{ui.color "ASA:", :cyan} #{get_config(:cisco_asa_hostname)}"
+        ui.info "#{ui.color "Host:", :cyan} #{hostname}"
+        ui.info "#{ui.color "IP:", :cyan} #{ip}"
 
-      ui.info "Adding host to Cisco ASA:"
-      ui.info "#{ui.color "ASA:", :cyan} #{get_config(:cisco_asa_hostname)}"
-      ui.info "#{ui.color "Host:", :cyan} #{hostname}"
-      ui.info "#{ui.color "IP:", :cyan} #{ip}"
+        commands << "object network #{hostname}"
+        commands << "  host #{ip}"
 
-      commands << "object network #{hostname}"
-      commands << "  host #{ip}"
+        if get_config(:description)
+          ui.info "#{ui.color "Description:", :cyan} #{get_config(:description)}"
+          commands << "  description #{get_config(:description)}"
+        end
 
-      if get_config(:description)
-        ui.info "#{ui.color "Description:", :cyan} #{get_config(:description)}"
-        commands << "  description #{get_config(:description)}"
-      end
+        if get_config(:nat)
+          ui.info "#{ui.color "NAT IP:", :cyan} #{get_config(:nat)}"
+          command = "  nat static #{get_config(:nat)}"
+          if get_config(:nat_dns)
+            ui.info "#{ui.color "NAT DNS:", :cyan} Enabled"
+            command = command + " dns"
+          end
+          commands << command
+        end
 
-      if get_config(:nat)
-        ui.info "#{ui.color "NAT IP:", :cyan} #{get_config(:nat)}"
-        command = "  nat static #{get_config(:nat)}"
-        if get_config(:nat_dns)
-          ui.info "#{ui.color "NAT DNS:", :cyan} Enabled"
-          command = command + " dns"
+        if get_config(:groups)
+          get_config(:groups).split(",").each do |group|
+            ui.info "#{ui.color "Group:", :cyan} #{group}"
+            commands << "object-group network #{group}"
+            commands << "  network-object object #{hostname}"
+          end
         end
-        commands << command
-      end
 
-      if get_config(:groups)
-        get_config(:groups).split(",").each do |group|
-          ui.info "#{ui.color "Group:", :cyan} #{group}"
-          commands << "object-group network #{group}"
-          commands << "  network-object object #{hostname}"
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping host creation process because --noop specified.", :red}"
+        else
+          run_config_commands(commands)
         end
+        
       end
 
-      if get_config(:noop)
-        ui.info "#{ui.color "Skipping host creation process because --noop specified.", :red}"
-      else
-        run_config_commands(commands)
-      end
-      
     end
-
   end
 end

data/lib/chef/knife/cisco_asa_host_remove.rb

@@ -3,70 +3,72 @@
 # License:: Apache License, Version 2.0
 #
 
-module CiscoAsaKnifePlugin
+require 'chef/knife/cisco_asa_base'
 
-  require 'chef/knife'
+class Chef
+  class Knife
+    class CiscoAsaHostRemove < Knife
 
-  class CiscoAsaHostRemove < BaseCiscoAsaCommand
+      include Knife::CiscoAsaBase
 
-    banner "knife cisco asa host remove NAME (options)"
-    category "cisco asa"
+      banner "knife cisco asa host remove NAME (options)"
+      category "cisco asa"
 
-    get_common_options
+      option :groups, 
+        :long => "--groups GROUP[,GROUP2]",
+        :description => "Groups for host"
 
-    option :groups, 
-      :long => "--groups GROUP[,GROUP2]",
-      :description => "Groups for host"
+      option :nat,
+        :long => "--nat IP",
+        :description => "NAT IP"
 
-    option :nat,
-      :long => "--nat IP",
-      :description => "NAT IP"
+      def run
+        $stdout.sync = true
+        
+        hostname = name_args.first.upcase
 
-    def run
-      
-      hostname = name_args.first.upcase
-
-      if hostname.nil?
-        ui.fatal "You need a host name!"
-        show_usage
-        exit 1
-      end
+        if hostname.nil?
+          ui.fatal "You need a host name!"
+          show_usage
+          exit 1
+        end
 
-      args = name_args[1]
-      if args.nil?
-        args = ""
-      end
+        args = name_args[1]
+        if args.nil?
+          args = ""
+        end
 
-      get_cisco_asa_config
-      commands = []
+        get_cisco_asa_config
+        commands = []
 
-      ui.info "Removing host from Cisco ASA:"
-      ui.info "#{ui.color "ASA:", :cyan} #{get_config(:cisco_asa_hostname)}"
-      ui.info "#{ui.color "Host:", :cyan} #{hostname}"
+        ui.info "Removing host from Cisco ASA:"
+        ui.info "#{ui.color "ASA:", :cyan} #{get_config(:cisco_asa_hostname)}"
+        ui.info "#{ui.color "Host:", :cyan} #{hostname}"
 
-      if get_config(:nat)
-        ui.info "#{ui.color "NAT IP:", :cyan} #{get_config(:nat)}"
-        commands << "object network #{hostname}"
-        commands << "  no nat (inside,outside) static #{get_config(:nat)} dns"
-      end
+        if get_config(:nat)
+          ui.info "#{ui.color "NAT IP:", :cyan} #{get_config(:nat)}"
+          commands << "object network #{hostname}"
+          commands << "  no nat (inside,outside) static #{get_config(:nat)} dns"
+        end
 
-      if get_config(:groups)
-        get_config(:groups).split(",").each do |group|
-          ui.info "#{ui.color "Group:", :cyan} #{group}"
-          commands << "object-group network #{group}"
-          commands << "  no network-object object #{hostname}"
+        if get_config(:groups)
+          get_config(:groups).split(",").each do |group|
+            ui.info "#{ui.color "Group:", :cyan} #{group}"
+            commands << "object-group network #{group}"
+            commands << "  no network-object object #{hostname}"
+          end
         end
-      end
 
-      commands << "no object network #{hostname}"
+        commands << "no object network #{hostname}"
 
-      if get_config(:noop)
-        ui.info "#{ui.color "Skipping host removal process because --noop specified.", :red}"
-      else
-        run_config_commands(commands)
+        if get_config(:noop)
+          ui.info "#{ui.color "Skipping host removal process because --noop specified.", :red}"
+        else
+          run_config_commands(commands)
+        end
+        
       end
-      
-    end
 
+    end
   end
 end

data/lib/knife-cisco_asa/version.rb

@@ -1,5 +1,6 @@
 module Knife
   module CiscoAsa
-    VERSION = "0.1.4"
+    VERSION = "0.2.0"
+    MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-cisco_asa
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-17 00:00:00.000000000 Z
+date: 2013-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cisco
@@ -40,7 +40,7 @@ files:
 - README.md
 - Rakefile
 - knife-cisco_asa.gemspec
-- lib/chef/knife/BaseCiscoAsaCommand.rb
+- lib/chef/knife/cisco_asa_base.rb
 - lib/chef/knife/cisco_asa_host_add.rb
 - lib/chef/knife/cisco_asa_host_remove.rb
 - lib/knife-cisco_asa/version.rb

data/lib/chef/knife/BaseCiscoAsaCommand.rb

@@ -1,104 +0,0 @@
-#
-# Author:: Brian Flad (<bflad417@gmail.com>)
-# License:: Apache License, Version 2.0
-#
-
-module CiscoAsaKnifePlugin
-
-  require 'chef/knife'
-  require 'cisco'
-  require 'highline/import'
-  
-  class BaseCiscoAsaCommand < Chef::Knife
-
-    deps do
-      require 'highline/import'
-    end
-
-    def self.get_common_options
-      unless defined? $default
-        $default = Hash.new
-      end
-
-      option :cisco_asa_enable_password,
-        :short => "-E PASSWORD",
-        :long => "--cisco-asa-enable-password PASSWORD",
-        :description => "Enable password for Cisco ASA"
-
-      option :cisco_asa_hostname,
-        :short => "-h HOSTNAME",
-        :long => "--cisco-asa-hostname HOSTNAME",
-        :description => "The hostname for Cisco ASA"
-
-      option :cisco_asa_password,
-        :short => "-p PASSWORD",
-        :long => "--cisco-asa-password PASSWORD",
-        :description => "The password for Cisco ASA"
-
-      option :cisco_asa_username,
-        :short => "-u USERNAME",
-        :long => "--cisco-asa-username USERNAME",
-        :description => "The username for Cisco ASA"
-      $default[:cisco_asa_username] = ENV['USER']
-
-      option :noop,
-        :long => "--noop",
-        :description => "Perform no modifying operations",
-        :boolean => false
-
-    end
-
-    def get_config(key)
-      key = key.to_sym
-      rval = config[key] || Chef::Config[:knife][key] || $default[key]
-      Chef::Log.debug("value for config item #{key}: #{rval}")
-      rval
-    end
-
-    def get_cisco_asa_config
-      config[:cisco_asa_password] = ask("Cisco Password for #{get_config(:cisco_asa_username)}: ") { |q| q.echo = "*" } unless get_config(:cisco_asa_password)
-      config[:cisco_asa_enable_password] = ask("Enable Password for #{get_config(:cisco_asa_hostname)}: ") { |q| q.echo = "*" } unless get_config(:cisco_asa_enable_password)
-    end
-
-    def run_config_commands(commands)
-      asa = Cisco::Base.new(:host => get_config(:cisco_asa_hostname), :user => get_config(:cisco_asa_username), :password => get_config(:cisco_asa_password), :transport => :ssh)
-      asa.enable(get_config(:cisco_asa_enable_password))
-      asa.cmd("conf t")
-      commands.each do |command|
-        asa.cmd(command)
-      end
-      asa.cmd("end")
-      asa.cmd("write mem")
-      unless get_config(:noop)
-        output = asa.run
-        output.each do |line|
-          Chef::Log.debug(line)
-        end
-      end
-      output
-    end
-
-    def tcp_test_port(hostname,port)
-      tcp_socket = TCPSocket.new(hostname, port)
-      readable = IO.select([tcp_socket], nil, nil, 5)
-      if readable
-        Chef::Log.debug("sshd accepting connections on #{hostname}, banner is #{tcp_socket.gets}") if port == 22
-        true
-      else
-        false
-      end
-      rescue Errno::ETIMEDOUT
-        false
-      rescue Errno::EPERM
-        false
-      rescue Errno::ECONNREFUSED
-        sleep 2
-        false
-      rescue Errno::EHOSTUNREACH, Errno::ENETUNREACH
-        sleep 2
-        false
-      ensure
-        tcp_socket && tcp_socket.close
-    end
-  end
-end