Crate elliptic_curve

RustCrypto: Elliptic Curve Traits

General purpose Elliptic Curve Cryptography (ECC) support, including types and traits for representing various elliptic curve forms, scalars, points, and public/secret keys composed thereof.

Documentation

Minimum Supported Rust Version

Requires Rust 1.61 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.

Usage

This crate provides traits for describing elliptic curves, along with types which are generic over elliptic curves which can be used as the basis of curve-agnostic code.

It’s intended to be used with the following concrete elliptic curve implementations from the RustCrypto/elliptic-curves project:

• bp256: brainpoolP256r1 and brainpoolP256t1
• bp384: brainpoolP384r1 and brainpoolP384t1
• k256: secp256k1 a.k.a. K-256
• p224: NIST P-224 a.k.a. secp224r1
• p256: NIST P-256 a.k.a secp256r1, prime256v1
• p384: NIST P-384 a.k.a. secp384r1
• p521: NIST P-521 a.k.a. secp521r1

The ecdsa crate provides a generic implementation of the Elliptic Curve Digital Signature Algorithm which can be used with any of the above crates, either via an external ECDSA implementation, or using native curve arithmetic where applicable.

Type conversions

The following chart illustrates the various conversions possible between the various types defined by this crate.

serde support

When the serde feature of this crate is enabled, Serialize and Deserialize impls are provided for the following types:

• JwkEcKey
• PublicKey
• ScalarPrimitive

Please see type-specific documentation for more information.

Re-exports

pub use crypto_bigint as bigint;

pub use generic_array;

pub use rand_core;

pub use subtle;

pub use zeroize;

pub use crate::point::AffinePoint;

arithmetic

pub use crate::point::ProjectivePoint;

arithmetic

pub use crate::scalar::Scalar;

arithmetic

pub use ff;

pub use group;

pub use pkcs8;

Modules

consts

Type aliases for many constants.

ecdhecdh

Elliptic Curve Diffie-Hellman Support.

hash2curvehash2curve

Traits for hashing byte sequences to curve points.

opsarithmetic

Traits for arithmetic operations on elliptic curve field elements.

point

Traits for elliptic curve points.

scalar

Scalar types.

sec1sec1

Support for SEC1 elliptic curve encoding formats.

weierstrassarithmetic

Complete projective formulas for prime order elliptic curves as described in Renes-Costello-Batina 2015.

Structs

Error

Elliptic curve errors.

JwkEcKeyjwk

JSON Web Key (JWK) with a kty of "EC" (elliptic curve).

NonZeroScalararithmetic

Non-zero scalar type.

PublicKeyarithmetic

Elliptic curve public keys.

ScalarPrimitive

Generic scalar type with primitive functionality.

SecretKey

Elliptic curve secret keys.

Constants

ALGORITHM_OIDpkcs8

Algorithm [ObjectIdentifier][pkcs8::ObjectIdentifier] for elliptic curve public key cryptography (id-ecPublicKey).

Traits

Curve

Elliptic curve.

CurveArithmeticarithmetic

Elliptic curve with an arithmetic implementation.

Fieldarithmetic

This trait represents an element of a field.

FieldBytesEncoding

Trait for decoding/encoding Curve::Uint from/to FieldBytes using curve-specific rules.

Grouparithmetic

This trait represents an element of a cryptographic group.

JwkParametersjwk

Elliptic curve parameters used by JSON Web Keys.

PrimeCurve

Marker trait for elliptic curves with prime order.

PrimeCurveArithmeticarithmetic

Prime order elliptic curve with projective arithmetic implementation.

PrimeFieldarithmetic

This represents an element of a non-binary prime field.

VoprfParametersvoprf

Elliptic curve parameters used by VOPRF.

Type Definitions

FieldBytes

Byte representation of a base/scalar field element of a given curve.

FieldBytesSize

Size of serialized field elements of this elliptic curve.

Result

Result type with the elliptic-curve crate’s Error type.