=====================================
.. image:: https://readthedocs.org/projects/argon2-cffi/badge/?version=stable :target: http://argon2-cffi.readthedocs.io/en/stable/?badge=stable :alt: Documentation Status
.. image:: https://github.com/hynek/argon2-cffi/workflows/CI/badge.svg?branch=master :target: https://github.com/hynek/argon2-cffi/actions?workflow=CI :alt: CI Status
.. image:: https://codecov.io/github/hynek/argon2-cffi/branch/master/graph/badge.svg :target: https://codecov.io/github/hynek/argon2-cffi :alt: Test Coverage
.. image:: https://www.irccloud.com/invite-svg?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1 :target: https://www.irccloud.com/invite?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1 :alt: IRC
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/ambv/black :alt: Code style: black
.. teaser-begin
Argon2 <https://github.com/p-h-c/phc-winner-argon2>
_ won the Password Hashing Competition <https://password-hashing.net/>
_ and argon2-cffi
is the simplest way to use it in Python and PyPy:
.. code-block:: pycon
from argon2 import PasswordHasher ph = PasswordHasher() hash = ph.hash("s3kr3tp4ssw0rd") hash # doctest: +SKIP '$argon2id$v=19$m=102400,t=2,p=8$tSm+JOWigOgPZx/g44K5fQ$WDyus6py50bVFIPkjA28lQ' ph.verify(hash, "s3kr3tp4ssw0rd") True ph.checkneedsrehash(hash) False ph.verify(hash, "t0t411ywr0ng") Traceback (most recent call last): ... argon2.exceptions.VerifyMismatchError: The password does not match the supplied hash
argon2-cffi
\ ’s documentation lives at Read the Docs <https://argon2-cffi.readthedocs.io/>
, the code on GitHub <https://github.com/hynek/argon2-cffi>
.
It’s rigorously tested on Python 2.7, 3.5+, and PyPy.
Vendoring Argon2 @ 62358ba <https://github.com/P-H-C/phc-winner-argon2/tree/62358ba2123abd17fccf2a108a301d4b52c01a7c>
_ (20190702)
Backward-incompatible changes: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
none
Deprecations: ^^^^^^^^^^^^^
none
Changes: ^^^^^^^^
ARGON2_CFFI_USE_SSE2
environment variable.Full changelog <https://argon2-cffi.readthedocs.io/en/stable/changelog.html>
_.
argon2-cffi
is maintained by Hynek Schlawack and released under the MIT license <https://github.com/hynek/argon2-cffi/blob/master/LICENSE>
_.
The development is kindly supported by Variomedia AG <https://www.variomedia.de/>
_.
A full list of contributors can be found in GitHub's overview <https://github.com/hynek/argon2-cffi/graphs/contributors>
_.
Argon2 ^^^^^^
The original Argon2 repo can be found at https://github.com/P-H-C/phc-winner-argon2/.
Except for the components listed below, the Argon2 code in this repository is copyright (c) 2015 Daniel Dinu, Dmitry Khovratovich (main authors), Jean-Philippe Aumasson and Samuel Neves, and under CC0_ license.
The string encoding routines in src/encoding.c are copyright (c) 2015 Thomas Pornin, and under CC0_ license.
The BLAKE2 <https://blake2.net>
_ code in src/blake2/
is copyright (c) Samuel Neves, 2013-2015, and under CC0_ license.
The authors of Argon2 also were very helpful to get the library to compile on ancient versions of Visual Studio for ancient versions of Python.
The documentation also quotes frequently from the Argon2 paper_ to avoid mistakes by rephrasing.
.. _CC0: https://creativecommons.org/publicdomain/zero/1.0/ .. _paper: https://password-hashing.net/argon2-specs.pdf
msinttypes ^^^^^^^^^^
In order to be able to compile on Visual Studio 2008 and Visual Studio 2010 which are required for Python 2.7, we also ship two C headers with integer types.
They are from the msinttypes project <https://code.google.com/archive/p/msinttypes>
_ (auto-import on GitHub <https://github.com/chemeris/msinttypes>
_) and licensed under New BSD:
Copyright (c) 2006-2013 Alexander Chemeris
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.