recog 3.1.1 → 3.1.2

data/spec/lib/recog/nizer_spec.rb

@@ -1,37 +1,36 @@
+# frozen_string_literal: true
+
 require 'recog'
 require 'yaml'
 
-
-VALID_FILTER = {match_key: 'smb.native_os', protocol: 'smb', database_type: 'util.os'}
-NOMATCH_MATCH_KEY = {match_key: 'no_such_987', protocol: 'smb', database_type: 'util.os'}
-NOMATCH_PROTO = {match_key: 'smb.native_os', protocol: 'no_such_987', database_type: 'util.os'}
-NOMATCH_TYPE = {match_key: 'smb.native_os', protocol: 'smb', database_type: 'no_such_987'}
+VALID_FILTER = { match_key: 'smb.native_os', protocol: 'smb', database_type: 'util.os' }.freeze
+NOMATCH_MATCH_KEY = { match_key: 'no_such_987', protocol: 'smb', database_type: 'util.os' }.freeze
+NOMATCH_PROTO = { match_key: 'smb.native_os', protocol: 'no_such_987', database_type: 'util.os' }.freeze
+NOMATCH_TYPE = { match_key: 'smb.native_os', protocol: 'smb', database_type: 'no_such_987' }.freeze
 
 describe Recog::Nizer do
   subject { described_class }
 
-  describe ".match" do
+  describe '.match' do
     File.readlines(File.expand_path(File.join('spec', 'data', 'smb_native_os.txt'))).each do |line|
       data = line.strip
       context "with smb_native_os:#{data}" do
         let(:match_result) { subject.match('smb.native_os', data) }
 
-        it "returns a hash" do
+        it 'returns a hash' do
           expect(match_result.class).to eq(::Hash)
         end
 
-        it "returns a successful match" do
+        it 'returns a successful match' do
           expect(match_result['matched'].to_s).to match(/^[A-Z]/)
         end
 
-        it "correctly matches service or os" do
-          if data =~ /^Windows/
-            expect(match_result['os.product']).to match(/^Windows/)
-          end
+        it 'correctly matches service or os' do
+          expect(match_result['os.product']).to match(/^Windows/) if data =~ /^Windows/
         end
 
         let(:nomatch_result) { subject.match('smb.native_os', 'no_such_987_76tgklh') }
-        it "returns a nil when data cannot be matched" do
+        it 'returns a nil when data cannot be matched' do
           expect(nomatch_result).to be_nil
         end
 
@@ -43,51 +42,47 @@ describe Recog::Nizer do
     end
 
     line = 'non-existent'
-    context "with non-existent match" do
-      let(:match_result) {subject.match('smb.native_os', line) }
-      it "returns a nil" do
+    context 'with non-existent match' do
+      let(:match_result) { subject.match('smb.native_os', line) }
+      it 'returns a nil' do
         expect(match_result).to be_nil
       end
     end
   end
 
-  describe ".match_all_db" do
+  describe '.match_all_db' do
     File.readlines(File.expand_path(File.join('spec', 'data', 'smb_native_os.txt'))).each do |line|
       data = line.strip
       context "with smb_native_os:#{data}" do
         let(:match_all_result) { subject.match_all_db(data, VALID_FILTER) }
 
-        it "returns an array" do
+        it 'returns an array' do
           expect(match_all_result.class).to eq(::Array)
         end
 
-        it "returns a successful match" do
+        it 'returns a successful match' do
           expect(match_all_result[0]['matched']).to match(/^[A-Z]/)
         end
 
-        it "correctly matches service or os" do
-          if data =~ /^Windows/
-            expect(match_all_result[0]['os.product']).to match(/^Windows/)
-          end
+        it 'correctly matches service or os' do
+          expect(match_all_result[0]['os.product']).to match(/^Windows/) if data =~ /^Windows/
         end
 
-        it "correctly matches protocol" do
+        it 'correctly matches protocol' do
           expect(match_all_result[0]['service.protocol']).to eq('smb')
         end
 
         let(:no_filter_result) { subject.match_all_db(data) }
-        it "returns an array when searching without a filter" do
+        it 'returns an array when searching without a filter' do
           expect(no_filter_result.class).to eq(::Array)
         end
 
-        it "returns a successful match when searching without a filter" do
+        it 'returns a successful match when searching without a filter' do
           expect(no_filter_result[0]['matched']).to match(/^[A-Z]/)
         end
 
-        it "correctly matches service or os when searching without a filter" do
-          if data =~ /^Windows/
-            expect(no_filter_result[0]['os.product']).to match(/^Windows/)
-          end
+        it 'correctly matches service or os when searching without a filter' do
+          expect(no_filter_result[0]['os.product']).to match(/^Windows/) if data =~ /^Windows/
         end
 
         let(:nomatch_db_result) { subject.match_all_db(data, NOMATCH_MATCH_KEY) }
@@ -117,214 +112,203 @@ describe Recog::Nizer do
     end
 
     line = 'non-existent'
-    context "with non-existent match" do
-      let(:match_result) {subject.match_all_db(line) }
-      it "returns an array" do
+    context 'with non-existent match' do
+      let(:match_result) { subject.match_all_db(line) }
+      it 'returns an array' do
         expect(match_result.class).to eq(::Array)
       end
-      it "returns an empty array" do
+      it 'returns an empty array' do
         expect(match_result).to be_empty
       end
     end
   end
 
-  describe ".multi_match" do
+  describe '.multi_match' do
     File.readlines(File.expand_path(File.join('spec', 'data', 'smb_native_os.txt'))).each do |line|
       data = line.strip
 
       context "with smb_native_os:#{data}" do
-        let(:match_results) {subject.multi_match('smb.native_os', data) }
+        let(:match_results) { subject.multi_match('smb.native_os', data) }
 
-        it "returns an array" do
+        it 'returns an array' do
           expect(match_results.class).to eq(::Array)
         end
 
-        it "returns at least one successful match" do
+        it 'returns at least one successful match' do
           expect(match_results.size).to be > 0
         end
 
-        it "correctly matches service or os" do
+        it 'correctly matches service or os' do
           match_results do |mr|
-            if data =~ /^Windows/
-              expect(mr['os.product']).to match(/^Windows/)
-            end
+            expect(mr['os.product']).to match(/^Windows/) if data =~ /^Windows/
           end
         end
 
         let(:invalid_db_result) { subject.multi_match('no_such_987', data) }
-        it "returns an array when passed an invalid match_key" do
+        it 'returns an array when passed an invalid match_key' do
           expect(invalid_db_result.class).to eq(::Array)
         end
 
-        it "returns an empty array when passed an invalid match_key" do
+        it 'returns an empty array when passed an invalid match_key' do
           expect(invalid_db_result).to be_empty
         end
       end
-
     end
 
     data = 'Windows Server 2012 R2 Standard 9600'
-    context "with {data}" do
-      let(:match_results) {subject.multi_match('smb.native_os', data) }
+    context 'with {data}' do
+      let(:match_results) { subject.multi_match('smb.native_os', data) }
 
-      it "returns an array" do
+      it 'returns an array' do
         expect(match_results.class).to eq(::Array)
       end
 
-      it "returns at least two successful matches" do
+      it 'returns at least two successful matches' do
         expect(match_results.size).to be > 1
       end
 
-      it "correctly matches os.product for all matches" do
+      it 'correctly matches os.product for all matches' do
         match_results do |mr|
-          if data =~ /^Windows/
-            expect(mr['os.product']).to match(/^Windows/)
-          end
+          expect(mr['os.product']).to match(/^Windows/) if data =~ /^Windows/
         end
       end
 
-      it "correctly matches protocol for all matches" do
+      it 'correctly matches protocol for all matches' do
         match_results do |mr|
-          if data =~ /^Windows/
-            expect(mr['service.protocol']).to eq('smb')
-          end
+          expect(mr['service.protocol']).to eq('smb') if data =~ /^Windows/
         end
       end
     end
 
     line = 'non-existent'
-    context "with non-existent match" do
-      let(:match_results) {subject.multi_match('smb.native_os', line) }
+    context 'with non-existent match' do
+      let(:match_results) { subject.multi_match('smb.native_os', line) }
 
-      it "returns an array" do
+      it 'returns an array' do
         expect(match_results.class).to eq(::Array)
       end
 
-      it "returns an empty array" do
+      it 'returns an empty array' do
         expect(match_results).to be_empty
       end
     end
   end
 
-  describe ".best_os_match" do
+  describe '.best_os_match' do
     # Demonstrates how this method picks up additional attributes from other members of the winning
     # os.product match group and applies them to the result.
-    matches1 = YAML.load(File.read(File.expand_path(File.join('spec', 'data', 'best_os_match_1.yml'))))
-    context "with best_os_match_1.yml" do
+    matches1 = YAML.safe_load(File.read(File.expand_path(File.join('spec', 'data', 'best_os_match_1.yml'))))
+    context 'with best_os_match_1.yml' do
       let(:result) { subject.best_os_match(matches1) }
 
-      it "returns a hash" do
+      it 'returns a hash' do
         expect(result.class).to eq(::Hash)
       end
 
-      it "matches Windows 2008" do
+      it 'matches Windows 2008' do
         expect(result['os.product']).to eq('Windows 2008')
       end
 
-      it "matches Microsoft" do
+      it 'matches Microsoft' do
         expect(result['os.vendor']).to eq('Microsoft')
       end
 
-      it "matches English" do
+      it 'matches English' do
         expect(result['os.language']).to eq('English')
       end
 
-      it "matches service pack 2" do
+      it 'matches service pack 2' do
         expect(result['os.version']).to eq('Service Pack 2')
       end
     end
 
     # Demonstrates how additive os.certainty values allow a 1.0 certainty rule to be overridden
     # by multiple lower certainty matches
-    matches2 = YAML.load(File.read(File.expand_path(File.join('spec', 'data', 'best_os_match_2.yml'))))
-    context "with best_os_match_2.yml" do
+    matches2 = YAML.safe_load(File.read(File.expand_path(File.join('spec', 'data', 'best_os_match_2.yml'))))
+    context 'with best_os_match_2.yml' do
       let(:result) { subject.best_os_match(matches2) }
 
-      it "returns a hash" do
+      it 'returns a hash' do
         expect(result.class).to eq(::Hash)
       end
 
-      it "matches Windows 2012" do
+      it 'matches Windows 2012' do
         expect(result['os.product']).to eq('Windows 2012')
       end
 
-      it "matches Microsoft" do
+      it 'matches Microsoft' do
         expect(result['os.vendor']).to eq('Microsoft')
       end
 
-      it "matches Arabic" do
+      it 'matches Arabic' do
         expect(result['os.language']).to eq('Arabic')
       end
 
-      it "matches service pack 1" do
+      it 'matches service pack 1' do
         expect(result['os.version']).to eq('Service Pack 1')
       end
     end
-
   end
 
-  describe ".best_service_match" do
+  describe '.best_service_match' do
     # Demonstrates how this method picks up additional attributes from other members of the winning
     # service.product match group and applies them to the result.
-    matches1 = YAML.load(File.read(File.expand_path(File.join('spec', 'data', 'best_service_match_1.yml'))))
-    context "with best_service_match_1.yml" do
+    matches1 = YAML.safe_load(File.read(File.expand_path(File.join('spec', 'data', 'best_service_match_1.yml'))))
+    context 'with best_service_match_1.yml' do
       let(:result) { subject.best_service_match(matches1) }
 
-      it "returns a hash" do
+      it 'returns a hash' do
         expect(result.class).to eq(::Hash)
       end
 
-      it "matches IIS" do
+      it 'matches IIS' do
         expect(result['service.product']).to eq('IIS')
       end
 
-      it "matches Microsoft" do
+      it 'matches Microsoft' do
         expect(result['service.vendor']).to eq('Microsoft')
       end
 
-      it "matches English" do
+      it 'matches English' do
         expect(result['service.language']).to eq('English')
       end
 
-      it "matches version 6.0" do
+      it 'matches version 6.0' do
         expect(result['service.version'].to_i).to eq(6.0)
       end
     end
-
   end
 
-
   describe '.load_db' do
     file_path = File.expand_path(File.join('spec', 'data', 'test_fingerprints.xml'))
     context "with #{file_path}" do
       let(:fp_db) { subject.load_db(file_path) }
-      it "loads without error" do
-        expect(fp_db).to  be true
-        subject.unload_db()
+      it 'loads without error' do
+        expect(fp_db).to be true
+        subject.unload_db
       end
     end
 
-    context "with no path specified" do
+    context 'with no path specified' do
       let(:fp_db) { subject.load_db }
-      it "loads without error" do
-        expect(fp_db).to  be true
-        subject.unload_db()
+      it 'loads without error' do
+        expect(fp_db).to be true
+        subject.unload_db
       end
     end
 
-    context "with empty file path" do
-      it "raises an error" do
+    context 'with empty file path' do
+      it 'raises an error' do
         expect { subject.load_db('') }.to raise_error(Errno::ENOENT)
-        subject.unload_db()
+        subject.unload_db
       end
     end
 
-    context "with invalid file path" do
-      it "raises an error" do
+    context 'with invalid file path' do
+      it 'raises an error' do
         expect { subject.load_db('no_such_987_file_path') }.to raise_error(Errno::ENOENT)
-        subject.unload_db()
+        subject.unload_db
       end
     end
   end
-
 end

data/spec/lib/recog/verify_reporter_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'recog/verify_reporter'
 
 describe Recog::VerifyReporter do
@@ -5,142 +7,141 @@ describe Recog::VerifyReporter do
   let(:fingerprint) { double(name: 'a name', tests: tests) }
   let(:tests) { [double, double, double] }
   let(:summary_line) do
-    "SUMMARY: Test completed with 1 successful, 1 warnings, and 1 failures"
+    'SUMMARY: Test completed with 1 successful, 1 warnings, and 1 failures'
   end
-  let(:path) { "fingerprint.xml" }
+  let(:path) { 'fingerprint.xml' }
 
   subject { Recog::VerifyReporter.new(double(detail: false, quiet: false, warnings: true), formatter) }
 
   def run_report
     subject.report(1) do
-        subject.print_name fingerprint
-        subject.success 'passed'
-        subject.warning 'a warning'
-        subject.failure 'a failure'
+      subject.print_name fingerprint
+      subject.success 'passed'
+      subject.warning 'a warning'
+      subject.failure 'a failure'
     end
   end
 
-  describe "#report" do
-    it "prints warnings" do
+  describe '#report' do
+    it 'prints warnings' do
       expect(formatter).to receive(:warning_message).with('WARN: a warning')
       run_report
     end
 
-    it "prints failures" do
+    it 'prints failures' do
       expect(formatter).to receive(:failure_message).with('FAIL: a failure')
       run_report
     end
 
-    it "prints summary" do
+    it 'prints summary' do
       expect(formatter).to receive(:failure_message).with(summary_line)
       run_report
     end
 
-    context "with detail" do
+    context 'with detail' do
       subject { Recog::VerifyReporter.new(double(detail: true, quiet: false, warnings: true), formatter) }
 
-      it "prints the fingerprint name" do
+      it 'prints the fingerprint name' do
         expect(formatter).to receive(:status_message).with("\na name")
         run_report
       end
 
-      it "prints successes" do
+      it 'prints successes' do
         expect(formatter).to receive(:success_message).with('   passed')
         run_report
       end
 
-      it "prints warnings" do
+      it 'prints warnings' do
         expect(formatter).to receive(:warning_message).with('   WARN: a warning')
         run_report
       end
 
-      it "prints failures" do
+      it 'prints failures' do
         expect(formatter).to receive(:failure_message).with('   FAIL: a failure')
         run_report
       end
 
-      it "prints the fingerprint count" do
+      it 'prints the fingerprint count' do
         expect(formatter).to receive(:status_message).with("\nVerified 1 fingerprints:")
         run_report
       end
 
-      it "prints summary" do
+      it 'prints summary' do
         expect(formatter).to receive(:failure_message).with(summary_line)
         run_report
       end
 
-      context "with no fingerprint tests" do
+      context 'with no fingerprint tests' do
         let(:tests) { [] }
 
-        it "does not print the name" do
+        it 'does not print the name' do
           expect(formatter).not_to receive(:status_message).with("\na name")
           run_report
         end
       end
     end
 
-    context "with fingerprint path" do
-
+    context 'with fingerprint path' do
       subject { Recog::VerifyReporter.new(double(detail: false, quiet: false, warnings: true), formatter, path) }
 
-      it "prints warnings" do
+      it 'prints warnings' do
         expect(formatter).to receive(:warning_message).with("#{path}: WARN: a warning")
         run_report
       end
 
-      it "prints failures" do
+      it 'prints failures' do
         expect(formatter).to receive(:failure_message).with("#{path}: FAIL: a failure")
         run_report
       end
 
-      it "prints summary" do
+      it 'prints summary' do
         expect(formatter).to receive(:failure_message).with("#{path}: #{summary_line}")
         run_report
       end
     end
 
-    context "with fingerprint path and detail" do
+    context 'with fingerprint path and detail' do
       subject { Recog::VerifyReporter.new(double(detail: true, quiet: false, warnings: true), formatter, path) }
 
-      it "prints the fingerprint path" do
+      it 'prints the fingerprint path' do
         expect(formatter).to receive(:status_message).with("\n#{path}:\n")
         run_report
       end
 
-      it "prints the fingerprint name" do
+      it 'prints the fingerprint name' do
         expect(formatter).to receive(:status_message).with("\na name")
         run_report
       end
 
-      it "prints successes" do
+      it 'prints successes' do
         expect(formatter).to receive(:success_message).with('   passed')
         run_report
       end
 
-      it "prints warnings" do
+      it 'prints warnings' do
         expect(formatter).to receive(:warning_message).with('   WARN: a warning')
         run_report
       end
 
-      it "prints failures" do
+      it 'prints failures' do
         expect(formatter).to receive(:failure_message).with('   FAIL: a failure')
         run_report
       end
 
-      it "prints the fingerprint count" do
+      it 'prints the fingerprint count' do
         expect(formatter).to receive(:status_message).with("\nVerified 1 fingerprints:")
         run_report
       end
 
-      it "prints summary" do
+      it 'prints summary' do
         expect(formatter).to receive(:failure_message).with(summary_line)
         run_report
       end
 
-      context "with no fingerprint tests" do
+      context 'with no fingerprint tests' do
         let(:tests) { [] }
 
-        it "does not print the name" do
+        it 'does not print the name' do
           expect(formatter).not_to receive(:status_message).with("\na name")
           run_report
         end
@@ -148,32 +149,32 @@ describe Recog::VerifyReporter do
     end
   end
 
-  describe "#print_summary" do
-    context "with success" do
+  describe '#print_summary' do
+    context 'with success' do
       before { subject.success 'pass' }
 
-      it "prints a successful summary" do
-        msg = "SUMMARY: Test completed with 1 successful, 0 warnings, and 0 failures"
+      it 'prints a successful summary' do
+        msg = 'SUMMARY: Test completed with 1 successful, 0 warnings, and 0 failures'
         expect(formatter).to receive(:success_message).with(msg)
         subject.print_summary
       end
     end
 
-    context "with warnings" do
+    context 'with warnings' do
       before { subject.warning 'warn' }
 
-      it "prints a warning summary" do
-        msg = "SUMMARY: Test completed with 0 successful, 1 warnings, and 0 failures"
+      it 'prints a warning summary' do
+        msg = 'SUMMARY: Test completed with 0 successful, 1 warnings, and 0 failures'
         expect(formatter).to receive(:warning_message).with(msg)
         subject.print_summary
       end
     end
 
-    context "with failures" do
+    context 'with failures' do
       before { subject.failure 'fail' }
 
-      it "prints a failure summary" do
-        msg = "SUMMARY: Test completed with 0 successful, 0 warnings, and 1 failures"
+      it 'prints a failure summary' do
+        msg = 'SUMMARY: Test completed with 0 successful, 0 warnings, and 1 failures'
         expect(formatter).to receive(:failure_message).with(msg)
         subject.print_summary
       end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 FINGERPRINT_DIR = File.expand_path(File.join('..', 'recog', 'xml'), __dir__)
 
 # setup code coverage
@@ -22,7 +24,6 @@ require 'rspec'
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing
   # the seed, which is printed after each run.

data.tar.gz.sig

@@ -1,3 +1 @@
-,��/�@xv4ȟD����H|C��Y���3�M����X����ຮ�ނ�d
-�0�?�v`Ӵ�C&b��[�#T1E6�������;i�z���a�
-S�v�=Ԡ^�z;X1�%���dc��p����w��,��GS�Vv�����	6%�z��r�c
����V�woVʊ�ǔȳ6�B�l���C���āe�i�@�7�E#'&s���9�H����a+%Y&&$�Mw�AǮk�ip�h����~p�R�Fq<{]F��
+=&�
-,*K��Z�8�k���O�ٱ�N���Y���X��9{��-J�&��Oot	��%�D�!Od�d�,�^�S

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recog
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.1.2
 platform: ruby
 authors:
 - Rapid7 Research
@@ -93,7 +93,7 @@ cert_chain:
   EknWpNgVhohbot1lfVAMmIhdtOVaRVcQQixWPwprDj/ydB8ryDMDosIMcw+fkoXU
   9GJsSaSRRYQ9UUkVL27b64okU8D48m8=
   -----END CERTIFICATE-----
-date: 2023-03-18 00:00:00.000000000 Z
+date: 2023-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -293,7 +293,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="