Skip to content

Commit

Permalink
docs: added Security policy
Browse files Browse the repository at this point in the history
Signed-off-by: manhtukhang <[email protected]>
  • Loading branch information
manhtukhang committed Dec 13, 2024
1 parent 3f6e16d commit 93ef076
Showing 1 changed file with 174 additions and 0 deletions.
174 changes: 174 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
# Security Policy

This document includes information about the vulnerability reporting, patch,
release, and disclosure processes, as well as general security posture.

<!-- markdown-toc --bullets="-" -i SECURITY.md -->

<!-- toc -->

- [Supported Versions](#supported-versions)
- [Reporting a Vulnerability](#reporting-a-vulnerability)
- [When Should I Report a Vulnerability?](#when-should-i-report-a-vulnerability)
- [When Should I NOT Report a Vulnerability?](#when-should-i-not-report-a-vulnerability)
- [Vulnerability Response](#vulnerability-response)
- [Security Release & Disclosure Process](#security-release--disclosure-process)
- [Private Disclosure](#private-disclosure)
- [Public Disclosure](#public-disclosure)
- [Security Releases](#security-releases)
- [Severity](#severity)
- [Security Posture](#security-posture)
- [Security Team](#security-team)
- [Security Policy Updates](#security-policy-updates)

<!-- tocstop -->

## Supported Versions

The following versions are currently supported and receive security updates.
Release candidates will not receive security updates.

| Version | Supported |
| --------- | ------------------ |
| >= 0.0.1 | :white_check_mark: |

## Reporting a Vulnerability

We're extremely grateful for security researchers and users that report
vulnerabilities to us. All reports are thoroughly investigated by the project
[security team](#security-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/manhtukhang/vault-plugin-secrets-nexus-repository/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 in vault-plugin-secrets-nexus-repository
- You are unsure how a vulnerability affects vault-plugin-secrets-nexus-repository
- You think you discovered a vulnerability in another project that vault-plugin-secrets-nexus-repository 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 GitHub Actions for security
- You need help applying security related updates
- Your issue is not security related

### Vulnerability Response

Each report is acknowledged and analyzed by the [Security Team](#security-team)
within 14 days. This will set off the
[Security Release Process](#security-release--disclosure-process).

Any vulnerability information shared with the Security Team stays within
vault-plugin-secrets-nexus-repository 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 the [Security Team](#security-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/manhtukhang/vault-plugin-secrets-nexus-repository/security/advisories).

A public disclosure date is negotiated by the [Security Team](#security-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 14 days.

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

If possible the Security 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 Security 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 patch releases to all [supported versions](#supported-versions)
and all fixed vulnerabilities will be noted in
the [CHANGELOG](./CHANGELOG.md).

### Severity

The [Security Team](#security-team) evaluates vulnerability severity on a
case-by-case basis, guided by [CVSS 3.1](https://www.first.org/cvss/v3.1/specification-document).

## Security Posture

We aim to reduce the number of security issues through several general
security-concious development practices including the use of unit-tests,
end-to-end (e2e) tests, static and dynamic analysis tools, and use of
memory-safe languages.

We aim to fix issues discovered by analysis tools as quickly as possible. We
prefer to add these tools to "pre-submit" checks on PRs so that issues are
never added to the code in the first place.

In general, we observe the following security-conscious practices during
development (This is not an exhaustive list).

- All PRs are reviewed by at least one [CODEOWNER](./CODEOWNERS).
- All tests must pass before a PRs is merged.
- We refrain from using memory-unsafe languages (e.g. C, C++) or memory-unsafe
use of languages that are memory-safe by default (e.g. the Go
[unsafe](https://pkg.go.dev/unsafe) package).

## Security Team

The Security Team is responsible for the overall security of the
project and for reviewing reported vulnerabilities. Each member is familiar
with designing secure software, security issues related to CI/CD, GitHub
Actions and build provenance.

<!-- NOTE: Team membership should be synced with CODEOWNERS for SECURITY.md -->

Security Team:

- Tu KhangManh (@manhtukhang)

Security Team membership is currently considered on a case-by-case basis.

## Security Policy Updates

Changes to this Security Policy are reviewed and approved by the
[Security Team](#security-team).

0 comments on commit 93ef076

Please sign in to comment.