spectre-ssh 1.0.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 180b0db0cfa9d88522b4f4147f5b2e2e2bdb2c9da4743d6fac85599f71769ea6
-  data.tar.gz: 7b65847ee82c04053f4ad6d1bc91aab8aa92aada3703505027bb3167a35bd5fd
+  metadata.gz: 471635f940f6c5c48d2d7e5645dc869d21180fb8e4aadecf3c60982fc1eb343f
+  data.tar.gz: 6bbbff4e6993938a834e85d50541a95ab51ce2085e61d73eb073821a85256b78
 SHA512:
-  metadata.gz: 907a71a63ac527f78b981c5dde110ce5914361685195d7827d23e6d716dbeea7402dadbbe849e0cb13c3b63ebcb01a5c26a76fac3be14109d99ddca20858147e
-  data.tar.gz: 1b9031c4c95d3773fe1b8fe83f310149a3c07226cc66ddce63efffabae98c27b745d54db774e80cb7801c98db298cc8139ce184508dd7ec685d767a2b5f5eb29
+  metadata.gz: de5f1b6829bbb9206d9d20e50bbedea9f037864e800e9fdf1bfebc1fbeacfcbadff2cd7bef9ce403687b23e22afe0a9f4ce10e1b2ee2b46b850fe3838de0237e
+  data.tar.gz: bd7c49933f0ef4f707261a1046dfbc0b66fc6b5c495f33d167da3b58a6fb48d23ceeb362f57638984830d4229693a145317303f5ad2d3443800266aaae6859a3

data/lib/spectre/ssh.rb

@@ -1,16 +1,13 @@
 require 'net/ssh'
 require 'logger'
 require 'spectre'
-
+require 'net/ssh/proxy/http'
 
 module Spectre
   module SSH
     @@cfg = {}
 
     class SSHError < Exception
-      def initialize message
-        super message
-      end
     end
 
     class SSHConnection < Spectre::DslClass
@@ -26,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
@@ -38,6 +53,7 @@ module Spectre
 
       def connect!
         return unless @__session == nil or @__session.closed?
+
         begin
           @__session = Net::SSH.start(@__host, @__username, @__opts)
         rescue SocketError
@@ -49,6 +65,7 @@ module Spectre
 
       def close
         return unless @__session and not @__session.closed?
+
         @__session.close
       end
 
@@ -76,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
 
@@ -97,7 +114,6 @@ module Spectre
             #   exit_code = data.read_long
             # end
           end
-
         end
 
         @channel.wait
@@ -119,8 +135,6 @@ module Spectre
 
     class << self
       def ssh name, options = {}, &block
-        raise "SSH connection '#{name}' not configured" unless @@cfg.key?(name) or options.count > 0
-
         cfg = @@cfg[name] || {}
 
         host = cfg['host'] || name
@@ -139,6 +153,10 @@ module Spectre
         opts[:auth_methods].push 'publickey' unless opts[:keys].nil? or opts[:keys].empty?
         opts[:auth_methods].push 'password' unless opts[:password].nil?
 
+        proxy_host = options[:proxy_host] || cfg['proxy_host']
+        proxy_port = options[:proxy_port] || cfg['proxy_port']
+        opts[:proxy] = Net::SSH::Proxy::HTTP.new(proxy_host, proxy_port) unless proxy_host.nil?
+
         ssh_con = SSHConnection.new(host, username, opts, @@logger)
 
         begin
@@ -150,7 +168,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|
@@ -161,4 +179,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.2
+  version: 1.2.0
 platform: ruby
 authors:
 - Christian Neubauer
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: openssl
@@ -30,28 +30,28 @@ dependencies:
     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.0
+        version: 1.14.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.14.3
 - !ruby/object:Gem::Dependency
   name: ed25519
   requirement: !ruby/object:Gem::Requirement
@@ -92,11 +92,10 @@ homepage: https://github.com/ionos-spectre/spectre-ssh
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
   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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -104,15 +103,15 @@ 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.3.7
-signing_key:
+rubygems_version: 3.3.26
+signing_key: 
 specification_version: 4
 summary: SSH module for spectre
 test_files: []