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

Add a security policy #26205

Closed
pnacht opened this issue Jun 6, 2023 · 0 comments · Fixed by #26204
Closed

Add a security policy #26205

pnacht opened this issue Jun 6, 2023 · 0 comments · Fixed by #26204

Comments

@pnacht
Copy link
Contributor

pnacht commented Jun 6, 2023

Description

If someone's found a potential security vulnerability (i.e. denial-of-service attack) in three.js, they should be able to report it privately, so that a new release with a fix can be released before the vulnerability is exploited in the wild.

Solution

three.js should have a security policy (SECURITY.md) letting anyone with a suspected vulnerability get in touch and work with maintainers out of the public eye. GitHub recommends having such a policy.

The security policy can be found by users who enter the project's "Security" panel. A new issue "type" will also be added to the "New issue" window pointing users to the policy if they've found a vulnerability.

There are two main ways to receive disclosures:

If you want to use GitHub's reporting system, it must be activated for the repository:

  1. Open the repo's settings
  2. Click on Code security & analysis
  3. Click "Enable" for "Private vulnerability reporting"

I'll send a PR with a draft policy along with this issue.

Alternatives

Instead of a separate file, having the relevant information in the project's README would also suffice, but then it won't appear in the Security panel or in the "New issue" type selection window.

Additional context

Disclosure: My name is Pedro and I work with Google and the Open Source Security Foundation (OpenSSF) to improve the supply-chain security of the open-source ecosystem.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants