Skip to content

Commit 6245803

Browse files
committed
Add security model
1 parent c3efc9b commit 6245803

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

SECURITY.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# Apache Baremaps Security Model
2+
3+
This document describes the security assumptions and roles for Apache Baremaps. It clarifies who is trusted and their responsibilities.
4+
5+
## Roles
6+
7+
* **Administrator**: Administrates Apache Baremaps, managing the system, configurations, tasks, and data through the CLI or other administrative interfaces.
8+
* **User**: Uses Apache Baremaps through limited, controlled interfaces such as the web interface or API.
9+
10+
## Trust Model
11+
12+
* **Trusted**:
13+
14+
* Administrators
15+
16+
* **Untrusted**:
17+
18+
* Users
19+
20+
## Security Assumptions
21+
22+
* Administrators are fully trusted and responsible for the security of the system and application.
23+
* Configuration files and data sources are managed exclusively by trusted administrators.
24+
25+
## Security Boundaries
26+
27+
* Apache Baremaps relies entirely on trusted administrators to manage files and data.
28+
* Risks such as file path traversal are low because only administrators have access to critical configuration and data inputs.
29+
30+
### Example: Partial Path Traversal Vulnerability in Zip Files
31+
32+
Administrator-provided files are trusted. For instance, if an administrator uses a zip file with a path traversal vulnerability, Apache Baremaps does not systematically sanitize the content, as the administrator is expected to ensure the integrity of the files.
33+
34+
User-provided files are not trusted. For instance, if a user uploads a file through an HTTP endpoint, Apache Baremaps must systematically sanitize and validate the content to block partial path traversal attacks.
35+
36+
## Reporting Security Issues
37+
38+
Report vulnerabilities to [[email protected]](mailto:[email protected]). The Baremaps PMC will address issues following Apache Security guidelines.

0 commit comments

Comments
 (0)