midnight-circuits 6.3.0

// This file is part of MIDNIGHT-ZK.
// Copyright (C) 2025 Midnight Foundation
// SPDX-License-Identifier: Apache-2.0
// Licensed under the Apache License, Version 2.0 (the "License");
// You may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! Implementation in-circuit of the SHA256 hash function.

#![allow(non_snake_case)]

mod sha256_chip;
mod sha256_varlen;
mod types;
mod utils;

use ff::PrimeField;
use midnight_proofs::{circuit::Layouter, plonk::Error};
use sha2::Digest;
pub use sha256_chip::{Sha256Chip, Sha256Config, NB_SHA256_ADVICE_COLS, NB_SHA256_FIXED_COLS};
pub use sha256_varlen::VarLenSha256Gadget;

use crate::{
    instructions::{
        hash::{HashCPU, VarHashInstructions},
        DecompositionInstructions, HashInstructions,
    },
    types::AssignedByte,
    vec::AssignedVector,
};

impl<F: PrimeField> HashCPU<u8, [u8; 32]> for Sha256Chip<F> {
    fn hash(inputs: &[u8]) -> [u8; 32] {
        let output = sha2::Sha256::digest(inputs);
        output.into_iter().collect::<Vec<_>>().try_into().unwrap()
    }
}

impl<F: PrimeField> HashInstructions<F, AssignedByte<F>, [AssignedByte<F>; 32]> for Sha256Chip<F> {
    fn hash(
        &self,
        layouter: &mut impl Layouter<F>,
        inputs: &[AssignedByte<F>],
    ) -> Result<[AssignedByte<F>; 32], Error> {
        let mut output_bytes = Vec::with_capacity(32);

        // We convert each `AssignedPlain<32>` returned by `self.sha256` into 4 bytes.
        for word in self.sha256(layouter, inputs)? {
            let bytes = self.native_gadget.assigned_to_be_bytes(layouter, &word.0, Some(4))?;
            output_bytes.extend(bytes)
        }

        Ok(output_bytes.try_into().unwrap())
    }
}

impl<F: PrimeField> HashCPU<u8, [u8; 32]> for VarLenSha256Gadget<F> {
    fn hash(inputs: &[u8]) -> [u8; 32] {
        let output = sha2::Sha256::digest(inputs);
        output.into_iter().collect::<Vec<_>>().try_into().unwrap()
    }
}

impl<F: PrimeField, const MAX_LEN: usize>
    VarHashInstructions<F, MAX_LEN, AssignedByte<F>, [AssignedByte<F>; 32], 64>
    for VarLenSha256Gadget<F>
{
    fn varhash(
        &self,
        layouter: &mut impl Layouter<F>,
        inputs: &AssignedVector<F, AssignedByte<F>, MAX_LEN, 64>,
    ) -> Result<[AssignedByte<F>; 32], Error> {
        let mut output_bytes = Vec::with_capacity(32);

        // We convert each `AssignedPlain<32>` returned by `self.sha256_varlen` into 4
        // bytes.
        for word in self.sha256_varlen(layouter, inputs)? {
            let bytes =
                self.sha256chip.native_gadget.assigned_to_be_bytes(layouter, &word.0, Some(4))?;
            output_bytes.extend(bytes)
        }

        Ok(output_bytes.try_into().unwrap())
    }
}

#[cfg(test)]
mod tests {
    use midnight_curves::Fq as Scalar;

    use super::sha256_varlen::VarLenSha256Gadget;
    use crate::{
        field::NativeGadget,
        hash::sha256::Sha256Chip,
        instructions::hash::tests::{test_hash, test_varhash},
        types::AssignedByte,
    };

    #[test]
    fn test_sha256_hash() {
        const SHA256_BLOCK_SIZE: usize = 64;
        let additional_sizes = [
            SHA256_BLOCK_SIZE - 2,
            SHA256_BLOCK_SIZE - 1,
            SHA256_BLOCK_SIZE,
            SHA256_BLOCK_SIZE + 1,
            SHA256_BLOCK_SIZE + 2,
            2 * SHA256_BLOCK_SIZE - 2,
            2 * SHA256_BLOCK_SIZE - 1,
            2 * SHA256_BLOCK_SIZE,
            2 * SHA256_BLOCK_SIZE + 1,
            2 * SHA256_BLOCK_SIZE + 2,
        ];
        test_hash::<
            Scalar,
            AssignedByte<Scalar>,
            [AssignedByte<Scalar>; 32],
            Sha256Chip<Scalar>,
            NativeGadget<Scalar, _, _>,
        >(true, "SHA256", &additional_sizes, 13);
    }

    #[test]
    fn test_sha256_varhash() {
        fn test_wrapper<const M: usize>(input_size: usize, k: u32, cost_model: bool) {
            test_varhash::<
                Scalar,
                AssignedByte<Scalar>,
                [AssignedByte<Scalar>; 32],
                VarLenSha256Gadget<Scalar>,
                M,
                64,
            >(cost_model, "VarSHA256", input_size, k)
        }

        test_wrapper::<512>(64, 16, true);
        test_wrapper::<512>(63, 16, false);
        test_wrapper::<256>(128, 16, false);
        test_wrapper::<256>(127, 16, false);

        test_wrapper::<128>(55, 16, false); // padding edge cases
        test_wrapper::<128>(56, 16, false);

        test_wrapper::<128>(0, 16, false);
        test_wrapper::<128>(1, 16, false);
    }
}