Add _legacy_get_session_auth_hash to fix Django 3.1 support

Author: codingjoe

.github/workflows/ci.yml

@@ -4,8 +4,8 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/setup-python@v1.1.1
-      - uses: actions/checkout@v2.0.0
+      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v2
       - run: python -m pip install -r requirements.txt
       - run: python setup.py develop
       - run: python setup.py build_sphinx -W
@@ -18,16 +18,37 @@ jobs:
         python-version: [3.6, 3.7, 3.8]
     steps:
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1.1.1
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/checkout@v2.0.0
+      - uses: actions/checkout@v2
       - run: python setup.py test
       - name: Codecov
         run: |
           python -m pip install codecov
           codecov -t ${{secrets.CODECOV_TOKEN}}
 
+  extras:
+    needs: [docs]
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        extras:
+          - wagtail
+        python-version: [3.8]
+    steps:
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: actions/checkout@v2
+      - run: python -m pip install -e ".[${{ matrix.extras }}]"
+      - run: python setup.py test
+      - name: Codecov
+        run: |
+          python -m pip install codecov
+          codecov -t ${{ secrets.CODECOV_TOKEN }}
+
 
   PostgreSQL:
     needs: [docs]
@@ -50,10 +71,10 @@ jobs:
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
     steps:
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v1.1.1
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: actions/checkout@v2.0.0
+      - uses: actions/checkout@v2
       - run: python -m pip install psycopg2-binary Django==${{ matrix.django-version }}
       - run: python setup.py test
         env:

mailauth/contrib/user/models.py

@@ -1,3 +1,4 @@
+from django.conf import settings
 from django.contrib.auth.base_user import BaseUserManager
 from django.contrib.auth.models import AbstractUser
 from django.db import models
@@ -62,12 +63,26 @@ def has_usable_password(self):
     class Meta(AbstractUser.Meta):
         abstract = True
 
+    def _legacy_get_session_auth_hash(self):
+        # RemovedInDjango40Warning: pre-Django 3.1 hashes will be invalid.
+        key_salt = "mailauth.contrib.user.models.EmailUserManager.get_session_auth_hash"
+        if not self.session_salt:
+            raise ValueError("'session_salt' must be set")
+        return salted_hmac(key_salt, self.session_salt, algorithm='sha1').hexdigest()
+
     def get_session_auth_hash(self):
         """Return an HMAC of the :attr:`.session_salt` field."""
         key_salt = "mailauth.contrib.user.models.EmailUserManager.get_session_auth_hash"
         if not self.session_salt:
             raise ValueError("'session_salt' must be set")
-        return salted_hmac(key_salt, self.session_salt).hexdigest()
+        return salted_hmac(
+            key_salt,
+            self.session_salt,
+            # RemovedInDjango40Warning: when the deprecation ends, replace
+            # with:
+            # algorithm='sha256',
+            algorithm=settings.DEFAULT_HASHING_ALGORITHM,
+        ).hexdigest()
 
 
 delattr(AbstractEmailUser, 'password')

setup.cfg

@@ -38,7 +38,6 @@ tests_require =
     pytest
     pytest-django
     pytest-cov
-    wagtail
 
 [options.package_data]
 * = *.txt, *.rst, *.html, *.po

tests/conftest.py

@@ -36,7 +36,7 @@ def admin_user(db):
 @pytest.fixture()
 def signature():
     """Return a signature matching the user fixture."""
-    return 'LZ.173QUS.1Hjptg.lf2hFgOXQtjQsFypS2ItRG2hkpA'
+    return 'LZ.173QUS.1Hjptg.UtFdkTPoyrSA0IB6AUEhtz_hMyFZY0kcREE1HnWdFq4'
 
 
 @pytest.fixture()

tests/contrib/auth/test_models.py

@@ -28,6 +28,26 @@ def test_get_session_auth_hash__unique(self, db):
 
         assert spiderman.get_session_auth_hash() != ironman.get_session_auth_hash()
 
+    def test_legacy_get_session_auth_hash__default(self, db):
+        user = EmailUser(email='spiderman@avengers.com')
+
+        assert user.session_salt
+        assert user._legacy_get_session_auth_hash()
+
+    def test_legacy_get_session_auth_hash__value_error(self, db):
+        user = EmailUser(email='spiderman@avengers.com', session_salt=None)
+
+        with pytest.raises(ValueError) as e:
+            user._legacy_get_session_auth_hash()
+
+        assert "'session_salt' must be set" in str(e.value)
+
+    def test_legacy_get_session_auth_hash__unique(self, db):
+        spiderman = EmailUser(email='spiderman@avengers.com')
+        ironman = EmailUser(email='ironman@avengers.com')
+
+        assert spiderman._legacy_get_session_auth_hash() != ironman._legacy_get_session_auth_hash()
+
     def test_password_field(self):
         user = EmailUser(email='spiderman@avengers.com')
         with pytest.raises(FieldDoesNotExist):