passay_rs/rule/

history.rs

use crate::rule::reference::{Reference, Salt};
use crate::rule::rule_result::RuleResult;
use crate::rule::{PasswordData, Rule};
use std::any::Any;
use std::collections::HashMap;
use std::fmt::{Debug, Formatter};

pub const ERROR_CODE: &str = "HISTORY_VIOLATION";

/// Rule for determining if a password matches one of any previous password a user has chosen. If no historical password
/// reference has been set, then passwords will meet this rule. See also [PasswordData::password_references]
///
/// # Example
///
/// ```
///  use passay_rs::rule::history::HistoryRule;
///  use passay_rs::rule::history::HistoricalReference;
///  use passay_rs::rule::PasswordData;
///  use passay_rs::rule::reference::Reference;
///  use passay_rs::rule::Rule;
///
///  let rule = HistoryRule::default();
///  let history: Vec<Box<dyn Reference>> =
///      vec![Box::new(HistoricalReference::with_password_label(
///          "t3stUs3r03".to_string(),
///          "history".to_string(),
///      ))];
///  let password = PasswordData::new(
///      "t3stUs3r03".to_string(),
///      Some("testuser".to_string()),
///      history,
///  );
///  let result = rule.validate(&password);
///  assert!(!result.valid());
/// ```
#[derive(Clone)]
pub struct HistoryRule {
    report_all: bool,
}

impl HistoryRule {
    pub fn new(report_all: bool) -> HistoryRule {
        HistoryRule { report_all }
    }
}

pub fn create_rule_result_detail_parameters(len: usize) -> HashMap<String, String> {
    let mut map = HashMap::with_capacity(1);
    map.insert("historySize".to_string(), len.to_string());
    map
}
impl Rule for HistoryRule {
    fn validate(&self, password_data: &PasswordData) -> RuleResult {
        validate_with_history_references(self.report_all, password_data, matches)
    }
}

pub(super) fn validate_with_history_references<F: Fn(&str, &HistoricalReference) -> bool>(
    report_all: bool,
    password_data: &PasswordData,
    matcher: F,
) -> RuleResult {
    let mut result = RuleResult::default();

    let mut len = 0;
    for rf in password_data.password_references() {
        if rf.as_any().downcast_ref::<HistoricalReference>().is_some() {
            len += 1;
        }
    }

    for rf in password_data.password_references() {
        if let Some(rf) = rf.as_any().downcast_ref::<HistoricalReference>() {
            let cleartext = password_data.password();
            if matcher(cleartext, rf) {
                result.add_error(ERROR_CODE, Some(create_rule_result_detail_parameters(len)));
                if !report_all {
                    return result;
                }
            }
        }
    }
    result
}

impl Default for HistoryRule {
    fn default() -> Self {
        Self { report_all: true }
    }
}
fn matches(password: &str, rf: &HistoricalReference) -> bool {
    password == rf.password()
}

pub struct HistoricalReference {
    label: Option<String>,
    password: String,
    salt: Option<Salt>,
}

impl HistoricalReference {
    pub fn new(password: String, label: Option<String>, salt: Option<Salt>) -> HistoricalReference {
        HistoricalReference {
            password,
            label,
            salt,
        }
    }

    pub fn with_password(password: String) -> HistoricalReference {
        Self::new(password, None, None)
    }
    pub fn with_password_label(password: String, label: String) -> HistoricalReference {
        Self::new(password, Some(label), None)
    }
}

impl Debug for HistoricalReference {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("HistoricalReference")
            .field("password", &self.password)
            .field("label", &self.label)
            .finish()
    }
}

impl Reference for HistoricalReference {
    fn password(&self) -> &str {
        self.password.as_str()
    }

    fn salt(&self) -> &Option<Salt> {
        &self.salt
    }

    fn as_any(&self) -> &dyn Any {
        self
    }
}

#[cfg(test)]
mod test {
    use crate::rule::PasswordData;
    use crate::rule::history::{ERROR_CODE, HistoricalReference, HistoryRule};
    use crate::rule::reference::Reference;
    use crate::test::{RulePasswordTestItem, check_messages, check_passwords};

    #[test]
    fn test_passwords() {
        let rule = HistoryRule::default();
        let rule_report_first = HistoryRule::new(false);
        let empty_rule = HistoryRule::default();
        let test_cases: Vec<RulePasswordTestItem> = vec![
            RulePasswordTestItem(
                Box::new(rule.clone()),
                PasswordData::new(
                    "t3stUs3r00".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![],
            ),
            RulePasswordTestItem(
                Box::new(rule.clone()),
                PasswordData::new(
                    "t3stUs3r01".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![ERROR_CODE],
            ),
            RulePasswordTestItem(
                Box::new(rule.clone()),
                PasswordData::new(
                    "t3stUs3r02".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![ERROR_CODE, ERROR_CODE],
            ),
            RulePasswordTestItem(
                Box::new(rule.clone()),
                PasswordData::new(
                    "t3stUs3r03".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![ERROR_CODE],
            ),
            RulePasswordTestItem(
                Box::new(rule_report_first.clone()),
                PasswordData::new(
                    "t3stUs3r00".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![],
            ),
            RulePasswordTestItem(
                Box::new(rule_report_first.clone()),
                PasswordData::new(
                    "t3stUs3r01".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![ERROR_CODE],
            ),
            RulePasswordTestItem(
                Box::new(rule_report_first.clone()),
                PasswordData::new(
                    "t3stUs3r02".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![ERROR_CODE],
            ),
            RulePasswordTestItem(
                Box::new(rule_report_first.clone()),
                PasswordData::new(
                    "t3stUs3r03".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![ERROR_CODE],
            ),
            RulePasswordTestItem(
                Box::new(empty_rule.clone()),
                PasswordData::with_password_and_user(
                    "t3stUs3r00".to_string(),
                    Some("testuser".to_string()),
                ),
                vec![],
            ),
            RulePasswordTestItem(
                Box::new(empty_rule.clone()),
                PasswordData::with_password_and_user(
                    "t3stUs3r01".to_string(),
                    Some("testuser".to_string()),
                ),
                vec![],
            ),
            RulePasswordTestItem(
                Box::new(empty_rule.clone()),
                PasswordData::with_password_and_user(
                    "t3stUs3r02".to_string(),
                    Some("testuser".to_string()),
                ),
                vec![],
            ),
            RulePasswordTestItem(
                Box::new(empty_rule.clone()),
                PasswordData::with_password_and_user(
                    "t3stUs3r03".to_string(),
                    Some("testuser".to_string()),
                ),
                vec![],
            ),
        ];
        check_passwords(test_cases);
    }

    #[test]
    fn test_messages() {
        let rule = HistoryRule::default();
        let rule_report_first = HistoryRule::new(false);

        let history_len = setup_history().len();
        let message = "HISTORY_VIOLATION,".to_owned() + history_len.to_string().as_str();

        let test_cases: Vec<RulePasswordTestItem> = vec![
            RulePasswordTestItem(
                Box::new(rule.clone()),
                PasswordData::new(
                    "t3stUs3r01".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![&message],
            ),
            RulePasswordTestItem(
                Box::new(rule.clone()),
                PasswordData::new(
                    "t3stUs3r02".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![&message, &message],
            ),
            RulePasswordTestItem(
                Box::new(rule_report_first),
                PasswordData::new(
                    "t3stUs3r02".to_string(),
                    Some("testuser".to_string()),
                    setup_history(),
                ),
                vec![&message],
            ),
        ];
        check_messages(test_cases);
    }

    fn setup_history() -> Vec<Box<dyn Reference>> {
        vec![
            Box::new(HistoricalReference::with_password_label(
                "t3stUs3r01".to_string(),
                "history".to_string(),
            )),
            Box::new(HistoricalReference::with_password_label(
                "t3stUs3r02".to_string(),
                "history".to_string(),
            )),
            Box::new(HistoricalReference::with_password_label(
                "t3stUs3r03".to_string(),
                "history".to_string(),
            )),
            Box::new(HistoricalReference::with_password_label(
                "t3stUs3r02".to_string(),
                "history".to_string(),
            )),
        ]
    }
}