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

194 lines
6.5 KiB
Rust

//! Integration tests for the GitHub channel using a `wiremock` HTTP server
//! standing in for `api.github.com` and `raw.githubusercontent.com`.
use chrono::Utc;
use kez_channels::{Channel, ChannelError, github::GithubChannel};
use kez_core::{ClaimPayload, Identity, NostrSecret, SignedClaim};
use reqwest::Client;
use serde_json::json;
use wiremock::matchers::{header, method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};
fn sign(subject: &str) -> SignedClaim {
let secret = NostrSecret::generate();
let primary = Identity::parse(format!("nostr:{}", secret.npub())).unwrap();
let subject = Identity::parse(subject).unwrap();
SignedClaim::sign(ClaimPayload::new(subject, primary, Utc::now()), &secret).unwrap()
}
fn channel_pointing_at(server: &MockServer) -> GithubChannel {
let client = Client::builder()
.user_agent("kez-channels-test/0.1")
.build()
.unwrap();
GithubChannel::with_bases(client, server.uri(), server.uri())
}
#[tokio::test]
async fn verifies_proof_published_in_a_gist() {
let server = MockServer::start().await;
let signed = sign("github:jason");
let markdown = signed.to_markdown_proof().unwrap();
Mock::given(method("GET"))
.and(path("/users/jason/gists"))
.and(header("accept", "application/vnd.github+json"))
.respond_with(ResponseTemplate::new(200).set_body_json(json!([
{
"files": {
"notes.txt": {
"raw_url": format!("{}/raw/notes.txt", server.uri())
},
"github-jason.kez.md": {
"raw_url": format!("{}/raw/github-jason.kez.md", server.uri())
}
}
}
])))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/raw/github-jason.kez.md"))
.respond_with(ResponseTemplate::new(200).set_body_string(markdown))
.mount(&server)
.await;
let channel = channel_pointing_at(&server);
let identity = Identity::parse("github:jason").unwrap();
let hit = channel.fetch_and_verify(&identity).await.unwrap();
assert_eq!(hit.proof, signed);
}
#[tokio::test]
async fn falls_back_to_profile_readme_on_main() {
let server = MockServer::start().await;
let signed = sign("github:jason");
let markdown = signed.to_markdown_proof().unwrap();
// No matching gists.
Mock::given(method("GET"))
.and(path("/users/jason/gists"))
.respond_with(ResponseTemplate::new(200).set_body_json(json!([])))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/jason/jason/main/README.md"))
.respond_with(ResponseTemplate::new(200).set_body_string(markdown))
.mount(&server)
.await;
let channel = channel_pointing_at(&server);
let identity = Identity::parse("github:jason").unwrap();
let hit = channel.fetch_and_verify(&identity).await.unwrap();
assert_eq!(hit.proof, signed);
}
#[tokio::test]
async fn falls_back_to_master_when_main_missing() {
let server = MockServer::start().await;
let signed = sign("github:jason");
let markdown = signed.to_markdown_proof().unwrap();
Mock::given(method("GET"))
.and(path("/users/jason/gists"))
.respond_with(ResponseTemplate::new(200).set_body_json(json!([])))
.mount(&server)
.await;
// main is 404, master serves the proof.
Mock::given(method("GET"))
.and(path("/jason/jason/main/README.md"))
.respond_with(ResponseTemplate::new(404))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/jason/jason/master/README.md"))
.respond_with(ResponseTemplate::new(200).set_body_string(markdown))
.mount(&server)
.await;
let channel = channel_pointing_at(&server);
let identity = Identity::parse("github:jason").unwrap();
let hit = channel.fetch_and_verify(&identity).await.unwrap();
assert_eq!(hit.proof, signed);
}
#[tokio::test]
async fn rejects_proof_signed_for_wrong_subject() {
let server = MockServer::start().await;
// Signed for github:mallory, but published in jason's gist.
let signed = sign("github:mallory");
let markdown = signed.to_markdown_proof().unwrap();
Mock::given(method("GET"))
.and(path("/users/jason/gists"))
.respond_with(ResponseTemplate::new(200).set_body_json(json!([
{
"files": {
"kez.md": {
"raw_url": format!("{}/raw/kez.md", server.uri())
}
}
}
])))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/raw/kez.md"))
.respond_with(ResponseTemplate::new(200).set_body_string(markdown))
.mount(&server)
.await;
// No fallback README either.
Mock::given(method("GET"))
.and(path("/jason/jason/main/README.md"))
.respond_with(ResponseTemplate::new(404))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/jason/jason/master/README.md"))
.respond_with(ResponseTemplate::new(404))
.mount(&server)
.await;
let channel = channel_pointing_at(&server);
let identity = Identity::parse("github:jason").unwrap();
let err = channel.fetch_and_verify(&identity).await.unwrap_err();
assert!(
matches!(err, ChannelError::SubjectMismatch { .. }),
"expected SubjectMismatch, got {err:?}"
);
}
#[tokio::test]
async fn returns_not_found_when_no_proof_anywhere() {
let server = MockServer::start().await;
Mock::given(method("GET"))
.and(path("/users/jason/gists"))
.respond_with(ResponseTemplate::new(200).set_body_json(json!([])))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/jason/jason/main/README.md"))
.respond_with(ResponseTemplate::new(404))
.mount(&server)
.await;
Mock::given(method("GET"))
.and(path("/jason/jason/master/README.md"))
.respond_with(ResponseTemplate::new(404))
.mount(&server)
.await;
let channel = channel_pointing_at(&server);
let identity = Identity::parse("github:jason").unwrap();
let err = channel.fetch_and_verify(&identity).await.unwrap_err();
assert!(
matches!(err, ChannelError::NotFound(_) | ChannelError::Unreachable(_)),
"expected NotFound/Unreachable, got {err:?}"
);
}