auths-storage 0.0.1-rc.10

Storage backends for Auths identity system — Git and SQL adapters
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
//! Registry-based identity storage adapter.
//!
//! This module provides an adapter that implements [`IdentityStorage`] using
//! the [`GitRegistryBackend`]. This enables hexagonal architecture where
//! the CLI depends on traits rather than concrete implementations.
//!
//! # Architecture
//!
//! ```text
//! ┌─────────────────┐     ┌──────────────────────┐     ┌─────────────────────┐
//! │  CLI Commands   │────▶│  IdentityStorage     │◀────│  PackedRegistry     │
//! │                 │     │  (trait)             │     │  Backend            │
//! └─────────────────┘     └──────────────────────┘     └─────────────────────┘
//!//!                         ┌─────────┴─────────┐
//!                         │                   │
//!                         ▼                   ▼
//!               RegistryIdentity       (future adapters)
//!               Storage (this)
//! ```
//!
//! # Data Mapping
//!
//! - `controller_did` = `did:keri:{prefix}` (derived from KeyState)
//! - `storage_id` = repository directory name
//! - `metadata` = stored in `v1/identities/{shard}/{prefix}/metadata.json`

use std::path::PathBuf;

use auths_crypto::Pkcs8Der;

use auths_id::error::{InitError, StorageError};
use git2::Repository;
use serde::{Deserialize, Serialize};

use auths_core::storage::keychain::IdentityDID;
use auths_id::identity::helpers::ManagedIdentity;
use auths_id::storage::identity::IdentityStorage;

use super::adapter::{GitRegistryBackend, REGISTRY_REF};
use super::config::RegistryConfig;
use super::tree_ops::{TreeMutator, TreeNavigator};
use auths_id::ports::registry::RegistryBackend;
use auths_id::storage::registry::shard::identity_path;

/// Identity metadata stored alongside KERI events.
#[derive(Debug, Clone, Serialize, Deserialize)]
struct StoredMetadata {
    /// Schema version for forward compatibility
    version: u32,
    /// Arbitrary metadata JSON
    #[serde(skip_serializing_if = "Option::is_none")]
    metadata: Option<serde_json::Value>,
}

impl StoredMetadata {
    const CURRENT_VERSION: u32 = 1;

    fn new(metadata: Option<serde_json::Value>) -> Self {
        Self {
            version: Self::CURRENT_VERSION,
            metadata,
        }
    }
}

/// Registry-based implementation of [`IdentityStorage`].
///
/// Uses [`GitRegistryBackend`] to store identity data in the registry tree.
/// Identity metadata is stored in `v1/identities/{shard}/{prefix}/metadata.json`.
///
/// # Example
///
/// ```rust,ignore
/// use auths_storage::git::RegistryIdentityStorage;
/// use auths_id::storage::identity::IdentityStorage;
///
/// let storage = RegistryIdentityStorage::new("/path/to/repo");
/// let identity = storage.load_identity()?;
/// println!("Controller: {}", identity.controller_did);
/// ```
pub struct RegistryIdentityStorage {
    repo_path: PathBuf,
    backend: GitRegistryBackend,
}

impl RegistryIdentityStorage {
    /// Create a new registry identity storage for the given repository.
    pub fn new(repo_path: impl Into<PathBuf>) -> Self {
        let repo_path = repo_path.into();
        let backend =
            GitRegistryBackend::from_config_unchecked(RegistryConfig::single_tenant(&repo_path));
        Self { repo_path, backend }
    }

    /// Initialize the registry if needed and create a KERI identity.
    ///
    /// This is the registry equivalent of identity initialization.
    /// It creates a KERI inception event and stores it in the registry,
    /// along with optional metadata.
    ///
    /// # Returns
    ///
    /// A tuple of (controller_did, InceptionResult) where InceptionResult
    /// contains the keypairs for storage.
    pub fn initialize_identity(
        &self,
        metadata: Option<serde_json::Value>,
        witness_config: Option<&auths_id::witness_config::WitnessConfig>,
    ) -> Result<(String, auths_id::keri::InceptionResult), InitError> {
        use auths_core::crypto::said::compute_next_commitment;
        use auths_id::keri::{
            Event, IcpEvent, InceptionResult, KERI_VERSION, KeriSequence, Prefix, Said,
            finalize_icp_event, serialize_for_signing,
        };
        use base64::{Engine, engine::general_purpose::URL_SAFE_NO_PAD};
        use ring::rand::SystemRandom;
        use ring::signature::{Ed25519KeyPair, KeyPair};

        // Initialize registry if needed
        self.backend
            .init_if_needed()
            .map_err(|e| InitError::Registry(format!("Failed to initialize registry: {e}")))?;

        // Generate keypairs
        let rng = SystemRandom::new();
        let current_pkcs8 = Ed25519KeyPair::generate_pkcs8(&rng)
            .map_err(|e| InitError::Crypto(format!("Key generation failed: {e}")))?;
        let current_keypair = Ed25519KeyPair::from_pkcs8(current_pkcs8.as_ref())
            .map_err(|e| InitError::Crypto(format!("Key parsing failed: {e}")))?;

        let next_pkcs8 = Ed25519KeyPair::generate_pkcs8(&rng)
            .map_err(|e| InitError::Crypto(format!("Key generation failed: {e}")))?;
        let next_keypair = Ed25519KeyPair::from_pkcs8(next_pkcs8.as_ref())
            .map_err(|e| InitError::Crypto(format!("Key parsing failed: {e}")))?;

        // Encode current public key with derivation code prefix
        let current_pub_encoded = format!(
            "D{}",
            URL_SAFE_NO_PAD.encode(current_keypair.public_key().as_ref())
        );

        // Compute next-key commitment
        let next_commitment = compute_next_commitment(next_keypair.public_key().as_ref());

        // Determine witness fields from config
        let (bt, b) = match witness_config {
            Some(cfg) if cfg.is_enabled() => (
                cfg.threshold.to_string(),
                cfg.witness_urls.iter().map(|u| u.to_string()).collect(),
            ),
            _ => ("0".to_string(), vec![]),
        };

        // Build inception event
        let icp = IcpEvent {
            v: KERI_VERSION.to_string(),
            d: Said::default(),
            i: Prefix::default(),
            s: KeriSequence::new(0),
            kt: "1".to_string(),
            k: vec![current_pub_encoded],
            nt: "1".to_string(),
            n: vec![next_commitment],
            bt,
            b,
            a: vec![],
            x: String::new(),
        };

        // Finalize event (computes SAID)
        let mut finalized = finalize_icp_event(icp)
            .map_err(|e| InitError::Keri(format!("Failed to finalize ICP: {e}")))?;
        let prefix = finalized.i.clone();

        // Sign the event
        let canonical = serialize_for_signing(&Event::Icp(finalized.clone()))
            .map_err(|e| InitError::Keri(format!("Failed to serialize for signing: {e}")))?;
        let sig = current_keypair.sign(&canonical);
        finalized.x = URL_SAFE_NO_PAD.encode(sig.as_ref());

        // Store event in packed registry
        self.backend
            .append_event(&prefix, &Event::Icp(finalized))
            .map_err(|e| InitError::Registry(format!("Failed to store event in registry: {e}")))?;

        let controller_did = format!("did:keri:{}", prefix);

        // Store metadata if provided
        if metadata.is_some() {
            self.store_metadata(&prefix, metadata)?;
        }

        Ok((
            controller_did,
            InceptionResult {
                prefix,
                current_keypair_pkcs8: Pkcs8Der::new(current_pkcs8.as_ref()),
                next_keypair_pkcs8: Pkcs8Der::new(next_pkcs8.as_ref()),
                current_public_key: current_keypair.public_key().as_ref().to_vec(),
                next_public_key: next_keypair.public_key().as_ref().to_vec(),
            },
        ))
    }

    /// Store metadata for an identity.
    fn store_metadata(
        &self,
        prefix: &auths_verifier::keri::Prefix,
        metadata: Option<serde_json::Value>,
    ) -> Result<(), StorageError> {
        let repo = Repository::open(&self.repo_path)?;

        // Get current registry tree
        let registry_ref = repo.find_reference(REGISTRY_REF)?;
        let commit = registry_ref.peel_to_commit()?;
        let tree = commit.tree()?;

        // Build metadata path
        let id_path = identity_path(prefix)
            .map_err(|e| StorageError::InvalidData(format!("Invalid prefix: {}", e)))?;
        let metadata_path = format!("{}/metadata.json", id_path);

        // Serialize metadata
        let stored = StoredMetadata::new(metadata);
        let json = serde_json::to_vec_pretty(&stored)?;

        // Write to tree
        let mut mutator = TreeMutator::new();
        mutator.write_blob(&metadata_path, json);
        let new_tree_oid = mutator
            .build_tree(&repo, Some(&tree))
            .map_err(|e| StorageError::InvalidData(e.to_string()))?;
        let new_tree = repo.find_tree(new_tree_oid)?;

        // Create commit
        #[allow(clippy::disallowed_methods)]
        let now = chrono::Utc::now();
        let sig =
            git2::Signature::new("auths", "auths@local", &git2::Time::new(now.timestamp(), 0))?;
        let parent = &[&commit];
        repo.commit(
            Some(REGISTRY_REF),
            &sig,
            &sig,
            "Store identity metadata",
            &new_tree,
            parent,
        )?;

        Ok(())
    }

    /// Load metadata for an identity.
    fn load_metadata(
        &self,
        prefix: &auths_verifier::keri::Prefix,
    ) -> Result<Option<serde_json::Value>, StorageError> {
        let repo = Repository::open(&self.repo_path)?;

        let registry_ref = match repo.find_reference(REGISTRY_REF) {
            Ok(r) => r,
            Err(_) => return Ok(None),
        };

        let commit = registry_ref.peel_to_commit()?;
        let tree = commit.tree()?;

        let id_path = identity_path(prefix)
            .map_err(|e| StorageError::InvalidData(format!("Invalid prefix: {}", e)))?;
        let metadata_path = format!("{}/metadata.json", id_path);

        let nav = TreeNavigator::new(&repo, tree);
        match nav.read_blob_path(&metadata_path) {
            Ok(bytes) => {
                let stored: StoredMetadata = serde_json::from_slice(&bytes)?;
                Ok(stored.metadata)
            }
            Err(_) => Ok(None),
        }
    }

    /// Get the storage ID (repository directory name).
    fn get_storage_id(&self) -> String {
        self.repo_path
            .file_name()
            .and_then(|n| n.to_str())
            .unwrap_or("unknown")
            .to_string()
    }

    /// Find the first identity prefix in the registry.
    fn find_first_identity(&self) -> Result<Option<String>, StorageError> {
        use std::ops::ControlFlow;

        let mut prefix = None;
        self.backend
            .visit_identities(&mut |p| {
                prefix = Some(p.to_string());
                ControlFlow::Break(())
            })
            .map_err(|e| StorageError::InvalidData(format!("Failed to visit identities: {}", e)))?;

        Ok(prefix)
    }
}

impl IdentityStorage for RegistryIdentityStorage {
    fn create_identity(
        &self,
        controller_did: &str,
        metadata: Option<serde_json::Value>,
    ) -> Result<(), StorageError> {
        use auths_verifier::keri::Prefix;

        // Extract prefix from controller_did (did:keri:{prefix})
        let prefix_str = controller_did.strip_prefix("did:keri:").ok_or_else(|| {
            StorageError::InvalidData(format!("Invalid controller DID format: {}", controller_did))
        })?;
        let prefix = Prefix::new_unchecked(prefix_str.to_string());

        // Store metadata for this identity
        self.store_metadata(&prefix, metadata)?;

        Ok(())
    }

    fn load_identity(&self) -> Result<ManagedIdentity, StorageError> {
        use auths_verifier::keri::Prefix;

        // Find the first (and typically only) identity in the registry
        let prefix_str = self
            .find_first_identity()?
            .ok_or_else(|| StorageError::NotFound("No identity found in registry".to_string()))?;
        let prefix = Prefix::new_unchecked(prefix_str.clone());

        // Load key state to verify identity exists
        self.backend
            .get_key_state(&prefix)
            .map_err(|e| StorageError::InvalidData(format!("Failed to load key state: {}", e)))?;

        // Build controller DID
        let controller_did = format!("did:keri:{}", prefix_str);

        // Load metadata
        let metadata = self.load_metadata(&prefix)?;

        #[allow(clippy::disallowed_methods)]
        // INVARIANT: controller_did is derived from a validated KERI prefix via format!("did:keri:{}", prefix_str)
        let controller_did = IdentityDID::new_unchecked(controller_did);
        Ok(ManagedIdentity {
            controller_did,
            storage_id: self.get_storage_id(),
            metadata,
        })
    }

    fn get_identity_ref(&self) -> Result<String, StorageError> {
        Ok(REGISTRY_REF.to_string())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::TempDir;

    fn setup_test_repo() -> (TempDir, RegistryIdentityStorage) {
        let dir = TempDir::new().unwrap();
        Repository::init(dir.path()).unwrap();
        let storage = RegistryIdentityStorage::new(dir.path());
        (dir, storage)
    }

    #[test]
    fn test_get_identity_ref() {
        let (_dir, storage) = setup_test_repo();
        let ref_name = storage.get_identity_ref().unwrap();
        assert_eq!(ref_name, "refs/auths/registry");
    }

    #[test]
    fn test_initialize_and_load_identity() {
        let (_dir, storage) = setup_test_repo();

        // Initialize with metadata
        let metadata = serde_json::json!({
            "name": "Test Identity",
            "created": "2024-01-01"
        });

        let (did, _result) = storage
            .initialize_identity(Some(metadata.clone()), None)
            .unwrap();
        assert!(did.starts_with("did:keri:"));

        // Load identity
        let identity = storage.load_identity().unwrap();
        assert_eq!(identity.controller_did, did.as_str());
        assert!(identity.metadata.is_some());
        assert_eq!(identity.metadata.as_ref().unwrap()["name"], "Test Identity");
    }

    #[test]
    fn test_load_identity_without_metadata() {
        let (_dir, storage) = setup_test_repo();

        // Initialize without metadata
        let (did, _result) = storage.initialize_identity(None, None).unwrap();

        // Load identity
        let identity = storage.load_identity().unwrap();
        assert_eq!(identity.controller_did, did.as_str());
        assert!(identity.metadata.is_none());
    }

    #[test]
    fn test_load_identity_not_found() {
        let (_dir, storage) = setup_test_repo();

        // Initialize registry but don't create identity
        storage.backend.init_if_needed().unwrap();

        let result = storage.load_identity();
        assert!(result.is_err());
    }
}