oxidized 0.29.1 → 0.37.0

data/lib/oxidized/model/dslsetup.rb

@@ -0,0 +1,102 @@
+module Oxidized
+  class Model
+    # Domain Specific Language for model setup
+    module DSLSetup
+      def prompt(regex = nil)
+        @prompt = regex || @prompt
+      end
+
+      def comment(str = "# ")
+        @comment = if block_given?
+                     yield
+                   elsif not @comment
+                     str
+                   else
+                     @comment
+                   end
+      end
+
+      def expect(regex, **args, &block)
+        process_args_block(@expect, args, [regex, block])
+      end
+
+      def expects
+        @expect
+      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
+
+      # Define multiple inputs as a sequence of equivalent options
+      # Example: use ssh or telnet, then scp or ftp:
+      # [:ssh, [:scp, :ftp]]
+      def inputs(list = nil)
+        return @inputs if list.nil?
+
+        validate_inputs(list)
+        @inputs = list
+      end
+
+      # Returns the input sequence for the model as an array of arrays of input
+      # classes, filtered and ordered according to the provided +input_classes+
+      # (as specified in the oxidized configuration file).
+      def input_sequence(input_classes)
+        model_inputs = inputs || [
+          @cfg.filter_map do |input, block_list|
+            input.to_sym unless block_list.empty?
+          end
+        ]
+
+        model_inputs.map do |sequence|
+          sequence = [sequence] unless sequence.is_a? Array
+          selected = input_classes.select { |input| sequence.include?(input.to_sym) }
+          logger.error "Needs one of #{sequence.inspect} to be configured" if selected.empty?
+
+          selected
+        end
+      end
+
+      def metadata(position, value = nil, &block)
+        return unless %i[top bottom].include? position
+
+        if block_given?
+          @metadata[position] = block
+        else
+          @metadata[position] = value
+        end
+      end
+
+      private
+
+      def validate_inputs(list)
+        message = "inputs must be an array containing symbols or " \
+                  "arrays of symbols"
+
+        raise ArgumentError, message unless list.is_a? Array
+        raise ArgumentError, message if list.empty?
+
+        list.each do |group|
+          case group
+          when Symbol
+            # Everything is fine
+          when Array
+            raise ArgumentError, message if group.empty?
+
+            group.each do |input|
+              raise ArgumentError, message unless input.is_a? Symbol
+            end
+          else
+            raise ArgumentError, message
+          end
+        end
+      end
+    end
+  end
+end

data/lib/oxidized/model/eatonnetwork.rb

@@ -0,0 +1,70 @@
+class EatonNetwork < Oxidized::Model
+  using Refinements
+  # Eaton Gigabit Network Card M3
+
+  # -p option is a passphrase used to encrypted parts of the config data, the
+  # encrypted data is nondeterministic and changes with each run. Use auth
+  # password as the passphrase.
+  #
+  # See docs/Model-Notes/EatonNetwork.md for more info
+  post do
+    # Get config in post to allow passing auth password to cmd.
+    cfg = cmd "save_configuration -p #{@node.auth[:password]}"
+    cfg
+  end
+
+  cmd :all do |cfg|
+    # `save_configuration` echos the command back, outputs date time info, with
+    # last line is the prompt again.
+    json_str = cfg.each_line.select { |line| line.match /^\{/ }.join
+    json = JSON.parse(json_str)
+
+    json['features']['userAndSessionManagement']['data']['settings']['all']['1.0']['local']['1.0']['predefinedAccounts'].each do |n|
+      n.delete('attemptLogin')
+      n['password'].delete('history')
+    end
+    json['features']['userAndSessionManagement']['data']['settings']['all']['1.0']['local']['1.0']['createdAccounts'].each do |n|
+      n.delete('attemptLogin')
+      n['password'].delete('history')
+    end
+
+    cfg = JSON.pretty_generate(json)
+    cfg
+  end
+
+  cmd :secret do |cfg|
+    # Re-parse json to remove secrets by json path
+    json = JSON.parse(cfg)
+
+    json.delete('passphrase')
+    json['features']['rms']['data']['settings'].delete('proxyUsername')
+    json['features']['rms']['data']['settings'].delete('proxyPassword')
+    json['features']['rms']['data']['settings'].delete('username')
+    json['features']['rms']['data']['settings'].delete('password')
+    json['features']['rms']['data']['settings'].delete('defaultPassword')
+
+    json['features']['smtp']['data']['dmeData'].delete('password')
+
+    json['features']['snmp']['data']['dmeData']['v3']['users'].each do |n|
+      n['auth'].delete('password')
+      n['priv'].delete('password')
+    end
+
+    json['features']['userAndSessionManagement']['data']['settings']['all']['1.0']['ldap']['1.0']['settings']['connectivity']['bind'].delete('password')
+    json['features']['userAndSessionManagement']['data']['settings']['all']['1.0']['radius']['1.0']['settings']['connectivity']['primaryServer'].delete('secret')
+    json['features']['userAndSessionManagement']['data']['settings']['all']['1.0']['radius']['1.0']['settings']['connectivity']['secondaryServer'].delete('secret')
+
+    # Added in frimware v2.2.0
+    json['features']['peripherals']['data']['dmeData']['ethernet']['ports'].each do |n|
+      n.dig('dot1x', 'peap', 'password') && n['dot1x']['peap'].delete('password')
+    end
+
+    cfg = JSON.pretty_generate(json)
+    cfg
+  end
+
+  cfg :ssh do
+    exec true
+    pre_logout 'logout'
+  end
+end

data/lib/oxidized/model/edgecos.rb

@@ -31,7 +31,9 @@ class EdgeCOS < Oxidized::Model
 
   cmd 'show system' do |cfg|
     cfg.gsub! /^.*\sUp Time\s*:.*\n/i, ''
-    cfg.gsub! /^(.*\sTemperature \d*:).*\n/i, '\\1 <removed>'
+    cfg.gsub! /(\sTemperature \d*:)\s*\d+ degrees/, '\\1 <temperature values hidden>'
+    cfg.gsub! /^!?\s*Fan \d+ speed:\s+\d+ rpm\s+Fan \d+ speed:\s+\d+ rpm\s+Fan \d+ speed:\s+\d+ rpm$/,
+              '<fan speeds hidden>'
     comment cfg
   end
 

data/lib/oxidized/model/edgeos.rb

@@ -1,7 +1,7 @@
 class Edgeos < Oxidized::Model
   using Refinements
 
-  # EdgeOS #
+  # Ubiquiti EdgeOS #
 
   prompt /@.*?:~\$\s/
 
@@ -10,11 +10,12 @@ class Edgeos < Oxidized::Model
   end
 
   cmd :secret do |cfg|
-    cfg.gsub! /encrypted-password (\S+).*/, 'encrypted-password <secret removed>'
-    cfg.gsub! /plaintext-password (\S+).*/, 'plaintext-password <secret removed>'
-    cfg.gsub! /password (\S+).*/, 'password <secret removed>'
-    cfg.gsub! /pre-shared-secret (\S+).*/, 'pre-shared-secret <secret removed>'
-    cfg.gsub! /community (\S+) {/, 'community <hidden> {'
+    cfg.gsub!(/(encrypted-password) \S+/, '\1 <secret removed>')
+    cfg.gsub!(/(plaintext-password) \S+/, '\1 <secret removed>')
+    cfg.gsub!(/(password) \S+/, '\1 <secret removed>')
+    cfg.gsub!(/(pre-shared-secret) \S+/, '\1 <secret removed>')
+    cfg.gsub!(/(community) \S+ {/, '\1 <hidden> {')
+    cfg.gsub!(/(commit-archive location) \S+/, '\1 <secret removed>')
     cfg
   end
 

data/lib/oxidized/model/edgeswitch.rb

@@ -8,7 +8,9 @@ class EdgeSwitch < Oxidized::Model
   prompt /\(.*\)\s[#>]/
 
   cmd 'show running-config' do |cfg|
-    cfg.each_line.to_a[2..-2].reject { |line| line.match(/System Up Time.*/) || line.match(/Current SNTP Synchronized Time.*/) }.join
+    cfg.each_line.to_a[2..-2].reject do |line|
+      line.match(/System Up Time.*/) || line.match(/Current SNTP Synchronized Time.*/)
+    end.join
   end
 
   cfg :telnet do

data/lib/oxidized/model/efos.rb

@@ -0,0 +1,41 @@
+class EFOS < Oxidized::Model
+  using Refinements
+
+  # Enhanced Fabric OS - Broadcom
+  comment '! '
+  prompt /^([\w.@()-]+[#>]\s?)$/
+
+  cmd :all do |cfg|
+    # Remove the echo of the entered command and the prompt after it
+    cfg.cut_both
+  end
+
+  cmd 'show bootvar' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show fiber-ports optical-transceiver-info all' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg.reject_lines [
+      'System Up Time',
+      'Current System Time:',
+      'Current SNTP Synchronized Time:'
+    ]
+  end
+
+  cfg :telnet, :ssh do
+    post_login do
+      if vars(:enable) == true
+        cmd 'enable'
+      elsif vars(:enable)
+        cmd 'enable', /^[pP]assword:/
+        cmd vars(:enable)
+      end
+    end
+    post_login 'terminal length 0'
+    pre_logout 'logout'
+  end
+end

data/lib/oxidized/model/eltex.rb

@@ -3,7 +3,7 @@ class Eltex < Oxidized::Model
 
   # Tested with MES2324FB Version: 4.0.7.1 Build: 37 (master)
 
-  prompt /^\s?[\w.@\(\)-]+[#>]\s?$/
+  prompt /^\s?[\w.@()-]+[#>]\s?$/
   comment '! '
 
   cmd :all do |cfg|
@@ -16,7 +16,7 @@ class Eltex < Oxidized::Model
     cfg.gsub! /^(enable (password|secret)( level \d+)? \d) .+/, '\\1 <secret hidden>'
     cfg.gsub! /^(\s+(?:password|secret)) (?:\d )?\S+/, '\\1 <secret hidden>'
     cfg.gsub! /^(tacacs-server (.+ )?key) .+/, '\\1 <secret hidden>'
-    cfg.gsub! /^((tacacs|radius) server [^\n]+\n(\s+[^\n]+\n)*\s+key) [^\n]+$/m, '\1 <secret hidden>'
+    cfg.gsub! /^((tacacs|radius) server [^\n]+\n( +[^\n]+\n)*\s+key) [^\n]+$/m, '\1 <secret hidden>'
     cfg.gsub! /username (\S+) privilege (\d+) (\S+).*/, '<secret hidden>'
     cfg.gsub! /^username \S+ password \d \S+/, '<secret hidden>'
     cfg.gsub! /^enable password \d \S+/, '<secret hidden>'
@@ -44,6 +44,8 @@ class Eltex < Oxidized::Model
       end
     end
     post_login 'terminal datadump'
+    # disable cli pagination for MES2424
+    post_login 'set cli pagination off'
     pre_logout 'disable'
     pre_logout 'exit'
   end

data/lib/oxidized/model/enterasys800.rb

@@ -5,7 +5,7 @@ class Enterasys800 < Oxidized::Model
   # Tested with 08H20G4-24 Fast Ethernet Switch Firmware: Build 01.01.01.0017
   comment '# '
 
-  prompt /([\w \(:.@-]+[#>]\s?)$/
+  prompt /([\w (:.@-]+[#>]\s?)$/
 
   cfg :telnet do
     username /UserName:/
@@ -23,7 +23,7 @@ class Enterasys800 < Oxidized::Model
   cmd :all do |cfg|
     cfg = cfg.cut_both
     cfg = cfg.gsub /^[\r\n]|^\s\s\s/, ''
-    cfg = cfg.gsub /Command: show config effective/, ''
+    cfg = cfg.gsub "Command: show config effective", ''
     cfg
   end
 

data/lib/oxidized/model/enterprise_sonic.rb

@@ -0,0 +1,46 @@
+class Enterprise_SONiC < Oxidized::Model # rubocop:disable Naming/ClassAndModuleCamelCase
+  using Refinements
+
+  # Remove ANSI escape codes
+  expect /\e\[[0-?]*[ -\/]*[@-~]\r?/ do |data, re|
+    data.gsub re, ''
+  end
+
+  # Matches both sonic-cli and linux terminal
+  prompt /^(?:[\w.-]+@[\w.-]+:[~\w\/-]+\$|[\w.-]+#)\s*/
+  comment "# "
+
+  def add_comment(comment)
+    "\n##### #{comment} #####\n"
+  end
+
+  post do
+    cmd 'show running-configuration' do |cfg|
+      add_comment('CONFIGURATION') + cfg
+    end
+  end
+
+  cmd 'show version' do |cfg|
+    cfg = cfg.each_line.reject { |line| line.match /Uptime/ }.join
+    add_comment('VERSION') + cfg
+  end
+
+  cmd 'show platform syseeprom' do |cfg|
+    add_comment('SYSEEPROM') + cfg
+  end
+
+  cmd :all do |cfg|
+    cfg.cut_both
+  end
+
+  cfg :ssh do
+    # if user logs in to linux == has admin rights
+    if vars(:admin) == true
+      post_login do
+        cmd "sonic-cli\n"
+      end
+    end
+    post_login 'terminal length 0'
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/eos.rb

@@ -15,10 +15,12 @@ class EOS < Oxidized::Model
     cfg.gsub! /^(snmp-server community).*/, '\\1 <configuration removed>'
     cfg.gsub! /(secret \w+) (\S+).*/, '\\1 <secret hidden>'
     cfg.gsub! /(password \d+) (\S+).*/, '\\1 <secret hidden>'
-    cfg.gsub! /^(enable secret).*/, '\\1 <configuration removed>'
+    cfg.gsub! /^(enable (?:secret|password)).*/, '\\1 <configuration removed>'
     cfg.gsub! /^(service unsupported-transceiver).*/, '\\1 <license key removed>'
     cfg.gsub! /^(tacacs-server key \d+).*/, '\\1 <configuration removed>'
+    cfg.gsub! /^(radius-server .+ key \d) \S+/, '\\1 <radius secret hidden>'
     cfg.gsub! /( {6}key) (\h+ 7) (\h+).*/, '\\1 <secret hidden>'
+    cfg.gsub! /(localized|auth (md5|sha\d{0,3})|priv (des|aes\d{0,3})) \S+/, '\\1 <secret hidden>'
     cfg
   end
 

data/lib/oxidized/model/exalink.rb

@@ -0,0 +1,36 @@
+class Exalink < Oxidized::Model
+  using Refinements
+
+  prompt /^([\w.@()-]+[#>]\s?)$/
+  comment '! '
+
+  cmd :all do |cfg|
+    cfg.gsub! /\r\n?/, "\n"
+    cfg.cut_both
+  end
+
+  cmd 'show version' do |cfg|
+    comment cfg.reject_lines /uptime/i
+  end
+
+  cmd 'show port' do |cfg|
+    comment cfg
+  end
+
+  cmd 'show running-config' do |cfg|
+    cfg.gsub! /^(show run.*)$/, '! \1'
+    cfg.gsub! /^!Time:[^\n]*\n/, ''
+    cfg
+  end
+
+  cfg :telnet do
+    username /^login:/
+    password /^Password:/
+  end
+
+  cfg :ssh, :telnet do
+    post_login 'terminal length 0'
+    post_login 'terminal width 0'
+    pre_logout 'logout'
+  end
+end

data/lib/oxidized/model/f5os.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class F5OS < Oxidized::Model
+  # F5OS Model #
+
+  comment '!'
+  prompt(/^([\w.@()-]+ ?[#>]\s+)$/)
+
+  cmd 'show running-config'
+
+  cfg :ssh do
+    post_login do
+      cmd 'paginate false'
+    end
+    pre_logout 'exit'
+  end
+end

data/lib/oxidized/model/fabricos.rb

@@ -4,11 +4,11 @@ class FabricOS < Oxidized::Model
   # Brocade Fabric OS model #
   ## FIXME: Only ssh exec mode support, no telnet, no ssh screenscraping
 
-  prompt /^([\w]+:+[\w]+[>]\s)$/
+  prompt /^(\w+:+\w+>\s)$/
   comment '# '
 
   cmd 'chassisShow' do |cfg|
-    comment cfg.each_line.reject { |line| line.match(/Time Awake:/) || line.match(/Power Usage \(Watts\):/) || line.match(/Power Usage:/) || line.match(/Time Alive:/) || line.match(/Update:/) }.join
+    comment cfg.each_line.reject { |line| line.match(/Time Awake:/) || line.match(/Power Usage \(Watts\):/) || line.match(/Power Usage:/) || line.match(/Time Alive:/) || line.match(/Update:/) || line.match(/PS Voltage input:/) }.join
   end
 
   cmd 'configShow -all' do |cfg|

data/lib/oxidized/model/fastiron.rb

@@ -1,7 +1,7 @@
 class FastIron < Oxidized::Model
   using Refinements
 
-  prompt /^([\w.@()-]+[#>]\s?)$/
+  prompt /^([\w.@\/()-]+[#>]\s?)$/
   comment  '! '
 
   cmd :all do |cfg|
@@ -19,7 +19,9 @@ class FastIron < Oxidized::Model
     lines.each_with_index do |line, _i|
       comments << "Version: #{Regexp.last_match(1)}" if line =~ /^\s+SW: Version (.*)$/
 
-      comments << "Boot-Monitor Version: #{Regexp.last_match(1)}" if line =~ /^\s+Compressed Boot-Monitor Image size = \d+, Version:(.*)$/
+      if line =~ /^\s+Compressed Boot-Monitor Image size = \d+, Version:(.*)$/
+        comments << "Boot-Monitor Version: #{Regexp.last_match(1)}"
+      end
 
       comments << "Serial: #{Regexp.last_match(1)}" if line =~ /^\s+Serial  #:(.*)$/
     end
@@ -41,7 +43,7 @@ class FastIron < Oxidized::Model
     comment cfg
   end
 
-  cmd 'show stack' do |cfg|
+  cmd 'show stack | exclude T=' do |cfg|
     comment cfg
   end
 

data/lib/oxidized/model/firebrick.rb

@@ -10,8 +10,8 @@ class Firebrick < Oxidized::Model
   end
 
   cmd 'show status' do |cfg|
-    cfg.gsub! /Status/, ''
-    cfg.gsub! /------/, ''
+    cfg.gsub! "Status", ''
+    cfg.gsub! "------", ''
     cfg.gsub! /Uptime.*/, ''
     cfg.gsub! /Current time.*/, ''
     cfg.gsub! /RAM.*/, ''

data/lib/oxidized/model/firelinuxos.rb

@@ -3,12 +3,21 @@ class FireLinuxOS < Oxidized::Model
 
   # Fire Linux OS is what the new FTD (FirePOWER) series devices from Cisco run. At the backend, it's mostly identical to ASA's.
 
-  prompt /^[#>]\(?.+\)?\s?/
-  comment  '! '
+  prompt /^[#>]\(?.+\)? ?$/
+  comment '! '
+
+  expect /^Syntax error: .*\n.*$/ do |data, re|
+    # The firepower does not remove the entered command, so
+    # Send CTRL-U and \n for a fresh prompt
+    send "\x15\n"
+    data.sub re, ''
+  end
 
   cmd :all do |cfg|
     cfg.gsub! /^% Invalid input detected at '\^' marker\.$|^\s+\^$/, ''
-    cfg.each_line.to_a[1..-2].join
+    # Ged rid of ANSI escape codes
+    cfg.gsub! /\e\[[0-?]*[ -\/]*[@-~]\r?/, ''
+    cfg.cut_both
   end
 
   cmd :secret do |cfg|
@@ -22,9 +31,7 @@ class FireLinuxOS < Oxidized::Model
   end
 
   cmd 'show version system' do |cfg|
-    cfg = cfg.each_line.reject { |line| line.match /(\s+up\s+\d+\s+)|(.*days.*)/ }
-    cfg = cfg.join
-    comment cfg
+    comment cfg.reject_lines [/(\s+up\s+\d+\s+)|(.*days.*)/]
   end
 
   cmd 'show inventory' do |cfg|

data/lib/oxidized/model/firewareos.rb

@@ -1,7 +1,16 @@
 class FirewareOS < Oxidized::Model
   using Refinements
 
-  prompt /^\[?\w*\]?\w*?(<\w*>)?(#|>)\s*$/
+  # matched prompts:
+  # [FAULT]WG<managed-by-wsm><master>>
+  # WG<managed-by-wsm><master>>
+  # WG<managed-by-wsm>>
+  # [FAULT]WG<non-master>>
+  # [FAULT]WG>
+  # WG>
+
+  prompt /^\[?\w*\]?\w*?(?:<[\w-]+>)*(#|>)\s*$/
+
   comment  '-- '
 
   cmd :all do |cfg|