Skip to content

Commit

Permalink
fix links in security process doc (#5683)
Browse files Browse the repository at this point in the history
Signed-off-by: Steve Kriss <krisss@vmware.com>
  • Loading branch information
skriss authored Aug 15, 2023
1 parent f6e349a commit acc15db
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion site/content/resources/security-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This document outlines a checklist for Contour security team members (at time of
The information that members receive on the Contour Distributors mailing list must not be made public, shared, or even hinted at anywhere beyond those who need to know within your specific team, unless you receive explicit approval to do so from the Contour Security Team. This remains true until the public disclosure date/time agreed upon by the list. Members of the list and others cannot use the information for any reason other than to get the issue fixed for your respective distribution's users.
Before you share any information from the list with members of your team who are required to fix the issue, these team members must agree to the same terms, and only be provided with information on a need-to-know basis.
In the unfortunate event that you share information beyond what is permitted by this policy, you must urgently inform the [Contour Security Team](https://github.com/projectcontour/contour/security/policy#mailing-lists) of exactly what information was leaked and to whom. If you continue to leak information and break the policy outlined here, you will be permanently removed from the list.
In the unfortunate event that you share information beyond what is permitted by this policy, you must urgently inform the [Contour Security Team](https://projectcontour.io/resources/security-process#mailing-lists) of exactly what information was leaked and to whom. If you continue to leak information and break the policy outlined here, you will be permanently removed from the list.
```
- Add #security tag to message
1. Release patches for all supported minors
Expand Down
14 changes: 7 additions & 7 deletions site/content/resources/security-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ layout: page
Contour is a growing community devoted in creating the most secure, performant, scalable, and available ingress controller for Kubernetes. The community has adopted this security disclosure and response policy to ensure we responsibly handle critical issues.

## Supported Versions
The Contour project maintains the following [document on the release process and support matrix](./RELEASES.md). Please refer to it for release related details.
The Contour project maintains the following [document on the release process and support matrix](https://github.com/projectcontour/contour/blob/main/RELEASES.md). Please refer to it for release related details.

## Reporting a Vulnerability - Private Disclosure Process
Security is of the highest importance and all security vulnerabilities or suspected security vulnerabilities should be reported to Contour privately, to minimize attacks against current users of Contour before they are fixed. Vulnerabilities will be investigated and patched on the next patch (or minor) release as soon as possible. This information could be kept entirely internal to the project.

If you know of a publicly disclosed security vulnerability for Contour, please **IMMEDIATELY** [contact](https://github.com/projectcontour/contour/security/policy#mailing-lists) the Contour Security Team.
If you know of a publicly disclosed security vulnerability for Contour, please **IMMEDIATELY** [contact](https://projectcontour.io/resources/security-process#mailing-lists) the Contour Security Team.

**IMPORTANT: Do not file public issues on GitHub for security vulnerabilities**

To report a vulnerability or a security-related issue, please contact the [Contour private email address](https://github.com/projectcontour/contour/security/policy#mailing-lists) with the details of the vulnerability. The email will be fielded by the Contour Security Team, which is made up of Contour maintainers who have committer and release permissions. Emails will be addressed within 3 business days, including a detailed plan to investigate the issue and any potential workarounds to perform in the meantime. Do not report non-security-impacting bugs through this channel. Use [GitHub issues](https://github.com/ProjectContour/Contour/issues/new/choose) instead.
To report a vulnerability or a security-related issue, please contact the [Contour private email address](https://projectcontour.io/resources/security-process#mailing-lists) with the details of the vulnerability. The email will be fielded by the Contour Security Team, which is made up of Contour maintainers who have committer and release permissions. Emails will be addressed within 3 business days, including a detailed plan to investigate the issue and any potential workarounds to perform in the meantime. Do not report non-security-impacting bugs through this channel. Use [GitHub issues](https://github.com/projectcontour/contour/issues/new/choose) instead.

### Proposed Email Content
Provide a descriptive subject line and in the body of the email include the following information:
Expand All @@ -38,18 +38,18 @@ The Contour Security Team will respond to vulnerability reports as follows:
4. If a vulnerability is acknowledged and the timeline for a fix is determined, the Security Team will work on a plan to communicate with the appropriate community, including identifying mitigating steps that affected users can take to protect themselves until the fix is rolled out.
5. The Security Team will also create a [CVSS](https://www.first.org/cvss/specification-document) using the [CVSS Calculator](https://www.first.org/cvss/calculator/3.0). The Security Team makes the final call on the calculated CVSS; it is better to move quickly than making the CVSS perfect. Issues may also be reported to [Mitre](https://cve.mitre.org/) using this [scoring calculator](https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator). The CVE will initially be set to private.
6. The Security Team will work on fixing the vulnerability and perform internal testing before preparing to roll out the fix.
7. The Security Team will provide early disclosure of the vulnerability by emailing the [Contour Distributors mailing list](https://github.com/projectcontour/contour/security/policy#mailing-lists). Distributors can initially plan for the vulnerability patch ahead of the fix, and later can test the fix and provide feedback to the Contour team. See the section **Early Disclosure to Contour Distributors List** for details about how to join this mailing list.
7. The Security Team will provide early disclosure of the vulnerability by emailing the [Contour Distributors mailing list](https://projectcontour.io/resources/security-process#mailing-lists). Distributors can initially plan for the vulnerability patch ahead of the fix, and later can test the fix and provide feedback to the Contour team. See the section **Early Disclosure to Contour Distributors List** for details about how to join this mailing list.
8. A public disclosure date is negotiated by the Contour Security Team, the bug submitter, and the distributors list. We prefer to fully disclose the bug as soon as possible once a user mitigation or patch is available. It is reasonable to delay disclosure when the bug or the fix is not yet fully understood, the solution is not well-tested, or for distributor coordination. The timeframe for disclosure is from immediate (especially if it’s already publicly known) to a few weeks. For a critical vulnerability with a straightforward mitigation, we expect report date to public disclosure date to be on the order of 14 business days. The Contour Security Team holds the final say when setting a public disclosure date.
9. Once the fix is confirmed, the Security Team will patch the vulnerability in the next patch or minor release, and backport a patch release into all earlier supported releases. Upon release of the patched version of Contour, we will follow the **Public Disclosure Process**.

### Public Disclosure Process
The Security Team publishes a public [advisory](https://github.com/ProjectContour/Contour/security/advisories) to the Contour community via GitHub. In most cases, additional communication via Slack, Twitter, mailing lists, blog and other channels will assist in educating Contour users and rolling out the patched release to affected users.
The Security Team publishes a public [advisory](https://github.com/projectcontour/contour/security/advisories) to the Contour community via GitHub. In most cases, additional communication via Slack, Twitter, mailing lists, blog and other channels will assist in educating Contour users and rolling out the patched release to affected users.

The Security Team will also publish any mitigating steps users can take until the fix can be applied to their Contour instances. Contour distributors will handle creating and publishing their own security advisories.

## Mailing lists
- Use cncf-contour-maintainers@lists.cncf.io to report security concerns to the Contour Security Team, who uses the list to privately discuss security issues and fixes prior to disclosure.
- Join the [Contour Distributors mailing list](https://github.com/projectcontour/contour/security/policy#requesting-to-join) for early private information and vulnerability disclosure. Early disclosure may include mitigating steps and additional information on security patch releases. See below for information on how Contour distributors or vendors can apply to join this list.
- Join the [Contour Distributors mailing list](https://projectcontour.io/resources/security-process/#requesting-to-join) for early private information and vulnerability disclosure. Early disclosure may include mitigating steps and additional information on security patch releases. See below for information on how Contour distributors or vendors can apply to join this list.

## Early Disclosure to Contour Distributors List
The private list cncf-contour-distributors-announce@lists.cncf.io is intended to be used primarily to provide actionable information to multiple distributor projects at once. This list is not intended to inform individuals about security issues.
Expand All @@ -70,7 +70,7 @@ To be eligible to join the Contour Distributors mailing list, you should:
The information that members receive on the Contour Distributors mailing list must not be made public, shared, or even hinted at anywhere beyond those who need to know within your specific team, unless you receive explicit approval to do so from the Contour Security Team. This remains true until the public disclosure date/time agreed upon by the list. Members of the list and others cannot use the information for any reason other than to get the issue fixed for your respective distribution's users.
Before you share any information from the list with members of your team who are required to fix the issue, these team members must agree to the same terms, and only be provided with information on a need-to-know basis.

In the unfortunate event that you share information beyond what is permitted by this policy, you must urgently inform the [Contour Security Team](https://github.com/projectcontour/contour/security/policy#mailing-lists) of exactly what information was leaked and to whom. If you continue to leak information and break the policy outlined here, you will be permanently removed from the list.
In the unfortunate event that you share information beyond what is permitted by this policy, you must urgently inform the [Contour Security Team](https://projectcontour.io/resources/security-process#mailing-lists) of exactly what information was leaked and to whom. If you continue to leak information and break the policy outlined here, you will be permanently removed from the list.

### Requesting to Join
Send new membership requests to cncf-contour-maintainers@lists.cncf.io. In the body of your request please specify how you qualify for membership and fulfill each criterion listed in the Membership Criteria section above.
Expand Down

0 comments on commit acc15db

Please sign in to comment.