passay-rs 0.1.0

A password validation library inspired by the Java Passay library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

use std::collections::HashMap;

use crate::rule::rule_result::{CountCategory, RuleResult, RuleResultMetadata};
use crate::rule::{PasswordData, Rule};

pub const ERROR_CODE_MIN: &str = "TOO_SHORT";
pub const ERROR_CODE_MAX: &str = "TOO_LONG";

/// Rule for determining if a password is within a desired length. The minimum and maximum lengths are used inclusively
/// to determine if a password meets this rule.
///
/// # Example
///
/// ```
///  use passay_rs::rule::PasswordData;
///  use passay_rs::rule::length::LengthRule;
///  use passay_rs::rule::Rule;
///
///  let rule = LengthRule::new(4, 10);
///  let password = PasswordData::with_password("123".to_string());
///  let result = rule.validate(&password);
///  assert!(!result.valid());
/// ```
pub struct LengthRule {
    min_length: usize,
    max_length: usize,
}

impl LengthRule {
    pub fn new(min_length: usize, max_length: usize) -> Self {
        Self {
            min_length,
            max_length,
        }
    }
    pub fn with_exact_length(length: usize) -> Self {
        Self {
            min_length: length,
            max_length: length,
        }
    }

    fn create_rule_result_detail_parameters(&self) -> HashMap<String, String> {
        let mut map = HashMap::new();
        map.insert("min_length".to_string(), self.min_length.to_string());
        map.insert("max_length".to_string(), self.max_length.to_string());
        map
    }
    fn create_rule_result_metadata(password_data: &PasswordData) -> RuleResultMetadata {
        RuleResultMetadata::new(CountCategory::Length, password_data.password.len())
    }
}

impl Default for LengthRule {
    fn default() -> Self {
        LengthRule {
            min_length: 0,
            max_length: usize::MAX,
        }
    }
}

impl Rule for LengthRule {
    fn validate(&self, password_data: &PasswordData) -> RuleResult {
        let mut result = RuleResult::new(true);
        let length = password_data.password.len();
        if length < self.min_length {
            result.add_error(
                ERROR_CODE_MIN,
                Some(self.create_rule_result_detail_parameters()),
            );
        } else if length > self.max_length {
            result.add_error(
                ERROR_CODE_MAX,
                Some(self.create_rule_result_detail_parameters()),
            )
        }
        result.set_metadata(Self::create_rule_result_metadata(password_data));
        result
    }
}

#[cfg(test)]
mod tests {
    use crate::rule::length::LengthRule;
    use crate::rule::rule_result::CountCategory;
    use crate::rule::{PasswordData, Rule};

    #[test]
    fn check_metada() {
        let rule = LengthRule::new(4, 10);
        let password = PasswordData::with_password("123".to_string());
        let result = rule.validate(&password);
        assert!(!result.valid());
    }
    #[test]
    fn check_metadata() {
        let rule = LengthRule::new(4, 10);
        let result = rule.validate(&PasswordData::with_password("metadata".to_string()));
        assert!(result.valid());
        assert_eq!(8, result.metadata().get_count(CountCategory::Length));

        let result = rule.validate(&PasswordData::with_password("md".to_string()));
        assert!(!result.valid());
        assert_eq!(2, result.metadata().get_count(CountCategory::Length));
    }
}