Skip to content

Security: fairy-pitta/portree

Security

SECURITY.md

Security Policy

Supported Versions

Version Supported
0.x.x

Reporting a Vulnerability

If you discover a security vulnerability in portree, please report it responsibly:

  1. Do NOT open a public GitHub issue
  2. Send an email to the maintainers (create a private security advisory on GitHub)
  3. Include:
    • Description of the vulnerability
    • Steps to reproduce
    • Potential impact
    • Suggested fix (if any)

We will respond within 48 hours and work with you to understand and address the issue.

Security Considerations

portree manages processes and network ports on your local machine. Please be aware:

  • Process Management: portree spawns child processes based on commands in .portree.toml. Only run commands you trust.
  • Port Binding: Services bind to 127.0.0.1 (localhost) by default. They are not exposed to external networks unless explicitly configured.
  • State Files: Runtime state is stored in ~/.portree/ with user-only permissions (0600).
  • No Remote Code Execution: portree does not fetch or execute remote code.

Best Practices

  • Review .portree.toml before running portree up in untrusted repositories
  • Keep portree updated to the latest version
  • Do not commit sensitive credentials in .portree.toml - use environment variables instead

There aren’t any published security advisories