Files
Duy /zuey/andGitHub ddf8e1099f feat(webhooks): HTTP webhooks to trigger agents with HMAC auth + durable callbacks (#2)
* feat(webhooks): HTTP webhooks to trigger agents with HMAC auth and durable callbacks

Add multi-tenant HTTP webhook endpoints for agent triggering:
- /v1/webhooks/message: send messages to channels
- /v1/webhooks/llm: sync/async LLM prompts with HMAC-signed callbacks
- HMAC-256 + bearer token authentication
- Rate limiting and tenant isolation
- Durable callback worker with exponential backoff
- PG 000056 + SQLite schema v25 migrations
- Unit + integration tests, P0 tenant isolation invariants
- Channel media capability helpers for attachment routing
- Comprehensive webhook documentation and i18n strings

* fix(webhooks): address post-review findings (K1-K10)

Comprehensive post-merge fixes addressing 10 blocking code review issues
and 2 adversarial re-audit findings in webhook-agent-triggering feature:

K1: Fix auth middleware tenant context lookup sequencing — move
    tenant context injection before authenticate() call to prevent
    unscoped secret lookups.

K2: Canonicalize JSON payload format for jsonb compatibility across
    PostgreSQL and SQLite — ensure consistent serialization without
    whitespace variance to prevent hash mismatches.

K3: Add fail-closed JSON parsing in body hash extraction with explicit
    error handling for malformed payloads before HMAC verification.

K4: Fix worker queue wedge by properly draining slot reservations
    when delivery succeeds, preventing permanent slot occupancy.

K5: Implement lease-token optimistic concurrency control to prevent
    duplicate webhook delivery under high concurrency or retry storms.

K6: Add AES-256-GCM encrypted secret storage at rest with fail-fast
    skip-mount when GOCLAW_ENCRYPTION_KEY environment variable unset.

K7: Implement IP allowlist enforcement supporting both CIDR ranges
    and exact IP matching with proper X-Forwarded-For parsing.

K8: Add HMAC replay nonce cache (5min expiry, non-blocking async flush)
    to prevent request replay attacks on webhook handler.

K9: Fix invariant test schema selection — replace hardcoded assumption
    with explicit schema name from config to support multi-schema testing.

K10: Consolidate rate limiters into single shared instance to prevent
     per-endpoint limiter starvation and ensure fair rate limiting.

New database migrations:
- 000057: webhook_calls.lease_token for optimistic concurrency
- 000058: webhooks.encrypted_secret_key for AES-256-GCM encryption

New i18n keys: MsgWebhookIPDenied, MsgWebhookEncryptionUnavailable
(with English, Vietnamese, Chinese translations).

New modules:
- internal/http/webhooks_payload.go: JSON canonicalization + body hash
- internal/http/webhooks_nonce.go: Replay nonce cache implementation
- internal/http/webhooks_idempotency_test.go: Integration tests

Documentation updates:
- docs/webhooks.md: §13-14 security sections, encryption flow
- docs/00-architecture-overview.md: webhook subsystem security overview
- docs/codebase-summary.md: webhook security patterns
- docs/project-changelog.md: webhook fixes changelog

Test coverage: 53 webhook tests + 4 P0 invariant tests all passing.
No tenant isolation violations. All security gates enforced.

* docs(journals): webhook feature ship + fix cycle entries

* fix(webhooks): address Claude review findings

- webhooks_llm.go: remove misleading ptr() helper; use &completedAt
  pattern for error-path audit rows (matches success path)
- webhooks_auth.go: wrap TouchLastUsed context in WithoutCancel so
  background DB update isn't cancelled when HTTP response completes
- store GetByIDUnscoped (PG+SQLite): add NOT revoked / revoked = 0
  filter for defense-in-depth parity with GetByHashUnscoped
- webhooks/sign.go: fix package doc — HMAC key is raw plaintext
  secret bytes, not hex-decoded SHA-256
- webhooks_admin.go: check auth before encKey guard to avoid leaking
  config state to unauthenticated callers
- webhooks_ratelimit.go: two-phase Load→LoadOrStore to avoid per-call
  entry allocation on the hot path

* docs(webhooks): fix Sign() function doc to match actual key input

Function-level comment still referenced hex-decoded SecretHash after
the package-level doc was corrected. Align with actual caller usage
([]byte(rawSecret)).

* fix(webhooks): use WithoutCancel for worker execute DB updates

Terminal status writes in execute() ran through the worker main-loop
ctx, which is cancelled on graceful shutdown. If the outbound send
completed but the status update raced with shutdown, the row stayed
in 'running' and got re-delivered via reclaimStale. WithoutCancel
lets the DB write survive worker cancellation while preserving
propagated values (tenant ID, etc.).

* fix(webhooks): move tctx init before panic defer in worker execute

Panic recovery called updateRetry with raw ctx (no tenant ID), making
requireTenantID fail and the reset-to-retry DB write silently drop.
Row stayed 'running' until reclaimStale (~90s delay). Init tctx first
so defer closure captures tenant-scoped non-cancellable context.

* fix(webhooks): pass tenant-scoped tctx to invokeAgent in worker

execute() was passing the raw worker-loop ctx (no tenant ID) to
invokeAgent → router.Get → PGAgentStore.GetByID. GetByID reads
TenantIDFromContext which returned uuid.Nil, making every lookup
return 'agent not found'. Async LLM webhook calls silently failed
all retries. Pass tctx (already tenant-scoped + WithoutCancel) so
the router resolves the agent correctly.

* fix(tests): resolve integration test compile errors

- Remove duplicate contains() in mcp_grant_revoke_test.go (already
  defined in tts_gemini_live_test.go)
- Update webhooks_admin_test.go RotateSecret call to match current
  5-arg signature (newSecretHash, newPrefix, newEncryptedSecret)

* fix(webhooks): default nil scopes/ip_allowlist to empty slice in Create

PG columns are NOT NULL DEFAULT '{}'. Explicit NULL from pqStringArray(nil)
violated the constraint, breaking TestWebhookAdminCRUD/TenantIsolation.
Coerce nil slices to empty []string{} so the default applies at the DB layer.

* chore: trigger CI on digitopvn/goclaw fork

* ci: retrigger workflows

* fix(webhooks): renumber migrations to 000059-000061 for merge train
2026-05-11 13:29:24 +07:00

122 lines
3.6 KiB
Go

package http
import (
"crypto/sha256"
"fmt"
"sync"
"sync/atomic"
"time"
)
const (
// webhookNonceTTL is the replay-protection window.
// Must exceed webhookHMACSkewSeconds (300s) so that a signature first seen at
// the edge of the skew window remains cached until the skew window closes.
// 320s = 300s skew + 20s slack. Note: a replay attempted after TTL expiry
// is also rejected by the timestamp skew check independently, so the nonce
// cache and skew check form complementary (not overlapping) defenses.
webhookNonceTTL = 320 * time.Second
// webhookNonceSweepInterval controls how often expired entries are evicted.
webhookNonceSweepInterval = 60 * time.Second
// webhookNonceMaxEntries is a defensive ceiling — if exceeded the sweep runs
// immediately to bound memory growth under DoS conditions.
webhookNonceMaxEntries = 100_000
)
// webhookNonceEntry holds the expiry timestamp for a cached nonce.
type webhookNonceEntry struct {
expiresAt int64 // Unix nanoseconds
}
// webhookNonceCache is a per-process, in-memory replay-protection store for
// HMAC-signed webhook requests. It caches sha256(tenantID|"|"|signatureHex)
// for webhookNonceTTL after first use. Subsequent requests with the same
// signature within the TTL are rejected as replays.
//
// Single-node caveat: this cache is not distributed. In a multi-node deployment
// a replay may succeed on a different node. Acceptable for current architecture
// (single-process gateway). Document in docs/webhooks.md.
//
// Thread-safe: uses sync.Map for concurrent access.
type webhookNonceCache struct {
entries sync.Map
count atomic.Int64
ttl time.Duration
stopCh chan struct{}
}
// newWebhookNonceCache creates a cache with TTL sweep goroutine.
// Caller must call Stop() when done (typically at process shutdown).
func newWebhookNonceCache() *webhookNonceCache {
c := &webhookNonceCache{
ttl: webhookNonceTTL,
stopCh: make(chan struct{}),
}
go c.sweepLoop()
return c
}
// nonceKey builds a cache key from tenantID and the hex-encoded HMAC signature.
// Using sha256 to bound key size regardless of input length.
func nonceKey(tenantID, signatureHex string) string {
h := sha256.Sum256([]byte(tenantID + "|" + signatureHex))
return fmt.Sprintf("%x", h)
}
// Seen returns true if this nonce was already seen within the TTL window,
// indicating a replay attempt. Returns false on first observation and records
// the nonce for future replay detection.
//
// Atomicity note: sync.Map.LoadOrStore provides the compare-and-swap semantics
// needed here — only one goroutine wins the "insert" race.
func (c *webhookNonceCache) Seen(key string) bool {
entry := webhookNonceEntry{
expiresAt: time.Now().Add(c.ttl).UnixNano(),
}
_, loaded := c.entries.LoadOrStore(key, entry)
if !loaded {
// First time seen — we inserted it.
n := c.count.Add(1)
if n >= webhookNonceMaxEntries {
// Defensive: sweep immediately under potential DoS load.
go c.sweep()
}
}
// loaded=true → key was already present → replay.
return loaded
}
// Stop halts the background sweep goroutine.
func (c *webhookNonceCache) Stop() {
close(c.stopCh)
}
// sweepLoop runs periodic expired-entry eviction.
func (c *webhookNonceCache) sweepLoop() {
ticker := time.NewTicker(webhookNonceSweepInterval)
defer ticker.Stop()
for {
select {
case <-ticker.C:
c.sweep()
case <-c.stopCh:
return
}
}
}
// sweep evicts all expired entries from the map.
func (c *webhookNonceCache) sweep() {
now := time.Now().UnixNano()
c.entries.Range(func(k, v any) bool {
entry, ok := v.(webhookNonceEntry)
if !ok || now > entry.expiresAt {
c.entries.Delete(k)
c.count.Add(-1)
}
return true
})
}