Skip to content

Security: birdbathd/lick_tester

Security

SECURITY.md

πŸ”’ Security Configuration Guide

⚠️ IMPORTANT: Protecting Your API Keys

Your AsterDX API keys are valuable and must be protected. Follow these steps:

βœ… What's Already Protected

  • config/config.user.json is automatically ignored by git
  • Template file provided for easy setup
  • Docker containers use secure non-root users
  • Environment variables supported for additional security

πŸ”§ Initial Setup

  1. Copy the template:

    cp config/config.user.json.template config/config.user.json
  2. Add your real API keys:

    {
      "api": {
        "apiKey": "your_actual_api_key_here",
        "secretKey": "your_actual_secret_key_here"
      }
    }
  3. Verify git ignores it:

    git status
    # config.user.json should NOT appear in changes

🚨 Emergency: If Keys Were Committed

If you accidentally committed API keys:

  1. Immediately revoke keys on AsterDX
  2. Generate new API keys
  3. Remove from git history:
    git filter-branch --force --index-filter \
    'git rm --cached --ignore-unmatch config/config.user.json' \
    --prune-empty --tag-name-filter cat -- --all
  4. Force push (DANGEROUS - coordinate with team):
    git push origin --force --all

πŸ” Best Practices

  • Never share config files containing real API keys
  • Use environment variables in production deployments
  • Rotate API keys regularly
  • Use separate keys for development and production
  • Enable IP restrictions on AsterDX if possible
  • Monitor API usage for unauthorized access

🐳 Docker Security

  • Containers run as non-root user
  • Use Docker secrets for production:
    secrets:
      asterdx_api_key:
        external: true
      asterdx_secret_key:
        external: true

πŸ” Environment Variables Alternative

For additional security, use environment variables:

export ASTERDX_API_KEY="your_api_key"
export ASTERDX_SECRET_KEY="your_secret_key"

Update your config to read from env vars:

{
  "api": {
    "apiKey": "${ASTERDX_API_KEY}",
    "secretKey": "${ASTERDX_SECRET_KEY}"
  }
}

πŸ“ž Need Help?

If you suspect your keys have been compromised:

  1. Immediately revoke the keys on AsterDX
  2. Generate new keys
  3. Review account activity
  4. Contact AsterDX support if needed

Remember: Security is your responsibility. Treat API keys like passwords!

There aren’t any published security advisories