hrr_rb_sftp 0.1.0 → 0.2.0

data/lib/hrr_rb_sftp/protocol/version3/packets/020_ssh_fxp_symlink.rb

@@ -0,0 +1,76 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_SYMLINK packet type, format, and responder.
+        #
+        class SSH_FXP_SYMLINK < Packets::Packet
+
+          #
+          # Represents SSH_FXP_SYMLINK packet type.
+          #
+          TYPE = 20
+
+          #
+          # Represents SSH_FXP_SYMLINK packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"targetpath"],
+            [DataTypes::String, :"linkpath"  ],
+          ]
+
+          #
+          # Responds to SSH_FXP_SYMLINK request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_SYMLINK request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              log_debug { "File.symlink(#{request[:"targetpath"].inspect}, #{request[:"linkpath"].inspect})" }
+              File.symlink request[:"targetpath"], request[:"linkpath"]
+              {
+                :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_OK,
+                :"error message" => "Success",
+                :"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 Errno::EEXIST => e
+              log_debug { e.message }
+              {
+                :"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"  => "",
+              }
+            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/packets/101_ssh_fxp_status.rb

@@ -0,0 +1,25 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 3 SSH_FXP_STATUS packet type, format, and responder.
+        #
+        class SSH_FXP_STATUS < Version2::Packets::SSH_FXP_STATUS
+
+          #
+          # Represents SSH_FXP_STATUS packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"         ],
+            [DataTypes::Uint32, :"request-id"   ],
+            [DataTypes::Uint32, :"code"         ],
+            [DataTypes::String, :"error message"],
+            [DataTypes::String, :"language tag" ],
+          ]
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version3/packets/200_ssh_fxp_extended.rb

@@ -0,0 +1,95 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_EXTENDED packet type, format, and responder.
+        #
+        class SSH_FXP_EXTENDED < Packets::Packet
+
+          #
+          # Represents SSH_FXP_EXTENDED packet type.
+          #
+          TYPE = 200
+
+          #
+          # Represents SSH_FXP_EXTENDED packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"            ],
+            [DataTypes::Uint32, :"request-id"      ],
+            [DataTypes::String, :"extended-request"],
+          ]
+
+          #
+          # Private method #conditional_format is used instead.
+          #
+          # @example
+          #   {
+          #     :"extended-request" => {
+          #       "hardlink@openssh.com" => [
+          #         [DataTypes::String, :"oldpath"],
+          #         [DataTypes::String, :"newpath"],
+          #       ],
+          #     },
+          #   }
+          #
+          #
+          CONDITIONAL_FORMAT = nil
+
+          #
+          # Responds to SSH_FXP_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
+              if extensions.respond_to? request
+                extensions.respond_to request
+              else
+                {
+                  :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                  :"request-id"    => request[:"request-id"],
+                  :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_OP_UNSUPPORTED,
+                  :"error message" => "Unsupported extended-request: #{request[:"extended-request"]}",
+                  :"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"          => 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
+
+          private
+
+          #
+          # Returns An instance of Extensions.
+          #
+          # @return [Extensions] An instance of Extensions.
+          #
+          def extensions
+            @extensions ||= Protocol.const_get(:"Version#{version}")::Extensions.new(context, logger: logger)
+          end
+
+          #
+          # Overrides Common::Packetable#conditional_format private method and represents SSH_FXP_EXTENDED packet conditional format.
+          #
+          def conditional_format packet
+            packet.inject([]){ |a, (field_name, field_value)|
+              a + ((extensions.conditional_request_format[field_name] || {})[field_value] || [])
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version3/packets/201_ssh_fxp_extended_reply.rb

@@ -0,0 +1,60 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_EXTENDED_REPLY packet type, format, and responder.
+        #
+        class SSH_FXP_EXTENDED_REPLY < Packets::Packet
+
+          #
+          # Represents SSH_FXP_EXTENDED_REPLY packet type.
+          #
+          TYPE = 201
+
+          #
+          # Represents SSH_FXP_EXTENDED_REPLY packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+          ]
+
+          #
+          # Private method #conditional_format is used instead.
+          #
+          # @example
+          #   {
+          #     :"extended-reply" => {
+          #       "hardlink@openssh.com" => [
+          #       ],
+          #     },
+          #   }
+          #
+          CONDITIONAL_FORMAT = nil
+
+          private
+
+          #
+          # Returns An instance of Extensions.
+          #
+          # @return [Extensions] An instance of Extensions.
+          #
+          def extensions
+            @extensions ||= Protocol.const_get(:"Version#{version}")::Extensions.new(context, logger: logger)
+          end
+
+          #
+          # Overrides Common::Packetable#conditional_format private method and represents SSH_FXP_EXTENDED_REPLY packet conditional format.
+          #
+          def conditional_format packet
+            packet.inject([]){ |a, (field_name, field_value)|
+              a + ((extensions.conditional_reply_format[field_name] || {})[field_value] || [])
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/receiver.rb

@@ -1,17 +1,32 @@
 module HrrRbSftp
+
+  #
+  # This class implements payload receiver.
+  #
   class Receiver
+
+    #
+    # Instantiates a new payload receiver for the input IO.
+    #
+    # @param io_in [IO] An IO for input.
+    #
     def initialize io_in
       @io_in = io_in
     end
 
+    #
+    # Receives payload_length payload. When input IO is EOF, returns nil.
+    #
+    # @return [String, nil] Received payload. when input IO is EOF, retruns nil.
+    #
     def receive
       begin
-        paylaod_length = Protocol::Common::DataType::Uint32.decode(@io_in)
+        paylaod_length = Protocol::Common::DataTypes::Uint32.decode(@io_in)
       rescue NoMethodError
         nil
       else
         payload = @io_in.read(paylaod_length)
-        if payload.nil? || payload.length != paylaod_length
+        if payload.nil? || payload.bytesize != paylaod_length
           nil
         else
           payload

data/lib/hrr_rb_sftp/sender.rb

@@ -1,11 +1,25 @@
 module HrrRbSftp
+
+  #
+  # This class implements payload sender.
+  #
   class Sender
+
+    #
+    # Instantiates a new payload sender for the output IO.
+    #
+    # @param io_out [IO] An IO for output.
+    #
     def initialize io_out
       @io_out = io_out
     end
 
+    #
+    # Sends payload_length then payload.
+    # Flushes output IO once payload is sent.
+    #
     def send payload
-      @io_out.write(Protocol::Common::DataType::Uint32.encode(payload.length))
+      @io_out.write(Protocol::Common::DataTypes::Uint32.encode(payload.bytesize))
       @io_out.write(payload)
       @io_out.flush
     end

data/lib/hrr_rb_sftp/server.rb

@@ -1,12 +1,37 @@
 module HrrRbSftp
+
+  #
+  # This class implements SFTP server.
+  #
+  # @example
+  #   # instantiate a server
+  #   server = HrrRbSftp::Server.new(logger: logger)
+  #
+  #   # then start the server with IO arguments
+  #   server.start(io_in, io_out, io_err)
+  #
   class Server
     include Loggable
 
+    #
+    # @param logger [Logger] logger.
+    #
     def initialize logger: nil
       self.logger = logger
     end
 
-    def start io_in, io_out, io_err
+    #
+    # Starts SFTP server.
+    #
+    # @example
+    #   # start a server with IO arguments
+    #   server.start(io_in, io_out, io_err)
+    #
+    # @param io_in  [IO] An IO for input.
+    # @param io_out [IO] An IO for output.
+    # @param io_err [IO] An IO for debug output.
+    #
+    def start io_in, io_out, io_err=nil
       log_info { "start server" }
 
       @io_in  = io_in
@@ -46,7 +71,10 @@ module HrrRbSftp
       version = [remote_version, local_version].min
       log_info { "negotiated version: #{version}" }
 
-      send_fxp_version version
+      extension_pairs = Protocol.extension_pairs(version)
+      log_info { "extension-pairs: #{extension_pairs}" }
+
+      send_fxp_version version, extension_pairs
 
       version
     end
@@ -60,31 +88,34 @@ module HrrRbSftp
         raise "Failed receiving SSH_FXP_INIT"
       end
 
-      packet = Protocol::Common::Packet::SSH_FXP_INIT.new({}, logger: logger).decode payload
+      packet = Protocol::Common::Packets::SSH_FXP_INIT.new(logger: logger).decode payload
       packet[:"version"]
     end
 
-    def send_fxp_version version
+    def send_fxp_version version, extensions
       log_debug { "start send_fxp_version" }
 
       packet = {
-        :"type"       => Protocol::Common::Packet::SSH_FXP_VERSION::TYPE,
+        :"type"       => Protocol::Common::Packets::SSH_FXP_VERSION::TYPE,
         :"version"    => version,
-        :"extensions" => [],
+        :"extensions" => extensions,
       }
-      payload = Protocol::Common::Packet::SSH_FXP_VERSION.new({}, logger: logger).encode packet
+      payload = Protocol::Common::Packets::SSH_FXP_VERSION.new(logger: logger).encode packet
       @sender.send payload
     end
 
     def respond_to_requests
       log_info { "start respond_to_requests" }
 
-      log_info { "start request and response loop" }
-      while request = @receiver.receive
-        response = @protocol.respond_to request
-        @sender.send response
+      begin
+        log_info { "start request and response loop" }
+        while request = @receiver.receive
+          response = @protocol.respond_to request
+          @sender.send response
+        end
+      ensure
+        log_info { "request and response loop finished" }
       end
-      log_info { "request and response loop finished" }
     end
 
     def close_handles

data/lib/hrr_rb_sftp/version.rb

@@ -1,3 +1,7 @@
 module HrrRbSftp
-  VERSION = "0.1.0"
+
+  #
+  # hrr_rb_sftp library version.
+  #
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hrr_rb_sftp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - hirura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-07 00:00:00.000000000 Z
+date: 2020-06-20 00:00:00.000000000 Z
 dependencies: []
 description: Pure Ruby SFTP server implementation.
 email:
@@ -35,54 +35,61 @@ files:
 - lib/hrr_rb_sftp/loggable.rb
 - lib/hrr_rb_sftp/protocol.rb
 - lib/hrr_rb_sftp/protocol/common.rb
-- lib/hrr_rb_sftp/protocol/common/data_type.rb
-- lib/hrr_rb_sftp/protocol/common/data_type/byte.rb
-- lib/hrr_rb_sftp/protocol/common/data_type/extension_pair.rb
-- lib/hrr_rb_sftp/protocol/common/data_type/extension_pairs.rb
-- lib/hrr_rb_sftp/protocol/common/data_type/string.rb
-- lib/hrr_rb_sftp/protocol/common/data_type/uint32.rb
-- lib/hrr_rb_sftp/protocol/common/data_type/uint64.rb
-- lib/hrr_rb_sftp/protocol/common/packet.rb
-- lib/hrr_rb_sftp/protocol/common/packet/001_ssh_fxp_init.rb
-- lib/hrr_rb_sftp/protocol/common/packet/002_ssh_fxp_version.rb
-- lib/hrr_rb_sftp/protocol/common/packetable.rb
+- lib/hrr_rb_sftp/protocol/common/data_types.rb
+- lib/hrr_rb_sftp/protocol/common/data_types/byte.rb
+- lib/hrr_rb_sftp/protocol/common/data_types/extension_pair.rb
+- lib/hrr_rb_sftp/protocol/common/data_types/extension_pairs.rb
+- lib/hrr_rb_sftp/protocol/common/data_types/string.rb
+- lib/hrr_rb_sftp/protocol/common/data_types/uint32.rb
+- lib/hrr_rb_sftp/protocol/common/data_types/uint64.rb
+- lib/hrr_rb_sftp/protocol/common/packets.rb
+- lib/hrr_rb_sftp/protocol/common/packets/001_ssh_fxp_init.rb
+- lib/hrr_rb_sftp/protocol/common/packets/002_ssh_fxp_version.rb
+- lib/hrr_rb_sftp/protocol/common/packets/packet.rb
 - lib/hrr_rb_sftp/protocol/version1.rb
-- lib/hrr_rb_sftp/protocol/version1/data_type.rb
-- lib/hrr_rb_sftp/protocol/version1/data_type/attrs.rb
-- lib/hrr_rb_sftp/protocol/version1/packet.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/003_ssh_fxp_open.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/004_ssh_fxp_close.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/005_ssh_fxp_read.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/006_ssh_fxp_write.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/007_ssh_fxp_lstat.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/008_ssh_fxp_fstat.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/009_ssh_fxp_setstat.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/010_ssh_fxp_fsetstat.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/011_ssh_fxp_opendir.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/012_ssh_fxp_readdir.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/013_ssh_fxp_remove.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/014_ssh_fxp_mkdir.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/015_ssh_fxp_rmdir.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/016_ssh_fxp_realpath.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/017_ssh_fxp_stat.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/101_ssh_fxp_status.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/102_ssh_fxp_handle.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/103_ssh_fxp_data.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/104_ssh_fxp_name.rb
-- lib/hrr_rb_sftp/protocol/version1/packet/105_ssh_fxp_attrs.rb
+- lib/hrr_rb_sftp/protocol/version1/data_types.rb
+- lib/hrr_rb_sftp/protocol/version1/data_types/attrs.rb
+- lib/hrr_rb_sftp/protocol/version1/packets.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/003_ssh_fxp_open.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/004_ssh_fxp_close.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/005_ssh_fxp_read.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/006_ssh_fxp_write.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/007_ssh_fxp_lstat.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/008_ssh_fxp_fstat.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/009_ssh_fxp_setstat.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/010_ssh_fxp_fsetstat.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/011_ssh_fxp_opendir.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/012_ssh_fxp_readdir.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/013_ssh_fxp_remove.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/014_ssh_fxp_mkdir.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/015_ssh_fxp_rmdir.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/016_ssh_fxp_realpath.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/017_ssh_fxp_stat.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/101_ssh_fxp_status.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/102_ssh_fxp_handle.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/103_ssh_fxp_data.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/104_ssh_fxp_name.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/105_ssh_fxp_attrs.rb
+- lib/hrr_rb_sftp/protocol/version1/packets/packet.rb
 - lib/hrr_rb_sftp/protocol/version2.rb
-- lib/hrr_rb_sftp/protocol/version2/data_type.rb
-- lib/hrr_rb_sftp/protocol/version2/packet.rb
-- lib/hrr_rb_sftp/protocol/version2/packet/018_ssh_fxp_rename.rb
+- lib/hrr_rb_sftp/protocol/version2/data_types.rb
+- lib/hrr_rb_sftp/protocol/version2/packets.rb
+- lib/hrr_rb_sftp/protocol/version2/packets/018_ssh_fxp_rename.rb
 - lib/hrr_rb_sftp/protocol/version3.rb
-- lib/hrr_rb_sftp/protocol/version3/data_type.rb
-- lib/hrr_rb_sftp/protocol/version3/packet.rb
-- lib/hrr_rb_sftp/protocol/version3/packet/014_ssh_fxp_mkdir.rb
-- lib/hrr_rb_sftp/protocol/version3/packet/019_ssh_fxp_readlink.rb
-- lib/hrr_rb_sftp/protocol/version3/packet/020_ssh_fxp_symlink.rb
-- lib/hrr_rb_sftp/protocol/version3/packet/101_ssh_fxp_status.rb
-- lib/hrr_rb_sftp/protocol/version3/packet/200_ssh_fxp_extended.rb
-- lib/hrr_rb_sftp/protocol/version3/packet/201_ssh_fxp_extended_reply.rb
+- lib/hrr_rb_sftp/protocol/version3/data_types.rb
+- lib/hrr_rb_sftp/protocol/version3/extensions.rb
+- lib/hrr_rb_sftp/protocol/version3/extensions/extension.rb
+- lib/hrr_rb_sftp/protocol/version3/extensions/fsync_at_openssh_com.rb
+- lib/hrr_rb_sftp/protocol/version3/extensions/hardlink_at_openssh_com.rb
+- lib/hrr_rb_sftp/protocol/version3/extensions/lsetstat_at_openssh_com.rb
+- lib/hrr_rb_sftp/protocol/version3/extensions/posix_rename_at_openssh_com.rb
+- lib/hrr_rb_sftp/protocol/version3/packets.rb
+- lib/hrr_rb_sftp/protocol/version3/packets/014_ssh_fxp_mkdir.rb
+- lib/hrr_rb_sftp/protocol/version3/packets/019_ssh_fxp_readlink.rb
+- lib/hrr_rb_sftp/protocol/version3/packets/020_ssh_fxp_symlink.rb
+- lib/hrr_rb_sftp/protocol/version3/packets/101_ssh_fxp_status.rb
+- lib/hrr_rb_sftp/protocol/version3/packets/200_ssh_fxp_extended.rb
+- lib/hrr_rb_sftp/protocol/version3/packets/201_ssh_fxp_extended_reply.rb
 - lib/hrr_rb_sftp/receiver.rb
 - lib/hrr_rb_sftp/sender.rb
 - lib/hrr_rb_sftp/server.rb