KEZ is a portable, decentralized identity graph: a person signs claims
linking their many accounts, publishes those claims in places only the
claimed account can publish to, and anyone can verify the connections
without trusting a central server.
Layout
------
- SPEC.md Language-agnostic protocol spec (v0.2)
- rust/ Rust implementation: kez-core, kez-channels, kez-cli
- nodejs/ TypeScript port at full parity
- rust-sig-server/ Optional axum + SQLite storage server for sigchains
- crosstest.sh Cross-implementation interop harness
Capabilities (both implementations, byte-compatible)
----------------------------------------------------
- Two primary-key algorithms: nostr/secp256k1 Schnorr (BIP-340) and
Ed25519 (RFC 8032). Identifiers: nostr:npub1... and ed25519:<hex>.
- JCS (RFC 8785) canonicalization for everything signed.
- Four proof encodings: JSON envelope, compact (kez:z1:<base64url(zstd(json))>),
Markdown fence, DNS TXT.
- Five channel plugins (no API keys, no auth needed for any of them):
dns: system resolver, _kez.<domain> TXT records
github: public gist scan + <user>/<user> profile README fallback
nostr: kind-30078 events from default relays
bluesky: public AppView author feed
ap: WebFinger + actor JSON (alias mastodon:)
- Identical CLI surface:
kez identity new [--key-type nostr|ed25519]
kez claim create <subject> (--nsec | --ed25519-seed) [--format ...] [--out ...]
kez claim dns <domain> (--nsec | --ed25519-seed)
kez verify file <path>
kez verify id <identifier>
kez sigchain add|revoke|show|export|publish
- Sigchains: append-only signed log per primary, hash-chained per spec §6,
stored locally at ~/.kez/sigchains/, exportable as JSONL or kez:zc1: bundle.
- Sigchain publish destinations: chain server, web (file dump), DNS (zone
record print), nostr (kind-30078 wrapping event).
kez-sig-server
--------------
Optional storage tier. Axum + SQLite, single binary, no external deps.
- No auth — the cryptography is the access control. The server validates
every signature, every seq, every prev hash before storing.
- REST API: POST /v1/sigchains/{scheme}/{id}/events (append signed event,
201 with new head hash or 4xx); GET /{scheme}/{id} (full chain as JSONL);
GET /head; GET /healthz.
- Designed for one central instance for now; the design doesn't preclude
running more later (clients gain a configurable list, verifiers
reconcile per spec §6.2).
- Channel-based publishing remains the always-available fallback if the
server is unavailable.
Tests
-----
- rust/ 99 tests
- rust-sig-server/ 10 integration tests (real HTTP, real SQLite)
- nodejs/ 91 tests (vitest)
- crosstest.sh 19 cross-impl scenarios — proves JCS bytes,
Schnorr + Ed25519 sigs, all four claim encodings,
and the sigchain JSONL bundle are byte-compatible
between Rust and Node in both directions.
What's not done yet
-------------------
- verify id consulting the sigchain for revocations (data path exists,
just not wired into the verifier output).
- rotate and add_device sigchain ops (types reserved).
- expires_at enforcement during claim verification.
- Typed VerificationStatus.status reflecting the five failure modes.
- Auth-required publishers (GitHub gist, Bluesky, ActivityPub).
54 lines
1.8 KiB
TypeScript
54 lines
1.8 KiB
TypeScript
// DNS channel: queries `_kez.<domain>` TXT records. Resolver is abstracted
|
|
// so tests can substitute a fake.
|
|
|
|
import { resolveTxt } from "node:dns/promises";
|
|
import { COMPACT_PROOF_PREFIX, type Identity, dnsTxtName } from "@kez/core";
|
|
import { ChannelError, type Channel, type ChannelHit, parseAndVerifyFor } from "./index.js";
|
|
|
|
export interface TxtResolver {
|
|
lookupTxt(name: string): Promise<string[]>;
|
|
}
|
|
|
|
export class SystemResolver implements TxtResolver {
|
|
async lookupTxt(name: string): Promise<string[]> {
|
|
try {
|
|
// Node returns TXT as string[][] (one inner array per record,
|
|
// each segment <=255 bytes). Concat segments per record.
|
|
const records = await resolveTxt(name);
|
|
return records.map((parts) => parts.join(""));
|
|
} catch (e) {
|
|
throw ChannelError.unreachable(`TXT lookup ${name}: ${(e as Error).message}`, e);
|
|
}
|
|
}
|
|
}
|
|
|
|
export class DnsChannel implements Channel {
|
|
readonly system = "dns";
|
|
private resolver: TxtResolver;
|
|
|
|
constructor(resolver: TxtResolver = new SystemResolver()) {
|
|
this.resolver = resolver;
|
|
}
|
|
|
|
async fetchAndVerify(identity: Identity): Promise<ChannelHit> {
|
|
const name = dnsTxtName(identity);
|
|
const records = await this.resolver.lookupTxt(name);
|
|
|
|
let lastError: ChannelError | undefined;
|
|
for (const value of records) {
|
|
if (!looksLikeKezTxt(value)) continue;
|
|
try {
|
|
return parseAndVerifyFor(value, identity);
|
|
} catch (e) {
|
|
if (e instanceof ChannelError) lastError = e;
|
|
else lastError = ChannelError.invalid((e as Error).message, e);
|
|
}
|
|
}
|
|
throw lastError ?? ChannelError.notFound(identity);
|
|
}
|
|
}
|
|
|
|
export function looksLikeKezTxt(value: string): boolean {
|
|
return value.startsWith(COMPACT_PROOF_PREFIX) || value.startsWith("kez1:");
|
|
}
|