mtik 4.0.0 → 4.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c85bb344286cb8faf3504f84bb617a6af422a5703972e8b9795601c2bc0b0ee
+  data.tar.gz: 9f727afa04a97fc3b366c54c637b6ba5274a057a9b460188022a2dc986ce0dca
+SHA512:
+  metadata.gz: 0ceb27e8ea2f409882128ace3557563987f4e3a4d140d504e304ed903c51ef9025b4fd4aab6a3efbfb52063a7008a59f029e48ef8d094c7e0ceca6d153bc2c41
+  data.tar.gz: 9ac0bd5e67ad3004c427637edb3436f96eec96298678b440b76cdd9582bf3ca98e3dc000a1c3e3990761236b9f3858633b72f785b4a931d980d67d3fdab2353a

data/CHANGELOG.txt

@@ -1,3 +1,26 @@
+2020-08-22 (22 AUG 2020)  VERSION 4.0.5
+  * This is a cosmetic version bump for the purpose of updating the gem for wider
+    availability via rubygems in addition to directly from github prior to some
+    coming feature updates and fixes for newer versions of RouterOS
+
+2019-07-26 (26 JUL 2020)  VERSION 4.0.4  Adam Kubica (github user xcr)
+  * Adam bumped the version number and separated out a gemspec file
+  * Jiacheng (github user krhougs) had submitted a similar update as Adam
+
+2014-02-14 (14 FEB 2014)  VERSION 4.0.3  Aaron D. Gifford (http://www.aarongifford.com)
+ * Update to fetch() utility, along with some very minor some cosmetic changes
+
+2013-06-06 (06 JUN 2013)  VERSION 4.0.2  Aaron D. Gifford (http://www.aarongifford.com)
+                                         Bart Braem (http://www.lalunerouge.net/)
+ * Merged Bart Braem's implementation of timeouts and bumped up the version.  Thanks, Bart!
+ * Updated Rakefile to remove a bit of obsolescence
+
+2012-02-09 (09 FEB 2012)  VERSION 4.0.1  Aaron D. Gifford (http://www.aarongifford.com)
+ * Added os_version to connections.  Upon successful connect and login, the RouterOS
+   version is fetched and stored.  This will allow future updates to better support
+   some commands that differ (like fetch) depending on which RouterOS version is
+   installed on the device.
+
 2011-03-25 (25 MAR 2011)  VERSION 4.0.0  Aaron D. Gifford (http://www.aarongifford.com)
  * Per user suggestion, added a new optional cancel parameter to the MTik#command()
    method that will auto-cancel the supplied command after receiving the specified
@@ -13,6 +36,7 @@
    to symbol and fixed those, updated error messages to reflect state as a symbol,
    eliminated a few redundant key?() calls, and fixed a replycounter initialization
    typo (had set it to 1 instead of 0).
+
 2011-01-11 (11 JAN 2011)  VERSION 3.1.2  Aaron D. Gifford (http://www.aarongifford.com)
  * Added source file encoding comments and updated the copyright notices
  * Fixed a tiny bug in lib/mtik/connection.rb
@@ -85,3 +109,4 @@
       fetch.rb
   * Added VERSION.txt, CHANGELOG.txt, README.txt, LICENSE.txt, and *.gemspec files, moved
     the example files into the bin subdirectory
+

data/README.txt

@@ -47,7 +47,7 @@ For documentation on the MikroTik RouterOS APi, see
 
 To install MTik is through its GEM file:
 
-  % [sudo] gem install mtik-3.1.0.gem
+  % [sudo] gem install mtik-4.0.0.gem
 
 == License
 

data/Rakefile

@@ -1,46 +1,15 @@
 require 'rubygems'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
+require 'rubygems/package_task'
+require 'rdoc/task'
 
-gemspec = Gem::Specification.new do |spec|
-  spec.name         = 'mtik'
-  spec.version      = File.open('VERSION.txt','r').to_a.join.strip
-  spec.date         = File.mtime('VERSION.txt')
-  spec.author       = 'Aaron D. Gifford'
-  spec.email        = 'email_not_accepted@aarongifford.com'
-  spec.homepage     = 'http://www.aarongifford.com/computers/mtik/'
-  spec.summary      = 'MTik implements the MikroTik RouterOS API for use in Ruby.'
-  spec.description  = 'MTik implements the MikroTik RouterOS API for use in Ruby.'
-  spec.rubyforge_project = 'mtik'
-  spec.extra_rdoc_files  = [ 'README.txt' ]
-  spec.require_paths     = [ 'lib' ]
-  spec.files             = [
-    'CHANGELOG.txt',
-    'LICENSE.txt',
-    'README.txt',
-    'VERSION.txt',
-    'Rakefile',
-    'examples/tikjson.rb',
-    'bin/tikcli',
-    'bin/tikcommand',
-    'bin/tikfetch',
-    'lib/mtik.rb',
-    'lib/mtik/connection.rb',
-    'lib/mtik/error.rb',
-    'lib/mtik/fatalerror.rb',
-    'lib/mtik/reply.rb',
-    'lib/mtik/request.rb',
-    'lib/mtik/timeouterror.rb'
-  ]
-  spec.executables = [ 'tikcli', 'tikcommand', 'tikfetch' ]
-end
+gemspec = Gem::Specification.load('mtik.gemspec')
 
-Rake::GemPackageTask.new(gemspec) do |pkg|
+Gem::PackageTask.new(gemspec) do |pkg|
   pkg.need_zip = true
   pkg.need_tar = true
 end
 
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   rdoc.name     = 'rdoc'
   rdoc.main     = 'README.txt'
   rdoc.rdoc_dir = 'doc'

data/VERSION.txt

@@ -1 +1 @@
-4.0.0
+4.0.5

data/examples/tikjson.rb

@@ -2,11 +2,13 @@
 ########################################################################
 #--
 #
-# FILE:     json.rb -- Example of using the Ruby MikroTik API in Ruby
+# FILE:  tikjson.rb -- Example of using the Ruby MikroTik API in Ruby
+#                      to execute an API command and retrieve results
+#                      in JSON format
 #
 #++
 # Author::    Aaron D. Gifford - http://www.aarongifford.com/
-# Copyright:: Copyright (c) 2009-2011, InfoWest, Inc.
+# Copyright:: Copyright (c) 2009-2014, InfoWest, Inc.
 # License::   BSD license
 #--
 # Redistribution and use in source and binary forms, with or without

data/lib/mtik.rb

@@ -34,15 +34,17 @@
 # encoding: ASCII-8BIT
 
 module MTik
-  require 'mtik/error.rb'
-  require 'mtik/fatalerror.rb'
-  require 'mtik/timeouterror.rb'
-  require 'mtik/request.rb'
-  require 'mtik/reply.rb'
-  require 'mtik/connection.rb'
+  require_relative 'mtik/error.rb'
+  require_relative 'mtik/fatalerror.rb'
+  require_relative 'mtik/timeouterror.rb'
+  require_relative 'mtik/request.rb'
+  require_relative 'mtik/reply.rb'
+  require_relative 'mtik/connection.rb'
 
   ## Default MikroTik RouterOS API TCP port:
   PORT = 8728
+  ## Default MikroTik RouterOS API-SSL TCP port:
+  PORT_SSL = 8729
   ## Default username to use if none is specified:
   USER = 'admin'
   ## Default password to use if none is specified:
@@ -56,6 +58,9 @@ module MTik
   ## Maximum number of replies before a command is auto-canceled:
   MAXREPLIES   = 1000
 
+  ## SSL is set to false by default
+  USE_SSL = false
+
   @verbose = false
   @debug   = false
 

data/lib/mtik/connection.rb

@@ -39,6 +39,7 @@
 class MTik::Connection
   require 'socket'
   require 'digest/md5'
+  require 'openssl'
 
   ## Initialize/construct the new _MTik_ object.  One or more
   ## key/value pair style arguments must be specified. The one
@@ -46,25 +47,31 @@ class MTik::Connection
   ## to.
   ## +host+:: This is the only _required_ argument. Example:
   ##          <i> :host => "rb411.example.org" </i>
-  ## +port+:: Override the default API port (8728)
+  ## +ssl+::  Use SSL to encrypt communications
+  ## +port+:: Override the default API port (8728/8729)
   ## +user+:: Override the default API username ('admin')
   ## +pass+:: Override the default API password (blank)
   ## +conn_timeout+:: Override the default connection
-  ##                  timeout (60 seconds) -- *NOT USED*
+  ##                  timeout (60 seconds)
   ## +cmd_timeout+::  Override the default command timeout
   ##                  (60 seconds) -- the number of seconds
   ##                  to wait for additional API input.
+  ## +unencrypted_plaintext+::  Attempt to use the 6.43+ login API even without SSL
   def initialize(args)
-    @sock         = nil
-    @requests     = Hash.new
-    @host         = args[:host]
-    @port         = args[:port] || MTik::PORT
-    @user         = args[:user] || MTik::USER
-    @pass         = args[:pass] || MTik::PASS
-    @conn_timeout = args[:conn_timeout] || MTik::CONN_TIMEOUT
-    @cmd_timeout  = args[:cmd_timeout]  || MTik::CMD_TIMEOUT
-    @data         = ''
-    @parsing      = false  ## Recursion flag
+    @sock                  = nil
+    @ssl_sock              = nil
+    @requests              = Hash.new
+    @use_ssl               = args[:ssl] || MTik::USE_SSL
+    @unencrypted_plaintext = args[:unecrypted_plaintext]
+    @host                  = args[:host]
+    @port                  = args[:port] || (@use_ssl ? MTik::PORT_SSL : MTik::PORT)
+    @user                  = args[:user] || MTik::USER
+    @pass                  = args[:pass] || MTik::PASS
+    @conn_timeout          = args[:conn_timeout] || MTik::CONN_TIMEOUT
+    @cmd_timeout           = args[:cmd_timeout]  || MTik::CMD_TIMEOUT
+    @data                  = ''
+    @parsing               = false  ## Recursion flag
+    @os_version            = nil
 
     ## Initiate connection and immediately login to device:
     login
@@ -74,7 +81,8 @@ class MTik::Connection
   def outstanding
     return @requests.length
   end
-  attr_reader :requests, :host, :port, :user, :pass, :conn_timeout, :cmd_timeout
+  attr_reader :requests, :host, :port, :user, :pass, :conn_timeout, :cmd_timeout,
+              :os_version
 
   ## Internal utility function:
   ## Sugar-coat ["0deadf0015"].pack('H*') so one can just do
@@ -93,37 +101,72 @@ class MTik::Connection
       raise MTik::Error.new("Login failed: Unable to connect to device.")
     end
 
-    ## Send first /login command to obtain the challenge:
-    reply = get_reply('/login')
-    ## Make sure the reply has the info we expect:
-    if reply.length != 1 || reply[0].length != 3 || !reply[0].key?('ret')
-      raise MTik::Error.new("Login failed: unexpected reply to login attempt.")
+    # Try using the the post-6.43 login API; on older routers this still initiates
+    # a regular challenge-response cycle.
+    if @use_ssl || @unencrypted_plaintext
+      warn("SENDING PLAINTEXT PASSWORD OVER UNENCRYPTED CONNECTION") unless @use_ssl
+      reply = get_reply('/login',["=name=#{@user}","=password=#{@pass}"])
+      if reply.length == 1 && reply[0].length == 2 && reply[0].key?('!done')
+        v_6_43_login_successful = true
+      end
+    else
+      ## Just send first /login command to obtain the challenge, if not using SSL
+      reply = get_reply('/login')
     end
 
-    ## Grab the challenge from first (only) sentence in the reply:
-    challenge = hex2bin(reply[0]['ret'])
+    unless v_6_43_login_successful
+      ## Make sure the reply has the info we expect for challenge-response authentication:
+      if reply.length != 1 || reply[0].length != 3 || !reply[0].key?('ret')
+        raise MTik::Error.new("Login failed: unexpected reply to login attempt.")
+      end
 
-    ## Generate reply MD5 hash and convert binary hash to hex string:
-    response  = Digest::MD5.hexdigest(0.chr + @pass + challenge)
+      ## Grab the challenge from first (only) sentence in the reply:
+      challenge = hex2bin(reply[0]['ret'])
 
-    ## Send second /login command with our response:
-    reply = get_reply('/login', '=name=' + @user, '=response=00' + response)
-    if reply[0].key?('!trap')
-      raise MTik::Error.new("Login failed: " + (reply[0].key?('message') ? reply[0]['message'] : 'Unknown error.'))
+      ## Generate reply MD5 hash and convert binary hash to hex string:
+      response  = Digest::MD5.hexdigest(0.chr + @pass + challenge)
+
+      ## Send second /login command with our response:
+      reply = get_reply('/login', '=name=' + @user, '=response=00' + response)
+      if reply[0].key?('!trap')
+        raise MTik::Error.new("Login failed: " + (reply[0].key?('message') ? reply[0]['message'] : 'Unknown error.'))
+      end
+      unless reply.length == 1 && reply[0].length == 2 && reply[0].key?('!done')
+        @sock.close
+        @sock = nil
+        raise MTik::Error.new('Login failed: Unknown response to login.')
+      end
     end
-    unless reply.length == 1 && reply[0].length == 2 && reply[0].key?('!done')
-      @sock.close
-      @sock = nil
-      raise MTik::Error.new('Login failed: Unknown response to login.')
+
+    ## Request the RouterOS version of the device as different versions
+    ## sometimes use slightly different command parameters:
+    reply = get_reply('/system/resource/getall')
+    if reply.first.key?('!re') && reply.first['version']
+      @os_version = reply.first['version']
     end
   end
 
   ## Connect to the device
   def connect
     return unless @sock.nil?
-    ## TODO: Perhaps catch more errors; implement connection timeout
+    ## TODO: Perhaps catch more errors
     begin
-      @sock = TCPSocket::new(@host, @port)
+      addr = Socket.getaddrinfo(@host, nil)
+      @sock = Socket.new(Socket.const_get(addr[0][0]), Socket::SOCK_STREAM, 0)
+
+      begin
+        @sock.connect_nonblock(Socket.pack_sockaddr_in(@port, addr[0][3]))
+      rescue Errno::EINPROGRESS
+        ready = IO.select([@sock], [@sock], [], @conn_timeout)
+        if ready
+          @sock
+        else
+          raise Errno::ETIMEDOUT
+      end
+    end
+
+    connect_ssl(@sock) if @use_ssl
+
     rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::ENETUNREACH,
            Errno::EHOSTUNREACH => e
       @sock = nil
@@ -131,6 +174,17 @@ class MTik::Connection
     end
   end
 
+  def connect_ssl(sock)
+    ssl_context = OpenSSL::SSL::SSLContext.new()
+    ssl_context.ciphers = ['HIGH']
+    ssl_socket = OpenSSL::SSL::SSLSocket.new(sock, ssl_context)
+    ssl_socket.sync_close = true
+    unless ssl_socket.connect
+      raise MTik::Error.new("Cannot establish SSL connection.")
+    end
+    @ssl_sock = ssl_socket
+  end
+
   ## Wait for and read exactly one sentence, regardless of content:
   def get_sentence
     ## TODO: Implement timeouts, detect disconnection, maybe do auto-reconnect
@@ -184,7 +238,8 @@ class MTik::Connection
       end
       oldlen = @data.length
       ## Read some more data IF any is available:
-      sel = IO.select([@sock],nil,[@sock], @cmd_timeout)
+      sock = @ssl_sock || @sock
+      sel = IO.select([sock],nil,[sock], @cmd_timeout)
       if sel.nil?
         raise MTik::TimeoutError.new(
           "Time-out while awaiting data with #{outstanding} pending " +
@@ -192,7 +247,7 @@ class MTik::Connection
         )
       end
       if sel[0].length == 1
-        @data += @sock.recv(8192)
+        @data += recv(8192)
       elsif sel[2].length == 1
         raise MTik::Error.new(
           "I/O (select) error while awaiting data with #{outstanding} pending " +
@@ -235,7 +290,7 @@ class MTik::Connection
       sentence = get_sentence  ## This call must be ATOMIC or re-entrant safety fails
 
       ## Check for '!fatal' before checking for a tag--'!fatal'
-      ## is never(???) tagged: 
+      ## is never(???) tagged:
       if sentence.key?('!fatal')
         ## FATAL ERROR has occured! (Or a '/quit' command was issued...)
         if @data.length > 0
@@ -334,7 +389,7 @@ class MTik::Connection
   ## +args+::              Zero or more arguments to the command
   ## +callback+::          Proc/lambda code (or code block if not provided as
   ##                       an argument) to be called.  (See the +await_completion+
-  ##                    
+  ##
   def send_request(await_completion, command, *args, &callback)
     if await_completion.is_a?(MTik::Request)
       req = await_completion
@@ -362,10 +417,41 @@ class MTik::Connection
 
   ## Send the request object over the socket
   def xmit(req)
-    @sock.send(req.request, 0)
+    if @ssl_sock
+      @ssl_sock.write(req.request)
+    else
+      @sock.send(req.request, 0)
+    end
+
     return req
   end
 
+  def recv(buffer_size)
+    if @ssl_sock
+      recv_openssl(buffer_size)
+    else
+      @sock.recv(buffer_size)
+    end
+  end
+
+  # 2 cases for backwards compatibility
+  def recv_openssl(buffer_size)
+    if OpenSSL::SSL.const_defined? 'SSLErrorWaitReadable'.freeze
+      begin
+        @ssl_sock.read_nonblock(buffer_size)
+      rescue OpenSSL::SSL::SSLErrorWaitReadable
+        ''
+      end
+    else
+      begin
+        @ssl_sock.read_nonblock(buffer_size)
+      rescue OpenSSL::SSL::SSLError => e
+        return '' if e.message == 'read would block'.freeze
+        raise e
+      end
+    end
+  end
+
   ## Send a command, then wait for the command to complete, then return
   ## the completed reply.
   ##
@@ -398,8 +484,10 @@ class MTik::Connection
 
   ## Close the connection.
   def close
-    return if @sock.nil?
-    @sock.close
+    return if @sock.nil? and @ssl_sock.nil?
+    @ssl_sock.close if @ssl_sock and !@ssl_sock.closed?
+    @sock.close if @sock and !@sock.closed?
+    @ssl_sock = nil
     @sock = nil
   end
 
@@ -503,16 +591,53 @@ class MTik::Connection
   ## +total+::    Final expected file size in bytes
   ## +bytes+::    Number of bytes transferred so far
   ## +request+::  The MTik::Request object
-  def fetch(url, filename, timeout=nil, &callback)
+  def fetch(url, filename=nil, timeout=nil, &callback)
+    require 'uri'
+
+    uri = URI(url)
+    filename = File.basename(uri.path) if filename.nil?
+
     total  = bytes = oldbytes = 0
     status = ''
     done   = false
     lastactivity = Time.now
-    req = get_reply_each(
-      '/tool/fetch',
-      '=url=' + url,
-      '=dst-path=' + filename
-    ) do |r, s|
+
+    ## RouterOS versions 4.9 and prior (not sure if this version cut-off
+    ## is exactly right) would accept the url parameter, but failed to
+    ## download the files.  So for versions older than this, we'll use
+    ## the mode/src-path/port parameters instead if possible.
+    if !@os_version.nil? && lambda {|a,b|
+      sr = %r{(?:\.|rc|beta|alpha)}
+      a = a.split(sr).map{|i| i.to_i}
+      b = b.split(sr).map{|i| i.to_i}
+      i = 0
+      while i < a.size && i < b.size
+        return -1 if a[i] < b[i]
+        return  1 if a[i] > b[i]
+        i += 1
+      end
+      return a.size <=> b.size
+    }.call(@os_version, '4.9') < 1
+      command = [
+        '/tool/fetch', '=mode=' + uri.scheme,
+        '=src-path=' + uri.path + (uri.query.size > 0 ? '?' + uri.query : ''),
+        '=dst-path=' + filename
+      ]
+      case uri.scheme
+      when 'http'
+        command << '=port=80'
+      when 'https'
+        command << '=port=443'
+      end
+    else
+      command = [
+        '/tool/fetch',
+        '=url=' + url,
+        '=dst-path=' + filename
+      ]
+    end
+
+    req = get_reply_each(command[0], *command[1..-1])  do |r, s|
       if s.key?('!re') && !done
         unless s.key?('status')
           raise MTik::Error.new("Unknown response to '/tool/fetch': missing 'status' in response.")
@@ -602,7 +727,7 @@ class MTik::Connection
           else
             raise MTik::Error.new("Invalid settings match class '#{keyitem}' (expected Array, Regexp, or String)")
           end
-            
+
           if s.key?(key)
             ## A key matches! && s[k] != v
             oldv = s[k]

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mtik
 version: !ruby/object:Gem::Version
-  version: 4.0.0
-  prerelease: 
+  version: 4.0.5
 platform: ruby
 authors:
 - Aaron D. Gifford
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-03-25 00:00:00.000000000Z
+date: 2020-08-22 00:00:00.000000000 Z
 dependencies: []
 description: MTik implements the MikroTik RouterOS API for use in Ruby.
 email: email_not_accepted@aarongifford.com
@@ -24,12 +23,12 @@ files:
 - CHANGELOG.txt
 - LICENSE.txt
 - README.txt
-- VERSION.txt
 - Rakefile
-- examples/tikjson.rb
+- VERSION.txt
 - bin/tikcli
 - bin/tikcommand
 - bin/tikfetch
+- examples/tikjson.rb
 - lib/mtik.rb
 - lib/mtik/connection.rb
 - lib/mtik/error.rb
@@ -39,26 +38,24 @@ files:
 - lib/mtik/timeouterror.rb
 homepage: http://www.aarongifford.com/computers/mtik/
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: mtik
-rubygems_version: 1.7.2
-signing_key: 
-specification_version: 3
+rubygems_version: 3.0.6
+signing_key:
+specification_version: 4
 summary: MTik implements the MikroTik RouterOS API for use in Ruby.
 test_files: []