Add post abourt converting Werkzeug hashes to Passlib format

This commit is contained in:
Gergely Polonkai 2020-07-19 08:24:02 +02:00
parent d3b11a083a
commit 8b7dd42b27
No known key found for this signature in database
GPG Key ID: 2D2885533B869ED4
1 changed files with 129 additions and 0 deletions

View File

@ -0,0 +1,129 @@
Converting werkzeugs hashes to Passlib format
:date: 2020-07-19T05:02Z
:category: blog
:tags: python,security
:url: blog/converting-werkzeug-hashes-to-passlib/
:save_as: blog/converting-werkzeug-hashes-to-passlib/index.html
:status: published
:author: Gergely Polonkai
In one of my projects i use `Werkzeug <>`_s
``generate_password_hash`` to, well, generate password hashes. Werkzeug uses Pythons
`hashlib <>`_ module under the hood which,
unfortunately to me, doesnt support Argon2 (which i want to transition to for greater security).
Enter `Passlib <>`_.
Passlib conveniently supports both `PBKDF2
<>`_ (what i currently
use in the project, using SHA256 digests), and also supports `Argon2
<>`_. Here are the
.. table::
:widths: auto
================== ==================== ============================
Feature Werkzeug Passlib
================== ==================== ============================
Iteration count 150000, hardcoded 29000, changeable
Default method PBKDF2 None, must be set explicitly
Default digest SHA-256 None, must be set explicitly
Default salt size 8, changeable 16, changeable
Salt character set ASCII only Binary
Salt storage Plain text (shorter) Adapted Base64
Hash storage Hex string Adapted Base64 (shorter)
================== ==================== ============================
But even if i force the same settings on Passlib, their format is different and, obviously,
Passlib doesnt understand Werkzeugs format so i had to convert all my hashes to the new format.
.. code-block:: python
>>> generate_password_hash('password', method='pbkdf2:sha256', salt_length=8)
>>> pbkdf2_sha256.using(rounds=150000, salt_size=8).hash('password')
First, lets split the old hash by the ``$`` characters, and also split the first part by colons:
.. code-block:: python
full_method, salt, hashed_value = old_hash.split('$')
method, digest, rounds = full_method.split(':')
As it soon turned out, the two libraries even store the actual data in different formats.
Werkzeug stores the salt in plain text (its always ASCII characters), and the resulting hash in a
hex string. Passlib, however, aims for greater security with a binary salt, so its Base64
encoded. This encoding is, however, a bit different from what youd expect, as its “using
shortened base64 format which omits padding & whitespace” and also “uses custom ``./`` altchars”.
It even has its own `ab64_encode
and `ab64_decode
functions to handle this encoding. So i first need to re-encode both the salt string and the hash
value hex string, so i have raw bytes.
.. code-block:: python
salt_bytes = salt.encode('ascii')
hash_bytes = bytes.fromhex(hash)
Then encode them to the adapted Base64 format (i also convert it back to ``str`` for easier
concatenation later):
.. code-block:: python
passlib_salt = ab64_encode(salt_bytes).decode('ascii')
passlib_hash = ab64_encode(hash_bytes).decode('ascii')
Now we just need to concatenate all the things with the right separators.
.. code-block:: python
passlib_final_hash = f'${method}-{digest}${rounds}${passlib_salt}${passlib_hash}'
Finally, lets verify everything went right:
.. code-block:: python
>>> pbkdf2_sha256.verify('password', passlib_final_hash)
Heres the whole series of command, converted to a Python function (with slightly altered variable
names) for your copy-pasting convenience (plus, its not using f-strings, so you can use it with
Python <3.6):
.. code-block:: python
def werkzeug_to_passlib_hash(old_hash):
"""Convert Werkzeugs password hashes to Passlib format.
Copied from
from passlib.utils import ab64_encode
# Werkzeug hashes look like full_method$salt$hash. We handle full_method later; salt is
# an ASCII string; hashed value is the hex string representation of the hashed value
full_method, salt, hashed_value = old_hash.split('$')
# Werkzeugs full_method is a colon delimited list of the method, digest, and rounds
method, digest, rounds = full_method.split(':')
new_parts = [
# Passlib expects the hashed value to starts with a $ sign (hence the empty string at the
# beginning of this list).
# Passlibs method and digest is concatenated together with a hyphen.
# Passlib expects the salt and the actual hash to be in the adapted base64 encoding format.
return '$'.join(new_parts)