Skip to content

Security: vwall/kitout

SECURITY.md

Security

Core safety principle

Kitout runs on a user's local machine and can modify important files. Safety is a product requirement, not an add-on.

Secrets

Do not store secrets in Kitout config.

Examples of secrets:

  • API keys
  • private SSH keys
  • tokens
  • passwords
  • .env values

Kitout may install or check secret-management tools, but it should not become one.

Shell commands

Shell commands are allowed only when explicitly listed in config.

Kitout must show shell commands during dry-run.

Kitout should require confirmation before running shell commands unless --yes is passed.

File safety

Kitout must not overwrite existing files by default.

Symlink replacement must be explicit.

Potential future backup behavior must be opt-in and well documented.

Reporting vulnerabilities

Do not report vulnerabilities in a public issue.

Use GitHub private vulnerability reporting to share sensitive details with the maintainer. If that channel is temporarily unavailable, open a public issue requesting a private contact channel without including vulnerability details.

Please include:

  • affected Kitout version or commit
  • config/resource type involved
  • steps to reproduce
  • expected impact
  • any suggested mitigation

The maintainer will acknowledge reports as soon as practical, triage the issue, and coordinate a fix before public disclosure when the report describes a real security impact.

There aren't any published security advisories