Skip to main content

Provides access to the vulndb information

Project description

Python SDK to access the vulnerability database

Build Status

Installation

It’s possible to install the latest stable release from pypi:

pip install vulndb

Or if you’re interested in the latest version from our repository:

git clone https://github.com/vulndb/python-sdk.git
python setup.py install

Usage

>>> from vulndb import DBVuln
>>> dbv = DBVuln.from_id(42)
>>> dbv.title
'SQL Injection'
>>> dbv.description
'A long and actionable description for SQL injection ...'
>>> dbv.fix_guidance
'Explains the developer how to fix SQL injections, usually a couple of <p> long ...'
>>> dbv.severity
'high'
>>> r = dbv.references[0]
>>> r.url
'http://example.com/sqli-description.html'
>>> r.title
'SQL injection cheat-sheet'

More attributes, methods and helpers are well documented and available in the source code.

Contributing

Send your pull requests with improvements and bug fixes, making sure that all tests PASS:

$ cd python-sdk
$ virtualenv venv
$ . venv/bin/activate
$ pip install -r vulndb/requirements-dev.txt
$ nosetests vulndb/
..........
----------------------------------------------------------------------
Ran 10 tests in 0.355s

OK

Updating the database

This package embeds the vulnerability database in the vulndb/db/ directory. To update the database with new information follow these steps:

# Update the database
. tools/update-db.sh

After updating the database it’s a good idea to publish the latest at pypi using:

python setup.py sdist upload

Project details


Download files

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

Source Distribution

vulndb-0.0.11.tar.gz (52.2 kB view details)

Uploaded Source

File details

Details for the file vulndb-0.0.11.tar.gz.

File metadata

  • Download URL: vulndb-0.0.11.tar.gz
  • Upload date:
  • Size: 52.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for vulndb-0.0.11.tar.gz
Algorithm Hash digest
SHA256 c2efd0ed2b6ad122c992d3a7019a80eddb216a5cf03f0e45b612cf4903c867b0
MD5 4bee5a5be4496b4e7608cefe99d1ab49
BLAKE2b-256 490b675e977eedc8f8fae13946c8cba5598a2bf42bf213c8bf9dd7f122dbbd47

See more details on using hashes here.

Supported by

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