ideogram-security-basics
Apply Ideogram security best practices for secrets and access control.Use when securing API keys, implementing least privilege access,or auditing Ideogram security configuration.Trigger with phrases like "ideogram security", "ideogram secrets","secure ideogram", "ideogram API key security".
When & Why to Use This Skill
This Claude skill provides a comprehensive framework for implementing Ideogram security best practices, focusing on robust secrets management and access control. It enables developers to secure API keys, implement the principle of least privilege across different environments, and establish automated audit logging to protect sensitive integration credentials and maintain system integrity.
Use Cases
- Secure API Key Management: Transitioning from hardcoded credentials to secure environment variables and configuring .gitignore to prevent accidental exposure in version control.
- Automated Secret Rotation: Implementing a step-by-step workflow for generating, verifying, and revoking Ideogram API keys to minimize the window of vulnerability.
- Environment-Specific Access Control: Applying granular scopes (Read/Write) tailored to Development, Staging, and Production environments to enforce least privilege.
- Webhook Signature Verification: Using cryptographic hashing to validate incoming Ideogram webhooks, ensuring data authenticity and preventing man-in-the-middle attacks.
- Security Auditing and Compliance: Integrating automated audit logs to track API actions, user IDs, and resource access for real-time monitoring and regulatory compliance.
| name | ideogram-security-basics |
|---|---|
| description | | |
| allowed-tools | Read, Write, Grep |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Ideogram Security Basics
Overview
Security best practices for Ideogram API keys, tokens, and access control.
Prerequisites
- Ideogram SDK installed
- Understanding of environment variables
- Access to Ideogram dashboard
Instructions
Step 1: Configure Environment Variables
# .env (NEVER commit to git)
IDEOGRAM_API_KEY=sk_live_***
IDEOGRAM_SECRET=***
# .gitignore
.env
.env.local
.env.*.local
Step 2: Implement Secret Rotation
# 1. Generate new key in Ideogram dashboard
# 2. Update environment variable
export IDEOGRAM_API_KEY="new_key_here"
# 3. Verify new key works
curl -H "Authorization: Bearer ${IDEOGRAM_API_KEY}" \
https://api.ideogram.com/health
# 4. Revoke old key in dashboard
Step 3: Apply Least Privilege
| Environment | Recommended Scopes |
|---|---|
| Development | read:* |
| Staging | read:*, write:limited |
| Production | Only required scopes |
Output
- Secure API key storage
- Environment-specific access controls
- Audit logging enabled
Error Handling
| Security Issue | Detection | Mitigation |
|---|---|---|
| Exposed API key | Git scanning | Rotate immediately |
| Excessive scopes | Audit logs | Reduce permissions |
| Missing rotation | Key age check | Schedule rotation |
Examples
Service Account Pattern
const clients = {
reader: new IdeogramClient({
apiKey: process.env.IDEOGRAM_READ_KEY,
}),
writer: new IdeogramClient({
apiKey: process.env.IDEOGRAM_WRITE_KEY,
}),
};
Webhook Signature Verification
import crypto from 'crypto';
function verifyWebhookSignature(
payload: string, signature: string, secret: string
): boolean {
const expected = crypto.createHmac('sha256', secret).update(payload).digest('hex');
return crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected));
}
Security Checklist
- API keys in environment variables
-
.envfiles in.gitignore - Different keys for dev/staging/prod
- Minimal scopes per environment
- Webhook signatures validated
- Audit logging enabled
Audit Logging
interface AuditEntry {
timestamp: Date;
action: string;
userId: string;
resource: string;
result: 'success' | 'failure';
metadata?: Record<string, any>;
}
async function auditLog(entry: Omit<AuditEntry, 'timestamp'>): Promise<void> {
const log: AuditEntry = { ...entry, timestamp: new Date() };
// Log to Ideogram analytics
await ideogramClient.track('audit', log);
// Also log locally for compliance
console.log('[AUDIT]', JSON.stringify(log));
}
// Usage
await auditLog({
action: 'ideogram.api.call',
userId: currentUser.id,
resource: '/v1/resource',
result: 'success',
});
Resources
Next Steps
For production deployment, see ideogram-prod-checklist.