mirror of
https://github.com/nvm-sh/nvm.git
synced 2025-06-26 11:08:43 +00:00
Compare commits
3 Commits
e29a1177d9
...
2c52d920ec
Author | SHA1 | Date | |
---|---|---|---|
![]() |
2c52d920ec | ||
![]() |
1aab8b2d5a | ||
![]() |
5712a97c66 |
117
.github/INCIDENT_RESPONSE_PLAN.md
vendored
Normal file
117
.github/INCIDENT_RESPONSE_PLAN.md
vendored
Normal file
@ -0,0 +1,117 @@
|
|||||||
|
# Incident Response Process for **nvm**
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
We take the security of **nvm** very seriously. If you believe you’ve found a security vulnerability, please inform us responsibly through coordinated disclosure.
|
||||||
|
|
||||||
|
### How to Report
|
||||||
|
|
||||||
|
> **Do not** report security vulnerabilities through public GitHub issues, discussions, or social media.
|
||||||
|
|
||||||
|
Instead, please use one of these secure channels:
|
||||||
|
|
||||||
|
1. **GitHub Security Advisories**
|
||||||
|
Use the **Report a vulnerability** button in the Security tab of the [nvm-sh/nvm repository](https://github.com/nvm-sh/nvm).
|
||||||
|
|
||||||
|
2. **Email**
|
||||||
|
Follow the posted [Security Policy](https://github.com/nvm-sh/nvm/security/policy).
|
||||||
|
|
||||||
|
### What to Include
|
||||||
|
|
||||||
|
**Required Information:**
|
||||||
|
- Brief description of the vulnerability type
|
||||||
|
- Affected version(s) and components
|
||||||
|
- Steps to reproduce the issue
|
||||||
|
- Impact assessment (what an attacker could achieve)
|
||||||
|
|
||||||
|
**Helpful Additional Details:**
|
||||||
|
- Full paths of affected scripts or files
|
||||||
|
- Specific commit or branch where the issue exists
|
||||||
|
- Required configuration to reproduce
|
||||||
|
- Proof-of-concept code (if available)
|
||||||
|
- Suggested mitigation or fix
|
||||||
|
|
||||||
|
## Our Response Process
|
||||||
|
|
||||||
|
**Timeline Commitments:**
|
||||||
|
- **Initial acknowledgment**: Within 24 hours
|
||||||
|
- **Detailed response**: Within 3 business days
|
||||||
|
- **Status updates**: Every 7 days until resolved
|
||||||
|
- **Resolution target**: 90 days for most issues
|
||||||
|
|
||||||
|
**What We’ll Do:**
|
||||||
|
1. Acknowledge your report and assign a tracking ID
|
||||||
|
2. Assess the vulnerability and determine severity
|
||||||
|
3. Develop and test a fix
|
||||||
|
4. Coordinate disclosure timeline with you
|
||||||
|
5. Release a security update and publish an advisory and CVE
|
||||||
|
6. Credit you in our security advisory (if desired)
|
||||||
|
|
||||||
|
## Disclosure Policy
|
||||||
|
|
||||||
|
- **Coordinated disclosure**: We’ll work with you on timing
|
||||||
|
- **Typical timeline**: 90 days from report to public disclosure
|
||||||
|
- **Early disclosure**: If actively exploited
|
||||||
|
- **Delayed disclosure**: For complex issues
|
||||||
|
|
||||||
|
## Scope
|
||||||
|
|
||||||
|
**In Scope:**
|
||||||
|
- **nvm** project (all supported versions)
|
||||||
|
- Installation and update scripts (`install.sh`, `nvm.sh`)
|
||||||
|
- Official documentation and CI/CD integrations
|
||||||
|
- Dependencies with direct security implications
|
||||||
|
|
||||||
|
**Out of Scope:**
|
||||||
|
- Third-party forks or mirrors
|
||||||
|
- Platform-specific installs outside core scripts
|
||||||
|
- Social engineering or physical attacks
|
||||||
|
- Theoretical vulnerabilities without practical exploitation
|
||||||
|
|
||||||
|
## Security Measures
|
||||||
|
|
||||||
|
**Our Commitments:**
|
||||||
|
- Regular vulnerability scanning via GitHub Actions
|
||||||
|
- Automated security checks in CI/CD pipelines
|
||||||
|
- Secure scripting practices and mandatory code review
|
||||||
|
- Prompt patch releases for critical issues
|
||||||
|
|
||||||
|
**User Responsibilities:**
|
||||||
|
- Keep **nvm** updated
|
||||||
|
- Verify script downloads via PGP signatures
|
||||||
|
- Follow secure configuration guidelines for shell environments
|
||||||
|
|
||||||
|
## Legal Safe Harbor
|
||||||
|
|
||||||
|
**We will NOT:**
|
||||||
|
- Initiate legal action
|
||||||
|
- Contact law enforcement
|
||||||
|
- Suspend or terminate your access
|
||||||
|
|
||||||
|
**You must:**
|
||||||
|
- Only test against your own installations
|
||||||
|
- Not access, modify, or delete user data
|
||||||
|
- Not degrade service availability
|
||||||
|
- Not publicly disclose before coordinated disclosure
|
||||||
|
- Act in good faith
|
||||||
|
|
||||||
|
## Recognition
|
||||||
|
|
||||||
|
- **Advisory Credits**: Credit in GitHub Security Advisories (unless anonymous)
|
||||||
|
|
||||||
|
## Security Updates
|
||||||
|
|
||||||
|
**Stay Informed:**
|
||||||
|
- Subscribe to GitHub releases for **nvm**
|
||||||
|
- Enable GitHub Security Advisory notifications
|
||||||
|
|
||||||
|
**Update Process:**
|
||||||
|
- Patch releases (e.g., v0.40.3 → v0.40.4)
|
||||||
|
- Out-of-band releases for critical issues
|
||||||
|
- Advisories via GitHub Security Advisories
|
||||||
|
|
||||||
|
## Contact Information
|
||||||
|
|
||||||
|
- **Security reports**: Security tab of [nvm-sh/nvm](https://github.com/nvm-sh/nvm/security)
|
||||||
|
- **General inquiries**: GitHub Discussions or Issues
|
||||||
|
|
17
.github/SECURITY.md
vendored
17
.github/SECURITY.md
vendored
@ -1,6 +1,6 @@
|
|||||||
# Security
|
# Security
|
||||||
|
|
||||||
Please email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report.
|
Please file a private vulnerability report via GitHub, email [@ljharb](https://github.com/ljharb), or see https://tidelift.com/security if you have a potential security vulnerability to report.
|
||||||
|
|
||||||
## OpenSSF CII Best Practices
|
## OpenSSF CII Best Practices
|
||||||
|
|
||||||
@ -12,16 +12,17 @@ There are three “tiers”: passing, silver, and gold.
|
|||||||
We meet 100% of the “passing” criteria.
|
We meet 100% of the “passing” criteria.
|
||||||
|
|
||||||
### Silver
|
### Silver
|
||||||
We meet 95% of the “silver” criteria. The gaps are as follows:
|
We meet 100% of the “silver” criteria.
|
||||||
- we do not have a DCO or a CLA process for contributions.
|
|
||||||
- because we only have one maintainer, the project has no way to continue if that maintainer stops being active.
|
|
||||||
- we do not currently document “what the user can and cannot expect in terms of security” for our project. This is planned to be completed in 2023.
|
|
||||||
|
|
||||||
### Gold
|
### Gold
|
||||||
We meet 65% of the “gold” criteria. The gaps are as follows:
|
We meet 78% of the “gold” criteria. The gaps are as follows:
|
||||||
- we do not yet have the “silver” badge; see all the gaps above.
|
- because we only have one maintainer, the project has no way to continue if that maintainer stops being active.
|
||||||
- We do not include a copyright or license statement in each source file. Efforts are underway to change this archaic practice into a suggestion instead of a hard requirement.
|
- We do not include a copyright or license statement in each source file. Efforts are underway to change this archaic practice into a suggestion instead of a hard requirement.
|
||||||
|
|
||||||
## Threat Model
|
## Threat Model
|
||||||
|
|
||||||
See [THREAT_MODEL.md](./THREAT_MODEL.md).
|
See [THREAT_MODEL.md](.github/THREAT_MODEL.md).
|
||||||
|
|
||||||
|
## Incident Response Plan
|
||||||
|
|
||||||
|
Please see our [Incident Response Plan](.github/INCIDENT_RESPONSE_PLAN.md).
|
||||||
|
@ -443,7 +443,7 @@ Node has a [schedule](https://github.com/nodejs/Release#release-schedule) for lo
|
|||||||
|
|
||||||
Any time your local copy of `nvm` connects to https://nodejs.org, it will re-create the appropriate local aliases for all available LTS lines. These aliases (stored under `$NVM_DIR/alias/lts`), are managed by `nvm`, and you should not modify, remove, or create these files - expect your changes to be undone, and expect meddling with these files to cause bugs that will likely not be supported.
|
Any time your local copy of `nvm` connects to https://nodejs.org, it will re-create the appropriate local aliases for all available LTS lines. These aliases (stored under `$NVM_DIR/alias/lts`), are managed by `nvm`, and you should not modify, remove, or create these files - expect your changes to be undone, and expect meddling with these files to cause bugs that will likely not be supported.
|
||||||
|
|
||||||
To get the latest LTS version of node and migrate your existing installed packages, use
|
To get the latest LTS version of node and migrate your existing installed packages, use:
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
nvm install --reinstall-packages-from=current 'lts/*'
|
nvm install --reinstall-packages-from=current 'lts/*'
|
||||||
|
Loading…
Reference in New Issue
Block a user