ore-rs 0.8.3

Order-revealing encryption library used by the CipherStash searchable encryption platform
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

//! ORE encryption for `chrono::NaiveDate` and `chrono::DateTime<Utc>`,
//! gated behind the `chrono` feature.
//!
//! Wraps the canonical fixed-length byte encodings from
//! [`orderable_bytes::chrono`] in [`OreEncrypt`] impls, feeding the
//! plaintext bytes through the existing fixed-N ORE machinery (`N = 4` for
//! `NaiveDate`, `N = 12` for `DateTime<Utc>`). See the
//! `orderable_bytes::chrono` module docs for encoding details and
//! ordering properties.

use crate::ciphertext::*;
use crate::{OreCipher, OreEncrypt, OreError};
use ::chrono::{DateTime, NaiveDate, Utc};
use orderable_bytes::ToOrderableBytes;

const NAIVE_DATE_LEN: usize = <NaiveDate as ToOrderableBytes>::ENCODED_LEN;
const DATETIME_UTC_LEN: usize = <DateTime<Utc> as ToOrderableBytes>::ENCODED_LEN;

impl<T: OreCipher> OreEncrypt<T> for NaiveDate {
    type LeftOutput = Left<T, NAIVE_DATE_LEN>;
    type FullOutput = CipherText<T, NAIVE_DATE_LEN>;

    fn encrypt_left(&self, cipher: &T) -> Result<Self::LeftOutput, OreError> {
        cipher.encrypt_left(&self.to_orderable_bytes())
    }

    fn encrypt(&self, cipher: &T) -> Result<Self::FullOutput, OreError> {
        cipher.encrypt(&self.to_orderable_bytes())
    }
}

impl<T: OreCipher> OreEncrypt<T> for DateTime<Utc> {
    type LeftOutput = Left<T, DATETIME_UTC_LEN>;
    type FullOutput = CipherText<T, DATETIME_UTC_LEN>;

    fn encrypt_left(&self, cipher: &T) -> Result<Self::LeftOutput, OreError> {
        cipher.encrypt_left(&self.to_orderable_bytes())
    }

    fn encrypt(&self, cipher: &T) -> Result<Self::FullOutput, OreError> {
        cipher.encrypt(&self.to_orderable_bytes())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::scheme::bit2::OreAes128ChaCha20;
    use ::chrono::{NaiveDate, TimeZone, Utc};
    use hex_literal::hex;
    use quickcheck::{Arbitrary, Gen};

    fn cipher() -> OreAes128ChaCha20 {
        let k1: [u8; 16] = hex!("00010203 04050607 08090a0b 0c0d0e0f");
        let k2: [u8; 16] = hex!("0f0e0d0c 0b0a0908 07060504 03020100");
        OreCipher::init(&k1, &k2).unwrap()
    }

    // ============================================================
    // NaiveDate
    // ============================================================

    fn ymd(year: i32, month: u32, day: u32) -> NaiveDate {
        NaiveDate::from_ymd_opt(year, month, day).unwrap()
    }

    #[test]
    fn naive_date_pre_ce_sorts_below_ce() {
        let ore = cipher();
        let bce = ymd(-1, 12, 31).encrypt(&ore).unwrap();
        let ce = ymd(1, 1, 1).encrypt(&ore).unwrap();
        assert!(bce < ce);
    }

    #[test]
    fn naive_date_preserves_order_across_dramatic_span() {
        let ore = cipher();
        let ascending = [
            NaiveDate::MIN,
            ymd(-10000, 1, 1),
            ymd(-1, 1, 1),
            ymd(1, 1, 1),
            ymd(1970, 1, 1),
            ymd(2000, 1, 1),
            ymd(2026, 4, 29),
            ymd(10000, 1, 1),
            NaiveDate::MAX,
        ];
        let cts: Vec<_> = ascending.iter().map(|d| d.encrypt(&ore).unwrap()).collect();
        for window in cts.windows(2) {
            assert!(window[0] < window[1]);
        }
    }

    #[test]
    fn naive_date_vec_sort_consistent_with_plaintext_sort() {
        let ore = cipher();
        let values = vec![
            ymd(2000, 1, 1),
            ymd(1, 1, 1),
            ymd(1970, 1, 1),
            ymd(-100, 6, 15),
            ymd(2026, 4, 29),
            NaiveDate::MIN,
            NaiveDate::MAX,
            ymd(-1, 12, 31),
        ];
        let mut sorted_plain = values.clone();
        sorted_plain.sort();
        let mut paired: Vec<_> = values
            .iter()
            .copied()
            .map(|v| (v.encrypt(&ore).unwrap(), v))
            .collect();
        paired.sort_by(|a, b| a.0.partial_cmp(&b.0).unwrap());
        let sorted_via_ct: Vec<_> = paired.into_iter().map(|(_, v)| v).collect();
        assert_eq!(sorted_via_ct, sorted_plain);
    }

    #[derive(Debug, Clone)]
    struct ArbDate(NaiveDate);

    impl Arbitrary for ArbDate {
        fn arbitrary(g: &mut Gen) -> Self {
            use ::chrono::Datelike;
            let valid_min = NaiveDate::MIN.num_days_from_ce();
            let valid_max = NaiveDate::MAX.num_days_from_ce();
            let days = i32::arbitrary(g).clamp(valid_min, valid_max);
            ArbDate(NaiveDate::from_num_days_from_ce_opt(days).expect("clamped"))
        }
    }

    quickcheck! {
        fn prop_date_cmp_consistent(x: ArbDate, y: ArbDate) -> bool {
            let ore = cipher();
            let a = x.0.encrypt(&ore).unwrap();
            let b = y.0.encrypt(&ore).unwrap();
            a.partial_cmp(&b).unwrap() == x.0.cmp(&y.0)
        }
    }

    // ============================================================
    // DateTime<Utc>
    // ============================================================

    fn dt(secs: i64, nanos: u32) -> DateTime<Utc> {
        Utc.timestamp_opt(secs, nanos).single().unwrap()
    }

    #[test]
    fn datetime_utc_pre_epoch_sorts_below_post_epoch() {
        let ore = cipher();
        let pre = dt(-1, 999_999_999).encrypt(&ore).unwrap();
        let post = dt(0, 0).encrypt(&ore).unwrap();
        assert!(pre < post);
    }

    #[test]
    fn datetime_utc_subsecond_ordering() {
        let ore = cipher();
        let a = dt(100, 100).encrypt(&ore).unwrap();
        let b = dt(100, 200).encrypt(&ore).unwrap();
        let c = dt(101, 0).encrypt(&ore).unwrap();
        assert!(a < b);
        assert!(b < c);
    }

    #[test]
    fn datetime_utc_dramatic_span_preserves_order() {
        let ore = cipher();
        let ascending = [
            DateTime::<Utc>::MIN_UTC,
            dt(-1_000_000_000_000, 0),
            dt(-1_000_000_000, 0),
            dt(-1, 999_999_999),
            dt(0, 0),
            dt(0, 1),
            dt(1_000_000_000, 0),
            dt(1_000_000_000_000, 0),
            DateTime::<Utc>::MAX_UTC,
        ];
        let cts: Vec<_> = ascending.iter().map(|d| d.encrypt(&ore).unwrap()).collect();
        for window in cts.windows(2) {
            assert!(window[0] < window[1]);
        }
    }

    #[derive(Debug, Clone)]
    struct ArbDateTime(DateTime<Utc>);

    impl Arbitrary for ArbDateTime {
        fn arbitrary(g: &mut Gen) -> Self {
            let secs = i64::arbitrary(g);
            let nanos = u32::arbitrary(g) % 2_000_000_000;
            let dt = DateTime::<Utc>::from_timestamp(secs, nanos)
                .unwrap_or_else(|| DateTime::<Utc>::from_timestamp(0, 0).unwrap());
            ArbDateTime(dt)
        }
    }

    quickcheck! {
        fn prop_datetime_cmp_consistent(x: ArbDateTime, y: ArbDateTime) -> bool {
            let ore = cipher();
            let a = x.0.encrypt(&ore).unwrap();
            let b = y.0.encrypt(&ore).unwrap();
            a.partial_cmp(&b).unwrap() == x.0.cmp(&y.0)
        }
    }
}