Skip to content

Security policy ​

中文

Reporting a vulnerability ​

GitHub private vulnerability reporting is enabled for this repository.

Use Security → Report a vulnerability in hulkbig/ferry: private report entry. If it is unavailable, use an existing private channel to the maintainer or request a private contact without disclosing vulnerability details. Do not submit exploit steps to a public issue or PR.

Do not attach databases, backups, tokens, complete OAuth callback URLs or user conversations. Ordinary functional bugs belong in Issues; see Contributing.

What to include ​

Provide the affected version, installation method, impact, a minimal reproduction, necessary redacted logs and whether actual exposure has occurred. Start with a summary, then exchange sensitive reproduction material privately. Do not test instances you are not authorized to assess.

Supported versions and response ​

The latest 0.1.x patch is supported, currently 0.1.1. Users of 0.1.0 should upgrade for the Codex usage refresh and quota protection fix. Older development snapshots do not have a separate support commitment.

There is no guaranteed response or remediation deadline. Maintainers first establish impact and reproduce the issue, then coordinate remediation and disclosure. A candidate build or passing CI is not evidence of a completed security audit.

Deployment boundaries ​

  • Initialize the administrator in a controlled environment before enabling access.
  • Use TLS and access restrictions for remote administration; avoid exposing management ports directly to the internet.
  • Use separate, scoped client API keys and management tokens.
  • Protect SQLite, WAL files, backups and request logs; encryption at rest is not enabled by default.
  • Request-body debugging can contain sensitive data. Enable it only when needed and review retention.

See Docker operations. The detailed threat model and operations guide are currently in Chinese.

Apache-2.0 · Third-party notices included