mirror of
https://github.com/tw93/Mole.git
synced 2026-03-22 23:05:08 +00:00
docs: strengthen public security signals
This commit is contained in:
76
SECURITY.md
Normal file
76
SECURITY.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# Security Policy
|
||||
|
||||
Mole is a local system maintenance tool. It includes high-risk operations such as cleanup, uninstall, optimization, and artifact removal. We treat safety boundaries, deletion logic, and release integrity as security-sensitive areas.
|
||||
|
||||
## Reporting a Vulnerability
|
||||
|
||||
Please report suspected security issues privately.
|
||||
|
||||
- Email: `hitw93@gmail.com`
|
||||
- Subject line: `Mole security report`
|
||||
|
||||
Do not open a public GitHub issue for an unpatched vulnerability.
|
||||
|
||||
If GitHub Security Advisories private reporting is enabled for the repository, you may use that channel instead of email.
|
||||
|
||||
Include as much of the following as possible:
|
||||
|
||||
- Mole version and install method
|
||||
- macOS version
|
||||
- Exact command or workflow involved
|
||||
- Reproduction steps or proof of concept
|
||||
- Whether the issue involves deletion boundaries, symlinks, sudo, path validation, or release/install integrity
|
||||
|
||||
## Response Expectations
|
||||
|
||||
- We aim to acknowledge new reports within 7 calendar days.
|
||||
- We aim to provide a status update within 30 days if a fix or mitigation is not yet available.
|
||||
- We will coordinate disclosure after a fix, mitigation, or clear user guidance is ready.
|
||||
|
||||
Response times are best-effort for a maintainer-led open source project, but security reports are prioritized over normal bug reports.
|
||||
|
||||
## Supported Versions
|
||||
|
||||
Security fixes are only guaranteed for:
|
||||
|
||||
- The latest published release
|
||||
- The current `main` branch
|
||||
|
||||
Older releases may not receive security fixes. Users running high-risk commands should stay current.
|
||||
|
||||
## What We Consider a Security Issue
|
||||
|
||||
Examples of security-relevant issues include:
|
||||
|
||||
- Path validation bypasses
|
||||
- Deletion outside intended cleanup boundaries
|
||||
- Unsafe handling of symlinks or path traversal
|
||||
- Unexpected privilege escalation or unsafe sudo behavior
|
||||
- Sensitive data removal that bypasses documented protections
|
||||
- Release, installation, update, or checksum integrity issues
|
||||
- Vulnerabilities in logic that can cause unintended destructive behavior
|
||||
|
||||
## What Usually Does Not Qualify
|
||||
|
||||
The following are usually normal bugs, feature requests, or documentation issues rather than security issues:
|
||||
|
||||
- Cleanup misses that leave recoverable junk behind
|
||||
- False negatives where Mole refuses to clean something
|
||||
- Cosmetic UI problems
|
||||
- Requests for broader or more aggressive cleanup behavior
|
||||
- Compatibility issues without a plausible security impact
|
||||
|
||||
If you are unsure whether something is security-relevant, report it privately first.
|
||||
|
||||
## Security-Focused Areas in Mole
|
||||
|
||||
The project pays particular attention to:
|
||||
|
||||
- Destructive command boundaries
|
||||
- Path validation and protected-directory rules
|
||||
- Sudo and privilege boundaries
|
||||
- Symlink and path traversal handling
|
||||
- Sensitive data exclusions
|
||||
- Packaging, release artifacts, checksums, and update/install flows
|
||||
|
||||
For the current technical design and known limitations, see [SECURITY_AUDIT.md](SECURITY_AUDIT.md).
|
||||
Reference in New Issue
Block a user