技能 编程开发 Clay 安全最佳实践

Clay 安全最佳实践

v20260222
clay-security-basics
介绍Clay API的密钥及访问控制安全流程,包括环境变量配置、密钥轮换、最小权限及审计日志,适用于开发/预发/生产环境的安全加固。
获取技能
212 次下载
概览

Clay Security Basics

Overview

Security best practices for Clay API keys, tokens, and access control.

Prerequisites

  • Clay SDK installed
  • Understanding of environment variables
  • Access to Clay dashboard

Instructions

Step 1: Configure Environment Variables

# .env (NEVER commit to git)
CLAY_API_KEY=sk_live_***
CLAY_SECRET=***

# .gitignore
.env
.env.local
.env.*.local

Step 2: Implement Secret Rotation

# 1. Generate new key in Clay dashboard
# 2. Update environment variable
export CLAY_API_KEY="new_key_here"

# 3. Verify new key works
curl -H "Authorization: Bearer ${CLAY_API_KEY}" \
  https://api.clay.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 ClayClient({
    apiKey: process.env.CLAY_READ_KEY,
  }),
  writer: new ClayClient({
    apiKey: process.env.CLAY_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
  • .env files 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 Clay analytics
  await clayClient.track('audit', log);

  // Also log locally for compliance
  console.log('[AUDIT]', JSON.stringify(log));
}

// Usage
await auditLog({
  action: 'clay.api.call',
  userId: currentUser.id,
  resource: '/v1/resource',
  result: 'success',
});

Resources

Next Steps

For production deployment, see clay-prod-checklist.

信息
Category 编程开发
Name clay-security-basics
版本 v20260222
大小 3.3KB
更新时间 2026-02-25
语言