Skip to content

Commit

Permalink
docs: update SECURITY.md
Browse files Browse the repository at this point in the history
markuslf committed Jan 7, 2025
1 parent 5a17c3e commit 3203d09
Showing 1 changed file with 94 additions and 4 deletions.
98 changes: 94 additions & 4 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -2,10 +2,100 @@

## Supported Versions

We support the latest version only.
The latest version is currently supported and receives security updates.


## Reporting a Vulnerability

Please report any vulnerabilities you find to info[at]linuxfabrik[dot]ch.
We will respond and assess the risk as soon as possible (usually within a few working days)
and provide a fix and a new release.
We're extremely grateful for security researchers and users that report
vulnerabilities to us. All reports are thoroughly investigated by our team.

Vulnerabilities are reported privately via GitHub's
[Security Advisories](https://docs.github.com/en/code-security/security-advisories)
feature. Please use the following link to submit your vulnerability:
[Report a vulnerability](https://github.com/Linuxfabrik/monitoring-plugins/security/advisories/new)

Please see
[Privately reporting a security vulnerability](https://docs.github.com/en/code-security/security-advisories/guidance-on-reporting-and-writing/privately-reporting-a-security-vulnerability#privately-reporting-a-security-vulnerability)
for more information on how to submit a vulnerability using GitHub's interface.


### When Should I Report a Vulnerability?

- You think you discovered a potential security vulnerability
- You are unsure how a vulnerability affects your system
- You think you discovered a vulnerability in another project that this project depends on
- For projects with their own vulnerability reporting and disclosure process, please report it directly there

### When Should I NOT Report a Vulnerability?

- You need help tuning your System for security
- You need help applying security related updates
- Your issue is not security related


### Vulnerability Response

Each report is acknowledged and analyzed within 30 days.

Any vulnerability information stays within this project and will not be disseminated to other projects
unless it is necessary to get the issue fixed.

As the security issue moves from triage, to identified fix, to release planning
we will keep the reporter updated.


## Security Release & Disclosure Process

Security vulnerabilities should be handled quickly and sometimes privately. The
primary goal of this process is to reduce the total time users are vulnerable
to publicly known exploits.


### Private Disclosure

We ask that all suspected vulnerabilities be privately and responsibly
disclosed via the [private disclosure process](#reporting-a-vulnerability)
outlined above.

Fixes may be developed and tested by our team in a
[temporary private fork](https://docs.github.com/en/code-security/security-advisories/repository-security-advisories/collaborating-in-a-temporary-private-fork-to-resolve-a-repository-security-vulnerability)
that are private from the general public if deemed necessary.


### Public Disclosure

Vulnerabilities are disclosed publicly as GitHub [Security
Advisories](https://github.com/Linuxfabrik/monitoring-plugins/security/advisories).

A public disclosure date is negotiated by our team
and the bug submitter. We prefer to fully disclose the bug as soon as possible
once a user mitigation is available. It is reasonable to delay disclosure when
the bug or the fix is not yet fully understood, the solution is not
well-tested, or for vendor coordination. The timeframe for disclosure is from
immediate (especially if it's already publicly known) to several weeks. For a
vulnerability with a straightforward mitigation, we expect report date to
disclosure date to be on the order of 30 days.

If you know of a publicly disclosed security vulnerability please IMMEDIATELY
[report the vulnerability](#reporting-a-vulnerability) to inform the team about the vulnerability so they may start the
patch, release, and communication process.

If possible the team will ask the person making the public report if
the issue can be handled via a private disclosure process. If the reporter
denies the request, the team will move swiftly with the fix and
release process. In extreme cases you can ask GitHub to delete the issue but
this generally isn't necessary and is unlikely to make a public disclosure less
damaging.

### Security Releases

Once a fix is available it will be released and announced via the project on
GitHub.
Security releases will announced and clearly marked as a security release and
include information on which vulnerabilities were fixed. As much as possible
this announcement should be actionable, and include any mitigating steps users
can take prior to upgrading to a fixed version.

Fixes will be applied in new releases and all fixed vulnerabilities will be noted in
the [CHANGELOG](./CHANGELOG.md).

0 comments on commit 3203d09

Please sign in to comment.