modoboa 2.5.0__py3-none-any.whl → 2.6.0__py3-none-any.whl

modoboa/admin/api/v2/serializers.py

@@ -745,7 +745,7 @@ class CSVImportSerializer(serializers.Serializer):
 class CSVIdentityImportSerializer(CSVImportSerializer):
     """Custom serializer for identity import."""
 
-    crypt_passwords = serializers.BooleanField()
+    crypt_passwords = serializers.BooleanField(default=False)
 
 
 class AlarmSerializer(serializers.ModelSerializer):

modoboa/admin/models/domain.py

@@ -202,7 +202,7 @@ class Domain(mixins.MessageLimitMixin, AdminObject):
         return self.dnsrecord_set.filter(type="autodiscover").first()
 
     @cached_property
-    def allocated_quota(self):
+    def allocated_quota(self) -> int:
         """Return current quota allocation."""
         if not self.quota:
             return 0

modoboa/admin/models/mixins.py

@@ -1,5 +1,7 @@
 """Admin model mixins."""
 
+from typing import Optional
+
 from modoboa.policyd.utils import get_message_counter
 
 
@@ -18,7 +20,7 @@ class MessageLimitMixin:
         return self.message_limit - get_message_counter(self.message_counter_key)
 
     @property
-    def sent_messages_in_percent(self):
+    def sent_messages_in_percent(self) -> Optional[int]:  # noqa
         """Return number of sent messages as a percentage."""
         if not self.message_limit:
             return None

modoboa/amavis/serializers.py

@@ -10,7 +10,7 @@ from modoboa.amavis import models
 class GlobalParametersSerializer(serializers.Serializer):
 
     localpart_is_case_sensitive = serializers.BooleanField(default=False)
-    recipient_delimiter = serializers.CharField(default="")
+    recipient_delimiter = serializers.CharField(default="", allow_blank=True)
     max_messages_age = serializers.IntegerField(default=14)
     released_msgs_cleanup = serializers.BooleanField(default=False)
     am_pdp_mode = serializers.ChoiceField(

modoboa/autoconfig/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AutoconfigConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "modoboa.autoconfig"

modoboa/autoconfig/templates/autoconfig/autoconfig.xml

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<clientConfig version="1.1">
+  <emailProvider id="{{ domain }}">
+    <domain>{{ domain }}</domain>
+    <displayName>Modoboa</displayName>
+    <displayShortName>Mail</displayShortName>
+
+    <incomingServer type="imap">
+      <hostname>{{ connection_settings.imap.HOSTNAME }}</hostname>
+      <port>{{ connection_settings.imap.PORT }}</port>
+      <socketType>{{ connection_settings.imap.SOCKET_TYPE }}</socketType>
+      <authentication>plain</authentication>
+      <username>{{ emailaddress }}</username>
+    </incomingServer>
+
+    <outgoingServer type="smtp">
+      <hostname>{{ connection_settings.smtp.HOSTNAME }}</hostname>
+      <port>{{ connection_settings.smtp.PORT }}</port>
+      <socketType>{{ connection_settings.smtp.SOCKET_TYPE }}</socketType>
+      <authentication>plain</authentication>
+      <username>{{ emailaddress }}</username>
+    </outgoingServer>
+  </emailProvider>
+</clientConfig>

modoboa/autoconfig/templates/autoconfig/autodiscover.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Autodiscover xmlns="http://schemas.microsoft.com/exchange/autodiscover/responseschema/2006">
+  <Response xmlns="http://schemas.microsoft.com/exchange/autodiscover/outlook/responseschema/2006a">
+    <Account>
+      <AccountType>email</AccountType>
+      <Action>settings</Action>
+
+      <Protocol>
+        <Type>IMAP</Type>
+        <Server>{{ connection_settings.imap.HOSTNAME }}</Server>
+        <Port>{{ connection_settings.imap.PORT }}</Port>
+        <SSL>true</SSL>
+        <LoginName>{{ emailaddress }}</LoginName>
+      </Protocol>
+
+      <Protocol>
+        <Type>SMTP</Type>
+        <Server>{{ connection_settings.smtp.HOSTNAME }}</Server>
+        <Port>{{ connection_settings.smtp.PORT }}</Port>
+        <SSL>false</SSL>
+        <TLS>true</TLS>
+        <LoginName>{{ emailaddress }}</LoginName>
+      </Protocol>
+
+    </Account>
+  </Response>
+</Autodiscover>

modoboa/autoconfig/tests.py

@@ -0,0 +1,38 @@
+from django.test import TestCase
+from django.urls import reverse
+
+
+class ViewsTestCase(TestCase):
+
+    databases = "__all__"
+
+    def test_autoconfig(self):
+        url = reverse("autoconfig:autoconfig")
+
+        resp = self.client.get(url)
+        self.assertEqual(resp.status_code, 404)
+
+        resp = self.client.get(f"{url}?emailaddress=test@test.com")
+        self.assertEqual(resp.status_code, 200)
+
+        self.assertIn(b'<emailProvider id="test.com">', resp.content)
+
+    def test_autodiscover(self):
+        url = reverse("autoconfig:autodiscover")
+
+        resp = self.client.post(url)
+        self.assertEqual(resp.status_code, 404)
+
+        resp = self.client.post(url, {"EmailAddress": "test@test.com"})
+        self.assertEqual(resp.status_code, 200)
+
+        self.assertIn(b"<LoginName>test@test.com", resp.content)
+
+    def test_mobileconfig(self):
+        url = reverse("autoconfig:mobileconfig")
+
+        resp = self.client.get(url)
+        self.assertEqual(resp.status_code, 404)
+
+        resp = self.client.get(f"{url}?emailaddress=test@test.com")
+        self.assertEqual(resp.status_code, 200)

modoboa/autoconfig/urls.py

@@ -0,0 +1,21 @@
+"""Autoconfig urls."""
+
+from django.urls import path
+
+from modoboa.autoconfig import views
+
+app_name = "autoconfig"
+
+urlpatterns = [
+    path(
+        "mail/config-v1.1.xml",
+        views.AutoConfigView.as_view(),
+        name="autoconfig",
+    ),
+    path(
+        "autodiscover/autodiscover.xml",
+        views.AutoDiscoverView.as_view(),
+        name="autodiscover",
+    ),
+    path("mobileconfig", views.MobileConfigView.as_view(), name="mobileconfig"),
+]

modoboa/autoconfig/views.py

@@ -0,0 +1,109 @@
+import plistlib
+import uuid
+
+from django.conf import settings
+from django.http import Http404, HttpResponse
+from django.utils.decorators import method_decorator
+from django.views import generic
+from django.views.decorators.csrf import csrf_exempt
+
+from modoboa.lib.email_utils import split_address
+
+
+class ConfigBaseMixin:
+
+    content_type = "application/xml"
+
+    def get_common_context(self, emailaddress: str) -> dict:
+        local_part, domain = split_address(emailaddress)
+        return {
+            "emailaddress": emailaddress,
+            "domain": domain,
+            "connection_settings": settings.EMAIL_CLIENT_CONNECTION_SETTINGS,
+        }
+
+
+class AutoConfigView(ConfigBaseMixin, generic.TemplateView):
+
+    http_method_names = ["get"]
+    template_name = "autoconfig/autoconfig.xml"
+
+    def get_context_data(self, **kwargs):
+        emailaddress = self.request.GET.get("emailaddress")
+        if not emailaddress:
+            raise Http404
+        context = super().get_context_data(**kwargs)
+        context.update(self.get_common_context(emailaddress))
+        return context
+
+
+@method_decorator(csrf_exempt, name="dispatch")
+class AutoDiscoverView(ConfigBaseMixin, generic.TemplateView):
+
+    http_method_names = ["post"]
+    template_name = "autoconfig/autodiscover.xml"
+
+    def get_context_data(self, **kwargs):
+        emailaddress = self.request.POST.get("EmailAddress")
+        if not emailaddress:
+            raise Http404
+        context = super().get_context_data(**kwargs)
+        context.update(self.get_common_context(emailaddress))
+        return context
+
+    def post(self, request, *args, **kwargs):
+        context = self.get_context_data(**kwargs)
+        return self.render_to_response(context)
+
+
+class MobileConfigView(generic.View):
+
+    http_method_names = ["get"]
+
+    def get(self, request, *args, **kwargs):
+        emailaddress = self.request.GET.get("emailaddress")
+        if not emailaddress:
+            raise Http404
+        local_part, domain = split_address(emailaddress)
+        parts = domain.split(".")
+        parts.reverse()
+        reverse_domain = ".".join(parts)
+        imap_settings = settings.EMAIL_CLIENT_CONNECTION_SETTINGS["imap"]
+        smtp_settings = settings.EMAIL_CLIENT_CONNECTION_SETTINGS["smtp"]
+        profile = {
+            "PayloadType": "Configuration",
+            "PayloadVersion": 1,
+            "PayloadIdentifier": f"{reverse_domain}.mailprofile",
+            "PayloadUUID": str(uuid.uuid4()),
+            "PayloadDisplayName": f"{domain} Mail Configuration",
+            "PayloadOrganization": domain,
+            "PayloadContent": [
+                {
+                    "PayloadType": "com.apple.mail.managed",
+                    "PayloadVersion": 1,
+                    "PayloadIdentifier": f"{reverse_domain}.mailprofile.mail",
+                    "PayloadUUID": str(uuid.uuid4()),
+                    "PayloadDisplayName": "Mail",
+                    "EmailAccountDescription": f"{domain} Mail",
+                    "EmailAccountType": "EmailTypeIMAP",
+                    "EmailAddress": emailaddress,
+                    # incoming
+                    "IncomingMailServerHostName": imap_settings["HOSTNAME"],
+                    "IncomingMailServerPortNumber": imap_settings["PORT"],
+                    "IncomingMailServerUseSSL": True,
+                    "IncomingMailServerUsername": emailaddress,
+                    # outgoing
+                    "OutgoingMailServerHostName": smtp_settings["HOSTNAME"],
+                    "OutgoingMailServerPortNumber": smtp_settings["PORT"],
+                    "OutgoingMailServerUseSSL": True,
+                    "OutgoingMailServerUsername": emailaddress,
+                    "OutgoingPasswordSameAsIncomingPassword": True,
+                }
+            ],
+        }
+        plist_bytes = plistlib.dumps(profile, fmt=plistlib.FMT_XML)
+        resp = HttpResponse(
+            plist_bytes, content_type="application/x-apple-aspen-config"
+        )
+        resp["Content-Disposition"] = 'attachment; filename="mail.mobileconfig"'
+        return resp

modoboa/autoreply/api/v2/tests.py

@@ -62,7 +62,7 @@ class ARMessageViewSetTestCase(PatcherMixin, ModoAPITestCase):
     def test_retrieve_armessage_domadmin(self):
         admin = User.objects.get(username="admin@test.com")
         self.client.logout()
-        self.client.force_login(admin)
+        self.client.force_authenticate(admin)
         url = reverse("api:armessage-list")
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
@@ -74,7 +74,7 @@ class ARMessageViewSetTestCase(PatcherMixin, ModoAPITestCase):
 
     def test_retrieve_armessage_simpleuser(self):
         self.client.logout()
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
         url = reverse("api:armessage-list")
         response = self.client.get(url)
         self.assertEqual(response.status_code, 200)
@@ -156,7 +156,7 @@ class AccountARMessageViewSetTestCase(PatcherMixin, ModoAPITestCase):
         response = self.client.get(url)
         self.assertEqual(response.status_code, 403)
         self.client.logout()
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
         self.assertFalse(
             models.ARmessage.objects.filter(mbox=self.account.mailbox).exists()
         )
@@ -168,7 +168,7 @@ class AccountARMessageViewSetTestCase(PatcherMixin, ModoAPITestCase):
 
     def test_set_armessage(self):
         self.client.logout()
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
         url = reverse("api:account_armessage-armessage")
         fromdate = timezone.now()
         todate = fromdate + relativedelta(days=4)

modoboa/calendars/tests.py

@@ -13,7 +13,7 @@ from modoboa.admin import factories as admin_factories
 from modoboa.admin import models as admin_models
 from modoboa.core import factories as core_factories
 from modoboa.core import models as core_models
-from modoboa.lib.tests import ModoTestCase, ModoAPITestCase
+from modoboa.lib.tests import ModoAPITestCase
 
 from modoboa.admin.factories import populate_database
 
@@ -53,7 +53,7 @@ class TestDataMixin:
         cls.scalendar2 = factories.SharedCalendarFactory(domain=cls.domain2)
 
 
-class AccessRuleTestCase(ModoTestCase):
+class AccessRuleTestCase(ModoAPITestCase):
 
     @classmethod
     def setUpTestData(cls):
@@ -139,7 +139,7 @@ class UserCalendarViewSetTestCase(TestDataMixin, ModoAPITestCase):
 
     def setUp(self):
         """Initiate test context."""
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
         self.set_global_parameter("server_location", "http://localhost:5232")
 
     def test_get_calendars(self):
@@ -214,7 +214,7 @@ class SharedCalendarViewSetTestCase(TestDataMixin, ModoAPITestCase):
 
     def setUp(self):
         """Initiate test context."""
-        self.client.force_login(self.admin_account)
+        self.client.force_authenticate(self.admin_account)
         self.set_global_parameter("server_location", "http://localhost:5232")
 
     def test_get_calendars(self):
@@ -304,7 +304,7 @@ class AccessRuleViewSetTestCase(TestDataMixin, ModoAPITestCase):
 
     def setUp(self):
         """Initiate test context."""
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
 
     def test_get_accessrules(self):
         """Test access rule retrieval."""
@@ -383,7 +383,7 @@ class EventViewSetTestCase(TestDataMixin, ModoAPITestCase):
         self.cal_mock.return_value = mocks.Calendar(client=self.client_mock)
         self.addCleanup(patcher2.stop)
 
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
         self.set_global_parameter("server_location", "http://localhost")
 
     def test_get_user_events(self):
@@ -550,7 +550,7 @@ class AttendeeViewSetTestCase(ModoAPITestCase):
 
     def setUp(self):
         """Initiate test context."""
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
 
     def test_get_attendees(self):
         """Test attendees retrieval."""
@@ -571,7 +571,7 @@ class MailboxViewSetTestCase(ModoAPITestCase):
 
     def setUp(self):
         """Initiate test context."""
-        self.client.force_login(self.account)
+        self.client.force_authenticate(self.account)
 
     def test_get_mailboxes(self):
         """Test mailbox retrieval."""

modoboa/contacts/tests.py

@@ -11,7 +11,7 @@ from django.utils import timezone
 
 from modoboa.admin import factories as admin_factories
 from modoboa.core import models as core_models
-from modoboa.lib.tests import ModoAPITestCase, ModoTestCase
+from modoboa.lib.tests import ModoAPITestCase
 
 from . import factories
 from . import mocks
@@ -46,7 +46,7 @@ class TestDataMixin:
 
     def setUp(self, *args, **kwargs):
         """Initiate test context."""
-        self.client.force_login(self.user)
+        self.client.force_authenticate(self.user)
         self.set_global_parameter(
             "server_location", "http://example.test/radicale/", app="calendars"
         )
@@ -72,8 +72,7 @@ class ViewsTestCase(TestDataMixin, ModoAPITestCase):
     def test_user_settings(self):
         """Check that remote collection creation request is sent."""
         # 1. Addressbook with contacts must be synced manually
-        data = {"username": self.user.username, "password": "toto"}
-        self.client.post(reverse("core:login"), data)
+        self.client.force_authenticate(self.user)
         self.enable_cdav_sync()
         self.addressbook.refresh_from_db()
         self.assertIs(self.addressbook.last_sync, None)
@@ -81,8 +80,7 @@ class ViewsTestCase(TestDataMixin, ModoAPITestCase):
         # 2. Addressbook with no contacts can be considered synced
         user = core_models.User.objects.get(username="user@test2.com")
         abook = user.addressbook_set.first()
-        data = {"username": user.username, "password": "toto"}
-        self.client.post(reverse("core:login"), data)
+        self.client.force_authenticate(user)
         abook.refresh_from_db()
         self.assertIs(abook.last_sync, None)
         # Now enable sync.
@@ -312,7 +310,7 @@ class EmailAddressViewSetTestCase(TestDataMixin, ModoAPITestCase):
         self.assertEqual(len(response.data), 3)
 
 
-class ImportTestCase(TestDataMixin, ModoTestCase):
+class ImportTestCase(TestDataMixin, ModoAPITestCase):
 
     def setUp(self):
         super().setUp()

modoboa/core/api/v1/tests.py

@@ -1,9 +1,9 @@
 from django.urls import reverse_lazy
 
-from modoboa.lib.tests import ModoTestCase
+from modoboa.lib.tests import ModoAPITestCase
 
 
-class OpenAPITestCase(ModoTestCase):
+class OpenAPITestCase(ModoAPITestCase):
     openapi_schema_url = reverse_lazy("schema-v1-legacy")
 
     def test_unauthorized(self):

modoboa/core/api/v2/views.py

@@ -157,7 +157,9 @@ class ComponentsInformationAPIView(APIView):
 class NotificationsAPIView(APIView):
     """Return list of active notifications."""
 
-    permission_classes = [permissions.IsAuthenticated, IsSuperUser]
+    permission_classes = [
+        permissions.IsAuthenticated,
+    ]
     throttle_classes = [UserLesserDdosUser]
 
     @extend_schema(responses=serializers.NotificationSerializer(many=True))

modoboa/core/commands/deploy.py

@@ -218,6 +218,7 @@ class DeployCommand(Command):
                 allowed_host = "localhost"
         extra_settings = []
         extensions = parsed_args.extensions
+        amavis_enabled = False
         if extensions:
             if "all" in extensions:
                 extensions = self._get_extension_list()
@@ -233,6 +234,7 @@ class DeployCommand(Command):
                 exec_cmd(cmd, capture_output=False)
             extra_settings = self.find_extra_settings(extensions)
             extensions = [extension[1] for extension in extensions]
+            amavis_enabled = "modoboa.amavis" in extensions
 
         mod = __import__(parsed_args.name, globals(), locals(), [smart_str("settings")])
         tpl = self._render_template(
@@ -247,6 +249,7 @@ class DeployCommand(Command):
                 "devmode": parsed_args.devel,
                 "extensions": extensions,
                 "extra_settings": extra_settings,
+                "amavis_enabled": amavis_enabled,
             },
         )
         with open(f"{path}/settings.py", "w") as fp:

modoboa/core/commands/templates/settings.py.tpl

@@ -2,10 +2,10 @@
 Django settings for {{ name }} project.
 
 For more information on this file, see
-https://docs.djangoproject.com/en/4.2/topics/settings/
+https://docs.djangoproject.com/en/dev/topics/settings/
 
 For the full list of settings and their values, see
-https://docs.djangoproject.com/en/2.2/ref/settings/
+https://docs.djangoproject.com/en/dev/ref/settings/
 """
 
 from logging.handlers import SysLogHandler
@@ -17,9 +17,6 @@ env = environ.Env()
 BASE_DIR = os.path.realpath(os.path.dirname(os.path.dirname(__file__)))
 environ.Env.read_env(os.path.join(BASE_DIR, '.env'))
 
-# Quick-start development settings - unsuitable for production
-# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
-
 # SECURITY WARNING: keep the secret key used in production secret!
 SECRET_KEY = '{{ secret_key }}'
 
@@ -41,6 +38,19 @@ SITE_ID = 1
 # The email address that error messages come from, such as those sent to ADMINS
 #SERVER_EMAIL = 'webmaster@example.net'
 
+EMAIL_CLIENT_CONNECTION_SETTINGS = {
+    'imap': {
+        'HOSTNAME': '{{ allowed_host }}',
+        'SOCKET_TYPE': 'SSL',
+        'PORT': 993,
+    },
+    'smtp': {
+        'HOSTNAME': '{{ allowed_host }}',
+        'SOCKET_TYPE': 'STARTTLS',
+        'PORT': 587
+    }
+}
+
 # Security settings
 
 X_FRAME_OPTIONS = "SAMEORIGIN"
@@ -78,6 +88,7 @@ MODOBOA_APPS = (
     'modoboa.core',
     'modoboa.lib',
     'modoboa.admin',
+    'modoboa.autoconfig',
     'modoboa.transport',
     'modoboa.relaydomains',
     'modoboa.limits',
@@ -157,14 +168,14 @@ WSGI_APPLICATION = '{{ name }}.wsgi.application'
 
 
 # Database
-# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+# https://docs.djangoproject.com/en/dev/ref/settings/#databases
 
 DATABASES = {
     {% for conn in db_connections.values %}{{ conn|safe }}{% endfor %}
 }
 
 # Internationalization
-# https://docs.djangoproject.com/en/4.2/topics/i18n/
+# https://docs.djangoproject.com/en/dev/topics/i18n/
 
 LANGUAGE_CODE = '{{ lang }}'
 
@@ -177,12 +188,12 @@ USE_L10N = True
 USE_TZ = True
 
 # Default primary key field type
-# https://docs.djangoproject.com/en/3.2/ref/settings/#default-auto-field
+# https://docs.djangoproject.com/en/dev/ref/settings/#default-auto-field
 
 DEFAULT_AUTO_FIELD = 'django.db.models.AutoField'
 
 # Static files (CSS, JavaScript, Images)
-# https://docs.djangoproject.com/en/2.2/howto/static-files/
+# https://docs.djangoproject.com/en/dev/howto/static-files/
 
 STATIC_URL = '/sitestatic/'
 STATIC_ROOT = os.path.join(BASE_DIR, 'sitestatic')
@@ -224,7 +235,6 @@ REST_FRAMEWORK = {
     'DEFAULT_AUTHENTICATION_CLASSES': (
         'oauth2_provider.contrib.rest_framework.OAuth2Authentication',
         'rest_framework.authentication.TokenAuthentication',
-        'rest_framework.authentication.SessionAuthentication',
     ),
     'DEFAULT_SCHEMA_CLASS': 'drf_spectacular.openapi.AutoSchema',
     'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.NamespaceVersioning',
@@ -295,7 +305,7 @@ CACHES = {
 
 
 # Password validation
-# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
+# https://docs.djangoproject.com/en/dev/ref/settings/#auth-password-validators
 
 AUTH_PASSWORD_VALIDATORS = [
     {
@@ -384,7 +394,11 @@ SILENCED_SYSTEM_CHECKS = [
 ]
 
 PHONENUMBER_DB_FORMAT = 'INTERNATIONAL'
-
+{% if amavis_enabled %}
+# Amavis settings
+DATABASE_ROUTERS = ["modoboa.amavis.dbrouter.AmavisRouter"]
+AMAVIS_DEFAULT_DATABASE_ENCODING = "LATIN1"  # or any value matching your database config
+{% endif %}
 # Load settings from extensions
 {% for extension in extra_settings %}
 try:

modoboa/core/models.py

@@ -220,7 +220,7 @@ class User(AbstractUser):
         return self.email
 
     @property
-    def tfa_enabled(self):
+    def tfa_enabled(self) -> bool:
         return self.totp_enabled or self.webauthn_enabled
 
     def is_owner(self, obj):

modoboa/core/tests/test_ldap.py

@@ -158,6 +158,8 @@ class ProfileTestCase(LDAPTestCaseMixin, ModoAPITestCase):
 
         username = "testuser@example.com"
         self.authenticate(username, "test")
+        user = models.User.objects.get(username=username)
+        self.client.force_authenticate(user)
         response = self.client.post(
             reverse("v2:account-set-me-password"),
             {"password": "test", "new_password": "Toto1234"},