Skip to main content

Python library and command-line utility for Vulners (https://vulners.com)

Project description

Vulners API v3 Python wrapper

Description

Python 2/3 library for the Vulners Database. It provides search, data retrieval, archive and vulnerability scanning API's for the integration purposes. With this library you can create powerful security tools and get access to the world largest security database.

Python version

Library was tested on a python2 and python3.

How to install

Package is available with PyPI

You can use pip for the installation

pip install -U vulners

Obtaining Vulners API key

Please, register at Vulners website. Go to the personal menu by clicking at your name at the right top corner. Follow "API KEYS" tab. Generate API key with scope "api" and use it with the library.

Functions and methods

All the callable methods are using Vulners REST API.

Search in database

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
heartbleed_related = vulners_api.search("heartbleed", limit=10)

Get information about document by identificator

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
CVE_2017_14174 = vulners_api.document("CVE-2017-14174")

Get information about multiple documents by identificators

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
CVE_DATA = vulners_api.documentList(["CVE-2017-14174", "CVE-2016-1175"])

Search for the public available exploits

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
wordpress_exploits = vulners_api.searchExploit("wordpress 4.7.0")

Get vulnerabilities and exploits by software name and version

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")

results = vulners_api.softwareVulnerabilities("httpd", "1.3")
exploit_list = results.get('exploit')
vulnerabilities_list = [results.get(key) for key in results if key not in ['info', 'blog', 'bugbounty']]

Get vulnerabilities by CPE product and version string

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")

cpe_results = vulners_api.cpeVulnerabilities("cpe:/a:cybozu:garoon:4.2.1")
cpe_exploit_list = cpe_results.get('exploit')
cpe_vulnerabilities_list = [cpe_results.get(key) for key in cpe_results if key not in ['info', 'blog', 'bugbounty']]

Get references for the vulnerability

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
references = vulners_api.references("CVE-2014-0160")

Get Windows KB superseeding and parentseeding information

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
# Superseeding information will be returned as dict
# with two fields: 'superseeds', 'parentseeds'.
# Superseeds means "what KB are covered by this KB".
# Parentseeds means "what KB are covering this KB".
superseeds = vulners_api.kbSuperseeds("KB4524135")

Get Windows KB updates list and download urls

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
microsoft_updates_for_kb = vulners_api.kbUpdates("KB4524135")
updates_download_links = [update.get('href') for update in microsoft_updates_for_kb]

Score any vulnerability description using Vulners AI

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
text_ai_score = vulners_api.aiScore("My cool vulnerability description")

Get possible query autocompletions

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
possible_autocomplete = vulners_api.autocomplete("heartbleed")

Download whole database collection and work with data locally

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
all_cve = vulners_api.archive("cve")

Audit Windows hosts for installed security KB

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")
win_vulners = vulners_api.kbAudit(os="Windows Server 2012 R2", kb_list=["KB4072650", "KB2959936", "KB2894856", "KB2896496"])
need_2_install_kb = win_vulners['kbMissed']
affected_cve = win_vulners['cvelist']

Audit Linux hosts for vulnerabilities (RPM/DEB based)

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")

# Example for CentOS 7
# You can use it for any RPM based OS
# Execute command: rpm -qa --qf '%{NAME}-%{VERSION}-%{RELEASE}.%{ARCH}\\n'
# Use it as package variable input

centos_vulnerabilities = vulners_api.audit(os= 'centos', os_version= '7', package= ['glibc-common-2.17-157.el7_3.5.x86_64'])
vulnerable_packages = centos_vulnerabilities.get('packages')
missed_patches_ids = centos_vulnerabilities.get('vulnerabilities')
cve_list = centos_vulnerabilities.get('cvelist')
how_to_fix = centos_vulnerabilities.get('cumulativeFix')

# Example for Debian 8
# You can use it for any DEB based OS
# Execute command: dpkg-query -W -f='${Package} ${Version} ${Architecture}\\n'
# Use it as package variable input

debian_vulnerabilities = vulners_api.audit(os= 'debian', os_version= '8', package= ['uno-libs3 4.3.3-2+deb8u7 amd64'])

Download Linux (RPM/DEB based) vulnerability assessment data for local processing

import vulners

vulners_api = vulners.Vulners(api_key="YOUR_API_KEY_HERE")

# Example for CentOS 7
centos_vulnerabilities_data = vulners_api.distributive("CentOS", "7")

Download web application vulnerability detection regex collection

import vulners

vulners_api = vulners.Vulners()

rules = vulners_api.rules()

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vulners-1.5.12.tar.gz (29.1 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

vulners-1.5.12-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

vulners-1.5.12-py2-none-any.whl (27.7 kB view details)

Uploaded Python 2

File details

Details for the file vulners-1.5.12.tar.gz.

File metadata

  • Download URL: vulners-1.5.12.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.10

File hashes

Hashes for vulners-1.5.12.tar.gz
Algorithm Hash digest
SHA256 de508bc6dd8031eb6f8b00f74f3d6197eb8cb86fe0353957284c17bc17b65f1a
MD5 6b2551cb1c4a8dca6fc5b4c1ab520978
BLAKE2b-256 7596c0a53e65ed2b779e546d681fc306c4d0d2b1e58a57012014a1933906d9f0

See more details on using hashes here.

File details

Details for the file vulners-1.5.12-py3-none-any.whl.

File metadata

  • Download URL: vulners-1.5.12-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.10

File hashes

Hashes for vulners-1.5.12-py3-none-any.whl
Algorithm Hash digest
SHA256 94a26ee69989d4a863408d4d5765ef4e3279d8f3ccc1f34bfb9c76c862cea138
MD5 5e11afa6417699f5f6e65dfce7b9e2fd
BLAKE2b-256 00210126765040f217512d56c95a9d17e850f85a8ddbe74c6d6e3d1200b4dac8

See more details on using hashes here.

File details

Details for the file vulners-1.5.12-py2-none-any.whl.

File metadata

  • Download URL: vulners-1.5.12-py2-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.22.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.56.2 CPython/3.8.10

File hashes

Hashes for vulners-1.5.12-py2-none-any.whl
Algorithm Hash digest
SHA256 ba5ffa05a9995995b307beb6faecbe627207269982b0e6d9081212269f8a2903
MD5 52b20b0456fddb67e8e1afe481c98d46
BLAKE2b-256 22eb739b039dd153448f5a1edda01bb0899f7403b12229aa1aed77df62b804cd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page