purecrypto 0.6.4

//! C ABI for HKDF, PBKDF2, scrypt, and Argon2.

use super::common::{PcStatus, guard, slice};
use super::hash::id;
use crate::hash::{Sha256, Sha384, Sha512};
use crate::kdf::argon2::{Argon2Params, Argon2Type, argon2};
use crate::kdf::scrypt::scrypt;
use crate::kdf::{
    CmacAes128Prf, CmacAes256Prf, HmacSha256Prf, HmacSha384Prf, HmacSha512Prf, Prf, hkdf,
    kbkdf_counter, kbkdf_feedback, pbkdf2,
};

/// Overwrites `buf` with zeros and routes the read through
/// `core::hint::black_box` so LLVM cannot eliminate the writes as dead
/// stores. Used to wipe a partially-written caller buffer on an error
/// return path so the half-derived key material does not surface
/// (same in-house pattern used by ML-DSA/ML-KEM in `src/mldsa/mod.rs`
/// and `src/mlkem/mod.rs`).
fn wipe(buf: &mut [u8]) {
    for b in buf.iter_mut() {
        *b = 0;
    }
    let _ = core::hint::black_box(&buf);
}

/// Argon2 variant identifiers.
pub mod argon2_id {
    #![allow(missing_docs)]
    pub const ARGON2D: i32 = 4;
    pub const ARGON2I: i32 = 5;
    pub const ARGON2ID: i32 = 6;
}

/// PRF identifiers for the SP 800-108 KBKDF (mirror `PcKbkdfPrf` in
/// `purecrypto.h`).
pub mod kbkdf_prf {
    #![allow(missing_docs)]
    pub const HMAC_SHA256: i32 = 1;
    pub const HMAC_SHA384: i32 = 2;
    pub const HMAC_SHA512: i32 = 3;
    pub const CMAC_AES128: i32 = 4;
    pub const CMAC_AES256: i32 = 5;
}

/// Required `KI` length for the CMAC PRFs (HMAC PRFs accept any length).
fn kbkdf_cmac_key_len(prf: i32) -> Option<usize> {
    match prf {
        kbkdf_prf::CMAC_AES128 => Some(16),
        kbkdf_prf::CMAC_AES256 => Some(32),
        _ => None,
    }
}

/// SP 800-108 counter-mode KBKDF. `prf` is one of `PC_KBKDF_*`; the
/// fixed-input layout is `[i]_32 ‖ Label ‖ 0x00 ‖ Context ‖ [L]_32`.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_kbkdf_counter(
    prf: i32,
    ki: *const u8,
    ki_len: usize,
    label: *const u8,
    label_len: usize,
    context: *const u8,
    context_len: usize,
    out: *mut u8,
    out_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(ki), Some(label), Some(context)) = (
            unsafe { slice(ki, ki_len) },
            unsafe { slice(label, label_len) },
            unsafe { slice(context, context_len) },
        ) else {
            return PcStatus::NullPointer;
        };
        if out.is_null() && out_len > 0 {
            return PcStatus::NullPointer;
        }
        if let Some(want) = kbkdf_cmac_key_len(prf)
            && ki.len() != want
        {
            return PcStatus::Unsupported;
        }
        let buf = if out_len == 0 {
            &mut [][..]
        } else {
            unsafe { core::slice::from_raw_parts_mut(out, out_len) }
        };
        fn run<P: Prf>(ki: &[u8], label: &[u8], context: &[u8], out: &mut [u8]) -> PcStatus {
            match kbkdf_counter::<P>(ki, label, context, out) {
                Ok(()) => PcStatus::Ok,
                Err(_) => PcStatus::Unsupported,
            }
        }
        match prf {
            kbkdf_prf::HMAC_SHA256 => run::<HmacSha256Prf>(ki, label, context, buf),
            kbkdf_prf::HMAC_SHA384 => run::<HmacSha384Prf>(ki, label, context, buf),
            kbkdf_prf::HMAC_SHA512 => run::<HmacSha512Prf>(ki, label, context, buf),
            kbkdf_prf::CMAC_AES128 => run::<CmacAes128Prf>(ki, label, context, buf),
            kbkdf_prf::CMAC_AES256 => run::<CmacAes256Prf>(ki, label, context, buf),
            _ => PcStatus::Unsupported,
        }
    })
}

/// SP 800-108 feedback-mode KBKDF. `prf` is one of `PC_KBKDF_*`; `iv` seeds
/// `K(0)` and may be empty. Layout: `K(i-1) ‖ [i]_32 ‖ Label ‖ 0x00 ‖ Context
/// ‖ [L]_32`.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_kbkdf_feedback(
    prf: i32,
    ki: *const u8,
    ki_len: usize,
    iv: *const u8,
    iv_len: usize,
    label: *const u8,
    label_len: usize,
    context: *const u8,
    context_len: usize,
    out: *mut u8,
    out_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(ki), Some(iv), Some(label), Some(context)) = (
            unsafe { slice(ki, ki_len) },
            unsafe { slice(iv, iv_len) },
            unsafe { slice(label, label_len) },
            unsafe { slice(context, context_len) },
        ) else {
            return PcStatus::NullPointer;
        };
        if out.is_null() && out_len > 0 {
            return PcStatus::NullPointer;
        }
        if let Some(want) = kbkdf_cmac_key_len(prf)
            && ki.len() != want
        {
            return PcStatus::Unsupported;
        }
        let buf = if out_len == 0 {
            &mut [][..]
        } else {
            unsafe { core::slice::from_raw_parts_mut(out, out_len) }
        };
        fn run<P: Prf>(
            ki: &[u8],
            iv: &[u8],
            label: &[u8],
            context: &[u8],
            out: &mut [u8],
        ) -> PcStatus {
            match kbkdf_feedback::<P>(ki, iv, label, context, out) {
                Ok(()) => PcStatus::Ok,
                Err(_) => PcStatus::Unsupported,
            }
        }
        match prf {
            kbkdf_prf::HMAC_SHA256 => run::<HmacSha256Prf>(ki, iv, label, context, buf),
            kbkdf_prf::HMAC_SHA384 => run::<HmacSha384Prf>(ki, iv, label, context, buf),
            kbkdf_prf::HMAC_SHA512 => run::<HmacSha512Prf>(ki, iv, label, context, buf),
            kbkdf_prf::CMAC_AES128 => run::<CmacAes128Prf>(ki, iv, label, context, buf),
            kbkdf_prf::CMAC_AES256 => run::<CmacAes256Prf>(ki, iv, label, context, buf),
            _ => PcStatus::Unsupported,
        }
    })
}

/// HKDF (RFC 5869). `hash` is `PC_SHA{256,384,512}`. `out_len` is the desired
/// output length.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_hkdf(
    hash: i32,
    salt: *const u8,
    salt_len: usize,
    ikm: *const u8,
    ikm_len: usize,
    info: *const u8,
    info_len: usize,
    out: *mut u8,
    out_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(s), Some(k), Some(i)) = (
            unsafe { slice(salt, salt_len) },
            unsafe { slice(ikm, ikm_len) },
            unsafe { slice(info, info_len) },
        ) else {
            return PcStatus::NullPointer;
        };
        if out.is_null() && out_len > 0 {
            return PcStatus::NullPointer;
        }
        let buf = if out_len == 0 {
            &mut [][..]
        } else {
            unsafe { core::slice::from_raw_parts_mut(out, out_len) }
        };
        match hash {
            id::SHA256 => hkdf::<Sha256>(s, k, i, buf),
            id::SHA384 => hkdf::<Sha384>(s, k, i, buf),
            id::SHA512 => hkdf::<Sha512>(s, k, i, buf),
            _ => return PcStatus::Unsupported,
        }
        PcStatus::Ok
    })
}

/// PBKDF2 (RFC 8018). `hash` is `PC_SHA{256,384,512}`.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_pbkdf2(
    hash: i32,
    pw: *const u8,
    pw_len: usize,
    salt: *const u8,
    salt_len: usize,
    iterations: u32,
    out: *mut u8,
    out_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(p), Some(s)) = (unsafe { slice(pw, pw_len) }, unsafe {
            slice(salt, salt_len)
        }) else {
            return PcStatus::NullPointer;
        };
        if out.is_null() && out_len > 0 {
            return PcStatus::NullPointer;
        }
        if iterations == 0 {
            return PcStatus::Unsupported;
        }
        let buf = if out_len == 0 {
            &mut [][..]
        } else {
            unsafe { core::slice::from_raw_parts_mut(out, out_len) }
        };
        match hash {
            id::SHA256 => pbkdf2::<Sha256>(p, s, iterations, buf),
            id::SHA384 => pbkdf2::<Sha384>(p, s, iterations, buf),
            id::SHA512 => pbkdf2::<Sha512>(p, s, iterations, buf),
            _ => return PcStatus::Unsupported,
        }
        PcStatus::Ok
    })
}

/// scrypt (RFC 7914). `n` must be a power of two.
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_scrypt(
    pw: *const u8,
    pw_len: usize,
    salt: *const u8,
    salt_len: usize,
    n: u32,
    r: u32,
    p: u32,
    out: *mut u8,
    out_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(pw), Some(s)) = (unsafe { slice(pw, pw_len) }, unsafe {
            slice(salt, salt_len)
        }) else {
            return PcStatus::NullPointer;
        };
        if out.is_null() && out_len > 0 {
            return PcStatus::NullPointer;
        }
        if n == 0 || !n.is_power_of_two() {
            return PcStatus::Unsupported;
        }
        let log_n = n.trailing_zeros() as u8;
        let buf = if out_len == 0 {
            &mut [][..]
        } else {
            unsafe { core::slice::from_raw_parts_mut(out, out_len) }
        };
        match scrypt(pw, s, log_n, r, p, buf) {
            Ok(()) => PcStatus::Ok,
            Err(_) => {
                // The implementation may have written partial state into
                // `buf` before erroring; wipe so the caller does not see
                // a half-derived key in their output buffer.
                wipe(buf);
                PcStatus::Unsupported
            }
        }
    })
}

/// Argon2 (RFC 9106).
///
/// # Safety
/// All pointers valid for their lengths.
#[unsafe(no_mangle)]
pub unsafe extern "C" fn pc_argon2(
    variant: i32,
    pw: *const u8,
    pw_len: usize,
    salt: *const u8,
    salt_len: usize,
    t_cost: u32,
    m_cost: u32,
    parallelism: u32,
    out: *mut u8,
    out_len: usize,
) -> PcStatus {
    guard(|| {
        let (Some(pw), Some(s)) = (unsafe { slice(pw, pw_len) }, unsafe {
            slice(salt, salt_len)
        }) else {
            return PcStatus::NullPointer;
        };
        if out.is_null() && out_len > 0 {
            return PcStatus::NullPointer;
        }
        let variant = match variant {
            argon2_id::ARGON2I => Argon2Type::Argon2i,
            argon2_id::ARGON2D => Argon2Type::Argon2d,
            argon2_id::ARGON2ID => Argon2Type::Argon2id,
            _ => return PcStatus::Unsupported,
        };
        let params = Argon2Params {
            t_cost,
            m_cost_kib: m_cost,
            parallelism,
            variant,
            version: 0x13,
        };
        let buf = if out_len == 0 {
            &mut [][..]
        } else {
            unsafe { core::slice::from_raw_parts_mut(out, out_len) }
        };
        match argon2(&params, pw, s, &[], &[], buf) {
            Ok(()) => PcStatus::Ok,
            Err(_) => {
                // See the scrypt error path for rationale: wipe any
                // partial output before propagating.
                wipe(buf);
                PcStatus::Unsupported
            }
        }
    })
}