spectre-ssh 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 774fafd0f95bfcbac2c96ffbb732918f1d7beb56c4045fcd5e0468c429664ff2
-  data.tar.gz: 280800cbaf572c48ded2db30090484bed91df9605ed3f3d046e366d21ff42552
+  metadata.gz: 8548d3d2c8b5cf86005bc9c9884e8ffad6250783c997af68a9c37b5b1577d759
+  data.tar.gz: 70d690e4e1c0e16a5fcd8f9b3c05c3b00721933a374e6550410558aa0927742d
 SHA512:
-  metadata.gz: 45c553eaeaaf6334e3ce12cae5a0c56fa022564436ea5368d7a94a61d35c4f0d8c09ee9972c5f36706ad85975984ce92ae4c489997790ec9a97911c8b1865241
-  data.tar.gz: caf6aacbc8313f0a1d9e500ffe7861b39a423b61a873af078aff96262b5a95aea69ffb0b6d300a2b736ca5ae1706739f6771a8489d9b544c36b96adc6c6a8059
+  metadata.gz: ef75af4b62cfd54b508b3ab2b0d974a811dc68f7c270ed2bb214720984f8d421bd90727e207f8208c402a1a0f7e83df3b7ac1c1081f7cfc07a993b02b81458a2
+  data.tar.gz: 9da77291b02ed303bd09273b5e85b073646fbd4cce4d17019d1230fd2bb32c279f6b76b55d13088e5674bc154ec48e52da33853a11e09b8cec85e854748d8ea6

data/lib/spectre/ssh.rb

@@ -7,6 +7,9 @@ module Spectre
   module SSH
     @@cfg = {}
 
+    class SSHError < Exception
+    end
+
     class SSHConnection < Spectre::DslClass
       def initialize host, username, opts, logger
         opts[:non_interactive] = true
@@ -20,6 +23,24 @@ module Spectre
         @__output = ''
       end
 
+      def username user
+        @__username = user
+      end
+
+      def password pass
+        @__opts[:password] = pass
+        @__opts[:auth_methods].push 'password' unless @__opts[:auth_methods].include? 'password'
+      end
+
+      def private_key file_path
+        @__opts[:keys] = [file_path]
+        @__opts[:auth_methods].push 'publickey' unless @__opts[:auth_methods].include? 'publickey'
+      end
+
+      def passphrase phrase
+        @__opts[:passphrase] = phrase
+      end
+
       def file_exists path
         exec "ls #{path}"
         exit_code == 0
@@ -32,11 +53,19 @@ module Spectre
 
       def connect!
         return unless @__session == nil or @__session.closed?
-        @__session = Net::SSH.start(@__host, @__username, @__opts)
+
+        begin
+          @__session = Net::SSH.start(@__host, @__username, @__opts)
+        rescue SocketError
+          raise SSHError.new("Unable to connect to #{@__host} with user #{@__username}")
+        rescue Net::SSH::AuthenticationFailed
+          raise SSHError.new("Authentication failed for #{@__username}@#{@__host}. Please check password, SSH keys and passphrases.")
+        end
       end
 
       def close
         return unless @__session and not @__session.closed?
+
         @__session.close
       end
 
@@ -64,20 +93,20 @@ module Spectre
         log_str = "#{@__session.options[:user]}@#{@__session.host} -p #{@__session.options[:port]} #{command}"
 
         @channel = @__session.open_channel do |channel|
-          channel.exec(command) do |ch, success|
+          channel.exec(command) do |_ch, success|
             abort "could not execute #{command} on #{@__session.host}" unless success
 
             @__output = ''
 
-            channel.on_data do |ch, data|
+            channel.on_data do |_, data|
               @__output += data
             end
 
-            channel.on_extended_data do |ch,type,data|
+            channel.on_extended_data do |_, _type, data|
               @__output += data
             end
 
-            channel.on_request('exit-status') do |ch, data|
+            channel.on_request('exit-status') do |_, data|
               @__exit_code = data.read_long
             end
 
@@ -85,7 +114,6 @@ module Spectre
             #   exit_code = data.read_long
             # end
           end
-
         end
 
         @channel.wait
@@ -106,24 +134,24 @@ module Spectre
 
 
     class << self
-      def ssh name, config = {}, &block
-        raise "SSH connection '#{name}' not configured" unless @@cfg.key?(name) or config.count > 0
-
+      def ssh name, options = {}, &block
         cfg = @@cfg[name] || {}
 
         host = cfg['host'] || name
-        username = config[:username] || cfg['username']
-        password = config[:password] || cfg['password']
+        username = options[:username] || cfg['username']
+        password = options[:password] || cfg['password']
 
         opts = {}
         opts[:password] = password
-        opts[:port] = config[:port] || cfg['port'] || 22
-        opts[:keys] = [cfg['key']] if cfg.key? 'key'
-        opts[:passphrase] = cfg['passphrase'] if cfg.key? 'passphrase'
+        opts[:port] = options[:port] || cfg['port'] || 22
+
+        ssh_key = options[:key] || cfg['key']
+        opts[:keys] = [ssh_key] unless ssh_key.nil?
+        opts[:passphrase] = options[:passphrase] || cfg['passphrase']
 
         opts[:auth_methods] = []
-        opts[:auth_methods].push 'publickey' if opts[:keys]
-        opts[:auth_methods].push 'password' if opts[:password]
+        opts[:auth_methods].push 'publickey' unless opts[:keys].nil? or opts[:keys].empty?
+        opts[:auth_methods].push 'password' unless opts[:password].nil?
 
         ssh_con = SSHConnection.new(host, username, opts, @@logger)
 
@@ -136,7 +164,7 @@ module Spectre
     end
 
     Spectre.register do |config|
-      @@logger = ::Logger.new config['log_file'], progname: 'spectre/ssh'
+      @@logger = Spectre::Logging::ModuleLogger.new(config, 'spectre/ssh')
 
       if config.key? 'ssh'
         config['ssh'].each do |name, cfg|
@@ -147,4 +175,4 @@ module Spectre
 
     Spectre.delegate :ssh, to: self
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spectre-ssh
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Christian Neubauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-19 00:00:00.000000000 Z
+date: 2023-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl
@@ -16,58 +16,85 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 7.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.1.0
+        version: 7.1.0
 - !ruby/object:Gem::Dependency
   name: spectre-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 1.14.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.4
+        version: 1.14.3
+- !ruby/object:Gem::Dependency
+  name: ed25519
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: bcrypt_pbkdf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: Adds SSH access functionality to the spectre framework
 email:
-- me@christianneubauer.de
+- christian.neubauer@ionos.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/spectre/ssh.rb
-homepage: https://github.com/cneubauer/spectre-ssh
+homepage: https://github.com/ionos-spectre/spectre-ssh
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/cneubauer/spectre-ssh
-  source_code_uri: https://github.com/cneubauer/spectre-ssh
-  changelog_uri: https://github.com/cneubauer/spectre-ssh/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/ionos-spectre/spectre-ssh
+  source_code_uri: https://github.com/ionos-spectre/spectre-ssh
+  changelog_uri: https://github.com/ionos-spectre/spectre-ssh/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -76,14 +103,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: SSH module for spectre