2018-04-17 12:50:16 -04:00
<!--
# Read me first!
2019-12-18 13:08:04 -05:00
Create this issue under https://gitlab.com/gitlab-org/security
2018-04-17 12:50:16 -04:00
2019-01-28 06:21:42 -05:00
Set the title to: `Description of the original issue`
2018-04-17 12:50:16 -04:00
-->
2019-12-18 13:08:04 -05:00
## Prior to starting the security release work
2018-04-17 12:50:16 -04:00
- [ ] Read the [security process for developers] if you are not familiar with it.
2020-02-24 19:09:12 -05:00
- [ ] Mark this [issue as related] to the Security Release tracking issue. You can find it on the topic of the `#releases` Slack channel.
2019-12-18 13:08:04 -05:00
- [ ] Run `scripts/security-harness` in your local repository to prevent accidentally pushing to any remote besides `gitlab.com/gitlab-org/security` .
2020-02-24 19:09:12 -05:00
- Fill out the [Links section ](#links ):
- [ ] Next to **Issue on GitLab** , add a link to the `gitlab-org/gitlab` issue that describes the security vulnerability.
- [ ] Next to **Security Release tracking issue** , add a link to the security release issue that will include this security issue.
2018-04-17 12:50:16 -04:00
2019-12-18 13:08:04 -05:00
## Development
2018-04-17 12:50:16 -04:00
2019-12-18 13:08:04 -05:00
- [ ] Create a new branch prefixing it with `security-` .
- [ ] Create a merge request targeting `master` on `gitlab.com/gitlab-org/security` and use the [Security Release merge request template].
- [ ] Follow the same [code review process]: Assign to a reviewer, then to a maintainer.
2018-04-17 12:50:16 -04:00
2020-03-18 14:09:35 -04:00
After your merge request has been approved according to our [approval guidelines], you're ready to prepare the backports
2019-12-18 13:08:04 -05:00
## Backports
2018-04-17 12:50:16 -04:00
2019-12-18 13:08:04 -05:00
- [ ] Once the MR is ready to be merged, create MRs targeting the latest 3 stable branches
* At this point, it might be easy to squash the commits from the MR into one
* You can use the script `bin/secpick` instead of the following steps, to help you cherry-picking. See the [secpick documentation]
- [ ] Create each MR targeting the stable branch `X-Y-stable` , using the [Security Release merge request template].
* Every merge request will have its own set of TODOs, so make sure to complete those.
2020-02-24 19:09:12 -05:00
- [ ] On the "Related merge requests" section, ensure all MRs are linked to this issue.
* This section should only list the merge requests created for this issue: One targeting `master` and the 3 backports.
2019-12-18 13:08:04 -05:00
## Documentation and final details
2018-04-17 12:50:16 -04:00
2019-12-18 13:08:04 -05:00
- [ ] Ensure the [Links section ](#links ) is completed.
2020-04-29 17:09:31 -04:00
- [ ] Add the GitLab [versions ](https://gitlab.com/gitlab-org/release/docs/-/blob/master/general/security/developer.md#versions-affected ) and editions affected to the [details section ](#details )
2020-04-21 20:09:24 -04:00
* The Git history of the files affected may help you associate the issue with a [release ](https://about.gitlab.com/releases/ )
2018-04-17 12:50:16 -04:00
- [ ] Fill in any upgrade notes that users may need to take into account in the [details section ](#details )
- [ ] Add Yes/No and further details if needed to the migration and settings columns in the [details section ](#details )
2018-04-18 05:37:55 -04:00
- [ ] Add the nickname of the external user who found the issue (and/or HackerOne profile) to the Thanks row in the [details section ](#details )
2018-11-29 14:24:12 -05:00
- [ ] Once your `master` MR is merged, comment on the original security issue with a link to that MR indicating the issue is fixed.
2018-04-17 12:50:16 -04:00
2019-12-18 13:08:04 -05:00
## Summary
2018-06-01 15:39:38 -04:00
2019-12-18 13:08:04 -05:00
### Links
2018-04-17 12:50:16 -04:00
| Description | Link |
| -------- | -------- |
2020-02-24 19:09:12 -05:00
| Issue on [GitLab ](https://gitlab.com/gitlab-org/gitlab/issues ) | #TODO |
| Security Release tracking issue | #TODO |
2018-04-17 12:50:16 -04:00
2019-12-18 13:08:04 -05:00
### Details
2018-04-17 12:50:16 -04:00
| Description | Details | Further details|
| -------- | -------- | -------- |
| Versions affected | X.Y | |
2020-04-29 17:09:31 -04:00
| GitLab EE only | Yes/No | |
2018-04-17 12:50:16 -04:00
| Upgrade notes | | |
| GitLab Settings updated | Yes/No| |
| Migration required | Yes/No | |
2018-04-18 05:37:55 -04:00
| Thanks | | |
2018-04-17 12:50:16 -04:00
2018-04-18 05:37:55 -04:00
[security process for developers]: https://gitlab.com/gitlab-org/release/docs/blob/master/general/security/developer.md
2019-12-18 13:08:04 -05:00
[secpick documentation]: https://gitlab.com/gitlab-org/release/docs/blob/master/general/security/developer.md#secpick-script
[security Release merge request template]: https://gitlab.com/gitlab-org/security/gitlab/blob/master/.gitlab/merge_request_templates/Security%20Release.md
[code review process]: https://docs.gitlab.com/ee/development/code_review.html
[approval guidelines]: https://docs.gitlab.com/ee/development/code_review.html#approval-guidelines
2020-02-24 19:09:12 -05:00
[issue as related]: https://docs.gitlab.com/ee/user/project/issues/related_issues.html#adding-a-related-issue
2018-04-17 12:50:16 -04:00
2018-08-15 03:27:59 -04:00
/label ~security