Skip to content

Security: bee-san/Ciphey

SECURITY.md

Security Policy

Supported Versions

Security fixes are applied on master.

Version Supported
master Yes
Latest tagged release Best effort
Older releases No

If a fix is shipped in a release, assume older releases remain vulnerable unless explicitly noted otherwise.

Reporting A Vulnerability

Do not open a public GitHub issue for a suspected vulnerability.

Report it privately to bee@skerritt.blog with a subject like [ciphey security] <short summary>.

If the GitHub UI shows a Report a vulnerability option for this repository, you can use that private reporting flow instead of email.

Include:

  • affected version, commit, or branch
  • operating system and how you installed ciphey
  • a short impact statement
  • reproduction steps or a proof of concept
  • whether the issue requires local access, crafted input, or user interaction

Plain text email is acceptable. If you need a different reporting channel, ask in the initial email.

What To Expect

Maintainers will aim to:

  • acknowledge the report within 72 hours
  • confirm whether the issue is in scope
  • share status updates while a fix is being prepared
  • credit the reporter after disclosure, if requested

Please allow time for a fix before public disclosure.

Related Security Documents

Scope Notes

Issues that are especially relevant for this project include:

  • crashes, hangs, or resource-exhaustion bugs triggered by untrusted input
  • unsafe handling of local files passed through the CLI
  • data exposure involving ~/.ciphey/config.toml, ~/.ciphey/database.sqlite, or model files under ~/.ciphey/models/
  • problems in the optional enhanced-detection setup flow, including token handling during model download
  • supply-chain issues in release artifacts or dependencies that materially affect users of ciphey

User Data And Secrets

Current repository behavior that matters for security review:

  • ciphey stores cache and human-review data in a local SQLite database at ~/.ciphey/database.sqlite.
  • Configuration is stored locally at ~/.ciphey/config.toml.
  • The first-run enhanced-detection flow prompts for a Hugging Face token and states that the token is used for model download and not stored on disk.

If you report an issue, avoid sending real secrets or private datasets unless they are necessary to reproduce the problem.

There aren’t any published security advisories