purecrypto 0.6.19

A pure-Rust cryptography toolkit with no foreign-code dependencies, from constant-time primitives up to keys, X.509 and TLS.
Documentation
//! Generic key decoders: parse an encoded key of unknown algorithm into a
//! boxed unified trait object.
//!
//! These parse via the X.509 [`AnyPrivateKey`](crate::x509::AnyPrivateKey) /
//! [`AnyPublicKey`](crate::x509::AnyPublicKey) OID dispatch and then bridge onto
//! the [`PrivateKey`]/[`PublicKey`] facade with `into_dyn()`, so a caller can
//! load "some key" from PKCS#8 / SPKI bytes and operate on it without knowing
//! the algorithm at compile time.
//!
//! Coverage matches `AnyPrivateKey`/`AnyPublicKey`: RSA, ECDSA (P-256/384/521,
//! secp256k1), Ed25519, Ed448, ML-DSA, and SLH-DSA. Keys outside that set —
//! X25519/X448, the stateful hash-based signers, ML-KEM, and SM2 (whose keys
//! decode as ECDSA over the SM2 curve, not as the SM2 signature scheme) — are
//! not produced here; construct those through their concrete types.
//!
//! Requires the `x509` feature (for the SPKI / PKCS#8 parsers).

use alloc::boxed::Box;

use crate::key::{Error, PrivateKey, PublicKey};
use crate::x509::{AnyPrivateKey, AnyPublicKey, Pkcs8ReadOptions};

/// Decodes a plaintext PKCS#8 (`PrivateKeyInfo`) DER document into a boxed
/// [`PrivateKey`].
pub fn private_key_from_pkcs8_der(der: &[u8]) -> Result<Box<dyn PrivateKey>, Error> {
    Ok(AnyPrivateKey::from_pkcs8_der(der, Pkcs8ReadOptions::new())
        .map_err(|_| Error::Encoding)?
        .into_dyn())
}

/// Decodes a plaintext PKCS#8 PEM (`-----BEGIN PRIVATE KEY-----`) document into
/// a boxed [`PrivateKey`].
pub fn private_key_from_pkcs8_pem(pem: &str) -> Result<Box<dyn PrivateKey>, Error> {
    Ok(AnyPrivateKey::from_pkcs8_pem(pem, Pkcs8ReadOptions::new())
        .map_err(|_| Error::Encoding)?
        .into_dyn())
}

/// Decodes an encrypted PKCS#8 (`EncryptedPrivateKeyInfo`) DER document under
/// `password` into a boxed [`PrivateKey`].
pub fn private_key_from_pkcs8_der_encrypted(
    der: &[u8],
    password: &[u8],
) -> Result<Box<dyn PrivateKey>, Error> {
    Ok(
        AnyPrivateKey::from_pkcs8_der(der, Pkcs8ReadOptions::new().password(password))
            .map_err(|_| Error::Encoding)?
            .into_dyn(),
    )
}

/// Decodes an encrypted PKCS#8 PEM (`-----BEGIN ENCRYPTED PRIVATE KEY-----`)
/// document under `password` into a boxed [`PrivateKey`].
pub fn private_key_from_pkcs8_pem_encrypted(
    pem: &str,
    password: &[u8],
) -> Result<Box<dyn PrivateKey>, Error> {
    Ok(
        AnyPrivateKey::from_pkcs8_pem(pem, Pkcs8ReadOptions::new().password(password))
            .map_err(|_| Error::Encoding)?
            .into_dyn(),
    )
}

/// Decodes a `SubjectPublicKeyInfo` DER document into a boxed [`PublicKey`].
pub fn public_key_from_spki_der(der: &[u8]) -> Result<Box<dyn PublicKey>, Error> {
    Ok(AnyPublicKey::from_spki_der(der)
        .map_err(|_| Error::Encoding)?
        .into_dyn())
}

/// Decodes a `SubjectPublicKeyInfo` PEM (`-----BEGIN PUBLIC KEY-----`) document
/// into a boxed [`PublicKey`].
pub fn public_key_from_spki_pem(pem: &str) -> Result<Box<dyn PublicKey>, Error> {
    Ok(AnyPublicKey::from_spki_pem(pem)
        .map_err(|_| Error::Encoding)?
        .into_dyn())
}