Skip to main content

Crate p384

Crate p384 

Source
Expand description

§RustCrypto: NIST P-384 (secp384r1) elliptic curve

crate Docs Build Status Apache2/MIT licensed Rust Version Project Chat

Pure Rust implementation of the NIST P-384 (a.k.a. secp384r1) elliptic curve with support for ECDH, ECDSA signing/verification, and general purpose curve arithmetic support implemented in terms of traits from the elliptic-curve crate.

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!

§Supported Algorithms

§PKCS#8 Key Encoding

PKCS#8 is a private key format with support for multiple algorithms. It can be encoded as binary DER or text PEM.

You can recognize PEM encoded PKCS#8 private keys because they do not have an algorithm name in the type label, e.g.:

-----BEGIN PRIVATE KEY-----

PKCS#8 support is gated under the pkcs8 feature. The pem feature, which is enabled by default, adds PEM decoding and also enables pkcs8.

The same pattern is used by the other curve crates in this repository which re-export pkcs8.

The following traits can be used to decode/encode secret and public keys as PKCS#8/SPKI. Note that pkcs8 is re-exported from p384 when the pkcs8 feature is enabled:

For private keys, SecretKey::from_der and SecretKey::from_pem provide convenience methods which can decode PKCS#8 keys. Use the trait methods above when the input is expected to be specifically PKCS#8.

§Example

use p384::SecretKey;

// WARNING: Do not hardcode private keys in your source code. This is for demonstration purposes only.
let pem = r#"-----BEGIN PRIVATE KEY-----
MIG2AgEAMBAGByqGSM49AgEGBSuBBAAiBIGeMIGbAgEBBDBs2FQo+zKrF8hywWB/
mISKUjsyCpYI/tZc0nzXW9zsBE3xqR0gG/f3qsETDG3cSw+hZANiAAR5bOBw+XY+
jrppUPPAT9VKB+e9X/4Lk9tpYNpC1dfLXzTa4wzRkCS5MJHgYNnYynzFKG0a1uY5
cO4Gd7ngQcruAZwkADecrwDeGtnrTdcRrQ0qhQGlHYfwT4runOeuT2c=
-----END PRIVATE KEY-----"#;
let secret_key = SecretKey::from_pem(pem)?;

§About P-384

NIST P-384 is a Weierstrass curve specified in SP 800-186: Recommendations for Discrete Logarithm-based Cryptography: Elliptic Curve Domain Parameters.

Also known as secp384r1 (SECG), it’s included in the US National Security Agency’s “Suite B” and is widely used in protocols like TLS and the associated X.509 PKI.

§License

All crates licensed under either of

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.

§Backends

This crate has support for two different field arithmetic backends which can be selected using cfg(p384_backend), e.g. to select the formally verified fiat backend:

$ RUSTFLAGS='--cfg p384_backend="fiat"' cargo test

Or it can be set through .cargo/config:

[build]
rustflags = ['--cfg', 'p384_backend="fiat"']

The available backends are:

  • bigint (default): backend provided by crypto-bigint, which should provide better performance as well as smaller code size and fewer dependencies, but isn’t formally verified and may contain bugs
  • fiat: formally verified implementation synthesized by fiat-crypto which should be correct for all inputs (though there’s a possibility of bugs in the code which glues to it)

§serde support

When the serde feature of this crate is enabled, Serialize and Deserialize are impl’d for the following types:

Please see type-specific documentation for more information.

Re-exports§

pub use elliptic_curve;
pub use elliptic_curve::pkcs8;pkcs8
pub use hash2curve;hash2curve

Modules§

ecdhecdh
Elliptic Curve Diffie-Hellman (Ephemeral) Support.
ecdsaecdsa-core
Elliptic Curve Digital Signature Algorithm (ECDSA)
test_vectorstest-vectors
secp384r1 test vectors.

Structs§

NistP384
NIST P-384 elliptic curve.
Odd
Wrapper type for odd integers.
Scalararithmetic
Element in the NIST P-384 scalar field modulo n.

Type Aliases§

AffinePointarithmetic
Elliptic curve point in affine coordinates.
CompressedPoint
Compressed SEC1-encoded NIST P-384 curve point.
FieldBytes
NIST P-384 field element serialized as bytes.
NonZeroScalararithmetic
Non-zero NIST P-384 scalar field element.
ProjectivePointarithmetic
Elliptic curve point in projective coordinates.
PublicKeyarithmetic
NIST P-384 public key.
Sec1Point
NIST P-384 SEC1 encoded point.
SecretKey
NIST P-384 secret key.
U48
U384
384-bit unsigned big integer.