# Security Guidelines

## IMPORTANT: API Token Security

The API token that was previously committed to this repository has been exposed and should be considered compromised. 

### Immediate Actions Required:

1. **Regenerate API Token**: 
   - Log into your Stellar Cyber instance
   - Navigate to API Settings
   - Revoke the existing token
   - Generate a new API token

2. **Never Commit Secrets**:
   - Always use environment variables for sensitive data
   - Use the `.env` file locally (it's now in .gitignore)
   - Reference `.env.example` for required variables

### Setting Up Credentials Securely:

1. Copy `.env.example` to `.env`:
   ```bash
   cp .env.example .env
   ```

2. Edit `.env` with your actual credentials:
   ```
   STELLAR_API_URL=https://your-instance.stellarcyber.cloud
   STELLAR_API_TOKEN=your-new-token-here
   ```

3. Ensure `.env` is never committed (it's in .gitignore)

### Best Practices:

- **Environment Variables**: Always use environment variables for sensitive configuration
- **Token Rotation**: Regularly rotate API tokens
- **Least Privilege**: Use tokens with minimal required permissions
- **Secure Storage**: Consider using secret management tools for production
- **Code Reviews**: Review all commits for accidentally included secrets

### Git History Cleanup:

Since the token was previously committed, consider:
1. Using `git filter-branch` or BFG Repo-Cleaner to remove sensitive data from history
2. Force-pushing the cleaned history (coordinate with team members)
3. Ensuring all team members update their local repositories

### Additional Security Measures:

- Enable 2FA on your Stellar Cyber account
- Monitor API token usage for suspicious activity
- Use separate tokens for different environments (dev, staging, prod)
- Implement token expiration policies where possible