tukaani-project / xz

XZ Utils
https://tukaani.org/xz/
Other
532 stars 95 forks source link

Add Security Policy #47

Closed gabibguti closed 1 year ago

gabibguti commented 1 year ago

Pull request checklist

Please check if your PR fulfills the following requirements:

Pull request type

Please check the type of change your PR introduces: - [ ] Bugfix - [x] Feature - [ ] Code style update (formatting, renaming, typo fix) - [ ] Refactoring (no functional changes, no api changes) - [ ] Build related changes - [x] Documentation content changes - [ ] Other (please describe): ## What is the current behavior?

Not having a Security Policy file.

Related Issue URL: Resolves https://github.com/tukaani-project/xz/issues/46

What is the new behavior?

Does this introduce a breaking change?

Other information

I've tried to keep the timelines of confirming a vulnerability report and fixing a vulnerability as open as possible. Let me know what you think and if this seems reasonable for maintainence.

gabibguti commented 1 year ago

I see you also have GitHub's Security Advisories feature enabled. So we could put 2 reporting options in the Security Policy, email and the security advisory report link. Does it make sense?

JiaT75 commented 1 year ago

Thanks for the PR! I recently enabled GitHub's Security Advisories feature so we should list that as a reporting option. Email is the preferred option, so we should list that option first.

Can you move the SECURITY.md to the .github folder? Since this is a GitHub specific file and the rest of our documentation is .txt files, this would fit better.

The 90 day timeline to fix security reports is plenty of time for us, so I think that is very reasonable for us to adhere to.

gabibguti commented 1 year ago

@JiaT75 Can you take a look to see if all your comments were addressed?

JiaT75 commented 1 year ago

Looks great. Thanks for the contribution!