Skip to content

Commit

Permalink
Add issue reporting note and vulnerability disclosure policy
Browse files Browse the repository at this point in the history
  • Loading branch information
Addvilz committed Mar 11, 2020
1 parent b0454d5 commit 3757de7
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,12 @@ is planned for level 2 expansion:
A side-goal of API level 2 is to retain compatibility with API level 1, meaning, if at all possible, all scripts written
for API level 1 will work just fine with API level 2 compatible libkafe.

## Reporting issues

To report a bug or request a feature, open a ticket at [https://github.com/libkafe/kafe/issues](https://github.com/libkafe/kafe/issues).

For security related issues, please follow our [Vulnerability Disclosure Policy](./SECURITY.md).

## History

Kafe is nearly complete rewrite of OPM (Optional Package Manager) - a command-line tool I wrote several years ago for my
Expand Down
40 changes: 40 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Kafe Vulnerability Disclosure Policy

We take the security of our systems seriously, and we value the security community. The disclosure of security
vulnerabilities helps us ensure the security and privacy of our users.

### Guidelines
We require that all researchers:
* Make every effort to avoid privacy violations, degradation of user experience, disruption to production systems,
and destruction of data during security testing;
* Perform research only within the scope set out below;
* Use the identified communication channels to report vulnerability information to us; and
* Keep information about any vulnerabilities you’ve discovered confidential between yourself and Kafe developers
until we’ve had 60 days to resolve the issue.

If you follow these guidelines when reporting an issue to us, we commit to:
* Not pursue or support any legal action related to your research;
* Work with you to understand and resolve the issue quickly (including an initial confirmation of your report within
72 hours of submission);
* Recognize your contribution on our source repository, if you are the first to report the issue and we make a code or
configuration change based on the issue.

### Scope
* Source code made available at https://github.com/libkafe/kafe
* Binary builds made available at https://github.com/libkafe/kafe

### Out of scope
Any services hosted by 3rd party providers and services are excluded from scope. These services include:

* GitHub
* Managed Kafe services or 3rd party software embedding kafe or libkafe

### How to report a security vulnerability?
If you believe you’ve found a security vulnerability in one of our products or platforms please send it to us by emailing
[email protected]. Please include the following details with your report:

* Description of the location and potential impact of the vulnerability;
* A detailed description of the steps required to reproduce the vulnerability (POC scripts, etc.); and
* Your name/handle and a link for recognition in our repository.

You can also share a private repository with proof of concept to the exploit directly with https://github.com/Addvilz

0 comments on commit 3757de7

Please sign in to comment.