def check_latest_version():
"""Checks for the latest version available at PyPI."""
name: str = "cve-bin-tool"
url: str = f"https://pypi.org/pypi/{name}/json"
try:
with request.urlopen(url) as resp: # nosec - static url above
package_json = json.load(resp)
pypi_version = package_json["info"]["version"]
if pypi_version != VERSION:
LOGGER.info(
f"[bold red]You are running version {VERSION} of {name} but the latest PyPI Version is {pypi_version}.[/]",
extra={"markup": True},
)
if version.parse(VERSION) < version.parse(pypi_version):
LOGGER.info(
"[bold yellow]Alert: We recommend using the latest stable release.[/]",
extra={"markup": True},
)
except Exception as error:
LOGGER.warning(
textwrap.dedent(
f"""
-------------------------- Can't check for the latest version ---------------------------
warning: unable to access 'https://pypi.org/pypi/{name}'
Exception details: {error}
Please make sure you have a working internet connection or try again later.
"""
)
)
def check_latest_version():
"""Checks for the latest version available at PyPI."""
name = "cve-bin-tool"
url = f"https://pypi.org/pypi/{name}/json"
try:
with request.urlopen(url) as resp:
package_json = json.load(resp)
pypi_version = package_json["info"]["version"]
if pypi_version == VERSION:
LOGGER.info(
textwrap.dedent("""
*********************************************************
Yay! you are running the latest version.
But you can try the latest development version at GitHub.
URL: https://github.com/intel/cve-bin-tool
*********************************************************
"""))
else:
# TODO In future mark me with some color ( prefer yellow or red )
LOGGER.info(
f"You are running version {VERSION} of {name} but the latest PyPI Version is {pypi_version}."
)
if version.parse(VERSION) < version.parse(pypi_version):
LOGGER.info(
"Alert: We recommend using the latest stable release.")
except Exception as error:
LOGGER.warning(
textwrap.dedent(f"""
-------------------------- Can't check for the latest version ---------------------------
warning: unable to access 'https://pypi.org/pypi/{name}'
Exception details: {error}
Please make sure you have a working internet connection or try again later.
"""))
def find_vendor_product(self):
"""find vendor-product pairs from database"""
LOGGER.debug(
f"checking for product_name='{self.product_name}' and version_name='{self.version_number}' in the database"
)
CVEDB.db_open(self)
cursor = self.connection.cursor()
# finding out all distinct (vendor, product) pairs with the help of product_name
query = """
SELECT distinct vendor, product FROM cve_range
WHERE product=(:product);
"""
cursor.execute(query, {"product": self.product_name})
data = cursor.fetchall()
# checking if (vendor, product) was found in the database
if data:
# warning the user to select the vendor-product pairs manually if multiple pairs are found
if len(data) != 1:
LOGGER.warning(
textwrap.dedent(f"""
===============================================================
Multiple ("vendor", "product") pairs found for "{self.product_name}"
Please manually select the appropriate pair.
===============================================================
"""))
return data # [('vendor', 'product')]
else:
if self.product_name:
# removing numeric characters from the product_name
if any(char.isdigit() for char in self.product_name):
LOGGER.debug(
f"removing digits from product_name={self.product_name}"
)
self.product_name = "".join(
filter(lambda x: not x.isdigit(), self.product_name))
return self.find_vendor_product()
else:
# raise error and ask for product_name
LOGGER.warning(
textwrap.dedent(f"""
=================================================================
No match was found for "{self.product_name}" in database.
Please check your file or try specifying the "product_name" also.
=================================================================
"""))
return []
CVEDB.db_close(self)
def scan_and_or_extract_file(self, ectx, filepath):
""" Runs extraction if possible and desired otherwise scans."""
# Scan the file
yield from self.scan_file(filepath)
# Attempt to extract the file and scan the contents
if ectx.can_extract(filepath):
if not self.should_extract:
LOGGER.warning(
f"{filepath} is an archive. Pass -x option to auto-extract"
)
return None
for filename in self.walker([ectx.extract(filepath)]):
clean_path = self.clean_file_path(filename)
self.file_stack.append(f" contains {clean_path}")
yield from self.scan_and_or_extract_file(ectx, filename)
self.file_stack.pop()
def main(argv=None):
"""Scan a binary file for certain open source libraries that may have CVEs"""
argv = argv or sys.argv
# Reset logger level to info
LOGGER.setLevel(logging.INFO)
parser = argparse.ArgumentParser(
prog="cve-bin-tool",
description=textwrap.dedent("""
The CVE Binary Tool scans for a number of common, vulnerable open source
components (openssl, libpng, libxml2, expat and a few others) to let you know
if a given directory or binary file includes common libraries with known
vulnerabilities.
"""),
epilog=textwrap.fill(
f'Available checkers: {", ".join(VersionScanner.available_checkers())}'
) + "\n\nPlease disclose issues responsibly!",
formatter_class=argparse.RawDescriptionHelpFormatter,
)
input_group = parser.add_argument_group("Input")
input_group.add_argument("directory",
help="directory to scan",
nargs="?",
default=None)
input_group.add_argument(
"-e",
"--exclude",
action=StringToListAction,
help="Comma separated Exclude directory path",
default=None,
)
input_group.add_argument(
"-i",
"--input-file",
action="store",
default="",
help="provide input filename",
)
input_group.add_argument("-C",
"--config",
action="store",
default="",
help="provide config file")
output_group = parser.add_argument_group("Output")
output_group.add_argument("-q",
"--quiet",
action="store_true",
help="suppress output")
output_group.add_argument(
"-l",
"--log",
help="log level (default: info)",
dest="log_level",
action="store",
choices=["debug", "info", "warning", "error", "critical"],
)
output_group.add_argument(
"-o",
"--output-file",
action="store",
help="provide output filename (default: output to stdout)",
)
output_group.add_argument(
"--html-theme",
action="store",
help="provide custom theme directory for HTML Report",
)
output_group.add_argument(
"-f",
"--format",
action="store",
choices=["csv", "json", "console", "html", "pdf"],
help="update output format (default: console)",
)
output_group.add_argument(
"-c",
"--cvss",
action="store",
help=
"minimum CVSS score (as integer in range 0 to 10) to report (default: 0)",
)
output_group.add_argument(
"-S",
"--severity",
action="store",
choices=["low", "medium", "high", "critical"],
help="minimum CVE severity to report (default: low)",
)
parser.add_argument("-V", "--version", action="version", version=VERSION)
parser.add_argument(
"-u",
"--update",
action="store",
choices=["now", "daily", "never", "latest"],
help="update schedule for NVD database (default: daily)",
)
parser.add_argument(
"-x",
"--extract",
action="store_true",
help="autoextract compressed files",
)
parser.add_argument(
"--disable-version-check",
action="store_true",
help="skips checking for a new version",
)
checker_group = parser.add_argument_group("Checkers")
checker_group.add_argument(
"-s",
"--skips",
dest="skips",
action=StringToListAction,
type=str,
help="comma-separated list of checkers to disable",
)
checker_group.add_argument(
"-r",
"--runs",
dest="runs",
action=StringToListAction,
type=str,
help="comma-separated list of checkers to enable",
)
defaults = {
"directory": "",
"exclude": [],
"input_file": "",
"log_level": "info",
"format": "console",
"cvss": 0,
"severity": "low",
"update": "daily",
"extract": True,
"disable_version_check": False,
"skips": "",
"runs": "",
"quiet": False,
"output_file": "",
"html_theme": "",
}
with ErrorHandler(mode=ErrorMode.NoTrace):
raw_args = parser.parse_args(argv[1:])
args = {key: value for key, value in vars(raw_args).items() if value}
configs = {}
if args.get("config"):
conf = ConfigParser(args["config"])
configs = conf.parse_config()
args = ChainMap(args, configs, defaults)
# logging and error related settings
if args["log_level"]:
LOGGER.setLevel(args["log_level"].upper())
if args["quiet"]:
LOGGER.setLevel(logging.CRITICAL)
if 0 < LOGGER.level <= 10:
error_mode = ErrorMode.FullTrace
elif LOGGER.level >= 50:
error_mode = ErrorMode.NoTrace
else:
error_mode = ErrorMode.TruncTrace
if platform.system() != "Linux":
warning_nolinux = """
**********************************************
Warning: this utility was developed for Linux.
You may need to install additional utilities
to use it on other operating systems.
**********************************************
"""
LOGGER.warning(warning_nolinux)
# Database update related settings
# Connect to the database
cvedb_orig = CVEDB(version_check=not args["disable_version_check"],
error_mode=error_mode)
# if OLD_CACHE_DIR (from cvedb.py) exists, print warning
if os.path.exists(OLD_CACHE_DIR):
LOGGER.warning(
f"Obsolete cache dir {OLD_CACHE_DIR} is no longer needed and can be removed."
)
# Clear data if -u now is set
if args["update"] == "now":
cvedb_orig.clear_cached_data()
if args["update"] == "latest":
cvedb_orig.refresh_cache_and_update_db()
# update db if needed
if args["update"] != "never":
cvedb_orig.get_cvelist_if_stale()
else:
LOGGER.warning("Not verifying CVE DB cache")
if not cvedb_orig.nvd_years():
with ErrorHandler(mode=error_mode, logger=LOGGER):
raise EmptyCache(cvedb_orig.cachedir)
# CVE Database validation
if not cvedb_orig.check_cve_entries():
with ErrorHandler(mode=error_mode, logger=LOGGER):
raise CVEDataMissing("No data in CVE Database")
# Input validation
if not args["directory"] and not args["input_file"]:
parser.print_usage()
with ErrorHandler(logger=LOGGER, mode=ErrorMode.NoTrace):
raise InsufficientArgs(
"Please specify a directory to scan or an input file required")
if args["directory"] and not os.path.exists(args["directory"]):
parser.print_usage()
with ErrorHandler(logger=LOGGER, mode=ErrorMode.NoTrace):
raise FileNotFoundError("Directory/File doesn't exist")
# Checkers related settings
skips = args["skips"]
if args["runs"]:
runs = args["runs"]
skips = list(
map(
lambda checker: checker.name,
filter(
lambda checker: checker.name not in runs,
pkg_resources.iter_entry_points("cve_bin_tool.checker"),
),
))
# CSVScanner related settings
score = 0
if args["severity"]:
# Set minimum CVSS score based on severity
cvss_score = {"low": 0, "medium": 4, "high": 7, "critical": 9}
score = cvss_score[args["severity"]]
if int(args["cvss"]) > 0:
score = int(args["cvss"])
with CVEScanner(score=score) as cve_scanner:
triage_data: TriageData
total_files: int = 0
parsed_data: Dict[ProductInfo, TriageData] = {}
if args["input_file"]:
input_engine = InputEngine(args["input_file"],
logger=LOGGER,
error_mode=error_mode)
parsed_data = input_engine.parse_input()
if not args["directory"]:
for product_info, triage_data in parsed_data.items():
LOGGER.warning(f"{product_info}, {triage_data}")
cve_scanner.get_cves(product_info, triage_data)
if args["directory"]:
version_scanner = VersionScanner(
should_extract=args["extract"],
exclude_folders=args["exclude"],
error_mode=error_mode,
)
version_scanner.remove_skiplist(skips)
version_scanner.print_checkers()
for scan_info in version_scanner.recursive_scan(args["directory"]):
if scan_info:
product_info, path = scan_info
LOGGER.debug(f"{product_info}: {path}")
triage_data = parsed_data.get(product_info,
{"default": {}})
# Ignore paths from triage_data if we are scanning directory
triage_data["paths"] = {path}
cve_scanner.get_cves(product_info, triage_data)
total_files = version_scanner.total_scanned_files
LOGGER.info("")
LOGGER.info("Overall CVE summary: ")
if args["input_file"]:
LOGGER.info(
f"There are {cve_scanner.products_with_cve} products with known CVEs detected"
)
else:
LOGGER.info(
f"There are {cve_scanner.products_with_cve} files with known CVEs detected"
)
if cve_scanner.products_with_cve > 0 or (args["format"] == "html"
or args["format"] == "pdf"):
affected_string = ", ".join(
map(
lambda product_version: "".join(str(product_version)),
cve_scanner.affected(),
))
LOGGER.info(f"Known CVEs in {affected_string}:")
# Creates a Object for OutputEngine
output = OutputEngine(
all_cve_data=cve_scanner.all_cve_data,
scanned_dir=args["directory"],
filename=args["output_file"],
themes_dir=args["html_theme"],
products_with_cve=cve_scanner.products_with_cve,
products_without_cve=cve_scanner.products_without_cve,
total_files=total_files,
)
if not args["quiet"]:
output.output_file(args["format"])
# Use the number of products with known cves as error code
# as requested by folk planning to automate use of this script.
# If no cves found, then the program exits cleanly.
return cve_scanner.products_with_cve
def parse_list(self):
input_file = self.input_file
self.check_file()
if not input_file.endswith("requirements.txt"):
if distro.id() not in SUPPORTED_DISTROS:
LOGGER.warning(
f"Package list support only available on {','.join(SUPPORTED_DISTROS)}!"
)
return {}
system_packages = []
LOGGER.info(f"Scanning {distro.id().capitalize()} package list.")
if distro.id() in DEB_DISTROS:
installed_packages = run(
[
"dpkg-query",
"--show",
'--showformat={"name": "${binary:Package}", "version": "${Version}"}, ',
],
stdout=PIPE,
)
installed_packages = json.loads(
f"[{installed_packages.stdout.decode('utf-8')[0:-2]}]")
elif distro.id() in RPM_DISTROS:
installed_packages = run(
[
"rpm",
"--query",
"--all",
"--queryformat",
'{"name": "%{NAME}", "version": "%{VERSION}"\\}, ',
],
stdout=PIPE,
)
installed_packages = json.loads(
f"[{installed_packages.stdout.decode('utf-8')[0:-2]}]")
elif distro.id() in PACMAN_DISTROS:
installed_packages = []
installed_packages_output = run(
["pacman", "--query", "--explicit"],
stdout=PIPE,
)
installed_packages_output = installed_packages_output.stdout.decode(
"utf-8").splitlines()
dict_keys = ["name", "version"]
for installed_package in installed_packages_output:
package_details = installed_package.split(" ")
installed_package_dict = dict(
zip(dict_keys, package_details))
installed_packages.append(installed_package_dict)
with open(input_file) as req:
lines = req.readlines()
for line in lines:
system_packages.append(re.split("\n", line)[0])
for installed_package in installed_packages:
if installed_package["name"] in system_packages:
self.package_names_without_vendor.append(installed_package)
else:
LOGGER.info("Scanning python package list.")
txt_package_names = []
installed_packages_json = run(
["pip", "list", "--format", "json"],
stdout=PIPE,
)
installed_packages = json.loads(
installed_packages_json.stdout.decode("utf-8"))
with open(input_file) as txtfile:
lines = txtfile.readlines()
for line in lines:
txt_package_names.append(re.split(">|\\[|;|=|\n", line)[0])
for installed_package in installed_packages:
package_name = installed_package["name"].lower()
if package_name in txt_package_names:
self.package_names_without_vendor.append(
installed_package)
cve_db = CVEDB()
vendor_package_pairs = cve_db.get_vendor_product_pairs(
self.package_names_without_vendor)
self.add_vendor(vendor_package_pairs)
self.parse_data()
return self.parsed_data_with_vendor
def check_file(self):
input_file = self.input_file
error_mode = self.error_mode
if not isfile(input_file):
with ErrorHandler(mode=error_mode):
raise FileNotFoundError(input_file)
if getsize(input_file) == 0:
with ErrorHandler(mode=error_mode):
raise EmptyTxtError(input_file)
if not input_file.endswith(".txt"):
with ErrorHandler(mode=error_mode):
raise InvalidListError(
"Invalid Package list file format (should be .txt)")
if not input_file.endswith("requirements.txt"):
if distro.id() not in SUPPORTED_DISTROS:
LOGGER.warning(
f"Package list support only available for {','.join(SUPPORTED_DISTROS)}!"
)
with ErrorHandler(mode=error_mode):
raise InvalidListError(
f"{distro.id().capitalize()} is not supported")
elif distro.id() in DEB_DISTROS:
# Simulate installation on Debian based system using apt-get to check if the file is valid
output = run(
["xargs", "-a", input_file, "apt-get", "install", "-s"],
capture_output=True,
)
if output.returncode != 0:
invalid_packages = re.findall(
r"E: Unable to locate package (.+)",
output.stderr.decode("utf-8"),
)
LOGGER.warning(
f"Invalid Package found: {','.join(invalid_packages)}")
elif distro.id() in RPM_DISTROS:
output = run(
["xargs", "-a", input_file, "rpm", "-qi"],
capture_output=True,
)
not_installed_packages = re.findall(
r"package (.+) is not installed",
output.stdout.decode("utf-8"))
if not_installed_packages:
LOGGER.warning(
f"The packages {','.join(not_installed_packages)} seems to be not installed.\nIt is either an invalid package or not installed.\nUse `sudo yum install $(cat package-list)` to install all packages"
)
elif distro.id() in PACMAN_DISTROS:
output = run(
["xargs", "-a", input_file, "pacman", "-Qk"],
capture_output=True,
)
not_installed_packages = re.findall(
r"error: package '(.+)' was not found",
output.stderr.decode("utf-8"),
)
if not_installed_packages:
LOGGER.warning(
f"The packages {','.join(not_installed_packages)} seems to be not installed.\nIt is either an invalid package or not installed.\nUse `sudo pacman -S $(cat package-list)` to install all packages"
)
else:
# TODO: Replace below error handling with a proper pip install dry run
# See: https://github.com/pypa/pip/issues/53
with ErrorHandler(mode=error_mode):
raise InvalidListError("Invalid Package list")
