Skip to content

Security: cmc3bear/api-key-forge

Security

SECURITY.md

πŸ”’ SECURITY POLICY

🚨 CRITICAL SECURITY NOTICE

The Vault Directory is SACRED

NEVER, EVER commit the vault/ directory to Git!

vault/
β”œβ”€β”€ GOOGLE/
β”‚   └── YOUR_ACTUAL_API_KEYS_HERE
β”œβ”€β”€ GITHUB/
β”‚   └── YOUR_ACTUAL_TOKENS_HERE
└── [OTHER_SERVICES]/
    └── YOUR_ACTUAL_SECRETS_HERE

This directory contains YOUR REAL API KEYS. If you accidentally commit it:

  1. Your keys will be compromised
  2. Bad actors could use your API quotas
  3. You might get charged money
  4. Your accounts could be hijacked

πŸ›‘οΈ What This Tool Does (and Doesn't Do)

βœ… What it DOES:

  • Opens browser tabs to official API pages
  • Provides step-by-step guides
  • Stores keys locally on YOUR machine
  • Looks incredibly cool while doing it

❌ What it DOESN'T do:

  • Hack anything
  • Bypass security
  • Generate fake API keys
  • Share your keys anywhere
  • Connect to any external servers

πŸ” Security Best Practices

  1. Check .gitignore is working

    git status
    # Make sure no vault/ files appear!
  2. If you see vault files in git status:

    # DO NOT COMMIT!
    git rm --cached -r vault/
    git commit -m "Remove vault from tracking"
  3. Rotate keys regularly

    • GitHub tokens: Every 90 days
    • API keys: Follow service recommendations
    • Passwords: Use a password manager
  4. Never share your vault

    • Don't zip and email it
    • Don't screenshot keys
    • Don't commit to ANY repository

πŸš‘ Emergency: I Committed My Keys!

If you accidentally committed API keys:

  1. Immediately revoke the exposed keys

    • GitHub: Settings β†’ Developer settings β†’ Personal access tokens
    • Google: Cloud Console β†’ Credentials
    • OpenAI: Account β†’ API keys
    • [Other services: check their security settings]
  2. Remove from Git history

    # Use BFG Repo-Cleaner (easier)
    bfg --delete-files "*.key" --delete-folders "vault"
    
    # Or git filter-branch (harder)
    git filter-branch --force --index-filter \
      'git rm -r --cached --ignore-unmatch vault/' \
      --prune-empty --tag-name-filter cat -- --all
  3. Force push to update remote

    git push --force --all
    git push --force --tags
  4. Generate new keys for all services

🎯 Responsible Disclosure

Found a security issue with this tool? Please:

  1. Do NOT post it publicly
  2. Email: [your-email@example.com]
  3. Allow 48 hours for response
  4. Be radical, but responsible

πŸ“‹ Security Checklist

Before sharing or publishing:

  • Vault directory is in .gitignore
  • No keys in any .bat files
  • No keys in README or docs
  • Git history is clean
  • Test files don't contain real keys
  • Screenshots don't show real keys

Remember: Looking like a hacker is cool. Being secure is cooler.

[SECURITY PROTOCOLS: ENGAGED]
[ENCRYPTION: MAXIMUM]
[PARANOIA LEVEL: APPROPRIATE]

There aren't any published security advisories