net-sftp 2.1.2 → 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4319de630f665ee342eb3c367bf1fbe1e71a057206379c5251ab2c3b073d0cb7
+  data.tar.gz: a35ca9f05cf5bd73f2e9b5ede7ed9f473d0025c7da530707a6470e0bdbcc1adb
+SHA512:
+  metadata.gz: 37774670d3e3a6627f1070e5043316ccc590fd0c5049971ff36a5f83391b266a129b3f660f1b75a1d71819baef95c104f3c22bb21a1c90cdab05ff4c96ddd7a9
+  data.tar.gz: 0fd554d08be7d9151484f8fe8a5bb17a4f095918457a33ffc6dbebd06a7fbffc3fcbf6d79d159339e4f20c3bada94d1b3c9980936808012287b717296c4facf0

data/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-18.04
+    continue-on-error: ${{ matrix.flaky }}
+    strategy:
+      matrix:
+        ruby-version: ["2.5", "2.6", "2.7", "3.0", "3.1", "truffleruby-22", "truffleruby-21"]
+        flaky: [false]
+        include:
+          - ruby-version: "ruby-head"
+            flaky: true
+          - ruby-version: "jruby-9.2"
+            flaky: true
+          - ruby-version: "jruby-9.3"
+            flaky: true
+          - ruby-version: "jruby-head"
+            flaky: true
+          - ruby-version: "truffleruby-head"
+            flaky: true
+    steps:
+      - uses: actions/checkout@v1
+
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Bundle install
+        run: |
+          gem install bundler
+          bundle install
+      - name: Run Tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,6 @@
+pkg
+doc
+coverage
+ri
+*.swp
+Gemfile.lock

data/CHANGES.txt

@@ -1,3 +1,7 @@
+=== 3.0.0
+
+* Pass protocol version via Net::SFTP.start [#107]
+* Net-ssh 6.0 support [#106]
 
 === 2.1.2 / 07 May 2013
 

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mygem.gemspec
+gemspec
+
+# TODO: add to gemspec
+gem "bundler", "~> 2.1"
+gem "rake", "~> 12.0"
+
+gem 'byebug', group: %i[development test] if !Gem.win_platform? && RUBY_ENGINE == "ruby"
+
+if ENV["CI"]
+  gem 'codecov', require: false, group: :test
+  gem 'simplecov', require: false, group: :test
+end

data/README.rdoc

@@ -1,6 +1,9 @@
 = Net::SFTP
 
-* Docs: http://net-ssh.github.com/net-sftp
+<em><b>Please note: this project is in maintenance mode. It is not under active development but pull requests are very much welcome. Just be sure to include tests! -- delano</b></em>
+
+
+* Docs: http://net-ssh.github.io/net-sftp
 * Issues: https://github.com/net-ssh/net-sftp/issues
 * Codes: https://github.com/net-ssh/net-sftp
 * Email: net-ssh@solutious.com
@@ -69,12 +72,12 @@ If you wish to run the tests, you'll need:
 
 * gem install net-sftp (might need sudo privileges)
 
-However, in order to be sure the code you're installing hasn't been tampered with, it's recommended that you verify the signiture[http://docs.rubygems.org/read/chapter/21]. To do this, you need to add my public key as a trusted certificate (you only need to do this once):
+However, in order to be sure the code you're installing hasn't been tampered with, it's recommended that you verify the signature[http://docs.rubygems.org/read/chapter/21]. To do this, you need to add my public key as a trusted certificate (you only need to do this once):
 
     # Add the public key as a trusted certificate
     # (You only need to do this once)
-    $ curl -O https://raw.github.com/net-ssh/net-ssh/master/gem-public_cert.pem
-    $ gem cert --add gem-public_cert.pem
+    $ curl -O https://raw.githubusercontent.com/net-ssh/net-sftp/master/net-sftp-public_cert.pem
+    $ gem cert --add net-sftp-public_cert.pem
 
 Then, when install the gem, do so with high security:
 

data/Rakefile

@@ -2,40 +2,35 @@ require "rubygems"
 require "rake"
 require "rake/clean"
 require "rdoc/task"
+require "bundler/gem_tasks"
+
+desc "When releasing make sure NET_SSH_BUILDGEM_SIGNED is set"
+task :check_NET_SSH_BUILDGEM_SIGNED do
+  raise "NET_SSH_BUILDGEM_SIGNED should be set to release" unless ENV['NET_SSH_BUILDGEM_SIGNED']
+end
+
+Rake::Task[:release].enhance [:check_NET_SSH_BUILDGEM_SIGNED]
+Rake::Task[:release].prerequisites.unshift(:check_NET_SSH_BUILDGEM_SIGNED)
 
 task :default => ["build"]
 CLEAN.include [ 'pkg', 'rdoc' ]
 name = "net-sftp"
 
-$:.unshift File.join(File.dirname(__FILE__), 'lib')
-require "net/sftp/version"
-version = Net::SFTP::Version::STRING.dup
-
-begin
-  require "jeweler"
-  Jeweler::Tasks.new do |s|
-    s.version = version
-    s.name = name
-    s.rubyforge_project = s.name
-    s.summary = "A pure Ruby implementation of the SFTP client protocol"
-    s.description = s.summary
-    s.email = "net-ssh@solutious.com"
-    s.homepage = "https://github.com/net-ssh/net-sftp"
-    s.authors = ["Jamis Buck", "Delano Mandelbaum"]
-
-    s.add_dependency 'net-ssh', ">=2.6.5"
-
-    s.add_development_dependency 'test-unit'
-    s.add_development_dependency 'mocha'
-
-    s.license = "MIT"
-
-    s.signing_key = File.join('/mnt/gem/', 'gem-private_key.pem')
-    s.cert_chain  = ['gem-public_cert.pem']
+require_relative "lib/net/sftp/version"
+version = Net::SFTP::Version::CURRENT
+
+namespace :cert do
+  desc "Update public cert from private - only run if public is expired"
+  task :update_public_when_expired do
+    require 'openssl'
+    require 'time'
+    raw = File.read "net-sftp-public_cert.pem"
+    certificate = OpenSSL::X509::Certificate.new raw
+    raise Exception, "Not yet expired: #{certificate.not_after}" unless certificate.not_after < Time.now
+    sh "gem cert --build netssh@solutious.com --days 365*5 --private-key /mnt/gem/net-ssh-private_key.pem"
+    sh "mv gem-public_cert.pem net-sftp-public_cert.pem"
+    sh "gem cert --add net-sftp-public_cert.pem"
   end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end
 
 require 'rake/testtask'
@@ -53,7 +48,6 @@ RDoc::Task.new do |rdoc|
   rdoc.rdoc_files.include("bin/*.rb")
   rdoc.rdoc_files.include("lib/**/*.rb")
   extra_files.each { |file|
-    rdoc.rdoc_files.include(file) if File.exists?(file)
+    rdoc.rdoc_files.include(file) if File.exist?(file)
   }
 end
-

data/lib/net/sftp/operations/dir.rb

@@ -57,10 +57,10 @@ module Net; module SFTP; module Operations
     # it should be able to handle modest numbers of files in each directory.
     def glob(path, pattern, flags=0)
       flags |= ::File::FNM_PATHNAME
-      path = path.chop if path[-1,1] == "/"
+      path = path.chop if path.end_with?('/') && path != '/'
 
       results = [] unless block_given?
-      queue = entries(path).reject { |e| e.name == "." || e.name == ".." }
+      queue = entries(path).reject { |e| %w(. ..).include?(e.name) }
       while queue.any?
         entry = queue.shift
 
@@ -90,4 +90,4 @@ module Net; module SFTP; module Operations
     end
   end
 
-end; end; end
+end; end; end

data/lib/net/sftp/operations/download.rb

@@ -27,7 +27,7 @@ module Net; module SFTP; module Operations
   #
   #   sftp.download!("/path/to/remotedir", "/path/to/local", :recursive => true)
   #
-  # This will download "/path/to/remotedir", it's contents, it's subdirectories,
+  # This will download "/path/to/remotedir", its contents, its subdirectories,
   # and their contents, recursively, to "/path/to/local" on the local host.
   # (If you specify :recursive => true and the source is not a directory,
   # you'll get an error!)
@@ -81,6 +81,7 @@ module Net; module SFTP; module Operations
   #       puts "creating directory #{args[0]}"
   #     when :finish then
   #       puts "all done!"
+  #     end
   #   end
   #
   # However, for more complex implementations (e.g., GUI interfaces and such)
@@ -255,7 +256,7 @@ module Net; module SFTP; module Operations
       # operation was successful.
       def on_opendir(response)
         entry = response.request[:entry]
-        raise "opendir #{entry.remote}: #{response}" unless response.ok?
+        raise  StatusException.new(response, "opendir #{entry.remote}") unless response.ok?
         entry.handle = response[:handle]
         request = sftp.readdir(response[:handle], &method(:on_readdir))
         request[:parent] = entry
@@ -270,7 +271,7 @@ module Net; module SFTP; module Operations
           request = sftp.close(entry.handle, &method(:on_closedir))
           request[:parent] = entry
         elsif !response.ok?
-          raise "readdir #{entry.remote}: #{response}"
+          raise StatusException.new(response, "readdir #{entry.remote}")
         else
           response[:names].each do |item|
             next if item.name == "." || item.name == ".."
@@ -296,7 +297,7 @@ module Net; module SFTP; module Operations
       def on_closedir(response)
         @active -= 1
         entry = response.request[:parent]
-        raise "close #{entry.remote}: #{response}" unless response.ok?
+        raise StatusException.new(response, "close #{entry.remote}") unless response.ok?
         process_next_entry
       end
 
@@ -304,7 +305,7 @@ module Net; module SFTP; module Operations
       # to initiate the data transfer.
       def on_open(response)
         entry = response.request[:entry]
-        raise "open #{entry.remote}: #{response}" unless response.ok?
+        raise StatusException.new(response, "open #{entry.remote}") unless response.ok?
 
         entry.handle = response[:handle]
         entry.sink = entry.local.respond_to?(:write) ? entry.local : ::File.open(entry.local, "wb")
@@ -332,7 +333,7 @@ module Net; module SFTP; module Operations
           request = sftp.close(entry.handle, &method(:on_close))
           request[:entry] = entry
         elsif !response.ok?
-          raise "read #{entry.remote}: #{response}"
+          raise StatusException.new(response, "read #{entry.remote}")
         else
           entry.offset += response[:data].bytesize
           update_progress(:get, entry, response.request[:offset], response[:data])
@@ -345,7 +346,7 @@ module Net; module SFTP; module Operations
       def on_close(response)
         @active -= 1
         entry = response.request[:entry]
-        raise "close #{entry.remote}: #{response}" unless response.ok?
+        raise StatusException.new(response, "close #{entry.remote}") unless response.ok?
         process_next_entry
       end
 

data/lib/net/sftp/operations/file.rb

@@ -81,21 +81,35 @@ module Net; module SFTP; module Operations
     # Reads up to the next instance of +sep_string+ in the stream, and
     # returns the bytes read (including +sep_string+). If +sep_string+ is
     # omitted, it defaults to +$/+. If EOF is encountered before any data
-    # could be read, #gets will return +nil+.
-    def gets(sep_string=$/)
-      delim = if sep_string.length == 0
+    # could be read, #gets will return +nil+. If the first argument is an
+    # integer, or optional second argument is given, the returning string
+    # would not be longer than the given value in bytes.
+    def gets(sep_or_limit=$/, limit=Float::INFINITY)
+      if sep_or_limit.is_a? Integer
+        sep_string = $/
+        lim = sep_or_limit
+      else
+        sep_string = sep_or_limit
+        lim = limit
+      end
+
+      delim = if sep_string && sep_string.length == 0
         "#{$/}#{$/}"
       else
         sep_string
       end
 
       loop do
-        at = @buffer.index(delim)
+        at = @buffer.index(delim) if delim
         if at
-          offset = at + delim.length
+          offset = [at + delim.length, lim].min
           @pos += offset
           line, @buffer = @buffer[0,offset], @buffer[offset..-1]
           return line
+        elsif lim < @buffer.length
+          @pos += lim
+          line, @buffer = @buffer[0,lim], @buffer[lim..-1]
+          return line
         elsif !fill
           return nil if @buffer.empty?
           @pos += @buffer.length
@@ -107,8 +121,8 @@ module Net; module SFTP; module Operations
 
     # Same as #gets, but raises EOFError if EOF is encountered before any
     # data could be read.
-    def readline(sep_string=$/)
-      line = gets(sep_string)
+    def readline(sep_or_limit=$/, limit=Float::INFINITY)
+      line = gets(sep_or_limit, limit)
       raise EOFError if line.nil?
       return line
     end
@@ -118,9 +132,9 @@ module Net; module SFTP; module Operations
     def write(data)
       data = data.to_s
       sftp.write!(handle, @real_pos, data)
-      @real_pos += data.length
+      @real_pos += data.bytes.length
       @pos = @real_pos
-      data.length
+      data.bytes.length
     end
 
     # Writes each argument to the stream. If +$\+ is set, it will be written
@@ -131,6 +145,15 @@ module Net; module SFTP; module Operations
       nil
     end
 
+    def size
+      stat.size
+    end
+
+    # Resets position to beginning of file
+    def rewind
+      self.pos = 0
+    end
+
     # Writes each argument to the stream, appending a newline to any item
     # that does not already end in a newline. Array arguments are flattened.
     def puts(*items)

data/lib/net/sftp/operations/upload.rb

@@ -27,14 +27,14 @@ module Net; module SFTP; module Operations
   #
   #   sftp.upload!("/path/to/directory", "/path/to/remote")
   #
-  # This will upload "/path/to/directory", it's contents, it's subdirectories,
+  # This will upload "/path/to/directory", its contents, its subdirectories,
   # and their contents, recursively, to "/path/to/remote" on the remote server.
   #
   # For uploading a directory without creating it, do
   # sftp.upload!("/path/to/directory", "/path/to/remote", :mkdir => false)
   #
   # If you want to send data to a file on the remote server, but the data is
-  # in memory, you can pass an IO object and upload it's contents:
+  # in memory, you can pass an IO object and upload its contents:
   #
   #   require 'stringio'
   #   io = StringIO.new(data)
@@ -173,7 +173,7 @@ module Net; module SFTP; module Operations
           process_next_entry
         end
       else
-        raise ArgumentError, "expected a file to upload" unless local.respond_to?(:read) || ::File.exists?(local)
+        raise ArgumentError, "expected a file to upload" unless local.respond_to?(:read) || ::File.exist?(local)
         @stack = [[local]]
         process_next_entry
       end

data/lib/net/sftp/session.rb

@@ -75,11 +75,13 @@ module Net; module SFTP
     #
     #   sftp = Net::SFTP::Session.new(ssh)
     #   sftp.loop { sftp.opening? }
-    def initialize(session, &block)
+    def initialize(session, version = nil, &block)
       @session    = session
+      @version    = version
       @input      = Net::SSH::Buffer.new
       self.logger = session.logger
       @state      = :closed
+      @pending_requests = {}
 
       connect(&block)
     end
@@ -106,7 +108,7 @@ module Net; module SFTP
       # Initiates a download from +remote+ to +local+, asynchronously. This
       # method will return a new Net::SFTP::Operations::Download instance, and requires
       # that the event loop be run in order for the download to progress. See
-      # Net::SFTP::Operations::Download for a full discussion of hos this method can be
+      # Net::SFTP::Operations::Download for a full discussion of how this method can be
       # used.
       #
       #   download = sftp.download("/remote/path", "/local/path")
@@ -417,7 +419,7 @@ module Net; module SFTP
 
       # :call-seq:
       #   readdir(handle) -> request
-      #   raeddir(handle) { |response| ... } -> request
+      #   readdir(handle) { |response| ... } -> request
       #
       # Reads a set of entries from the given directory handle (which must
       # have been obtained via #opendir). If the response is EOF, then there
@@ -876,7 +878,7 @@ module Net; module SFTP
         channel.on_close(&method(:when_channel_closed))
         channel.on_process(&method(:when_channel_polled))
 
-        send_packet(FXP_INIT, :long, HIGHEST_PROTOCOL_VERSION_SUPPORTED)
+        send_packet(FXP_INIT, :long, @version || HIGHEST_PROTOCOL_VERSION_SUPPORTED)
       end
 
       # Called when the SSH server closes the underlying channel.
@@ -949,4 +951,4 @@ module Net; module SFTP
       end
   end
 
-end; end
+end; end

data/lib/net/sftp/version.rb

@@ -1,18 +1,68 @@
-require 'net/ssh/version'
+module Net
+  module SFTP
+    # A class for describing the current version of a library. The version
+    # consists of three parts: the +major+ number, the +minor+ number, and the
+    # +tiny+ (or +patch+) number.
+    #
+    # Two Version instances may be compared, so that you can test that a version
+    # of a library is what you require:
+    #
+    #   require 'net/sftp/version'
+    #
+    #   if Net::SFTP::Version::CURRENT < Net::SFTP::Version[2,1,0]
+    #     abort "your software is too old!"
+    #   end
+    class Version
+      include Comparable
 
-module Net; module SFTP
+      # A convenience method for instantiating a new Version instance with the
+      # given +major+, +minor+, and +tiny+ components.
+      def self.[](major, minor, tiny, pre = nil)
+        new(major, minor, tiny, pre)
+      end
 
-  # Describes the current version of the Net::SFTP library.
-  class Version < Net::SSH::Version
-    MAJOR = 2
-    MINOR = 1
-    TINY  = 2
+      attr_reader :major, :minor, :tiny
 
-    # The current version, as a Version instance
-    CURRENT = new(MAJOR, MINOR, TINY)
+      # Create a new Version object with the given components.
+      def initialize(major, minor, tiny, pre = nil)
+        @major, @minor, @tiny, @pre = major, minor, tiny, pre
+      end
 
-    # The current version, as a String instance
-    STRING  = CURRENT.to_s
-  end
+      # Compare this version to the given +version+ object.
+      def <=>(version)
+        to_i <=> version.to_i
+      end
+
+      # Converts this version object to a string, where each of the three
+      # version components are joined by the '.' character. E.g., 2.0.0.
+      def to_s
+        @to_s ||= [@major, @minor, @tiny, @pre].compact.join(".")
+      end
+
+      # Converts this version to a canonical integer that may be compared
+      # against other version objects.
+      def to_i
+        @to_i ||= @major * 1_000_000 + @minor * 1_000 + @tiny
+      end
+
+      # The major component of this version of the Net::SFTP library
+      MAJOR = 4
+
+      # The minor component of this version of the Net::SFTP library
+      MINOR = 0
 
-end; end
+      # The tiny component of this version of the Net::SFTP library
+      TINY  = 0
+
+      # The prerelease component of this version of the Net::SFTP library
+      # nil allowed
+      PRE   = nil
+
+      # The current version of the Net::SFTP library as a Version instance
+      CURRENT = new(*[MAJOR, MINOR, TINY, PRE].compact)
+
+      # The current version of the Net::SFTP library as a String
+      STRING = CURRENT.to_s
+    end
+  end
+end

data/lib/net/sftp.rb

@@ -27,9 +27,17 @@ module Net
     #   Net::SFTP.start("localhost", "user") do |sftp|
     #     sftp.upload! "/local/file.tgz", "/remote/file.tgz"
     #   end
-    def self.start(host, user, options={}, &block)
-      session = Net::SSH.start(host, user, options)
-      sftp = Net::SFTP::Session.new(session, &block).connect!
+    #
+    # Extra parameters can be passed:
+    # - The Net::SSH connection options (see Net::SSH for more information)
+    # - The Net::SFTP connection options (only :version is supported, to let you 
+    #   set the SFTP protocol version to be used)
+    def self.start(host, user, ssh_options={}, sftp_options={}, &block)
+      session = Net::SSH.start(host, user, ssh_options)
+      # We only use a single option here, but this leaves room for more later
+      # without breaking the external API.
+      version = sftp_options.fetch(:version, nil)
+      sftp = Net::SFTP::Session.new(session, version, &block).connect!
 
       if block_given?
         sftp.loop
@@ -56,7 +64,7 @@ class Net::SSH::Connection::Session
   # SSH session. Blocks until the SFTP session is fully open, and then
   # returns the SFTP session.
   #
-  #   Net::SSH.start("localhost", "user", "password") do |ssh|
+  #   Net::SSH.start("localhost", "user", :password => "password") do |ssh|
   #     ssh.sftp.upload!("/local/file.tgz", "/remote/file.tgz")
   #     ssh.exec! "cd /some/path && tar xf /remote/file.tgz && rm /remote/file.tgz"
   #   end

data/net-sftp-public_cert.pem

@@ -0,0 +1,20 @@
+-----BEGIN CERTIFICATE-----
+MIIDQDCCAiigAwIBAgIBATANBgkqhkiG9w0BAQsFADAlMSMwIQYDVQQDDBpuZXRz
+c2gvREM9c29sdXRpb3VzL0RDPWNvbTAeFw0yMjA5MjIxMTUwMDJaFw0yMzA5MjIx
+MTUwMDJaMCUxIzAhBgNVBAMMGm5ldHNzaC9EQz1zb2x1dGlvdXMvREM9Y29tMIIB
+IjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAxieE22fR/qmdPKUHyYTyUx2g
+wskLwrCkxay+Tvc97ZZUOwf85LDDDPqhQaTWLvRwnIOMgQE2nBPzwalVclK6a+pW
+x/18KDeZY15vm3Qn5p42b0wi9hUxOqPm3J2hdCLCcgtENgdX21nVzejn39WVqFJO
+lntgSDNW5+kCS8QaRsmIbzj17GKKkrsw39kiQw7FhWfJFeTjddzoZiWwc59KA/Bx
+fBbmDnsMLAtAtauMOxORrbx3EOY7sHku/kSrMg3FXFay7jc6BkbbUij+MjJ/k82l
+4o8o0YO4BAnya90xgEmgOG0LCCxRhuXQFnMDuDjK2XnUe0h4/6NCn94C+z9GsQID
+AQABo3sweTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUBfKiwO2e
+M4NEiRrVG793qEPLYyMwHwYDVR0RBBgwFoEUbmV0c3NoQHNvbHV0aW91cy5jb20w
+HwYDVR0SBBgwFoEUbmV0c3NoQHNvbHV0aW91cy5jb20wDQYJKoZIhvcNAQELBQAD
+ggEBABI2ORK5kzUL7uOF0EHI4ECMWxQMiN+pURyGp9u7DU0H8eSdZN52jbUGHzSB
+j7bB6GpqElEWjOe0IbH3vR52IVXq2bOF4P4vFchGAb4OuzJD8aJmrC/SPLHbWBuV
+2GpbRQRJyYPWN6Rt/4EHOxoFnhXOBEB6CGIy0dt7YezycVbzqtHoiI2Qf/bIFJQZ
+mpJAAUBkRiWksE7zrsE5DGK8kL2GVos7f8kdM71zT8p7VBwkMdY277T29TG2xD0D
+66Oev0C3/x89NXqCHkl1JElSzEFbOoxan16z7xNEf2MKcBKGhsYfzWVNyEtJm785
+g+97rn/AuO6dcxJnW2qBGYQa7pQ=
+-----END CERTIFICATE-----