ssh_scan 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6911a09269a07da696877c04d8d8e436875ca78
+  data.tar.gz: 4fb3f5b3e716db185cf140b060342404350467e6
+SHA512:
+  metadata.gz: bd6f4506587b796e7a9c5374aa6209c348df48a5fea9fc13f7a50b5eed89ca9c648ebae5d70e73af6db6fc1977a424e06b6d6d242f732dc37921ab9e04e6f59d
+  data.tar.gz: f2d4380fb4dd20f49968f9546b03646ad122c4ca6222e34d0408e265906f47ef32edeceb73113a55fa087b6e4b42d4959aea10aa437ee997c0f0d154d87f628a

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.1.3
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - ruby-head
+  - jruby-head

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to ssh_scan
+
+Thanks for your interest in contributing to ssh_scan.
+
+If you could follow the following guidelines, you will make it much easier for
+us to give feedback, help you find whatever problem you have and fix it.
+
+## Issues
+
+If you have questions of any kind, or are unsure of how something works, please
+[create an issue](https://github.com/claudijd/ssh_scan/issues/new).
+
+Please try to answer the following questions in your issue:
+
+- What did you do?
+- What did you expect to happen?
+- What happened instead?
+
+If you have identified a bug, it would be very helpful if you could include a
+way to replicate the bug.  Ideally a failing test would be perfect, but even a
+simple script demonstrating the error would suffice.
+
+Feature requests are great and if submitted they will be considered for
+inclusion, but sending a pull request is much more awesome.
+
+## Pull Requests
+
+If you want your pull requests to be accepted, please follow the following guidelines:
+
+- [**Add tests!**](http://rspec.info/) Your patch won't be accepted (or will be delayed) if it doesn't have tests.
+
+- [**Document any change in behaviour**](http://yardoc.org/) Make sure the README and any other
+  relevant documentation are kept up-to-date.
+
+- [**Create topic branches**](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) Don't ask us to pull from your master branch.
+
+- [**One pull request per feature**](https://help.github.com/articles/using-pull-requests) If you want to do more than one thing, send
+  multiple pull requests.
+
+- [**Send coherent history**](http://stackoverflow.com/questions/6934752/git-combining-multiple-commits-before-pushing) Make sure each individual commit in your pull
+  request is meaningful. If you had to make multiple intermediate commits while
+  developing, please squash them before sending them to us.
+
+- [**Follow coding conventions**](https://github.com/styleguide/ruby) The standard Ruby stuff, two spaces indent,
+  don't omit parens unless you have a good reason.
+
+Thank you so much for contributing!

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,54 @@
+# ssh_scan
+
+[![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
+
+## Key Benefits
+
+- **Minimal Dependancies** - Uses native Ruby and BinData to do it's work, no heavy dependancies.
+- **Not Just a Script** - Implementation is portable for use in another project or for automation of tasks.
+- **Simple** - It is a small project so the interfaces are simple and easy to use.
+
+## Setup
+
+To install, type
+
+```bash
+gem install ssh_scan
+```
+
+## Example Command-Line Usage
+
+Run `ssh_scan -h` to get this
+
+    Usage: ssh_scan [ip] [port]
+        -h, --help                       Show this message
+
+    Example: ssh_scan 192.168.1.1
+    Example: ssh_scan 192.168.1.1 22
+
+## Rubies Supported
+
+This project is integrated with [travis-ci](http://about.travis-ci.org/) and is regularly tested to work with the following rubies:
+
+* [2.1.3](https://github.com/ruby/ruby/tree/ruby_2_1)
+* [2.1.0](https://github.com/ruby/ruby/tree/ruby_2_1)
+* [2.0.0](https://github.com/ruby/ruby/tree/ruby_2_0_0)
+* [1.9.3](https://github.com/ruby/ruby/tree/ruby_1_9_3)
+* [ruby-head](https://github.com/ruby/ruby)
+* [jruby-head](http://jruby.org/)
+* [jruby-19mode](http://jruby.org/)
+
+To checkout the current build status for these rubies, click [here](https://travis-ci.org/#!/claudijd/ssh_scan).
+
+## Contributing
+
+If you are interested in contributing to this project, please see [CONTRIBUTING.md](https://github.com/claudijd/ssh_scan/blob/master/CONTRIBUTING.md)
+
+## Credits
+
+**Sources of Inspiration for ssh_scan**
+
+- [**Mozilla OpenSSH Security Guide**](https://wiki.mozilla.org/Security/Guidelines/OpenSSH) - For providing a sane baseline policy recommendation for SSH configuration parameters (eg. Ciphers, Macs, and KexAlgos).

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'rubygems/package_task'
+require 'rspec'
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+
+require 'ssh_scan'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)

data/bin/ssh_scan.rb

@@ -0,0 +1,14 @@
+require 'ssh_scan'
+
+# Usage: ruby ssh_scan.rb 192.168.1.1
+
+# Populate the info we need to perform a scan
+ip = ARGV[0].chomp
+port = ARGV[1].nil? ? 22 : ARGV[1].to_i
+policy = SSHScan::IntermediatePolicy.new
+
+# Perform scan and get results
+scan_engine = SSHScan::ScanEngine.new()
+result = scan_engine.scan(ip, port, policy)
+
+puts JSON.pretty_generate(result)

data/lib/ssh_scan.rb

@@ -0,0 +1,11 @@
+#External Deps
+require 'bindata'
+
+#Internal Deps
+require 'ssh_scan/constants'
+require 'ssh_scan/policy'
+require 'ssh_scan/protocol'
+require 'ssh_scan/scan_engine'
+
+#Monkey Patches
+require 'string_ext'

data/lib/ssh_scan/basic_server.rb

@@ -0,0 +1,19 @@
+require 'sinatra'
+require 'protocol'
+require 'socket'
+require 'policy'
+require 'constants'
+require 'scan_engine'
+
+get '/api/v1/scan/:ip' do
+  if ip = params['ip']
+    policy = SSHScan::IntermediatePolicy.new
+    scan_engine = SSHScan::ScanEngine.new()
+    result = scan_engine.scan(ip, 22, policy)
+    content_type :json
+    return JSON.pretty_generate(result)
+  else
+    status 500
+    body "Error: did not supply a valid IP to be scanned"
+  end
+end

data/lib/ssh_scan/constants.rb

@@ -0,0 +1,19 @@
+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"
+  end
+end

data/lib/ssh_scan/policy.rb

@@ -0,0 +1,75 @@
+module SSHScan
+  class IntermediatePolicy
+    def name
+      self.class.to_s
+    end
+
+    def macs
+      ["hmac-sha2-512","hmac-sha2-256"]
+    end
+
+    def encryption
+      ["aes256-ctr","aes192-ctr","aes128-ctr"]
+    end
+
+    def kexs
+      ["diffie-hellman-group-exchange-sha256"]
+    end
+  end
+
+  class PolicyManager
+    def initialize(result, policy)
+      @policy = policy
+      @result = result
+    end
+
+    def out_of_policy_encryption
+      target_encryption = @result[:encryption_algorithms_client_to_server] | @result[:encryption_algorithms_server_to_client]
+      outliers = []
+      target_encryption.each do |target_enc|
+        outliers << target_enc unless @policy.encryption.include?(target_enc)
+      end
+      return outliers
+    end
+
+    def out_of_policy_macs
+      target_macs = @result[:mac_algorithms_server_to_client] | @result[:mac_algorithms_client_to_server]
+      outliers = []
+      target_macs.each do |target_mac|
+        outliers << target_mac unless @policy.macs.include?(target_mac)
+      end
+      return outliers
+    end
+
+    def out_of_policy_kex
+      target_kexs = @result[:key_algorithms]
+      outliers = []
+      target_kexs.each do |target_kex|
+        outliers << target_kex unless @policy.kexs.include?(target_kex)
+      end
+      return outliers
+    end
+
+    def compliant?
+      out_of_policy_encryption.empty? &&
+      out_of_policy_macs.empty? &&
+      out_of_policy_kex.empty?
+    end
+
+    def recommendations
+      recommendations = []
+      recommendations << "Remove these Key Exchange Algos: #{out_of_policy_kex.join(", ")}" unless out_of_policy_kex.empty?
+      recommendations << "Remove these MAC Algos: #{out_of_policy_macs.join(", ")}" unless out_of_policy_macs.empty?
+      recommendations << "Remove these Encryption Ciphers: #{out_of_policy_encryption.join(", ")}" unless out_of_policy_encryption.empty?
+      return recommendations
+    end
+
+    def compliance_results
+      {
+        :policy => @policy.name,
+        :compliant => compliant?,
+        :recommendations => recommendations
+      }
+    end
+  end
+end

data/lib/ssh_scan/protocol.rb

@@ -0,0 +1,97 @@
+require 'bindata'
+require 'string_ext'
+require 'json'
+
+module SSHScan
+  # SSHv2 KexInit
+  class KeyExchangeInit < BinData::Record
+    endian :big
+    uint32 :packet_length
+    uint8 :padding_length
+    uint8 :message_code
+    string :cookie, :length => 16
+    uint32 :kex_algorithms_length
+    string :key_algorithms_string, :length => lambda { self.kex_algorithms_length }
+    uint32 :server_host_key_algorithms_length
+    string :server_host_key_algorithms_string, :length => lambda { self.server_host_key_algorithms_length }
+    uint32 :encryption_algorithms_client_to_server_length
+    string :encryption_algorithms_client_to_server_string, :length => lambda { self.encryption_algorithms_client_to_server_length }
+    uint32 :encryption_algorithms_server_to_client_length
+    string :encryption_algorithms_server_to_client_string, :length => lambda { self.encryption_algorithms_server_to_client_length }
+    uint32 :mac_algorithms_client_to_server_length
+    string :mac_algorithms_client_to_server_string, :length => lambda { self.mac_algorithms_client_to_server_length }
+    uint32 :mac_algorithms_server_to_client_length
+    string :mac_algorithms_server_to_client_string, :length => lambda { self.mac_algorithms_server_to_client_length }
+    uint32 :compression_algorithms_client_to_server_length
+    string :compression_algorithms_client_to_server_string, :length => lambda { self.compression_algorithms_client_to_server_length }
+    uint32 :compression_algorithms_server_to_client_length
+    string :compression_algorithms_server_to_client_string, :length => lambda { self.compression_algorithms_server_to_client_length }
+    uint32 :languages_client_to_server_length
+    string :languages_client_to_server_string, :length => lambda { self.languages_client_to_server_length }
+    uint32 :languages_server_to_client_length
+    string :languages_server_to_client_string, :length => lambda { self.languages_server_to_client_length }
+    uint8 :kex_first_packet_follows
+    uint32 :reserved
+
+    def key_algorithms
+      self.key_algorithms_string.split(",")
+    end
+
+    def server_host_key_algorithms
+      self.server_host_key_algorithms_string.split(",")
+    end
+
+    def encryption_algorithms_client_to_server
+      self.encryption_algorithms_client_to_server_string.split(",")
+    end
+
+    def encryption_algorithms_server_to_client
+      self.encryption_algorithms_server_to_client_string.split(",")
+    end
+
+    def mac_algorithms_client_to_server
+      self.mac_algorithms_client_to_server_string.split(",")
+    end
+
+    def mac_algorithms_server_to_client
+      self.mac_algorithms_server_to_client_string.split(",")
+    end
+
+    def compression_algorithms_client_to_server
+      self.compression_algorithms_client_to_server_string.split(",")
+    end
+
+    def compression_algorithms_server_to_client
+      self.compression_algorithms_client_to_server_string.split(",")
+    end
+
+    def languages_client_to_server
+      self.languages_client_to_server_string.split(",")
+    end
+
+    def languages_server_to_client
+      self.languages_server_to_client_string.split(",")
+    end
+
+    # Summarize as Hash
+    def to_hash
+      {
+        :key_algorithms => key_algorithms,
+        :server_host_key_algorithms => server_host_key_algorithms,
+        :encryption_algorithms_client_to_server => encryption_algorithms_client_to_server,
+        :encryption_algorithms_server_to_client => encryption_algorithms_server_to_client,
+        :mac_algorithms_client_to_server => mac_algorithms_client_to_server,
+        :mac_algorithms_server_to_client => mac_algorithms_server_to_client,
+        :compression_algorithms_client_to_server => compression_algorithms_client_to_server,
+        :compression_algorithms_server_to_client => compression_algorithms_server_to_client,
+        :languages_client_to_server => languages_client_to_server,
+        :languages_server_to_client => languages_server_to_client,
+      }
+    end
+
+    # Summarize as JSON
+    def to_json
+      self.to_hash.to_json
+    end
+  end
+end

data/lib/ssh_scan/scan_engine.rb

@@ -0,0 +1,37 @@
+require 'socket'
+
+module SSHScan
+  class ScanEngine
+
+    # TODO: this is pretty crude, clean this up a bit
+
+    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 = SSHScan::IntermediatePolicy.new
+      policy_mgr = SSHScan::PolicyManager.new(result, policy)
+      result['compliance'] = policy_mgr.compliance_results
+
+      return result
+    end
+  end
+end

data/lib/ssh_scan/version.rb

@@ -0,0 +1,3 @@
+module SSHScan
+  VERSION = '0.0.1'
+end

data/lib/string_ext.rb

@@ -0,0 +1,6 @@
+# Extend string to include some helpful stuff
+class String
+  def unhexify
+    [self].pack("H*")
+  end
+end

data/ssh_scan.gemspec

@@ -0,0 +1,32 @@
+$: << "lib"
+require 'ssh_scan/version'
+
+Gem::Specification.new do |s|
+  s.name = 'ssh_scan'
+  s.version = SSHScan::VERSION
+  s.authors = ["Jonathan Claudius"]
+  s.date = Date.today.to_s
+  s.email = 'claudijd@yahoo.com'
+  s.platform = Gem::Platform::RUBY
+  s.files = Dir.glob("lib/**/*") +
+            Dir.glob("bin/**/*") +
+            [".gitignore",
+             ".rspec",
+             ".travis.yml",
+             "CONTRIBUTING.md",
+             "Gemfile",
+             "Rakefile",
+             "README.md",
+             "ssh_scan.gemspec"]
+  s.license       = "ruby"
+  s.require_paths = ["lib"]
+  s.executables   = s.files.grep(%r{^bin/[^\/]+$}) { |f| File.basename(f) }
+  s.summary = 'Ruby-based SSH Scanner'
+  s.description = 'A Ruby-based SSH scanner for configuration and policy scanning'
+  s.homepage = 'http://rubygems.org/gems/ssh_scan'
+
+  s.add_dependency('bindata', '~> 2.0')
+  s.add_development_dependency('rspec', '~> 3.0')
+  s.add_development_dependency('rspec-its', '~> 1.2')
+  s.add_development_dependency('rake', '~> 10.3')
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: ssh_scan
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jonathan Claudius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: A Ruby-based SSH scanner for configuration and policy scanning
+email: claudijd@yahoo.com
+executables:
+- ssh_scan.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/ssh_scan.rb
+- lib/ssh_scan.rb
+- lib/ssh_scan/basic_server.rb
+- lib/ssh_scan/constants.rb
+- lib/ssh_scan/policy.rb
+- lib/ssh_scan/protocol.rb
+- lib/ssh_scan/scan_engine.rb
+- lib/ssh_scan/version.rb
+- lib/string_ext.rb
+- ssh_scan.gemspec
+homepage: http://rubygems.org/gems/ssh_scan
+licenses:
+- ruby
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.8
+signing_key: 
+specification_version: 4
+summary: Ruby-based SSH Scanner
+test_files: []