Sigstore is a growing community of volunteers, users, and vendors. The Sigstore community has adopted this security disclosures and response policy to ensure we responsibly handle critical issues.
Send the vulnerability disclosure to [email protected]. The Security Response Committee will acknowledge the report within 24 hours.
Include steps to reproduce the vulnerability, the vulnerable versions, and any additional files to reproduce the vulnerability.
If you are only comfortable sharing under GPG, please start by sending an email requesting a public PGP key to use for encryption.
Security vulnerabilities should be handled quickly and sometimes privately. The primary goal of this process is to reduce the total time users are vulnerable to publicly and privately known exploits.
The SRC are responsible for organizing the entire response including internal communication and external disclosure, but will need help from relevant maintainers to successfully run this process.
The SRC currently consists of:
- Luke Hinds ([email protected])
- Bob Callaway ([email protected])
- Hayden Blauzvern ([email protected])
- Cody Soyland ([email protected])
The SRC members will share various tasks as listed below:
- Triage: Assess the impact of the vulnerability (can it be replicated, is the code in Sigstore or upstream?)
- Infra: Create a security advisory and temporary fork for the fix team to work on the issue
- Disclosure: Handle public messaging around the vulnerability, by documenting the issue (how to upgrade, list affected versions, draft an advisory notice)
- Release: Create new release addressing a security fix and notify the public
Contact the team by sending email to [email protected].
The SRC should ideally consist of 3-5 members. New potential members to the SRC can express their interest to the SRC members. These individuals can be nominated by SRC members or Sigstore maintainers to the current SRC members. Membership if possible should be vendor diverse (no more than 2:1 ratio of representation from any single vendor).
If representation changes due to employment change, then SRC members are encouraged to grow the team or replace themselves through mentoring new members.
Selection of new members will be done by lazy consensus amongst members for adding new people with fallback on majority vote.
Members may step down at any time and propose a replacement from existing active contributors of Sigstore.
- Members must remain active and responsive.
- Members taking an extended leave of two weeks or more should coordinate with other members to ensure the role is adequately staffed during the leave.
- Members going on leave for 1-3 months may identify a temporary replacement.
- Members of a role should remove any other members that have not communicated a leave of absence and either cannot be reached for more than 1 month or are not fulfilling their documented responsibilities for more than 1 month. This may be done through a super-majority vote of members.
- Members should never intentionally disclose a vulnerbility during the embargo process to any public channels or indviduals outside of the SRC or codeowners selected to work as part of a fix team.
Thank you to the previous members of the SRC!
- Dan Lorenc
- Asra Ali
The Sigstore community asks that all suspected vulnerabilities be handled in accordance with Responsible Disclosure model.
If anyone knows of a publicly disclosed security vulnerability please IMMEDIATELY email [email protected] to inform the SRC about the vulnerability so they may start the patch, release, and communication process.
If a reporter contacts the SRC to express intent to make an issue public before a fix is available, the SRC will request if the issue can be handled via a private disclosure process. If the reporter denies the request, the SRC will move swiftly with the fix and release process.
For each vulnerability, the SRC members will coordinate to create the fix and release, and notify the rest of the community.
All of the timelines below are suggestions and assume a Private Disclosure.
- The SRC drives the schedule using their best judgment based on severity, development time, and release work.
- If the SRC is dealing with a Public Disclosure all timelines become ASAP.
- If the fix relies on another upstream project's disclosure timeline, that will adjust the process as well.
- We will work with the upstream project to fit their timeline and best protect Sigstore users.
These steps should be completed within the first 24 hours of Disclosure.
- The SRC will work quickly to identify relevant engineers from the affected projects and packages and being those engineers into the security advisory thread.
- These selected developers become the "Fix Team" (the fix team is often drawn from the projects MAINTAINERS)
These steps should be completed within the 1-7 days of Disclosure.
- The SRC will create a new security advisory in affected repository by visiting
https://github.com/sigstore/<project>/security/advisories/new - As many details as possible should be entered such as versions affected, CVE (if available yet). As more information is discovered, edit and update the advisory accordingly.
- Use the CVSS calculator to score a severity level.
- Add collaborators from codeowners team only (outside members can only be added after approval from the SRC team)
- The reporter may be added to the issue to assist with review, but only reporters who have contacted the SRC using a private channel.
- Select 'Request CVE'
- The SRC / Fix Team create a private temporary fork
- The Fix team performs all work in a 'security advisory' within its temporary fork
- CI can be checked locally using the act project
- All communication happens within the security advisory, it is not discussed in slack channels or non private issues.
- The Fix Team will notify the SRC that work on the fix branch is completed, this can be done by tagging names in the advisory
- The Fix team and the SRC will agree on fix release day
- The recommended release time is 4pm UTC on a non-Friday weekday. This means the announcement will be seen morning Pacific, early evening Europe, and late evening Asia.
If the CVSS score is under ~4.0 (a low severity score) or the assessed risk is low the Fix Team can decide to slow the release process down in the face of holidays, developer bandwidth, etc.
Note: CVSS is convenient but imperfect. Ultimately, the SRC has discretion on classifying the severity of a vulnerability.
The severity of the bug and related handling decisions must be discussed on in the security advisory, never in public repos.
With the Fix Development underway, the SRC needs to come up with an overall communication plan for the wider community. This Disclosure process should begin after the Fix Team has developed a Fix or mitigation so that a realistic timeline can be communicated to users.
Fix Release Day (Completed within 1-21 days of Disclosure)
- The Fix Team will approve the related pull requests in the private temporary branch of the security advisory
- The SRC will merge the security advisory / temporary fork and its commits into the main branch of the affected repository
- The SRC will ensure all the binaries are built, signed, publicly available, and functional.
- The SRC will announce the new releases, the CVE number, severity, and impact, and the location of the binaries to get wide distribution and user action. As much as possible this announcement should be actionable, and include any mitigating steps users can take prior to upgrading to a fixed version. An announcement template is available below. The announcement will be sent to the the following channels:
- A link to the google groups email will be posted to the sigstore slack workplace in the general and development channels
Subject: Security release of sigstore/<project/ $VERSION is now available
To: [email protected]
Hello sigstore Community,
The Security Response Committee and maintainers of sigstore/$PROJECT would like
to announce the availability of sigstore/$PROJECT $VERSION.
This addresses the following CVE(s):
* CVE-YEAR-ABCDEF (CVSS score $CVSS): $CVESUMMARY
...
Upgrading to $VERSION is encouraged to fix these issues.
**Am I vulnerable?**
Run `$PROJECT --version` and if it indicates a base version of $OLDVERSION or
older that means it is a vulnerable version.
<!-- Provide details on features, extensions, configuration that make it likely that a system is
vulnerable in practice. -->
**How do I mitigate the vulnerability?**
<!--
[This is an optional section. Remove if there are no mitigations.]
-->
**How do I upgrade?**
<!--
[Outline upgrade steps]
-->
**Vulnerability Details**
<!--
[For each CVE]
-->
These steps should be completed 1-3 days after the Release Date. The retrospective process should be blameless.
- The SRC will send a retrospective of the process to [email protected] including details on everyone involved, the timeline of the process, links to relevant PRs that introduced the issue, if relevant, and any critiques of the response and release process.
- The SRC and Fix Team are also encouraged to send their own feedback on the process to [email protected]. Honest critique is the only way we are going to get good at this as a community.
Parts of this process were inspired by the etc-d's security handling process.