mirror of
https://github.com/moparisthebest/curl
synced 2024-12-24 17:18:48 -05:00
e9605dbda2
Use proper Markdown hyperlink format for the Bountygraph links in order for the generated website page to be more user friendly. Also link to the sponsors to give them a little extra credit. Closes #3082 Reviewed-by: Daniel Stenberg <daniel@haxx.se>
154 lines
6.4 KiB
Markdown
154 lines
6.4 KiB
Markdown
curl security process
|
|
=====================
|
|
|
|
This document describes how security vulnerabilities should be handled in the
|
|
curl project.
|
|
|
|
Publishing Information
|
|
----------------------
|
|
|
|
All known and public curl or libcurl related vulnerabilities are listed on
|
|
[the curl web site security page](https://curl.haxx.se/docs/security.html).
|
|
|
|
Security vulnerabilities should not be entered in the project's public bug
|
|
tracker unless the necessary configuration is in place to limit access to the
|
|
issue to only the reporter and the project's security team.
|
|
|
|
Vulnerability Handling
|
|
----------------------
|
|
|
|
The typical process for handling a new security vulnerability is as follows.
|
|
|
|
No information should be made public about a vulnerability until it is
|
|
formally announced at the end of this process. That means, for example that a
|
|
bug tracker entry must NOT be created to track the issue since that will make
|
|
the issue public and it should not be discussed on any of the project's public
|
|
mailing lists. Also messages associated with any commits should not make
|
|
any reference to the security nature of the commit if done prior to the public
|
|
announcement.
|
|
|
|
- The person discovering the issue, the reporter, reports the vulnerability
|
|
privately to `curl-security@haxx.se`. That's an email alias that reaches a
|
|
handful of selected and trusted people.
|
|
|
|
- Messages that do not relate to the reporting or managing of an undisclosed
|
|
security vulnerability in curl or libcurl are ignored and no further action
|
|
is required.
|
|
|
|
- A person in the security team sends an e-mail to the original reporter to
|
|
acknowledge the report.
|
|
|
|
- The security team investigates the report and either rejects it or accepts
|
|
it.
|
|
|
|
- If the report is rejected, the team writes to the reporter to explain why.
|
|
|
|
- If the report is accepted, the team writes to the reporter to let him/her
|
|
know it is accepted and that they are working on a fix.
|
|
|
|
- The security team discusses the problem, works out a fix, considers the
|
|
impact of the problem and suggests a release schedule. This discussion
|
|
should involve the reporter as much as possible.
|
|
|
|
- The release of the information should be "as soon as possible" and is most
|
|
often synced with an upcoming release that contains the fix. If the
|
|
reporter, or anyone else, thinks the next planned release is too far away
|
|
then a separate earlier release for security reasons should be considered.
|
|
|
|
- Write a security advisory draft about the problem that explains what the
|
|
problem is, its impact, which versions it affects, solutions or workarounds,
|
|
when the release is out and make sure to credit all contributors properly.
|
|
Figure out the CWE (Common Weakness Enumeration) number for the flaw.
|
|
|
|
- Request a CVE number from
|
|
[distros@openwall](https://oss-security.openwall.org/wiki/mailing-lists/distros)
|
|
when also informing and preparing them for the upcoming public security
|
|
vulnerability announcement - attach the advisory draft for information. Note
|
|
that 'distros' won't accept an embargo longer than 14 days and they do not
|
|
care for Windows-specific flaws. For windows-specific flaws, request CVE
|
|
directly from MITRE.
|
|
|
|
- Update the "security advisory" with the CVE number.
|
|
|
|
- The security team commits the fix in a private branch. The commit message
|
|
should ideally contain the CVE number. This fix is usually also distributed
|
|
to the 'distros' mailing list to allow them to use the fix prior to the
|
|
public announcement.
|
|
|
|
- No more than 48 hours before the release, the private branch is merged into
|
|
the master branch and pushed. Once pushed, the information is accessible to
|
|
the public and the actual release should follow suit immediately afterwards.
|
|
The time between the push and the release is used for final tests and
|
|
reviews.
|
|
|
|
- The project team creates a release that includes the fix.
|
|
|
|
- The project team announces the release and the vulnerability to the world in
|
|
the same manner we always announce releases. It gets sent to the
|
|
curl-announce, curl-library and curl-users mailing lists.
|
|
|
|
- The security web page on the web site should get the new vulnerability
|
|
mentioned.
|
|
|
|
curl-security (at haxx dot se)
|
|
------------------------------
|
|
|
|
Who is on this list? There are a couple of criteria you must meet, and then we
|
|
might ask you to join the list or you can ask to join it. It really isn't very
|
|
formal. We basically only require that you have a long-term presence in the
|
|
curl project and you have shown an understanding for the project and its way
|
|
of working. You must've been around for a good while and you should have no
|
|
plans in vanishing in the near future.
|
|
|
|
We do not make the list of participants public mostly because it tends to vary
|
|
somewhat over time and a list somewhere will only risk getting outdated.
|
|
|
|
Publishing Security Advisories
|
|
------------------------------
|
|
|
|
1. Write up the security advisory, using markdown syntax. Use the same
|
|
subtitles as last time to maintain consistency.
|
|
|
|
2. Name the advisory file after the allocated CVE id.
|
|
|
|
3. Add a line on the top of the array in `curl-www/docs/vuln.pm'.
|
|
|
|
4. Put the new advisory markdown file in the curl-www/docs/ directory. Add it
|
|
to the git repo.
|
|
|
|
5. Run `make` in your local web checkout and verify that things look fine.
|
|
|
|
6. On security advisory release day, push the changes on the curl-www
|
|
repository's remote master branch.
|
|
|
|
Bountygraph Bug Bounty
|
|
----------------------
|
|
|
|
The curl project runs a bug bounty program in association with
|
|
bountygraph.com.
|
|
|
|
After you have reported a security issue to the curl project, it has been
|
|
deemed credible and a patch and advisory has been made public you can be
|
|
eligible for a bounty from this program.
|
|
|
|
See all details at [BountyGraph](https://bountygraph.com/programs/curl).
|
|
|
|
This bounty is relying on funds from
|
|
[sponsors](https://bountygraph.com/programs/curl#publicpledges). If you use
|
|
curl professionally, consider help funding this!
|
|
|
|
Hackerone Internet Bug Bounty
|
|
-----------------------------
|
|
|
|
This bounty program is run by an independent outside organization: Hackerone.
|
|
First report your issue the normal way and proceed as described in this
|
|
document.
|
|
|
|
Then, if the issue is [critical](https://hackerone.com/ibb-data), you are
|
|
eligible to apply for a bounty from Hackerone for your find.
|
|
|
|
Once your reported vulnerability has been publicly disclosed by the curl
|
|
project, you can submit a [report to them](https://hackerone.com/ibb-data).
|
|
|
|
You will not be able to claim bounties from more than one bounty program.
|