Skip to content

Security: alielsokary/CaskFlow

SECURITY.md

Security Policy

CaskFlow is a free, open-source data pipeline. It turns the Homebrew cask catalog into reviewed metadata and icon assets consumed by CaskHub.

The integrity of the published assets is the core security concern of this project. This policy explains how to report security issues, what to expect, and what is in scope.

Supported Versions

CaskFlow follows a rolling release model: only the latest release assets and the latest commit on master are supported. Security fixes ship in a new release rather than being backported.

Version Supported
Latest release
Latest commit on master
Older releases

Reporting a Vulnerability

You must not report security vulnerabilities through public GitHub issues, discussions, or pull requests.

Exception: if you have no GitHub account or cannot use the advisory form below, open a regular issue asking for a private contact channel, without including vulnerability details.

Report privately through GitHub's private vulnerability reporting:

Open a security advisory

Reports should include:

  • A description of the vulnerability and its impact
  • The affected script, workflow, or published asset
  • Step-by-step instructions to reproduce the issue
  • Proof-of-concept code or crafted input, and a suggested mitigation, if you have them

What to expect

For now, CaskFlow is maintained by a single developer in their spare time, so please allow a little slack on timelines:

  • Your report will be acknowledged within 7 days.
  • You will receive updates as the issue is triaged and fixed.
  • Confirmed vulnerabilities are fixed as quickly as severity demands.

Disclosure policy

We follow coordinated disclosure. You should allow up to 90 days for a fix to be released before disclosing the issue publicly.

Once fixed, an advisory will be published. You will be credited for the discovery unless you prefer to remain anonymous.

There is no bug bounty program, since CaskFlow is free software with no revenue, but reporters are credited in the advisory and release notes.

Scope

In scope (report privately)

  • The pipeline code in this repository: scripts/ and the GitHub Actions workflows
  • The integrity of published assets: categories.json, added_dates.json, release artifacts, and the icons branch

Examples of in-scope issues:

  • Tampering with published assets or releases through the project's CI
  • Escaping the icon extraction safety protocol, e.g. archive path traversal, bypassing checksum verification, or executing vendor installer code during extraction
  • Injecting malicious content into published data past human review, e.g. crafted cask metadata or homepage content that abuses the high-confidence auto-merge classification path
  • Leaking CI secrets (LLM provider keys, tokens) through workflows or logs
  • Code execution in the pipeline via attacker-controlled inputs: cask metadata, homepages, or vendor artifacts

Out of scope (report elsewhere or publicly)

  • Homebrew itself. Vulnerabilities in Homebrew or its cask catalog belong to Homebrew's security policy.
  • Malicious or vulnerable upstream apps. CaskFlow classifies third-party software; the behavior of those apps is not a CaskFlow vulnerability. A vendor artifact that exploits the extraction pipeline itself is in scope.
  • Misclassification without security impact. Wrong categories or dates are quality bugs. See the classification guide and file a regular issue.
  • The CaskHub app. Issues in the consumer belong to CaskHub's security policy.
  • Attacks requiring local control of the machine running the scripts, or of the repository and CI credentials themselves.
  • Availability of third-party services the pipeline relies on (GitHub, Homebrew's API, LLM providers).

Thank you for helping keep CaskFlow, CaskHub, and their users safe!

There aren't any published security advisories