hrr_rb_sftp 0.1.0 → 0.2.0

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/003_ssh_fxp_open.rb

@@ -1,73 +1,88 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_OPEN
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_OPEN packet type, format, and responder.
+        #
+        class SSH_FXP_OPEN < Packet
+
+          #
+          # Represents SSH_FXP_OPEN packet type.
+          #
           TYPE = 3
 
+          #
+          # Represents SSH_FXP_OPEN packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"filename"  ],
-            [DataType::Uint32, :"pflags"    ],
-            [DataType::Attrs,  :"attrs"     ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"filename"  ],
+            [DataTypes::Uint32, :"pflags"    ],
+            [DataTypes::Attrs,  :"attrs"     ],
           ]
 
+          #
+          # Represents SSH_FXF_READ flag.
+          #
           SSH_FXF_READ   = 0x00000001
+
+          #
+          # Represents SSH_FXF_WRITE flag.
+          #
           SSH_FXF_WRITE  = 0x00000002
+
+          #
+          # Represents SSH_FXF_APPEND flag.
+          #
           SSH_FXF_APPEND = 0x00000004
+
+          #
+          # Represents SSH_FXF_CREAT flag.
+          #
           SSH_FXF_CREAT  = 0x00000008
-          SSH_FXF_TRUNC  = 0x00000010
-          SSH_FXF_EXCL   = 0x00000020
 
-          class Error < StandardError
-          end
+          #
+          # Represents SSH_FXF_TRUNC flag.
+          #
+          SSH_FXF_TRUNC  = 0x00000010
 
-          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
+          #
+          # Represents SSH_FXF_EXCL flag.
+          #
+          SSH_FXF_EXCL   = 0x00000020
 
+          #
+          # Responds to SSH_FXP_OPEN request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_OPEN request represented in Hash.
+          #                                       Only permissions attribute is taken care of.
+          #                                       When attrs field contains attributes other than permissions are ignored
+          #                                       and they are expected to be taken care of by subsequent SSH_FXP_SETSTAT and/or SSH_FXP_FSETSTAT requests.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_HANDLE. In other cases, its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
               flags = convert_pflags_to_flags request[:"pflags"]
               args = [request[:"filename"], flags]
-              if request[:"attrs"].has_key?(:"permissions")
+              if (flags & ::File::CREAT == ::File::CREAT) && request[:"attrs"].has_key?(:"permissions")
                 args.push request[:"attrs"][:"permissions"]
               end
+              log_debug { "file = File.open(#{args.map(&:inspect).join(", ")})" }
               file = ::File.open(*args)
+              log_debug { "handle = #{file.object_id.to_s(16).inspect}" }
               handle = file.object_id.to_s(16)
-              @handles[handle] = file
+              log_debug { "handles[#{handle.inspect}] = file" }
+              handles[handle] = file
               {
                 :"type"       => SSH_FXP_HANDLE::TYPE,
                 :"request-id" => request[:"request-id"],
                 :"handle"     => handle,
               }
             rescue Error => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -75,7 +90,8 @@ module HrrRbSftp
                 :"error message" => e.message,
                 :"language tag"  => "",
               }
-            rescue Errno::ENOENT
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -83,7 +99,8 @@ module HrrRbSftp
                 :"error message" => "No such file or directory",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -102,6 +119,40 @@ module HrrRbSftp
               }
             end
           end
+
+          class Error < StandardError
+          end
+
+          private_constant :Error
+
+          private
+
+          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
         end
       end
     end

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

@@ -0,0 +1,61 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_CLOSE packet type, format, and responder.
+        #
+        class SSH_FXP_CLOSE < Packet
+
+          #
+          # Represents SSH_FXP_CLOSE packet type.
+          #
+          TYPE = 4
+
+          #
+          # Represents SSH_FXP_CLOSE packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
+          ]
+
+          #
+          # Responds to SSH_FXP_CLOSE request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_CLOSE request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              raise "Specified handle does not exist" unless handles.has_key?(request[:"handle"])
+              handle = request[:"handle"]
+              log_debug { "handles[#{handle.inspect}].close" }
+              handles[handle].close rescue nil
+              log_debug { "handles.delete(#{handle.inspect})" }
+              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/packets/005_ssh_fxp_read.rb

@@ -0,0 +1,72 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_READ packet type, format, and responder.
+        #
+        class SSH_FXP_READ < Packet
+
+          #
+          # Represents SSH_FXP_READ packet type.
+          #
+          TYPE = 5
+
+          #
+          # Represents SSH_FXP_READ packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
+            [DataTypes::Uint64, :"offset"    ],
+            [DataTypes::Uint32, :"len"       ],
+          ]
+
+          #
+          # Responds to SSH_FXP_READ request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_READ request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_DATA. In other cases, its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              raise "Specified handle does not exist" unless handles.has_key?(request[:"handle"])
+              log_debug { "file = handles[#{request[:"handle"].inspect}]" }
+              file = handles[request[:"handle"]]
+              log_debug { "file.pos = #{request[:"offset"].inspect}" }
+              file.pos = request[:"offset"]
+              unless file.eof?
+                log_debug { "data = file.read(#{request[:"len"].inspect})" }
+                data = file.read(request[:"len"])
+                {
+                  :"type"          => SSH_FXP_DATA::TYPE,
+                  :"request-id"    => request[:"request-id"],
+                  :"data"          => data,
+                }
+              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/packets/006_ssh_fxp_write.rb

@@ -0,0 +1,64 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_WRITE packet type, format, and responder.
+        #
+        class SSH_FXP_WRITE < Packet
+
+          #
+          # Represents SSH_FXP_WRITE packet type.
+          #
+          TYPE = 6
+
+          #
+          # Represents SSH_FXP_WRITE packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
+            [DataTypes::Uint64, :"offset"    ],
+            [DataTypes::String, :"data"      ],
+          ]
+
+          #
+          # Responds to SSH_FXP_WRITE request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_WRITE request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              raise "Specified handle does not exist" unless handles.has_key?(request[:"handle"])
+              log_debug { "file = handles[#{request[:"handle"].inspect}]" }
+              file = handles[request[:"handle"]]
+              log_debug { "file.pos = #{request[:"offset"].inspect}" }
+              file.pos = request[:"offset"]
+              log_debug { "file.write(#{request[:"data"].inspect})" }
+              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 → packets}/007_ssh_fxp_lstat.rb

@@ -1,20 +1,36 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_LSTAT
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_LSTAT packet type, format, and responder.
+        #
+        class SSH_FXP_LSTAT < Packet
+
+          #
+          # Represents SSH_FXP_LSTAT packet type.
+          #
           TYPE = 7
 
+          #
+          # Represents SSH_FXP_LSTAT packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"path"      ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
           ]
 
+          #
+          # Responds to SSH_FXP_LSTAT request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_LSTAT request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_ATTRS. In other cases, its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
+              log_debug { "File.lstat(#{request[:"path"].inspect})" }
               stat = File.lstat(request[:"path"])
               attrs = Hash.new
               attrs[:"size"]        = stat.size       if stat.size
@@ -28,7 +44,8 @@ module HrrRbSftp
                 :"request-id" => request[:"request-id"],
                 :"attrs"      => attrs,
               }
-            rescue Errno::ENOENT
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -36,7 +53,8 @@ module HrrRbSftp
                 :"error message" => "No such file or directory",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],