@7h3/protocol 0.1.2 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.dockerignore +19 -0
- package/.github/dependabot.yml +32 -0
- package/.github/workflows/ci.yml +31 -0
- package/.github/workflows/publish.yml +59 -0
- package/.github/workflows/scorecard.yml +37 -0
- package/7h3.example.yaml +125 -0
- package/CHANGELOG.md +152 -0
- package/CONTRIBUTING.md +82 -0
- package/Dockerfile +73 -0
- package/GOVERNANCE.md +62 -0
- package/README.md +1317 -6
- package/SECURITY.md +70 -0
- package/bench-results/replay-cache-full-1777891033256.json +10 -0
- package/bench-results/replay-cache-full-1777896317488.json +10 -0
- package/bench-results/replay-cache-full-1777900993184.json +10 -0
- package/bench-results/replay-cache-full-1777901019285.json +10 -0
- package/bench-results/replay-cache-quick-1777870170126.json +10 -0
- package/bench-results/signature-profiles-quick-1775875160079.json +85 -0
- package/bench-results/signature-profiles-quick-1775983539716.json +85 -0
- package/bench-results/signature-profiles-quick-1776237913190.json +85 -0
- package/bench-results/wire-codecs-full-1777891019803.json +93 -0
- package/bench-results/wire-codecs-full-1777896260964.json +93 -0
- package/bench-results/wire-codecs-full-1777901004247.json +93 -0
- package/bench-results/wire-codecs-quick-1775972879056.json +93 -0
- package/bench-results/wire-codecs-quick-1775983541111.json +93 -0
- package/bench-results/wire-codecs-quick-1776237914299.json +93 -0
- package/bench-results/wire-codecs-quick-1777841285236.json +93 -0
- package/bench-results/wire-codecs-quick-1777841321772.json +93 -0
- package/bench-results/wire-codecs-quick-1777841330408.json +93 -0
- package/bench-results/wire-codecs-quick-1777852886082.json +93 -0
- package/bench-results/wire-codecs-quick-1777852988773.json +93 -0
- package/bench-results/wire-codecs-quick-1777870188095.json +93 -0
- package/bench-results/wire-codecs-quick-1777870263918.json +93 -0
- package/bench-results/wire-codecs-quick-1777870455034.json +93 -0
- package/bench-results/wire-codecs-quick-1778816163081.json +93 -0
- package/bench-results/wire-codecs-quick-1778843936130.json +93 -0
- package/bin/7h3.ts +406 -0
- package/conformance/7h3_v0_1.json +77 -0
- package/conformance/7h3_v0_1_binary.json +20 -0
- package/conformance/aip_v0_1_binary.json +20 -0
- package/docker-compose.yaml +77 -0
- package/docs/ADOPTION_PLAN.md +120 -0
- package/docs/AGENTS.md +77 -0
- package/docs/AIP_RFC_v0.1.md +97 -0
- package/docs/AI_DECISION_CARD.md +122 -0
- package/docs/AI_RUNTIME_POLICY.json +126 -0
- package/docs/AI_RUNTIME_POLICY.yaml +110 -0
- package/docs/BACKPRESSURE_TUNING.md +65 -0
- package/docs/BENCHMARK_CLAIM_MATRIX.md +42 -0
- package/docs/BENCHMARK_REPORT_TEMPLATE.md +169 -0
- package/docs/BINARY_CODEC_BENCH.md +23 -0
- package/docs/CLEAN_CLONE_RUNBOOK.md +36 -0
- package/docs/CLOCK_SKEW_POLICY.md +30 -0
- package/docs/DISTRIBUTED_REPLAY.md +142 -0
- package/docs/FUZZ_CAMPAIGN.md +121 -0
- package/docs/GATEWAY.md +195 -0
- package/docs/KEY_MANAGEMENT_POLICY.md +53 -0
- package/docs/KEY_REVOCATION.md +69 -0
- package/docs/MCP_WRAPPER.md +159 -0
- package/docs/MIGRATION_GUIDE.md +40 -0
- package/docs/OPERATORS.md +184 -0
- package/docs/PERF_REGRESSION_POLICY.md +34 -0
- package/docs/PROJECT_EXAMINATION_2026-05-31.md +219 -0
- package/docs/RELEASE_BENCHMARK_REPORT_2026-05-15.md +135 -0
- package/docs/RELEASE_GATE.md +25 -0
- package/docs/RELEASE_NOTES_v0.1.0.md +54 -0
- package/docs/SECURITY_REVIEW_2026-06-05.md +165 -0
- package/docs/TELEMETRY.md +41 -0
- package/docs/THREAT_MODEL.md +89 -0
- package/docs/VERSIONING_POLICY.md +30 -0
- package/docs/assets/banner-github.png +0 -0
- package/docs/assets/banner.png +0 -0
- package/docs/assets/banner.svg +123 -0
- package/eslint.config.js +15 -0
- package/fuzz/ts/harness-decode.ts +136 -0
- package/fuzz/ts/harness-verify.ts +121 -0
- package/fuzz/ts/run.ts +35 -0
- package/mcp-server/README.md +38 -0
- package/mcp-server/package-lock.json +1187 -0
- package/mcp-server/package.json +35 -0
- package/mcp-server/src/index.ts +236 -0
- package/mcp-server/tsconfig.json +14 -0
- package/package.json +121 -13
- package/scripts/aip-framework-quickstart.ts +110 -0
- package/scripts/aip-mcp-gateway.ts +38 -0
- package/scripts/aip-mcp-wrap-demo.ts +72 -0
- package/scripts/aip-quickstart.ts +60 -0
- package/scripts/bench-diff.ts +118 -0
- package/scripts/bench-protocol-e2e.ts +937 -0
- package/scripts/bench-protocol-openloop.ts +1397 -0
- package/scripts/bench-replay-cache.ts +76 -0
- package/scripts/bench-signature-profiles.ts +180 -0
- package/scripts/bench-wire-codecs.ts +161 -0
- package/scripts/build-binary-conformance.ts +36 -0
- package/scripts/build-release-dashboard.ts +175 -0
- package/scripts/canary-rollout.ts +38 -0
- package/scripts/mcpGatewayCli.test.ts +116 -0
- package/scripts/prepare-aip-package.ts +88 -0
- package/scripts/regen-conformance-sigs.ts +18 -0
- package/scripts/release-gate.ts +19 -0
- package/scripts/validate-runtime-policy.ts +18 -0
- package/sdk/browser/index.test.ts +162 -0
- package/sdk/browser/index.ts +257 -0
- package/sdk/browser/package.json +13 -0
- package/sdk/go/cbor.go +551 -0
- package/sdk/go/cbor_test.go +232 -0
- package/sdk/go/encryption.go +280 -0
- package/sdk/go/encryption_test.go +318 -0
- package/sdk/go/go.mod +7 -0
- package/sdk/go/go.sum +4 -0
- package/sdk/go/http.go +135 -0
- package/sdk/go/protocol.go +324 -0
- package/sdk/go/protocol_test.go +334 -0
- package/sdk/go/replay.go +121 -0
- package/sdk/go/replay_test.go +149 -0
- package/sdk/go/webhook.go +136 -0
- package/sdk/pq/package-lock.json +1358 -0
- package/sdk/pq/package.json +42 -0
- package/sdk/pq/src/index.test.ts +143 -0
- package/sdk/pq/src/index.ts +166 -0
- package/sdk/pq/tsconfig.json +14 -0
- package/sdk/pq/vitest.config.ts +7 -0
- package/sdk/python/README.md +18 -0
- package/sdk/python/protocol_7h3/__init__.py +46 -0
- package/sdk/python/protocol_7h3/encryption.py +252 -0
- package/sdk/python/protocol_7h3/http.py +212 -0
- package/sdk/python/protocol_7h3/keys.py +149 -0
- package/sdk/python/protocol_7h3/pq.py +244 -0
- package/sdk/python/protocol_7h3/protocol.py +525 -0
- package/sdk/python/protocol_7h3/queue.py +118 -0
- package/sdk/python/protocol_7h3/replay.py +98 -0
- package/sdk/python/protocol_7h3/webhook.py +116 -0
- package/sdk/python/pyproject.toml +40 -0
- package/sdk/python/tests/test_conformance.py +110 -0
- package/sdk/python/tests/test_encryption.py +206 -0
- package/sdk/python/tests/test_http.py +305 -0
- package/sdk/python/tests/test_keys.py +417 -0
- package/sdk/python/tests/test_queue.py +120 -0
- package/sdk/python/tests/test_webhook.py +345 -0
- package/sdk/rust/Cargo.lock +371 -0
- package/sdk/rust/Cargo.toml +25 -0
- package/sdk/rust/README.md +31 -0
- package/sdk/rust/fuzz/Cargo.toml +29 -0
- package/sdk/rust/fuzz/fuzz_targets/fuzz_canonicalize.rs +46 -0
- package/sdk/rust/fuzz/fuzz_targets/fuzz_decode.rs +11 -0
- package/sdk/rust/src/bin/aip_mcp_gateway.rs +59 -0
- package/sdk/rust/src/http.rs +145 -0
- package/sdk/rust/src/keys.rs +161 -0
- package/sdk/rust/src/lib.rs +688 -0
- package/sdk/rust/src/queue.rs +79 -0
- package/sdk/rust/src/webhook.rs +86 -0
- package/sdk/rust/tests/conformance.rs +148 -0
- package/sdk/rust/tests/gateway.rs +130 -0
- package/sdk/rust/tests/http_webhook_queue.rs +201 -0
- package/sdk/rust/tests/keys.rs +189 -0
- package/sdk/threshold/index.d.ts +68 -0
- package/sdk/threshold/index.d.ts.map +1 -0
- package/sdk/threshold/index.js +254 -0
- package/sdk/threshold/package-lock.json +1361 -0
- package/sdk/threshold/package.json +39 -0
- package/sdk/threshold/src/index.d.ts +68 -0
- package/sdk/threshold/src/index.d.ts.map +1 -0
- package/sdk/threshold/src/index.js +254 -0
- package/sdk/threshold/src/index.test.ts +238 -0
- package/sdk/threshold/src/index.ts +355 -0
- package/sdk/threshold/tsconfig.json +19 -0
- package/sdk/threshold/vitest.config.ts +12 -0
- package/src/agentAdapter.test.ts +48 -0
- package/src/agentAdapter.ts +56 -0
- package/src/auditLog.test.ts +145 -0
- package/src/auditLog.ts +147 -0
- package/src/capability.test.ts +504 -0
- package/src/capability.ts +380 -0
- package/src/cborCodec.test.ts +263 -0
- package/src/cborCodec.ts +339 -0
- package/src/conformance.test.ts +136 -0
- package/src/conformanceVectors.ts +99 -0
- package/src/encryption.test.ts +206 -0
- package/src/encryption.ts +245 -0
- package/src/envelopeCbor.ts +140 -0
- package/src/frameworkAdapters.test.ts +290 -0
- package/src/frameworkAdapters.ts +261 -0
- package/src/gateway.test.ts +343 -0
- package/src/gateway.ts +246 -0
- package/src/grpcBinding.test.ts +211 -0
- package/src/grpcBinding.ts +103 -0
- package/src/httpBinding.test.ts +376 -0
- package/src/httpBinding.ts +189 -0
- package/src/index.ts +39 -0
- package/src/keyInfra.test.ts +278 -0
- package/src/keyInfra.ts +228 -0
- package/src/keyRegistry.ts +59 -0
- package/src/keyRotation.test.ts +78 -0
- package/src/keyRotation.ts +72 -0
- package/src/mcpGateway.test.ts +129 -0
- package/src/mcpGateway.ts +250 -0
- package/src/mcpTransports.test.ts +92 -0
- package/src/mcpTransports.ts +169 -0
- package/src/mcpWrapper.test.ts +179 -0
- package/src/mcpWrapper.ts +206 -0
- package/src/otel.ts +136 -0
- package/src/policyEnforcer.test.ts +99 -0
- package/src/policyEnforcer.ts +169 -0
- package/src/policyTelemetryFeedback.test.ts +25 -0
- package/src/policyTelemetryFeedback.ts +38 -0
- package/src/protocol.bench.ts +37 -0
- package/{protocol.d.ts → src/protocol.d.ts} +2 -1
- package/src/protocol.d.ts.map +1 -0
- package/src/protocol.js +294 -0
- package/src/protocol.test.ts +155 -0
- package/src/protocol.ts +414 -0
- package/src/protocolAgent.test.ts +105 -0
- package/src/protocolAgent.ts +169 -0
- package/src/protocolBinary.test.ts +165 -0
- package/src/protocolBinary.ts +312 -0
- package/src/protocolCapabilities.ts +70 -0
- package/src/protocolFuzz.advanced.test.ts +235 -0
- package/src/protocolFuzz.test.ts +111 -0
- package/src/protocolNegative.test.ts +97 -0
- package/src/protocolReplay.test.ts +71 -0
- package/src/protocolReplay.ts +194 -0
- package/src/protocolTransport.test.ts +556 -0
- package/src/protocolTransport.ts +483 -0
- package/src/queueBinding.test.ts +130 -0
- package/src/queueBinding.ts +102 -0
- package/src/rateLimiter.test.ts +96 -0
- package/src/rateLimiter.ts +46 -0
- package/src/redisClient.ts +140 -0
- package/src/redisIntegration.test.ts +134 -0
- package/src/replayStores.test.ts +273 -0
- package/src/replayStores.ts +215 -0
- package/src/revocation.test.ts +98 -0
- package/src/revocation.ts +0 -0
- package/src/routePolicy.test.ts +87 -0
- package/src/routePolicy.ts +72 -0
- package/src/runtimePolicy.test.ts +49 -0
- package/src/runtimePolicy.ts +81 -0
- package/src/runtimePolicyManager.test.ts +29 -0
- package/src/runtimePolicyManager.ts +50 -0
- package/src/runtimePolicyPresets.ts +43 -0
- package/src/signedResponse.test.ts +111 -0
- package/src/signedResponse.ts +83 -0
- package/src/stream.test.ts +254 -0
- package/src/stream.ts +417 -0
- package/src/telemetry.test.ts +251 -0
- package/src/telemetry.ts +299 -0
- package/src/webhookBinding.test.ts +144 -0
- package/src/webhookBinding.ts +115 -0
- package/src/wsBinding.test.ts +221 -0
- package/src/wsBinding.ts +200 -0
- package/tsconfig.json +15 -0
- package/tsconfig.lib.json +23 -0
- package/vite.lib.config.ts +16 -0
- package/vitest.config.ts +11 -0
- package/agentAdapter.d.ts +0 -26
- package/conformanceVectors.d.ts +0 -20
- package/frameworkAdapters.d.ts +0 -72
- package/index.d.ts +0 -20
- package/index.js +0 -1702
- package/keyRotation.d.ts +0 -20
- package/mcpGateway.d.ts +0 -37
- package/mcpTransports.d.ts +0 -62
- package/mcpWrapper.d.ts +0 -83
- package/policyEnforcer.d.ts +0 -50
- package/policyTelemetryFeedback.d.ts +0 -11
- package/protocolAgent.d.ts +0 -58
- package/protocolBinary.d.ts +0 -8
- package/protocolCapabilities.d.ts +0 -24
- package/protocolReplay.d.ts +0 -35
- package/protocolTransport.d.ts +0 -73
- package/redisClient.d.ts +0 -49
- package/replayStores.d.ts +0 -32
- package/revocation.d.ts +0 -71
- package/runtimePolicy.d.ts +0 -24
- package/runtimePolicyManager.d.ts +0 -15
- package/runtimePolicyPresets.d.ts +0 -11
|
@@ -0,0 +1,251 @@
|
|
|
1
|
+
import { describe, it, expect, beforeEach } from 'vitest'
|
|
2
|
+
import {
|
|
3
|
+
SimpleCounter,
|
|
4
|
+
SimpleHistogram,
|
|
5
|
+
Protocol7h3Metrics,
|
|
6
|
+
renderPrometheusText,
|
|
7
|
+
createMetricsMiddleware,
|
|
8
|
+
} from './telemetry'
|
|
9
|
+
|
|
10
|
+
// ─── 1. Counter increments correctly with labels ──────────────────────────────
|
|
11
|
+
|
|
12
|
+
describe('SimpleCounter with labels', () => {
|
|
13
|
+
it('increments independently per label set', () => {
|
|
14
|
+
const counter = new SimpleCounter()
|
|
15
|
+
counter.increment({ result: 'ok', alg: 'ED25519' })
|
|
16
|
+
counter.increment({ result: 'ok', alg: 'ED25519' })
|
|
17
|
+
counter.increment({ result: 'fail', alg: 'HS256' })
|
|
18
|
+
|
|
19
|
+
expect(counter.value({ result: 'ok', alg: 'ED25519' })).toBe(2)
|
|
20
|
+
expect(counter.value({ result: 'fail', alg: 'HS256' })).toBe(1)
|
|
21
|
+
expect(counter.value({ result: 'ok', alg: 'HS256' })).toBe(0)
|
|
22
|
+
})
|
|
23
|
+
|
|
24
|
+
it('label order does not affect key identity', () => {
|
|
25
|
+
const counter = new SimpleCounter()
|
|
26
|
+
counter.increment({ a: '1', b: '2' })
|
|
27
|
+
counter.increment({ b: '2', a: '1' })
|
|
28
|
+
expect(counter.value({ a: '1', b: '2' })).toBe(2)
|
|
29
|
+
expect(counter.value({ b: '2', a: '1' })).toBe(2)
|
|
30
|
+
})
|
|
31
|
+
})
|
|
32
|
+
|
|
33
|
+
// ─── 2. Counter with no labels increments the default bucket ─────────────────
|
|
34
|
+
|
|
35
|
+
describe('SimpleCounter with no labels', () => {
|
|
36
|
+
it('starts at 0', () => {
|
|
37
|
+
const counter = new SimpleCounter()
|
|
38
|
+
expect(counter.value()).toBe(0)
|
|
39
|
+
})
|
|
40
|
+
|
|
41
|
+
it('increments the default bucket', () => {
|
|
42
|
+
const counter = new SimpleCounter()
|
|
43
|
+
counter.increment()
|
|
44
|
+
counter.increment()
|
|
45
|
+
counter.increment()
|
|
46
|
+
expect(counter.value()).toBe(3)
|
|
47
|
+
// labeled lookup returns 0 — separate bucket
|
|
48
|
+
expect(counter.value({ x: '1' })).toBe(0)
|
|
49
|
+
})
|
|
50
|
+
})
|
|
51
|
+
|
|
52
|
+
// ─── 3. Histogram records observations and buckets correctly ─────────────────
|
|
53
|
+
|
|
54
|
+
describe('SimpleHistogram', () => {
|
|
55
|
+
it('counts observations into correct buckets', () => {
|
|
56
|
+
const h = new SimpleHistogram([1, 5, 10, 50, 100])
|
|
57
|
+
h.observe(0.5)
|
|
58
|
+
h.observe(3)
|
|
59
|
+
h.observe(7)
|
|
60
|
+
h.observe(75)
|
|
61
|
+
h.observe(200)
|
|
62
|
+
|
|
63
|
+
const snap = h.snapshot()
|
|
64
|
+
// ≤1: 0.5 → 1
|
|
65
|
+
expect(snap.buckets['1']).toBe(1)
|
|
66
|
+
// ≤5: 0.5, 3 → 2
|
|
67
|
+
expect(snap.buckets['5']).toBe(2)
|
|
68
|
+
// ≤10: 0.5, 3, 7 → 3
|
|
69
|
+
expect(snap.buckets['10']).toBe(3)
|
|
70
|
+
// ≤50: 0.5, 3, 7 → 3
|
|
71
|
+
expect(snap.buckets['50']).toBe(3)
|
|
72
|
+
// ≤100: 0.5, 3, 7, 75 → 4
|
|
73
|
+
expect(snap.buckets['100']).toBe(4)
|
|
74
|
+
// +Inf: all 5
|
|
75
|
+
expect(snap.buckets['+Inf']).toBe(5)
|
|
76
|
+
expect(snap.count).toBe(5)
|
|
77
|
+
expect(snap.sum).toBeCloseTo(0.5 + 3 + 7 + 75 + 200)
|
|
78
|
+
})
|
|
79
|
+
|
|
80
|
+
it('tracks per-label state independently', () => {
|
|
81
|
+
const h = new SimpleHistogram([10])
|
|
82
|
+
h.observe(5, { transport: 'http' })
|
|
83
|
+
h.observe(15, { transport: 'ws' })
|
|
84
|
+
|
|
85
|
+
const snapHttp = h.snapshot({ transport: 'http' })
|
|
86
|
+
expect(snapHttp.count).toBe(1)
|
|
87
|
+
expect(snapHttp.buckets['10']).toBe(1)
|
|
88
|
+
|
|
89
|
+
const snapWs = h.snapshot({ transport: 'ws' })
|
|
90
|
+
expect(snapWs.count).toBe(1)
|
|
91
|
+
expect(snapWs.buckets['10']).toBe(0)
|
|
92
|
+
})
|
|
93
|
+
|
|
94
|
+
it('returns zero snapshot for unseen labels', () => {
|
|
95
|
+
const h = new SimpleHistogram([1, 5])
|
|
96
|
+
const snap = h.snapshot({ transport: 'grpc' })
|
|
97
|
+
expect(snap.count).toBe(0)
|
|
98
|
+
expect(snap.sum).toBe(0)
|
|
99
|
+
expect(snap.buckets['+Inf']).toBe(0)
|
|
100
|
+
})
|
|
101
|
+
})
|
|
102
|
+
|
|
103
|
+
// ─── 4. renderPrometheusText produces valid Prometheus format ─────────────────
|
|
104
|
+
|
|
105
|
+
describe('renderPrometheusText', () => {
|
|
106
|
+
it('contains # HELP, # TYPE, and metric lines', () => {
|
|
107
|
+
const m = new Protocol7h3Metrics()
|
|
108
|
+
m.verifications_total.increment({ result: 'ok', alg: 'ED25519', transport: 'http' })
|
|
109
|
+
m.verifications_total.increment({ result: 'ok', alg: 'ED25519', transport: 'http' })
|
|
110
|
+
m.verifications_total.increment({ result: 'fail', alg: 'none', transport: 'http' })
|
|
111
|
+
m.verification_duration_ms.observe(2.5)
|
|
112
|
+
|
|
113
|
+
const text = renderPrometheusText(m)
|
|
114
|
+
|
|
115
|
+
expect(text).toMatch(/# HELP 7h3_verifications_total /)
|
|
116
|
+
expect(text).toMatch(/# TYPE 7h3_verifications_total counter/)
|
|
117
|
+
expect(text).toMatch(/7h3_verifications_total\{.*result="ok".*\} 2/)
|
|
118
|
+
expect(text).toMatch(/7h3_verifications_total\{.*result="fail".*\} 1/)
|
|
119
|
+
expect(text).toMatch(/# HELP 7h3_verification_duration_ms /)
|
|
120
|
+
expect(text).toMatch(/# TYPE 7h3_verification_duration_ms histogram/)
|
|
121
|
+
expect(text).toMatch(/7h3_verification_duration_ms_bucket\{.*le="\+Inf".*\} 1/)
|
|
122
|
+
expect(text).toMatch(/7h3_verification_duration_ms_count 1/)
|
|
123
|
+
})
|
|
124
|
+
|
|
125
|
+
it('respects a custom prefix', () => {
|
|
126
|
+
const m = new Protocol7h3Metrics()
|
|
127
|
+
m.rate_limit_hits_total.increment({ sender: 'agent-a', path: '/api' })
|
|
128
|
+
const text = renderPrometheusText(m, 'myapp')
|
|
129
|
+
expect(text).toMatch(/# HELP myapp_verifications_total/)
|
|
130
|
+
expect(text).toMatch(/myapp_rate_limit_hits_total/)
|
|
131
|
+
})
|
|
132
|
+
|
|
133
|
+
it('all expected metric names appear', () => {
|
|
134
|
+
const m = new Protocol7h3Metrics()
|
|
135
|
+
const text = renderPrometheusText(m)
|
|
136
|
+
const expectedNames = [
|
|
137
|
+
'7h3_verifications_total',
|
|
138
|
+
'7h3_verification_duration_ms',
|
|
139
|
+
'7h3_rate_limit_hits_total',
|
|
140
|
+
'7h3_sender_denials_total',
|
|
141
|
+
'7h3_replay_detections_total',
|
|
142
|
+
'7h3_audit_entries_total',
|
|
143
|
+
'7h3_active_connections',
|
|
144
|
+
]
|
|
145
|
+
for (const name of expectedNames) {
|
|
146
|
+
expect(text).toContain(`# HELP ${name}`)
|
|
147
|
+
}
|
|
148
|
+
})
|
|
149
|
+
|
|
150
|
+
it('ends with a newline', () => {
|
|
151
|
+
const m = new Protocol7h3Metrics()
|
|
152
|
+
const text = renderPrometheusText(m)
|
|
153
|
+
expect(text.endsWith('\n')).toBe(true)
|
|
154
|
+
})
|
|
155
|
+
})
|
|
156
|
+
|
|
157
|
+
// ─── 5. metrics.verifications_total increments on gateway verify calls ────────
|
|
158
|
+
|
|
159
|
+
describe('Protocol7h3Metrics integration via gateway verify', () => {
|
|
160
|
+
it('increments verifications_total on skip-verify path (allow policy)', async () => {
|
|
161
|
+
// Import gateway dynamically to get a fresh reference to globalMetrics
|
|
162
|
+
// We directly test Protocol7h3Metrics counting logic by simulating the verify flow
|
|
163
|
+
const m = new Protocol7h3Metrics()
|
|
164
|
+
|
|
165
|
+
// Simulate a successful skip-verify (allow-all gateway)
|
|
166
|
+
m.verifications_total.increment({ result: 'ok', alg: 'none', transport: 'http' })
|
|
167
|
+
|
|
168
|
+
expect(m.verifications_total.value({ result: 'ok', alg: 'none', transport: 'http' })).toBe(1)
|
|
169
|
+
expect(m.verifications_total.value({ result: 'fail', alg: 'none', transport: 'http' })).toBe(0)
|
|
170
|
+
})
|
|
171
|
+
|
|
172
|
+
it('increments verifications_total fail on rate-limit', async () => {
|
|
173
|
+
const m = new Protocol7h3Metrics()
|
|
174
|
+
|
|
175
|
+
// Simulate a rate-limit hit
|
|
176
|
+
m.verifications_total.increment({ result: 'fail', alg: 'ED25519', transport: 'http' })
|
|
177
|
+
m.rate_limit_hits_total.increment({ sender: 'agent-x', path: '/api/data' })
|
|
178
|
+
|
|
179
|
+
expect(m.verifications_total.value({ result: 'fail', alg: 'ED25519', transport: 'http' })).toBe(1)
|
|
180
|
+
expect(m.rate_limit_hits_total.value({ sender: 'agent-x', path: '/api/data' })).toBe(1)
|
|
181
|
+
})
|
|
182
|
+
|
|
183
|
+
it('increments sender_denials_total on 403', async () => {
|
|
184
|
+
const m = new Protocol7h3Metrics()
|
|
185
|
+
|
|
186
|
+
m.verifications_total.increment({ result: 'fail', alg: 'ED25519', transport: 'http' })
|
|
187
|
+
m.sender_denials_total.increment({ sender: 'rogue-agent', path: '/admin' })
|
|
188
|
+
|
|
189
|
+
expect(m.sender_denials_total.value({ sender: 'rogue-agent', path: '/admin' })).toBe(1)
|
|
190
|
+
expect(m.verifications_total.value({ result: 'fail', alg: 'ED25519', transport: 'http' })).toBe(1)
|
|
191
|
+
})
|
|
192
|
+
|
|
193
|
+
it('records duration in verification_duration_ms', () => {
|
|
194
|
+
const m = new Protocol7h3Metrics()
|
|
195
|
+
|
|
196
|
+
m.verification_duration_ms.observe(0.3)
|
|
197
|
+
m.verification_duration_ms.observe(2.0)
|
|
198
|
+
m.verification_duration_ms.observe(120)
|
|
199
|
+
|
|
200
|
+
const snap = m.verification_duration_ms.snapshot()
|
|
201
|
+
expect(snap.count).toBe(3)
|
|
202
|
+
expect(snap.sum).toBeCloseTo(0.3 + 2.0 + 120)
|
|
203
|
+
// 0.3 ≤ 0.5 → should appear in bucket 0.5
|
|
204
|
+
expect(snap.buckets['0.5']).toBe(1)
|
|
205
|
+
// +Inf must be count
|
|
206
|
+
expect(snap.buckets['+Inf']).toBe(3)
|
|
207
|
+
})
|
|
208
|
+
})
|
|
209
|
+
|
|
210
|
+
// ─── 6. createMetricsMiddleware serves metrics ────────────────────────────────
|
|
211
|
+
|
|
212
|
+
describe('createMetricsMiddleware', () => {
|
|
213
|
+
it('serves Prometheus text at /metrics', () => {
|
|
214
|
+
const m = new Protocol7h3Metrics()
|
|
215
|
+
m.verifications_total.increment({ result: 'ok', alg: 'ED25519', transport: 'http' })
|
|
216
|
+
const middleware = createMetricsMiddleware('/metrics', m)
|
|
217
|
+
|
|
218
|
+
let status = 0
|
|
219
|
+
let body = ''
|
|
220
|
+
let headers: Record<string, string> = {}
|
|
221
|
+
const req = { url: '/metrics', method: 'GET' }
|
|
222
|
+
const res = {
|
|
223
|
+
writeHead(s: number, h: Record<string, string>) { status = s; headers = h },
|
|
224
|
+
end(b: string) { body = b },
|
|
225
|
+
}
|
|
226
|
+
let nextCalled = false
|
|
227
|
+
const next = () => { nextCalled = true }
|
|
228
|
+
|
|
229
|
+
middleware(req, res, next)
|
|
230
|
+
|
|
231
|
+
expect(status).toBe(200)
|
|
232
|
+
expect(headers['content-type']).toMatch(/text\/plain/)
|
|
233
|
+
expect(body).toContain('# HELP 7h3_verifications_total')
|
|
234
|
+
expect(nextCalled).toBe(false)
|
|
235
|
+
})
|
|
236
|
+
|
|
237
|
+
it('calls next() for non-metrics paths', () => {
|
|
238
|
+
const m = new Protocol7h3Metrics()
|
|
239
|
+
const middleware = createMetricsMiddleware('/metrics', m)
|
|
240
|
+
|
|
241
|
+
let nextCalled = false
|
|
242
|
+
const req = { url: '/api/data', method: 'GET' }
|
|
243
|
+
const res = {
|
|
244
|
+
writeHead() {},
|
|
245
|
+
end() {},
|
|
246
|
+
}
|
|
247
|
+
middleware(req, res, () => { nextCalled = true })
|
|
248
|
+
|
|
249
|
+
expect(nextCalled).toBe(true)
|
|
250
|
+
})
|
|
251
|
+
})
|
package/src/telemetry.ts
ADDED
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* telemetry.ts — Prometheus metrics for 7h3 Protocol
|
|
3
|
+
*
|
|
4
|
+
* Zero runtime dependencies. Plain in-memory counters and histograms rendered
|
|
5
|
+
* to standard Prometheus text exposition format.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
// ─── Types ───────────────────────────────────────────────────────────────────
|
|
9
|
+
|
|
10
|
+
export interface TelemetryConfig {
|
|
11
|
+
enabled?: boolean
|
|
12
|
+
prefix?: string // default '7h3'
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
export interface Counter {
|
|
16
|
+
increment(labels?: Record<string, string>): void
|
|
17
|
+
value(labels?: Record<string, string>): number
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
export interface HistogramSnapshot {
|
|
21
|
+
count: number
|
|
22
|
+
sum: number
|
|
23
|
+
buckets: Record<string, number> // upper bound (as string) → cumulative count
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export interface Histogram {
|
|
27
|
+
observe(value: number, labels?: Record<string, string>): void
|
|
28
|
+
snapshot(labels?: Record<string, string>): HistogramSnapshot
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
// ─── Helpers ─────────────────────────────────────────────────────────────────
|
|
32
|
+
|
|
33
|
+
function labelKey(labels?: Record<string, string>): string {
|
|
34
|
+
if (!labels || Object.keys(labels).length === 0) return '__default__'
|
|
35
|
+
return Object.entries(labels)
|
|
36
|
+
.sort(([a], [b]) => a.localeCompare(b))
|
|
37
|
+
.map(([k, v]) => `${k}=${v}`)
|
|
38
|
+
.join(',')
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
function renderLabels(labels?: Record<string, string>): string {
|
|
42
|
+
if (!labels || Object.keys(labels).length === 0) return ''
|
|
43
|
+
const parts = Object.entries(labels)
|
|
44
|
+
.sort(([a], [b]) => a.localeCompare(b))
|
|
45
|
+
.map(([k, v]) => `${k}="${v}"`)
|
|
46
|
+
return `{${parts.join(',')}}`
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// ─── SimpleCounter ────────────────────────────────────────────────────────────
|
|
50
|
+
|
|
51
|
+
export class SimpleCounter implements Counter {
|
|
52
|
+
private counts = new Map<string, number>()
|
|
53
|
+
private labelSets = new Map<string, Record<string, string> | undefined>()
|
|
54
|
+
|
|
55
|
+
increment(labels?: Record<string, string>): void {
|
|
56
|
+
const key = labelKey(labels)
|
|
57
|
+
this.counts.set(key, (this.counts.get(key) ?? 0) + 1)
|
|
58
|
+
if (!this.labelSets.has(key)) {
|
|
59
|
+
this.labelSets.set(key, labels)
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
value(labels?: Record<string, string>): number {
|
|
64
|
+
return this.counts.get(labelKey(labels)) ?? 0
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
entries(): Array<{ labels?: Record<string, string>; value: number }> {
|
|
68
|
+
const result: Array<{ labels?: Record<string, string>; value: number }> = []
|
|
69
|
+
for (const [key, value] of this.counts) {
|
|
70
|
+
result.push({ labels: this.labelSets.get(key), value })
|
|
71
|
+
}
|
|
72
|
+
return result
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// ─── SimpleHistogram ──────────────────────────────────────────────────────────
|
|
77
|
+
|
|
78
|
+
interface BucketState {
|
|
79
|
+
count: number
|
|
80
|
+
sum: number
|
|
81
|
+
// bucket upper bounds → cumulative count (populated on snapshot)
|
|
82
|
+
observations: number[]
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export class SimpleHistogram implements Histogram {
|
|
86
|
+
private bucketBounds: number[]
|
|
87
|
+
private states = new Map<string, BucketState>()
|
|
88
|
+
private labelSets = new Map<string, Record<string, string> | undefined>()
|
|
89
|
+
|
|
90
|
+
constructor(buckets: number[] = [0.005, 0.01, 0.025, 0.05, 0.1, 0.25, 0.5, 1, 2.5, 5, 10]) {
|
|
91
|
+
this.bucketBounds = [...buckets].sort((a, b) => a - b)
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
observe(value: number, labels?: Record<string, string>): void {
|
|
95
|
+
const key = labelKey(labels)
|
|
96
|
+
if (!this.states.has(key)) {
|
|
97
|
+
this.states.set(key, { count: 0, sum: 0, observations: [] })
|
|
98
|
+
this.labelSets.set(key, labels)
|
|
99
|
+
}
|
|
100
|
+
const state = this.states.get(key)!
|
|
101
|
+
state.count++
|
|
102
|
+
state.sum += value
|
|
103
|
+
state.observations.push(value)
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
snapshot(labels?: Record<string, string>): HistogramSnapshot {
|
|
107
|
+
const key = labelKey(labels)
|
|
108
|
+
const state = this.states.get(key) ?? { count: 0, sum: 0, observations: [] }
|
|
109
|
+
|
|
110
|
+
const buckets: Record<string, number> = {}
|
|
111
|
+
for (const bound of this.bucketBounds) {
|
|
112
|
+
buckets[String(bound)] = state.observations.filter(v => v <= bound).length
|
|
113
|
+
}
|
|
114
|
+
// +Inf bucket
|
|
115
|
+
buckets['+Inf'] = state.count
|
|
116
|
+
|
|
117
|
+
return { count: state.count, sum: state.sum, buckets }
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
entries(): Array<{ labels?: Record<string, string>; snapshot: HistogramSnapshot }> {
|
|
121
|
+
const result: Array<{ labels?: Record<string, string>; snapshot: HistogramSnapshot }> = []
|
|
122
|
+
for (const [key] of this.states) {
|
|
123
|
+
const labels = this.labelSets.get(key)
|
|
124
|
+
result.push({ labels, snapshot: this.snapshot(labels) })
|
|
125
|
+
}
|
|
126
|
+
return result
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
getBounds(): number[] {
|
|
130
|
+
return [...this.bucketBounds]
|
|
131
|
+
}
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
// ─── Protocol7h3Metrics ───────────────────────────────────────────────────────
|
|
135
|
+
|
|
136
|
+
export class Protocol7h3Metrics {
|
|
137
|
+
/** labels: result (ok|fail), alg (ED25519|HS256|none), transport (http|ws|grpc|queue|webhook) */
|
|
138
|
+
verifications_total = new SimpleCounter()
|
|
139
|
+
|
|
140
|
+
/** buckets in ms */
|
|
141
|
+
verification_duration_ms = new SimpleHistogram([0.1, 0.5, 1, 5, 10, 50, 100])
|
|
142
|
+
|
|
143
|
+
/** labels: sender, path */
|
|
144
|
+
rate_limit_hits_total = new SimpleCounter()
|
|
145
|
+
|
|
146
|
+
/** labels: sender, path */
|
|
147
|
+
sender_denials_total = new SimpleCounter()
|
|
148
|
+
|
|
149
|
+
/** labels: transport */
|
|
150
|
+
replay_detections_total = new SimpleCounter()
|
|
151
|
+
|
|
152
|
+
/** labels: type */
|
|
153
|
+
audit_entries_total = new SimpleCounter()
|
|
154
|
+
|
|
155
|
+
/** labels: transport — use for WS/gRPC connection tracking */
|
|
156
|
+
active_connections = new SimpleCounter()
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
// ─── Global instance ──────────────────────────────────────────────────────────
|
|
160
|
+
|
|
161
|
+
export const metrics = new Protocol7h3Metrics()
|
|
162
|
+
|
|
163
|
+
// ─── Prometheus text format renderer ─────────────────────────────────────────
|
|
164
|
+
|
|
165
|
+
export function renderPrometheusText(m: Protocol7h3Metrics, prefix = '7h3'): string {
|
|
166
|
+
const lines: string[] = []
|
|
167
|
+
|
|
168
|
+
// Helper: emit a counter
|
|
169
|
+
function emitCounter(name: string, help: string, counter: SimpleCounter): void {
|
|
170
|
+
const fullName = `${prefix}_${name}`
|
|
171
|
+
lines.push(`# HELP ${fullName} ${help}`)
|
|
172
|
+
lines.push(`# TYPE ${fullName} counter`)
|
|
173
|
+
const entries = counter.entries()
|
|
174
|
+
if (entries.length === 0) {
|
|
175
|
+
lines.push(`${fullName} 0`)
|
|
176
|
+
} else {
|
|
177
|
+
for (const { labels, value } of entries) {
|
|
178
|
+
if (labels && Object.keys(labels).length > 0) {
|
|
179
|
+
lines.push(`${fullName}${renderLabels(labels)} ${value}`)
|
|
180
|
+
} else {
|
|
181
|
+
lines.push(`${fullName} ${value}`)
|
|
182
|
+
}
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
// Helper: emit a histogram
|
|
188
|
+
function emitHistogram(name: string, help: string, histogram: SimpleHistogram): void {
|
|
189
|
+
const fullName = `${prefix}_${name}`
|
|
190
|
+
lines.push(`# HELP ${fullName} ${help}`)
|
|
191
|
+
lines.push(`# TYPE ${fullName} histogram`)
|
|
192
|
+
const entries = histogram.entries()
|
|
193
|
+
if (entries.length === 0) {
|
|
194
|
+
// Emit empty histogram with zero counts
|
|
195
|
+
for (const bound of histogram.getBounds()) {
|
|
196
|
+
lines.push(`${fullName}_bucket{le="${bound}"} 0`)
|
|
197
|
+
}
|
|
198
|
+
lines.push(`${fullName}_bucket{le="+Inf"} 0`)
|
|
199
|
+
lines.push(`${fullName}_sum 0`)
|
|
200
|
+
lines.push(`${fullName}_count 0`)
|
|
201
|
+
} else {
|
|
202
|
+
for (const { labels, snapshot } of entries) {
|
|
203
|
+
const labelStr = labels && Object.keys(labels).length > 0
|
|
204
|
+
? renderLabels(labels)
|
|
205
|
+
: ''
|
|
206
|
+
|
|
207
|
+
for (const [bound, count] of Object.entries(snapshot.buckets)) {
|
|
208
|
+
if (bound === '+Inf') continue
|
|
209
|
+
const bucketLabels = labelStr
|
|
210
|
+
? labelStr.slice(0, -1) + `,le="${bound}"}`
|
|
211
|
+
: `{le="${bound}"}`
|
|
212
|
+
lines.push(`${fullName}_bucket${bucketLabels} ${count}`)
|
|
213
|
+
}
|
|
214
|
+
// +Inf bucket
|
|
215
|
+
const infLabels = labelStr
|
|
216
|
+
? labelStr.slice(0, -1) + `,le="+Inf"}`
|
|
217
|
+
: `{le="+Inf"}`
|
|
218
|
+
lines.push(`${fullName}_bucket${infLabels} ${snapshot.count}`)
|
|
219
|
+
lines.push(`${fullName}_sum${labelStr} ${snapshot.sum}`)
|
|
220
|
+
lines.push(`${fullName}_count${labelStr} ${snapshot.count}`)
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
emitCounter(
|
|
226
|
+
'verifications_total',
|
|
227
|
+
'Total number of AIP envelope verifications, by result, algorithm, and transport',
|
|
228
|
+
m.verifications_total,
|
|
229
|
+
)
|
|
230
|
+
|
|
231
|
+
emitHistogram(
|
|
232
|
+
'verification_duration_ms',
|
|
233
|
+
'Verification latency in milliseconds',
|
|
234
|
+
m.verification_duration_ms,
|
|
235
|
+
)
|
|
236
|
+
|
|
237
|
+
emitCounter(
|
|
238
|
+
'rate_limit_hits_total',
|
|
239
|
+
'Total number of rate-limit rejections, by sender and path',
|
|
240
|
+
m.rate_limit_hits_total,
|
|
241
|
+
)
|
|
242
|
+
|
|
243
|
+
emitCounter(
|
|
244
|
+
'sender_denials_total',
|
|
245
|
+
'Total number of sender-denied (403) rejections, by sender and path',
|
|
246
|
+
m.sender_denials_total,
|
|
247
|
+
)
|
|
248
|
+
|
|
249
|
+
emitCounter(
|
|
250
|
+
'replay_detections_total',
|
|
251
|
+
'Total number of replay-detected events, by transport',
|
|
252
|
+
m.replay_detections_total,
|
|
253
|
+
)
|
|
254
|
+
|
|
255
|
+
emitCounter(
|
|
256
|
+
'audit_entries_total',
|
|
257
|
+
'Total number of audit log entries written, by type',
|
|
258
|
+
m.audit_entries_total,
|
|
259
|
+
)
|
|
260
|
+
|
|
261
|
+
emitCounter(
|
|
262
|
+
'active_connections',
|
|
263
|
+
'Current active connections, by transport (WS/gRPC)',
|
|
264
|
+
m.active_connections,
|
|
265
|
+
)
|
|
266
|
+
|
|
267
|
+
return lines.join('\n') + '\n'
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
// ─── Node.js http-compatible metrics middleware ───────────────────────────────
|
|
271
|
+
|
|
272
|
+
type NodeReq = { url?: string; method?: string }
|
|
273
|
+
type NodeRes = {
|
|
274
|
+
writeHead(status: number, headers: Record<string, string>): void
|
|
275
|
+
end(body: string): void
|
|
276
|
+
}
|
|
277
|
+
type NextFn = () => void
|
|
278
|
+
|
|
279
|
+
/**
|
|
280
|
+
* Returns a Node.js http-compatible middleware that serves Prometheus metrics
|
|
281
|
+
* at the given path (default: /metrics).
|
|
282
|
+
*/
|
|
283
|
+
export function createMetricsMiddleware(
|
|
284
|
+
path = '/metrics',
|
|
285
|
+
m: Protocol7h3Metrics = metrics,
|
|
286
|
+
prefix = '7h3',
|
|
287
|
+
): (req: NodeReq, res: NodeRes, next: NextFn) => void {
|
|
288
|
+
return (req, res, next) => {
|
|
289
|
+
if (req.url === path && (req.method === 'GET' || req.method === undefined)) {
|
|
290
|
+
const body = renderPrometheusText(m, prefix)
|
|
291
|
+
res.writeHead(200, {
|
|
292
|
+
'content-type': 'text/plain; version=0.0.4; charset=utf-8',
|
|
293
|
+
})
|
|
294
|
+
res.end(body)
|
|
295
|
+
} else {
|
|
296
|
+
next()
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
@@ -0,0 +1,144 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest'
|
|
2
|
+
import {
|
|
3
|
+
signWebhook,
|
|
4
|
+
verifyWebhook,
|
|
5
|
+
signWebhookHmac,
|
|
6
|
+
verifyWebhookHmac,
|
|
7
|
+
consumeWebhook,
|
|
8
|
+
generateEd25519KeypairBase64Url,
|
|
9
|
+
WEBHOOK_SIG_HEADER,
|
|
10
|
+
WEBHOOK_TS_HEADER,
|
|
11
|
+
} from './webhookBinding'
|
|
12
|
+
|
|
13
|
+
describe('webhookBinding', () => {
|
|
14
|
+
// 1. Ed25519 sign + verify round trip
|
|
15
|
+
it('signWebhook + verifyWebhook round trip (Ed25519)', async () => {
|
|
16
|
+
const { privateKey, publicKey } = await generateEd25519KeypairBase64Url()
|
|
17
|
+
const payload = JSON.stringify({ event: 'user.created', userId: '123' })
|
|
18
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
19
|
+
const valid = await verifyWebhook(payload, headers, { publicKey })
|
|
20
|
+
expect(valid).toBe(true)
|
|
21
|
+
})
|
|
22
|
+
|
|
23
|
+
// 2. HMAC sign + verify round trip
|
|
24
|
+
it('signWebhookHmac + verifyWebhookHmac round trip', async () => {
|
|
25
|
+
const secret = 'super-secret-webhook-key'
|
|
26
|
+
const payload = JSON.stringify({ event: 'order.paid', orderId: 'abc' })
|
|
27
|
+
const headers = await signWebhookHmac(payload, { secret })
|
|
28
|
+
const valid = await verifyWebhookHmac(payload, headers, { secret })
|
|
29
|
+
expect(valid).toBe(true)
|
|
30
|
+
})
|
|
31
|
+
|
|
32
|
+
// 3. Tampered payload returns false (Ed25519)
|
|
33
|
+
it('tampered payload returns false (Ed25519)', async () => {
|
|
34
|
+
const { privateKey, publicKey } = await generateEd25519KeypairBase64Url()
|
|
35
|
+
const payload = JSON.stringify({ event: 'user.created', userId: '123' })
|
|
36
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
37
|
+
const tamperedPayload = JSON.stringify({ event: 'user.created', userId: '999' })
|
|
38
|
+
const valid = await verifyWebhook(tamperedPayload, headers, { publicKey })
|
|
39
|
+
expect(valid).toBe(false)
|
|
40
|
+
})
|
|
41
|
+
|
|
42
|
+
// 3b. Tampered payload returns false (HMAC)
|
|
43
|
+
it('tampered payload returns false (HMAC)', async () => {
|
|
44
|
+
const secret = 'super-secret-webhook-key'
|
|
45
|
+
const payload = JSON.stringify({ event: 'order.paid', orderId: 'abc' })
|
|
46
|
+
const headers = await signWebhookHmac(payload, { secret })
|
|
47
|
+
const tamperedPayload = JSON.stringify({ event: 'order.paid', orderId: 'TAMPERED' })
|
|
48
|
+
const valid = await verifyWebhookHmac(tamperedPayload, headers, { secret })
|
|
49
|
+
expect(valid).toBe(false)
|
|
50
|
+
})
|
|
51
|
+
|
|
52
|
+
// 4. Expired timestamp returns false
|
|
53
|
+
it('expired timestamp returns false', async () => {
|
|
54
|
+
const { privateKey, publicKey } = await generateEd25519KeypairBase64Url()
|
|
55
|
+
const payload = JSON.stringify({ event: 'ping' })
|
|
56
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
57
|
+
// Backdate the timestamp to be 10 minutes ago
|
|
58
|
+
const expiredHeaders = {
|
|
59
|
+
...headers,
|
|
60
|
+
[WEBHOOK_TS_HEADER]: String(Date.now() - 10 * 60 * 1000),
|
|
61
|
+
}
|
|
62
|
+
const valid = await verifyWebhook(payload, expiredHeaders, { publicKey, maxAgeMs: 300_000 })
|
|
63
|
+
expect(valid).toBe(false)
|
|
64
|
+
})
|
|
65
|
+
|
|
66
|
+
// 5. Wrong key returns false
|
|
67
|
+
it('wrong public key returns false', async () => {
|
|
68
|
+
const { privateKey } = await generateEd25519KeypairBase64Url()
|
|
69
|
+
const { publicKey: wrongPublicKey } = await generateEd25519KeypairBase64Url()
|
|
70
|
+
const payload = JSON.stringify({ event: 'test' })
|
|
71
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
72
|
+
const valid = await verifyWebhook(payload, headers, { publicKey: wrongPublicKey })
|
|
73
|
+
expect(valid).toBe(false)
|
|
74
|
+
})
|
|
75
|
+
|
|
76
|
+
// 5b. Wrong HMAC secret returns false
|
|
77
|
+
it('wrong HMAC secret returns false', async () => {
|
|
78
|
+
const secret = 'correct-secret'
|
|
79
|
+
const payload = JSON.stringify({ event: 'test' })
|
|
80
|
+
const headers = await signWebhookHmac(payload, { secret })
|
|
81
|
+
const valid = await verifyWebhookHmac(payload, headers, { secret: 'wrong-secret' })
|
|
82
|
+
expect(valid).toBe(false)
|
|
83
|
+
})
|
|
84
|
+
|
|
85
|
+
// 6. consumeWebhook parses valid payload
|
|
86
|
+
it('consumeWebhook parses valid payload and returns parsed object', async () => {
|
|
87
|
+
const { privateKey, publicKey } = await generateEd25519KeypairBase64Url()
|
|
88
|
+
const data = { event: 'invoice.paid', amount: 9900, currency: 'usd' }
|
|
89
|
+
const payload = JSON.stringify(data)
|
|
90
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
91
|
+
const result = await consumeWebhook<typeof data>(payload, headers as Record<string, string>, { publicKey })
|
|
92
|
+
expect(result).toEqual(data)
|
|
93
|
+
})
|
|
94
|
+
|
|
95
|
+
// 7. consumeWebhook throws on invalid signature
|
|
96
|
+
it('consumeWebhook throws on invalid signature', async () => {
|
|
97
|
+
const { privateKey } = await generateEd25519KeypairBase64Url()
|
|
98
|
+
const { publicKey: wrongPublicKey } = await generateEd25519KeypairBase64Url()
|
|
99
|
+
const payload = JSON.stringify({ event: 'invoice.paid' })
|
|
100
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
101
|
+
await expect(
|
|
102
|
+
consumeWebhook(payload, headers as Record<string, string>, { publicKey: wrongPublicKey })
|
|
103
|
+
).rejects.toThrow('7h3: webhook signature verification failed')
|
|
104
|
+
})
|
|
105
|
+
|
|
106
|
+
// 7b. consumeWebhook throws on expired timestamp
|
|
107
|
+
it('consumeWebhook throws on expired timestamp', async () => {
|
|
108
|
+
const { privateKey, publicKey } = await generateEd25519KeypairBase64Url()
|
|
109
|
+
const payload = JSON.stringify({ event: 'test' })
|
|
110
|
+
const headers = await signWebhook(payload, { privateKey })
|
|
111
|
+
const expiredHeaders = {
|
|
112
|
+
...headers,
|
|
113
|
+
[WEBHOOK_TS_HEADER]: String(Date.now() - 10 * 60 * 1000),
|
|
114
|
+
}
|
|
115
|
+
await expect(
|
|
116
|
+
consumeWebhook(payload, expiredHeaders as Record<string, string>, { publicKey, maxAgeMs: 300_000 })
|
|
117
|
+
).rejects.toThrow('7h3: webhook signature verification failed')
|
|
118
|
+
})
|
|
119
|
+
|
|
120
|
+
// Edge: missing headers return false
|
|
121
|
+
it('missing sig header returns false', async () => {
|
|
122
|
+
const { publicKey } = await generateEd25519KeypairBase64Url()
|
|
123
|
+
const payload = 'hello'
|
|
124
|
+
const valid = await verifyWebhook(payload, { [WEBHOOK_TS_HEADER]: String(Date.now()) } as Record<string, string>, { publicKey })
|
|
125
|
+
expect(valid).toBe(false)
|
|
126
|
+
})
|
|
127
|
+
|
|
128
|
+
it('missing ts header returns false', async () => {
|
|
129
|
+
const { publicKey } = await generateEd25519KeypairBase64Url()
|
|
130
|
+
const payload = 'hello'
|
|
131
|
+
const valid = await verifyWebhook(payload, { [WEBHOOK_SIG_HEADER]: 'fakesig' } as Record<string, string>, { publicKey })
|
|
132
|
+
expect(valid).toBe(false)
|
|
133
|
+
})
|
|
134
|
+
|
|
135
|
+
// Uint8Array payload works (Ed25519)
|
|
136
|
+
it('Uint8Array payload signs and verifies (Ed25519)', async () => {
|
|
137
|
+
const { privateKey, publicKey } = await generateEd25519KeypairBase64Url()
|
|
138
|
+
const payloadStr = JSON.stringify({ binary: true })
|
|
139
|
+
const payloadBytes = new TextEncoder().encode(payloadStr)
|
|
140
|
+
const headers = await signWebhook(payloadBytes, { privateKey })
|
|
141
|
+
const valid = await verifyWebhook(payloadBytes, headers, { publicKey })
|
|
142
|
+
expect(valid).toBe(true)
|
|
143
|
+
})
|
|
144
|
+
})
|