mirror of https://github.com/cve-search/cpe-guesser.git synced 2024-11-24 07:47:23 +00:00

Tool to guess CPE name based on common software name

Find a file

Olivier Ferrand 95cf01a949 Adding systemd & logrotate		2021-12-14 11:27:15 +01:00
bin	chg: [format] `black -S` on all files	2021-10-19 18:30:29 +02:00
data	chg: [import] remove obsolete import mechanism	2021-09-21 20:25:24 +03:00
etc	Adding systemd & logrotate	2021-12-14 11:27:15 +01:00
lib	chg: [format] `black -S` on all files	2021-10-19 18:30:29 +02:00
.gitignore	new: [dev] .gitignore added	2021-09-21 20:17:42 +03:00
LICENSE	chg: [LICENSE] added	2021-09-16 20:23:49 +02:00
README.md	chg: [lookup] use positional arguments for WORD(s)	2021-09-22 17:16:23 +03:00
REQUIREMENTS	new: [doc] REQUIREMENTS added	2021-09-20 22:11:10 +02:00

README.md

CPE guesser

CPE guesser is a command-line or web service to guess the CPE name based on one or more keyword(s). Then the result can be used against cve-search to do actual searches by CPE names.

Requirements

Redis
Python

Usage

To use CPE guesser, you have to initialise the Redis database with import.py. Then you can use the software with lookup.py to find the most probable CPE matching the keywords provided.

Installation

git clone https://github.com/cve-search/cpe-guesser.git
cd cpe-guesser/bin
Download the CPE dictionary & populate the database with python3 ./import.py.
Take a cup of black or green tea.
python3 cpe-guesser/bin/server.py to run the local HTTP server.

If you don't want to install it locally, there is a public online version. Check below.

Public online version

cpe-guesser.cve-search.org is public online version of CPE guesser which can be used via a simple API. The endpoint is /search and the JSON is composed of a query list with the list of keyword(s) to search for.

curl -s -X POST https://cpe-guesser.cve-search.org/search -d "{\"query\": [\"outlook\", \"connector\"]}" | jq .
[
  [
    18117,
    "cpe:2.3:a:microsoft:outlook_connector"
  ],
  [
    60947,
    "cpe:2.3:a:oracle:oracle_communications_unified_communications_suite_connector_for_microsoft_outlook"
  ],
  [
    68306,
    "cpe:2.3:a:oracle:corporate_time_outlook_connector"
  ]
]

Command line - `lookup.py`

usage: lookup.py [-h] WORD [WORD ...]

Find potential CPE names from a list of keyword(s) and return a JSON of the results

positional arguments:
  WORD        One or more keyword(s) to lookup

optional arguments:
  -h, --help  show this help message and exit

python3 lookup.py microsoft sql server | jq .
[
  [
    51325,
    "cpe:2.3:a:microsoft:sql_server_2017_reporting_services"
  ],
  [
    51326,
    "cpe:2.3:a:microsoft:sql_server_2019_reporting_services"
  ],
  [
    57898,
    "cpe:2.3:a:quest:intrust_knowledge_pack_for_microsoft_sql_server"
  ],
  [
    60386,
    "cpe:2.3:o:microsoft:sql_server"
  ],
  [
    60961,
    "cpe:2.3:a:microsoft:sql_server_desktop_engine"
  ],
  [
    64810,
    "cpe:2.3:a:microsoft:sql_server_reporting_services"
  ],
  [
    75858,
    "cpe:2.3:a:microsoft:sql_server_management_studio"
  ],
  [
    77570,
    "cpe:2.3:a:microsoft:sql_server"
  ],
  [
    78206,
    "cpe:2.3:a:ibm:tivoli_storage_manager_for_databases_data_protection_for_microsoft_sql_server"
  ]
]

How does this work?

A CPE entry is composed of a human readable name with some references and the structured CPE name.

  <cpe-item name="cpe:/a:10web:form_maker:1.7.17::~~~wordpress~~">
    <title xml:lang="en-US">10web Form Maker 1.7.17 for WordPress</title>
    <references>
      <reference href="https://wordpress.org/plugins/form-maker/#developers">Change Log</reference>
    </references>
    <cpe-23:cpe23-item name="cpe:2.3:a:10web:form_maker:1.7.17:*:*:*:*:wordpress:*:*"/>
  </cpe-item>

The CPE name is structured with a vendor name, a product name and some additional information. CPE name can be easily changed due to vendor name or product name changes, some vendor/product are sharing common names or name is composed of multiple words.

Data

Split vendor name and product name (such as _) into single word(s) and then canonize the word. Building an inverse index using the cpe vendor:product format as value and the canonized word as key. Then cpe guesser creates a ranked set with the most common cpe (vendor:product) per version to give a probability of the CPE appearance.

Redis structure

w:<word> set
s:<word> sorted set with a score depending of the number of appearance

License

Software is open source and released under a 2-Clause BSD License