recog 2.3.5 → 2.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa45c67f4a225e53c7652e9175945a943b73245c9552e50dbe8ba0681ec07722
-  data.tar.gz: 80c8391cdb963c981cd3ebd170f2899a756811dbe1f92e4ac9542e2ed941e9c1
+  metadata.gz: 882d241ba5d8115e818c1f3a9373171d502cc4cd1b0d9069a41bd9383aabf90a
+  data.tar.gz: d90114dc975f4ae473af3958ba30cfe1d14953299a9585726a6b1d834e6c2091
 SHA512:
-  metadata.gz: cb5fbebf168eb99e8d83ceb5e3793e9a708f44a452478b23016aaeaed6da7b30e696a508f87052654a4dea7a90549e6b23c6b3b73343d3a98f7025cdc3b28c24
-  data.tar.gz: a794f4f31c037afdbacf9bbbf0c137cc89e3ffa4a451d8ca75005b5f907d0ad282a98a8af0a73403be8ac574c1fd3054edf6f6a819655aac0b6728d7adb84a53
+  metadata.gz: c98f1e8fc087478c4ac5cc2a6512059976ff8bb99bd83c5f7098856888e31af4f9e8a3643a18a091fa4676df9da83314aee24ef01b0367a381ebee7077aa2fdd
+  data.tar.gz: 01034d8c3ca39855af88582e1027ce6f2bd2f60b312d06e9a11f81b8e3ed896801d0e40e09a18a37e57df1adb58dfb0125bcca74bea26443e9b068fd6b60f7d7

data/.gitignore

@@ -1,11 +1,23 @@
+# Ruby and tooling specific
 .yardoc
 coverage/
 doc/
 pkg/
-.idea/
-.vscode/
+
 /Gemfile.lock
 
-# ignore rvm files
-.ruby-version
-.ruby-gemset
+#Python specific
+venv
+
+# IDE specific
+.vscode/
+.idea
+
+# Misc
+**/.DS_Store
+
+# CPE XML
+official-cpe-dictionary*.xml
+
+# CPE Remap Errors
+errors.txt

data/.ruby-gemset

@@ -0,0 +1 @@
+recog

data/.ruby-version

@@ -0,0 +1 @@
+2.6.6

data/.travis.yml

@@ -2,11 +2,14 @@ language: ruby
 sudo: false
 cache: bundler
 rvm:
-  - '2.3.8'
-  - '2.4.5'
-  - '2.5.3'
-  - '2.6.1'
+  - '2.5.8'
+  - '2.6.6'
   - 'jruby-9.1.9.0'
+jdk:
+  - openjdk8
+matrix:
+  allow_failures:
+    - rvm: 'jruby-9.1.9.0'
 before_install:
   - "echo 'gem: --no-ri --no-rdoc' > ~/.gemrc"
   - rake --version

data/CONTRIBUTING.md

@@ -3,9 +3,24 @@
 The users and maintainers of Recog would greatly appreciate any contributions
 you can make to the project.  These contributions typically come in the form of
 filed bugs/issues or pull requests (PRs).  These contributions routinely result
-in new versions of the [recog gem](https://rubygems.org/gems/recog) to be
+in new versions of the [recog gem](https://rubygems.org/gems/recog) being
 released.  The process for everything is described below.
 
+## Table of Contents
+
+1. [Contributing Issues / Bug Reports](#contributing-issues-/-bug-reports)
+1. [Contributing Code](#contributing-code)
+    1. [Fork and Clone](#fork-and-clone)
+    1. [Branch and Improve](#branch-and-improve)
+    1. [Testing](#testing)
+1. [Fingerprints](#fingerprints)
+    1. [Best Practices](#best-practices)
+    1. [Fingerprint Testing](#fingerprint-testing)
+    1. [Updating CPEs](#updating-cpes)
+1. [Project Operations](#project-operations)
+    1. [Landing PRs](#landing-prs)
+    1. [Releasing New Versions](#releasing-new-versions)
+
 ## Contributing Issues / Bug Reports
 
 If you encounter any bugs or problems with Recog, please file them
@@ -14,6 +29,8 @@ possible.  If the bug is straight-forward enough and you understand the fix for
 the bug well enough, you may take the simpler, less-paperwork route and simply
 fill a PR with the fix and the necessary details.
 
+[^back to top](#contributing-to-recog)
+
 ## Contributing Code
 
 Recog uses a model nearly identical to that of
@@ -26,33 +43,39 @@ this document.
 
 On the other hand, if you haven't, read on!
 
+[^back to top](#contributing-to-recog)
+
 ### Fork and Clone
 
 Generally, this should only need to be done once, or if you need to start over.
 
 1. Fork Recog: Visit https://github.com/rapid7/recog and click Fork,
    selecting your github account if prompted
-2.  Clone ```git@github.com:<your-github-username>/recog.git```, replacing
-```<your-github-username>``` with, you guessed it, your Github username.
-3.  Add the master Recog repository as your upstream:
-
- ```
-   git remote add upstream git://github.com/rapid7/recog.git
- ```
-4. Update your `.git/config` to ensure that the `remote ["upstream"]` section is configured to pull both branches and PRs from upstream.  It should look something like the following, in particular the second `fetch` option:
+1. Clone `git@github.com:<your-github-username>/recog.git`, replacing
+`<your-github-username>` with, you guessed it, your Github username.
+1. Add the master Recog repository as your upstream:
 
+     ```bash
+    git remote add upstream git://github.com/rapid7/recog.git
     ```
+
+1. Update your `.git/config` to ensure that the `remote ["upstream"]` section is configured to pull both branches and PRs from upstream.  It should look something like the following, in particular the second `fetch` option:
+
+    ```bash
      [remote "upstream"]
       url = git@github.com:rapid7/recog.git
       fetch = +refs/heads/*:refs/remotes/upstream/*
       fetch = +refs/pull/*/head:refs/remotes/upstream/pr/*
      ```
-5. Fetch the latest revisions, including PRs:
 
-    ```
+1. Fetch the latest revisions, including PRs:
+
+    ```bash
     git fetch --all
     ```
 
+[^back to top](#contributing-to-recog)
+
 ### Branch and Improve
 
 If you have a contribution to make, first create a branch to contain your
@@ -60,7 +83,7 @@ work.  The name is yours to choose, however generally it should roughly
 describe what you are doing.  In this example, and from here on out, the
 branch will be FOO, but you should obviously change this:
 
-```
+```bash
 git fetch --all
 git checkout master
 git rebase upstream/master
@@ -73,17 +96,66 @@ Please note that changes to [lib/recog/version.rb](https://github.com/rapid7/rec
 
 Now push your changes to your fork:
 
-```
+```bash
 git push origin FOO
 ```
 
 Finally, submit the PR.  Navigate to ```https://github.com/<your-github-username>/recog/compare/FOO```, fill in the details and submit.
 
+[^back to top](#contributing-to-recog)
+
 ### Testing
 
 When your PR is submitted, it will be automatically subjected to the full run of tests in [Travis](https://travis-ci.org/rapid7/recog/), however you are encourage to perform testing _before_ submitting the PR.  To do this, simply run `rake tests`.
 
-## Updating CPEs
+[^back to top](#contributing-to-recog)
+
+## Fingerprints
+
+### Best Practices
+
+* Create a single fingerprint for each product as long as the pattern remains clear and readable. If that is not possible, the pattern should be logically decomposed into additional fingerprints.
+
+* Create regular expressions that allow for flexible version number matching. This ensures greater probability of matching a product. For example, all known public releases of a product report either `major.minor` or `major.minor.build` format version numbers. If the fingerprint strictly matches this version number format, it would fail to match a modified build of the product that reports only a `major` version number format.
+
+[^back to top](#contributing-to-recog)
+
+### Fingerprint Testing
+
+Once a fingerprint has been added, the `example` entries can be tested by executing `bin/recog_verify` against the fingerprint file:
+
+```shell
+bin/recog_verify xml/ssh_banners.xml
+```
+
+Matches can be tested on the command-line in a similar fashion:
+
+```shell
+$ echo 'OpenSSH_6.6p1 Ubuntu-2ubuntu1' | bin/recog_match xml/ssh_banners.xml -
+MATCH: {"matched"=>"OpenSSH running on Ubuntu 14.04", "service.version"=>"6.6p1", "openssh.comment"=>"Ubuntu-2ubuntu1", "service.vendor"=>"OpenBSD", "service.family"=>"OpenSSH", "service.product"=>"OpenSSH", "os.vendor"=>"Ubuntu", "os.device"=>"General", "os.family"=>"Linux", "os.product"=>"Linux", "os.version"=>"14.04", "service.protocol"=>"ssh", "fingerprint_db"=>"ssh.banner", "data"=>"OpenSSH_6.6p1 Ubuntu-2ubuntu1"}
+```
+
+[^back to top](#contributing-to-recog)
+
+
+### Standardizing Vendors, Products, and Services
+
+Given the number of fingerprints in Recog, it can be common for specific products, vendors, or services to be identified with different spellings and casing.
+To limit the creep of slightly-different-names, the `bin/recog_standardize` script can be used to extract all identifiers and merge them into the known lists.
+
+To get started, run the `recog_standardize` tool:
+```shell
+ruby bin/recog_standardize
+```
+
+Review any new additions to the text files under `identifiers/`. If any of these names are close to an existing name, update the offending fingerprint to use
+the existing name instead. Once the fingerprints are fixed, removed the "extra" names from the identifiers files, and run the tool again.
+
+
+[^back to top](#contributing-to-recog)
+
+
+### Updating CPEs
 
 There exists some automation to update the CPEs that might be asserted with
 some recog fingerprints.  This should be run periodically to ensure that all
@@ -91,30 +163,47 @@ fingerprints that could have CPEs do, etc.
 
 First, setup a python3 venv:
 
-  ```
+  ```bash
   python3 -m venv venv
-  source venv/bin/activate
+  source venv/{bin,Scripts}/activate
   pip install -r requirements.txt
   ```
 
 Download the latest CPE 2.3 dictionary:
 
-  ```
-  wget https://nvd.nist.gov/feeds/xml/cpe/dictionary/official-cpe-dictionary_v2.3.xml.gz
-  ````
+```bash
+curl -o official-cpe-dictionary_v2.3.xml.gz https://nvd.nist.gov/feeds/xml/cpe/dictionary/official-cpe-dictionary_v2.3.xml.gz && \
+gunzip official-cpe-dictionary_v2.3.xml.gz
+```
 
-Run the CPE automation against every XML file, using GNU `parallel` to speed things up:
+Run the CPE automation against every XML file:
 
-  ```
-  ls xml/*.xml | parallel --gnu "./update_cpes.py {} official-cpe-dictionary_v2.3.xml cpe-remap.yaml && xmllint --format --noblanks {} > {}.bak &&  mv {}.bak {} || echo {}" 2> errors.txt
-  ```
+```bash
+# Update the CPEs (sequentially)
+ls xml/*.xml | xargs -i python update_cpes.py {} official-cpe-dictionary_v2.3.xml cpe-remap.yaml 2>>errors.txt
+```
+
+You may want to use GNU `parallel` to speed things up:
+```bash
+# Update the CPEs (with GNU Parallel)
+ls xml/*.xml | parallel --gnu "python update_cpes.py {} official-cpe-dictionary_v2.3.xml cpe-remap.yaml"  2>>errors.txt
+```
+
+Clean up the whitespace across all fingerprints:
+```bash
+ruby bin/recog_cleanup
+```
 
 Any mismatched fingerprints will be listed in `errors.txt` for eventual
 maintenance.  The `cpe-remap.yaml` file can be used to map between
 vendor/product/etc differences between Recog and CPE, or to work around bugs in
 either.
 
-## Landing PRs
+[^back to top](#contributing-to-recog)
+
+## Project Operations
+
+### Landing PRs
 
 (Note: this portion is a work-in-progress.  Please update it as things change)
 
@@ -126,46 +215,56 @@ In short:
 1. Follow the "Fork and Clone" steps from above
 2. Update your `.git/config` to ensure that the `remote ["upstream"]` section is configured to pull both branches and PRs from upstream.  It should look something like the following, in particular the second `fetch` option:
 
-    ```
+    ```bash
      [remote "upstream"]
       url = git@github.com:rapid7/recog.git
       fetch = +refs/heads/*:refs/remotes/upstream/*
       fetch = +refs/pull/*/head:refs/remotes/upstream/pr/*
      ```
+
 3. Fetch the latest revisions, including PRs:
 
-    ```
+    ```bash
     git fetch --all
     ```
+
 4. Checkout and branch the PR for testing.  Replace ```PR``` below with the actual PR # in question:
 
-    ```
+    ```bash
     git checkout -b landing-PR upstream/pr/PR
     ```
+
 5. Test the PR (see the Testing section above)
 6. Merge with master, re-test, validate and push:
 
-    ```
+    ```bash
     git checkout -b upstream-master --track upstream/master
     git merge -S --no-ff --edit landing-PR # merge the PR into upstream-master
+
     # re-test if/as necessary
     git push upstream upstream-master:master --dry-run # confirm you are pushing what you expect
+
     git push upstream upstream-master:master # push upstream-master to upstream:master
     ```
+
 7. If applicable, release a new version (see next section)
 
-## Releasing New Versions
+[^back to top](#contributing-to-recog)
+
+### Releasing New Versions
 
 When Recog's critical parts are modified, for example its fingerprints or underlying supporting code, a new version _must_ eventually be released.  These new releases can then be optionally included in projects such as Metasploit or products such as Rapid7's Nexpose in a controlled manner.  Releases for non-functional updates such as updates to documentation are not necessary.
 
 When a new version of Recog is to be released, you _must_ follow the instructions below.
 
 1. If are not already a Recog project contributor for the Recog gem (you'd be listed [here under OWNERS](https://rubygems.org/gems/recog)), become one:
-  1. Get an account on [Rubygems](https://rubygems.org)
-  2. Contact one of the Recog project contributors (listed [here under OWNERS](https://rubygems.org/gems/recog) and have them add you to the Recog gem.  They'll need to run:
-    ```
-      gem owner recog -a EMAIL
-    ```
-2. Edit [lib/recog/version.rb](https://github.com/rapid7/recog/blob/master/lib/recog/version.rb) and increment ```VERSION```.  Commit and push to rapid7/recog master.
-3. Run `rake release`.  Among other things, this creates the new gem, uploads it to Rubygems and tags the release with a tag like `v<VERSION>`, where `<VERSION>` is replaced with the version from `version.rb`.  For example, if you release version 1.2.3 of the gem, the tag will be `v1.2.3`.
-4. If your default remote repository is not `rapid7/recog`, you must ensure that the tags created in the previous step are also pushed to the right location(s).  For example, if `origin` is your fork of recog and `upstream` is `rapid7/master`, you should run `git push --tags --dry-run upstream` to confirm what tags will be pushed and then `git push --tags upstream` to push the tags.
+   1. Get an account on [Rubygems](https://rubygems.org)
+   1. Contact one of the Recog project contributors (listed [here under OWNERS](https://rubygems.org/gems/recog) and have them add you to the Recog gem.  They'll need to run: `gem owner recog -a EMAIL`
+
+1. Edit [lib/recog/version.rb](https://github.com/rapid7/recog/blob/master/lib/recog/version.rb) and increment `VERSION`.  Commit and push to rapid7/recog master.
+
+1. Run `rake release`.  Among other things, this creates the new gem, uploads it to Rubygems and tags the release with a tag like `v<VERSION>`, where `<VERSION>` is replaced with the version from `version.rb`.  For example, if you release version 1.2.3 of the gem, the tag will be `v1.2.3`.
+
+1. If your default remote repository is not `rapid7/recog`, you must ensure that the tags created in the previous step are also pushed to the right location(s).  For example, if `origin` is your fork of recog and `upstream` is `rapid7/master`, you should run `git push --tags --dry-run upstream` to confirm what tags will be pushed and then `git push --tags upstream` to push the tags.
+
+[^back to top](#contributing-to-recog)

data/Gemfile

@@ -1,13 +1,10 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec name: 'recog'
 
 gem 'nokogiri'
 
 group :test do
   gem 'rake'
-  gem 'rspec', '>= 2.99'
-  gem 'cucumber', '~> 1.3.8'
-  gem 'aruba', '~> 0.5.3'
-  gem 'regexp_parser', '~> 0.2.0'
+  gem 'regexp_parser'
 end

data/README.md

@@ -1,30 +1,45 @@
-Recog: A Recognition Framework
-=====
-
-Recog is a framework for identifying products, services, operating systems, and hardware by matching fingerprints against data returned from various network probes. Recog makes it simple to extract useful information from web server banners, snmp system description fields, and a whole lot more. Recog is open source, please see the [LICENSE](https://raw.githubusercontent.com/rapid7/recog/master/LICENSE) file for more information.
+# Recog: A Recognition Framework
 
 [![Gem Version](https://badge.fury.io/rb/recog.svg)](http://badge.fury.io/rb/recog)
 [![Build Status](https://travis-ci.org/rapid7/recog.svg?branch=master)](https://travis-ci.org/rapid7/recog)
 
+
+Recog is a framework for identifying products, services, operating systems, and hardware by matching fingerprints against data returned from various network probes. Recog makes it simple to extract useful information from web server banners, snmp system description fields, and a whole lot more.
+
+Recog is open source, please see the [LICENSE](https://raw.githubusercontent.com/rapid7/recog/master/LICENSE) file for more information.
+
+## Table of Contents
+
+1. [Installation](#installation)
+1. [Maturity](#maturity)
+1. [Fingerprints](#fingerprints)
+1. [Contributing](#contributing)
+
 ## Installation
 
-Recog consists of both XML fingerprint files and an assortment of code, mostly in Ruby, that makes it easy to develop, test, and use the contained fingerprints. In order to use the included ruby code, a recent version of Ruby (2.1+) is required, along with Rubygems and the `bundler` gem. Once these dependencies are in place, use the following commands to grab the latest source code and install any additional dependencies.
+Recog consists of both XML fingerprint files and an assortment of code, mostly in Ruby, that makes it easy to develop, test, and use the contained fingerprints. In order to use the included ruby code, a recent version of Ruby (2.31+) is required, along with Rubygems and the `bundler` gem. Once these dependencies are in place, use the following commands to grab the latest source code and install any additional dependencies.
+
+```shell
+$ git clone git@github.com:rapid7/recog.git
+$ cd recog
+$ bundle install
+```
 
-    $ git clone git@github.com:rapid7/recog.git
-    $ cd recog
-    $ bundle install
+[^back to top](#recog-a-recognition-framework)
 
 ## Maturity
 
 Please note that while the XML fingerprints themselves are quite stable and well-tested, the Ruby codebase in Recog is still fairly new and subject to change quickly. Please contact us (research[at]rapid7.com) before leveraging the Recog code within any production projects.
 
+[^back to top](#recog-a-recognition-framework)
+
 ## Fingerprints
 
 The fingerprints within Recog are stored in XML files, each of which is designed to match a specific protocol response string or field. For example, the file [ssh_banners.xml](https://github.com/rapid7/recog/blob/master/xml/ssh_banners.xml) can determine the os, vendor, and sometimes hardware product by matching the initial SSH daemon banner string.
 
 A fingerprint file consists of an XML document like the following:
 
-```
+```xml
 <fingerprints matches="ssh.banner">
   <fingerprint pattern="^RomSShell_([\d\.]+)$">
     <description>Allegro RomSShell SSH</description>
@@ -36,15 +51,15 @@ A fingerprint file consists of an XML document like the following:
 </fingerprints>
 ```
 
-The first line should always consist of the XML version declaration. The first element should always be a `fingerpints` block with a `matches` attribute indicating what data this fingerprint file is supposed to match. The `matches` attribute is normally in the form of `protocol.field`.
+The first line should always consist of the XML version declaration. The first element should always be a `fingerprints` block with a `matches` attribute indicating what data this fingerprint file is supposed to match. The `matches` attribute is normally in the form of `protocol.field`.
 
 Inside of the `fingerprints` element there should be one or more `fingerprint` elements. Every `fingerprint` must contain a `pattern` attribute, which contains the regular expression to be used to match against the data.  An optional `flags` attribute can be specified to control how the regular expression is to be interpreted.  See [the Recog documentation for `FLAG_MAP`](http://www.rubydoc.info/gems/recog/Recog/Fingerprint/RegexpFactory#FLAG_MAP-constant) for more information.
 
 Inside of the fingerprint, a `description` element should contain a human-readable string describing this fingerprint.
 
-At least one `example` element should be present, however multiple `example` elements are preferred.  These elements are used as part of the test coverage present in rspec which validates that the provided data matches the specified regular expression.  Additionally, if the fingerprint is using the `param` elements to extract field values from the data (described next), you can add these expected extractions as attributes for the `example` elements.  In the example above, this:
+At least one `example` element should be present, however multiple `example` elements are preferred.  These elements are used as part of the test coverage present in `rspec` which validates that the provided data matches the specified regular expression.  Additionally, if the fingerprint is using the `param` elements to extract field values from the data (described next), you can add these expected extractions as attributes for the `example` elements.  In the example above, this:
 
-```
+```xml
 <example service.version="4.62">RomSShell_4.62</example>
 ```
 
@@ -54,29 +69,19 @@ The `param` elements contain a `pos` attribute, which indicates what capture fie
 
 The `example` string can be base64 encoded to permit the use of unprintable characters.  To signal this to Recog an `_encoding` attribute with the value of `base64` is added to the `example` element.  Based64 encoded text that is longer than 80 characters may be wrapped with newlines as shown below to aid in readability.
 
-````
+````xml
 <example _encoding="base64">
   dGllczGEAAAAlQQWMS4yLjg0MC4xMTM1NTYuMS40LjgwMAQuZGF0YS5yZW1vdmVkLjCEAAAAK
   AQdZG9tYWluQ29udHJvbGxlckZ1bmN0aW9uYWxpdHkxhAAAAAMEATc=
 </example>
 ````
 
-### Testing
-
-Once a fingerprint has been added, the `example` entries can be tested by executing `bin/recog_verify` against the fingerprint file:
+[^back to top](#recog-a-recognition-framework)
 
-```
-    $ bin/recog_verify xml/ssh_banners.xml
-```
-
-Matches can be tested on the command-line in a similar fashion:
-
-```
-    $ echo 'OpenSSH_6.6p1 Ubuntu-2ubuntu1' | bin/recog_match xml/ssh_banners.xml -
-    MATCH: {"matched"=>"OpenSSH running on Ubuntu 14.04", "service.version"=>"6.6p1", "openssh.comment"=>"Ubuntu-2ubuntu1", "service.vendor"=>"OpenBSD", "service.family"=>"OpenSSH", "service.product"=>"OpenSSH", "os.vendor"=>"Ubuntu", "os.device"=>"General", "os.family"=>"Linux", "os.product"=>"Linux", "os.version"=>"14.04", "service.protocol"=>"ssh", "fingerprint_db"=>"ssh.banner", "data"=>"OpenSSH_6.6p1 Ubuntu-2ubuntu1"}
-```
+## Contributing
 
-### Best Practices
+The users and maintainers of Recog would greatly appreciate any contributions
+you can make to the project. For guidelines and instructions please see
+[CONTRIBUTING.MD](CONTRIBUTING.md)
 
-* Create a single fingerprint for each product as long as the pattern remains clear and readable. If that is not possible, the pattern should be logically decomposed into additional fingerprints.
-* Create regular expressions that allow for flexible version number matching. This ensures greater probability of matching a product. For example, all known public releases of a product report either `major.minor` or `major.minor.build` format version numbers. If the fingerprint strictly matches this version number format, it would fail to match a modified build of the product that reports only a `major` version number format.
+[^back to top](#recog-a-recognition-framework)