8291_scanner 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c1fbcd809d8e07b1ae613e25b2270a069f2ef2a2ffc58cd7ccfce0c10d689e0
-  data.tar.gz: 8ec55b9d4cb896149c328e6306a17425bff26571b0baab1714cf9d914f1cd583
+  metadata.gz: 3b2c610d2d178592045fa499f7242336739fea9dd064c2fb572f2194b16663e5
+  data.tar.gz: dbf44c21d5b52f8ebc9e10a34848b12daa48ff9884bc8d78060379b978f69bca
 SHA512:
-  metadata.gz: 03f95da14003fb916106e05ec758e601bb9fdc4e20275a98ce763556a3dbd36dee722e3efbe3db8e2363e80a3e7f4a1684d20e98c5ba400d9e97a62f9d4f8e3b
-  data.tar.gz: 5a077557feb4db3443fe5889b896c61b9d9b5bf4541e6930860c4075ac85cefe8ef5bd870c7368f841dff3ca7e195cea20ab924fde3d7ed3c8421a07595c08db
+  metadata.gz: 7fbe53e33e2f281e961b7b1ae80179d3049cc301ba094f2996613e453c42ba0cebb476d58362606710366a637b80ad823ecbd4cf2f8d14561c847481b19846e6
+  data.tar.gz: 5de9242e4d98f4d01c2cb3967e76cc04fa2a287d6db4e6ae05169b9ec5296f2fa70cac8bbc67f8633b85465fb38d8fc33b3a541098afc28c159c3d25d8bc65c0

data/bin/8291_scanner

@@ -4,12 +4,12 @@
 
 require '8291_scanner/winbox_connection'
 
-if ARGV.length < 1
+if ARGV.empty?
   puts 'Too few arguments.'
   puts 'Usage: 8291_scanner host [port]'
   exit!
 elsif ARGV.length > 2
-  puts "Too much arguments."
+  puts 'Too much arguments.'
   puts 'Usage: 8291_scanner host [port]'
   exit!
 end
@@ -17,6 +17,6 @@ end
 host = ARGV[0]
 port = ARGV[1]&.to_i
 
-connection = (port ? WinboxConnection.new(host, port) : WinboxConnection.new(host))
+connection = (port ? WinboxAPIScanner::WinboxConnection.new(host, port) : WinboxAPIScanner::WinboxConnection.new(host))
 
-puts connection.get_version
+puts connection.request_version

data/lib/8291_scanner/errors.rb

@@ -1,17 +1,20 @@
 # frozen_string_literal: true
 # sharable_constant_value: literal
 
-# General Winbox error
-class WinboxError < Exception; end
+# Scanner that connects to the Winbox API of Mikrotik's RouterOS and attempts to read the version of the operating system.
+module WinboxAPIScanner
+  # General Winbox error
+  class WinboxError < StandardError; end
 
-# Error in the connection to the Winbox API
-class WinboxConnectionError < Exception; end
+  # Error in the connection to the Winbox API
+  class WinboxConnectionError < WinboxError; end
 
-# An invalid or unexpected magic number has occurred in the response
-class InvalidMagicNumberError < WinboxError; end
+  # An invalid or unexpected magic number has occurred in the response
+  class InvalidMagicNumberError < WinboxError; end
 
-# A different file was returned than was requested
-class FilenameError < WinboxError; end
+  # A different file was returned than was requested
+  class FilenameError < WinboxError; end
 
-# The list is invalid
-class InvalidListError < WinboxError; end
+  # The list is invalid
+  class InvalidListError < WinboxError; end
+end

data/lib/8291_scanner/winbox_connection.rb

@@ -1,98 +1,98 @@
 # frozen_string_literal: true
 # sharable_constant_value: literal
 
-# Models a connection to the Winbox API with an underlying TCP connection
-class WinboxConnection
-
-  # Reference implementation: https://github.com/tenable/routeros/tree/master/8291_scanner
-
-  require 'socket'
-  require 'psych'
-  require_relative 'errors'
-
-  # Initializes a Winbox API connection
-  #
-  # @param host [String] 
-  # @param port [Integer]
-  def initialize(host, port = 8291)
-    raise ArgumentError, 'Host must be a string' unless host.is_a? String
-    raise ArgumentError, 'Port must be an integer' unless port.is_a? Integer
-
-    begin
-      @socket = TCPSocket.new(host, port)
-    rescue SocketError, EncodingError, EOFError, IO::TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNRESET => e
-      raise WinboxConnectionError, "Failed to connect to Winbox API: #{e.message}"
+# Scanner that connects to the Winbox API of Mikrotik's RouterOS and attempts to read the version of the operating system.
+module WinboxAPIScanner
+  # Models a connection to the Winbox API with an underlying TCP connection
+  class WinboxConnection
+    # Reference implementation: https://github.com/tenable/routeros/tree/master/8291_scanner
+
+    require 'socket'
+    require 'psych'
+    require_relative 'errors'
+
+    # Initializes a Winbox API connection
+    #
+    # @param host [String]
+    # @param port [Integer]
+    def initialize(host, port = 8291)
+      raise ArgumentError, 'Host must be a string' unless host.is_a? String
+      raise ArgumentError, 'Port must be an integer' unless port.is_a? Integer
+
+      begin
+        @socket = TCPSocket.new(host, port)
+      rescue SocketError, EncodingError, EOFError, IO::TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNRESET => e
+        raise WinboxConnectionError, "Failed to connect to Winbox API: #{e.message}"
+      end
     end
-  end
 
-  # Fetches the first 128 bytes of a file
-  #
-  # @param file [String]
-  # @return [String]
-  def old_mproxy_get_file(file)
-    raise ArgumentError, 'File must be a string' unless file.is_a? String
-    raise ArgumentError, 'Filename too long' if file.length > 12
+    # Fetches the first 128 bytes of a file
+    #
+    # @param file [String]
+    # @return [String]
+    def old_mproxy_get_file(file)
+      raise ArgumentError, 'File must be a string' unless file.is_a? String
+      raise ArgumentError, 'Filename too long' if file.length > 12
 
-    # Prepare the file name
-    file_request = file.ljust(12, "\x00")
+      # Prepare the file name
+      file_request = file.ljust(12, "\x00")
 
-    # Request only the first 128 bytes of the response.
-    file_request += "\x00\x80\x00\x00\x00\x00"
+      # Request only the first 128 bytes of the response.
+      file_request += "\x00\x80\x00\x00\x00\x00"
 
-    # Create and send request
-    request = "#{[file_request.length].pack 'C'}\x02#{file_request}"
-    @socket.send request, 0
-    @socket.flush
+      # Create and send request
+      request = "#{[file_request.length].pack 'C'}\x02#{file_request}"
+      @socket.send request, 0
+      @socket.flush
 
-    # Receive short length and first magic number
-    short_length = @socket.recv(1).unpack('C')[0]
-    magic_number1 = @socket.recv(1)
-    raise InvalidMagicNumberError, "Unknown magic number 1 in answer: #{magic_number1.dump}" unless magic_number1 == "\x02"
+      # Receive short length and first magic number
+      short_length = @socket.recv(1).unpack1('C')
+      magic_number1 = @socket.recv(1)
+      raise InvalidMagicNumberError, "Unknown magic number 1 in answer: #{magic_number1.dump}" unless magic_number1 == "\x02"
 
-    # Receive the name of the file in the response and the second magic number (probably an error code?)
-    name = @socket.recv(11).rstrip
-    magic_number2 = @socket.recv 1
-    raise InvalidMagicNumberError, "Unknown magic number 2 in answer: #{magic_number2.dump}" unless magic_number2 == "\x01"
+      # Receive the name of the file in the response and the second magic number (probably an error code?)
+      name = @socket.recv(11).rstrip
+      magic_number2 = @socket.recv 1
+      raise InvalidMagicNumberError, "Unknown magic number 2 in answer: #{magic_number2.dump}" unless magic_number2 == "\x01"
 
-    raise FilenameError, 'Returned file is not requested file' unless name == file
+      raise FilenameError, 'Returned file is not requested file' unless name == file
 
-    long_length = @socket.recv(2).unpack('n')[0]
+      long_length = @socket.recv(2).unpack1('n')
 
-    magic_number3 = @socket.recv 4
-    raise InvalidMagicNumberError, "Unknown magic number 3 in answer: #{magic_number3.dump}" unless magic_number3 == "\x00\x00\x00\x00"
+      magic_number3 = @socket.recv 4
+      raise InvalidMagicNumberError, "Unknown magic number 3 in answer: #{magic_number3.dump}" unless magic_number3 == "\x00\x00\x00\x00"
 
-    # Use the short length if possible. If the short length has the maximum value, use the long length.
-    length = ( short_length == 255 ? long_length : short_length )
+      # Use the short length if possible. If the short length has the maximum value, use the long length.
+      length = (short_length == 255 ? long_length : short_length)
 
-    # Read the answer
-    buffer = @socket.recv length
+      # Read the answer
+      buffer = @socket.recv length
 
-    # Return the answer
-    return buffer
-  rescue SocketError, EncodingError, EOFError, IO::TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNRESET => e
-    raise WinboxConnectionError, "Failed to connect to Winbox API: #{e.message}"
-  end
+      # Return the answer
+      return buffer
+    rescue SocketError, EncodingError, EOFError, IO::TimeoutError, Errno::EHOSTUNREACH, Errno::ECONNRESET => e
+      raise WinboxConnectionError, "Failed to connect to Winbox API: #{e.message}"
+    end
 
-  # @return [String]
-  def get_version
-    # Receive the first bytes of the list
-    answer = old_mproxy_get_file('list')
+    # @return [String]
+    def request_version
+      # Receive the first bytes of the list
+      answer = old_mproxy_get_file('list')
 
-    # Extract the first file information (formatted as JSON) from the response
-    json_raw = answer[0...answer.index("\n")-1]
+      # Extract the first file information (formatted as JSON) from the response
+      json_raw = answer[0...(answer.index("\n") - 1)]
 
-    raise InvalidListError, 'JSON is empty' if json_raw.empty?
+      raise InvalidListError, 'JSON is empty' if json_raw.empty?
 
-    # Load the JSON
-    first_file = Psych.safe_load json_raw
+      # Load the JSON
+      first_file = Psych.safe_load json_raw
 
-    raise InvalidListError, 'List is not JSON' unless first_file.is_a? Hash
-    raise InvalidListError, 'File does not have a version information' unless first_file['version']
-    
-    version = first_file['version']
+      raise InvalidListError, 'List is not JSON' unless first_file.is_a? Hash
+      raise InvalidListError, 'File does not have a version information' unless first_file['version']
 
-    return version
-  end
+      version = first_file['version']
 
+      return version
+    end
+  end
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: 8291_scanner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Marek Küthe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-11 00:00:00.000000000 Z
+date: 2024-07-22 00:00:00.000000000 Z
 dependencies: []
 description: This tool connects to the Winbox API of Mikrotik's RouterOS and tries
   to read the operating system version.
@@ -27,7 +27,7 @@ files:
 - lib/8291_scanner/winbox_connection.rb
 homepage: https://codeberg.org/mark22k/8291_scanner
 licenses:
-- WTFPL
+- GPL-3.0-or-later
 metadata:
   source_code_uri: https://codeberg.org/mark22k/8291_scanner
   bug_tracker_uri: https://codeberg.org/mark22k/8291_scanner/issues
@@ -47,7 +47,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.15
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: connects to the Winbox API of Mikrotik's RouterOS and tries to read the operating