nessana 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee396ef7c7de91a411465ca7cd27f2dd2ec0ae3ada00d65f2d7fd93bcf7231d1
-  data.tar.gz: f53065e4cd980ea6ea2da9127a87bede09ceaca1a7607df7f53323b4d090aa73
+  metadata.gz: b385c40628994b9e7819e4a855084d81d9bf5a3c8d650e0999ec4e217ba038d6
+  data.tar.gz: c62f1308a920473dd891ddfa2057d2b2dabe4ae0d58b0922184ce7998ef19e65
 SHA512:
-  metadata.gz: 68b6913aa147d06ef5e1336fd8f694f148e2f67e58cf28b1e1e3690d7761fadbcb0addcd94fa21eafd4f7bbf4bd27f8047702451e65f434d59a66141d2b604ba
-  data.tar.gz: 0bcab82e1682510938fcaf5a69a4d3cffe2beba1af660c8417d81540dd464512dcaeaee0bf57d8e3918aba060f240a9e9c686fb190d82961ce1b9ff2cf94d808
+  metadata.gz: 5cb874ce7320573f4b19e0393a3d8a0af2a0851a9df0f7cebca345d3d3ffc9dfeb1cc6ae45fec6ce35ab855a75c71eb94abb22b53afeebfa55d82122ca1c4104
+  data.tar.gz: 9efc4f1a4f11b29db8b4b11da2800bfe5e0574219e3d0c87c8e45bfca6229d7224e190fba9e58ed23f50e1ecf0d23d3de13255dbeff3612667f72b782e2d4685

data/README.md

@@ -11,3 +11,23 @@ $ nessana -c config.yml scan.csv
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+
+```
+<one line to give the program's name and a brief idea of what it does.>
+Copyright (C) 2019 Kristofer Rye
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published
+by the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Affero General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <https://www.gnu.org/licenses/>.
+```

data/bin/nessana

@@ -2,4 +2,4 @@
 
 require 'nessana/executor'
 
-Nessana::Executor.execute!
+exit Nessana::Executor.execute!

data/lib/nessana/detection.rb

@@ -25,7 +25,7 @@ module Nessana
 				@status == other.status || false
 		end
 
-		alias eql? ==
+		alias :eql? :==
 
 		protected
 

data/lib/nessana/dump.rb

@@ -2,7 +2,6 @@ require 'time'
 
 require 'csv'
 require 'fastcsv'
-require 'tty-spinner'
 
 require 'nessana/detection'
 require 'nessana/vulnerability'
@@ -10,75 +9,32 @@ require 'nessana/vulnerability'
 module Nessana
 	class Dump < Hash
 		attr_reader :filters
-		attr_reader :filename
 
-		def initialize(filename = nil, filters = [])
-			@filename, @filters = filename, filters
+		def self.read(file, filters = [])
+			data = read_csv(file)
 
-			if @filename
-				if File.readable?(@filename)
-					spinner_options = {
-						success_mark: "\u2713".encode('utf-8'),
-						format: :dots_3
-					}
-					spinner = TTY::Spinner.new("[:spinner] Loading #{@filename}...", **spinner_options)
-					spinner.auto_spin
+			self.new(data, filters)
+		end
 
-					read_csv!
+		def initialize(vulnerabilities = {}, filters = [])
+			@filters = filters
 
-					spinner.success('done!')
-				else
-					throw 'file not readable; sad face'
-				end
+			filtered_data = vulnerabilities.select do |_, vulnerability|
+				!vulnerability.matches?(@filters)
 			end
+
+			merge!(filtered_data)
 		end
 
 		def -(other)
-			spinner_options = {
-				success_mark: "\u2713".encode('utf-8'),
-				format: :dots_3
-			}
-
-			spinner = TTY::Spinner.new('[:spinner] :action...', **spinner_options)
-			spinner.update(action: 'Generating detections...')
-
 			other_plugin_ids = other.keys
 			self_plugin_ids = keys
 
-			spinner.update(action: 'Finding L detections')
-
-			other_detection_pairs = other.map do |plugin_id, vulnerability|
-				spinner.update(action: "Finding L detections (#{plugin_id})")
-				spinner.auto_spin
-
-				vulnerability.detections.map do |detection|
-					{ plugin_id => detection }
-				end
-			end
-
-			other_detections = Set.new(other_detection_pairs.flatten)
-
-			spinner.update(action: 'Finding R detections')
-
-			detection_pairs = map do |plugin_id, vulnerability|
-				spinner.update(action: "Finding R detections (#{plugin_id})")
-				spinner.auto_spin
-
-				vulnerability.detections.map do |detection|
-					{ plugin_id => detection }
-				end
-			end
-
-			self_detections = Set.new(detection_pairs.flatten)
-
-			spinner.update(action: 'Joining detection sets')
-			spinner.auto_spin
+			other_detections = other.detection_pairs
+			self_detections = detection_pairs
 
 			detections = Set.new([other_detections, self_detections]).flatten
 
-			spinner.update(action: 'Processing detections')
-			spinner.auto_spin
-
 			detections.each do |detection_entry|
 				in_self = self_detections.include? detection_entry
 				in_other = other_detections.include? detection_entry
@@ -96,8 +52,6 @@ module Nessana
 				end
 			end
 
-			spinner.success('done!')
-
 			added_plugin_ids = self_plugin_ids - other_plugin_ids
 			deleted_plugin_ids = other_plugin_ids - self_plugin_ids
 			all_plugin_ids = other_plugin_ids + added_plugin_ids
@@ -127,19 +81,19 @@ module Nessana
 			all_vulnerabilities
 		end
 
-		def read_csv!
-			data = read_csv(filename)
-
-			filtered_data = data.select do |_, vulnerability|
-				!vulnerability.matches?(@filters)
+		def detection_pairs
+			pairs = map do |plugin_id, vulnerability|
+				vulnerability.detections.map do |detection|
+					{ plugin_id => detection }
+				end
 			end
 
-			merge!(filtered_data)
+			Set.new(pairs.flatten)
 		end
 
 		protected
 
-		def read_csv(filename)
+		def self.read_csv(filename)
 			dump_data = {}
 
 			first_row = true

data/lib/nessana/executor.rb

@@ -1,7 +1,6 @@
 require 'optparse'
 require 'pp'
-require 'ruby-prof'
-require 'ruby-prof-flamegraph'
+require 'tty-spinner'
 
 require 'nessana/executor/execution_configuration'
 require 'nessana/filter'
@@ -16,26 +15,55 @@ module Nessana
 		def self.execute!(argv = ARGV)
 			parse!(*argv)
 
-			RubyProf.start if !!@configuration['performance']
+			return @configuration unless @configuration.is_a?(Nessana::Executor::ExecutionConfiguration)
+
+			return @configuration['__exit-code__'] if @configuration['__stop__']
 
 			unless @configuration['old_filename']
-				$stderr.puts 'No old dump filename given; will assume no prior knowledge.'
+				warn 'No old dump filename given; assuming you want this.'
 			end
 
 			unless @configuration['new_filename']
-				puts 'No new dump filename given; cannot do anything.'
-				return
+				warn 'No new dump filename given; cannot do anything.'
+				return 1
 			end
 
 			filters = @configuration['filters'].map do |filter_hash|
 				Filter.new(filter_hash)
 			end
 
-			old_dump = @configuration['old_filename'] ? Dump.new(@configuration['old_filename'], filters) : Dump.new
-			new_dump = Dump.new(@configuration['new_filename'], filters)
+			spinner_options = {
+				success_mark: "\u2713".encode('utf-8'),
+				format: :dots_3
+			}
+
+			old_dump = nil
+
+			if @configuration['old_filename']
+				spinner = TTY::Spinner.new("[:spinner] Loading #{@configuration['old_filename']}...", **spinner_options)
+				spinner.auto_spin
+
+				old_dump = Dump.read(@configuration['old_filename'], filters)
+
+				spinner.success('done!')
+			else
+				old_dump = Dump.new
+			end
+
+			spinner = TTY::Spinner.new("[:spinner] Loading #{@configuration['old_filename']}...", **spinner_options)
+			spinner.auto_spin
+
+			new_dump = Dump.read(@configuration['new_filename'], filters)
+
+			spinner.success('done!')
+
+			spinner = TTY::Spinner.new('[:spinner] Comparing dumps...', **spinner_options)
+			spinner.auto_spin
 
 			diff = new_dump - old_dump
 
+			spinner.success('done!')
+
 			diff.sort do |vulnerability_a, vulnerability_b|
 				vulnerability_a.plugin_id.to_i <=> vulnerability_b.plugin_id.to_i
 			end.sort do |vulnerability_a, vulnerability_b|
@@ -52,12 +80,7 @@ DISCOVERIES"
 				puts "\n" * 2
 			end
 
-			if !!@configuration['performance']
-				result = RubyProf.stop
-				printer = RubyProf::FlameGraphPrinter.new(result)
-				io = open(@configuration['performance'], 'wb')
-				printer.print(io, {})
-			end
+			0
 		end
 
 		def self.parse(*argv)
@@ -68,10 +91,8 @@ DISCOVERIES"
 
 				if argv.count == 0
 					puts parser
-					exit 1
+					return 1
 				end
-
-				parser.parse(*argv)
 			end
 
 			remaining_arguments = option_parser.order!(argv)
@@ -95,6 +116,5 @@ DISCOVERIES"
 		def self.parse!(*argv)
 			@configuration = parse(*argv)
 		end
-
 	end
 end

data/lib/nessana/executor/execution_configuration.rb

@@ -3,6 +3,8 @@ require 'mime-types'
 require 'nessana/version'
 
 module Nessana::Executor
+	# TODO: Replace __stop__ and __exit-code__ with exits again, and
+	# use a rescue SystemExit => e instead.
 	class ExecutionConfiguration < ::Hash
 		def initialize
 			self['verbosity'] = 'info'
@@ -25,14 +27,10 @@ module Nessana::Executor
 			add_usage_option(parser)
 			add_verbosity_option(parser)
 
-			parser.on_tail('-h', '--help', 'Show this message') do
-				puts parser
-				exit
-			end
-
-			parser.on_tail('--version', 'Show version') do
+			parser.on_tail('-V', '--version', 'Show version') do
 				puts Nessana::VERSION
-				exit
+				self['__stop__'] = true
+				self['__exit-code__'] = 0
 			end
 		end
 
@@ -52,7 +50,8 @@ module Nessana::Executor
 		def add_usage_option(parser)
 			parser.on('-h', '--help', 'Print usage summary.') do
 				puts parser
-				exit 0
+				self['__stop__'] = true
+				self['__exit-code__'] = 0
 			end
 		end
 

data/lib/nessana/version.rb

@@ -1,3 +1,3 @@
 module Nessana
-	VERSION = '0.2.0'.freeze
+	VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nessana
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kristofer Rye <kristofer.rye@gmail.com>
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fastcsv
@@ -136,34 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.57'
-- !ruby/object:Gem::Dependency
-  name: ruby-prof
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.0
-- !ruby/object:Gem::Dependency
-  name: ruby-prof-flamegraph
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -199,7 +171,7 @@ files:
 - lib/nessana/vulnerability.rb
 homepage: https://github.com/rye/nessana
 licenses:
-- MIT
+- AGPL-3.0-only
 metadata: {}
 post_install_message: 
 rdoc_options: []