gmcrypto_core/
lib.rs

1//! Constant-time-designed pure-Rust SM2 / SM3 / SM4 primitives.
2//!
3//! See the workspace `README.md` for scope, threat model, and the honest
4//! framing of the in-CI `dudect`-based timing-leak regression harness.
5//!
6//! # Modules
7//!
8//! - [`sm2`] — SM2 elliptic-curve sign / verify / encrypt / decrypt
9//!   (GB/T 32918). Comb-table fixed-base scalar mult (v0.3 W6).
10//! - [`sm3`] — SM3 hash (GB/T 32905) with streaming `new/update/finalize`.
11//! - [`sm4`] — SM4 block cipher (GB/T 32907) + CBC mode (single-shot
12//!   and v0.3 W5 streaming). v0.4 W3 adds an opt-in bitsliced
13//!   (table-less, gate-only) S-box behind the `sm4-bitsliced` feature.
14//! - [`hmac`] — HMAC-SM3 (RFC 2104), single-shot + v0.3 W5 streaming.
15//! - [`kdf`] — PBKDF2-HMAC-SM3 (RFC 8018 §5.2).
16//! - [`asn1`] — strict-canonical DER reader / writer / OID constants
17//!   (v0.3 W1); GM/T 0009 SM2 ciphertext SEQUENCE; RFC 3279 SM2
18//!   signature SEQUENCE.
19//! - [`pem`] — RFC 7468 PEM codec (v0.3 W2; hand-rolled, `no_std`).
20//! - [`spki`] — RFC 5280 `SubjectPublicKeyInfo` for SM2 (v0.3 W2).
21//! - [`sec1`] — RFC 5915 `ECPrivateKey` + SEC1 uncompressed point (v0.3 W2).
22//! - [`pkcs8`] — RFC 5958 `OneAsymmetricKey` + RFC 8018 PBES2 (v0.3 W2).
23//! - [`traits`] — in-crate `Hash` / `Mac` / `BlockCipher` traits
24//!   (v0.3 W5). v0.4 W2 adds RustCrypto-trait fit (`digest::Digest`,
25//!   `digest::Mac`, `cipher::BlockEncrypt`/`BlockDecrypt`) behind the
26//!   opt-in `digest-traits` / `cipher-traits` features.
27//!
28//! # Crate features
29//!
30//! - `default` — `no_std`, `alloc`-only. No optional dependencies.
31//! - `digest-traits` — opt-in (v0.4 W2). Implements `digest::Digest` for
32//!   [`sm3::Sm3`] and `digest::Mac` for [`hmac::HmacSm3`]. Pulls
33//!   `digest = "0.10"`.
34//! - `cipher-traits` — opt-in (v0.4 W2). Implements
35//!   `cipher::{BlockEncrypt, BlockDecrypt, BlockSizeUser, KeySizeUser,
36//!   KeyInit}` for [`sm4::Sm4Cipher`]. Pulls `cipher = "0.4"`.
37//! - `sm4-bitsliced` — opt-in (v0.4 W3). Routes the SM4 S-box through
38//!   a bitsliced (table-less, gate-only) Itoh-Tsujii inversion in
39//!   GF(2^8). Byte-identical output to the default linear-scan path;
40//!   constant-time by construction (no table lookups, no branches on
41//!   secret bits).
42//! - `sm4-bitsliced-simd` — opt-in (v0.5 W4 scaffolding; AVX2 / NEON
43//!   intrinsic implementations land in v0.5.x). Implies
44//!   `sm4-bitsliced`. Default-off.
45//! - `crypto-bigint-scalar` — opt-in (v0.5 W5). Exposes
46//!   [`sm2::Sm2PrivateKey::from_scalar`] which takes a
47//!   `crypto_bigint::U256` directly. Default-off; the always-on
48//!   `from_bytes_be` constructor is the recommended path for callers
49//!   who don't want a transitive `crypto-bigint` dep.
50//!
51//! # `wasm32-unknown-unknown`
52//!
53//! Builds clean as of v0.4 W1. The crate is `no_std + alloc` only and
54//! does NOT pull `getrandom`'s `wasm_js` backend or `wasm-bindgen` /
55//! `js-sys` into its default dep graph. Wasm callers wire their own
56//! `rand_core::Rng` impl — see the workspace `README.md`.
57
58#![no_std]
59#![deny(missing_docs)]
60#![doc(html_root_url = "https://docs.rs/gmcrypto-core/0.5.0")]
61
62extern crate alloc;
63
64pub mod asn1;
65pub mod hmac;
66pub mod kdf;
67pub mod pem;
68pub mod pkcs8;
69pub mod sec1;
70pub mod sm2;
71pub mod sm3;
72pub mod sm4;
73pub mod spki;
74pub mod traits;
75
76/// Workspace-wide failure type (v0.5 W5).
77///
78/// Every fallible public surface in `gmcrypto-core` that does not
79/// return `Option` / `bool` / `subtle::CtOption` returns
80/// `Result<_, Error>`. The single `Failed` variant is deliberate per
81/// the **failure-mode invariant** (see `SECURITY.md`): distinguishing
82/// failure modes leaks information to padding-oracle / invalid-curve /
83/// password-oracle attackers.
84///
85/// Per-module aliases keep the established import paths working:
86/// `sm2::Error`, `pem::Error`, `pkcs8::Error` are type aliases for
87/// this one type. Prior to v0.5 these were separate per-module enums
88/// (`SignError`, `EncryptError`, `DecryptError`, `pem::Error`,
89/// `pkcs8::Error`) all with a single `Failed` variant; v0.5 unifies
90/// them per Q5.16 in `docs/v0.5-scope.md`.
91#[derive(Debug, Clone, Copy, PartialEq, Eq)]
92#[non_exhaustive]
93pub enum Error {
94    /// The operation failed. No further information is exposed —
95    /// distinguishing failure modes leaks attacker-useful signal.
96    Failed,
97}
98
99impl core::fmt::Display for Error {
100    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
101        f.write_str("gmcrypto-core operation failed")
102    }
103}
104
105impl core::error::Error for Error {}
gmcrypto_core/lib.rs

gmcrypto_core/
lib.rs
