| name | juicebox-security-basics |
| description | Apply Juicebox security best practices.
Use when securing API keys, implementing access controls,
or auditing Juicebox integration security.
Trigger with phrases like "juicebox security", "secure juicebox",
"juicebox API key security", "juicebox access control".
|
| allowed-tools | Read, Grep, Bash(curl:*) |
| version | 1.0.0 |
| license | MIT |
| author | Jeremy Longshore <jeremy@intentsolutions.io> |
Juicebox Security Basics
Overview
Implement security best practices for Juicebox API integration.
Prerequisites
- Juicebox API access configured
- Environment variable management
- Basic security awareness
Instructions
Step 1: Secure API Key Storage
NEVER do this:
const client = new JuiceboxClient({
apiKey: 'jb_prod_xxxxxxxxxxxxxxxxx'
});
DO this instead:
const client = new JuiceboxClient({
apiKey: process.env.JUICEBOX_API_KEY
});
For production, use secret managers:
import { SecretsManager } from '@aws-sdk/client-secrets-manager';
async function getApiKey(): Promise<string> {
const client = new SecretsManager({ region: 'us-east-1' });
const secret = await client.getSecretValue({
SecretId: 'juicebox/api-key'
});
return JSON.parse(secret.SecretString!).apiKey;
}
import { SecretManagerServiceClient } from '@google-cloud/secret-manager';
async function getApiKey(): Promise<string> {
const client = new SecretManagerServiceClient();
const [version] = await client.accessSecretVersion({
name: 'projects/my-project/secrets/juicebox-api-key/versions/latest'
});
return version.payload!.data!.toString();
}
Step 2: Implement Access Controls
export function requireJuiceboxAccess(requiredScope: string) {
return async (req: Request, res: Response, next: NextFunction) => {
const user = req.user;
if (!user) {
return res.status(401).json({ error: 'Authentication required' });
}
const hasScope = user.permissions.includes(`juicebox:${requiredScope}`);
if (!hasScope) {
return res.status(403).json({ error: 'Insufficient permissions' });
}
next();
};
}
app.get('/api/search',
requireJuiceboxAccess('search:read'),
async (req, res) => {
}
);
Step 3: Audit Logging
export class JuiceboxAuditLogger {
async logAccess(event: AuditEvent): Promise<void> {
const entry = {
timestamp: new Date().toISOString(),
userId: event.userId,
action: event.action,
resource: event.resource,
ip: event.ip,
userAgent: event.userAgent,
success: event.success,
metadata: event.metadata
};
await db.auditLogs.insert(entry);
if (this.isSuspicious(event)) {
await this.sendAlert(entry);
}
}
private isSuspicious(event: AuditEvent): boolean {
return (
event.action === 'bulk_export' ||
event.metadata?.resultCount > 1000 ||
.()
);
}
}
Step 4: Data Privacy Compliance
export class DataPrivacyHandler {
redactPII(profile: Profile): RedactedProfile {
return {
...profile,
email: this.maskEmail(profile.email),
phone: profile.phone ? '***-***-' + profile.phone.slice(-4) : undefined
};
}
async recordDataAccess(
userId: string,
profileIds: string[],
purpose: string
): Promise<void> {
await db.dataAccessLog.insert({
userId,
profileIds,
purpose,
timestamp: new Date(),
retentionExpiry: addDays(new Date(), 90)
});
}
async handleDeletionRequest(requestId: string): Promise<> {
}
}
Security Checklist
## Juicebox Security Audit Checklist
### API Key Management
- [ ] API keys stored in secret manager
- [ ] No hardcoded keys in code
- [ ] Keys rotated every 90 days
- [ ] Separate keys for dev/staging/prod
### Access Control
- [ ] Role-based access implemented
- [ ] Principle of least privilege
- [ ] Regular access reviews
### Logging & Monitoring
- [ ] All API calls logged
- [ ] Audit trail maintained
- [ ] Anomaly detection enabled
- [ ] Alerts configured
### Data Privacy
- [ ] PII handling documented
- [ ] Data retention policy
- [ ] GDPR/CCPA compliance
- [ ] Deletion request workflow
Error Handling
| Security Issue | Detection | Response |
|---|
| Key exposure | Git scanning | Rotate immediately |
| Unauthorized access | Audit logs | Revoke access |
| Data breach | Monitoring | Incident response |
Resources
Next Steps
After security setup, see juicebox-prod-checklist for deployment readiness.