stenoxide_core/image_io/

phash.rs

//! Perceptual hash margin filter with a hard stability limit of `k <= 1`.
//!
//! The Argon2id salt is not stored anywhere. It is recomputed from the image
//! itself on both sides, which is what lets extraction work without any
//! metadata travelling next to the payload. That only holds if the hash the
//! receiver computes over the *stego* image is bit-for-bit the one the sender
//! computed over the *cover* image.
//!
//! Embedding perturbs the least significant bits of a few thousand pixels. A
//! 32x32 DCT coefficient is an average over the whole image, so those flips
//! move it by a vanishing amount — unless the coefficient happened to sit right
//! on the median, in which case an arbitrarily small perturbation flips its
//! bit and the salt, the master key and the whole payload are lost.
//!
//! This module therefore refuses to hash images whose coefficients sit too
//! close to the median. Each bit carries a margin, and:
//!
//! - `k == 0` unstable bits: the hash is reproducible, embedding proceeds.
//! - `k == 1`: the image is still usable, but the receiver has to try both
//!   values of the uncertain bit; `recover_phash_salt` does exactly that.
//! - `k >= 2`: rejected. Two uncertain bits would mean four hypotheses, each
//!   costing a full Argon2id derivation, and the number doubles from there.
//!
//! The margin filter also absorbs a second, subtler source of divergence: the
//! DCT is built on `cos`, which is not specified bit-exactly by IEEE 754 and
//! may differ in the last place between platforms. A bit whose margin exceeds
//! `DELTA_MIN` cannot be flipped by an error of that size.

use std::f32::consts::PI;
use std::fmt;

use image::{imageops, imageops::FilterType, GrayImage, Luma};
use sha3::{Digest, Sha3_256};
use zeroize::{ZeroizeOnDrop, Zeroizing};

use crate::crypto::expand::{expand_master_key, DerivedKeys};
use crate::crypto::kdf::KeyDeriver;
use crate::image_io::buffer::{ColorSpace, CoverSource, ImageBuffer};

/// Side length of the square thumbnail the DCT is computed over.
const PHASH_THUMBNAIL_SIZE: usize = 32;

/// Number of AC coefficients turned into hash bits.
const N_HASH_BITS: usize = 64;

/// Smallest distance from the median a coefficient may have and still be
/// considered stable, in coefficient units.
///
/// The number is only meaningful against a fixed transform scale; see
/// [`dct_2d`], which is deliberately left unnormalised for that reason.
///
/// At that scale the threshold is a texture requirement in disguise. A smooth
/// container concentrates almost all of its energy in a handful of low
/// coefficients and leaves the rest piled up around a near-zero median, so
/// dozens of bits fall inside the margin and the image is rejected. A textured
/// one spreads its energy across the spectrum and clears the threshold on
/// every bit. That is the same property the cost layer wants, arrived at
/// independently.
const DELTA_MIN: f32 = 5.0;

/// Largest number of unstable bits an image may have and still be accepted.
///
/// One uncertain bit means two hypotheses on the receiving side. Two would
/// mean four Argon2id derivations, which at 128 MiB and four passes each is
/// already an unreasonable price to pay for a container the user can simply
/// replace.
const MAX_UNSTABLE_BITS: usize = 1;

/// Domain separator mixed into the salt so that the 64 hash bits cannot be
/// reused as an input to any other construction in this crate.
const PHASH_SALT_DOMAIN: &[u8] = b"STENOXIDE-v1-phash-salt";

/// Length of the derived salt, in bytes.
const PHASH_SALT_LEN: usize = 32;

/// Magic number of a Zstandard frame, little-endian, as it appears on the wire.
///
/// See [`prefix_matches_key`] for why a compression magic number, of all
/// things, is what distinguishes the two hypotheses.
const ZSTD_FRAME_MAGIC: [u8; 4] = [0x28, 0xB5, 0x2F, 0xFD];

/// Number of keystream bytes XChaCha20-Poly1305 spends on the Poly1305 key
/// before it starts encrypting the message.
///
/// The AEAD construction of RFC 8439 reserves block zero for the one-time MAC
/// key and encrypts the plaintext from block one onwards, so a raw XChaCha20
/// instance has to be seeked past those 64 bytes to line its keystream up with
/// the ciphertext.
const AEAD_KEYSTREAM_OFFSET: u64 = 64;

/// Perceptual hash of the container image, used as the Argon2id salt.
///
/// The bytes are wiped when the value is dropped. Like [`MasterKey`], the type
/// implements neither [`Clone`], [`Copy`] nor [`Debug`]: the salt is not a
/// secret in the sense a key is, but it is a deterministic function of the
/// container, and leaking it into a log would let an attacker confirm which
/// image a given payload belongs to.
///
/// # Why it compares and hashes, but still does not print
///
/// Two images that produce one salt produce one key and one nonce under any
/// given password, so a caller holding several containers has a question worth
/// asking about them: do any two of these collide? [`PartialEq`], [`Eq`] and
/// [`Hash`] are derived to answer exactly that, and to answer it in linear time
/// — grouping by salt needs a hash-map key, and comparing every pair instead
/// would be quadratic in the size of a photo library.
///
/// Equality is the whole of what a caller gets. [`as_bytes`] stays
/// crate-private and there is no public path to the 64 hash bits, so an outside
/// program can learn that two of its own files collide and cannot learn the
/// value that made them collide, nor compute a fingerprint it could compare
/// against an image it does not hold.
///
/// The comparison is not constant time and does not need to be. Both operands
/// are derived in-process from files the caller already has in front of them;
/// there is no remote party feeding one side of it, and nothing timeable that
/// the caller could not obtain by looking at the images.
///
/// [`MasterKey`]: crate::crypto::kdf::MasterKey
/// [`as_bytes`]: PHashSalt::as_bytes
#[derive(ZeroizeOnDrop, PartialEq, Eq, Hash)]
pub struct PHashSalt([u8; PHASH_SALT_LEN]);

impl PHashSalt {
    /// Wraps the 32 bytes of a perceptual hash as a salt.
    ///
    /// Restricted to the crate: outside code must obtain a salt through
    /// [`compute_stable_phash`], the only path that applies the stability
    /// filter.
    pub(crate) fn new(bytes: [u8; PHASH_SALT_LEN]) -> Self {
        Self(bytes)
    }

    /// Borrows the salt bytes, for use as the Argon2id salt.
    pub(crate) fn as_bytes(&self) -> &[u8] {
        &self.0
    }
}

/// Every way perceptual hashing can fail.
#[derive(Debug)]
pub enum PHashError {
    /// Too many coefficients sit within `DELTA_MIN` of the median for the
    /// hash to be reproducible after embedding.
    InsufficientStability {
        /// How many of the 64 bits are uncertain.
        unstable_bits: usize,
        /// The margin threshold that was applied.
        threshold: f32,
    },
    /// Neither hypothesis for the uncertain bit produced a key that matches the
    /// extracted payload. The image, the password or the payload is wrong.
    RecoveryFailed,
    /// Key derivation failed while testing a hypothesis.
    KdfError(String),
}

impl fmt::Display for PHashError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            PHashError::InsufficientStability {
                unstable_bits,
                threshold,
            } => write!(
                f,
                "image is perceptually unstable: {unstable_bits} hash bits sit within {threshold} \
                 of the median; choose a container with more texture"
            ),
            PHashError::RecoveryFailed => write!(
                f,
                "could not recover the perceptual hash salt from the stego image"
            ),
            PHashError::KdfError(message) => {
                write!(f, "key derivation failed during salt recovery: {message}")
            }
        }
    }
}

impl std::error::Error for PHashError {}

/// The 64 hash bits together with how far each one is from the decision
/// boundary.
///
/// Kept as one value because the two arrays are always produced and consumed
/// together: a bit without its margin cannot be judged reproducible, and a
/// margin without its bit says nothing about the hash.
struct HashBits {
    /// `true` where the AC coefficient is above the median.
    bits: [bool; N_HASH_BITS],
    /// `|coefficient - median|` for each bit.
    margins: [f32; N_HASH_BITS],
}

impl HashBits {
    /// Indices of the bits whose margin is below [`DELTA_MIN`].
    fn unstable_indices(&self) -> Vec<usize> {
        self.margins
            .iter()
            .enumerate()
            .filter(|(_, &margin)| margin < DELTA_MIN)
            .map(|(index, _)| index)
            .collect()
    }
}

/// BT.601 luma of one pixel, from the raw sample bytes of that pixel.
///
/// `sample` is exactly one pixel as laid out by `color_space`, so every index
/// below is in bounds by construction: the callers slice the buffer with
/// [`ColorSpace::bytes_per_pixel`].
///
/// Shared with [`crate::image_io::jpeg_detect`], which measures its block
/// energies on the same luma plane. The two analyses must agree on what "the
/// brightness of a pixel" means, so there is exactly one implementation of it.
pub(super) fn luminance(sample: &[u8], color_space: ColorSpace) -> u8 {
    let (red, green, blue) = match color_space {
        // Grayscale is already luma; running it through the coefficients would
        // only add a rounding error.
        ColorSpace::Luma8 => return sample[0],
        ColorSpace::Rgb8 | ColorSpace::Rgba8 => {
            (sample[0] as f32, sample[1] as f32, sample[2] as f32)
        }
        // Samples were stored as explicit little-endian pairs by the validation
        // stage, so they are re-read the same way here rather than as native
        // `u16`. Normalised to [0, 255] before the coefficients are applied, so
        // that DELTA_MIN means the same thing at both bit depths.
        ColorSpace::Rgb16 => {
            const SCALE: f32 = 255.0 / 65535.0;
            let red = u16::from_le_bytes([sample[0], sample[1]]) as f32 * SCALE;
            let green = u16::from_le_bytes([sample[2], sample[3]]) as f32 * SCALE;
            let blue = u16::from_le_bytes([sample[4], sample[5]]) as f32 * SCALE;
            (red, green, blue)
        }
    };

    let luma = 0.299 * red + 0.587 * green + 0.114 * blue;
    luma.clamp(0.0, 255.0) as u8
}

/// Step 1 and 2 — converts the image to luma and resizes it to 32x32.
///
/// The resize is bilinear ([`FilterType::Triangle`]): the filter kernel is
/// scaled to the source resolution, so every input pixel contributes to the
/// thumbnail. That is what makes the result insensitive to the handful of
/// least significant bits embedding will flip.
fn luminance_thumbnail(img: &ImageBuffer) -> GrayImage {
    let (width, height) = img.dimensions();
    let color_space = img.color_space();
    let bytes_per_pixel = color_space.bytes_per_pixel();
    let pixels = img.pixels();

    let full = GrayImage::from_fn(width, height, |x, y| {
        let offset = img.pixel_offset(x, y);
        // In range for every coordinate the closure is called with, by the
        // `CoverSource` length contract. Falling back to black instead of
        // indexing keeps the function total.
        let sample = pixels.get(offset..offset + bytes_per_pixel);
        Luma([sample.map_or(0, |sample| luminance(sample, color_space))])
    });

    let side = PHASH_THUMBNAIL_SIZE as u32;
    imageops::resize(&full, side, side, FilterType::Triangle)
}

/// Step 3 — separable DCT-II of the 32x32 thumbnail.
///
/// Rows first, then columns; the output is row-major, and the receiver
/// reproduces exactly this order.
///
/// # Why the transform is left unnormalised
///
/// No orthonormal scale factor is applied, following the convention every
/// mainstream perceptual hash uses. The choice is not cosmetic: it fixes the
/// scale that [`DELTA_MIN`] is measured against. Orthonormalising would divide
/// every AC coefficient by about sixteen, and a threshold of `5.0` would then
/// reject even densely textured containers, which is the opposite of what the
/// filter is for. Only the ratio between the threshold and the transform scale
/// has any meaning; this function pins one half of it.
fn dct_2d(thumbnail: &GrayImage) -> [f32; PHASH_THUMBNAIL_SIZE * PHASH_THUMBNAIL_SIZE] {
    const N: usize = PHASH_THUMBNAIL_SIZE;

    // basis[k][n] = cos(pi/N * (n + 1/2) * k). Constant for a fixed N, but
    // rebuilt per call because `cos` is not available in a const context on
    // stable Rust.
    let mut basis = [[0.0f32; N]; N];
    for (k, row) in basis.iter_mut().enumerate() {
        for (n, value) in row.iter_mut().enumerate() {
            *value = (PI / N as f32 * (n as f32 + 0.5) * k as f32).cos();
        }
    }

    let mut rows = [0.0f32; N * N];
    for y in 0..N {
        for (k, basis_row) in basis.iter().enumerate() {
            let mut acc = 0.0f32;
            for (n, weight) in basis_row.iter().enumerate() {
                acc += thumbnail.get_pixel(n as u32, y as u32).0[0] as f32 * weight;
            }
            rows[y * N + k] = acc;
        }
    }

    let mut coefficients = [0.0f32; N * N];
    for x in 0..N {
        for (k, basis_row) in basis.iter().enumerate() {
            let mut acc = 0.0f32;
            for (n, weight) in basis_row.iter().enumerate() {
                acc += rows[n * N + x] * weight;
            }
            coefficients[k * N + x] = acc;
        }
    }

    coefficients
}

/// Median of the 64 AC coefficients.
///
/// An even number of samples, so the two central values are averaged. Sorted
/// with [`f32::total_cmp`] rather than `partial_cmp`: the latter is fallible on
/// NaN, and a comparator that has to decide what to do about NaN is a
/// comparator that can panic.
fn median(coefficients: &[f32; N_HASH_BITS]) -> f32 {
    let mut sorted = *coefficients;
    sorted.sort_by(f32::total_cmp);
    (sorted[N_HASH_BITS / 2 - 1] + sorted[N_HASH_BITS / 2]) / 2.0
}

/// Steps 1 to 4 — everything up to, but not including, the stability verdict.
///
/// Split out because [`recover_phash_salt`] needs the margins as well as the
/// bits, and recomputing a DCT over a multi-megapixel image to get them back
/// would be wasteful.
fn compute_hash_bits(img: &ImageBuffer) -> HashBits {
    let thumbnail = luminance_thumbnail(img);
    let coefficients = dct_2d(&thumbnail);

    // The DC term at [0, 0] is the mean brightness of the whole image. It
    // carries no structure, dwarfs every other coefficient and would drag the
    // median with it, so it is dropped and the next 64 coefficients are taken
    // in row-major order.
    let mut ac = [0.0f32; N_HASH_BITS];
    ac.copy_from_slice(&coefficients[1..=N_HASH_BITS]);

    let median = median(&ac);

    let mut bits = [false; N_HASH_BITS];
    let mut margins = [0.0f32; N_HASH_BITS];
    for index in 0..N_HASH_BITS {
        bits[index] = ac[index] > median;
        margins[index] = (ac[index] - median).abs();
    }

    HashBits { bits, margins }
}

/// Step 6 — packs the 64 bits and hashes them into a salt.
///
/// Bits are packed most-significant-first inside each byte: bit `i` of the hash
/// lands in bit `7 - (i % 8)` of byte `i / 8`. The order is arbitrary but it is
/// part of the wire format, so both sides must agree on it.
fn salt_from_bits(bits: &[bool; N_HASH_BITS]) -> PHashSalt {
    let mut packed = [0u8; N_HASH_BITS / 8];
    for (index, &bit) in bits.iter().enumerate() {
        if bit {
            packed[index / 8] |= 1 << (7 - (index % 8));
        }
    }

    let mut hasher = Sha3_256::new();
    hasher.update(packed);
    hasher.update(PHASH_SALT_DOMAIN);
    let digest: [u8; PHASH_SALT_LEN] = hasher.finalize().into();

    PHashSalt::new(digest)
}

/// Every salt a container's perceptual hash could have produced.
///
/// One when the hash is fully determined; two when a single coefficient sits
/// inside the margin, in which case the sender used one of the pair and nothing
/// in the image says which.
pub(crate) struct PHashHypotheses {
    /// Salt of the bits exactly as they measure on this image.
    ///
    /// The one the sender used whenever the image is the unmodified cover, and
    /// the overwhelmingly likely one even for a stego image: the uncertain
    /// coefficient only moves if embedding happened to push it across the
    /// median.
    pub(crate) primary: PHashSalt,
    /// Salt of the same bits with the uncertain one flipped, when there is one.
    pub(crate) alternative: Option<PHashSalt>,
}

/// Enumerates the salts a container's hash can take, applying the same
/// stability limit as [`compute_stable_phash`].
///
/// The extraction path needs this rather than a single salt. Its problem is
/// circular: the payload is what tells the two hypotheses apart, and reading the
/// payload needs the permutation seed, which is derived from the salt. It can
/// only be broken by trying a hypothesis, extracting under it and letting
/// [`recover_phash_salt`] judge the result — which requires being able to name
/// the other hypothesis, and that is what this function provides.
///
/// # Errors
///
/// Returns [`PHashError::InsufficientStability`] when more than
/// [`MAX_UNSTABLE_BITS`] coefficients sit within [`DELTA_MIN`] of the median.
pub(crate) fn phash_salt_hypotheses(img: &ImageBuffer) -> Result<PHashHypotheses, PHashError> {
    let hash = compute_hash_bits(img);
    let unstable = hash.unstable_indices();

    if unstable.len() > MAX_UNSTABLE_BITS {
        return Err(PHashError::InsufficientStability {
            unstable_bits: unstable.len(),
            threshold: DELTA_MIN,
        });
    }

    let alternative = unstable.first().map(|&index| {
        let mut flipped = hash.bits;
        // In bounds: the indices come from enumerating the margin array, which
        // has exactly as many entries as the bit array. The fallback keeps the
        // function total without an index panic.
        if let Some(bit) = flipped.get_mut(index) {
            *bit = !*bit;
        }

        salt_from_bits(&flipped)
    });

    Ok(PHashHypotheses {
        primary: salt_from_bits(&hash.bits),
        alternative,
    })
}

/// Computes the perceptual hash salt of a container image, refusing images
/// whose hash would not survive embedding.
///
/// Public so that the stability of a container can be asked about on its own,
/// without running an embedding. The returned salt is opaque outside this
/// crate — it has no public accessor — so exposing this function grants the
/// verdict and not the value.
///
/// # Errors
///
/// Returns [`PHashError::InsufficientStability`] when more than
/// `MAX_UNSTABLE_BITS` coefficients sit within `DELTA_MIN` of the median.
/// Note that a single unstable bit is *accepted* here: the sender does not
/// care which value it takes, because the receiver resolves the ambiguity
/// during extraction.
pub fn compute_stable_phash(img: &ImageBuffer) -> Result<PHashSalt, PHashError> {
    Ok(phash_salt_hypotheses(img)?.primary)
}

/// Tests whether `ciphertext_prefix` was produced under the keys derived from a
/// candidate salt.
///
/// # Why this is not a MAC check
///
/// Poly1305 authenticates the ciphertext as a whole and its tag lives at the
/// very end of it, so a 64-byte prefix carries nothing that can be verified.
/// Extracting the entire payload before the salt is known is not an option
/// either: the STC decoder needs the permutation seed, which is derived from
/// the very key we are trying to pin down.
///
/// What a prefix *does* allow is decrypting it with the raw XChaCha20
/// keystream and looking at the plaintext. The payload is Zstandard-compressed
/// before it is encrypted, so the correct key uncovers a Zstandard frame magic
/// number and a wrong key uncovers uniformly random bytes — a discriminator
/// that is wrong with probability `2^-32`.
///
/// That is sound because this function decides nothing security-relevant. It
/// only picks which of two hypotheses to try first; the actual authentication
/// still happens when the pipeline decrypts the full payload under the chosen
/// salt, and a mistake here surfaces there as an ordinary authentication
/// failure.
fn prefix_matches_key(keys: &DerivedKeys, ciphertext_prefix: &[u8]) -> bool {
    use chacha20::cipher::{KeyIvInit, StreamCipher, StreamCipherSeek};
    use chacha20::XChaCha20;

    let Some(head) = ciphertext_prefix.get(..ZSTD_FRAME_MAGIC.len()) else {
        return false;
    };

    let mut cipher = XChaCha20::new(keys.enc_key().into(), keys.nonce().into());
    if cipher.try_seek(AEAD_KEYSTREAM_OFFSET).is_err() {
        return false;
    }

    let mut plaintext = Zeroizing::new(head.to_vec());

    // The fallible form: as of `cipher` 0.5 the plain `apply_keystream_b2b`
    // panics when the two buffers differ in length, and a panic is not
    // something this crate is allowed to reach for. The lengths do match here —
    // `plaintext` was built from `head` — so the branch is unreachable, and it
    // stays as a branch rather than an assertion for exactly that reason.
    if cipher
        .try_apply_keystream_b2b(head, &mut plaintext)
        .is_err()
    {
        return false;
    }

    plaintext.as_slice() == ZSTD_FRAME_MAGIC
}

/// Derives the keys for one hypothesis and checks them against the payload.
///
/// Returns `Ok(Some(salt))` when the hypothesis matches, `Ok(None)` when it
/// does not, and `Err` only when key derivation itself failed — a condition
/// that says nothing about which hypothesis was right and must not be confused
/// with a rejection.
fn try_hypothesis(
    bits: &[bool; N_HASH_BITS],
    password: &[u8],
    kdf: &impl KeyDeriver,
    ciphertext_prefix: &[u8],
) -> Result<Option<PHashSalt>, PHashError> {
    let salt = salt_from_bits(bits);

    let master_key = kdf
        .derive(password, &salt)
        .map_err(|err| PHashError::KdfError(err.to_string()))?;
    let keys =
        expand_master_key(&master_key).map_err(|err| PHashError::KdfError(err.to_string()))?;
    // Wiped here rather than at the end of the scope: nothing below needs it,
    // and the two hypotheses run concurrently, so one of the two master keys is
    // always live material that no longer has any use.
    drop(master_key);

    let matched = prefix_matches_key(&keys, ciphertext_prefix);
    drop(keys);

    if matched {
        Ok(Some(salt))
    } else {
        Ok(None)
    }
}

/// Recovers the salt of a stego image whose hash has one uncertain bit.
///
/// `ciphertext_prefix` is the first 64 bytes of the provisionally extracted
/// payload. It is used to tell the two hypotheses apart; see
/// [`prefix_matches_key`] for what "tell apart" means here and why it is not,
/// and does not need to be, an authentication step.
///
/// # Errors
///
/// Returns [`PHashError::InsufficientStability`] if the stego image has more
/// than [`MAX_UNSTABLE_BITS`] uncertain bits, [`PHashError::RecoveryFailed`] if
/// neither hypothesis matches the payload, and [`PHashError::KdfError`] if the
/// key derivation used to test a hypothesis failed.
pub(crate) fn recover_phash_salt(
    stego_img: &ImageBuffer,
    password: &[u8],
    kdf: &impl KeyDeriver,
    ciphertext_prefix: &[u8],
) -> Result<PHashSalt, PHashError> {
    let hash = compute_hash_bits(stego_img);
    let unstable = hash.unstable_indices();

    let uncertain = match unstable.as_slice() {
        // k = 0: every coefficient is far enough from the median that
        // embedding cannot have moved it across. The hash the receiver just
        // computed is the one the sender used, and no search is needed. This
        // is exactly what `compute_stable_phash` would return, minus a second
        // pass over the image.
        [] => return Ok(salt_from_bits(&hash.bits)),
        [index] => *index,
        more => {
            return Err(PHashError::InsufficientStability {
                unstable_bits: more.len(),
                threshold: DELTA_MIN,
            })
        }
    };

    let mut cleared = hash.bits;
    cleared[uncertain] = false;
    let mut set = hash.bits;
    set[uncertain] = true;

    // Argon2id at the production parameters costs 128 MiB and several hundred
    // milliseconds. Running the two hypotheses on separate threads makes the
    // recovery cost the same wall time as an ordinary derivation, at the price
    // of holding two memory blocks at once.
    let (cleared, set) = rayon::join(
        || try_hypothesis(&cleared, password, kdf, ciphertext_prefix),
        || try_hypothesis(&set, password, kdf, ciphertext_prefix),
    );

    // Both hypotheses can only match if the discriminator collided, which is a
    // `2^-32` event; picking either one is then as good as picking the other,
    // and the full-payload authentication downstream catches the mistake.
    match (cleared?, set?) {
        (Some(salt), _) | (None, Some(salt)) => Ok(salt),
        (None, None) => Err(PHashError::RecoveryFailed),
    }
}

#[cfg(test)]
mod tests {
    // The crate-wide bans on panicking helpers reach into `cfg(test)` code as
    // well. A test that cannot panic cannot fail, so they are lifted here and
    // only here.
    #![allow(clippy::expect_used)]
    #![allow(clippy::panic)]

    use super::*;

    use rand::rngs::StdRng;
    use rand::{RngExt, SeedableRng};

    use crate::crypto::aead::{compress_and_encrypt, XChaCha20Poly1305Cipher};
    use crate::crypto::kdf::{Argon2Kdf, MasterKey};

    /// Side length of the synthetic containers below.
    ///
    /// Exactly the thumbnail size, so the resize step is the identity and the
    /// DCT reads the samples these tests wrote. Building the hash out of a
    /// multi-megapixel image instead would test the resampler, not the filter.
    const SIDE: u32 = PHASH_THUMBNAIL_SIZE as u32;

    /// The password the recovery tests stretch.
    const PASSWORD: &[u8] = b"a-container-passphrase";

    /// A square of uncorrelated colour noise.
    ///
    /// White noise spreads the 64 AC coefficients over a range of some
    /// thousands of units, which is three orders of magnitude above the `5.0`
    /// stability margin — so the hash of such an image is reproducible for
    /// almost any seed.
    fn noise_image(seed: u64) -> ImageBuffer {
        let mut rng = StdRng::seed_from_u64(seed);
        let pixel_count = (SIDE * SIDE) as usize;
        let pixels = (0..pixel_count * 3).map(|_| rng.random()).collect();

        ImageBuffer::new(pixels, SIDE, SIDE, ColorSpace::Rgb8)
    }

    /// The first noise square at or after `seed` whose hash is reproducible.
    ///
    /// Almost every seed produces one, but not quite every seed: the two
    /// central AC coefficients are what the verdict turns on, and they land
    /// within `2 * DELTA_MIN` of each other often enough that pinning a
    /// literal seed would make these tests brittle for no reason.
    fn stable_noise_image(seed: u64) -> ImageBuffer {
        match (seed..seed + 64)
            .map(noise_image)
            .find(|image| compute_hash_bits(image).unstable_indices().is_empty())
        {
            Some(image) => image,
            None => panic!("no stable container in sixty-four candidates from {seed}"),
        }
    }

    /// A container with no structure at all, and therefore no usable hash.
    fn flat_image() -> ImageBuffer {
        let pixel_count = (SIDE * SIDE) as usize;

        ImageBuffer::new(vec![128u8; pixel_count * 3], SIDE, SIDE, ColorSpace::Rgb8)
    }

    /// Sixty-four bytes of ciphertext produced under the keys of `bits`.
    ///
    /// The head of a real payload: compressed with Zstandard and then
    /// encrypted, which is exactly what [`prefix_matches_key`] is written to
    /// recognise.
    fn ciphertext_prefix_for(bits: &[bool; N_HASH_BITS]) -> Vec<u8> {
        let salt = salt_from_bits(bits);
        let master_key = Argon2Kdf::low_cost_for_tests()
            .derive(PASSWORD, &salt)
            .expect("a non-empty password must stretch");
        let keys = expand_master_key(&master_key).expect("expansion must succeed");

        let ciphertext = compress_and_encrypt(
            &b"a payload long enough to fill a whole keystream block and then some".repeat(4),
            keys.enc_key(),
            keys.nonce(),
            &XChaCha20Poly1305Cipher::new(),
        )
        .expect("encryption must succeed");

        ciphertext.iter().copied().take(64).collect()
    }

    /// Every layout reduces to the same notion of brightness.
    #[test]
    fn luminance_reads_each_layout_on_the_same_scale() {
        // Grayscale is passed through untouched.
        assert_eq!(luminance(&[110], ColorSpace::Luma8), 110);

        // BT.601 weights the green channel most and the blue least.
        assert_eq!(luminance(&[255, 0, 0], ColorSpace::Rgb8), 76);
        assert_eq!(luminance(&[0, 255, 0], ColorSpace::Rgb8), 149);
        assert_eq!(luminance(&[0, 0, 255], ColorSpace::Rgb8), 29);

        // The alpha channel is not part of the brightness of a pixel.
        assert_eq!(
            luminance(&[255, 0, 0, 17], ColorSpace::Rgba8),
            luminance(&[255, 0, 0], ColorSpace::Rgb8)
        );

        // Sixteen-bit samples are read as little-endian pairs and normalised to
        // the same 0..=255 range, so `DELTA_MIN` means one thing at both depths.
        assert_eq!(
            luminance(&[0xFF, 0xFF, 0, 0, 0, 0], ColorSpace::Rgb16),
            luminance(&[255, 0, 0], ColorSpace::Rgb8)
        );
    }

    /// A textured container hashes reproducibly and leaves nothing to guess.
    #[test]
    fn a_textured_container_has_a_single_hypothesis() {
        let image = stable_noise_image(1);

        let hypotheses = match phash_salt_hypotheses(&image) {
            Ok(hypotheses) => hypotheses,
            Err(error) => panic!("colour noise must hash stably: {error}"),
        };

        assert!(
            hypotheses.alternative.is_none(),
            "a fully determined hash has nothing to disambiguate"
        );

        let salt = compute_stable_phash(&image).expect("the same image must hash again");
        assert_eq!(salt.as_bytes(), hypotheses.primary.as_bytes());
    }

    /// A container with no structure is refused, and the refusal counts the
    /// bits it could not pin down.
    #[test]
    fn a_flat_container_is_refused_as_unstable() {
        let error = phash_salt_hypotheses(&flat_image())
            .map(|_| ())
            .expect_err("a uniform image cannot hash reproducibly");

        match error {
            PHashError::InsufficientStability {
                unstable_bits,
                threshold,
            } => {
                assert!(unstable_bits > MAX_UNSTABLE_BITS);
                assert_eq!(threshold, DELTA_MIN);
            }
            other => panic!("expected an instability verdict, got: {other:?}"),
        }
    }

    /// Uncertain bits always come in pairs, so `k` is never exactly one.
    ///
    /// A structural property of the filter rather than an accident of the
    /// images below. The median of an even-sized sample is the midpoint of its
    /// two central values, so those two are equidistant from it and no other
    /// coefficient can be closer: whenever the smallest margin falls under
    /// [`DELTA_MIN`], two bits do at once.
    ///
    /// The consequence is worth stating where it can be checked: the branch of
    /// [`recover_phash_salt`] that resolves a single uncertain bit describes a
    /// case this filter cannot produce, and every container it accepts has a
    /// hash that is fully determined.
    #[test]
    fn uncertain_bits_never_appear_alone() {
        for seed in 0..64u64 {
            let unstable = compute_hash_bits(&noise_image(seed))
                .unstable_indices()
                .len();

            assert_ne!(unstable, 1, "seed {seed} produced a lone uncertain bit");
        }

        assert_ne!(compute_hash_bits(&flat_image()).unstable_indices().len(), 1);
    }

    /// The hash is a function of the image and of nothing else.
    #[test]
    fn the_salt_is_deterministic_and_image_dependent() {
        let image = stable_noise_image(100);
        let other_image = stable_noise_image(200);

        let first = compute_stable_phash(&image).expect("noise must hash");
        let again = compute_stable_phash(&image).expect("noise must hash");
        let other = compute_stable_phash(&other_image).expect("noise must hash");

        assert_eq!(first.as_bytes(), again.as_bytes());
        assert_ne!(first.as_bytes(), other.as_bytes());
    }

    /// Two containers that derive one salt compare equal and land in one
    /// bucket; an unrelated one does not.
    ///
    /// The property the equality surface exists for, and the reason it is not
    /// hypothetical: the hash is *built* to survive a change of this size —
    /// extraction could not recompute the salt otherwise — so a stego image and
    /// the cover it was made from are one container as far as the key
    /// derivation is concerned, and so are two frames of one burst.
    ///
    /// # Why the perturbation is this small
    ///
    /// The variant flips the least significant bit of three of the 3072 samples.
    /// Each flip moves the luma of its pixel by at most `0.587`, and every DCT
    /// coefficient is a weighted sum of the samples with weights in `[-1, 1]`,
    /// so no coefficient and no median can move by more than `3 * 0.587`. A bit
    /// therefore needs a margin below `3.52` to be at risk, and
    /// [`stable_noise_image`] returns a container whose every margin clears
    /// [`DELTA_MIN`] — the equality below is arithmetic, not luck.
    #[test]
    fn containers_that_derive_one_salt_group_together() {
        use std::collections::HashMap;

        let image = stable_noise_image(7);

        let mut samples = image.pixels().to_vec();
        for (index, sample) in samples.iter_mut().enumerate() {
            if index % 1024 == 0 {
                *sample ^= 1;
            }
        }
        assert_ne!(samples, image.pixels(), "the variant must be another file");

        let variant = ImageBuffer::new(samples, SIDE, SIDE, ColorSpace::Rgb8);
        let unrelated = stable_noise_image(4_000);

        let salt = compute_stable_phash(&image).expect("noise must hash");
        let variant_salt = compute_stable_phash(&variant).expect("noise must hash");
        let unrelated_salt = compute_stable_phash(&unrelated).expect("noise must hash");

        assert!(
            salt == variant_salt,
            "a change embedding could have made must not move the salt"
        );
        assert!(
            salt != unrelated_salt,
            "two unrelated containers must not share a salt"
        );

        // And the equality is usable as a hash-map key, which is what lets a
        // caller group a folder of containers in one pass instead of comparing
        // every pair of them.
        let mut buckets: HashMap<PHashSalt, usize> = HashMap::new();
        for salt in [salt, variant_salt, unrelated_salt] {
            *buckets.entry(salt).or_default() += 1;
        }

        assert_eq!(buckets.len(), 2, "the variant must join the image it came from");
        assert!(buckets.values().any(|&count| count == 2));
    }

    /// Flipping one hash bit changes the whole salt.
    ///
    /// The bits are packed and then hashed, so the salt is not a rearrangement
    /// of them and a neighbouring hypothesis shares nothing with its partner.
    #[test]
    fn one_flipped_bit_changes_the_whole_salt() {
        let mut bits = [false; N_HASH_BITS];
        let base = salt_from_bits(&bits);

        bits[17] = true;
        let flipped = salt_from_bits(&bits);

        assert_ne!(base.as_bytes(), flipped.as_bytes());
    }

    /// The median of an even sample is the midpoint of its two central values.
    #[test]
    fn the_median_is_the_midpoint_of_the_two_central_coefficients() {
        let mut coefficients = [0.0f32; N_HASH_BITS];
        for (index, value) in coefficients.iter_mut().enumerate() {
            *value = index as f32;
        }

        assert_eq!(median(&coefficients), 31.5);
    }

    /// A correct key uncovers a Zstandard frame; a wrong one uncovers noise.
    #[test]
    fn the_zstd_magic_number_tells_the_keys_apart() {
        let bits = [true; N_HASH_BITS];
        let prefix = ciphertext_prefix_for(&bits);

        let salt = salt_from_bits(&bits);
        let master_key = Argon2Kdf::low_cost_for_tests()
            .derive(PASSWORD, &salt)
            .expect("a non-empty password must stretch");
        let keys = expand_master_key(&master_key).expect("expansion must succeed");

        assert!(prefix_matches_key(&keys, &prefix));

        // Any other key decrypts the same prefix to bytes that are not a frame
        // header, which is the whole discriminator.
        let other = expand_master_key(&MasterKey::new([0x5Au8; 32])).expect("expansion");
        assert!(!prefix_matches_key(&other, &prefix));

        // A prefix too short to hold the magic number decides nothing.
        assert!(!prefix_matches_key(&keys, &prefix[..3]));
    }

    /// One hypothesis is confirmed by the payload, the other is not.
    #[test]
    fn a_hypothesis_is_judged_by_the_payload_it_explains() {
        let kdf = Argon2Kdf::low_cost_for_tests();
        let bits = [true; N_HASH_BITS];
        let prefix = ciphertext_prefix_for(&bits);

        // `PHashSalt` implements no `Debug` — it is derived from the container
        // and must not reach a log — so the arms below are spelled out rather
        // than compared with a macro that would want to print the value.
        match try_hypothesis(&bits, PASSWORD, &kdf, &prefix) {
            Ok(Some(salt)) => assert_eq!(salt.as_bytes(), salt_from_bits(&bits).as_bytes()),
            Ok(None) => panic!("the hypothesis the payload was made under must match"),
            Err(error) => panic!("derivation must succeed: {error}"),
        }

        let mut wrong = bits;
        wrong[0] = false;
        match try_hypothesis(&wrong, PASSWORD, &kdf, &prefix) {
            Ok(None) => {}
            Ok(Some(_)) => panic!("a hypothesis that explains nothing must be rejected"),
            Err(error) => panic!("derivation must succeed: {error}"),
        }

        // A derivation that fails is not a rejection: it says nothing about
        // which hypothesis was right and must not be reported as one.
        match try_hypothesis(&bits, &[], &kdf, &prefix) {
            Err(PHashError::KdfError(_)) => {}
            Err(error) => panic!("expected a derivation failure, got: {error}"),
            Ok(_) => panic!("an empty password must fail derivation"),
        }
    }

    /// A hash with no uncertain bit needs no search.
    #[test]
    fn recovery_short_circuits_on_a_certain_hash() {
        let image = stable_noise_image(4);
        let expected = compute_stable_phash(&image).expect("noise must hash");

        let recovered = recover_phash_salt(&image, PASSWORD, &Argon2Kdf::low_cost_for_tests(), &[])
            .expect("a fully determined hash needs no payload to be recovered");

        assert_eq!(recovered.as_bytes(), expected.as_bytes());
    }

    /// An image whose hash is not reproducible is refused by the recovery path
    /// on the same terms as by the sender's path.
    #[test]
    fn recovery_refuses_an_unstable_image() {
        let error = recover_phash_salt(
            &flat_image(),
            PASSWORD,
            &Argon2Kdf::low_cost_for_tests(),
            &[],
        )
        .map(|_| ())
        .expect_err("a uniform image has no hash to recover");

        assert!(
            matches!(error, PHashError::InsufficientStability { .. }),
            "got: {error:?}"
        );
    }

    /// Every failure of this layer explains itself.
    #[test]
    fn every_failure_explains_itself() {
        let unstable = PHashError::InsufficientStability {
            unstable_bits: 7,
            threshold: DELTA_MIN,
        }
        .to_string();
        assert!(unstable.contains('7') && unstable.contains("texture"));

        assert!(!PHashError::RecoveryFailed.to_string().is_empty());
        assert!(PHashError::KdfError("empty password".to_owned())
            .to_string()
            .contains("empty password"));
    }
}