@7h3/protocol 0.4.0 → 0.5.1

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.
Files changed (248) hide show
  1. package/README.md +6 -323
  2. package/agentAdapter.d.ts +26 -0
  3. package/auditLog.d.ts +54 -0
  4. package/capability.d.ts +67 -0
  5. package/cborCodec.d.ts +34 -0
  6. package/conformanceVectors.d.ts +20 -0
  7. package/encryption.d.ts +85 -0
  8. package/envelopeCbor.d.ts +33 -0
  9. package/frameworkAdapters.d.ts +72 -0
  10. package/gateway.d.ts +53 -0
  11. package/grpcBinding.d.ts +29 -0
  12. package/httpBinding.d.ts +50 -0
  13. package/index.d.ts +39 -0
  14. package/index.js +3662 -0
  15. package/keyInfra.d.ts +64 -0
  16. package/keyRegistry.d.ts +9 -0
  17. package/keyRotation.d.ts +20 -0
  18. package/mcpGateway.d.ts +37 -0
  19. package/mcpTransports.d.ts +62 -0
  20. package/mcpWrapper.d.ts +83 -0
  21. package/otel.d.ts +65 -0
  22. package/package.json +13 -79
  23. package/policyEnforcer.d.ts +50 -0
  24. package/policyTelemetryFeedback.d.ts +11 -0
  25. package/protocol.d.ts +66 -0
  26. package/protocolAgent.d.ts +58 -0
  27. package/protocolBinary.d.ts +8 -0
  28. package/protocolCapabilities.d.ts +24 -0
  29. package/protocolReplay.d.ts +35 -0
  30. package/protocolTransport.d.ts +73 -0
  31. package/queueBinding.d.ts +43 -0
  32. package/rateLimiter.d.ts +18 -0
  33. package/{src/redisClient.ts → redisClient.d.ts} +25 -75
  34. package/replayStores.d.ts +98 -0
  35. package/revocation.d.ts +71 -0
  36. package/routePolicy.d.ts +30 -0
  37. package/runtimePolicy.d.ts +24 -0
  38. package/runtimePolicyManager.d.ts +15 -0
  39. package/runtimePolicyPresets.d.ts +11 -0
  40. package/signedResponse.d.ts +21 -0
  41. package/stream.d.ts +59 -0
  42. package/telemetry.d.ts +79 -0
  43. package/webhookBinding.d.ts +30 -0
  44. package/wsBinding.d.ts +52 -0
  45. package/.dockerignore +0 -19
  46. package/.github/dependabot.yml +0 -32
  47. package/.github/workflows/ci.yml +0 -31
  48. package/.github/workflows/publish.yml +0 -59
  49. package/.github/workflows/scorecard.yml +0 -37
  50. package/7h3.example.yaml +0 -125
  51. package/CHANGELOG.md +0 -92
  52. package/CONTRIBUTING.md +0 -82
  53. package/Dockerfile +0 -73
  54. package/GOVERNANCE.md +0 -62
  55. package/SECURITY.md +0 -70
  56. package/bench-results/replay-cache-full-1777891033256.json +0 -10
  57. package/bench-results/replay-cache-full-1777896317488.json +0 -10
  58. package/bench-results/replay-cache-full-1777900993184.json +0 -10
  59. package/bench-results/replay-cache-full-1777901019285.json +0 -10
  60. package/bench-results/replay-cache-quick-1777870170126.json +0 -10
  61. package/bench-results/signature-profiles-quick-1775875160079.json +0 -85
  62. package/bench-results/signature-profiles-quick-1775983539716.json +0 -85
  63. package/bench-results/signature-profiles-quick-1776237913190.json +0 -85
  64. package/bench-results/wire-codecs-full-1777891019803.json +0 -93
  65. package/bench-results/wire-codecs-full-1777896260964.json +0 -93
  66. package/bench-results/wire-codecs-full-1777901004247.json +0 -93
  67. package/bench-results/wire-codecs-quick-1775972879056.json +0 -93
  68. package/bench-results/wire-codecs-quick-1775983541111.json +0 -93
  69. package/bench-results/wire-codecs-quick-1776237914299.json +0 -93
  70. package/bench-results/wire-codecs-quick-1777841285236.json +0 -93
  71. package/bench-results/wire-codecs-quick-1777841321772.json +0 -93
  72. package/bench-results/wire-codecs-quick-1777841330408.json +0 -93
  73. package/bench-results/wire-codecs-quick-1777852886082.json +0 -93
  74. package/bench-results/wire-codecs-quick-1777852988773.json +0 -93
  75. package/bench-results/wire-codecs-quick-1777870188095.json +0 -93
  76. package/bench-results/wire-codecs-quick-1777870263918.json +0 -93
  77. package/bench-results/wire-codecs-quick-1777870455034.json +0 -93
  78. package/bench-results/wire-codecs-quick-1778816163081.json +0 -93
  79. package/bench-results/wire-codecs-quick-1778843936130.json +0 -93
  80. package/bin/7h3.ts +0 -385
  81. package/conformance/7h3_v0_1.json +0 -77
  82. package/conformance/7h3_v0_1_binary.json +0 -20
  83. package/conformance/aip_v0_1_binary.json +0 -20
  84. package/docker-compose.yaml +0 -77
  85. package/docs/ADOPTION_PLAN.md +0 -120
  86. package/docs/AGENTS.md +0 -77
  87. package/docs/AIP_RFC_v0.1.md +0 -97
  88. package/docs/AI_DECISION_CARD.md +0 -122
  89. package/docs/AI_RUNTIME_POLICY.json +0 -126
  90. package/docs/AI_RUNTIME_POLICY.yaml +0 -110
  91. package/docs/BACKPRESSURE_TUNING.md +0 -65
  92. package/docs/BENCHMARK_CLAIM_MATRIX.md +0 -42
  93. package/docs/BENCHMARK_REPORT_TEMPLATE.md +0 -169
  94. package/docs/BINARY_CODEC_BENCH.md +0 -23
  95. package/docs/CLEAN_CLONE_RUNBOOK.md +0 -36
  96. package/docs/CLOCK_SKEW_POLICY.md +0 -30
  97. package/docs/DISTRIBUTED_REPLAY.md +0 -142
  98. package/docs/FUZZ_CAMPAIGN.md +0 -121
  99. package/docs/GATEWAY.md +0 -195
  100. package/docs/KEY_MANAGEMENT_POLICY.md +0 -53
  101. package/docs/KEY_REVOCATION.md +0 -69
  102. package/docs/MCP_WRAPPER.md +0 -159
  103. package/docs/MIGRATION_GUIDE.md +0 -40
  104. package/docs/OPERATORS.md +0 -184
  105. package/docs/PERF_REGRESSION_POLICY.md +0 -34
  106. package/docs/PROJECT_EXAMINATION_2026-05-31.md +0 -219
  107. package/docs/RELEASE_BENCHMARK_REPORT_2026-05-15.md +0 -135
  108. package/docs/RELEASE_GATE.md +0 -25
  109. package/docs/RELEASE_NOTES_v0.1.0.md +0 -54
  110. package/docs/SECURITY_REVIEW_2026-06-05.md +0 -165
  111. package/docs/TELEMETRY.md +0 -41
  112. package/docs/THREAT_MODEL.md +0 -89
  113. package/docs/VERSIONING_POLICY.md +0 -30
  114. package/docs/assets/banner.png +0 -0
  115. package/eslint.config.js +0 -15
  116. package/fuzz/ts/harness-decode.ts +0 -136
  117. package/fuzz/ts/harness-verify.ts +0 -121
  118. package/fuzz/ts/run.ts +0 -35
  119. package/mcp-server/README.md +0 -38
  120. package/mcp-server/package-lock.json +0 -1187
  121. package/mcp-server/package.json +0 -35
  122. package/mcp-server/src/index.ts +0 -236
  123. package/mcp-server/tsconfig.json +0 -14
  124. package/scripts/aip-framework-quickstart.ts +0 -110
  125. package/scripts/aip-mcp-gateway.ts +0 -38
  126. package/scripts/aip-mcp-wrap-demo.ts +0 -72
  127. package/scripts/aip-quickstart.ts +0 -60
  128. package/scripts/bench-diff.ts +0 -118
  129. package/scripts/bench-protocol-e2e.ts +0 -937
  130. package/scripts/bench-protocol-openloop.ts +0 -1397
  131. package/scripts/bench-replay-cache.ts +0 -76
  132. package/scripts/bench-signature-profiles.ts +0 -180
  133. package/scripts/bench-wire-codecs.ts +0 -161
  134. package/scripts/build-binary-conformance.ts +0 -36
  135. package/scripts/build-release-dashboard.ts +0 -175
  136. package/scripts/canary-rollout.ts +0 -38
  137. package/scripts/mcpGatewayCli.test.ts +0 -116
  138. package/scripts/prepare-aip-package.ts +0 -88
  139. package/scripts/regen-conformance-sigs.ts +0 -18
  140. package/scripts/release-gate.ts +0 -19
  141. package/scripts/validate-runtime-policy.ts +0 -18
  142. package/sdk/browser/index.test.ts +0 -162
  143. package/sdk/browser/index.ts +0 -257
  144. package/sdk/browser/package.json +0 -13
  145. package/sdk/go/go.mod +0 -3
  146. package/sdk/go/http.go +0 -135
  147. package/sdk/go/protocol.go +0 -324
  148. package/sdk/go/protocol_test.go +0 -334
  149. package/sdk/go/webhook.go +0 -136
  150. package/sdk/python/README.md +0 -18
  151. package/sdk/python/protocol_7h3/__init__.py +0 -46
  152. package/sdk/python/protocol_7h3/http.py +0 -212
  153. package/sdk/python/protocol_7h3/keys.py +0 -149
  154. package/sdk/python/protocol_7h3/protocol.py +0 -525
  155. package/sdk/python/protocol_7h3/queue.py +0 -118
  156. package/sdk/python/protocol_7h3/webhook.py +0 -116
  157. package/sdk/python/pyproject.toml +0 -40
  158. package/sdk/python/tests/test_conformance.py +0 -110
  159. package/sdk/python/tests/test_http.py +0 -305
  160. package/sdk/python/tests/test_keys.py +0 -417
  161. package/sdk/python/tests/test_queue.py +0 -120
  162. package/sdk/python/tests/test_webhook.py +0 -345
  163. package/sdk/rust/Cargo.lock +0 -371
  164. package/sdk/rust/Cargo.toml +0 -25
  165. package/sdk/rust/README.md +0 -31
  166. package/sdk/rust/fuzz/Cargo.toml +0 -29
  167. package/sdk/rust/fuzz/fuzz_targets/fuzz_canonicalize.rs +0 -46
  168. package/sdk/rust/fuzz/fuzz_targets/fuzz_decode.rs +0 -11
  169. package/sdk/rust/src/bin/aip_mcp_gateway.rs +0 -59
  170. package/sdk/rust/src/http.rs +0 -145
  171. package/sdk/rust/src/keys.rs +0 -161
  172. package/sdk/rust/src/lib.rs +0 -688
  173. package/sdk/rust/src/queue.rs +0 -79
  174. package/sdk/rust/src/webhook.rs +0 -86
  175. package/sdk/rust/tests/conformance.rs +0 -148
  176. package/sdk/rust/tests/gateway.rs +0 -130
  177. package/sdk/rust/tests/http_webhook_queue.rs +0 -201
  178. package/sdk/rust/tests/keys.rs +0 -189
  179. package/src/agentAdapter.test.ts +0 -48
  180. package/src/agentAdapter.ts +0 -56
  181. package/src/auditLog.test.ts +0 -145
  182. package/src/auditLog.ts +0 -147
  183. package/src/conformance.test.ts +0 -136
  184. package/src/conformanceVectors.ts +0 -99
  185. package/src/frameworkAdapters.test.ts +0 -290
  186. package/src/frameworkAdapters.ts +0 -261
  187. package/src/gateway.test.ts +0 -343
  188. package/src/gateway.ts +0 -171
  189. package/src/grpcBinding.test.ts +0 -211
  190. package/src/grpcBinding.ts +0 -103
  191. package/src/httpBinding.test.ts +0 -376
  192. package/src/httpBinding.ts +0 -163
  193. package/src/index.ts +0 -32
  194. package/src/keyInfra.test.ts +0 -278
  195. package/src/keyInfra.ts +0 -228
  196. package/src/keyRegistry.ts +0 -59
  197. package/src/keyRotation.test.ts +0 -78
  198. package/src/keyRotation.ts +0 -72
  199. package/src/mcpGateway.test.ts +0 -129
  200. package/src/mcpGateway.ts +0 -250
  201. package/src/mcpTransports.test.ts +0 -92
  202. package/src/mcpTransports.ts +0 -169
  203. package/src/mcpWrapper.test.ts +0 -179
  204. package/src/mcpWrapper.ts +0 -206
  205. package/src/policyEnforcer.test.ts +0 -99
  206. package/src/policyEnforcer.ts +0 -169
  207. package/src/policyTelemetryFeedback.test.ts +0 -25
  208. package/src/policyTelemetryFeedback.ts +0 -38
  209. package/src/protocol.bench.ts +0 -37
  210. package/src/protocol.test.ts +0 -155
  211. package/src/protocol.ts +0 -413
  212. package/src/protocolAgent.test.ts +0 -105
  213. package/src/protocolAgent.ts +0 -169
  214. package/src/protocolBinary.test.ts +0 -165
  215. package/src/protocolBinary.ts +0 -312
  216. package/src/protocolCapabilities.ts +0 -70
  217. package/src/protocolFuzz.advanced.test.ts +0 -235
  218. package/src/protocolFuzz.test.ts +0 -111
  219. package/src/protocolNegative.test.ts +0 -97
  220. package/src/protocolReplay.test.ts +0 -71
  221. package/src/protocolReplay.ts +0 -194
  222. package/src/protocolTransport.test.ts +0 -556
  223. package/src/protocolTransport.ts +0 -483
  224. package/src/queueBinding.test.ts +0 -130
  225. package/src/queueBinding.ts +0 -102
  226. package/src/rateLimiter.test.ts +0 -96
  227. package/src/rateLimiter.ts +0 -46
  228. package/src/redisIntegration.test.ts +0 -134
  229. package/src/replayStores.test.ts +0 -141
  230. package/src/replayStores.ts +0 -82
  231. package/src/revocation.test.ts +0 -98
  232. package/src/revocation.ts +0 -0
  233. package/src/routePolicy.test.ts +0 -87
  234. package/src/routePolicy.ts +0 -72
  235. package/src/runtimePolicy.test.ts +0 -49
  236. package/src/runtimePolicy.ts +0 -81
  237. package/src/runtimePolicyManager.test.ts +0 -29
  238. package/src/runtimePolicyManager.ts +0 -50
  239. package/src/runtimePolicyPresets.ts +0 -43
  240. package/src/signedResponse.test.ts +0 -111
  241. package/src/signedResponse.ts +0 -83
  242. package/src/webhookBinding.test.ts +0 -144
  243. package/src/webhookBinding.ts +0 -115
  244. package/src/wsBinding.test.ts +0 -221
  245. package/src/wsBinding.ts +0 -100
  246. package/tsconfig.json +0 -15
  247. package/tsconfig.lib.json +0 -23
  248. package/vite.lib.config.ts +0 -16
@@ -1,83 +0,0 @@
1
- import {
2
- createEnvelope,
3
- signEnvelopeEd25519,
4
- verifyEnvelopeEd25519,
5
- type ProtocolEnvelope,
6
- } from './protocol'
7
-
8
- export const RESPONSE_HEADER = 'x-7h3-response'
9
-
10
- export async function signResponse(
11
- body: string,
12
- opts: {
13
- privateKey: string
14
- sender: string
15
- recipient?: string
16
- correlationId?: string
17
- ttlMs?: number
18
- },
19
- ): Promise<{ headers: { 'x-7h3-response': string } }> {
20
- const envelope = createEnvelope({
21
- sender: opts.sender,
22
- recipient: opts.recipient,
23
- intent: 'RESULT',
24
- content: body,
25
- correlationId: opts.correlationId,
26
- ttlMs: opts.ttlMs ?? 60_000,
27
- })
28
-
29
- const signed = await signEnvelopeEd25519(envelope, opts.privateKey)
30
-
31
- return {
32
- headers: {
33
- [RESPONSE_HEADER]: JSON.stringify(signed),
34
- },
35
- }
36
- }
37
-
38
- export async function verifyResponse(
39
- body: string,
40
- headers: Record<string, string | string[] | undefined>,
41
- opts: {
42
- publicKey: string
43
- maxAgeMs?: number
44
- },
45
- ): Promise<{ ok: boolean; envelope?: ProtocolEnvelope; reason?: string }> {
46
- const raw = headers[RESPONSE_HEADER]
47
- const rawStr = Array.isArray(raw) ? raw[0] : raw
48
- if (!rawStr) {
49
- return { ok: false, reason: 'missing-header' }
50
- }
51
-
52
- let envelope: ProtocolEnvelope
53
- try {
54
- envelope = JSON.parse(rawStr) as ProtocolEnvelope
55
- } catch {
56
- return { ok: false, reason: 'malformed-envelope' }
57
- }
58
-
59
- // Check TTL from envelope
60
- const nowMs = Date.now()
61
- const { timestampMs, ttlMs } = envelope.header
62
- if (timestampMs + ttlMs < nowMs) {
63
- return { ok: false, reason: 'ttl-expired', envelope }
64
- }
65
-
66
- // Check maxAgeMs if provided
67
- if (opts.maxAgeMs !== undefined && nowMs - timestampMs > opts.maxAgeMs) {
68
- return { ok: false, reason: 'ttl-expired', envelope }
69
- }
70
-
71
- // Verify signature
72
- const valid = await verifyEnvelopeEd25519(envelope, opts.publicKey)
73
- if (!valid) {
74
- return { ok: false, reason: 'invalid-signature', envelope }
75
- }
76
-
77
- // Verify body matches envelope content
78
- if (envelope.body.content !== body) {
79
- return { ok: false, reason: 'content-mismatch', envelope }
80
- }
81
-
82
- return { ok: true, envelope }
83
- }
@@ -1,144 +0,0 @@
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
- })
@@ -1,115 +0,0 @@
1
- import {
2
- signCanonicalPayloadEd25519,
3
- verifyCanonicalPayloadEd25519,
4
- signCanonicalPayloadHmac,
5
- verifyCanonicalPayloadHmac,
6
- generateEd25519KeypairBase64Url,
7
- } from './protocol'
8
-
9
- export const WEBHOOK_SIG_HEADER = 'x-7h3-sig'
10
- export const WEBHOOK_TS_HEADER = 'x-7h3-ts'
11
- export const WEBHOOK_DEFAULT_TTL_MS = 300_000 // 5 minutes
12
-
13
- // What gets signed: "${timestampMs}.${rawBody}" — binds time AND content
14
- function webhookSigningPayload(timestampMs: number, body: string): string {
15
- return `${timestampMs}.${body}`
16
- }
17
-
18
- export interface WebhookSignOptions {
19
- privateKey: string // Ed25519 PKCS8 base64url
20
- ttlMs?: number // default 5 min
21
- }
22
-
23
- export interface WebhookSignHmacOptions {
24
- secret: string
25
- ttlMs?: number
26
- }
27
-
28
- export interface WebhookVerifyOptions {
29
- publicKey: string // Ed25519 SPKI base64url
30
- maxAgeMs?: number // default 5 min
31
- }
32
-
33
- export interface WebhookVerifyHmacOptions {
34
- secret: string
35
- maxAgeMs?: number
36
- }
37
-
38
- export interface WebhookHeaders {
39
- [WEBHOOK_SIG_HEADER]: string
40
- [WEBHOOK_TS_HEADER]: string
41
- }
42
-
43
- // Sign a webhook payload with Ed25519
44
- export async function signWebhook(
45
- payload: string | Uint8Array,
46
- opts: WebhookSignOptions
47
- ): Promise<WebhookHeaders> {
48
- const body = typeof payload === 'string' ? payload : new TextDecoder().decode(payload)
49
- const timestampMs = Date.now()
50
- const signingPayload = webhookSigningPayload(timestampMs, body)
51
- const sig = await signCanonicalPayloadEd25519(signingPayload, opts.privateKey)
52
- return { [WEBHOOK_SIG_HEADER]: sig, [WEBHOOK_TS_HEADER]: String(timestampMs) }
53
- }
54
-
55
- // Sign with HMAC shared secret
56
- export async function signWebhookHmac(
57
- payload: string | Uint8Array,
58
- opts: WebhookSignHmacOptions
59
- ): Promise<WebhookHeaders> {
60
- const body = typeof payload === 'string' ? payload : new TextDecoder().decode(payload)
61
- const timestampMs = Date.now()
62
- const signingPayload = webhookSigningPayload(timestampMs, body)
63
- const sig = await signCanonicalPayloadHmac(signingPayload, opts.secret)
64
- return { [WEBHOOK_SIG_HEADER]: sig, [WEBHOOK_TS_HEADER]: String(timestampMs) }
65
- }
66
-
67
- // Verify Ed25519 webhook signature
68
- export async function verifyWebhook(
69
- payload: string | Uint8Array,
70
- headers: WebhookHeaders | Record<string, string>,
71
- opts: WebhookVerifyOptions
72
- ): Promise<boolean> {
73
- const body = typeof payload === 'string' ? payload : new TextDecoder().decode(payload)
74
- const sig = headers[WEBHOOK_SIG_HEADER]
75
- const tsStr = headers[WEBHOOK_TS_HEADER]
76
- if (!sig || !tsStr) return false
77
- const ts = Number(tsStr)
78
- if (!Number.isFinite(ts)) return false
79
- const maxAge = opts.maxAgeMs ?? WEBHOOK_DEFAULT_TTL_MS
80
- if (Date.now() - ts > maxAge) return false
81
- const signingPayload = webhookSigningPayload(ts, body)
82
- return verifyCanonicalPayloadEd25519(signingPayload, sig, opts.publicKey)
83
- }
84
-
85
- // Verify HMAC webhook signature
86
- export async function verifyWebhookHmac(
87
- payload: string | Uint8Array,
88
- headers: WebhookHeaders | Record<string, string>,
89
- opts: WebhookVerifyHmacOptions
90
- ): Promise<boolean> {
91
- const body = typeof payload === 'string' ? payload : new TextDecoder().decode(payload)
92
- const sig = headers[WEBHOOK_SIG_HEADER]
93
- const tsStr = headers[WEBHOOK_TS_HEADER]
94
- if (!sig || !tsStr) return false
95
- const ts = Number(tsStr)
96
- if (!Number.isFinite(ts)) return false
97
- const maxAge = opts.maxAgeMs ?? WEBHOOK_DEFAULT_TTL_MS
98
- if (Date.now() - ts > maxAge) return false
99
- const signingPayload = webhookSigningPayload(ts, body)
100
- return verifyCanonicalPayloadHmac(signingPayload, sig, opts.secret)
101
- }
102
-
103
- // Parse and verify in one call, throws on failure
104
- export async function consumeWebhook<T = unknown>(
105
- payload: string,
106
- headers: Record<string, string>,
107
- opts: WebhookVerifyOptions
108
- ): Promise<T> {
109
- const valid = await verifyWebhook(payload, headers, opts)
110
- if (!valid) throw new Error('7h3: webhook signature verification failed')
111
- return JSON.parse(payload) as T
112
- }
113
-
114
- // Re-export key generation for convenience
115
- export { generateEd25519KeypairBase64Url }
@@ -1,221 +0,0 @@
1
- import { describe, it, expect, vi } from 'vitest'
2
- import { wrapWebSocket, generateEd25519KeypairBase64Url, type WebSocketLike } from './wsBinding'
3
- import { signEnvelopeEd25519, createEnvelope, type ProtocolEnvelope } from './protocol'
4
- import { createStaticKeyRegistry } from './keyRegistry'
5
-
6
- // Mock WebSocket class that buffers sent messages and lets you inject received messages
7
- class MockWebSocket implements WebSocketLike {
8
- public sent: string[] = []
9
- private messageHandlers: Array<(e: { data: string }) => void> = []
10
- private closeHandlers: Array<() => void> = []
11
- readyState = 1
12
-
13
- send(data: string): void {
14
- this.sent.push(data)
15
- }
16
-
17
- addEventListener(event: string, handler: (...args: any[]) => void): void {
18
- if (event === 'message') {
19
- this.messageHandlers.push(handler as (e: { data: string }) => void)
20
- } else if (event === 'close') {
21
- this.closeHandlers.push(handler as () => void)
22
- }
23
- }
24
-
25
- removeEventListener(event: string, handler: (...args: unknown[]) => void): void {
26
- if (event === 'message') {
27
- const idx = this.messageHandlers.indexOf(handler as any)
28
- if (idx !== -1) this.messageHandlers.splice(idx, 1)
29
- } else if (event === 'close') {
30
- const idx = this.closeHandlers.indexOf(handler as any)
31
- if (idx !== -1) this.closeHandlers.splice(idx, 1)
32
- }
33
- }
34
-
35
- // Inject a received message
36
- receive(data: string): void {
37
- for (const h of this.messageHandlers) h({ data })
38
- }
39
-
40
- close(): void {
41
- for (const h of this.closeHandlers) h()
42
- }
43
- }
44
-
45
- describe('wrapWebSocket', () => {
46
- it('send() produces a signed JSON frame', async () => {
47
- const keypair = await generateEd25519KeypairBase64Url()
48
- const ws = new MockWebSocket()
49
- const registry = createStaticKeyRegistry({ 'agent-A': keypair.publicKey })
50
-
51
- const pws = wrapWebSocket(ws, {
52
- privateKey: keypair.privateKey,
53
- sender: 'agent-A',
54
- keyRegistry: registry,
55
- })
56
-
57
- await pws.send({ hello: 'world' })
58
-
59
- expect(ws.sent).toHaveLength(1)
60
- const frame = JSON.parse(ws.sent[0]) as ProtocolEnvelope
61
- expect(frame.header.sender).toBe('agent-A')
62
- expect(frame.signature).toBeDefined()
63
- expect(frame.signature?.alg).toBe('ED25519')
64
- expect(frame.body.intent).toBe('TASK')
65
- expect(frame.body.content).toBe(JSON.stringify({ hello: 'world' }))
66
- })
67
-
68
- it('incoming signed frame calls onMessage handler', async () => {
69
- const keypair = await generateEd25519KeypairBase64Url()
70
- const ws = new MockWebSocket()
71
- const registry = createStaticKeyRegistry({ 'agent-B': keypair.publicKey })
72
-
73
- const pws = wrapWebSocket(ws, {
74
- privateKey: keypair.privateKey,
75
- sender: 'agent-A',
76
- keyRegistry: registry,
77
- })
78
-
79
- const received: Array<{ payload: unknown; envelope: ProtocolEnvelope }> = []
80
- pws.onMessage((payload, envelope) => received.push({ payload, envelope }))
81
-
82
- // Create a valid signed frame from agent-B
83
- const envelope = createEnvelope({
84
- sender: 'agent-B',
85
- intent: 'TASK',
86
- content: JSON.stringify({ ping: true }),
87
- ttlMs: 30_000,
88
- })
89
- const signed = await signEnvelopeEd25519(envelope, keypair.privateKey)
90
-
91
- // Wait for async message processing
92
- await new Promise<void>(resolve => {
93
- pws.onMessage(() => resolve())
94
- ws.receive(JSON.stringify(signed))
95
- })
96
-
97
- expect(received).toHaveLength(1)
98
- expect(received[0].payload).toEqual({ ping: true })
99
- expect(received[0].envelope.header.sender).toBe('agent-B')
100
- })
101
-
102
- it('tampered frame calls onVerifyFail', async () => {
103
- const keypair = await generateEd25519KeypairBase64Url()
104
- const ws = new MockWebSocket()
105
- const registry = createStaticKeyRegistry({ 'agent-B': keypair.publicKey })
106
-
107
- const pws = wrapWebSocket(ws, {
108
- privateKey: keypair.privateKey,
109
- sender: 'agent-A',
110
- keyRegistry: registry,
111
- })
112
-
113
- const errors: Error[] = []
114
- pws.onVerifyFail((err) => errors.push(err))
115
-
116
- // Create a valid signed frame, then tamper with body content
117
- const envelope = createEnvelope({
118
- sender: 'agent-B',
119
- intent: 'TASK',
120
- content: 'original content',
121
- ttlMs: 30_000,
122
- })
123
- const signed = await signEnvelopeEd25519(envelope, keypair.privateKey)
124
- // Tamper with content after signing
125
- const tampered = { ...signed, body: { ...signed.body, content: 'tampered content' } }
126
-
127
- await new Promise<void>(resolve => {
128
- pws.onVerifyFail(() => resolve())
129
- ws.receive(JSON.stringify(tampered))
130
- })
131
-
132
- expect(errors).toHaveLength(1)
133
- expect(errors[0].message).toContain('invalid signature')
134
- })
135
-
136
- it('unknown sender calls onVerifyFail', async () => {
137
- const keypair = await generateEd25519KeypairBase64Url()
138
- const ws = new MockWebSocket()
139
- // Registry has no entry for 'unknown-agent'
140
- const registry = createStaticKeyRegistry({})
141
-
142
- const pws = wrapWebSocket(ws, {
143
- privateKey: keypair.privateKey,
144
- sender: 'agent-A',
145
- keyRegistry: registry,
146
- })
147
-
148
- const errors: Error[] = []
149
- pws.onVerifyFail((err) => errors.push(err))
150
-
151
- const envelope = createEnvelope({
152
- sender: 'unknown-agent',
153
- intent: 'TASK',
154
- content: 'hello',
155
- ttlMs: 30_000,
156
- })
157
- const signed = await signEnvelopeEd25519(envelope, keypair.privateKey)
158
-
159
- await new Promise<void>(resolve => {
160
- pws.onVerifyFail(() => resolve())
161
- ws.receive(JSON.stringify(signed))
162
- })
163
-
164
- expect(errors).toHaveLength(1)
165
- expect(errors[0].message).toContain('unknown sender')
166
- })
167
-
168
- it('malformed JSON calls onVerifyFail', async () => {
169
- const keypair = await generateEd25519KeypairBase64Url()
170
- const ws = new MockWebSocket()
171
- const registry = createStaticKeyRegistry({})
172
-
173
- const pws = wrapWebSocket(ws, {
174
- privateKey: keypair.privateKey,
175
- sender: 'agent-A',
176
- keyRegistry: registry,
177
- })
178
-
179
- const errors: Error[] = []
180
- pws.onVerifyFail((err) => errors.push(err))
181
-
182
- await new Promise<void>(resolve => {
183
- pws.onVerifyFail(() => resolve())
184
- ws.receive('this is not valid JSON {{{')
185
- })
186
-
187
- expect(errors).toHaveLength(1)
188
- expect(errors[0].message).toContain('malformed frame')
189
- })
190
-
191
- it('seq increments on each send', async () => {
192
- const keypair = await generateEd25519KeypairBase64Url()
193
- const ws = new MockWebSocket()
194
- const registry = createStaticKeyRegistry({ 'agent-A': keypair.publicKey })
195
-
196
- const pws = wrapWebSocket(ws, {
197
- privateKey: keypair.privateKey,
198
- sender: 'agent-A',
199
- keyRegistry: registry,
200
- })
201
-
202
- expect(pws.seq).toBe(0)
203
-
204
- await pws.send('first')
205
- expect(pws.seq).toBe(1)
206
-
207
- await pws.send('second')
208
- expect(pws.seq).toBe(2)
209
-
210
- await pws.send('third')
211
- expect(pws.seq).toBe(3)
212
-
213
- // Verify correlationId carries the seq number
214
- const frame1 = JSON.parse(ws.sent[0]) as ProtocolEnvelope
215
- const frame2 = JSON.parse(ws.sent[1]) as ProtocolEnvelope
216
- const frame3 = JSON.parse(ws.sent[2]) as ProtocolEnvelope
217
- expect(frame1.body.correlationId).toBe('1')
218
- expect(frame2.body.correlationId).toBe('2')
219
- expect(frame3.body.correlationId).toBe('3')
220
- })
221
- })
package/src/wsBinding.ts DELETED
@@ -1,100 +0,0 @@
1
- import {
2
- signEnvelopeEd25519, verifyEnvelopeEd25519,
3
- createEnvelope, validateEnvelope,
4
- generateEd25519KeypairBase64Url, type ProtocolEnvelope
5
- } from './protocol'
6
- import type { KeyRegistry } from './keyRegistry'
7
-
8
- export { type KeyRegistry, generateEd25519KeypairBase64Url }
9
-
10
- // Minimal WebSocket interface (works with browser WebSocket, ws library, etc.)
11
- export interface WebSocketLike {
12
- send(data: string): void
13
- addEventListener(event: 'message', handler: (e: { data: string | Buffer }) => void): void
14
- addEventListener(event: 'close', handler: () => void): void
15
- removeEventListener(event: string, handler: (...args: unknown[]) => void): void
16
- readyState?: number
17
- }
18
-
19
- export interface WsBindingOptions {
20
- privateKey: string
21
- sender: string
22
- recipient?: string
23
- keyRegistry: KeyRegistry // to look up peer public keys by sender ID
24
- ttlMs?: number // per-frame TTL, default 30_000
25
- onVerifyFail?: (err: Error, rawData: string) => void
26
- }
27
-
28
- export interface ProtectedWebSocket {
29
- // Send a payload — automatically signs it
30
- send(payload: unknown): Promise<void>
31
- // Register handler for verified incoming messages
32
- onMessage(handler: (payload: unknown, envelope: ProtocolEnvelope) => void): void
33
- // Register handler for verify failures (optional)
34
- onVerifyFail(handler: (err: Error, rawData: string) => void): void
35
- // Sequence number of last sent message
36
- readonly seq: number
37
- }
38
-
39
- export function wrapWebSocket(ws: WebSocketLike, opts: WsBindingOptions): ProtectedWebSocket {
40
- let seq = 0
41
- const messageHandlers: Array<(payload: unknown, envelope: ProtocolEnvelope) => void> = []
42
- const failHandlers: Array<(err: Error, rawData: string) => void> = []
43
-
44
- function fireVerifyFail(err: Error, raw: string) {
45
- opts.onVerifyFail?.(err, raw)
46
- for (const h of failHandlers) h(err, raw)
47
- }
48
-
49
- // Listen for incoming frames
50
- const messageListener = async (e: { data: string | Buffer }) => {
51
- const raw = typeof e.data === 'string' ? e.data : e.data.toString('utf8')
52
- let envelope: ProtocolEnvelope
53
- try { envelope = JSON.parse(raw) as ProtocolEnvelope }
54
- catch (err) { fireVerifyFail(new Error('malformed frame'), raw); return }
55
-
56
- const sender = envelope?.header?.sender
57
- if (!sender) { fireVerifyFail(new Error('missing sender'), raw); return }
58
-
59
- const publicKey = await opts.keyRegistry.getPublicKey(sender)
60
- if (!publicKey) { fireVerifyFail(new Error(`unknown sender: ${sender}`), raw); return }
61
-
62
- const valid = await verifyEnvelopeEd25519(envelope, publicKey).catch(() => false)
63
- if (!valid) { fireVerifyFail(new Error('invalid signature'), raw); return }
64
-
65
- const diags = validateEnvelope(envelope)
66
- if (diags.some(d => d.level === 'error')) {
67
- fireVerifyFail(new Error(`envelope invalid: ${diags.map(d => d.message).join('; ')}`), raw)
68
- return
69
- }
70
-
71
- let payload: unknown = envelope.body.content
72
- try { payload = JSON.parse(envelope.body.content) } catch { /* keep as string */ }
73
- for (const h of messageHandlers) h(payload, envelope)
74
- }
75
-
76
- ws.addEventListener('message', messageListener as any)
77
- ws.addEventListener('close', () => {
78
- ws.removeEventListener('message', messageListener as any)
79
- })
80
-
81
- return {
82
- get seq() { return seq },
83
- async send(payload: unknown): Promise<void> {
84
- const content = typeof payload === 'string' ? payload : JSON.stringify(payload)
85
- const envelope = createEnvelope({
86
- sender: opts.sender,
87
- recipient: opts.recipient,
88
- ttlMs: opts.ttlMs ?? 30_000,
89
- intent: 'TASK',
90
- content,
91
- })
92
- // embed sequence number in correlationId to help downstream ordering
93
- ;(envelope.body as any).correlationId = String(++seq)
94
- const signed = await signEnvelopeEd25519(envelope, opts.privateKey)
95
- ws.send(JSON.stringify(signed))
96
- },
97
- onMessage(handler) { messageHandlers.push(handler) },
98
- onVerifyFail(handler) { failHandlers.push(handler) },
99
- }
100
- }
package/tsconfig.json DELETED
@@ -1,15 +0,0 @@
1
- {
2
- "compilerOptions": {
3
- "target": "ES2022",
4
- "module": "ESNext",
5
- "moduleResolution": "bundler",
6
- "lib": ["ES2023", "DOM"],
7
- "types": ["node"],
8
- "strict": true,
9
- "skipLibCheck": true,
10
- "noEmit": true,
11
- "esModuleInterop": true,
12
- "verbatimModuleSyntax": false
13
- },
14
- "include": ["src/**/*.ts", "scripts/**/*.ts"]
15
- }