hrr_rb_ssh 0.1.0

data/lib/hrr_rb_ssh/message/095_ssh_msg_channel_extended_data.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/message/codable'
+
+module HrrRbSsh
+  module Message
+    module SSH_MSG_CHANNEL_EXTENDED_DATA
+      module DataTypeCode
+        SSH_EXTENDED_DATA_STDERR = 1
+      end
+
+      class << self
+        include Codable
+      end
+
+      ID    = self.name.split('::').last
+      VALUE = 95
+
+      DEFINITION = [
+        # [Data Type, Field Name]
+        ['byte',      'SSH_MSG_CHANNEL_EXTENDED_DATA'],
+        ['uint32',    'recipient channel'],
+        ['uint32',    'data type code'],
+        ['string',    'data'],
+      ]
+    end
+  end
+end

data/lib/hrr_rb_ssh/message/096_ssh_msg_channel_eof.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/message/codable'
+
+module HrrRbSsh
+  module Message
+    module SSH_MSG_CHANNEL_EOF
+      class << self
+        include Codable
+      end
+
+      ID    = self.name.split('::').last
+      VALUE = 96
+
+      DEFINITION = [
+        # [Data Type, Field Name]
+        ['byte',      'SSH_MSG_CHANNEL_EOF'],
+        ['uint32',    'recipient channel'],
+      ]
+    end
+  end
+end

data/lib/hrr_rb_ssh/message/097_ssh_msg_channel_close.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/message/codable'
+
+module HrrRbSsh
+  module Message
+    module SSH_MSG_CHANNEL_CLOSE
+      class << self
+        include Codable
+      end
+
+      ID    = self.name.split('::').last
+      VALUE = 97
+
+      DEFINITION = [
+        # [Data Type, Field Name]
+        ['byte',      'SSH_MSG_CHANNEL_CLOSE'],
+        ['uint32',    'recipient channel'],
+      ]
+    end
+  end
+end

data/lib/hrr_rb_ssh/message/098_ssh_msg_channel_request.rb

@@ -0,0 +1,139 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/message/codable'
+
+module HrrRbSsh
+  module Message
+    module SSH_MSG_CHANNEL_REQUEST
+      module SignalName
+        ABRT = 'ABRT'
+        ALRM = 'ALRM'
+        FPE  = 'FPE'
+        HUP  = 'HUP'
+        ILL  = 'ILL'
+        INT  = 'INT'
+        KILL = 'KILL'
+        PIPE = 'PIPE'
+        QUIT = 'QUIT'
+        SEGV = 'SEGV'
+        TERM = 'TERM'
+        USR1 = 'USR1'
+        USR2 = 'USR2'
+      end
+
+      class << self
+        include Codable
+      end
+
+      ID    = self.name.split('::').last
+      VALUE = 98
+
+      DEFINITION = [
+        # [Data Type, Field Name]
+        ['byte',      'SSH_MSG_CHANNEL_REQUEST'],
+        ['uint32',    'recipient channel'],
+        ['string',    'request type'],
+        ['boolean',   'want reply'],
+      ]
+
+      PTY_REQ_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "pty-req"],
+        ['string',    'TERM environment variable value'],
+        ['uint32',    'terminal width, characters'],
+        ['uint32',    'terminal height, rows'],
+        ['uint32',    'terminal width, pixels'],
+        ['uint32',    'terminal height, pixels'],
+        ['string',    'encoded terminal modes'],
+      ]
+
+      X11_REQ_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "x11-req"],
+        ['boolean',   'single connection'],
+        ['string',    'x11 authentication protocol'],
+        ['string',    'x11 authentication cookie'],
+        ['uint32',    'x11 screen number'],
+      ]
+
+      ENV_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "env"],
+        ['string',    'variable name'],
+        ['string',    'variable value'],
+      ]
+
+      SHELL_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "shell"],
+      ]
+
+      EXEC_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "exec"],
+        ['string',    'command'],
+      ]
+
+      SUBSYSTEM_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "subsystem"],
+        ['string',    'subsystem name'],
+      ]
+
+      WINDOW_CHANGE_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "window-change"],
+        ['uint32',    'terminal width, columns'],
+        ['uint32',    'terminal height, rows'],
+        ['uint32',    'terminal width, pixels'],
+        ['uint32',    'terminal height, pixels'],
+      ]
+
+      XON_XOFF_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "xon-xoff"],
+        ['boolean',   'client can do'],
+      ]
+
+      SIGNAL_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "signal"],
+        ['string',    'signal name'],
+      ]
+
+      EXIT_STATUS_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "exit-status"],
+        ['uint32',    'exit status'],
+      ]
+
+      EXIT_SIGNAL_DEFINITION = [
+        # [Data Type, Field Name]
+        # ['string',  'request type' : "exit-signal"],
+        ['string',    'signal name'],
+        ['boolean',   'core dumped'],
+        ['string',    'error message'],
+        ['string',    'language tag'],
+      ]
+
+      CONDITIONAL_DEFINITION = {
+        # Field Name => {Field Value => Conditional Definition}
+        'request type' => {
+          'pty-req'       => PTY_REQ_DEFINITION,
+          'x11-req'       => X11_REQ_DEFINITION,
+          'env'           => ENV_DEFINITION,
+          'shell'         => SHELL_DEFINITION,
+          'exec'          => EXEC_DEFINITION,
+          'subsystem'     => SUBSYSTEM_DEFINITION,
+          'window-change' => WINDOW_CHANGE_DEFINITION,
+          'xon-xoff'      => XON_XOFF_DEFINITION,
+          'signal'        => SIGNAL_DEFINITION,
+          'exit-status'   => EXIT_STATUS_DEFINITION,
+          'exit-signal'   => EXIT_SIGNAL_DEFINITION,
+        },
+      }
+    end
+  end
+end

data/lib/hrr_rb_ssh/message/099_ssh_msg_channel_success.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/message/codable'
+
+module HrrRbSsh
+  module Message
+    module SSH_MSG_CHANNEL_SUCCESS
+      class << self
+        include Codable
+      end
+
+      ID    = self.name.split('::').last
+      VALUE = 99
+
+      DEFINITION = [
+        # [Data Type, Field Name]
+        ['byte',      'SSH_MSG_CHANNEL_SUCCESS'],
+        ['uint32',    'recipient channel'],
+      ]
+    end
+  end
+end

data/lib/hrr_rb_ssh/message/100_ssh_msg_channel_failure.rb

@@ -0,0 +1,24 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/message/codable'
+
+module HrrRbSsh
+  module Message
+    module SSH_MSG_CHANNEL_FAILURE
+      class << self
+        include Codable
+      end
+
+      ID    = self.name.split('::').last
+      VALUE = 100
+
+      DEFINITION = [
+        # [Data Type, Field Name]
+        ['byte',      'SSH_MSG_CHANNEL_FAILURE'],
+        ['uint32',    'recipient channel'],
+      ]
+    end
+  end
+end

data/lib/hrr_rb_ssh/message/codable.rb

@@ -0,0 +1,67 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/transport/data_type'
+
+module HrrRbSsh
+  module Message
+    module Codable
+      def logger
+        @logger ||= HrrRbSsh::Logger.new self.name
+      end
+
+      def common_definition
+        self::DEFINITION
+      end
+
+      def conditional_definition message
+        message.inject([]){ |a, (k,v)|
+          field_name  = k
+          field_value = if v.instance_of? ::Proc then v.call else v end
+          a + ((self::CONDITIONAL_DEFINITION rescue {}).fetch(field_name, {})[field_value] || [])
+        }
+      end
+
+      def encode message, complementary_message={}
+        logger.debug('encoding message: ' + message.inspect)
+        definition = common_definition + conditional_definition(message.merge complementary_message)
+        definition.map{ |data_type, field_name|
+          field_value = if message[field_name].instance_of? ::Proc then message[field_name].call else message[field_name] end
+          HrrRbSsh::Transport::DataType[data_type].encode( field_value )
+        }.join
+      end
+
+      def decode payload, complementary_message={}
+        def decode_recursively payload_io, message=nil
+          if message.class == Array and message.size == 0
+            []
+          else
+            definition = case message
+                         when nil
+                           common_definition
+                         when Array
+                           conditional_definition(message)
+                         end
+            decoded_message = definition.map{ |data_type, field_name|
+              [
+                field_name,
+                HrrRbSsh::Transport::DataType[data_type].decode( payload_io )
+              ]
+            }
+
+            decoded_message + decode_recursively(payload_io, decoded_message)
+          end
+        end
+
+        payload_io = StringIO.new payload
+        decoded_message = decode_recursively(payload_io).to_h
+        if complementary_message.any?
+          decoded_message.merge! decode_recursively(payload_io, complementary_message.to_a).to_h
+        end
+        logger.debug('decoded message: ' + decoded_message.inspect)
+        decoded_message
+      end
+    end
+  end
+end

data/lib/hrr_rb_ssh/message.rb

@@ -0,0 +1,36 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/message/001_ssh_msg_disconnect'
+require 'hrr_rb_ssh/message/002_ssh_msg_ignore'
+require 'hrr_rb_ssh/message/003_ssh_msg_unimplemented'
+require 'hrr_rb_ssh/message/004_ssh_msg_debug'
+require 'hrr_rb_ssh/message/005_ssh_msg_service_request'
+require 'hrr_rb_ssh/message/006_ssh_msg_service_accept'
+require 'hrr_rb_ssh/message/020_ssh_msg_kexinit'
+require 'hrr_rb_ssh/message/021_ssh_msg_newkeys'
+require 'hrr_rb_ssh/message/030_ssh_msg_kexdh_init'
+require 'hrr_rb_ssh/message/031_ssh_msg_kexdh_reply'
+require 'hrr_rb_ssh/message/050_ssh_msg_userauth_request'
+require 'hrr_rb_ssh/message/051_ssh_msg_userauth_failure'
+require 'hrr_rb_ssh/message/052_ssh_msg_userauth_success'
+require 'hrr_rb_ssh/message/060_ssh_msg_userauth_pk_ok'
+require 'hrr_rb_ssh/message/080_ssh_msg_global_request.rb'
+require 'hrr_rb_ssh/message/081_ssh_msg_request_success.rb'
+require 'hrr_rb_ssh/message/082_ssh_msg_request_failure.rb'
+require 'hrr_rb_ssh/message/090_ssh_msg_channel_open.rb'
+require 'hrr_rb_ssh/message/091_ssh_msg_channel_open_confirmation.rb'
+require 'hrr_rb_ssh/message/092_ssh_msg_channel_open_failure.rb'
+require 'hrr_rb_ssh/message/093_ssh_msg_channel_window_adjust.rb'
+require 'hrr_rb_ssh/message/094_ssh_msg_channel_data.rb'
+require 'hrr_rb_ssh/message/095_ssh_msg_channel_extended_data.rb'
+require 'hrr_rb_ssh/message/096_ssh_msg_channel_eof.rb'
+require 'hrr_rb_ssh/message/097_ssh_msg_channel_close.rb'
+require 'hrr_rb_ssh/message/098_ssh_msg_channel_request.rb'
+require 'hrr_rb_ssh/message/099_ssh_msg_channel_success.rb'
+require 'hrr_rb_ssh/message/100_ssh_msg_channel_failure.rb'
+
+module HrrRbSsh
+  module Message
+  end
+end

data/lib/hrr_rb_ssh/transport/compression_algorithm/none.rb

@@ -0,0 +1,33 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+
+module HrrRbSsh
+  class Transport
+    class CompressionAlgorithm
+      name_list = [
+        'none'
+      ]
+
+      class None
+        def initialize
+          @logger = HrrRbSsh::Logger.new self.class.name
+        end
+
+        def deflate data
+          data
+        end
+
+        def inflate data
+          data
+        end
+      end
+
+      @@list ||= Hash.new
+      name_list.each do |name|
+        @@list[name] = None
+      end
+    end
+  end
+end

data/lib/hrr_rb_ssh/transport/compression_algorithm/zlib.rb

@@ -0,0 +1,38 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'zlib'
+
+require 'hrr_rb_ssh/logger'
+
+module HrrRbSsh
+  class Transport
+    class CompressionAlgorithm
+      name_list = [
+        'zlib'
+      ]
+
+      class Zlib
+        def initialize
+          @logger = HrrRbSsh::Logger.new self.class.name
+
+          @deflator = ::Zlib::Deflate.new
+          @inflator = ::Zlib::Inflate.new
+        end
+
+        def deflate data
+          @deflator.deflate(data, ::Zlib::SYNC_FLUSH)
+        end
+
+        def inflate data
+          @inflator.inflate(data)
+        end
+      end
+
+      @@list ||= Hash.new
+      name_list.each do |name|
+        @@list[name] = Zlib
+      end
+    end
+  end
+end

data/lib/hrr_rb_ssh/transport/compression_algorithm.rb

@@ -0,0 +1,22 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'hrr_rb_ssh/logger'
+require 'hrr_rb_ssh/transport/compression_algorithm/none'
+require 'hrr_rb_ssh/transport/compression_algorithm/zlib'
+
+module HrrRbSsh
+  class Transport
+    class CompressionAlgorithm
+      @@list ||= Hash.new
+
+      def self.[] key
+        @@list[key]
+      end
+
+      def self.name_list
+        @@list.keys
+      end
+    end
+  end
+end

data/lib/hrr_rb_ssh/transport/constant.rb

@@ -0,0 +1,11 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+module HrrRbSsh
+  class Transport
+    module Constant
+      CR = 0x0d.chr
+      LF = 0x0a.chr
+    end
+  end
+end

data/lib/hrr_rb_ssh/transport/data_type.rb

@@ -0,0 +1,163 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'openssl'
+
+require 'hrr_rb_ssh/logger'
+
+module HrrRbSsh
+  class Transport
+    module DataType
+      def self.[] key
+        case key
+        when 'byte'
+          Byte
+        when 'boolean'
+          Boolean
+        when 'uint32'
+          Uint32
+        when 'uint64'
+          Uint64
+        when 'string'
+          String
+        when 'mpint'
+          Mpint
+        when 'name-list'
+          NameList
+        end
+      end
+
+      class Byte
+        def self.encode arg
+          case arg
+          when 0x00..0xff
+            [arg].pack("C")
+          else
+            raise
+          end
+        end
+
+        def self.decode io
+          io.read(1).unpack("C")[0]
+        end
+      end
+
+      class Boolean
+        def self.encode arg
+          case arg
+          when false
+            [0].pack("C")
+          when true
+            [1].pack("C")
+          else
+            raise
+          end
+        end
+
+        def self.decode io
+          if 0 == io.read(1).unpack("C")[0]
+            false
+          else
+            true
+          end
+        end
+      end
+
+      class Uint32
+        def self.encode arg
+          case arg
+          when 0x0000_0000..0xffff_ffff
+            [arg].pack("N")
+          else
+            raise
+          end
+        end
+
+        def self.decode io
+          io.read(4).unpack("N")[0]
+        end
+      end
+
+      class Uint64
+        def self.encode arg
+          case arg
+          when 0x0000_0000_0000_0000..0xffff_ffff_ffff_ffff
+            [arg >> 32].pack("N") + [arg & 0x0000_0000_ffff_ffff].pack("N")
+          else
+            raise
+          end
+        end
+
+        def self.decode io
+          (io.read(4).unpack("N")[0] << 32) + (io.read(4).unpack("N")[0])
+        end
+      end
+
+      class String
+        def self.encode arg
+          raise unless arg.kind_of? ::String
+          raise if     arg.length > 0xffff_ffff
+          [arg.length, arg].pack("Na*")
+        end
+
+        def self.decode io
+          length = io.read(4).unpack("N")[0]
+          io.read(length).unpack("a*")[0]
+        end
+      end
+
+      class Mpint
+        def self.encode arg
+          raise unless arg.kind_of? ::Integer
+          raise if     arg.size > 0xffff_ffff
+          bn = ::OpenSSL::BN.new(arg)
+
+          if bn < 0
+            # get 2's complement
+            tc = bn.to_i & ((1 << (bn.num_bytes * 8)) - 1)
+            # get hex representation
+            hex_str = "%x" % tc
+
+            if tc[(bn.num_bytes * 8) - 1] == 1
+              [bn.num_bytes, hex_str].pack("NH*")
+            else
+              [bn.num_bytes + 1, "ff" + hex_str].pack("NH*")
+            end
+          else
+            bn.to_s(0)
+          end
+        end
+
+        def self.decode io
+          length = io.read(4).unpack("N")[0]
+          hex_str = io.read(length).unpack("H*")[0]
+          # get temporal integer value
+          value = hex_str.hex
+
+          if length == 0
+            0
+          elsif value[(length * 8) - 1] == 0
+            value
+          else
+            num_bytes = if hex_str.start_with?("ff") then length - 1 else length end
+            - (((~ value) & ((1 << (num_bytes * 8)) - 1)) + 1)
+          end
+        end
+      end
+
+      class NameList
+        def self.encode arg
+          raise unless arg.kind_of? Array
+          raise unless (arg.map(&:class) - [::String]).empty?
+          raise if     arg.join(',').length > 0xffff_ffff
+          [arg.join(',').length, arg.join(',')].pack("Na*")
+        end
+
+        def self.decode io
+          length = io.read(4).unpack("N")[0]
+          io.read(length).unpack("a*")[0].split(',')
+        end
+      end
+    end
+  end
+end