Python SDK to access the vulnerability database
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:
rm -rf dist/ python setup.py sdist bdist_wheel twine check dist/* twine upload dist/*
Release files for vulndb 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vulndb-0.1.3.tar.gz | 51.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vulndb-0.1.3-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 161.9 kB
Release files / vulndb-0.1.3.tar.gz
| Download URL | vulndb-0.1.3.tar.gz |
|---|---|
| Size | 51.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3804be93a3fdfe550a7f2db06ff162ab4b622bcb9327bf4ac62737dbc9fddb8f
|
|
BLAKE2b-256 checksum How to use checksums |
f365afb1363677627bc9f63f413298179f374466391261db3a0c13d7653bb26e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/2.7.15+
|
Release files / vulndb-0.1.3-py2-none-any.whl
| Download URL | vulndb-0.1.3-py2-none-any.whl |
|---|---|
| Size | 110.6 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
9dca9112f8636c82fe50ecb0db0bb022f0f6b83d35cd8aa105acaaefb895a697
|
|
BLAKE2b-256 checksum How to use checksums |
b2cebd2569e78067922c9e73c36806be07f6c9ac44106c652a16bf0380a3ca56
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/2.7.15+
|