hrw 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 670978eb8167255d8fbe62416a0a4b2bc8915074b34e4c4cc75091d2cc6cd3d3
+  data.tar.gz: 26d18f588f3145076d70d7ba2bac78badcb35169a16e2c8af917ac8299bb0238
+SHA512:
+  metadata.gz: d0b77d983c3036917919aac670ed757c7660de56bd151f3141b83227a5afa5e391e765dbbef7676b5ddbe60602f78707db86e2ca6aed0f29e53c51478a311ddd
+  data.tar.gz: 28ad93ca22a29c4239f76b609a6a077878a563e93bf84a3b390a3178d2bbd045ab2659b1880794269435ef0999aba2c8037f8c13c36602b85319a190c26217e2

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.1
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hrw.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# Hrw
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/hrw`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hrw'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hrw
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hrw.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hrw"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/hrw

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+require 'ostruct'
+require 'optparse'
+require 'hrw'
+
+ARGV << '--help' if ARGV.empty?
+
+options = OpenStruct.new
+OptionParser.new do |opt|
+  opt.banner = "usage: #{__FILE__} [OPTIONS]"
+
+  opt.on('-u', '--url [URL]', 'remote api url') do |url|
+    options.url = url
+  end
+end.parse!
+
+if options.url.nil?
+  if ENV.key?(Hrw::ENV)
+    options.url = ENV[Hrw::ENV]
+  else
+    puts '[-] no url'
+    exit(1)
+  end
+end
+
+begin
+  scanner = Hrw::Detector.detect
+  specs = scanner.scan
+
+  api = Hrw::API.new(options.url)
+  hash = api.submit(specs)
+  result = api.retrieve(hash)
+
+  formatter = Hrw::Formatter.new
+  vulnerable_deps = formatter.format(result)
+
+  unless vulnerable_deps.empty?
+    formatter.print_vulnerable_deps(vulnerable_deps)
+    exit(1)
+  end
+rescue StandardError => ex
+  require 'pry-byebug'
+  binding.pry
+  puts ex.message
+end

data/hrw.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hrw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hrw'
+  spec.version       = Hrw::VERSION
+  spec.authors       = ['hi_ztz']
+  spec.email         = ['hi_ztz@protonmail.com']
+
+  spec.summary       = 'Hrw helps you to secure your ruby apps.'
+  spec.description   = 'Hrw helps you to secure your ruby apps.'
+  spec.homepage      = 'https://github.com/zt2/hrw'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_runtime_dependency 'http', '~> 4.1', '>= 4.1.1'
+  spec.add_runtime_dependency 'rainbow', '~> 3.0'
+  spec.add_runtime_dependency 'pry-byebug', '~> 3.7'
+end

data/lib/hrw.rb

@@ -0,0 +1,23 @@
+#
+# Used to scan vulnerabilities in dependencies
+#
+module Hrw
+  #
+  # Errors
+  #
+  class Error < StandardError; end
+
+  #
+  # Constants
+  #
+  ENV = 'HRW_URL'.freeze
+
+  #
+  # Load libraries
+  #
+  require 'hrw/api'
+  require 'hrw/detector'
+  require 'hrw/formatter'
+  require 'hrw/scanner'
+  require 'hrw/version'
+end

data/lib/hrw/api.rb

@@ -0,0 +1,66 @@
+#
+# Standard libraries
+#
+require 'digest'
+
+#
+# Third-party libraries
+#
+require 'http'
+
+module Hrw
+  #
+  # Used to interact with Horus server
+  #
+  class API
+    #
+    # Errors
+    #
+    class HTTPCodeError < StandardError; end
+
+    # Class constructor
+    #
+    # @param [String] url API remote address
+    def initialize(url)
+      @submit_url = url.chomp('/') + '/dependency'
+      @retrieve_url = url.chomp('/') + '/ancestry'
+    end
+
+    # Submit dependencies to server
+    #
+    # @param [Array] dependencies
+    # @return [String] Checksum for those dependencies
+    def submit(dependencies)
+      body = {
+        hash: _calc_hash(dependencies),
+        pkg_manager: {
+          name: :rubygems
+        },
+        packages: dependencies
+      }
+
+      res = HTTP.post(@submit_url, json: body)
+      raise HTTPCodeError, "#{res.code}: #{res.body}" if res.code != 200
+
+      body[:hash]
+    end
+
+    # Used to retrieve scan results
+    #
+    # @param [String] hash
+    # @return [Hash] result
+    def retrieve(hash)
+      res = HTTP.get(@retrieve_url + "/#{hash}")
+      raise HTTPCodeError, "#{res.code}: #{res.body}" if res.code != 200
+
+      res.parse
+    end
+
+    private
+
+    def _calc_hash(dependencies)
+      str = dependencies.map { |d| "#{d[:name]}@#{d[:version]}" }.sort.join('|')
+      Digest::SHA256.hexdigest(str)
+    end
+  end
+end

data/lib/hrw/detector.rb

@@ -0,0 +1,38 @@
+require 'hrw/scanner'
+
+module Hrw
+  #
+  # To detect which platform used by current project
+  #
+  module Detector
+    #
+    # Errors
+    #
+    class MultipleChoiceError < StandardError; end
+
+    #
+    # Constants
+    #
+    DETECTABLE_FILES = {
+      'Gemfile.lock': Scanner::Gemfile
+    }.freeze
+
+    # Detect package manager in root dir
+    #
+    # @param [String] root root dir for project
+    # @return [Hrw::Scanner] scanner
+    def self.detect(root = Dir.pwd)
+      files = Dir['*', base: root].map { |file| File.basename(file).to_sym }
+      pkg_files = DETECTABLE_FILES.keys & files
+
+      if pkg_files.empty?
+        nil
+      elsif pkg_files.size > 1
+        raise MultipleChoiceError
+      else
+        file = pkg_files.first
+        DETECTABLE_FILES[file].new(root, file.to_s)
+      end
+    end
+  end
+end

data/lib/hrw/formatter.rb

@@ -0,0 +1,50 @@
+#
+# Standard libraries
+#
+require 'json'
+
+#
+# Third-party libraries
+#
+require 'rainbow'
+
+module Hrw
+  #
+  # Format result and pretty print it
+  #
+  class Formatter
+    # Format result
+    #
+    # @param [Hash] result scan result
+    # @return [Boolean] vulnerable or not
+    def format(result)
+      deps = []
+
+      result['ancestry']['layers'].each do |layer|
+        layer['detected_features'].each do |feature|
+          deps << feature if feature.key?('vulnerabilities')
+        end
+      end
+
+      deps
+    end
+
+    # Pretty print result
+    #
+    def print_vulnerable_deps(deps)
+      deps.each do |dep|
+        dep['vulnerabilities'].each do |vuln|
+          patched_version = JSON.parse(vuln['fixed_by'])
+
+          puts "Name: #{dep['name']}"
+          puts "Version: #{dep['version']}"
+          puts "Advisory: #{vuln['name']}"
+          puts "Severity: #{vuln['severity']}"
+          puts "Link: #{vuln['link']}"
+          puts "Patched version: #{patched_version['spec'].join(', ')}"
+          puts
+        end
+      end
+    end
+  end
+end

data/lib/hrw/scanner.rb

@@ -0,0 +1,8 @@
+module Hrw
+  #
+  # Used to scan dependencies
+  #
+  module Scanner
+    require 'hrw/scanner/gemfile'
+  end
+end

data/lib/hrw/scanner/gemfile.rb

@@ -0,0 +1,37 @@
+#
+# Third-party libraries
+#
+require 'bundler'
+require 'bundler/lockfile_parser'
+
+module Hrw
+  module Scanner
+    #
+    # Used to scan gem lock file
+    #
+    class Gemfile
+      # Initialize a scanner
+      #
+      # @param [String] root The path to the project root
+      # @param [String] lockfile
+      #   The name for the lock file, default is `Gemfile.lock`
+      def initialize(root = Dir.pwd, lockfile = 'Gemfile.lock')
+        @root = File.expand_path(root)
+        @lockfile = Bundler::LockfileParser.new(
+          File.read(File.join(@root, lockfile))
+        )
+      end
+
+      # Scan the lock file
+      # @return [Hash]
+      def scan
+        @lockfile.specs.map do |spec|
+          {
+            name: spec.name,
+            version: spec.version.to_s
+          }
+        end
+      end
+    end
+  end
+end

data/lib/hrw/version.rb

@@ -0,0 +1,3 @@
+module Hrw
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: hrw
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- hi_ztz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Hrw helps you to secure your ruby apps.
+email:
+- hi_ztz@protonmail.com
+executables:
+- hrw
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/hrw
+- hrw.gemspec
+- lib/hrw.rb
+- lib/hrw/api.rb
+- lib/hrw/detector.rb
+- lib/hrw/formatter.rb
+- lib/hrw/scanner.rb
+- lib/hrw/scanner/gemfile.rb
+- lib/hrw/version.rb
+homepage: https://github.com/zt2/hrw
+licenses:
+- MIT
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Hrw helps you to secure your ruby apps.
+test_files: []