native_ossl/

pkey.rs

//! `Pkey<T>` — asymmetric key container and operations.
//!
//! Phase 5 delivers key loading/serialisation (5.1), keygen (5.2),
//! sign/verify (5.3), derive (5.4), asymmetric encrypt/decrypt (5.5),
//! and KEM encapsulate/decapsulate (5.6).
//!
//! # Type-state markers
//!
//! `Pkey<Private>`, `Pkey<Public>`, and `Pkey<Params>` statically prevent
//! misuse (e.g. signing with a public key).  `HasPrivate: HasPublic` means
//! every `Pkey<Private>` can also be used wherever `Pkey<Public>` is needed.

use crate::error::ErrorStack;
use crate::bio::{MemBio, MemBioBuf};
use native_ossl_sys as sys;
use std::marker::PhantomData;
use std::sync::Arc;

// ── Marker types and sealed trait hierarchy ───────────────────────────────────

/// Marker: key holds public key material only.
pub struct Public;
/// Marker: key holds public + private key material.
pub struct Private;
/// Marker: key holds PKEY parameters only (e.g. EC group with no key).
pub struct Params;

mod sealed {
    /// Sealed base: any key role.
    pub trait HasParams {}
    impl HasParams for super::Public {}
    impl HasParams for super::Private {}
    impl HasParams for super::Params {}

    /// Sealed: key has public material.
    pub trait HasPublic: HasParams {}
    impl HasPublic for super::Public {}
    impl HasPublic for super::Private {}

    /// Sealed: key has private material.
    pub trait HasPrivate: HasPublic {}
    impl HasPrivate for super::Private {}
}

/// All key markers satisfy this bound.
pub trait HasParams: sealed::HasParams {}
impl<T: sealed::HasParams> HasParams for T {}

/// Public key material is accessible (both `Public` and `Private` keys).
pub trait HasPublic: sealed::HasPublic {}
impl<T: sealed::HasPublic> HasPublic for T {}

/// Private key material is accessible.
pub trait HasPrivate: sealed::HasPrivate {}
impl<T: sealed::HasPrivate> HasPrivate for T {}

// ── Pkey<T> — key container ───────────────────────────────────────────────────

/// An asymmetric key (`EVP_PKEY*`) with a compile-time role marker.
///
/// Cloneable via `EVP_PKEY_up_ref`; wrapping in `Arc<Pkey<T>>` is safe.
pub struct Pkey<T> {
    ptr: *mut sys::EVP_PKEY,
    _role: PhantomData<T>,
}

// SAFETY: `EVP_PKEY` is reference-counted.
unsafe impl<T> Send for Pkey<T> {}
unsafe impl<T> Sync for Pkey<T> {}

impl<T> Clone for Pkey<T> {
    fn clone(&self) -> Self {
        unsafe { sys::EVP_PKEY_up_ref(self.ptr) };
        Pkey { ptr: self.ptr, _role: PhantomData }
    }
}

impl<T> Drop for Pkey<T> {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_free(self.ptr) };
    }
}

impl<T: HasParams> Pkey<T> {
    /// Construct from a raw (owned) `EVP_PKEY*`.
    ///
    /// # Safety
    ///
    /// `ptr` must be a valid, non-null `EVP_PKEY*` that the caller is giving up ownership of.
    #[must_use]
    pub unsafe fn from_ptr(ptr: *mut sys::EVP_PKEY) -> Self {
        Pkey { ptr, _role: PhantomData }
    }

    /// Raw `EVP_PKEY*` pointer valid for the lifetime of `self`.
    #[must_use]
    pub fn as_ptr(&self) -> *mut sys::EVP_PKEY {
        self.ptr
    }


    /// Size of the key in bits (e.g. 256 for P-256, 2048 for RSA-2048).
    #[must_use]
    pub fn bits(&self) -> u32 {
        u32::try_from(unsafe { sys::EVP_PKEY_get_bits(self.ptr) }).unwrap_or(0)
    }

    /// Security strength in bits (e.g. 128 for P-256, 112 for RSA-2048).
    #[must_use]
    pub fn security_bits(&self) -> u32 {
        u32::try_from(unsafe { sys::EVP_PKEY_get_security_bits(self.ptr) }).unwrap_or(0)
    }

    /// Return `true` if this key is of the named algorithm (e.g. `c"EC"`, `c"RSA"`).
    #[must_use]
    pub fn is_a(&self, name: &std::ffi::CStr) -> bool {
        unsafe { sys::EVP_PKEY_is_a(self.ptr, name.as_ptr()) == 1 }
    }

    /// Return `true` if this key's public component equals `other`'s.
    ///
    /// Wraps `EVP_PKEY_eq`.  Useful for verifying that a certificate's public
    /// key matches a private key before using them together.
    #[must_use]
    pub fn public_eq<U: HasPublic>(&self, other: &Pkey<U>) -> bool
    where
        T: HasPublic,
    {
        unsafe { sys::EVP_PKEY_eq(self.ptr, other.ptr) == 1 }
    }

    /// Fill the values for a pre-prepared mutable `Params` query array.
    ///
    /// Wraps `EVP_PKEY_get_params`.  The array must already contain the keys
    /// of interest with null data pointers; OpenSSL writes the values in place.
    ///
    /// # Errors
    pub fn get_params(&self, params: &mut crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_get_params(self.ptr, params.as_mut_ptr()))
    }

    /// DER-encode the public key (`SubjectPublicKeyInfo` format).
    ///
    /// Zero-copy: writes directly into a caller-owned `Vec<u8>` — no OpenSSL
    /// heap allocation occurs.
    ///
    /// # Errors
    ///
    /// Returns `Err` if serialisation fails.
    pub fn public_key_to_der(&self) -> Result<Vec<u8>, ErrorStack>
    where
        T: HasPublic,
    {
        // First call with null to query the DER byte length.
        let len = unsafe { sys::i2d_PUBKEY(self.ptr, std::ptr::null_mut()) };
        if len < 0 {
            return Err(ErrorStack::drain());
        }
        // Allocate our own buffer and write into it.
        // i2d_ advances the out-pointer; our Vec base address is unaffected.
        let mut buf = vec![0u8; usize::try_from(len).unwrap_or(0)];
        let mut out_ptr = buf.as_mut_ptr();
        let written = unsafe { sys::i2d_PUBKEY(self.ptr, std::ptr::addr_of_mut!(out_ptr)) };
        if written < 0 {
            return Err(ErrorStack::drain());
        }
        buf.truncate(usize::try_from(written).unwrap_or(0));
        Ok(buf)
    }
}

// ── PEM loading — private key ─────────────────────────────────────────────────

impl Pkey<Private> {
    /// Return the provider-side `keydata` pointer from the `EVP_PKEY` struct.
    ///
    /// This is the `void *keydata` field of `evp_pkey_st`.  It holds the
    /// algorithm-specific key material allocated by the provider's keymgmt
    /// implementation.  The pointer is valid for the lifetime of `self`.
    ///
    /// Only available with the `fips-provider` cargo feature.  Intended for
    /// use inside a FIPS provider when invoking `EVP_SIGNATURE` vtable functions
    /// that require `void *provkey` (= `keydata`).
    ///
    /// # Safety
    ///
    /// The returned pointer points into the internal state of this `Pkey`.
    /// It must not outlive `self` and must not be freed independently.
    /// The field offset is computed by the C compiler for the current target
    /// ABI via a build-time probe; see `native-ossl-sys/build.rs`.
    #[cfg(feature = "fips-provider")]
    pub unsafe fn keydata(&self) -> *mut std::ffi::c_void {
        // SAFETY: self.ptr is a valid non-null EVP_PKEY*.  We read the void* at
        // the ABI-correct byte offset of the `keydata` field in evp_pkey_st,
        // determined at build time by a C offsetof probe.
        self.ptr
            .cast::<u8>()
            .add(native_ossl_sys::fips_internal::EVP_PKEY_KEYDATA_OFFSET)
            .cast::<*mut std::ffi::c_void>()
            .read()
    }

    /// Load a private key from PEM bytes.
    ///
    /// Pass `passphrase = Some(cb)` for encrypted PEM; `None` for unencrypted.
    ///
    /// # Errors
    pub fn from_pem(pem: &[u8]) -> Result<Self, ErrorStack> {
        let bio = MemBioBuf::new(pem)?;
        let ptr = unsafe {
            sys::PEM_read_bio_PrivateKey(bio.as_ptr(), std::ptr::null_mut(), None, std::ptr::null_mut())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(ptr) })
    }

    /// Serialise the private key to PEM (`PKCS#8` `BEGIN PRIVATE KEY`).
    ///
    /// # Errors
    pub fn to_pem(&self) -> Result<Vec<u8>, ErrorStack> {
        let mut bio = MemBio::new()?;
        let rc = unsafe {
            sys::PEM_write_bio_PrivateKey(
                bio.as_ptr(),
                self.ptr,
                std::ptr::null(),
                std::ptr::null_mut(),
                0,
                None,
                std::ptr::null_mut(),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(bio.into_vec())
    }

    /// Load a private key from PEM bytes within a specific library context.
    ///
    /// Uses `PEM_read_bio_PrivateKey_ex` so the key's internal algorithm fetch
    /// uses `ctx`'s provider set.  Necessary when the private key is later used
    /// for EVP operations inside an isolated (e.g. FIPS) context.
    ///
    /// # Errors
    pub fn from_pem_in(ctx: &Arc<crate::lib_ctx::LibCtx>, pem: &[u8]) -> Result<Self, ErrorStack> {
        let bio = MemBioBuf::new(pem)?;
        let ptr = unsafe {
            sys::PEM_read_bio_PrivateKey_ex(
                bio.as_ptr(),
                std::ptr::null_mut(),
                None,
                std::ptr::null_mut(),
                ctx.as_ptr(),
                std::ptr::null(),
            )
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(ptr) })
    }

    /// Load a private key from DER bytes (auto-detecting `PKCS#8` / traditional).
    ///
    /// Zero-copy: the `EVP_PKEY` is decoded from the caller's slice without copying.
    ///
    /// # Errors
    pub fn from_der(der: &[u8]) -> Result<Self, ErrorStack> {
        let bio = MemBioBuf::new(der)?;
        let ptr = unsafe { sys::d2i_PrivateKey_bio(bio.as_ptr(), std::ptr::null_mut()) };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(ptr) })
    }
}

// ── PEM loading — public key ──────────────────────────────────────────────────

impl Pkey<Public> {
    /// Load a public key from PEM (`SubjectPublicKeyInfo` or RSA public key).
    ///
    /// # Errors
    pub fn from_pem(pem: &[u8]) -> Result<Self, ErrorStack> {
        let bio = MemBioBuf::new(pem)?;
        let ptr = unsafe {
            sys::PEM_read_bio_PUBKEY(bio.as_ptr(), std::ptr::null_mut(), None, std::ptr::null_mut())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(ptr) })
    }

    /// Load a public key from PEM bytes within a specific library context.
    ///
    /// Uses `PEM_read_bio_PUBKEY_ex` so the key's internal algorithm fetch
    /// uses `ctx`'s provider set.  Necessary when the public key is later used
    /// for EVP operations inside an isolated (e.g. FIPS) context.
    ///
    /// # Errors
    pub fn from_pem_in(ctx: &Arc<crate::lib_ctx::LibCtx>, pem: &[u8]) -> Result<Self, ErrorStack> {
        let bio = MemBioBuf::new(pem)?;
        let ptr = unsafe {
            sys::PEM_read_bio_PUBKEY_ex(
                bio.as_ptr(),
                std::ptr::null_mut(),
                None,
                std::ptr::null_mut(),
                ctx.as_ptr(),
                std::ptr::null(),
            )
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(ptr) })
    }

    /// Load a public key from DER (`SubjectPublicKeyInfo`).
    ///
    /// # Errors
    pub fn from_der(der: &[u8]) -> Result<Self, ErrorStack> {
        let bio = MemBioBuf::new(der)?;
        let ptr = unsafe { sys::d2i_PUBKEY_bio(bio.as_ptr(), std::ptr::null_mut()) };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(ptr) })
    }

    /// Serialise the public key to PEM.
    ///
    /// # Errors
    pub fn to_pem(&self) -> Result<Vec<u8>, ErrorStack> {
        let mut bio = MemBio::new()?;
        let rc = unsafe { sys::PEM_write_bio_PUBKEY(bio.as_ptr(), self.ptr) };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(bio.into_vec())
    }
}

// Upcast: every `Pkey<Private>` can be viewed as `Pkey<Public>`.
impl From<Pkey<Private>> for Pkey<Public> {
    fn from(k: Pkey<Private>) -> Self {
        unsafe { sys::EVP_PKEY_up_ref(k.ptr) };
        Pkey { ptr: k.ptr, _role: PhantomData }
    }
}

// ── Key import from OSSL_PARAM ────────────────────────────────────────────────

// EVP_PKEY_fromdata / EVP_PKEY_todata selection constants.
const PKEY_PUBLIC_KEY: i32 = 2;
const PKEY_KEYPAIR: i32 = 3;

/// Shared implementation for `EVP_PKEY_fromdata`.
fn pkey_fromdata(
    ctx: Option<&Arc<crate::lib_ctx::LibCtx>>,
    pkey_type: &std::ffi::CStr,
    params: &crate::params::Params<'_>,
    selection: i32,
) -> Result<*mut sys::EVP_PKEY, ErrorStack> {
    let libctx = ctx.map_or(std::ptr::null_mut(), |c| c.as_ptr());
    let pctx = unsafe {
        sys::EVP_PKEY_CTX_new_from_name(libctx, pkey_type.as_ptr(), std::ptr::null())
    };
    if pctx.is_null() {
        return Err(ErrorStack::drain());
    }
    let rc = unsafe { sys::EVP_PKEY_fromdata_init(pctx) };
    if rc != 1 {
        unsafe { sys::EVP_PKEY_CTX_free(pctx) };
        return Err(ErrorStack::drain());
    }
    let mut pkey: *mut sys::EVP_PKEY = std::ptr::null_mut();
    let rc = unsafe {
        sys::EVP_PKEY_fromdata(
            pctx,
            std::ptr::addr_of_mut!(pkey),
            selection,
            // OSSL_PARAM array is read-only during fromdata; cast is safe.
            params.as_ptr().cast_mut(),
        )
    };
    unsafe { sys::EVP_PKEY_CTX_free(pctx) };
    if rc != 1 || pkey.is_null() {
        return Err(ErrorStack::drain());
    }
    Ok(pkey)
}

/// Shared implementation for `EVP_PKEY_todata`.
fn pkey_todata(
    ptr: *mut sys::EVP_PKEY,
    selection: i32,
) -> Result<crate::params::Params<'static>, ErrorStack> {
    let mut out: *mut sys::OSSL_PARAM = std::ptr::null_mut();
    let rc = unsafe { sys::EVP_PKEY_todata(ptr, selection, std::ptr::addr_of_mut!(out)) };
    if rc != 1 || out.is_null() {
        return Err(ErrorStack::drain());
    }
    // SAFETY: `out` is a freshly allocated OSSL_PARAM array from OpenSSL;
    // Params takes ownership and will free it via OSSL_PARAM_free on drop.
    Ok(unsafe { crate::params::Params::from_owned_ptr(out) })
}

impl Pkey<Private> {
    /// Import a private key pair from an `OSSL_PARAM` array.
    ///
    /// Equivalent to `EVP_PKEY_fromdata` with `EVP_PKEY_KEYPAIR` selection.
    /// Pass `ctx = None` to use the global default library context.
    ///
    /// # Errors
    pub fn from_params(
        ctx: Option<&Arc<crate::lib_ctx::LibCtx>>,
        pkey_type: &std::ffi::CStr,
        params: &crate::params::Params<'_>,
    ) -> Result<Self, ErrorStack> {
        pkey_fromdata(ctx, pkey_type, params, PKEY_KEYPAIR)
            .map(|ptr| unsafe { Pkey::from_ptr(ptr) })
    }

    /// Export all key parameters (private + public) as an owned `OSSL_PARAM` array.
    ///
    /// Uses `EVP_PKEY_KEYPAIR` selection so both private and public material
    /// are included in the returned array.
    ///
    /// # Errors
    pub fn export(&self) -> Result<crate::params::Params<'static>, ErrorStack> {
        pkey_todata(self.ptr, PKEY_KEYPAIR)
    }
}

impl Pkey<Public> {
    /// Import a public key from an `OSSL_PARAM` array.
    ///
    /// Equivalent to `EVP_PKEY_fromdata` with `EVP_PKEY_PUBLIC_KEY` selection.
    /// Pass `ctx = None` to use the global default library context.
    ///
    /// # Errors
    pub fn from_params(
        ctx: Option<&Arc<crate::lib_ctx::LibCtx>>,
        pkey_type: &std::ffi::CStr,
        params: &crate::params::Params<'_>,
    ) -> Result<Self, ErrorStack> {
        pkey_fromdata(ctx, pkey_type, params, PKEY_PUBLIC_KEY)
            .map(|ptr| unsafe { Pkey::from_ptr(ptr) })
    }

    /// Export the public key parameters as an owned `OSSL_PARAM` array.
    ///
    /// Uses `EVP_PKEY_PUBLIC_KEY` selection.
    ///
    /// # Errors
    pub fn export(&self) -> Result<crate::params::Params<'static>, ErrorStack> {
        pkey_todata(self.ptr, PKEY_PUBLIC_KEY)
    }
}

// ── KeygenCtx — key generation ────────────────────────────────────────────────

/// Context for generating asymmetric key pairs (`EVP_PKEY_CTX` in keygen mode).
pub struct KeygenCtx {
    ptr: *mut sys::EVP_PKEY_CTX,
}

impl KeygenCtx {
    /// Create a keygen context for the named algorithm.
    ///
    /// Common names: `c"RSA"`, `c"EC"`, `c"ED25519"`, `c"X25519"`.
    ///
    /// # Errors
    pub fn new(name: &std::ffi::CStr) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_name(std::ptr::null_mut(), name.as_ptr(), std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        let rc = unsafe { sys::EVP_PKEY_keygen_init(ptr) };
        if rc != 1 {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            return Err(ErrorStack::drain());
        }
        Ok(KeygenCtx { ptr })
    }

    /// Configure parameters before calling `generate`.
    ///
    /// # Errors
    pub fn set_params(&mut self, params: &crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(self.ptr, params.as_ptr()))
    }

    /// Generate a key pair.
    ///
    /// # Errors
    pub fn generate(&mut self) -> Result<Pkey<Private>, ErrorStack> {
        let mut key: *mut sys::EVP_PKEY = std::ptr::null_mut();
        crate::ossl_call!(sys::EVP_PKEY_keygen(self.ptr, std::ptr::addr_of_mut!(key)))?;
        if key.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(unsafe { Pkey::from_ptr(key) })
    }
}

impl Drop for KeygenCtx {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ptr) };
    }
}

// ── Signer — streaming DigestSign ─────────────────────────────────────────────

/// Parameters for creating a [`Signer`] or [`Verifier`].
#[derive(Default)]
pub struct SignInit<'a> {
    /// Digest algorithm, or `None` for pre-hashed / `EdDSA` one-shot mode.
    pub digest: Option<&'a crate::digest::DigestAlg>,
    /// Optional parameters (e.g. RSA PSS salt length).
    pub params: Option<&'a crate::params::Params<'a>>,
}

/// Streaming `DigestSign` context.
///
/// Call `update` zero or more times, then `finish` to produce the signature.
pub struct Signer {
    ctx: crate::digest::DigestCtx,
    /// The key is kept alive for the duration of the signer.
    _key: Pkey<Private>,
}

impl Signer {
    /// Create a signer.
    ///
    /// # Errors
    pub fn new(key: &Pkey<Private>, init: &SignInit<'_>) -> Result<Self, ErrorStack> {
        let ctx = alloc_digest_ctx()?;
        // Resolve digest name for EVP_DigestSignInit_ex (NULL for Ed25519/one-shot).
        let md_name_ptr = if let Some(d) = init.digest {
            let p = unsafe { sys::OBJ_nid2sn(d.nid()) };
            if p.is_null() {
                return Err(ErrorStack::drain());
            }
            p
        } else {
            std::ptr::null()
        };
        let params_ptr = init.params.map_or(crate::params::null_params(), crate::params::Params::as_ptr);
        let rc = unsafe {
            sys::EVP_DigestSignInit_ex(
                ctx.as_ptr(),
                std::ptr::null_mut(),
                md_name_ptr,
                std::ptr::null_mut(),
                std::ptr::null(),
                key.ptr,
                params_ptr,
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(Signer { ctx, _key: key.clone() })
    }

    /// Feed data into the hash.
    ///
    /// # Errors
    pub fn update(&mut self, data: &[u8]) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_DigestSignUpdate(self.ctx.as_ptr(), data.as_ptr().cast(), data.len()))
    }

    /// Finalise and return the signature.
    ///
    /// Not supported by pure one-shot algorithms such as Ed25519 — use
    /// [`sign_oneshot`](Self::sign_oneshot) for those.
    ///
    /// # Errors
    pub fn finish(&mut self) -> Result<Vec<u8>, ErrorStack> {
        // First call with null buf to get the required size.
        let mut siglen: usize = 0;
        let rc = unsafe {
            sys::EVP_DigestSignFinal(
                self.ctx.as_ptr(),
                std::ptr::null_mut(),
                std::ptr::addr_of_mut!(siglen),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        let mut sig = vec![0u8; siglen];
        let rc = unsafe {
            sys::EVP_DigestSignFinal(
                self.ctx.as_ptr(),
                sig.as_mut_ptr(),
                std::ptr::addr_of_mut!(siglen),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        sig.truncate(siglen);
        Ok(sig)
    }

    /// One-shot sign over `data`.
    ///
    /// Required for algorithms that do not support streaming (Ed25519, Ed448).
    /// For algorithms that do support streaming, prefer `update` + `finish`.
    ///
    /// # Errors
    pub fn sign_oneshot(&mut self, data: &[u8]) -> Result<Vec<u8>, ErrorStack> {
        // First call: query the required signature length.
        let mut siglen: usize = 0;
        let rc = unsafe {
            sys::EVP_DigestSign(
                self.ctx.as_ptr(),
                std::ptr::null_mut(),
                std::ptr::addr_of_mut!(siglen),
                data.as_ptr(),
                data.len(),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        let mut sig = vec![0u8; siglen];
        let rc = unsafe {
            sys::EVP_DigestSign(
                self.ctx.as_ptr(),
                sig.as_mut_ptr(),
                std::ptr::addr_of_mut!(siglen),
                data.as_ptr(),
                data.len(),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        sig.truncate(siglen);
        Ok(sig)
    }
}

// ── Verifier — streaming DigestVerify ─────────────────────────────────────────

/// Streaming `DigestVerify` context.
pub struct Verifier {
    ctx: crate::digest::DigestCtx,
    _key: Pkey<Public>,
}

impl Verifier {
    /// Create a verifier.
    ///
    /// # Errors
    pub fn new(key: &Pkey<Public>, init: &SignInit<'_>) -> Result<Self, ErrorStack> {
        let ctx = alloc_digest_ctx()?;
        // Resolve digest name for EVP_DigestVerifyInit_ex (NULL for Ed25519/one-shot).
        let md_name_ptr = if let Some(d) = init.digest {
            let p = unsafe { sys::OBJ_nid2sn(d.nid()) };
            if p.is_null() {
                return Err(ErrorStack::drain());
            }
            p
        } else {
            std::ptr::null()
        };
        let params_ptr = init.params.map_or(crate::params::null_params(), crate::params::Params::as_ptr);
        let rc = unsafe {
            sys::EVP_DigestVerifyInit_ex(
                ctx.as_ptr(),
                std::ptr::null_mut(),
                md_name_ptr,
                std::ptr::null_mut(),
                std::ptr::null(),
                key.ptr,
                params_ptr,
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(Verifier { ctx, _key: key.clone() })
    }

    /// Feed data into the hash.
    ///
    /// # Errors
    pub fn update(&mut self, data: &[u8]) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_DigestVerifyUpdate(self.ctx.as_ptr(), data.as_ptr().cast(), data.len()))
    }

    /// Verify `signature` against all data fed via `update`.
    ///
    /// Returns `Ok(true)` if valid, `Ok(false)` if the signature is incorrect,
    /// or `Err` on a fatal OpenSSL error.
    ///
    /// Not supported by pure one-shot algorithms such as Ed25519 — use
    /// [`verify_oneshot`](Self::verify_oneshot) for those.
    ///
    /// # Errors
    pub fn verify(&mut self, signature: &[u8]) -> Result<bool, ErrorStack> {
        let rc = unsafe {
            sys::EVP_DigestVerifyFinal(
                self.ctx.as_ptr(),
                signature.as_ptr(),
                signature.len(),
            )
        };
        match rc {
            1 => Ok(true),
            0 => Ok(false),
            _ => Err(ErrorStack::drain()),
        }
    }

    /// One-shot verify `signature` over `data`.
    ///
    /// Required for algorithms that do not support streaming (Ed25519, Ed448).
    ///
    /// # Errors
    pub fn verify_oneshot(&mut self, data: &[u8], signature: &[u8]) -> Result<bool, ErrorStack> {
        let rc = unsafe {
            sys::EVP_DigestVerify(
                self.ctx.as_ptr(),
                signature.as_ptr(),
                signature.len(),
                data.as_ptr(),
                data.len(),
            )
        };
        match rc {
            1 => Ok(true),
            0 => Ok(false),
            _ => Err(ErrorStack::drain()),
        }
    }
}

// ── Internal helper: allocate an EVP_MD_CTX for DigestSign/Verify ─────────────

/// Allocate a fresh, algorithm-unbound `EVP_MD_CTX` for use with
/// `EVP_DigestSign*Init_ex` / `EVP_DigestVerify*Init_ex`.
fn alloc_digest_ctx() -> Result<crate::digest::DigestCtx, ErrorStack> {
    let ctx_ptr = unsafe { sys::EVP_MD_CTX_new() };
    if ctx_ptr.is_null() {
        return Err(ErrorStack::drain());
    }
    // SAFETY: DigestCtx takes ownership; ptr is valid and non-null.
    Ok(unsafe { crate::digest::DigestCtx::from_ptr(ctx_ptr) })
}

// ── DeriveCtx — ECDH / DH key agreement ──────────────────────────────────────

/// Asymmetric key-agreement context (`EVP_PKEY_CTX` in derive mode).
pub struct DeriveCtx {
    ptr: *mut sys::EVP_PKEY_CTX,
}

impl DeriveCtx {
    /// Create a derive context from a private key.
    ///
    /// # Errors
    pub fn new(key: &Pkey<Private>) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_derive_init(ptr)).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        Ok(DeriveCtx { ptr })
    }

    /// Set the peer's public key.
    ///
    /// # Errors
    pub fn set_peer(&mut self, peer: &Pkey<Public>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_derive_set_peer(self.ptr, peer.ptr))
    }

    /// Derive the shared secret into `out`.
    ///
    /// Returns the number of bytes written.
    ///
    /// # Errors
    pub fn derive(&mut self, out: &mut [u8]) -> Result<usize, ErrorStack> {
        let mut len = out.len();
        crate::ossl_call!(sys::EVP_PKEY_derive(
            self.ptr,
            out.as_mut_ptr(),
            std::ptr::addr_of_mut!(len)
        ))?;
        Ok(len)
    }

    /// Query the required output length (call with empty slice).
    ///
    /// # Errors
    pub fn derive_len(&mut self) -> Result<usize, ErrorStack> {
        let mut len: usize = 0;
        crate::ossl_call!(sys::EVP_PKEY_derive(
            self.ptr,
            std::ptr::null_mut(),
            std::ptr::addr_of_mut!(len)
        ))?;
        Ok(len)
    }
}

impl Drop for DeriveCtx {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ptr) };
    }
}

// ── PkeyEncryptCtx / PkeyDecryptCtx ──────────────────────────────────────────

/// RSA asymmetric encryption context.
pub struct PkeyEncryptCtx {
    ptr: *mut sys::EVP_PKEY_CTX,
}

impl PkeyEncryptCtx {
    /// Create an encryption context from a public key.
    ///
    /// `params` is applied immediately after init if `Some`.  Typical use:
    /// ```ignore
    /// let oaep = ParamBuilder::new()?.push_utf8_string(c"pad-mode", c"oaep")?.build()?;
    /// let ctx = PkeyEncryptCtx::new(&pub_key, Some(&oaep))?;
    /// ```
    ///
    /// # Errors
    pub fn new(key: &Pkey<Public>, params: Option<&crate::params::Params<'_>>) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_encrypt_init(ptr)).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        let ctx = PkeyEncryptCtx { ptr };
        if let Some(p) = params {
            crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(ctx.ptr, p.as_ptr()))
                .map_err(|e| { unsafe { sys::EVP_PKEY_CTX_free(ptr) }; e })?;
        }
        Ok(ctx)
    }

    /// Configure parameters (e.g. RSA padding mode).
    ///
    /// # Errors
    pub fn set_params(&mut self, params: &crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(self.ptr, params.as_ptr()))
    }

    /// Encrypt `plaintext` into `ciphertext`.
    ///
    /// Returns the number of bytes written.
    ///
    /// # Errors
    pub fn encrypt(&mut self, plaintext: &[u8], ciphertext: &mut [u8]) -> Result<usize, ErrorStack> {
        let mut outlen = ciphertext.len();
        crate::ossl_call!(sys::EVP_PKEY_encrypt(
            self.ptr,
            ciphertext.as_mut_ptr(),
            std::ptr::addr_of_mut!(outlen),
            plaintext.as_ptr(),
            plaintext.len()
        ))?;
        Ok(outlen)
    }

    /// Query the ciphertext length for a given plaintext length.
    ///
    /// # Errors
    pub fn encrypt_len(&mut self, plaintext_len: usize) -> Result<usize, ErrorStack> {
        let mut outlen: usize = 0;
        crate::ossl_call!(sys::EVP_PKEY_encrypt(
            self.ptr,
            std::ptr::null_mut(),
            std::ptr::addr_of_mut!(outlen),
            std::ptr::null(),
            plaintext_len
        ))?;
        Ok(outlen)
    }
}

impl Drop for PkeyEncryptCtx {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ptr) };
    }
}

/// RSA asymmetric decryption context.
pub struct PkeyDecryptCtx {
    ptr: *mut sys::EVP_PKEY_CTX,
}

impl PkeyDecryptCtx {
    /// Create a decryption context from a private key.
    ///
    /// `params` is applied immediately after init if `Some`.
    ///
    /// # Errors
    pub fn new(key: &Pkey<Private>, params: Option<&crate::params::Params<'_>>) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_decrypt_init(ptr)).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        let ctx = PkeyDecryptCtx { ptr };
        if let Some(p) = params {
            crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(ctx.ptr, p.as_ptr()))
                .map_err(|e| { unsafe { sys::EVP_PKEY_CTX_free(ptr) }; e })?;
        }
        Ok(ctx)
    }

    /// Configure parameters.
    ///
    /// # Errors
    pub fn set_params(&mut self, params: &crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(self.ptr, params.as_ptr()))
    }

    /// Decrypt `ciphertext` into `plaintext`.
    ///
    /// Returns the number of bytes written.
    ///
    /// # Errors
    pub fn decrypt(&mut self, ciphertext: &[u8], plaintext: &mut [u8]) -> Result<usize, ErrorStack> {
        let mut outlen = plaintext.len();
        crate::ossl_call!(sys::EVP_PKEY_decrypt(
            self.ptr,
            plaintext.as_mut_ptr(),
            std::ptr::addr_of_mut!(outlen),
            ciphertext.as_ptr(),
            ciphertext.len()
        ))?;
        Ok(outlen)
    }
}

impl Drop for PkeyDecryptCtx {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ptr) };
    }
}

// ── EncapCtx / DecapCtx — KEM (OpenSSL 3.2+) ────────────────────────────────

/// KEM encapsulation output.
#[cfg(ossl320)]
pub struct EncapResult {
    /// Wrapped key (encoded shared secret).
    pub wrapped_key: Vec<u8>,
    /// Shared secret (plaintext).
    pub shared_secret: Vec<u8>,
}

/// KEM encapsulation context (recipient's public key).
#[cfg(ossl320)]
pub struct EncapCtx {
    ptr: *mut sys::EVP_PKEY_CTX,
}

#[cfg(ossl320)]
impl EncapCtx {
    /// Create a KEM encapsulation context from the recipient's public key.
    ///
    /// # Errors
    pub fn new(key: &Pkey<Public>) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_encapsulate_init(ptr, std::ptr::null())).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        Ok(EncapCtx { ptr })
    }

    /// Perform encapsulation, returning the wrapped key and shared secret.
    ///
    /// # Errors
    pub fn encapsulate(&mut self) -> Result<EncapResult, ErrorStack> {
        let mut wkeylen: usize = 0;
        let mut sslen: usize = 0;
        // Query lengths first.
        let rc = unsafe {
            sys::EVP_PKEY_encapsulate(
                self.ptr,
                std::ptr::null_mut(),
                std::ptr::addr_of_mut!(wkeylen),
                std::ptr::null_mut(),
                std::ptr::addr_of_mut!(sslen),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        let mut wrapped_key = vec![0u8; wkeylen];
        let mut shared_secret = vec![0u8; sslen];
        crate::ossl_call!(sys::EVP_PKEY_encapsulate(
            self.ptr,
            wrapped_key.as_mut_ptr(),
            std::ptr::addr_of_mut!(wkeylen),
            shared_secret.as_mut_ptr(),
            std::ptr::addr_of_mut!(sslen)
        ))?;
        wrapped_key.truncate(wkeylen);
        shared_secret.truncate(sslen);
        Ok(EncapResult { wrapped_key, shared_secret })
    }
}

#[cfg(ossl320)]
impl Drop for EncapCtx {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ptr) };
    }
}

/// KEM decapsulation context (recipient's private key).
#[cfg(ossl320)]
pub struct DecapCtx {
    ptr: *mut sys::EVP_PKEY_CTX,
}

#[cfg(ossl320)]
impl DecapCtx {
    /// Create a KEM decapsulation context from the recipient's private key.
    ///
    /// # Errors
    pub fn new(key: &Pkey<Private>) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_decapsulate_init(ptr, std::ptr::null())).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        Ok(DecapCtx { ptr })
    }

    /// Recover the shared secret from a wrapped key.
    ///
    /// # Errors
    pub fn decapsulate(&mut self, wrapped_key: &[u8]) -> Result<Vec<u8>, ErrorStack> {
        let mut sslen: usize = 0;
        // Query output length.
        let rc = unsafe {
            sys::EVP_PKEY_decapsulate(
                self.ptr,
                std::ptr::null_mut(),
                std::ptr::addr_of_mut!(sslen),
                wrapped_key.as_ptr(),
                wrapped_key.len(),
            )
        };
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        let mut ss = vec![0u8; sslen];
        crate::ossl_call!(sys::EVP_PKEY_decapsulate(
            self.ptr,
            ss.as_mut_ptr(),
            std::ptr::addr_of_mut!(sslen),
            wrapped_key.as_ptr(),
            wrapped_key.len()
        ))?;
        ss.truncate(sslen);
        Ok(ss)
    }
}

#[cfg(ossl320)]
impl Drop for DecapCtx {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ptr) };
    }
}

// ── RawSigner — pre-hashed / no-digest signing ───────────────────────────────

/// Raw (no-digest) signing context wrapping `EVP_PKEY_CTX` after `EVP_PKEY_sign_init`.
///
/// Use this for algorithms where the caller has already hashed the data, such
/// as raw ECDSA (data is the hash) or raw RSA with explicit padding.  For
/// algorithms that hash internally, use [`Signer`] or [`MessageSigner`].
///
/// The context is reusable: after a successful [`sign`](Self::sign) call the
/// init state is preserved, so the same padding parameters apply to further
/// sign calls with the same key.
pub struct RawSigner {
    ctx: *mut sys::EVP_PKEY_CTX,
}

// SAFETY: EVP_PKEY_CTX is not thread-safe on a shared pointer, but
// RawSigner owns its ctx exclusively and &mut self enforces single-caller.
unsafe impl Send for RawSigner {}

impl RawSigner {
    /// Create and initialise a sign context (`EVP_PKEY_CTX_new_from_pkey` +
    /// `EVP_PKEY_sign_init`).
    ///
    /// Pass `libctx = Some(ctx)` to restrict provider lookup to that library
    /// context; `None` uses the key's own library context.
    ///
    /// # Errors
    pub fn new(
        key: &Pkey<Private>,
        libctx: Option<&Arc<crate::lib_ctx::LibCtx>>,
    ) -> Result<Self, ErrorStack> {
        let lctx = libctx.map_or(std::ptr::null_mut(), |c| c.as_ptr());
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(lctx, key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_sign_init(ptr)).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        Ok(RawSigner { ctx: ptr })
    }

    /// Apply parameters after init (e.g. RSA padding mode, salt length).
    ///
    /// # Errors
    pub fn set_params(&mut self, params: &crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(self.ctx, params.as_ptr()))
    }

    /// Query the signature output size for the given input length.
    ///
    /// Calls `EVP_PKEY_sign` with a null output pointer — does not consume
    /// the signing state.
    ///
    /// # Errors
    pub fn sign_len(&mut self, tbs_len: usize) -> Result<usize, ErrorStack> {
        let mut siglen: usize = 0;
        crate::ossl_call!(sys::EVP_PKEY_sign(
            self.ctx,
            std::ptr::null_mut(),
            std::ptr::addr_of_mut!(siglen),
            std::ptr::null(),
            tbs_len,
        ))?;
        Ok(siglen)
    }

    /// Sign pre-hashed data into `sig`.  Returns the number of bytes written.
    ///
    /// `sig.len()` must be >= `sign_len(tbs.len())`.
    ///
    /// # Errors
    pub fn sign(&mut self, tbs: &[u8], sig: &mut [u8]) -> Result<usize, ErrorStack> {
        let mut siglen = sig.len();
        crate::ossl_call!(sys::EVP_PKEY_sign(
            self.ctx,
            sig.as_mut_ptr(),
            std::ptr::addr_of_mut!(siglen),
            tbs.as_ptr(),
            tbs.len(),
        ))?;
        Ok(siglen)
    }

    /// Sign pre-hashed data, allocating the output buffer.
    ///
    /// Convenience wrapper around [`sign_len`](Self::sign_len) + [`sign`](Self::sign).
    ///
    /// # Errors
    pub fn sign_alloc(&mut self, tbs: &[u8]) -> Result<Vec<u8>, ErrorStack> {
        let siglen = self.sign_len(tbs.len())?;
        let mut sig = vec![0u8; siglen];
        let written = self.sign(tbs, &mut sig)?;
        sig.truncate(written);
        Ok(sig)
    }
}

impl Drop for RawSigner {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ctx) };
    }
}

// ── RawVerifier — pre-hashed / no-digest verification ────────────────────────

/// Raw (no-digest) verification context wrapping `EVP_PKEY_CTX` after
/// `EVP_PKEY_verify_init`.
///
/// Mirror of [`RawSigner`] for the verification side.
pub struct RawVerifier {
    ctx: *mut sys::EVP_PKEY_CTX,
}

unsafe impl Send for RawVerifier {}

impl RawVerifier {
    /// Create and initialise a verify context.
    ///
    /// # Errors
    pub fn new<T: HasPublic>(
        key: &Pkey<T>,
        libctx: Option<&Arc<crate::lib_ctx::LibCtx>>,
    ) -> Result<Self, ErrorStack> {
        let lctx = libctx.map_or(std::ptr::null_mut(), |c| c.as_ptr());
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(lctx, key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        crate::ossl_call!(sys::EVP_PKEY_verify_init(ptr)).map_err(|e| {
            unsafe { sys::EVP_PKEY_CTX_free(ptr) };
            e
        })?;
        Ok(RawVerifier { ctx: ptr })
    }

    /// Apply parameters after init (e.g. RSA padding mode).
    ///
    /// # Errors
    pub fn set_params(&mut self, params: &crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(self.ctx, params.as_ptr()))
    }

    /// Verify `sig` against pre-hashed `tbs`.  Returns `Ok(())` if valid.
    ///
    /// # Errors
    ///
    /// Returns `Err` if the signature is invalid or on any OpenSSL error.
    pub fn verify(&mut self, tbs: &[u8], sig: &[u8]) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_verify(
            self.ctx,
            sig.as_ptr(),
            sig.len(),
            tbs.as_ptr(),
            tbs.len(),
        ))
    }
}

impl Drop for RawVerifier {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ctx) };
    }
}

// ── SigAlg — EVP_SIGNATURE algorithm descriptor (OpenSSL 3.2+) ──────────────

/// Algorithm descriptor for `EVP_SIGNATURE` (OpenSSL 3.2+).
///
/// Mirrors `DigestAlg` / `CipherAlg` / `MacAlg` in naming and lifecycle.
/// Used with [`MessageSigner`] and [`MessageVerifier`] for algorithms such
/// as ML-DSA, SLH-DSA, and Ed25519/Ed448 with context strings.
#[cfg(ossl320)]
pub struct SigAlg {
    ptr: *mut sys::EVP_SIGNATURE,
}

// SAFETY: EVP_SIGNATURE is reference-counted.
#[cfg(ossl320)]
unsafe impl Send for SigAlg {}
#[cfg(ossl320)]
unsafe impl Sync for SigAlg {}

#[cfg(ossl320)]
impl SigAlg {
    /// Fetch an `EVP_SIGNATURE` by name from the default library context.
    ///
    /// Example names: `c"ML-DSA-44"`, `c"ED25519"`, `c"SLH-DSA-SHA2-128s"`.
    ///
    /// # Errors
    pub fn fetch(name: &std::ffi::CStr, props: Option<&std::ffi::CStr>) -> Result<Self, ErrorStack> {
        let props_ptr = props.map_or(std::ptr::null(), |p| p.as_ptr());
        let ptr = unsafe {
            sys::EVP_SIGNATURE_fetch(std::ptr::null_mut(), name.as_ptr(), props_ptr)
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(SigAlg { ptr })
    }

    /// Fetch an `EVP_SIGNATURE` by name within a specific library context.
    ///
    /// # Errors
    pub fn fetch_in(
        ctx: &Arc<crate::lib_ctx::LibCtx>,
        name: &std::ffi::CStr,
        props: Option<&std::ffi::CStr>,
    ) -> Result<Self, ErrorStack> {
        let props_ptr = props.map_or(std::ptr::null(), |p| p.as_ptr());
        let ptr = unsafe {
            sys::EVP_SIGNATURE_fetch(ctx.as_ptr(), name.as_ptr(), props_ptr)
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        Ok(SigAlg { ptr })
    }
}

#[cfg(ossl320)]
impl Clone for SigAlg {
    fn clone(&self) -> Self {
        unsafe { sys::EVP_SIGNATURE_up_ref(self.ptr) };
        SigAlg { ptr: self.ptr }
    }
}

#[cfg(ossl320)]
impl Drop for SigAlg {
    fn drop(&mut self) {
        unsafe { sys::EVP_SIGNATURE_free(self.ptr) };
    }
}

// ── MessageSigner — EVP_PKEY_sign_message_* streaming sign (OpenSSL 3.2+) ────

/// Stateful signing context using `EVP_PKEY_sign_message_*` (OpenSSL 3.2+).
///
/// Used for algorithms that do not use a separate internal digest (`ML-DSA`,
/// `SLH-DSA`, `Ed25519` with context strings).  Unlike [`Signer`], the
/// algorithm is specified as a [`SigAlg`] rather than a digest name.
///
/// Call [`update`](Self::update) zero or more times (if the algorithm supports
/// streaming — check with [`supports_streaming`](Self::supports_streaming)),
/// then [`finish`](Self::finish) to produce the signature.  For algorithms
/// that only support one-shot operation, use [`sign_oneshot`](Self::sign_oneshot).
#[cfg(ossl320)]
pub struct MessageSigner {
    ctx: *mut sys::EVP_PKEY_CTX,
}

#[cfg(ossl320)]
unsafe impl Send for MessageSigner {}

#[cfg(ossl320)]
impl MessageSigner {
    /// Create and initialise a message-sign context.
    ///
    /// `alg` is consumed by the init call; pass a clone if you need to reuse it.
    /// `params` sets algorithm-specific options (e.g. context string for Ed25519).
    ///
    /// # Errors
    pub fn new(
        key: &Pkey<Private>,
        alg: &mut SigAlg,
        params: Option<&crate::params::Params<'_>>,
    ) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        let params_ptr = params.map_or(crate::params::null_params(), crate::params::Params::as_ptr);
        crate::ossl_call!(sys::EVP_PKEY_sign_message_init(ptr, alg.ptr, params_ptr))
            .map_err(|e| {
                unsafe { sys::EVP_PKEY_CTX_free(ptr) };
                e
            })?;
        Ok(MessageSigner { ctx: ptr })
    }

    /// Probe whether this algorithm backend supports incremental `update` calls.
    ///
    /// Calls `EVP_PKEY_sign_message_update` with an empty input, bracketed by
    /// `ERR_set_mark` / `ERR_pop_to_mark` so that a failure does not leave
    /// entries on the error queue.  Returns `true` if streaming is supported.
    ///
    /// If this returns `false`, use [`sign_oneshot`](Self::sign_oneshot) instead.
    pub fn supports_streaming(&mut self) -> bool {
        // Probe: feed 0 bytes and see if the algorithm accepts it.
        // ERR mark/pop ensures the error queue is clean regardless of outcome.
        unsafe { sys::ERR_set_mark() };
        let probe: [u8; 0] = [];
        let rc = unsafe {
            sys::EVP_PKEY_sign_message_update(self.ctx, probe.as_ptr(), 0)
        };
        unsafe { sys::ERR_pop_to_mark() };
        rc == 1
    }

    /// Feed `data` into the signing operation.
    ///
    /// Returns `Err` if the algorithm does not support streaming — use
    /// [`sign_oneshot`](Self::sign_oneshot) in that case.
    ///
    /// # Errors
    pub fn update(&mut self, data: &[u8]) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_sign_message_update(
            self.ctx,
            data.as_ptr(),
            data.len(),
        ))
    }

    /// Query the signature output length.
    ///
    /// Calls `EVP_PKEY_sign_message_final` with a null buffer — does not
    /// consume the signing state.
    ///
    /// # Errors
    pub fn sig_len(&mut self) -> Result<usize, ErrorStack> {
        let mut siglen: usize = 0;
        crate::ossl_call!(sys::EVP_PKEY_sign_message_final(
            self.ctx,
            std::ptr::null_mut(),
            std::ptr::addr_of_mut!(siglen),
        ))?;
        Ok(siglen)
    }

    /// Finalise and produce the signature into `sig`.
    ///
    /// Consumes `self` because the context is finalised.  Call
    /// [`sig_len`](Self::sig_len) first to size the buffer.  Returns the
    /// number of bytes written.
    ///
    /// # Errors
    pub fn finish(self, sig: &mut [u8]) -> Result<usize, ErrorStack> {
        let mut siglen = sig.len();
        let rc = unsafe {
            sys::EVP_PKEY_sign_message_final(
                self.ctx,
                sig.as_mut_ptr(),
                std::ptr::addr_of_mut!(siglen),
            )
        };
        // self is dropped here → EVP_PKEY_CTX_free via Drop.
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(siglen)
    }

    /// One-shot sign: feed `data` then finalise into `sig`.
    ///
    /// Consumes `self`.  Use this for algorithms that do not support
    /// streaming (`supports_streaming` returns `false`).
    ///
    /// # Errors
    pub fn sign_oneshot(self, data: &[u8], sig: &mut [u8]) -> Result<usize, ErrorStack> {
        // Feed all data, then finalise.  Both ops share the same ctx.
        let rc_upd = unsafe {
            sys::EVP_PKEY_sign_message_update(self.ctx, data.as_ptr(), data.len())
        };
        if rc_upd != 1 {
            // self dropped here → ctx freed.
            return Err(ErrorStack::drain());
        }
        let mut siglen = sig.len();
        let rc_fin = unsafe {
            sys::EVP_PKEY_sign_message_final(
                self.ctx,
                sig.as_mut_ptr(),
                std::ptr::addr_of_mut!(siglen),
            )
        };
        // self dropped here → ctx freed.
        if rc_fin != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(siglen)
    }
}

#[cfg(ossl320)]
impl Drop for MessageSigner {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ctx) };
    }
}

// ── MessageVerifier — EVP_PKEY_verify_message_* streaming verify (OpenSSL 3.2+)

/// Stateful verification context using `EVP_PKEY_verify_message_*` (OpenSSL 3.2+).
///
/// Mirror of [`MessageSigner`] for the verification side.
///
/// For streaming mode: call [`set_signature`](Self::set_signature), then
/// [`update`](Self::update) zero or more times, then [`finish`](Self::finish).
/// For one-shot: call [`verify_oneshot`](Self::verify_oneshot).
#[cfg(ossl320)]
pub struct MessageVerifier {
    ctx: *mut sys::EVP_PKEY_CTX,
}

#[cfg(ossl320)]
unsafe impl Send for MessageVerifier {}

#[cfg(ossl320)]
impl MessageVerifier {
    /// Create and initialise a message-verify context.
    ///
    /// # Errors
    pub fn new<T: HasPublic>(
        key: &Pkey<T>,
        alg: &mut SigAlg,
        params: Option<&crate::params::Params<'_>>,
    ) -> Result<Self, ErrorStack> {
        let ptr = unsafe {
            sys::EVP_PKEY_CTX_new_from_pkey(std::ptr::null_mut(), key.ptr, std::ptr::null())
        };
        if ptr.is_null() {
            return Err(ErrorStack::drain());
        }
        let params_ptr = params.map_or(crate::params::null_params(), crate::params::Params::as_ptr);
        crate::ossl_call!(sys::EVP_PKEY_verify_message_init(ptr, alg.ptr, params_ptr))
            .map_err(|e| {
                unsafe { sys::EVP_PKEY_CTX_free(ptr) };
                e
            })?;
        Ok(MessageVerifier { ctx: ptr })
    }

    /// Apply parameters after init.
    ///
    /// # Errors
    pub fn set_params(&mut self, params: &crate::params::Params<'_>) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_params(self.ctx, params.as_ptr()))
    }

    /// Supply the signature to verify against (required before streaming `finish`).
    ///
    /// Calls `EVP_PKEY_CTX_set_signature`.  Not needed for
    /// [`verify_oneshot`](Self::verify_oneshot) which sets it internally.
    ///
    /// # Errors
    pub fn set_signature(&mut self, sig: &[u8]) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_CTX_set_signature(self.ctx, sig.as_ptr(), sig.len()))
    }

    /// Probe whether this algorithm supports incremental `update` calls.
    ///
    /// Uses the same `ERR_set_mark` / `ERR_pop_to_mark` probe as
    /// [`MessageSigner::supports_streaming`].
    pub fn supports_streaming(&mut self) -> bool {
        unsafe { sys::ERR_set_mark() };
        let probe: [u8; 0] = [];
        let rc = unsafe {
            sys::EVP_PKEY_verify_message_update(self.ctx, probe.as_ptr(), 0)
        };
        unsafe { sys::ERR_pop_to_mark() };
        rc == 1
    }

    /// Feed `data` into the verification operation.
    ///
    /// # Errors
    pub fn update(&mut self, data: &[u8]) -> Result<(), ErrorStack> {
        crate::ossl_call!(sys::EVP_PKEY_verify_message_update(
            self.ctx,
            data.as_ptr(),
            data.len(),
        ))
    }

    /// Finalise and verify.
    ///
    /// The signature must have been set via [`set_signature`](Self::set_signature).
    /// Consumes `self`.  Returns `Ok(())` if the signature is valid.
    ///
    /// # Errors
    pub fn finish(self) -> Result<(), ErrorStack> {
        let rc = unsafe { sys::EVP_PKEY_verify_message_final(self.ctx) };
        // self dropped here → ctx freed.
        if rc != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(())
    }

    /// One-shot verify `sig` over `data`.
    ///
    /// Sets the signature, feeds all data, and finalises.  Consumes `self`.
    ///
    /// # Errors
    pub fn verify_oneshot(self, data: &[u8], sig: &[u8]) -> Result<(), ErrorStack> {
        let rc_set = unsafe {
            sys::EVP_PKEY_CTX_set_signature(self.ctx, sig.as_ptr(), sig.len())
        };
        if rc_set != 1 {
            return Err(ErrorStack::drain());
        }
        let rc_upd = unsafe {
            sys::EVP_PKEY_verify_message_update(self.ctx, data.as_ptr(), data.len())
        };
        if rc_upd != 1 {
            return Err(ErrorStack::drain());
        }
        let rc_fin = unsafe { sys::EVP_PKEY_verify_message_final(self.ctx) };
        // self dropped here → ctx freed.
        if rc_fin != 1 {
            return Err(ErrorStack::drain());
        }
        Ok(())
    }
}

#[cfg(ossl320)]
impl Drop for MessageVerifier {
    fn drop(&mut self) {
        unsafe { sys::EVP_PKEY_CTX_free(self.ctx) };
    }
}

// ── Tests ─────────────────────────────────────────────────────────────────────

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

    /// Generate an Ed25519 key pair; sign and verify "hello world".
    ///
    /// Ed25519 is a one-shot algorithm — uses `sign_oneshot` / `verify_oneshot`.
    #[test]
    fn ed25519_sign_verify() {
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let priv_key = kgen.generate().unwrap();
        let pub_key = Pkey::<Public>::from(priv_key.clone());

        let msg = b"hello world";
        let init = SignInit::default();

        let mut signer = Signer::new(&priv_key, &init).unwrap();
        let sig = signer.sign_oneshot(msg).unwrap();
        assert!(!sig.is_empty());

        let mut verifier = Verifier::new(&pub_key, &init).unwrap();
        assert!(verifier.verify_oneshot(msg, &sig).unwrap());
    }

    /// Tampered message must fail verification.
    #[test]
    fn ed25519_verify_wrong_msg_fails() {
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let priv_key = kgen.generate().unwrap();
        let pub_key = Pkey::<Public>::from(priv_key.clone());

        let mut signer = Signer::new(&priv_key, &SignInit::default()).unwrap();
        let sig = signer.sign_oneshot(b"correct").unwrap();

        let mut verifier = Verifier::new(&pub_key, &SignInit::default()).unwrap();
        assert!(!verifier.verify_oneshot(b"tampered", &sig).unwrap());
    }

    /// Generate an X25519 key pair; perform ECDH derive and confirm length.
    #[test]
    fn x25519_derive() {
        let mut kgen_a = KeygenCtx::new(c"X25519").unwrap();
        let priv_a = kgen_a.generate().unwrap();

        let mut kgen_b = KeygenCtx::new(c"X25519").unwrap();
        let priv_b = kgen_b.generate().unwrap();
        let pub_b = Pkey::<Public>::from(priv_b);

        let mut derive = DeriveCtx::new(&priv_a).unwrap();
        derive.set_peer(&pub_b).unwrap();
        let len = derive.derive_len().unwrap();
        assert_eq!(len, 32); // X25519 shared secret is always 32 bytes

        let mut ss = vec![0u8; len];
        let n = derive.derive(&mut ss).unwrap();
        assert_eq!(n, 32);
        assert_ne!(ss, [0u8; 32]);
    }

    /// Round-trip through PEM: generate Ed25519, export, re-import, verify key equality.
    #[test]
    fn pem_round_trip() {
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let priv_key = kgen.generate().unwrap();

        let pem = priv_key.to_pem().unwrap();
        assert!(!pem.is_empty());
        assert!(pem.starts_with(b"-----BEGIN"));

        let priv_key2 = Pkey::<Private>::from_pem(&pem).unwrap();
        assert_eq!(priv_key.bits(), priv_key2.bits());
        assert!(priv_key.is_a(c"ED25519"));
    }

    /// Key metadata: Ed25519 should report 256 bits.
    #[test]
    fn ed25519_metadata() {
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let key = kgen.generate().unwrap();
        assert_eq!(key.bits(), 256);
        assert_eq!(key.security_bits(), 128);
        assert!(key.is_a(c"ED25519"));
    }

    /// RawSigner / RawVerifier round-trip with P-256 ECDSA over a pre-hashed digest.
    #[test]
    fn ecdsa_p256_raw_sign_verify() {
        // Generate P-256 key.
        let mut kgen = KeygenCtx::new(c"EC").unwrap();
        let params = crate::params::ParamBuilder::new().unwrap()
            .push_utf8_string(c"group", c"P-256").unwrap()
            .build().unwrap();
        kgen.set_params(&params).unwrap();
        let priv_key = kgen.generate().unwrap();
        let pub_key = Pkey::<Public>::from(priv_key.clone());

        // SHA-256 hash of the message (32 bytes — the "pre-hash").
        let tbs: [u8; 32] = *b"0123456789abcdef0123456789abcdef";

        let mut signer = RawSigner::new(&priv_key, None).unwrap();
        let sig = signer.sign_alloc(&tbs).unwrap();
        assert!(!sig.is_empty());

        let mut verifier = RawVerifier::new(&pub_key, None).unwrap();
        verifier.verify(&tbs, &sig).unwrap();
    }

    /// RawVerifier rejects a tampered signature.
    #[test]
    fn ecdsa_p256_raw_verify_tampered_fails() {
        let mut kgen = KeygenCtx::new(c"EC").unwrap();
        let params = crate::params::ParamBuilder::new().unwrap()
            .push_utf8_string(c"group", c"P-256").unwrap()
            .build().unwrap();
        kgen.set_params(&params).unwrap();
        let priv_key = kgen.generate().unwrap();
        let pub_key = Pkey::<Public>::from(priv_key.clone());

        let tbs: [u8; 32] = *b"0123456789abcdef0123456789abcdef";
        let mut signer = RawSigner::new(&priv_key, None).unwrap();
        let mut sig = signer.sign_alloc(&tbs).unwrap();
        // Flip a byte in the signature.
        if let Some(b) = sig.last_mut() { *b ^= 0xff; }

        let mut verifier = RawVerifier::new(&pub_key, None).unwrap();
        assert!(verifier.verify(&tbs, &sig).is_err());
    }

    /// SigAlg: fetch, clone, drop — verifies EVP_SIGNATURE lifecycle.
    ///
    /// Does not attempt sign_message_final: OpenSSL 3.5's built-in ML-DSA
    /// provider implements only the one-shot EVP_DigestSign path, not
    /// OSSL_FUNC_SIGNATURE_SIGN_MESSAGE_FINAL.  Actual ML-DSA signing is
    /// done via Signer (DigestSign with NULL digest).
    #[cfg(ossl320)]
    #[test]
    fn sig_alg_fetch_clone_drop() {
        let alg = SigAlg::fetch(c"ML-DSA-44", None).unwrap();
        let alg2 = alg.clone();
        drop(alg);
        drop(alg2); // both up_ref / free paths exercised
    }

    /// MessageSigner construction and supports_streaming probe for Ed25519.
    ///
    /// Ed25519 supports EVP_PKEY_sign_message_init.  The streaming probe
    /// uses ERR_set_mark / ERR_pop_to_mark so it cannot leave error state.
    #[cfg(ossl320)]
    #[test]
    fn message_signer_construction_and_streaming_probe() {
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let priv_key = kgen.generate().unwrap();

        let mut alg = SigAlg::fetch(c"ED25519", None).unwrap();
        let mut signer = MessageSigner::new(&priv_key, &mut alg, None).unwrap();

        // Probe must not crash or leave the error queue dirty.
        let _streaming = signer.supports_streaming();
        // Error queue must be empty after the probe.
        assert_eq!(crate::error::ErrorStack::drain().errors().count(), 0);
    }

    /// MessageVerifier construction for Ed25519.
    #[cfg(ossl320)]
    #[test]
    fn message_verifier_construction() {
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let priv_key = kgen.generate().unwrap();
        let pub_key = Pkey::<Public>::from(priv_key.clone());

        let mut alg = SigAlg::fetch(c"ED25519", None).unwrap();
        let _verifier = MessageVerifier::new(&pub_key, &mut alg, None).unwrap();
    }

    /// `Pkey<Public>::from_pem_in` loads a public key within an explicit `LibCtx`.
    #[test]
    fn pubkey_from_pem_in_roundtrip() {
        // Generate an EC key and export the public half to PEM.
        let mut kgen = KeygenCtx::new(c"ED25519").unwrap();
        let priv_key = kgen.generate().unwrap();
        let pub_pem = Pkey::<Public>::from(priv_key).to_pem().unwrap();

        // Re-import via from_pem_in using the default lib ctx.
        let lib_ctx = Arc::new(crate::lib_ctx::LibCtx::new().unwrap());
        let pub_key = Pkey::<Public>::from_pem_in(&lib_ctx, &pub_pem).unwrap();

        // Sanity: key is usable for verification.
        assert!(!pub_key.to_pem().unwrap().is_empty());
    }
}