Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#12023 Add GitHub security policy #12024

Merged
merged 5 commits into from
Nov 6, 2023
Merged

Conversation

adiroiban
Copy link
Member

@adiroiban adiroiban commented Oct 25, 2023

Scope and purpose

Fixes #12023

Right now the main "Security" page for twisted/twisted looks like

image

We would like have the security info right away. something like electron

image


In order to actual see the result of this PR, it needs to be merged

You can view the content of the file at https://github.com/twisted/twisted/blob/12023-github-security-policy/.SECURITY.md

@adiroiban
Copy link
Member Author

I left the file as /SECURITY.md to be as visible as possible

For now SECURITY.md has the same content as docs/security.rst

Maybe /SECURITY.md can be brief, just an introduction and then link to our full security reporting page

What do you think

needs-review

We take security very seriously.
Your input and feedback on our security is always appreciated.

You can send urgent or sensitive reports directly to security@twistedmatrix.com
You can send urgent or sensitive reports via `GitHub Security Advisory <https://github.com/twisted/twisted/security/advisories/new>`_.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that we should also add a big warning at the start of this document, to mention that any security PR should be done via private repos using the GitHub functionalty.

Otherwise, by creating a normal PR the bug is disclosed before the fix being ready :)

docs/security.rst Outdated Show resolved Hide resolved
.SECURITY.md Outdated Show resolved Hide resolved
@adiroiban
Copy link
Member Author

The file should be SECURITY.md
I will try to get this fixed.

@adiroiban
Copy link
Member Author

The rename is done.

My suggetion is to keep SECURITY.MD brief.

Just inform that security reports should be done by clicking the button from top right.

Inform that no public ticket or public PR should be made for this issue, and that the GitHub process will handle the privacy.

Also provide a link to the security.rst full docs.

What do you think?

@adiroiban
Copy link
Member Author

As we try to receive money from Tidelift, for each CVE we will need to answer to these questions:

  • Does this vulnerability still apply when the package is only used as a build tool or dev/test dependency? YES | NO
  • Does this vulnerability apply only if certain methods, classes, or functionality are in use? YES | NO
  • Please list the affected classes, methods, functionality: TEXTARE
  • Are there any other conditions that users should check for to determine if they're vulnerable? YES|NO
  • Please describe the conditions users should check for: TEXTAREA
  • For users who are unable to upgrade to a supported release, is there a workaround available? YES | NO
  • When using the package as intended, how likely is it that users are affected by this vulnerability? Scale 0 - 10 (0 not likely - 10 highly likely)
  • Please explain: TEXTAREA
  • Please select the releases affected by this vulnerability. CHECKBOXES

I see that for previous CVEs (Twisted releases), someone from Tidelift has already answered these questions.


I think that the questions are reasonable, and we might want include them in the release notes for a security issue.

@glyph
Copy link
Member

glyph commented Nov 6, 2023

My suggetion is to keep SECURITY.MD brief.

Just inform that security reports should be done by clicking the button from top right.

Inform that no public ticket or public PR should be made for this issue, and that the GitHub process will handle the privacy.

Also provide a link to the security.rst full docs.

What do you think?

I'd say let's just land this since it seems mostly fine, and possibly do the clean-up you're suggesting in a follow-up.

@adiroiban
Copy link
Member Author

Thanks for the review. I have enabled the auto-merge.
There was a new flaky macos tests and I opened a new ticket to track it

@adiroiban adiroiban merged commit 311d8db into trunk Nov 6, 2023
23 checks passed
@adiroiban adiroiban deleted the 12023-github-security-policy branch November 6, 2023 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update security policy link in GItHub.com
3 participants