flpdf 0.7.0

A pure-Rust PDF toolkit modeled on qpdf — read, rewrite, linearize, and inspect PDFs.
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
//! Stream SHA-256, SHA-384, or SHA-512 digests through a reusable pipeline
//! stage. Calling `finish()` resets the selected digest, so the next `write()`
//! starts a fresh cycle with the same bit size.
//!
//! qpdf correspondence: Pl_SHA2.cc reusable streaming SHA-256/384/512 digest with next-pipeline passthrough.
//!
//!
//!
//! The uncommitted `bits=0` write/finish paths would dereference qpdf's null crypto
//! provider, and digest access before the first `finish()` would read its uninitialized
//! result buffer. Rust translates those memory-unsafe states into defined logic errors.
use super::{Pipeline, PipelineError, PipelineResult};
use sha2::{Digest, Sha256, Sha384, Sha512};

enum Sha2Digest {
    Bits256(Sha256),
    Bits384(Sha384),
    Bits512(Sha512),
}

impl Sha2Digest {
    fn new(bits: i32) -> PipelineResult<Self> {
        match bits {
            256 => Ok(Self::Bits256(Sha256::new())),
            384 => Ok(Self::Bits384(Sha384::new())),
            512 => Ok(Self::Bits512(Sha512::new())),
            _ => Err(PipelineError::logic(
                "SHA2_native has bits != 256, 384, or 512",
            )),
        }
    }

    fn update(&mut self, data: &[u8]) {
        match self {
            Self::Bits256(hasher) => Digest::update(hasher, data),
            Self::Bits384(hasher) => Digest::update(hasher, data),
            Self::Bits512(hasher) => Digest::update(hasher, data),
        }
    }

    fn finalize_and_reset(&mut self) -> Vec<u8> {
        // qpdf's native close functions return the digest and reinitialize the same
        // selected context (`sha2.c:670-673`, `sha2big.c:209-228`).
        match self {
            Self::Bits256(hasher) => hasher.finalize_reset().to_vec(),
            Self::Bits384(hasher) => hasher.finalize_reset().to_vec(),
            Self::Bits512(hasher) => hasher.finalize_reset().to_vec(),
        }
    }
}

pub(crate) struct PlSha2<'a> {
    identifier: String,
    next: Option<&'a mut dyn Pipeline>,
    digest: Option<Sha2Digest>,
    raw_digest: Option<Vec<u8>>,
    in_progress: bool,
}

impl<'a> PlSha2<'a> {
    pub(crate) fn new(
        identifier: impl Into<String>,
        next: Option<&'a mut dyn Pipeline>,
        bits: i32,
    ) -> PipelineResult<Self> {
        let mut sha2 = Self {
            identifier: identifier.into(),
            next,
            digest: None,
            raw_digest: None,
            in_progress: false,
        };
        if bits != 0 {
            sha2.reset_bits(bits)?;
        }
        Ok(sha2)
    }

    pub(crate) fn reset_bits(&mut self, bits: i32) -> PipelineResult<()> {
        if self.in_progress {
            return Err(PipelineError::logic(
                "bit reset requested for in-progress SHA2 Pipeline",
            ));
        }
        self.digest = Some(Sha2Digest::new(bits)?);
        self.raw_digest = None;
        Ok(())
    }

    pub(crate) fn get_raw_digest(&self) -> PipelineResult<&[u8]> {
        if self.in_progress {
            return Err(PipelineError::logic(
                "digest requested for in-progress SHA2 Pipeline",
            ));
        }
        let identifier = &self.identifier;
        // qpdf-deviation-start: Pl_SHA2::getRawDigest (Pl_SHA2.cc:59-66)
        // unconditionally dereferences `crypto` here with no guard; if
        // resetBits() was called but finalize() never was, it reads
        // SHA2_native's raw C digest arrays before they are written --
        // genuinely uninitialized memory (UB). This converts that into a
        // defined logic error.
        self.raw_digest.as_deref().ok_or_else(|| {
            PipelineError::logic(format!(
                "{identifier}: Pl_SHA2: digest requested before finish() computed one"
            ))
        })
        // qpdf-deviation-end
    }

    #[cfg(test)]
    pub(crate) fn get_hex_digest(&self) -> PipelineResult<String> {
        self.get_raw_digest().map(hex::encode)
    }
}

impl Pipeline for PlSha2<'_> {
    fn identifier(&self) -> &str {
        &self.identifier
    }

    fn write(&mut self, data: &[u8]) -> PipelineResult<()> {
        let digest = match self.digest.as_mut() {
            Some(digest) => digest,
            // qpdf-deviation-start: Pl_SHA2::write (Pl_SHA2.cc:17-37) has
            // no guard here -- it unconditionally dereferences a
            // default-constructed (null) `crypto` shared_ptr when bits=0
            // was left uncommitted (resetBits() never called); this
            // converts qpdf's null-pointer UB into a defined logic error.
            // Unreachable from any parsed PDF: PlSha2 is pub(crate) and
            // its only production caller (encryption/standard.rs) always
            // passes bits in {256,384,512}.
            None => {
                let identifier = &self.identifier;
                return Err(PipelineError::logic(format!(
                    "{identifier}: Pl_SHA2: write() called before resetBits() selected a digest size"
                )));
            } // qpdf-deviation-end
        };
        self.in_progress = true;
        digest.update(data);
        if let Some(next) = self.next.as_deref_mut() {
            next.write(data)?;
        }
        Ok(())
    }

    fn finish(&mut self) -> PipelineResult<()> {
        // qpdf forwards to `next` unconditionally on every `finish()` call, including
        // repeats, before touching its own digest state — that part is unconditional.
        if let Some(next) = self.next.as_deref_mut() {
            next.finish()?;
        }
        if let Some(digest) = self.digest.as_mut() {
            self.raw_digest = Some(digest.finalize_and_reset());
            self.in_progress = false;
            return Ok(());
        }
        // qpdf-deviation-start: Pl_SHA2::finish (Pl_SHA2.cc:39-47)
        // unconditionally dereferences `crypto` here too, with the same
        // null-pointer UB when bits=0 was left uncommitted; converts it
        // into a defined logic error instead.
        let identifier = &self.identifier;
        Err(PipelineError::logic(format!(
            "{identifier}: Pl_SHA2: finish() called before resetBits() selected a digest size"
        )))
        // qpdf-deviation-end
    }
}

#[cfg(test)]
mod tests {
    use super::PlSha2;
    use crate::pipeline::{Pipeline, PipelineError, PipelineResult};

    // ── digest vectors (qpdf `libtests/sha2.cc`, cross-checked against NIST FIPS 180-4) ──

    fn digest_of(bits: i32, input: &[u8]) -> String {
        let mut sha2 = PlSha2::new("sha2", None, bits).unwrap();
        sha2.write(input).unwrap();
        sha2.finish().unwrap();
        sha2.get_hex_digest().unwrap()
    }

    #[test]
    fn sha256_short_vector_matches_fips_and_qpdf() {
        assert_eq!(
            digest_of(256, b"abc"),
            "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
        );
    }

    #[test]
    fn sha256_long_vector_matches_qpdf() {
        assert_eq!(
            digest_of(
                256,
                b"abcdbcdecdefdefgefghfghighijhijkijkljklmklmnlmnomnopnopq"
            ),
            "248d6a61d20638b8e5c026930c3e6039a33ce45964ff2167f6ecedd419db06c1"
        );
    }

    #[test]
    fn sha256_million_a_matches_qpdf() {
        let input = vec![b'a'; 1_000_000];
        assert_eq!(
            digest_of(256, &input),
            "cdc76e5c9914fb9281a1c7e284d73e67f1809a48a497200e046d39ccc7112cd0"
        );
    }

    #[test]
    fn sha384_short_vector_matches_fips_and_qpdf() {
        assert_eq!(
            digest_of(384, b"abc"),
            "cb00753f45a35e8bb5a03d699ac65007272c32ab0eded163\
             1a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7"
        );
    }

    #[test]
    fn sha384_long_vector_matches_qpdf() {
        assert_eq!(
            digest_of(
                384,
                b"abcdefghbcdefghicdefghijdefghijkefghijklfghijklmghijklmn\
                  hijklmnoijklmnopjklmnopqklmnopqrlmnopqrsmnopqrstnopqrstu"
            ),
            "09330c33f71147e83d192fc782cd1b4753111b173b3b05d2\
             2fa08086e3b0f712fcc7c71a557e2db966c3e9fa91746039"
        );
    }

    #[test]
    fn sha384_million_a_matches_qpdf() {
        let input = vec![b'a'; 1_000_000];
        assert_eq!(
            digest_of(384, &input),
            "9d0e1809716474cb086e834e310a4a1ced149e9c00f24852\
             7972cec5704c2a5b07b8b3dc38ecc4ebae97ddd87f3d8985"
        );
    }

    #[test]
    fn sha512_short_vector_matches_fips_and_qpdf() {
        assert_eq!(
            digest_of(512, b"abc"),
            "ddaf35a193617abacc417349ae20413112e6fa4e89a97ea20a9eeee64b55d39a\
             2192992a274fc1a836ba3c23a3feebbd454d4423643ce80e2a9ac94fa54ca49f"
        );
    }

    #[test]
    fn sha512_long_vector_matches_qpdf() {
        assert_eq!(
            digest_of(
                512,
                b"abcdefghbcdefghicdefghijdefghijkefghijklfghijklmghijklmn\
                  hijklmnoijklmnopjklmnopqklmnopqrlmnopqrsmnopqrstnopqrstu"
            ),
            "8e959b75dae313da8cf4f72814fc143f8f7779c6eb9f7fa17299aeadb6889018\
             501d289e4900f7e4331b99dec4b5433ac7d329eeb6dd26545e96e55b874be909"
        );
    }

    #[test]
    fn sha512_million_a_matches_qpdf() {
        let input = vec![b'a'; 1_000_000];
        assert_eq!(
            digest_of(512, &input),
            "e718483d0ce769644e2e42c7bc15b4638e1f98b13b2044285632a803afa973eb\
             de0ff244877ea60a4cb0432ce577c31beb009c5c2c49aa2e4eadb217ad8cc09b"
        );
    }

    // ── identifier and passthrough ──────────────────────────────────────────

    #[derive(Default)]
    struct RecordingSink {
        chunks: Vec<Vec<u8>>,
        finishes: usize,
    }

    impl Pipeline for RecordingSink {
        fn identifier(&self) -> &str {
            "recording"
        }

        fn write(&mut self, data: &[u8]) -> PipelineResult<()> {
            self.chunks.push(data.to_vec());
            Ok(())
        }

        fn finish(&mut self) -> PipelineResult<()> {
            self.finishes += 1;
            Ok(())
        }
    }

    #[test]
    fn identifier_matches_the_constructed_value() {
        let sha2 = PlSha2::new("pl-sha2-stage", None, 256).unwrap();
        assert_eq!(Pipeline::identifier(&sha2), "pl-sha2-stage");
    }

    /// A `PlSha2` can itself be another `PlSha2`'s `next`, matching qpdf's stackable
    /// `Pipeline` design (any pipeline is valid downstream of any other).
    #[test]
    fn a_sha2_pipeline_can_be_chained_as_another_ones_next() {
        let mut inner = PlSha2::new("inner", None, 256).unwrap();
        {
            let mut outer =
                PlSha2::new("outer", Some(&mut inner as &mut dyn Pipeline), 384).unwrap();
            outer.write(b"abc").unwrap();
            outer.finish().unwrap();
        }
        assert_eq!(
            inner.get_hex_digest().unwrap(),
            "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
        );
    }

    #[test]
    fn write_forwards_unmodified_bytes_to_next_once_per_call() {
        let mut sink = RecordingSink::default();
        let hex_digest;
        {
            let mut sha2 = PlSha2::new("sha2", Some(&mut sink as &mut dyn Pipeline), 256).unwrap();
            sha2.write(b"hello ").unwrap();
            sha2.write(b"world").unwrap();
            sha2.finish().unwrap();
            hex_digest = sha2.get_hex_digest().unwrap();
        }
        // Two separate write() calls forward as two separate downstream writes...
        assert_eq!(sink.chunks, vec![b"hello ".to_vec(), b"world".to_vec()]);
        // ...but the digest still accumulates across both, matching a single-shot hash.
        assert_eq!(hex_digest, digest_of(256, b"hello world"));
    }

    #[test]
    fn finish_forwards_to_next_before_finalizing_the_digest() {
        let mut sink = RecordingSink::default();
        {
            let mut sha2 = PlSha2::new("sha2", Some(&mut sink as &mut dyn Pipeline), 256).unwrap();
            sha2.write(b"abc").unwrap();
            sha2.finish().unwrap();
        }
        assert_eq!(sink.finishes, 1);
    }

    struct FinishFaultSink;

    impl Pipeline for FinishFaultSink {
        fn identifier(&self) -> &str {
            "finish-fault"
        }

        fn write(&mut self, _data: &[u8]) -> PipelineResult<()> {
            Ok(())
        }

        fn finish(&mut self) -> PipelineResult<()> {
            Err(PipelineError::logic(
                "finish-fault: downstream finish failed",
            ))
        }
    }

    #[test]
    fn finish_error_from_next_leaves_digest_unfinalized_and_in_progress() {
        let mut fault = FinishFaultSink;
        let mut sha2 = PlSha2::new("sha2", Some(&mut fault as &mut dyn Pipeline), 256).unwrap();
        sha2.write(b"abc").unwrap();

        let error = sha2.finish().unwrap_err();
        assert_eq!(error.to_string(), "finish-fault: downstream finish failed");

        // Ordering proof: `next.finish()` runs before `crypto.finalize()` in qpdf's
        // `Pl_SHA2::finish`. Since `next.finish()` failed, the digest must still be
        // unfinalized and `in_progress` must still be true.
        let digest_error = sha2.get_raw_digest().unwrap_err();
        assert_eq!(
            digest_error.to_string(),
            "digest requested for in-progress SHA2 Pipeline"
        );
    }

    #[test]
    fn repeated_finish_starts_an_empty_cycle_and_forwards_each_time() {
        let cases = [
            (
                256,
                "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
            ),
            (
                384,
                "38b060a751ac96384cd9327eb1b1e36a21fdb71114be07434c0cc7bf63f6e1d\
                 a274edebfe76f65fbd51ad2f14898b95b",
            ),
            (
                512,
                "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9\
                 ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e",
            ),
        ];

        for (bits, expected) in cases {
            let mut sink = RecordingSink::default();
            let second_digest;
            {
                let mut sha2 =
                    PlSha2::new("sha2", Some(&mut sink as &mut dyn Pipeline), bits).unwrap();
                sha2.write(b"abc").unwrap();
                sha2.finish().unwrap();
                sha2.finish().unwrap();
                second_digest = sha2.get_hex_digest().unwrap();
            }

            assert_eq!(second_digest, expected);
            assert_eq!(sink.finishes, 2);
        }
    }

    struct WriteFaultSink;

    impl Pipeline for WriteFaultSink {
        fn identifier(&self) -> &str {
            "write-fault"
        }

        fn write(&mut self, _data: &[u8]) -> PipelineResult<()> {
            Err(PipelineError::runtime(
                "write-fault: downstream write failed",
            ))
        }

        fn finish(&mut self) -> PipelineResult<()> {
            Ok(())
        }
    }

    #[test]
    fn downstream_write_error_is_returned_unchanged() {
        let mut fault = WriteFaultSink;
        let mut sha2 = PlSha2::new("sha2", Some(&mut fault as &mut dyn Pipeline), 256).unwrap();
        let error = sha2.write(b"x").unwrap_err();
        assert!(matches!(error, PipelineError::Runtime(_)));
        assert_eq!(error.to_string(), "write-fault: downstream write failed");
    }

    #[test]
    fn helper_sink_identifiers_and_noop_halves_are_exercised() {
        assert_eq!(RecordingSink::default().identifier(), "recording");

        assert_eq!(FinishFaultSink.identifier(), "finish-fault");
        // The half of `FinishFaultSink` that no test above exercises: `write()` is a no-op.
        FinishFaultSink.write(b"ignored").unwrap();

        assert_eq!(WriteFaultSink.identifier(), "write-fault");
        // The half of `WriteFaultSink` that no test above exercises: `finish()` is a no-op.
        WriteFaultSink.finish().unwrap();
    }

    /// qpdf FIPS 180-4 empty-string digest. `Pl_SHA2::finish` finalizes unconditionally
    /// (no `in_progress` check), so a committed pipeline that never received a `write()`
    /// must still produce the hash of zero bytes.
    #[test]
    fn finish_with_no_prior_write_computes_the_empty_input_digest() {
        let mut sha2 = PlSha2::new("sha2", None, 256).unwrap();
        sha2.finish().unwrap();
        assert_eq!(
            sha2.get_hex_digest().unwrap(),
            "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
        );
    }

    /// qpdf's `Pl_SHA2::write` does not special-case `len == 0`: it unconditionally sets
    /// `in_progress` and unconditionally forwards to `next`, unlike e.g. `Pl_Count`/`Pl_RC4`
    /// in this codebase which skip empty writes.
    #[test]
    fn empty_write_still_sets_in_progress_and_forwards_an_empty_chunk() {
        let mut sink = RecordingSink::default();
        {
            let mut sha2 = PlSha2::new("sha2", Some(&mut sink as &mut dyn Pipeline), 256).unwrap();
            sha2.write(b"").unwrap();
            let in_progress_error = sha2.get_raw_digest().unwrap_err();
            assert_eq!(
                in_progress_error.to_string(),
                "digest requested for in-progress SHA2 Pipeline"
            );
            sha2.finish().unwrap();
        }
        assert_eq!(sink.chunks, vec![Vec::<u8>::new()]);
    }

    #[test]
    fn no_next_pipeline_still_computes_a_digest() {
        let mut sha2 = PlSha2::new("sha2", None, 256).unwrap();
        sha2.write(b"abc").unwrap();
        sha2.finish().unwrap();
        assert_eq!(
            sha2.get_hex_digest().unwrap(),
            "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
        );
    }

    // ── in-progress guards (qpdf `Pl_SHA2::resetBits` / `getRawDigest`) ─────

    #[test]
    fn reset_bits_while_in_progress_is_rejected() {
        let mut sha2 = PlSha2::new("sha2", None, 256).unwrap();
        sha2.write(b"abc").unwrap();
        let error = sha2.reset_bits(256).unwrap_err();
        assert_eq!(
            error.to_string(),
            "bit reset requested for in-progress SHA2 Pipeline"
        );
    }

    #[test]
    fn raw_digest_while_in_progress_is_rejected() {
        let mut sha2 = PlSha2::new("sha2", None, 256).unwrap();
        sha2.write(b"abc").unwrap();
        let error = sha2.get_raw_digest().unwrap_err();
        assert_eq!(
            error.to_string(),
            "digest requested for in-progress SHA2 Pipeline"
        );
    }

    #[test]
    fn hex_digest_while_in_progress_is_rejected() {
        let mut sha2 = PlSha2::new("sha2", None, 256).unwrap();
        sha2.write(b"abc").unwrap();
        let error = sha2.get_hex_digest().unwrap_err();
        assert_eq!(
            error.to_string(),
            "digest requested for in-progress SHA2 Pipeline"
        );
    }

    #[test]
    fn invalid_bit_length_is_rejected_at_construction() {
        let error = PlSha2::new("sha2", None, 128)
            .err()
            .expect("bits=128 must be rejected");
        assert_eq!(
            error.to_string(),
            "SHA2_native has bits != 256, 384, or 512"
        );
    }

    #[test]
    fn invalid_bit_length_is_rejected_by_reset_bits() {
        let mut sha2 = PlSha2::new("sha2", None, 256).unwrap();
        sha2.write(b"abc").unwrap();
        sha2.finish().unwrap();
        let error = sha2.reset_bits(1).unwrap_err();
        assert_eq!(
            error.to_string(),
            "SHA2_native has bits != 256, 384, or 512"
        );
    }

    // ── reuse across resetBits cycles (mirrors qpdf's own `libtests/sha2.cc`) ─

    #[test]
    fn same_pipeline_is_reusable_across_reset_bits_cycles_with_different_lengths() {
        let mut sha2 = PlSha2::new("sha2", None, 0).unwrap();

        sha2.reset_bits(256).unwrap();
        sha2.write(b"abc").unwrap();
        sha2.finish().unwrap();
        assert_eq!(
            sha2.get_hex_digest().unwrap(),
            "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad"
        );

        sha2.reset_bits(384).unwrap();
        sha2.write(b"abc").unwrap();
        sha2.finish().unwrap();
        assert_eq!(
            sha2.get_hex_digest().unwrap(),
            "cb00753f45a35e8bb5a03d699ac65007272c32ab0eded163\
             1a8b605a43ff5bed8086072ba1e7cc2358baeca134c825a7"
        );
    }

    // ── never-committed pipeline safety (qpdf leaves `bits=0` uncommitted; the C++
    //    crypto pointer is genuinely null there and `write()`/`finish()` would
    //    dereference it. Converting that crash into a defined logic error is the
    //    mandatory Rust-safety translation of C++ UB — see module doc §1.) ──────────

    #[test]
    fn write_before_reset_bits_is_rejected() {
        let mut sha2 = PlSha2::new("sha2-stage", None, 0).unwrap();
        let error = sha2.write(b"abc").unwrap_err();
        assert_eq!(
            error.to_string(),
            "sha2-stage: Pl_SHA2: write() called before resetBits() selected a digest size"
        );
    }

    #[test]
    fn finish_before_reset_bits_is_rejected() {
        let mut sha2 = PlSha2::new("sha2-stage", None, 0).unwrap();
        let error = sha2.finish().unwrap_err();
        assert_eq!(
            error.to_string(),
            "sha2-stage: Pl_SHA2: finish() called before resetBits() selected a digest size"
        );
    }

    #[test]
    fn digest_before_finish_is_rejected() {
        let sha2 = PlSha2::new("sha2-stage", None, 256).unwrap();
        let error = sha2.get_raw_digest().unwrap_err();
        assert_eq!(
            error.to_string(),
            "sha2-stage: Pl_SHA2: digest requested before finish() computed one"
        );
    }

    #[test]
    fn write_after_finish_starts_a_fresh_cycle_with_the_same_bit_size() {
        let cases = [
            (
                256,
                "cb8379ac2098aa165029e3938a51da0bcecfc008fd6795f401178647f96c5b34",
            ),
            (
                384,
                "180c325cccb299e76ec6c03a5b5a7755af8ef499906dbf531f18d0ca509e4871\
                 b0805cac0f122b962d54badc6119f3cf",
            ),
            (
                512,
                "40a855bf0a93c1019d75dd5b59cd8157608811dd75c5977e07f3bc4be0cad98\
                 b22dde4db9ddb429fc2ad3cf9ca379fedf6c1dc4d4bb8829f10c2f0ee04a66663",
            ),
        ];

        for (bits, expected) in cases {
            let mut sha2 = PlSha2::new("sha2-stage", None, bits).unwrap();
            sha2.write(b"abc").unwrap();
            sha2.finish().unwrap();
            sha2.write(b"def").unwrap();
            sha2.finish().unwrap();

            assert_eq!(sha2.get_hex_digest().unwrap(), expected);
        }
    }
}