Tudisco d0db6f00f1 Initial implementation of KEZ — protocol, two impls, and storage server
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).
2026-05-24 14:41:00 -06:00

94 lines
2.9 KiB
TypeScript

import { describe, expect, it } from "vitest";
import {
Identity,
NostrSecret,
dnsTxtValue,
newClaimPayload,
signClaim,
toCompact,
} from "@kez/core";
import { ChannelError } from "../src/index.js";
import { DnsChannel, looksLikeKezTxt, type TxtResolver } from "../src/dns.js";
class CapturingResolver implements TxtResolver {
constructor(
private readonly records: string[],
private readonly expectedName: string,
) {}
async lookupTxt(name: string): Promise<string[]> {
expect(name).toBe(this.expectedName);
return this.records;
}
}
class FailingResolver implements TxtResolver {
async lookupTxt(): Promise<string[]> {
throw ChannelError.unreachable("simulated network failure");
}
}
function signDns(subject: string) {
const secret = NostrSecret.generate();
return signClaim(
newClaimPayload(Identity.parse(subject), secret.identity(), new Date()),
secret,
);
}
describe("DnsChannel", () => {
it("queries _kez.<domain>", async () => {
const signed = signDns("dns:jason.example.com");
const channel = new DnsChannel(
new CapturingResolver([toCompact(signed)], "_kez.jason.example.com"),
);
const hit = await channel.fetchAndVerify(Identity.parse("dns:jason.example.com"));
expect(hit.proof).toEqual(signed);
});
it("supports legacy kez1: prefix", async () => {
const signed = signDns("dns:jason.example.com");
const legacy = dnsTxtValue(signed);
expect(legacy.startsWith("kez1:")).toBe(true);
const channel = new DnsChannel(
new CapturingResolver([legacy], "_kez.jason.example.com"),
);
const hit = await channel.fetchAndVerify(Identity.parse("dns:jason.example.com"));
expect(hit.proof).toEqual(signed);
});
it("returns NotFound when no records", async () => {
const channel = new DnsChannel(new CapturingResolver([], "_kez.jason.example.com"));
await expect(
channel.fetchAndVerify(Identity.parse("dns:jason.example.com")),
).rejects.toMatchObject({ kind: "NotFound" });
});
it("skips non-KEZ TXT records", async () => {
const channel = new DnsChannel(
new CapturingResolver(
["v=spf1 -all", "google-site-verification=abc"],
"_kez.jason.example.com",
),
);
await expect(
channel.fetchAndVerify(Identity.parse("dns:jason.example.com")),
).rejects.toMatchObject({ kind: "NotFound" });
});
it("surfaces resolver failure as Unreachable", async () => {
const channel = new DnsChannel(new FailingResolver());
await expect(
channel.fetchAndVerify(Identity.parse("dns:jason.example.com")),
).rejects.toMatchObject({ kind: "Unreachable" });
});
});
describe("looksLikeKezTxt", () => {
it("accepts both prefixes", () => {
expect(looksLikeKezTxt("kez:z1:foo")).toBe(true);
expect(looksLikeKezTxt("kez1:{...}")).toBe(true);
expect(looksLikeKezTxt("v=spf1")).toBe(false);
expect(looksLikeKezTxt("")).toBe(false);
});
});