mirror of
https://github.com/tiennm99/goclaw.git
synced 2026-07-25 20:19:45 +00:00
Duy /zuey/andGitHub
ddf8e1099f
* 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
61 lines
2.9 KiB
SQL
61 lines
2.9 KiB
SQL
-- Webhook registry + call audit log.
|
|
-- tenant_id on every row — all queries must include WHERE tenant_id = $N.
|
|
-- secret_hash stores SHA-256 hex; raw secret returned only once on create (phase-04).
|
|
|
|
-- ============================================================
|
|
-- Table: webhooks (registry)
|
|
-- ============================================================
|
|
CREATE TABLE webhooks (
|
|
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
tenant_id uuid NOT NULL,
|
|
agent_id uuid REFERENCES agents(id) ON DELETE SET NULL,
|
|
name text NOT NULL,
|
|
kind text NOT NULL CHECK (kind IN ('llm', 'message')),
|
|
secret_prefix text,
|
|
secret_hash text NOT NULL,
|
|
scopes text[] NOT NULL DEFAULT '{}',
|
|
channel_id uuid,
|
|
rate_limit_per_min int NOT NULL DEFAULT 60,
|
|
ip_allowlist text[] NOT NULL DEFAULT '{}',
|
|
require_hmac boolean NOT NULL DEFAULT false,
|
|
localhost_only boolean NOT NULL DEFAULT false,
|
|
revoked boolean NOT NULL DEFAULT false,
|
|
created_by text,
|
|
created_at timestamptz NOT NULL DEFAULT now(),
|
|
updated_at timestamptz NOT NULL DEFAULT now(),
|
|
last_used_at timestamptz
|
|
);
|
|
|
|
CREATE INDEX idx_webhooks_tenant ON webhooks (tenant_id);
|
|
CREATE INDEX idx_webhooks_tenant_agent ON webhooks (tenant_id, agent_id);
|
|
CREATE UNIQUE INDEX uq_webhooks_secret ON webhooks (secret_hash) WHERE revoked = false;
|
|
|
|
-- ============================================================
|
|
-- Table: webhook_calls (audit + async state)
|
|
-- ============================================================
|
|
CREATE TABLE webhook_calls (
|
|
id uuid PRIMARY KEY DEFAULT gen_random_uuid(),
|
|
tenant_id uuid NOT NULL,
|
|
webhook_id uuid NOT NULL REFERENCES webhooks(id) ON DELETE CASCADE,
|
|
agent_id uuid,
|
|
idempotency_key text,
|
|
mode text NOT NULL CHECK (mode IN ('sync', 'async')),
|
|
callback_url text,
|
|
status text NOT NULL DEFAULT 'queued' CHECK (status IN ('queued', 'running', 'done', 'failed', 'dead')),
|
|
attempts int NOT NULL DEFAULT 0,
|
|
delivery_id uuid NOT NULL DEFAULT gen_random_uuid(),
|
|
next_attempt_at timestamptz,
|
|
started_at timestamptz,
|
|
request_payload jsonb,
|
|
response jsonb,
|
|
last_error text,
|
|
created_at timestamptz NOT NULL DEFAULT now(),
|
|
completed_at timestamptz
|
|
);
|
|
|
|
CREATE INDEX idx_webhook_calls_tenant_created ON webhook_calls (tenant_id, created_at DESC);
|
|
CREATE INDEX idx_webhook_calls_status_attempt ON webhook_calls (status, next_attempt_at);
|
|
CREATE UNIQUE INDEX uq_webhook_calls_idempotency
|
|
ON webhook_calls (webhook_id, idempotency_key)
|
|
WHERE idempotency_key IS NOT NULL;
|