Skip to content

connect 参考(Connect reference) ​

connect 是面向跨进程 SPOKE 主机的可选交互信封族(spoke-connect 能力标志):签名清单交换、会话上下文、远程 op 调用与可扩展鉴权。该族是增量的 —— 基线合规与基线 schema 保持不变。以下字段表溯源到 schemas/connect/ 中的已提交 schema。

六个信封 ​

ConnectHello —— 签名清单交换 ​

必填:protocol_version、peer_id、nonce、host、signature、extensions。

字段说明
protocol_version消费方在 ConnectHello 中设置的 protocol_version 值是 1(hello 交换未升版;hello 签名字段集与 spoke-connect-hello-jcs-v1 算法不变)。协议版本 2 是当前的规范性 connect 协议版本:它在 post-hello 线上增加必填的逐信封签名,由 RemoteAdapter 内部强制执行,消费方从不把它作为字段值设置(见信封认证(protocol_version 2))。绑定的 protocolVersion() 报告的是 hello 版本(1)。
peer_id发送方网络身份 —— 协议 v1:Ed25519 的 libp2p identity-spec PeerId 字符串(protobuf PublicKey 的 base58btc 身份 multihash)。对协议逻辑不透明;noise-peerid allowlist 的信任根
nonce单次使用重放 nonce,绑定进签名对象
peer_nonce仅响应方使用的拨号绑定:发起方的 nonce,由响应方回显并绑定进其签名对象。发起方 hello 中缺省;发起方拒绝 peer_nonce 与其自身 nonce 不一致的响应方 hello
host完整内嵌 HostCapabilityManifest(含 host.extensions);属于签名对象的一部分
signature对 JCS 规范化签名对象的原始签名字节,base64url(无填充)编码
extensions产品字段袋;不在签名覆盖范围内

ConnectSession —— 已建立的会话上下文 ​

必填:session_id、initiator_peer_id、responder_peer_id、opened_at、negotiated_capabilities、initial_sequence、extensions(protocol_version 2 下另有 signature)。

字段说明
session_id不透明会话 id(建议 UUID;schema 不强制)
initiator_peer_id / responder_peer_id拨号的对端 / 接受的对端
opened_at会话开启时间(UTC)
negotiated_capabilities双方 capabilities[] 的交集(或协商子集);双方都声明时包含 spoke-connect
initial_sequence首次 invoke 请求使用的序列 —— 协议版本 1 与 2 均为常量 0
signature仅 v2、必填、minLength 86 maxLength 86 —— 对 JCS 规范化签名对象的 64 字节 Ed25519 签名的 base64url(无填充)编码(spoke-connect-session-jcs-v1);见信封认证(protocol_version 2)
extensions产品 namespace 袋

ConnectInvokeRequest / ConnectInvokeResponse —— 远程 op 调用 ​

ConnectInvokeRequest 必填:session_id、sequence、request_id、op、payload、extensions(protocol_version 2 下另有 signature)。

字段说明
session_id不透明会话 id
sequence本发送方按会话单调递增的出站序列;逻辑 u64,上限 2^53−1(JSON 安全)
request_id调用方生成的关联 id(建议 UUID)
op开放词汇。核心列表(记录在案,不强制):upsert、promote、relate、check、assemble、extract、project、compute;保留 port.* 前缀用于 RemoteAdapter port 方法(见 Port-method ops(RemoteAdapter);extract 核心 op 见知识抽取与归属(RemoteAdapter))
payload不透明 JSON —— 面向 SPOKE ops 时,必须是所命名 op 的完整既有 ops 请求信封
auth可选会话中证明块;主要鉴权是握手。使用时形状按方法决定。在 protocol_version 2 线上存在时,auth 包含在 JCS 签名对象中
signature仅 v2、必填、minLength 86 maxLength 86 —— 对 JCS 规范化签名对象的 64 字节 Ed25519 签名的 base64url(无填充)编码(spoke-connect-invoke-request-jcs-v1);见信封认证(protocol_version 2)
extensions产品 namespace 袋

ConnectInvokeResponse 是成功 { payload } 或 { error } —— 与 ops 线上相同的单一失败方言;失败复用共享 ErrorEnvelope。两个分支在 protocol_version 2 下都增加必填 signature:

分支v2 signature
成功 { session_id, sequence, request_id, payload, extensions }必填,minLength 86 maxLength 86 —— 对 {session_id, sequence, request_id, payload} 的 spoke-connect-invoke-response-jcs-v1
错误 { session_id, sequence, request_id, error, extensions }必填,minLength 86 maxLength 86 —— 对 {session_id, sequence, request_id, error} 的 spoke-connect-invoke-response-jcs-v1

ConnectAuthChallenge / ConnectAuthResponse —— 可扩展鉴权 ​

ConnectAuthChallenge 必填:challenge_id、method、challenge、extensions。ConnectAuthResponse 必填:challenge_id、method、proof、extensions。

字段说明
challenge_id关联 id,由响应回显
method开放词汇。核心列表(记录在案,不强制):noise-peerid、capability-token;保留名:did
challenge / proof不透明、按方法区分的材料;对 capability-token,proof 为 { v, claims, sig },sig 只覆盖 JCS(claims)

身份 ​

peer_id 是网络信任根:libp2p identity-spec PeerId(Ed25519,base58btc 身份 multihash)。host_id 是内嵌 HostCapabilityManifest 中的咨询性应用标签。两者保持独立 —— 一个主机可随时间呈现多个 peer id,而一个 peer id 恰好由一个 Ed25519 公钥推导。

签名握手(spoke-connect-hello-jcs-v1) ​

  1. 连接双方交换已签名的 ConnectHello。
  2. 发起方 hello 的签名对象为 {protocol_version, peer_id, nonce, host}(4 个字段,peer_nonce 缺省);响应方 hello 的签名对象为 {protocol_version, peer_id, nonce, host, peer_nonce}(5 个字段,peer_nonce = 发起方的 nonce,即拨号绑定)。顶层 extensions 与 signature 排除在外。
  3. 对象经 RFC 8785 JCS 规范化(RFC 8785)。
  4. 字节用 Ed25519 密钥对签名;原始签名以无填充 base64url 编码(RFC 4648 §5)。
  5. 接收方仅在以下全部满足时接受:协议版本为 1、声称的 peer_id 等于已认证的远端对等节点、密钥能推导出该 peer id、对等节点在已配置 allowlist 中(空 allowlist 拒绝全部 —— fail-closed)、签名按角色感知的字段集校验通过、且 (peer_id, nonce) 对是新的(单次使用,进程生命周期)。
  6. 拨号绑定:发起方额外要求响应方签名的 peer_nonce 等于其自身 nonce —— 捕获的响应方 hello 无法重放进新的拨号(例如客户端重启导致内存 nonce 存储重置之后)。

信封认证(protocol_version 2) ​

协议版本 2 在协议层对每条 post-hello 影响信任的信封 —— ConnectSession、ConnectInvokeRequest、ConnectInvokeResponse —— 做认证,使用逐信封 JCS + Ed25519 签名字段集,构造与 spoke-connect-hello-jcs-v1 相同,扩展为三个新算法 id。接收方在协议层校验信封真实性,独立于传输层的 TLS 或 Noise;传输层提供的已认证对等节点身份不会放宽规则。

算法 id ​

算法 id信封
spoke-connect-hello-jcs-v1ConnectHello(不变)
spoke-connect-session-jcs-v1ConnectSession
spoke-connect-invoke-request-jcs-v1ConnectInvokeRequest
spoke-connect-invoke-response-jcs-v1ConnectInvokeResponse

四个算法共享同一构造:RFC 8785 JCS → UTF-8 字节 → Ed25519 签名/校验 → 无填充 base64url。签名密钥是发送方的对等节点身份 Ed25519 私钥;校验使用推导出已认证握手 peer_id 的公钥。

已签名字段集 ​

每个签名对象都是线上信封的严格子集(精确键,无其它)。extensions 与 signature 排除在外 —— extensions 不在签名覆盖范围内,不参与信任决策:

  • ConnectSession:{session_id, initiator_peer_id, responder_peer_id, opened_at, negotiated_capabilities, initial_sequence}
  • ConnectInvokeRequest:{session_id, sequence, request_id, op, payload},且当 auth 在线上存在时另加 auth
  • ConnectInvokeResponse 成功分支:{session_id, sequence, request_id, payload}
  • ConnectInvokeResponse 错误分支:{session_id, sequence, request_id, error}

两个响应分支分别对其字段集签名;signature 字段必须是 64 个原始签名字节的规范 base64url(无填充)编码。

校验规则 ​

对每条 v2 post-hello 信封,接收方:(1)检查 signature 存在;(2)执行规范编码往返检查;(3)按锁定的字段集构造签名对象;(4)用 RFC 8785 JCS 规范化;(5)用对等节点的握手 Ed25519 公钥校验;(6)断言会话绑定(session_id 绑定到已建立会话,对等节点标识与已认证握手一致)。任一失败都拒绝该信封。签名绑定到会话:未绑定到已建立会话的 session_id 被拒绝,从一个会话捕获的信封重放进另一个会话会在另一个会话的握手密钥下校验失败。

版本策略 ​

方向行为
v2 对等节点 ↔ v1 对等节点v2 侧在已校验握手中看到 protocol_version: 1 并拒绝建立 —— v1 侧无法产生带签名的会话/invoke 信封。拨号 fail-closed
双方 v2会话在 v2 规则下建立;所有 post-hello 信封携带必填 signature
双方 v1仅传统 v1 互操作
未知版本(> 2)通告未知版本的握手在版本门禁 fail-closed(版本检查是握手校验第 1 步,先于签名校验),按混合版本拨号处理

hello 签名字段集(4 字段发起方 / 5 字段响应方)不变;拨号绑定 peer_nonce 规则保留。

错误映射 ​

信封认证失败使用共享 ErrorEnvelope 词汇:auth_failed 覆盖缺失、无效、非规范或字段集漂移的签名与会话绑定不匹配。在 RemoteAdapter 面上,这些以 SpokeResult 拒绝呈现 —— INTERNAL_ERROR,details.kind ∈ {envelope_auth_missing、envelope_auth_invalid、envelope_auth_session_unbound} —— 而混合或未知版本 hello 以专用种类使拨号失败:RemoteAdapterError::ProtocolVersionMismatch(Rust)/ CoreError(code: "protocol_version_mismatch",TS),经 FFI 以 FfiError.Dial(kind: "protocol_version_mismatch")呈现;无 adapter 实例。版本门禁是握手校验第 1 步 —— 先于签名校验 —— 因此任何版本不匹配的 hello(无论签名是否有效)都以该专用种类失败。

强制 ​

RemoteAdapter(TypeScript ./remote 子路径、Rust remote-adapter feature)与 connect 客户端在它们发射或接受的每条 post-hello 信封上内部强制 v2 逐信封认证,无需任何配置:拨号在建立时校验签名的 ConnectSession 快照,每个出站 invoke 请求都签名,每条关联响应在关联回显检查后校验。hello 交换保持在协议版本 1。ConnectAuthChallenge / ConnectAuthResponse 携带方法特定的证明,本身已绑定签名;它们不在 v2 逐信封签名范围内。

排序与关联 ​

每个会话、每个方向的单调 sequence 计数器从 0 开始;序列溢出会关闭会话并开启新会话。invoke 响应回显 session_id / sequence / request_id —— 任何不匹配都会使关联校验失败。接收方强制入站序列单调性,并以 invalid_sequence 线上信封应答重放或乱序序列。

会话核心状态机 ​

会话核心为每个本地节点、每个会话跟踪一个逻辑状态:

状态含义
Disconnected无传输会话;本会话无出站序列
Handshaking传输已建立;hello 在途;invoke 尚未被授权
Established双方 hello 均被接受;session_id 已分配;出站计数器 = 0;入站期望 = 0
Closed会话不可用(序列耗尽、传输丢失、认证失败、本地关闭);开启新会话 —— 序列不回绕
转换触发守卫 / 效果
Disconnected → Handshaking传输连接 / 接受——
Handshaking → Established本地接受远端 hello 且远端接受本地 helloallowlist + 签名 + nonce 单次使用;拨号绑定(响应方签名的 peer_nonce = 发起方 nonce);会话对等节点标识绑定到已认证 hello 的 peer_id;negotiated_capabilities = 协商子集;出站计数器 = 0 且入站期望 = 0
Handshaking → Closed任一 hello 门禁失败被拒绝 hello 的 nonce 不记录
Established → Established出站 invoke原子分配 sequence = last + 1(从 0 开始);附加新 request_id;发送
Established → Established入站 invoke仅当 sequence == next_expected_inbound(从 0 开始)时接受,然后前进;否则以线上错误拒绝且无处理方副作用
Established → Established入站响应仅当回显某挂起请求的 session_id、sequence 与 request_id 时接受;否则关联失败
Established → Closed下一个出站序列将超过 2^53−1、传输丢失或本地关闭不回绕

在 v2 线上,序列/关联检查先运行,但在信封认证校验通过前不推进会话状态(见信封认证(protocol_version 2))。

鉴权方法 ​

方法工作原理
noise-peerid握手默认:allowlist 准入加签名握手,远端对等节点由传输层(noise)认证
capability-token提权 / 会话中授权:受信任签发方以 Ed25519 对一组短声明(iss / sub / aud / capabilities / exp,可选 iat / jti)做 JCS 签名;证明经挑战/响应交换或逐 invoke 的 auth 携带。校验强制签发方信任、主体/受众绑定、过期与时钟偏差。受信任签发方列表为空时该方法被禁用(fail-closed)

能力词汇(Capability vocabulary) ​

每个操作映射到会话 negotiated_capabilities 上它所需的能力(dispatch gate 评估协商集,而非仅远端 manifest):

操作所需能力
upsert、promote、relate、check、assemble(以及 port.* 基线操作)spoke-baseline
extractke-extraction
project、compute(以及 port.computable.*)l2-computable
listForkTimelineEvents(以及 port.fork.*)l5-fork
携带非空 scope.viewpoint 的 port.scope.list_knowledge_entries、port.scope.list_timeline_events、port.fork.list_timeline_events该行能力外加 ke-ownership
产品自定义操作产品文档化的能力

能力令牌授权为其 capabilities[] 覆盖的 ops 授权会话成员资格,但并不取代 negotiated_capabilities —— 令牌门禁生效时,令牌授权与协商集都必须允许该 op。

Port-method ops(RemoteAdapter) ​

RemoteAdapter 把每个 BaselinePorts 方法代理为一个 connect invoke,携带保留的 port.* 产品 op 与不透明的 snake_case 载荷:

方法op请求 payload成功 payload
getKnowledgeEntryport.knowledge.get{ "entry_id": string }KnowledgeEntry
putKnowledgeEntryport.knowledge.put{ "entry": KnowledgeEntry, "expected_base_revision": number | null }KnowledgeEntry
getRelationport.relation.get{ "relation_id": string }Relation
putRelationport.relation.put{ "relation": Relation, "expected_base_revision": number | null }Relation
listKnowledgeEntriesport.scope.list_knowledge_entries{ "scope": Scope }KnowledgeEntry[]
listTimelineEventsport.scope.list_timeline_events{ "scope": Scope }TimelineEvent[]
putFindingsport.finding.put{ "findings": Finding[] }Finding[]
listRulesport.rule.list{ "rule_refs": string[] }Rule[]
listPeerHostCapabilityManifestsport.host.list_peer_manifests{}HostCapabilityManifest[]
projectport.computable.project{ "session_id": string, "entry_id": string, "state": ComputableFieldMap }ProjectResponse
computeport.computable.compute{ "session_id": string, "entry_id": string, "computable": ComputableFieldMap, "settle": boolean }ComputeResponse
listForkTimelineEventsport.fork.list_timeline_events{ "scope": { "scope_id": string, "fork_id": string } }TimelineEvent[]
getHostCapabilityManifest(无 —— 会话缓存)——建立时缓存的远端握手 host;无往返

可选 l2-computable(project / compute)与 l5-fork(listForkTimelineEvents)族随同目录交付,与基线行一样按能力门控 —— 库与原生绑定两侧的声明 / 服务 / 驱动 / 拒绝契约见可选 port 族。

可选 port 族 ​

两个可选族把 port 目录扩展到 spoke-baseline 之外:l2-computable(project / compute 会话)与 l5-fork(分支时间线查询)。它们遵循与基线行相同的 port 模式 —— manifest 声明的能力、由响应方服务的 provider 面、以及 RemoteAdapter 代理方法 —— 外加一条规则:该族必须被协商。双方 manifest 都必须在 capabilities[] 中声明它,于是会话的 negotiated_capabilities(双方握手交集)包含它;响应方的 dispatch gate 评估协商集,只有一侧声明的族与未知 op 一样被拒绝。

声明 ​

族能力OpsProvider 面
可计算会话l2-computableproject / computeComputablePort
分支时间线l5-forklistForkTimelineEventsForkTimelineQueryPort

Provider 面是 operations crate 的契约(@42ch/spoke-operations);组合类型 FullPorts 即 BaselinePorts & ComputablePort & ForkTimelineQueryPort。

服务(响应方) ​

响应方经其注入的 ports provider 服务 port.* 调用。可选族走同一条接缝,分派前做结构性探测 —— gate → probe → serve/deny:

面形状
TypeScript —— connectResponder({ ports })实现 BaselinePorts 及可选方法(project / compute / listForkTimelineEvents)的 ports provider;组合类型 FullPorts 覆盖全部十二个服务方法
Rust —— ConnectResponderOptions.portsArc<dyn RemoteServePorts>:当 provider 实现 BaselinePorts + ComputablePort + ForkTimelineQueryPort 时,blanket impl 服务所有族;混合主机经 RemoteServePortsComposite::new(baseline, computable, fork) 组合,未提供的面传 None
FFI —— connect_responder_ffi 的 ports 参数可选的带外回调 PortsHandler,实现下方 port 目录外加 extract 服务面;见下方回调表
FFI PortsHandler 方法族服务的 op
get_knowledge_entry(entry_id)基线port.knowledge.get
put_knowledge_entry(entry_json, expected_base_revision)基线port.knowledge.put
get_relation(relation_id) / put_relation(relation_json, expected_base_revision)基线port.relation.get / port.relation.put
list_knowledge_entries(scope_json) / list_timeline_events(scope_json)基线port.scope.list_knowledge_entries / port.scope.list_timeline_events
put_findings(findings_json)基线port.finding.put
list_rules(rule_refs)基线port.rule.list
list_peer_host_capability_manifests()基线port.host.list_peer_manifests
project(project_request_json)l2-computableport.computable.project
compute(compute_request_json)l2-computableport.computable.compute
list_fork_timeline_events(scope_json)l5-forkport.fork.list_timeline_events
extract(extract_request_json)ke-extractionextract

每个 PortsHandler 方法以 JSON 字符串接收请求载荷,以 JSON 字符串返回成功载荷。get_host_capability_manifest 不在目录中 —— 它是会话缓存,绝不经过 ports handler 服务。不服务某 op 的方法抛出 FfiError.Rejected,原样穿透给调用方作为应用拒绝;缺席的 ports handler(构造参数 ports = None)对每条 port.* 调用保留文档化的拒绝分支。

驱动(adapter) ​

RemoteAdapter 在已建立的会话上像任何基线方法一样代理这三个可选 op:

面方法
TypeScript RemoteAdapterproject(request) / compute(request) / listForkTimelineEvents(scope) —— 类型化请求,SpokeResult 结算
Rust RemoteAdapterproject(request) / compute(request) / list_fork_timeline_events(scope) —— 同一契约
FFI RemoteAdapterFFIproject(project_request_json) / compute(compute_request_json) / list_fork_timeline_events(scope_json) —— JSON 进 / JSON 出

拒绝映射 ​

可选 port 的拒绝与其它任何分派拒绝走同一行:响应方 gate 以线上码 op_unsupported 应答(族未协商 —— 任一侧都未声明,或只有一侧声明),RemoteAdapter 将其映射为带 details.wire_code = "op_unsupported" 的 CAPABILITY_PORT_MISSING 拒绝;FFI 上同一行是 code: "CAPABILITY_PORT_MISSING" 且保留 wire_code 的 FfiError.Rejected。声明了某族但不为其提供任何 provider 面的主机 —— ports 缺席,或探测缺失方法 —— 应答同一拒绝分支,因此调用方总能观察到拒绝,而非静默成功。

知识抽取与归属(RemoteAdapter) ​

两个能力把 adapter 扩展到 port 目录之外:用于 extract 核心 op 的 ke-extraction,以及用于携带读者视角的 Scope 承载操作的 ke-ownership。两者都是普通能力字符串,声明在双方对等节点的 HostCapabilityManifest.capabilities[] 中,因此会话的 negotiated_capabilities(双方握手交集)必须包含该标志,操作才会被服务。manifest 独立声明能力与角色:提供抽取的主机通告 input-source 角色,它是描述该主机的元数据,而 ke-extraction 与 ke-ownership 是门禁分派的能力标志。

远程抽取(Remote extraction,ke-extraction) ​

extract 是一个整体操作服务面 —— adapter 委派整个抽取,并解码对等节点的线上 ExtractResponse:

面方法
TypeScript RemoteAdapterextract(request) —— 类型化 ExtractRequest 进,SpokeResult<ExtractResponse> 出
Rust RemoteAdapterextract(request) —— 同一契约
FFI RemoteAdapterFFIextract(extract_request_json) —— ExtractRequest JSON 进,ExtractResponse 成功分支 JSON 出
线上位置形状
opextract
请求 payloadExtractRequest 本身 —— { run_id, sources, entry_types?, extensions? } 原样。run_id 是非空关联 id,sources 是非空 SourceAnchor(溯源指针)列表,每个锚点的可选 span 收窄所引用的制品;载荷携带这些引用,源内容保留在服务方主机本地
成功 payloadExtractResponse 成功分支 —— { candidates, run }。candidates 为空数组是成功的零结果运行;每个返回的候选都携带 status: "provisional";run.run_id 原样回显请求,run.method / run.coverage_hint 是产品的咨询性运行元数据
错误ExtractResponse 错误分支复用共享 ErrorEnvelope,走应用拒绝路径

服务方主机拥有源加载与抽取:loader 值保留在其 port 本地,请求方只需协商后的标志。服务是一个 connect 拥有的服务面 —— TypeScript RemoteExtractService.extract(request) 组合进响应方的 ports(BaselinePorts & Partial<RemoteExtractService>,以函数值的 ports.extract 做结构性探测);Rust RemoteExtractService 经 RemoteServePorts::as_extract 探测,并以 RemoteServePortsComposite::with_extract 接入混合主机;FFI 上则是经 into_remote_serve_ports 桥接的 PortsHandler.extract(extract_request_json) 回调。服务顺序是 gate → probe → serve/deny,因此声明了 ke-extraction 且不服务抽取的主机,应答与不服务 ports 面的主机相同的拒绝分支。

归属门禁(The ownership gate,ke-ownership) ​

三个 Scope 承载操作 —— port.scope.list_knowledge_entries、port.scope.list_timeline_events、port.fork.list_timeline_events —— 在 payload.scope.viewpoint 为非空字符串时,要求在其行能力之外另加 ke-ownership。门禁按原样读取 payload.scope.viewpoint,并把任何非空字符串视为承载归属,因此其它任何 Scope 形状都仅按其行能力放行。畸形 Scope 仍是既有的 INVALID_INPUT 拒绝。viewpoint 是请求载荷中携带的读者上下文;查询返回的条目与治理字段保持不变。

该要求是能力:它在远程分派边界依据请求载荷求值,分派表把它施加于上述三个 Scope 承载行。响应方在行能力门禁之后、探测或调用 provider 之前,把它作为补充门禁施加;路由器在选对等节点时把它作为硬能力过滤器,因此通告为过滤器提供输入,而被选中的对等节点仍施加自身门禁并可拒绝。拨号方 adapter 直接把请求发给对等节点,并呈现对等节点的拒绝。

拒绝面(Refusal surfaces) ​

每个拒绝都经既有错误词汇结算:

拒绝来源观察到的拒绝
所需能力位于协商集之外(ke-extraction,或视角承载 Scope 上的 ke-ownership)分派拒绝:线上码 op_unsupported 映射为带 details.wire_code = "op_unsupported" 的 CAPABILITY_PORT_MISSING
标志已协商,而主机不服务该 op 的服务面(针对不服务抽取的主机的 extract 请求,或 provider 方法未设置的可选族)同一分派拒绝分支
服务方回调自行拒绝该调用回调的应用拒绝原样穿透 —— 拒绝抽取的回调给出 CAPABILITY_PORT_MISSING,wire_code 保持未设置,因此被拒绝的抽取与缺失的能力可区分
该能力在路由器的候选对等节点中处于未通告状态 —— 视角承载 Scope 请求既有本地终结拒绝:CAPABILITY_PORT_MISSING,wire_code = kind = no_capable_peer

工具(反向调用) ​

清单的 tools[](内嵌于握手 host)声明对等节点可以从会话提供服务的工具 ABI。tools.* invoke 是反方向的一条普通签名 ConnectInvokeRequest —— op 字符串就是能力字符串 —— 且该面是对称的:已建立会话的任一侧为自身声明的工具注册处理器,并可以用同一个 invokeTool 面调用对端声明的工具。demo 与参考提供方(fixtures/toy-world/)为 tools.toy_world.roll_dice 与 tools.toy_world.lore_lookup 交付逐字节一致的描述符。

清单 tools[] 字段表 ​

HostCapabilityManifest.tools 中的每一项是一个 ToolDescriptor(schemas/data/tool-descriptor.schema.json):

字段类型说明
schema_versionnumber共享的 SchemaVersion
capability_idstring工具能力字符串 tools.<ns>.<tool_id>,匹配 ^tools\.[a-z][a-z0-9_-]*\.[a-z0-9][a-z0-9_-]*$;namespace 必须由声明清单拥有(namespaces[] 成员)
opstring该工具的线上 op;必须等于 capability_id(draft-07 无法表达跨字段相等,由辅助函数强制)
descriptionstring人类可读的工具描述
inputobject描述工具参数的不透明 JSON Schema draft-07 子 schema;空对象 {} 声明无约束
outputobject描述成功结果的不透明 JSON Schema draft-07 子 schema;空对象 {} 声明无约束
idempotentboolean咨询性幂等元数据(默认 false);协议不定义幂等键机制

validateManifestTools(spoke-operations)对照清单自身检查其 tools[]:每个描述符有效、其 capability_id 出现在 capabilities[] 中、其 namespace 在 namespaces[] 中被拥有、且工具 id 唯一。listTools 按声明顺序返回描述符。两个辅助函数都是纯函数 —— 库不会自动调用它们;demo 主机在发现时对拨号方的清单运行它们,集成方应在任何以清单为门禁之处自行调用。

工具调用辅助函数 ​

@42ch/spoke-operations 为调用路径提供三个辅助函数(Rust 对应物为 spoke-operations crate 中的 validate_tool_arguments / ToolInvokePort / orchestrate_invoke_tool):

  • validateToolArguments(descriptor, args) —— 结构参数门禁(粒度冻结):args 必须是 JSON 对象;当 descriptor.input 声明顶层 "type": "object" 且带有 "required": [...] 列表时,每个列出的键必须存在于 args 中。它以 INVALID_INPUT 拒绝,并携带 details.field(非对象载荷为 "arguments",畸形子 schema 为 "input")以及缺失键的 details.missing;input: {} 是空转通过(无约束)。不做更深的 JSON-Schema 检查 —— 完整校验留在消费方或 fixture 侧。
  • ToolInvokePort —— 可选的远程工具调用注入缝:invokeTool(request),入参 ToolInvokeRequest { capability_id, arguments },结算为 SpokeResult<ToolInvokeResponse { result }>。该族独立存在 —— 不并入 BaselinePorts,能力门禁按工具(即能力字符串本身)进行。端口不重新校验请求参数:调用方应在调用前运行 validateToolArguments。
  • orchestrateInvokeTool(port, request) —— 冻结的编排序列:(1) 能力 id 语法门禁(parseToolCapabilityId)→ INVALID_INPUT;(2) 运行时端口守卫(null/undefined 端口或结构上缺失的 invokeTool)→ 携带 details.capability = request.capability_id 的 CAPABILITY_PORT_MISSING;(3) 原样返回 port.invokeTool(request)。此处不重跑参数校验 —— 只校验请求语法。

tools.* 分派规则 ​

当两个条件都成立时,tools.* invoke 才被分派:

  1. 已协商 —— op 字符串本身在会话的 negotiated_capabilities(协商能力)中;双方都声明了该工具的能力 id,因此双方协商了它。工具族是自描述的:它不依赖 spoke-baseline。
  2. 已注册 —— 服务侧为精确的能力 id 注册了处理器(RemoteAdapter 或响应方上的 registerToolHandler)。

两个门禁都 fail-closed:未协商的工具以分派拒绝码 op_unsupported 应答;已协商但无注册处理器的工具以 op_unsupported 应答(处理器或拒绝式服务)。抛异常的处理器经 toErrorEnvelope 应答错误分支;服务循环从不崩溃。

请求载荷以 { "arguments": <opaque JSON> } 携带工具参数;成功载荷为 { "result": <opaque JSON> } —— invokeTool 提取 result,并拒绝缺少 result 的成功载荷。

反向调用语义 ​

invokeTool(capabilityId, args) 向对端发出以 op = capabilityId 的签名 ConnectInvokeRequest,并以工具的 result 结算。拒绝应答经共享错误行映射:op_unsupported / capability_missing → 带 details.wire_code 的 CAPABILITY_PORT_MISSING 拒绝 —— 调用方观察到拒绝,而非静默成功。该面同时存在于 RemoteAdapter 与响应方(connectResponder):主机以响应方的面在编排中途调用拨号方的工具;拨号方以 adapter 的面调用主机声明的工具。非 tools. id 快速失败(语法错误,INVALID_INPUT)。处理器注册表不修改清单 —— 用于发现的描述符真源保持在 tools[]。已声明但未注册的工具能通过 validateManifestTools —— 注册不属于清单内容 —— 并在调用时以 CAPABILITY_PORT_MISSING 被拒绝。

发现与显式对等连接 ​

显式对等连接(explicit peering)是生产路径:主机配置监听地址,并经带外方式互相拨号(配置的地址或直接拨号)。connect 线上不携带任何发现字段 —— 发现属传输侧职责,会话准入仍完全由 allowlist 与签名握手门禁把关。

传输 ​

每条消息一个 JSON connect 信封,承载于有序、可靠、双向的字节流(TCP、WebSocket、yamux、libp2p request-response)。组帧分隔符、重试与载荷上限由传输 adapter 负责。

嵌入模型 ​

嵌入方式交付物
语言原生客户端(language-native client)在宿主语言中实现的线上契约与会话核心规则(TypeScript @42ch/spoke-connect 客户端,WebSocket 传输)
原生绑定(native bindings)经 FFI 导出到宿主语言的共享会话核心(C# NuGet、Kotlin Maven、Swift SPM、Go modules、Python PyPI、C/C++ git)
Rust 参考实现(Rust reference)已发布的 spoke-connect crate:会话核心参考、uniffi 绑定来源,以及 rust-libp2p 传输栈(crate README)

会话核心规则 —— allowlist、peer_id 推导与反推、握手密码学、nonce、请求关联、sequence、capability-token 鉴权与 dispatch gate —— 在所有语言间共享,并由 golden vectors 锁定。薄客户端便利(Session、negotiatedCapabilities、generateNonce)在宿主运行时受益处提供。

错误词汇 ​

条目出现位置含义
auth_failedErrorEnvelope.code令牌认证失败(需要时缺失或无效令牌;签名 / 签发方 / 受众 / 主体 / 过期 / 畸形证明)以及全部信封认证失败(缺失、无效或非规范签名;字段集漂移;会话绑定不匹配)
invalid_sequenceErrorEnvelope.code重放或乱序的入站序列
op_unsupportedErrorEnvelope.code未知 op,或令牌有效但缺乏所请求 op 的能力
capability_missingErrorEnvelope.codeop 的必需能力不在有效授权中
no_capable_peer路由器拒绝 details.wire_code / details.kind没有已注册对等节点通过硬选择门禁时的终结路由器拒绝(CAPABILITY_PORT_MISSING);注册满足条件的对等节点并重新调用
envelope_auth_missing / envelope_auth_invalid / envelope_auth_session_unboundRemoteAdapter 拒绝 details.kindINTERNAL_ERROR 拒绝上的信封认证拒绝种类(仅该等待者;会话状态不变)
handshake拨号失败 details.kind(FfiError.Dial)握手签名 / 身份 / nonce 校验失败(版本不匹配以 protocol_version_mismatch 呈现);拨号面为 {config、handshake、timeout、protocol_version_mismatch},无 adapter 实例
protocol_version_mismatch拨号失败 details.kind(FfiError.Dial)通告混合或未知协议版本的 hello 以专用种类使拨号失败 —— RemoteAdapterError::ProtocolVersionMismatch / CoreError("protocol_version_mismatch");无 adapter 实例
transport / session_closed / timeout / panic / correlation_mismatch / sequence_exhaustedRemoteAdapter 拒绝 details.kind传输 I/O、会话丢失、invoke 超时、panic 遏制、关联不匹配与序列耗尽的 INTERNAL_ERROR 拒绝种类

相关页面 ​