oxidized 0.21.0 → 0.22.0

data/lib/oxidized/model/opengear.rb

@@ -1,8 +1,7 @@
 class OpenGear < Oxidized::Model
+  comment '# '
 
-  comment  '# '
-  
-  prompt /^(\$\s)?$/
+  prompt /^(\$\s)$/
 
   cmd :secret do |cfg|
     cfg.gsub!(/password (\S+)/, 'password <secret removed>')
@@ -15,7 +14,6 @@ class OpenGear < Oxidized::Model
   cmd 'config -g config'
 
   cfg :ssh do
-    exec true  # don't run shell, run each command in exec channel
+    exec true # don't run shell, run each command in exec channel
   end
-
 end

data/lib/oxidized/model/openwrt.rb

@@ -0,0 +1,77 @@
+class OpenWrt < Oxidized::Model
+  prompt /^[^#]+#/
+  comment '#'
+
+  cmd 'cat /etc/banner' do |cfg|
+    comment "#### Info: /etc/banner #####\n#{cfg}"
+  end
+
+  cmd 'cat /proc/cpuinfo' do |cfg|
+    comment "#### Info: /proc/cpuinfo #####\n#{cfg}"
+  end
+
+  cmd 'cat /etc/openwrt_release' do |cfg|
+    comment "#### Info: /etc/openwrt_release #####\n#{cfg}"
+  end
+
+  cmd 'sysupgrade -l' do |cfg|
+    @sysupgradefiles = cfg
+    comment "#### Info: sysupgrade -l #####\n#{cfg}"
+  end
+
+  cmd 'cat /proc/mtd' do |cfg|
+    @mtdpartitions = cfg
+    comment "#### Info: /proc/mtd #####\n#{cfg}"
+  end
+
+  post do
+    cfg = []
+    binary_files = vars(:openwrt_binary_files) || %w[/etc/dropbear/dropbear_rsa_host_key]
+    non_sensitive_files = vars(:openwrt_non_sensitive_files) || %w[rpcd uhttpd]
+    partitions_to_backup = vars(:openwrt_partitions_to_backup) || %w[art devinfo u_env config caldata]
+    @sysupgradefiles.lines.each do |sysupgradefile|
+      sysupgradefile = sysupgradefile.strip
+      if sysupgradefile.start_with?('/etc/config/')
+        unless sysupgradefile.end_with?('-opkg')
+          filename = sysupgradefile.split('/')[-1]
+          cfg << comment("#### File: #{sysupgradefile} #####")
+          uciexport = cmd("uci export #{filename}")
+          Oxidized.logger.debug "Exporting uci config - #{filename}"
+          if vars(:remove_secret) && !(non_sensitive_files.include? filename)
+            Oxidized.logger.debug "Scrubbing uci config - #{filename}"
+            uciexport.gsub!(/^(\s+option\s+(password|key)\s+')[^']+'/, '\\1<secret hidden>\'')
+          end
+          cfg << uciexport
+        end
+      elsif binary_files.include? sysupgradefile
+        Oxidized.logger.debug "Exporting binary file - #{sysupgradefile}"
+        cfg << comment("#### Binary file: #{sysupgradefile} #####")
+        cfg << comment("Decode using 'echo -en <data> | gzip -dc > #{sysupgradefile}'")
+        cfg << cmd("gzip -c #{sysupgradefile} | hexdump -ve '1/1 \"_x%.2x\"' | tr _ \\")
+      elsif vars(:remove_secret) && sysupgradefile == '/etc/shadow'
+        Oxidized.logger.debug 'Exporting and scrubbing /etc/shadow'
+        cfg << comment("#### File: #{sysupgradefile} #####")
+        shadow = cmd("cat #{sysupgradefile}")
+        shadow.gsub!(/^([^:]+:)[^:]*(:[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:[^:]*:)/, '\\1\\2')
+        cfg << shadow
+      else
+        Oxidized.logger.debug "Exporting file - #{sysupgradefile}"
+        cfg << comment("#### File: #{sysupgradefile} #####")
+        cfg << cmd("cat #{sysupgradefile}")
+      end
+    end
+    @mtdpartitions.scan(/(\w+):\s+\w+\s+\w+\s+"(.*)"/).each do |partition, name|
+      next unless vars(:openwrt_backup_partitions) && partitions_to_backup.include?(name)
+      Oxidized.logger.debug "Exporting partition - #{name}(#{partition})"
+      cfg << comment("#### Partition: #{name} /dev/#{partition} #####")
+      cfg << comment("Decode using 'echo -en <data> | gzip -dc > #{name}'")
+      cfg << cmd("dd if=/dev/#{partition} 2>/dev/null | gzip -c | hexdump -ve '1/1 \"%.2x\"'")
+    end
+    cfg.join "\n"
+  end
+
+  cfg :ssh do
+    exec true
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/opnsense.rb

@@ -0,0 +1,19 @@
+class OpnSense < Oxidized::Model
+  # minimum required permissions: "System: Shell account access"
+  # must enable SSH and password-based SSH access
+
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-1].join
+  end
+
+  cmd 'cat /conf/config.xml' do |cfg|
+    cfg.gsub! /\s<revision>\s*<time>\d*<\/time>\s*.*\s*.*\s*<\/revision>/, ''
+    cfg.gsub! /\s<last_rule_upd_time>\d*<\/last_rule_upd_time>/, ''
+    cfg
+  end
+
+  cfg :ssh do
+    exec true
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/outputs.rb

@@ -1,7 +1,6 @@
 module Oxidized
   class Model
     class Outputs
-
       def to_cfg
         type_to_str(nil)
       end
@@ -23,7 +22,7 @@ module Oxidized
       end
 
       def type type
-        @outputs.select { |out| out.type==type }
+        @outputs.select { |out| out.type == type }
       end
 
       def types
@@ -35,7 +34,6 @@ module Oxidized
       def initialize
         @outputs = []
       end
-
     end
   end
 end

data/lib/oxidized/model/panos.rb

@@ -1,8 +1,7 @@
 class PanOS < Oxidized::Model
-
   # PaloAlto PAN-OS model #
 
-  comment  '! '
+  comment '! '
 
   prompt /^[\w.\@:\(\)-]+>\s?$/
 

data/lib/oxidized/model/pfsense.rb

@@ -1,20 +1,24 @@
 class PfSense < Oxidized::Model
-
   # use other use than 'admin' user, 'admin' user cannot get ssh/exec. See issue #535
-  
+
   cmd :all do |cfg|
     cfg.each_line.to_a[1..-1].join
   end
-  
+
+  cmd :secret do |cfg|
+    cfg.gsub! /(\s+<bcrypt-hash>)[^<]+(<\/bcrypt-hash>)/, '\\1<secret hidden>\\2'
+    cfg.gsub! /(\s+<password>)[^<]+(<\/password>)/, '\\1<secret hidden>\\2'
+    cfg
+  end
+
   cmd 'cat /cf/conf/config.xml' do |cfg|
     cfg.gsub! /\s<revision>\s*<time>\d*<\/time>\s*.*\s*.*\s*<\/revision>/, ''
     cfg.gsub! /\s<last_rule_upd_time>\d*<\/last_rule_upd_time>/, ''
     cfg
   end
-  
+
   cfg :ssh do
     exec true
     pre_logout 'exit'
   end
- 
 end

data/lib/oxidized/model/planet.rb

@@ -1,24 +1,23 @@
 class Planet < Oxidized::Model
-
   prompt /^\r?([\w.@()-]+[#>]\s?)$/
   comment  '! '
 
   # example how to handle pager
-  #expect /^\s--More--\s+.*$/ do |data, re|
+  # expect /^\s--More--\s+.*$/ do |data, re|
   # send ' '
   # data.sub re, ''
-  #end
+  # end
 
   # non-preferred way to handle additional PW prompt
-  #expect /^[\w.]+>$/ do |data|
+  # expect /^[\w.]+>$/ do |data|
   #  send "enable\n"
   #  send vars(:enable) + "\n"
   #  data
-  #end
+  # end
 
   cmd :all do |cfg|
-    #cfg.gsub! /\cH+\s{8}/, ''         # example how to handle pager
-    #cfg.gsub! /\cH+/, ''              # example how to handle pager
+    # cfg.gsub! /\cH+\s{8}/, ''         # example how to handle pager
+    # cfg.gsub! /\cH+/, ''              # example how to handle pager
     cfg.each_line.to_a[1..-2].join
   end
 
@@ -39,7 +38,7 @@ class Planet < Oxidized::Model
 
     cfg = cfg.each_line.to_a[0...-2]
 
-   # Strip system (up)time and temperature
+    # Strip system (up)time and temperature
     cfg = cfg.reject { |line| line.match /System Time\s*:.*/ }
     cfg = cfg.reject { |line| line.match /System Uptime\s*:.*/ }
     cfg = cfg.reject { |line| line.match /Temperature\s*:.*/ }
@@ -47,13 +46,12 @@ class Planet < Oxidized::Model
     comment cfg.join
   end
 
-
   cmd 'show running-config' do |cfg|
     cfg.gsub! "\n\r", "\n"
     cfg = cfg.each_line.to_a
 
     cfg = cfg.reject { |line| line.match "Building configuration..." }
-  
+
     if @planetsgs
       cfg << cmd('show transceiver detail | include transceiver detail information|found|Type|length|Nominal|wavelength|Base information') do |cfg|
         comment cfg
@@ -62,7 +60,6 @@ class Planet < Oxidized::Model
 
     cfg.join
   end
-  
 
   cfg :telnet do
     username /^Username:/
@@ -80,5 +77,4 @@ class Planet < Oxidized::Model
     end
     pre_logout 'exit'
   end
-
 end

data/lib/oxidized/model/powerconnect.rb

@@ -1,12 +1,11 @@
 class PowerConnect < Oxidized::Model
-
   prompt /^([\w\s.@-]+[#>]\s?)$/ # allow spaces in hostname..dell does not limit it.. #
 
-  comment  '! '
+  comment '! '
 
   expect /^\s*--More--\s+.*$/ do |data, re|
-     send ' '
-     data.sub re, ''
+    send ' '
+    data.sub re, ''
   end
 
   cmd :all do |cfg|
@@ -14,7 +13,7 @@ class PowerConnect < Oxidized::Model
   end
 
   cmd :secret do |cfg|
-    cfg.gsub! /^username (\S+) password \S+ (.*)/, 'username \1 password <hidden> \2'
+    cfg.gsub! /^(username \S+ password (?:encrypted )?)\S+(.*)/, '\1<hidden>\2'
     cfg
   end
 
@@ -22,7 +21,7 @@ class PowerConnect < Oxidized::Model
     if (@stackable.nil?)
       @stackable = true if cfg.match /(U|u)nit\s/
     end
-    cfg = cfg.split("\n").select { |line| not line[/Up\sTime/] }
+    cfg = cfg.split("\n").reject { |line| line[/Up\sTime/] }
     comment cfg.join("\n") + "\n"
   end
 
@@ -52,7 +51,6 @@ class PowerConnect < Oxidized::Model
     post_login "terminal length 0"
     pre_logout "logout"
     pre_logout "exit"
-    
   end
 
   def clean cfg
@@ -72,9 +70,8 @@ class PowerConnect < Oxidized::Model
       end
       out << line.strip
     end
-    out = out.select { |line| not line[/Up\sTime/] }
+    out = out.reject { |line| line[/Up\sTime/] }
     out = comment out.join "\n"
     out << "\n"
   end
-
 end

data/lib/oxidized/model/procurve.rb

@@ -1,10 +1,9 @@
 class Procurve < Oxidized::Model
-
   # some models start lines with \r
   # previous command is repeated followed by "\eE", which sometimes ends up on last line
   prompt /^\r?([\w.-]+# )$/
 
-  comment  '! '
+  comment '! '
 
   # replace next line control sequence with a new line
   expect /(\e\[1M\e\[\??\d+(;\d+)*[A-Za-z]\e\[1L)|(\eE)/ do |data, re|
@@ -21,6 +20,11 @@ class Procurve < Oxidized::Model
     ""
   end
 
+  expect /Enter switch number/ do
+    send "\n"
+    ""
+  end
+
   cmd :all do |cfg|
     cfg = cfg.each_line.to_a[1..-2].join
     cfg = cfg.gsub /^\r/, ''
@@ -42,6 +46,10 @@ class Procurve < Oxidized::Model
     comment cfg
   end
 
+  cmd 'show system power-supply' do |cfg|
+    comment cfg
+  end
+
   cmd 'show interfaces transceiver' do |cfg|
     comment cfg
   end
@@ -58,7 +66,7 @@ class Procurve < Oxidized::Model
 
   # not supported on all models
   cmd 'show system information' do |cfg|
-    cfg = cfg.each_line.select { |line| not line.match /(.*CPU.*)|(.*Up Time.*)|(.*Total.*)|(.*Free.*)|(.*Lowest.*)|(.*Missed.*)/ }
+    cfg = cfg.each_line.reject { |line| line.match /(.*CPU.*)|(.*Up Time.*)|(.*Total.*)|(.*Free.*)|(.*Lowest.*)|(.*Missed.*)/ }
     cfg = cfg.join
     comment cfg
   end
@@ -71,6 +79,13 @@ class Procurve < Oxidized::Model
   end
 
   cfg :telnet, :ssh do
+    # preferred way to handle additional passwords
+    if vars :enable
+      post_login do
+        send "enable\n"
+        cmd vars(:enable)
+      end
+    end
     post_login 'no page'
     pre_logout "logout\ny\nn"
   end
@@ -78,5 +93,4 @@ class Procurve < Oxidized::Model
   cfg :ssh do
     pty_options({ chars_wide: 1000 })
   end
-
 end

data/lib/oxidized/model/quantaos.rb

@@ -1,13 +1,12 @@
 class QuantaOS < Oxidized::Model
-
   prompt /^\((\w|\S)+\) (>|#)$/
   comment '! '
-  
+
   cmd 'show run' do |cfg|
     cfg.each_line.select do |line|
       not line.match /^!.*$/ and
-      not line.match /^\((\w|\S)+\) (>|#)$/ and
-      not line.match /^show run$/
+        not line.match /^\((\w|\S)+\) (>|#)$/ and
+        not line.match /^show run$/
     end.join
   end
 
@@ -31,5 +30,4 @@ class QuantaOS < Oxidized::Model
       send "n\n"
     end
   end
-
 end

data/lib/oxidized/model/routeros.rb

@@ -18,8 +18,9 @@ class RouterOS < Oxidized::Model
     run_cmd = vars(:remove_secret) ? '/export hide-sensitive' : '/export'
     cmd run_cmd do |cfg|
       cfg.gsub! /\x1B\[([0-9]{1,3}((;[0-9]{1,3})*)?)?[m|K]/, '' # strip ANSI colours
-      cfg.gsub! /\\\r\n\s+/, ''   # strip new line
-      cfg = cfg.split("\n").select { |line| not line[/^\#\s\w{3}\/\d{2}\/\d{4}.*$/] }
+      cfg.gsub! /\\\r\n\s+/, '' # strip new line
+      cfg.gsub! /# inactive time\r\n/, '' # Remove time based system comment
+      cfg = cfg.split("\n").reject { |line| line[/^\#\s\w{3}\/\d{2}\/\d{4}.*$/] }
       cfg.join("\n") + "\n"
     end
   end

data/lib/oxidized/model/saos.rb

@@ -1,5 +1,4 @@
 class SAOS < Oxidized::Model
-
   # Ciena SAOS switch
   # used for 6.x devices
 

data/lib/oxidized/model/screenos.rb

@@ -1,8 +1,7 @@
-class ScreenOS  < Oxidized::Model
-
+class ScreenOS < Oxidized::Model
   # Netscreen ScreenOS model #
 
-  comment  '! '
+  comment '! '
 
   prompt /^[\w.:\(\)-]+->\s?$/
 
@@ -10,7 +9,7 @@ class ScreenOS  < Oxidized::Model
     cfg.each_line.to_a[2..-2].join
   end
 
-  cmd :secret do |cfg| 
+  cmd :secret do |cfg|
     cfg.gsub! /^(set admin name) .*|^(set admin password) .*/, '\\1 <removed>'
     cfg.gsub! /^(set admin user .* password) .* (.*)/, '\\1 <removed> \\2'
     cfg.gsub! /(secret|password|preshare) .*/, '\\1 <secret hidden>'
@@ -41,5 +40,4 @@ class ScreenOS  < Oxidized::Model
       send "n"
     end
   end
-
 end

data/lib/oxidized/model/sgos.rb

@@ -1,5 +1,4 @@
 class SGOS < Oxidized::Model
-
   comment '!- '
   prompt /\w+>|#/
 
@@ -20,14 +19,14 @@ class SGOS < Oxidized::Model
     comment cfg
   end
 
-   cmd :secret do |cfg|
+  cmd :secret do |cfg|
     cfg.gsub! /^(security hashed-enable-password).*/, '\\1 <secret hidden>'
     cfg.gsub! /^(security hashed-password).*/, '\\1 <secret hidden>'
     cfg
   end
 
   cmd 'show configuration expanded noprompts with-keyrings unencrypted' do |cfg|
-    cfg.gsub! /^(!- Local time).*/,""
+    cfg.gsub! /^(!- Local time).*/, ""
     cfg.gsub! /^(archive-configuration encrypted-password).*/, ""
     cfg.gsub! /^(download encrypted-password).*/, ""
     cfg