Skip to content

Commit

Permalink
Bootstrap Security Policy
Browse files Browse the repository at this point in the history
  • Loading branch information
tyranron committed Jan 27, 2023
1 parent e860ef8 commit 3ad667b
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Security Policy
===============

Security policy of [`gherkin`] crate.




## Supported versions

Before going `1.0`, the [`gherkin`] crate maintains only the most recent minor release.




## Reporting a vulnerability

Security is of the highest importance and all security vulnerabilities or suspected security vulnerabilities should be reported to this project privately, to minimize attacks against current users of [`gherkin`] crate before they are fixed. Vulnerabilities will be investigated and patched on the next patch (or minor) release as soon as possible. This information could be kept entirely internal to the project.


### Private disclosure process

> **WARNING:** Do not file public issues on GitHub for security vulnerabilities.
To report a vulnerability or a security-related issue, please use [GitHub private vulnerability reporting][11] on the [Security Advisories page][1] and fill the vulnerability details. It will be addressed within a week, including a detailed plan to investigate the issue and any potential workarounds to perform in the meantime. Do not report non-security-impacting bugs through this channel, use [GitHub issues][2] instead.


### Public disclosure process

Project maintainers publish a [public advisory][1] to the community [via GitHub][12].




[`gherkin`]: https://docs.rs/gherkin

[1]: /../../security/advisories
[2]: /../../issues
[11]: https://docs.github.com/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability
[12]: https://docs.github.com/code-security/security-advisories/repository-security-advisories/publishing-a-repository-security-advisory#about-publishing-a-security-advisory

2 comments on commit 3ad667b

@tyranron
Copy link
Member Author

Choose a reason for hiding this comment

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

@bbqsrc same here, please:

enable "Private vulnerability reporting (Beta)" option on this page, so any hypotetical vulnerabilities may be reported privately via GitHub. Thanks!

@bbqsrc
Copy link
Member

@bbqsrc bbqsrc commented on 3ad667b Jan 27, 2023

Choose a reason for hiding this comment

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

@tyranron you're an org owner now so you can do it :D

Please sign in to comment.