Skip to content

Commit 11e96ab

Browse files
committed
update security.md
been a while...
1 parent da812e0 commit 11e96ab

File tree

1 file changed

+22
-15
lines changed

1 file changed

+22
-15
lines changed

SECURITY.md

Lines changed: 22 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This document outlines security procedures and general policies for the pyzmq project.
44

55
- [Reporting a Bug](#reporting-a-bug)
6-
- [Disclosure Policy](#disclosure-policy)
6+
- [Security Process](#security-process)
77
- [Comments on this Policy](#comments-on-this-policy)
88

99
## Reporting a Bug
@@ -12,29 +12,36 @@ Thank you for improving the security of pyzmq. We appreciate your efforts and
1212
responsible disclosure and will make every effort to acknowledge your
1313
contributions.
1414

15-
Report security bugs by emailing the lead maintainer at benjaminrk AT gmail.com.
15+
Please report vulnerabilities via GitHub's security reporting at
16+
https://github.com/zeromq/pyzmq/security/advisories.
17+
You may also report vulnerabilities by emailing the lead maintainer at benjaminrk AT gmail.com.
18+
If you do so, please include your github username if you have one for the vulnerability process.
1619

17-
The lead maintainer will acknowledge your email as promptly as possible,
20+
Maintainers will acknowledge the report as promptly as possible,
1821
and will follow up with a more detailed response.
1922

20-
When the issue is confirmed, a GitHub security advisory will be created to discuss resolutions.
21-
We will endeavor to keep you informed of the progress towards a fix and full
22-
announcement, and may ask for additional information or guidance.
23+
## Security Process
2324

24-
Report security bugs in libzmq itself or other packages to the mainainers of those packages.
25+
If you haven't used GitHub's vulnerability reporting, a draft GitHub security advisory will be created.
26+
The draft advisory will be used to privately discuss fixes and disclosure,
27+
including gathering more information from the reporter, as needed.
28+
After the fix is available to users, the security advisory will be published, usually within 7 days of publishing.
2529

26-
## Disclosure Policy
30+
Report security bugs in libzmq itself or other packages to the maintainers of those packages.
2731

28-
When the security team receives a security bug report, they will assign it to a
29-
primary handler. This person will coordinate the fix and release process,
30-
involving the following steps:
32+
Once the draft advisory is created, we will take the following steps:
3133

3234
- Confirm the problem and determine the affected versions.
3335
- Audit code to find any potential similar problems.
34-
- Prepare fixes for all releases still under maintenance. These fixes will be
35-
released as fast as possible to npm.
36+
- Prepare fixes for all releases still under maintenance.
37+
This will usually be only the current major version.
38+
These fixes will be released as fast as possible to PyPI and conda-forge.
39+
- Notify tidelift.
40+
- Publish GitHub Security Advisory.
41+
42+
The timeline is on a best-effort basis.
3643

3744
## Comments on this Policy
3845

39-
If you have suggestions on how this process could be improved please submit a
40-
pull request.
46+
Feel free to open a pull request or issue to suggest improvements to this process.
47+
Contributions welcome!

0 commit comments

Comments
 (0)