About the GitHub Advisory Database
The GitHub Advisory Database contains a list of known security vulnerabilities grouped in two categories: GitHub-reviewed advisories and unreviewed advisories.
We add advisories to the GitHub Advisory Database from the following sources:
- The National Vulnerability Database
- A combination of machine learning and human review to detect vulnerabilities in public commits on GitHub
- Security advisories reported on GitHub
- The npm Security advisories database
About types of security advisories
Each advisory in the GitHub Advisory Database is for a vulnerability in open source projects.
A vulnerability is a problem in a project's code that could be exploited to damage the confidentiality, integrity, or availability of the project or other projects that use its code. Vulnerabilities vary in type, severity, and method of attack. Vulnerabilities in code are usually introduced by accident and fixed soon after they are discovered. You should update your code to use the fixed version of the dependency as soon as it is available.
GitHub-reviewed advisories
GitHub-reviewed advisories are security vulnerabilities that have been mapped to packages in ecosystems we support. We carefully review each advisory for validity and ensure that they have a full description, and contain both ecosystem and package information.
Generally, we name our supported ecosystems after the software programming language's associated package registry. We review advisories if they are for a vulnerability in a package that comes from a supported registry.
- Composer (registry: https://packagist.org/)
- Go (registry: https://pkg.go.dev/)
- Maven (registry: https://repo.maven.apache.org/maven2)
- npm (registry: https://www.npmjs.com/)
- NuGet (registry: https://www.nuget.org/)
- pip (registry: https://pypi.org/)
- RubyGems (registry: https://rubygems.org/)
- Rust (registry: https://crates.io/)
If you have a suggestion for a new ecosystem we should support, please open an issue for discussion.
If you enable Dependabot alerts for your repositories, you are automatically notified when a new GitHub-reviewed advisory reports a vulnerability for a package you depend on. For more information, see "About Dependabot alerts."
Unreviewed advisories
Unreviewed advisories are security vulnerabilites that we publish automatically into the GitHub Advisory Database, directly from the National Vulnerability Database feed.
Dependabot doesn't create Dependabot alerts for unreviewed advisories as this type of advisory isn't checked for validity or completion.
About information in security advisories
Each security advisory contains information about the vulnerability which may include the description, severity, affected package, package ecosystem, affected versions and patched versions, impact, and optional information such as references, workarounds, and credits. In addition, advisories from the National Vulnerability Database list contain a link to the CVE record, where you can read more details about the vulnerability, its CVSS scores, and its qualitative severity level. For more information, see the "National Vulnerability Database" from the National Institute of Standards and Technology.
The severity level is one of four possible levels defined in the "Common Vulnerability Scoring System (CVSS), Section 5."
- Low
- Medium/Moderate
- High
- Critical
The GitHub Advisory Database uses the CVSS levels described above. If GitHub obtains a CVE, the GitHub Advisory Database uses CVSS version 3.1. If the CVE is imported, the GitHub Advisory Database supports both CVSS versions 3.0 and 3.1.
You can also join GitHub Security Lab to browse security-related topics and contribute to security tools and projects.
Accessing an advisory in the GitHub Advisory Database
-
Navigate to https://github.com/advisories.
-
Optionally, to filter the list, use any of the drop-down menus.
Tip: You can use the sidebar on the left to explore GitHub-reviewed and unreviewed advisories separately.
-
Click an advisory to view details. By default, you will see GitHub-reviewed advisories for security vulnerabilities.
The database is also accessible using the GraphQL API. For more information, see the "security_advisory
webhook event."
Editing an advisory in the GitHub Advisory Database
You can suggest improvements to any advisory in the GitHub Advisory Database. For more information, see "Editing security advisories in the GitHub Advisory Database."
Searching the GitHub Advisory Database
You can search the database, and use qualifiers to narrow your search. For example, you can search for advisories created on a certain date, in a specific ecosystem, or in a particular library.
Date formatting must follow the ISO8601 standard, which is YYYY-MM-DD
(year-month-day). You can also add optional time information THH:MM:SS+00:00
after the date, to search by the hour, minute, and second. That's T
, followed by HH:MM:SS
(hour-minutes-seconds), and a UTC offset (+00:00
).
When you search for a date, you can use greater than, less than, and range qualifiers to further filter results. For more information, see "Understanding the search syntax."
Qualifier | Example |
---|---|
type:reviewed | type:reviewed will show GitHub-reviewed advisories for security vulnerabilities. |
type:unreviewed | type:unreviewed will show unreviewed advisories. |
GHSA-ID | GHSA-49wp-qq6x-g2rf will show the advisory with this GitHub Advisory Database ID. |
CVE-ID | CVE-2020-28482 will show the advisory with this CVE ID number. |
ecosystem:ECOSYSTEM | ecosystem:npm will show only advisories affecting NPM packages. |
severity:LEVEL | severity:high will show only advisories with a high severity level. |
affects:LIBRARY | affects:lodash will show only advisories affecting the lodash library. |
cwe:ID | cwe:352 will show only advisories with this CWE number. |
credit:USERNAME | credit:octocat will show only advisories credited to the "octocat" user account. |
sort:created-asc | sort:created-asc will sort by the oldest advisories first. |
sort:created-desc | sort:created-desc will sort by the newest advisories first. |
sort:updated-asc | sort:updated-asc will sort by the least recently updated first. |
sort:updated-desc | sort:updated-desc will sort by the most recently updated first. |
is:withdrawn | is:withdrawn will show only advisories that have been withdrawn. |
created:YYYY-MM-DD | created:2021-01-13 will show only advisories created on this date. |
updated:YYYY-MM-DD | updated:2021-01-13 will show only advisories updated on this date. |
Viewing your vulnerable repositories
For any GitHub-reviewed advisory in the GitHub Advisory Database, you can see which of your repositories are affected by that security vulnerability. To see a vulnerable repository, you must have access to Dependabot alerts for that repository. For more information, see "About Dependabot alerts."
- Navigate to https://github.com/advisories.
- Click an advisory.
- At the top of the advisory page, click Dependabot alerts.
- Optionally, to filter the list, use the search bar or the drop-down menus. The "Organization" drop-down menu allows you to filter the Dependabot alerts per owner (organization or user).
- For more details about the advisory, and for advice on how to fix the vulnerable repository, click the repository name.
Further reading
- MITRE's definition of "vulnerability"