From 8a60b658b46dd8b8f9a99581849d8fa04dc76fdb Mon Sep 17 00:00:00 2001 From: Vincent Kling Date: Thu, 20 Oct 2022 13:41:35 +0200 Subject: [PATCH 01/13] Implement FETCHMAIL_ENABLED --- core/admin/mailu/configuration.py | 5 +++-- core/admin/mailu/ui/templates/sidebar.html | 2 ++ core/admin/mailu/ui/views/fetches.py | 9 +++++++++ docs/configuration.rst | 3 +++ setup/flavors/compose/mailu.env | 3 +++ towncrier/newsfragments/2127.feature | 1 + 6 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 towncrier/newsfragments/2127.feature diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py index 2f137c0c..e7de2a40 100644 --- a/core/admin/mailu/configuration.py +++ b/core/admin/mailu/configuration.py @@ -16,13 +16,14 @@ DEFAULT_CONFIG = { 'DOMAIN_REGISTRATION': False, 'TEMPLATES_AUTO_RELOAD': True, 'MEMORY_SESSIONS': False, + 'FETCHMAIL_ENABLED': False, # Database settings 'DB_FLAVOR': None, 'DB_USER': 'mailu', 'DB_PW': None, 'DB_HOST': 'database', 'DB_NAME': 'mailu', - 'SQLITE_DATABASE_FILE':'data/main.db', + 'SQLITE_DATABASE_FILE': 'data/main.db', 'SQLALCHEMY_DATABASE_URI': 'sqlite:////data/main.db', 'SQLALCHEMY_TRACK_MODIFICATIONS': False, # Statistics management @@ -59,7 +60,7 @@ DEFAULT_CONFIG = { # Web settings 'SITENAME': 'Mailu', 'WEBSITE': 'https://mailu.io', - 'ADMIN' : 'none', + 'ADMIN': 'none', 'WEB_ADMIN': '/admin', 'WEB_WEBMAIL': '/webmail', 'WEBMAIL': 'none', diff --git a/core/admin/mailu/ui/templates/sidebar.html b/core/admin/mailu/ui/templates/sidebar.html index a57a2abe..54448c8b 100644 --- a/core/admin/mailu/ui/templates/sidebar.html +++ b/core/admin/mailu/ui/templates/sidebar.html @@ -31,12 +31,14 @@

{% trans %}Auto-reply{% endtrans %}

+ {%- if config["FETCHMAIL_ENABLED"] %}

  • {% trans %}Fetched accounts{% endtrans %}
    • + {%- endif %}
  • diff --git a/core/admin/mailu/ui/views/fetches.py b/core/admin/mailu/ui/views/fetches.py index ec208af1..ca837a8e 100644 --- a/core/admin/mailu/ui/views/fetches.py +++ b/core/admin/mailu/ui/views/fetches.py @@ -1,5 +1,6 @@ from mailu import models from mailu.ui import ui, forms, access +from flask import current_app as app import flask import flask_login @@ -10,6 +11,8 @@ import wtforms @ui.route('/fetch/list/', methods=['GET']) @access.owner(models.User, 'user_email') def fetch_list(user_email): + if not app.config['FETCHMAIL_ENABLED']: + flask.abort(404) user_email = user_email or flask_login.current_user.email user = models.User.query.get(user_email) or flask.abort(404) return flask.render_template('fetch/list.html', user=user) @@ -19,6 +22,8 @@ def fetch_list(user_email): @ui.route('/fetch/create/', methods=['GET', 'POST']) @access.owner(models.User, 'user_email') def fetch_create(user_email): + if not app.config['FETCHMAIL_ENABLED']: + flask.abort(404) user_email = user_email or flask_login.current_user.email user = models.User.query.get(user_email) or flask.abort(404) form = forms.FetchForm() @@ -37,6 +42,8 @@ def fetch_create(user_email): @ui.route('/fetch/edit/', methods=['GET', 'POST']) @access.owner(models.Fetch, 'fetch_id') def fetch_edit(fetch_id): + if not app.config['FETCHMAIL_ENABLED']: + flask.abort(404) fetch = models.Fetch.query.get(fetch_id) or flask.abort(404) form = forms.FetchForm(obj=fetch) if form.validate_on_submit(): @@ -55,6 +62,8 @@ def fetch_edit(fetch_id): @access.confirmation_required("delete a fetched account") @access.owner(models.Fetch, 'fetch_id') def fetch_delete(fetch_id): + if not app.config['FETCHMAIL_ENABLED']: + flask.abort(404) fetch = models.Fetch.query.get(fetch_id) or flask.abort(404) user = fetch.user models.db.session.delete(fetch) diff --git a/docs/configuration.rst b/docs/configuration.rst index 80f97d3a..58965dff 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -102,6 +102,9 @@ support or e.g. mismatching TLS versions to deliver emails to Mailu. .. _fetchmail: +When ``FETCHMAIL_ENABLED`` is set to ``True``, the fetchmail functionality is shown in the admin interface. +The container itself still needs to be deployed manually. As fetchmail is optional, ``FETCHMAIL_ENABLED`` defaults to ``False``. + The ``FETCHMAIL_DELAY`` is a delay (in seconds) for the fetchmail service to go and fetch new email if available. Do not use too short delays if you do not want to be blacklisted by external services, but not too long delays if you diff --git a/setup/flavors/compose/mailu.env b/setup/flavors/compose/mailu.env index 2963c882..4e13a8c9 100644 --- a/setup/flavors/compose/mailu.env +++ b/setup/flavors/compose/mailu.env @@ -79,6 +79,9 @@ RELAYNETS= # Will relay all outgoing mails if configured RELAYHOST={{ relayhost }} +# Show fetchmail functionality in admin interface +FETCHMAIL_ENABLED={{ fetchmail_enabled or 'False' }} + # Fetchmail delay FETCHMAIL_DELAY={{ fetchmail_delay or '600' }} diff --git a/towncrier/newsfragments/2127.feature b/towncrier/newsfragments/2127.feature new file mode 100644 index 00000000..dd4951dd --- /dev/null +++ b/towncrier/newsfragments/2127.feature @@ -0,0 +1 @@ +Add FETCHMAIL_ENABLED to toggle the fetchmail functionality in the admin interface \ No newline at end of file From 83fdc07a6fc2c8b3fad75619c4e8ce988dff8621 Mon Sep 17 00:00:00 2001 From: Vincent Kling Date: Fri, 4 Nov 2022 11:59:26 +0100 Subject: [PATCH 02/13] Default FETCHMAIL_ENABLED to True --- core/admin/mailu/configuration.py | 2 +- docs/configuration.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py index e7de2a40..060edc8e 100644 --- a/core/admin/mailu/configuration.py +++ b/core/admin/mailu/configuration.py @@ -16,7 +16,7 @@ DEFAULT_CONFIG = { 'DOMAIN_REGISTRATION': False, 'TEMPLATES_AUTO_RELOAD': True, 'MEMORY_SESSIONS': False, - 'FETCHMAIL_ENABLED': False, + 'FETCHMAIL_ENABLED': True, # Database settings 'DB_FLAVOR': None, 'DB_USER': 'mailu', diff --git a/docs/configuration.rst b/docs/configuration.rst index 58965dff..6bf0845b 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -102,8 +102,8 @@ support or e.g. mismatching TLS versions to deliver emails to Mailu. .. _fetchmail: -When ``FETCHMAIL_ENABLED`` is set to ``True``, the fetchmail functionality is shown in the admin interface. -The container itself still needs to be deployed manually. As fetchmail is optional, ``FETCHMAIL_ENABLED`` defaults to ``False``. +When ``FETCHMAIL_ENABLED`` is set to ``True``, the fetchmail functionality is enabled in the admin interface. +The container itself still needs to be deployed manually. ``FETCHMAIL_ENABLED`` defaults to ``True``. The ``FETCHMAIL_DELAY`` is a delay (in seconds) for the fetchmail service to go and fetch new email if available. Do not use too short delays if you do not From 6901b0f05e8fb5167fa7c1d0c8cec6ea002bef3f Mon Sep 17 00:00:00 2001 From: Vincent Kling Date: Tue, 8 Nov 2022 11:47:20 +0100 Subject: [PATCH 03/13] Implement FETCHMAIL_ENABLED in fetchmail.py --- optional/fetchmail/fetchmail.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/optional/fetchmail/fetchmail.py b/optional/fetchmail/fetchmail.py index 5459de59..1889d808 100755 --- a/optional/fetchmail/fetchmail.py +++ b/optional/fetchmail/fetchmail.py @@ -1,5 +1,5 @@ #!/usr/bin/python3 - +import distutils.util import time import os import tempfile @@ -96,5 +96,9 @@ def run(debug): if __name__ == "__main__": while True: time.sleep(int(os.environ.get("FETCHMAIL_DELAY", 60))) + + if not os.environ.get("FETCHMAIL_ENABLED", 'True') in ('True', 'true'): + continue + run(os.environ.get("DEBUG", None) == "True") sys.stdout.flush() From 4a74cd9afeb5c75a1f3ceaadd5cdfdb07d0b8918 Mon Sep 17 00:00:00 2001 From: Vincent Kling Date: Tue, 8 Nov 2022 11:56:08 +0100 Subject: [PATCH 04/13] Resolve conflict --- optional/fetchmail/fetchmail.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/optional/fetchmail/fetchmail.py b/optional/fetchmail/fetchmail.py index 1889d808..2afd103b 100755 --- a/optional/fetchmail/fetchmail.py +++ b/optional/fetchmail/fetchmail.py @@ -1,5 +1,5 @@ #!/usr/bin/python3 -import distutils.util + import time import os import tempfile From 728afdd34a698e065240b0650e73ab394fa2e8f2 Mon Sep 17 00:00:00 2001 From: Vincent Kling Date: Tue, 8 Nov 2022 16:51:35 +0100 Subject: [PATCH 05/13] Add basic logging for FETCHMAIL_ENABLED and FETCHMAIL_DELAY --- optional/fetchmail/fetchmail.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/optional/fetchmail/fetchmail.py b/optional/fetchmail/fetchmail.py index 2afd103b..dfac6d2d 100755 --- a/optional/fetchmail/fetchmail.py +++ b/optional/fetchmail/fetchmail.py @@ -95,9 +95,12 @@ def run(debug): if __name__ == "__main__": while True: - time.sleep(int(os.environ.get("FETCHMAIL_DELAY", 60))) + delay = int(os.environ.get("FETCHMAIL_DELAY", 60)) + print("Sleeping for {} seconds".format(delay)) + time.sleep(delay) if not os.environ.get("FETCHMAIL_ENABLED", 'True') in ('True', 'true'): + print("Fetchmail disabled, skipping...") continue run(os.environ.get("DEBUG", None) == "True") From 031a157ad9f3f966e47114b1c7dc7dd014963eec Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Tue, 15 Nov 2022 17:25:44 +0100 Subject: [PATCH 06/13] fix the linux/arm/v7 build --- core/base/Dockerfile | 2 ++ 1 file changed, 2 insertions(+) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index 35bcbd15..1ddffc1b 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -8,11 +8,13 @@ ENV TZ=Etc/UTC LANG=C.UTF-8 ARG MAILU_UID=1000 ARG MAILU_GID=1000 +ARG TARGETPLATFORM RUN set -euxo pipefail \ ; addgroup -Sg ${MAILU_GID} mailu \ ; adduser -Sg ${MAILU_UID} -G mailu -h /app -g "mailu app" -s /bin/bash mailu \ ; apk add --no-cache bash ca-certificates curl python3 tzdata \ + ; if [[ "$TARGETPLATFORM" == 'linux/arm/v7' ]]; then exit;fi \ ; machine="$(uname -m)" \ ; if [[ "${machine}" == x86_64 || "${machine}" == armv8* || "${machine}" == aarch64 ]] \ ; then \ From 1f895d5f82de3afee546870022ff477b49cc60d9 Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Wed, 16 Nov 2022 11:53:52 +0100 Subject: [PATCH 07/13] ghostwheel42's suggestion --- core/base/Dockerfile | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index 1ddffc1b..4972d303 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -14,13 +14,8 @@ RUN set -euxo pipefail \ ; addgroup -Sg ${MAILU_GID} mailu \ ; adduser -Sg ${MAILU_UID} -G mailu -h /app -g "mailu app" -s /bin/bash mailu \ ; apk add --no-cache bash ca-certificates curl python3 tzdata \ - ; if [[ "$TARGETPLATFORM" == 'linux/arm/v7' ]]; then exit;fi \ - ; machine="$(uname -m)" \ - ; if [[ "${machine}" == x86_64 || "${machine}" == armv8* || "${machine}" == aarch64 ]] \ - ; then \ - echo "Installing hardened-malloc" \ - ; apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc \ - ; fi + ; ! [[ "${TARGETPLATFORM}" != linux/arm/v7 && \( "${machine}" == x86_64 || "${machine}" == armv8* || "${machine}" == aarch64 \) ]] \ + || apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc ENV LD_PRELOAD=/usr/lib/libhardened_malloc.so From d43e7f72df9cadb0c5f74d80c2dda54e6c605a92 Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Wed, 16 Nov 2022 11:55:12 +0100 Subject: [PATCH 08/13] ghostwheel42's suggestion --- core/base/Dockerfile | 1 + 1 file changed, 1 insertion(+) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index 4972d303..4a7ffb38 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -14,6 +14,7 @@ RUN set -euxo pipefail \ ; addgroup -Sg ${MAILU_GID} mailu \ ; adduser -Sg ${MAILU_UID} -G mailu -h /app -g "mailu app" -s /bin/bash mailu \ ; apk add --no-cache bash ca-certificates curl python3 tzdata \ + ; machine="$(uname -m)" \ ; ! [[ "${TARGETPLATFORM}" != linux/arm/v7 && \( "${machine}" == x86_64 || "${machine}" == armv8* || "${machine}" == aarch64 \) ]] \ || apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc From 04f6bd263390265da9357b17b9f77a4fd6a22330 Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Wed, 16 Nov 2022 12:23:14 +0100 Subject: [PATCH 09/13] simplify --- core/base/Dockerfile | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index 4a7ffb38..bded67e0 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -15,8 +15,8 @@ RUN set -euxo pipefail \ ; adduser -Sg ${MAILU_UID} -G mailu -h /app -g "mailu app" -s /bin/bash mailu \ ; apk add --no-cache bash ca-certificates curl python3 tzdata \ ; machine="$(uname -m)" \ - ; ! [[ "${TARGETPLATFORM}" != linux/arm/v7 && \( "${machine}" == x86_64 || "${machine}" == armv8* || "${machine}" == aarch64 \) ]] \ - || apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc + ; [[ "${TARGETPLATFORM}" != linux/arm/v7 && \( "${machine}" == x86_64 || "${machine}" == armv8* || "${machine}" == aarch64 \) ]] \ + && apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc ENV LD_PRELOAD=/usr/lib/libhardened_malloc.so From aa44a42654c9f4175922410a307645d1addaa630 Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Wed, 16 Nov 2022 12:33:05 +0100 Subject: [PATCH 10/13] ensure we compile the wheels with bells and whistles too --- core/base/Dockerfile | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index bded67e0..bfc8cbc9 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -42,6 +42,10 @@ RUN set -euxo pipefail \ ; rm -f /tmp/*.pem ENV PATH="${VIRTUAL_ENV}/bin:${PATH}" +ENV CXXFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" +ENV CFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" +ENV CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2" +ENV LDFLAGS="-Wl,-z,relro" COPY requirements-${MAILU_DEPS}.txt ./ COPY libs/ libs/ From 7ab3d8f9feda2375e3a689dd5002f6712146c351 Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Wed, 16 Nov 2022 12:34:45 +0100 Subject: [PATCH 11/13] There is no good reason not to export them is the base image too --- core/base/Dockerfile | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index bfc8cbc9..57ed1fa1 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -19,6 +19,10 @@ RUN set -euxo pipefail \ && apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc ENV LD_PRELOAD=/usr/lib/libhardened_malloc.so +ENV CXXFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" +ENV CFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" +ENV CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2" +ENV LDFLAGS="-Wl,-z,relro" WORKDIR /app @@ -42,10 +46,6 @@ RUN set -euxo pipefail \ ; rm -f /tmp/*.pem ENV PATH="${VIRTUAL_ENV}/bin:${PATH}" -ENV CXXFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" -ENV CFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" -ENV CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2" -ENV LDFLAGS="-Wl,-z,relro" COPY requirements-${MAILU_DEPS}.txt ./ COPY libs/ libs/ From 32f3241569a0ed68e59d8bb0bfde4bc3c87ff384 Mon Sep 17 00:00:00 2001 From: Florent Daigniere Date: Wed, 16 Nov 2022 12:47:43 +0100 Subject: [PATCH 12/13] ensure we have -pie too --- core/base/Dockerfile | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/core/base/Dockerfile b/core/base/Dockerfile index 57ed1fa1..4639781b 100644 --- a/core/base/Dockerfile +++ b/core/base/Dockerfile @@ -19,9 +19,9 @@ RUN set -euxo pipefail \ && apk add --no-cache --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing hardened-malloc ENV LD_PRELOAD=/usr/lib/libhardened_malloc.so -ENV CXXFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" -ENV CFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security" -ENV CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2" +ENV CXXFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security -pie -fPIE" +ENV CFLAGS="-g -O2 -fdebug-prefix-map=/app=. -fstack-protector-strong -Wformat -Werror=format-security -pie -fPIE" +ENV CPPFLAGS="-Wdate-time -D_FORTIFY_SOURCE=2 -pie -fPIE" ENV LDFLAGS="-Wl,-z,relro" WORKDIR /app From 8afb544a10238e831dea5428b4c2bc9f38de454b Mon Sep 17 00:00:00 2001 From: Dimitri Huisman Date: Wed, 16 Nov 2022 12:12:04 +0000 Subject: [PATCH 13/13] Default FETCHMAIL_ENABLED to False --- core/admin/mailu/configuration.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/admin/mailu/configuration.py b/core/admin/mailu/configuration.py index 060edc8e..e7de2a40 100644 --- a/core/admin/mailu/configuration.py +++ b/core/admin/mailu/configuration.py @@ -16,7 +16,7 @@ DEFAULT_CONFIG = { 'DOMAIN_REGISTRATION': False, 'TEMPLATES_AUTO_RELOAD': True, 'MEMORY_SESSIONS': False, - 'FETCHMAIL_ENABLED': True, + 'FETCHMAIL_ENABLED': False, # Database settings 'DB_FLAVOR': None, 'DB_USER': 'mailu',