Something went wrong. Try again.
A lexicon-driven AppView for ATProto. forked from gamesgamesgamesgames.games/happyview
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669//! Attestation signing for plugin records.//!//! Implements the ATProtocol attestation spec://! - Computes CID with $sig metadata for replay protection//! - Signs using ECDSA (P-256 or K-256)//! - Adds inline signatures to records
use cid::Cid;use k256::ecdsa::{Signature, SigningKey, signature::Signer};use serde_json::{Map, Value};use sha2::{Digest, Sha256};use std::sync::Arc;
// Multihash code for SHA2-256const SHA2_256_CODE: u64 = 0x12;// DAG-CBOR codecconst DAG_CBOR_CODEC: u64 = 0x71;
/// Attestation signer for HappyViewpub struct AttestationSigner { /// The signing key (K-256/secp256k1) signing_key: SigningKey, /// The key identifier (e.g., "did:web:happyview.example#attestation") key_id: String, /// The signature type identifier sig_type: String,}
#[derive(Debug, thiserror::Error)]pub enum AttestationError { #[error("Failed to encode record: {0}")] Encoding(String), #[error("Failed to sign: {0}")] Signing(String), #[error("Invalid key: {0}")] InvalidKey(String), #[error("Record missing required field: {0}")] MissingField(String),}
impl AttestationSigner { /// Create a new signer from a hex-encoded private key pub fn from_hex( private_key_hex: &str, key_id: String, sig_type: String, ) -> Result<Self, AttestationError> { let key_bytes = hex::decode(private_key_hex) .map_err(|e| AttestationError::InvalidKey(format!("invalid hex: {}", e)))?;
let signing_key = SigningKey::from_slice(&key_bytes[..]) .map_err(|e| AttestationError::InvalidKey(format!("invalid key: {}", e)))?;
Ok(Self { signing_key, key_id, sig_type, }) }
/// Create a new signer with a test key (for testing only) #[cfg(test)] pub fn for_testing(key_id: String, sig_type: String) -> Self { // Fixed test key (32 bytes of 0x01) - DO NOT USE IN PRODUCTION let test_key_bytes = [0x01u8; 32]; let signing_key = SigningKey::from_slice(&test_key_bytes[..]).expect("valid test key"); Self { signing_key, key_id, sig_type, } }
/// Get the public key in compressed format (for verification) pub fn public_key_bytes(&self) -> Vec<u8> { use k256::ecdsa::VerifyingKey; let verifying_key = VerifyingKey::from(&self.signing_key); verifying_key.to_sec1_point(true).as_bytes().to_vec() }
/// Sign a record and add the signature to the signatures array. /// /// # Arguments /// * `record` - The record to sign (will be modified to add signature) /// * `repository_did` - The DID of the repository (for replay protection) /// /// # Returns /// The CID of the signed content pub fn sign_record( &self, record: &mut Value, repository_did: &str, ) -> Result<Cid, AttestationError> { let obj = record .as_object_mut() .ok_or_else(|| AttestationError::Encoding("record must be an object".into()))?;
// Remove existing signatures for CID computation let existing_signatures = obj.remove("signatures");
// Inject $sig metadata for CID computation let sig_metadata = serde_json::json!({ "$type": &self.sig_type, "repository": repository_did, }); obj.insert("$sig".to_string(), sig_metadata);
// Encode to CBOR (DAG-CBOR canonical form) let cbor_bytes = self.encode_dag_cbor(obj)?;
// Compute CID (sha2-256, dag-cbor codec) let cid = self.compute_cid(&cbor_bytes);
// Remove $sig (it's only for CID computation) obj.remove("$sig");
// Sign the CID bytes let signature = self.sign_cid(&cid)?;
// Create inline signature object let inline_sig = serde_json::json!({ "$type": &self.sig_type, "key": &self.key_id, "signature": { "$bytes": base64::Engine::encode(&base64::engine::general_purpose::STANDARD, &signature) } });
// Add to signatures array let signatures = obj .entry("signatures") .or_insert_with(|| Value::Array(vec![]));
if let Value::Array(arr) = signatures { // Restore any existing signatures if let Some(Value::Array(existing)) = existing_signatures { for sig in existing { arr.push(sig); } } arr.push(inline_sig); }
Ok(cid) }
/// Encode a JSON object to DAG-CBOR canonical form fn encode_dag_cbor(&self, obj: &Map<String, Value>) -> Result<Vec<u8>, AttestationError> { // Convert to ciborium Value and encode // DAG-CBOR requires deterministic key ordering (lexicographic) let cbor_value = json_to_cbor(&Value::Object(obj.clone()));
let mut buf = Vec::new(); ciborium::into_writer(&cbor_value, &mut buf) .map_err(|e| AttestationError::Encoding(format!("CBOR encoding failed: {}", e)))?;
Ok(buf) }
/// Compute CID from CBOR bytes (sha2-256, dag-cbor codec) fn compute_cid(&self, cbor_bytes: &[u8]) -> Cid { // SHA2-256 hash let digest = Sha256::digest(cbor_bytes);
// Create multihash: varint(code) || varint(size) || digest let mut multihash_bytes = Vec::new(); // SHA2-256 code (0x12) multihash_bytes.push(SHA2_256_CODE as u8); // Digest size (32 bytes) multihash_bytes.push(32u8); // The digest multihash_bytes.extend_from_slice(&digest);
let multihash = cid::multihash::Multihash::<64>::from_bytes(&multihash_bytes).expect("valid multihash");
// CID v1 with dag-cbor codec Cid::new_v1(DAG_CBOR_CODEC, multihash) }
/// Sign a CID using ECDSA with low-S normalization fn sign_cid(&self, cid: &Cid) -> Result<Vec<u8>, AttestationError> { let cid_bytes = cid.to_bytes();
// Sign using k256 ECDSA (automatically uses low-S) let signature: Signature = self.signing_key.sign(&cid_bytes);
Ok(signature.to_bytes().to_vec()) }
/// Verify that a signature in a record was produced by this signer. /// /// Recomputes the CID from the record (same process as signing) and verifies /// the ECDSA signature using our public key. pub fn verify_record_signature( &self, record: &Value, signature_obj: &Value, repository_did: &str, ) -> Result<bool, AttestationError> { use k256::ecdsa::{VerifyingKey, signature::Verifier};
// Check key ID matches let key = signature_obj .get("key") .and_then(|k| k.as_str()) .ok_or_else(|| AttestationError::MissingField("signature.key".into()))?;
if key != self.key_id { return Ok(false); }
// Extract signature bytes let sig_bytes_b64 = signature_obj .get("signature") .and_then(|s| s.get("$bytes")) .and_then(|b| b.as_str()) .ok_or_else(|| AttestationError::MissingField("signature.signature.$bytes".into()))?;
let sig_bytes = base64::Engine::decode(&base64::engine::general_purpose::STANDARD, sig_bytes_b64) .map_err(|e| AttestationError::Encoding(format!("invalid base64: {e}")))?;
let signature = Signature::from_slice(&sig_bytes[..]) .map_err(|e| AttestationError::Signing(format!("invalid signature bytes: {e}")))?;
// Recompute CID from record (same as signing) let mut obj = record .as_object() .ok_or_else(|| AttestationError::Encoding("record must be an object".into()))? .clone();
// Remove signatures for CID computation obj.remove("signatures");
// Inject $sig metadata let sig_metadata = serde_json::json!({ "$type": &self.sig_type, "repository": repository_did, }); obj.insert("$sig".to_string(), sig_metadata);
let cbor_bytes = self.encode_dag_cbor(&obj)?; let cid = self.compute_cid(&cbor_bytes);
// Verify let verifying_key = VerifyingKey::from(&self.signing_key); Ok(verifying_key.verify(&cid.to_bytes(), &signature).is_ok()) }}
/// Convert JSON Value to ciborium Value with deterministic orderingfn json_to_cbor(value: &Value) -> ciborium::Value { match value { Value::Null => ciborium::Value::Null, Value::Bool(b) => ciborium::Value::Bool(*b), Value::Number(n) => { if let Some(i) = n.as_i64() { ciborium::Value::Integer(i.into()) } else if let Some(u) = n.as_u64() { ciborium::Value::Integer(u.into()) } else if let Some(f) = n.as_f64() { ciborium::Value::Float(f) } else { ciborium::Value::Null } } Value::String(s) => { // Check for $bytes encoding (base64) ciborium::Value::Text(s.clone()) } Value::Array(arr) => ciborium::Value::Array(arr.iter().map(json_to_cbor).collect()), Value::Object(obj) => { // Handle special $bytes encoding for binary data if obj.len() == 1 && let Some(Value::String(b64)) = obj.get("$bytes") && let Ok(bytes) = base64::Engine::decode(&base64::engine::general_purpose::STANDARD, b64) { return ciborium::Value::Bytes(bytes); }
// Sort keys lexicographically for deterministic encoding let mut pairs: Vec<_> = obj .iter() .map(|(k, v)| (ciborium::Value::Text(k.clone()), json_to_cbor(v))) .collect(); pairs.sort_by(|a, b| { if let (ciborium::Value::Text(ka), ciborium::Value::Text(kb)) = (&a.0, &b.0) { ka.cmp(kb) } else { std::cmp::Ordering::Equal } });
ciborium::Value::Map(pairs) } }}
/// Shared attestation signer for the applicationpub type SharedAttestationSigner = Arc<AttestationSigner>;
/// Load attestation signer from environment variables.////// Returns `Ok(None)` when no `ATTESTATION_PRIVATE_KEY` is set.pub fn load_from_env() -> Result<Option<AttestationSigner>, AttestationError> { let private_key = match std::env::var("ATTESTATION_PRIVATE_KEY") { Ok(k) => k, Err(_) => return Ok(None), };
let key_id = std::env::var("ATTESTATION_KEY_ID") .unwrap_or_else(|_| "did:web:localhost#attestation".to_string());
let sig_type = std::env::var("ATTESTATION_SIG_TYPE") .unwrap_or_else(|_| "games.gamesgamesgamesgames.attestation".to_string());
Ok(Some(AttestationSigner::from_hex( &private_key, key_id, sig_type, )?))}
/// Load or auto-generate the attestation signer.////// Priority order:/// 1. Environment variables (`ATTESTATION_PRIVATE_KEY`, etc.)/// 2. `instance_settings` table in the database/// 3. Generate a fresh key, persist it to `instance_settings`, and use it////// `key_id` is derived from `public_url` when not explicitly set:/// `did:web:{host}#attestation`pub async fn load_or_generate( db: &sqlx::AnyPool, backend: crate::db::DatabaseBackend, public_url: &str,) -> Result<AttestationSigner, AttestationError> { use crate::db::adapt_sql;
// 1. Try env vars first (explicit override) if let Some(signer) = load_from_env()? { tracing::info!("Attestation signer loaded from environment variables"); return Ok(signer); }
// Derive default key_id from public_url (extract host without adding a url crate dep) let host = public_url .strip_prefix("https://") .or_else(|| public_url.strip_prefix("http://")) .unwrap_or(public_url) .split('/') .next() .unwrap_or("localhost") .split(':') .next() .unwrap_or("localhost") .to_string(); let default_key_id = format!("did:web:{host}#attestation"); let default_sig_type = "games.gamesgamesgamesgames.attestation".to_string();
// 2. Try loading from instance_settings let sql = adapt_sql( "SELECT value FROM happyview_instance_settings WHERE key = ?", backend, ); let existing: Option<(String,)> = crate::db::query_as(&sql) .bind("attestation_private_key") .fetch_optional(db) .await .map_err(|e| AttestationError::Encoding(format!("db query failed: {e}")))?;
if let Some((hex_key,)) = existing { // Load key_id and sig_type from DB too (or use defaults) let key_id: Option<(String,)> = crate::db::query_as(&sql) .bind("attestation_key_id") .fetch_optional(db) .await .map_err(|e| AttestationError::Encoding(format!("db query failed: {e}")))?; let sig_type: Option<(String,)> = crate::db::query_as(&sql) .bind("attestation_sig_type") .fetch_optional(db) .await .map_err(|e| AttestationError::Encoding(format!("db query failed: {e}")))?;
tracing::info!("Attestation signer loaded from database"); return AttestationSigner::from_hex( &hex_key, key_id.map(|r| r.0).unwrap_or(default_key_id), sig_type.map(|r| r.0).unwrap_or(default_sig_type), ); }
// 3. Generate a new key and persist it tracing::info!("Generating new attestation signing key"); let hex_key = { // Generate 32 random bytes for a K-256 private key use rand::Rng; let mut key_bytes = [0u8; 32]; rand::rng().fill_bytes(&mut key_bytes); // Validate it's a valid K-256 scalar by trying to construct a SigningKey let _ = SigningKey::from_slice(&key_bytes[..]) .map_err(|e| AttestationError::InvalidKey(format!("generated invalid key: {e}")))?; hex::encode(key_bytes) };
let upsert_sql = adapt_sql( "INSERT INTO happyview_instance_settings (key, value, updated_at) VALUES (?, ?, ?) \ ON CONFLICT (key) DO UPDATE SET value = excluded.value, updated_at = excluded.updated_at", backend, ); let now = crate::db::now_rfc3339();
for (k, v) in [ ("attestation_private_key", hex_key.as_str()), ("attestation_key_id", default_key_id.as_str()), ("attestation_sig_type", default_sig_type.as_str()), ] { crate::db::query(&upsert_sql) .bind(k) .bind(v) .bind(&now) .execute(db) .await .map_err(|e| AttestationError::Encoding(format!("failed to persist key: {e}")))?; }
tracing::info!(key_id = %default_key_id, "Attestation signing key generated and persisted");
AttestationSigner::from_hex(&hex_key, default_key_id, default_sig_type)}
#[cfg(test)]mod tests { use super::*;
#[test] fn test_sign_record() { let signer = AttestationSigner::for_testing( "did:web:test.example#signing".to_string(), "test.signature".to_string(), );
let mut record = serde_json::json!({ "$type": "games.gamesgamesgamesgames.actor.game", "game": {"platform": "steam", "externalId": "440"}, "platform": "steam", "createdAt": "2024-01-01T00:00:00Z" });
let cid = signer .sign_record(&mut record, "did:plc:testuser") .expect("signing should succeed");
// Verify signature was added let signatures = record["signatures"].as_array().expect("signatures array"); assert_eq!(signatures.len(), 1);
let sig = &signatures[0]; assert_eq!(sig["$type"], "test.signature"); assert_eq!(sig["key"], "did:web:test.example#signing"); assert!(sig["signature"]["$bytes"].is_string());
// CID should be valid assert!(!cid.to_bytes().is_empty()); }
#[test] fn test_deterministic_cid() { let signer = AttestationSigner::for_testing( "did:web:test.example#signing".to_string(), "test.signature".to_string(), );
// Same record should produce same CID (before signature) let record1 = serde_json::json!({ "a": 1, "b": 2, "c": {"nested": true} });
let record2 = serde_json::json!({ "c": {"nested": true}, "a": 1, "b": 2 });
let mut r1 = record1.clone(); let mut r2 = record2.clone();
let cid1 = signer.sign_record(&mut r1, "did:plc:test").unwrap(); let cid2 = signer.sign_record(&mut r2, "did:plc:test").unwrap();
// Different signatures (random nonce in ECDSA) but... // Actually the CIDs should be the same since they're computed before signing // and the key ordering is normalized assert_eq!(cid1, cid2); }
#[test] fn test_verify_record_signature() { let signer = AttestationSigner::for_testing( "did:web:test.example#signing".to_string(), "test.signature".to_string(), );
let original = serde_json::json!({ "$type": "games.gamesgamesgamesgames.contribution", "contributionType": "correction", "changes": {"name": "Fixed Name"}, "createdAt": "2024-01-01T00:00:00Z" });
let mut record = original.clone(); signer .sign_record(&mut record, "did:plc:contributor") .expect("signing should succeed");
let sig = &record["signatures"].as_array().unwrap()[0];
// Verification should succeed with correct DID assert!( signer .verify_record_signature(&record, sig, "did:plc:contributor") .unwrap() );
// Verification should fail with wrong DID (replay protection) assert!( !signer .verify_record_signature(&record, sig, "did:plc:wrong") .unwrap() ); }
#[test] fn test_verify_rejects_wrong_key_id() { let signer = AttestationSigner::for_testing( "did:web:test.example#signing".to_string(), "test.signature".to_string(), );
let forged_sig = serde_json::json!({ "$type": "test.signature", "key": "did:web:evil.example#signing", "signature": { "$bytes": "AAAA" } });
let record = serde_json::json!({ "contributionType": "correction", "changes": {"name": "test"} });
assert!( !signer .verify_record_signature(&record, &forged_sig, "did:plc:test") .unwrap() ); }
#[test] fn test_verify_rejects_tampered_record() { let signer = AttestationSigner::for_testing( "did:web:test.example#signing".to_string(), "test.signature".to_string(), );
let mut record = serde_json::json!({ "contributionType": "correction", "changes": {"name": "Original"}, "createdAt": "2024-01-01T00:00:00Z" });
signer .sign_record(&mut record, "did:plc:test") .expect("signing should succeed");
let sig = record["signatures"].as_array().unwrap()[0].clone();
// Tamper with the record record["changes"]["name"] = serde_json::json!("Tampered");
// Verification should fail assert!( !signer .verify_record_signature(&record, &sig, "did:plc:test") .unwrap() ); }
#[tokio::test] async fn test_load_or_generate_creates_key() { sqlx::any::install_default_drivers(); let pool = sqlx::pool::PoolOptions::new() .max_connections(1) .connect("sqlite::memory:") .await .unwrap(); crate::db::query( "CREATE TABLE happyview_instance_settings (key TEXT PRIMARY KEY, value TEXT NOT NULL, updated_at TEXT NOT NULL DEFAULT '')", ) .execute(&pool) .await .unwrap();
let signer = load_or_generate( &pool, crate::db::DatabaseBackend::Sqlite, "https://happyview.example.com", ) .await .expect("should generate a key");
// Key ID should be derived from public_url assert_eq!(signer.key_id, "did:web:happyview.example.com#attestation");
// Should be persisted — loading again returns the same key let signer2 = load_or_generate( &pool, crate::db::DatabaseBackend::Sqlite, "https://happyview.example.com", ) .await .expect("should load from DB");
// Same key → same public key bytes assert_eq!(signer.public_key_bytes(), signer2.public_key_bytes()); }
#[tokio::test] async fn test_load_or_generate_sign_verify_roundtrip() { sqlx::any::install_default_drivers(); let pool = sqlx::pool::PoolOptions::new() .max_connections(1) .connect("sqlite::memory:") .await .unwrap(); crate::db::query( "CREATE TABLE happyview_instance_settings (key TEXT PRIMARY KEY, value TEXT NOT NULL, updated_at TEXT NOT NULL DEFAULT '')", ) .execute(&pool) .await .unwrap();
let signer = load_or_generate( &pool, crate::db::DatabaseBackend::Sqlite, "https://example.com", ) .await .unwrap();
let mut record = serde_json::json!({ "contributionType": "correction", "changes": {"name": "Test"}, });
signer.sign_record(&mut record, "did:plc:user123").unwrap();
let sig = &record["signatures"].as_array().unwrap()[0]; assert!( signer .verify_record_signature(&record, sig, "did:plc:user123") .unwrap() ); }}