gitlab-org--gitlab-foss/doc/release/security.md

77 lines
3.7 KiB
Markdown
Raw Normal View History

2013-11-14 13:40:05 -05:00
# Things to do when doing an out-of-bound security release
2014-05-27 08:12:15 -04:00
2013-11-14 13:40:05 -05:00
NOTE: This is a guide for GitLab developers. If you are trying to install GitLab see the latest stable [installation guide](install/installation.md) and if you are trying to upgrade, see the [upgrade guides](update).
## When to do a security release
2014-04-24 18:48:22 -04:00
Do a security release when there is a critical issue that needs to be addresses before the next monthly release. Otherwise include it in the monthly release and note there was a security fix in the release announcement.
2013-11-14 13:40:05 -05:00
## Security vulnerability disclosure
Please report suspected security vulnerabilities in private to <support@gitlab.com>, also see the [disclosure section on the GitLab.com website](http://about.gitlab.com/disclosure/). Please do NOT create publicly viewable issues for suspected security vulnerabilities.
2013-11-14 13:40:05 -05:00
## Release Procedure
2014-04-24 18:48:22 -04:00
1. Verify that the issue can be reproduced
2013-11-14 13:40:05 -05:00
1. Acknowledge the issue to the researcher that disclosed it
1. Inform the release manager that there needs to be a security release
1. Do the steps from [patch release document](doc/release/patch.md), starting with "Create an issue on private GitLab development server"
1. The MR with the security fix should get a 'security' label and be assigned to the release manager
1. Build the package for GitLab.com and do a deploy
1. Build the package for ci.gitLab.com and do a deploy
1. [Create new AMIs](https://dev.gitlab.org/gitlab/AMI/blob/master/README.md)
2014-03-10 12:40:40 -04:00
1. Create feature branches for the blog post on GitLab.com and link them from the code branch
2013-11-14 13:40:05 -05:00
1. Merge and publish the blog posts
2014-04-24 18:48:22 -04:00
1. Send tweets about the release from `@gitlabhq`
2013-11-14 13:40:05 -05:00
1. Send out an email to [the community google mailing list](https://groups.google.com/forum/#!forum/gitlabhq)
2015-03-09 20:38:42 -04:00
1. Post a signed copy of our complete announcement to [oss-security](http://www.openwall.com/lists/oss-security/) and request a CVE number. CVE is only needed for bugs that allow someone to own the server (Remote Code Execution) or access to code of projects they are not a member of.
1. Add the security researcher to the [Security Researcher Acknowledgments list](http://about.gitlab.com/vulnerability-acknowledgements/)
2013-11-14 13:40:05 -05:00
1. Thank the security researcher in an email for their cooperation
2014-04-24 18:48:22 -04:00
1. Update the blog post and the CHANGELOG when we receive the CVE number
2013-11-17 08:46:04 -05:00
The timing of the code merge into master should be coordinated in advance.
2014-04-24 18:48:22 -04:00
2013-11-17 08:46:04 -05:00
After the merge we strive to publish the announcements within 60 minutes.
2013-11-14 13:40:05 -05:00
## Blog post template
XXX Security Advisory for GitLab
2014-04-24 18:48:22 -04:00
A recently discovered critical vulnerability in GitLab allows [unauthenticated API access|remote code execution|unauthorized access to repositories|XXX|PICKSOMETHING]. All users should update GitLab and gitlab-shell immediately. We [have|haven't|XXX|PICKSOMETHING|] heard of this vulnerability being actively exploited.
2013-11-14 13:40:05 -05:00
### Version affected
GitLab Community Edition XXX and lower
2014-04-24 18:48:22 -04:00
2013-11-14 13:40:05 -05:00
GitLab Enterprise Edition XXX and lower
### Fixed versions
GitLab Community Edition XXX and up
2014-04-24 18:48:22 -04:00
2013-11-14 13:40:05 -05:00
GitLab Enterprise Edition XXX and up
### Impact
On GitLab installations which use MySQL as their database backend it is possible for an attacker to assume the identity of any existing GitLab user in certain API calls. This attack can be performed by [unauthenticated|authenticated|XXX|PICKSOMETHING] users.
### Workarounds
If you are unable to upgrade you should apply the following patch and restart GitLab.
XXX
### Credit
We want to thank XXX of XXX for the responsible disclosure of this vulnerability.
2013-11-14 13:40:05 -05:00
## Email template
We just announced a security advisory for GitLab at XXX
Please contact us at support@gitlab.com if you have any questions.
## Tweet template
We just announced a security advisory for GitLab at XXX