bc-envelope-cli 0.35.0

Gordian Envelope Command Line Tool.
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
428
429
430
431
use indoc::indoc;
mod common;
use common::*;

#[test]
fn test_xid_resolution_basic() {
    bc_envelope::register_tags();

    // ### `xid resolution`: Work with Resolution Methods (dereferenceVia)
    //
    // Resolution methods declare where a XID document can be fetched from.
    // They are stored as `'dereferenceVia'` assertions on the XID document.

    // Create a basic XID document using deterministic keys.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            XID(93a4d4e7) [
                'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                    'allow': 'All'
                    'nickname': "Alice"
                ]
            ]
        "#}.trim()
    ).unwrap();

    // Verify starting with no resolution methods.
    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "0").unwrap();

    // Add a resolution method.
    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    // Verify the XID document now has the resolution method.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            XID(93a4d4e7) [
                'dereferenceVia': URI(https://resolver.example.com)
                'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                    'allow': 'All'
                    'nickname': "Alice"
                ]
            ]
        "#}.trim()
    ).unwrap();

    // Verify count is now 1.
    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "1").unwrap();

    // List all resolution methods.
    run_cli_expect(
        &["xid", "resolution", "all", &xid_doc],
        "https://resolver.example.com",
    )
    .unwrap();

    // Get a resolution method by index.
    run_cli_expect(
        &["xid", "resolution", "at", "0", &xid_doc],
        "https://resolver.example.com",
    )
    .unwrap();
}

#[test]
fn test_xid_resolution_multiple() {
    bc_envelope::register_tags();

    // Create XID and add multiple resolution methods.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    let xid_doc =
        run_cli(&["xid", "resolution", "add", "btcr:01234567", &xid_doc])
            .unwrap();

    // Verify the XID document has both resolution methods.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            XID(93a4d4e7) [
                'dereferenceVia': URI(btcr:01234567)
                'dereferenceVia': URI(https://resolver.example.com)
                'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                    'allow': 'All'
                    'nickname': "Alice"
                ]
            ]
        "#}.trim()
    ).unwrap();

    // Verify count.
    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "2").unwrap();

    // Verify all lists both methods (order may vary due to HashSet).
    let all_methods = run_cli(&["xid", "resolution", "all", &xid_doc]).unwrap();
    assert!(all_methods.contains("https://resolver.example.com"));
    assert!(all_methods.contains("btcr:01234567"));
}

#[test]
fn test_xid_resolution_remove() {
    bc_envelope::register_tags();

    // Create XID with two resolution methods.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    let xid_doc =
        run_cli(&["xid", "resolution", "add", "btcr:01234567", &xid_doc])
            .unwrap();

    // Verify both resolution methods are present.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            XID(93a4d4e7) [
                'dereferenceVia': URI(btcr:01234567)
                'dereferenceVia': URI(https://resolver.example.com)
                'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                    'allow': 'All'
                    'nickname': "Alice"
                ]
            ]
        "#}.trim()
    ).unwrap();

    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "2").unwrap();

    // Remove one resolution method.
    let xid_doc =
        run_cli(&["xid", "resolution", "remove", "btcr:01234567", &xid_doc])
            .unwrap();

    // Verify only the first method remains.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            XID(93a4d4e7) [
                'dereferenceVia': URI(https://resolver.example.com)
                'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                    'allow': 'All'
                    'nickname': "Alice"
                ]
            ]
        "#}.trim()
    ).unwrap();

    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "1").unwrap();
    run_cli_expect(
        &["xid", "resolution", "all", &xid_doc],
        "https://resolver.example.com",
    )
    .unwrap();
}

#[test]
fn test_xid_resolution_remove_not_found() {
    bc_envelope::register_tags();

    // Create XID with one resolution method.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    // Try to remove a non-existent resolution method.
    let result = run_cli(&[
        "xid",
        "resolution",
        "remove",
        "https://nonexistent.com",
        &xid_doc,
    ]);

    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(err_msg.contains("Resolution method not found"));
    assert!(err_msg.contains("https://nonexistent.com"));
}

#[test]
fn test_xid_resolution_index_out_of_bounds() {
    bc_envelope::register_tags();

    // Create XID with one resolution method.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    // Try to access an invalid index.
    let result = run_cli(&["xid", "resolution", "at", "5", &xid_doc]);
    assert!(result.is_err());
    let err_msg = result.unwrap_err().to_string();
    assert!(err_msg.contains("Index out of bounds"));
}

#[test]
fn test_xid_resolution_with_signature() {
    bc_envelope::register_tags();

    // Test that resolution methods work with signed XID documents.
    //
    // Create a signed XID document with encrypted private keys.

    let xid_doc = run_cli(&[
        "xid",
        "new",
        "--nickname",
        "Alice",
        "--private",
        "encrypt",
        "--encrypt-password",
        "secret",
        "--sign",
        "inception",
        ALICE_PRVKEYS,
    ])
    .unwrap();

    // Verify initial signed structure with encrypted private key.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            {
                XID(93a4d4e7) [
                    'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                        {
                            'privateKey': ENCRYPTED [
                                'hasSecret': EncryptedKey(Argon2id)
                            ]
                        } [
                            'salt': Salt
                        ]
                        'allow': 'All'
                        'nickname': "Alice"
                    ]
                ]
            } [
                'signed': Signature
            ]
        "#}.trim()
    ).unwrap();

    // Add a resolution method with proper verification and re-signing.
    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "--verify",
        "inception",
        "--password",
        "secret",
        "--sign",
        "inception",
        "--private",
        "encrypt",
        "--encrypt-password",
        "secret",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    // Verify the signed document now has the resolution method.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            {
                XID(93a4d4e7) [
                    'dereferenceVia': URI(https://resolver.example.com)
                    'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                        {
                            'privateKey': ENCRYPTED [
                                'hasSecret': EncryptedKey(Argon2id)
                            ]
                        } [
                            'salt': Salt
                        ]
                        'allow': 'All'
                        'nickname': "Alice"
                    ]
                ]
            } [
                'signed': Signature
            ]
        "#}.trim()
    ).unwrap();

    // Verify signature is valid.
    let result = run_cli(&["xid", "id", "--verify", "inception", &xid_doc]);
    assert!(result.is_ok());
}

#[test]
fn test_xid_resolution_empty_list() {
    bc_envelope::register_tags();

    // Create XID without any resolution methods.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    // Verify count is 0.
    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "0").unwrap();

    // Verify all returns empty string.
    run_cli_expect(&["xid", "resolution", "all", &xid_doc], "").unwrap();
}

#[test]
fn test_xid_resolution_preserved_after_other_operations() {
    bc_envelope::register_tags();

    // Test that resolution methods are preserved when doing other operations
    // on the XID document.

    let xid_doc =
        run_cli(&["xid", "new", "--nickname", "Alice", ALICE_PUBKEYS]).unwrap();

    // Add a resolution method.
    let xid_doc = run_cli(&[
        "xid",
        "resolution",
        "add",
        "https://resolver.example.com",
        &xid_doc,
    ])
    .unwrap();

    // Add another key to the XID document.
    let xid_doc = run_cli(&[
        "xid",
        "key",
        "add",
        "--nickname",
        "Device2",
        BOB_PUBKEYS,
        &xid_doc,
    ])
    .unwrap();

    // Verify resolution method is still present along with both keys.
    // expected-text-output-rubric:
    #[rustfmt::skip]
    run_cli_expect(
        &["format", &xid_doc],
        indoc! {r#"
            XID(93a4d4e7) [
                'dereferenceVia': URI(https://resolver.example.com)
                'key': PublicKeys(cab108a0, SigningPublicKey(93a4d4e7, SchnorrPublicKey(26712894)), EncapsulationPublicKey(00b42db3, X25519PublicKey(00b42db3))) [
                    'allow': 'All'
                    'nickname': "Alice"
                ]
                'key': PublicKeys(e2c18423, SigningPublicKey(f1199a75, SchnorrPublicKey(f0638394)), EncapsulationPublicKey(4af6be52, X25519PublicKey(4af6be52))) [
                    'allow': 'All'
                    'nickname': "Device2"
                ]
            ]
        "#}.trim()
    ).unwrap();

    run_cli_expect(&["xid", "resolution", "count", &xid_doc], "1").unwrap();
    run_cli_expect(
        &["xid", "resolution", "all", &xid_doc],
        "https://resolver.example.com",
    )
    .unwrap();
}