lib-q-core 0.0.2

Core types and traits for lib-Q post-quantum cryptography library
Documentation
//! WASM conversion helpers between Rust buffers and JavaScript [`js_sys::Uint8Array`].
//!
//! These are mechanical copies: they do not infer sensitivity. Callers choose [`zeroize::Zeroizing`]
//! or explicit clearing when handling secrets.

#[cfg(feature = "wasm")]
extern crate alloc;
#[cfg(feature = "wasm")]
use alloc::{
    format,
    string::{
        String,
        ToString,
    },
    vec::Vec,
};

#[cfg(feature = "wasm")]
use js_sys::Uint8Array;
#[cfg(feature = "wasm")]
use serde_json;
#[cfg(feature = "wasm")]
use serde_wasm_bindgen;
#[cfg(feature = "wasm")]
use wasm_bindgen::prelude::*;

use crate::api::Algorithm;
use crate::error::Result;

/// Byte-array conversion helpers for WASM bindings.
#[cfg(feature = "wasm")]
pub struct WasmConversions;

#[cfg(feature = "wasm")]
impl WasmConversions {
    /// Copy `data` into a new JavaScript `Uint8Array`.
    ///
    /// The input slice is not modified; callers that need the source buffer cleared must do so
    /// separately (for example by holding secrets in [`zeroize::Zeroizing`] and letting it drop
    /// after this call).
    pub fn vec_to_uint8array(data: &[u8]) -> Uint8Array {
        let n = u32::try_from(data.len()).expect("length exceeds JavaScript Uint8Array maximum");
        let array = Uint8Array::new_with_length(n);
        array.copy_from(data);
        array
    }

    /// Convert WASM Uint8Array to Rust Vec<u8>
    ///
    /// Validates input size to limit abuse; copies array contents into a new `Vec`.
    pub fn uint8array_to_vec(array: &Uint8Array) -> Result<Vec<u8>> {
        let length = array.length() as usize;

        // Validate size to prevent DoS attacks
        const MAX_SIZE: usize = 1024 * 1024; // 1MB limit
        if length > MAX_SIZE {
            return Err(crate::error::Error::InvalidMessageSize {
                max: MAX_SIZE,
                actual: length,
            });
        }

        let mut vec = alloc::vec![0u8; length];
        array.copy_to(&mut vec);
        Ok(vec)
    }

    /// Convert algorithm string to Algorithm enum
    ///
    /// This function provides secure algorithm parsing with:
    /// - Input validation to prevent injection attacks
    /// - Case-insensitive matching for user convenience
    /// - Clear error messages for unsupported algorithms
    pub fn string_to_algorithm(algorithm_str: &str) -> Result<Algorithm> {
        match algorithm_str.to_lowercase().as_str() {
            // KEM algorithms
            "mlkem512" | "ml-kem-512" => Ok(Algorithm::MlKem512),
            "mlkem768" | "ml-kem-768" => Ok(Algorithm::MlKem768),
            "mlkem1024" | "ml-kem-1024" => Ok(Algorithm::MlKem1024),
            // Signature algorithms
            "mldsa44" | "ml-dsa-44" => Ok(Algorithm::MlDsa44),
            "mldsa65" | "ml-dsa-65" => Ok(Algorithm::MlDsa65),
            "mldsa87" | "ml-dsa-87" => Ok(Algorithm::MlDsa87),
            "fndsa" | "fn-dsa" => Ok(Algorithm::FnDsa),

            // SLH-DSA (hyphenated IDs, NIST-style names, and PascalCase `SlhDsa*` lowercased)
            "slh-dsa-sha256-128f-robust" |
            "slh-dsa-sha2-128f-robust" |
            "slhdsasha256128frobust" => Ok(Algorithm::SlhDsaSha256128fRobust),
            "slh-dsa-sha256-192f-robust" |
            "slh-dsa-sha2-192f-robust" |
            "slhdsasha256192frobust" => Ok(Algorithm::SlhDsaSha256192fRobust),
            "slh-dsa-sha256-256f-robust" |
            "slh-dsa-sha2-256f-robust" |
            "slhdsasha256256frobust" => Ok(Algorithm::SlhDsaSha256256fRobust),
            "slh-dsa-shake256-128f-robust" | "slhdsashake256128frobust" => {
                Ok(Algorithm::SlhDsaShake256128fRobust)
            }
            "slh-dsa-shake256-192f-robust" | "slhdsashake256192frobust" => {
                Ok(Algorithm::SlhDsaShake256192fRobust)
            }
            "slh-dsa-shake256-256f-robust" | "slhdsashake256256frobust" => {
                Ok(Algorithm::SlhDsaShake256256fRobust)
            }

            // Hash algorithms
            "sha3_224" | "sha3-224" => Ok(Algorithm::Sha3_224),
            "sha3_256" | "sha3-256" => Ok(Algorithm::Sha3_256),
            "sha3_384" | "sha3-384" => Ok(Algorithm::Sha3_384),
            "sha3_512" | "sha3-512" => Ok(Algorithm::Sha3_512),
            "shake128" => Ok(Algorithm::Shake128),
            "shake256" => Ok(Algorithm::Shake256),
            "sha224" | "sha-224" => Ok(Algorithm::Sha224),
            "sha256" | "sha-256" => Ok(Algorithm::Sha256),
            "sha384" | "sha-384" => Ok(Algorithm::Sha384),
            "sha512" | "sha-512" => Ok(Algorithm::Sha512),
            "sha512_224" | "sha512-224" | "sha-512/224" => Ok(Algorithm::Sha512_224),
            "sha512_256" | "sha512-256" | "sha-512/256" => Ok(Algorithm::Sha512_256),
            "cshake128" | "cshake-128" => Ok(Algorithm::CShake128),
            "cshake256" | "cshake-256" => Ok(Algorithm::CShake256),
            "keccak224" | "keccak-224" => Ok(Algorithm::Keccak224),
            "keccak256" | "keccak-256" => Ok(Algorithm::Keccak256),
            "keccak384" | "keccak-384" => Ok(Algorithm::Keccak384),
            "keccak512" | "keccak-512" => Ok(Algorithm::Keccak512),
            "kangarootwelve" | "kt128" | "k12" => Ok(Algorithm::Kt128),
            "kt256" => Ok(Algorithm::Kt256),
            "turboshake128" | "turboshake-128" => Ok(Algorithm::TurboShake128),
            "turboshake256" | "turboshake-256" => Ok(Algorithm::TurboShake256),
            "kmac128" | "kmac-128" => Ok(Algorithm::Kmac128),
            "kmac256" | "kmac-256" => Ok(Algorithm::Kmac256),
            "tuplehash128" | "tuplehash-128" => Ok(Algorithm::TupleHash128),
            "tuplehash256" | "tuplehash-256" => Ok(Algorithm::TupleHash256),
            "parallelhash128" | "parallelhash-128" => Ok(Algorithm::ParallelHash128),
            "parallelhash256" | "parallelhash-256" => Ok(Algorithm::ParallelHash256),

            // AEAD algorithms
            "saturnin" => Ok(Algorithm::Saturnin),
            "shake256aead" | "shake256-aead" => Ok(Algorithm::Shake256Aead),
            "duplexspongeaead" | "duplex-sponge-aead" => Ok(Algorithm::DuplexSpongeAead),
            "tweakaead" | "tweak-aead" => Ok(Algorithm::TweakAead),
            "romulus-n" | "romulusn" => Ok(Algorithm::RomulusN),
            "romulus-m" | "romulusm" => Ok(Algorithm::RomulusM),

            _ => Err(crate::error::Error::UnsupportedAlgorithm {
                algorithm: algorithm_str.to_string(),
            }),
        }
    }

    /// Convert Algorithm enum to string
    ///
    /// This function provides consistent algorithm naming for JavaScript
    pub fn algorithm_to_string(algorithm: Algorithm) -> String {
        match algorithm {
            // KEM algorithms
            Algorithm::MlKem512 => "ml-kem-512".to_string(),
            Algorithm::MlKem768 => "ml-kem-768".to_string(),
            Algorithm::MlKem1024 => "ml-kem-1024".to_string(),
            // Signature algorithms
            Algorithm::MlDsa44 => "ml-dsa-44".to_string(),
            Algorithm::MlDsa65 => "ml-dsa-65".to_string(),
            Algorithm::MlDsa87 => "ml-dsa-87".to_string(),
            Algorithm::FnDsa => "fn-dsa".to_string(),

            Algorithm::SlhDsaSha256128fRobust => "slh-dsa-sha256-128f-robust".to_string(),
            Algorithm::SlhDsaSha256192fRobust => "slh-dsa-sha256-192f-robust".to_string(),
            Algorithm::SlhDsaSha256256fRobust => "slh-dsa-sha256-256f-robust".to_string(),
            Algorithm::SlhDsaShake256128fRobust => "slh-dsa-shake256-128f-robust".to_string(),
            Algorithm::SlhDsaShake256192fRobust => "slh-dsa-shake256-192f-robust".to_string(),
            Algorithm::SlhDsaShake256256fRobust => "slh-dsa-shake256-256f-robust".to_string(),

            // Hash algorithms
            Algorithm::Sha3_224 => "sha3-224".to_string(),
            Algorithm::Sha3_256 => "sha3-256".to_string(),
            Algorithm::Sha3_384 => "sha3-384".to_string(),
            Algorithm::Sha3_512 => "sha3-512".to_string(),
            Algorithm::Shake128 => "shake128".to_string(),
            Algorithm::Shake256 => "shake256".to_string(),
            Algorithm::Sha224 => "sha-224".to_string(),
            Algorithm::Sha256 => "sha-256".to_string(),
            Algorithm::Sha384 => "sha-384".to_string(),
            Algorithm::Sha512 => "sha-512".to_string(),
            Algorithm::Sha512_224 => "sha-512/224".to_string(),
            Algorithm::Sha512_256 => "sha-512/256".to_string(),
            Algorithm::CShake128 => "cshake128".to_string(),
            Algorithm::CShake256 => "cshake256".to_string(),
            Algorithm::Keccak224 => "keccak-224".to_string(),
            Algorithm::Keccak256 => "keccak-256".to_string(),
            Algorithm::Keccak384 => "keccak-384".to_string(),
            Algorithm::Keccak512 => "keccak-512".to_string(),
            Algorithm::Kt128 => "kt128".to_string(),
            Algorithm::Kt256 => "kt256".to_string(),
            Algorithm::TurboShake128 => "turboshake128".to_string(),
            Algorithm::TurboShake256 => "turboshake256".to_string(),
            Algorithm::Kmac128 => "kmac128".to_string(),
            Algorithm::Kmac256 => "kmac256".to_string(),
            Algorithm::TupleHash128 => "tuplehash128".to_string(),
            Algorithm::TupleHash256 => "tuplehash256".to_string(),
            Algorithm::ParallelHash128 => "parallelhash128".to_string(),
            Algorithm::ParallelHash256 => "parallelhash256".to_string(),

            // AEAD algorithms
            Algorithm::Saturnin => "saturnin".to_string(),
            Algorithm::Shake256Aead => "shake256-aead".to_string(),
            Algorithm::DuplexSpongeAead => "duplex-sponge-aead".to_string(),
            Algorithm::TweakAead => "tweak-aead".to_string(),
            Algorithm::RomulusN => "romulus-n".to_string(),
            Algorithm::RomulusM => "romulus-m".to_string(),

            // Other algorithms (add as needed)
            _ => format!("{:?}", algorithm).to_lowercase().replace('_', "-"),
        }
    }

    /// Convert KEM keypair to JavaScript object
    ///
    /// This function securely serializes keypair data for JavaScript consumption
    pub fn kem_keypair_to_js(public_key: &[u8], secret_key: &[u8]) -> Result<JsValue> {
        let result = serde_json::json!({
            "public_key": public_key,
            "secret_key": secret_key,
            "algorithm": "kem"
        });

        serde_wasm_bindgen::to_value(&result).map_err(|e| crate::error::Error::NotImplemented {
            feature: format!("Serialization error: {:?}", e),
        })
    }

    /// Convert signature keypair to JavaScript object
    ///
    /// This function securely serializes keypair data for JavaScript consumption
    pub fn sig_keypair_to_js(public_key: &[u8], secret_key: &[u8]) -> Result<JsValue> {
        let result = serde_json::json!({
            "public_key": public_key,
            "secret_key": secret_key,
            "algorithm": "signature"
        });

        serde_wasm_bindgen::to_value(&result).map_err(|e| crate::error::Error::NotImplemented {
            feature: format!("Serialization error: {:?}", e),
        })
    }

    /// Convert hash result to JavaScript object
    ///
    /// This function securely serializes hash data for JavaScript consumption
    pub fn hash_result_to_js(hash: &[u8], algorithm: Algorithm) -> Result<JsValue> {
        let result = serde_json::json!({
            "hash": hash,
            "algorithm": Self::algorithm_to_string(algorithm),
            "length": hash.len()
        });

        serde_wasm_bindgen::to_value(&result).map_err(|e| crate::error::Error::NotImplemented {
            feature: format!("Serialization error: {:?}", e),
        })
    }

    /// Convert error to JavaScript error
    ///
    /// This function provides secure error conversion that doesn't leak sensitive information
    pub fn error_to_js(error: &crate::error::Error) -> JsValue {
        // Only expose safe error information to JavaScript
        let safe_message = match error {
            crate::error::Error::NotImplemented { feature } => {
                format!("Feature not implemented: {}", feature)
            }
            crate::error::Error::InvalidAlgorithm { algorithm } => {
                format!("Invalid algorithm: {}", algorithm)
            }
            crate::error::Error::InvalidKey { key_type, reason } => {
                format!("Invalid {}: {}", key_type, reason)
            }
            crate::error::Error::InvalidMessageSize { max, actual } => {
                format!("Message size {} exceeds maximum {}", actual, max)
            }
            crate::error::Error::InvalidNonceSize { expected, actual } => {
                format!("Nonce size {} does not match expected {}", actual, expected)
            }
            _ => "Cryptographic operation failed".to_string(),
        };

        JsValue::from_str(&safe_message)
    }
}

/// Canonical WASM signature algorithm id strings for listings (`WasmSignatureContext`,
/// `WasmProviderManager`, JSON summaries). Matches [`WasmConversions::algorithm_to_string`] for SLH.
#[cfg(feature = "wasm")]
pub const WASM_SIGNATURE_ALGORITHM_IDS: &[&str] = &[
    "ml-dsa-44",
    "ml-dsa-65",
    "ml-dsa-87",
    "fn-dsa",
    "slh-dsa-sha256-128f-robust",
    "slh-dsa-sha256-192f-robust",
    "slh-dsa-sha256-256f-robust",
    "slh-dsa-shake256-128f-robust",
    "slh-dsa-shake256-192f-robust",
    "slh-dsa-shake256-256f-robust",
];

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_algorithm_conversion() {
        // Test string to algorithm conversion
        assert_eq!(
            WasmConversions::string_to_algorithm("ml-kem-512").unwrap(),
            Algorithm::MlKem512
        );
        assert_eq!(
            WasmConversions::string_to_algorithm("ML-KEM-512").unwrap(),
            Algorithm::MlKem512
        );
        assert_eq!(
            WasmConversions::string_to_algorithm("sha3-256").unwrap(),
            Algorithm::Sha3_256
        );

        // Test unsupported algorithm
        assert!(WasmConversions::string_to_algorithm("unsupported").is_err());

        // Test algorithm to string conversion
        assert_eq!(
            WasmConversions::algorithm_to_string(Algorithm::MlKem512),
            "ml-kem-512"
        );
        assert_eq!(
            WasmConversions::algorithm_to_string(Algorithm::Sha3_256),
            "sha3-256"
        );

        assert_eq!(
            WasmConversions::string_to_algorithm("slh-dsa-shake256-128f-robust").unwrap(),
            Algorithm::SlhDsaShake256128fRobust
        );
        assert_eq!(
            WasmConversions::string_to_algorithm("SLH-DSA-SHAKE256-128f-Robust").unwrap(),
            Algorithm::SlhDsaShake256128fRobust
        );
        assert_eq!(
            WasmConversions::string_to_algorithm("SlhDsaShake256128fRobust").unwrap(),
            Algorithm::SlhDsaShake256128fRobust
        );
        assert_eq!(
            WasmConversions::string_to_algorithm("slh-dsa-sha256-128f-robust").unwrap(),
            Algorithm::SlhDsaSha256128fRobust
        );
        assert_eq!(
            WasmConversions::algorithm_to_string(Algorithm::SlhDsaShake256128fRobust),
            "slh-dsa-shake256-128f-robust"
        );
    }

    #[test]
    #[cfg(target_arch = "wasm32")]
    fn test_error_conversion() {
        let error = crate::error::Error::NotImplemented {
            feature: "test feature".to_string(),
        };
        let js_error = WasmConversions::error_to_js(&error);
        // In a real WASM environment, we would test the JsValue
        // For now, we just ensure the function doesn't panic
        assert!(!js_error.is_undefined());
    }
}