Skip to main content

The secure Argon2 password hashing algorithm.

Project description

Documentation Status https://travis-ci.org/hynek/argon2_cffi.svg?branch=master https://codecov.io/github/hynek/argon2_cffi/coverage.svg?branch=master https://ci.appveyor.com/api/projects/status/3faufu7qgwc8nv2v/branch/master?svg=true https://www.irccloud.com/invite-svg?channel=%23cryptography-dev&hostname=irc.freenode.net&port=6697&ssl=1

Argon2 won the Password Hashing Competition and argon2_cffi is the simplest way to use it in Python and PyPy:

>>> import argon2
>>> hash = argon2.hash_password(b"secret")
>>> hash   # doctest: +SKIP
b'$argon2i$m=512,t=2,p=2$c29tZXNhbHQ$2IdoNVglVTxb9w4YVJqW8w'
>>> argon2.verify_password(hash, b"secret")
True
>>> argon2.verify_password(hash, b"wrong")
Traceback (most recent call last):
  ...
argon2.exceptions.VerificationError: Decoding failed

argon2_cffi’s documentation lives at Read the Docs, the code on GitHub. It’s rigorously tested on Python 2.6, 2.7, 3.3+, and PyPy.

Credits & License

argon2_cffi is maintained by Hynek Schlawack and released under the MIT license.

The development is kindly supported by Variomedia AG.

A full list of contributors can be found in GitHub’s overview.

Vendored Code

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 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.

msinttypes

In order to be able to compile on Visual Studio 2008 and Visual Studio 2010 which are required for Python 2.6/2.7 and 3.3/3.4 respectively, we also ship two C headers with integer types. They are from the msinttypes project (auto-import on GitHub) 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:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  3. Neither the name of the product nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

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.

Changelog

Versions are year-based with a strict backward compatibility policy. The third digit is only for regressions.

15.0.1 (2015-12-18)

Vendoring argon2 @ 4fe0d8cda37691228dd5a96a310be57369403a4b.

Changes:

  • Fix long_description on PyPI.

15.0.0 (2015-12-18)

Vendoring argon2 @ 4fe0d8cda37691228dd5a96a310be57369403a4b.

Changes:

  • verify_password() doesn’t guess the hash type if passed None anymore. Supporting this resulted in measurable overhead (~ 0.6ms vs 0.8ms on my notebook) since it had to happen in Python. That means that naïve usage of the API would give attackers an edge. The new behavior is that it has the same default value as hash_password() such that verify_password(hash_password(b"password"), b"password") still works.
  • Conditionally use the SSE2-optimized version of argon2 on x86 architectures.
  • More packaging fixes. Most notably compilation on Visual Studio 2010 for Python 3.3 and 3.4.
  • Tweaked default parameters to more reasonable values. Verification should take between 0.5ms and 1ms on recent-ish hardware.

15.0.0b5 (2015-12-10)

Vendoring argon2 @ 4fe0d8cda37691228dd5a96a310be57369403a4b.

Initial work. Previous betas were only for fixing Windows packaging. The authors of argon2 were kind enough to help me to get it building under Visual Studio 2008 that we’re forced to use for Python 2.7 on Windows.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for argon2-cffi, version 15.0.1
Filename, size File type Python version Upload date Hashes
Filename, size argon2_cffi-15.0.1-cp26-none-macosx_10_7_intel.whl (46.7 kB) File type Wheel Python version cp26 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp26-none-win32.whl (30.4 kB) File type Wheel Python version cp26 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp26-none-win_amd64.whl (31.0 kB) File type Wheel Python version cp26 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp27-none-macosx_10_6_intel.whl (49.6 kB) File type Wheel Python version cp27 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp27-none-win32.whl (30.2 kB) File type Wheel Python version cp27 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp27-none-win_amd64.whl (30.7 kB) File type Wheel Python version cp27 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp33-cp33m-macosx_10_6_intel.whl (49.7 kB) File type Wheel Python version cp33 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp33-none-win32.whl (30.1 kB) File type Wheel Python version cp33 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp33-none-win_amd64.whl (30.4 kB) File type Wheel Python version cp33 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp34-cp34m-macosx_10_6_intel.whl (49.6 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp34-none-win32.whl (30.1 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp34-none-win_amd64.whl (30.3 kB) File type Wheel Python version cp34 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp35-cp35m-macosx_10_6_intel.whl (49.7 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp35-none-win32.whl (31.5 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1-cp35-none-win_amd64.whl (34.5 kB) File type Wheel Python version cp35 Upload date Hashes View hashes
Filename, size argon2_cffi-15.0.1.tar.gz (818.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page