deedar-cli 0.7.1

Operator path: deedar create/get/list/trail/evidence/delete/leave/timestamp/current/migrate
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
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
//! `deedar import` end to end: a bag from one store into another, then the
//! receiver's own evidence, trail, current and log audit on what it took.

use std::path::Path;
use std::process::{Command, Output};

use deedar::EXIT_UNTRUSTED_SIGNER;

fn deedar(home: &Path, signing: &str, args: &[&str]) -> Output {
    Command::new(env!("CARGO_BIN_EXE_deedar"))
        .args(args)
        .env("HOME", home)
        .env("XDG_CONFIG_HOME", home.join(".config"))
        .env("DEEDAR_HOST_SIGNING_KEY", signing)
        .env_remove("DEEDAR_HOST_KEY")
        .env_remove("DEEDAR_URL")
        .current_dir(home)
        .output()
        .expect("deedar runs")
}

fn ok(home: &Path, signing: &str, args: &[&str]) -> String {
    let out = deedar(home, signing, args);
    assert!(
        out.status.success(),
        "deedar {args:?}: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    String::from_utf8_lossy(&out.stdout).into_owned()
}

fn fails(home: &Path, signing: &str, args: &[&str]) -> String {
    let out = deedar(home, signing, args);
    assert!(!out.status.success(), "deedar {args:?} passed");
    String::from_utf8_lossy(&out.stderr).into_owned()
}

/// `check` and `vouch check` finished, and the signer was not accepted.
fn untrusted(out: &Output) {
    assert_eq!(
        out.status.code(),
        Some(i32::from(EXIT_UNTRUSTED_SIGNER)),
        "stdout {}\nstderr {}",
        String::from_utf8_lossy(&out.stdout),
        String::from_utf8_lossy(&out.stderr)
    );
}

fn url(home: &Path, name: &str) -> String {
    format!("file://{}", home.join(name).display())
}

/// A store with no deeds and the layout a first open writes. A read does not
/// make one, so a test that edits the layout first has to.
fn empty_store(home: &Path, name: &str) {
    let dir = home.join(name);
    std::fs::create_dir_all(&dir).unwrap();
    std::fs::write(dir.join("layout"), "1\n").unwrap();
}

fn quote(home: &Path, store: &str, signing: &str, id: &str, extra: &[&str]) {
    let mut args = vec![
        "--url",
        store,
        "create",
        "quote",
        "--id",
        id,
        "--excerpt",
        "a range in a frozen edition",
        "--src-url",
        "https://example.invalid/edition",
        "--agent",
        "seat",
    ];
    args.extend_from_slice(extra);
    ok(home, signing, &args);
}

/// An unsigned bag needs the flag. Taken, every deed in it answers on the
/// receiver: evidence, the trail to its source, current to its revision, and
/// a log that answers for the shelves. A second import adds nothing.
#[test]
fn an_unsigned_bag_needs_the_flag_and_then_answers_on_the_receiver() {
    let home = tempfile::tempdir().unwrap();
    let home = home.path();
    let sender = url(home, "sender");
    let receiver = url(home, "receiver");
    quote(home, &sender, "off", "deed-quote-src", &[]);
    quote(
        home,
        &sender,
        "off",
        "deed-quote-made",
        &["--input", "deed-quote-src"],
    );
    quote(home, &sender, "off", "deed-quote-v1", &[]);
    quote(
        home,
        &sender,
        "off",
        "deed-quote-v2",
        &["--excerpt", "a later take", "--supersedes", "deed-quote-v1"],
    );
    std::fs::write(home.join("letter.txt"), "the letter itself").unwrap();
    ok(
        home,
        "off",
        &[
            "--url",
            &sender,
            "create",
            "file",
            "--id",
            "deed-file-letter",
            "--path",
            "letter.txt",
            "--agent",
            "seat",
        ],
    );
    let ids = [
        "deed-quote-src",
        "deed-quote-made",
        "deed-quote-v1",
        "deed-quote-v2",
        "deed-file-letter",
    ];
    let mut export = vec!["--url", &sender, "export", "--into", "bag/data/deeds"];
    export.extend_from_slice(&ids);
    ok(home, "off", &export);

    let err = fails(home, "off", &["--url", &receiver, "import", "bag"]);
    assert!(err.contains("head is unsigned"), "{err}");
    assert!(err.contains("--allow-unsigned-head"), "{err}");
    assert_eq!(ok(home, "off", &["--url", &receiver, "log", "list"]), "");
    assert_eq!(ok(home, "off", &["--url", &receiver, "list"]), "");

    let first = ok(
        home,
        "off",
        &["--url", &receiver, "import", "bag", "--allow-unsigned-head"],
    );
    assert!(first.contains("5 deeds proven"), "{first}");
    assert!(
        first.contains("imported 5 deeds, appended 5 log entries"),
        "{first}"
    );

    let mut evidence = vec!["--url", &receiver, "evidence"];
    evidence.extend_from_slice(&ids);
    let said = ok(home, "off", &evidence);
    assert!(said.contains("5 of 5 verified"), "{said}");
    let trail = ok(
        home,
        "off",
        &["--url", &receiver, "trail", "deed-quote-made"],
    );
    assert!(trail.contains("id=deed-quote-src"), "{trail}");
    let current = ok(
        home,
        "off",
        &["--url", &receiver, "current", "deed-quote-v1"],
    );
    assert!(current.contains("id=deed-quote-v2"), "{current}");
    let audit = ok(home, "off", &["--url", &receiver, "log", "audit"]);
    assert_eq!(audit, "ok 5 logged and served\n");

    let second = ok(
        home,
        "off",
        &["--url", &receiver, "import", "bag", "--allow-unsigned-head"],
    );
    assert!(
        second.contains("imported 0 deeds, appended 0 log entries"),
        "{second}"
    );
}

/// A head signed by a key the receiver lists is the bar, and needs no flag.
#[test]
fn a_head_signed_by_a_listed_key_needs_no_flag() {
    let home = tempfile::tempdir().unwrap();
    let home = home.path();
    let key = home.join("sender.key");
    std::fs::write(&key, [7u8; 32]).unwrap();
    let key = key.display().to_string();
    let sender = url(home, "sender");
    let receiver = url(home, "receiver");
    quote(home, &sender, &key, "deed-quote-signed", &[]);
    let host = ok(home, &key, &["--url", &sender, "host"]);
    let public = host
        .strip_prefix("host key: ")
        .and_then(|rest| rest.split(',').next())
        .unwrap_or_else(|| panic!("{host}"));
    ok(
        home,
        &key,
        &[
            "--url",
            &sender,
            "export",
            "--into",
            "bag/data/deeds",
            "deed-quote-signed",
        ],
    );

    empty_store(home, "receiver");
    std::fs::write(
        home.join("receiver/layout"),
        format!("1\nattestation = required\nsigner = {public}\n"),
    )
    .unwrap();
    let said = ok(home, "off", &["--url", &receiver, "import", "bag"]);
    assert!(said.contains("(accepted)"), "{said}");
    assert!(said.contains("appended 1 log entries"), "{said}");
    let ev = ok(
        home,
        "off",
        &["--url", &receiver, "evidence", "deed-quote-signed"],
    );
    assert!(ev.contains("id=deed-quote-signed ok"), "{ev}");
    ok(home, "off", &["--url", &receiver, "log", "audit"]);
    assert!(home
        .join("receiver/deeds/deed-quote-signed.proof")
        .is_file());
    assert!(home.join("receiver/deeds/deed-quote-signed.head").is_file());
}

/// `--allow-unsigned-head` takes a signature by a key the layout does not
/// list. The deed was created with signing off, so there is no host sidecar
/// for that key to fail afterwards. `check` reports the signer, warns, and
/// exits `EXIT_UNTRUSTED_SIGNER`.
#[test]
fn allow_unsigned_head_takes_an_unlisted_signature() {
    let home = tempfile::tempdir().unwrap();
    let home = home.path();
    let key = home.join("sender.key");
    std::fs::write(&key, [7u8; 32]).unwrap();
    let other = home.join("other.key");
    std::fs::write(&other, [9u8; 32]).unwrap();
    let key = key.display().to_string();
    let other = other.display().to_string();
    let sender = url(home, "sender");
    let receiver = url(home, "receiver");
    quote(home, &sender, "off", "deed-quote-signed", &[]);
    ok(
        home,
        &key,
        &[
            "--url",
            &sender,
            "export",
            "--into",
            "bag/data/deeds",
            "deed-quote-signed",
        ],
    );

    empty_store(home, "receiver");
    let host = fails(home, &other, &["--url", &receiver, "host"]);
    let public = host
        .split_whitespace()
        .find(|word| word.starts_with("ed25519:"))
        .unwrap_or_else(|| panic!("{host}"));
    std::fs::write(
        home.join("receiver/layout"),
        format!("1\nsigner = {public}\n"),
    )
    .unwrap();

    let checked = deedar(home, "off", &["--url", &receiver, "check", "bag"]);
    untrusted(&checked);
    let stdout = String::from_utf8_lossy(&checked.stdout);
    let stderr = String::from_utf8_lossy(&checked.stderr);
    assert!(stdout.contains("not a key this reader accepts"), "{stdout}");
    assert!(
        stderr.contains("deedar: warning:") && stderr.contains("not a key this reader accepts"),
        "{stderr}"
    );
    let err = fails(home, "off", &["--url", &receiver, "import", "bag"]);
    assert!(err.contains("does not list"), "{err}");
    assert!(err.contains("--allow-unsigned-head"), "{err}");
    let said = ok(
        home,
        "off",
        &["--url", &receiver, "import", "bag", "--allow-unsigned-head"],
    );
    assert!(said.contains("appended 1 log entries"), "{said}");
    let ev = ok(
        home,
        "off",
        &["--url", &receiver, "evidence", "deed-quote-signed"],
    );
    assert!(ev.contains("id=deed-quote-signed ok"), "{ev}");
}

/// A layout that demands attestation still imports an unsigned head when
/// the flag is set, and warns. Without the flag nothing is written.
#[test]
fn attestation_required_imports_an_unsigned_head_with_the_flag_and_warns() {
    let home = tempfile::tempdir().unwrap();
    let home = home.path();
    let key_path = home.join("host.key");
    std::fs::write(&key_path, [7u8; 32]).unwrap();
    let key = key_path.display().to_string();
    let sender = url(home, "sender");
    let receiver = url(home, "receiver");
    // The deed is attested. Export with signing off leaves the head unsigned
    // and keeps the sidecar, which is what a required store can still hold.
    quote(home, &sender, &key, "deed-quote-plain", &[]);
    let host = ok(home, &key, &["--url", &sender, "host"]);
    let public = host
        .strip_prefix("host key: ")
        .and_then(|rest| rest.split(',').next())
        .unwrap_or_else(|| panic!("{host}"));
    ok(
        home,
        "off",
        &[
            "--url",
            &sender,
            "export",
            "--into",
            "bag/data/deeds",
            "deed-quote-plain",
        ],
    );
    empty_store(home, "receiver");
    std::fs::write(
        home.join("receiver/layout"),
        format!("1\nattestation = required\nsigner = {public}\n"),
    )
    .unwrap();

    let err = fails(home, "off", &["--url", &receiver, "import", "bag"]);
    assert!(err.contains("--allow-unsigned-head"), "{err}");
    assert_eq!(ok(home, "off", &["--url", &receiver, "log", "list"]), "");

    let out = deedar(
        home,
        "off",
        &["--url", &receiver, "import", "bag", "--allow-unsigned-head"],
    );
    assert!(
        out.status.success(),
        "{}",
        String::from_utf8_lossy(&out.stderr)
    );
    let stdout = String::from_utf8_lossy(&out.stdout);
    let stderr = String::from_utf8_lossy(&out.stderr);
    assert!(stdout.contains("appended 1 log entries"), "{stdout}");
    assert!(
        stderr.contains("deedar: warning:") && stderr.contains("attestation = required"),
        "{stderr}"
    );
    assert!(
        ok(home, "off", &["--url", &receiver, "log", "list"]).contains("deed-quote-plain"),
        "the deed was not logged"
    );

    let err = fails(
        home,
        "off",
        &["--url", &receiver, "import", "bag", "--allow-unsigned"],
    );
    assert!(
        err.contains("unknown import flag --allow-unsigned"),
        "{err}"
    );
}

/// `host accept` on a store that demands attestation refuses, names the
/// line to add by hand, and leaves the layout as it was.
#[test]
fn host_accept_on_a_required_store_refuses() {
    let home = tempfile::tempdir().unwrap();
    let home = home.path();
    let key_path = home.join("host.key");
    std::fs::write(&key_path, [7u8; 32]).unwrap();
    let key = key_path.display().to_string();
    let store = url(home, "store");
    empty_store(home, "store");
    let layout_path = home.join("store/layout");
    let layout_text = "1\nattestation = required\n";
    std::fs::write(&layout_path, layout_text).unwrap();

    let out = deedar(home, &key, &["--url", &store, "host", "accept"]);
    assert_eq!(out.status.code(), Some(1), "{out:?}");
    assert_eq!(String::from_utf8_lossy(&out.stdout), "");
    let stderr = String::from_utf8_lossy(&out.stderr);
    assert!(stderr.contains("attestation = required"), "{stderr}");
    assert!(stderr.contains("signer = ed25519:"), "{stderr}");
    assert!(stderr.contains("by hand"), "{stderr}");
    assert_eq!(std::fs::read_to_string(&layout_path).unwrap(), layout_text);
}

/// `vouch check` reports a key the layout does not list, warns, and exits
/// `EXIT_UNTRUSTED_SIGNER`. With no list it says so, does not warn, and
/// exits 0. A signature that does not cover the file still exits 1.
#[test]
fn vouch_check_reports_an_unlisted_key_and_warns() {
    let home = tempfile::tempdir().unwrap();
    let home = home.path();
    let key_path = home.join("host.key");
    std::fs::write(&key_path, [7u8; 32]).unwrap();
    let other_path = home.join("other.key");
    std::fs::write(&other_path, [9u8; 32]).unwrap();
    let key = key_path.display().to_string();
    let other = other_path.display().to_string();
    let store = url(home, "store");
    empty_store(home, "store");
    std::fs::write(home.join("manifest-sha256.txt"), "abc  data/one\n").unwrap();
    ok(
        home,
        &key,
        &["--url", &store, "vouch", "sign", "manifest-sha256.txt"],
    );

    let open = deedar(
        home,
        "off",
        &["--url", &store, "vouch", "check", "manifest-sha256.txt"],
    );
    assert!(
        open.status.success(),
        "{}",
        String::from_utf8_lossy(&open.stderr)
    );
    assert!(String::from_utf8_lossy(&open.stdout).contains("no signer list was given"));
    assert!(
        !String::from_utf8_lossy(&open.stderr).contains("deedar: warning:"),
        "{}",
        String::from_utf8_lossy(&open.stderr)
    );

    let host = fails(home, &other, &["--url", &store, "host"]);
    let public = host
        .split_whitespace()
        .find(|word| word.starts_with("ed25519:"))
        .unwrap_or_else(|| panic!("{host}"));
    std::fs::write(home.join("store/layout"), format!("1\nsigner = {public}\n")).unwrap();
    let out = deedar(
        home,
        "off",
        &["--url", &store, "vouch", "check", "manifest-sha256.txt"],
    );
    untrusted(&out);
    let stdout = String::from_utf8_lossy(&out.stdout);
    let stderr = String::from_utf8_lossy(&out.stderr);
    assert!(stdout.contains("not a key this reader accepts"), "{stdout}");
    assert!(
        stderr.contains("deedar: warning:") && stderr.contains("not a key this reader accepts"),
        "{stderr}"
    );

    std::fs::write(home.join("manifest-sha256.txt"), "changed\n").unwrap();
    let broken = deedar(
        home,
        "off",
        &["--url", &store, "vouch", "check", "manifest-sha256.txt"],
    );
    assert_eq!(broken.status.code(), Some(1), "{broken:?}");
    assert!(
        !String::from_utf8_lossy(&broken.stderr).contains("deedar: warning:"),
        "{}",
        String::from_utf8_lossy(&broken.stderr)
    );
}