apx_core 0.26.0

APx core primitives
Documentation
//! # Public keys and secret keys

use thiserror::Error;

use crate::{
    crypto::{
        eddsa::{
            ed25519_public_key_from_bytes,
            ed25519_public_key_from_pkcs8_pem,
            ed25519_public_key_from_secret_key,
            ed25519_public_key_to_multikey,
            ed25519_public_key_to_pkcs8_pem,
            Ed25519PublicKey,
            Ed25519SecretKey,
            Ed25519SerializationError,
        },
        rsa::{
            deserialize_rsa_public_key,
            rsa_public_key_from_pkcs1_der,
            rsa_public_key_to_multikey,
            rsa_public_key_to_pkcs8_pem,
            RsaPublicKey,
            RsaSecretKey,
            RsaSerializationError,
        },
    },
    multibase::Multibase,
    multicodec::Multicodec,
};

/// Errors that may occur during key serialization
#[derive(Debug, Error)]
pub enum KeySerializationError {
    #[error(transparent)]
    Ed25519(#[from] Ed25519SerializationError),

    #[error(transparent)]
    Rsa(#[from] RsaSerializationError),
}

/// Public key
#[derive(Debug, PartialEq)]
pub enum PublicKey {
    Ed25519(Ed25519PublicKey),
    Rsa(RsaPublicKey),
}

impl PublicKey {
    /// Parses multikey string
    pub fn from_multikey(public_key_multibase: &str) -> Result<Self, &'static str> {
        let public_key_multicode = Multibase::Base58Btc
            .decode_exact(public_key_multibase)
            .map_err(|_| "invalid key encoding")?;
        let public_key_decoded = Multicodec::decode(&public_key_multicode)
            .map_err(|_| "unexpected key type")?;
        let public_key = match public_key_decoded {
            (Multicodec::RsaPub, public_key_der) => {
                let public_key = rsa_public_key_from_pkcs1_der(&public_key_der)
                    .map_err(|_| "invalid key encoding")?;
                PublicKey::Rsa(public_key)
            },
            (Multicodec::Ed25519Pub, public_key_bytes) => {
                // Validate Ed25519 key
                let public_key = ed25519_public_key_from_bytes(&public_key_bytes)
                    .map_err(|_| "invalid key encoding")?;
                PublicKey::Ed25519(public_key)
            },
            _ => return Err("unexpected key type"),
        };
        Ok(public_key)
    }

    /// Encodes public key into multikey string
    pub fn to_multikey(&self) -> Result<String, KeySerializationError> {
        let multikey = match self {
            Self::Ed25519(ed25519_key) =>
                ed25519_public_key_to_multikey(ed25519_key),
            Self::Rsa(rsa_key) =>
                rsa_public_key_to_multikey(rsa_key)?,
        };
        Ok(multikey)
    }

    /// Parses public key in PEM format
    pub fn from_pem(public_key_pem: &str) -> Result<Self, &'static str> {
        let public_key = match deserialize_rsa_public_key(public_key_pem) {
            Ok(public_key) => PublicKey::Rsa(public_key),
            Err(_) => {
                let public_key = ed25519_public_key_from_pkcs8_pem(public_key_pem)
                    .map_err(|_| "unexpected key type")?;
                PublicKey::Ed25519(public_key)
            },
        };
        Ok(public_key)
    }

    /// Encodes public key into PEM format
    pub fn to_pem(&self) -> Result<String, KeySerializationError> {
        let key_pem = match self {
            Self::Ed25519(ed25519_key) =>
                ed25519_public_key_to_pkcs8_pem(*ed25519_key)?,
            Self::Rsa(rsa_key) =>
                rsa_public_key_to_pkcs8_pem(rsa_key)?,
        };
        Ok(key_pem)
    }
}

/// Secret key
pub enum SecretKey {
    Ed25519(Ed25519SecretKey),
    Rsa(RsaSecretKey),
}

impl SecretKey {
    /// Returns the public key corresponding to this secret key
    pub fn public_key(&self) -> PublicKey {
        match self {
            Self::Ed25519(secret_key) => {
                let public_key =
                    ed25519_public_key_from_secret_key(secret_key);
                PublicKey::Ed25519(public_key)
            },
            Self::Rsa(rsa_secret_key) => {
                let public_key = RsaPublicKey::from(rsa_secret_key);
                PublicKey::Rsa(public_key)
            },
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::{
        crypto::{
            eddsa::generate_weak_ed25519_key,
            rsa::generate_weak_rsa_key,
        },
    };
    use super::*;

    #[test]
    fn test_public_key_ed25519_multikey_encode_decode() {
        let secret_key = generate_weak_ed25519_key();
        let public_key = PublicKey::Ed25519(ed25519_public_key_from_secret_key(&secret_key));
        let encoded = public_key.to_multikey().unwrap();
        let decoded = PublicKey::from_multikey(&encoded).unwrap();
        assert_eq!(decoded, public_key);
    }

    #[test]
    fn test_public_key_rsa_multikey_encode_decode() {
        let secret_key = generate_weak_rsa_key().unwrap();
        let public_key = PublicKey::Rsa(RsaPublicKey::from(secret_key));
        let encoded = public_key.to_multikey().unwrap();
        let decoded = PublicKey::from_multikey(&encoded).unwrap();
        assert_eq!(decoded, public_key);
    }

    #[test]
    fn test_public_key_ed25519_pem_encode_decode() {
        let secret_key = generate_weak_ed25519_key();
        let public_key = PublicKey::Ed25519(ed25519_public_key_from_secret_key(&secret_key));
        let encoded = public_key.to_pem().unwrap();
        let decoded = PublicKey::from_pem(&encoded).unwrap();
        assert_eq!(decoded, public_key);
    }

    #[test]
    fn test_public_key_rsa_pem_encode_decode() {
        let secret_key = generate_weak_rsa_key().unwrap();
        let public_key = PublicKey::Rsa(RsaPublicKey::from(secret_key));
        let encoded = public_key.to_pem().unwrap();
        let decoded = PublicKey::from_pem(&encoded).unwrap();
        assert_eq!(decoded, public_key);
    }
}