hrr_rb_ssh 0.3.0.pre1 → 0.3.0.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08be357edfafa61b913c4f28f6d97a29e7aa0c94eaef933a3ea2dce9bc51c9a3'
-  data.tar.gz: 4b87367e0ac95045fcfac372fd1e8735e896436a2d26a2987b94daad2244379f
+  metadata.gz: 2a478983b765002a5277ac63e5ae06e4eccde19d35394b762c13760c33a9cf4b
+  data.tar.gz: d541edd1bd30026919fbf0b4d47369d6853a7ad9f9705b00a43054eaf85d41bd
 SHA512:
-  metadata.gz: f830b32cb263e45ca84596b310889cee768fcf870fc78093c818d2a8dff9fa59c09c334bb7942bf56b344d6d9ce9bcff609962880fcd7e4ac9b74aa1a703c8a5
-  data.tar.gz: 31f317c5fc929b0b04b78fa19d9f85be1f9e4aef4c57474e8fe06039e8f947818eb7e0033da21b80bd9f7e8fa8d3a544c348a468ba31da4cf509812013b2a550
+  metadata.gz: e7c09c9e54fa096de5b2417490860e0e80f5ac3c73e2d8fda28b53bdf77fbc7233bede1ecc961bc31cdc817be39fc32bb2b72708d266a4fd46138bdae980e439
+  data.tar.gz: 536e9e52e0eaa7d88449f740ae379d9c2bb0a7c9e29bde06762da14d7220fcc89178cc8f835afc63e1bf9f28c23a7ca876826d219364f4fa7b7dab94a7d1f989

data/README.md

@@ -161,6 +161,8 @@ The `context` variable in password authentication context provides the following
 
 - `#username` : The username that a remote user tries to authenticate
 - `#password` : The password that a remote user tries to authenticate
+- `#variables` : A hash instance that is shared in each authenticator and subsequent session channel request handlers
+- `#vars` : The same object that `#variables` returns
 - `#verify(username, password)` : Returns `true` when username and password arguments match with the context's username and password. Or returns `false` when username and password arguments don't match.
 
 ##### Publickey authentication
@@ -277,6 +279,8 @@ In `HrrRbSsh::Connection::RequestHandler.new` block, context variable basically
 - `#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 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.
+- `#variables => Hash` : A hash instance that is passed from authenticator and is shared in subsequent session channel request handlers
+- `#vars` : The same object that `#variables` returns
 
 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`.
 

data/hrr_rb_ssh.gemspec

@@ -1,3 +1,5 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
 
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
@@ -21,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_dependency "ed25519", "~> 1.2"
-  spec.add_development_dependency "bundler", "~> 1.16"
+
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.8"
+  spec.add_development_dependency "simplecov", "~> 0.16"
 end

data/lib/hrr_rb_ssh/authentication.rb

@@ -22,6 +22,7 @@ module HrrRbSsh
       @closed = nil
 
       @username = nil
+      @variables = {}
     end
 
     def send payload
@@ -62,6 +63,11 @@ module HrrRbSsh
       @username
     end
 
+    def variables
+      raise Error::ClosedAuthentication if @closed
+      @variables
+    end
+
     def authenticate
       loop do
         payload = @transport.receive
@@ -69,7 +75,7 @@ module HrrRbSsh
         when Message::SSH_MSG_USERAUTH_REQUEST::VALUE
           userauth_request_message = Message::SSH_MSG_USERAUTH_REQUEST.decode payload
           method_name = userauth_request_message[:'method name']
-          method = Method[method_name].new(@transport, {'session id' => @transport.session_id}.merge(@options))
+          method = Method[method_name].new(@transport, {'session id' => @transport.session_id}.merge(@options), @variables)
           result = method.authenticate(userauth_request_message)
           case result
           when TrueClass

data/lib/hrr_rb_ssh/authentication/method/keyboard_interactive.rb

@@ -10,10 +10,11 @@ module HrrRbSsh
         NAME = 'keyboard-interactive'
         PREFERENCE = 30
 
-        def initialize transport, options
+        def initialize transport, options, variables
           @logger = Logger.new(self.class.name)
           @transport = transport
           @authenticator = options.fetch( 'authentication_keyboard_interactive_authenticator', Authenticator.new { false } )
+          @variables = variables
         end
 
         def authenticate userauth_request_message
@@ -21,7 +22,7 @@ module HrrRbSsh
           @logger.debug { "userauth request: " + userauth_request_message.inspect }
           username = userauth_request_message[:'user name']
           submethods = userauth_request_message[:'submethods']
-          context = Context.new(@transport, username, submethods)
+          context = Context.new(@transport, username, submethods, @variables)
           @authenticator.authenticate context
         end
       end

data/lib/hrr_rb_ssh/authentication/method/keyboard_interactive/context.rb

@@ -13,12 +13,16 @@ module HrrRbSsh
           attr_reader \
             :username,
             :submethods,
-            :info_response
+            :info_response,
+            :variables,
+            :vars
 
-          def initialize transport, username, submethods
+          def initialize transport, username, submethods, variables
             @transport = transport
             @username = username
             @submethods = submethods
+            @variables = variables
+            @vars = variables
 
             @logger = Logger.new self.class.name
           end

data/lib/hrr_rb_ssh/authentication/method/keyboard_interactive/info_request.rb

@@ -30,7 +30,7 @@ module HrrRbSsh
               [
                 [:"prompt[#{i+1}]", prompt],
                 [:"echo[#{i+1}]",   echo],
-              ].to_h
+              ].inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
             }.inject(Hash.new){ |a, b| a.merge(b) }
             message.merge(message_prompts)
           end

data/lib/hrr_rb_ssh/authentication/method/none.rb

@@ -10,15 +10,16 @@ module HrrRbSsh
         NAME = 'none'
         PREFERENCE = 0
 
-        def initialize transport, options
+        def initialize transport, options, variables
           @logger = Logger.new(self.class.name)
           @authenticator = options.fetch( 'authentication_none_authenticator', Authenticator.new { false } )
+          @variables = variables
         end
 
         def authenticate userauth_request_message
           @logger.info { "authenticate" }
           @logger.debug { "userauth request: " + userauth_request_message.inspect }
-          context = Context.new(userauth_request_message[:'user name'])
+          context = Context.new(userauth_request_message[:'user name'], @variables)
           @authenticator.authenticate context
         end
       end

data/lib/hrr_rb_ssh/authentication/method/none/context.rb

@@ -8,10 +8,15 @@ module HrrRbSsh
     class Method
       class None
         class Context
-          attr_reader :username
+          attr_reader \
+            :username,
+            :variables,
+            :vars
 
-          def initialize username
+          def initialize username, variables
             @username = username
+            @variables = variables
+            @vars = variables
 
             @logger = Logger.new self.class.name
           end

data/lib/hrr_rb_ssh/authentication/method/password.rb

@@ -10,9 +10,10 @@ module HrrRbSsh
         NAME = 'password'
         PREFERENCE = 10
 
-        def initialize transport, options
+        def initialize transport, options, variables
           @logger = Logger.new(self.class.name)
           @authenticator = options.fetch( 'authentication_password_authenticator', Authenticator.new { false } )
+          @variables = variables
         end
 
         def authenticate userauth_request_message
@@ -20,7 +21,7 @@ module HrrRbSsh
           @logger.debug { "userauth request: " + userauth_request_message.inspect }
           username = userauth_request_message[:'user name']
           password = userauth_request_message[:'plaintext password']
-          context = Context.new(username, password)
+          context = Context.new(username, password, @variables)
           @authenticator.authenticate context
         end
       end

data/lib/hrr_rb_ssh/authentication/method/password/context.rb

@@ -8,11 +8,17 @@ module HrrRbSsh
     class Method
       class Password
         class Context
-          attr_reader :username, :password
+          attr_reader \
+            :username,
+            :password,
+            :variables,
+            :vars
 
-          def initialize username, password
+          def initialize username, password, variables
             @username = username
             @password = password
+            @variables = variables
+            @vars = variables
 
             @logger = Logger.new self.class.name
           end

data/lib/hrr_rb_ssh/authentication/method/publickey.rb

@@ -10,10 +10,11 @@ module HrrRbSsh
         NAME = 'publickey'
         PREFERENCE = 20
 
-        def initialize transport, options
+        def initialize transport, options, variables
           @logger = Logger.new(self.class.name)
           @session_id = options['session id']
           @authenticator = options.fetch( 'authentication_publickey_authenticator', Authenticator.new { false } )
+          @variables = variables
         end
 
         def authenticate userauth_request_message
@@ -30,7 +31,7 @@ module HrrRbSsh
             @logger.info { "verify signature" }
             username = userauth_request_message[:'user name']
             algorithm = Algorithm[public_key_algorithm_name].new
-            context = Context.new(username, algorithm, @session_id, userauth_request_message)
+            context = Context.new(username, algorithm, @session_id, userauth_request_message, @variables)
             @authenticator.authenticate context
           end
         end

data/lib/hrr_rb_ssh/authentication/method/publickey/context.rb

@@ -11,6 +11,8 @@ module HrrRbSsh
           attr_reader \
             :username,
             :session_id,
+            :variables,
+            :vars,
             :message_number,
             :service_name,
             :method_name,
@@ -19,11 +21,13 @@ module HrrRbSsh
             :public_key_blob,
             :signature
 
-          def initialize username, algorithm, session_id, message
+          def initialize username, algorithm, session_id, message, variables
             @username   = username
             @algorithm  = algorithm
             @session_id = session_id
             @message    = message
+            @variables  = variables
+            @vars       = variables
 
             @message_number            = message[:'message number']
             @service_name              = message[:'service name']

data/lib/hrr_rb_ssh/codable.rb

@@ -58,9 +58,9 @@ module HrrRbSsh
 
     def decode payload, complementary_message={}
       payload_io = StringIO.new payload
-      decoded_message = decode_recursively(payload_io).to_h
+      decoded_message = decode_recursively(payload_io).inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
       if complementary_message.any?
-        decoded_message.merge! decode_recursively(payload_io, complementary_message.to_a).to_h
+        decoded_message.merge! decode_recursively(payload_io, complementary_message.to_a).inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
       end
       logger.debug { 'decoded message: ' + decoded_message.inspect }
       decoded_message

data/lib/hrr_rb_ssh/compat/ruby.rb

@@ -1,6 +1,5 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_ssh/compat/ruby/array'
 require 'hrr_rb_ssh/compat/ruby/openssl'
 require 'hrr_rb_ssh/compat/ruby/queue'

data/lib/hrr_rb_ssh/connection.rb

@@ -10,6 +10,7 @@ module HrrRbSsh
   class Connection
     attr_reader \
       :username,
+      :variables,
       :options
 
     def initialize authentication, options={}
@@ -21,6 +22,7 @@ module HrrRbSsh
       @global_request_handler = GlobalRequestHandler.new self
       @channels = Hash.new
       @username = nil
+      @variables = nil
       @closed = nil
     end
 
@@ -76,6 +78,7 @@ module HrrRbSsh
           break
         end
         @username ||= @authentication.username
+        @variables ||= @authentication.variables
         case payload[0,1].unpack("C")[0]
         when Message::SSH_MSG_GLOBAL_REQUEST::VALUE
           global_request payload

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

@@ -14,7 +14,6 @@ module HrrRbSsh
             @logger = Logger.new self.class.name
             @connection = connection
             @channel = channel
-            @variables = {}
             @proc_chain = ProcChain.new
           end
 
@@ -30,7 +29,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, self
+            RequestType[request_type].run @proc_chain, @connection.username, @channel.io, @connection.variables, message, @connection.options, self
           end
 
           def proc_chain_thread

data/lib/hrr_rb_ssh/message/098_ssh_msg_channel_request.rb

@@ -89,7 +89,7 @@ module HrrRbSsh
       ID    = self.name.split('::').last
       VALUE = 98
 
-      TERMINAL_MODE_INV = TerminalMode.constants.map{|c| [TerminalMode.const_get(c), c.to_s]}.to_h
+      TERMINAL_MODE_INV = TerminalMode.constants.map{|c| [TerminalMode.const_get(c), c.to_s]}.inject(Hash.new){ |h, (k, v)| h.update({k => v}) }
 
       DEFINITION = [
         #[DataType, Field Name]

data/lib/hrr_rb_ssh/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hrr_rb_ssh
 version: !ruby/object:Gem::Version
-  version: 0.3.0.pre1
+  version: 0.3.0.pre2
 platform: ruby
 authors:
 - hirura
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.8
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.8
+        version: '0.16'
 description: Pure Ruby SSH 2.0 server implementation
 email:
 - hirura@gmail.com
@@ -149,7 +135,6 @@ files:
 - lib/hrr_rb_ssh/compat/openssh/authorized_keys.rb
 - lib/hrr_rb_ssh/compat/openssh/public_key.rb
 - lib/hrr_rb_ssh/compat/ruby.rb
-- lib/hrr_rb_ssh/compat/ruby/array.rb
 - lib/hrr_rb_ssh/compat/ruby/openssl.rb
 - lib/hrr_rb_ssh/compat/ruby/openssl/bn.rb
 - lib/hrr_rb_ssh/compat/ruby/queue.rb

data/lib/hrr_rb_ssh/compat/ruby/array.rb

@@ -1,14 +0,0 @@
-# coding: utf-8
-# vim: et ts=2 sw=2
-
-if RUBY_VERSION < "2.1"
-  class Array
-    def to_h
-      h = Hash.new
-      self.each do |k, v|
-        h[k] = v
-      end
-      h
-    end
-  end
-end