lita-ssh-run 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b793719e3aa195e2c62439c4c422ffbc6265a454
-  data.tar.gz: 08c14c7a3c181c3bc538c326ed9f7011e110bff1
+  metadata.gz: 6668cf973bb770f5e4780e4158e3fb040bcaff6b
+  data.tar.gz: ceea91c7635db468810021111e925bafb7068886
 SHA512:
-  metadata.gz: 6d93b40502d91f6c41c65a9417721401920358d6e59bdf7d7a02d1d34d1a475b5f1e1572f32ed0307f45f3f74efb0ca5d134400889a0431d54d618264981ff44
-  data.tar.gz: eaa9647d43663756f0cc236c90589568287b9812acd43b13ba8c6d2150c27ac5233fefacbb35a611a1ad6b8c4ba0aff5614073c0def836b33c22a2ef4cb5675f
+  metadata.gz: f696b54d60afebd72c8b4e0df86efaf4c7f11cae81a86c7968d82f84ce192c67c041e6998a79aaf4914c6b1a0bf0278d6fbce54b1bfc40bb4de019f979f898ec
+  data.tar.gz: b4d3c3df2b10daf7415b272539e09cc627579ce63812b8486e09ffeb2bc7a07ab0e66a61d9c1ff0db86b429166b1007f1d46f0ab27861d48ef96ee8494895ae2

data/README.md

@@ -1,13 +1,17 @@
 # lita-ssh-run
 
-This will allow you to run commands via ssh
+This will allow you to run commands via ssh and powershell via winrm
+    
 Example:
 `Lita, run uptime on 192.168.1.10`
+`Lita, run Get-Service on 192.168.1.20`
 
-Usernames and passwords are stored in redis memory by chat userid and host passed. **Only tested on slack**
-If not found, it will prompt via private message on how to enter user and password:
+Usernames, passwords, and OS type are stored in redis memory by chat userid and host passed.  
+
+If not found, it will prompt via private message on how to enter user, password, and OS:
 Currently passwords are passed via plaintext in private message. I have requested to Slack to add an obfuscation format block for things like this.
 
+**Tested on slack and hipchat**  
 ## Installation
 
 Add lita-ssh-run to your Lita instance's Gemfile:
@@ -16,7 +20,6 @@ Add lita-ssh-run to your Lita instance's Gemfile:
 gem "lita-ssh-run"
 ```
 
-
 ## Configuration
 
 None
@@ -29,6 +32,12 @@ None
 
 `Lita, set password for 192.168.1.0 to PASSWORD`
 
+`Lita, set OS for 192.168.1.0 to linux`
+
+`Lita, set OS for 192.168.1.0 to windows`
+
+`List, set port for 192.168.1.0 to 2222`
+
 
 ## License
 

data/lib/lita/handlers/ssh_run.rb

@@ -1,73 +1,190 @@
 module Lita
   module Handlers
     class SshRun < Handler
-      require 'net/ssh'
+    require 'net/ssh'
+    require 'winrm'
 
-      route(/^run\s+(.+)\s+on\s+(.+)/i, :run_ssh, command: true)
+    route(/^run\s+(.+)\s+on\s+(.+)/i, 
+          :run_command, 
+          command: true, 
+          help: { "run <command> on <machine>" => "runs an ssh or powershell command on remote machine" })
 
-      route(/^set\s+(username|password)\s+for\s+(.+)\s+to\s+(.+)/i, :set_user_pass, command: true)
+    route(/^set\s+(username|password)\s+for\s+(.+)\s+to\s+(.+)/i, 
+          :set_user_pass, 
+          command: true, 
+          help: { "set <username or password> for <machineName>" =>
+                  "sets a username or password for a machine you want to run commands on" })
 
-      route(/^clear\s+all\s+stored\s+(creds|credentials)/i, :flush_redis, command: true, restrict_to: :admins)
+    route(/^set\s+(port)\s+for\s+(.+)\s+to\s+(.+)/i,
+          :set_server_port, 
+          command: true, 
+          help: { "set port for <machinename>" => 
+                  "changes default port for machine connection (defaults are 22 for SSH and 5985 for winrm" })
 
-      def run_ssh(response)
+    route(/^set\s+(os)\s+for\s+(.+)\s+to\s+(.+)/i, 
+          :set_server_os, 
+          command: true, 
+          help: { "set os for <machineName>" => 
+                  "choices are 'windows' and 'linux'. This tells us to use ssh or winrm for the specified machine" })
 
-        cmd = response.matches[0][0]
-        server = response.matches[0][1]
-        id_server_user = response.user.id + "_" + server + "_username"
-        id_server_pass = response.user.id + "_" + server + "_password"
-        usernm = redis.get(id_server_user)
-        passwd = redis.get(id_server_pass)
-        get_user_pass(response, server, "Username") unless usernm
-        get_user_pass(response, server, "Password") unless passwd
+    route(/^clear\s+all\s+stored\s+(creds|credentials)/i, 
+          :flush_redis, 
+          command: true, 
+          restrict_to: :admins, 
+          help: { "clear all stored cred" => 
+                  "blows away our redis data for lita-run-ssh" })
+
+    def run_command(response)
+      server = response.matches[0][1]
+      id_server_os = response.user.id + "_" + server + "_os"
+      os = redis.get(id_server_os)
+      get_os(response, server) unless['WINDOWS', 'LINUX'].include? os.to_s.upcase
+      if (os.to_s.upcase.eql? 'WINDOWS')
+        run_winrm(response)
+      elsif (os.to_s.upcase.eql? 'LINUX')
+        run_ssh(response)
+      else
+        response.reply("I was unable to find an OS for you on #{server}, please check you direct messages from me.")
+      end
+    end
 
-        if usernm && passwd
-          Net::SSH.start(server, usernm, :password => passwd) do |ssh|
-            output = ssh.exec!(cmd)
-            response.reply("```" + output + "```")
+    def run_ssh(response)
+      cmd = response.matches[0][0]
+      server = response.matches[0][1]
+      id_server_port = response.user.id + "_" + server + "_port"
+      port = redis.get(id_server_port)
+      if (port.nil?)
+        port = 22
+      end
+      id_server_user = response.user.id + "_" + server + "_username"
+      id_server_pass = response.user.id + "_" + server + "_password"
+      usernm = redis.get(id_server_user)
+      passwd = redis.get(id_server_pass)
+      get_user_pass(response, server, "Username") unless usernm
+      get_user_pass(response, server, "Password") unless passwd
+      if usernm && passwd && port
+        Net::SSH.start(server, usernm, :port => port, :password => passwd, :timeout => 10) do |ssh |
+          output = ssh.exec!(cmd)
+          if !output
+          response.reply("Command was run, but it appears there was no output to stdout or stderr.")
+          else
+            response.reply("```" + output.encode('utf-8', :invalid => :replace, :undef => :replace, :replace => '_') + "```")
           end
-        elsif usernm
-          response.reply_with_mention("I was unable to find a password for you on #{server}, please check you direct messages from me.")
-        elsif passwd
-          response.reply_with_mention("I was unable to find a username for you on #{server}, please check you direct messages from me.")
-        else
-          response.reply_with_mention("I was unable to find a username or password for you on #{server}, please check you direct messages from me.")
         end
+      elsif usernm
+        response.reply_with_mention("I was unable to find a password for you on #{server}, please check you direct messages from me.")
+      elsif passwd
+        response.reply_with_mention("I was unable to find a username for you on #{server}, please check you direct messages from me.")
+      else
+        response.reply_with_mention("I was unable to find a username or password for you on #{server}, please check you direct messages from me.")
+      end
+    end
 
+    def run_winrm(response)
+      cmd = response.matches[0][0]
+      server = response.matches[0][1]
+      id_server_port = response.user.id + "_" + server + "_port"
+      port = redis.get(id_server_port)
+      if (port.nil?)
+        port = 5985
       end
+      id_server_user = response.user.id + "_" + server + "_username"
+      id_server_pass = response.user.id + "_" + server + "_password"
+      usernm = redis.get(id_server_user)
+      passwd = redis.get(id_server_pass)
+      get_user_pass(response, server, "Username") unless usernm
+      get_user_pass(response, server, "Password") unless passwd
+      if usernm && passwd && port
+      endpoint = "http://#{server}:#{port}/wsman"
+      winrm = WinRM::WinRMWebService.new(endpoint, :negotiate, :user => usernm, :pass => passwd)
+      winrm.create_executor do |executor|
+        executor.run_powershell_script(cmd) do |stdout, stderr|
+          if stdout.to_s == '' && stderr.to_s == ''
+            response.reply("Command was run, but it appears there was no output to stdout or stderr.")
+          else
+            out = StringIO.new
+            out.puts stdout
+            response.reply(out.string)
+          end
+        end
+      end
+      elsif usernm
+        response.reply_with_mention("I was unable to find a password for you on #{server}, please check you direct messages from me.")
+      elsif passwd
+        response.reply_with_mention("I was unable to find a username for you on #{server}, please check you direct messages from me.")
+      else
+        response.reply_with_mention("I was unable to find a username or password for you on #{server}, please check you direct messages from me.")
+      end
+    end
+
+    def get_user_pass(response, server, * user_pass)
+      user_pass.each do |blah|
+        response.reply_privately("No #{blah.capitalize} found for you on #{server}\nPlease privately reply with:\n`Lita, set #{blah.capitalize} for #{server} to #{blah.upcase}`")
+      end
+    end
 
-      def get_user_pass(response, server, *user_pass)
-        user_pass.each do |blah|
-          response.reply_privately("No #{blah.capitalize} found for you on #{server}\nPlease privately reply with:\n`Lita, Set #{blah.capitalize} for #{server} to #{blah.upcase}`")
+    def get_os(response, server)
+      response.reply_privately("No os found for you on #{server}\nPlease privately reply with:\n`Lita, set os for #{server} to windows` or \n`Lita, set os for #{server} to linux`")
+    end
+
+    def set_user_pass(response)
+      request = response.matches[0][0]
+      server = response.matches[0][1]
+      value = response.matches[0][2]
+      id_server_user_pass = response.user.id + "_" + server + "_" + request.downcase
+      if request && server && value
+        redis.set(id_server_user_pass, value)
+        response.reply_privately("#{request.capitalize} set")
+        id_server_user = response.user.id + "_" + server + "_username"
+        id_server_pass = response.user.id + "_" + server + "_password"
+        if redis.get(id_server_user) && redis.get(id_server_pass)
+          response.reply("Username and Password now set, please rerun your request")
         end
+      else
+        response.reply_privately("There seems to have been a problem setting that for you")
       end
+    end
 
-      def set_user_pass(response)
-        request = response.matches[0][0]
-        server = response.matches[0][1]
-        value = response.matches[0][2]
-        id_server_user_pass = response.user.id + "_" + server + "_" + request.downcase
+    def flush_redis(response)
+      redis.flushdb
+    end
 
-        if request && server && value
-          redis.set(id_server_user_pass, value)
-          response.reply_privately("#{request.capitalize} set")
-          id_server_user = response.user.id + "_" + server + "_username"
-          id_server_pass = response.user.id + "_" + server + "_password"
-          if redis.get(id_server_user) && redis.get(id_server_pass)
-            response.reply("Username and Password now set, please rerun your request")
+    def set_server_port(response)
+      request = response.matches[0][0]
+      server = response.matches[0][1]
+      value = response.matches[0][2]
+      id_server_port = response.user.id + "_" + server + "_port"
+      if request && server && value
+        redis.set(id_server_port, value)
+        if redis.get(id_server_port)
+          response.reply("Server Port now set to #{value}")
+        end
+      else
+        response.reply_privately("There seems to have been a problem setting that for you")
+      end
+    end
 
+    def set_server_os(response)
+      request = response.matches[0][0]
+      server = response.matches[0][1]
+      value = response.matches[0][2]
+      id_server_os = response.user.id + "_" + server + "_os"
+      if ['WINDOWS', 'LINUX'].include? value.to_s.upcase
+        if request && server && value
+          redis.set(id_server_os, value)
+          id_server_os = response.user.id + "_" + server + "_os"
+          if redis.get(id_server_os)
+            response.reply("Server os now set to #{value}.")
           end
         else
           response.reply_privately("There seems to have been a problem setting that for you")
         end
+        else
+          response.reply_privately("valid options for os are: windows, linux")
       end
-
-      def flush_redis(response)
-        redis.flushdb
-      end
-
-
     end
 
     Lita.register_handler(SshRun)
+    end
   end
-end
+end

data/lita-ssh-run.gemspec

@@ -1,9 +1,9 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-ssh-run"
-  spec.version       = "0.0.1"
+  spec.version       = "0.0.3"
   spec.authors       = ["Dan Cash"]
   spec.email         = ["dancash04@gmail.com"]
-  spec.description   = %q{Runs commands against remote server via ssh}
+  spec.description   = %q{Runs commands against remote server via ssh or winrm}
   spec.summary       = %q{See description}
   spec.homepage      = "https://github.com/cashman04/lita-ssh-run"
   spec.license       = "MIT"
@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "lita", ">= 4.1"
   spec.add_runtime_dependency 'net-ssh'
+  spec.add_runtime_dependency 'winrm'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,128 +1,142 @@
 --- !ruby/object:Gem::Specification
 name: lita-ssh-run
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Dan Cash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-28 00:00:00.000000000 Z
+date: 2016-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: winrm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Runs commands against remote server via ssh
+description: Runs commands against remote server via ssh or winrm
 email:
 - dancash04@gmail.com
 executables: []
@@ -150,17 +164,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: See description