Skip to content

Security: arboretica/Report-Scout

Security

SECURITY.md

Security Policy

Thanks for helping keep this project and its users safe. This document explains how to report a vulnerability and what we do to mitigate risk.

Supported Versions

Until v1.0, we provide security fixes for the main branch only.

Reporting a Vulnerability

We aim to acknowledge within 72 hours and provide an initial assessment within 7 days.

Scope & Environment

This repository is a research/ETL pipeline that:

  • Queries web search APIs (ScaleSERP) and fetches public PDFs/HTML
  • Classifies content with an LLM (OpenAI)
  • Writes CSV artifacts and saves PDFs locally

Out of scope: Attacks that require privileged local access, issues in third‑party services/libraries, or site‑owner legal/policy restrictions related to scraping.

Handling Secrets

  • Never commit API keys or tokens. Prefer environment variables or a local .env ignored by Git.
  • Rotate credentials that may have been exposed (e.g., in logs or crash reports).
  • Mask keys in debug output. If a secret appears in logs, treat it as compromised.

Dependency Security

We rely on third‑party libraries. To reduce supply‑chain risk:

  • Keep dependencies updated (consider Dependabot or similar).
  • Pin versions in requirements.txt when possible.
  • Avoid adding packages that execute code at import time without review.

Safe Networking & Scraping Etiquette

  • Respect website terms where applicable; do not bypass paywalls/auth.
  • Use timeouts and conservative retry policies; add polite backoff if broad crawling is introduced.
  • Avoid storing PII; only save PDFs that pass relevance/company checks.

Vulnerability Disclosure & Patch Process

  1. Triage and reproduce.
  2. Assess impact and draft a minimal fix.
  3. Land the fix on main and cut a patch release if versioned.
  4. Credit the reporter (optional, with permission).
  5. Publish a short advisory noting affected versions, mitigation, and fixes.

Hardening Recommendations (for users)

  • Run in an isolated virtual environment (venv/conda).
  • Do not run the pipeline with elevated privileges.
  • Review downloaded PDFs before further distribution.

There aren’t any published security advisories