===============
VulnerableCode
===============
|Build Status| |Code License| |Data License| |Python 3.8+| |stability-wip| |Gitter chat|
.. |Build Status| image:: https://github.com/nexB/vulnerablecode/actions/workflows/main.yml/badge.svg?branch=main
:target: https://github.com/nexB/vulnerablecode/actions?query=workflow%3ACI
.. |Code License| image:: https://img.shields.io/badge/Code%20License-Apache--2.0-green.svg
:target: https://opensource.org/licenses/Apache-2.0
.. |Data License| image:: https://img.shields.io/badge/Data%20License-CC--BY--SA--4.0-green.svg
:target: https://creativecommons.org/licenses/by-sa/4.0/legalcode
.. |Python 3.8+| image:: https://img.shields.io/badge/python-3.8+-green.svg
:target: https://www.python.org/downloads/release/python-380/
.. |stability-wip| image:: https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg
.. |Gitter chat| image:: https://badges.gitter.im/gitterHQ/gitter.png
:target: https://gitter.im/aboutcode-org/vulnerablecode
VulnerableCode is a free and open database of open source software package
vulnerabilities **because open source software vulnerabilities data and tools
should be free and open source themselves**:
we are trying to change this and evolve the status quo in a few other areas!
- Vulnerability databases have been **traditionally proprietary** even though they
are mostly about free and open source software.
- Vulnerability databases also often contain a lot of lesser value data which
means a lot of false positive signals that require extensive expert reviews.
- Vulnerability databases are also mostly about vulnerabilities first and software
package second, making it difficult to find if and when a vulnerability applies
to a piece of code. VulnerableCode focus is on software package first where
a Package URL is a key and natural identifier for packages; this is making it
easier to find a package and whether it is vulnerable.
Package URL themselves were designed first in ScanCode and VulnerableCode
and are now a de-facto standard for vulnerability management and package references.
See https://github.com/package-url/purl-spec
The VulnerableCode project is a FOSS community resource to help improve the
security of the open source software ecosystem and its users at large.
VulnerableCode consists of a database and the tools to collect, refine and keep
the database current.
.. pull-quote::
**Warning**
VulnerableCode is under active development and is not yet fully
usable.
Read more about VulnerableCode https://vulnerablecode.readthedocs.org/
VulnerableCode tech stack is Python, Django, PostgreSQL, nginx and Docker and
several libraries.
Getting started
===============
Run with Docker
---------------
First install docker, then run
.. code:: bash
git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode
make envfile
docker compose build
docker compose up -d
docker compose run vulnerablecode ./manage.py import --list
Then run an importer for nginx advisories (which is small)
.. code:: bash
docker compose exec vulnerablecode ./manage.py import nginx_importer
docker compose exec vulnerablecode ./manage.py improve --all
At this point, the VulnerableCode app and API should be up and running with
some data at http://localhost
Populate VulnerableCode database
--------------------------------
VulnerableCode data collection works in two steps: importing data from multiple
sources and then refining and improving how package and software vulnerabilities
are related.
To run all importers and improvers use this
.. code:: bash
./manage.py import --all
.. code:: bash
./manage.py improve --all
Local development installation
------------------------------
On a Debian system, use this
.. code:: bash
sudo apt-get install python3-venv python3-dev postgresql libpq-dev build-essential
git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode
make dev envfile postgres
make test
source venv/bin/activate
./manage.py import nginx_importer
./manage.py improve --all
make run
At this point, the VulnerableCode app and API is up at http://127.0.0.1:8001/
License
========
Copyright (c) nexB Inc. and others. All rights reserved.
VulnerableCode is a trademark of nexB Inc.
SPDX-License-Identifier: Apache-2.0 AND CC-BY-SA-4.0
VulnerableCode software is licensed under the Apache License version 2.0.
VulnerableCode data is licensed collectively under CC-BY-SA-4.0.
See https://www.apache.org/licenses/LICENSE-2.0 for the license text.
See https://creativecommons.org/licenses/by-sa/4.0/legalcode for the license text.
See https://github.com/nexB/vulnerablecode for support or download.
See https://aboutcode.org for more information about nexB OSS projects.
Acknowledgements, Funding, Support and Sponsoring
=================================================
This project is funded, supported and sponsored by:
- Generous support and contributions from users like you!
- the European Commission NGI programme
- the NLnet Foundation
- the Swiss State Secretariat for Education, Research and Innovation (SERI)
- Google, including the Google Summer of Code and the Google Seasons of Doc programmes
- Mercedes-Benz Group
- Microsoft and Microsoft Azure
- AboutCode ASBL
- nexB Inc.
|europa| |dgconnect|
|ngi| |nlnet|
|aboutcode| |nexb|
This project was funded through the NGI0 PET Fund, a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme, under the aegis of DG
Communications Networks, Content and Technology under grant agreement No 825310.
|ngizeropet| https://nlnet.nl/project/VulnerableCode/
This project was funded through the NGI0 Discovery Fund, a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme, under the aegis of DG
Communications Networks, Content and Technology under grant agreement No 825322.
|ngidiscovery| https://nlnet.nl/project/vulnerabilitydatabase/
This project was funded through the NGI0 Core Fund, a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme, under the aegis of DG
Communications Networks, Content and Technology under grant agreement No 101092990.
|ngizerocore| https://nlnet.nl/project/VulnerableCode-enhancements/
This project is funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme, under the aegis of DG
Communications Networks, Content and Technology under grant agreement No 101069594.
|ngizeroentrust| https://nlnet.nl/project/FederatedSoftwareMetadata/
This project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme, under the aegis of DG
Communications Networks, Content and Technology under grant agreement No 101135429. Additional
funding is made available by the Swiss State Secretariat for Education, Research and Innovation
(SERI).
|ngizerocommons| |swiss| https://nlnet.nl/project/FederatedCodeNext/
This project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial
support from the European Commission's Next Generation Internet programme, under the aegis of DG
Communications Networks, Content and Technology under grant agreement No 101069594.
|ngizeroentrust| https://nlnet.nl/project/CRAVEX/
.. |nlnet| image:: https://nlnet.nl/logo/banner.png
:target: https://nlnet.nl
:height: 50
:alt: NLnet foundation logo
.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png
:target: https://ngi.eu35
:height: 50
:alt: NGI logo
.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg
:target: https://nexb.com
:height: 30
:alt: nexB logo
.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png
:target: http://ec.europa.eu/index_en.htm
:height: 40
:alt: Europa logo
.. |aboutcode| image:: https://aboutcode.org/wp-content/uploads/2023/10/AboutCode.svg
:target: https://aboutcode.org/
:height: 30
:alt: AboutCode logo
.. |swiss| image:: https://www.sbfi.admin.ch/sbfi/en/_jcr_content/logo/image.imagespooler.png/1493119032540/logo.png
:target: https://www.sbfi.admin.ch/sbfi/en/home/seri/seri.html
:height: 40
:alt: Swiss logo
.. |dgconnect| image:: https://commission.europa.eu/themes/contrib/oe_theme/dist/ec/images/logo/positive/logo-ec--en.svg
:target: https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en
:height: 40
:alt: EC DG Connect logo
.. |ngizerocore| image:: https://nlnet.nl/image/logos/NGI0_tag.svg
:target: https://nlnet.nl/core
:height: 40
:alt: NGI Zero Core Logo
.. |ngizerocommons| image:: https://nlnet.nl/image/logos/NGI0_tag.svg
:target: https://nlnet.nl/commonsfund/
:height: 40
:alt: NGI Zero Commons Logo
.. |ngizeropet| image:: https://nlnet.nl/image/logos/NGI0PET_tag.svg
:target: https://nlnet.nl/PET
:height: 40
:alt: NGI Zero PET logo
.. |ngizeroentrust| image:: https://nlnet.nl/image/logos/NGI0Entrust_tag.svg
:target: https://nlnet.nl/entrust
:height: 38
:alt: NGI Zero Entrust logo
.. |ngiassure| image:: https://nlnet.nl/image/logos/NGIAssure_tag.svg
:target: https://nlnet.nl/image/logos/NGIAssure_tag.svg
:height: 32
:alt: NGI Assure logo
.. |ngidiscovery| image:: https://nlnet.nl/image/logos/NGI0Discovery_tag.svg
:target: https://nlnet.nl/discovery/
:height: 40
:alt: NGI Discovery logo
Raw data
{
"_id": null,
"home_page": "https://github.com/nexB/vulnerablecode",
"name": "vulnerablecode",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "open source, vulnerability, security, cve, purl, packageurl, dependency, package, vulnerability-db, SBOM, sca",
"author": "nexB. Inc. and others",
"author_email": "info@aboutcode.org",
"download_url": "https://files.pythonhosted.org/packages/eb/f0/8eba1a9f8e77c1fb144ccc36ce061ef135c9ca997a9d53a28583d19bfe42/vulnerablecode-35.0.0.tar.gz",
"platform": null,
"description": "===============\nVulnerableCode\n===============\n\n|Build Status| |Code License| |Data License| |Python 3.8+| |stability-wip| |Gitter chat|\n\n\n.. |Build Status| image:: https://github.com/nexB/vulnerablecode/actions/workflows/main.yml/badge.svg?branch=main\n :target: https://github.com/nexB/vulnerablecode/actions?query=workflow%3ACI\n.. |Code License| image:: https://img.shields.io/badge/Code%20License-Apache--2.0-green.svg\n :target: https://opensource.org/licenses/Apache-2.0\n.. |Data License| image:: https://img.shields.io/badge/Data%20License-CC--BY--SA--4.0-green.svg\n :target: https://creativecommons.org/licenses/by-sa/4.0/legalcode \n.. |Python 3.8+| image:: https://img.shields.io/badge/python-3.8+-green.svg\n :target: https://www.python.org/downloads/release/python-380/\n.. |stability-wip| image:: https://img.shields.io/badge/stability-work_in_progress-lightgrey.svg\n.. |Gitter chat| image:: https://badges.gitter.im/gitterHQ/gitter.png\n :target: https://gitter.im/aboutcode-org/vulnerablecode\n\n\nVulnerableCode is a free and open database of open source software package\nvulnerabilities **because open source software vulnerabilities data and tools\nshould be free and open source themselves**:\n\nwe are trying to change this and evolve the status quo in a few other areas!\n\n- Vulnerability databases have been **traditionally proprietary** even though they\n are mostly about free and open source software. \n\n- Vulnerability databases also often contain a lot of lesser value data which\n means a lot of false positive signals that require extensive expert reviews.\n\n- Vulnerability databases are also mostly about vulnerabilities first and software\n package second, making it difficult to find if and when a vulnerability applies\n to a piece of code. VulnerableCode focus is on software package first where\n a Package URL is a key and natural identifier for packages; this is making it\n easier to find a package and whether it is vulnerable.\n\nPackage URL themselves were designed first in ScanCode and VulnerableCode\nand are now a de-facto standard for vulnerability management and package references.\nSee https://github.com/package-url/purl-spec\n\nThe VulnerableCode project is a FOSS community resource to help improve the\nsecurity of the open source software ecosystem and its users at large.\n\nVulnerableCode consists of a database and the tools to collect, refine and keep\nthe database current. \n\n\n.. pull-quote::\n **Warning**\n\n VulnerableCode is under active development and is not yet fully\n usable.\n\n\nRead more about VulnerableCode https://vulnerablecode.readthedocs.org/\n\nVulnerableCode tech stack is Python, Django, PostgreSQL, nginx and Docker and\nseveral libraries.\n\n\nGetting started\n===============\n\nRun with Docker\n---------------\n\nFirst install docker, then run\n\n.. code:: bash\n\n git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode\n make envfile\n docker compose build\n docker compose up -d\n docker compose run vulnerablecode ./manage.py import --list\n\nThen run an importer for nginx advisories (which is small)\n\n.. code:: bash\n\n docker compose exec vulnerablecode ./manage.py import nginx_importer\n docker compose exec vulnerablecode ./manage.py improve --all\n\nAt this point, the VulnerableCode app and API should be up and running with\nsome data at http://localhost\n\n\nPopulate VulnerableCode database\n--------------------------------\n\nVulnerableCode data collection works in two steps: importing data from multiple\nsources and then refining and improving how package and software vulnerabilities\nare related.\n\nTo run all importers and improvers use this\n\n.. code:: bash\n\n ./manage.py import --all\n\n.. code:: bash\n\n ./manage.py improve --all\n\n\nLocal development installation\n------------------------------\n\nOn a Debian system, use this\n\n.. code:: bash\n\n sudo apt-get install python3-venv python3-dev postgresql libpq-dev build-essential\n git clone https://github.com/nexB/vulnerablecode.git && cd vulnerablecode\n make dev envfile postgres\n make test\n source venv/bin/activate\n ./manage.py import nginx_importer\n ./manage.py improve --all\n make run\n\nAt this point, the VulnerableCode app and API is up at http://127.0.0.1:8001/\n\n\nLicense\n========\n\nCopyright (c) nexB Inc. and others. All rights reserved.\n\nVulnerableCode is a trademark of nexB Inc.\n\nSPDX-License-Identifier: Apache-2.0 AND CC-BY-SA-4.0\n\nVulnerableCode software is licensed under the Apache License version 2.0.\n\nVulnerableCode data is licensed collectively under CC-BY-SA-4.0.\n\nSee https://www.apache.org/licenses/LICENSE-2.0 for the license text.\n\nSee https://creativecommons.org/licenses/by-sa/4.0/legalcode for the license text.\n\nSee https://github.com/nexB/vulnerablecode for support or download. \n\nSee https://aboutcode.org for more information about nexB OSS projects.\n\n\nAcknowledgements, Funding, Support and Sponsoring\n=================================================\n\nThis project is funded, supported and sponsored by:\n\n- Generous support and contributions from users like you!\n- the European Commission NGI programme\n- the NLnet Foundation \n- the Swiss State Secretariat for Education, Research and Innovation (SERI)\n- Google, including the Google Summer of Code and the Google Seasons of Doc programmes\n- Mercedes-Benz Group\n- Microsoft and Microsoft Azure\n- AboutCode ASBL\n- nexB Inc. \n\n\n\n|europa| |dgconnect| \n\n|ngi| |nlnet| \n\n|aboutcode| |nexb|\n\n\n\nThis project was funded through the NGI0 PET Fund, a fund established by NLnet with financial\nsupport from the European Commission's Next Generation Internet programme, under the aegis of DG\nCommunications Networks, Content and Technology under grant agreement No 825310.\n\n|ngizeropet| https://nlnet.nl/project/VulnerableCode/\n\n\nThis project was funded through the NGI0 Discovery Fund, a fund established by NLnet with financial\nsupport from the European Commission's Next Generation Internet programme, under the aegis of DG\nCommunications Networks, Content and Technology under grant agreement No 825322.\n\n|ngidiscovery| https://nlnet.nl/project/vulnerabilitydatabase/\n\n\nThis project was funded through the NGI0 Core Fund, a fund established by NLnet with financial\nsupport from the European Commission's Next Generation Internet programme, under the aegis of DG\nCommunications Networks, Content and Technology under grant agreement No 101092990.\n\n|ngizerocore| https://nlnet.nl/project/VulnerableCode-enhancements/\n\n\nThis project is funded through the NGI0 Entrust Fund, a fund established by NLnet with financial\nsupport from the European Commission's Next Generation Internet programme, under the aegis of DG\nCommunications Networks, Content and Technology under grant agreement No 101069594.\n\n|ngizeroentrust| https://nlnet.nl/project/FederatedSoftwareMetadata/\n\n\nThis project was funded through the NGI0 Commons Fund, a fund established by NLnet with financial\nsupport from the European Commission's Next Generation Internet programme, under the aegis of DG\nCommunications Networks, Content and Technology under grant agreement No 101135429. Additional\nfunding is made available by the Swiss State Secretariat for Education, Research and Innovation\n(SERI). \n\n|ngizerocommons| |swiss| https://nlnet.nl/project/FederatedCodeNext/\n\nThis project was funded through the NGI0 Entrust Fund, a fund established by NLnet with financial\nsupport from the European Commission's Next Generation Internet programme, under the aegis of DG\nCommunications Networks, Content and Technology under grant agreement No 101069594. \n\n|ngizeroentrust| https://nlnet.nl/project/CRAVEX/\n\n\n\n.. |nlnet| image:: https://nlnet.nl/logo/banner.png\n :target: https://nlnet.nl\n :height: 50\n :alt: NLnet foundation logo\n\n.. |ngi| image:: https://ngi.eu/wp-content/uploads/thegem-logos/logo_8269bc6efcf731d34b6385775d76511d_1x.png\n :target: https://ngi.eu35\n :height: 50\n :alt: NGI logo\n\n.. |nexb| image:: https://nexb.com/wp-content/uploads/2022/04/nexB.svg\n :target: https://nexb.com\n :height: 30\n :alt: nexB logo\n\n.. |europa| image:: https://ngi.eu/wp-content/uploads/sites/77/2017/10/bandiera_stelle.png\n :target: http://ec.europa.eu/index_en.htm\n :height: 40\n :alt: Europa logo\n\n.. |aboutcode| image:: https://aboutcode.org/wp-content/uploads/2023/10/AboutCode.svg\n :target: https://aboutcode.org/\n :height: 30\n :alt: AboutCode logo\n\n.. |swiss| image:: https://www.sbfi.admin.ch/sbfi/en/_jcr_content/logo/image.imagespooler.png/1493119032540/logo.png\n :target: https://www.sbfi.admin.ch/sbfi/en/home/seri/seri.html\n :height: 40\n :alt: Swiss logo\n\n.. |dgconnect| image:: https://commission.europa.eu/themes/contrib/oe_theme/dist/ec/images/logo/positive/logo-ec--en.svg\n :target: https://commission.europa.eu/about-european-commission/departments-and-executive-agencies/communications-networks-content-and-technology_en\n :height: 40\n :alt: EC DG Connect logo\n\n.. |ngizerocore| image:: https://nlnet.nl/image/logos/NGI0_tag.svg\n :target: https://nlnet.nl/core\n :height: 40\n :alt: NGI Zero Core Logo\n\n.. |ngizerocommons| image:: https://nlnet.nl/image/logos/NGI0_tag.svg\n :target: https://nlnet.nl/commonsfund/\n :height: 40\n :alt: NGI Zero Commons Logo\n\n.. |ngizeropet| image:: https://nlnet.nl/image/logos/NGI0PET_tag.svg\n :target: https://nlnet.nl/PET\n :height: 40\n :alt: NGI Zero PET logo\n\n.. |ngizeroentrust| image:: https://nlnet.nl/image/logos/NGI0Entrust_tag.svg\n :target: https://nlnet.nl/entrust\n :height: 38\n :alt: NGI Zero Entrust logo\n\n.. |ngiassure| image:: https://nlnet.nl/image/logos/NGIAssure_tag.svg\n :target: https://nlnet.nl/image/logos/NGIAssure_tag.svg\n :height: 32\n :alt: NGI Assure logo\n\n.. |ngidiscovery| image:: https://nlnet.nl/image/logos/NGI0Discovery_tag.svg\n :target: https://nlnet.nl/discovery/\n :height: 40\n :alt: NGI Discovery logo\n",
"bugtrack_url": null,
"license": "Apache-2.0 AND CC-BY-SA-4.0",
"summary": "VulnerableCode is a free and open database of open source software package vulnerabilities because open source software vulnerabilities data and tools should be free and open source themselves.",
"version": "35.0.0",
"project_urls": {
"Homepage": "https://github.com/nexB/vulnerablecode"
},
"split_keywords": [
"open source",
" vulnerability",
" security",
" cve",
" purl",
" packageurl",
" dependency",
" package",
" vulnerability-db",
" sbom",
" sca"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d2eed55f2c85f4cba403035ee16c64f6caf59bf4c4a81570c7d5d25f72ca5c3",
"md5": "a7be003fdafe919f9559f87e75d3985d",
"sha256": "906f6a687d167733e8bfdc5cd35afabd175acd62e32a68ab3e3395b61e62dc5e"
},
"downloads": -1,
"filename": "vulnerablecode-35.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a7be003fdafe919f9559f87e75d3985d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 2317864,
"upload_time": "2024-11-20T10:19:31",
"upload_time_iso_8601": "2024-11-20T10:19:31.082938Z",
"url": "https://files.pythonhosted.org/packages/3d/2e/ed55f2c85f4cba403035ee16c64f6caf59bf4c4a81570c7d5d25f72ca5c3/vulnerablecode-35.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ebf08eba1a9f8e77c1fb144ccc36ce061ef135c9ca997a9d53a28583d19bfe42",
"md5": "74a2f9fc63c3fabe16714949fa0cb5d1",
"sha256": "3ae6eca76b0546e9386d32d4439917462db68fce95445233b45a6753f7384a45"
},
"downloads": -1,
"filename": "vulnerablecode-35.0.0.tar.gz",
"has_sig": false,
"md5_digest": "74a2f9fc63c3fabe16714949fa0cb5d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 12663332,
"upload_time": "2024-11-20T10:19:33",
"upload_time_iso_8601": "2024-11-20T10:19:33.299117Z",
"url": "https://files.pythonhosted.org/packages/eb/f0/8eba1a9f8e77c1fb144ccc36ce061ef135c9ca997a9d53a28583d19bfe42/vulnerablecode-35.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 10:19:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nexB",
"github_project": "vulnerablecode",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "vulnerablecode"
}
JSON
