hrr_rb_sftp 0.1.0

data/lib/hrr_rb_sftp/protocol/version1.rb

@@ -0,0 +1,10 @@
+module HrrRbSftp
+  class Protocol
+    class Version1
+      PROTOCOL_VERSION = 1
+    end
+  end
+end
+
+require "hrr_rb_sftp/protocol/version1/data_type"
+require "hrr_rb_sftp/protocol/version1/packet"

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

@@ -0,0 +1,11 @@
+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

@@ -0,0 +1,54 @@
+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

@@ -0,0 +1,29 @@
+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/003_ssh_fxp_open.rb

@@ -0,0 +1,109 @@
+module HrrRbSftp
+  class Protocol
+    class Version1
+      module Packet
+        class SSH_FXP_OPEN
+          include Common::Packetable
+
+          TYPE = 3
+
+          FORMAT = [
+            [DataType::Byte,   :"type"      ],
+            [DataType::Uint32, :"request-id"],
+            [DataType::String, :"filename"  ],
+            [DataType::Uint32, :"pflags"    ],
+            [DataType::Attrs,  :"attrs"     ],
+          ]
+
+          SSH_FXF_READ   = 0x00000001
+          SSH_FXF_WRITE  = 0x00000002
+          SSH_FXF_APPEND = 0x00000004
+          SSH_FXF_CREAT  = 0x00000008
+          SSH_FXF_TRUNC  = 0x00000010
+          SSH_FXF_EXCL   = 0x00000020
+
+          class Error < StandardError
+          end
+
+          def convert_pflags_to_flags pflags
+            flags = 0
+            if ((pflags & SSH_FXF_READ) == SSH_FXF_READ) && ((pflags & SSH_FXF_WRITE) == SSH_FXF_WRITE)
+              flags |= ::File::RDWR
+            elsif (pflags & SSH_FXF_READ) == SSH_FXF_READ
+              flags |= ::File::RDONLY
+            elsif (pflags & SSH_FXF_WRITE) == SSH_FXF_WRITE
+              flags |= ::File::WRONLY
+            else
+              raise Error, "At least SSH_FXF_READ or SSH_FXF_READ must be specified"
+            end
+            if (pflags & SSH_FXF_APPEND) == SSH_FXF_APPEND
+              flags |= ::File::APPEND
+            end
+            if (pflags & SSH_FXF_CREAT) == SSH_FXF_CREAT
+              flags |= ::File::CREAT
+              flags |= ::File::TRUNC if (pflags & SSH_FXF_TRUNC) == SSH_FXF_TRUNC
+              flags |= ::File::EXCL  if (pflags & SSH_FXF_EXCL ) == SSH_FXF_EXCL
+            elsif (pflags & SSH_FXF_TRUNC) == SSH_FXF_TRUNC
+              raise Error, "SSH_FXF_CREAT MUST also be specified when SSH_FXF_TRUNC is specified"
+            elsif (pflags & SSH_FXF_EXCL) == SSH_FXF_EXCL
+              raise Error, "SSH_FXF_CREAT MUST also be specified when SSH_FXF_EXCL is specified"
+            end
+            flags |= ::File::BINARY
+            flags
+          end
+
+          def respond_to request
+            begin
+              flags = convert_pflags_to_flags request[:"pflags"]
+              args = [request[:"filename"], flags]
+              if request[:"attrs"].has_key?(:"permissions")
+                args.push request[:"attrs"][:"permissions"]
+              end
+              file = ::File.open(*args)
+              handle = file.object_id.to_s(16)
+              @handles[handle] = file
+              {
+                :"type"       => SSH_FXP_HANDLE::TYPE,
+                :"request-id" => request[:"request-id"],
+                :"handle"     => handle,
+              }
+            rescue Error => e
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
+                :"error message" => e.message,
+                :"language tag"  => "",
+              }
+            rescue Errno::ENOENT
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_NO_SUCH_FILE,
+                :"error message" => "No such file or directory",
+                :"language tag"  => "",
+              }
+            rescue Errno::EACCES
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_PERMISSION_DENIED,
+                :"error message" => "Permission denied",
+                :"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/004_ssh_fxp_close.rb

@@ -0,0 +1,44 @@
+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

@@ -0,0 +1,53 @@
+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

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

@@ -0,0 +1,46 @@
+module HrrRbSftp
+  class Protocol
+    class Version1
+      module Packet
+        class SSH_FXP_WRITE
+          include Common::Packetable
+
+          TYPE = 6
+
+          FORMAT = [
+            [DataType::Byte,   :"type"      ],
+            [DataType::Uint32, :"request-id"],
+            [DataType::String, :"handle"    ],
+            [DataType::Uint64, :"offset"    ],
+            [DataType::String, :"data"      ],
+          ]
+
+          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"]
+              file.write request[:"data"]
+              {
+                :"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/007_ssh_fxp_lstat.rb

@@ -0,0 +1,62 @@
+module HrrRbSftp
+  class Protocol
+    class Version1
+      module Packet
+        class SSH_FXP_LSTAT
+          include Common::Packetable
+
+          TYPE = 7
+
+          FORMAT = [
+            [DataType::Byte,   :"type"      ],
+            [DataType::Uint32, :"request-id"],
+            [DataType::String, :"path"      ],
+          ]
+
+          def respond_to request
+            begin
+              stat = File.lstat(request[:"path"])
+              attrs = Hash.new
+              attrs[:"size"]        = stat.size       if stat.size
+              attrs[:"uid"]         = stat.uid        if stat.uid
+              attrs[:"gid"]         = stat.gid        if stat.gid
+              attrs[:"permissions"] = stat.mode       if stat.mode
+              attrs[:"atime"]       = stat.atime.to_i if stat.atime
+              attrs[:"mtime"]       = stat.mtime.to_i if stat.mtime
+              {
+                :"type"       => SSH_FXP_ATTRS::TYPE,
+                :"request-id" => request[:"request-id"],
+                :"attrs"      => attrs,
+              }
+            rescue Errno::ENOENT
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_NO_SUCH_FILE,
+                :"error message" => "No such file or directory",
+                :"language tag"  => "",
+              }
+            rescue Errno::EACCES
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_PERMISSION_DENIED,
+                :"error message" => "Permission denied",
+                :"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/008_ssh_fxp_fstat.rb

@@ -0,0 +1,48 @@
+module HrrRbSftp
+  class Protocol
+    class Version1
+      module Packet
+        class SSH_FXP_FSTAT
+          include Common::Packetable
+
+          TYPE = 8
+
+          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"])
+              file = @handles[request[:"handle"]]
+              stat = file.stat
+              attrs = Hash.new
+              attrs[:"size"]        = stat.size       if stat.size
+              attrs[:"uid"]         = stat.uid        if stat.uid
+              attrs[:"gid"]         = stat.gid        if stat.gid
+              attrs[:"permissions"] = stat.mode       if stat.mode
+              attrs[:"atime"]       = stat.atime.to_i if stat.atime
+              attrs[:"mtime"]       = stat.mtime.to_i if stat.mtime
+              {
+                :"type"       => SSH_FXP_ATTRS::TYPE,
+                :"request-id" => request[:"request-id"],
+                :"attrs"      => attrs,
+              }
+            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