treq icon indicating copy to clipboard operation
treq copied to clipboard

How to get in touch regarding a security concern

Open JamieSlome opened this issue 3 years ago • 8 comments

Hey there!

I belong to an open source security research community, and a member (@ranjit-git) has found an issue, but doesn’t know the best way to disclose it.

If not a hassle, might you kindly add a SECURITY.md file with an email, or another contact method? GitHub recommends this best practice to ensure security issues are responsibly disclosed, and it would serve as a simple instruction for security researchers in the future.

Thank you for your consideration, and I look forward to hearing from you!

(cc @huntr-helper)

JamieSlome avatar Jan 16 '22 17:01 JamieSlome

Hey! I'm the somewhat-absentee maintainer of Treq, and also a committer on the primary Twisted project and several other sub-projects. I'd say Treq should use the same process as Twisted itself.

You can find the Twisted security process here: https://twistedmatrix.com/trac/wiki/Security A quick summary would be:

Send urgent or sensitive reports directly to ​[email protected].

Unfortunately most of the rest of the page is a bit out-of-date as development has moved to GitHub, particularly as applied to Treq. I'll look into to getting this updated.

I'll look into adding a SECURITY.md file to whole Twisted org. Thanks for the suggestion!

twm avatar Jan 18 '22 05:01 twm

@twm - thanks for the in-depth response!

I have created https://github.com/twisted/treq/pull/337 for the SECURITY.md in the meantime.

Otherwise, you can view the report directly here. It is private and only accessible to maintainers with repository write permissions.

Let me know if you have any questions or need help! 😄

JamieSlome avatar Jan 18 '22 11:01 JamieSlome

Hi @JamieSlome I've issued a security release of Treq, version 22.1.0, addressing GHSA-fhpf-pp6p-55qc. There is also a Twisted release in progress to address GHSA-92x2-jw7w-xvvx / CVE-2022-21712. The bulk of the fixes are in the Twisted release.

twm avatar Jan 30 '22 05:01 twm

@twm - thanks for the heads up here!

Are you able to confirm the fix against the report?

Also, are you able to edit the huntr.dev URL on the advisory to not include the sensitive token in the link? The URLs with tokens should not be shared as this gives maintainer capabilities for anyone with the token.

Let me know once you have confirmed the fix, and I will go ahead and regenerate/invalidate the token so it cannot be used in the future.

JamieSlome avatar Jan 31 '22 10:01 JamieSlome

@JamieSlome The fix was made in Twisted, so I don't see how to express that in your form. There hasn't been a Treq release that bumps the Twisted dependency yet (as the Twisted release is still a pre-release).

I think that the comment history will still contain the token, so I think that you should invalidate it.

twm avatar Feb 01 '22 07:02 twm

@twm - I can adjust the repository that the report points to if that helps?

I have also invalidated the token and updated it with a new one, thanks for the heads up! ❤️

JamieSlome avatar Feb 01 '22 09:02 JamieSlome

@JamieSlome Sure, switch it to twisted/twisted.

twm avatar Feb 05 '22 05:02 twm

@twm - updated here! 🤗

JamieSlome avatar Feb 07 '22 11:02 JamieSlome