lexe-tls 0.1.17

//! Extension traits and types on [`lexe_crypto::ed25519`], so it can integrate
//! with TLS libraries like `rustls` and `rcgen` without adding a dependency
//! on an entire TLS stack in a foundational crate like `lexe_crypto`.

use asn1_rs::{Oid, oid};
use base64::Engine as _;
use lexe_byte_array::ByteArray;
use lexe_crypto::ed25519;
use rustls::pki_types::pem::PemObject;
use secrecy::Zeroize;
use x509_parser::x509;

/// The standard PKCS OID for Ed25519.
/// See "id-Ed25519" in [RFC 8410](https://tools.ietf.org/html/rfc8410).
#[rustfmt::skip]
const PKCS_OID: Oid<'static> = oid!(1.3.101.112);
// const PKCS_OID_SLICE: &[u64] = &[1, 3, 101, 112];

pub trait Ed25519KeyPairExt: Sized {
    /// Serialize the [`ed25519::KeyPair`] into a PKCS#8 PEM string.
    fn serialize_pkcs8_pem(&self) -> String;

    /// Deserialize the [`ed25519::KeyPair`] from a PKCS#8 PEM string.
    fn deserialize_pkcs8_pem(pem: &[u8]) -> Result<Self, ed25519::Error>;

    /// Returns a wrapper type that impls `rcgen` traits so you can use
    /// this keypair with `rcgen`.
    fn rcgen(&self) -> RcgenEd25519KeyPair<'_>;
}

pub trait Ed25519PublicKeyExt: Sized {
    /// Try to convert a generic x509 cert Subject PublicKeyInfo (SPKI) into an
    /// ed25519 Public Key.
    fn try_from_spki(
        spki: &x509::SubjectPublicKeyInfo<'_>,
    ) -> Result<Self, ed25519::Error>;

    /// Returns a wrapper type that impls `rcgen` traits so you can use
    /// this public key with `rcgen`.
    fn rcgen(&self) -> RcgenEd25519PublicKey<'_>;
}

pub struct RcgenEd25519KeyPair<'a>(pub &'a ed25519::KeyPair);

pub struct RcgenEd25519PublicKey<'a>(pub &'a ed25519::PublicKey);

// --- impl Ed25519KeyPairExt --- //

impl Ed25519KeyPairExt for ed25519::KeyPair {
    fn serialize_pkcs8_pem(&self) -> String {
        let mut der = self.serialize_pkcs8_der();
        // Reserve enough space to always avoid reallocs (and thus avoid secrets
        // smeared around the heap).
        let mut pem = String::with_capacity(171);

        pem.push_str("-----BEGIN PRIVATE KEY-----\n");
        // TODO(phlip9): b64_ct
        base64::engine::general_purpose::STANDARD.encode_string(der, &mut pem);
        pem.push_str("\n-----END PRIVATE KEY-----\n");

        der.zeroize();
        pem
    }

    fn deserialize_pkcs8_pem(pem: &[u8]) -> Result<Self, ed25519::Error> {
        let der = rustls::pki_types::PrivatePkcs8KeyDer::from_pem_slice(pem)
            .map_err(|_| ed25519::Error::KeyDeserializeError)?;
        ed25519::KeyPair::deserialize_pkcs8_der(der.secret_pkcs8_der())
    }

    fn rcgen(&self) -> RcgenEd25519KeyPair<'_> {
        RcgenEd25519KeyPair(self)
    }
}

// --- impl Ed25519PublicKeyExt --- //

impl Ed25519PublicKeyExt for ed25519::PublicKey {
    fn try_from_spki(
        spki: &x509::SubjectPublicKeyInfo<'_>,
    ) -> Result<Self, ed25519::Error> {
        let alg = &spki.algorithm;
        if !(alg.oid() == &PKCS_OID) {
            return Err(ed25519::Error::UnexpectedAlgorithm);
        }

        Self::try_from(spki.subject_public_key.as_ref())
    }

    fn rcgen(&self) -> RcgenEd25519PublicKey<'_> {
        RcgenEd25519PublicKey(self)
    }
}

// --- impl RcgenEd25519KeyPair --- //

impl<'a> rcgen::SigningKey for RcgenEd25519KeyPair<'a> {
    fn sign(&self, msg: &[u8]) -> Result<Vec<u8>, rcgen::Error> {
        Ok(self.0.sign_raw(msg).as_slice().to_vec())
    }
}

impl<'a> rcgen::PublicKeyData for RcgenEd25519KeyPair<'a> {
    #[inline]
    fn der_bytes(&self) -> &[u8] {
        self.0.public_key().as_slice()
    }
    #[inline]
    fn algorithm(&self) -> &'static rcgen::SignatureAlgorithm {
        self.0.public_key().rcgen().algorithm()
    }
    #[inline]
    fn subject_public_key_info(&self) -> Vec<u8> {
        self.0.public_key().rcgen().subject_public_key_info()
    }
}

// --- impl RcgenEd25519KeyPair --- //

impl<'a> rcgen::PublicKeyData for RcgenEd25519PublicKey<'a> {
    #[inline]
    fn der_bytes(&self) -> &[u8] {
        self.0.as_slice()
    }
    #[inline]
    fn algorithm(&self) -> &'static rcgen::SignatureAlgorithm {
        &rcgen::PKCS_ED25519
    }
}

#[cfg(test)]
mod test {
    use proptest::proptest;

    use super::*;

    #[test]
    fn test_keypair_pkcs8_pem_roundtrip() {
        proptest!(|(key_1: ed25519::KeyPair)| {
            let pem_1 = key_1.serialize_pkcs8_pem();
            let key_2 = ed25519::KeyPair::deserialize_pkcs8_pem(pem_1.as_bytes()).unwrap();
            let pem_2 = key_2.serialize_pkcs8_pem();
            assert_eq!(key_1.secret_key(), key_2.secret_key());
            assert_eq!(pem_1, pem_2);
        });
    }
}