hc_seed_bundle 0.7.0

/// Enum to specify limits (difficulty) for argon2id pwhashing algorithm.
///
/// Ops in this library don't take explicit limit parameters. Instead, they
/// check the current context, if not set using the default "Moderate" limits.
///
/// To set the context for the scope of the "with_exec" callback:
///
/// ```rust
/// # use hc_seed_bundle::*;
/// let _my_result = PwHashLimits::Sensitive.with_exec(|| {
///   // execute my function that needs "Sensitive" limits
/// });
/// ```
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum PwHashLimits {
    /// minimum limits (UNIT TESTING ONLY)
    Minimum,

    /// low cpu/mem limits
    Interactive,

    /// middle cpu/mem limits (default)
    Moderate,

    /// high cpu/mem limits
    Sensitive,
}

thread_local! {
    static PWHASH_LIMITS: std::cell::RefCell<PwHashLimits> = const { std::cell::RefCell::new(PwHashLimits::Moderate) };
}

impl PwHashLimits {
    /// Get the current set limits
    /// or the default "Moderate" limits if none are set by `with_exec()`.
    pub fn current() -> Self {
        PWHASH_LIMITS.with(|s| *s.borrow())
    }

    /// Execute a closure with these pwhash limits set.
    pub fn with_exec<R, F>(self, f: F) -> R
    where
        F: FnOnce() -> R,
    {
        PWHASH_LIMITS.with(move |s| {
            *s.borrow_mut() = self;
            let res = f();
            *s.borrow_mut() = PwHashLimits::Moderate;
            res
        })
    }

    /// translate into mem limit
    pub fn as_mem_limit(&self) -> u32 {
        match self {
            Self::Minimum => sodoken::argon2::ARGON2_ID_MEMLIMIT_MIN,
            Self::Interactive => {
                sodoken::argon2::ARGON2_ID_MEMLIMIT_INTERACTIVE
            }
            Self::Moderate => sodoken::argon2::ARGON2_ID_MEMLIMIT_MODERATE,
            Self::Sensitive => sodoken::argon2::ARGON2_ID_MEMLIMIT_SENSITIVE,
        }
    }

    /// translate into cpu limit
    pub fn as_ops_limit(&self) -> u32 {
        match self {
            Self::Minimum => sodoken::argon2::ARGON2_ID_OPSLIMIT_MIN,
            Self::Interactive => {
                sodoken::argon2::ARGON2_ID_OPSLIMIT_INTERACTIVE
            }
            Self::Moderate => sodoken::argon2::ARGON2_ID_OPSLIMIT_MODERATE,
            Self::Sensitive => sodoken::argon2::ARGON2_ID_OPSLIMIT_SENSITIVE,
        }
    }
}