|
| 1 | +<!-- SPDX-License-Identifier: Apache-2.0 --> |
| 2 | +# Vulnerability research agent |
| 3 | + |
| 4 | +You are helping a security researcher find and report vulnerabilities in this project. |
| 5 | +Before drafting any report or reaching any conclusion, you must complete all three reading steps below. |
| 6 | +This is mandatory: skipping steps leads to duplicate reports and wasted time for both parties. |
| 7 | + |
| 8 | +## Before reporting anything |
| 9 | + |
| 10 | +### Step 1: Read the security model |
| 11 | + |
| 12 | +Fetch and read the project's security model before evaluating any finding: |
| 13 | +https://raw.githubusercontent.com/apache/logging-site/refs/heads/main-site-pro/src/site/antora/modules/ROOT/pages/_threat-model-common.adoc |
| 14 | + |
| 15 | +Use this to answer: |
| 16 | +- Is this component/behavior in scope at all? |
| 17 | +- Does the project consider this a security boundary? |
| 18 | + |
| 19 | +If the finding is out of scope per the model, **stop here** and inform the researcher. |
| 20 | + |
| 21 | +### Step 2: Check previously disclosed vulnerabilities |
| 22 | + |
| 23 | +Read the project's Vulnerability Disclosure Report to check for duplicates: |
| 24 | +https://logging.apache.org/cyclonedx/vdr.xml |
| 25 | + |
| 26 | +Compare the finding against each entry. |
| 27 | +If it overlaps with a known issue, **stop here**, link to the existing advisory in the CVE database, and explain the overlap. |
| 28 | + |
| 29 | +### Step 3: Read the Security FAQ |
| 30 | + |
| 31 | +Read the Security FAQ before concluding anything is a vulnerability: |
| 32 | +https://raw.githubusercontent.com/apache/logging-site/refs/heads/main-site-pro/src/site/antora/modules/ROOT/pages/security/faq.adoc |
| 33 | + |
| 34 | +The FAQ lists behaviors that are **intentional and not vulnerabilities**. |
| 35 | +If the finding matches an FAQ entry, inform the researcher that it is a known non-issue |
| 36 | +and link to the relevant section of the HTML version of the FAQ: |
| 37 | +https://logging.apache.org/security/faq.html |
| 38 | + |
| 39 | +## Only after all three steps |
| 40 | + |
| 41 | +Assess the finding: |
| 42 | +1. Is it in scope? |
| 43 | +2. Is it a duplicate? |
| 44 | +3. Is it covered by the FAQ? |
| 45 | +4. If none of the above: it is likely a valid new finding. |
| 46 | + Help the researcher write a clear, minimal report including: |
| 47 | + - affected component, |
| 48 | + - impact on the application using this project and subsequent SIEM systems, |
| 49 | + - NUnit 4 test to reproduce the behavior, |
| 50 | + - proposed fix. |
| 51 | +5. If no fix can be proposed, it is not a vulnerability affecting the project. |
| 52 | + |
| 53 | +## Report quality rules |
| 54 | + |
| 55 | +- Never speculate about impact beyond what you can demonstrate. |
| 56 | +- Reproduction steps must be minimal and self-contained. |
| 57 | +- Do not include unrelated findings in the same report: one issue per report. |
| 58 | +- If unsure about severity, say so explicitly rather than guessing. |
0 commit comments