oxidized 0.25.1 → 0.26.0

data/.travis.yml

@@ -2,10 +2,9 @@ language: ruby
 sudo: false
 cache: bundler
 before_install:
-  - gem install bundler
+    - gem install bundler
 rvm:
-  - 2.1
-  - 2.2
   - 2.3
   - 2.4
   - 2.5
+  - 2.6

data/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 ## Master
 
+## 0.26.0
+
+* FEATURE: add Cisco VPN3000 model (@baznikin)
+* FEATURE: add NetGear PROSafe Smart switches model (@baznikin)
+* FEATURE: Added possibility to pass root logs directory as environment variable (@Glorf)
+* FEATURE: add OneAccess TDRE (1645) model (@starrsl)
+* FEATURE: add Audiocodes MediaPack MP-1xx and Mediant 1000 model (@pedjaj)
+* FEATURE: add raisecom RAX model (@vitalisator)
+* FEATURE: add huawei smartax model (@nyash)
+* FEATURE: add grandstream model
+* MISC: prompt updates in siklu, netonix, netscaler models
+* MISC: minimal supported ruby is now 2.3, net-ssh dependency ~> 5, rubocop ~> 0.65.0
+* FIX: in git comparison we might mistakenly always detect change due to !utf8 vs. utf8 encoding of a char
+
 ## 0.25.0
 
 * FEATURE: add viptela model (@bobthebutcher)

data/Dockerfile

@@ -3,8 +3,10 @@ FROM phusion/baseimage:0.11
 LABEL maintainer="Samer Abdel-Hafez <sam@arahant.net>"
 
 # set up dependencies for the build process
-RUN apt-get -yq update && \
-    apt-get -yq install ruby2.5 ruby2.5-dev libssl1.1 libssl-dev pkg-config make cmake libssh2-1 libssh2-1-dev git g++ libffi-dev ruby-bundler libicu60 libicu-dev libsqlite3-0 libsqlite3-dev libmysqlclient20 libmysqlclient-dev
+RUN apt-get -yq update \
+    && apt-get -yq --no-install-recommends install ruby2.5 ruby2.5-dev libssl1.1 libssl-dev pkg-config make cmake libssh2-1 libssh2-1-dev git g++ libffi-dev ruby-bundler libicu60 libicu-dev libsqlite3-0 libsqlite3-dev libmysqlclient20 libmysqlclient-dev \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
 
 # dependencies for hooks
 RUN gem install aws-sdk slack-api xmpp4r cisco_spark --no-ri --no-rdoc
@@ -29,9 +31,9 @@ RUN rm -rf /tmp/oxidized
 RUN apt-get -yq --purge autoremove ruby-dev pkg-config make cmake ruby-bundler libssl-dev libssh2-1-dev libicu-dev libsqlite3-dev libmysqlclient-dev
 
 # add runit services
-ADD extra/oxidized.runit /etc/service/oxidized/run
-ADD extra/auto-reload-config.runit /etc/service/auto-reload-config/run
-ADD extra/update-ca-certificates.runit /etc/service/update-ca-certificates/run
+COPY extra/oxidized.runit /etc/service/oxidized/run
+COPY extra/auto-reload-config.runit /etc/service/auto-reload-config/run
+COPY extra/update-ca-certificates.runit /etc/service/update-ca-certificates/run
 
 VOLUME ["/root/.config/oxidized"]
 EXPOSE 8888/tcp

data/README.md

@@ -37,7 +37,7 @@ Check out the [Oxidized TREX 2014 presentation](http://youtu.be/kBQ_CTUuqeU#t=3h
     * [FreeBSD](#freebsd)
     * [Build from Git](#build-from-git)
     * [Docker](#running-with-docker)
-    * [Installing Ruby 2.1.2 using RVM](#installing-ruby-212-using-rvm)
+    * [Installing Ruby 2.3 using RVM](#installing-ruby-23-using-rvm)
 3. [Initial Configuration](#configuration)
 4. [Configuration](docs/Configuration.md)
     * [Debugging](docs/Configuration.md#debugging)
@@ -86,7 +86,7 @@ add-apt-repository universe
 Install the dependencies:
 
 ```shell
-apt-get install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev
+apt-get install ruby ruby-dev libsqlite3-dev libssl-dev pkg-config cmake libssh2-1-dev libicu-dev zlib1g-dev g++
 ```
 
 Finally, install the gems:
@@ -98,21 +98,25 @@ gem install oxidized-script oxidized-web # If you don't install oxidized-web, en
 
 ### CentOS, Oracle Linux, Red Hat Linux
 
-On CentOS 6 / RHEL 6, begin by installing Ruby 2.0 or greater. For Ruby 2.1.2 installation instructions see [Installing Ruby 2.1.2 using RVM](#installing-ruby-212-using-rvm).
+On CentOS 6 and 7 / RHEL 6 and 7, begin by installing Ruby 2.3 or greater. This can be accomplished in one of two ways:
 
-If you've installed Ruby 2.0 or greater via a 3rd party package rather than the RVM instructions, additional dependencies will be required:
+Install Ruby 2.3 from [SCL](https://www.softwarecollections.org/en/scls/rhscl/rh-ruby23/):
 
 ```shell
-yum install make cmake which sqlite-devel openssl-devel libssh2-devel ruby gcc ruby-devel libicu-devel gcc-c++
+yum install centos-release-scl
+yum install rh-ruby23
+scl enable rh-ruby23 bash
 ```
 
-RHEL 7 / CentOS 7 will work out of the box with the following package list:
+The following additional packages will be required to build the dependencies:
 
 ```shell
 yum install make cmake which sqlite-devel openssl-devel libssh2-devel ruby gcc ruby-devel libicu-devel gcc-c++
 ```
 
-Now let's install oxidized via Rubygems:
+Alternatively, install Ruby 2.3 by following the instructions at [Installing Ruby 2.3 using RVM](#installing-ruby-23-using-rvm).
+
+Finally, install oxidized via Rubygems:
 
 ```shell
 gem install oxidized
@@ -121,7 +125,7 @@ gem install oxidized-script oxidized-web # if you don't install oxidized-web, ma
 
 ### FreeBSD
 
-[Use RVM to install Ruby v2.1.2](#installing-ruby-212-using-rvm), then install all required packages and gems:
+[Use RVM to install Ruby v2.3](#installing-ruby-23-using-rvm), then install all required packages and gems:
 
 ```shell
 pkg install cmake pkgconf
@@ -225,9 +229,9 @@ If you need to use an internal CA (e.g. to connect to an private github instance
 docker run -v /etc/oxidized:/root/.config/oxidized -v /path/to/MY-CA.crt:/usr/local/share/ca-certificates/MY-CA.crt -p 8888:8888/tcp -e UPDATE_CA_CERTIFICATES=true -t oxidized/oxidized:latest
 ```
 
-### Installing Ruby 2.1.2 using RVM
+### Installing Ruby 2.3 using RVM
 
-Install Ruby 2.1.2 build dependencies
+Install Ruby 2.3 build dependencies
 
 ```shell
 yum install curl gcc-c++ patch readline readline-devel zlib zlib-devel
@@ -241,12 +245,12 @@ Install RVM
 curl -L get.rvm.io | bash -s stable
 ```
 
-Setup RVM environment and compile and install Ruby 2.1.2 and set it as default
+Setup RVM environment and compile and install Ruby 2.3 and set it as default
 
 ```shell
 source /etc/profile.d/rvm.sh
-rvm install 2.1.2
-rvm use --default 2.1.2
+rvm install 2.3
+rvm use --default 2.3
 ```
 
 ## Configuration
@@ -286,7 +290,7 @@ Oxidized supports [CSV](docs/Configuration.md#source-csv),  [SQLite](docs/Config
 
 Possible outputs are either [File](docs/Configuration.md#output-file), [GIT](docs/Configuration.md#output-git), [GIT-Crypt](docs/Configuration.md#output-git-crypt) and [HTTP](docs/Configuration.md#output-http). The file backend takes a destination directory as argument and will keep a file per device, with most recent running version of a device. The GIT backend (recommended) will initialize an empty GIT repository in the specified path and create a new commit on every configuration change. The GIT-Crypt backend will also initialize a GIT repository but every configuration push to it will be encrypted on the fly by using `git-crypt` tool. Take a look at the [Configuration](docs/Configuration.md) for more details.
 
-Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog`(requires Ruby >= 2.0) is set to `true`.
+Maps define how to map a model's fields to model [model fields](https://github.com/ytti/oxidized/tree/master/lib/oxidized/model). Most of the settings should be self explanatory, log is ignored if `use_syslog` is set to `true`.
 
 First create the directory where the CSV `output` is going to store device configs and start Oxidized once.
 

data/Rakefile

@@ -32,7 +32,7 @@ task :test do
   end
 end
 
-task :build => :version_set
+task build: :version_set
 task :version_set do
   Oxidized.version_set
   Bundler::GemHelper.instance.gemspec.version = Oxidized::VERSION
@@ -54,7 +54,7 @@ task :tag do
 end
 
 desc 'Push to rubygems'
-task :push => :tag do
+task push: :tag do
   system "gem push pkg/#{file}"
 end
 

data/bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-lib = File.expand_path('../../lib', __FILE__)
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'oxidized'

data/bin/oxidized

@@ -6,8 +6,8 @@ trap("INT") { exit } # sinatra will otherwise steal this from us
 begin
   require_relative '../lib/oxidized/cli'
   Oxidized::CLI.new.run
-rescue => error
-  warn "#{error}"
+rescue StandardError => error
+  warn error.to_s
   debug = Oxidized.config.debug rescue true
   raise if debug
 end

data/docs/Configuration.md

@@ -262,3 +262,9 @@ Names can instead be passed verbatim to the input:
 ```yaml
 resolve_dns: false
 ```
+
+## Environment variables
+
+You can use some environment variables to change default root directories values.
+* `OXIDIZED_HOME` may be used to set oxidized configuration directory, which defaults to `~/.config/oxidized`
+* `OXIDIZED_LOGS` may be used to set oxidzied logs and crash directories root, which default to `~/.config/oxidized`

data/docs/Model-Notes/README.md

@@ -12,6 +12,7 @@ Arbor Networks|[ArbOS](ArbOS.md)|27 Feb 2018
 Arista|[EOS](EOS.md)|05 Feb 2018
 Cumulus|[Cumulus](Cumulus.md)|11 Jun 2018
 Huawei|[VRP](VRP-Huawei.md)|17 Nov 2017
+Huawei|[SmartAX series](SmartAX-Huawei.md)|21 Jan 2019
 Juniper|[MX/QFX/EX/SRX/J Series](JunOS.md)|18 Jan 2018
 Netgear|[Netgear](Netgear.md)|11 Apr 2018
 Nokia|[Nokia ISAM](Nokia.md)|22 Aug 2018

data/docs/Model-Notes/SmartAX-Huawei.md

@@ -0,0 +1,35 @@
+# Huawei SmartAX GPON/EPON/DOCSIS network access devices
+
+It is necessary to disable SSH keepalives in Oxidized for configuration retrieval via SSH to work properly.
+
+To disable SSH keepalives globally edit the config's vars section and add:
+
+```yaml
+vars:
+  ssh_no_keepalive: true
+```
+
+To disable SSH keepalives per device edit the config's source section and map ssh_no_keepalive to a column inside router.db file.
+
+```yaml
+source:
+  default: csv
+  csv:
+    file: ~/.config/oxidized/router.db
+    delimiter: !ruby/regexp /:/
+    map:
+      name: 0
+      model: 1
+      username: 2
+      password: 3
+    vars_map:
+      ssh_no_keepalive: 4
+```
+
+```text
+# router.db
+10.0.0.1:smartax:someusername:somepassword:true
+10.0.0.2:ios:someusername:somepassword:false
+```
+
+Back to [Model-Notes](README.md)

data/docs/Supported-OS-Types.md

@@ -16,6 +16,7 @@
   * Wireless
 * Allied Telesis
   * [Alliedware Plus](/lib/oxidized/model/awplus.rb)
+  * [AT-8000S, AT-8000GS series](/lib/oxidized/model/powerconnect.rb)
 * Alvarion
   * [BreezeACCESS](/lib/oxidized/model/alvarion.rb)
 * APC
@@ -30,6 +31,7 @@
   * [AOSW](/lib/oxidized/model/aosw.rb)
 * AudioCodes
   * [AudioCodes](/lib/oxdized/model/audiocodes.rb)
+  * [MediaPack MP-1xx, Mediant1000](/lib/oxdized/model/audiocodesmp.rb)
 * Avaya
   * [VOSS (VSP Operating System Software)](/lib/oxidized/model/voss.rb)
   * [BOSS (Baystack Operating System Software)](/lib/oxidized/model/boss.rb)
@@ -61,6 +63,7 @@
   * [SMA](/lib/oxidized/model/ciscosma.rb)
   * [SMB (Nikola series)](/lib/oxidized/model/ciscosmb.rb)
   * [UCS](/lib/oxidized/model/ucs.rb)
+  * [VPN3000](/lib/oxidized/model/ciscovpn3k.rb)
 * Citrix
   * [NetScaler (Virtual Applicance)](/lib/oxidized/model/netscaler.rb)
 * Coriant (former Tellabs)
@@ -109,6 +112,8 @@
   * [PRIMERGY Blade switch 1/10Gbe](/lib/oxidized/model/fujitsupy.rb)
 * GCOM Technologies
   * [Broadband Network Platform Software](/lib/oxidized/model/gcombnps.rb)
+* Grandstream Networks
+  * [GSX](/lib/oxidized/model/grandstream.rb)
 * Hatteras
   * [Hatteras](/lib/oxidized/model/hatteras.rb)
 * Hillstone Networks
@@ -122,6 +127,7 @@
   * [MSA](/lib/oxidized/model/hpemsa.rb)
 * Huawei
   * [VRP](/lib/oxidized/model/vrp.rb)
+  * [SmartAX series](/lib/oxidized/model/smartax.rb)
 * Juniper
   * [JunOS](/lib/oxidized/model/junos.rb)
   * [ScreenOS (Netscreen)](/lib/oxidized/model/screenos.rb)
@@ -137,12 +143,14 @@
   * [FiberDriver](/lib/oxidized/model/fiberdriver.rb)
 * Netgear
   * [Netgear](/lib/oxidized/model/netgear.rb)
+  * [Netgear PROSafe Smart switches](/lib/oxidized/model/netgearxs716.rb)
 * Netonix
   * [WISP Switch (As Netonix)](/lib/oxidized/model/netonix.rb)
 * Nokia (formerly TiMetra, Alcatel, Alcatel-Lucent)
   * [SR OS (TiMOS)](/lib/oxidized/model/sros.rb)
 * OneAccess
   * [OneOS](/lib/oxidized/model/oneos.rb)
+  * [TDRE](/lib/oxidized/model/tdre.rb)
 * [OpenBSD](/lib/oxidized/model/openbsd.rb)
 * Opengear
   * [Opengear](/lib/oxidized/model/opengear.rb)
@@ -154,6 +162,8 @@
 * [pfSense](/lib/oxidized/model/pfsense.rb)
 * Radware
   * [AlteonOS](/lib/oxidized/model/alteonos.rb)
+* Raisecom
+  * [Raisecom](/lib/oxidized/model/raisecom.rb)
 * Quanta
   * [Quanta / VxWorks 6.6 (1.1.0.8)](/lib/oxidized/model/quantaos.rb)
 * Siklu
@@ -171,6 +181,8 @@
   * [Trango](/lib/oxidized/model/trango.rb)
 * TPLink
   * [TPLink](/lib/oxidized/model/tplink.rb)
+  * [TL-SL5428](/lib/oxidized/model/edgecos.rb)
+  * [TL-SL3428](/lib/oxidized/model/powerconnect.rb)
 * Ubiquiti
   * [AirOS](/lib/oxidized/model/airos.rb)
   * [Edgeos](/lib/oxidized/model/edgeos.rb)

data/extra/nagios_check_failing_nodes.rb

@@ -10,7 +10,7 @@ pending = false
 critical_nodes = []
 pending_nodes = []
 
-json = JSON.load(open("http://localhost:8888/nodes.json"))
+json = JSON.parse(open("http://localhost:8888/nodes.json"))
 json.each do |node|
   if not node['last'].nil?
     if node['last']['status'] != 'success'

data/extra/rest_client.rb

@@ -9,36 +9,34 @@ module Oxidized
       Root = Root = ENV['OXIDIZED_HOME'] || File.join(ENV['HOME'], '.config', 'oxidized')
     end
 
-    CFGS = Asetus.new :name => 'oxidized', :load => false, :key_to_s => true
+    CFGS = Asetus.new name: 'oxidized', load: false, key_to_s: true
     CFGS.default.rest = '127.0.0.1:8888'
 
     begin
       CFGS.load
-    rescue => error
+    rescue StandardError => error
       raise InvalidConfig, "Error loading config: #{error.message}"
     end
 
     restcfg = CFGS.cfg.rest
-    unless restcfg.match(/^http:\/\//)
-      restcfg.insert(0, 'http://')
-    end
+    restcfg.insert(0, 'http://') unless restcfg =~ /^http:\/\//
 
     HOST = URI(restcfg).host
     PORT = URI(restcfg).port
     PATH = URI(restcfg).path
 
     class << self
-      def next opt = {}, host = HOST, port = PORT
+      def next(opt = {}, host = HOST, port = PORT)
         web = new host, port
         web.next opt
       end
     end
 
-    def initialize host = HOST, port = PORT
+    def initialize(host = HOST, port = PORT)
       @web = Net::HTTP.new host, port
     end
 
-    def next opt
+    def next(opt)
       data = JSON.dump opt
       @web.put PATH + '/node/next/' + opt[:name].to_s, data
     end

data/extra/syslog.rb

@@ -32,14 +32,14 @@ module Oxidized
     Root = File.join ENV['HOME'], '.config', 'oxidized'
   end
 
-  CFGS = Asetus.new :name => 'oxidized', :load => false, :key_to_s => true
+  CFGS = Asetus.new name: 'oxidized', load: false, key_to_s: true
   CFGS.default.syslogd.port        = 514
   CFGS.default.syslogd.file        = 'messages'
   CFGS.default.syslogd.resolve     = true
 
   begin
     CFGS.load
-  rescue => error
+  rescue StandardError => error
     raise InvalidConfig, "Error loading config: #{error.message}"
   ensure
     CFG = CFGS.cfg # convenienence, instead of Config.cfg.password, CFG.password
@@ -48,24 +48,24 @@ module Oxidized
   class SyslogMonitor
     NAME_MAP = {
       /(.*)\.ip\.tdc\.net/ => '\1',
-      /(.*)\.ip\.fi/       => '\1',
-    }
+      /(.*)\.ip\.fi/       => '\1'
+    }.freeze
     MSG = {
-      :ios   => /%SYS-(SW[0-9]+-)?5-CONFIG_I:/,
-      :junos => 'UI_COMMIT:',
-      :eos   => /%SYS-5-CONFIG_I:/,
-      :nxos  => /%VSHD-5-VSHD_SYSLOG_CONFIG_I:/,
-    }
+      ios:   /%SYS-(SW[0-9]+-)?5-CONFIG_I:/,
+      junos: 'UI_COMMIT:',
+      eos:   /%SYS-5-CONFIG_I:/,
+      nxos:  /%VSHD-5-VSHD_SYSLOG_CONFIG_I:/
+    }.freeze
 
     class << self
-      def udp port = Oxidized::CFG.syslogd.port, listen = 0
+      def udp(port = Oxidized::CFG.syslogd.port, listen = 0)
         io = UDPSocket.new
         io.bind listen, port
         new io, :udp
       end
 
-      def file syslog_file = Oxidized::CFG.syslogd.file
-        io = open syslog_file, 'r'
+      def file(syslog_file = Oxidized::CFG.syslogd.file)
+        io = File.open syslog_file, 'r'
         io.seek 0, IO::SEEK_END
         new io, :file
       end
@@ -73,43 +73,43 @@ module Oxidized
 
     private
 
-    def initialize io, mode = :udp
+    def initialize(io, mode = :udp)
       @mode = mode
       run io
     end
 
-    def rest opt
+    def rest(opt)
       Oxidized::RestClient.next opt
     end
 
-    def ios ip, log, i
+    def ios(ipaddr, log, index)
       # TODO: we need to fetch 'ip/name' in mode == :file here
-      user = log[i + 5]
+      user = log[index + 5]
       from = log[-1][1..-2]
-      rest(:user => user, :from => from, :model => 'ios', :ip => ip,
-           :name => getname(ip))
+      rest(user: user, from: from, model: 'ios', ip: ipaddr,
+           name: getname(ipaddr))
     end
 
-    def jnpr ip, log, i
+    def jnpr(ipaddr, log, index)
       # TODO: we need to fetch 'ip/name' in mode == :file here
-      user = log[i + 2][1..-2]
-      msg  = log[(i + 6)..-1].join(' ')[10..-2]
+      user = log[index + 2][1..-2]
+      msg  = log[(index + 6)..-1].join(' ')[10..-2]
       msg  = nil if msg == 'none'
-      rest(:user => user, :msg => msg, :model => 'jnpr', :ip => ip,
-           :name => getname(ip))
+      rest(user: user, msg: msg, model: 'jnpr', ip: ipaddr,
+           name: getname(ipaddr))
     end
 
-    def handle_log log, ip
+    def handle_log(log, ipaddr)
       log = log.to_s.split ' '
-      if i = log.find_index { |e| e.match(MSG[:ios]) }
-        ios ip, log,  i
-      elsif i = log.index(MSG[:junos])
-        jnpr ip, log, i
+      if (i = log.find_index { |e| e.match(MSG[:ios]) })
+        ios ipaddr, log,  i
+      elsif (i = log.index(MSG[:junos]))
+        jnpr ipaddr, log, i
       end
     end
 
-    def run io
-      while true
+    def run(io)
+      loop do
         log = select [io]
         log, ip = log.first.first, nil
         if @mode == :udp
@@ -127,11 +127,11 @@ module Oxidized
       end
     end
 
-    def getname ip
+    def getname(ipaddr)
       if Oxidized::CFG.syslogd.resolve == false
-        ip
+        ipddr
       else
-        name = (Resolv.getname ip.to_s rescue ip)
+        name = (Resolv.getname ipaddr.to_s rescue ipadr)
         NAME_MAP.each { |re, sub| name.sub! re, sub }
         name
       end