oxidized 0.29.1 → 0.37.0

data/lib/oxidized/model/model.rb

@@ -1,22 +1,40 @@
 require 'strscan'
 require_relative 'outputs'
+require_relative 'dslsetup'
+require_relative 'dslcommands'
+require_relative 'macros'
 
 module Oxidized
   class Model
+    include SemanticLogger::Loggable
+
     using Refinements
 
+    # Domain Specific Language for models
+    extend Oxidized::Model::DSLSetup
+    extend Oxidized::Model::DSLCommands
+    extend Oxidized::Model::Macros
+
     include Oxidized::Config::Vars
 
+    # rubocop:disable Style/FormatStringToken
+    METADATA_DEFAULT = "%{comment}Fetched by Oxidized with model %{model} " \
+                       "from host %{name} [%{ip}]\n".freeze
+    # rubocop:enable Style/FormatStringToken
+
     class << self
       def inherited(klass)
         super
         if klass.superclass == Oxidized::Model
-          klass.instance_variable_set '@cmd',     (Hash.new { |h, k| h[k] = [] })
-          klass.instance_variable_set '@cfg',     (Hash.new { |h, k| h[k] = [] })
-          klass.instance_variable_set '@procs',   (Hash.new { |h, k| h[k] = [] })
+          klass.instance_variable_set('@cmd',     Hash.new { |h, k| h[k] = [] })
+          klass.instance_variable_set('@cfg',     Hash.new { |h, k| h[k] = [] })
+          klass.instance_variable_set('@procs',   Hash.new { |h, k| h[k] = [] })
           klass.instance_variable_set '@expect',  []
           klass.instance_variable_set '@comment', nil
           klass.instance_variable_set '@prompt',  nil
+          klass.instance_variable_set '@metadata', {}
+          klass.instance_variable_set '@inputs', nil
+
         else # we're subclassing some existing model, take its variables
           instance_variables.each do |var|
             iv = instance_variable_get(var)
@@ -25,101 +43,20 @@ module Oxidized
           end
         end
       end
-
-      def comment(str = "# ")
-        @comment = if block_given?
-                     yield
-                   elsif not @comment
-                     str
-                   else
-                     @comment
-                   end
-      end
-
-      def prompt(regex = nil)
-        @prompt = regex || @prompt
-      end
-
-      def cfg(*methods, **args, &block)
-        [methods].flatten.each do |method|
-          process_args_block(@cfg[method.to_s], args, block)
-        end
-      end
-
-      def cfgs
-        @cfg
-      end
-
-      def cmd(cmd_arg = nil, **args, &block)
-        if cmd_arg.instance_of?(Symbol)
-          process_args_block(@cmd[cmd_arg], args, block)
-        else
-          process_args_block(@cmd[:cmd], args, [cmd_arg, block])
-        end
-        Oxidized.logger.debug "lib/oxidized/model/model.rb Added #{cmd_arg} to the commands list"
-      end
-
-      def cmds
-        @cmd
-      end
-
-      def expect(regex, **args, &block)
-        process_args_block(@expect, args, [regex, block])
-      end
-
-      def expects
-        @expect
-      end
-
-      # calls the block at the end of the model, prepending the output of the
-      # block to the output string
-      #
-      # @author Saku Ytti <saku@ytti.fi>
-      # @since 0.0.39
-      # @yield expects block which should return [String]
-      # @return [void]
-      def pre(**args, &block)
-        process_args_block(@procs[:pre], args, block)
-      end
-
-      # calls the block at the end of the model, adding the output of the block
-      # to the output string
-      #
-      # @author Saku Ytti <saku@ytti.fi>
-      # @since 0.0.39
-      # @yield expects block which should return [String]
-      # @return [void]
-      def post(**args, &block)
-        process_args_block(@procs[:post], args, block)
-      end
-
-      # @author Saku Ytti <saku@ytti.fi>
-      # @since 0.0.39
-      # @return [Hash] hash proc procs :pre+:post to be prepended/postfixed to output
-      attr_reader :procs
-
-      private
-
-      def process_args_block(target, args, block)
-        if args[:clear]
-          if block.instance_of?(Array)
-            target.reject! { |k, _| k == block[0] }
-            target.push(block)
-          else
-            target.replace([block])
-          end
-        else
-          method = args[:prepend] ? :unshift : :push
-          target.send(method, block)
-        end
-      end
     end
 
     attr_accessor :input, :node
 
-    def cmd(string, &block)
-      Oxidized.logger.debug "lib/oxidized/model/model.rb Executing #{string}"
-      out = @input.cmd(string)
+    # input specifies to run this command only with this input type
+    # if input is not specified, always run the command
+    def cmd(string, input: nil, &block)
+      logger.debug "Executing #{string}"
+      out = if input.nil? || input.include?(@input.to_sym)
+              out = @input.cmd(string)
+            else
+              # Do not run this command
+              return ''
+            end
       return false unless out
 
       out = out.b unless Oxidized.config.input.utf8_encoded?
@@ -135,6 +72,44 @@ module Oxidized
       process_cmd_output out, string
     end
 
+    def metadata(position)
+      return unless %i[top bottom].include? position
+
+      model_metadata = self.class.instance_variable_get(:@metadata)
+      var_position = { top: "metadata_top", bottom: "metadata_bottom" }
+      if model_metadata[:top] || model_metadata[:bottom]
+        # the model defines metadata at :top ot :bottom, use the model
+        value = model_metadata[position]
+        value.is_a?(Proc) ? instance_eval(&value) : interpolate_string(value)
+      elsif vars("metadata_top") || vars("metadata_bottom")
+        # vars defines metadata_top or metadata bottom, use the vars
+        interpolate_string(vars(var_position[position]))
+      elsif position == :top
+        # default: use METADATA_DEFAULT for top
+        interpolate_string(METADATA_DEFAULT)
+      end
+    end
+
+    def interpolate_string(template)
+      return nil unless template
+
+      time = Time.now
+      template_variables = {
+        model:   self.class.name,
+        name:    node.name,
+        ip:      node.ip,
+        group:   node.group,
+        comment: self.class.comment,
+        year:    time.year,
+        month:   "%02d" % time.month,
+        day:     "%02d" % time.day,
+        hour:    "%02d" % time.hour,
+        minute:  "%02d" % time.min,
+        second:  "%02d" % time.sec
+      }
+      template % template_variables
+    end
+
     def output
       @input.output
     end
@@ -143,8 +118,8 @@ module Oxidized
       @input.send data
     end
 
-    def expect(regex, &block)
-      self.class.expect regex, &block
+    def expect(...)
+      self.class.expect(...)
     end
 
     def cfg
@@ -164,27 +139,40 @@ module Oxidized
       data
     end
 
+    # Get the commands from the model
     def get
-      Oxidized.logger.debug 'lib/oxidized/model/model.rb Collecting commands\' outputs'
+      logger.debug 'Collecting commands\' outputs'
       outputs = Outputs.new
-      procs = self.class.procs
-      self.class.cmds[:cmd].each do |command, block|
-        out = cmd command, &block
+      self.class.cmds[:cmd].each do |data|
+        command = data[:cmd]
+        args = data[:args]
+        block = data[:block]
+
+        next if args.include?(:if) && !instance_exec(&args[:if])
+
+        out = cmd command, input: args[:input], &block
         return false unless out
 
         outputs << out
       end
+      procs = self.class.procs
       procs[:pre].each do |pre_proc|
         outputs.unshift process_cmd_output(instance_eval(&pre_proc), '')
       end
       procs[:post].each do |post_proc|
         outputs << process_cmd_output(instance_eval(&post_proc), '')
       end
+      if vars("metadata") == true
+        metadata_top = metadata(:top)
+        metadata_bottom = metadata(:bottom)
+        outputs.unshift metadata_top if metadata_top
+        outputs << metadata_bottom if metadata_bottom
+      end
       outputs
     end
 
     def comment(str)
-      data = ''
+      data = String.new('')
       str.each_line do |line|
         data << self.class.comment << line
       end
@@ -202,7 +190,7 @@ module Oxidized
       # Also, XML Comments must not contain --. So we put a space between
       # any double hyphens, by replacing any - that is followed by another -
       # with '- '
-      data = ''
+      data = String.new('')
       str.each_line do |_line|
         data << '<!-- ' << str.gsub(/-(?=-)/, '- ').chomp << " -->\n"
       end
@@ -213,11 +201,18 @@ module Oxidized
       @input.class.to_s.match(/Telnet/) || vars(:ssh_no_exec)
     end
 
+    def significant_changes(config)
+      self.class.cmds[:significant_changes].each do |block|
+        config = instance_exec config, &block
+      end
+      config
+    end
+
     private
 
     def process_cmd_output(output, name)
       output = String.new('') unless output.instance_of?(String)
-      output.set_cmd(name)
+      output.process_cmd(name)
       output
     end
   end

data/lib/oxidized/model/mtrlrfs.rb

@@ -3,6 +3,7 @@ class Mtrlrfs < Oxidized::Model
 
   # Motorola RFS/Extreme WM
 
+  prompt /^([\w.@-]+\*?[#>])\s?$/
   comment  '# '
 
   cmd :all do |cfg|

data/lib/oxidized/model/ndms.rb

@@ -22,4 +22,10 @@ class NDMS < Oxidized::Model
     password /^Password:/
     pre_logout 'exit'
   end
+
+  cmd :significant_changes do |cfg|
+    cfg.reject_lines [
+      'Last change:'
+    ]
+  end
 end

data/lib/oxidized/model/netgear.rb

@@ -2,7 +2,14 @@ class Netgear < Oxidized::Model
   using Refinements
 
   comment '!'
-  prompt /^(\([\w\s\-.]+\)\s[#>])$/
+  prompt /^\(?[\w \-+.]+\)? ?[#>] ?$/
+  clean :escape_codes
+
+  # Handle pager for "show version" on old Netgear models: #2394
+  expect /^--More--(?: or \(q\)uit)?$/ do |data, re|
+    send ' '
+    data.sub re, ''
+  end
 
   cmd :secret do |cfg|
     cfg.gsub!(/password (\S+)/, 'password <hidden>')
@@ -13,7 +20,7 @@ class Netgear < Oxidized::Model
   end
 
   cfg :telnet do
-    username /^(User:|Applying Interface configuration, please wait ...)/
+    username /^(Username:|User:|Applying Interface configuration, please wait ...)/
     password /^Password:/i
   end
 
@@ -51,7 +58,11 @@ class Netgear < Oxidized::Model
     comment cfg
   end
   cmd 'show running-config' do |cfg|
-    cfg.gsub! /(System Up Time\s+).*/, '\\1 <removed>'
+    cfg.gsub! /(System Up Time:?\s+).*/, '\\1 <removed>'
     cfg.gsub! /(Current SNTP Synchronized Time:).*/, '\\1 <removed>'
+    cfg.gsub! /(Current System Time:).*/, '\\1 <removed>'
+    # Remove standalone backspace lines
+    cfg.gsub!(/(?:\r?\n)?\x08(?:\r?\n)?/, "\n")
+    cfg
   end
 end

data/lib/oxidized/model/netonix.rb

@@ -1,7 +1,7 @@
 class Netonix < Oxidized::Model
   using Refinements
 
-  prompt /^[\w\s\(\).@_\/:-]+#/
+  prompt /^[\w\s().@_\/:-]+#/
 
   cmd :all do |cfg|
     cfg.cut_both

data/lib/oxidized/model/netscaler.rb

@@ -1,7 +1,7 @@
 class NetScaler < Oxidized::Model
   using Refinements
 
-  prompt /^([\w\.-]*>\s?)$/
+  prompt /^(.*[\w.-]*>\s?)$/
   comment '# '
 
   cmd :all do |cfg|

data/lib/oxidized/model/nodegrid.rb

@@ -4,7 +4,7 @@ class Nodegrid < Oxidized::Model
   # ZPE Nodegrid (Tested with Nodegrid Gate/Bold/NSR)
   # https://www.zpesystems.com/products/
 
-  prompt(%r{(?<!@)\[(.*?\s/)\]#})
+  prompt /(?<!@)\[(.*?\s\/)\]#/
   comment '# '
 
   cmd 'show system/about/' do |cfg|

data/lib/oxidized/model/nsxdfw.rb

@@ -0,0 +1,31 @@
+require 'net/http'
+class NSXDfw < Oxidized::Model
+  using Refinements
+
+  cmd "/policy/api/v1/infra/domains/" do |cfg|
+    domains = JSON.parse(cfg.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))["results"]
+    domain_config = {}
+    domains.each do |domain|
+      domain_config[domain['id']] = {}
+      policies_data = cmd "/policy/api/v1/infra/domains/#{domain['id']}/security-policies/"
+      policies = JSON.parse(policies_data.encode('UTF-8',
+                                                 { invalid: :replace, undef: :replace, replace: '?' }))["results"]
+      policies_config = {}
+      policies.each do |policy|
+        rules_data = cmd "/policy/api/v1/infra/domains/#{domain['id']}/security-policies/#{policy['id']}/rules"
+        rules = JSON.parse(rules_data.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))["results"]
+        policies_config[policy['id']] = rules
+      end
+      domain_config[domain['id']] = policies_config
+    end
+    JSON.pretty_generate(domain_config)
+  end
+
+  cfg :http do
+    @username = @node.auth[:username]
+    @password = @node.auth[:password]
+    @headers['Content-Type'] = 'application/json'
+    @headers['Accept'] = 'application/json'
+    @secure = true
+  end
+end

data/lib/oxidized/model/nsxfirewall.rb

@@ -8,7 +8,8 @@ class NSXFirewall < Oxidized::Model
     edges.each do |edge|
       firewall_config = cmd "/api/4.0/edges/#{edge['id']}/firewall/config"
       json_config = {}
-      json_config["#{edge['id']} #{edge['name']}"] = JSON.parse(firewall_config.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))
+      json_config["#{edge['id']} #{edge['name']}"] =
+        JSON.parse(firewall_config.encode('UTF-8', { invalid: :replace, undef: :replace, replace: '?' }))
       data.push(json_config)
     end
     JSON.pretty_generate(data)

data/lib/oxidized/model/nxos.rb

@@ -1,39 +1,44 @@
 class NXOS < Oxidized::Model
   using Refinements
 
-  prompt /^(\r?[\w.@_()-]+[#]\s?)$/
+  prompt /^(\r?[\w.@_()-]+\#\s?)$/
   comment '! '
 
-  def filter(cfg)
-    cfg.gsub! /\r\n?/, "\n"
-    cfg.gsub! prompt, ''
+  cmd :all do |cfg|
+    cfg.cut_both
   end
 
   cmd :secret do |cfg|
-    cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
-    cfg.gsub! /^(snmp-server user (\S+) (\S+) auth (\S+)) (\S+) (priv) (\S+)/, '\\1 <configuration removed> '
+    cfg.gsub! /^(snmp-server community).*/, '\\1 <secret hidden>'
+    cfg.gsub!(
+      /^(snmp-server user \S+ \S+ auth \S+) \S+ (priv \S+) \S+ /,
+      '\\1 <secret hidden> \\2 <secret hidden> '
+    )
+    cfg.gsub! /^(snmp-server host.*? )\S+( udp-port \d+)?$/, '\\1<secret hidden>\\2'
+    cfg.gsub! /^(snmp-server mib community-map) \S+ ?(.*)/, '\\1 <secret hidden> \\2'
     cfg.gsub! /(password \d+) (\S+)/, '\\1 <secret hidden>'
-    cfg.gsub! /^(radius-server key).*/, '\\1 <secret hidden>'
-    cfg.gsub! /^(tacacs-server host .+ key(?: \d+)?) \S+/, '\\1 <secret hidden>'
+    cfg.gsub! /^(radius-server .*key(?: \d+)?) \S+/, '\\1 <secret hidden>'
+    cfg.gsub! /^(tacacs-server .*key(?: \d+)?) \S+/, '\\1 <secret hidden>'
     cfg
   end
 
   cmd 'show version' do |cfg|
-    cfg = filter cfg
-    cfg = cfg.each_line.take_while { |line| not line.match(/uptime/i) }
-    comment cfg.join
+    cfg = cfg.each_line.take_while { |line| not line.match(/uptime|bootflash:\s+\d+\skB|sysmgrcli_show_flash_size/i) }
+    comment cfg.join + "\n"
   end
 
-  cmd 'show inventory' do |cfg|
-    cfg = filter cfg
+  cmd 'show inventory all' do |cfg|
+    if cfg.match? /^% Invalid .* at '\^' marker\./
+      # 'show inventory all' isn't supported on older versions (See Issues #3657, #3779)
+      cfg = cmd 'show inventory'
+    end
     comment cfg
   end
 
   cmd 'show running-config' do |cfg|
-    cfg = filter cfg
     cfg.gsub! /^(show run.*)$/, '! \1'
     cfg.gsub! /^!Time:[^\n]*\n/, ''
-    cfg.gsub! /^[\w.@_()-]+[#].*$/, ''
+    cfg.gsub! /^[\w.@_()-]+\#.*$/, ''
     cfg
   end
 

data/lib/oxidized/model/ocnos.rb

@@ -0,0 +1,42 @@
+class OcNOS < Oxidized::Model
+  using Refinements
+
+  prompt /([\w.@-]+[#>]\s?)$/
+  comment '# '
+
+  cfg :ssh do
+    post_login 'terminal length 0'
+    pre_logout do
+      send "disable\r"
+      send "logout\r"
+    end
+  end
+
+  cmd :all do |cfg|
+    cfg.lines.to_a[1..-2].join
+  end
+
+  cmd 'show version' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show system fru' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show system-information board-info' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show forwarding profile limit' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show license' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg
+  end
+end

data/lib/oxidized/model/onefinity.rb

@@ -0,0 +1,18 @@
+class OneFinity < Oxidized::Model
+  using Refinements
+
+  # Fujitsu 1finity
+
+  prompt /(\r?[\w.@_()-]+>\s?)$/
+
+  cmd :all do |cfg|
+    cfg.each_line.to_a[1..-3].join
+  end
+
+  cmd 'show configuration | display set | nomore'
+
+  cfg :ssh do
+    pre_logout 'exit'
+    exec true
+  end
+end

data/lib/oxidized/model/openbsd.rb

@@ -5,7 +5,7 @@ class Openbsd < Oxidized::Model
   # you can edit the one that your user uses, with root would be /root/.profile using the next PS1 def
   # export PS1="\033[32m\u@\h\033[00m:\033[36m\w\033[00m$ "
 
-  prompt /^.+@.+\:.+\$/
+  prompt /^.+@.+:.+\$/
   comment '# '
 
   # Add a comment between files/configs

data/lib/oxidized/model/opengear.rb

@@ -8,12 +8,47 @@ class OpenGear < Oxidized::Model
   cmd :secret do |cfg|
     cfg.gsub!(/password (\S+)/, 'password <secret removed>')
     cfg.gsub!(/community (\S+)/, 'community <secret removed>')
+    cfg.gsub!(/community=(\S+)/, 'community=<secret removed>')
+    cfg.gsub!(/private_key=(\S+)/, 'private_key=<secret removed>')
+    cfg.gsub!(/ key=(\S+)/, ' key=<secret removed>')
+    cfg.gsub!(/hashed_password=(\S+)/, 'hashed_password=<secret removed>')
     cfg
   end
 
   cmd('cat /etc/version') { |cfg| comment cfg }
 
-  cmd('config -g config') { |cfg| cfg }
+  # newer opengear firmware versions
+  cmd 'ogdeviceinfo -r' do |cfg|
+    comment cfg unless cfg.include? "ogdeviceinfo: command not found"
+  end
+
+  cmd 'config export' do |cfg|
+    unless cfg.include? "usage: config"
+      out = ''
+      cfg.each_line do |line|
+        out << line
+      end
+      out
+    end
+  end
+
+  # older opengear firmware versions
+  cmd 'showserial' do |cfg|
+    unless cfg.include? "showserial: command not found"
+      cfg.gsub! /^/, 'Serial Number: '
+      comment cfg
+    end
+  end
+
+  cmd 'config -g config' do |cfg|
+    unless cfg.include? "config: error: argument"
+      out = ''
+      cfg.each_line do |line|
+        out << line
+      end
+      out
+    end
+  end
 
   cfg :ssh do
     exec true # don't run shell, run each command in exec channel

data/lib/oxidized/model/openwrt.rb

@@ -38,26 +38,26 @@ class OpenWrt < Oxidized::Model
           filename = sysupgradefile.split('/')[-1]
           cfg << comment("#### File: #{sysupgradefile} #####")
           uciexport = cmd("uci export #{filename}")
-          Oxidized.logger.debug "Exporting uci config - #{filename}"
+          logger.debug "Exporting uci config - #{filename}"
           if vars(:remove_secret) && !(non_sensitive_files.include? filename)
-            Oxidized.logger.debug "Scrubbing uci config - #{filename}"
+            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}"
+        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'
+        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}"
+        logger.debug "Exporting file - #{sysupgradefile}"
         cfg << comment("#### File: #{sysupgradefile} #####")
         cfg << cmd("cat #{sysupgradefile}")
       end
@@ -65,7 +65,7 @@ class OpenWrt < Oxidized::Model
     @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})"
+      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\"'")

data/lib/oxidized/model/opnsense.rb

@@ -18,10 +18,18 @@ class OpnSense < Oxidized::Model
   # that lack the opnsense-version command. Newer versions of OPNsense no longer
   # store the version information in this file, so both versions have to be
   # supported here for now.
-  cmd 'opnsense-version 2>/dev/null || echo "OPNsense "`cat /usr/local/opnsense/version/opnsense`' do |version|
+  cmd 'opnsense-version || echo "OPNsense "`cat /usr/local/opnsense/version/opnsense`' do |version|
     xmlcomment version
   end
 
+  metadata :bottom do
+    xmlcomment interpolate_string(
+      vars("metadata_bottom") ||
+      vars("metadata_top") ||
+      Oxidized::Model::METADATA_DEFAULT
+    )
+  end
+
   cfg :ssh do
     exec true
     pre_logout 'exit'