ssh_scan 0.0.4 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe073c7993799a15ff0c5810aaa2258e77cb5a79
-  data.tar.gz: c174c8f25bddd40e032bdd211fd1f3d6875e59e3
+  metadata.gz: 7d2c9bf22bc6a5d8add93c53017b015ef4c93d34
+  data.tar.gz: 1e8b0e0240aa1bbec27895aab4df439ba393d99b
 SHA512:
-  metadata.gz: 88395aabbb5d6f8514453681ba75ebf8e8a894103f39f554bbeab90682de18408aacc5942da7e74063f8f4e919f6c281baab9ec6e43d3f3ac74ede840e2b180e
-  data.tar.gz: f75b79b572e5526827a129190db5bd1558fde3b365e39b78a9cce0439be6f2390c78e5a4b796a3d2f303b648e963dad7f5599e3e119f0a511dffad7e9089ca03
+  metadata.gz: 03dccca8b8627bced9051658a17614e37d01bbf7f9331be5938479347c671aaa2d0736ddb520916ce08d6fa7285c76201162f57d36998f6dd54fc4cbf60223f1
+  data.tar.gz: d1f61dd9ab0b18114817ca086ec0fe06930a36bd9ca14247dac43b829ef4119a2688adb1902673394acd9e8b4210a0a34d709ed7d92b4fbc869fc39923ab7044

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://secure.travis-ci.org/claudijd/ssh_scan.png)](http://travis-ci.org/claudijd/ssh_scan)
 [![Code Climate](https://codeclimate.com/github/claudijd/ssh_scan.png)](https://codeclimate.com/github/claudijd/ssh_scan)
 
-A Ruby-based SSH configuration and policy scanner
+A SSH configuration and policy scanner
 
 ## Key Benefits
 
@@ -34,14 +34,24 @@ gem install bindata
 
 Run `ssh_scan -h` to get this
 
-    Usage: ssh_scan [ip] [port]
+    ssh_scan v0.0.5 (https://github.com/claudijd/ssh_scan)
+
+    Usage: ssh_scan [options]
+        -t, --target [IP]                IP
+        -p, --port [PORT]                Port (Default: 22)
+        -P, --policy [FILE]              Policy file (Default: Mozilla Modern)
         -h, --help                       Show this message
 
-    Example: ssh_scan 192.168.1.1
-    Example: ssh_scan 192.168.1.1 22
+    Examples:
+
+      ssh_scan -t 192.168.1.1
+      ssh_scan -t 192.168.1.1 -p 22222
+      ssh_scan -t 192.168.1.1 -P custom_policy.yml
 
 See here for [example output](https://github.com/claudijd/ssh_scan/blob/master/examples/192.168.1.1.json)
 
+See here for [example policies](https://github.com/claudijd/ssh_scan/blob/master/policies)
+
 ## Rubies Supported
 
 This project is integrated with [travis-ci](http://about.travis-ci.org/) and is regularly tested to work with the following rubies:

data/bin/ssh_scan

@@ -4,25 +4,67 @@
 $:.unshift File.join(File.dirname(__FILE__), "../lib")
 
 require 'ssh_scan'
+require 'optparse'
 
-# Usage: ruby ssh_scan.rb 192.168.1.1
-if ARGV[0].nil? || ARGV[0] == "-h" || ARGV[0] == "--help"
-  puts "ssh_scan #{SSHScan::VERSION} (https://github.com/claudijd/ssh_scan)\n\n" +
-       "Usage: ssh_scan [ip] [port]\n" +
-       "   -h, --help        Show this message\n\n" +
-       "Example: ssh_scan 192.168.1.1\n" +
-       "Example: ssh_scan 192.168.1.1 22\n\n"
+#Default options
+options = {
+  :target => nil,
+  :port => 22,
+  :policy => File.expand_path("../../policies/mozilla_modern.yml", __FILE__)
+}
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "ssh_scan v#{SSHScan::VERSION} (https://github.com/claudijd/ssh_scan)\n\n" +
+                "Usage: ssh_scan [options]"
+
+  opts.on("-t", "--target [IP]",
+          "IP") do |ip|
+    options[:target] = ip
+  end
+
+  opts.on("-p", "--port [PORT]",
+          "Port (Default: 22)") do |port|
+    options[:port] = port.to_i
+  end
+
+  opts.on("-P", "--policy [FILE]",
+          "Policy file (Default: Mozilla Modern)") do |policy|
+    options[:policy] = policy
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    puts "\nExamples:"
+    puts "\n  ssh_scan -t 192.168.1.1"
+    puts "  ssh_scan -t 192.168.1.1 -p 22222"
+    puts "  ssh_scan -t 192.168.1.1 -P custom_policy.yml"
+    exit
+  end
+end
+
+opt_parser.parse!
+
+if options[:target].nil?
+  puts opt_parser.help
+  puts "\nReason: no target specified"
+  exit
+end
+
+unless (0..65535).include?(options[:port])
+  puts opt_parser.help
+  puts "\nReason: port supplied is not within acceptable range"
   exit
 end
 
-# Populate the info we need to perform a scan
-ip = ARGV[0].chomp
-port = ARGV[1].nil? ? 22 : ARGV[1].to_i
+unless File.exists?(options[:policy])
+  puts opt_parser.help
+  puts "\nReason: policy file supplied is not a file"
+  exit
+end
 
-policy = SSHScan::Policy.from_file(File.expand_path("../../policies/mozilla_modern.yml", __FILE__))
+policy = SSHScan::Policy.from_file(options[:policy])
 
 # Perform scan and get results
 scan_engine = SSHScan::ScanEngine.new()
-result = scan_engine.scan(ip, port, policy)
+result = scan_engine.scan(options[:target], options[:port], policy)
 
 puts JSON.pretty_generate(result)

data/lib/ssh_scan/client.rb

@@ -0,0 +1,40 @@
+require 'socket'
+require 'ssh_scan/constants'
+require 'ssh_scan/protocol'
+
+module SSHScan
+  class Client
+    def initialize(ip, port)
+      @ip = ip
+      @port = port
+      @client_protocol = SSHScan::Constants::DEFAULT_CLIENT_PROTOCOL
+      @server_protocol = nil
+      @kex_init_raw = SSHScan::Constants::DEFAULT_KEY_INIT_RAW
+    end
+
+    def connect()
+      @sock = TCPSocket.new(@ip, @port)
+      @server_protocol = @sock.gets.chomp
+      @sock.puts(@client_protocol)
+    end
+
+    def get_kex_result(kex_init_raw = @kex_init_raw)
+      @sock.write(kex_init_raw)
+      resp = @sock.read(4)
+      resp += @sock.read(resp.unpack("N").first)
+      @sock.close
+
+      kex_exchange_init = SSHScan::KeyExchangeInit.read(resp)
+
+      # Assemble and print results
+      result = {
+        :ip => @ip,
+        :port => @port,
+        :server_banner => @server_protocol
+      }
+      result.merge!(kex_exchange_init.to_hash)
+
+      return result
+    end
+  end
+end

data/lib/ssh_scan/constants.rb

@@ -1,19 +1,22 @@
+require 'string_ext'
+
 module SSHScan
   module Constants
-    DEFAULT_PROTOCOL = "SSH-2.0-client"
-    DEFAULT_KEY_INIT_RAW = "d8eb97b11b6cacbc3285473f08004500019ceccf40004006663fc0a80a7c3ff" +
-                           "5db33cdfd0016982e6062988da97e801810154d2b00000101080a03a6399f3d" +
-                           "f735d6000001640414e33f813f8cdcc6b00a3d852ec1aea4980000001a64696" +
-                           "66669652d68656c6c6d616e2d67726f7570312d736861310000000f7373682d" +
-                           "6473732c7373682d727361000000576165733132382d6362632c336465732d6" +
-                           "362632c626c6f77666973682d6362632c6165733139322d6362632c61657332" +
-                           "35362d6362632c6165733132382d6374722c6165733139322d6374722c61657" +
-                           "33235362d637472000000576165733132382d6362632c336465732d6362632c" +
-                           "626c6f77666973682d6362632c6165733139322d6362632c6165733235362d6" +
-                           "362632c6165733132382d6374722c6165733139322d6374722c616573323536" +
-                           "2d63747200000021686d61632d6d64352c686d61632d736861312c686d61632" +
-                           "d726970656d6431363000000021686d61632d6d64352c686d61632d73686131" +
-                           "2c686d61632d726970656d64313630000000046e6f6e65000000046e6f6e650" +
-                           "00000000000000000000000006e05b3b4"
+    DEFAULT_CLIENT_PROTOCOL = "SSH-2.0-client"
+    DEFAULT_SERVER_PROTOCOL = "SSH-2.0-server"
+    DEFAULT_KEY_INIT_RAW = ("d8eb97b11b6cacbc3285473f08004500019ceccf40004006663fc0a80a7c3ff" +
+                            "5db33cdfd0016982e6062988da97e801810154d2b00000101080a03a6399f3d" +
+                            "f735d6000001640414e33f813f8cdcc6b00a3d852ec1aea4980000001a64696" +
+                            "66669652d68656c6c6d616e2d67726f7570312d736861310000000f7373682d" +
+                            "6473732c7373682d727361000000576165733132382d6362632c336465732d6" +
+                            "362632c626c6f77666973682d6362632c6165733139322d6362632c61657332" +
+                            "35362d6362632c6165733132382d6374722c6165733139322d6374722c61657" +
+                            "33235362d637472000000576165733132382d6362632c336465732d6362632c" +
+                            "626c6f77666973682d6362632c6165733139322d6362632c6165733235362d6" +
+                            "362632c6165733132382d6374722c6165733139322d6374722c616573323536" +
+                            "2d63747200000021686d61632d6d64352c686d61632d736861312c686d61632" +
+                            "d726970656d6431363000000021686d61632d6d64352c686d61632d73686131" +
+                            "2c686d61632d726970656d64313630000000046e6f6e65000000046e6f6e650" +
+                            "00000000000000000000000006e05b3b4").unhexify
   end
 end

data/lib/ssh_scan/scan_engine.rb

@@ -1,34 +1,20 @@
 require 'socket'
+require 'ssh_scan/client'
 
 module SSHScan
   class ScanEngine
 
-    # TODO: this is pretty crude, clean this up a bit
+    def scan(ip, port, policy = nil)
+      # Connect and get results
+      client = SSHScan::Client.new(ip, port)
+      client.connect()
+      result = client.get_kex_result()
 
-    def scan(ip, port, policy)
-      # Do initial protocol exchange
-      sock = TCPSocket.new(ip, port)
-      server_protocol = sock.gets
-      sock.puts(SSHScan::Constants::DEFAULT_PROTOCOL)
-
-      # Perform Key Initialization Exchange
-      sock.write(SSHScan::Constants::DEFAULT_KEY_INIT_RAW)
-      resp = sock.read(4)
-      resp += sock.read(resp.unpack("N").first)
-      kex_init_response = SSHScan::KeyExchangeInit.read(resp)
-      sock.close
-
-      # Assemble and print results
-      result = {
-        :ip => ip,
-        :port => port,
-        :server_banner => server_protocol.chomp
-      }
-      result.merge!(kex_init_response.to_hash)
-
-      # Evaluate for Policy Compliance
-      policy_mgr = SSHScan::PolicyManager.new(result, policy)
-      result['compliance'] = policy_mgr.compliance_results
+      # If policy defined, then add compliance results
+      unless policy.nil?
+        policy_mgr = SSHScan::PolicyManager.new(result, policy)
+        result['compliance'] = policy_mgr.compliance_results
+      end
 
       return result
     end

data/lib/ssh_scan/version.rb

@@ -1,3 +1,3 @@
 module SSHScan
-  VERSION = '0.0.4'
+  VERSION = '0.0.6'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ssh_scan
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.6
 platform: ruby
 authors:
 - Jonathan Claudius
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-19 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -97,6 +97,7 @@ files:
 - bin/ssh_scan
 - lib/ssh_scan.rb
 - lib/ssh_scan/basic_server.rb
+- lib/ssh_scan/client.rb
 - lib/ssh_scan/constants.rb
 - lib/ssh_scan/policy.rb
 - lib/ssh_scan/policy_manager.rb