net-sftp-backports 4.0.0.backports

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d06f649000e5b6b2b99d1d7687823e13d26a5096946d328f6bc2b8c91a6f4f58
+  data.tar.gz: '094c9406cc40e516f1db5db40a7644ca5b97f119cb2197dfa00c57e0e9027602'
+SHA512:
+  metadata.gz: 9ba63089193e5900a47d1b4fb63eef6b356dc4c468c66b5c18f82c2e2445a108380f1bcc51e6a8f83fc7f47bfbeb470c02d90a785b1e2bbf373170cf4b8a5d50
+  data.tar.gz: 22052815baf86a9d676272c0d2b126f0ef8fa904c5d224ef5d06df188803bc7698f02f31faf1fb41d86192f7e440c51b671d80eb25f4cb794b17e14292778a21

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

@@ -0,0 +1,67 @@
+=== 3.0.0
+
+* Pass protocol version via Net::SFTP.start [#107]
+* Net-ssh 6.0 support [#106]
+
+=== 2.1.2 / 07 May 2013
+
+* Fix fragmentation download failure [accardi]
+
+=== 2.1.0 / 06 Feb 2013
+
+* Added public cert. All gem releases are now signed. See INSTALL in readme.
+* Remove self-require, it causes a warning in Ruby 1.9.2. [jbarnette]
+* Allow for upload to use the filename of the local file by default [czarneckid]
+* Properly handle receiving less data than requested. [thedarkone]
+* Added option to create directory on directory upload [Pablo Merino]
+* Remove a warnings in tests [kachick]
+
+
+=== 2.0.5 / 19 Aug 2010
+
+* Fixed missing StringIO exception in download! [Toby Bryans, Delano Mandelbaum]
+
+
+=== 2.0.4 / 23 Nov 2009
+
+* Fixed frozen string issue in StatusException.message [appoxy]
+
+
+=== 2.0.3 / 17 Nov 2009
+
+* Reference the correct Exception class when rescuing errors [Scott Tadman]
+
+
+=== 2.0.2 / 1 Feb 2009
+
+* Avoid using 'ensure' in Net::SFTP.start since it causes unfriendly behavior when exceptions are raised [Jamis Buck]
+
+
+=== 2.0.1 / 29 May 2008
+
+* Open files in binary mode to appease Windows [Jamis Buck]
+
+
+=== 2.0.0 / 1 May 2008
+
+* Make Net::SSH::Connection::Session#sftp accept an argument determining whether or not to block while the SFTP subsystem initializes (defaults to true) [Jamis Buck]
+
+* Allow Session#connect to be useful even in the open/opening states by invoking or queuing the callback block [Jamis Buck]
+
+* Allow custom properties to be set on upload/download initiation via the :properties option [Jamis Buck]
+
+* Custom properties on Download instances [Jamis Buck]
+
+* Add #abort! method to Upload and Download operations [Jamis Buck]
+
+* More complete support for file-type detection in protocol versions 1-3 [Jamis Buck]
+
+
+=== 2.0 Preview Release 2 (1.99.1) / 10 Apr 2008
+
+* Custom properties on Upload instances [Jamis Buck]
+
+
+=== 2.0 Preview Release 1 (1.99.0) / 22 Mar 2008
+
+* Rewritten! (Never, ever, do this at home.) New and improved API.

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/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright © 2008 Jamis Buck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the ‘Software’), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Manifest

@@ -0,0 +1,55 @@
+CHANGELOG.rdoc
+lib/net/sftp/constants.rb
+lib/net/sftp/errors.rb
+lib/net/sftp/operations/dir.rb
+lib/net/sftp/operations/download.rb
+lib/net/sftp/operations/file.rb
+lib/net/sftp/operations/file_factory.rb
+lib/net/sftp/operations/upload.rb
+lib/net/sftp/packet.rb
+lib/net/sftp/protocol/01/attributes.rb
+lib/net/sftp/protocol/01/base.rb
+lib/net/sftp/protocol/01/name.rb
+lib/net/sftp/protocol/02/base.rb
+lib/net/sftp/protocol/03/base.rb
+lib/net/sftp/protocol/04/attributes.rb
+lib/net/sftp/protocol/04/base.rb
+lib/net/sftp/protocol/04/name.rb
+lib/net/sftp/protocol/05/base.rb
+lib/net/sftp/protocol/06/attributes.rb
+lib/net/sftp/protocol/06/base.rb
+lib/net/sftp/protocol/base.rb
+lib/net/sftp/protocol.rb
+lib/net/sftp/request.rb
+lib/net/sftp/response.rb
+lib/net/sftp/session.rb
+lib/net/sftp/version.rb
+lib/net/sftp.rb
+Rakefile
+README.rdoc
+setup.rb
+test/common.rb
+test/protocol/01/test_attributes.rb
+test/protocol/01/test_base.rb
+test/protocol/01/test_name.rb
+test/protocol/02/test_base.rb
+test/protocol/03/test_base.rb
+test/protocol/04/test_attributes.rb
+test/protocol/04/test_base.rb
+test/protocol/04/test_name.rb
+test/protocol/05/test_base.rb
+test/protocol/06/test_attributes.rb
+test/protocol/06/test_base.rb
+test/protocol/test_base.rb
+test/test_all.rb
+test/test_dir.rb
+test/test_download.rb
+test/test_file.rb
+test/test_file_factory.rb
+test/test_packet.rb
+test/test_protocol.rb
+test/test_request.rb
+test/test_response.rb
+test/test_session.rb
+test/test_upload.rb
+Manifest

data/README.rdoc

@@ -0,0 +1,118 @@
+= 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
+
+<em>As of v2.1.0, all gem releases are signed. See INSTALL.</em>
+
+
+== DESCRIPTION:
+
+Net::SFTP is a pure-Ruby implementation of the SFTP protocol (specifically, versions 1 through 6 of the SFTP protocol). Note that this is the "Secure File Transfer Protocol", typically run over an SSH connection, and has nothing to do with the FTP protocol.
+
+== FEATURES/PROBLEMS:
+
+* Transfer files or even entire directory trees to or from a remote host via SFTP
+* Completely supports all six protocol versions
+* Asynchronous and synchronous operation
+* Read and write files using an IO-like interface
+
+== SYNOPSIS:
+
+In a nutshell:
+
+  require 'net/sftp'
+
+  Net::SFTP.start('host', 'username', :password => 'password') do |sftp|
+    # upload a file or directory to the remote host
+    sftp.upload!("/path/to/local", "/path/to/remote")
+
+    # download a file or directory from the remote host
+    sftp.download!("/path/to/remote", "/path/to/local")
+
+    # grab data off the remote host directly to a buffer
+    data = sftp.download!("/path/to/remote")
+
+    # open and write to a pseudo-IO for a remote file
+    sftp.file.open("/path/to/remote", "w") do |f|
+      f.puts "Hello, world!\n"
+    end
+
+    # open and read from a pseudo-IO for a remote file
+    sftp.file.open("/path/to/remote", "r") do |f|
+      puts f.gets
+    end
+
+    # create a directory
+    sftp.mkdir! "/path/to/directory"
+
+    # list the entries in a directory
+    sftp.dir.foreach("/path/to/directory") do |entry|
+      puts entry.longname
+    end
+  end
+
+For the full documentation, start with Net::SFTP::Session. Also see Net::SFTP::Operations::Upload, Net::SFTP::Operations::Download, Net::SFTP::Operations::FileFactory, Net::SFTP::Operations::File, and Net::SFTP::Operations::Dir.
+
+== REQUIREMENTS:
+
+* Net::SSH 2
+
+If you wish to run the tests, you'll need:
+
+* Echoe (if you want to use the Rakefile)
+* Mocha
+
+== INSTALL:
+
+* 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 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.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:
+
+    $ gem install net-sftp -P HighSecurity
+
+If you don't add the public key, you'll see an error like "Couldn't verify data signature". If you're still having trouble let me know and I'll give you a hand.
+
+Or, if you prefer to do it the hard way (sans Rubygems):
+
+* tar xzf net-ssh-*.tgz
+* cd net-ssh-*
+* ruby setup.rb config
+* ruby setup.rb install (might need sudo privileges)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Jamis Buck <jamis@37signals.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,53 @@
+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"
+
+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
+end
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs = ["lib", "test"]
+end
+
+extra_files = %w[LICENSE.txt THANKS.txt CHANGES.txt ]
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "#{name} #{version}"
+  rdoc.generator = 'hanna' # gem install hanna-nouveau
+  rdoc.main = 'README.rdoc'
+  rdoc.rdoc_files.include("README*")
+  rdoc.rdoc_files.include("bin/*.rb")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+  extra_files.each { |file|
+    rdoc.rdoc_files.include(file) if File.exist?(file)
+  }
+end

data/lib/net/sftp/constants.rb

@@ -0,0 +1,187 @@
+module Net module SFTP
+
+  # The packet types and other general constants used by the SFTP protocol.
+  # See the specification for the SFTP protocol for a full discussion of their
+  # meaning and usage.
+  module Constants
+
+    # The various packet types supported by SFTP protocol versions 1 through 6.
+    # The FXP_EXTENDED and FXP_EXTENDED_REPLY packet types are not currently
+    # understood by Net::SFTP.
+    module PacketTypes
+      FXP_INIT           = 1
+      FXP_VERSION        = 2
+                         
+      FXP_OPEN           = 3
+      FXP_CLOSE          = 4
+      FXP_READ           = 5
+      FXP_WRITE          = 6
+      FXP_LSTAT          = 7
+      FXP_FSTAT          = 8
+      FXP_SETSTAT        = 9
+      FXP_FSETSTAT       = 10
+      FXP_OPENDIR        = 11
+      FXP_READDIR        = 12
+      FXP_REMOVE         = 13
+      FXP_MKDIR          = 14
+      FXP_RMDIR          = 15
+      FXP_REALPATH       = 16
+      FXP_STAT           = 17
+      FXP_RENAME         = 18
+      FXP_READLINK       = 19
+      FXP_SYMLINK        = 20
+      FXP_LINK           = 21
+      FXP_BLOCK          = 22
+      FXP_UNBLOCK        = 23
+                         
+      FXP_STATUS         = 101
+      FXP_HANDLE         = 102
+      FXP_DATA           = 103
+      FXP_NAME           = 104
+      FXP_ATTRS          = 105
+                         
+      FXP_EXTENDED       = 200
+      FXP_EXTENDED_REPLY = 201
+    end
+
+    # Beginning in version 5 of the protocol, Net::SFTP::Session#rename accepts
+    # an optional +flags+ argument that must be either 0 or a combination of
+    # these constants.
+    module RenameFlags
+      OVERWRITE = 0x00000001
+      ATOMIC    = 0x00000002
+      NATIVE    = 0x00000004
+    end
+
+    # When an FXP_STATUS packet is received from the server, the +code+ will
+    # be one of the following constants.
+    module StatusCodes
+      FX_OK                     = 0
+      FX_EOF                    = 1
+      FX_NO_SUCH_FILE           = 2
+      FX_PERMISSION_DENIED      = 3
+      FX_FAILURE                = 4
+      FX_BAD_MESSAGE            = 5
+      FX_NO_CONNECTION          = 6
+      FX_CONNECTION_LOST        = 7
+      FX_OP_UNSUPPORTED         = 8
+      FX_INVALID_HANDLE         = 9
+      FX_NO_SUCH_PATH           = 10
+      FX_FILE_ALREADY_EXISTS    = 11
+      FX_WRITE_PROTECT          = 12
+      FX_NO_MEDIA               = 13
+      FX_NO_SPACE_ON_FILESYSTEM = 14
+      FX_QUOTA_EXCEEDED         = 15
+      FX_UNKNOWN_PRINCIPLE      = 16
+      FX_LOCK_CONFlICT          = 17
+      FX_DIR_NOT_EMPTY          = 18
+      FX_NOT_A_DIRECTORY        = 19
+      FX_INVALID_FILENAME       = 20
+      FX_LINK_LOOP              = 21
+    end
+
+    # The Net::SFTP::Session#open operation is one of the worst casualties of
+    # the revisions between SFTP protocol versions. The flags change considerably
+    # between version 1 and version 6. Net::SFTP tries to shield programmers
+    # from the differences, so you'll almost never need to use these flags
+    # directly, but if you ever need to specify some flag that isn't exposed
+    # by the higher-level API, these are the ones that are available to you.
+    module OpenFlags
+      # These are the flags that are understood by versions 1-4 of the the
+      # open operation.
+      module FV1
+        READ   = 0x00000001
+        WRITE  = 0x00000002
+        APPEND = 0x00000004
+        CREAT  = 0x00000008
+        TRUNC  = 0x00000010
+        EXCL   = 0x00000020
+      end
+
+      # Version 5 of the open operation totally discarded the flags understood
+      # by versions 1-4, and replaced them with these.
+      module FV5
+        CREATE_NEW         = 0x00000000
+        CREATE_TRUNCATE    = 0x00000001
+        OPEN_EXISTING      = 0x00000002
+        OPEN_OR_CREATE     = 0x00000003
+        TRUNCATE_EXISTING  = 0x00000004
+
+        APPEND_DATA        = 0x00000008
+        APPEND_DATA_ATOMIC = 0x00000010
+        TEXT_MODE          = 0x00000020
+        READ_LOCK          = 0x00000040
+        WRITE_LOCK         = 0x00000080
+        DELETE_LOCK        = 0x00000100
+      end
+
+      # Version 6 of the open operation added these flags, in addition to the
+      # flags understood by version 5.
+      module FV6
+        ADVISORY_LOCK           = 0x00000200
+        NOFOLLOW                = 0x00000400
+        DELETE_ON_CLOSE         = 0x00000800
+        ACCESS_AUDIT_ALARM_INFO = 0x00001000
+        ACCESS_BACKUP           = 0x00002000
+        BACKUP_STREAM           = 0x00004000
+        OVERRIDE_OWNER          = 0x00008000
+      end
+    end
+
+    # The Net::SFTP::Session#block operation, implemented in version 6 of
+    # the protocol, understands these constants for the +mask+ parameter.
+    module LockTypes
+      READ     = OpenFlags::FV5::READ_LOCK
+      WRITE    = OpenFlags::FV5::WRITE_LOCK
+      DELETE   = OpenFlags::FV5::DELETE_LOCK
+      ADVISORY = OpenFlags::FV6::ADVISORY_LOCK
+    end
+
+    module ACE
+      # Access control entry types, used from version 4 of the protocol,
+      # onward. See Net::SFTP::Protocol::V04::Attributes::ACL.
+      module Type
+        ACCESS_ALLOWED = 0x00000000
+        ACCESS_DENIED  = 0x00000001
+        SYSTEM_AUDIT   = 0x00000002
+        SYSTEM_ALARM   = 0x00000003
+      end
+
+      # Access control entry flags, used from version 4 of the protocol,
+      # onward. See Net::SFTP::Protocol::V04::Attributes::ACL.
+      module Flag
+        FILE_INHERIT         = 0x00000001
+        DIRECTORY_INHERIT    = 0x00000002
+        NO_PROPAGATE_INHERIT = 0x00000004
+        INHERIT_ONLY         = 0x00000008
+        SUCCESSFUL_ACCESS    = 0x00000010
+        FAILED_ACCESS        = 0x00000020
+        IDENTIFIER_GROUP     = 0x00000040
+      end
+
+      # Access control entry masks, used from version 4 of the protocol,
+      # onward. See Net::SFTP::Protocol::V04::Attributes::ACL.
+      module Mask
+        READ_DATA         = 0x00000001
+        LIST_DIRECTORY    = 0x00000001
+        WRITE_DATA        = 0x00000002
+        ADD_FILE          = 0x00000002
+        APPEND_DATA       = 0x00000004
+        ADD_SUBDIRECTORY  = 0x00000004
+        READ_NAMED_ATTRS  = 0x00000008
+        WRITE_NAMED_ATTRS = 0x00000010
+        EXECUTE           = 0x00000020
+        DELETE_CHILD      = 0x00000040
+        READ_ATTRIBUTES   = 0x00000080
+        WRITE_ATTRIBUTES  = 0x00000100
+        DELETE            = 0x00010000
+        READ_ACL          = 0x00020000
+        WRITE_ACL         = 0x00040000
+        WRITE_OWNER       = 0x00080000
+        SYNCHRONIZE       = 0x00100000
+      end
+    end
+
+  end
+
+end end

data/lib/net/sftp/errors.rb

@@ -0,0 +1,39 @@
+module Net; module SFTP
+
+  # The base exception class for the SFTP system.
+  class Exception < RuntimeError; end
+
+  # A exception class for reporting a non-success result of an operation.
+  class StatusException < Net::SFTP::Exception
+
+    # The response object that caused the exception.
+    attr_reader :response
+
+    # The error code (numeric)
+    attr_reader :code
+
+    # The description of the error
+    attr_reader :description
+
+    # Any incident-specific text given when the exception was raised
+    attr_reader :text
+
+    # Create a new status exception that reports the given code and
+    # description.
+    def initialize(response, text=nil)
+      @response, @text = response, text
+      @code = response.code
+      @description = response.message
+      @description = Response::MAP[@code] if @description.nil? || @description.empty?
+    end
+
+    # Override the default message format, to include the code and
+    # description.
+    def message
+      m = super.dup
+      m << " #{text}" if text
+      m << " (#{code}, #{description.inspect})"
+    end
+
+  end
+end; end