hrr_rb_sftp 0.1.0 → 0.2.0

data/lib/hrr_rb_sftp/protocol/common/data_type.rb

@@ -1,15 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-      end
-    end
-  end
-end
-
-require "hrr_rb_sftp/protocol/common/data_type/byte"
-require "hrr_rb_sftp/protocol/common/data_type/uint32"
-require "hrr_rb_sftp/protocol/common/data_type/uint64"
-require 'hrr_rb_sftp/protocol/common/data_type/string'
-require 'hrr_rb_sftp/protocol/common/data_type/extension_pair'
-require 'hrr_rb_sftp/protocol/common/data_type/extension_pairs'

data/lib/hrr_rb_sftp/protocol/common/data_type/byte.rb

@@ -1,22 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-        module Byte
-          def self.encode arg
-            case arg
-            when 0x00..0xff
-              [arg].pack("C")
-            else
-              raise ArgumentError, "must be in #{0x00}..#{0xff}, but got #{arg.inspect}"
-            end
-          end
-
-          def self.decode io
-            io.read(1).unpack("C")[0]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/data_type/extension_pair.rb

@@ -1,23 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-        module ExtensionPair
-          def self.encode arg
-            unless arg.kind_of? ::Hash
-              raise ArgumentError, "must be a kind of Hash, but got #{arg.inspect}"
-            end
-            DataType::String.encode(arg[:"extension-name"]) + DataType::String.encode(arg[:"extension-data"])
-          end
-
-          def self.decode io
-            {
-              :"extension-name" => DataType::String.decode(io),
-              :"extension-data" => DataType::String.decode(io),
-            }
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/data_type/extension_pairs.rb

@@ -1,24 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-        module ExtensionPairs
-          def self.encode arg
-            unless arg.kind_of? ::Array
-              raise ArgumentError, "must be a kind of Array, but got #{arg.inspect}"
-            end
-            arg.map{|arg| ExtensionPair.encode(arg)}.join
-          end
-
-          def self.decode io
-            extension_pairs = Array.new
-            until io.eof?
-              extension_pairs.push ExtensionPair.decode(io)
-            end
-            extension_pairs
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/data_type/string.rb

@@ -1,24 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-        module String
-          def self.encode arg
-            unless arg.kind_of? ::String
-              raise ArgumentError, "must be a kind of String, but got #{arg.inspect}"
-            end
-            if arg.bytesize > 0xffff_ffff
-              raise ArgumentError, "must be shorter than or equal to #{0xffff_ffff}, but got length #{arg.bytesize}"
-            end
-            [arg.bytesize, arg].pack("Na*")
-          end
-
-          def self.decode io
-            length = io.read(4).unpack("N")[0]
-            io.read(length).unpack("a*")[0].force_encoding(Encoding::UTF_8)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/data_type/uint32.rb

@@ -1,22 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-        module Uint32
-          def self.encode arg
-            case arg
-            when 0x0000_0000..0xffff_ffff
-              [arg].pack("N")
-            else
-              raise ArgumentError, "must be in #{0x0000_0000}..#{0xffff_ffff}, but got #{arg.inspect}"
-            end
-          end
-
-          def self.decode io
-            io.read(4).unpack("N")[0]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/data_type/uint64.rb

@@ -1,22 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module DataType
-        module 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 ArgumentError, "must be in #{0x0000_0000_0000_0000}..#{0xffff_ffff_ffff_ffff}, but got #{arg.inspect}"
-            end
-          end
-
-          def self.decode io
-            (io.read(4).unpack("N")[0] << 32) + (io.read(4).unpack("N")[0])
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/packet.rb

@@ -1,11 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module Packet
-      end
-    end
-  end
-end
-
-require "hrr_rb_sftp/protocol/common/packet/001_ssh_fxp_init"
-require "hrr_rb_sftp/protocol/common/packet/002_ssh_fxp_version"

data/lib/hrr_rb_sftp/protocol/common/packet/001_ssh_fxp_init.rb

@@ -1,18 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module Packet
-        class SSH_FXP_INIT
-          include Packetable
-
-          TYPE = 1
-
-          FORMAT = [
-            [DataType::Byte,   :"type"   ],
-            [DataType::Uint32, :"version"],
-          ]
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/packet/002_ssh_fxp_version.rb

@@ -1,19 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module Packet
-        class SSH_FXP_VERSION
-          include Packetable
-
-          TYPE = 2
-
-          FORMAT = [
-            [DataType::Byte,           :"type"      ],
-            [DataType::Uint32,         :"version"   ],
-            [DataType::ExtensionPairs, :"extensions"],
-          ]
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/common/packetable.rb

@@ -1,72 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    module Common
-      module Packetable
-        include Loggable
-
-        def initialize handles, logger: nil
-          self.logger = logger
-
-          @handles = handles
-        end
-
-        def encode packet
-          log_debug { 'encoding packet: ' + packet.inspect }
-          format = common_format + conditional_format(packet)
-          format.map{ |data_type, field_name|
-            begin
-              field_value = packet[field_name]
-              data_type.encode field_value
-            rescue => e
-              log_debug { "'field_name', 'field_value': #{field_name.inspect}, #{field_value.inspect}" }
-              raise e
-            end
-          }.join
-        end
-
-        def decode payload
-          payload_io = StringIO.new payload
-          format = common_format
-          decoded_packet = decode_recursively(payload_io).inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
-          log_debug { 'decoded packet: ' + decoded_packet.inspect }
-          decoded_packet
-        end
-
-        private
-
-        def common_format
-          self.class::FORMAT
-        end
-
-        def conditional_format packet
-          return [] unless self.class.const_defined? :CONDITIONAL_FORMAT
-          packet.inject([]){ |a, (field_name, field_value)|
-            a + (self.class::CONDITIONAL_FORMAT.fetch(field_name, {})[field_value] || [])
-          }
-        end
-
-        def decode_recursively payload_io, packet=nil
-          if packet.class == Array and packet.size == 0
-            []
-          else
-            format = case packet
-                     when nil
-                       common_format
-                     when Array
-                       conditional_format(packet)
-                     end
-            decoded_packet = format.map{ |data_type, field_name|
-              begin
-                [field_name, data_type.decode(payload_io)]
-              rescue => e
-                log_debug { "'field_name': #{field_name.inspect}" }
-                raise e
-              end
-            }
-            decoded_packet + decode_recursively(payload_io, decoded_packet)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/version1/data_type.rb

@@ -1,11 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    class Version1
-      module DataType
-        include Common::DataType
-      end
-    end
-  end
-end
-
-require "hrr_rb_sftp/protocol/version1/data_type/attrs"

data/lib/hrr_rb_sftp/protocol/version1/data_type/attrs.rb

@@ -1,54 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    class Version1
-      module DataType
-        class Attrs
-          SSH_FILEXFER_ATTR_SIZE        = 0x00000001
-          SSH_FILEXFER_ATTR_UIDGID      = 0x00000002
-          SSH_FILEXFER_ATTR_PERMISSIONS = 0x00000004
-          SSH_FILEXFER_ATTR_ACMODTIME   = 0x00000008
-          SSH_FILEXFER_ATTR_EXTENDED    = 0x80000000
-
-          def self.encode arg
-            unless arg.kind_of? ::Hash
-              raise ArgumentError, "must be a kind of Hash, but got #{arg.inspect}"
-            end
-
-            flags = 0
-            flags |= SSH_FILEXFER_ATTR_SIZE        if arg.has_key?(:"size")
-            flags |= SSH_FILEXFER_ATTR_UIDGID      if arg.has_key?(:"uid") && arg.has_key?(:"gid")
-            flags |= SSH_FILEXFER_ATTR_PERMISSIONS if arg.has_key?(:"permissions")
-            flags |= SSH_FILEXFER_ATTR_ACMODTIME   if arg.has_key?(:"atime") && arg.has_key?(:"mtime")
-            flags |= SSH_FILEXFER_ATTR_EXTENDED    if arg.has_key?(:"extensions")
-
-            payload  = DataType::Uint32.encode flags
-            payload += DataType::Uint64.encode arg[:"size"]               unless (flags & SSH_FILEXFER_ATTR_SIZE).zero?
-            payload += DataType::Uint32.encode arg[:"uid"]                unless (flags & SSH_FILEXFER_ATTR_UIDGID).zero?
-            payload += DataType::Uint32.encode arg[:"gid"]                unless (flags & SSH_FILEXFER_ATTR_UIDGID).zero?
-            payload += DataType::Uint32.encode arg[:"permissions"]        unless (flags & SSH_FILEXFER_ATTR_PERMISSIONS).zero?
-            payload += DataType::Uint32.encode arg[:"atime"]              unless (flags & SSH_FILEXFER_ATTR_ACMODTIME).zero?
-            payload += DataType::Uint32.encode arg[:"mtime"]              unless (flags & SSH_FILEXFER_ATTR_ACMODTIME).zero?
-            payload += DataType::Uint32.encode arg[:"extensions"].size    unless (flags & SSH_FILEXFER_ATTR_EXTENDED).zero?
-            payload += DataType::ExtensionPairs.encode arg[:"extensions"] unless (flags & SSH_FILEXFER_ATTR_EXTENDED).zero?
-            payload
-          end
-
-          def self.decode io
-            attrs = Hash.new
-            flags                 = DataType::Uint32.decode(io)
-            attrs[:"size"]        = DataType::Uint64.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_SIZE).zero?
-            attrs[:"uid"]         = DataType::Uint32.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_UIDGID).zero?
-            attrs[:"gid"]         = DataType::Uint32.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_UIDGID).zero?
-            attrs[:"permissions"] = DataType::Uint32.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_PERMISSIONS).zero?
-            attrs[:"atime"]       = DataType::Uint32.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_ACMODTIME).zero?
-            attrs[:"mtime"]       = DataType::Uint32.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_ACMODTIME).zero?
-            extended_count        = DataType::Uint32.decode(io)                                   unless (flags & SSH_FILEXFER_ATTR_EXTENDED).zero?
-            attrs[:"extensions"]  = Array.new(extended_count){DataType::ExtensionPair.decode(io)} unless (flags & SSH_FILEXFER_ATTR_EXTENDED).zero?
-            attrs
-          end
-        end
-      end
-    end
-  end
-end
-

data/lib/hrr_rb_sftp/protocol/version1/packet.rb

@@ -1,29 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    class Version1
-      module Packet
-      end
-    end
-  end
-end
-
-require "hrr_rb_sftp/protocol/version1/packet/003_ssh_fxp_open"
-require "hrr_rb_sftp/protocol/version1/packet/004_ssh_fxp_close"
-require "hrr_rb_sftp/protocol/version1/packet/005_ssh_fxp_read"
-require "hrr_rb_sftp/protocol/version1/packet/006_ssh_fxp_write"
-require "hrr_rb_sftp/protocol/version1/packet/007_ssh_fxp_lstat"
-require "hrr_rb_sftp/protocol/version1/packet/008_ssh_fxp_fstat"
-require "hrr_rb_sftp/protocol/version1/packet/009_ssh_fxp_setstat"
-require "hrr_rb_sftp/protocol/version1/packet/010_ssh_fxp_fsetstat"
-require "hrr_rb_sftp/protocol/version1/packet/011_ssh_fxp_opendir"
-require "hrr_rb_sftp/protocol/version1/packet/012_ssh_fxp_readdir"
-require "hrr_rb_sftp/protocol/version1/packet/013_ssh_fxp_remove"
-require "hrr_rb_sftp/protocol/version1/packet/014_ssh_fxp_mkdir"
-require "hrr_rb_sftp/protocol/version1/packet/015_ssh_fxp_rmdir"
-require "hrr_rb_sftp/protocol/version1/packet/016_ssh_fxp_realpath"
-require "hrr_rb_sftp/protocol/version1/packet/017_ssh_fxp_stat"
-require "hrr_rb_sftp/protocol/version1/packet/101_ssh_fxp_status"
-require "hrr_rb_sftp/protocol/version1/packet/102_ssh_fxp_handle"
-require "hrr_rb_sftp/protocol/version1/packet/103_ssh_fxp_data"
-require "hrr_rb_sftp/protocol/version1/packet/104_ssh_fxp_name"
-require "hrr_rb_sftp/protocol/version1/packet/105_ssh_fxp_attrs"

data/lib/hrr_rb_sftp/protocol/version1/packet/004_ssh_fxp_close.rb

@@ -1,44 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_CLOSE
-          include Common::Packetable
-
-          TYPE = 4
-
-          FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"handle"    ],
-          ]
-
-          def respond_to request
-            begin
-              raise "Specified handle does not exist" unless @handles.has_key?(request[:"handle"])
-              handle = request[:"handle"]
-              @handles[handle].close rescue nil
-              @handles.delete(handle)
-              {
-                :"type"          => SSH_FXP_STATUS::TYPE,
-                :"request-id"    => request[:"request-id"],
-                :"code"          => SSH_FXP_STATUS::SSH_FX_OK,
-                :"error message" => "Success",
-                :"language tag"  => "",
-              }
-            rescue => e
-              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
-              {
-                :"type"          => SSH_FXP_STATUS::TYPE,
-                :"request-id"    => request[:"request-id"],
-                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
-                :"error message" => e.message,
-                :"language tag"  => "",
-              }
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/hrr_rb_sftp/protocol/version1/packet/005_ssh_fxp_read.rb

@@ -1,53 +0,0 @@
-module HrrRbSftp
-  class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_READ
-          include Common::Packetable
-
-          TYPE = 5
-
-          FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"handle"    ],
-            [DataType::Uint64, :"offset"    ],
-            [DataType::Uint32, :"len"       ],
-          ]
-
-          def respond_to request
-            begin
-              raise "Specified handle does not exist" unless @handles.has_key?(request[:"handle"])
-              file = @handles[request[:"handle"]]
-              file.pos = request[:"offset"]
-              unless file.eof?
-                {
-                  :"type"          => SSH_FXP_DATA::TYPE,
-                  :"request-id"    => request[:"request-id"],
-                  :"data"          => file.read(request[:"len"]),
-                }
-              else
-                {
-                  :"type"          => SSH_FXP_STATUS::TYPE,
-                  :"request-id"    => request[:"request-id"],
-                  :"code"          => SSH_FXP_STATUS::SSH_FX_EOF,
-                  :"error message" => "End of file",
-                  :"language tag"  => "",
-                }
-              end
-            rescue => e
-              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
-              {
-                :"type"          => SSH_FXP_STATUS::TYPE,
-                :"request-id"    => request[:"request-id"],
-                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
-                :"error message" => e.message,
-                :"language tag"  => "",
-              }
-            end
-          end
-        end
-      end
-    end
-  end
-end