ssh_scan_worker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7dbd0c6b82769e9e8cfd7d6e42205d982f4d0045f0bb9950867bc7b5788de7e4
+  data.tar.gz: d4d42f223d5b1c2b6b91395b55fcbe50943f1858a7704f99742efe9afbf7d103
+SHA512:
+  metadata.gz: 7a151f5ea8a343fceb523c2fd2bc8190c17221121bfa4ae2fc5d34b66ad52be794a6b9ac114f101ff5418cb185a3b825184e8c226840bebae742e9ee37e152fa
+  data.tar.gz: a2db50cbdab9175ac80d056541d159715aa082670439edded80315fc68a353f7fbfbc527f6274ce89ae650f1fd203d71f79774a3791f5f1c4827de36f6db2274

data/.gitignore

@@ -0,0 +1,29 @@
+*.gem
+*.db
+/coverage/
+
+config/api/config.yml
+config/policies/mozilla_modern.yml
+config/worker/config.yml
+postgres-data/*
+
+## 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
+gh-pages/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,25 @@
+language: ruby
+sudo: false
+dist: trusty
+before_install: gem update --system
+matrix:
+  include:
+  - rvm: ruby-head
+    env:
+      - LABEL=unit_tests
+  - rvm: 2.5.0
+    env:
+      - LABEL=unit_tests
+  - rvm: 2.3.6
+    env:
+      - LABEL=unit_tests
+  - rvm: 2.2.9
+    env:
+      - LABEL=unit_tests
+  # - rvm: 2.5.0
+  #   env:
+  #     - LABEL=docker_build_tests
+  #   services:
+  #     - docker
+  #   script:
+  #     - docker-compose build

data/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to ssh_scan_worker
+
+Thanks for your interest in contributing to ssh_scan_worker.
+
+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_worker/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,7 @@
+source "https://rubygems.org"
+
+# Allow local checkout of ssh_scan repo
+#gem 'ssh_scan', :path=>'../ssh_scan'
+
+gem 'coveralls', require: false
+gemspec

data/README.md

@@ -0,0 +1,5 @@
+# ssh_scan_worker
+
+[![Build Status](https://secure.travis-ci.org/mozilla/ssh_scan_worker.png)](http://travis-ci.org/mozilla/ssh_scan_worker)
+
+A dumb worker for performing ssh_scans using [ssh_scan_api](https://github.com/mozilla/ssh_scan_api)

data/Rakefile

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

data/bin/ssh_scan_worker

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.join(File.dirname(__FILE__), "../lib")
+
+require 'ssh_scan'
+require 'ssh_scan_worker/worker'
+
+# Usage: ruby ./bin/ssh_scan_worker [test/development/production]
+
+# Set defaults for config items
+opts = {
+  "server" => "127.0.0.1",
+  "scheme" => "http",
+  "verify" => "false", # this is done for testing/development purposes, the expectation is that you will be setting this to true in a production setup
+  "port" => 8000,
+  "token" => "EXAMPLE_API_TOKEN",  # this is done for testing/development purposes, the expectation is that you will be setting this to a real API token in a production setup
+  "poll_interval" => 3,
+}
+
+worker = SSHScan::Worker.new(opts)
+worker.run!

data/lib/ssh_scan_worker.rb

@@ -0,0 +1,6 @@
+# #External Deps
+require 'ssh_scan'
+
+# #Internal Deps
+require 'ssh_scan_worker/version'
+require 'ssh_scan_worker/worker'

data/lib/ssh_scan_worker/version.rb

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

data/lib/ssh_scan_worker/worker.rb

@@ -0,0 +1,136 @@
+require 'ssh_scan/scan_engine'
+require 'ssh_scan_worker/version'
+require 'openssl'
+require 'net/https'
+
+module SSHScan
+  class Worker
+    def initialize(opts = {})
+      raise ArgumentError.new("API server not specified") unless ENV['sshscan.api.host'] || opts["server"]
+      @server =  ENV['SSHSCAN_API_HOST'] || opts["server"]
+      
+      raise ArgumentError.new("API scheme not specified") unless ENV['sshscan.api.host'] || opts["scheme"]
+      @scheme = ENV['SSHSCAN_API_SCHEME'] || opts["scheme"]
+
+      raise ArgumentError.new("API verify not specified") unless ENV['sshscan.api.verify'] || opts["verify"]
+      @verify = ENV['SSHSCAN_API_VERIFY'] || opts["verify"]
+
+      raise ArgumentError.new("API port not specified") unless ENV['sshscan.api.port'] || opts["port"]
+      @port = ENV['SSHSCAN_API_PORT'] || opts["port"]
+
+      raise ArgumentError.new("API auth token not specified") unless ENV['sshscan.api.token'] || opts["token"]
+      @auth_token = ENV['SSHSCAN_API_TOKEN'] || opts["token"] 
+
+      @logger = setup_logger(opts["logger"])
+      @poll_interval = opts["poll_interval"] || 5 # in seconds
+      @poll_restore_interval = opts["poll_restore_interval"] || 5 # in seconds
+      @worker_id = SecureRandom.uuid
+    end
+
+    def setup_logger(logger)
+      case logger
+      when Logger
+        return logger
+      when String
+        return Logger.new(logger)
+      end
+
+      return Logger.new(STDOUT)
+    end
+
+    def run!
+      loop do
+        begin
+          response = retrieve_work
+          
+          if response["work"]
+            work = response["work"]
+            results = perform_work(work)
+            post_results(results, work)
+          elsif response["error"]
+            @logger.info("Error: #{response["error"]}")
+            sleep @poll_interval
+            next
+          else
+            @logger.info("No jobs available from #{@server}:#{@port} (waiting #{@poll_interval} seconds)")
+            sleep @poll_interval
+            next
+          end
+        rescue Errno::ECONNREFUSED
+          @logger.error("Cannot reach API endpoint #{@server}:#{@port}, waiting #{@poll_restore_interval} seconds")
+          sleep @poll_restore_interval
+        #rescue RuntimeError => e
+          @logger.error(e.inspect)
+        end
+      end
+    end
+
+    def retrieve_work
+      (Net::HTTP::SSL_IVNAMES << :@ssl_options).uniq!
+      (Net::HTTP::SSL_ATTRIBUTES << :options).uniq!
+
+      Net::HTTP.class_eval do
+        attr_accessor :ssl_options
+      end
+
+      uri = URI(
+        "#{@scheme}://#{@server}:#{@port}/api/v1/\
+work?worker_id=#{@worker_id}"
+      )
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if @scheme == "https"
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @verify == false
+        options_mask =
+          OpenSSL::SSL::OP_NO_SSLv2 +
+          OpenSSL::SSL::OP_NO_SSLv3 +
+          OpenSSL::SSL::OP_NO_COMPRESSION
+        http.ssl_options = options_mask
+      end
+
+      request = Net::HTTP::Get.new(uri.path)
+      request.add_field("SSH_SCAN_AUTH_TOKEN", @auth_token) unless @auth_token.nil?
+      response = http.request(request)
+      JSON.parse(response.body)
+    end
+
+    def perform_work(work)
+      @logger.info("Started job: #{work["uuid"]}")
+      work["sockets"] = [work["target"] + ":" + work["port"].to_s]
+      scan_engine = SSHScan::ScanEngine.new
+      work["fingerprint_database"] = File.join(File.dirname(__FILE__),"../../data/fingerprints.yml")
+      work["policy"] = File.join(File.dirname(__FILE__),"../../config/policies/mozilla_modern.yml")
+      work["timeout"] = 5
+      results = scan_engine.scan(work)
+      @logger.info("Completed job: #{work["uuid"]}")
+      return results
+    end
+
+    def post_results(results, job)
+      uri = URI(
+        "#{@scheme}://#{@server}:#{@port}/api/v1/\
+work/results/#{@worker_id}/#{job["uuid"]}"
+      )
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if @scheme == "https"
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE if @verify == false
+        options_mask =
+          OpenSSL::SSL::OP_NO_SSLv2 +
+          OpenSSL::SSL::OP_NO_SSLv3 +
+          OpenSSL::SSL::OP_NO_COMPRESSION
+        http.ssl_options = options_mask
+      end
+
+      request = Net::HTTP::Post.new(uri.path)
+      request.add_field("SSH_SCAN_AUTH_TOKEN", @auth_token) unless @auth_token.nil?
+      request.add_field("Content-Type", "application/json")
+
+      request.body = results.to_json
+      http.request(request)
+      @logger.info("Posted job: #{job["uuid"]}")
+    end
+  end
+end

data/ssh_scan_worker.gemspec

@@ -0,0 +1,35 @@
+$: << "lib"
+require 'ssh_scan_worker/version'
+require 'date'
+
+Gem::Specification.new do |s|
+  s.name = 'ssh_scan_worker'
+  s.version = SSHScan::WORKER_VERSION
+  s.authors = ["Harsh Vardhan", "Rishabh Saxena", "Ashish Gaurav", "Jonathan Claudius" ]
+  s.date = Date.today.to_s
+  s.email = 'jclaudius@mozilla.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_worker.gemspec"]
+  s.license       = "ruby"
+  s.require_paths = ["lib"]
+  s.executables   = s.files.grep(%r{^bin/[^\/]+$}) { |f| File.basename(f) }
+  s.summary = 'ssh_scan worker'
+  s.description = 'The worker component for performing SSH scans using ssh_scan_api'
+  s.homepage = 'http://rubygems.org/gems/ssh_scan_worker'
+
+  s.add_dependency('ssh_scan', '0.0.35')
+  s.add_development_dependency('rack-test')
+  s.add_development_dependency('pry')
+  s.add_development_dependency('rspec', '~> 3.0')
+  s.add_development_dependency('rspec-its', '~> 1.2')
+  s.add_development_dependency('rake')
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: ssh_scan_worker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Harsh Vardhan
+- Rishabh Saxena
+- Ashish Gaurav
+- Jonathan Claudius
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ssh_scan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.35
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.35
+- !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: pry
+  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'
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: The worker component for performing SSH scans using ssh_scan_api
+email: jclaudius@mozilla.com
+executables:
+- ssh_scan_worker
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/ssh_scan_worker
+- lib/ssh_scan_worker.rb
+- lib/ssh_scan_worker/version.rb
+- lib/ssh_scan_worker/worker.rb
+- ssh_scan_worker.gemspec
+homepage: http://rubygems.org/gems/ssh_scan_worker
+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.6.13
+signing_key: 
+specification_version: 4
+summary: ssh_scan worker
+test_files: []