oss_audit 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8c4b09cddf3f5d00344f375d67dbd749ed3f01ed8b741ae6eb40c1d5c020713
+  data.tar.gz: 37ecb417d5a2d5622a3968eb6a1926cf4924163a3c6a236d8e251216e86059fa
+SHA512:
+  metadata.gz: 3a94792667ae9baf23e5c725c74003183ad23b02261a8bbe2ea2d82a138f666999f99848ebc96fb2d9eb6f78d1630c55c09555a2ccd0c471bc251a8690f2a5c6
+  data.tar.gz: dbdb75ae55ee96790a89b90390d7ff7e0f821eeede177efb12e1552f1ef7bfc777fa0bb6e165b6e7fd5261f5b1cfdeb3bc98e5a94829f19e7bd3a14f7c00abc5

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oss_audit.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    oss_audit (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.14.4)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  oss_audit!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Alessio Signorini
+
+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,62 @@
+# Open Source Software Auditor
+Simple, opinionated tool to compile a list of the open source software in use
+in a project. Each library is listed together with its licenses and links,
+ready to be audited.
+
+**Useful features:**
+* No dependencies, can be ran anywhere
+* Does not require any package manager nor for the code to work or be installed
+* Output can be in JSON or CSV format
+* Scans for nested packages
+* Accepts an override file to programmatically amend results
+
+## Installation
+
+Can be installed with
+
+    $ gem install oss_audit
+
+## Usage
+
+A useful help screen will be displayed if launched with no arguments.
+
+Run as
+
+    $ oss_audit [options] <dir1> ... <dirN>
+
+Output is printed on STDOUT and can be easily redirected using `>`. Informative
+logging is sent to STDERR.
+
+A more complete example is
+
+    $ oss_audit -f csv -o overrides.json pj/serviceA pj/serviceB > libs.csv
+
+## Overrides
+
+Not all libraries specify the license or useful links in their configuration
+files. Instead of manually fixing that after the fact, create an override file
+in JSON and pass it as argument to the tool, e.g.,
+```json
+[
+  { "manager":"Bundler", "name":"barnes", "licenses":["MIT"] },
+  { "manager":"Yarn", "name":"sinon", "homepage":"https://sinonjs.org/" }
+]
+```
+
+## Limitations
+
+Package Managers currently supported:
+* Bundler
+* Yarn / NPM (anything with `package.json`)
+
+Adding others is trivial, look in `lib/oss_audit/managers` for examples.
+
+Currently ignores version numbers but that too can be easily added.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alessio-signorini/oss_audit.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oss_audit"
+
+# 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/oss_audit

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require "oss_audit"
+
+banner = "#{OssAudit::NAME} v#{OssAudit::VERSION} - alessio@signorini.us
+  Usage: #{File.basename($0)} [options] <dir1> ... <dirN>
+"
+
+@options = {}
+opts = OptionParser.new do |opts|
+  opts.banner = banner
+  
+  @options[:format] = :json
+  opts.on("-f", "--format FORMAT", [:csv, :json], "Output format (csv,json)") do |v|
+    @options[:format] = v
+  end
+  
+  @options[:simple] = true
+  opts.on("-x", "--extended", "Add extra details (e.g., dependencies)") do |v|
+    @options[:simple] = false
+  end
+  
+  opts.on("-o", "--overrides FILE.json", "Override data if in file") do |v|
+    @options[:overrides] = v
+  end
+end
+
+opts.parse!
+
+unless ARGV.count > 0
+    puts opts.help()
+    exit 1
+end
+
+dependencies = []
+ARGV.each do |path|
+  abort("ERROR: '#{path}' does not exists") unless Dir.exists?(path)
+  dependencies += OssAudit.scan(path)
+end
+
+if @options[:overrides]
+  OssAudit::Overrides.patch!(dependencies, @options[:overrides])
+end
+
+puts OssAudit::Output.format(dependencies, @options[:format], @options[:simple])

data/lib/oss_audit.rb

@@ -0,0 +1,43 @@
+require "oss_audit/version"
+require "oss_audit/managers"
+require "oss_audit/output"
+require 'oss_audit/overrides'
+
+require 'logger'
+
+module OssAudit
+  class Error < StandardError; end
+
+  def self.logger
+    @@logger ||= Logger.new(STDERR)
+  end
+
+  def self.scan(path)
+    libraries = []
+    Managers.list.each do |manager|
+      next unless manager.used_in?(path)
+
+      logger.info{"#{manager} (#{path})"}
+
+      dependencies = manager.list_dependencies(path)
+
+      logger.debug{"* Found #{dependencies.count} dependencies"}
+
+      dependencies.each do |dependency|
+        name, version = Array(dependency)
+
+        info      = manager.get_info(name, version) or next
+        defaults  = {
+          'name'          => name,
+          'version'       => version,
+          'manager'       => manager.name.split('::').last,
+          'dependencies'  => []
+        }
+
+        libraries << defaults.merge(info)
+      end
+    end
+    
+    return libraries
+  end
+end

data/lib/oss_audit/managers.rb

@@ -0,0 +1,13 @@
+require_relative 'utils'
+require_relative 'managers/bundler'
+require_relative 'managers/yarn'
+
+module OssAudit
+  module Managers
+    
+    def self.list
+      constants(false).map{|x| const_get(x)}
+    end
+    
+  end
+end

data/lib/oss_audit/managers/bundler.rb

@@ -0,0 +1,44 @@
+module OssAudit
+  module Managers
+    module Bundler
+      extend OssAudit::Utils
+
+      def self.used_in?(directory)
+        File.exists?(File.join(directory, 'Gemfile.lock')) || File.exists?(File.join(directory, 'Gemfile'))
+      end
+
+      def self.list_dependencies(directory)
+        file = File.read(File.join(directory, 'Gemfile'))
+
+        file.gsub!(/\#.*/,'')
+
+        return file.scan(/gem\s["'](\w+)["']/).flatten.uniq
+      end
+
+      def self.get_info(package, version=nil)
+        data = get_uri("https://rubygems.org/api/v1/gems/#{package}.json")
+        
+        if data.is_a?(Exception)
+          OssAudit.logger.error{"#{package} | #{data}"}
+          return
+        end
+
+        name          = data['name']
+        licenses      = Array(data['license'] || data['licenses'])
+        homepage      = data['homepage_uri'] || data.dig('metadata','homepage_uri') || data['project_uri']
+        source        = data['source_code_uri'] || data.dig('metadata','source_code_uri')
+
+        dependencies  = data['dependencies']['runtime'].map{|k| k['name']}
+
+        return {
+          "name"          => name,
+          "licenses"      => licenses,
+          "homepage"      => homepage,
+          "source"        => source,
+          "dependencies"  => dependencies
+        }
+      end
+
+    end
+  end
+end

data/lib/oss_audit/managers/yarn.rb

@@ -0,0 +1,48 @@
+module OssAudit
+  module Managers
+    module Yarn
+      extend OssAudit::Utils
+
+      def self.packages_files(directory)
+        Dir.glob(File.join(directory, '**/package.json')).reject{|x| x.include?('node_modules')}
+      end
+
+      def self.used_in?(directory)
+        packages_files(directory).any?
+      end
+
+      def self.list_dependencies(directory)
+        packages_files(directory).map do |file|
+          data = JSON.parse(File.read(file))
+          ((data['dependencies']||{}).keys | (data['devDependencies']||{}).keys)
+        end.flatten
+      end
+
+      def self.get_info(package, version=nil)
+        data = get_uri("https://registry.yarnpkg.com/#{package}/#{version||'latest'}")
+        
+        unless data.is_a?(Hash)
+          OssAudit.logger.error{"#{package} | #{data}"}
+          return
+        end
+
+        name          = data['name']
+        licenses      = Array(data['license'])
+        homepage      = data['homepage']
+        source        = data.dig('repository','url')
+
+        dependencies  = (data['dependencies']||{}).keys
+
+
+        return {
+          "name"          => name,
+          "licenses"      => licenses,
+          "homepage"      => homepage,
+          "source"        => source,
+          "dependencies"  => dependencies
+        }
+      end
+
+    end
+  end
+end

data/lib/oss_audit/output.rb

@@ -0,0 +1,46 @@
+require 'json'
+require 'csv'
+
+module OssAudit
+  module Output
+
+    def self.format(dependencies, type='json', simple=true)
+      send("as_#{type}", uniq(dependencies), simple)
+    end
+
+    def self.as_csv(dependencies, simple=true)
+      headers = dependencies.map{|x| x.keys}.flatten.uniq
+
+      if simple
+        headers = %w(manager name version licenses homepage source)
+        dependencies = simplify(dependencies)
+      end
+      
+      return CSV.generate('', :headers => headers, :col_sep => "\t", :write_headers => true) do |csv|
+        dependencies.each do |dependency|
+          csv << headers.map{|x| dependency[x]}.map{|x| to_s(x)}
+        end
+      end
+    end
+
+    def self.as_json(dependencies, simple=true)
+      dependencies = simplify(dependencies) if simple
+      return JSON.pretty_generate(dependencies)
+    end
+
+    def self.simplify(dependencies)
+      keys = %w(manager name version licenses homepage source)
+      return dependencies.map{|x| x.slice(*keys)}
+    end
+
+    def self.to_s(object)
+      object.is_a?(Array) ? (object.empty? ? nil : object.join(',')) : object
+    end
+    
+    def self.uniq(dependencies)
+      dependencies
+        .uniq{|x| x['name']}
+        .sort{|a,b| a['name'] <=> b['name']}
+    end
+  end
+end

data/lib/oss_audit/overrides.rb

@@ -0,0 +1,30 @@
+require 'json'
+
+module OssAudit
+  module Overrides
+
+    def self.patch!(dependencies, overrides_file)
+      overrides = index(overrides_file)
+
+      dependencies.each do |dep|
+        id = key(dep)
+        if overrides.include?(id)
+          OssAudit.logger.debug("  - Overriding #{dep['name']}")
+          dep.merge!(overrides[id])
+        end
+      end
+    end
+
+    def self.index(overrides_file)
+      data = JSON.parse(File.read(overrides_file)) rescue nil
+        abort("ERROR: Cannot read/parse JSON from #{overrides_file}") unless data
+
+      return Array(data).map{|x| [key(x), x]}.to_h
+    end
+
+    def self.key(dependency)
+      ['manager', 'name'].map{|x| dependency[x]}.join('#')
+    end
+
+  end
+end

data/lib/oss_audit/utils.rb

@@ -0,0 +1,16 @@
+require 'net/http'
+require 'uri'
+
+module OssAudit
+  module Utils
+
+    def get_uri(url)
+      uri = URI.parse(url)
+      response = Net::HTTP.get_response(uri)
+      return JSON.parse(response.body)
+    rescue => e
+      return e
+    end
+
+  end
+end

data/lib/oss_audit/version.rb

@@ -0,0 +1,4 @@
+module OssAudit
+  NAME    = "Open Source Software Auditor"
+  VERSION = "1.0.1"
+end

data/oss_audit.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/oss_audit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oss_audit"
+  spec.version       = OssAudit::VERSION
+  spec.authors       = ["Alessio Signorini"]
+  spec.email         = ["alessio@signorini.us"]
+
+  spec.summary       = OssAudit::NAME
+  spec.description   = "Generate list of libraries used with licenses and links"
+  spec.homepage      = "https://github.com/alessio-signorini/oss_audit"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = 'http://mygemserver.com'
+
+  spec.metadata["homepage_uri"]     = spec.homepage
+  spec.metadata["source_code_uri"]  = spec.homepage
+  #  spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) 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"]
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: oss_audit
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Alessio Signorini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-02-26 00:00:00.000000000 Z
+dependencies: []
+description: Generate list of libraries used with licenses and links
+email:
+- alessio@signorini.us
+executables:
+- oss_audit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/oss_audit
+- lib/oss_audit.rb
+- lib/oss_audit/managers.rb
+- lib/oss_audit/managers/bundler.rb
+- lib/oss_audit/managers/yarn.rb
+- lib/oss_audit/output.rb
+- lib/oss_audit/overrides.rb
+- lib/oss_audit/utils.rb
+- lib/oss_audit/version.rb
+- oss_audit.gemspec
+homepage: https://github.com/alessio-signorini/oss_audit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/alessio-signorini/oss_audit
+  source_code_uri: https://github.com/alessio-signorini/oss_audit
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Open Source Software Auditor
+test_files: []