cyphr-cli 0.1.0

Reference CLI for the Cyphr identity protocol
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
//! Integration tests for cyphr CLI.
//!
//! These tests exercise the CLI binary through `std::process::Command`,
//! validating complete workflows in isolation.

use std::path::PathBuf;
use std::process::Command;

use tempfile::TempDir;

/// Test helper for invoking the CLI.
struct CliTest {
    /// Temporary directory for test isolation.
    temp_dir: TempDir,
    /// Path to the CLI binary.
    binary: PathBuf,
}

impl CliTest {
    fn new() -> Self {
        let temp_dir = TempDir::new().expect("failed to create temp dir");

        // Find the binary - cargo test puts it in target/debug
        let binary = std::env::current_exe()
            .expect("current_exe")
            .parent()
            .expect("parent")
            .parent()
            .expect("parent")
            .join("cyphr");

        Self { temp_dir, binary }
    }

    fn keystore_path(&self) -> PathBuf {
        self.temp_dir.path().join("keys.json")
    }

    fn store_path(&self) -> PathBuf {
        self.temp_dir.path().join("data")
    }

    fn store_uri(&self) -> String {
        format!("file:{}", self.store_path().display())
    }

    /// Run the CLI with given arguments, returning stdout.
    fn run(&self, args: &[&str]) -> Result<String, String> {
        let mut cmd = Command::new(&self.binary);
        cmd.arg("--keystore")
            .arg(self.keystore_path())
            .arg("--store")
            .arg(self.store_uri())
            .args(args);

        let output = cmd.output().expect("failed to execute CLI");

        if output.status.success() {
            Ok(String::from_utf8_lossy(&output.stdout).to_string())
        } else {
            Err(String::from_utf8_lossy(&output.stderr).to_string())
        }
    }

    /// Run and assert success, returning stdout.
    fn run_ok(&self, args: &[&str]) -> String {
        match self.run(args) {
            Ok(out) => out,
            Err(err) => panic!("CLI command failed: {err}\nArgs: {args:?}"),
        }
    }

    /// Run with JSON output and parse a field.
    fn run_json(&self, args: &[&str]) -> serde_json::Value {
        let mut full_args = vec!["--output", "json"];
        full_args.extend(args);
        let out = self.run_ok(&full_args);
        serde_json::from_str(&out).expect("invalid JSON output")
    }
}

#[test]
fn test_key_generate() {
    let cli = CliTest::new();

    let json = cli.run_json(&["key", "generate", "--algo", "ES256", "--tag", "test-key"]);

    assert_eq!(json["alg"], "ES256");
    assert_eq!(json["tag"], "test-key");
    assert!(json["tmb"].as_str().is_some(), "should have thumbprint");
}

#[test]
fn test_key_lifecycle() {
    let cli = CliTest::new();

    // 1. Generate genesis key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256", "--tag", "genesis"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // 2. Add a new key to identity (this creates the first coz)
    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let signer_arg = format!("--signer={genesis_tmb}");
    let add_result = cli.run_json(&["key", "add", &identity_arg, &signer_arg]);
    let new_key_tmb = add_result["added_key"].as_str().unwrap();

    // 3. List keys - should show both (field is "active_keys")
    let list_result = cli.run_json(&["key", "list", &identity_arg]);
    let keys = list_result["active_keys"].as_array().unwrap();
    assert_eq!(keys.len(), 2, "should have 2 active keys");

    // 4. Revoke the new key (self-revoke: the key signs its own revocation)
    // Per SPEC §4.2.4, only self-revoke is supported
    let key_arg = format!("--key={new_key_tmb}");
    let new_key_signer = format!("--signer={new_key_tmb}");
    let _ = cli.run_ok(&["key", "revoke", &identity_arg, &key_arg, &new_key_signer]);

    // 5. List keys - should show only genesis
    let list_result = cli.run_json(&["key", "list", &identity_arg]);
    let keys = list_result["active_keys"].as_array().unwrap();
    assert_eq!(keys.len(), 1, "should have 1 active key after revoke");
    // Key order is not guaranteed, check that genesis key is present
    assert!(
        keys.iter().any(|k| k["tmb"].as_str() == Some(genesis_tmb)),
        "genesis key should be in active keys"
    );
}

#[test]
fn test_export_import_roundtrip() {
    let cli = CliTest::new();

    // 1. Generate key and create identity with coz
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let signer_arg = format!("--signer={genesis_tmb}");
    let _ = cli.run_ok(&["key", "add", &identity_arg, &signer_arg]);

    // 2. Export to file
    let export_path = cli.temp_dir.path().join("export.jsonl");
    let output_path_arg = format!("--output={}", export_path.to_str().unwrap());
    let _ = cli.run_ok(&["export", &identity_arg, &output_path_arg]);

    assert!(export_path.exists(), "export file should exist");

    // 3. Create new storage location for import
    let import_store = cli.temp_dir.path().join("import-data");
    let import_uri = format!("file:{}", import_store.display());

    // 4. Import to new storage
    let mut cmd = Command::new(&cli.binary);
    cmd.arg("--keystore")
        .arg(cli.keystore_path())
        .arg("--store")
        .arg(&import_uri)
        .arg("import")
        .arg("--input")
        .arg(&export_path);

    let output = cmd.output().expect("import failed");
    assert!(
        output.status.success(),
        "import should succeed, but got stderr: {}",
        String::from_utf8_lossy(&output.stderr)
    );

    // 5. List keys from imported store to verify (field is "active_keys")
    let mut cmd = Command::new(&cli.binary);
    cmd.arg("--keystore")
        .arg(cli.keystore_path())
        .arg("--store")
        .arg(&import_uri)
        .arg("--output")
        .arg("json")
        .arg("key")
        .arg("list")
        .arg("--identity")
        .arg(genesis_tmb);

    let output = cmd.output().expect("list failed");
    assert!(output.status.success(), "list should succeed");

    let list: serde_json::Value = serde_json::from_slice(&output.stdout).expect("invalid JSON");
    let keys = list["active_keys"].as_array().unwrap();
    assert_eq!(keys.len(), 2, "imported identity should have 2 keys");
}

#[test]
fn test_keystore_list() {
    let cli = CliTest::new();

    // Generate a few keys
    cli.run_ok(&["key", "generate", "--algo", "ES256", "--tag", "key1"]);
    cli.run_ok(&["key", "generate", "--algo", "ES256", "--tag", "key2"]);

    // List keystore keys (no identity specified)
    let list = cli.run_json(&["key", "list"]);
    let keys = list.as_array().unwrap();
    assert_eq!(keys.len(), 2, "should have 2 keys in keystore");
}

#[test]
fn test_tx_list_genesis() {
    let cli = CliTest::new();

    // Generate key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // List cozies (should be empty for genesis)
    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let tx_list = cli.run_json(&["tx", "list", &identity_arg]);

    assert_eq!(tx_list["transaction_count"], 0);
}

#[test]
fn test_tx_list_after_transactions() {
    let cli = CliTest::new();

    // Generate key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // Add a key (creates first coz)
    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let signer_arg = format!("--signer={genesis_tmb}");
    cli.run_ok(&["key", "add", &identity_arg, &signer_arg]);

    // List cozies - should show 2 (key/create + commit/create per commit)
    let tx_list = cli.run_json(&["tx", "list", &identity_arg]);

    assert_eq!(tx_list["transaction_count"], 2);
    let cozies = tx_list["cozies"].as_array().unwrap();
    assert_eq!(cozies.len(), 2);
}

#[test]
fn test_inspect_genesis() {
    let cli = CliTest::new();

    // Generate key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // Inspect genesis state
    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let inspect = cli.run_json(&["inspect", &identity_arg]);

    // At genesis, PR is not yet established
    assert_eq!(inspect["pr"].as_str().unwrap(), "<none>");
    assert_eq!(inspect["ps"].as_str().unwrap(), genesis_tmb);
    assert_eq!(inspect["ks"].as_str().unwrap(), genesis_tmb);
    assert_eq!(inspect["as"].as_str().unwrap(), genesis_tmb);
    assert_eq!(inspect["commit_count"], 0);

    let keys = inspect["active_keys"].as_array().unwrap();
    assert_eq!(keys.len(), 1);
}

#[test]
fn test_inspect_after_transactions() {
    let cli = CliTest::new();

    // Generate key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // Add a key
    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let signer_arg = format!("--signer={genesis_tmb}");
    cli.run_ok(&["key", "add", &identity_arg, &signer_arg]);

    // Inspect after coz
    let inspect = cli.run_json(&["inspect", &identity_arg]);

    // PR is still <none> until a principal/create coz establishes it
    assert_eq!(inspect["pr"].as_str().unwrap(), "<none>");
    assert_ne!(
        inspect["ks"].as_str().unwrap(),
        genesis_tmb,
        "KS should change after key add"
    );
    assert_eq!(inspect["commit_count"], 1);

    let keys = inspect["active_keys"].as_array().unwrap();
    assert_eq!(keys.len(), 2, "should have 2 keys after add");
}

#[test]
fn test_full_workflow() {
    // Comprehensive test mimicking the demo script
    let cli = CliTest::new();

    // 1. Generate genesis key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256", "--tag", "genesis"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();

    // Use --arg=value format to handle thumbprints starting with -
    let identity_arg = format!("--identity={genesis_tmb}");
    let signer_arg = format!("--signer={genesis_tmb}");

    // 2. Verify keystore has the key
    let keystore_list = cli.run_json(&["key", "list"]);
    assert_eq!(keystore_list.as_array().unwrap().len(), 1);

    // 3. Check tx list at genesis (0 cozies)
    let tx_list = cli.run_json(&["tx", "list", &identity_arg]);
    assert_eq!(tx_list["transaction_count"], 0);

    // 4. Check inspect at genesis
    let inspect = cli.run_json(&["inspect", &identity_arg]);
    assert_eq!(inspect["commit_count"], 0);

    // 5. Add a key
    let add_result = cli.run_json(&["key", "add", &identity_arg, &signer_arg]);
    let second_key = add_result["added_key"].as_str().unwrap();
    let key_arg = format!("--key={second_key}");

    // 6. List keys - should have 2
    let key_list = cli.run_json(&["key", "list", &identity_arg]);
    assert_eq!(key_list["active_keys"].as_array().unwrap().len(), 2);

    // 7. Check tx list after coz (mutation + commit/create per commit)
    let tx_list = cli.run_json(&["tx", "list", &identity_arg]);
    assert_eq!(tx_list["transaction_count"], 2);

    // 8. Check inspect after coz
    let inspect = cli.run_json(&["inspect", &identity_arg]);
    assert_eq!(inspect["commit_count"], 1);
    assert_eq!(inspect["active_keys"].as_array().unwrap().len(), 2);

    // 9. Export
    let export_path = cli.temp_dir.path().join("export.jsonl");
    let output_arg = format!("--output={}", export_path.display());
    cli.run_ok(&["export", &identity_arg, &output_arg]);
    assert!(export_path.exists());

    // 10. Revoke the second key (self-revoke: the key signs its own revocation)
    let second_key_signer = format!("--signer={second_key}");
    cli.run_ok(&["key", "revoke", &identity_arg, &key_arg, &second_key_signer]);

    // 11. Verify final state - only genesis key remains
    let final_list = cli.run_json(&["key", "list", &identity_arg]);
    let final_keys = final_list["active_keys"].as_array().unwrap();
    assert_eq!(final_keys.len(), 1);
    // Key order is not guaranteed, check that genesis key is present
    assert!(
        final_keys
            .iter()
            .any(|k| k["tmb"].as_str() == Some(genesis_tmb)),
        "genesis key should be in final active keys"
    );

    // 12. Check tx list shows 4 cozies (2 commits × 2 each: mutation + commit/create)
    let tx_list = cli.run_json(&["tx", "list", &identity_arg]);
    assert_eq!(tx_list["transaction_count"], 4);
}

#[test]
fn test_tx_verify_genesis() {
    let cli = CliTest::new();

    // Generate key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();
    let identity_arg = format!("--identity={genesis_tmb}");

    // Verify genesis state (no cozies yet)
    let verify = cli.run_json(&["tx", "verify", &identity_arg]);

    assert_eq!(verify["status"], "OK");
    assert_eq!(verify["commits_verified"], 0);
    assert_eq!(verify["transactions_verified"], 0);
}

#[test]
fn test_tx_verify_after_transactions() {
    let cli = CliTest::new();

    // Generate key
    let genesis = cli.run_json(&["key", "generate", "--algo", "ES256"]);
    let genesis_tmb = genesis["tmb"].as_str().unwrap();
    let identity_arg = format!("--identity={genesis_tmb}");
    let signer_arg = format!("--signer={genesis_tmb}");

    // Add a key (creates first coz)
    cli.run_ok(&["key", "add", &identity_arg, &signer_arg]);

    // Verify coz chain - THIS IS THE CRITICAL TEST
    // If PS Mismatch bug exists, this will fail
    let verify = cli.run_json(&["tx", "verify", &identity_arg]);

    assert_eq!(verify["status"], "OK", "tx verify should succeed");
    assert_eq!(verify["commits_verified"], 1);
    assert_eq!(verify["transactions_verified"], 2);
}