PKMLI6flask_argon2.py""" flaskext.argon2 --------------- A Flask extension providing argon2 hashing and comparison. :copyright: (c) 2016 by DominusTemporis. :license: MIT, see LICENSE for more details. """ from __future__ import absolute_import from __future__ import print_function # from sys import version_info __version_info__ = ('0', '1', '1', '0') __version__ = '.'.join(__version_info__) __author__ = 'DominusTemporis' __license__ = 'MIT' __copyright__ = 'Copyright (c) 2016 DominusTemporis' __all__ = ['Argon2', 'generate_password_hash', 'check_password_hash'] try: import argon2 from argon2.exceptions import VerifyMismatchError except ImportError as e: print('argon2_cffi is required to use Flask-Argon2') raise e # PY3 = version_info[0] >= 3 def generate_password_hash(password): ''' This helper function wraps the identical method of :class:`Argon2`. It is intended to be used as a helper function at the expense of the configuration variable provided when passing back the app object. In other words, this shortcut does not make use of the app object at all. To use this function, simply import it from the module and use it in a similar fashion as using the method. Here is a quick example:: from flask.ext.argon2 import generate_password_hash pw_hash = generate_password_hash('hunter2') :param password: The password to be hashed. ''' return Argon2().generate_password_hash(password) def check_password_hash(pw_hash, password): ''' This helper function wraps the similarly names method of :class:`Argon2.` It is intended to be used as a helper function at the expense of the configuration variable provided when passing back the app object. In other words, this shortcut does not make use of the app object at all. To use this function, simply import it from the module and use it in a similar fashion as using the method. Here is a quick example:: from flask.ext.argon2 import check_password_hash check_password_hash(pw_hash, 'hunter2') # returns True :param pw_hash: The hash to be compared against. :param password: The password to compare. ''' return Argon2().check_password_hash(pw_hash, password) class Argon2(object): ''' Argon2 class container for password hashing and checking logic using argon2, of course. This class may be used to intialize your Flask app object. The purpose is to provide a simple interface for overriding Werkzeug's built-in password hashing utilities. Although such methods are not actually overriden, the API is intentionally made similar so that existing applications which make use of the previous hashing functions might be easily adapted to the stronger facility of argon2. To get started you will wrap your application's app object something like this:: app = Flask(__name__) argon2 = Argon2(app) Now the two primary utility methods are exposed via this object, `argon2`. So in the context of the application, important data, such as passwords, could be hashed using this syntax:: password = 'hunter2' pw_hash = argon2.generate_password_hash(password) Once hashed, the value is irreversible. However in the case of validating logins a simple hashing of candidate password and subsequent comparison. Importantly a comparison should be done in constant time. This helps prevent timing attacks. A simple utility method is provided for this:: candidate = 'secret' argon2.check_password_hash(pw_hash, candidate) If both the candidate and the existing password hash are a match `check_password_hash` returns True. Otherwise, it returns False. .. admonition:: Namespacing Issues It's worth noting that if you use the format, `argon2 = Argon2(app)` you are effectively overriding the argon2 module. Though it's unlikely you would need to access the module outside of the scope of the extension be aware that it's overriden. Alternatively consider using a different name, such as `flask_argon2 = Argon2(app)` to prevent naming collisions. :param app: The Flask application object. Defaults to None. ''' _time_cost = argon2.DEFAULT_TIME_COST _memory_cost = argon2.DEFAULT_MEMORY_COST _parallelism = argon2.DEFAULT_PARALLELISM _hash_len = argon2.DEFAULT_HASH_LENGTH _salt_len = argon2.DEFAULT_RANDOM_SALT_LENGTH _encoding = 'utf-8' def __init__(self, app=None, time_cost=_time_cost, memory_cost=_memory_cost, parallelism=_parallelism, hash_len=_hash_len, salt_len=_salt_len, encoding=_encoding): self.time_cost = time_cost self.memory_cost = memory_cost self.parallelism = parallelism self.hash_len = hash_len self.salt_len = salt_len self.encoding = encoding self.ph = argon2.PasswordHasher(self.time_cost, self.memory_cost, self.parallelism, self.hash_len, self.salt_len, self.encoding) def generate_password_hash(self, password): '''Generates a password hash using argon2. Example usage of :class:`generate_password_hash` might look something like this:: pw_hash = argon2.generate_password_hash('secret') :param password: The password to be hashed. ''' if not password: raise ValueError('Password must be non-empty.') # if PY3: # if isinstance(password, str): # password = bytes(password, 'utf-8') # else: # if isinstance(password, unicode): # password = password.encode('utf-8') return self.ph.hash(password) def check_password_hash(self, pw_hash, password): '''Tests a password hash against a candidate password. The candidate password is first hashed and then subsequently compared in constant time to the existing hash. This will either return `True` or `False`. Example usage of :class:`check_password_hash` would look something like this:: pw_hash = argon2.generate_password_hash('secret') argon2.check_password_hash(pw_hash, 'secret') # returns True :param pw_hash: The hash to be compared against. :param password: The password to compare. ''' try: return self.ph.verify(pw_hash, password) except VerifyMismatchError: return False PKLIjQ^^.Flask_Argon2-0.1.1.0.dist-info/DESCRIPTION.rstFlask-Argon2 ------------ The Flask-Argon2 extension provides Argon2i password hashing with sensible defaults and a random salt for Flask. Links ````` * `Documentation `_ * `Development version `_ * `argon2_cffi `_ PKLI-O,Flask_Argon2-0.1.1.0.dist-info/metadata.json{"classifiers": ["Development Status :: 4 - Beta", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules"], "extensions": {"python.details": {"contacts": [{"email": "python@dominustemporis.com", "name": "DominusTemporis", "role": "author"}], "document_names": {"description": "DESCRIPTION.rst"}, "project_urls": {"Home": "https://github.com/red-coracle/flask-argon2"}}}, "extras": [], "generator": "bdist_wheel (0.28.0)", "license": "MIT", "metadata_version": "2.0", "name": "Flask-Argon2", "platform": "any", "run_requires": [{"requires": ["Flask", "argon2-cffi"]}], "summary": "Flask-Argon2 provides convenient wrappers for Argon2 password hashing", "version": "0.1.1.0"}PKLI.> ,Flask_Argon2-0.1.1.0.dist-info/top_level.txtflask_argon2 PKLI#M\\$Flask_Argon2-0.1.1.0.dist-info/WHEELWheel-Version: 1.0 Generator: bdist_wheel (0.28.0) Root-Is-Purelib: true Tag: py2-none-any PKLIl@@'Flask_Argon2-0.1.1.0.dist-info/METADATAMetadata-Version: 2.0 Name: Flask-Argon2 Version: 0.1.1.0 Summary: Flask-Argon2 provides convenient wrappers for Argon2 password hashing Home-page: https://github.com/red-coracle/flask-argon2 Author: DominusTemporis Author-email: python@dominustemporis.com License: MIT Platform: any Classifier: Development Status :: 4 - Beta Classifier: Environment :: Web Environment Classifier: Intended Audience :: Developers Classifier: License :: OSI Approved :: MIT License Classifier: Operating System :: OS Independent Classifier: Programming Language :: Python Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content Classifier: Topic :: Software Development :: Libraries :: Python Modules Requires-Dist: Flask Requires-Dist: argon2-cffi Flask-Argon2 ------------ The Flask-Argon2 extension provides Argon2i password hashing with sensible defaults and a random salt for Flask. Links ````` * `Documentation `_ * `Development version `_ * `argon2_cffi `_ PKLI)y__%Flask_Argon2-0.1.1.0.dist-info/RECORDflask_argon2.py,sha256=KRo3tgAN6s1VtUjFJ1lLqTauMwcp7JKOxL9Hxkmd6UA,6818 Flask_Argon2-0.1.1.0.dist-info/DESCRIPTION.rst,sha256=SM-XDE7bs4H8wfDAokugl6XZJ324OFBv8dsblgZIUZM,350 Flask_Argon2-0.1.1.0.dist-info/METADATA,sha256=4I5YeQn3m8ldWJ1E2A8HDCZRLcOo-qNT07_LKt7-JoU,1088 Flask_Argon2-0.1.1.0.dist-info/RECORD,, Flask_Argon2-0.1.1.0.dist-info/WHEEL,sha256=eZuMUHtrZN3bwljZqH2VonANw_HIsKDj9jLQtlaMlbw,92 Flask_Argon2-0.1.1.0.dist-info/metadata.json,sha256=WQ4m_QLsj22GlSlzios_TmWASrk6eBNVDccrCj152TU,916 Flask_Argon2-0.1.1.0.dist-info/top_level.txt,sha256=HedlUQN6so5gu144GRnpbgSwjquFkBQ_WVHE8Lv7bBc,13 PKMLI6flask_argon2.pyPKLIjQ^^.Flask_Argon2-0.1.1.0.dist-info/DESCRIPTION.rstPKLI-O,yFlask_Argon2-0.1.1.0.dist-info/metadata.jsonPKLI.> ,W Flask_Argon2-0.1.1.0.dist-info/top_level.txtPKLI#M\\$ Flask_Argon2-0.1.1.0.dist-info/WHEELPKLIl@@'L!Flask_Argon2-0.1.1.0.dist-info/METADATAPKLI)y__%%Flask_Argon2-0.1.1.0.dist-info/RECORDPKGs(