prikk-store 0.24.0

Prikk storage crate scaffold.
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

#![allow(clippy::indexing_slicing)]

use prikk_error::Result;

use super::{
    TrustKeyEntry, TrustKeyRecordStatus, TrustPolicyRecordStatus, TrustPolicySnapshotEntry,
    decode_trust_key_records, decode_trust_policy_records, encode_trust_key_record,
    encode_trust_policy_record,
};

fn sample_public_key(seed: u8) -> [u8; 32] {
    [seed; 32]
}

#[test]
fn a_single_key_entry_round_trips_through_decode() -> Result<()> {
    let entry = TrustKeyEntry {
        key_id: "maintainer".to_string(),
        public_key: sample_public_key(1),
    };
    let bytes = encode_trust_key_record(&entry)?;
    let replay = decode_trust_key_records(&bytes)?;
    assert_eq!(replay.entries, vec![entry]);
    assert_eq!(replay.trailing_partial_bytes, 0);
    assert!(
        replay
            .record_outcomes
            .iter()
            .all(|outcome| matches!(outcome.status, TrustKeyRecordStatus::Evaluated))
    );
    Ok(())
}

#[test]
fn trailing_partial_key_bytes_are_tolerated_not_treated_as_corruption() -> Result<()> {
    let entry = TrustKeyEntry {
        key_id: "maintainer".to_string(),
        public_key: sample_public_key(1),
    };
    let mut bytes = encode_trust_key_record(&entry)?;
    bytes.extend_from_slice(&[0_u8; 10]);
    let replay = decode_trust_key_records(&bytes)?;
    assert_eq!(replay.entries, vec![entry]);
    assert_eq!(replay.trailing_partial_bytes, 10);
    Ok(())
}

/// Decode-level isolation: a damaged entry is named at its own offset and the scan resyncs past it,
/// leaving every sound entry on either side intact -- the same discipline `pointer_index.rs`/
/// `received_index.rs` use.
#[test]
fn isolates_a_damaged_key_entry_and_reads_sound_entries_around_it() -> Result<()> {
    let first = TrustKeyEntry {
        key_id: "alice".to_string(),
        public_key: sample_public_key(1),
    };
    let damaged_source = TrustKeyEntry {
        key_id: "bob".to_string(),
        public_key: sample_public_key(2),
    };
    let third = TrustKeyEntry {
        key_id: "carol".to_string(),
        public_key: sample_public_key(3),
    };
    let mut bytes = encode_trust_key_record(&first)?;
    let damaged_start = bytes.len();
    let damaged_record = encode_trust_key_record(&damaged_source)?;
    let damaged_end = damaged_start + damaged_record.len();
    bytes.extend_from_slice(&damaged_record);
    bytes.extend_from_slice(&encode_trust_key_record(&third)?);
    bytes[damaged_end - 1] ^= 0x01;

    let replay = decode_trust_key_records(&bytes)?;
    let failed_offsets: Vec<_> = replay
        .record_outcomes
        .iter()
        .filter_map(|outcome| match &outcome.status {
            TrustKeyRecordStatus::Failed { .. } => Some(outcome.offset),
            TrustKeyRecordStatus::Evaluated => None,
        })
        .collect();
    assert_eq!(failed_offsets, vec![damaged_start]);
    assert_eq!(replay.entries, vec![first, third]);
    Ok(())
}

#[test]
fn a_single_policy_snapshot_round_trips_through_decode() -> Result<()> {
    let entry = TrustPolicySnapshotEntry {
        key_ids: vec!["alice".to_string(), "bob".to_string()],
    };
    let bytes = encode_trust_policy_record(&entry)?;
    let replay = decode_trust_policy_records(&bytes)?;
    assert_eq!(replay.entries, vec![entry]);
    assert_eq!(replay.trailing_partial_bytes, 0);
    Ok(())
}

/// The property that makes revocation representable: a second, shorter snapshot is a wholly
/// independent record, not a diff against the first -- "last entry wins" resolves the whole list at
/// once, matching `trust_index.rs`'s own module doc.
#[test]
fn a_second_snapshot_supersedes_the_first_at_replay() -> Result<()> {
    let first = TrustPolicySnapshotEntry {
        key_ids: vec!["alice".to_string(), "bob".to_string()],
    };
    let second = TrustPolicySnapshotEntry {
        key_ids: vec!["alice".to_string()],
    };
    let mut bytes = encode_trust_policy_record(&first)?;
    bytes.extend_from_slice(&encode_trust_policy_record(&second)?);
    let replay = decode_trust_policy_records(&bytes)?;
    assert_eq!(replay.entries, vec![first, second.clone()]);
    assert_eq!(replay.entries.last(), Some(&second));
    Ok(())
}

#[test]
fn decode_rejects_a_snapshot_listing_the_same_key_id_twice() -> Result<()> {
    let entry = TrustPolicySnapshotEntry {
        key_ids: vec!["alice".to_string(), "alice".to_string()],
    };
    let bytes = encode_trust_policy_record(&entry)?;
    let replay = decode_trust_policy_records(&bytes)?;
    assert!(replay.has_item_failure());
    assert!(replay.record_outcomes.iter().any(
        |outcome| matches!(&outcome.status, TrustPolicyRecordStatus::Failed { message }
                if message.contains("more than once"))
    ));
    Ok(())
}