mirror of
https://github.com/simstudioai/sim.git
synced 2026-04-06 03:00:16 -04:00
* feat(audit-log): add persistent audit log system with comprehensive route instrumentation
* fix(audit-log): address PR review — nullable workspaceId, enum usage, remove redundant queries
- Make audit_log.workspace_id nullable with ON DELETE SET NULL (logs survive workspace/user deletion)
- Make audit_log.actor_id nullable with ON DELETE SET NULL
- Replace all 53 routes' string literal action/resourceType with AuditAction.X and AuditResourceType.X enums
- Fix empty workspaceId ('') → null for OAuth, form, and org routes to avoid FK violations
- Remove redundant DB queries in chat manage route (use checkChatAccess return data)
- Fix organization routes to pass workspaceId: null instead of organizationId
* fix(audit-log): replace remaining workspaceId '' fallbacks with null
* fix(audit-log): credential-set org IDs, workspace deletion FK, actorId fallback, string literal action
* reran migrations
* fix(mcp,audit): tighten env var domain bypass, add post-resolution check, form workspaceId
- Only bypass MCP domain check when env var is in hostname/authority, not path/query
- Add post-resolution validateMcpDomain call in test-connection endpoint
- Match client-side isDomainAllowed to same hostname-only bypass logic
- Return workspaceId from checkFormAccess, use in form audit logs
- Add 49 comprehensive domain-check tests covering all edge cases
* fix(mcp): stateful regex lastIndex bug, RFC 3986 authority parsing
- Remove /g flag from module-level ENV_VAR_PATTERN to avoid lastIndex state
- Create fresh regex instances per call in server-side hasEnvVarInHostname
- Fix authority extraction to terminate at /, ?, or # per RFC 3986
- Prevents bypass via https://evil.com?token={{SECRET}} (no path)
- Add test cases for query-only and fragment-only env var URLs (53 total)
* fix(audit-log): try/catch for never-throw contract, accept null actorName/Email, fix misleading action
- Wrap recordAudit body in try/catch so nanoid() or header extraction can't throw
- Accept string | null for actorName and actorEmail (session.user.name can be null)
- Normalize null -> undefined before insert to match DB column types
- Fix org members route: ORG_MEMBER_ADDED -> ORG_INVITATION_CREATED (sends invite, not adds member)
* improvement(audit-log): add resource names and specific invitation actions
* fix(audit-log): use validated chat record, add mock sync tests
262 lines
7.4 KiB
TypeScript
262 lines
7.4 KiB
TypeScript
import { db } from '@sim/db'
|
|
import { apiKey } from '@sim/db/schema'
|
|
import { createLogger } from '@sim/logger'
|
|
import { and, eq, inArray } from 'drizzle-orm'
|
|
import { nanoid } from 'nanoid'
|
|
import { type NextRequest, NextResponse } from 'next/server'
|
|
import { z } from 'zod'
|
|
import { createApiKey, getApiKeyDisplayFormat } from '@/lib/api-key/auth'
|
|
import { AuditAction, AuditResourceType, recordAudit } from '@/lib/audit/log'
|
|
import { getSession } from '@/lib/auth'
|
|
import { PlatformEvents } from '@/lib/core/telemetry'
|
|
import { generateRequestId } from '@/lib/core/utils/request'
|
|
import { getUserEntityPermissions, getWorkspaceById } from '@/lib/workspaces/permissions/utils'
|
|
|
|
const logger = createLogger('WorkspaceApiKeysAPI')
|
|
|
|
const CreateKeySchema = z.object({
|
|
name: z.string().trim().min(1, 'Name is required'),
|
|
})
|
|
|
|
const DeleteKeysSchema = z.object({
|
|
keys: z.array(z.string()).min(1),
|
|
})
|
|
|
|
export async function GET(request: NextRequest, { params }: { params: Promise<{ id: string }> }) {
|
|
const requestId = generateRequestId()
|
|
const workspaceId = (await params).id
|
|
|
|
try {
|
|
const session = await getSession()
|
|
if (!session?.user?.id) {
|
|
logger.warn(`[${requestId}] Unauthorized workspace API keys access attempt`)
|
|
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
|
|
}
|
|
|
|
const userId = session.user.id
|
|
|
|
const ws = await getWorkspaceById(workspaceId)
|
|
if (!ws) {
|
|
return NextResponse.json({ error: 'Workspace not found' }, { status: 404 })
|
|
}
|
|
|
|
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
|
|
if (!permission) {
|
|
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
|
|
}
|
|
|
|
const workspaceKeys = await db
|
|
.select({
|
|
id: apiKey.id,
|
|
name: apiKey.name,
|
|
key: apiKey.key,
|
|
createdAt: apiKey.createdAt,
|
|
lastUsed: apiKey.lastUsed,
|
|
expiresAt: apiKey.expiresAt,
|
|
createdBy: apiKey.createdBy,
|
|
})
|
|
.from(apiKey)
|
|
.where(and(eq(apiKey.workspaceId, workspaceId), eq(apiKey.type, 'workspace')))
|
|
.orderBy(apiKey.createdAt)
|
|
|
|
const formattedWorkspaceKeys = await Promise.all(
|
|
workspaceKeys.map(async (key) => {
|
|
const displayFormat = await getApiKeyDisplayFormat(key.key)
|
|
return {
|
|
...key,
|
|
key: key.key,
|
|
displayKey: displayFormat,
|
|
}
|
|
})
|
|
)
|
|
|
|
return NextResponse.json({
|
|
keys: formattedWorkspaceKeys,
|
|
})
|
|
} catch (error: unknown) {
|
|
logger.error(`[${requestId}] Workspace API keys GET error`, error)
|
|
return NextResponse.json(
|
|
{ error: error instanceof Error ? error.message : 'Failed to load API keys' },
|
|
{ status: 500 }
|
|
)
|
|
}
|
|
}
|
|
|
|
export async function POST(request: NextRequest, { params }: { params: Promise<{ id: string }> }) {
|
|
const requestId = generateRequestId()
|
|
const workspaceId = (await params).id
|
|
|
|
try {
|
|
const session = await getSession()
|
|
if (!session?.user?.id) {
|
|
logger.warn(`[${requestId}] Unauthorized workspace API key creation attempt`)
|
|
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
|
|
}
|
|
|
|
const userId = session.user.id
|
|
|
|
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
|
|
if (permission !== 'admin') {
|
|
return NextResponse.json({ error: 'Forbidden' }, { status: 403 })
|
|
}
|
|
|
|
const body = await request.json()
|
|
const { name } = CreateKeySchema.parse(body)
|
|
|
|
const existingKey = await db
|
|
.select()
|
|
.from(apiKey)
|
|
.where(
|
|
and(
|
|
eq(apiKey.workspaceId, workspaceId),
|
|
eq(apiKey.name, name),
|
|
eq(apiKey.type, 'workspace')
|
|
)
|
|
)
|
|
.limit(1)
|
|
|
|
if (existingKey.length > 0) {
|
|
return NextResponse.json(
|
|
{
|
|
error: `A workspace API key named "${name}" already exists. Please choose a different name.`,
|
|
},
|
|
{ status: 409 }
|
|
)
|
|
}
|
|
|
|
const { key: plainKey, encryptedKey } = await createApiKey(true)
|
|
|
|
if (!encryptedKey) {
|
|
throw new Error('Failed to encrypt API key for storage')
|
|
}
|
|
|
|
const [newKey] = await db
|
|
.insert(apiKey)
|
|
.values({
|
|
id: nanoid(),
|
|
workspaceId,
|
|
userId: userId,
|
|
createdBy: userId,
|
|
name,
|
|
key: encryptedKey,
|
|
type: 'workspace',
|
|
createdAt: new Date(),
|
|
updatedAt: new Date(),
|
|
})
|
|
.returning({
|
|
id: apiKey.id,
|
|
name: apiKey.name,
|
|
createdAt: apiKey.createdAt,
|
|
})
|
|
|
|
try {
|
|
PlatformEvents.apiKeyGenerated({
|
|
userId: userId,
|
|
keyName: name,
|
|
})
|
|
} catch {
|
|
// Telemetry should not fail the operation
|
|
}
|
|
|
|
logger.info(`[${requestId}] Created workspace API key: ${name} in workspace ${workspaceId}`)
|
|
|
|
recordAudit({
|
|
workspaceId,
|
|
actorId: userId,
|
|
actorName: session?.user?.name,
|
|
actorEmail: session?.user?.email,
|
|
action: AuditAction.API_KEY_CREATED,
|
|
resourceType: AuditResourceType.API_KEY,
|
|
resourceId: newKey.id,
|
|
resourceName: name,
|
|
description: `Created API key "${name}"`,
|
|
metadata: { keyName: name },
|
|
request,
|
|
})
|
|
|
|
return NextResponse.json({
|
|
key: {
|
|
...newKey,
|
|
key: plainKey,
|
|
},
|
|
})
|
|
} catch (error: unknown) {
|
|
logger.error(`[${requestId}] Workspace API key POST error`, error)
|
|
return NextResponse.json(
|
|
{ error: error instanceof Error ? error.message : 'Failed to create workspace API key' },
|
|
{ status: 500 }
|
|
)
|
|
}
|
|
}
|
|
|
|
export async function DELETE(
|
|
request: NextRequest,
|
|
{ params }: { params: Promise<{ id: string }> }
|
|
) {
|
|
const requestId = generateRequestId()
|
|
const workspaceId = (await params).id
|
|
|
|
try {
|
|
const session = await getSession()
|
|
if (!session?.user?.id) {
|
|
logger.warn(`[${requestId}] Unauthorized workspace API key deletion attempt`)
|
|
return NextResponse.json({ error: 'Unauthorized' }, { status: 401 })
|
|
}
|
|
|
|
const userId = session.user.id
|
|
|
|
const permission = await getUserEntityPermissions(userId, 'workspace', workspaceId)
|
|
if (permission !== 'admin') {
|
|
return NextResponse.json({ error: 'Forbidden' }, { status: 403 })
|
|
}
|
|
|
|
const body = await request.json()
|
|
const { keys } = DeleteKeysSchema.parse(body)
|
|
|
|
const deletedCount = await db
|
|
.delete(apiKey)
|
|
.where(
|
|
and(
|
|
eq(apiKey.workspaceId, workspaceId),
|
|
eq(apiKey.type, 'workspace'),
|
|
inArray(apiKey.id, keys)
|
|
)
|
|
)
|
|
|
|
try {
|
|
for (const keyId of keys) {
|
|
PlatformEvents.apiKeyRevoked({
|
|
userId: userId,
|
|
keyId: keyId,
|
|
})
|
|
}
|
|
} catch {
|
|
// Telemetry should not fail the operation
|
|
}
|
|
|
|
logger.info(
|
|
`[${requestId}] Deleted ${deletedCount} workspace API keys from workspace ${workspaceId}`
|
|
)
|
|
|
|
recordAudit({
|
|
workspaceId,
|
|
actorId: userId,
|
|
actorName: session?.user?.name,
|
|
actorEmail: session?.user?.email,
|
|
action: AuditAction.API_KEY_REVOKED,
|
|
resourceType: AuditResourceType.API_KEY,
|
|
description: `Revoked ${deletedCount} API key(s)`,
|
|
metadata: { keyIds: keys, deletedCount },
|
|
request,
|
|
})
|
|
|
|
return NextResponse.json({ success: true, deletedCount })
|
|
} catch (error: unknown) {
|
|
logger.error(`[${requestId}] Workspace API key DELETE error`, error)
|
|
return NextResponse.json(
|
|
{ error: error instanceof Error ? error.message : 'Failed to delete workspace API keys' },
|
|
{ status: 500 }
|
|
)
|
|
}
|
|
}
|