Skip to content

Commit 20c5e09

Browse files
docs(SECURITY): add vulnerability reporting details
1 parent bce64f7 commit 20c5e09

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

SECURITY.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Security
2+
3+
Security of all [WinkJS](https://github.com/winkjs) packages, including [winkNLP](https://github.com/winkjs/wink-nlp) is important to us.
4+
5+
6+
7+
## Supported Versions
8+
9+
Only the latest version of [winkNLP](https://github.com/winkjs/wink-nlp) is supported. This version can be installed and/or downloaded from [NPM](https://www.npmjs.com/package/wink-nlp) or from the [latest GitHub release](https://github.com/winkjs/wink-nlp/releases/latest).
10+
11+
## Reporting a Vulnerability
12+
13+
We would appreciate [responsible disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure). If you would like to report a vulnerability, the preferred way to do so is [contacting us directly](mailto:[email protected]). Please do not report security vulnerabilities through public GitHub issues.
14+
15+
Please include the following minimum information to help us understand and analyze the potential issue:
16+
17+
1. Type of issue for example buffer overflow or privilege escalation.
18+
2. Full path(s) of source file(s) related to the issue including the affected source code’s tag or commit SHA.
19+
3. Step-by-step instructions on how to reproduce the issue, including the sample exploit code
20+
4. Impact of the issue.
21+
22+
23+
When you are investigating and reporting the vulnerability you must never:
24+
1. break any law,
25+
3. tell others about the vulnerability you have found until we have disclosed it, and/or
26+
4. demand money to disclose a vulnerability.

0 commit comments

Comments
 (0)