net-sftp 0.5.0

data/lib/net/sftp/protocol/01/packet-assistant.rb

@@ -0,0 +1,82 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/protocol/packet-assistant'
+
+module Net ; module SFTP ; module Protocol ; module V_01
+
+  # Defines the packets available to version 1 of the SFTP protocol, as well
+  # as their formats. These packets are:
+  #
+  # * open( id, path, flags, attrs )
+  # * close( id, handle )
+  # * read( id, handle, offset, length )
+  # * write( id, handle, offset, data )
+  # * opendir( id, path )
+  # * readdir( id, handle )
+  # * remove( id, filename )
+  # * stat( id, path )
+  # * lstat( id, path )
+  # * fstat( id, handle )
+  # * setstat( id, path, attrs )
+  # * fsetstat( id, handle, attrs )
+  # * mkdir( id, path, attrs )
+  # * rmdir( id, path )
+  # * realpath( id, path )
+  class PacketAssistant < Protocol::PacketAssistant
+
+    packet :open,     :string, # path
+                      :long,   # flags
+                      :attrs   # file attributes
+
+    packet :close,    :string  # handle
+
+    packet :read,     :string, # handle
+                      :int64,  # offset
+                      :long    # length
+
+    packet :write,    :string, # handle
+                      :int64,  # offset
+                      :string  # data
+
+    packet :opendir,  :string  # path
+
+    packet :readdir,  :string  # handle
+
+    packet :remove,   :string  # filename
+
+    packet :stat,     :string  # path
+
+    packet :lstat,    :string  # path
+
+    packet :fstat,    :string  # handle
+
+    packet :setstat,  :string, # path
+                      :attrs   # attributes to set
+
+    packet :fsetstat, :string, # handle
+                      :attrs   # attributes to set
+
+    packet :mkdir,    :string, # path
+                      :attrs   # directory attributes
+
+    packet :rmdir,    :string  # path
+
+    packet :realpath, :string  # path
+
+  end
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/01/services.rb

@@ -0,0 +1,47 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+module Net ; module SFTP ; module Protocol ; module V_01
+
+  def register_services( container )
+    container.namespace_define :v_01 do |ns|
+
+      # The packet assistant to use for formatting SFTP packets.
+      ns.packet_assistant do |c,|
+        require 'net/sftp/protocol/01/packet-assistant'
+        PacketAssistant.new( c[:transport][:buffers],
+                             c[:driver] )
+      end
+
+      # The attribute factory to use to obtain attribute object instances.
+      ns.attr_factory do |c,|
+        require 'net/sftp/protocol/01/attributes'
+        Attributes.init( c[:transport][:buffers] )
+      end
+
+      # The version implementation to use.
+      ns.impl do |c,|
+        require 'net/sftp/protocol/01/impl'
+        Impl.new( c[:transport][:buffers],
+                  c[:driver], c[:packet_assistant],
+                  c[:attr_factory] )
+      end
+
+    end
+  end
+  module_function :register_services
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/02/impl.rb

@@ -0,0 +1,39 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/protocol/01/impl'
+
+module Net ; module SFTP ; module Protocol ; module V_02
+
+  # The implementation of the operations defined by version 2 of the SFTP
+  # protocol. This simply adds support for the RENAME operation, otherwise
+  # extending the version 1 implementation, unaltered.
+  class Impl < V_01::Impl
+
+    operation :rename
+
+    alias :rename_raw :rename
+
+    # This operation is special since a later version of the protocol adds
+    # support for flags. In this version, the flags parameter is ignored,
+    # but it exists for compatibility with later versions.
+    def rename( id, name, new_name, flags=nil )
+      rename_raw id, name, new_name
+    end
+
+  end
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/02/packet-assistant.rb

@@ -0,0 +1,32 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/protocol/01/packet-assistant'
+
+module Net ; module SFTP ; module Protocol ; module V_02
+
+  # The packet assistant, used to format packets for version 2 of the SFTP
+  # protocol. This simply adds support for the RENAME packet:
+  #
+  # * rename( id, old, new )
+  class PacketAssistant < V_01::PacketAssistant
+
+    packet :rename,   :string, # old name
+                      :string  # new name
+
+  end
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/02/services.rb

@@ -0,0 +1,44 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+module Net ; module SFTP ; module Protocol ; module V_02
+
+  def register_services( container )
+    container.namespace_define :v_02 do |ns|
+
+      ns.packet_assistant do |c,|
+        require 'net/sftp/protocol/02/packet-assistant'
+        PacketAssistant.new( c[:transport][:buffers],
+                             c[:driver] )
+      end
+
+      ns.attr_factory do |c,|
+        require 'net/sftp/protocol/01/attributes'
+        V_01::Attributes.init( c[:transport][:buffers] )
+      end
+
+      ns.impl do |c,|
+        require 'net/sftp/protocol/02/impl'
+        Impl.new( c[:transport][:buffers],
+                  c[:driver], c[:packet_assistant],
+                  c[:attr_factory] )
+      end
+
+    end
+  end
+  module_function :register_services
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/03/impl.rb

@@ -0,0 +1,42 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/protocol/02/impl'
+
+module Net ; module SFTP ; module Protocol ; module V_03
+
+  # The implementation of the operations for version 3 of the SFTP protocol.
+  # This adds support for the readlink and symlink operations.
+  class Impl < V_02::Impl
+
+    operation :readlink,
+              :symlink
+
+    # The #status message changed in this version. It adds +message+ and
+    # +language+ fields, so the callback now receives +driver+, +id+, +code+,
+    # +message+, and +language+ as parameters.
+    def do_status( channel, content )
+      return unless has_on_status?
+      id = content.read_long
+      code = content.read_long
+      message = content.read_string
+      language = content.read_string
+      call_on_status( driver, id, code, message, language )
+    end
+    
+  end
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/03/packet-assistant.rb

@@ -0,0 +1,35 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/protocol/02/packet-assistant'
+
+module Net ; module SFTP ; module Protocol ; module V_03
+
+  # The packet assistant which formats packets for version 3 of the SFTP
+  # protocol. This adds support for the readlink and symlink packets:
+  #
+  # * readlink( id, path )
+  # * symlink( id, link, target )
+  class PacketAssistant < V_02::PacketAssistant
+
+    packet :readlink, :string  # path
+
+    packet :symlink,  :string, # link-path
+                      :string  # target-path
+
+  end
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/03/services.rb

@@ -0,0 +1,44 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+module Net ; module SFTP ; module Protocol ; module V_03
+
+  def register_services( container )
+    container.namespace_define :v_03 do |ns|
+
+      ns.packet_assistant do |c,|
+        require 'net/sftp/protocol/03/packet-assistant'
+        PacketAssistant.new( c[:transport][:buffers],
+                             c[:driver] )
+      end
+
+      ns.attr_factory do |c,|
+        require 'net/sftp/protocol/01/attributes'
+        V_01::Attributes.init( c[:transport][:buffers] )
+      end
+
+      ns.impl do |c,|
+        require 'net/sftp/protocol/03/impl'
+        Impl.new( c[:transport][:buffers],
+                  c[:driver], c[:packet_assistant],
+                  c[:attr_factory] )
+      end
+
+    end
+  end
+  module_function :register_services
+
+end ; end ; end ; end

data/lib/net/sftp/protocol/04/attributes.rb

@@ -0,0 +1,227 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+module Net ; module SFTP ; module Protocol ; module V_04
+
+  # Version 4 of the SFTP protocol made some pretty significant alterations to
+  # the File Attributes data type. This encapsulates those changes.
+  class Attributes
+
+    F_SIZE              = 0x00000001
+    F_PERMISSIONS       = 0x00000004
+    F_ACCESSTIME        = 0x00000008
+    F_CREATETIME        = 0x00000010
+    F_MODIFYTIME        = 0x00000020
+    F_ACL               = 0x00000040
+    F_OWNERGROUP        = 0x00000080
+    F_SUBSECOND_TIMES   = 0x00000100
+    F_EXTENDED          = 0x80000000
+    
+    attr_accessor :type
+    attr_accessor :size
+    attr_accessor :owner
+    attr_accessor :group
+    attr_accessor :permissions
+    attr_accessor :atime
+    attr_accessor :atime_nseconds
+    attr_accessor :ctime
+    attr_accessor :ctime_nseconds
+    attr_accessor :mtime
+    attr_accessor :mtime_nseconds
+    attr_accessor :acl
+    attr_accessor :extended
+
+    ACL = Struct.new( :type, :flag, :mask, :who )
+
+    # An initializer for specifying the buffer factory that should be used by
+    # instances of this class.
+    def self.init( buffers )
+      @buffers = buffers
+      self
+    end
+
+    # Return a reference to the buffer factory in use by this class.
+    def self.buffers
+      @buffers
+    end
+
+    # A convenience for obtaining a reference to the buffer factory used by
+    # this instance's class.
+    def buffers
+      self.class.buffers
+    end
+
+    # Return an empty Attributes instance.
+    def self.empty
+      new
+    end
+
+    # Return an Attributes instance initialized from the given buffer.
+    def self.from_buffer( buffer )
+      flags = buffer.read_long
+
+      type = buffer.read_byte
+      size = buffer.read_int64 if ( flags & F_SIZE ) != 0
+      owner = buffer.read_string if ( flags & F_OWNERGROUP ) != 0
+      group = buffer.read_string if ( flags & F_OWNERGROUP ) != 0
+      permissions = buffer.read_long if ( flags & F_PERMISSIONS ) != 0
+      if ( flags & F_ACCESSTIME ) != 0
+        atime = buffer.read_int64
+        atime_nseconds = buffer.read_long if ( flags & F_SUBSECOND_TIMES ) != 0
+      end
+      if ( flags & F_CREATETIME ) != 0
+        ctime = buffer.read_int64
+        ctime_nseconds = buffer.read_long if ( flags & F_SUBSECOND_TIMES ) != 0
+      end
+      if ( flags & F_MODIFYTIME ) != 0
+        mtime = buffer.read_int64
+        mtime_nseconds = buffer.read_long if ( flags & F_SUBSECOND_TIMES ) != 0
+      end
+      if ( flags & F_ACL ) != 0
+        acl_buf = buffers.reader( buffer.read_string )
+        acl = []
+        acl_buf.read_long.times do
+          acl << ACL.new( acl_buf.read_long,
+                          acl_buf.read_long,
+                          acl_buf.read_long,
+                          acl_buf.read_string )
+        end
+      end
+
+      if ( flags & F_EXTENDED ) != 0
+        extended = Hash.new
+        buffer.read_long.times do
+          extended[ buffer.read_string ] = buffer.read_string
+        end
+      end
+
+      new( type, size, owner, group, permissions, atime, atime_nseconds,
+        ctime, ctime_nseconds, mtime, mtime_nseconds, acl, extended )
+    end
+
+    # Create a new attributes object, initialized from the given hash. The
+    # :uid and :gid attributes are treated specially; they are not actually
+    # supported by this version of the protocol, but are instead converted
+    # by this method to their corresponding names, and assigned (respectively)
+    # to :owner and :group.
+    def self.from_hash( hash )
+      if hash.has_key?(:uid)
+        require 'etc'
+        hash[:owner] = Etc.getpwuid( hash[:uid] ).name
+      end
+
+      if hash.has_key?(:gid)
+        require 'etc'
+        hash[:group] = Etc.getgrgid( hash[:gid] ).name
+      end
+
+      new hash[:type] || T_REGULAR, hash[:size], hash[:owner], hash[:group],
+        hash[:permissions], hash[:atime], hash[:atime_nseconds],
+        hash[:ctime], hash[:ctime_nseconds], hash[:mtime],
+        hash[:mtime_nseconds], hash[:acl], hash[:extended]
+    end
+
+    private_class_method :new
+
+    T_REGULAR      = 1
+    T_DIRECTORY    = 2
+    T_SYMLINK      = 3
+    T_SPECIAL      = 4
+    T_UNKNOWN      = 5
+    T_SOCKET       = 6
+    T_CHAR_DEVICE  = 7
+    T_BLOCK_DEVICE = 8
+    T_FIFO         = 9
+
+    # Create a new Attributes instance with the given values.
+    def initialize( type=T_REGULAR, size=nil, owner=nil, group=nil,
+      permissions=nil, atime=nil, atime_nseconds=nil, ctime=nil,
+      ctime_nseconds=nil, mtime=nil, mtime_nseconds=nil, acl=nil,
+      extended=nil )
+    # begin
+      @type = type
+      @size = size
+      @owner = owner
+      @group = group
+      @permissions = permissions
+      @atime = atime
+      @atime_nseconds = atime_nseconds
+      @ctime = ctime
+      @ctime_nseconds = ctime_nseconds
+      @mtime = mtime
+      @mtime_nseconds = mtime_nseconds
+      @acl = acl
+      @extended = extended
+    end
+
+    # Convert this object to a string, suitable for inclusion in an SFTP
+    # packet (protocol version 4+).
+    def to_s
+      flags = 0
+
+      flags |= F_SIZE if @size
+      flags |= F_OWNERGROUP if @owner && @group
+      flags |= F_PERMISSIONS if @permissions
+      flags |= F_ACCESSTIME if @atime
+      flags |= F_CREATETIME if @ctime
+      flags |= F_MODIFYTIME if @mtime
+      if @atime_nseconds && @ctime_nseconds && @mtime_nseconds
+        flags |= F_SUBSECOND_TIMES
+      end
+      flags |= F_ACL if @acl
+      flags |= F_EXTENDED if @extended
+
+      buffer = buffers.writer
+      buffer.write_long flags
+      buffer.write_byte @type
+      buffer.write_int64 @size if @size
+      buffer.write_string @owner, @group if @owner && @group
+      buffer.write_long @permissions if @permissions
+
+      if @atime
+        buffer.write_int64 @atime
+        buffer.write_long @atime_nseconds if ( flags & F_SUBSECOND_TIMES != 0 )
+      end
+      if @ctime
+        buffer.write_int64 @ctime
+        buffer.write_long @ctime_nseconds if ( flags & F_SUBSECOND_TIMES != 0 )
+      end
+      if @mtime
+        buffer.write_int64 @mtime
+        buffer.write_long @mtime_nseconds if ( flags & F_SUBSECOND_TIMES != 0 )
+      end
+
+      if @acl
+        acl_buf = buffers.writer
+        acl_buf.write_long @acl.length
+        @acl.each do |item|
+          acl_buf.write_long item.type, item.flag, item.mask
+          acl_buf.write_string item.who
+        end
+        buffer.write_string acl_buf.to_s
+      end
+
+      if @extended
+        buffer.write_long @extended.length
+        @extended.each { |k,v| buffer.write_string k, v }
+      end
+
+      buffer.to_s
+    end
+
+  end
+
+end ; end ; end ; end