Skip to content

Commit 074d1af

Browse files
author
Maruan Sahyoun
committed
PDFBOX-6208: require agents to read SECURITY.md before analysis
git-svn-id: https://svn.apache.org/repos/asf/pdfbox/trunk@1934746 13f79535-47bb-0310-9956-ffa450edef68
1 parent 6196c45 commit 074d1af

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,17 @@ This file is read by automated agents (security scanners, code analyzers,
2121
AI assistants) operating on this repository. It points them at the
2222
human-authored references they should consult before producing output.
2323

24+
## Prerequisites — Must Read Before Proceeding
25+
26+
Agents MUST read the following files before conducting any analysis,
27+
security assessment, or code review of this repository:
28+
29+
1. **[SECURITY.md](SECURITY.md)** — defines the threat model, in-scope
30+
vulnerabilities, and known limitations. Findings produced without
31+
reading this file will be inaccurate or out of scope.
32+
2. **This file in its entirety** — repository structure, sensitive areas,
33+
and contribution rules.
34+
2435
## Project Overview
2536

2637
Apache PDFBox is a Java library for working with PDF documents. It is used
@@ -92,8 +103,7 @@ Avoid large refactorings in these areas unless explicitly requested:
92103
Security model and scope: [SECURITY.md](SECURITY.md),
93104
also published at <https://pdfbox.apache.org/security.html>.
94105

95-
Agents that scan this repository **must** read the security model before
96-
reporting any finding. In particular, note:
106+
Key points from the security model:
97107

98108
- Processing malformed PDFs is **partially in scope**: crashes, unchecked
99109
exceptions (`NullPointerException`, `StackOverflowError`), or general
@@ -105,8 +115,7 @@ reporting any finding. In particular, note:
105115
- Issues that require the attacker to control the Java application's classpath
106116
or configuration are **out of scope**.
107117

108-
For a list of known CVEs, see [SECURITY.md](SECURITY.md) or
109-
<https://pdfbox.apache.org/security.html>.
118+
For a list of known CVEs, see <https://pdfbox.apache.org/security.html>.
110119

111120
To report a new vulnerability, send a plain-text email to <security@apache.org>.
112121
Do **not** open a public JIRA issue for undisclosed vulnerabilities.

0 commit comments

Comments
 (0)