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

# passay-rs

passay-rs is a Rust library that provides password validation rules, inspired by the original Java library passay. It
allows developers to enforce complex password policies such as minimum length, character composition, and exclusion of
common words.

## Features

- Validate passwords against a set of rules
- Support for various rule types such as:
    - Minimum and maximum length
    - Character composition (uppercase, lowercase, digits, special characters)
    - Exclusion of common words
    - Check for username or password reuse
    - Whitespace detection
    - Source reference matching
- Customizable rule behavior (e.g., case sensitivity, backwards matching)
- Extensible architecture to support additional rules and languages

## Usage

To use passay-rs, add it to your `Cargo.toml`:

```toml
[dependencies]
passay-rs = "0.1.0"
```

Then, create and configure your password validation rules:

```rust
use passay_rs::rule::PasswordData;
use passay_rs::rule::Rule;
use passay_rs::rule::length::LengthRule;

fn main() {
    let rule = LengthRule::new(8, 20);
    let password_data = PasswordData::with_password("SecureP@ssw0rd".to_string());
    let result = rule.validate(&password_data);
    assert!(result.valid());
}
```

## Contributing

We welcome contributions! If you're interested in helping with the project, please refer to
the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.

## License

This project is licensed under your choice of either the MIT License or the Apache License 2.0.

See [LICENSE-MIT](LICENSE-MIT) and [LICENSE-APACHE](LICENSE-APACHE) for details.

## Notes

This project is in early stages of development and there might be bugs and missing documentation. It's not recommended
to be used in production.