password-validator-s 1.0.0__tar.gz

password_validator_s-1.0.0/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026 [Md Shamimur Rahman Shuvo]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

password_validator_s-1.0.0/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: password-validator-s
+Version: 1.0.0
+Summary: Highly configurable password validation and strength analysis package
+Author-email: Md Shamimur Rahman Shuvo <shamimur.shuvo@gmail.com>
+License: Copyright (c) 2026 [Md Shamimur Rahman Shuvo]
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/ShamimurRahmanShuvo/password-validator
+Project-URL: Repository, https://github.com/ShamimurRahmanShuvo/password-validator
+Project-URL: Documentation, https://github.com/ShamimurRahmanShuvo/password-validator/wiki
+Project-URL: Issues, https://github.com/ShamimurRahmanShuvo/password-validator/issues
+Keywords: password,validation,security,python,authentication,validator
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Security
+Classifier: Topic :: Software Development :: Libraries
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dotenv>=1.2.2
+Dynamic: license-file
+
+# Password Validator Pro
+
+A configurable Python library for password policy validation and password strength analysis.
+
+**Version:** 1.0.0  
+**Python:** 3.10+  
+**License:** MIT
+
+## What it provides
+
+Password Validator Pro separates two concerns:
+
+1. **Password policy validation** — determines whether a password satisfies the configured rules.
+2. **Password strength analysis** — analyzes password characteristics and patterns, produces a score, identifies a strength level, and generates improvement suggestions.
+
+### Core capabilities
+
+- Minimum and maximum password length validation
+- Uppercase, lowercase, digit, and special-character rules
+- Configurable special-character set
+- Environment-based configuration through `.env` files and process environment variables
+- Custom validation rules through the `Rule` abstraction
+- Rule registration and removal through `RuleRegistry`
+- Repeated-character analysis
+- Repeated-group analysis
+- Sequential-pattern analysis
+- Keyboard-pattern analysis
+- Dictionary and common-password analysis
+- Character composition and estimated entropy metrics
+- Configurable strength scoring weights
+- Password-strength suggestions
+- Structured validation and strength result objects
+- `src/` package layout suitable for modern Python packaging
+
+## Installation
+
+### From PyPI
+
+```bash
+python -m pip install password-validator
+```
+
+### From source
+
+```bash
+git clone https://github.com/ShamimurRahmanShuvo/password-validator.git
+cd password-validator
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+```
+
+For Windows PowerShell, activate the environment with:
+
+```powershell
+.venv\Scripts\Activate.ps1
+```
+
+See [`docs/installation.md`](docs/installation.md) for the complete installation and packaging guide.
+
+## Quick start
+
+```python
+from password_validator import PasswordValidator
+
+validator = PasswordValidator()
+result = validator.validate("MySecurePassword123!")
+
+print(result.valid)
+print(result.passed)
+print(result.failed)
+print(result.errors)
+```
+
+The validator uses the package's default password policy unless a `PasswordRuleConfig` is supplied.
+
+## Configure the password policy
+
+```python
+from password_validator import PasswordValidator
+from password_validator.config.settings import PasswordRuleConfig
+
+config = PasswordRuleConfig(
+    min_length=12,
+    max_length=64,
+    require_uppercase=True,
+    require_lowercase=True,
+    require_digit=True,
+    require_special=True,
+    special_characters="!@#$%^&*()-_=+[]{}|;:'\",.<>?/`~",
+)
+
+validator = PasswordValidator(config=config)
+result = validator.validate("MySecurePassword123!")
+```
+
+The package also supports environment-driven configuration. See [`docs/configuration.md`](docs/configuration.md).
+
+## Password strength scoring
+
+```python
+from password_validator import PasswordStrengthScorer
+
+scorer = PasswordStrengthScorer()
+result = scorer.score("MySecurePassword123!")
+
+print(result.score)
+print(result.level)
+print(result.metrics)
+print(result.suggestion_message)
+```
+
+Strength scoring is independent of policy validation. A password can be policy-valid while still receiving a relatively low strength score, or vice versa.
+
+See [`docs/strength-analysis.md`](docs/strength-analysis.md).
+
+## Custom validation rules
+
+Rules implement the `Rule` interface and return a `RuleResult`.
+
+```python
+from password_validator.rules.base import Rule, RuleResult
+
+
+class NoUsernameRule(Rule):
+    name = "no_username"
+
+    def __init__(self, username: str):
+        self.username = username
+
+    def validate(self, password: str) -> RuleResult:
+        if self.username.lower() in password.lower():
+            return self._failed(
+                message="Password must not contain the username",
+                code="USERNAME_IN_PASSWORD",
+            )
+
+        return self._passed(message="Password does not contain the username")
+```
+
+You can pass custom rules directly to `PasswordValidator`:
+
+```python
+validator = PasswordValidator(rules=[NoUsernameRule("shuvo")])
+result = validator.validate("MySecurePassword123!")
+```
+
+See [`docs/rules.md`](docs/rules.md) and [`docs/plugins.md`](docs/plugins.md).
+
+## Documentation
+
+- [`Installation`](docs/installation.md) — install, verify, development setup, testing, and packaging
+- [`Configuration`](docs/configuration.md) — policy and strength configuration
+- [`Rules`](docs/rules.md) — built-in rules and custom rule development
+- [`Plugins and extensions`](docs/plugins.md) — extension model and integration guidance
+- [`Validation`](docs/validation.md) — validation API and result objects
+- [`Strength analysis`](docs/strength-analysis.md) — analyzers, scoring, metrics, and suggestions
+- [`Architecture`](docs/architecture.md) — package design and responsibilities
+- [`Testing`](docs/testing.md) — unit/integration testing and coverage
+- [`Security`](docs/security.md) — secure usage and operational guidance
+- [`Troubleshooting`](docs/troubleshooting.md) — common installation and development problems
+- [`Contributing`](docs/contributing.md) — development workflow and contribution expectations
+
+## Project layout
+
+```text
+password-validator/
+├── config/
+│   └── .env.example
+├── docs/
+├── examples/
+├── src/
+│   ├── password_validator/
+│   │   ├── config/
+│   │   ├── engine/
+│   │   ├── loaders/
+│   │   ├── rules/
+│   │   ├── strength/
+│   │   ├── constants.py
+│   │   ├── enums.py
+│   │   ├── exceptions.py
+│   │   ├── models.py
+│   │   └── version.py
+│   └── plugins/
+├── tests/
+├── pyproject.toml
+├── requirements-dev.txt
+└── README.md
+```
+
+## Important security note
+
+This library validates and analyzes passwords; it is **not a password storage system**. Never store plaintext passwords or log them. Application code should hash passwords using an appropriate password-hashing mechanism and should avoid placing credentials in exception messages, telemetry, traces, or request logs.
+
+## License
+
+MIT. See [`LICENSE`](LICENSE).

password_validator_s-1.0.0/README.md

@@ -0,0 +1,197 @@
+# Password Validator Pro
+
+A configurable Python library for password policy validation and password strength analysis.
+
+**Version:** 1.0.0  
+**Python:** 3.10+  
+**License:** MIT
+
+## What it provides
+
+Password Validator Pro separates two concerns:
+
+1. **Password policy validation** — determines whether a password satisfies the configured rules.
+2. **Password strength analysis** — analyzes password characteristics and patterns, produces a score, identifies a strength level, and generates improvement suggestions.
+
+### Core capabilities
+
+- Minimum and maximum password length validation
+- Uppercase, lowercase, digit, and special-character rules
+- Configurable special-character set
+- Environment-based configuration through `.env` files and process environment variables
+- Custom validation rules through the `Rule` abstraction
+- Rule registration and removal through `RuleRegistry`
+- Repeated-character analysis
+- Repeated-group analysis
+- Sequential-pattern analysis
+- Keyboard-pattern analysis
+- Dictionary and common-password analysis
+- Character composition and estimated entropy metrics
+- Configurable strength scoring weights
+- Password-strength suggestions
+- Structured validation and strength result objects
+- `src/` package layout suitable for modern Python packaging
+
+## Installation
+
+### From PyPI
+
+```bash
+python -m pip install password-validator
+```
+
+### From source
+
+```bash
+git clone https://github.com/ShamimurRahmanShuvo/password-validator.git
+cd password-validator
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -e .
+```
+
+For Windows PowerShell, activate the environment with:
+
+```powershell
+.venv\Scripts\Activate.ps1
+```
+
+See [`docs/installation.md`](docs/installation.md) for the complete installation and packaging guide.
+
+## Quick start
+
+```python
+from password_validator import PasswordValidator
+
+validator = PasswordValidator()
+result = validator.validate("MySecurePassword123!")
+
+print(result.valid)
+print(result.passed)
+print(result.failed)
+print(result.errors)
+```
+
+The validator uses the package's default password policy unless a `PasswordRuleConfig` is supplied.
+
+## Configure the password policy
+
+```python
+from password_validator import PasswordValidator
+from password_validator.config.settings import PasswordRuleConfig
+
+config = PasswordRuleConfig(
+    min_length=12,
+    max_length=64,
+    require_uppercase=True,
+    require_lowercase=True,
+    require_digit=True,
+    require_special=True,
+    special_characters="!@#$%^&*()-_=+[]{}|;:'\",.<>?/`~",
+)
+
+validator = PasswordValidator(config=config)
+result = validator.validate("MySecurePassword123!")
+```
+
+The package also supports environment-driven configuration. See [`docs/configuration.md`](docs/configuration.md).
+
+## Password strength scoring
+
+```python
+from password_validator import PasswordStrengthScorer
+
+scorer = PasswordStrengthScorer()
+result = scorer.score("MySecurePassword123!")
+
+print(result.score)
+print(result.level)
+print(result.metrics)
+print(result.suggestion_message)
+```
+
+Strength scoring is independent of policy validation. A password can be policy-valid while still receiving a relatively low strength score, or vice versa.
+
+See [`docs/strength-analysis.md`](docs/strength-analysis.md).
+
+## Custom validation rules
+
+Rules implement the `Rule` interface and return a `RuleResult`.
+
+```python
+from password_validator.rules.base import Rule, RuleResult
+
+
+class NoUsernameRule(Rule):
+    name = "no_username"
+
+    def __init__(self, username: str):
+        self.username = username
+
+    def validate(self, password: str) -> RuleResult:
+        if self.username.lower() in password.lower():
+            return self._failed(
+                message="Password must not contain the username",
+                code="USERNAME_IN_PASSWORD",
+            )
+
+        return self._passed(message="Password does not contain the username")
+```
+
+You can pass custom rules directly to `PasswordValidator`:
+
+```python
+validator = PasswordValidator(rules=[NoUsernameRule("shuvo")])
+result = validator.validate("MySecurePassword123!")
+```
+
+See [`docs/rules.md`](docs/rules.md) and [`docs/plugins.md`](docs/plugins.md).
+
+## Documentation
+
+- [`Installation`](docs/installation.md) — install, verify, development setup, testing, and packaging
+- [`Configuration`](docs/configuration.md) — policy and strength configuration
+- [`Rules`](docs/rules.md) — built-in rules and custom rule development
+- [`Plugins and extensions`](docs/plugins.md) — extension model and integration guidance
+- [`Validation`](docs/validation.md) — validation API and result objects
+- [`Strength analysis`](docs/strength-analysis.md) — analyzers, scoring, metrics, and suggestions
+- [`Architecture`](docs/architecture.md) — package design and responsibilities
+- [`Testing`](docs/testing.md) — unit/integration testing and coverage
+- [`Security`](docs/security.md) — secure usage and operational guidance
+- [`Troubleshooting`](docs/troubleshooting.md) — common installation and development problems
+- [`Contributing`](docs/contributing.md) — development workflow and contribution expectations
+
+## Project layout
+
+```text
+password-validator/
+├── config/
+│   └── .env.example
+├── docs/
+├── examples/
+├── src/
+│   ├── password_validator/
+│   │   ├── config/
+│   │   ├── engine/
+│   │   ├── loaders/
+│   │   ├── rules/
+│   │   ├── strength/
+│   │   ├── constants.py
+│   │   ├── enums.py
+│   │   ├── exceptions.py
+│   │   ├── models.py
+│   │   └── version.py
+│   └── plugins/
+├── tests/
+├── pyproject.toml
+├── requirements-dev.txt
+└── README.md
+```
+
+## Important security note
+
+This library validates and analyzes passwords; it is **not a password storage system**. Never store plaintext passwords or log them. Application code should hash passwords using an appropriate password-hashing mechanism and should avoid placing credentials in exception messages, telemetry, traces, or request logs.
+
+## License
+
+MIT. See [`LICENSE`](LICENSE).

password_validator_s-1.0.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = [
+    "setuptools>=68.0",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "password-validator-s"
+version = "1.0.0"
+description = "Highly configurable password validation and strength analysis package"
+readme = "README.md"
+license = { file= "LICENSE" }
+
+authors = [
+    { name = "Md Shamimur Rahman Shuvo", email = "shamimur.shuvo@gmail.com" }
+]
+
+keywords = [
+    "password",
+    "validation",
+    "security",
+    "python",
+    "authentication",
+    "validator"
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Security",
+    "Topic :: Software Development :: Libraries",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent"
+]
+
+requires-python = ">=3.10"
+
+dependencies = [
+    "python-dotenv>=1.2.2"
+]
+
+[project.urls]
+Homepage = "https://github.com/ShamimurRahmanShuvo/password-validator"
+Repository = "https://github.com/ShamimurRahmanShuvo/password-validator"
+Documentation = "https://github.com/ShamimurRahmanShuvo/password-validator/wiki"
+Issues = "https://github.com/ShamimurRahmanShuvo/password-validator/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]

password_validator_s-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

password_validator_s-1.0.0/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup()

password_validator_s-1.0.0/src/password_validator/__init__.py

@@ -0,0 +1,30 @@
+"""
+Entry point for the password_validator package.
+A configurable password validation library that allows users to define custom rules and
+criteria for password strength and security.
+"""
+from .version import (
+    __title__,
+    __version__,
+    __author__,
+    __description__
+)
+from .engine.validator import PasswordValidator, ValidationResult
+from .strength.scorer import PasswordStrengthScorer
+
+# Package metadata
+VERSION = __version__
+
+__all__ = [
+    # Package Metadata
+    "__version__",
+    "__title__",
+    "__author__",
+    "__description__",
+    "VERSION",
+
+    # Main API
+    "PasswordValidator",
+    "ValidationResult",
+    "PasswordStrengthScorer",
+]

password_validator_s-1.0.0/src/password_validator/config/settings.py

@@ -0,0 +1,135 @@
+"""
+Application-level configuration for password-validator.
+This module provides the top-level package configuration.
+Strength-specific configuration is maintained separately in:
+    password_validator.strength.config.StrengthConfig
+Password policy configuration is maintained here and can be
+loaded from environment variables.
+"""
+from __future__ import annotations
+from dataclasses import dataclass
+
+from ..loaders.env_loader import EnvLoader
+from ..strength.config import StrengthConfig
+from password_validator.constants import *
+
+
+@dataclass(frozen=True, slots=True)
+class PasswordRuleConfig:
+    """
+    Configuration for password policy rules.
+    These settings determine whether a password satisfies the configured password policy.
+    This is separate from password strength scoring.
+    """
+    min_length: int = 8
+    max_length: int = 128
+
+    require_uppercase: bool = True
+    require_lowercase: bool =True
+    require_digit: bool =True
+    require_special: bool = True
+    special_characters: str = "!@#$%^&*()-_=[]{}|/:;'<>?"
+
+    """
+    require_whitespace: bool
+    min_uppercase: int
+    min_lowercase: int
+    min_digit: int
+    min_special: int
+
+    allowed_special: str
+    allow_spaces: bool
+
+    max_repeat: int
+    check_sequential: bool
+    check_common_passwords: bool
+    check_dictionary: bool
+
+    custom_regex: str | None
+    min_entropy: int
+    language: str
+    """
+
+    @classmethod
+    def from_env(cls, env: EnvLoader) -> "PasswordRuleConfig":
+        """
+        Loads the password policy configuration from EnvLoader.
+        :param env: .env file. Defaults to ".env".
+        :return: password policy object
+        """
+
+        return cls(
+            min_length=env.get_int("PASSWORD_MIN_LENGTH", DEFAULT_MIN_LENGTH),
+            max_length=env.get_int("PASSWORD_MAX_LENGTH", DEFAULT_MAX_LENGTH),
+
+            require_uppercase=env.get_bool("PASSWORD_REQUIRE_UPPERCASE", DEFAULT_REQUIRE_UPPERCASE),
+            require_lowercase=env.get_bool("PASSWORD_REQUIRE_LOWERCASE", DEFAULT_REQUIRE_LOWERCASE),
+            require_digit=env.get_bool("PASSWORD_REQUIRE_DIGIT", DEFAULT_REQUIRE_DIGIT),
+            require_special=env.get_bool("PASSWORD_REQUIRE_SPECIAL", DEFAULT_REQUIRE_SPECIAL),
+            special_characters=env.get("PASSWORD_SPECIAL_CHARACTERS", DEFAULT_SPECIAL_CHARACTERS)
+        )
+
+    def validate(self) -> None:
+        """
+        Validate the configuration itself.
+        Raises:
+            ValueError: If the configuration is invalid.
+        :return:
+        """
+        if self.min_length < 1:
+            raise ValueError("PASSWORD_MIN_LENGTH must be greater than 0")
+
+        if self.max_length < self.min_length:
+            raise ValueError("PASSWORD_MAX_LENGTH must be greater than or equal to PASSWORD_MIN_LENGTH")
+
+        if self.require_special and not self.special_characters:
+            raise ValueError("PASSWORD_SPECIAL_CHARACTERS cannot be empty when PASSWORD_REQUIRE_SPECIAL=true")
+
+    @classmethod
+    def defaults(cls) -> "PasswordRuleConfig":
+        """
+        Return the package defaults.
+        Useful for applications that don't use .env.
+        :return:
+        """
+        return cls()
+
+
+@dataclass(slots=True, frozen=True)
+class Settings:
+    """
+    Root configuration object for the password-validator package.
+    This object is the main configuration boundary for the package.
+
+    Environment variables are loaded once and converted into typed configuration objects.
+    """
+    rules: PasswordRuleConfig
+    strength: StrengthConfig
+
+    @classmethod
+    def from_env(cls, env_file: str = ".env") -> "Settings":
+        """
+        Build application settings from environment file.
+        :param env_file: Path to the .env file
+        :return: Fully initialized settings object
+        """
+        env = EnvLoader(env_file)
+        rules = PasswordRuleConfig.from_env(env)
+        rules.validate()
+        strength = StrengthConfig.from_env(env_file)
+
+        return cls(rules=rules, strength=strength)
+
+    @classmethod
+    def defaults(cls) -> "Settings":
+        """
+        Return package defaults without reading an environment file
+        :return:
+        """
+        rules = PasswordRuleConfig()
+        rules.validate()
+
+        return cls(
+            rules=rules,
+            strength=StrengthConfig.defaults()
+        )