Expand description
Interop / discovery helpers.
This module rounds out the crate’s public Solid surface with small, framework-agnostic helpers for ecosystem discovery flows:
.well-known/solid— Solid Protocol §4.1.2 discovery document.- WebFinger — RFC 7033, used to map acct: URIs to WebIDs.
- NIP-05 verification — Nostr pubkey ↔ DNS name binding.
- Dev-mode session bypass — consumer-crate helper for tests.
None of these helpers perform network I/O on their own; they return response bodies and signal objects that the consumer crate wires into its HTTP server.
Structs§
- DevSession
- Dev-mode session — ergonomic handle a consumer crate can plug into its request-processing pipeline in place of NIP-98/OIDC verification during tests or local development. The bypass is only constructable via explicit allow, never through a header the client supplies.
- Nip05
Document - NIP-05 response document (the JSON served at
.well-known/nostr.json?name=<local>). - Solid
Well Known - Solid Protocol
.well-known/soliddiscovery document. The doc advertises the OIDC issuer, the pod URL, and the Notifications endpoint. JSS parity: includesapi.accountsURLs. - Solid
Well Known Accounts - JSS-compatible account endpoint URLs.
- Solid
Well Known Api - JSS-compatible account management API pointers.
- WebFinger
Jrd - WebFinger JRD (JSON Resource Descriptor) response.
- WebFinger
Link
Functions§
- dev_
session - Build a dev-session bypass. Callers are expected to gate this on a
top-level
ENABLE_DEV_SESSION=1or similar environment check — the helper itself will not read env to avoid accidental activation. - nip05_
document - Build the NIP-05 document structure for a pod’s own hosted names.
- nodeinfo_
2_ 1 /.well-known/nodeinfo/2.1content document, per nodeinfo.diaspora.software §3 (schema 2.1).- nodeinfo_
discovery /.well-known/nodeinfodiscovery document (JSON), per nodeinfo.diaspora.software §6. Points clients at one or more versioned NodeInfo docs.- verify_
nip05 - Verify a NIP-05 identifier (
local@example.com) against a fetched NIP-05 document. Returns the resolved hex pubkey on success. - webfinger_
response - Produce a WebFinger JRD response pointing
acct:user@hostat the user’s WebID. ReturnsNoneif the resource is not recognised. - well_
known_ solid - Build the discovery document for a pod root.