[WIP] [Governance Enhancement] Add Security team #97
Conversation
Signed-off-by: JesseStutler <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @JesseStutler, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request introduces a comprehensive framework for managing security within the Volcano project. It establishes a dedicated Security Team, defines clear processes for vulnerability reporting and disclosure, and outlines policies for communication with private distributors. This initiative aims to formalize and enhance the project's security posture, addressing issue #88.
Highlights
- Security Team Establishment: Formalizes the creation and responsibilities of a dedicated Security Team.
- Vulnerability Management: Introduces detailed procedures for reporting, processing, and disclosing security vulnerabilities.
- Private Distributor Communication: Defines a private distributors list, including membership criteria, embargo policies, and contribution expectations, to facilitate responsible disclosure.
- Comprehensive Security Policies: Adds new documentation covering overall security policy, supported versions, and dependency management.
- Automated Application Process: Provides a new GitHub issue template to streamline applications for the private distributors list.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request is a great step towards formalizing the security processes for Volcano by adding comprehensive documentation for a security team, vulnerability reporting, and release management. The new documents are well-structured. My review has identified several broken links to images and document templates that need to be fixed, along with some minor grammatical improvements to enhance clarity. Addressing these points will ensure the documentation is accurate and professional.
|
|
||
| The following flowchart shows the vulnerability handling process. we will strictly handle the reporting vulnerability according to this procedure. | ||
|
|
||
| <img src="./images/Vulnerability-handling-process.PNG"> |
There was a problem hiding this comment.
This image link appears to be broken. The images directory and the Vulnerability-handling-process.PNG file are not included in this pull request. Please add the image file or remove the <img> tag.
|
|
||
| ### Request to Join | ||
|
|
||
| File an issue [here](https://github.com/volcano-sh/community/issues/new?template=distributors-application.md), or send an [email](comms-templates/join-announcement-email-list.md), filling in the criteria template. No newline at end of file |
There was a problem hiding this comment.
This link to an email template appears to be broken. The comms-templates directory and the join-announcement-email-list.md file do not exist in this pull request. Please add the template file or remove this part of the link if it's not yet available.
| announcement should be actionable, and include any mitigating steps users can take prior to | ||
| upgrading to a fixed version. The announcement will be sent via the following channels: | ||
| - General announcement email ([template](comms-templates/distributors-announcement-email.md)) to multiple Volcano lists | ||
| - Tracking issue opened in https://github.com/volcano-sh/volcano/issues ([template](comms-templates/vulnerability-announcement-issue.md)) and prefixed with the associated CVE ID (if applicable) |
There was a problem hiding this comment.
This link to a template is broken. The comms-templates directory and the vulnerability-announcement-issue.md file are not included in this pull request. Please add the template file or remove the link.
|
|
||
| The Volcano community will strictly handle the reporting vulnerability according to this [procedure](security-release-process.md). The following flowchart shows the vulnerability handling process. | ||
|
|
||
| <img src="./images/Vulnerability-handling-process.PNG"> |
There was a problem hiding this comment.
This image link appears to be broken. The images directory and the Vulnerability-handling-process.PNG file are not included in this pull request, which will result in a missing image in the rendered document. Please add the image file to the repository or remove the <img> tag.
| 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. The announcement will be sent via the following channels: | ||
| - General announcement email ([template](comms-templates/distributors-announcement-email.md)) to multiple Volcano lists |
There was a problem hiding this comment.
This link to a template is broken. The comms-templates directory and the distributors-announcement-email.md file are not included in this pull request. Please add the template file or remove the link.
| - lead disclosures that are publicly disclosed or explicitly designated as low sensitivity (often done because of reporter request, a low CVSS score, or design issue that requires long-term refactoring). | ||
| - assisting in process improvements, bug bounty administration, audits, or other non-disclosure activities | ||
|
|
||
| ## Process a undisclosed vulnerability |
There was a problem hiding this comment.
There's a grammatical error in the heading. It should be "an undisclosed" instead of "a undisclosed". This will also require updating the link in the table of contents on line 13.
| ## Process a undisclosed vulnerability | |
| ## Process an undisclosed vulnerability |
| - [Stepping Down](#stepping-down) | ||
| - [Responsibilities](#responsibilities) | ||
| - [Associate](#associate) | ||
| - [Process a undisclosed vulnerability](#process-a-undisclosed-vulnerability) |
There was a problem hiding this comment.
There's a grammatical error here. It should be "an undisclosed" instead of "a undisclosed". The anchor in the link should also be updated to #process-an-undisclosed-vulnerability to match the corrected heading on line 53.
| - [Process a undisclosed vulnerability](#process-a-undisclosed-vulnerability) | |
| - [Process an undisclosed vulnerability](#process-an-undisclosed-vulnerability) |
|
|
||
| If the vulnerability is accepted, its remediation priority, and develop remediations (including mitigations, patches/versions, and other risk mitigations) will be determined. | ||
|
|
||
| The Security Team will launch a CVE procedures to get a CVSS score and CVE ID. The CVSS v3 adopted by the Volcano community assesses the impact of a vulnerability. |
There was a problem hiding this comment.
There's a grammatical error here. It should be "CVE procedures" (plural) or "a CVE procedure" (singular). Based on the context, plural seems more appropriate.
| The Security Team will launch a CVE procedures to get a CVSS score and CVE ID. The CVSS v3 adopted by the Volcano community assesses the impact of a vulnerability. | |
| The Security Team will launch CVE procedures to get a CVSS score and CVE ID. The CVSS v3 adopted by the Volcano community assesses the impact of a vulnerability. |
|
|
||
| Members: | ||
|
|
||
| - Zefeng Wang([@Kevin Wang](https://github.com/kevin-wangzefeng)), [[email protected]](mailto:[email protected]) |
There was a problem hiding this comment.
The display text for Zefeng Wang's GitHub profile link is [@Kevin Wang]. For consistency with other members (e.g., [@Monokaix] on line 29), it would be better to use the GitHub handle kevin-wangzefeng. This also applies to the same entry on line 24.
| - Zefeng Wang([@Kevin Wang](https://github.com/kevin-wangzefeng)), [[email protected]](mailto:[email protected]) | |
| - Zefeng Wang([@kevin-wangzefeng](https://github.com/kevin-wangzefeng)), [[email protected]](mailto:[email protected]) |
|
|
||
| To report a vulnerability, please contact the [Security Team](mailto:[email protected]). You can email the Security Team with the security details and the format follows [Volcano bug reports](https://github.com/volcano-sh/volcano/blob/master/.github/ISSUE_TEMPLATE/bug_report.yaml). | ||
|
|
||
| The team will help diagnose the severity of the issue and determine how to address the issue. The reporter(s) can expect a response within 2 business day acknowledging the issue was received. If a response is not received within 2 business day, please reach out to any Security Team member (listed [here](security-groups.md), under the `The Security Team` section) directly to confirm receipt of the issue. We’ll try to keep you informed about our progress throughout the process. |
There was a problem hiding this comment.
There is a minor grammatical error here. Since the number is 2, "day" should be plural "days".
| The team will help diagnose the severity of the issue and determine how to address the issue. The reporter(s) can expect a response within 2 business day acknowledging the issue was received. If a response is not received within 2 business day, please reach out to any Security Team member (listed [here](security-groups.md), under the `The Security Team` section) directly to confirm receipt of the issue. We’ll try to keep you informed about our progress throughout the process. | |
| The team will help diagnose the severity of the issue and determine how to address the issue. The reporter(s) can expect a response within 2 business days acknowledging the issue was received. If a response is not received within 2 business days, please reach out to any Security Team member (listed [here](security-groups.md), under the `The Security Team` section) directly to confirm receipt of the issue. We’ll try to keep you informed about our progress throughout the process. |
2 participants
Fix #88