Skip to main content

gmcrypto_core/sm4/
cipher.rs

1//! SM4 block cipher (GB/T 32907-2016).
2//!
3//! 128-bit block, 128-bit key, 32 Feistel-like rounds.
4//!
5//! # Constant-time stance
6//!
7//! v0.2 W1 ships SM4 with a [`subtle`]-style linear-scan S-box —
8//! [`subtle::ConditionallySelectable::conditional_assign`] over all 256
9//! possible byte inputs per S-box invocation. This costs ~256× per
10//! lookup vs. an LUT-only implementation but keeps the cryptographic
11//! side-channel posture consistent with the rest of the crate. A
12//! bitsliced fast-path is deferred to v0.4 alongside the C-ABI / wasm
13//! work.
14//!
15//! Throughput on the linear-scan S-box is ~1-2M blocks/sec
16//! single-threaded on modern x86 (vs. ~150M for an LUT impl). Document
17//! this on every callsite that cares about throughput.
18//!
19//! # Single-shot API
20//!
21//! v0.2 ships single-shot block-level `encrypt_block` / `decrypt_block`
22//! only. Streaming `BlockCipher`-trait wiring lands in v0.3 alongside
23//! the broader trait generalization.
24//!
25//! # KAT sources
26//!
27//! GB/T 32907-2016 Appendix A.1, two KATs under
28//! key = plaintext = `01 23 45 67 89 ab cd ef fe dc ba 98 76 54 32 10`:
29//!
30//! - Single-block ciphertext:
31//!   `68 1e df 34 d2 06 96 5e 86 b3 e9 4f 53 6e 42 46`.
32//! - 1,000,000-round ciphertext (encrypt 1M times under the same key):
33//!   `59 52 98 c7 c6 fd 27 1f 04 02 f8 04 c3 3d 3f 66`.
34//!
35//! The 1M-round test is `#[ignore]`d by default — at debug-build
36//! linear-scan-S-box speeds it takes minutes. Run with
37//! `cargo test --release -- --ignored` before any release.
38
39#[cfg(not(feature = "sm4-bitsliced"))]
40use subtle::{ConditionallySelectable, ConstantTimeEq};
41use zeroize::{Zeroize, ZeroizeOnDrop};
42
43/// Block size in bytes (128 bits).
44pub const BLOCK_SIZE: usize = 16;
45
46/// Key size in bytes (128 bits).
47pub const KEY_SIZE: usize = 16;
48
49/// SM4 S-box (GB/T 32907-2016 §6.2).
50///
51/// `pub(crate)` so the `sm4::sbox_bitsliced` module (v0.4 W3) can
52/// reference it for the exhaustive bitsliced-vs-table equivalence
53/// test. Not part of the public API.
54///
55/// Under `--features sm4-bitsliced` the runtime path doesn't touch
56/// `S_BOX` (the bitsliced S-box is table-less); only the bitsliced-
57/// equivalence test in `sm4::sbox_bitsliced::tests` keeps a
58/// reference. `#[allow(dead_code)]` suppresses the dead-code warning
59/// on the non-test feature-on build path.
60#[cfg_attr(feature = "sm4-bitsliced", allow(dead_code))]
61#[rustfmt::skip]
62pub(crate) const S_BOX: [u8; 256] = [
63    0xd6, 0x90, 0xe9, 0xfe, 0xcc, 0xe1, 0x3d, 0xb7, 0x16, 0xb6, 0x14, 0xc2, 0x28, 0xfb, 0x2c, 0x05,
64    0x2b, 0x67, 0x9a, 0x76, 0x2a, 0xbe, 0x04, 0xc3, 0xaa, 0x44, 0x13, 0x26, 0x49, 0x86, 0x06, 0x99,
65    0x9c, 0x42, 0x50, 0xf4, 0x91, 0xef, 0x98, 0x7a, 0x33, 0x54, 0x0b, 0x43, 0xed, 0xcf, 0xac, 0x62,
66    0xe4, 0xb3, 0x1c, 0xa9, 0xc9, 0x08, 0xe8, 0x95, 0x80, 0xdf, 0x94, 0xfa, 0x75, 0x8f, 0x3f, 0xa6,
67    0x47, 0x07, 0xa7, 0xfc, 0xf3, 0x73, 0x17, 0xba, 0x83, 0x59, 0x3c, 0x19, 0xe6, 0x85, 0x4f, 0xa8,
68    0x68, 0x6b, 0x81, 0xb2, 0x71, 0x64, 0xda, 0x8b, 0xf8, 0xeb, 0x0f, 0x4b, 0x70, 0x56, 0x9d, 0x35,
69    0x1e, 0x24, 0x0e, 0x5e, 0x63, 0x58, 0xd1, 0xa2, 0x25, 0x22, 0x7c, 0x3b, 0x01, 0x21, 0x78, 0x87,
70    0xd4, 0x00, 0x46, 0x57, 0x9f, 0xd3, 0x27, 0x52, 0x4c, 0x36, 0x02, 0xe7, 0xa0, 0xc4, 0xc8, 0x9e,
71    0xea, 0xbf, 0x8a, 0xd2, 0x40, 0xc7, 0x38, 0xb5, 0xa3, 0xf7, 0xf2, 0xce, 0xf9, 0x61, 0x15, 0xa1,
72    0xe0, 0xae, 0x5d, 0xa4, 0x9b, 0x34, 0x1a, 0x55, 0xad, 0x93, 0x32, 0x30, 0xf5, 0x8c, 0xb1, 0xe3,
73    0x1d, 0xf6, 0xe2, 0x2e, 0x82, 0x66, 0xca, 0x60, 0xc0, 0x29, 0x23, 0xab, 0x0d, 0x53, 0x4e, 0x6f,
74    0xd5, 0xdb, 0x37, 0x45, 0xde, 0xfd, 0x8e, 0x2f, 0x03, 0xff, 0x6a, 0x72, 0x6d, 0x6c, 0x5b, 0x51,
75    0x8d, 0x1b, 0xaf, 0x92, 0xbb, 0xdd, 0xbc, 0x7f, 0x11, 0xd9, 0x5c, 0x41, 0x1f, 0x10, 0x5a, 0xd8,
76    0x0a, 0xc1, 0x31, 0x88, 0xa5, 0xcd, 0x7b, 0xbd, 0x2d, 0x74, 0xd0, 0x12, 0xb8, 0xe5, 0xb4, 0xb0,
77    0x89, 0x69, 0x97, 0x4a, 0x0c, 0x96, 0x77, 0x7e, 0x65, 0xb9, 0xf1, 0x09, 0xc5, 0x6e, 0xc6, 0x84,
78    0x18, 0xf0, 0x7d, 0xec, 0x3a, 0xdc, 0x4d, 0x20, 0x79, 0xee, 0x5f, 0x3e, 0xd7, 0xcb, 0x39, 0x48,
79];
80
81/// FK system parameter (GB/T 32907-2016 §7.3.1.1).
82const FK: [u32; 4] = [0xa3b1_bac6, 0x56aa_3350, 0x677d_9197, 0xb270_22dc];
83
84/// CK system parameter (GB/T 32907-2016 §7.3.1.2). Computed at compile
85/// time per the spec: `ck_{i,j} = (4i+j)·7 mod 256`. Cross-checks
86/// against the published values (e.g. `CK[0] = 0x00070e15`,
87/// `CK[31] = 0x646b7279`) sit in the test module below.
88const CK: [u32; 32] = {
89    let mut ck = [0u32; 32];
90    let mut i: u32 = 0;
91    while i < 32 {
92        let mut v: u32 = 0;
93        let mut j: u32 = 0;
94        while j < 4 {
95            let byte = (4 * i + j).wrapping_mul(7) & 0xff;
96            v = (v << 8) | byte;
97            j += 1;
98        }
99        ck[i as usize] = v;
100        i += 1;
101    }
102    ck
103};
104
105/// SM4 cipher with pre-computed round keys.
106///
107/// `Sm4Cipher` zeroizes its round-key buffer on drop via the workspace
108/// `zeroize` policy. Construction runs the key schedule (32 round keys
109/// × secret-key-touching S-box invocations); see the W1 dudect target
110/// `ct_sm4_key_schedule`.
111#[derive(Clone, Zeroize, ZeroizeOnDrop)]
112pub struct Sm4Cipher {
113    round_keys: [u32; 32],
114}
115
116impl Sm4Cipher {
117    /// Construct a cipher from a 128-bit key and run the key schedule.
118    #[must_use]
119    pub fn new(key: &[u8; KEY_SIZE]) -> Self {
120        let mk = [
121            u32::from_be_bytes([key[0], key[1], key[2], key[3]]),
122            u32::from_be_bytes([key[4], key[5], key[6], key[7]]),
123            u32::from_be_bytes([key[8], key[9], key[10], key[11]]),
124            u32::from_be_bytes([key[12], key[13], key[14], key[15]]),
125        ];
126
127        // K[0..3] = MK[0..3] XOR FK[0..3]; then 32 rounds expand to K[4..35].
128        // Sliding 4-word window matches the round-function loop in `crypt`.
129        let mut k = [mk[0] ^ FK[0], mk[1] ^ FK[1], mk[2] ^ FK[2], mk[3] ^ FK[3]];
130        let mut round_keys = [0u32; 32];
131        for i in 0..32 {
132            let t = k[1] ^ k[2] ^ k[3] ^ CK[i];
133            let new_k = k[0] ^ t_prime(t);
134            round_keys[i] = new_k;
135            k[0] = k[1];
136            k[1] = k[2];
137            k[2] = k[3];
138            k[3] = new_k;
139        }
140
141        // The intermediate `mk` and `k` arrays held secret material; wipe
142        // them before returning. (`round_keys` lives on in `self` and
143        // zeroizes via `ZeroizeOnDrop`.)
144        let mut mk = mk;
145        mk.zeroize();
146        k.zeroize();
147
148        Self { round_keys }
149    }
150
151    /// Encrypt one 16-byte block in place.
152    pub fn encrypt_block(&self, block: &mut [u8; BLOCK_SIZE]) {
153        crypt(block, &self.round_keys, false);
154    }
155
156    /// Decrypt one 16-byte block in place.
157    pub fn decrypt_block(&self, block: &mut [u8; BLOCK_SIZE]) {
158        crypt(block, &self.round_keys, true);
159    }
160
161    /// v0.7 W1 — Encrypt N 16-byte blocks in place. Byte-identical
162    /// to calling [`encrypt_block`] N times; under the
163    /// `sm4-bitsliced-simd` feature this fans the SM4 round loop
164    /// across the SIMD register width (8-block batches on `x86_64`
165    /// AVX2 via `sbox_x32`, 4-block batches on `aarch64` NEON via
166    /// `sbox_x16`). `blocks.len()` may be any value including zero;
167    /// the tail after the largest multiple of `SIMD_BATCH` falls
168    /// back to per-block [`encrypt_block`]. Cross-checked in
169    /// `tests/sm4_batch_api.rs`.
170    ///
171    /// [`encrypt_block`]: Self::encrypt_block
172    #[allow(clippy::missing_panics_doc)] // chunks_exact_mut → try_into can't fail by construction.
173    pub fn encrypt_blocks(&self, blocks: &mut [[u8; BLOCK_SIZE]]) {
174        #[cfg(feature = "sm4-bitsliced-simd")]
175        {
176            let mut chunks = blocks.chunks_exact_mut(SIMD_BATCH);
177            for chunk in chunks.by_ref() {
178                let array: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH] = chunk
179                    .try_into()
180                    .expect("chunks_exact_mut yields slices of length SIMD_BATCH");
181                self.encrypt_blocks_simd(array);
182            }
183            for block in chunks.into_remainder() {
184                self.encrypt_block(block);
185            }
186        }
187        #[cfg(not(feature = "sm4-bitsliced-simd"))]
188        {
189            for block in blocks {
190                self.encrypt_block(block);
191            }
192        }
193    }
194
195    /// v0.7 W1 — Decrypt N 16-byte blocks in place. Symmetric
196    /// counterpart of [`encrypt_blocks`]; see that method's
197    /// docstring for the SIMD-fanout posture.
198    ///
199    /// [`encrypt_blocks`]: Self::encrypt_blocks
200    #[allow(clippy::missing_panics_doc)] // chunks_exact_mut → try_into can't fail by construction.
201    pub fn decrypt_blocks(&self, blocks: &mut [[u8; BLOCK_SIZE]]) {
202        #[cfg(feature = "sm4-bitsliced-simd")]
203        {
204            let mut chunks = blocks.chunks_exact_mut(SIMD_BATCH);
205            for chunk in chunks.by_ref() {
206                let array: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH] = chunk
207                    .try_into()
208                    .expect("chunks_exact_mut yields slices of length SIMD_BATCH");
209                self.decrypt_blocks_simd(array);
210            }
211            for block in chunks.into_remainder() {
212                self.decrypt_block(block);
213            }
214        }
215        #[cfg(not(feature = "sm4-bitsliced-simd"))]
216        {
217            for block in blocks {
218                self.decrypt_block(block);
219            }
220        }
221    }
222
223    /// v0.6 W6 — Batched SIMD-packed CBC-decrypt path. Runs the SM4
224    /// decrypt round loop on `SIMD_BATCH` blocks in lockstep; the
225    /// per-round `tau` (4 byte S-box lookups per block) gets fanned
226    /// out across the full SIMD register width via
227    /// `gmcrypto_simd::sm4::sbox_x32` (x86_64 AVX2: 8 blocks × 4 =
228    /// 32 bytes packed in `__m256i`) or `sbox_x16` (aarch64 NEON:
229    /// 4 blocks × 4 = 16 bytes packed in `uint8x16_t`). On other
230    /// targets, `SIMD_BATCH = 1` and this falls back to a single
231    /// [`decrypt_block`] call.
232    ///
233    /// Used by [`super::cbc_streaming::Sm4CbcDecryptor`]'s
234    /// `decrypt_batch` (which keeps the fixed-size-array shape for
235    /// the lockstep prev-block XOR semantics) and by
236    /// [`decrypt_blocks`] (length-flexible public API; v0.7 W1).
237    ///
238    /// [`decrypt_block`]: Self::decrypt_block
239    /// [`decrypt_blocks`]: Self::decrypt_blocks
240    #[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "x86_64"))]
241    pub(super) fn decrypt_blocks_simd(&self, blocks: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH]) {
242        crypt_batch_x8(blocks, &self.round_keys, true);
243    }
244
245    #[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "aarch64"))]
246    pub(super) fn decrypt_blocks_simd(&self, blocks: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH]) {
247        crypt_batch_x4(blocks, &self.round_keys, true);
248    }
249
250    #[cfg(all(
251        feature = "sm4-bitsliced-simd",
252        not(any(target_arch = "x86_64", target_arch = "aarch64"))
253    ))]
254    pub(super) fn decrypt_blocks_simd(&self, blocks: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH]) {
255        // SIMD_BATCH = 1 on this arch; just delegate.
256        self.decrypt_block(&mut blocks[0]);
257    }
258
259    /// v0.7 W1 — Encrypt-direction mirror of [`decrypt_blocks_simd`].
260    /// Same SIMD batched gate sequence, with `reverse=false`. Used
261    /// internally by [`encrypt_blocks`].
262    ///
263    /// [`decrypt_blocks_simd`]: Self::decrypt_blocks_simd
264    /// [`encrypt_blocks`]: Self::encrypt_blocks
265    #[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "x86_64"))]
266    pub(super) fn encrypt_blocks_simd(&self, blocks: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH]) {
267        crypt_batch_x8(blocks, &self.round_keys, false);
268    }
269
270    #[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "aarch64"))]
271    pub(super) fn encrypt_blocks_simd(&self, blocks: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH]) {
272        crypt_batch_x4(blocks, &self.round_keys, false);
273    }
274
275    #[cfg(all(
276        feature = "sm4-bitsliced-simd",
277        not(any(target_arch = "x86_64", target_arch = "aarch64"))
278    ))]
279    pub(super) fn encrypt_blocks_simd(&self, blocks: &mut [[u8; BLOCK_SIZE]; SIMD_BATCH]) {
280        // SIMD_BATCH = 1 on this arch; just delegate.
281        self.encrypt_block(&mut blocks[0]);
282    }
283}
284
285/// v0.6 W6 — compile-time batch size for [`Sm4Cipher::decrypt_blocks_simd`].
286///
287/// - 8 on x86_64 (AVX2 `__m256i` = 32 bytes = 8 blocks × 4 `tau` bytes).
288/// - 4 on aarch64 (NEON `uint8x16_t` = 16 bytes = 4 blocks × 4 `tau` bytes).
289/// - 1 elsewhere (`decrypt_blocks_simd` collapses to `decrypt_block`).
290#[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "x86_64"))]
291pub(super) const SIMD_BATCH: usize = 8;
292
293#[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "aarch64"))]
294pub(super) const SIMD_BATCH: usize = 4;
295
296#[cfg(all(
297    feature = "sm4-bitsliced-simd",
298    not(any(target_arch = "x86_64", target_arch = "aarch64"))
299))]
300pub(super) const SIMD_BATCH: usize = 1;
301
302impl crate::traits::BlockCipher for Sm4Cipher {
303    const BLOCK_SIZE: usize = BLOCK_SIZE;
304
305    /// Construct from a key slice. `key.len()` must equal
306    /// [`KEY_SIZE`].
307    ///
308    /// # Panics
309    ///
310    /// Panics if `key.len() != KEY_SIZE`.
311    fn new(key: &[u8]) -> Self {
312        let key: &[u8; KEY_SIZE] = key
313            .try_into()
314            .expect("Sm4Cipher::new: key must be exactly 16 bytes");
315        Self::new(key)
316    }
317
318    /// Encrypt one 16-byte block in place.
319    ///
320    /// # Panics
321    ///
322    /// Panics if `block.len() != BLOCK_SIZE`.
323    fn encrypt_block(&self, block: &mut [u8]) {
324        let block: &mut [u8; BLOCK_SIZE] = block
325            .try_into()
326            .expect("Sm4Cipher::encrypt_block: block must be exactly 16 bytes");
327        Self::encrypt_block(self, block);
328    }
329
330    /// Decrypt one 16-byte block in place.
331    ///
332    /// # Panics
333    ///
334    /// Panics if `block.len() != BLOCK_SIZE`.
335    fn decrypt_block(&self, block: &mut [u8]) {
336        let block: &mut [u8; BLOCK_SIZE] = block
337            .try_into()
338            .expect("Sm4Cipher::decrypt_block: block must be exactly 16 bytes");
339        Self::decrypt_block(self, block);
340    }
341}
342
343#[cfg(feature = "cipher-traits")]
344mod cipher_impl {
345    //! `cipher::BlockEncrypt` / `cipher::BlockDecrypt`-compatible impl
346    //! for [`Sm4Cipher`] (v0.4 W2; Q4.3).
347    //!
348    //! Behind the `cipher-traits` feature flag. The cipher 0.4 trait
349    //! surface uses a rank-2 backend pattern: callers invoke
350    //! `encrypt_with_backend` / `decrypt_with_backend` with a
351    //! `BlockClosure`, and the impl calls the closure with a
352    //! `BlockBackend`. Following the `aes` crate's pattern.
353    //!
354    //! Block size = 16 bytes; key size = 16 bytes. Output is byte-
355    //! identical to the inherent
356    //! [`Sm4Cipher::encrypt_block`] / [`Sm4Cipher::decrypt_block`].
357
358    use super::{BLOCK_SIZE, KEY_SIZE, Sm4Cipher};
359    use cipher::consts::{U1, U16};
360    use cipher::crypto_common::{Key, KeyInit, KeySizeUser, ParBlocksSizeUser};
361    use cipher::inout::InOut;
362    use cipher::{
363        BlockBackend, BlockCipher, BlockClosure, BlockDecrypt, BlockEncrypt, BlockSizeUser,
364    };
365
366    const _: () = assert!(BLOCK_SIZE == 16, "cipher trait fit assumes U16 block");
367    const _: () = assert!(KEY_SIZE == 16, "cipher trait fit assumes U16 key");
368
369    impl BlockSizeUser for Sm4Cipher {
370        type BlockSize = U16;
371    }
372
373    impl KeySizeUser for Sm4Cipher {
374        type KeySize = U16;
375    }
376
377    impl KeyInit for Sm4Cipher {
378        fn new(key: &Key<Self>) -> Self {
379            let key: &[u8; KEY_SIZE] = key.as_ref();
380            Self::new(key)
381        }
382    }
383
384    impl BlockCipher for Sm4Cipher {}
385
386    struct Sm4Backend<'a> {
387        cipher: &'a Sm4Cipher,
388        decrypt: bool,
389    }
390
391    impl BlockSizeUser for Sm4Backend<'_> {
392        type BlockSize = U16;
393    }
394
395    impl ParBlocksSizeUser for Sm4Backend<'_> {
396        type ParBlocksSize = U1;
397    }
398
399    impl BlockBackend for Sm4Backend<'_> {
400        #[inline]
401        fn proc_block(&mut self, mut block: InOut<'_, '_, cipher::Block<Self>>) {
402            let mut buf = [0u8; BLOCK_SIZE];
403            buf.copy_from_slice(block.get_in().as_slice());
404            if self.decrypt {
405                self.cipher.decrypt_block(&mut buf);
406            } else {
407                self.cipher.encrypt_block(&mut buf);
408            }
409            block.get_out().copy_from_slice(&buf);
410        }
411        // ParBlocksSize = U1, so the default `proc_par_blocks` falls back
412        // to `proc_block` for each block. No override needed.
413    }
414
415    impl BlockEncrypt for Sm4Cipher {
416        fn encrypt_with_backend(&self, f: impl BlockClosure<BlockSize = Self::BlockSize>) {
417            f.call(&mut Sm4Backend {
418                cipher: self,
419                decrypt: false,
420            });
421        }
422    }
423
424    impl BlockDecrypt for Sm4Cipher {
425        fn decrypt_with_backend(&self, f: impl BlockClosure<BlockSize = Self::BlockSize>) {
426            f.call(&mut Sm4Backend {
427                cipher: self,
428                decrypt: true,
429            });
430        }
431    }
432}
433
434/// Run the 32-round Feistel-like SM4 transform in place. `reverse`
435/// flips the round-key index direction — encrypt and decrypt share
436/// the same data path under SM4's key-reversal property.
437fn crypt(block: &mut [u8; BLOCK_SIZE], rk: &[u32; 32], reverse: bool) {
438    let mut x = [
439        u32::from_be_bytes([block[0], block[1], block[2], block[3]]),
440        u32::from_be_bytes([block[4], block[5], block[6], block[7]]),
441        u32::from_be_bytes([block[8], block[9], block[10], block[11]]),
442        u32::from_be_bytes([block[12], block[13], block[14], block[15]]),
443    ];
444    for i in 0..32 {
445        let rki = if reverse { rk[31 - i] } else { rk[i] };
446        let t = x[1] ^ x[2] ^ x[3] ^ rki;
447        let new_x = x[0] ^ t_round(t);
448        x[0] = x[1];
449        x[1] = x[2];
450        x[2] = x[3];
451        x[3] = new_x;
452    }
453    // Output is (X35, X34, X33, X32) — i.e. `x` reversed.
454    let out = [x[3], x[2], x[1], x[0]];
455    for (i, w) in out.iter().enumerate() {
456        block[i * 4..i * 4 + 4].copy_from_slice(&w.to_be_bytes());
457    }
458}
459
460/// v0.6 W6 — AVX2 batched SM4 round loop on 8 blocks in lockstep.
461///
462/// Same algorithm as [`crypt`] for `N = 8` blocks; the difference is
463/// that per round, all 8 blocks' `tau` inputs (32 bytes total) are
464/// packed into one `__m256i` and S-boxed in a single
465/// [`gmcrypto_simd::sm4::sbox_x32::sbox_x32`] call. 32× fewer SIMD
466/// dispatches per batch vs 8 sequential [`crypt`] calls × 32 rounds
467/// × 4 S-box bytes per round = 1024 single-byte `sbox_x8` dispatches.
468///
469/// The L transform (`l_round`) and the round-state shift stay
470/// per-block — they're per-u32 bit rotations / XORs, not naturally
471/// SIMD-packable in the same shape.
472///
473/// Behavior is byte-identical to 8 sequential `crypt` calls; verified
474/// in `super::cbc_streaming::tests`.
475#[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "x86_64"))]
476fn crypt_batch_x8(blocks: &mut [[u8; BLOCK_SIZE]; 8], rk: &[u32; 32], reverse: bool) {
477    let mut x: [[u32; 4]; 8] = [[0; 4]; 8];
478    for b in 0..8 {
479        for w in 0..4 {
480            x[b][w] = u32::from_be_bytes([
481                blocks[b][w * 4],
482                blocks[b][w * 4 + 1],
483                blocks[b][w * 4 + 2],
484                blocks[b][w * 4 + 3],
485            ]);
486        }
487    }
488
489    for i in 0..32 {
490        let rki = if reverse { rk[31 - i] } else { rk[i] };
491
492        // Pack all 8 blocks' tau inputs (8 × 4 = 32 bytes) into one
493        // buffer, run a single SIMD S-box pass, then unpack.
494        let mut t_bytes = [0u8; 32];
495        for b in 0..8 {
496            let t = x[b][1] ^ x[b][2] ^ x[b][3] ^ rki;
497            t_bytes[b * 4..b * 4 + 4].copy_from_slice(&t.to_be_bytes());
498        }
499        let s_bytes = gmcrypto_simd::sm4::sbox_x32::sbox_x32(&t_bytes);
500
501        // Per-block: apply L, XOR with x[0], shift state window.
502        for b in 0..8 {
503            let s = u32::from_be_bytes([
504                s_bytes[b * 4],
505                s_bytes[b * 4 + 1],
506                s_bytes[b * 4 + 2],
507                s_bytes[b * 4 + 3],
508            ]);
509            let new_x = x[b][0] ^ l_round(s);
510            x[b][0] = x[b][1];
511            x[b][1] = x[b][2];
512            x[b][2] = x[b][3];
513            x[b][3] = new_x;
514        }
515    }
516
517    // Reverse-output per block (matches `crypt`'s tail).
518    for b in 0..8 {
519        let out = [x[b][3], x[b][2], x[b][1], x[b][0]];
520        for w in 0..4 {
521            blocks[b][w * 4..w * 4 + 4].copy_from_slice(&out[w].to_be_bytes());
522        }
523    }
524}
525
526/// v0.6 W6 — NEON batched SM4 round loop on 4 blocks in lockstep.
527///
528/// Same as [`crypt_batch_x8`] but for `N = 4` blocks; per-round
529/// tau bytes (4 × 4 = 16) pack into one `uint8x16_t` and S-box
530/// via [`gmcrypto_simd::sm4::sbox_x16::sbox_x16`].
531#[cfg(all(feature = "sm4-bitsliced-simd", target_arch = "aarch64"))]
532fn crypt_batch_x4(blocks: &mut [[u8; BLOCK_SIZE]; 4], rk: &[u32; 32], reverse: bool) {
533    let mut x: [[u32; 4]; 4] = [[0; 4]; 4];
534    for b in 0..4 {
535        for w in 0..4 {
536            x[b][w] = u32::from_be_bytes([
537                blocks[b][w * 4],
538                blocks[b][w * 4 + 1],
539                blocks[b][w * 4 + 2],
540                blocks[b][w * 4 + 3],
541            ]);
542        }
543    }
544
545    for i in 0..32 {
546        let rki = if reverse { rk[31 - i] } else { rk[i] };
547
548        let mut t_bytes = [0u8; 16];
549        for b in 0..4 {
550            let t = x[b][1] ^ x[b][2] ^ x[b][3] ^ rki;
551            t_bytes[b * 4..b * 4 + 4].copy_from_slice(&t.to_be_bytes());
552        }
553        let s_bytes = gmcrypto_simd::sm4::sbox_x16::sbox_x16(&t_bytes);
554
555        for b in 0..4 {
556            let s = u32::from_be_bytes([
557                s_bytes[b * 4],
558                s_bytes[b * 4 + 1],
559                s_bytes[b * 4 + 2],
560                s_bytes[b * 4 + 3],
561            ]);
562            let new_x = x[b][0] ^ l_round(s);
563            x[b][0] = x[b][1];
564            x[b][1] = x[b][2];
565            x[b][2] = x[b][3];
566            x[b][3] = new_x;
567        }
568    }
569
570    for b in 0..4 {
571        let out = [x[b][3], x[b][2], x[b][1], x[b][0]];
572        for w in 0..4 {
573            blocks[b][w * 4..w * 4 + 4].copy_from_slice(&out[w].to_be_bytes());
574        }
575    }
576}
577
578/// Constant-time S-box lookup via [`subtle`] linear scan.
579///
580/// Compiles to a fixed 256-iteration loop; each iteration runs a
581/// constant-time equality check and a constant-time conditional
582/// assignment. Roughly 256× slower than a direct LUT lookup but
583/// uniform over the input — see module-doc.
584///
585/// Default-features build uses this path. Under
586/// `--features sm4-bitsliced` (v0.4 W3) [`tau`] swaps to the
587/// table-less Itoh-Tsujii bitsliced implementation; this function
588/// remains compiled but unused on the bitsliced path.
589#[cfg(not(feature = "sm4-bitsliced"))]
590#[inline]
591fn sbox_ct(x: u8) -> u8 {
592    let mut result: u8 = 0;
593    for i in 0..256u16 {
594        #[allow(clippy::cast_possible_truncation)]
595        let i_u8 = i as u8;
596        let eq = i_u8.ct_eq(&x);
597        result.conditional_assign(&S_BOX[i as usize], eq);
598    }
599    result
600}
601
602/// Apply the S-box to all four bytes of a `u32` (the τ transform,
603/// GB/T 32907-2016 §6.3.1).
604///
605/// Default-features path uses the linear-scan [`sbox_ct`]. Under
606/// `--features sm4-bitsliced` (v0.4 W3) this dispatches to the
607/// table-less Itoh-Tsujii bitsliced S-box in
608/// [`crate::sm4::sbox_bitsliced`]. Under
609/// `--features sm4-bitsliced-simd` (v0.5 W4) it further dispatches to
610/// [`crate::sm4::sbox_bitsliced_simd`] — in phase 1 a transparent
611/// delegate to the single-block bitslice (byte-identical output);
612/// phase 2 / phase 3 swap in AVX2 / NEON intrinsics behind the same
613/// path.
614// Under `sm4-bitsliced` the bitsliced S-box is `const fn`, which
615// would let `tau` be const too — but the default linear-scan path
616// uses runtime `subtle` ops that aren't const-eligible. Suppress the
617// clippy lint that only fires on one feature config.
618#[allow(clippy::missing_const_for_fn)]
619#[inline]
620fn tau(a: u32) -> u32 {
621    let a_bytes = a.to_be_bytes();
622    #[cfg(not(feature = "sm4-bitsliced"))]
623    let b = [
624        sbox_ct(a_bytes[0]),
625        sbox_ct(a_bytes[1]),
626        sbox_ct(a_bytes[2]),
627        sbox_ct(a_bytes[3]),
628    ];
629    // `sm4-bitsliced-simd` implies `sm4-bitsliced` per Cargo.toml's
630    // feature-dependency declaration. The dispatch ordering ensures
631    // the SIMD path wins when both are enabled.
632    #[cfg(all(feature = "sm4-bitsliced", not(feature = "sm4-bitsliced-simd")))]
633    let b = [
634        crate::sm4::sbox_bitsliced::sbox(a_bytes[0]),
635        crate::sm4::sbox_bitsliced::sbox(a_bytes[1]),
636        crate::sm4::sbox_bitsliced::sbox(a_bytes[2]),
637        crate::sm4::sbox_bitsliced::sbox(a_bytes[3]),
638    ];
639    #[cfg(feature = "sm4-bitsliced-simd")]
640    let b = [
641        crate::sm4::sbox_bitsliced_simd::sbox(a_bytes[0]),
642        crate::sm4::sbox_bitsliced_simd::sbox(a_bytes[1]),
643        crate::sm4::sbox_bitsliced_simd::sbox(a_bytes[2]),
644        crate::sm4::sbox_bitsliced_simd::sbox(a_bytes[3]),
645    ];
646    u32::from_be_bytes(b)
647}
648
649/// Linear transform `L` for the round function (GB/T 32907-2016 §6.3.2):
650/// `L(B) = B XOR (B<<<2) XOR (B<<<10) XOR (B<<<18) XOR (B<<<24)`.
651#[inline]
652const fn l_round(b: u32) -> u32 {
653    b ^ b.rotate_left(2) ^ b.rotate_left(10) ^ b.rotate_left(18) ^ b.rotate_left(24)
654}
655
656/// Linear transform `L'` for the key schedule (GB/T 32907-2016 §7.3.1):
657/// `L'(B) = B XOR (B<<<13) XOR (B<<<23)`.
658#[inline]
659const fn l_prime(b: u32) -> u32 {
660    b ^ b.rotate_left(13) ^ b.rotate_left(23)
661}
662
663/// Round-function composite transform `T(x) = L(τ(x))`.
664#[inline]
665fn t_round(x: u32) -> u32 {
666    l_round(tau(x))
667}
668
669/// Key-schedule composite transform `T'(x) = L'(τ(x))`.
670#[inline]
671fn t_prime(x: u32) -> u32 {
672    l_prime(tau(x))
673}
674
675#[cfg(test)]
676mod tests {
677    use super::*;
678
679    /// Cross-check the compile-time `CK` table against published values.
680    #[test]
681    fn ck_table_matches_published_endpoints() {
682        assert_eq!(CK[0], 0x0007_0e15, "CK[0]");
683        assert_eq!(CK[31], 0x646b_7279, "CK[31]");
684        // Spot-check a middle entry: CK[7] = 0xc4cbd2d9 per spec.
685        assert_eq!(CK[7], 0xc4cb_d2d9, "CK[7]");
686    }
687
688    /// GB/T 32907-2016 Appendix A.1: single-block KAT.
689    #[test]
690    fn gbt32907_single_block() {
691        let key: [u8; 16] = [
692            0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef, 0xfe, 0xdc, 0xba, 0x98, 0x76, 0x54,
693            0x32, 0x10,
694        ];
695        // The spec KAT happens to use plaintext == key.
696        let plaintext: [u8; 16] = key;
697        let expected: [u8; 16] = [
698            0x68, 0x1e, 0xdf, 0x34, 0xd2, 0x06, 0x96, 0x5e, 0x86, 0xb3, 0xe9, 0x4f, 0x53, 0x6e,
699            0x42, 0x46,
700        ];
701
702        let cipher = Sm4Cipher::new(&key);
703        let mut block = plaintext;
704        cipher.encrypt_block(&mut block);
705        assert_eq!(block, expected, "encrypt KAT mismatch");
706
707        cipher.decrypt_block(&mut block);
708        assert_eq!(block, plaintext, "decrypt round-trip mismatch");
709    }
710
711    /// GB/T 32907-2016 Appendix A.1: 1,000,000-round KAT.
712    ///
713    /// Encrypt the same plaintext 1,000,000 times under the same key
714    /// and verify the final ciphertext matches the spec. Slow on the
715    /// linear-scan S-box at debug-build speeds (single-digit minutes);
716    /// gated `#[ignore]` so default `cargo test --workspace` stays fast.
717    /// Run with `cargo test --release -- --ignored` before any release.
718    #[test]
719    #[ignore = "1M-round KAT — run with --release --ignored before release"]
720    fn gbt32907_one_million_rounds() {
721        let key: [u8; 16] = [
722            0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef, 0xfe, 0xdc, 0xba, 0x98, 0x76, 0x54,
723            0x32, 0x10,
724        ];
725        let expected: [u8; 16] = [
726            0x59, 0x52, 0x98, 0xc7, 0xc6, 0xfd, 0x27, 0x1f, 0x04, 0x02, 0xf8, 0x04, 0xc3, 0x3d,
727            0x3f, 0x66,
728        ];
729
730        let cipher = Sm4Cipher::new(&key);
731        let mut block = key;
732        for _ in 0..1_000_000 {
733            cipher.encrypt_block(&mut block);
734        }
735        assert_eq!(block, expected, "1M-round KAT mismatch");
736    }
737
738    /// Random plaintext should round-trip through encrypt+decrypt.
739    #[test]
740    fn encrypt_decrypt_round_trip() {
741        let key: [u8; 16] = [
742            0xde, 0xad, 0xbe, 0xef, 0xfe, 0xed, 0xfa, 0xce, 0xca, 0xfe, 0xba, 0xbe, 0xba, 0xad,
743            0xf0, 0x0d,
744        ];
745        let plaintext: [u8; 16] = [
746            0xa5, 0x5a, 0x12, 0x34, 0x56, 0x78, 0x9a, 0xbc, 0xde, 0xf0, 0x0f, 0x1e, 0x2d, 0x3c,
747            0x4b, 0x5a,
748        ];
749        let cipher = Sm4Cipher::new(&key);
750        let mut block = plaintext;
751        cipher.encrypt_block(&mut block);
752        assert_ne!(block, plaintext, "ciphertext must differ from plaintext");
753        cipher.decrypt_block(&mut block);
754        assert_eq!(block, plaintext, "round-trip must restore plaintext");
755    }
756
757    /// Spot-check `sbox_ct` against the LUT for a handful of inputs.
758    /// `sbox_ct` is the constant-time reformulation of `S_BOX[x]` and
759    /// must agree with it for every `x` (otherwise we ship a broken
760    /// cipher).
761    ///
762    /// Gated `cfg(not(feature = "sm4-bitsliced"))` because `sbox_ct`
763    /// itself is gated off the bitsliced path; v0.4 W3's bitsliced
764    /// impl has its own exhaustive-vs-S_BOX equivalence test in
765    /// [`crate::sm4::sbox_bitsliced::tests::bitsliced_matches_table`].
766    #[cfg(not(feature = "sm4-bitsliced"))]
767    #[test]
768    fn sbox_ct_matches_lut() {
769        for x in 0..=255u8 {
770            assert_eq!(
771                sbox_ct(x),
772                S_BOX[x as usize],
773                "sbox_ct mismatch at x={x:#04x}"
774            );
775        }
776    }
777}