docs: add SECURITY.md

This commit is contained in:
Nicolas Giard 2020-04-29 19:14:10 -04:00 committed by GitHub
parent 954262f517
commit 662ebccd22
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

25
SECURITY.md Normal file
View File

@ -0,0 +1,25 @@
# Security Policy
Wiki.js is built with security in mind. We try our absolute best to deliver secure and robust applications. However, like any software, there can be security bugs, either introduced by an update or by using an attack vector that wasn't considered when designing the software.
If you find such vulnerability, it's important to disclose it in a quick and secure manner to the developers. Follow the instructions below to report a vulnerability.
## Supported Versions
| Version | Supported |
| ------- | ------------------ |
| 2.x.x | :white_check_mark: |
| 1.x.x | :x: |
## Reporting a Vulnerability
**DO NOT CREATE AN ISSUE ON GITHUB** to report a potential vulnerability / security problem. Instead, send an email to security@requarks.io.
Include as much details as possible, such as:
- The version(s) of Wiki.js that are impacted
- How to reproduce the vulnerability (step-by-step, screenshots or a video)
- The platform / environment it occurs on (e.g. OS version, DB type + version, etc.)
- Any potential fixes or reference code you think might be helpful in resolving the issue
- Your GitHub username if you'd like to be included as a collaborator on the private fix branch
The vulnerability will be investigated ASAP. If deemed valid, a draft security advisory will be created on GitHub and you will be included as a collaborator. A fix will be worked on in a private branch to resolves the issue. Once a fix is available, the advisory will be published.