Files
simstudioai--sim/apps/sim/lib/webhooks/providers/tiktok.ts
T
wehub-resource-sync d25d482dc2
Publish CLI Package / publish-npm (push) Waiting to run
Publish Python SDK / publish-pypi (push) Waiting to run
Publish TypeScript SDK / publish-npm (push) Waiting to run
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

246 lines
8.0 KiB
TypeScript

import { createLogger } from '@sim/logger'
import { safeCompare } from '@sim/security/compare'
import { hmacSha256Hex } from '@sim/security/hmac'
import { NextResponse } from 'next/server'
import { env } from '@/lib/core/config/env'
import type {
AuthContext,
EventMatchContext,
FormatInputContext,
FormatInputResult,
WebhookProviderHandler,
} from '@/lib/webhooks/providers/types'
const logger = createLogger('WebhookProvider:TikTok')
/** TikTok recommends rejecting replayed signatures; 5 minutes matches Linear/common practice. */
export const TIKTOK_WEBHOOK_TIMESTAMP_SKEW_SECONDS = 5 * 60
export interface TikTokSignatureParts {
timestamp: string
signature: string
}
/**
* Parse `TikTok-Signature: t=<unix>,s=<hex>` (comma-separated prefix=value pairs).
*/
export function parseTikTokSignatureHeader(header: string | null): TikTokSignatureParts | null {
if (!header) return null
let timestamp: string | undefined
let signature: string | undefined
for (const part of header.split(',')) {
const trimmed = part.trim()
const eq = trimmed.indexOf('=')
if (eq <= 0) continue
const prefix = trimmed.slice(0, eq)
const value = trimmed.slice(eq + 1)
if (prefix === 't') timestamp = value
if (prefix === 's') signature = value
}
if (!timestamp || !signature) return null
return { timestamp, signature }
}
/**
* Verify TikTok webhook HMAC-SHA256 of `${t}.${rawBody}` with the app client secret.
* Returns null on success, or a 401 NextResponse on failure.
*/
export function verifyTikTokSignature(
rawBody: string,
signatureHeader: string | null,
requestId: string,
clientSecret: string | undefined = env.TIKTOK_CLIENT_SECRET,
nowSeconds: number = Math.floor(Date.now() / 1000)
): NextResponse | null {
if (!clientSecret) {
logger.warn(`[${requestId}] TikTok webhook missing TIKTOK_CLIENT_SECRET`)
return new NextResponse('Unauthorized - TikTok client secret not configured', { status: 401 })
}
const parts = parseTikTokSignatureHeader(signatureHeader)
if (!parts) {
logger.warn(`[${requestId}] TikTok webhook missing or malformed TikTok-Signature header`)
return new NextResponse('Unauthorized - Missing TikTok signature', { status: 401 })
}
const timestampSeconds = Number(parts.timestamp)
if (!Number.isFinite(timestampSeconds)) {
logger.warn(`[${requestId}] TikTok webhook signature timestamp is not a number`)
return new NextResponse('Unauthorized - Invalid TikTok signature timestamp', { status: 401 })
}
if (Math.abs(nowSeconds - timestampSeconds) > TIKTOK_WEBHOOK_TIMESTAMP_SKEW_SECONDS) {
logger.warn(`[${requestId}] TikTok webhook signature timestamp outside allowed skew`, {
skewSeconds: TIKTOK_WEBHOOK_TIMESTAMP_SKEW_SECONDS,
timestampSeconds,
nowSeconds,
})
return new NextResponse('Unauthorized - TikTok signature timestamp skew too large', {
status: 401,
})
}
const signedPayload = `${parts.timestamp}.${rawBody}`
const computed = hmacSha256Hex(signedPayload, clientSecret)
if (!safeCompare(computed, parts.signature)) {
logger.warn(`[${requestId}] TikTok signature verification failed`)
return new NextResponse('Unauthorized - Invalid TikTok signature', { status: 401 })
}
return null
}
function asRecord(value: unknown): Record<string, unknown> | null {
if (!value || typeof value !== 'object' || Array.isArray(value)) return null
return value as Record<string, unknown>
}
/**
* Parse the TikTok envelope `content` field (a JSON string) into an object.
*/
export function parseTikTokContent(content: unknown): Record<string, unknown> {
if (typeof content !== 'string' || content.length === 0) {
return asRecord(content) ?? {}
}
try {
return asRecord(JSON.parse(content)) ?? {}
} catch {
logger.warn('Failed to parse TikTok webhook content JSON string')
return {}
}
}
function stringField(obj: Record<string, unknown>, ...keys: string[]): string | undefined {
for (const key of keys) {
const value = obj[key]
if (typeof value === 'string' && value.length > 0) return value
if (typeof value === 'number' && Number.isFinite(value)) return String(value)
}
return undefined
}
function numberField(value: unknown): number | null {
const number = typeof value === 'number' ? value : Number(value)
return Number.isFinite(number) ? number : null
}
export const tiktokHandler: WebhookProviderHandler = {
ingressMode: 'provider',
executionMode: 'queue',
async verifyAuth({ request, rawBody, requestId }: AuthContext): Promise<NextResponse | null> {
return verifyTikTokSignature(rawBody, request.headers.get('TikTok-Signature'), requestId)
},
async matchEvent({ body, requestId, providerConfig }: EventMatchContext) {
const triggerId =
typeof providerConfig.triggerId === 'string' ? providerConfig.triggerId : undefined
if (!triggerId) return true
const { isTikTokEventMatch } = await import('@/triggers/tiktok/utils')
const event = stringField(asRecord(body) ?? {}, 'event')
if (!isTikTokEventMatch(triggerId, event)) {
logger.debug(
`[${requestId}] TikTok event mismatch for trigger ${triggerId}. Event: ${event}. Skipping.`
)
return false
}
return true
},
async formatInput({ body }: FormatInputContext): Promise<FormatInputResult> {
const envelope = asRecord(body) ?? {}
const content = parseTikTokContent(envelope.content)
const event = typeof envelope.event === 'string' ? envelope.event : ''
const commonInput: Record<string, unknown> = {
event,
createTime: numberField(envelope.create_time),
userOpenId: typeof envelope.user_openid === 'string' ? envelope.user_openid : null,
clientKey: typeof envelope.client_key === 'string' ? envelope.client_key : null,
}
const postingInput = {
...commonInput,
publishId: stringField(content, 'publish_id') ?? null,
publishType: stringField(content, 'publish_type') ?? null,
}
if (event === 'post.publish.failed') {
return {
input: {
...postingInput,
failReason: stringField(content, 'fail_reason', 'reason') ?? null,
},
}
}
if (event === 'post.publish.complete' || event === 'post.publish.inbox_delivered') {
return { input: postingInput }
}
if (
event === 'post.publish.publicly_available' ||
event === 'post.publish.no_longer_publicaly_available'
) {
return {
input: {
...postingInput,
postId: stringField(content, 'post_id') ?? null,
},
}
}
if (event === 'authorization.removed') {
return {
input: {
...commonInput,
reason: numberField(content.reason),
},
}
}
if (event === 'video.publish.completed' || event === 'video.upload.failed') {
return {
input: {
...commonInput,
shareId: stringField(content, 'share_id') ?? null,
},
}
}
return { input: commonInput }
},
extractIdempotencyId(body: unknown) {
const envelope = asRecord(body)
if (!envelope) return null
const event = typeof envelope.event === 'string' ? envelope.event : null
const userOpenId = typeof envelope.user_openid === 'string' ? envelope.user_openid : null
if (!event || !userOpenId) return null
const content = parseTikTokContent(envelope.content)
const publishId = stringField(content, 'publish_id')
const postId = stringField(content, 'post_id')
const shareId = stringField(content, 'share_id')
const createTime =
typeof envelope.create_time === 'number' || typeof envelope.create_time === 'string'
? String(envelope.create_time)
: null
let unique: string | null = null
if (publishId && postId) {
unique = `${publishId}:${postId}`
} else if (event === 'post.publish.complete' && publishId && createTime) {
unique = `${publishId}:${createTime}`
} else {
unique = publishId ?? shareId ?? createTime
}
if (!unique) return null
return `${event}:${userOpenId}:${unique}`
},
}