hrr_rb_ssh 0.2.2 → 0.3.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c8f4e84817663132562929cf774d32295eb62df8820d7c08aa621672ae6a002
-  data.tar.gz: 783f325e4514b69f5bc2c9936ad012d07d263e1c93aa813393afb773ee72c4c9
+  metadata.gz: '08be357edfafa61b913c4f28f6d97a29e7aa0c94eaef933a3ea2dce9bc51c9a3'
+  data.tar.gz: 4b87367e0ac95045fcfac372fd1e8735e896436a2d26a2987b94daad2244379f
 SHA512:
-  metadata.gz: b08a544e2085ea9399564ae5a0ce654ba81adbcf5eaa28b17dbea438d29dadeafb89a450d7cf3151115cce29d1e32a3dada2c14e96efe1f47516fad75076c551
-  data.tar.gz: 204b40938e402920729b2e96261faf2be13851b9ee4e2b0de996db9bba17363b169bfb107bc951917008c9950fc314a53807c1ea639d8512378ecc9711540e21
+  metadata.gz: f830b32cb263e45ca84596b310889cee768fcf870fc78093c818d2a8dff9fa59c09c334bb7942bf56b344d6d9ce9bcff609962880fcd7e4ac9b74aa1a703c8a5
+  data.tar.gz: 31f317c5fc929b0b04b78fa19d9f85be1f9e4aef4c57474e8fe06039e8f947818eb7e0033da21b80bd9f7e8fa8d3a544c348a468ba31da4cf509812013b2a550

data/.travis.yml

@@ -10,6 +10,7 @@ rvm:
   - 2.3
   - 2.4
   - 2.5
+  - 2.6
   - ruby-head
 os:
   - linux
@@ -17,10 +18,9 @@ matrix:
   allow_failures:
     - rvm: ruby-head
 before_install:
-  - gem update --system --no-document
-  - gem update --no-document
+  - gem uninstall -v '>= 2' -i $(rvm gemdir)@global -ax bundler || true
+  - gem install bundler -v '< 2'
 install:
-  - gem install bundler --no-document
   - bundle install --path vendor/bundle
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/README.md

@@ -27,6 +27,7 @@ With hrr_rb_ssh, it is possible to write an SSH server easily, and also possible
             - [Reference request handlers](#reference-request-handlers)
             - [Custom request handlers](#custom-request-handlers)
         - [Defining preferred algorithms (optional)](#defining-preferred-algorithms-optional)
+        - [Hiding and/or simulating local SSH version](#hiding-and-or-simulating-local-ssh-version)
     - [Demo](#demo)
 - [Supported Features](#supported-features)
     - [Connection layer](#connection-layer)
@@ -79,8 +80,8 @@ loop do
   Thread.new(server.accept) do |io|
     pid = fork do
       begin
-        server = HrrRbSsh::Server.new io, options
-        server.start
+        server = HrrRbSsh::Server.new options
+        server.start io
       ensure
         io.close
       end
@@ -274,7 +275,8 @@ options['connection_channel_request_shell'] = conn_echo
 In `HrrRbSsh::Connection::RequestHandler.new` block, context variable basically provides the followings.
 
 - `#io => [in, out, err]` : `in` is readable and read data is sent by remote. `out` and `err` are writable. `out` is for standard output and written data is sent as channel data. `err` is for standard error and written data is sent as channel extended data.
-- `#chain_proc => {|chain| ... }` : When a session channel is opened, a background thread is started and is waitng for a chaned block registered. This `#chain_proc` is used to define how to handle subsequent communications between local and remote. The `chain` variable provides `#call_next` method. In `#proc_chain` block, it is possible to call subsequent block that is defined in another request handler. For instance, shell request must called after pty-req request. The `chain` in pty-req request handler's `#chain_proc` calls `#next_proc` and then subsequent shell request handler's `#chain_proc` will be called.
+- `#chain_proc => {|chain| ... }` : When a session channel is opened, a background thread is started and is waitng for a chained block registered. This `#chain_proc` is used to define how to handle subsequent communications between local and remote. The `chain` variable provides `#call_next` method. In `#proc_chain` block, it is possible to call subsequent block that is defined in another request handler. For instance, shell request must called after pty-req request. The `chain` in pty-req request handler's `#chain_proc` calls `#next_proc` and then subsequent shell request handler's `#chain_proc` will be called.
+- `#close_session` : In most cases, input and output between a client and the server is handled in `#chain_proc` and closing the `#chain_proc` block will lead closing the underlying session channel. This means that to close the underlying session channel it is required to write at least one `#chain_proc` block. If it is not required to use `#chain_proc` block or is required to close the underlying session channel from outside of `#chain_proc` block, `#close_session` can be used. The `#close_session` will close the background thread that calls `#chain_proc` blocks.
 
 And request handler's `context` variable also provides additional methods based on request type. See `lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/<request type>/context.rb`.
 
@@ -321,6 +323,23 @@ p HrrRbSsh::Transport::CompressionAlgorithm.list_preferred
 # => ["none", "zlib"]
 ```
 
+#### Hiding and/or simulating local SSH version
+
+By default, hrr_rb_ssh sends `SSH-2.0-HrrRbSsh-#{VERSION}` string at initial negotiation with remote peer. To address security concerns, it is possible to replace the version string.
+
+```ruby
+# Hiding version
+options['local_version'] = "SSH-2.0-HrrRbSsh"
+
+# Simulating OpenSSH
+options['local_version'] = "SSH-2.0-OpenSSH_x.x"
+
+# Simulating OpenSSH and hiding version
+options['local_version'] = "SSH-2.0-OpenSSH"
+```
+
+Please note that the beginning of the string must be `SSH-2.0-`. Otherwise SSH 2.0 remote peer cannot continue negotiation with the local peer.
+
 ### Demo
 
 The `demo/server.rb` shows a good example on how to use the hrr_rb_ssh library in SSH server mode.

data/demo/echo_server.rb

@@ -39,8 +39,8 @@ def start_service io, logger=nil
   options['authentication_password_authenticator'] = auth_password
   options['connection_channel_request_shell']      = conn_echo
 
-  server = HrrRbSsh::Server.new io, options
-  server.start
+  server = HrrRbSsh::Server.new options
+  server.start io
 end
 
 logger = Logger.new STDOUT

data/demo/server.rb

@@ -89,8 +89,8 @@ OfeosJOO9twerD7pPhmXREkygblPsEXaVA==
   options['connection_channel_request_exec']          = HrrRbSsh::Connection::RequestHandler::ReferenceExecRequestHandler.new
   options['connection_channel_request_window_change'] = HrrRbSsh::Connection::RequestHandler::ReferenceWindowChangeRequestHandler.new
 
-  server = HrrRbSsh::Server.new io, options
-  server.start
+  server = HrrRbSsh::Server.new options
+  server.start io
 end
 
 

data/demo/subsystem_echo_server.rb

@@ -47,8 +47,8 @@ def start_service io, logger=nil
   options['authentication_password_authenticator'] = auth_password
   options['connection_channel_request_subsystem']  = conn_echo
 
-  server = HrrRbSsh::Server.new io, options
-  server.start
+  server = HrrRbSsh::Server.new options
+  server.start io
 end
 
 logger = Logger.new STDOUT

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/env/context.rb

@@ -20,7 +20,7 @@ module HrrRbSsh
                   :variable_name,
                   :variable_value
 
-                def initialize proc_chain, username, io, variables, message
+                def initialize proc_chain, username, io, variables, message, session
                   @logger = Logger.new self.class.name
 
                   @proc_chain = proc_chain
@@ -28,6 +28,7 @@ module HrrRbSsh
                   @io         = io
                   @variables  = variables
                   @vars       = variables
+                  @session    = session
 
                   @variable_name  = message[:'variable name']
                   @variable_value = message[:'variable value']
@@ -36,6 +37,10 @@ module HrrRbSsh
                 def chain_proc &block
                   @proc = block || @proc
                 end
+
+                def close_session
+                  @session.close
+                end
               end
             end
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/env.rb

@@ -13,10 +13,10 @@ module HrrRbSsh
             class Env < RequestType
               NAME = 'env'
 
-              def self.run proc_chain, username, io, variables, message, options
+              def self.run proc_chain, username, io, variables, message, options, session
                 logger = Logger.new self.class.name
 
-                context = Context.new proc_chain, username, io, variables, message
+                context = Context.new proc_chain, username, io, variables, message, session
                 handler = options.fetch('connection_channel_request_env', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/exec/context.rb

@@ -19,7 +19,7 @@ module HrrRbSsh
                   :vars,
                   :command
 
-                def initialize proc_chain, username, io, variables, message
+                def initialize proc_chain, username, io, variables, message, session
                   @logger = Logger.new self.class.name
 
                   @proc_chain = proc_chain
@@ -27,6 +27,7 @@ module HrrRbSsh
                   @io         = io
                   @variables  = variables
                   @vars       = variables
+                  @session    = session
 
                   @command = message[:'command']
                 end
@@ -34,6 +35,10 @@ module HrrRbSsh
                 def chain_proc &block
                   @proc = block || @proc
                 end
+
+                def close_session
+                  @session.close
+                end
               end
             end
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/exec.rb

@@ -13,10 +13,10 @@ module HrrRbSsh
             class Exec < RequestType
               NAME = 'exec'
 
-              def self.run proc_chain, username, io, variables, message, options
+              def self.run proc_chain, username, io, variables, message, options, session
                 logger = Logger.new self.class.name
 
-                context = Context.new proc_chain, username, io, variables, message
+                context = Context.new proc_chain, username, io, variables, message, session
                 handler = options.fetch('connection_channel_request_exec', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/pty_req/context.rb

@@ -24,7 +24,7 @@ module HrrRbSsh
                   :terminal_height_pixels,
                   :encoded_terminal_modes
 
-                def initialize proc_chain, username, io, variables, message
+                def initialize proc_chain, username, io, variables, message, session
                   @logger = Logger.new self.class.name
 
                   @proc_chain = proc_chain
@@ -32,6 +32,7 @@ module HrrRbSsh
                   @io         = io
                   @variables  = variables
                   @vars       = variables
+                  @session    = session
 
                   @term_environment_variable_value = message[:'TERM environment variable value']
                   @terminal_width_characters       = message[:'terminal width, characters']
@@ -44,6 +45,10 @@ module HrrRbSsh
                 def chain_proc &block
                   @proc = block || @proc
                 end
+
+                def close_session
+                  @session.close
+                end
               end
             end
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/pty_req.rb

@@ -13,10 +13,10 @@ module HrrRbSsh
             class PtyReq < RequestType
               NAME = 'pty-req'
 
-              def self.run proc_chain, username, io, variables, message, options
+              def self.run proc_chain, username, io, variables, message, options, session
                 logger = Logger.new self.class.name
 
-                context = Context.new proc_chain, username, io, variables, message
+                context = Context.new proc_chain, username, io, variables, message, session
                 handler = options.fetch('connection_channel_request_pty_req', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/shell/context.rb

@@ -18,7 +18,7 @@ module HrrRbSsh
                   :variables,
                   :vars
 
-                def initialize proc_chain, username, io, variables, message
+                def initialize proc_chain, username, io, variables, message, session
                   @logger = Logger.new self.class.name
 
                   @proc_chain = proc_chain
@@ -26,11 +26,16 @@ module HrrRbSsh
                   @io         = io
                   @variables  = variables
                   @vars       = variables
+                  @session    = session
                 end
 
                 def chain_proc &block
                   @proc = block || @proc
                 end
+
+                def close_session
+                  @session.close
+                end
               end
             end
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/shell.rb

@@ -13,10 +13,10 @@ module HrrRbSsh
             class Shell < RequestType
               NAME = 'shell'
 
-              def self.run proc_chain, username, io, variables, message, options
+              def self.run proc_chain, username, io, variables, message, options, session
                 logger = Logger.new self.class.name
 
-                context = Context.new proc_chain, username, io, variables, message
+                context = Context.new proc_chain, username, io, variables, message, session
                 handler = options.fetch('connection_channel_request_shell', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/subsystem/context.rb

@@ -19,7 +19,7 @@ module HrrRbSsh
                   :vars,
                   :subsystem_name
 
-                def initialize proc_chain, username, io, variables, message
+                def initialize proc_chain, username, io, variables, message, session
                   @logger = Logger.new self.class.name
 
                   @proc_chain = proc_chain
@@ -27,6 +27,7 @@ module HrrRbSsh
                   @io         = io
                   @variables  = variables
                   @vars       = variables
+                  @session    = session
 
                   @subsystem_name = message[:'subsystem name']
                 end
@@ -34,6 +35,10 @@ module HrrRbSsh
                 def chain_proc &block
                   @proc = block || @proc
                 end
+
+                def close_session
+                  @session.close
+                end
               end
             end
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/subsystem.rb

@@ -13,10 +13,10 @@ module HrrRbSsh
             class Subsystem < RequestType
               NAME = 'subsystem'
 
-              def self.run proc_chain, username, io, variables, message, options
+              def self.run proc_chain, username, io, variables, message, options, session
                 logger = Logger.new self.class.name
 
-                context = Context.new proc_chain, username, io, variables, message
+                context = Context.new proc_chain, username, io, variables, message, session
                 handler = options.fetch('connection_channel_request_subsystem', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/window_change/context.rb

@@ -22,7 +22,7 @@ module HrrRbSsh
                   :terminal_width_pixels,
                   :terminal_height_pixels
 
-                def initialize proc_chain, username, io, variables, message
+                def initialize proc_chain, username, io, variables, message, session
                   @logger = Logger.new self.class.name
 
                   @proc_chain = proc_chain
@@ -30,6 +30,7 @@ module HrrRbSsh
                   @io         = io
                   @variables  = variables
                   @vars       = variables
+                  @session    = session
 
                   @terminal_width_columns = message[:'terminal width, columns']
                   @terminal_height_rows   = message[:'terminal height, rows']
@@ -40,6 +41,10 @@ module HrrRbSsh
                 def chain_proc &block
                   @proc = block || @proc
                 end
+
+                def close_session
+                  @session.close
+                end
               end
             end
           end

data/lib/hrr_rb_ssh/connection/channel/channel_type/session/request_type/window_change.rb

@@ -13,10 +13,10 @@ module HrrRbSsh
             class WindowChange < RequestType
               NAME = 'window-change'
 
-              def self.run proc_chain, username, io, variables, message, options
+              def self.run proc_chain, username, io, variables, message, options, session
                 logger = Logger.new self.class.name
 
-                context = Context.new proc_chain, username, io, variables, message
+                context = Context.new proc_chain, username, io, variables, message, session
                 handler = options.fetch('connection_channel_request_window_change', RequestHandler.new {})
                 handler.run context
 

data/lib/hrr_rb_ssh/connection/channel/channel_type/session.rb

@@ -30,7 +30,7 @@ module HrrRbSsh
 
           def request message
             request_type = message[:'request type']
-            RequestType[request_type].run @proc_chain, @connection.username, @channel.io, @variables, message, @connection.options
+            RequestType[request_type].run @proc_chain, @connection.username, @channel.io, @variables, message, @connection.options, self
           end
 
           def proc_chain_thread

data/lib/hrr_rb_ssh/server.rb

@@ -8,16 +8,22 @@ require 'hrr_rb_ssh/connection'
 
 module HrrRbSsh
   class Server
-    def initialize io, options={}
+    def self.start io, options={}
+      server = self.new options
+      server.start io
+    end
+
+    def initialize options={}
       @logger = Logger.new self.class.name
-      @transport      = HrrRbSsh::Transport.new      io, HrrRbSsh::Mode::SERVER, options
-      @authentication = HrrRbSsh::Authentication.new @transport, options
-      @connection     = HrrRbSsh::Connection.new     @authentication, options
+      @options = options
     end
 
-    def start
+    def start io
       @logger.info { "start server service" }
-      @connection.start
+      transport      = HrrRbSsh::Transport.new      io, HrrRbSsh::Mode::SERVER, @options
+      authentication = HrrRbSsh::Authentication.new transport, @options
+      connection     = HrrRbSsh::Connection.new     authentication, @options
+      connection.start
     end
   end
 end

data/lib/hrr_rb_ssh/transport.rb

@@ -67,7 +67,7 @@ module HrrRbSsh
       @sender_monitor   = Monitor.new
       @receiver_monitor = Monitor.new
 
-      @local_version  = "SSH-2.0-HrrRbSsh-#{VERSION}".force_encoding(Encoding::ASCII_8BIT)
+      @local_version  = @options.delete('local_version') || "SSH-2.0-HrrRbSsh-#{VERSION}".force_encoding(Encoding::ASCII_8BIT)
       @remote_version = "".force_encoding(Encoding::ASCII_8BIT)
 
       @incoming_sequence_number = SequenceNumber.new

data/lib/hrr_rb_ssh/version.rb

@@ -2,5 +2,5 @@
 # vim: et ts=2 sw=2
 
 module HrrRbSsh
-  VERSION = "0.2.2"
+  VERSION = "0.3.0.pre1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hrr_rb_ssh
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0.pre1
 platform: ruby
 authors:
 - hirura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2019-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ed25519
@@ -316,9 +316,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6