Crate sm2

RustCrypto: SM2 elliptic curve

Pure Rust implementation of the SM2 elliptic curve as defined in the Chinese national standard GM/T 0003-2012 as well as ISO/IEC 14888.

Documentation

⚠️ Security Warning

The elliptic curve arithmetic contained in this crate has never been independently audited!

This crate has been designed with the goal of ensuring that secret-dependent operations are performed in constant time (using the subtle crate and constant-time formulas). However, it has not been thoroughly assessed to ensure that generated assembly is constant time on common CPU architectures.

USE AT YOUR OWN RISK!

About SM2

ShangMi 2 (SM2) is a Weierstrass curve specified in GM/T 0003-2012: Cryptography Industry Standard of the People’s Republic of China.

The SM2 cryptosystem is composed of three distinct algorithms:

• SM2DSA: digital signature algorithm defined in GBT.32918.2-2016, ISO.IEC.14888-3 (SM2-2)
• SM2KEP: key exchange protocol defined in GBT.32918.3-2016 (SM2-3)
• SM2PKE: public key encryption algorithm defined in GBT.32918.4-2016 (SM2-4)

Minimum Supported Rust Version

Rust 1.65 or higher.

Minimum supported Rust version can be changed in the future, but it will be done with a minor version bump.

SemVer Policy

• All on-by-default features of this library are covered by SemVer
• MSRV is considered exempt from SemVer as noted above

License

All crates licensed under either of

• Apache License, Version 2.0
• MIT license

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Re-exports

pub use elliptic_curve;

pub use elliptic_curve::pkcs8;pkcs8

Modules

dsadsa

SM2 Digital Signature Algorithm (SM2DSA) as defined in draft-shen-sm2-ecdsa § 5.

Structs

Scalararithmetic

Scalars are elements in the finite field modulo n.

Sm2

SM2 elliptic curve.

Type Aliases

AffinePointarithmetic

Elliptic curve point in affine coordinates.

CompressedPoint

Compressed SEC1-encoded curve point.

EncodedPoint

SEC1 encoded point.

FieldBytes

SM2 field element serialized as bytes.

NonZeroScalararithmetic

Non-zero scalar field element.

ProjectivePointarithmetic

Elliptic curve point in projective coordinates.

PublicKeyarithmetic

SM2 public key: wrapper type for an elliptic curve point.

SecretKey

SM2 secret key: wrapper point for a secret scalar.

U256

256-bit unsigned big integer.