Class: HrrRbSftp::Protocol::Version1::Packets::SSH_FXP_OPENDIR

Inherits:
Packet show all
Defined in:
lib/hrr_rb_sftp/protocol/version1/packets/011_ssh_fxp_opendir.rb

Overview

This class implements SFTP protocol version 1 SSH_FXP_OPENDIR packet type, format, and responder.

Constant Summary collapse

TYPE =

Represents SSH_FXP_OPENDIR packet type.

11
FORMAT =

Represents SSH_FXP_OPENDIR packet format.

[
  [DataTypes::Byte,   :"type"      ],
  [DataTypes::Uint32, :"request-id"],
  [DataTypes::String, :"path"      ],
]

Instance Attribute Summary

Attributes included from Loggable

#logger

Instance Method Summary collapse

Methods inherited from Packet

#context, #handles, #initialize, #version

Methods inherited from Common::Packets::Packet

#decode, #encode, #initialize

Methods included from Loggable

#log_debug, #log_error, #log_fatal, #log_info, #log_warn

Constructor Details

This class inherits a constructor from HrrRbSftp::Protocol::Version1::Packets::Packet

Instance Method Details

#respond_to(request) ⇒ Hash{Symbol=>Object}

Responds to SSH_FXP_OPENDIR request.

Parameters:

  • request (Hash{Symbol=>Object}) —

    SSH_FXP_OPENDIR request represented in Hash.

Returns:

  • (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.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/hrr_rb_sftp/protocol/version1/packets/011_ssh_fxp_opendir.rb', line 31

def respond_to request
  begin
    log_debug { "dir = Dir.open(#{request[:"path"].inspect})" }
    dir = ::Dir.open(request[:"path"])
    log_debug { "handle = #{dir.object_id.to_s(16).inspect}" }
    handle = dir.object_id.to_s(16)
    log_debug { "handles[#{handle.inspect}] = dir" }
    handles[handle] = dir
    {
      :"type"       => SSH_FXP_HANDLE::TYPE,
      :"request-id" => request[:"request-id"],
      :"handle"     => handle,
    }
  rescue Errno::ENOENT => e
    log_debug { e.message }
    {
      :"type"          => SSH_FXP_STATUS::TYPE,
      :"request-id"    => request[:"request-id"],
      :"code"          => 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"          => SSH_FXP_STATUS::TYPE,
      :"request-id"    => request[:"request-id"],
      :"code"          => SSH_FXP_STATUS::SSH_FX_PERMISSION_DENIED,
      :"error message" => "Permission denied",
      :"language tag"  => "",
    }
  rescue Errno::ENOTDIR => e
    log_debug { e.message }
    {
      :"type"          => SSH_FXP_STATUS::TYPE,
      :"request-id"    => request[:"request-id"],
      :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
      :"error message" => "Not a directory",
      :"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