hrr_rb_sftp 0.1.0 → 0.2.0

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

@@ -0,0 +1,84 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Extensions
+
+        #
+        # This class implements hardlink@openssh.com version 1 extension format and responder.
+        #
+        class HardlinkAtOpensshCom < Extension
+
+          #
+          # Represents hardlink@openssh.com version 1 extension name.
+          #
+          EXTENSION_NAME = "hardlink@openssh.com"
+
+          #
+          # Represents hardlink@openssh.com version 1 extension data.
+          #
+          EXTENSION_DATA = "1"
+
+          #
+          # Represents SSH_FXP_EXTENDED packet additional format for hardlink@openssh.com version 1 extension.
+          #
+          REQUEST_FORMAT = {
+            :"extended-request" => {
+              "hardlink@openssh.com" => [
+                [DataTypes::String, :"oldpath"],
+                [DataTypes::String, :"newpath"],
+              ],
+            },
+          }
+
+          #
+          # Responds to SSH_FXP_EXTENDED request with hardlink@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
+              log_debug { "File.link(#{request[:"oldpath"].inspect}, #{request[:"newpath"].inspect})" }
+              File.link(request[:"oldpath"], request[:"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"  => "",
+              }
+            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 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"  => "",
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,132 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Extensions
+
+        #
+        # This class implements lsetstat@openssh.com version 1 extension format and responder.
+        #
+        class LsetstatAtOpensshCom < Extension
+
+          #
+          # Represents lsetstat@openssh.com version 1 extension name.
+          #
+          EXTENSION_NAME = "lsetstat@openssh.com"
+
+          #
+          # Represents lsetstat@openssh.com version 1 extension data.
+          #
+          EXTENSION_DATA = "1"
+
+          #
+          # Represents SSH_FXP_EXTENDED packet additional format for lsetstat@openssh.com version 1 extension.
+          #
+          REQUEST_FORMAT = {
+            :"extended-request" => {
+              "lsetstat@openssh.com" => [
+                [DataTypes::String, :"path" ],
+                [DataTypes::Attrs,  :"attrs"],
+              ],
+            },
+          }
+
+          #
+          # Responds to SSH_FXP_EXTENDED request with lsetstat@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
+              path = request[:"path"]
+              attrs = request[:"attrs"]
+              raise BadMessageError, "Invalid file attribute: size" if attrs.has_key?(:"size")
+              if attrs.has_key?(:"atime") && attrs.has_key?(:"mtime")
+                raise FileLutimeUnsupportedError, "File.lutime is not supported on this Ruby version" unless File.respond_to?(:lutime)
+                log_debug { "File.lutime(#{attrs[:"atime"].inspect}, #{attrs[:"mtime"].inspect}, #{path.inspect})" }
+                File.lutime(attrs[:"atime"], attrs[:"mtime"], path)
+              end
+              if attrs.has_key?(:"uid") && attrs.has_key?(:"gid")
+                log_debug { "File.lchown(#{attrs[:"uid"].inspect}, #{attrs[:"gid"].inspect}, #{path.inspect})" }
+                File.lchown(attrs[:"uid"], attrs[:"gid"], path)
+              end
+              if attrs.has_key?(:"permissions")
+                log_debug { "File.lchmod(#{attrs[:"permissions"].inspect}, #{path.inspect})" }
+                File.lchmod(attrs[:"permissions"], path)
+              end
+              {
+                :"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 BadMessageError => e
+              log_debug { e.message }
+              {
+                :"type"          => Packets::SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => Packets::SSH_FXP_STATUS::SSH_FX_BAD_MESSAGE,
+                :"error message" => "Bad message",
+                :"language tag"  => "",
+              }
+            rescue FileLutimeUnsupportedError => 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" => e.message,
+                :"language tag"  => "",
+              }
+            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, Errno::EPERM => 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 NotImplementedError => 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" => e.message,
+                :"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
+
+          class BadMessageError < StandardError
+          end
+
+          class FileLutimeUnsupportedError < StandardError
+          end
+
+          private_constant :BadMessageError, :FileLutimeUnsupportedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Extensions
+
+        #
+        # This class implements posix-rename@openssh.com version 1 extension format and responder.
+        #
+        class PosixRenameAtOpensshCom < Extension
+
+          #
+          # Represents posix-rename@openssh.com version 1 extension name.
+          #
+          EXTENSION_NAME = "posix-rename@openssh.com"
+
+          #
+          # Represents posix-rename@openssh.com version 1 extension data.
+          #
+          EXTENSION_DATA = "1"
+
+          #
+          # Represents SSH_FXP_EXTENDED packet additional format for posix-rename@openssh.com version 1 extension.
+          #
+          REQUEST_FORMAT = {
+            :"extended-request" => {
+              "posix-rename@openssh.com" => [
+                [DataTypes::String, :"oldpath"],
+                [DataTypes::String, :"newpath"],
+              ],
+            },
+          }
+
+          #
+          # Responds to SSH_FXP_EXTENDED request with posix-rename@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
+              oldpath = request[:"oldpath"]
+              newpath = request[:"newpath"]
+              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"  => "",
+              }
+            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"  => "",
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+
+      #
+      # This class implements SFTP protocol version 3 packet types, formats, and responders.
+      #
+      class Packets < Version2::Packets
+      end
+    end
+  end
+end
+
+require "hrr_rb_sftp/protocol/version3/packets/014_ssh_fxp_mkdir"
+require "hrr_rb_sftp/protocol/version3/packets/019_ssh_fxp_readlink"
+require "hrr_rb_sftp/protocol/version3/packets/020_ssh_fxp_symlink"
+require "hrr_rb_sftp/protocol/version3/packets/101_ssh_fxp_status"
+require "hrr_rb_sftp/protocol/version3/packets/200_ssh_fxp_extended"
+require "hrr_rb_sftp/protocol/version3/packets/201_ssh_fxp_extended_reply"

data/lib/hrr_rb_sftp/protocol/version3/packets/014_ssh_fxp_mkdir.rb

@@ -0,0 +1,75 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 3 SSH_FXP_MKDIR packet type, format, and responder.
+        #
+        class SSH_FXP_MKDIR < Version2::Packets::SSH_FXP_MKDIR
+
+          #
+          # Represents SSH_FXP_MKDIR packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
+            [DataTypes::Attrs,  :"attrs"     ],
+          ]
+
+          #
+          # Responds to SSH_FXP_MKDIR request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_MKDIR request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              args = [request[:"path"]]
+              if request[:"attrs"].has_key?(:"permissions")
+                args.push request[:"attrs"][:"permissions"]
+              end
+              log_debug { "Dir.mkdir(#{args.map(&:inspect).join(", ")})" }
+              Dir.mkdir(*args)
+              {
+                :"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/019_ssh_fxp_readlink.rb

@@ -0,0 +1,76 @@
+module HrrRbSftp
+  class Protocol
+    module Version3
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_READLINK packet type, format, and responder.
+        #
+        class SSH_FXP_READLINK < Packets::Packet
+
+          #
+          # Represents SSH_FXP_READLINK packet type.
+          #
+          TYPE = 19
+
+          #
+          # Represents SSH_FXP_READLINK packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
+          ]
+
+          #
+          # Responds to SSH_FXP_READLINK request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_READLINK request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_NAME. In other cases, its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              log_debug { "realpath = File.realpath(#{request[:"path"].inspect})" }
+              realpath = File.realpath(request[:"path"])
+              {
+                :"type"        => Packets::SSH_FXP_NAME::TYPE,
+                :"request-id"  => request[:"request-id"],
+                :"count"       => 1,
+                :"filename[0]" => realpath,
+                :"longname[0]" => realpath,
+                :"attrs[0]"    => {},
+              }
+            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