recog 2.0.14 → 2.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2d08dc173999e1694bdc5f102a28be119f4e8866
-  data.tar.gz: 46283f711629cc12bb944b02cfe6ce1bbfc1f5d5
+  metadata.gz: 81ca81c5892d0fb7882afdb14f8c6e0324196cbb
+  data.tar.gz: 793218a1570ce08ee7e3c0895b1c5822e5f49922
 SHA512:
-  metadata.gz: 44b5b348c47caefd5998d36fa2439e64b05ae679daba22a58014d484b1a55baa0348b301ecbe3ccfeea337ca5fd2afb35b94580ebefa0f2161284f69d22c4c76
-  data.tar.gz: ab0237e095304a36ae8b72f1afbbb9abb6e2fd4423af1d8e071546c178eb3e547355c70b8f9ea4ec78a1e38738fe4b582b9e36a1ebf0ea0bbf9e8d3e3a63c060
+  metadata.gz: fa6edf956ca223ea34ebd8c39a6a2e4a471b3f225d9642ba83e4e945ce4135f0691b64b67b767d48b557df83c474563ccf7ff28f11e77bac5007a6607cc81272
+  data.tar.gz: 9e9045604f3a260422e0002bf63d565ebedad35ab1a2afb99775a2bb28bf70d459ed9330feba2742c1f1b118daf421c2965b7c11498c30de02c406dc967a4831

data/bin/recog_verify

@@ -6,7 +6,7 @@ require 'ostruct'
 require 'recog'
 require 'recog/verifier_factory'
 
-options = OpenStruct.new(color: false, detail: false)
+options = OpenStruct.new(color: false, detail: false, quiet: false, warnings: true)
 
 option_parser = OptionParser.new do |opts|
   opts.banner = "Usage: #{$0} [options] XML_FINGERPRINT_FILE1 ..."
@@ -17,16 +17,24 @@ option_parser = OptionParser.new do |opts|
   opts.on("-f", "--format FORMATTER",
           "Choose a formatter.",
           "  [s]ummary (default - failure/warning msgs and summary)",
+          "  [q]uiet (configured failure/warning msgs only)",
           "  [d]etail  (fingerprint name with tests and expanded summary)") do |format|
     if format.start_with? 'd'
       options.detail = true
     end
+    if format.start_with? 'q'
+      options.quiet = true
+    end
   end
 
   opts.on("-c", "--color", "Enable color in the output.") do
     options.color = true
   end
 
+  opts.on("--[no-]warnings", "Track warnings") do |o|
+    options.warnings = o
+  end
+
   opts.on("-h", "--help", "Show this message.") do
     puts opts
     exit
@@ -40,9 +48,17 @@ if ARGV.empty?
   exit(1)
 end
 
-ARGV.each do |file|
-  ndb = Recog::DB.new(file)
-  options.fingerprints = ndb.fingerprints
-  verifier = Recog::VerifierFactory.build(options)
-  verifier.verify_tests
+warnings = 0
+failures = 0
+ARGV.each do |arg|
+  Dir.glob(arg).each do |file|
+    ndb = Recog::DB.new(file)
+    options.fingerprints = ndb.fingerprints
+    verifier = Recog::VerifierFactory.build(options)
+    verified = verifier.verify
+    failures += verifier.reporter.failure_count
+    warnings += verifier.reporter.warning_count
+  end
 end
+
+exit failures + warnings

data/features/data/tests_with_failures.xml

@@ -10,11 +10,11 @@
      <!-- Fail: doesn't match -->
      <example>This almost matches</example>
    </fingerprint>
-   <fingerprint pattern="^bar ([\d.]+)$">
+   <fingerprint pattern="^(\S+) ([\d.]+)$">
      <description>bar test</description>
      <!-- Fail: expected os.version doesn't match the capture group -->
      <example os.version="5.0" >bar 1.0</example>
-     <param pos="1" name="os.version" />
-     <param pos="0" name="os.name" value="Bar" />
+     <param pos="2" name="os.version" />
+     <param pos="1" name="os.name" value="Bar" />
    </fingerprint>
 </fingerprints>

data/features/verify.feature

@@ -13,22 +13,32 @@ Feature: Verify
       SUMMARY: Test completed with 4 successful, 0 warnings, and 0 failures
       """
 
-  Scenario: Tests with warnings
+  Scenario: Tests with warnings, warnings enabled
     When I run `recog_verify tests_with_warnings.xml`
-    Then it should pass with:
+    Then it should fail with:
       """
       WARN: 'Pure-FTPd' has no test cases
       SUMMARY: Test completed with 1 successful, 1 warnings, and 0 failures
       """
+    And the exit status should be 1
+
+  Scenario: Tests with warnings, warnings disabled
+    When I run `recog_verify --no-warnings tests_with_warnings.xml`
+    Then it should pass with:
+      """
+      SUMMARY: Test completed with 1 successful, 0 warnings, and 0 failures
+      """
 
   Scenario: Tests with failures
     When I run `recog_verify tests_with_failures.xml`
-    Then it should pass with:
+    Then it should fail with:
       """
       FAIL: 'foo test' failed to match "bar" with (?-mix:^foo$)'
       FAIL: '' failed to match "This almost matches" with (?-mix:^This matches$)'
+      FAIL: 'bar test's os.name is a non-zero pos but specifies a value of 'Bar'
       FAIL: 'bar test' failed to find expected capture group os.version '5.0'
-      SUMMARY: Test completed with 0 successful, 0 warnings, and 3 failures
+      SUMMARY: Test completed with 0 successful, 0 warnings, and 4 failures
       """
+    And the exit status should be 4
 
 

data/lib/recog/fingerprint.rb

@@ -61,6 +61,21 @@ class Fingerprint
     return result
   end
 
+  # Ensure all the {#params} are valid
+  #
+  # @yieldparam status [Symbol] One of `:warn`, `:fail`, or `:success` to
+  #   indicate whether a param is valid
+  # @yieldparam message [String] A human-readable string explaining the
+  #   `status`
+  def verify_params(&block)
+    return if params.empty?
+    params.each do |param_name, pos_value|
+      pos, value = pos_value
+      next unless pos != 0 && !value.to_s.empty?
+      yield :fail, "'#{@name}'s #{param_name} is a non-zero pos but specifies a value of '#{value}'"
+    end
+  end
+
   # Ensure all the {#tests} actually match the fingerprint and return the
   # expected capture groups.
   #

data/lib/recog/match_reporter.rb

@@ -12,7 +12,7 @@ class MatchReporter
   def report
     reset_counts
     yield self
-    summarize
+    summarize unless @options.quiet
   end
 
   def stop?

data/lib/recog/verifier.rb

@@ -7,11 +7,21 @@ class Verifier
     @reporter = reporter
   end
 
-  def verify_tests
+  def verify
     reporter.report(fingerprints.count) do
       fingerprints.each do |fp|
         reporter.print_name fp
 
+        fp.verify_params do |status, message|
+          case status
+          when :warn
+            reporter.warning "WARN: #{message}"
+          when :fail
+            reporter.failure "FAIL: #{message}"
+          when :success
+            reporter.success(message)
+          end
+        end
         fp.verify_tests do |status, message|
           case status
           when :warn
@@ -21,9 +31,7 @@ class Verifier
           when :success
             reporter.success(message)
           end
-
         end
-
       end
     end
   end

data/lib/recog/verify_reporter.rb

@@ -12,7 +12,7 @@ class VerifyReporter
   def report(fingerprint_count)
     reset_counts
     yield self
-    summarize(fingerprint_count)
+    summarize(fingerprint_count) unless @options.quiet
   end
 
   def success(text)
@@ -21,6 +21,7 @@ class VerifyReporter
   end
 
   def warning(text)
+    return unless @options.warnings
     @warning_count += 1
     formatter.warning_message("#{padding}#{text}")
   end

data/lib/recog/version.rb

@@ -1,3 +1,3 @@
 module Recog
-  VERSION = '2.0.14'
+  VERSION = '2.0.15'
 end

data/spec/data/smb_native_os.txt

@@ -23,9 +23,3 @@ Windows 7 Starter 7601 Service Pack 1
 Windows 7 Home Premium 7600
 Windows 7 Enterprise 7601 Service Pack 1
 Windows 7 Enterprise 7600
-Samba 3.6.9-151.el6_4.1
-Samba 3.6.6
-Samba 3.6.3
-Samba 3.0.32-0.2-2210-SUSE-SL10.3
-Samba 3.0.28a
-Samba 3.0.24

data/spec/lib/recog/match_reporter_spec.rb

@@ -1,7 +1,7 @@
 require 'recog/match_reporter'
 
 describe Recog::MatchReporter do
-  let(:options) { double(detail: false) }
+  let(:options) { double(detail: false, quiet: false) }
   let(:formatter) { double('formatter').as_null_object }
   subject { Recog::MatchReporter.new(options, formatter) }
 
@@ -25,7 +25,7 @@ describe Recog::MatchReporter do
     end
 
     context "with detail" do
-      subject { Recog::MatchReporter.new(double(detail: true), formatter) }
+      subject { Recog::MatchReporter.new(double(detail: true, quiet: false), formatter) }
 
       it "prints the lines processed" do
         expect(formatter).to receive(:status_message).with("\nProcessed 1 lines")

data/spec/lib/recog/nizer_spec.rb

@@ -22,10 +22,6 @@ describe Recog::Nizer do
           if data =~ /^Windows/
             expect(match_result['os.product']).to match(/^Windows/)
           end
-
-          if data =~ /^Samba/
-            expect(match_result['service.product']).to match(/^Samba/)
-          end
         end
 
       end

data/spec/lib/recog/verify_reporter_spec.rb

@@ -8,7 +8,7 @@ describe Recog::VerifyReporter do
     "SUMMARY: Test completed with 1 successful, 1 warnings, and 1 failures"
   end
 
-  subject { Recog::VerifyReporter.new(double(detail: false), formatter) }
+  subject { Recog::VerifyReporter.new(double(detail: false, quiet: false, warnings: true), formatter) }
 
   def run_report
     subject.report(1) do
@@ -36,7 +36,7 @@ describe Recog::VerifyReporter do
     end
 
     context "with detail" do
-      subject { Recog::VerifyReporter.new(double(detail: true), formatter) }
+      subject { Recog::VerifyReporter.new(double(detail: true, quiet: false, warnings: true), formatter) }
 
       it "prints the fingerprint name" do
         expect(formatter).to receive(:status_message).with("\na name")

data/xml/smb_native_lm.xml

@@ -0,0 +1,45 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  SMB fingerprints obtained from the Native LM (LAN manager) field of SMB
+  negotations
+-->
+<fingerprints matches="smb.native_lm">
+  <!-- Mac OS X -->
+  <fingerprint pattern="^Samba (3\.0\.28a-apple)$">
+    <description>Samba on OS X 10.6</description>
+    <example service.version="3.0.28a-apple">Samba 3.0.28a-apple</example>
+    <param pos="0" name="os.vendor" value="Apple"/>
+    <param pos="0" name="os.family" value="Mac OS X"/>
+    <param pos="0" name="os.product" value="Mac OS X"/>
+    <param pos="0" name="os.device" value="General"/>
+    <param pos="0" name="os.version" value="10.6"/>
+    <param pos="0" name="service.vendor" value="Samba"/>
+    <param pos="0" name="service.product" value="Samba"/>
+    <param pos="1" name="service.version"/>
+  </fingerprint>
+  <fingerprint pattern="^Samba (3\.0\.25b-apple)$">
+    <description>Samba on OS X 10.5</description>
+    <example service.version="3.0.25b-apple">Samba 3.0.25b-apple</example>
+    <param pos="0" name="os.vendor" value="Apple"/>
+    <param pos="0" name="os.family" value="Mac OS X"/>
+    <param pos="0" name="os.product" value="Mac OS X"/>
+    <param pos="0" name="os.device" value="General"/>
+    <param pos="0" name="os.version" value="10.5"/>
+    <param pos="0" name="service.vendor" value="Samba"/>
+    <param pos="0" name="service.product" value="Samba"/>
+    <param pos="1" name="service.version"/>
+  </fingerprint>
+  <!-- TODO: Detect vendor, distribution, and package versions -->
+  <fingerprint pattern="^Samba (\d\.\d+.\d+\w*)">
+    <description>Samba</description>
+    <example>Samba 3.0.24</example>
+    <example>Samba 3.0.28a</example>
+    <example>Samba 3.0.32-0.2-2210-SUSE-SL10.3</example>
+    <example>Samba 3.6.3</example>
+    <example>Samba 3.6.6</example>
+    <example>Samba 3.6.9-151.el6_4.1</example>
+    <param pos="0" name="service.vendor" value="Samba"/>
+    <param pos="0" name="service.product" value="Samba"/>
+    <param pos="1" name="service.version"/>
+  </fingerprint>
+</fingerprints>

data/xml/smb_native_os.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
-  SMB Native OS Fingerprints
+  SMB fingerprints obtained from the Native OS field of SMB negotations
 -->
 <fingerprints matches="smb.native_os">
   <fingerprint pattern="^(Windows NT \d\.\d+)$">
@@ -342,44 +342,6 @@
     <param pos="1" name="os.edition"/>
     <param pos="2" name="os.build"/>
   </fingerprint>
-  <!-- Mac OS X -->
-  <fingerprint pattern="^Samba (3\.0\.28a-apple)$">
-    <description>Samba on OS X 10.6</description>
-    <example service.version="3.0.28a-apple">Samba 3.0.28a-apple</example>
-    <param pos="0" name="os.vendor" value="Apple"/>
-    <param pos="0" name="os.family" value="Mac OS X"/>
-    <param pos="0" name="os.product" value="Mac OS X"/>
-    <param pos="0" name="os.device" value="General"/>
-    <param pos="0" name="os.version" value="10.6"/>
-    <param pos="0" name="service.vendor" value="Samba"/>
-    <param pos="0" name="service.product" value="Samba"/>
-    <param pos="1" name="service.version"/>
-  </fingerprint>
-  <fingerprint pattern="^Samba (3\.0\.25b-apple)$">
-    <description>Samba on OS X 10.5</description>
-    <example service.version="3.0.25b-apple">Samba 3.0.25b-apple</example>
-    <param pos="0" name="os.vendor" value="Apple"/>
-    <param pos="0" name="os.family" value="Mac OS X"/>
-    <param pos="0" name="os.product" value="Mac OS X"/>
-    <param pos="0" name="os.device" value="General"/>
-    <param pos="0" name="os.version" value="10.5"/>
-    <param pos="0" name="service.vendor" value="Samba"/>
-    <param pos="0" name="service.product" value="Samba"/>
-    <param pos="1" name="service.version"/>
-  </fingerprint>
-  <!-- TODO: Detect vendor, distribution, and package versions -->
-  <fingerprint pattern="^Samba (\d\.\d+.\d+\w*)">
-    <description>Samba</description>
-    <example>Samba 3.0.24</example>
-    <example>Samba 3.0.28a</example>
-    <example>Samba 3.0.32-0.2-2210-SUSE-SL10.3</example>
-    <example>Samba 3.6.3</example>
-    <example>Samba 3.6.6</example>
-    <example>Samba 3.6.9-151.el6_4.1</example>
-    <param pos="0" name="service.vendor" value="Samba"/>
-    <param pos="0" name="service.product" value="Samba"/>
-    <param pos="1" name="service.version"/>
-  </fingerprint>
   <fingerprint pattern="^VxWorks">
     <description>VxWorks</description>
     <example>VxWorks</example>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recog
 version: !ruby/object:Gem::Version
-  version: 2.0.14
+  version: 2.0.15
 platform: ruby
 authors:
 - Rapid7 Research
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-23 00:00:00.000000000 Z
+date: 2015-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -197,6 +197,7 @@ files:
 - xml/rsh_resp.xml
 - xml/sip_banners.xml
 - xml/sip_user_agents.xml
+- xml/smb_native_lm.xml
 - xml/smb_native_os.xml
 - xml/smtp_banners.xml
 - xml/smtp_debug.xml