hrr_rb_sftp 0.1.0

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

@@ -0,0 +1,58 @@
+module HrrRbSftp
+  class Protocol
+    class Version3
+      module Packet
+        class SSH_FXP_SYMLINK
+          include Common::Packetable
+
+          TYPE = 20
+
+          FORMAT = [
+            [DataType::Byte,   :"type"      ],
+            [DataType::Uint32, :"request-id"],
+            [DataType::String, :"linkpath"  ],
+            [DataType::String, :"targetpath"],
+          ]
+
+          def respond_to request
+            begin
+              File.symlink request[:"targetpath"], request[:"linkpath"]
+              {
+                :"type"          => Packet::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packet::SSH_FXP_STATUS::SSH_FX_OK,
+                :"error message" => "Success",
+                :"language tag"  => "",
+              }
+            rescue Errno::EACCES
+              {
+                :"type"          => Packet::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packet::SSH_FXP_STATUS::SSH_FX_PERMISSION_DENIED,
+                :"error message" => "Permission denied",
+                :"language tag"  => "",
+              }
+            rescue Errno::EEXIST
+              {
+                :"type"          => Packet::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packet::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"          => Packet::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packet::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/packet/101_ssh_fxp_status.rb

@@ -0,0 +1,31 @@
+module HrrRbSftp
+  class Protocol
+    class Version3
+      module Packet
+        class SSH_FXP_STATUS
+          include Common::Packetable
+
+          TYPE = 101
+
+          FORMAT = [
+            [DataType::Byte,   :"type"         ],
+            [DataType::Uint32, :"request-id"   ],
+            [DataType::Uint32, :"code"         ],
+            [DataType::String, :"error message"],
+            [DataType::String, :"language tag" ],
+          ]
+
+          SSH_FX_OK                = 0
+          SSH_FX_EOF               = 1
+          SSH_FX_NO_SUCH_FILE      = 2
+          SSH_FX_PERMISSION_DENIED = 3
+          SSH_FX_FAILURE           = 4
+          SSH_FX_BAD_MESSAGE       = 5
+          SSH_FX_NO_CONNECTION     = 6
+          SSH_FX_CONNECTION_LOST   = 7
+          SSH_FX_OP_UNSUPPORTED    = 8
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module HrrRbSftp
+  class Protocol
+    class Version3
+      module Packet
+        class SSH_FXP_EXTENDED
+          include Common::Packetable
+
+          TYPE = 200
+
+          FORMAT = [
+            [DataType::Byte,   :"type"            ],
+            [DataType::Uint32, :"request-id"      ],
+            [DataType::String, :"extended-request"],
+          ]
+
+          CONDITIONAL_FORMAT = {
+            :"extended-request" => {
+            },
+          }
+
+          def respond_to request
+            {
+              :"type"          => Packet::SSH_FXP_STATUS::TYPE,
+              :"request-id"    => request[:"request-id"],
+              :"code"          => Packet::SSH_FXP_STATUS::SSH_FX_OP_UNSUPPORTED,
+              :"error message" => "Unsupported extended-request: #{request[:"extended-request"]}",
+              :"language tag"  => "",
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module HrrRbSftp
+  class Protocol
+    class Version3
+      module Packet
+        class SSH_FXP_EXTENDED_REPLY
+          include Common::Packetable
+
+          TYPE = 201
+
+          FORMAT = [
+            [DataType::Byte,   :"type"      ],
+            [DataType::Uint32, :"request-id"],
+          ]
+
+          CONDITIONAL_FORMAT = {
+            :"extended-request" => {
+            },
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/receiver.rb

@@ -0,0 +1,22 @@
+module HrrRbSftp
+  class Receiver
+    def initialize io_in
+      @io_in = io_in
+    end
+
+    def receive
+      begin
+        paylaod_length = Protocol::Common::DataType::Uint32.decode(@io_in)
+      rescue NoMethodError
+        nil
+      else
+        payload = @io_in.read(paylaod_length)
+        if payload.nil? || payload.length != paylaod_length
+          nil
+        else
+          payload
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/sender.rb

@@ -0,0 +1,13 @@
+module HrrRbSftp
+  class Sender
+    def initialize io_out
+      @io_out = io_out
+    end
+
+    def send payload
+      @io_out.write(Protocol::Common::DataType::Uint32.encode(payload.length))
+      @io_out.write(payload)
+      @io_out.flush
+    end
+  end
+end

data/lib/hrr_rb_sftp/server.rb

@@ -0,0 +1,96 @@
+module HrrRbSftp
+  class Server
+    include Loggable
+
+    def initialize logger: nil
+      self.logger = logger
+    end
+
+    def start io_in, io_out, io_err
+      log_info { "start server" }
+
+      @io_in  = io_in
+      @io_out = io_out
+      @io_err = io_err
+
+      @receiver = Receiver.new(@io_in)
+      @sender   = Sender.new(@io_out)
+
+      @version = negotiate_version
+
+      @protocol = Protocol.new(@version, logger: logger)
+
+      begin
+        respond_to_requests
+      rescue => e
+        log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+        raise
+      ensure
+        close_handles
+      end
+
+      log_info { "server finished" }
+    end
+
+    private
+
+    def negotiate_version
+      log_info { "start negotiate_version" }
+
+      remote_version = receive_fxp_init
+      log_info { "remote version: #{remote_version}" }
+
+      local_version = Protocol.versions.max
+      log_info { "local version: #{local_version}" }
+
+      version = [remote_version, local_version].min
+      log_info { "negotiated version: #{version}" }
+
+      send_fxp_version version
+
+      version
+    end
+
+    def receive_fxp_init
+      log_debug { "start receive_fxp_init" }
+
+      payload = @receiver.receive
+
+      if payload.nil?
+        raise "Failed receiving SSH_FXP_INIT"
+      end
+
+      packet = Protocol::Common::Packet::SSH_FXP_INIT.new({}, logger: logger).decode payload
+      packet[:"version"]
+    end
+
+    def send_fxp_version version
+      log_debug { "start send_fxp_version" }
+
+      packet = {
+        :"type"       => Protocol::Common::Packet::SSH_FXP_VERSION::TYPE,
+        :"version"    => version,
+        :"extensions" => [],
+      }
+      payload = Protocol::Common::Packet::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
+      end
+      log_info { "request and response loop finished" }
+    end
+
+    def close_handles
+      log_info { "closing handles" }
+      @protocol.close_handles
+      log_info { "handles closed" }
+    end
+  end
+end

data/lib/hrr_rb_sftp/version.rb

@@ -0,0 +1,3 @@
+module HrrRbSftp
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: hrr_rb_sftp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hirura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-07 00:00:00.000000000 Z
+dependencies: []
+description: Pure Ruby SFTP server implementation.
+email:
+- hirura@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- demo/hrr_rb_sftp_server.rb
+- demo/instantiate_hrr_rb_sftp_server.rb
+- demo/spawn_hrr_rb_sftp_server.rb
+- hrr_rb_sftp.gemspec
+- lib/hrr_rb_sftp.rb
+- 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/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/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/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/receiver.rb
+- lib/hrr_rb_sftp/sender.rb
+- lib/hrr_rb_sftp/server.rb
+- lib/hrr_rb_sftp/version.rb
+homepage: https://github.com/hirura/hrr_rb_sftp
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hirura/hrr_rb_sftp
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.3
+signing_key: 
+specification_version: 4
+summary: Pure Ruby SFTP server implementation.
+test_files: []