windsurf-security-basics

将 Windsurf 安全最佳实践应用于机密和访问控制。在保护 API 密钥、实施最低权限访问或审核 Windsurf 安全配置时使用。使用“windsurf 安全”、“windsurf 秘密”、“安全 Windsurf”、“windsurf API 密钥安全”等短语触发。

📖 中文导读:将 Windsurf 安全最佳实践应用于机密和访问控制。在保护 API 密钥、实施最低权限访问或审核 Windsurf 安全配置时使用。使用“windsurf 安全”、“windsurf 秘密”、“安全 Windsurf”、“windsurf API 密钥安全”等短语触发。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: windsurf-security-basics description: | Apply Windsurf security best practices for secrets and access control. Use when securing API keys, implementing least privilege access, or auditing Windsurf security configuration. Trigger with phrases like "windsurf security", "windsurf secrets", "secure windsurf", "windsurf API key security". allowed-tools: Read, Write, Grep version: 1.0.0 license: MIT author: Jeremy Longshore jeremy@intentsolutions.io

Windsurf Security Basics

Overview

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

Prerequisites

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

Instructions

Step 1: Configure Environment Variables

# .env (NEVER commit to git)
WINDSURF_API_KEY=sk_live_***
WINDSURF_SECRET=***

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

Step 2: Implement Secret Rotation

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

# 3. Verify new key works
curl -H "Authorization: Bearer ${WINDSURF_API_KEY}" \
  https://api.windsurf.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 WindsurfClient({
    apiKey: process.env.WINDSURF_READ_KEY,
  }),
  writer: new WindsurfClient({
    apiKey: process.env.WINDSURF_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 Windsurf analytics
  await windsurfClient.track('audit', log);

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

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

Resources

Next Steps

For production deployment, see windsurf-prod-checklist.