volcano.sh/apis@v1.8.2/SECURITY.md (about)

     1  # Security Release Process
     2  
     3  The Volcano project has adopted this security disclosures and response policy
     4  to ensure responsible handling of critical issues.
     5  
     6  
     7  ## Product Security Team (PST)
     8  
     9  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 known exploits.
    10  
    11  The Product Security Team (PST) is responsible for organizing the entire response including internal communication and external disclosure.
    12  
    13  The initial Product Security Team will consist of all maintainers in the private [volcano-security](volcano-security@googlegroups.com) list. In the future we may decide to have a subset of maintainers work on security response given that this process is time consuming.
    14  
    15  
    16  ## Disclosures
    17  
    18  ### Private Disclosure Processes
    19  
    20  If you find a security vulnerability or any security related issues,
    21  please DO NOT file a public issue. Do not create a Github issue.
    22  Instead, send your report privately to [volcano-security](volcano-security@googlegroups.com).
    23  Security reports are greatly appreciated and we will publicly thank you for it.
    24  
    25  Please provide as much information as possible, so we can react quickly.
    26  For instance, that could include:
    27  - Description of the location and potential impact of the vulnerability;
    28  - A detailed description of the steps required to reproduce the vulnerability (POC scripts, screenshots, and compressed packet captures are all helpful to us)
    29  - Whatever else you think we might need to identify the source of this vulnerability
    30  
    31  ### Public Disclosure Processes
    32  
    33  If you know of a publicly disclosed security vulnerability please IMMEDIATELY email [volcano-security](volcano-security@googlegroups.com)
    34  to inform the Product Security Team (PST) about the vulnerability so we start the patch, release, and communication process.
    35  
    36  If possible the PST will ask the person making the public report if the issue can be handled via a private disclosure process
    37  (for example if the full exploit details have not yet been published).
    38  If the reporter denies the request for private disclosure, the PST will move swiftly with the fix and release process.
    39  In extreme cases you can ask GitHub to delete the issue but this generally isn't necessary and is unlikely to make a public disclosure less damaging.
    40  
    41  ## Patch, Release, and Public Communication
    42  
    43  For each vulnerability a member of the PST will volunteer to lead coordination with the "Fix Team"
    44  and is responsible for sending disclosure emails to the rest of the community.
    45  This lead will be referred to as the "Fix Lead."
    46  
    47  The role of Fix Lead should rotate round-robin across the PST.
    48  
    49  Note that given the current size of the Volcano community it is likely that the PST is the same as the "Fix team."
    50  The PST may decide to bring in additional contributors for added expertise depending on the area of the code that contains the vulnerability.
    51  
    52  All of the timelines below are suggestions and assume a Private Disclosure.
    53  If the Team is dealing with a Public Disclosure all timelines become ASAP.
    54  If the fix relies on another upstream project's disclosure timeline, that will adjust the process as well.
    55  We will work with the upstream project to fit their timeline and best protect our users.
    56  
    57  ### Fix Team Organization
    58  
    59  These steps should be completed within the first 24 hours of disclosure.
    60  
    61  - The Fix Lead will work quickly to identify relevant engineers from the affected projects and
    62    packages and CC those engineers into the disclosure thread. These selected developers are the Fix
    63    Team.
    64  - The Fix Lead will get the Fix Team access to private security repos to develop the fix.
    65  
    66  
    67  ### Fix Development Process
    68  
    69  These steps should be completed within the 1-7 days of Disclosure.
    70  
    71  - The Fix Lead and the Fix Team will create a
    72    [CVSS](https://www.first.org/cvss/specification-document) using the [CVSS
    73    Calculator](https://www.first.org/cvss/calculator/3.0). The Fix Lead makes the final call on the
    74    calculated CVSS; it is better to move quickly than making the CVSS perfect.
    75  - The Fix Team will notify the Fix Lead that work on the fix branch is complete once there are LGTMs
    76    on all commits in the private repo from one or more maintainers.
    77  
    78  If the CVSS score is under 4.0 ([a low severity
    79  score](https://www.first.org/cvss/specification-document#i5)) the Fix Team can decide to slow the
    80  release process down in the face of holidays, developer bandwidth, etc. These decisions must be
    81  discussed on the volcano-security mailing list.
    82  
    83  ### Fix Disclosure Process
    84  
    85  With the Fix Development underway the Volcano Security Team needs to come up with an overall communication plan for the wider community.
    86  This Disclosure process should begin after the Team has developed a fix or mitigation
    87  so that a realistic timeline can be communicated to users.
    88  
    89  **Disclosure of Forthcoming Fix to Users** (Completed within 1-7 days of Disclosure)
    90  
    91  - The Fix Lead will create a github issue in Volcano project to inform users that a security vulnerability
    92  has been disclosed and that a fix will be made available, with an estimation of the Release Date.
    93  It will include any mitigating steps users can take until a fix is available.
    94  
    95  The communication to users should be actionable.
    96  They should know when to block time to apply patches, understand exact mitigation steps, etc.
    97  
    98  **Optional Fix Disclosure to Private Distributors List** (Completed within 1-14 days of Disclosure):
    99  
   100  - The Fix Lead will make a determination with the help of the Fix Team if an issue is critical enough to require early disclosure to distributors.
   101  Generally this Private Distributor Disclosure process should be reserved for remotely exploitable or privilege escalation issues.
   102  Otherwise, this process can be skipped.
   103  - The Fix Lead will email the patches to volcano-distributors-announce@lists.cncf.io so distributors can prepare their own release to be available to users on the day of the issue's announcement.
   104  Distributors should read about the [Private Distributor List](#private-distributor-list) to find out the requirements for being added to this list.
   105  - **What if a distributor breaks embargo?** The PST will assess the damage and may make the call to release earlier or continue with the plan.
   106  When in doubt push forward and go public ASAP.
   107  
   108  **Fix Release Day** (Completed within 1-21 days of Disclosure)
   109  
   110  - the Fix Team will selectively choose all needed commits from the Master branch in order to create a new release on top of the current last version released.
   111  - Release process will be as usual.
   112  - The Fix Lead will request a CVE from [DWF](https://github.com/distributedweaknessfiling/DWF-Documentation)
   113    and include the CVSS and release details.
   114  - The Fix Lead will inform all users, devs and integrators, now that everything is public,
   115    announcing the new releases, the CVE number, and the relevant merged PRs to get wide distribution
   116    and user action. As much as possible this email should be actionable and include links on how to apply
   117    the fix to user's environments; this can include links to external distributor documentation.
   118  
   119  
   120  ## Private Distributor List
   121  
   122  This list is intended to be used primarily to provide actionable information to
   123  multiple distributor projects at once. This list is not intended for
   124  individuals to find out about security issues.
   125  
   126  ### Embargo Policy
   127  
   128  The information members receive on volcano-distributors-announce@lists.cncf.io must not be
   129  made public, shared, nor even hinted at anywhere beyond the need-to-know within
   130  your specific team except with the list's explicit approval.
   131  This holds true until the public disclosure date/time that was agreed upon by the list.
   132  Members of the list and others may not use the information for anything other
   133  than getting the issue fixed for your respective distribution's users.
   134  
   135  Before any information from the list is shared with respective members of your
   136  team required to fix said issue, they must agree to the same terms and only
   137  find out information on a need-to-know basis.
   138  
   139  In the unfortunate event you share the information beyond what is allowed by this policy, you must urgently inform the volcano-security@googlegroups.com mailing list of exactly what information leaked and to whom. A retrospective will take place after the leak so we can assess how to prevent making the same mistake in the future.
   140  
   141  If you continue to leak information and break the policy outlined here, you
   142  will be removed from the list.
   143  
   144  ### Contributing Back
   145  
   146  This is a team effort. As a member of the list you must carry some water. This
   147  could be in the form of the following:
   148  
   149  **Technical**
   150  
   151  - Review and/or test the proposed patches and point out potential issues with
   152    them (such as incomplete fixes for the originally reported issues, additional
   153    issues you might notice, and newly introduced bugs), and inform the list of the
   154    work done even if no issues were encountered.
   155  
   156  **Administrative**
   157  
   158  - Help draft emails to the public disclosure mailing list.
   159  - Help with release notes.
   160  
   161  ### Membership Criteria
   162  
   163  To be eligible for the volcano-distributors-announce@lists.cncf.io mailing list, your
   164  distribution should:
   165  
   166  1. Be an active distributor of Volcano.
   167  2. Have a user base not limited to your own organization.
   168  3. Have a publicly verifiable track record up to present day of fixing security
   169     issues.
   170  4. Not be a downstream or rebuild of another distributor.
   171  5. Be a participant and active contributor in the community.
   172  6. Accept the [Embargo Policy](#embargo-policy) that is outlined above.
   173  7. Have someone already on the list vouch for the person requesting membership
   174     on behalf of your distribution.
   175  
   176  ### Requesting to Join
   177  
   178  New membership requests are sent to volcano-security@googlegroups.com.
   179  
   180  In the body of your request please specify how you qualify and fulfill each
   181  criterion listed in [Membership Criteria](#membership-criteria).
   182