@7h3/protocol 0.5.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 (294) hide show
  1. package/README.md +6 -1317
  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 -121
  23. package/policyEnforcer.d.ts +50 -0
  24. package/policyTelemetryFeedback.d.ts +11 -0
  25. package/{src/protocol.d.ts → protocol.d.ts} +1 -2
  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 -152
  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 -406
  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-github.png +0 -0
  115. package/docs/assets/banner.png +0 -0
  116. package/docs/assets/banner.svg +0 -123
  117. package/eslint.config.js +0 -15
  118. package/fuzz/ts/harness-decode.ts +0 -136
  119. package/fuzz/ts/harness-verify.ts +0 -121
  120. package/fuzz/ts/run.ts +0 -35
  121. package/mcp-server/README.md +0 -38
  122. package/mcp-server/package-lock.json +0 -1187
  123. package/mcp-server/package.json +0 -35
  124. package/mcp-server/src/index.ts +0 -236
  125. package/mcp-server/tsconfig.json +0 -14
  126. package/scripts/aip-framework-quickstart.ts +0 -110
  127. package/scripts/aip-mcp-gateway.ts +0 -38
  128. package/scripts/aip-mcp-wrap-demo.ts +0 -72
  129. package/scripts/aip-quickstart.ts +0 -60
  130. package/scripts/bench-diff.ts +0 -118
  131. package/scripts/bench-protocol-e2e.ts +0 -937
  132. package/scripts/bench-protocol-openloop.ts +0 -1397
  133. package/scripts/bench-replay-cache.ts +0 -76
  134. package/scripts/bench-signature-profiles.ts +0 -180
  135. package/scripts/bench-wire-codecs.ts +0 -161
  136. package/scripts/build-binary-conformance.ts +0 -36
  137. package/scripts/build-release-dashboard.ts +0 -175
  138. package/scripts/canary-rollout.ts +0 -38
  139. package/scripts/mcpGatewayCli.test.ts +0 -116
  140. package/scripts/prepare-aip-package.ts +0 -88
  141. package/scripts/regen-conformance-sigs.ts +0 -18
  142. package/scripts/release-gate.ts +0 -19
  143. package/scripts/validate-runtime-policy.ts +0 -18
  144. package/sdk/browser/index.test.ts +0 -162
  145. package/sdk/browser/index.ts +0 -257
  146. package/sdk/browser/package.json +0 -13
  147. package/sdk/go/cbor.go +0 -551
  148. package/sdk/go/cbor_test.go +0 -232
  149. package/sdk/go/encryption.go +0 -280
  150. package/sdk/go/encryption_test.go +0 -318
  151. package/sdk/go/go.mod +0 -7
  152. package/sdk/go/go.sum +0 -4
  153. package/sdk/go/http.go +0 -135
  154. package/sdk/go/protocol.go +0 -324
  155. package/sdk/go/protocol_test.go +0 -334
  156. package/sdk/go/replay.go +0 -121
  157. package/sdk/go/replay_test.go +0 -149
  158. package/sdk/go/webhook.go +0 -136
  159. package/sdk/pq/package-lock.json +0 -1358
  160. package/sdk/pq/package.json +0 -42
  161. package/sdk/pq/src/index.test.ts +0 -143
  162. package/sdk/pq/src/index.ts +0 -166
  163. package/sdk/pq/tsconfig.json +0 -14
  164. package/sdk/pq/vitest.config.ts +0 -7
  165. package/sdk/python/README.md +0 -18
  166. package/sdk/python/protocol_7h3/__init__.py +0 -46
  167. package/sdk/python/protocol_7h3/encryption.py +0 -252
  168. package/sdk/python/protocol_7h3/http.py +0 -212
  169. package/sdk/python/protocol_7h3/keys.py +0 -149
  170. package/sdk/python/protocol_7h3/pq.py +0 -244
  171. package/sdk/python/protocol_7h3/protocol.py +0 -525
  172. package/sdk/python/protocol_7h3/queue.py +0 -118
  173. package/sdk/python/protocol_7h3/replay.py +0 -98
  174. package/sdk/python/protocol_7h3/webhook.py +0 -116
  175. package/sdk/python/pyproject.toml +0 -40
  176. package/sdk/python/tests/test_conformance.py +0 -110
  177. package/sdk/python/tests/test_encryption.py +0 -206
  178. package/sdk/python/tests/test_http.py +0 -305
  179. package/sdk/python/tests/test_keys.py +0 -417
  180. package/sdk/python/tests/test_queue.py +0 -120
  181. package/sdk/python/tests/test_webhook.py +0 -345
  182. package/sdk/rust/Cargo.lock +0 -371
  183. package/sdk/rust/Cargo.toml +0 -25
  184. package/sdk/rust/README.md +0 -31
  185. package/sdk/rust/fuzz/Cargo.toml +0 -29
  186. package/sdk/rust/fuzz/fuzz_targets/fuzz_canonicalize.rs +0 -46
  187. package/sdk/rust/fuzz/fuzz_targets/fuzz_decode.rs +0 -11
  188. package/sdk/rust/src/bin/aip_mcp_gateway.rs +0 -59
  189. package/sdk/rust/src/http.rs +0 -145
  190. package/sdk/rust/src/keys.rs +0 -161
  191. package/sdk/rust/src/lib.rs +0 -688
  192. package/sdk/rust/src/queue.rs +0 -79
  193. package/sdk/rust/src/webhook.rs +0 -86
  194. package/sdk/rust/tests/conformance.rs +0 -148
  195. package/sdk/rust/tests/gateway.rs +0 -130
  196. package/sdk/rust/tests/http_webhook_queue.rs +0 -201
  197. package/sdk/rust/tests/keys.rs +0 -189
  198. package/sdk/threshold/index.d.ts +0 -68
  199. package/sdk/threshold/index.d.ts.map +0 -1
  200. package/sdk/threshold/index.js +0 -254
  201. package/sdk/threshold/package-lock.json +0 -1361
  202. package/sdk/threshold/package.json +0 -39
  203. package/sdk/threshold/src/index.d.ts +0 -68
  204. package/sdk/threshold/src/index.d.ts.map +0 -1
  205. package/sdk/threshold/src/index.js +0 -254
  206. package/sdk/threshold/src/index.test.ts +0 -238
  207. package/sdk/threshold/src/index.ts +0 -355
  208. package/sdk/threshold/tsconfig.json +0 -19
  209. package/sdk/threshold/vitest.config.ts +0 -12
  210. package/src/agentAdapter.test.ts +0 -48
  211. package/src/agentAdapter.ts +0 -56
  212. package/src/auditLog.test.ts +0 -145
  213. package/src/auditLog.ts +0 -147
  214. package/src/capability.test.ts +0 -504
  215. package/src/capability.ts +0 -380
  216. package/src/cborCodec.test.ts +0 -263
  217. package/src/cborCodec.ts +0 -339
  218. package/src/conformance.test.ts +0 -136
  219. package/src/conformanceVectors.ts +0 -99
  220. package/src/encryption.test.ts +0 -206
  221. package/src/encryption.ts +0 -245
  222. package/src/envelopeCbor.ts +0 -140
  223. package/src/frameworkAdapters.test.ts +0 -290
  224. package/src/frameworkAdapters.ts +0 -261
  225. package/src/gateway.test.ts +0 -343
  226. package/src/gateway.ts +0 -246
  227. package/src/grpcBinding.test.ts +0 -211
  228. package/src/grpcBinding.ts +0 -103
  229. package/src/httpBinding.test.ts +0 -376
  230. package/src/httpBinding.ts +0 -189
  231. package/src/index.ts +0 -39
  232. package/src/keyInfra.test.ts +0 -278
  233. package/src/keyInfra.ts +0 -228
  234. package/src/keyRegistry.ts +0 -59
  235. package/src/keyRotation.test.ts +0 -78
  236. package/src/keyRotation.ts +0 -72
  237. package/src/mcpGateway.test.ts +0 -129
  238. package/src/mcpGateway.ts +0 -250
  239. package/src/mcpTransports.test.ts +0 -92
  240. package/src/mcpTransports.ts +0 -169
  241. package/src/mcpWrapper.test.ts +0 -179
  242. package/src/mcpWrapper.ts +0 -206
  243. package/src/otel.ts +0 -136
  244. package/src/policyEnforcer.test.ts +0 -99
  245. package/src/policyEnforcer.ts +0 -169
  246. package/src/policyTelemetryFeedback.test.ts +0 -25
  247. package/src/policyTelemetryFeedback.ts +0 -38
  248. package/src/protocol.bench.ts +0 -37
  249. package/src/protocol.d.ts.map +0 -1
  250. package/src/protocol.js +0 -294
  251. package/src/protocol.test.ts +0 -155
  252. package/src/protocol.ts +0 -414
  253. package/src/protocolAgent.test.ts +0 -105
  254. package/src/protocolAgent.ts +0 -169
  255. package/src/protocolBinary.test.ts +0 -165
  256. package/src/protocolBinary.ts +0 -312
  257. package/src/protocolCapabilities.ts +0 -70
  258. package/src/protocolFuzz.advanced.test.ts +0 -235
  259. package/src/protocolFuzz.test.ts +0 -111
  260. package/src/protocolNegative.test.ts +0 -97
  261. package/src/protocolReplay.test.ts +0 -71
  262. package/src/protocolReplay.ts +0 -194
  263. package/src/protocolTransport.test.ts +0 -556
  264. package/src/protocolTransport.ts +0 -483
  265. package/src/queueBinding.test.ts +0 -130
  266. package/src/queueBinding.ts +0 -102
  267. package/src/rateLimiter.test.ts +0 -96
  268. package/src/rateLimiter.ts +0 -46
  269. package/src/redisIntegration.test.ts +0 -134
  270. package/src/replayStores.test.ts +0 -273
  271. package/src/replayStores.ts +0 -215
  272. package/src/revocation.test.ts +0 -98
  273. package/src/revocation.ts +0 -0
  274. package/src/routePolicy.test.ts +0 -87
  275. package/src/routePolicy.ts +0 -72
  276. package/src/runtimePolicy.test.ts +0 -49
  277. package/src/runtimePolicy.ts +0 -81
  278. package/src/runtimePolicyManager.test.ts +0 -29
  279. package/src/runtimePolicyManager.ts +0 -50
  280. package/src/runtimePolicyPresets.ts +0 -43
  281. package/src/signedResponse.test.ts +0 -111
  282. package/src/signedResponse.ts +0 -83
  283. package/src/stream.test.ts +0 -254
  284. package/src/stream.ts +0 -417
  285. package/src/telemetry.test.ts +0 -251
  286. package/src/telemetry.ts +0 -299
  287. package/src/webhookBinding.test.ts +0 -144
  288. package/src/webhookBinding.ts +0 -115
  289. package/src/wsBinding.test.ts +0 -221
  290. package/src/wsBinding.ts +0 -200
  291. package/tsconfig.json +0 -15
  292. package/tsconfig.lib.json +0 -23
  293. package/vite.lib.config.ts +0 -16
  294. package/vitest.config.ts +0 -11
@@ -1,211 +0,0 @@
1
- import { describe, it, expect, vi } from 'vitest'
2
- import {
3
- signGrpcCall,
4
- verifyGrpcCall,
5
- withGrpcVerification,
6
- GRPC_METADATA_KEY,
7
- } from './grpcBinding'
8
- import { createStaticKeyRegistry, type KeyRegistry } from './keyRegistry'
9
- import {
10
- generateEd25519KeypairBase64Url,
11
- createEnvelope,
12
- signEnvelopeEd25519,
13
- type ProtocolEnvelope,
14
- } from './protocol'
15
-
16
- // Helper: build a KeyRegistry that holds HMAC shared secrets but no public keys
17
- function createHmacKeyRegistry(secrets: Record<string, string>): KeyRegistry {
18
- return {
19
- async getPublicKey() { return null },
20
- async getSharedSecret(keyId) { return secrets[keyId] ?? null },
21
- }
22
- }
23
-
24
- describe('signGrpcCall', () => {
25
- it('produces metadata with the correct key', async () => {
26
- const { privateKey } = await generateEd25519KeypairBase64Url()
27
- const sender = 'grpc-client-agent'
28
-
29
- const metadata = await signGrpcCall({ privateKey, sender })
30
-
31
- expect(metadata[GRPC_METADATA_KEY]).toBeDefined()
32
- expect(typeof metadata[GRPC_METADATA_KEY]).toBe('string')
33
-
34
- // Parse and validate structure
35
- const parsed = JSON.parse(metadata[GRPC_METADATA_KEY]) as ProtocolEnvelope
36
- expect(parsed.header.sender).toBe(sender)
37
- expect(parsed.signature?.alg).toBe('ED25519')
38
- })
39
-
40
- it('uses a custom metadataKey when provided', async () => {
41
- const { privateKey } = await generateEd25519KeypairBase64Url()
42
- const customKey = 'x-custom-grpc-sig'
43
-
44
- const metadata = await signGrpcCall({ privateKey, sender: 'agent-x', metadataKey: customKey })
45
-
46
- expect(metadata[customKey]).toBeDefined()
47
- expect(metadata[GRPC_METADATA_KEY]).toBeUndefined()
48
- })
49
- })
50
-
51
- describe('verifyGrpcCall', () => {
52
- it('valid signed call returns ok:true with envelope', async () => {
53
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
54
- const sender = 'grpc-server-agent'
55
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
56
-
57
- const metadata = await signGrpcCall({ privateKey, sender })
58
- const result = await verifyGrpcCall(metadata, { keyRegistry: registry })
59
-
60
- expect(result.ok).toBe(true)
61
- if (result.ok) {
62
- expect(result.envelope.header.sender).toBe(sender)
63
- expect(result.envelope.body.intent).toBe('TASK')
64
- }
65
- })
66
-
67
- it('missing metadata returns ok:false with code 16', async () => {
68
- const registry = createStaticKeyRegistry({})
69
- const result = await verifyGrpcCall({}, { keyRegistry: registry })
70
-
71
- expect(result.ok).toBe(false)
72
- if (!result.ok) {
73
- expect(result.code).toBe(16)
74
- expect(result.message).toContain('missing')
75
- }
76
- })
77
-
78
- it('tampered envelope returns ok:false with code 16', async () => {
79
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
80
- const sender = 'grpc-tamper-agent'
81
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
82
-
83
- const env = createEnvelope({ sender, intent: 'TASK', content: 'original', ttlMs: 60_000 })
84
- const signed = await signEnvelopeEd25519(env, privateKey)
85
-
86
- // Tamper with content after signing
87
- const tampered: ProtocolEnvelope = {
88
- ...signed,
89
- body: { ...signed.body, content: 'tampered' },
90
- }
91
- const metadata = { [GRPC_METADATA_KEY]: JSON.stringify(tampered) }
92
-
93
- const result = await verifyGrpcCall(metadata, { keyRegistry: registry })
94
-
95
- expect(result.ok).toBe(false)
96
- if (!result.ok) {
97
- expect(result.code).toBe(16)
98
- }
99
- })
100
-
101
- it('expired envelope returns ok:false with code 4', async () => {
102
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
103
- const sender = 'grpc-expired-agent'
104
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
105
-
106
- const pastNow = Date.now() - 120_000 // 2 minutes ago
107
- const env = createEnvelope({
108
- sender,
109
- intent: 'TASK',
110
- content: 'expired-task',
111
- ttlMs: 1_000, // 1 second TTL — already expired
112
- nowMs: pastNow,
113
- })
114
- const signed = await signEnvelopeEd25519(env, privateKey)
115
- const metadata = { [GRPC_METADATA_KEY]: JSON.stringify(signed) }
116
-
117
- const result = await verifyGrpcCall(metadata, { keyRegistry: registry, strictTtl: true })
118
-
119
- expect(result.ok).toBe(false)
120
- if (!result.ok) {
121
- expect(result.code).toBe(4)
122
- }
123
- })
124
-
125
- it('unknown sender returns ok:false with code 16', async () => {
126
- const { privateKey } = await generateEd25519KeypairBase64Url()
127
- const registry = createStaticKeyRegistry({}) // empty registry
128
-
129
- const env = createEnvelope({ sender: 'unknown-grpc-agent', intent: 'TASK', content: 'hi', ttlMs: 60_000 })
130
- const signed = await signEnvelopeEd25519(env, privateKey)
131
- const metadata = { [GRPC_METADATA_KEY]: JSON.stringify(signed) }
132
-
133
- const result = await verifyGrpcCall(metadata, { keyRegistry: registry })
134
-
135
- expect(result.ok).toBe(false)
136
- if (!result.ok) {
137
- expect(result.code).toBe(16)
138
- expect(result.message).toContain('unknown-grpc-agent')
139
- }
140
- })
141
-
142
- it('accepts Buffer values in metadata', async () => {
143
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
144
- const sender = 'grpc-buffer-agent'
145
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
146
-
147
- const env = createEnvelope({ sender, intent: 'TASK', content: 'buf-test', ttlMs: 60_000 })
148
- const signed = await signEnvelopeEd25519(env, privateKey)
149
- const metadata: Record<string, Buffer> = {
150
- [GRPC_METADATA_KEY]: Buffer.from(JSON.stringify(signed), 'utf8'),
151
- }
152
-
153
- const result = await verifyGrpcCall(metadata, { keyRegistry: registry })
154
- expect(result.ok).toBe(true)
155
- })
156
-
157
- it('accepts string array values in metadata', async () => {
158
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
159
- const sender = 'grpc-array-agent'
160
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
161
-
162
- const env = createEnvelope({ sender, intent: 'TASK', content: 'arr-test', ttlMs: 60_000 })
163
- const signed = await signEnvelopeEd25519(env, privateKey)
164
- const metadata: Record<string, string[]> = {
165
- [GRPC_METADATA_KEY]: [JSON.stringify(signed)],
166
- }
167
-
168
- const result = await verifyGrpcCall(metadata, { keyRegistry: registry })
169
- expect(result.ok).toBe(true)
170
- })
171
- })
172
-
173
- describe('withGrpcVerification', () => {
174
- it('calls handler on valid call and attaches envelope to call object', async () => {
175
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
176
- const sender = 'grpc-wrap-agent'
177
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
178
-
179
- const signedMeta = await signGrpcCall({ privateKey, sender })
180
- const call = { metadata: signedMeta, someField: 'value' }
181
-
182
- const handler = vi.fn().mockResolvedValue({ status: 'ok' })
183
- const wrapped = withGrpcVerification(handler, { keyRegistry: registry })
184
-
185
- const response = await wrapped(call)
186
-
187
- expect(handler).toHaveBeenCalledOnce()
188
- expect(handler).toHaveBeenCalledWith(call)
189
- expect(response).toEqual({ status: 'ok' })
190
- expect((call as any)['7h3Envelope']).toBeDefined()
191
- expect((call as any)['7h3Envelope'].header.sender).toBe(sender)
192
- })
193
-
194
- it('throws on invalid call and does not invoke handler', async () => {
195
- const registry = createStaticKeyRegistry({})
196
- const call = { metadata: {} } // no envelope metadata
197
-
198
- const handler = vi.fn().mockResolvedValue({ status: 'ok' })
199
- const wrapped = withGrpcVerification(handler, { keyRegistry: registry })
200
-
201
- await expect(wrapped(call)).rejects.toThrow()
202
- expect(handler).not.toHaveBeenCalled()
203
-
204
- // The thrown error should carry the gRPC status code
205
- try {
206
- await wrapped(call)
207
- } catch (err: any) {
208
- expect(err.code).toBe(16)
209
- }
210
- })
211
- })
@@ -1,103 +0,0 @@
1
- import {
2
- signEnvelopeEd25519,
3
- verifyEnvelopeEd25519, verifyEnvelopeHmac,
4
- createEnvelope, validateEnvelope,
5
- type ProtocolEnvelope,
6
- } from './protocol'
7
- import type { KeyRegistry } from './keyRegistry'
8
-
9
- export { type KeyRegistry }
10
-
11
- export const GRPC_METADATA_KEY = '7h3-envelope-bin' // -bin suffix = binary safe in gRPC
12
-
13
- export interface GrpcSignOptions {
14
- privateKey: string
15
- sender: string
16
- recipient?: string
17
- ttlMs?: number
18
- metadataKey?: string
19
- }
20
-
21
- export interface GrpcVerifyOptions {
22
- keyRegistry: KeyRegistry
23
- metadataKey?: string
24
- strictTtl?: boolean
25
- }
26
-
27
- export type GrpcVerifyResult =
28
- | { ok: true; envelope: ProtocolEnvelope }
29
- | { ok: false; code: number; message: string } // code = gRPC status code
30
-
31
- // Client side: produce metadata to attach to outbound call
32
- export async function signGrpcCall(
33
- opts: GrpcSignOptions
34
- ): Promise<Record<string, string>> {
35
- const envelope = createEnvelope({
36
- sender: opts.sender,
37
- recipient: opts.recipient,
38
- ttlMs: opts.ttlMs ?? 60_000,
39
- intent: 'TASK',
40
- content: 'grpc-call',
41
- })
42
- const signed = await signEnvelopeEd25519(envelope, opts.privateKey)
43
- return { [opts.metadataKey ?? GRPC_METADATA_KEY]: JSON.stringify(signed) }
44
- }
45
-
46
- // Server side: verify metadata from incoming call
47
- export async function verifyGrpcCall(
48
- metadata: Record<string, string | Buffer | string[]>,
49
- opts: GrpcVerifyOptions
50
- ): Promise<GrpcVerifyResult> {
51
- const key = opts.metadataKey ?? GRPC_METADATA_KEY
52
- const raw = metadata[key]
53
- const rawStr = Array.isArray(raw) ? raw[0] : (raw instanceof Uint8Array ? new TextDecoder().decode(raw) : raw)
54
- if (!rawStr) return { ok: false, code: 16, message: '7h3: missing gRPC envelope metadata' }
55
-
56
- let envelope: ProtocolEnvelope
57
- try { envelope = JSON.parse(typeof rawStr === 'string' ? rawStr : String(rawStr)) as ProtocolEnvelope }
58
- catch { return { ok: false, code: 3, message: '7h3: malformed envelope metadata' } }
59
-
60
- if (opts.strictTtl !== false) {
61
- const diags = validateEnvelope(envelope)
62
- if (diags.some(d => d.level === 'error')) {
63
- return { ok: false, code: 4, message: '7h3: envelope expired or invalid' }
64
- }
65
- }
66
-
67
- const sender = envelope.header?.sender
68
- const alg = envelope.signature?.alg
69
- if (!sender || !alg) return { ok: false, code: 3, message: '7h3: missing sender or alg' }
70
-
71
- if (alg === 'ED25519') {
72
- const publicKey = await opts.keyRegistry.getPublicKey(sender)
73
- if (!publicKey) return { ok: false, code: 16, message: `7h3: unknown sender ${sender}` }
74
- const valid = await verifyEnvelopeEd25519(envelope, publicKey)
75
- if (!valid) return { ok: false, code: 16, message: '7h3: invalid signature' }
76
- } else if (alg === 'HS256') {
77
- const secret = await opts.keyRegistry.getSharedSecret?.(envelope.signature!.keyId)
78
- if (!secret) return { ok: false, code: 16, message: '7h3: unknown key' }
79
- const valid = await verifyEnvelopeHmac(envelope, secret)
80
- if (!valid) return { ok: false, code: 16, message: '7h3: invalid signature' }
81
- } else {
82
- return { ok: false, code: 3, message: `7h3: unsupported alg ${String(alg)}` }
83
- }
84
-
85
- return { ok: true, envelope }
86
- }
87
-
88
- // Factory: creates a function that wraps any async gRPC handler with verify logic
89
- // Usage: const handler = withGrpcVerification(myHandler, verifyOpts)
90
- export function withGrpcVerification<TCall extends { metadata: Record<string, string | Buffer | string[]> }, TResp>(
91
- handler: (call: TCall) => Promise<TResp>,
92
- opts: GrpcVerifyOptions
93
- ): (call: TCall) => Promise<TResp> {
94
- return async (call: TCall) => {
95
- const result = await verifyGrpcCall(call.metadata, opts)
96
- if (!result.ok) {
97
- const err = Object.assign(new Error(result.message), { code: result.code })
98
- throw err
99
- }
100
- ;(call as any)['7h3Envelope'] = result.envelope
101
- return handler(call)
102
- }
103
- }
@@ -1,376 +0,0 @@
1
- import { describe, it, expect, vi } from 'vitest'
2
- import {
3
- verifyHttpEnvelope,
4
- signHttpRequest,
5
- signHttpRequestHmac,
6
- createHttpMiddleware,
7
- signFetchRequest,
8
- createSignedFetchRequest,
9
- DEFAULT_HEADER,
10
- } from './httpBinding'
11
- import { createStaticKeyRegistry, type KeyRegistry } from './keyRegistry'
12
- import {
13
- generateEd25519KeypairBase64Url,
14
- createEnvelope,
15
- signEnvelopeEd25519,
16
- signEnvelopeHmac,
17
- type ProtocolEnvelope,
18
- } from './protocol'
19
-
20
- // Helper: build a static KeyRegistry that also holds HMAC shared secrets
21
- function createHmacKeyRegistry(secrets: Record<string, string>): KeyRegistry {
22
- return {
23
- async getPublicKey() { return null },
24
- async getSharedSecret(keyId) { return secrets[keyId] ?? null },
25
- }
26
- }
27
-
28
- describe('verifyHttpEnvelope', () => {
29
- it('returns missing-header when header is absent', async () => {
30
- const registry = createStaticKeyRegistry({})
31
- const result = await verifyHttpEnvelope({}, { keyRegistry: registry })
32
- expect(result.ok).toBe(false)
33
- if (!result.ok) expect(result.reason).toBe('missing-header')
34
- })
35
-
36
- it('returns missing-header when header value is undefined', async () => {
37
- const registry = createStaticKeyRegistry({})
38
- const result = await verifyHttpEnvelope(
39
- { [DEFAULT_HEADER]: undefined },
40
- { keyRegistry: registry },
41
- )
42
- expect(result.ok).toBe(false)
43
- if (!result.ok) expect(result.reason).toBe('missing-header')
44
- })
45
-
46
- it('returns malformed-envelope for invalid JSON', async () => {
47
- const registry = createStaticKeyRegistry({})
48
- const result = await verifyHttpEnvelope(
49
- { [DEFAULT_HEADER]: 'not-json' },
50
- { keyRegistry: registry },
51
- )
52
- expect(result.ok).toBe(false)
53
- if (!result.ok) {
54
- expect(result.reason).toBe('malformed-envelope')
55
- expect(result.detail).toContain('JSON parse failed')
56
- }
57
- })
58
-
59
- it('returns malformed-envelope when required fields are missing', async () => {
60
- const registry = createStaticKeyRegistry({})
61
- const result = await verifyHttpEnvelope(
62
- { [DEFAULT_HEADER]: JSON.stringify({ header: {} }) },
63
- { keyRegistry: registry },
64
- )
65
- expect(result.ok).toBe(false)
66
- if (!result.ok) expect(result.reason).toBe('malformed-envelope')
67
- })
68
-
69
- it('passes a valid Ed25519 signed envelope', async () => {
70
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
71
- const sender = 'agent-alice'
72
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
73
-
74
- const env = createEnvelope({ sender, intent: 'PING', content: 'hello', ttlMs: 60_000 })
75
- const signed = await signEnvelopeEd25519(env, privateKey)
76
- const headers = { [DEFAULT_HEADER]: JSON.stringify(signed) }
77
-
78
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
79
- expect(result.ok).toBe(true)
80
- if (result.ok) expect(result.envelope.header.sender).toBe(sender)
81
- })
82
-
83
- it('returns invalid-signature when envelope is tampered', async () => {
84
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
85
- const sender = 'agent-bob'
86
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
87
-
88
- const env = createEnvelope({ sender, intent: 'PING', content: 'hello', ttlMs: 60_000 })
89
- const signed = await signEnvelopeEd25519(env, privateKey)
90
-
91
- // Tamper with the content after signing
92
- const tampered: ProtocolEnvelope = {
93
- ...signed,
94
- body: { ...signed.body, content: 'tampered-content' },
95
- }
96
- const headers = { [DEFAULT_HEADER]: JSON.stringify(tampered) }
97
-
98
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
99
- expect(result.ok).toBe(false)
100
- if (!result.ok) expect(result.reason).toBe('invalid-signature')
101
- })
102
-
103
- it('returns unknown-sender when sender is not in registry', async () => {
104
- const { privateKey } = await generateEd25519KeypairBase64Url()
105
- const registry = createStaticKeyRegistry({}) // empty registry
106
-
107
- const env = createEnvelope({ sender: 'unknown-agent', intent: 'PING', content: 'hi', ttlMs: 60_000 })
108
- const signed = await signEnvelopeEd25519(env, privateKey)
109
- const headers = { [DEFAULT_HEADER]: JSON.stringify(signed) }
110
-
111
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
112
- expect(result.ok).toBe(false)
113
- if (!result.ok) {
114
- expect(result.reason).toBe('unknown-sender')
115
- expect(result.detail).toBe('unknown-agent')
116
- }
117
- })
118
-
119
- it('returns ttl-expired for an expired envelope', async () => {
120
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
121
- const sender = 'agent-expired'
122
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
123
-
124
- // Create envelope with past timestamp so it is already expired
125
- const pastNow = Date.now() - 120_000 // 2 minutes ago
126
- const env = createEnvelope({
127
- sender,
128
- intent: 'PING',
129
- content: 'hello',
130
- ttlMs: 1_000, // 1 second TTL
131
- nowMs: pastNow,
132
- })
133
- const signed = await signEnvelopeEd25519(env, privateKey)
134
- const headers = { [DEFAULT_HEADER]: JSON.stringify(signed) }
135
-
136
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry, strictTtl: true })
137
- expect(result.ok).toBe(false)
138
- if (!result.ok) expect(result.reason).toBe('ttl-expired')
139
- })
140
-
141
- it('skips TTL check when strictTtl is false', async () => {
142
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
143
- const sender = 'agent-nostrictttl'
144
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
145
-
146
- const pastNow = Date.now() - 120_000
147
- const env = createEnvelope({
148
- sender,
149
- intent: 'PING',
150
- content: 'hello',
151
- ttlMs: 1_000,
152
- nowMs: pastNow,
153
- })
154
- const signed = await signEnvelopeEd25519(env, privateKey)
155
- const headers = { [DEFAULT_HEADER]: JSON.stringify(signed) }
156
-
157
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry, strictTtl: false })
158
- expect(result.ok).toBe(true)
159
- })
160
- })
161
-
162
- describe('signHttpRequest + verifyHttpEnvelope round trip (Ed25519)', () => {
163
- it('signs and verifies successfully', async () => {
164
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
165
- const sender = 'agent-roundtrip'
166
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
167
-
168
- const env = createEnvelope({ sender, intent: 'TASK', content: 'do something', ttlMs: 60_000 })
169
- const { headers } = await signHttpRequest(env, privateKey)
170
-
171
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
172
- expect(result.ok).toBe(true)
173
- if (result.ok) {
174
- expect(result.envelope.header.sender).toBe(sender)
175
- expect(result.envelope.body.intent).toBe('TASK')
176
- }
177
- })
178
-
179
- it('uses custom header name when provided', async () => {
180
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
181
- const sender = 'agent-custom-header'
182
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
183
- const customHeader = 'x-custom-sig'
184
-
185
- const env = createEnvelope({ sender, intent: 'PING', content: 'hi', ttlMs: 60_000 })
186
- const { headers } = await signHttpRequest(env, privateKey, { headerName: customHeader })
187
-
188
- expect(headers[customHeader]).toBeDefined()
189
- expect(headers[DEFAULT_HEADER]).toBeUndefined()
190
-
191
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry, headerName: customHeader })
192
- expect(result.ok).toBe(true)
193
- })
194
- })
195
-
196
- describe('createHttpMiddleware', () => {
197
- it('calls next() when envelope is valid', async () => {
198
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
199
- const sender = 'agent-middleware'
200
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
201
-
202
- const env = createEnvelope({ sender, intent: 'PING', content: 'hi', ttlMs: 60_000 })
203
- const signed = await signEnvelopeEd25519(env, privateKey)
204
- const req = { headers: { [DEFAULT_HEADER]: JSON.stringify(signed) } }
205
-
206
- const res = { status: vi.fn().mockReturnThis(), json: vi.fn() }
207
- const next = vi.fn()
208
-
209
- const middleware = createHttpMiddleware({ keyRegistry: registry })
210
- await middleware(req, res as any, next)
211
-
212
- expect(next).toHaveBeenCalledOnce()
213
- expect(next).toHaveBeenCalledWith() // no error argument
214
- expect(res.status).not.toHaveBeenCalled()
215
- // The envelope should be attached to req
216
- expect((req as any)['7h3Envelope']).toBeDefined()
217
- })
218
-
219
- it('returns 401 and does not call next() when envelope is missing', async () => {
220
- const registry = createStaticKeyRegistry({})
221
- const req = { headers: {} }
222
- const jsonMock = vi.fn()
223
- const res = { status: vi.fn().mockReturnValue({ json: jsonMock }) }
224
- const next = vi.fn()
225
-
226
- const middleware = createHttpMiddleware({ keyRegistry: registry })
227
- await middleware(req, res as any, next)
228
-
229
- expect(res.status).toHaveBeenCalledWith(401)
230
- expect(jsonMock).toHaveBeenCalledWith(
231
- expect.objectContaining({ reason: 'missing-header' }),
232
- )
233
- expect(next).not.toHaveBeenCalled()
234
- })
235
-
236
- it('returns 401 for invalid signature', async () => {
237
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
238
- const { privateKey: otherPrivateKey } = await generateEd25519KeypairBase64Url()
239
- const sender = 'agent-bad-sig'
240
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
241
-
242
- const env = createEnvelope({ sender, intent: 'PING', content: 'hi', ttlMs: 60_000 })
243
- // Sign with wrong key
244
- const signed = await signEnvelopeEd25519(env, otherPrivateKey)
245
- const req = { headers: { [DEFAULT_HEADER]: JSON.stringify(signed) } }
246
-
247
- const jsonMock = vi.fn()
248
- const res = { status: vi.fn().mockReturnValue({ json: jsonMock }) }
249
- const next = vi.fn()
250
-
251
- const middleware = createHttpMiddleware({ keyRegistry: registry })
252
- await middleware(req, res as any, next)
253
-
254
- expect(res.status).toHaveBeenCalledWith(401)
255
- expect(next).not.toHaveBeenCalled()
256
- })
257
- })
258
-
259
- describe('signFetchRequest', () => {
260
- it('adds the envelope header to a Request', async () => {
261
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
262
- const sender = 'agent-fetch'
263
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
264
-
265
- const env = createEnvelope({ sender, intent: 'TASK', content: 'fetch-task', ttlMs: 60_000 })
266
- const originalRequest = new Request('https://example.com/api')
267
- const signedRequest = await signFetchRequest(originalRequest, env, privateKey)
268
-
269
- expect(signedRequest.headers.get(DEFAULT_HEADER)).not.toBeNull()
270
-
271
- // Parse and verify
272
- const headerVal = signedRequest.headers.get(DEFAULT_HEADER)!
273
- const headers = { [DEFAULT_HEADER]: headerVal }
274
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
275
- expect(result.ok).toBe(true)
276
- })
277
-
278
- it('preserves existing headers on the Request', async () => {
279
- const { privateKey } = await generateEd25519KeypairBase64Url()
280
- const sender = 'agent-headers'
281
- const env = createEnvelope({ sender, intent: 'PING', content: 'hi', ttlMs: 60_000 })
282
- const originalRequest = new Request('https://example.com/api', {
283
- headers: { 'Authorization': 'Bearer token123', 'Content-Type': 'application/json' },
284
- })
285
- const signedRequest = await signFetchRequest(originalRequest, env, privateKey)
286
-
287
- expect(signedRequest.headers.get('Authorization')).toBe('Bearer token123')
288
- expect(signedRequest.headers.get('Content-Type')).toBe('application/json')
289
- expect(signedRequest.headers.get(DEFAULT_HEADER)).not.toBeNull()
290
- })
291
- })
292
-
293
- describe('HMAC round trip', () => {
294
- it('signs with HMAC and verifies successfully', async () => {
295
- const secret = 'super-secret-hmac-key'
296
- const keyId = 'hmac-key-1'
297
- const sender = 'agent-hmac'
298
- const registry = createHmacKeyRegistry({ [keyId]: secret })
299
-
300
- const env = createEnvelope({ sender, intent: 'TASK', content: 'hmac task', ttlMs: 60_000 })
301
- const { headers } = await signHttpRequestHmac(env, secret, keyId)
302
-
303
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
304
- expect(result.ok).toBe(true)
305
- if (result.ok) {
306
- expect(result.envelope.header.sender).toBe(sender)
307
- expect(result.envelope.signature?.alg).toBe('HS256')
308
- }
309
- })
310
-
311
- it('returns invalid-signature when HMAC tampered', async () => {
312
- const secret = 'super-secret-hmac-key'
313
- const keyId = 'hmac-key-2'
314
- const sender = 'agent-hmac-tamper'
315
- const registry = createHmacKeyRegistry({ [keyId]: secret })
316
-
317
- const env = createEnvelope({ sender, intent: 'TASK', content: 'hmac task', ttlMs: 60_000 })
318
- const signed = await signEnvelopeHmac(env, secret, keyId)
319
-
320
- const tampered: ProtocolEnvelope = {
321
- ...signed,
322
- body: { ...signed.body, content: 'tampered' },
323
- }
324
- const headers = { [DEFAULT_HEADER]: JSON.stringify(tampered) }
325
-
326
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
327
- expect(result.ok).toBe(false)
328
- if (!result.ok) expect(result.reason).toBe('invalid-signature')
329
- })
330
-
331
- it('returns unknown-sender when HMAC keyId not in registry', async () => {
332
- const secret = 'super-secret-hmac-key'
333
- const keyId = 'hmac-key-missing'
334
- const sender = 'agent-hmac-unknown'
335
- const registry = createHmacKeyRegistry({}) // empty
336
-
337
- const env = createEnvelope({ sender, intent: 'PING', content: 'hi', ttlMs: 60_000 })
338
- const signed = await signEnvelopeHmac(env, secret, keyId)
339
- const headers = { [DEFAULT_HEADER]: JSON.stringify(signed) }
340
-
341
- const result = await verifyHttpEnvelope(headers, { keyRegistry: registry })
342
- expect(result.ok).toBe(false)
343
- if (!result.ok) {
344
- expect(result.reason).toBe('unknown-sender')
345
- expect(result.detail).toBe(keyId)
346
- }
347
- })
348
- })
349
-
350
- describe('createSignedFetchRequest', () => {
351
- it('creates a signed fetch request with correct sender', async () => {
352
- const { publicKey, privateKey } = await generateEd25519KeypairBase64Url()
353
- const sender = 'agent-create-signed'
354
- const registry = createStaticKeyRegistry({ [sender]: publicKey })
355
-
356
- const originalRequest = new Request('https://example.com/api/task')
357
- const signedRequest = await createSignedFetchRequest(originalRequest, {
358
- privateKey,
359
- sender,
360
- ttlMs: 60_000,
361
- })
362
-
363
- const headerVal = signedRequest.headers.get(DEFAULT_HEADER)
364
- expect(headerVal).not.toBeNull()
365
-
366
- const result = await verifyHttpEnvelope(
367
- { [DEFAULT_HEADER]: headerVal! },
368
- { keyRegistry: registry },
369
- )
370
- expect(result.ok).toBe(true)
371
- if (result.ok) {
372
- expect(result.envelope.header.sender).toBe(sender)
373
- expect(result.envelope.body.intent).toBe('TASK')
374
- }
375
- })
376
- })