django-pfx 1.4.dev30__tar.gz → 1.4.dev38__tar.gz

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/.gitlab-ci.yml

@@ -23,20 +23,29 @@ stages:
   - build
   - package
 
+quality check:
+  variables:
+    DJANGO_VERSION: 'django==4.2.*'  # LTS
+  script:
+    - apt-get update
+    - apt-get install -y gettext
+    - flake8 .
+    - isort . -c
+    - ./make_messages
+    - git diff --exit-code  # exit if messages changed
+    - python manage.py makemigrations --check --dry-run --setting='pfx.settings.dev'
+
 test:
   variables:
     POSTGRES_DB: ci
     POSTGRES_USER: postgres
     POSTGRES_PASSWORD: postgres
-    TEST_SETTINGS_MODULE: 'tests.settings.ci'
+    DJANGO_SETTINGS_MODULE: 'tests.settings.ci'
   script:
     - apt-get update
     - apt-get install -y gettext
-    - flake8 .
-    - isort . -c
-    - django-admin compilemessages --ignore venv
-    - export DJANGO_SETTINGS_MODULE=$TEST_SETTINGS_MODULE
-    - coverage run --source='.' runtest.py
+    - python manage.py compilemessages -i venv
+    - coverage run --source='.' manage.py test
     - coverage report
     - coverage xml
     - coverage html
@@ -86,6 +95,10 @@ pages:
     - master
 
 package:
+  stage: package
+  needs:
+    - job: quality check
+    - job: test
   rules:
     - if: $CI_COMMIT_TAG =~ /^\d+\.\d+$/
       when: on_success
@@ -97,6 +110,6 @@ package:
     - git fetch --prune --unshallow
     - pip install --upgrade twine
     - pip install -r requirements.txt
-    - (cd pfx/pfxcore/ && django-admin compilemessages)
+    - ./manage.py compilemessages -i venv -i tests
     - python3 -m build
     - TWINE_PASSWORD=${PYPI_DEPLOY_TOKEN} TWINE_USERNAME=__token__ python3 -m twine upload dist/*

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.4.dev30
+Version: 1.4.dev38
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/django_pfx.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: django-pfx
-Version: 1.4.dev30
+Version: 1.4.dev38
 Summary: Django PFX is a toolkit designed to streamline the development of RESTful APIs using the Django framework.
 Author: Hervé Martinet
 Author-email: herve.martinet@gmail.com

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/django_pfx.egg-info/SOURCES.txt

@@ -4,10 +4,10 @@
 LICENSE
 MANIFEST.in
 README.md
-django-admin-test
+make_messages
+manage.py
 pyproject.toml
 requirements.txt
-runtest.py
 serve-doc
 setup.cfg
 setup.py
@@ -60,6 +60,8 @@ pfx/pfxcore/middleware/__init__.py
 pfx/pfxcore/middleware/authentication.py
 pfx/pfxcore/middleware/locale.py
 pfx/pfxcore/middleware/profiling.py
+pfx/pfxcore/migrations/0001_initial.py
+pfx/pfxcore/migrations/__init__.py
 pfx/pfxcore/models/__init__.py
 pfx/pfxcore/models/abstract_pfx_base_user.py
 pfx/pfxcore/models/cache_mixins.py
@@ -103,6 +105,8 @@ pfx/pfxcore/views/parameters/subset_offset.py
 pfx/pfxcore/views/parameters/subset_page.py
 pfx/pfxcore/views/parameters/subset_page_size.py
 pfx/pfxcore/views/parameters/subset_page_subset.py
+pfx/settings/__init__.py
+pfx/settings/dev.py
 tests/__init__.py
 tests/models.py
 tests/urls.py

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/django_pfx.egg-info/top_level.txt

@@ -1,3 +1,4 @@
 dist
 doc
+htmlcov
 pfx

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/doc/source/authentication.md

@@ -210,13 +210,13 @@ except that the login service returns a temporary JWT token valid only for the o
 
 ### Enable MFA OTP
 Services to enable the MFA with OTP.
-You have to call first the `activate` service to get the URI,
+You have to call first the `setup-uri` service to get the URI,
 encode it as a QR code and present it in the UI of your software.
 Then user then scans this QR code to add the OTP secret to his OTP App.
-Finally, the `confirm` service must be called with an OTP code retrieved
+Finally, the `enable` service must be called with an OTP code retrieved
 in the OTP App to confirm the activation.
 
-**Request :** `PUT` `/auth/otp/activate`
+**Request :** `GET` `/auth/otp/setup-uri`
 
 **Responses :**
 
@@ -227,7 +227,7 @@ in the OTP App to confirm the activation.
 |-----------|---------------------------------------|
 | setup_uri | the uri to enable the OTP application |
 
-**Request :** `PUT` `/auth/otp/confirm`
+**Request :** `PUT` `/auth/otp/enable`
 
 **Request body:**
 

django_pfx-1.4.dev38/make_messages

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+(cd pfx/pfxcore && django-admin makemessages -a)
+(cd tests/tests && django-admin makemessages -a)

django_pfx-1.4.dev38/manage.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import logging
+import os
+import sys
+
+from django.db.migrations import writer
+
+if len(sys.argv) > 1 and sys.argv[1] == 'test':
+    logging.disable(logging.WARNING)
+
+
+writer.MIGRATION_HEADER_TEMPLATE = """\
+# Generated by Django %(version)s on %(timestamp)s
+# flake8: noqa
+
+"""
+
+def main():
+    """Run administrative tasks."""
+    cmd = len(sys.argv) > 1 and sys.argv[1]
+    os.environ.setdefault(
+        "DJANGO_SETTINGS_MODULE",
+        cmd == 'test' and "tests.settings.dev" or "pfx.settings.dev")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == '__main__':
+    main()

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/pfx/pfxcore/locale/fr/LC_MESSAGES/django.po

@@ -7,7 +7,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: \n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-04-08 13:51+0200\n"
+"POT-Creation-Date: 2024-04-18 14:37+0200\n"
 "PO-Revision-Date: 2021-06-22 23:31+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
@@ -18,7 +18,7 @@ msgstr ""
 "Plural-Forms: nplurals=2; plural=(n > 1);\n"
 "X-Generator: Poedit 2.3\n"
 
-#: decorator/rest.py:43
+#: decorator/rest.py:41
 msgid "An internal server error occured."
 msgstr "Une erreur interne du serveur est survenue."
 
@@ -59,63 +59,67 @@ msgstr ""
 "Format non valide, il peut s’agir d’un nombre en heures, « 1:05 », « :05 », "
 "« 1h 5m », « 1.5h » ou « 30m »."
 
-#: models/login_ban.py:45
+#: models/login_ban.py:43
 msgid "Username"
 msgstr "Nom d’utilisateur"
 
-#: models/login_ban.py:46
+#: models/login_ban.py:44
 msgid "Failed counter"
 msgstr "Compteur d’échec"
 
-#: models/login_ban.py:47
+#: models/login_ban.py:45
 msgid "Last failed"
 msgstr "Dernier échec"
 
-#: models/login_ban.py:52
+#: models/login_ban.py:50
 msgid "Login ban"
 msgstr "Login banni"
 
-#: models/login_ban.py:53
+#: models/login_ban.py:51
 msgid "Login bans"
 msgstr "Login bannis"
 
-#: models/otp_user_mixin.py:10
+#: models/otp_user_mixin.py:16
 msgid "OTP secret token"
 msgstr "Jeton secret OTP"
 
-#: models/otp_user_mixin.py:13
+#: models/otp_user_mixin.py:20
 msgid "Temporary OTP secret token"
 msgstr "Jeton secret OTP temporaire"
 
-#: models/otp_user_mixin.py:14
+#: models/otp_user_mixin.py:22
 msgid "HOTP count"
 msgstr "Compte HOTP"
 
-#: models/otp_user_mixin.py:15
+#: models/otp_user_mixin.py:24
 msgid "HOTP expiry"
 msgstr "Expiration HOTP"
 
+#: models/otp_user_mixin.py:29 views/authentication_views.py:489
+msgid "OTP enabled"
+msgstr "OTP activé"
+
 #: models/pfx_models.py:14
 #, python-format
 msgid "%(model_name)s with this %(field_labels)s already exists."
 msgstr "%(model_name)s avec ce/cette %(field_labels)s éxiste déjà."
 
-#: shortcuts.py:52
+#: shortcuts.py:50
 #, python-brace-format
 msgid "{key} must be an integer number."
 msgstr "{key} doit être un nombre entier."
 
-#: shortcuts.py:68
+#: shortcuts.py:66
 #, python-brace-format
 msgid "{key} must be a number."
 msgstr "{key} doit être un nombre."
 
-#: shortcuts.py:84
+#: shortcuts.py:82
 #, python-brace-format
 msgid "{key} must be a date."
 msgstr "{key} doit être une date."
 
-#: shortcuts.py:105
+#: shortcuts.py:103
 #, python-brace-format
 msgid "{key} must be “true”, “false”, “1”, “0” or empty."
 msgstr "{key} doit être « true », « false », « 1 », « 0 » ou vide"
@@ -152,6 +156,7 @@ msgid "The %(site_name)s team"
 msgstr "L'équipe de %(site_name)s"
 
 #: templates/registration/otp_code_subject.txt:2
+#, python-format
 msgid "New authentication code for %(site_name)s"
 msgstr "Nouveau code d’authentication pour %(site_name)s"
 
@@ -191,7 +196,7 @@ msgstr "Bienvenue sur %(site_name)s."
 msgid "Welcome on %(site_name)s"
 msgstr "Bienvenue sur %(site_name)s"
 
-#: views/authentication_views.py:82
+#: views/authentication_views.py:81
 #, python-brace-format
 msgid ""
 "Your connection is temporarily disabled after several unsuccessful attempts, "
@@ -200,43 +205,39 @@ msgstr ""
 "Votre connexion est temporairement désactivée après plusieurs tentatives "
 "infructueuses, veuillez réessayer dans {seconds} secondes."
 
-#: views/authentication_views.py:244 views/authentication_views.py:407
+#: views/authentication_views.py:243 views/authentication_views.py:408
 msgid "password updated successfully"
 msgstr "le mot de passe a été mis à jour avec succès"
 
-#: views/authentication_views.py:249
+#: views/authentication_views.py:248
 msgid "Incorrect password"
 msgstr "Mot de passe incorrect"
 
-#: views/authentication_views.py:252 views/authentication_views.py:416
+#: views/authentication_views.py:251 views/authentication_views.py:417
 msgid "Empty password is not allowed"
 msgstr "Un mot de passe vide n’est pas autorisé"
 
-#: views/authentication_views.py:341
+#: views/authentication_views.py:342
 msgid "User and token are valid"
 msgstr "L'utilisateur et le token sont valides"
 
-#: views/authentication_views.py:343
+#: views/authentication_views.py:344
 msgid "User or token is invalid"
 msgstr "L'utilisateur ou le token est invalide"
 
-#: views/authentication_views.py:449
-msgid "OTP is already activated"
-msgstr "L'OTP est déjà activé"
-
-#: views/authentication_views.py:487
-msgid "OTP is activated"
-msgstr "L'OTP est activé"
+#: views/authentication_views.py:451
+msgid "OTP is already enabled"
+msgstr "OTP est déjà activé"
 
-#: views/authentication_views.py:488 views/authentication_views.py:522
+#: views/authentication_views.py:490 views/authentication_views.py:524
 msgid "Invalid OTP code"
 msgstr "Code OTP invalide"
 
-#: views/authentication_views.py:521
-msgid "OTP is disabled"
-msgstr "L'OTP est désactivé"
+#: views/authentication_views.py:523
+msgid "OTP disabled"
+msgstr "OTP désactivé"
 
-#: views/authentication_views.py:777
+#: views/authentication_views.py:783
 msgid ""
 "If the email address you entered is correct, you will receive an email from "
 "us with instructions to reset your password."
@@ -245,7 +246,7 @@ msgstr ""
 "un courrier électronique de notre part contenant des instructions pour "
 "réinitialiser votre mot de passe."
 
-#: views/authentication_views.py:845
+#: views/authentication_views.py:857
 msgid "A new authentication code has been sent by email."
 msgstr "Un nouveau code d'authentification a été envoyé par e-mail."
 

django_pfx-1.4.dev38/pfx/pfxcore/migrations/0001_initial.py

@@ -0,0 +1,59 @@
+# Generated by Django 4.2.11 on 2024-04-11 04:19
+# flake8: noqa
+
+import django.contrib.auth.models
+import django.contrib.auth.validators
+import django.utils.timezone
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    initial = True
+
+    dependencies = [
+        ('auth', '0012_alter_user_first_name_max_length'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='LoginBan',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('username', models.CharField(max_length=150, unique=True, verbose_name='Username')),
+                ('failed_counter', models.IntegerField(verbose_name='Failed counter')),
+                ('last_failed', models.DateTimeField(auto_now=True, verbose_name='Last failed')),
+            ],
+            options={
+                'verbose_name': 'Login ban',
+                'verbose_name_plural': 'Login bans',
+            },
+        ),
+        migrations.CreateModel(
+            name='PFXUser',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('password', models.CharField(max_length=128, verbose_name='password')),
+                ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')),
+                ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')),
+                ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')),
+                ('first_name', models.CharField(blank=True, max_length=150, verbose_name='first name')),
+                ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')),
+                ('email', models.EmailField(blank=True, max_length=254, verbose_name='email address')),
+                ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')),
+                ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')),
+                ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')),
+                ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.group', verbose_name='groups')),
+                ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.permission', verbose_name='user permissions')),
+            ],
+            options={
+                'verbose_name': 'user',
+                'verbose_name_plural': 'users',
+                'abstract': False,
+                'swappable': 'AUTH_USER_MODEL',
+            },
+            managers=[
+                ('objects', django.contrib.auth.models.UserManager()),
+            ],
+        ),
+    ]

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/pfx/pfxcore/models/otp_user_mixin.py

@@ -4,6 +4,7 @@ from django.db import models
 from django.utils import timezone
 from django.utils.translation import gettext_lazy as _
 
+from pfx.pfxcore.decorator import rest_property
 from pfx.pfxcore.settings import settings
 
 
@@ -25,6 +26,10 @@ class OtpUserMixin(models.Model):
     class Meta:
         abstract = True
 
+    @rest_property(_("OTP enabled"), "BooleanField")
+    def is_otp(self):
+        return bool(self.otp_secret_token)
+
     def enable_otp(self):
         """Activate OTP for this user.
 

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/pfx/pfxcore/views/authentication_views.py

@@ -281,11 +281,15 @@ class AuthenticationView(
         Can be overridden to customize result.
 
         :param user: The user"""
-        return {
+        info = {
             'username': user.get_username(),
             'first_name': user.first_name,
             'last_name': user.last_name,
-            'email': user.email}
+            'email': user.email
+        }
+        if isinstance(user, OtpUserMixin):
+            info.update(is_otp=user.is_otp)
+        return info
 
     @classmethod
     def get_user_information_schema(cls):
@@ -414,21 +418,22 @@ class AuthenticationView(
         raise UnauthorizedError()
 
     @method_decorator(never_cache)
-    @rest_api("/otp/activate", public=False, method="put", priority_doc=52)
-    def otp_activate(self, *args, **kwargs):
-        """Entrypoint for :code:`PUT /otp/activate` route.
+    @rest_api("/otp/setup-uri", public=False, method="get", priority_doc=52)
+    def otp_setup_uri(self, *args, **kwargs):
+        """Entrypoint for :code:`GET /otp/secret-key` route.
 
-        Activate the OTP authentication and return the setup URI.
+        Get the setup uri for the OTP authentication.
 
         :returns: The JSON response
         :rtype: :class:`JsonResponse`
         ---
         put:
-            summary: Activate OTP
-            description: A service to activate OTP authentication for
-                the user. Returns a setup URI to build a QR code. You
-                have to call the confirm service with a valid code to
-                fully activate OTP authentication.
+            summary: Get the activation url for the OTP authentication.
+            description: This service returns a setup URI to enable the OTP.
+                Your front-end application should provide this URI in the form
+                of a QR code so that the user can scan it with
+                an OTP application. You must then call the /confirm service
+                with a valid OTP code to activate OTP authentication.
             responses:
                 200:
                     content:
@@ -443,26 +448,26 @@ class AuthenticationView(
             raise NotFoundError()
         if self.request.user.otp_secret_token:
             return JsonResponse(
-                dict(message=_("OTP is already activated")), status=400)
+                dict(message=_("OTP is already enabled")), status=400)
         self.request.user.enable_otp()
         return JsonResponse(dict(
             setup_uri=self.request.user.get_otp_setup_uri(tmp=True)))
 
     @method_decorator(never_cache)
     @rest_api(
-        "/otp/confirm", public=False, method="put", priority_doc=53,
+        "/otp/enable", public=False, method="put", priority_doc=53,
         response_schema='message_schema')
-    def otp_confirm(self, *args, **kwargs):
-        """Entrypoint for :code:`PUT /otp/confirm` route.
+    def otp_enable(self, *args, **kwargs):
+        """Entrypoint for :code:`PUT /otp/enable` route.
 
-        Confirm the OTP authentification activation.
+        Enable the OTP authentication.
 
         :returns: The JSON response
         :rtype: :class:`JsonResponse`
         ---
         put:
-            summary: Confirm OTP
-            description: A service to confirm the OTP activation with a
+            summary: Enable OTP authentication
+            description: A service to enable the OTP authentication with a
                 valid OTP code.
             requestBody:
                 content:
@@ -481,7 +486,7 @@ class AuthenticationView(
             raise NotFoundError()
         data = self.deserialize_body()
         if self.request.user.confirm_otp(data.get('otp_code')):
-            return JsonResponse(dict(message=_("OTP is activated")))
+            return JsonResponse(dict(message=_("OTP enabled")))
         return JsonResponse(dict(message=_("Invalid OTP code")), status=422)
 
     @method_decorator(never_cache)
@@ -489,7 +494,7 @@ class AuthenticationView(
     def otp_disable(self, *args, **kwargs):
         """Entrypoint for :code:`PUT /otp/disable` route.
 
-        Disable the OTP authentification.
+        Disable the OTP authentication.
 
         :returns: The JSON response
         :rtype: :class:`JsonResponse`
@@ -515,7 +520,7 @@ class AuthenticationView(
         data = self.deserialize_body()
         if self.request.user.is_otp_valid(data.get('otp_code')):
             self.request.user.disable_otp()
-            return JsonResponse(dict(message=_("OTP is disabled")))
+            return JsonResponse(dict(message=_("OTP disabled")))
         return JsonResponse(dict(message=_("Invalid OTP code")), status=422)
 
     @method_decorator(never_cache)

django_pfx-1.4.dev38/pfx/settings/dev.py

@@ -0,0 +1,8 @@
+SECRET_KEY = 'fake-key'
+INSTALLED_APPS = [
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.postgres',
+    'pfx.pfxcore',
+]
+DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

{django-pfx-1.4.dev30 → django_pfx-1.4.dev38}/setup.cfg

@@ -53,6 +53,7 @@ exclude =
 [flake8]
 per-file-ignores = 
 	__init__.py: F401,F403
+exclude = .git,__pycache__,venv
 
 [isort]
 skip_glob = */venv/*