Skip to content

v1.1.0

Choose a tag to compare

@github-actions github-actions released this 19 Oct 10:48
· 319 commits to main since this release
3430018

FORA v1.1.0 brings request signing in line with the IETF Web Bot Auth draft, lets a Broker buy on an agent's behalf, and adds typed signature refusals, published JSON Schemas and SDK support for conformance harnesses.

Breaking changes: upgrade every party together

v1.1.0 does not interoperate with v1.0.8 inside one deployment. Request signatures changed in both directions, so every signer, verifier, publisher edge and key directory upgrades at the same time.

  • Request signatures and key directories (hard cut). Requests are signed as Web Bot Auth: Signature-Agent is a structured-field dictionary, and each key directory is served with its own media type and signed by every key it lists. v1.1.0 refuses the bare Signature-Agent value v1.0.8 sends, and a directory served as application/jwk-set+json or unsigned.
  • New reason values. The v1.0.8 Python and TypeScript SDKs refuse a whole answer that carries a reason value added in this release, such as DENIAL_REASON_RELAY_NOT_ACCEPTED. Upgrade those clients.
  • Requests name their requester. requester, with an id, is required on ResourceQuery, DiscoveryRequest and TransactionRequest.
  • Exchange behaviour. An offer states its price once, in Offer.pricing. A denied one-item purchase is answered OK, with denial_reason in the body. A reused idempotency key with a different request is refused already_exists. A request relayed by a Broker is acted on only if the Exchange admits that Broker.
  • RemoveResources names each resource in resources (domain and path); paths is ignored.
  • SDK API. Signing requires the signer's key directory (WithSignatureAgent, signature_agent, signatureAgent). The key resolver's scheme option and several TypeScript signature helpers are removed.

Each change, with what to do for each party, is listed under "Breaking against v1.0.8" in the changelog.

Highlights

  • Web Bot Auth profile. Every FORA request signature is a conformant Web Bot Auth signature (draft-ietf-webbotauth-httpsig-protocol-00), so a CDN or origin that verifies Web Bot Auth can verify a FORA agent.
  • The Broker buys. New BrokerService.ExecuteTransaction: one call purchases offers from several Exchanges.
  • Typed signature refusals. ErrorDetail.request_auth_failure says why a request signature was refused: SIGNATURE_MISSING, SIGNATURE_INVALID or SIGNATURE_STALE.
  • Published JSON Schemas. One draft 2020-12 schema per message, plus a strict variant that rejects unknown fields, shipped in all three packages.
  • Harness support in the SDKs. A pre-signing hook and a raw mode in Go, Python and TypeScript, for conformance and e2e tests.
  • Edge discovery headers. X-Content-Rules and X-FORA-Exchange are now part of the protocol.
  • Docs. The publisher guide is rewritten around the publisher console, and the Identity Service MCP transport is documented.

Install

go get github.com/FORA-Protocol/protocol@v1.1.0
pip install fora-protocol-sdk==1.1.0
npm install @fora-protocol/sdk@1.1.0

What's Changed

  • Document the Identity Service MCP transport by @EugeneDymo in #45
  • Send publishers from the agent preview to the publisher console by @EugeneDymo in #53
  • Fail the build when a URL that main served stops answering by @KonstantinMirin in #43
  • Web Bot Auth signing, Broker purchases, the final money rules and the SDK harness capabilities by @KonstantinMirin in #52
  • Specify request signing and key directories as Web Bot Auth by @KonstantinMirin in #48
  • Send publishers to the publisher console and rewrite the publisher guide by @legendko in #46
  • Release v1.1.0 by @legendko in #55

Full Changelog: v1.0.8...v1.1.0