net-ssh 3.2.0.rc2 → 7.1.0

data/CHANGES.txt

@@ -1,12 +1,233 @@
-=== 3.2.0
 
-* Added agent_socket_factory option [Alon Goldboim]
-* Send KEXINIT asap don't wait for server [Miklos Fazekas]
-* Close channels in case server closed connection [Miklos Fazekas]
+=== 7.1.0
 
-=== 3.1.1
+  * Accept pubkey_algorithms option when starting a new connection [#891]
 
-* added missing etc require
+=== 7.1.0 beta1
+
+  * Don't use the deprecated set_XXX methods on RSA keys. [#875]
+  * Raise error when BCryptPbkdf fails [#876]
+
+=== 7.0.1
+
+  * Drop leftover debug statement [#866]
+
+=== 7.0.0
+
+  * BREAKING: Drop support for Ruby 2.5
+  * Fix decoding of ecdsa-sha2-nistp256 private keys [#657, #854]
+  * Fix missing require [#855]
+  * Support `~` in the path to the SSH agent's unix socket [#850]
+  * Add support for RSA client authentication with SHA-2 [a45f54]
+  * openssl: DSA: don't hardcode expected signature size, see ruby/openssl#483 [23a15c]
+  * Internal housekeeping (rubocop, codecov, remove travis, adding/improving tests)
+
+=== 6.3.0 beta1
+
+  * Support cert based host key auth, fix asterisk in known_hosts [#833]
+  * Support kex dh-group14-sha256  [#795]
+  * Fix StrictHostKeyChecking ssh config parameter translation [#765]
+
+=== 6.2.0 rc1
+
+=== 6.2.0 beta1
+
+  * rsa-sha2-512, rsa-sha2-256 host_key algs [#771]
+  * JRuby aes*-ctr suppport [#767]
+
+=== 6.1.0
+
+  * Adapt to ssh's default behaviors when no username is provided.
+    When Net::SSH.start user is nil and config has no entry
+    we default to Etc.getpwuid.name() instead of Etc.getlogin(). [#749]
+
+=== 6.1.0.rc1
+
+  * Make sha2-{256,512}-etm@openssh.com MAC default again [#761]
+  * Support algorithm subtraction syntax from ssh_config [#751]
+
+=== 6.0.2
+
+  * Fix corrupted hmac issue in etm hmac [#759]
+
+=== 6.0.1
+
+  * Make sha2-{256,512}-etm@openssh.com MAC opt-in as they seems to have issues [#757]
+
+=== 6.0.0
+
+  * Support empty lines and comments in known_hosts [donoghuc, #742]
+  * Add sha2-{256,512}-etm@openssh.com MAC algorithms [graaff, #714]
+
+=== 6.0.0 beta2
+  
+  * Support :certkeys and CertificateFile configuration option  [Anders Carling, #722]
+
+=== 6.0.0 beta1
+
+  * curve25519sha256 support [Florian Wininger ,#690]
+  * disabled insecure algs [Florian Wininger , #709]
+
+=== 5.2.0
+
+=== 5.2.0.rc3
+
+  * Fix check_host_ip read from config
+  * Support ssh-ed25519 in known hosts
+
+=== 5.2.0.rc2
+
+  * Read check_host_ip from ssh config files
+
+=== 5.2.0.rc1
+
+  * Interpret * and ? in know_hosts file [Romain Tartière, #660]
+  * New :check_host_ip so ip checking can be disabled in known hosts [Romain Tartière, #656]
+
+=== 5.1.0
+
+=== 5.1.0.rc1
+
+  * Support new OpenSSH private key format for rsa - bcrypt for rsa (ed25519 already supported) [#646]
+  * Support IdentityAgent is ssh config [Frank Groeneveld, #645]
+  * Improve Match processing in ssh config [Aleksandrs Ļedovskis, #642]
+  * Ignore signature verification when verify_host_key is never [Piotr Kliczewski, #641]
+  * Alg preference was changed to prefer stronger encryptions  [Tray, #637]
+
+=== 5.0.2
+
+  * Fix ctr for jruby [#612]
+
+=== 5.0.1
+
+  * default_keys were not loaded even if no keys or key_data options specified [#607]
+
+=== 5.0.0
+
+ * Breaking change: ed25519 now requires ed25519 gem instead of RbNaCl gem [#563]
+ * Verify_host_key options rename (true, false, :very, :secure depreacted new equivalents are :never, :accept_new_or_local_tunnel :accept_new :always) [Jared Beck, #595]
+
+=== 5.0.0.rc2
+
+ * Add .dll extensions to dlopen on cygwin [#603]
+ * Fix host certificate validation [#601]
+
+=== 5.0.0.rc1
+
+ * Fix larger than 4GB file transfers [#599]
+ * Update HTTP proxy to version 1.1 [Connor Dunn, #597]
+
+=== 5.0.0.beta2
+
+ * Support for sha256 pubkey fingerprint [Tom Maher, #585]
+ * Don't try to load default_keys if key_data option is used [Josh Larson, #589]
+ * Added fingerprint_hash defaulting to SHA256 as fingerprint format, and MD5 can be used as an option [Miklós Fazekas, #591]
+
+=== 5.0.0.beta1
+
+ * Don't leave proxy command as zombie on timeout [DimitriosLisenko, #560]
+ * Use OpenSSL for aes*-ctr for up to 5x throughput improvement [Miklós Fazekas, Harald Sitter, #570]
+ * Optimize slice! usage in CTR for up to 2x throughput improvement [Harald Sitter, #569]
+ * Replace RbNaCl dependency with ed25519 gem [Tony Arcieri ,#563]
+ * Add initial Match support [Kasumi Hanazuki,  #553]
+
+=== 4.2.0.rc2
+
+ * Fix double close bug on auth failure (or ruby 2.2 or earlier) [#538]
+
+=== 4.2.0.rc1
+
+ * Improved logging with proxy command [Dmitriy Ivliev, #530]
+ * Close transport on proxy error [adamruzicka, #526]
+ * Support multiple identity files [Kimura Masayuki, #528]
+ * Move `none` cipher to end of cipher list [Brian Cain, #525]
+ * Deprecate `:paranoid` in favor of `:verify_host_key` [Jared Beck, #524]
+ * Support Multile Include ssh config files [Kasumi Hanazuki, #516]
+ * Support Relative path in ssh confif files [Akinori MUSHA, #510]
+ * add direct-streamlocal@openssh.com support in Forward class [Harald Sitter, #502]
+
+=== 4.1.0
+=== 4.1.0.rc1
+
+ * ProxyJump support [Ryan McGeary, #500]
+ * Fix agent detection on Windows [Christian Koehler, #495]
+
+=== 4.1.0.beta1
+
+ * Fix nil error when libsodium is not there [chapmajs ,#488]
+ * SSH certificate support for client auth [David Bartley, #485]
+
+=== 4.0.1
+=== 4.0.1.rc2
+
+ * ENV["HOME"] might be empty so filter non expandable paths [Matt Casper, #351]
+
+=== 4.0.1.rc1
+
+ * support of rbnacl 4.0 and better error message [#479]
+ * support include in config files [Kimura Masayuki, #475]
+ * fixed issue with ruby 2.2 or older on windows [#472]
+
+=== 4.0.0
+=== 4.0.0.rc3
+
+ * parse `+` character in config files [Christoph Lupprich, #470, #314]
+
+=== 4.0.0.rc2
+
+ * Fixed OpenSSL 2.0/Ruby 2.4.0 warnings [Miklós Fazekas, #468]
+ * Added ssh-ed25519 to KnownHosts:SUPPORTED_TYPE [detatka-kuzlatka-otevrete, Miklós Fazekas, #459]
+ * Allow nil for :passhrase and passing in nil option is now a depreaction warning [Miklós Fazekas, #465]
+
+=== 4.0.0.rc1
+
+ * Allow :password to be nil for capistrano v2 compatibility [Will Bryant, #357]
+ * In next_packet if prefer consuming buffer before filling it again if we have enough data [Miklós Fazekas, #454]
+
+=== 4.0.0.beta4
+
+ * Added exitstatus method to exec's return [Miklós Fazekas, #452]
+ * Don't raise from exec if server closes transport just after channel close [Miklós Fazekas, #450]
+ * Removed java_pageant, as jruby should be using regular pagent impl [Miklós Fazekas, ]
+ * Use SSH_AUTH_SOCK if possible on windows (cygwin) [Miklós Fazekas, Martin Dürst, #365, #361]
+ * HTTPS proxy support [Marcus Ilgner, #432]
+ * Supports ruby 2.4.0.dev new exception type from OpenSSL::PKey.read
+
+=== 4.0.0.beta3
+
+ * Fix Net::SSH::Disconnect exceptions when channels are closed cleanly [Miklos Fazekas, #421, #422]
+
+=== 4.0.0.beta2
+
+ * Fix raiseUnlessLoaded undefined ERROR issue [Miklos Fazekas, #418]
+
+=== 4.0.0.beta1
+
+* Fix pageant [elconas, #235]
+* Relaxed rbnacl,rbnacl-selenium contstraints ang give better errors about them [Miklos Fazekas, #398]
+* Fix UTF-8 encoding issues [Ethan J. Brown, #407]
+
+=== 4.0.0.alpha4
+
+* Experimental event loop abstraction [Miklos Fazekas]
+* RbNacl dependency is optional [Miklos Fazekas]
+* agent_socket_factory option [Alon Goldboim]
+* client sends KEXINIT, it doesn't have to wait for server [Miklos Fazekas]
+* better error message when option is nil [Kane Morgan]
+* prompting can be customized [Miklos Fazekas]
+
+=== 4.0.0.alpha3
+
+* added max_select_wait_time [Eugene Kenny]
+
+=== 4.0.0.alpha2
+
+* when transport closes we're cleaning up channels [Miklos Fazekas]
+
+=== 4.0.0.alpha1
+
+* ed25519 key support [Miklos Fazekas]
+* removed camellia [Miklos Fazekas]
 
 === 3.1.0
 === 3.1.0.rc1
@@ -95,7 +316,7 @@
 === 2.9.2-beta
 
 * Remove advertised algorithms that were not working (ssh-rsa-cert-* *ed25519 acm*-gcm@openssh.com) [mfazekas]
-* Unkown algorithms now ignored instead of failed [mfazekas]
+* Unknown algorithms now ignored instead of failed [mfazekas]
 * Configuration change: Asks for password with password auth (up to number_of_password_prompts) [mfazekas]
 * Removed warnings [amatsuda]
 

data/Dockerfile

@@ -0,0 +1,27 @@
+ARG RUBY_VERSION=3.1
+FROM ruby:${RUBY_VERSION}
+
+RUN apt update && apt install -y openssh-server sudo netcat \
+  && useradd --create-home --shell '/bin/bash' --comment 'NetSSH' 'net_ssh_1' \
+  && useradd --create-home --shell '/bin/bash' --comment 'NetSSH' 'net_ssh_2' \
+  && echo net_ssh_1:foopwd | chpasswd \
+  && echo net_ssh_2:foo2pwd | chpasswd \
+  && mkdir -p /home/net_ssh_1/.ssh \
+  && mkdir -p /home/net_ssh_2/.ssh \
+  && echo "net_ssh_1 ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers \
+  && echo "net_ssh_2 ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers \
+  && ssh-keygen -f /etc/ssh/users_ca -N ''
+
+ENV INSTALL_PATH="/netssh"
+
+WORKDIR $INSTALL_PATH
+
+COPY Gemfile net-ssh.gemspec $INSTALL_PATH/
+
+COPY lib/net/ssh/version.rb $INSTALL_PATH/lib/net/ssh/version.rb
+
+RUN gem install bundler && bundle install
+
+COPY . $INSTALL_PATH/
+
+CMD service ssh start && rake test && NET_SSH_NO_ED25519=1 rake test

data/Dockerfile.openssl3

@@ -0,0 +1,17 @@
+FROM ubuntu:22.04
+
+ENV INSTALL_PATH="/netssh"
+
+RUN apt update && apt install -y openssl ruby ruby-dev git build-essential
+
+WORKDIR $INSTALL_PATH
+
+COPY Gemfile net-ssh.gemspec $INSTALL_PATH/
+
+COPY lib/net/ssh/version.rb $INSTALL_PATH/lib/net/ssh/version.rb
+
+RUN ls -l && gem install bundler && bundle install
+
+COPY . $INSTALL_PATH/
+
+CMD openssl version && ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION' && rake test

data/Gemfile

@@ -0,0 +1,13 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mygem.gemspec
+gemspec
+
+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
+
+gem 'webrick', group: %i[development test] if RUBY_VERSION.split(".")[0].to_i >= 3

data/Gemfile.noed25519

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+ENV['NET_SSH_NO_ED25519'] = 'true'
+# Specify your gem's dependencies in mygem.gemspec
+gemspec
+
+if ENV["CI"] && !Gem.win_platform?
+  gem 'simplecov', require: false, group: :test
+  gem 'codecov', require: false, group: :test
+end
+
+gem 'webrick', group: %i[development test] if RUBY_VERSION.split(".")[0].to_i >= 3

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,30 @@
+### Expected behavior
+
+Tell us what should happen
+
+### Actual behavior
+
+Tell us what happens instead.
+
+### System configuration
+
+- net-ssh version
+- Ruby version
+
+### Example App
+
+Please provide an example script that reproduces the problem. This will save maintainers time so they can spend it fixing your issues instead of trying to build a reproduction case from sparse instructions.
+
+You can use this as stating point:
+
+```ruby
+gem 'net-ssh', '= 4.0.0.beta3'
+require 'net/ssh'
+puts Net::SSH::Version::CURRENT
+
+@host = 'localhost'
+@user = ENV['USER']
+Net::SSH.start(@host, @user) do |ssh|
+  puts ssh.exec!('echo "hello"')
+end
+```

data/Manifest

@@ -33,7 +33,6 @@ lib/net/ssh/proxy/errors.rb
 lib/net/ssh/proxy/http.rb
 lib/net/ssh/proxy/socks4.rb
 lib/net/ssh/proxy/socks5.rb
-lib/net/ssh/ruby_compat.rb
 lib/net/ssh/service/forward.rb
 lib/net/ssh/test.rb
 lib/net/ssh/test/channel.rb
@@ -75,10 +74,10 @@ lib/net/ssh/transport/packet_stream.rb
 lib/net/ssh/transport/server_version.rb
 lib/net/ssh/transport/session.rb
 lib/net/ssh/transport/state.rb
-lib/net/ssh/verifiers/lenient.rb
-lib/net/ssh/verifiers/null.rb
-lib/net/ssh/verifiers/secure.rb
-lib/net/ssh/verifiers/strict.rb
+lib/net/ssh/verifiers/accept_new.rb
+lib/net/ssh/verifiers/accept_new_or_local_tunnel.rb
+lib/net/ssh/verifiers/always.rb
+lib/net/ssh/verifiers/never.rb
 lib/net/ssh/version.rb
 net-ssh.gemspec
 setup.rb

data/README.md

@@ -0,0 +1,297 @@
+[![Gem Version](https://badge.fury.io/rb/net-ssh.svg)](https://badge.fury.io/rb/net-ssh)
+[![Join the chat at https://gitter.im/net-ssh/net-ssh](https://badges.gitter.im/net-ssh/net-ssh.svg)](https://gitter.im/net-ssh/net-ssh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build status](https://github.com/net-ssh/net-ssh/actions/workflows/ci.yml/badge.svg)](https://github.com/net-ssh/net-ssh/actions/workflows/ci.yml)
+[![Coverage status](https://codecov.io/gh/net-ssh/net-ssh/branch/master/graph/badge.svg)](https://codecov.io/gh/net-ssh/net-ssh)
+[![Backers on Open Collective](https://opencollective.com/net-ssh/backers/badge.svg)](#backers])
+[![Sponsors on Open Collective](https://opencollective.com/net-ssh/sponsors/badge.svg)](#sponsors)
+
+# Net::SSH 7.x
+
+* Docs: http://net-ssh.github.io/net-ssh
+* Issues: https://github.com/net-ssh/net-ssh/issues
+* Codes: https://github.com/net-ssh/net-ssh
+* Email: net-ssh@solutious.com
+
+*As of v2.6.4, all gem releases are signed. See [INSTALL](#install).*
+
+## DESCRIPTION:
+
+Net::SSH is a pure-Ruby implementation of the SSH2 client protocol.
+It allows you to write programs that invoke and interact with processes on remote servers, via SSH2.
+
+## FEATURES:
+
+* Execute processes on remote servers and capture their output
+* Run multiple processes in parallel over a single SSH connection
+* Support for SSH subsystems
+* Forward local and remote ports via an SSH connection
+
+## Supported Algorithms
+
+Net::SSH 6.0 disables by default the usage of weak algorithms.
+We strongly recommend that you install a servers's version that supports the latest algorithms.
+
+It is possible to return to the previous behavior by adding the option : `append_all_supported_algorithms: true`
+
+Unsecure algoritms will definitely be removed in Net::SSH 7.*.
+
+### Host Keys
+
+| Name                 | Support               | Details  |
+|----------------------|-----------------------|----------|
+| ssh-rsa              | OK                    |          |
+| ssh-ed25519          | OK                    | Require the gem `ed25519` |
+| ecdsa-sha2-nistp521  | OK                    | [using weak elliptic curves](https://safecurves.cr.yp.to/) |
+| ecdsa-sha2-nistp384  | OK                    | [using weak elliptic curves](https://safecurves.cr.yp.to/) |
+| ecdsa-sha2-nistp256  | OK                    | [using weak elliptic curves](https://safecurves.cr.yp.to/) |
+| ssh-dss              | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+
+### Key Exchange
+
+| Name                                 | Support               | Details  |
+|--------------------------------------|-----------------------|----------|
+| curve25519-sha256                    | OK                    | Require the gem `x25519` |
+| ecdh-sha2-nistp521                   | OK                    | [using weak elliptic curves](https://safecurves.cr.yp.to/) |
+| ecdh-sha2-nistp384                   | OK                    | [using weak elliptic curves](https://safecurves.cr.yp.to/) |
+| ecdh-sha2-nistp256                   | OK                    | [using weak elliptic curves](https://safecurves.cr.yp.to/) |
+| diffie-hellman-group1-sha1           | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| diffie-hellman-group14-sha1          | OK                    |          |
+| diffie-hellman-group-exchange-sha1   | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| diffie-hellman-group-exchange-sha256 | OK                    |          |
+
+### Encryption algorithms (ciphers)
+
+| Name                                 | Support               | Details  |
+|--------------------------------------|-----------------------|----------|
+| aes256-ctr / aes192-ctr / aes128-ctr | OK                    |          |
+| aes256-cbc / aes192-cbc / aes128-cbc | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| rijndael-cbc@lysator.liu.se          | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| blowfish-ctr blowfish-cbc            | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| cast128-ctr cast128-cbc              | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| 3des-ctr 3des-cbc                    | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| idea-cbc                             | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| none                                 | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+
+### Message Authentication Code algorithms
+
+| Name                 | Support               | Details  |
+|----------------------|-----------------------|----------|
+| hmac-sha2-512-etm    | OK                    |          |
+| hmac-sha2-256-etm    | OK                    |          |
+| hmac-sha2-512        | OK                    |          |
+| hmac-sha2-256        | OK                    |          |
+| hmac-sha2-512-96     | Deprecated in 6.0     | removed from the specification, will be removed in 7.0 |
+| hmac-sha2-256-96     | Deprecated in 6.0     | removed from the specification, will be removed in 7.0 |
+| hmac-sha1            | OK                    | for backward compatibility      |
+| hmac-sha1-96         | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| hmac-ripemd160       | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| hmac-md5             | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| hmac-md5-96          | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+| none                 | Deprecated in 6.0     | unsecure, will be removed in 7.0 |
+
+## SYNOPSIS:
+
+In a nutshell:
+
+```ruby
+require 'net/ssh'
+
+Net::SSH.start('host', 'user', password: "password") do |ssh|
+
+# capture all stderr and stdout output from a remote process
+output = ssh.exec!("hostname")
+puts output
+
+# capture only stdout matching a particular pattern
+stdout = ""
+ssh.exec!("ls -l /home/jamis") do |channel, stream, data|
+  stdout << data if stream == :stdout && /foo/.match(data)
+end
+puts stdout
+
+# run multiple processes in parallel to completion
+ssh.exec "sed ..."
+ssh.exec "awk ..."
+ssh.exec "rm -rf ..."
+ssh.loop
+
+# open a new channel and configure a minimal set of callbacks, then run
+# the event loop until the channel finishes (closes)
+channel = ssh.open_channel do |ch|
+  ch.exec "/usr/local/bin/ruby /path/to/file.rb" do |ch, success|
+    raise "could not execute command" unless success
+
+    # "on_data" is called when the process writes something to stdout
+    ch.on_data do |c, data|
+      $stdout.print data
+    end
+
+    # "on_extended_data" is called when the process writes something to stderr
+    ch.on_extended_data do |c, type, data|
+      $stderr.print data
+    end
+
+    ch.on_close { puts "done!" }
+  end
+end
+
+channel.wait
+
+# forward connections on local port 1234 to port 80 of www.capify.org
+ssh.forward.local(1234, "www.capify.org", 80)
+ssh.loop { true }
+end
+```
+
+See Net::SSH for more documentation, and links to further information.
+
+## REQUIREMENTS:
+
+The only requirement you might be missing is the OpenSSL bindings for Ruby with a version greather than `1.0.1`.
+These are built by default on most platforms, but you can verify that they're built and installed on your system by running the following command line:
+
+```sh
+ruby -ropenssl -e 'puts OpenSSL::OPENSSL_VERSION'
+```
+
+If that spits out something like `OpenSSL 1.0.1 14 Mar 2012`, then you're set.
+If you get an error, then you'll need to see about rebuilding ruby with OpenSSL support,
+or (if your platform supports it) installing the OpenSSL bindings separately.
+
+## INSTALL:
+
+```sh
+gem install net-ssh # might need sudo privileges
+```
+
+NOTE: If you are running on jruby on windows you need to install `jruby-pageant` manually
+(gemspec doesn't allow for platform specific dependencies at gem installation time).
+
+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):
+
+```sh
+# Add the public key as a trusted certificate
+# (You only need to do this once)
+curl -O https://raw.githubusercontent.com/net-ssh/net-ssh/master/net-ssh-public_cert.pem
+gem cert --add net-ssh-public_cert.pem
+```
+
+Then, when install the gem, do so with high security:
+
+```sh
+gem install net-ssh -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.
+
+For ed25519 public key auth support your bundle file should contain `ed25519`, `bcrypt_pbkdf` dependencies.
+
+```sh
+gem install ed25519
+gem install bcrypt_pbkdf
+```
+
+For curve25519-sha256 kex exchange support your bundle file should contain `x25519` dependency.
+
+## RUBY SUPPORT
+
+* See [net-ssh.gemspec](https://github.com/net-ssh/net-ssh/blob/master/net-ssh.gemspec) for current versions ruby requirements
+
+## RUNNING TESTS
+
+If you want to run the tests or use any of the Rake tasks, you'll need Mocha and
+other dependencies listed in Gemfile
+
+Run the test suite from the net-ssh directory with the following command:
+
+```sh
+bundle exec rake test
+```
+
+NOTE : you can run test on all ruby versions with docker :
+
+```
+docker-compose up --build
+```
+
+Run a single test file like this:
+
+```sh
+ruby -Ilib -Itest test/transport/test_server_version.rb
+```
+
+To run integration tests see [here](test/integration/README.md)
+
+### BUILDING GEM
+
+```sh
+rake build
+```
+
+### GEM SIGNING (for maintainers)
+
+If you have the net-ssh private signing key, you will be able to create signed release builds. Make sure the private key path matches the `signing_key` path set in `net-ssh.gemspec` and tell rake to sign the gem by setting the `NET_SSH_BUILDGEM_SIGNED` flag:
+
+```sh
+NET_SSH_BUILDGEM_SIGNED=true rake build
+```
+
+For time to time, the public certificate associated to the private key needs to be renewed. You can do this with the following command:
+
+```sh
+gem cert --build netssh@solutious.com --private-key path/2/net-ssh-private_key.pem
+mv gem-public_cert.pem net-ssh-public_cert.pem
+gem cert --add net-ssh-public_cert.pem
+```
+
+## Security contact information
+
+See [SECURITY.md](SECURITY.md)
+
+## CREDITS
+
+### Contributors
+
+This project exists thanks to all the people who contribute.
+
+[![contributors](https://opencollective.com/net-ssh/contributors.svg?width=890&button=false)](graphs/contributors)
+
+### Backers
+
+Thank you to all our backers! 🙏 [Become a backer](https://opencollective.com/net-ssh#backer)
+
+[![backers](https://opencollective.com/net-ssh/backers.svg?width=890)](https://opencollective.com/net-ssh#backers)
+
+### Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor](https://opencollective.com/net-ssh#sponsor)
+
+[![Sponsor](https://opencollective.com/net-ssh/sponsor/0/avatar.svg)](https://opencollective.com/net-ssh/sponsor/0/website)
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 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.