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 #864

Merged
merged 4 commits into from
Jul 31, 2024
Merged

Conversation

jl-wynen
Copy link
Contributor

@jl-wynen jl-wynen commented Nov 2, 2023

This is good practice so that users know what to do when they find a problem.

I basically copied this from Scitacean. So it may not be exactly what you want here. In particular, please

  • Let me know what email address I can insert.
  • Check if the supported versions info is correct.

Copy link
Contributor

@bpedersen2 bpedersen2 left a comment

Choose a reason for hiding this comment

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

Good idea.

We should discuss in the meeting whether we want support at least two minr -version branches for security updates (or a LTS version and one faster moving branch with regular releases (e.g. the jenkins model: one release from master every 2 weeks and a LTS release every 3 month) to cater for facilties that cannot support too frequent updates?

@nitrosx
Copy link
Contributor

nitrosx commented Nov 22, 2023

@jl-wynen based on the file that you added, we should have a log of all the vulnerabilities that we have fixed.
How do you propose to do that in a way that minimize the maintenance effort.
Thanks

On a side note, what else do we need to do on this PR to approve and merge?

@jl-wynen
Copy link
Contributor Author

Just use GH security advisories. They allow you to track what has been fixed and for what version and disclose those when appropriate.

Related, there is actually no need for an email address. You can enable security reporting on the repo which is like issues but can be opened by anyone but seen only by maintainers.

SECURITY.md Outdated Show resolved Hide resolved
SECURITY.md Outdated

**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**

Instead, please email <ADDRESS>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

We still need to put an email address here.

Alternatively, or in addition, you can also enable private security reporting for the repo: https://docs.github.com/en/code-security/security-advisories/working-with-repository-security-advisories/configuring-private-vulnerability-reporting-for-a-repository

Copy link
Contributor

Choose a reason for hiding this comment

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

@jl-wynen Thanks for the info. I have enabled the security report feature for this repository.
@nitrosx What email should we put in the template?

@Junjiequan Junjiequan marked this pull request as ready for review July 31, 2024 12:05
@Junjiequan Junjiequan enabled auto-merge (squash) July 31, 2024 12:07
@Junjiequan Junjiequan merged commit a294b62 into SciCatProject:master Jul 31, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants