Skip to content

Security: HyperVon/new-kraken-rebalancer

SECURITY.md

Security Policy

Supported Versions

Only the latest release on the main branch is actively maintained and receives security updates.

Version Supported
latest (main)
older releases

Reporting a Vulnerability

Please do not report security vulnerabilities through public GitHub issues.

This project manages live cryptocurrency portfolio data and interacts with the Kraken exchange API. Security vulnerabilities should be treated with care.

How to Report

Please use GitHub's * *Private Vulnerability Reporting ** feature to submit a vulnerability report confidentially.

Alternatively, you may open a GitHub Security Advisory directly from the * Security* tab of this repository.

What to Include

Please include as much of the following as possible:

  • A description of the vulnerability and its potential impact
  • Steps to reproduce the issue
  • Any relevant logs, screenshots, or proof-of-concept code
  • Suggested fix or mitigation (if known)

What to Expect

  • Acknowledgement: Within 48 hours of submission
  • Status update: Within 7 days with an assessment of severity and planned resolution
  • Resolution: Critical vulnerabilities will be prioritized and patched as quickly as possible

Security Considerations for Users

This application handles sensitive Kraken API credentials and executes live trades. When deploying:

  • Never commit your rebalancer-config.json — it contains your API keys and is listed in .gitignore for this reason
  • Run with the minimum required API permissions on Kraken (Query Funds, Query Open Orders, Create & Modify Orders)
  • Consider running in dry-run mode (dryRun: true) before enabling live trading
  • Restrict access to the machine running this application
  • Regularly rotate your Kraken API keys

There aren't any published security advisories