Skip to content

Commit

Permalink
Chore: adds a security policy
Browse files Browse the repository at this point in the history
  • Loading branch information
pustovitDmytro committed Sep 5, 2021
1 parent 51200bf commit ed86aba
Show file tree
Hide file tree
Showing 3 changed files with 66 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Ex. I'm always frustrated when [...]

**Please follow the general troubleshooting steps first:**
- [ ] I've searched on the [issue tracker](../) before creating one.
- [ ] I'm running latest package version.
- [ ] I'm ready to provide help with enhancement, if needed.
- [ ] I'm running the latest package version.
- [ ] I'm ready to provide help with enhancement if needed.
- [ ] Feature will break current functionality

**Describe the solution you'd like**
Expand Down
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/vulnerability.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
name: Vulnerability
about: Report a vulnerability
title: 'Security: brief description'
labels: security
assignees: pustovitDmytro
---

**Issue Description**

A clear and concise description of what the bug is. Paste here a brief summary of your issue. If you are able to, please also include: the type of vulnerability, for example, the OWASP category.

**Please follow the general troubleshooting steps first:**
- [ ] I've searched on the [issue tracker](../) before creating one.
- [ ] The issue relates to the package's dependency.
- [ ] The issue relates to the codebase.
- [ ] I'm running the latest package version.
- [ ] I'm ready to provide help with a fix if needed.

**Screenshots**

If applicable, add screenshots or logs showing the exploitation of the vulnerability.

**Environment:**
- Version X.X.X
- Node.js version: XXX
- Operating System: XXX

**Additional context**
Add any other context about the problem here.
34 changes: 34 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Security Policy

If you’ve found a vulnerability, we would like to know so we can fix it. This notice provides details for how you can let us know about vulnerabilities

## Supported Versions

Only last major version is currently being supported with security updates.

## Reporting a Vulnerability

To report a (suspected) security vulnerability in package code use the **Vulnerability Template** in the issues section.

If the issue is confirmed, we will release a patch as soon as possible depending on complexity but historically within a few days.

Report security bugs in third-party modules to the person or team maintaining the module. Use the **Vulnerability Template** if a dependency version update is needed to resolve the vulnerability.

When you are investigating and reporting the vulnerability, you must not:

* break the law
* access unnecessary or excessive amounts of data
* modify third-party data
* use high-intensity invasive or destructive scanning tools to find vulnerabilities
* try a denial of service - for example overwhelming a real service with a high volume of requests
* disrupt production services or systems
* tell other people about the vulnerability you have found until we have disclosed it
* social engineer, phish or physically attack any staff or infrastructure
* demand money to disclose a vulnerability

## Bug bounty
Unfortunately, we doesn't offer a paid bug bounty programme.

## Comments on this Policy

If you have suggestions on how this process could be improved please submit a pull request.

0 comments on commit ed86aba

Please sign in to comment.