hctr2-rs 0.9.1

HCTR2 and HCTR3 length-preserving encryption with format-preserving variants
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
//! Cross-check tests to verify Rust implementation matches Zig implementation.
//!
//! These tests use fixed inputs and produce deterministic outputs that can be
//! compared against the Zig implementation.

#[cfg(test)]
mod tests {
    use crate::common::lfsr_next_128;
    use crate::hctr2fp::{decode_base_radix, encode_base_radix, first_block_length};
    use crate::*;

    /// Helper to format bytes as hex string for output.
    fn hex(data: &[u8]) -> String {
        data.iter().map(|b| format!("{:02x}", b)).collect()
    }

    #[test]
    fn cross_check_hctr2_128_basic() {
        let key = [0x01u8; 16];
        let cipher = Hctr2_128::new(&key);

        let plaintext = b"Hello, this is a test message that is longer than one block!";
        let tweak = b"test tweak data";

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR2-128 Basic Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_hctr2_256_basic() {
        let key = [0x02u8; 32];
        let cipher = Hctr2_256::new(&key);

        let plaintext = b"This is another test message for HCTR2-256 with a longer key size!";
        let tweak = b"another test tweak";

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR2-256 Basic Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_hctr3_128_basic() {
        let key = [0x01u8; 16];
        let cipher = Hctr3_128::new(&key);

        let plaintext = b"Hello, this is a test message that is longer than one block!";
        let tweak = b"test tweak data";

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR3-128 Basic Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_hctr3_256_basic() {
        let key = [0x02u8; 32];
        let cipher = Hctr3_256::new(&key);

        let plaintext = b"This is another test message for HCTR3-256 with a longer key size!";
        let tweak = b"another test tweak";

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR3-256 Basic Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_lfsr_128() {
        let initial = [0x01u8; 16];
        let mut state = initial;

        println!("LFSR-128 Evolution Test:");
        println!("  Initial: {}", hex(&state));

        for i in 1..=10 {
            state = lfsr_next_128(&state);
            println!("  State {:2}: {}", i, hex(&state));
        }

        let mut state2 = [0xFFu8; 16];
        println!("\nLFSR-128 with MSB set:");
        println!("  Initial: {}", hex(&state2));
        for i in 1..=5 {
            state2 = lfsr_next_128(&state2);
            println!("  State {:2}: {}", i, hex(&state2));
        }
    }

    #[test]
    fn cross_check_chctr2_128_basic() {
        let key = [0x42u8; 32];
        let cipher = Chctr2_128::new(&key);

        let plaintext = b"CHCTR2 test message with some length!";
        let tweak = b"chctr2 tweak";

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, tweak, &mut ciphertext).unwrap();

        println!("CHCTR2-128 Basic Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_hctr2_twkd_128_basic() {
        let master_key = [0x55u8; 16];
        let cipher = Hctr2TwKD_128::new(&master_key);

        let plaintext = b"HCTR2-TwKD test message!";
        // Tweak must be at least 16 bytes, with top 2 bits of first byte = 0
        let tweak = [0x01u8; 20];

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, &tweak, &mut ciphertext).unwrap();

        println!("HCTR2-TwKD-128 Basic Test:");
        println!("  Master Key: {}", hex(&master_key));
        println!("  Tweak:      {}", hex(&tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, &tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_encode_decode_radix_10() {
        let value: u128 = 0x0123456789ABCDEF_FEDCBA9876543210;
        let mut digits = vec![0u8; first_block_length(10)];
        encode_base_radix(value, 10, &mut digits);

        println!("Base-10 Encode/Decode Test:");
        println!("  Value:  {:032x}", value);
        println!("  Digits: {:?}", digits);

        let decoded = decode_base_radix(&digits, 10).unwrap();
        assert_eq!(value, decoded);
    }

    #[test]
    fn cross_check_encode_decode_radix_16() {
        let value: u128 = 0xDEADBEEFCAFEBABE_0123456789ABCDEF;
        let mut digits = vec![0u8; first_block_length(16)];
        encode_base_radix(value, 16, &mut digits);

        println!("Base-16 Encode/Decode Test:");
        println!("  Value:  {:032x}", value);
        println!("  Digits: {:?}", digits);

        let decoded = decode_base_radix(&digits, 16).unwrap();
        assert_eq!(value, decoded);
    }

    #[test]
    fn cross_check_hctr2fp_decimal() {
        let key = [0x42u8; 16];
        let cipher = Hctr2Fp_128_Decimal::new(&key);

        let value: u128 = 0x0123456789ABCDEF_FEDCBA9876543210;
        let first_len = first_block_length(10);
        let mut plaintext = vec![0u8; first_len + 10]; // first block + 10 tail digits
        encode_base_radix(value, 10, &mut plaintext[..first_len]);
        for i in first_len..plaintext.len() {
            plaintext[i] = ((i - first_len) % 10) as u8;
        }

        let tweak = b"test_tweak";
        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR2-FP-128-Decimal Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {:?}", plaintext);
        println!("  Ciphertext: {:?}", ciphertext);

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext, decrypted);
    }

    #[test]
    fn cross_check_hctr2fp_hex() {
        let key = [0x99u8; 16];
        let cipher = Hctr2Fp_128_Hex::new(&key);

        let value: u128 = 0xDEADBEEFCAFEBABE_123456789ABCDEF0;
        let first_len = first_block_length(16);
        let mut plaintext = vec![0u8; first_len + 8];
        encode_base_radix(value, 16, &mut plaintext[..first_len]);
        for i in first_len..plaintext.len() {
            plaintext[i] = ((i - first_len) % 16) as u8;
        }

        let tweak = b"hex_tweak";
        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR2-FP-128-Hex Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {:?}", plaintext);
        println!("  Ciphertext: {:?}", ciphertext);

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext, decrypted);
    }

    #[test]
    fn cross_check_hctr3fp_decimal() {
        let key = [0x42u8; 16];
        let cipher = Hctr3Fp_128_Decimal::new(&key);

        let value: u128 = 0x0123456789ABCDEF_FEDCBA9876543210;
        let first_len = first_block_length(10);
        let mut plaintext = vec![0u8; first_len + 10];
        encode_base_radix(value, 10, &mut plaintext[..first_len]);
        for i in first_len..plaintext.len() {
            plaintext[i] = ((i - first_len) % 10) as u8;
        }

        let tweak = b"test_tweak";
        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR3-FP-128-Decimal Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {:?}", plaintext);
        println!("  Ciphertext: {:?}", ciphertext);

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext, decrypted);
    }

    #[test]
    fn cross_check_hctr3fp_hex() {
        let key = [0x99u8; 16];
        let cipher = hctr3fp::Hctr3Fp_128_Hex::new(&key);

        let value: u128 = 0xDEADBEEFCAFEBABE_123456789ABCDEF0;
        let first_len = first_block_length(16);
        let mut plaintext = vec![0u8; first_len + 8];
        encode_base_radix(value, 16, &mut plaintext[..first_len]);
        for i in first_len..plaintext.len() {
            plaintext[i] = ((i - first_len) % 16) as u8;
        }

        let tweak = b"hex_tweak";
        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR3-FP-128-Hex Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {:?}", plaintext);
        println!("  Ciphertext: {:?}", ciphertext);

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext, decrypted);
    }

    #[test]
    fn cross_check_chctr2_256_basic() {
        let key = [0x42u8; 64];
        let cipher = Chctr2_256::new(&key);

        let plaintext = b"CHCTR2-256 test message with some length!";
        let tweak = b"chctr2-256 tweak";

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, tweak, &mut ciphertext).unwrap();

        println!("CHCTR2-256 Basic Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_hctr2_twkd_256_basic() {
        let master_key = [0x55u8; 32];
        let cipher = Hctr2TwKD_256::new(&master_key);

        let plaintext = b"HCTR2-TwKD-256 test message!";
        // Tweak must be at least 16 bytes, with top 2 bits of first byte = 0
        let tweak = [0x02u8; 20];

        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(plaintext, &tweak, &mut ciphertext).unwrap();

        println!("HCTR2-TwKD-256 Basic Test:");
        println!("  Master Key: {}", hex(&master_key));
        println!("  Tweak:      {}", hex(&tweak));
        println!("  Plaintext:  {}", hex(plaintext));
        println!("  Ciphertext: {}", hex(&ciphertext));

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, &tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext.as_slice(), decrypted.as_slice());
    }

    #[test]
    fn cross_check_hctr2fp_256_decimal() {
        let key = [0x42u8; 32];
        let cipher = Hctr2Fp_256_Decimal::new(&key);

        let value: u128 = 0x0123456789ABCDEF_FEDCBA9876543210;
        let first_len = first_block_length(10);
        let mut plaintext = vec![0u8; first_len + 10];
        encode_base_radix(value, 10, &mut plaintext[..first_len]);
        for i in first_len..plaintext.len() {
            plaintext[i] = ((i - first_len) % 10) as u8;
        }

        let tweak = b"test256_tweak";
        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR2-FP-256-Decimal Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {:?}", plaintext);
        println!("  Ciphertext: {:?}", ciphertext);

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext, decrypted);
    }

    #[test]
    fn cross_check_hctr3fp_256_decimal() {
        let key = [0x42u8; 32];
        let cipher = Hctr3Fp_256_Decimal::new(&key);

        let value: u128 = 0x0123456789ABCDEF_FEDCBA9876543210;
        let first_len = first_block_length(10);
        let mut plaintext = vec![0u8; first_len + 10];
        encode_base_radix(value, 10, &mut plaintext[..first_len]);
        for i in first_len..plaintext.len() {
            plaintext[i] = ((i - first_len) % 10) as u8;
        }

        let tweak = b"test256_tweak";
        let mut ciphertext = vec![0u8; plaintext.len()];
        cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();

        println!("HCTR3-FP-256-Decimal Test:");
        println!("  Key:        {}", hex(&key));
        println!("  Tweak:      {}", hex(tweak));
        println!("  Plaintext:  {:?}", plaintext);
        println!("  Ciphertext: {:?}", ciphertext);

        let mut decrypted = vec![0u8; plaintext.len()];
        cipher.decrypt(&ciphertext, tweak, &mut decrypted).unwrap();
        assert_eq!(plaintext, decrypted);
    }

    #[test]
    fn cross_check_deterministic_vectors() {
        println!("\n=== DETERMINISTIC TEST VECTORS ===\n");

        {
            let key = [0u8; 16];
            let cipher = Hctr2_128::new(&key);
            let plaintext = [0x00u8; 16];
            let tweak = b"";
            let mut ciphertext = [0u8; 16];
            cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();
            println!("Test 1: HCTR2-128 zero key, 16-byte zero plaintext, empty tweak");
            println!("  Ciphertext: {}", hex(&ciphertext));
        }

        {
            let key = [0u8; 16];
            let cipher = Hctr3_128::new(&key);
            let plaintext = [0x00u8; 16];
            let tweak = b"";
            let mut ciphertext = [0u8; 16];
            cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();
            println!("Test 2: HCTR3-128 zero key, 16-byte zero plaintext, empty tweak");
            println!("  Ciphertext: {}", hex(&ciphertext));
        }

        {
            let key = [0u8; 16];
            let cipher = Hctr2Fp_128_Decimal::new(&key);
            let mut plaintext = [0u8; 39];
            plaintext[0] = 1;
            plaintext[1] = 2;
            plaintext[2] = 3;
            let tweak = b"";
            let mut ciphertext = [0u8; 39];
            cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();
            println!("Test 3: HCTR2-FP-128 decimal, zero key, digits [1,2,3,0...], empty tweak");
            println!("  Ciphertext: {:?}", ciphertext);
        }

        {
            let key = [0u8; 16];
            let cipher = Hctr3Fp_128_Decimal::new(&key);
            let mut plaintext = [0u8; 39];
            plaintext[0] = 1;
            plaintext[1] = 2;
            plaintext[2] = 3;
            let tweak = b"";
            let mut ciphertext = [0u8; 39];
            cipher.encrypt(&plaintext, tweak, &mut ciphertext).unwrap();
            println!("Test 4: HCTR3-FP-128 decimal, zero key, digits [1,2,3,0...], empty tweak");
            println!("  Ciphertext: {:?}", ciphertext);
        }

        {
            let state0 = [0x01u8; 16];
            let state1 = lfsr_next_128(&state0);
            let state2 = lfsr_next_128(&state1);
            println!("Test 5: LFSR-128 evolution from [0x01; 16]");
            println!("  State 0: {}", hex(&state0));
            println!("  State 1: {}", hex(&state1));
            println!("  State 2: {}", hex(&state2));
        }
    }
}