Guide to coordinated vulnerability disclosure for open source software projects

This repository is a set of resources and reference materials to help open source projects perform coordinated vulnerability disclosure (CVD).

This repository contains:

• Guide to coordinated vulnerability disclosure for open source software projects: This contains background material on vulnerability disclosure, the steps to the CVD process, considerations for the decision points of the process, and "troubleshooting" for common scenarios.
• Guide to coordinated vulnerability disclosure for Finders working with open source software projects: Focused on security researchers (aka "Finders"), this contains background material on vulnerability disclosure, the steps to the CVD process, considerations for the decision points of the process, and "troubleshooting" for common scenarios.
• Templates: These will help you get started with the communication components of CVD. This includes SECURITY.md templates, embargoed notification and vulnerability disclosure.
• Runbook: A step-by-step list for the CVD process. For additional information on these steps, refer to the Guide.

Getting Started

If you are new to coordinated vulnerability disclosure, it is recommended you start with the Guide. While it is dense, you will want to be familiar with this information and the concepts presented before you need to address a vulnerability report.

If you are familiar with coordinated vulnerability disclosure, you can get a refresher by skipping to the Response Process section of the Guide, or go straight to the Runbook.

Feedback

We welcome feedback from OSS project maintainers and security researchers on this guide. Opening a GitHub Issue is the best way to send feedback (see CONTRIBUTING.md for directions on submitting PRs).