sc_drbg 0.1.0-alpha.2

Subset Counter-Based Deterministic Random Bit Generator
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
use crate::traits::UnsignedInt;
use aes::{
    Aes128, Aes192, Aes256,
    cipher::{KeyIvInit, StreamCipher},
};
use ctr::Ctr128BE;
use digest::{
    Digest, ExtendableOutput, HashMarker, OutputSizeUser, Update, XofReader,
    block_buffer::Eager,
    core_api::{
        BlockSizeUser, BufferKindUser, CoreProxy, FixedOutputCore, UpdateCore,
    },
    typenum::{IsLess, Le, NonZero, U256},
};
use hkdf::{self, Hkdf};
use hmac::{Hmac, Mac};
use sha3::Shake256;
use std::marker::PhantomData;

const D_1: u8 = 0x01;
const D_2: u8 = 0x02;
const D_3: u8 = 0x03;
const D_4: u8 = 0x04;
const D_5: u8 = 0x05;
const D_6: u8 = 0x06;
const D_7: u8 = 0x07;

pub struct Prf<D> {
    _digest: PhantomData<D>,
}

impl<D> Prf<D>
where
    D: Digest + CoreProxy + OutputSizeUser,
    D::Core: Sync
        + HashMarker
        + UpdateCore
        + FixedOutputCore
        + BufferKindUser<BufferKind = Eager>
        + Default
        + Clone
        + BlockSizeUser,
    <D::Core as BlockSizeUser>::BlockSize: IsLess<U256>,
    Le<<D::Core as BlockSizeUser>::BlockSize, U256>: NonZero,
{
    pub fn init_commits<T>(
        arr: &[Vec<u8>],
        key: &[u8],
        encode: fn(T) -> Vec<u8>,
    ) -> Vec<Vec<u8>>
    where
        T: UnsignedInt,
    {
        // Initialize element commitments
        let mut commits = Vec::with_capacity(arr.len());
        // Commit each element to its position, length, and content
        for i in 0..arr.len() {
            // Initialize MAC using key
            let mut mac = Hmac::<D>::new_from_slice(&key)
                .expect("HMAC can take key of any size");
            // Absorb domain byte
            Mac::update(&mut mac, &[D_1]);
            // Absorb element position, length, and contents
            Mac::update(&mut mac, &encode(T::from_usize(i)));
            Mac::update(&mut mac, &encode(T::from_usize(arr[i].len())));
            Mac::update(&mut mac, &arr[i]);
            // Add commitment to element commitments
            commits.push(mac.finalize().into_bytes().to_vec());
        }
        commits
    }
    pub fn mix<T>(
        arr: &[Vec<u8>],
        prk: &[u8],
        rounds: usize,
        encode: fn(T) -> Vec<u8>,
    ) -> Vec<Vec<u8>>
    where
        T: UnsignedInt,
    {
        // Initialize mixed elements from array
        let mut mixed = arr.to_vec();
        let key_len = <D as OutputSizeUser>::output_size();
        // Apply rounds of mixing
        for i in 0..rounds {
            // Create info from round number, expand PRK into mixing key
            let info = format!("ROUND{}", i);
            let info_bytes = info.as_bytes();
            let hk = hkdf::Hkdf::<D>::from_prk(prk)
                .expect("PRK should be large enough");
            let mut key = vec![0u8; key_len];
            hk.expand(&info_bytes, &mut key)
                .expect("okm length should match the hash digest length");
            // Create tweak from mixing key and round
            let mut tweak_hasher = D::new();
            tweak_hasher.update(&key);
            tweak_hasher.update(&encode(T::from_usize(i)));
            let tweak = tweak_hasher.finalize().to_vec();
            // Create sponge, absorb tweak
            let mut sponge = Shake256::default();
            sponge.update(&tweak);
            // Absorb all elements and positions
            for j in 0..mixed.len() {
                sponge.update(&mixed[j]);
                sponge.update(&encode(T::from_usize(j)));
            }
            // Squeeze outputs from sponge, use temporary buffer
            let mut sponge_reader = sponge.finalize_xof();
            let mut tmp = Vec::with_capacity(mixed.len());
            for j in 0..mixed.len() {
                let mut element = vec![0u8; mixed[j].len()];
                sponge_reader.read(&mut element);
                tmp.push(element);
            }
            mixed = tmp;
        }
        mixed
    }
    pub fn next<T>(
        arr: &[Vec<u8>],
        context: &str,
        prk: &[u8],
        subset: usize,
        counter: T,
        encode: fn(T) -> Vec<u8>,
        decode: fn(&[u8]) -> T,
        dst: &mut [u8],
    ) where
        T: UnsignedInt,
    {
        // Create commitment
        let commit = Self::commitment::<T>(arr, encode);
        // Expand PRK into keys for each step
        let key_len = <D as OutputSizeUser>::output_size();
        let hk = Hkdf::<D>::from_prk(prk).expect("PRK should be large enough");
        let mut key_1 = vec![0u8; key_len];
        let mut info = format!("{}-SUBKEYS", context);
        hk.expand(&info.as_bytes(), &mut key_1)
            .expect("okm length should match the hash digest length");
        let mut key_2 = vec![0u8; key_len];
        info = format!("{}-INDICES", context);
        hk.expand(&info.as_bytes(), &mut key_2)
            .expect("okm length should match the hash digest length");
        let mut key_3 = vec![0u8; key_len];
        info = format!("{}-PRF", context);
        hk.expand(&info.as_bytes(), &mut key_3)
            .expect("okm length should match the hash digest length");
        // Create subkeys and select indices
        let k_s = Self::subkeys::<T>(arr, &key_1, &commit, encode);
        let k_i = Self::indices::<T>(
            &key_2,
            &commit,
            T::from_usize(arr.len()),
            T::from_usize(subset),
            counter,
            encode,
            decode,
        );
        // Bind each subkey to the commitment and counter, XOR into accumulator
        let acc = Self::combine::<T>(&k_s, &k_i, &commit, counter, encode);
        // Derive PRF key and nonce
        let (prf_key, nonce) =
            Self::derive_key_nonce::<T>(&key_3, &commit, counter, &acc, encode);
        // Fill the destination buffer with zero bytes
        dst.fill(0);
        // Encrypt zero bytes using AES-CTR, change variant based on key size
        match prf_key.len() {
            16 => {
                let mut aes_key = [0u8; 16];
                aes_key.copy_from_slice(&prf_key);
                let mut cipher =
                    Ctr128BE::<Aes128>::new(&aes_key.into(), &nonce.into());
                cipher.apply_keystream(dst);
            }
            24 => {
                let mut aes_key = [0u8; 24];
                aes_key.copy_from_slice(&prf_key);
                let mut cipher =
                    Ctr128BE::<Aes192>::new(&aes_key.into(), &nonce.into());
                cipher.apply_keystream(dst);
            }
            32 => {
                let mut aes_key = [0u8; 32];
                aes_key.copy_from_slice(&prf_key);
                let mut cipher =
                    Ctr128BE::<Aes256>::new(&aes_key.into(), &nonce.into());
                cipher.apply_keystream(dst);
            }
            _ => panic!("key length {} is invalid for AES-CTR", prf_key.len()),
        }
    }
    fn commitment<T>(arr: &[Vec<u8>], encode: fn(T) -> Vec<u8>) -> Vec<u8>
    where
        T: UnsignedInt,
    {
        // Initialize hasher
        let mut hasher = D::new();
        // Absorb domain byte
        hasher.update(&[D_2]);
        // Encode and absorb element count
        hasher.update(&encode(T::from_usize(arr.len())));
        // For each element, commit to its position, length, and content
        for i in 0..arr.len() {
            // Absorb element position, length, and contents
            hasher.update(&encode(T::from_usize(i)));
            hasher.update(&encode(T::from_usize(arr[i].len())));
            hasher.update(&arr[i]);
        }
        // Return commitment
        hasher.finalize().to_vec()
    }
    fn subkeys<T>(
        arr: &[Vec<u8>],
        key: &[u8],
        commit: &[u8],
        encode: fn(T) -> Vec<u8>,
    ) -> Vec<Vec<u8>>
    where
        T: UnsignedInt,
    {
        // Allocate subkeys buffer
        let mut k_s = Vec::with_capacity(arr.len());
        // Derive a subkey for each element
        for i in 0..arr.len() {
            // Initialize MAC using key
            let mut mac = Hmac::<D>::new_from_slice(&key)
                .expect("HMAC can take key of any size");
            // Absorb domain byte, element properties, and commitment
            Mac::update(&mut mac, &[D_3]);
            Mac::update(&mut mac, &encode(T::from_usize(i)));
            Mac::update(&mut mac, &encode(T::from_usize(arr[i].len())));
            Mac::update(&mut mac, &arr[i]);
            Mac::update(&mut mac, commit);
            // Use MAC digest as the subkey for the current element
            let subkey: Vec<u8> = mac.finalize().into_bytes().to_vec();
            k_s.push(subkey);
        }
        k_s
    }
    fn indices<T>(
        key: &[u8],
        commit: &[u8],
        n: T,
        s: T,
        counter: T,
        encode: fn(T) -> Vec<u8>,
        decode: fn(&[u8]) -> T,
    ) -> Vec<T>
    where
        T: UnsignedInt,
    {
        // Initialize indices array [0..n-1]
        let n_usize = n.as_usize();
        let s_usize = s.as_usize();
        let mut k_i: Vec<T> = (0..n_usize).map(|i| T::from_usize(i)).collect();
        // Encode external counter
        let ctr_bytes_ext = encode(counter);
        // Initialize internal counter
        let mut ctr: T = T::from(0);
        // Byte source from PRF closure
        // Produces the next 32 bytes of PRF output on each call
        let mut next = || {
            // Encode internal counter
            let ctr_bytes_in = encode(ctr);
            ctr = ctr.wrapping_add(T::from(1));
            // Initialize MAC using key
            let mut mac = Hmac::<D>::new_from_slice(key)
                .expect("HMAC can take key of any size");
            // Absorb domain byte, commitment and counters
            Mac::update(&mut mac, &[D_4]);
            Mac::update(&mut mac, commit);
            Mac::update(&mut mac, &ctr_bytes_ext);
            Mac::update(&mut mac, &ctr_bytes_in);
            // Return MAC digest as PRF bytes
            let bytes: Vec<u8> = mac.finalize().into_bytes().to_vec();
            bytes
        };
        // Buffer of PRF bytes
        let mut p: Vec<u8> = Vec::new();
        // Iterate until reaching subset size
        for i in 0..s_usize {
            let i_c = T::from_usize(i);
            // Limit range to unsigned integer limit
            let range = n.wrapping_sub(i_c);
            // Calculate remainder for rejection sampling
            let rem = T::from(0).wrapping_sub(range) % range;
            // Draw v with rejection sampling
            let mut v: T;
            if rem == T::from(0) {
                // Range divides integer limit evenly, no rejection needed
                // Verify enough bytes available
                if p.len() < T::SIZE {
                    p = next();
                }
                // Read integer from p
                v = decode(&p[0..T::SIZE]);
                // Consume bytes
                p.drain(0..T::SIZE);
            } else {
                // Apply rejection sampling to avoid modulo bias
                let limit = T::from(0).wrapping_sub(rem);
                loop {
                    // Verify enough bytes available
                    if p.len() < T::SIZE {
                        p = next();
                    }
                    // Read integer from p
                    v = decode(&p[0..T::SIZE]);
                    // Consume bytes
                    p.drain(0..T::SIZE);
                    // Only accept v in range [0, limit)
                    if v.as_usize() < limit.as_usize() {
                        break;
                    }
                    // If v is out of range, draw another value
                }
            }
            // Map v into the indices array by modular reduction
            // of the remaining range size
            let j_usize = i + (v % range).as_usize();
            // Swap indices i and j
            k_i.swap(i, j_usize);
        }
        k_i[0..s_usize].to_vec()
    }
    fn combine<T>(
        subkeys: &Vec<Vec<u8>>,
        indices: &Vec<T>,
        commit: &[u8],
        counter: T,
        encode: fn(T) -> Vec<u8>,
    ) -> Vec<u8>
    where
        T: UnsignedInt,
    {
        // Set output length based on hashing algorithm
        let output_len = <D as OutputSizeUser>::output_size();
        // Encode external counter
        let ctr_bytes = encode(counter);
        // Allocate XOR accumulator
        let mut acc = vec![0u8; output_len];
        // For all selected indices
        for i in indices.iter() {
            // Initialize MAC using subkey
            let mut mac = Hmac::<D>::new_from_slice(&subkeys[i.as_usize()])
                .expect("HMAC can take key of any size");
            // Absorb commitment and counter
            Mac::update(&mut mac, &[D_5]);
            Mac::update(&mut mac, commit);
            Mac::update(&mut mac, &ctr_bytes);
            let y = mac.finalize().into_bytes().to_vec();
            // acc ^= Y
            for j in 0..output_len {
                acc[j] ^= y[j]
            }
        }
        acc
    }
    fn derive_key_nonce<T>(
        key: &[u8],
        commit: &[u8],
        counter: T,
        acc: &[u8],
        encode: fn(T) -> Vec<u8>,
    ) -> (Vec<u8>, [u8; 16])
    where
        T: UnsignedInt,
    {
        // Set PRF key length based on hashing algorithm
        let digest_len = <D as OutputSizeUser>::output_size();
        let key_len = if digest_len >= 32 {
            32 // AES-256
        } else if digest_len >= 24 {
            24 // AES-196
        } else {
            16 // AES-128
        };
        // Encode external counter
        let ctr_bytes = encode(counter);
        // Derive PRF key
        // Depends on commitment, counter, and accumulator
        let mut mac = Hmac::<D>::new_from_slice(key)
            .expect("HMAC can take key of any size");
        Mac::update(&mut mac, &[D_6]);
        Mac::update(&mut mac, commit);
        Mac::update(&mut mac, &ctr_bytes);
        Mac::update(&mut mac, acc);
        let key_full: Vec<u8> = mac.finalize().into_bytes().to_vec();
        let mut prf_key = vec![0u8; key_len];
        if key_full.len() >= key_len {
            prf_key.copy_from_slice(&key_full[0..key_len]);
        } else {
            // If hash output is too small, expand it with HKDF
            prf_key[0..key_full.len()].copy_from_slice(&key_full);
            let hk = Hkdf::<D>::new(None, &key_full);
            hk.expand(b"AES_KEY_EXPANSION", &mut prf_key[key_full.len()..])
                .expect("HKDF expansion should succeed");
        }
        // Derive PRF nonce
        // Depends on commitment and counter
        let mut mac = Hmac::<D>::new_from_slice(key)
            .expect("HMAC can take key of any size");
        Mac::update(&mut mac, &[D_7]);
        Mac::update(&mut mac, commit);
        Mac::update(&mut mac, &ctr_bytes);
        let nonce_full: Vec<u8> = mac.finalize().into_bytes().to_vec();
        let mut nonce = [0u8; 16];
        nonce.copy_from_slice(&nonce_full[0..16]);
        // Return PRF key and nonce
        (prf_key, nonce)
    }
}