https://github.com/rollerworks/password-common-list
This package provides a Symfony Validator for the xato-net-10-million-passwords-1000000 CommonPassword list.
https://github.com/rollerworks/password-common-list
Last synced: 6 months ago
JSON representation
This package provides a Symfony Validator for the xato-net-10-million-passwords-1000000 CommonPassword list.
- Host: GitHub
- URL: https://github.com/rollerworks/password-common-list
- Owner: rollerworks
- License: mit
- Created: 2021-09-29T09:36:11.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T10:35:20.000Z (about 2 years ago)
- Last Synced: 2025-06-18T01:19:49.741Z (7 months ago)
- Language: PHP
- Size: 4.02 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
PasswordCommonList Validator
============================
This package provides a [Symfony Validator] for the [xato-net-10-million-passwords-1000000] CommonPassword list.
**Note:** It's better to use the [NotCompromisedPassword](https://symfony.com/doc/current/reference/constraints/NotCompromisedPassword.html#notcompromisedpassword)
validator when possible. The PasswordCommonList should only be used when network access is limited or restricted.
**Only passwords of 6 or more characters are included in this list.**
## Installation
To install this package, add `rollerworks/password-common-list` to your composer.json:
```bash
$ php composer.phar require rollerworks/password-common-list
```
Now, [Composer][composer] will automatically download all required files,
and install them for you.
**Note:** To use this library with a Symfony Application make sure the
`\Rollerworks\Bundle\PasswordCommonListBundle\RollerworksPasswordCommonListBundle` is enabled.
## Requirements
You need at least PHP 7.4, mbstring is recommended but not required.
## Usage
**Caution:**
> The password validators do not enforce that the field must have a value!
> To make a field "required" use the [NotBlank constraint](http://symfony.com/doc/current/reference/constraints/NotBlank.html)
> in combination with the PasswordCommonList validator.
Use the `Rollerworks\Component\PasswordCommonList\Validator\Constraints\NotInPasswordCommonList` constraint as
described in the [Symfony Documentation](https://symfony.com/doc/current/validation.html). This constraint has no special options.
## Versioning
For transparency and insight into the release cycle, and for striving
to maintain backward compatibility, this package is maintained under
the Semantic Versioning guidelines as much as possible.
Releases will be numbered with the following format:
`..`
And constructed with the following guidelines:
* Breaking backward compatibility bumps the major (and resets the minor and patch)
* New additions without breaking backward compatibility bumps the minor (and resets the patch)
* Bug fixes and misc changes bumps the patch
For more information on SemVer, please visit .
## License
This library is released under the [MIT license](LICENSE).
## Contributing
This is an open source project. If you'd like to contribute,
please read the [Contributing Guidelines][contributing]. If you're submitting
a pull request, please follow the guidelines in the [Submitting a Patch][patches] section.
[Symfony Validator]: (http://symfony.com/doc/current/components/validator.html
[xato-net-10-million-passwords-1000000]: https://github.com/danielmiessler/SecLists/tree/master/Passwords
[composer]: https://getcomposer.org/doc/00-intro.md
[flex]: https://symfony.com/doc/current/setup/flex.html
[contributing]: https://contributing.rollerscapes.net/
[patches]: https://contributing.rollerscapes.net/latest/patches.html