Files
send-mail/node_modules/nodemailer/SECURITY.md
T

141 lines
6.5 KiB
Markdown
Raw Normal View History

2026-06-15 07:32:52 +02:00
# Security Policy
2026-10-14 12:50:45 +02:00
Nodemailer is a widely deployed, zero-dependency email library. We welcome
responsible reports of vulnerabilities that present a credible security risk to
users. Please distinguish security vulnerabilities from ordinary bugs, unusual
edge cases, and hardening suggestions.
2026-06-15 07:32:52 +02:00
## Supported Versions
Security fixes are released only against the latest major version. We do not
2026-09-15 13:00:32 +02:00
backport patches to older majors, so upgrading to the current release line is
the supported way to receive security updates.
2026-06-15 07:32:52 +02:00
| Version | Supported |
| ------- | ------------------ |
2026-09-15 13:00:32 +02:00
| 10.x | :white_check_mark: |
| < 10.0 | :x: |
2026-06-15 07:32:52 +02:00
If you are on an older major, please upgrade. See the migration notes at
<https://nodemailer.com/> before updating.
2026-10-14 12:50:45 +02:00
## What Qualifies as a Security Vulnerability
A security report should identify a realistic way for an attacker to cross a
security boundary in a supported version of Nodemailer. Unexpected behavior,
a failing test, or a technically correct proof of concept is not sufficient on
its own to establish security impact.
In particular, explain:
- **Attacker capabilities:** Who is the attacker, and what inputs, systems, or
responses can they control _without_ already having the privileges or secrets
they are trying to gain?
- **Attack path:** How does attacker-controlled input reach the affected code
through a supported Nodemailer API or a realistic application integration?
- **Prerequisites:** What configuration and user actions are required? If the
attack depends on unusual options or deliberately malformed input, explain
why those conditions could arise in a real application.
- **Impact:** What confidentiality, integrity, or availability boundary is
crossed, and what can the attacker achieve as a result?
A vulnerability involving an optional or less common feature can still qualify
if these conditions are met. Conversely, the existence of a defensive check in
the code does not, by itself, establish that every bypass of that check has a
realistic security impact.
2026-06-15 07:32:52 +02:00
## Reporting a Vulnerability
2026-10-14 12:50:45 +02:00
**Do not disclose suspected exploitable vulnerabilities through public GitHub
issues, pull requests, or discussions before coordinating with the maintainer.**
2026-06-15 07:32:52 +02:00
Report privately through one of the following channels:
2026-10-14 12:50:45 +02:00
1. **GitHub Security Advisories (preferred):**
<https://github.com/nodemailer/nodemailer/security/advisories/new>.
2. **Email:** **andris@reinman.eu**, as listed in
[`SECURITY.txt`](SECURITY.txt). Encrypt sensitive details if possible.
2026-06-15 07:32:52 +02:00
2026-10-14 12:50:45 +02:00
### Required Information
2026-06-15 07:32:52 +02:00
2026-10-14 12:50:45 +02:00
Please provide enough information to evaluate both the defect and its security
impact. Reports should include:
2026-06-15 07:32:52 +02:00
2026-10-14 12:50:45 +02:00
1. The affected Nodemailer version or commit, Node.js version, and relevant
configuration.
2. A concise description of the issue and the affected public API or code path.
3. A minimal, tested reproduction, including steps to run it, expected behavior,
and observed behavior.
4. A concrete threat model: attacker control, prerequisites, trust boundary, and
resulting impact. Clearly distinguish what your reproduction proves from what
you believe might be possible.
5. An explanation of why the issue affects applications beyond a deliberately
constructed test setup, where this is not obvious.
2026-06-15 07:32:52 +02:00
2026-10-14 12:50:45 +02:00
A suggested fix is welcome but does not replace an explanation of exploitability.
A complete real-world exploit is not always necessary, but the report must make
a credible security impact clear.
2026-06-15 07:32:52 +02:00
2026-10-14 12:50:45 +02:00
### Reports That May Be Treated as Ordinary Bugs
The following generally do **not** qualify for private security handling unless
you can demonstrate an additional, meaningful security boundary crossing:
- Issues that require the attacker to control trusted application code,
administrator-only configuration, or the secret they supposedly extract.
- Problems caused solely by application-level misuse, exposed credentials, or
insecure deployment choices outside Nodemailer's control.
- Contrived proof-of-concept setups where the tester controls both sides of a
request, without explaining how a separate attacker could trigger the issue.
- Parser quirks, unexpected behavior, and bypasses of internal checks with no
demonstrated security impact.
- Speculative findings based only on static analysis or an automated tool's
assessment, without a verified reproduction and credible attack scenario.
These may still be valid bugs and may be considered through the normal issue
tracker. Please coordinate before making any potentially exploitable details
public. Classification as a bug does not guarantee a fix or a particular
priority.
### Automated and AI-Assisted Reports
Automated analysis and AI tools are welcome as research aids, but the person
submitting a report is responsible for verifying its claims. **Do not submit
bulk, unverified, or speculative AI-generated findings.** Test each finding
against a supported release and establish the actual security impact. Reports
that do not meet the requirements above may be closed without further
investigation or individual feedback; they can be resubmitted with stronger
evidence.
## Triage and Disclosure
Nodemailer is maintained by a single person, and there is **no guaranteed
response or resolution time**. Reports are prioritized based on demonstrated
impact, exploitability, affected usage, and available maintenance resources.
A private report does not automatically become a security advisory. Confirmed
vulnerabilities may be fixed and disclosed through GitHub Security Advisories;
other findings may be closed, deferred, or handled as ordinary bugs. Please do
not disclose details of an unresolved, potentially exploitable issue publicly
without coordinating with the maintainer.
## CVEs and Credit
We do not request or manage CVE identifiers. A report being acknowledged, a bug
being fixed, or a pull request being merged does **not** mean that Nodemailer
has confirmed a security vulnerability or endorsed a CVE assignment. We do not
guarantee advisories, CVE identifiers, or public credit for reports. For
confirmed vulnerabilities disclosed through an advisory, substantive reporters
may be credited if they wish.
2026-06-15 07:32:52 +02:00
## Scope
2026-09-15 13:00:32 +02:00
In scope: the `nodemailer` package source in this repository: message and MIME
2026-10-14 12:50:45 +02:00
generation, SMTP/LMTP client behavior, address parsing, header handling, DKIM
2026-06-15 07:32:52 +02:00
signing, and the bundled transports.
Out of scope: vulnerabilities in your own application code, misconfiguration of
your mail server or credentials, social-engineering reports, and issues in
third-party services Nodemailer connects to.
Thank you for helping keep Nodemailer and its users safe.