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).
77 lines
2.2 KiB
TypeScript
77 lines
2.2 KiB
TypeScript
// Wire types: claim payload, signature block, full envelope.
|
|
// Field names and ordering match Rust exactly so JCS bytes are identical.
|
|
|
|
import type { Identity } from "./identity.js";
|
|
|
|
export const CLAIM_TYPE = "kez.claim";
|
|
export const SIGCHAIN_EVENT_TYPE = "kez.sigchain.event";
|
|
export const FORMAT_VERSION = 1;
|
|
export const NOSTR_SCHNORR_ALG = "nostr-secp256k1-schnorr-sha256-jcs";
|
|
export const ED25519_SHA512_ALG = "ed25519-sha512-jcs";
|
|
export const COMPACT_PROOF_PREFIX = "kez:z1:";
|
|
export const COMPACT_CHAIN_PREFIX = "kez:zc1:";
|
|
|
|
export interface ClaimPayload {
|
|
type: typeof CLAIM_TYPE;
|
|
version: number;
|
|
subject: string; // serialized Identity
|
|
primary: string; // serialized Identity
|
|
created_at: string; // RFC 3339
|
|
expires_at?: string;
|
|
}
|
|
|
|
export interface SignatureBlock {
|
|
alg: string;
|
|
key: string; // serialized Identity (matches `primary`)
|
|
sig: string; // hex
|
|
}
|
|
|
|
export interface SignedClaimEnvelope {
|
|
kez: "claim";
|
|
payload: ClaimPayload;
|
|
signature: SignatureBlock;
|
|
}
|
|
|
|
/**
|
|
* Spec §6 sigchain event payload. Field order/names match Rust exactly so
|
|
* JCS-canonicalized bytes are byte-identical across implementations.
|
|
*/
|
|
export interface SigchainEventPayload {
|
|
type: typeof SIGCHAIN_EVENT_TYPE;
|
|
version: number;
|
|
primary: string; // serialized Identity, e.g. "nostr:npub1..."
|
|
seq: number;
|
|
prev?: string; // "sha256:<hex>" of prior envelope; omitted iff seq === 0
|
|
created_at: string;
|
|
op: SigchainOp;
|
|
payload: Record<string, unknown>;
|
|
}
|
|
|
|
export type SigchainOp = "add" | "revoke" | "rotate" | "add_device";
|
|
|
|
export interface SignedSigchainEvent {
|
|
kez: "sigchain_event";
|
|
payload: SigchainEventPayload;
|
|
signature: SignatureBlock;
|
|
}
|
|
|
|
/** Build a fresh ClaimPayload with the right `type` and `version` fields. */
|
|
export function newClaimPayload(
|
|
subject: Identity,
|
|
primary: Identity,
|
|
createdAt: Date,
|
|
): ClaimPayload {
|
|
return {
|
|
type: CLAIM_TYPE,
|
|
version: FORMAT_VERSION,
|
|
subject: subject.toString(),
|
|
primary: primary.toString(),
|
|
created_at: rfc3339Utc(createdAt),
|
|
};
|
|
}
|
|
|
|
/** RFC 3339 / ISO 8601 in UTC, matching the format Rust's chrono emits. */
|
|
export function rfc3339Utc(date: Date): string {
|
|
return date.toISOString().replace(/Z$/, "Z");
|
|
}
|