Rename SHA-256 to SHA-2

Author: Avaneesh-axiom

.github/workflows/extension-tests.yml

@@ -28,7 +28,7 @@ jobs:
           - { name: "rv32im", path: "rv32im" }
           - { name: "native", path: "native" }
           - { name: "keccak256", path: "keccak256" }
-          - { name: "sha256", path: "sha256" }
+          - { name: "sha2", path: "sha2" }
           - { name: "bigint", path: "bigint" }
           - { name: "algebra", path: "algebra" }
           - { name: "ecc", path: "ecc" }

.github/workflows/primitives.yml

@@ -8,7 +8,7 @@ on:
     paths:
       - "crates/circuits/primitives/**"
       - "crates/circuits/poseidon2-air/**"
-      - "crates/circuits/sha-air/**"
+      - "crates/circuits/sha2-air/**"
       - "crates/circuits/mod-builder/**"
       - "Cargo.toml"
       - ".github/workflows/primitives.yml"
@@ -47,8 +47,8 @@ jobs:
         run: |
           cargo nextest run --cargo-profile fast --features parallel
 
-      - name: Run tests for sha-air
-        working-directory: crates/circuits/sha-air
+      - name: Run tests for sha2-air
+        working-directory: crates/circuits/sha2-air
         run: |
           cargo nextest run --cargo-profile fast --features parallel
 

Cargo.toml

@@ -51,10 +51,10 @@ members = [
     "extensions/keccak256/transpiler",
     "extensions/keccak256/guest",
     "extensions/keccak256/tests",
-    "extensions/sha256/circuit",
-    "extensions/sha256/transpiler",
-    "extensions/sha256/guest",
-    "extensions/sha256/tests",
+    "extensions/sha2/circuit",
+    "extensions/sha2/transpiler",
+    "extensions/sha2/guest",
+    "extensions/sha2/tests",
     "extensions/ecc/circuit",
     "extensions/ecc/transpiler",
     "extensions/ecc/guest",
@@ -112,7 +112,7 @@ openvm-stark-sdk = { git = "https://github.com/openvm-org/stark-backend.git", ta
 openvm-sdk = { path = "crates/sdk", default-features = false }
 openvm-mod-circuit-builder = { path = "crates/circuits/mod-builder", default-features = false }
 openvm-poseidon2-air = { path = "crates/circuits/poseidon2-air", default-features = false }
-openvm-sha-air = { path = "crates/circuits/sha-air", default-features = false }
+openvm-sha2-air = { path = "crates/circuits/sha2-air", default-features = false }
 openvm-sha-macros = { path = "crates/circuits/sha-macros", default-features = false }
 openvm-circuit-primitives = { path = "crates/circuits/primitives", default-features = false }
 openvm-circuit-primitives-derive = { path = "crates/circuits/primitives/derive", default-features = false }
@@ -141,9 +141,9 @@ openvm-native-recursion = { path = "extensions/native/recursion", default-featur
 openvm-keccak256-circuit = { path = "extensions/keccak256/circuit", default-features = false }
 openvm-keccak256-transpiler = { path = "extensions/keccak256/transpiler", default-features = false }
 openvm-keccak256-guest = { path = "extensions/keccak256/guest", default-features = false }
-openvm-sha256-circuit = { path = "extensions/sha256/circuit", default-features = false }
-openvm-sha256-transpiler = { path = "extensions/sha256/transpiler", default-features = false }
-openvm-sha256-guest = { path = "extensions/sha256/guest", default-features = false }
+openvm-sha2-circuit = { path = "extensions/sha2/circuit", default-features = false }
+openvm-sha2-transpiler = { path = "extensions/sha2/transpiler", default-features = false }
+openvm-sha2-guest = { path = "extensions/sha2/guest", default-features = false }
 openvm-bigint-circuit = { path = "extensions/bigint/circuit", default-features = false }
 openvm-bigint-transpiler = { path = "extensions/bigint/transpiler", default-features = false }
 openvm-bigint-guest = { path = "extensions/bigint/guest", default-features = false }
@@ -212,7 +212,7 @@ rrs-lib = "0.1.0"
 rand = { version = "0.8.5", default-features = false }
 hex = { version = "0.4.3", default-features = false }
 serde-big-array = "0.5.1"
-ndarray = "0.16.1"
+ndarray = { version = "0.16.1", default-features = false }
 
 # default-features = false for no_std for use in guest programs
 itertools = { version = "0.14.0", default-features = false }

benchmarks/programs/kitchen-sink/Cargo.toml

@@ -18,7 +18,7 @@ openvm-pairing-guest = { path = "../../../extensions/pairing/guest", default-fea
     "bls12_381",
 ] }
 openvm-keccak256-guest = { path = "../../../extensions/keccak256/guest", default-features = false }
-openvm-sha256-guest = { path = "../../../extensions/sha256/guest", default-features = false }
+openvm-sha2-guest = { path = "../../../extensions/sha2/guest", default-features = false }
 openvm-bigint-guest = { path = "../../../extensions/bigint/guest", default-features = false }
 hex = { version = "0.4.3", default-features = false, features = ["alloc"] }
 serde = "1.0"

benchmarks/programs/kitchen-sink/src/main.rs

@@ -3,7 +3,7 @@ use std::{hint::black_box, mem::transmute};
 use openvm_algebra_guest::IntMod;
 use openvm_bigint_guest::I256;
 use openvm_keccak256_guest::keccak256;
-use openvm_sha256_guest::sha256;
+use openvm_sha2_guest::sha256;
 #[allow(unused_imports)]
 use {
     openvm_ecc_guest::{

benchmarks/src/bin/kitchen_sink.rs

@@ -30,7 +30,7 @@ fn main() -> Result<()> {
         .rv32m(Default::default())
         .io(Default::default())
         .keccak(Default::default())
-        .sha256(Default::default())
+        .sha2(Default::default())
         .bigint(Default::default())
         .modular(ModularExtension::new(vec![
             BigUint::from_str("1000000000000000003").unwrap(),

book/src/custom-extensions/overview.md

@@ -5,13 +5,13 @@ You can seamlessly integrate certain performance-optimized extensions maintained
 In this chapter, we will explain how to use the following existing extensions:
 
 - [`openvm-keccak-guest`](./keccak.md) - Keccak256 hash function.
-- [`openvm-sha256-guest`](./sha256.md) - SHA2-256 hash function.
+- [`openvm-sha2-guest`](./sha2.md) - SHA2 hash functions.
 - [`openvm-bigint-guest`](./bigint.md) - Big integer arithmetic for 256-bit signed and unsigned integers.
 - [`openvm-algebra-guest`](./algebra.md) - Modular arithmetic and complex field extensions.
 - [`openvm-ecc-guest`](./ecc.md) - Elliptic curve cryptography.
 - [`openvm-pairing-guest`](./pairing.md) - Elliptic curve optimal Ate pairings.
 
-Some extensions such as `openvm-keccak-guest`, `openvm-sha256-guest`, and `openvm-bigint-guest` can be enabled without specifying any additional configuration.
+Some extensions such as `openvm-keccak-guest`, `openvm-sha2-guest`, and `openvm-bigint-guest` can be enabled without specifying any additional configuration.
 
 On the other hand certain arithmetic operations, particularly modular arithmetic, can be optimized significantly when the modulus is known at compile time. This approach requires a framework to inform the compiler about all the moduli and associated arithmetic structures we intend to use. To achieve this, three steps are involved:
 

book/src/custom-extensions/sha256.md renamed to book/src/custom-extensions/sha2.md

@@ -13,7 +13,7 @@ itertools = "0.14"
 proc-macro2 = "1.0"
 
 [dev-dependencies]
-openvm-sha-air = { workspace = true }
+openvm-sha2-air = { workspace = true }
 openvm-circuit-primitives-derive = { workspace = true }
 ndarray.workspace = true
 

crates/circuits/sha-macros/Cargo.toml

@@ -1,9 +1,9 @@
-use openvm_sha_air::{Sha256Config, ShaConfig};
+use openvm_sha2_air::{Sha256Config, Sha2Config};
 use openvm_sha_macros::ColsRef;
 
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 pub struct ShaFlagsCols<T, const ROW_VAR_CNT: usize> {
     pub is_round_row: T,
     /// A flag that indicates if the current row is among the first 4 rows of a block

crates/circuits/sha-macros/tests/flags.rs

@@ -1,17 +1,17 @@
-use openvm_sha_air::{Sha256Config, ShaConfig};
+use openvm_sha2_air::{Sha256Config, Sha2Config};
 use openvm_sha_macros::ColsRef;
 
 #[allow(dead_code)]
 #[derive(ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 struct Test1Cols<T, const WORD_BITS: usize> {
     pub a: T,
     pub nested: Test2Cols<T, WORD_BITS>,
 }
 
 #[allow(dead_code)]
 #[derive(ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 struct Test2Cols<T, const WORD_BITS: usize> {
     pub b: T,
     pub c: [T; WORD_BITS],

crates/circuits/sha-macros/tests/nested.rs

@@ -1,9 +1,9 @@
-use openvm_sha_air::{Sha256Config, ShaConfig};
+use openvm_sha2_air::{Sha256Config, Sha2Config};
 use openvm_sha_macros::ColsRef;
 
 #[allow(dead_code)]
 #[derive(ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 struct Test<T, const WORD_BITS: usize, const ROUNDS_PER_ROW: usize, const WORD_U16S: usize> {
     a: T,
     b: [T; WORD_BITS],

crates/circuits/sha-macros/tests/simple.rs

@@ -1,9 +1,9 @@
-use openvm_sha_air::{Sha256Config, ShaConfig};
+use openvm_sha2_air::{Sha256Config, Sha2Config};
 use openvm_sha_macros::ColsRef;
 
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 pub struct ShaWorkVarsCols<
     T,
     const WORD_BITS: usize,

crates/circuits/sha-macros/tests/work-vars.rs

@@ -1,5 +1,5 @@
 [package]
-name = "openvm-sha-air"
+name = "openvm-sha2-air"
 version.workspace = true
 authors.workspace = true
 edition.workspace = true

crates/circuits/sha-air/Cargo.toml renamed to crates/circuits/sha2-air/Cargo.toml

@@ -19,20 +19,20 @@ use super::{
     small_sig1_field,
 };
 use crate::{
-    constraint_word_addition, word_into_u16_limbs, ShaConfig, ShaDigestColsRef, ShaRoundColsRef,
+    constraint_word_addition, word_into_u16_limbs, Sha2Config, ShaDigestColsRef, ShaRoundColsRef,
 };
 
 /// Expects the message to be padded to a multiple of C::BLOCK_WORDS * C::WORD_BITS bits
 #[derive(Clone, Debug)]
-pub struct Sha2Air<C: ShaConfig> {
+pub struct Sha2Air<C: Sha2Config> {
     pub bitwise_lookup_bus: BitwiseOperationLookupBus,
     pub row_idx_encoder: Encoder,
     /// Internal bus for self-interactions in this AIR.
     bus: PermutationCheckBus,
     _phantom: PhantomData<C>,
 }
 
-impl<C: ShaConfig> Sha2Air<C> {
+impl<C: Sha2Config> Sha2Air<C> {
     pub fn new(bitwise_lookup_bus: BitwiseOperationLookupBus, self_bus_idx: BusIndex) -> Self {
         Self {
             bitwise_lookup_bus,
@@ -43,13 +43,13 @@ impl<C: ShaConfig> Sha2Air<C> {
     }
 }
 
-impl<F, C: ShaConfig> BaseAir<F> for Sha2Air<C> {
+impl<F, C: Sha2Config> BaseAir<F> for Sha2Air<C> {
     fn width(&self) -> usize {
         max(C::ROUND_WIDTH, C::DIGEST_WIDTH)
     }
 }
 
-impl<AB: InteractionBuilder, C: ShaConfig> SubAir<AB> for Sha2Air<C> {
+impl<AB: InteractionBuilder, C: Sha2Config> SubAir<AB> for Sha2Air<C> {
     /// The start column for the sub-air to use
     type AirContext<'a>
         = usize
@@ -69,7 +69,7 @@ impl<AB: InteractionBuilder, C: ShaConfig> SubAir<AB> for Sha2Air<C> {
     }
 }
 
-impl<C: ShaConfig> Sha2Air<C> {
+impl<C: Sha2Config> Sha2Air<C> {
     /// Implements the single row constraints (i.e. imposes constraints only on local)
     /// Implements some sanity constraints on the row index, flags, and work variables
     fn eval_row<AB: InteractionBuilder>(&self, builder: &mut AB, start_col: usize) {

crates/circuits/sha-air/src/air.rs renamed to crates/circuits/sha2-air/src/air.rs

@@ -4,7 +4,7 @@ use openvm_circuit_primitives::utils::not;
 use openvm_sha_macros::ColsRef;
 use openvm_stark_backend::p3_field::FieldAlgebra;
 
-use crate::ShaConfig;
+use crate::Sha2Config;
 
 /// In each SHA block:
 /// - First C::ROUND_ROWS rows use ShaRoundCols
@@ -20,7 +20,7 @@ use crate::ShaConfig;
 /// 2. Specific constraints to use the appropriate struct, with flags helping to do conditional constraints
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 pub struct ShaRoundCols<
     T,
     const WORD_BITS: usize,
@@ -30,16 +30,16 @@ pub struct ShaRoundCols<
     const ROUNDS_PER_ROW_MINUS_ONE: usize,
     const ROW_VAR_CNT: usize,
 > {
-    pub flags: ShaFlagsCols<T, ROW_VAR_CNT>,
+    pub flags: Sha2FlagsCols<T, ROW_VAR_CNT>,
     pub work_vars: ShaWorkVarsCols<T, WORD_BITS, ROUNDS_PER_ROW, WORD_U16S>,
     pub schedule_helper:
-        ShaMessageHelperCols<T, WORD_U16S, ROUNDS_PER_ROW, ROUNDS_PER_ROW_MINUS_ONE>,
+        Sha2MessageHelperCols<T, WORD_U16S, ROUNDS_PER_ROW, ROUNDS_PER_ROW_MINUS_ONE>,
     pub message_schedule: ShaMessageScheduleCols<T, WORD_BITS, ROUNDS_PER_ROW, WORD_U8S>,
 }
 
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 pub struct ShaDigestCols<
     T,
     const WORD_BITS: usize,
@@ -50,11 +50,11 @@ pub struct ShaDigestCols<
     const ROUNDS_PER_ROW_MINUS_ONE: usize,
     const ROW_VAR_CNT: usize,
 > {
-    pub flags: ShaFlagsCols<T, ROW_VAR_CNT>,
+    pub flags: Sha2FlagsCols<T, ROW_VAR_CNT>,
     /// Will serve as previous hash values for the next block
     pub hash: ShaWorkVarsCols<T, WORD_BITS, ROUNDS_PER_ROW, WORD_U16S>,
     pub schedule_helper:
-        ShaMessageHelperCols<T, WORD_U16S, ROUNDS_PER_ROW, ROUNDS_PER_ROW_MINUS_ONE>,
+        Sha2MessageHelperCols<T, WORD_U16S, ROUNDS_PER_ROW, ROUNDS_PER_ROW_MINUS_ONE>,
     /// The actual final hash values of the given block
     /// Note: the above `hash` will be equal to `final_hash` unless we are on the last block
     pub final_hash: [[T; WORD_U8S]; HASH_WORDS],
@@ -65,7 +65,7 @@ pub struct ShaDigestCols<
 
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 pub struct ShaMessageScheduleCols<
     T,
     const WORD_BITS: usize,
@@ -81,7 +81,7 @@ pub struct ShaMessageScheduleCols<
 
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
+#[config(Sha2Config)]
 pub struct ShaWorkVarsCols<
     T,
     const WORD_BITS: usize,
@@ -100,8 +100,8 @@ pub struct ShaWorkVarsCols<
 /// Note: these need to be correctly assigned for every row even on padding rows
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
-pub struct ShaMessageHelperCols<
+#[config(Sha2Config)]
+pub struct Sha2MessageHelperCols<
     T,
     const WORD_U16S: usize,
     const ROUNDS_PER_ROW: usize,
@@ -119,8 +119,8 @@ pub struct ShaMessageHelperCols<
 
 #[repr(C)]
 #[derive(Clone, Copy, Debug, ColsRef)]
-#[config(ShaConfig)]
-pub struct ShaFlagsCols<T, const ROW_VAR_CNT: usize> {
+#[config(Sha2Config)]
+pub struct Sha2FlagsCols<T, const ROW_VAR_CNT: usize> {
     pub is_round_row: T,
     /// A flag that indicates if the current row is among the first 4 rows of a block (the message rows)
     pub is_first_4_rows: T,
@@ -135,7 +135,7 @@ pub struct ShaFlagsCols<T, const ROW_VAR_CNT: usize> {
 }
 
 impl<O, T: Copy + core::ops::Add<Output = O>, const ROW_VAR_CNT: usize>
-    ShaFlagsCols<T, ROW_VAR_CNT>
+    Sha2FlagsCols<T, ROW_VAR_CNT>
 {
     pub fn is_not_padding_row(&self) -> O {
         self.is_round_row + self.is_digest_row
@@ -149,7 +149,7 @@ impl<O, T: Copy + core::ops::Add<Output = O>, const ROW_VAR_CNT: usize>
     }
 }
 
-impl<O, T: Copy + core::ops::Add<Output = O>> ShaFlagsColsRef<'_, T> {
+impl<O, T: Copy + core::ops::Add<Output = O>> Sha2FlagsColsRef<'_, T> {
     pub fn is_not_padding_row(&self) -> O {
         *self.is_round_row + *self.is_digest_row
     }

crates/circuits/sha-air/src/columns.rs renamed to crates/circuits/sha2-air/src/columns.rs

@@ -2,7 +2,7 @@ use std::ops::{BitAnd, BitOr, BitXor, Not, Shl, Shr};
 
 use crate::{ShaDigestColsRef, ShaRoundColsRef};
 
-pub trait ShaConfig: Send + Sync + Clone {
+pub trait Sha2Config: Send + Sync + Clone {
     type Word: 'static
         + Shr<usize, Output = Self::Word>
         + Shl<usize, Output = Self::Word>
@@ -72,7 +72,7 @@ pub trait ShaConfig: Send + Sync + Clone {
 #[derive(Clone)]
 pub struct Sha256Config;
 
-impl ShaConfig for Sha256Config {
+impl Sha2Config for Sha256Config {
     // ==== Do not change these constants! ====
     type Word = u32;
     /// Number of bits in a SHA256 word
@@ -136,7 +136,7 @@ pub const SHA256_H: [u32; 8] = [
 #[derive(Clone)]
 pub struct Sha512Config;
 
-impl ShaConfig for Sha512Config {
+impl Sha2Config for Sha512Config {
     // ==== Do not change these constants! ====
     type Word = u64;
     /// Number of bits in a SHA512 word
@@ -282,7 +282,7 @@ pub const SHA512_H: [u64; 8] = [
 #[derive(Clone)]
 pub struct Sha384Config;
 
-impl ShaConfig for Sha384Config {
+impl Sha2Config for Sha384Config {
     // ==== Do not change these constants! ====
     type Word = u64;
     /// Number of bits in a SHA384 word