hrr_rb_sftp 0.1.0 → 0.2.0

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

@@ -0,0 +1,57 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements base packet operations and is to be inherited by each packet class.
+        #
+        class Packet < Common::Packets::Packet
+
+          #
+          # Returns a new instance of a class that includes this module.
+          #
+          # @param context [Hash] Contextual variables.
+          #   - :version (Integer) - Negotiated protocol version.
+          #   - :handles (Hash\\{String=>File, Dir\}) - Opened handles.
+          # @param logger [Logger] Logger.
+          #
+          def initialize context, logger: nil
+            super logger: logger
+
+            @context = context
+          end
+
+          #
+          # Returns contextual variables.
+          #
+          # @return [Hash] Contextual variables.
+          #   - :version (Integer) - Negotiated protocol version.
+          #   - :handles (Hash\\{String=>File, Dir\}) - Opened handles.
+          #
+          def context
+            @context
+          end
+
+          #
+          # Returns Negotiated protocol version.
+          #
+          # @return [Integer] Negotiated protocol version.
+          #
+          def version
+            @context[:version]
+          end
+
+          #
+          # Returns opened handles.
+          #
+          # @return [Hash{String=>File, Dir}] Opened handles.
+          #
+          def handles
+            @context[:handles]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version2.rb

@@ -1,10 +1,18 @@
 module HrrRbSftp
   class Protocol
-    class Version2
+
+    #
+    # This module implements SFTP protocol version 2 packet types, formats, and responders.
+    #
+    module Version2
+
+      #
+      # Represents SFTP protocol version 2.
+      #
       PROTOCOL_VERSION = 2
     end
   end
 end
 
-require "hrr_rb_sftp/protocol/version2/data_type"
-require "hrr_rb_sftp/protocol/version2/packet"
+require "hrr_rb_sftp/protocol/version2/data_types"
+require "hrr_rb_sftp/protocol/version2/packets"

data/lib/hrr_rb_sftp/protocol/version2/data_types.rb

@@ -0,0 +1,13 @@
+module HrrRbSftp
+  class Protocol
+    module Version2
+
+      #
+      # This module implements SFTP protocol version 2 data types to be used to encode or decode packet.
+      #
+      module DataTypes
+        include Version1::DataTypes
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version2/packets.rb

@@ -0,0 +1,14 @@
+module HrrRbSftp
+  class Protocol
+    module Version2
+
+      #
+      # This class implements SFTP protocol version 2 packet types, formats, and responders.
+      #
+      class Packets < Version1::Packets
+      end
+    end
+  end
+end
+
+require "hrr_rb_sftp/protocol/version2/packets/018_ssh_fxp_rename"

data/lib/hrr_rb_sftp/protocol/version2/packets/018_ssh_fxp_rename.rb

@@ -0,0 +1,91 @@
+module HrrRbSftp
+  class Protocol
+    module Version2
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 2 SSH_FXP_RENAME packet type, format, and responder.
+        #
+        class SSH_FXP_RENAME < Packets::Packet
+
+          #
+          # Represents SSH_FXP_RENAME packet type.
+          #
+          TYPE = 18
+
+          #
+          # Represents SSH_FXP_RENAME packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"oldpath"   ],
+            [DataTypes::String, :"newpath"   ],
+          ]
+
+          #
+          # Responds to SSH_FXP_RENAME request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_RENAME request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              oldpath = request[:"oldpath"]
+              newpath = request[:"newpath"]
+              log_debug { "File.exist?(#{newpath.inspect})" }
+              if File.exist?(newpath)
+                log_debug { "File exists" }
+                {
+                  :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                  :"request-id"    => request[:"request-id"],
+                  :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_FAILURE,
+                  :"error message" => "File exists",
+                  :"language tag"  => "",
+                }
+              else
+                log_debug { "File does not exist" }
+                log_debug { "File.rename(#{oldpath.inspect}, #{newpath.inspect})" }
+                File.rename(oldpath, newpath)
+                {
+                  :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                  :"request-id"    => request[:"request-id"],
+                  :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_OK,
+                  :"error message" => "Success",
+                  :"language tag"  => "",
+                }
+              end
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
+              {
+                :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_NO_SUCH_FILE,
+                :"error message" => "No such file or directory",
+                :"language tag"  => "",
+              }
+            rescue Errno::EACCES => e
+              log_debug { e.message }
+              {
+                :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packets::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"          => Packets::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packets::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/version3.rb

@@ -1,10 +1,19 @@
 module HrrRbSftp
   class Protocol
-    class Version3
+
+    #
+    # This module implements SFTP protocol version 3 packet types, formats, and responders.
+    #
+    module Version3
+
+      #
+      # Represents SFTP protocol version 3.
+      #
       PROTOCOL_VERSION = 3
     end
   end
 end
 
-require "hrr_rb_sftp/protocol/version3/data_type"
-require "hrr_rb_sftp/protocol/version3/packet"
+require "hrr_rb_sftp/protocol/version3/data_types"
+require "hrr_rb_sftp/protocol/version3/extensions"
+require "hrr_rb_sftp/protocol/version3/packets"

data/lib/hrr_rb_sftp/protocol/version3/data_types.rb

@@ -0,0 +1,13 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+
+      #
+      # This module implements SFTP protocol version 3 data types to be used to encode or decode packet.
+      #
+      module DataTypes
+        include Version2::DataTypes
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version3/extensions.rb

@@ -0,0 +1,94 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+
+      #
+      # This class implements SFTP protocol version 3 extension formats and responders.
+      #
+      class Extensions
+        include Loggable
+
+        #
+        # @return [Array<Class>] A list of classes that has EXTENSION_NAME constant.
+        #
+        def self.extension_classes
+          constants.map{|c| const_get(c)}.select{|c| c.respond_to?(:const_defined?) && c.const_defined?(:EXTENSION_NAME)}
+        end
+
+        #
+        # @return [Array] A list of extension-pair that the library supports.
+        #
+        def self.extension_pairs
+          extension_classes.map{|c| {:"extension-name" => c::EXTENSION_NAME, :"extension-data" => c::EXTENSION_DATA}}
+        end
+
+        #
+        # @param context [Hash] Contextual variables.
+        #   - :version (Integer) - Negotiated protocol version.
+        #   - :handles (Hash\\{String=>File, Dir\}) - Opened handles.
+        # @param logger [Logger] Logger.
+        #
+        def initialize context, logger: nil
+          self.logger = logger
+
+          @conditional_request_format = conditional_request_format
+          @conditional_reply_format   = conditional_reply_format
+          @extensions = extension_classes.map{ |c|
+                          extension = c.new(context, logger: logger)
+                          (c::REQUEST_FORMAT[:"extended-request"] || {}).keys.map{|key| {key => extension} }.inject({}, :merge)
+                        }.inject({}, :merge)
+        end
+
+        #
+        # @return [Boolean] true if request's extended-request is supported. false if not.
+        #
+        def respond_to? request
+          extended_request = request[:"extended-request"]
+          @extensions.has_key?(extended_request)
+        end
+
+        #
+        # @return [Hash{Symbol=>Object] Response represented in Hash.
+        #
+        def respond_to request
+          extended_request = request[:"extended-request"]
+          @extensions[extended_request].respond_to request
+        end
+
+        #
+        # @return [Hash{Symbol=>Hash{String=>Array<Array(Object, Symbol)>}}] Conditional format used in extended-request packet.
+        #
+        def conditional_request_format
+          @conditional_request_format ||= request_formats.inject({}){|h1,h2| h1.merge(h2){|k,v1,v2| v1.merge(v2)}}
+        end
+
+        #
+        # @return [Hash{Symbol=>Hash{String=>Array<Array(Object, Symbol)>}}] Conditional format used in extended-reply packet.
+        #
+        def conditional_reply_format
+          @conditional_reply_format ||= reply_formats.inject({}){|h1,h2| h1.merge(h2){|k,v1,v2| v1.merge(v2)}}
+        end
+
+        private
+
+        def extension_classes
+          self.class.constants.map{|c| self.class.const_get(c)}.select{|c| c.respond_to?(:const_defined?) && c.const_defined?(:EXTENSION_NAME)}
+        end
+
+        def request_formats
+          extension_classes.map{|c| c.const_defined?(:REQUEST_FORMAT) ? c::REQUEST_FORMAT : {}}
+        end
+
+        def reply_formats
+          extension_classes.map{|c| c.const_defined?(:REPLY_FORMAT) ? c::REPLY_FORMAT : {}}
+        end
+      end
+    end
+  end
+end
+
+require "hrr_rb_sftp/protocol/version3/extensions/extension"
+require "hrr_rb_sftp/protocol/version3/extensions/hardlink_at_openssh_com"
+require "hrr_rb_sftp/protocol/version3/extensions/fsync_at_openssh_com"
+require "hrr_rb_sftp/protocol/version3/extensions/posix_rename_at_openssh_com"
+require "hrr_rb_sftp/protocol/version3/extensions/lsetstat_at_openssh_com"

data/lib/hrr_rb_sftp/protocol/version3/extensions/extension.rb

@@ -0,0 +1,58 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Extensions
+
+        #
+        # This class implements base extension operations and is to be inherited by each extension class.
+        #
+        class Extension
+          include Loggable
+
+          #
+          # Returns a new instance of a class that includes this module.
+          #
+          # @param context [Hash] Contextual variables.
+          #   - :version (Integer) - Negotiated protocol version.
+          #   - :handles (Hash\\{String=>File, Dir\}) - Opened handles.
+          # @param logger [Logger] Logger.
+          #
+          def initialize context, logger: nil
+            self.logger = logger
+
+            @context = context
+          end
+
+          #
+          # Returns contextual variables.
+          #
+          # @return [Hash] Contextual variables.
+          #   - :version (Integer) - Negotiated protocol version.
+          #   - :handles (Hash\\{String=>File, Dir\}) - Opened handles.
+          #
+          def context
+            @context
+          end
+
+          #
+          # Returns Negotiated protocol version.
+          #
+          # @return [Integer] Negotiated protocol version.
+          #
+          def version
+            @context[:version]
+          end
+
+          #
+          # Returns opened handles.
+          #
+          # @return [Hash{String=>File, Dir}] Opened handles.
+          #
+          def handles
+            @context[:handles]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version3/extensions/fsync_at_openssh_com.rb

@@ -0,0 +1,59 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Extensions
+
+        #
+        # This class implements fsync@openssh.com version 1 extension format and responder.
+        #
+        class FsyncAtOpensshCom < Extension
+
+          #
+          # Represents fsync@openssh.com version 1 extension name.
+          #
+          EXTENSION_NAME = "fsync@openssh.com"
+
+          #
+          # Represents fsync@openssh.com version 1 extension data.
+          #
+          EXTENSION_DATA = "1"
+
+          #
+          # Represents SSH_FXP_EXTENDED packet additional format for fsync@openssh.com version 1 extension.
+          #
+          REQUEST_FORMAT = {
+            :"extended-request" => {
+              "fsync@openssh.com" => [
+                [DataTypes::String, :"handle"],
+              ],
+            },
+          }
+
+          #
+          # Responds to SSH_FXP_EXTENDED request with fsync@openssh.com extended-request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_EXTENDED 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.fsync" }
+              file.fsync
+              {
+                :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_OK,
+                :"error message" => "Success",
+                :"language tag"  => "",
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end
+