mtik 4.0.5 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c85bb344286cb8faf3504f84bb617a6af422a5703972e8b9795601c2bc0b0ee
-  data.tar.gz: 9f727afa04a97fc3b366c54c637b6ba5274a057a9b460188022a2dc986ce0dca
+  metadata.gz: 5ce416fc9ce5a6d6768f40c11b68fc983fcf75ba69e10e3bc660a0b405fc1bcc
+  data.tar.gz: 910a34bcb91770ea3f5607fd91297fa1d518f0020e35e27e810deb4eb797cd71
 SHA512:
-  metadata.gz: 0ceb27e8ea2f409882128ace3557563987f4e3a4d140d504e304ed903c51ef9025b4fd4aab6a3efbfb52063a7008a59f029e48ef8d094c7e0ceca6d153bc2c41
-  data.tar.gz: 9ac0bd5e67ad3004c427637edb3436f96eec96298678b440b76cdd9582bf3ca98e3dc000a1c3e3990761236b9f3858633b72f785b4a931d980d67d3fdab2353a
+  metadata.gz: 86879188b9b9af32b1d61f61d3c539a3f8482ef1da078f4a347ea548e1480e0c5b6502d73784a7acda610a17d4b6be141dae93a20b07c1c85959aec538834be5
+  data.tar.gz: 6778bcf64f479677ccdaec744a8356b936527471870e21aa6878749ceb22d79d43452415113a2e15de4d4be0bbc133d7a32b1d0c7d70807cf7066eb94acab91e

data/CHANGELOG.txt

@@ -1,3 +1,18 @@
+2020-08-23 (23 AUG 2020)  VERSION 4.1.0
+  * Minor version bump due to changing argument passing for the call to
+    MTik.interactive_client()
+  * Updated tikcli, tikcommand, and tikfetch commands to add options for
+    enabling SSL and/or to use unencrypted plaintext logins (newer API
+    login style).  Also one can set environment variables MTIK_SSL to 
+    specify SSL use, or MTIK_UNENCRYPTED_PLAINTEXT to enable unencrypted
+    plaintext logins if SSL is NOT used for compatibility with cleartext
+    API usage on RouterOS versions 6.43+
+  * THANKS to Zdenek Crha (zdenek-crha on github) for pointing out that
+    the binary commands were lacking proper argument passing to allow
+    for SSL and/or unencrypted plaintext options, and for suggesting the
+    use of environment variables as an alterative to CLI options for
+    enabling such.
+
 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
@@ -66,7 +81,7 @@
  * Fixed RDoc formatting in several files, and added an RDocTask to the Rakefile
 
 2010-04-23 (23 APR 2010)  VERSION 3.0.5  Aaron D. Gifford (http://www.aarongifford.com)
- * Double bug-fix (typo fix and logic fix) to request.rb thanks to Allan Eising and 
+ * Double bug-fix (typo fix and logic fix) to request.rb thanks to Allan Eising and
    Søren Daugaard.  Thank you both for the patch!
  * Added a brief sanity-check in request.rb to help spotlight logic errors.
 

data/README.txt

@@ -27,7 +27,7 @@ The latest version of MTik can be found at
 
 Ruby RDoc documentation can be found online at
 
-* http://www.aarongifford.com/computers/mtik/latest/doc/ 
+* http://www.aarongifford.com/computers/mtik/latest/doc/
 
 Additional documentation is available at
 

data/VERSION.txt

@@ -1 +1 @@
-4.0.5
+4.1.0

data/bin/tikcli

@@ -42,10 +42,46 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
-unless ARGV.length == 3
-  STDERR.print("Usage: #{$0} <host> <user> <pass>\n")
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\n" : '') +
+    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <host> <user> <pass>\n"  +
+    "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n" +
+    "                                        using SSL.\n"                          +
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"
+  )
   exit(-1)
 end
 
-MTik::interactive_client(ARGV[0], ARGV[1], ARGV[2])
+use_ssl = unencrypted_plaintext = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  when '--ssl', '-s'
+    usage("Please do not repeat the --ssl (or -s) parameter") if use_ssl
+    use_ssl = true
+  when '--unencrypted_plaintext', '-u'
+    usage("Please do not repeat the --unencrypted_plaintext (or -u) parameter") if unencrypted_plaintext
+    unencrypted_plaintext = true
+  else
+    usage("Unknown argument #{arg.inspect}")
+  end
+end
+usage("Too many arguments.")     if ARGV.size > 3
+usage("Insufficient arguments.") if ARGV.size < 3
+
+## Permit setting use_ssl and unencrypted_plaintext via environment variables:
+use_ssl               = true if ENV['MTIK_SSL']
+unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
+
+args = {
+  :host => ARGV[0],
+  :user => ARGV[1],
+  :pass => ARGV[2],
+  :ssl  => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+p args
+
+MTik::interactive_client(args)
 

data/bin/tikcommand

@@ -42,12 +42,39 @@ $LOAD_PATH.unshift(File.dirname(__FILE__)+'/../lib')
 require 'rubygems'
 require 'mtik'
 
-unless ARGV.length > 3
-  STDERR.print("Usage: #{$0} <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n")
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\n" : '') +
+    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <host> <user> <pass> <command> [<args>...] [<command> [<args> ...]]\n" +
+    "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n" +
+    "                                        using SSL.\n"                          +
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"
+  )
   exit(-1)
 end
 
-MTik::verbose = true  ## Set how you want
+MTik::verbose = true  ## Set how verbose you want things
+
+use_ssl = unencrypted_plaintext = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  when '--ssl', '-s'
+    usage("Please do not repeat the --ssl (or -s) parameter") if use_ssl
+    use_ssl = true
+  when '--unencrypted_plaintext', '-u'
+    usage("Please do not repeat the --unencrypted_plaintext (or -u) parameter") if unencrypted_plaintext
+    unencrypted_plaintext = true
+  else
+    usage("Unknown argument #{arg.inspect}")
+  end
+end
+usage("Too few arguments.") if ARGV.size < 4
+usage("First command must start with a slash '/' character. #{ARGV[3].inspect}") if ARGV[3].nil? || ARGV[3][0] != '/'
+
+## Permit setting use_ssl and unencrypted_plaintext via environment variables:
+use_ssl               = true if ENV['MTIK_SSL']
+unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
 
 ## Detect multiple command sequences and build an array of arrays
 ## where each outer array element is a command plus arguments:
@@ -62,10 +89,14 @@ while i < ARGV.length
   i += 1
 end
 
-p MTik::command(
-  :host=>ARGV[0],
-  :user=>ARGV[1],
-  :pass=>ARGV[2],
-  :command=>command
-)
+args = {
+  :host    => ARGV[0],
+  :user    => ARGV[1],
+  :pass    => ARGV[2],
+  :command => command,
+  :ssl     => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+
+p MTik::command(args)
 

data/bin/tikfetch

@@ -46,16 +46,48 @@ require 'mtik'
 ## output of all API interactions:
 #MTik::verbose = true
 
-if ARGV.length < 4
-  print "Usage: #{$0} <device> <user> <pass> <url> [<localfilename> [<url> [<localfilename> ... ]]]\n"
-  exit
+def usage(msg='')
+  STDERR.print(
+    (msg.size > 0 ? msg + "\n\n" : '') +
+    "Usage: #{$0} [-s|--ssl] [-u|--unencrypted_plaintext] <device> <user> <pass> <url> [<localfilename> [<url> [<localfilename> ... ]]]\n" +
+    "       --unencrypted_plaintext OR -u  - Use the 6.43+ login API even if NOT\n" +
+    "                                        using SSL.\n"                          +
+    "       --ssl OR -s                    - Use SSL for the API connection.\n"
+  )
+  exit(-1)
+end
+
+use_ssl = unencrypted_plaintext = false
+while !ARGV[0].nil? && ARGV[0][0] == '-'
+  arg = ARGV.shift
+  case arg
+  when '--ssl', '-s'
+    usage("Please do not repeat the --ssl (or -s) parameter") if use_ssl
+    use_ssl = true
+  when '--unencrypted_plaintext', '-u'
+    usage("Please do not repeat the --unencrypted_plaintext (or -u) parameter") if unencrypted_plaintext
+    unencrypted_plaintext = true
+  else
+    usage("Unknown argument #{arg.inspect}")
+  end
 end
+usage("Too few arguments.") if ARGV.size < 4
+
+## Permit setting use_ssl and unencrypted_plaintext via environment variables:
+use_ssl               = true if ENV['MTIK_SSL']
+unencrypted_plaintext = true if ENV['MTIK_UNENCRYPTED_PLAINTEXT']
+
+args = {
+  :host => ARGV.shift,
+  :user => ARGV.shift,
+  :pass => ARGV.shift,
+  :ssl  => use_ssl,
+  :unencrypted_plaintext => unencrypted_plaintext
+}
+
 
-host = ARGV.shift
-user = ARGV.shift
-pass = ARGV.shift
 begin
-  mt = MTik::Connection.new(:host=>host, :user=>user, :pass=>pass)
+  mt = MTik::Connection.new(args)
 rescue Errno::ETIMEDOUT, Errno::ENETUNREACH, Errno::EHOSTUNREACH, MTik::Error => e
   print ">>> ERROR CONNECTING: #{e}\n"
   exit
@@ -129,6 +161,7 @@ print "SIZE        CREATED               FILENAME\n"
 print "====================================================================\n"
 mt.get_reply_each('/file/getall') do |req, s|
   unless s.key?('!done')
+    s['size'] = 'directory' if s['type'] == 'directory'
     print "#{(s['size']+'        ')[0,10]}  #{s['creation-time']}  #{s['name']}\n"
   end
 end

data/lib/mtik.rb

@@ -49,7 +49,7 @@ module MTik
   USER = 'admin'
   ## Default password to use if none is specified:
   PASS = ''
-  ## Connection timeout default -- *NOT USED* 
+  ## Connection timeout default -- *NOT USED*
   CONN_TIMEOUT = 60
   ## Command timeout -- The maximum number of seconds to wait for more
   ## API data when expecting one or more command responses.
@@ -86,12 +86,30 @@ module MTik
 
 
   ## Act as an interactive client with the device, accepting user
-  ## input from STDIN.
-  def self.interactive_client(host, user, pass)
+  ## input from STDIN.  Arguments are key/value pairs, and are
+  ## simply passed directly to MTik::Connection().  The below
+  ## documentation is taken directly from MTik::Connection. One
+  ## more ## key/value pair style arguments must be specified.
+  ## The one ## required argument is the host or IP of the device
+  ## to connect to.
+  ## +host+:: This is the only _required_ argument. Example:
+  ##          <i> :host => "rb411.example.org" </i>
+  ## +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)
+  ## +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 self.interactive_client(args)
     old_verbose = MTik::verbose
     MTik::verbose = true
     begin
-      tk = MTik::Connection.new(:host => host, :user => user, :pass => pass)
+      tk = MTik::Connection.new(args)
     rescue MTik::Error, Errno::ECONNREFUSED => e
       print "=== LOGIN ERROR: #{e.message}\n"
       exit
@@ -132,7 +150,7 @@ module MTik
               cmd == '/tool/fetch' && sentence['status'] == 'finished'
             ) || (maxreply > 0 && count == maxreply)
               state = 2
-              req.cancel do |r, s|  
+              req.cancel do |r, s|
                 state = 1
               end
             end
@@ -159,7 +177,7 @@ module MTik
         end
       end
     end
- 
+
     reply = tk.get_reply('/quit')
     unless reply[0].key?('!fatal')
       raise MTik::Error.new("Unexpected response to '/quit' command.")
@@ -245,16 +263,9 @@ module MTik
   ## Remember that the limit applies separately to each API command
   ## executed.
   def self.command(args)
-    tk = MTik::Connection.new(
-      :host => args[:host],
-      :user => args[:user],
-      :pass => args[:pass],
-      :port => args[:port],
-      :conn_timeout => args[:conn_timeout],
-      :cmd_timeout  => args[:cmd_timeout]
-    )
-    limit = args[:limit]  ## Optional reply limit
-    cmd = args[:command]
+    tk      = MTik::Connection.new(args)
+    limit   = args[:limit]  ## Optional reply limit
+    cmd     = args[:command]
     replies = Array.new
     if cmd.is_a?(String)
       ## Single command, no arguments

data/lib/mtik/connection.rb

@@ -62,7 +62,7 @@ class MTik::Connection
     @ssl_sock              = nil
     @requests              = Hash.new
     @use_ssl               = args[:ssl] || MTik::USE_SSL
-    @unencrypted_plaintext = args[:unecrypted_plaintext]
+    @unencrypted_plaintext = args[:unencrypted_plaintext]
     @host                  = args[:host]
     @port                  = args[:port] || (@use_ssl ? MTik::PORT_SSL : MTik::PORT)
     @user                  = args[:user] || MTik::USER
@@ -151,23 +151,20 @@ class MTik::Connection
     return unless @sock.nil?
     ## TODO: Perhaps catch more errors
     begin
-      addr = Socket.getaddrinfo(@host, nil)
+      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
+        raise Errno::ETIMEDOUT unless ready
       end
-    end
-
-    connect_ssl(@sock) if @use_ssl
 
-    rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, Errno::ENETUNREACH,
+      connect_ssl(@sock) if @use_ssl
+    rescue Errno::ECONNREFUSED,
+           Errno::ETIMEDOUT,
+           Errno::ENETUNREACH,
            Errno::EHOSTUNREACH => e
       @sock = nil
       raise e ## Re-raise the exception
@@ -417,12 +414,16 @@ class MTik::Connection
 
   ## Send the request object over the socket
   def xmit(req)
-    if @ssl_sock
-      @ssl_sock.write(req.request)
-    else
-      @sock.send(req.request, 0)
+    begin
+      if @ssl_sock
+        @ssl_sock.write(req.request)
+      else
+        @sock.send(req.request, 0)
+      end
+    rescue Errno::EPIPE => e
+      @sock = @ssl_sock = nil
+      raise e ## Re-raise the exception
     end
-
     return req
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mtik
 version: !ruby/object:Gem::Version
-  version: 4.0.5
+  version: 4.1.0
 platform: ruby
 authors:
 - Aaron D. Gifford