libpep 0.13.0

Library for polymorphic encryption and pseudonymization
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
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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
//! End-to-end tests of the `peppy` command-line tool, run against the built binary.
#![cfg(feature = "build-binary")]
#![allow(clippy::unwrap_used, clippy::expect_used)]

use std::collections::HashSet;
use std::io::Write;
use std::process::{Command, Stdio};

struct Run {
    status: i32,
    stdout: String,
    stderr: String,
}

fn peppy_with_stdin(args: &[&str], stdin: Option<&str>) -> Run {
    let mut child = Command::new(env!("CARGO_BIN_EXE_peppy"))
        .args(args)
        .stdin(if stdin.is_some() {
            Stdio::piped()
        } else {
            Stdio::null()
        })
        .stdout(Stdio::piped())
        .stderr(Stdio::piped())
        .spawn()
        .expect("peppy starts");
    if let Some(input) = stdin {
        child
            .stdin
            .take()
            .unwrap()
            .write_all(input.as_bytes())
            .unwrap();
    }
    let output = child.wait_with_output().unwrap();
    Run {
        status: output.status.code().unwrap_or(-1),
        stdout: String::from_utf8(output.stdout).unwrap(),
        stderr: String::from_utf8(output.stderr).unwrap(),
    }
}

/// Run peppy and return its single output line.
fn peppy(args: &[&str]) -> String {
    let run = peppy_with_stdin(args, None);
    assert_eq!(run.status, 0, "peppy {args:?} failed: {}", run.stderr);
    run.stdout.trim().to_string()
}

/// Run peppy with `--json` and return the output object.
fn peppy_json(args: &[&str]) -> serde_json::Value {
    let mut full = vec!["--json"];
    full.extend_from_slice(args);
    let run = peppy_with_stdin(&full, None);
    assert_eq!(run.status, 0, "peppy {args:?} failed: {}", run.stderr);
    serde_json::from_str(&run.stdout).expect("JSON output")
}

fn field<'a>(v: &'a serde_json::Value, key: &str) -> &'a str {
    v[key]
        .as_str()
        .unwrap_or_else(|| panic!("missing {key} in {v}"))
}

struct Session {
    keys: serde_json::Value,
}

impl Session {
    fn public(&self) -> &str {
        field(&self.keys, "pseudonym_public_key")
    }
    fn secret(&self) -> &str {
        field(&self.keys, "pseudonym_secret_key")
    }
}

/// Global keys and session keys for two contexts, derived through the CLI.
fn setup() -> (serde_json::Value, Session, Session) {
    let global = peppy_json(&["keys", "global", "generate"]);
    let derive = |context: &str| Session {
        keys: peppy_json(&[
            "keys",
            "session",
            "derive",
            "--pseudonym-global-secret",
            field(&global, "pseudonym_secret_key"),
            "--attribute-global-secret",
            field(&global, "attribute_secret_key"),
            "--secret",
            "encryption secret",
            "--context",
            context,
        ]),
    };
    (global.clone(), derive("session-a"), derive("session-b"))
}

const TRANSCRYPT: [&str; 4] = [
    "--pseudonymization-secret",
    "pseudonymization secret",
    "--encryption-secret",
    "encryption secret",
];

#[test]
fn pseudonym_round_trip_through_transcryption() {
    let (_, a, b) = setup();
    let value = peppy(&["pseudonym", "encode", "patient-42"]);
    let encrypted = peppy(&["pseudonym", "encrypt", "--key", a.public(), &value]);
    let mut args = vec!["pseudonym", "transcrypt"];
    args.extend_from_slice(&TRANSCRYPT);
    args.extend_from_slice(&[
        "--from-domain",
        "hospital",
        "--to-domain",
        "research",
        "--from-context",
        "session-a",
        "--to-context",
        "session-b",
        &encrypted,
    ]);
    let transcrypted = peppy(&args);
    let in_b = peppy(&["pseudonym", "decrypt", "--key", b.secret(), &transcrypted]);
    assert_ne!(in_b, value, "pseudonym must differ between domains");

    let mut back = vec!["pseudonym", "transcrypt"];
    back.extend_from_slice(&TRANSCRYPT);
    back.extend_from_slice(&[
        "--from-domain",
        "research",
        "--to-domain",
        "hospital",
        "--from-context",
        "session-b",
        "--to-context",
        "session-a",
        &transcrypted,
    ]);
    let returned = peppy(&back);
    let in_a = peppy(&["pseudonym", "decrypt", "--key", a.secret(), &returned]);
    assert_eq!(in_a, value);
    assert_eq!(peppy(&["pseudonym", "decode", &in_a]), "patient-42");
}

#[test]
fn attribute_is_rekeyed_not_reshuffled() {
    let (_, a, b) = setup();
    let value = peppy(&["attribute", "encode", "blood type O"]);
    let encrypted = peppy(&[
        "attribute",
        "encrypt",
        "--key",
        field(&a.keys, "attribute_public_key"),
        &value,
    ]);
    let transcrypted = peppy(&[
        "attribute",
        "transcrypt",
        "--encryption-secret",
        "encryption secret",
        "--from-context",
        "session-a",
        "--to-context",
        "session-b",
        &encrypted,
    ]);
    let decrypted = peppy(&[
        "attribute",
        "decrypt",
        "--key",
        field(&b.keys, "attribute_secret_key"),
        &transcrypted,
    ]);
    assert_eq!(decrypted, value);
    assert_eq!(peppy(&["attribute", "decode", &decrypted]), "blood type O");
}

#[test]
fn long_values_round_trip() {
    let (_, a, _) = setup();
    let text = "an identifier that is much longer than sixteen bytes";
    let value = peppy(&["pseudonym", "encode", text]);
    assert!(
        value.split(' ').count() > 1,
        "long value has several blocks"
    );
    let encrypted = peppy(&["pseudonym", "encrypt", "--key", a.public(), &value]);
    assert!(
        encrypted.contains('|'),
        "long ciphertext has several blocks"
    );
    let decrypted = peppy(&["pseudonym", "decrypt", "--key", a.secret(), &encrypted]);
    assert_eq!(decrypted, value);
    assert_eq!(peppy(&["pseudonym", "decode", &decrypted]), text);
    // The blocks may also be given concatenated.
    let joined = value.replace(' ', "");
    assert_eq!(peppy(&["pseudonym", "decode", &joined]), text);
}

#[test]
fn explicit_factors_match_the_transcryptor() {
    let (_, a, b) = setup();
    let info = peppy_json(&[
        "factors",
        "info",
        "--pseudonymization-secret",
        "pseudonymization secret",
        "--encryption-secret",
        "encryption secret",
        "--from-domain",
        "hospital",
        "--to-domain",
        "research",
        "--from-context",
        "session-a",
        "--to-context",
        "session-b",
    ]);
    let value = peppy(&["pseudonym", "random"]);
    let encrypted = peppy(&["pseudonym", "encrypt", "--key", a.public(), &value]);
    let by_factors = peppy(&[
        "pseudonym",
        "pseudonymize",
        "--s",
        field(&info, "reshuffle_factor"),
        "--k",
        field(&info, "pseudonym_rekey_factor"),
        &encrypted,
    ]);
    let mut args = vec!["pseudonym", "transcrypt"];
    args.extend_from_slice(&TRANSCRYPT);
    args.extend_from_slice(&[
        "--from-domain",
        "hospital",
        "--to-domain",
        "research",
        "--from-context",
        "session-a",
        "--to-context",
        "session-b",
        &encrypted,
    ]);
    let by_transcryptor = peppy(&args);
    let d1 = peppy(&["pseudonym", "decrypt", "--key", b.secret(), &by_factors]);
    let d2 = peppy(&[
        "pseudonym",
        "decrypt",
        "--key",
        b.secret(),
        &by_transcryptor,
    ]);
    assert_eq!(d1, d2);
}

#[test]
fn primitives_compose() {
    let s = peppy(&["scalar", "random"]);
    let k = peppy(&["scalar", "random"]);
    let y = peppy(&["scalar", "random"]);
    let public = peppy(&["point", "base", &y]);
    let message = peppy(&["point", "random"]);
    let encrypted = peppy(&["elgamal", "encrypt", "--key", &public, &message]);

    // rsk is reshuffle followed by rekey.
    let rsk = peppy(&["elgamal", "rsk", "--s", &s, "--k", &k, &encrypted]);
    let rs = peppy(&["elgamal", "rs", "--s", &s, &encrypted]);
    let rs_rk = peppy(&["elgamal", "rk", "--k", &k, &rs]);
    assert_eq!(rsk, rs_rk);

    // Rekeying with k makes the ciphertext decryptable under k * y.
    let ky = peppy(&["scalar", "mul", &k, &y]);
    let rekeyed = peppy(&["elgamal", "rk", "--k", &k, &encrypted]);
    assert_eq!(
        peppy(&["elgamal", "decrypt", "--key", &ky, &rekeyed]),
        message
    );

    // The transitive variants are reversible.
    let (s_from, s_to) = (peppy(&["scalar", "random"]), peppy(&["scalar", "random"]));
    let forth = peppy(&[
        "elgamal", "rs2", "--from", &s_from, "--to", &s_to, &encrypted,
    ]);
    let back = peppy(&["elgamal", "rs2", "--from", &s_to, "--to", &s_from, &forth]);
    assert_eq!(peppy(&["elgamal", "decrypt", "--key", &y, &back]), message);

    // Rerandomization changes the ciphertext but not the message.
    #[cfg(feature = "elgamal3")]
    let rr = peppy(&["elgamal", "rr", &encrypted]);
    #[cfg(not(feature = "elgamal3"))]
    let rr = peppy(&["elgamal", "rr", "--key", &public, &encrypted]);
    let rr = rr.lines().last().unwrap().to_string();
    assert_ne!(rr, encrypted);
    assert_eq!(peppy(&["elgamal", "decrypt", "--key", &y, &rr]), message);
}

#[test]
fn distributed_setup_shares_and_reconstruction() {
    let n = 3;
    let setup = peppy_json(&["keys", "distributed", "setup", "-n", "3"]);
    let factors: Vec<&str> = setup["blinding_factors"]
        .as_array()
        .unwrap()
        .iter()
        .map(|f| f.as_str().unwrap())
        .collect();
    assert_eq!(factors.len(), n);

    // Each transcryptor produces its shares for the client's session.
    let secrets: Vec<String> = (0..n).map(|i| format!("secret-{i}")).collect();
    let shares: Vec<serde_json::Value> = (0..n)
        .map(|i| {
            peppy_json(&[
                "keys",
                "distributed",
                "share",
                "--blinding",
                factors[i],
                "--secret",
                &secrets[i],
                "--context",
                "session-1",
            ])
        })
        .collect();
    let mut args = vec![
        "keys",
        "distributed",
        "reconstruct",
        "--blinded-pseudonym",
        field(&setup, "blinded_pseudonym_secret_key"),
        "--blinded-attribute",
        field(&setup, "blinded_attribute_secret_key"),
    ];
    for share in &shares {
        args.extend_from_slice(&["--pseudonym-share", field(share, "pseudonym_share")]);
        args.extend_from_slice(&["--attribute-share", field(share, "attribute_share")]);
    }
    let session = peppy_json(&args);

    // Data encrypted towards the global key and transcrypted by every transcryptor in turn
    // decrypts with the reconstructed session key.
    let value = peppy(&["pseudonym", "random"]);
    let mut current = peppy(&[
        "pseudonym",
        "encrypt",
        "--global",
        "--key",
        field(&setup, "pseudonym_public_key"),
        &value,
    ]);
    for secret in &secrets {
        current = peppy(&[
            "pseudonym",
            "transcrypt",
            "--pseudonymization-secret",
            secret,
            "--encryption-secret",
            secret,
            "--from-domain",
            "domain",
            "--to-domain",
            "domain",
            "--to-context",
            "session-1",
            &current,
        ]);
    }
    let decrypted = peppy(&[
        "pseudonym",
        "decrypt",
        "--key",
        field(&session, "pseudonym_secret_key"),
        &current,
    ]);
    assert_eq!(decrypted, value);

    // Moving one transcryptor's share to another session updates the key consistently.
    let new_share = peppy_json(&[
        "keys",
        "distributed",
        "share",
        "--blinding",
        factors[0],
        "--secret",
        &secrets[0],
        "--context",
        "session-2",
    ]);
    let updated = peppy_json(&[
        "keys",
        "distributed",
        "update",
        "--secret-key",
        field(&session, "pseudonym_secret_key"),
        "--old-share",
        field(&shares[0], "pseudonym_share"),
        "--new-share",
        field(&new_share, "pseudonym_share"),
    ]);
    let moved = peppy(&[
        "pseudonym",
        "transcrypt",
        "--pseudonymization-secret",
        &secrets[0],
        "--encryption-secret",
        &secrets[0],
        "--from-domain",
        "domain",
        "--to-domain",
        "domain",
        "--from-context",
        "session-1",
        "--to-context",
        "session-2",
        &current,
    ]);
    let decrypted = peppy(&[
        "pseudonym",
        "decrypt",
        "--key",
        field(&updated, "pseudonym_secret_key"),
        &moved,
    ]);
    assert_eq!(decrypted, value);
}

#[cfg(feature = "json")]
#[test]
fn json_documents() {
    let (_, a, b) = setup();
    let keys_a = a.keys.to_string();
    let keys_b = b.keys.to_string();
    let encrypted = peppy_json(&[
        "json",
        "encrypt",
        "--keys",
        &keys_a,
        "--pseudonym-field",
        "id",
        r#"{"id":"patient-42","age":41}"#,
    ])["encrypted"]
        .to_string();
    let mut args = vec!["json", "transcrypt"];
    args.extend_from_slice(&TRANSCRYPT);
    args.extend_from_slice(&[
        "--from-domain",
        "hospital",
        "--to-domain",
        "research",
        "--from-context",
        "session-a",
        "--to-context",
        "session-b",
        &encrypted,
    ]);
    let transcrypted = peppy_json(&args)["encrypted"].to_string();
    let document = peppy_json(&["json", "decrypt", "--keys", &keys_b, &transcrypted]);
    assert_eq!(document["document"]["age"], 41);
    assert_ne!(document["document"]["id"], "patient-42");
}

#[test]
fn inputs_from_stdin_and_files() {
    let (_, a, _) = setup();
    let value = peppy(&["pseudonym", "random"]);
    let encrypted = peppy(&["pseudonym", "encrypt", "--key", a.public(), &value]);
    let dir = std::env::temp_dir().join(format!("peppy-cli-{}", std::process::id()));
    std::fs::create_dir_all(&dir).unwrap();
    let key_file = dir.join("key");
    std::fs::write(&key_file, format!("{}\n", a.secret())).unwrap();
    let key_arg = format!("@{}", key_file.display());
    let run = peppy_with_stdin(
        &["pseudonym", "decrypt", "--key", &key_arg, "-"],
        Some(&format!("{encrypted}\n")),
    );
    assert_eq!(run.status, 0, "{}", run.stderr);
    assert_eq!(run.stdout.trim(), value);
    std::fs::remove_dir_all(dir).unwrap();
}

#[test]
fn errors_have_messages_and_exit_codes() {
    let run = peppy_with_stdin(&["pseudonym", "decrypt", "--key", "nope", "AAAA"], None);
    assert_eq!(run.status, 1);
    assert!(run.stderr.contains("session secret key"), "{}", run.stderr);
    assert!(run.stdout.is_empty());

    #[cfg(feature = "elgamal3")]
    {
        let (_, a, b) = setup();
        let value = peppy(&["pseudonym", "random"]);
        let encrypted = peppy(&["pseudonym", "encrypt", "--key", a.public(), &value]);
        let run = peppy_with_stdin(
            &["pseudonym", "decrypt", "--key", b.secret(), &encrypted],
            None,
        );
        assert_eq!(run.status, 2, "{}", run.stderr);
        assert!(run.stderr.contains("does not match"));
    }
}

#[test]
fn json_output_holds_every_value() {
    let global = peppy_json(&["keys", "global", "generate"]);
    let keys: HashSet<&str> = global
        .as_object()
        .unwrap()
        .keys()
        .map(String::as_str)
        .collect();
    for expected in [
        "pseudonym_public_key",
        "pseudonym_secret_key",
        "attribute_public_key",
        "attribute_secret_key",
    ] {
        assert!(keys.contains(expected), "{expected} missing from {global}");
    }
}