55 lines
2.6 KiB
Markdown
55 lines
2.6 KiB
Markdown
# *argon2-cffi*: Argon2 for Python
|
|
|
|
[](https://argon2-cffi.readthedocs.io/)
|
|
[](https://bestpractices.coreinfrastructure.org/projects/6671)
|
|
[](https://pypi.org/project/argon2-cffi/)
|
|
[](https://pepy.tech/project/argon2-cffi)
|
|
|
|
<!-- begin short -->
|
|
<!-- begin pypi -->
|
|
|
|
[Argon2](https://github.com/p-h-c/phc-winner-argon2) won the [Password Hashing Competition](https://www.password-hashing.net/) and *argon2-cffi* is the simplest way to use it in Python:
|
|
|
|
```pycon
|
|
>>> from argon2 import PasswordHasher
|
|
>>> ph = PasswordHasher()
|
|
>>> hash = ph.hash("correct horse battery staple")
|
|
>>> hash # doctest: +SKIP
|
|
'$argon2id$v=19$m=65536,t=3,p=4$MIIRqgvgQbgj220jfp0MPA$YfwJSVjtjSU0zzV/P3S9nnQ/USre2wvJMjfCIjrTQbg'
|
|
>>> ph.verify(hash, "correct horse battery staple")
|
|
True
|
|
>>> ph.check_needs_rehash(hash)
|
|
False
|
|
>>> ph.verify(hash, "Tr0ub4dor&3")
|
|
Traceback (most recent call last):
|
|
...
|
|
argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash
|
|
|
|
```
|
|
<!-- end short -->
|
|
|
|
## Project Links
|
|
|
|
- [**PyPI**](https://pypi.org/project/argon2-cffi/)
|
|
- [**GitHub**](https://github.com/hynek/argon2-cffi)
|
|
- [**Documentation**](https://argon2-cffi.readthedocs.io/)
|
|
- [**Changelog**](https://github.com/hynek/argon2-cffi/blob/main/CHANGELOG.md)
|
|
- [**Funding**](https://hynek.me/say-thanks/)
|
|
- The low-level Argon2 CFFI bindings are maintained in the separate [*argon2-cffi-bindings*](https://github.com/hynek/argon2-cffi-bindings) project.
|
|
|
|
<!-- end pypi -->
|
|
|
|
## Credits
|
|
|
|
*argon2-cffi* is maintained by [Hynek Schlawack](https://hynek.me/).
|
|
|
|
The development is kindly supported by my employer [Variomedia AG](https://www.variomedia.de/), *argon2-cffi* [Tidelift subscribers](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek), and my amazing [GitHub Sponsors](https://github.com/sponsors/hynek).
|
|
|
|
|
|
## *argon2-cffi* for Enterprise
|
|
|
|
Available as part of the [Tidelift Subscription](https://tidelift.com/?utm_source=lifter&utm_medium=referral&utm_campaign=hynek).
|
|
|
|
The maintainers of *argon2-cffi* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open-source packages you use to build your applications.
|
|
Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
|