mirror of
https://github.com/chatmail/relay.git
synced 2026-05-11 16:34:39 +00:00
Compare commits
1 Commits
j4n/docker
...
link2xt/do
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d96c9221c4 |
@@ -1,18 +0,0 @@
|
|||||||
data/
|
|
||||||
venv/
|
|
||||||
__pycache__
|
|
||||||
*.pyc
|
|
||||||
*.orig
|
|
||||||
*.ini
|
|
||||||
.pytest_cache
|
|
||||||
.env
|
|
||||||
|
|
||||||
# Slim build context — .git/ alone can be 100s of MB
|
|
||||||
.git
|
|
||||||
.github/
|
|
||||||
docs/
|
|
||||||
tests/
|
|
||||||
|
|
||||||
# Exclude markdown files but keep www/src/*.md (used by WebsiteDeployer)
|
|
||||||
*.md
|
|
||||||
!www/**/*.md
|
|
||||||
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
33
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@@ -1,33 +0,0 @@
|
|||||||
---
|
|
||||||
name: Bug report
|
|
||||||
about: Report something that isn't working.
|
|
||||||
title: ''
|
|
||||||
assignees: ''
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
<!--
|
|
||||||
Please fill out as much of this form as you can (leaving out stuff that is not applicable is ok).
|
|
||||||
-->
|
|
||||||
|
|
||||||
- Server OS (Operating System) - preferably Debian 12:
|
|
||||||
- On which OS you run cmdeploy:
|
|
||||||
- chatmail/relay version: `git rev-parse HEAD`
|
|
||||||
|
|
||||||
## Expected behavior
|
|
||||||
|
|
||||||
*What did you try to achieve?*
|
|
||||||
|
|
||||||
## Actual behavior
|
|
||||||
|
|
||||||
*What happened instead?*
|
|
||||||
|
|
||||||
### Steps to reproduce the problem:
|
|
||||||
|
|
||||||
1.
|
|
||||||
2.
|
|
||||||
|
|
||||||
### Screenshots
|
|
||||||
|
|
||||||
### Logs
|
|
||||||
|
|
||||||
1
.github/ISSUE_TEMPLATE/config.yml
vendored
1
.github/ISSUE_TEMPLATE/config.yml
vendored
@@ -1 +0,0 @@
|
|||||||
blank_issues_enabled: true
|
|
||||||
7
.github/workflows/ci.yaml
vendored
7
.github/workflows/ci.yaml
vendored
@@ -10,12 +10,7 @@ jobs:
|
|||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
# Checkout pull request HEAD commit instead of merge commit
|
|
||||||
# Otherwise `test_deployed_state` will be unhappy.
|
|
||||||
with:
|
|
||||||
ref: ${{ github.event.pull_request.head.sha }}
|
|
||||||
- name: download filtermail
|
|
||||||
run: curl -L https://github.com/chatmail/filtermail/releases/download/v0.5.2/filtermail-x86_64 -o /usr/local/bin/filtermail && chmod +x /usr/local/bin/filtermail
|
|
||||||
- name: run chatmaild tests
|
- name: run chatmaild tests
|
||||||
working-directory: chatmaild
|
working-directory: chatmaild
|
||||||
run: pipx run tox
|
run: pipx run tox
|
||||||
|
|||||||
375
.github/workflows/deploy.yaml
vendored
375
.github/workflows/deploy.yaml
vendored
@@ -1,375 +0,0 @@
|
|||||||
name: Deploy
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- j4n/docker-pr
|
|
||||||
pull_request:
|
|
||||||
paths-ignore:
|
|
||||||
- 'scripts/**'
|
|
||||||
- '**/README.md'
|
|
||||||
- 'CHANGELOG.md'
|
|
||||||
- 'LICENSE'
|
|
||||||
|
|
||||||
env:
|
|
||||||
REGISTRY: ghcr.io
|
|
||||||
IMAGE_NAME: ${{ github.repository }}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
build-docker:
|
|
||||||
name: Build Docker image
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
|
||||||
contents: read
|
|
||||||
packages: write
|
|
||||||
outputs:
|
|
||||||
image: ${{ steps.image-ref.outputs.image }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: Set up Docker Buildx
|
|
||||||
uses: docker/setup-buildx-action@v3
|
|
||||||
|
|
||||||
- name: Login to GHCR
|
|
||||||
if: github.event_name == 'push'
|
|
||||||
uses: docker/login-action@v3
|
|
||||||
with:
|
|
||||||
registry: ${{ env.REGISTRY }}
|
|
||||||
username: ${{ github.actor }}
|
|
||||||
password: ${{ secrets.GITHUB_TOKEN }}
|
|
||||||
|
|
||||||
- name: Extract metadata (tags, labels)
|
|
||||||
id: meta
|
|
||||||
uses: docker/metadata-action@v5
|
|
||||||
with:
|
|
||||||
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
|
||||||
tags: |
|
|
||||||
# Tagged releases: v1.2.3 -> :1.2.3, :1.2, :latest
|
|
||||||
type=semver,pattern={{version}}
|
|
||||||
type=semver,pattern={{major}}.{{minor}}
|
|
||||||
# Branch pushes: foo/docker-pr -> :foo-docker-pr
|
|
||||||
type=ref,event=branch
|
|
||||||
# Always: :sha-<hash>
|
|
||||||
type=sha
|
|
||||||
|
|
||||||
- name: Build and push
|
|
||||||
uses: docker/build-push-action@v6
|
|
||||||
with:
|
|
||||||
context: .
|
|
||||||
file: docker/chatmail_relay.dockerfile
|
|
||||||
push: ${{ github.event_name == 'push' }}
|
|
||||||
tags: ${{ steps.meta.outputs.tags }}
|
|
||||||
labels: ${{ steps.meta.outputs.labels }}
|
|
||||||
cache-from: type=gha
|
|
||||||
cache-to: type=gha,mode=max
|
|
||||||
build-args: |
|
|
||||||
GIT_HASH=${{ github.sha }}
|
|
||||||
|
|
||||||
- name: Output image reference
|
|
||||||
id: image-ref
|
|
||||||
run: |
|
|
||||||
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
|
|
||||||
IMAGE="${{ env.REGISTRY }}/$(echo "${{ env.IMAGE_NAME }}" | tr '[:upper:]' '[:lower:]'):sha-${SHORT_SHA}"
|
|
||||||
echo "image=${IMAGE}" >> "$GITHUB_OUTPUT"
|
|
||||||
|
|
||||||
deploy:
|
|
||||||
name: Deploy to ${{ matrix.host }}
|
|
||||||
needs: build-docker
|
|
||||||
# dont do the regular tests on this branch
|
|
||||||
if: >-
|
|
||||||
!cancelled() && (
|
|
||||||
github.event_name == 'push' ||
|
|
||||||
(github.event_name == 'pull_request' && !startsWith(github.head_ref, 'j4n/'))
|
|
||||||
)
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
timeout-minutes: 60
|
|
||||||
strategy:
|
|
||||||
fail-fast: false
|
|
||||||
matrix:
|
|
||||||
include:
|
|
||||||
- host: staging2.testrun.org
|
|
||||||
acme_dir: acme
|
|
||||||
dkim_dir: dkimkeys
|
|
||||||
zone_file: staging.testrun.org-default.zone
|
|
||||||
disable_ipv6: false
|
|
||||||
add_ssh_keys: true
|
|
||||||
- host: staging-ipv4.testrun.org
|
|
||||||
acme_dir: acme-ipv4
|
|
||||||
dkim_dir: dkimkeys-ipv4
|
|
||||||
zone_file: staging-ipv4.testrun.org-default.zone
|
|
||||||
disable_ipv6: true
|
|
||||||
add_ssh_keys: false
|
|
||||||
environment:
|
|
||||||
name: ${{ matrix.host }}
|
|
||||||
url: https://${{ matrix.host }}/
|
|
||||||
concurrency: ${{ matrix.host }}
|
|
||||||
steps:
|
|
||||||
# --- Common setup ---
|
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: prepare SSH and save ACME/DKIM
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
ACME_DIR: ${{ matrix.acme_dir }}
|
|
||||||
DKIM_DIR: ${{ matrix.dkim_dir }}
|
|
||||||
ZONE: ${{ matrix.zone_file }}
|
|
||||||
run: |
|
|
||||||
mkdir ~/.ssh
|
|
||||||
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
|
||||||
chmod 600 ~/.ssh/id_ed25519
|
|
||||||
ssh-keyscan ${HOST} > ~/.ssh/known_hosts
|
|
||||||
# save previous acme & dkim state (trailing slash = copy contents)
|
|
||||||
rsync -avz root@${HOST}:/var/lib/acme/ ${ACME_DIR}/ || true
|
|
||||||
rsync -avz root@${HOST}:/etc/dkimkeys/ ${DKIM_DIR}/ || true
|
|
||||||
# backup to ns.testrun.org if contents are useful
|
|
||||||
if [ -f ${DKIM_DIR}/opendkim.private ]; then
|
|
||||||
rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" ${DKIM_DIR}/ root@ns.testrun.org:/tmp/${DKIM_DIR}/ || true
|
|
||||||
fi
|
|
||||||
if [ "$(ls -A ${ACME_DIR}/certs 2>/dev/null)" ]; then
|
|
||||||
rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" ${ACME_DIR}/ root@ns.testrun.org:/tmp/${ACME_DIR}/ || true
|
|
||||||
fi
|
|
||||||
# make sure CAA record isn't set
|
|
||||||
scp -o StrictHostKeyChecking=accept-new .github/workflows/${ZONE} root@ns.testrun.org:/etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org sed -i '/CAA/d' /etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org nsd-checkzone ${HOST} /etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org systemctl reload nsd
|
|
||||||
|
|
||||||
- name: rebuild VPS
|
|
||||||
env:
|
|
||||||
SERVER_ID: ${{ matrix.host == 'staging2.testrun.org' && secrets.STAGING_SERVER_ID || secrets.STAGING_IPV4_SERVER_ID }}
|
|
||||||
run: |
|
|
||||||
curl -X POST \
|
|
||||||
-H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
|
||||||
-H "Content-Type: application/json" \
|
|
||||||
-d '{"image":"debian-12"}' \
|
|
||||||
"https://api.hetzner.cloud/v1/servers/${SERVER_ID}/actions/rebuild"
|
|
||||||
|
|
||||||
- run: scripts/initenv.sh
|
|
||||||
- name: append venv/bin to PATH
|
|
||||||
run: echo venv/bin >>$GITHUB_PATH
|
|
||||||
|
|
||||||
- name: wait for VPS rebuild
|
|
||||||
id: wait-for-vps
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
rm ~/.ssh/known_hosts
|
|
||||||
while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new root@${HOST} id -u ; do sleep 1 ; done
|
|
||||||
|
|
||||||
- name: restore ACME/DKIM
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
ACME_DIR: ${{ matrix.acme_dir }}
|
|
||||||
DKIM_DIR: ${{ matrix.dkim_dir }}
|
|
||||||
run: |
|
|
||||||
# download from ns.testrun.org
|
|
||||||
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/${ACME_DIR}/ acme-restore/ || true
|
|
||||||
rsync -avz root@ns.testrun.org:/tmp/${DKIM_DIR}/ dkimkeys-restore/ || true
|
|
||||||
# restore to VPS
|
|
||||||
rsync -avz acme-restore/ root@${HOST}:/var/lib/acme/ || true
|
|
||||||
rsync -avz dkimkeys-restore/ root@${HOST}:/etc/dkimkeys/ || true
|
|
||||||
ssh root@${HOST} chown root:root -R /var/lib/acme || true
|
|
||||||
|
|
||||||
- name: bare offline tests
|
|
||||||
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
|
|
||||||
run: pytest --pyargs cmdeploy
|
|
||||||
|
|
||||||
- name: bare deploy
|
|
||||||
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
DISABLE_IPV6: ${{ matrix.disable_ipv6 }}
|
|
||||||
run: |
|
|
||||||
ssh root@${HOST} 'apt update && apt install -y git python3.11-venv python3-dev gcc'
|
|
||||||
ssh root@${HOST} 'git clone https://github.com/chatmail/relay'
|
|
||||||
ssh root@${HOST} "cd relay && git checkout ${{ github.head_ref || github.ref_name }}"
|
|
||||||
ssh root@${HOST} 'cd relay && scripts/initenv.sh'
|
|
||||||
ssh root@${HOST} "cd relay && scripts/cmdeploy init ${HOST}"
|
|
||||||
if [ "${DISABLE_IPV6}" = "true" ]; then
|
|
||||||
ssh root@${HOST} "sed -i 's#disable_ipv6 = False#disable_ipv6 = True#' relay/chatmail.ini"
|
|
||||||
fi
|
|
||||||
ssh root@${HOST} "sed -i 's/#\s*mtail_address/mtail_address/' relay/chatmail.ini"
|
|
||||||
ssh root@${HOST} "cd relay && scripts/cmdeploy run --verbose --skip-dns-check --ssh-host localhost"
|
|
||||||
|
|
||||||
- name: bare DNS
|
|
||||||
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
ZONE: ${{ matrix.zone_file }}
|
|
||||||
run: |
|
|
||||||
ssh root@${HOST} chown opendkim:opendkim -R /etc/dkimkeys
|
|
||||||
ssh root@${HOST} "cd relay && scripts/cmdeploy dns --zonefile staging-generated.zone --ssh-host localhost"
|
|
||||||
ssh root@${HOST} cat relay/staging-generated.zone >> .github/workflows/${ZONE}
|
|
||||||
cat .github/workflows/${ZONE}
|
|
||||||
scp .github/workflows/${ZONE} root@ns.testrun.org:/etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org nsd-checkzone ${HOST} /etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org systemctl reload nsd
|
|
||||||
|
|
||||||
- name: bare integration tests
|
|
||||||
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: ssh root@${HOST} "cd relay && CHATMAIL_DOMAIN2=ci-chatmail.testrun.org scripts/cmdeploy test --slow --ssh-host localhost"
|
|
||||||
|
|
||||||
- name: bare final DNS check
|
|
||||||
if: github.ref == 'refs/heads/main' || github.event_name == 'pull_request'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: ssh root@${HOST} "cd relay && scripts/cmdeploy dns -v --ssh-host localhost"
|
|
||||||
|
|
||||||
# --- Docker deploy (push only, runs even if bare failed) ---
|
|
||||||
|
|
||||||
- name: stop bare services
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
ssh root@${HOST} 'systemctl stop postfix dovecot nginx opendkim unbound filtermail doveauth chatmail-metadata iroh-relay mtail fcgiwrap acmetool 2>/dev/null || true'
|
|
||||||
|
|
||||||
- name: install Docker on VPS
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
ssh root@${HOST} 'apt-get update && apt-get install -y ca-certificates curl'
|
|
||||||
ssh root@${HOST} 'install -m 0755 -d /etc/apt/keyrings'
|
|
||||||
ssh root@${HOST} 'curl -fsSL https://download.docker.com/linux/debian/gpg -o /etc/apt/keyrings/docker.asc && chmod a+r /etc/apt/keyrings/docker.asc'
|
|
||||||
ssh root@${HOST} 'echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/debian $(. /etc/os-release && echo $VERSION_CODENAME) stable" > /etc/apt/sources.list.d/docker.list'
|
|
||||||
ssh root@${HOST} 'apt-get update && apt-get install -y docker-ce docker-ce-cli containerd.io docker-compose-plugin'
|
|
||||||
|
|
||||||
- name: prepare Docker bind mounts
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
ssh root@${HOST} 'mkdir -p /srv/chatmail/certs /srv/chatmail/dkim'
|
|
||||||
ssh root@${HOST} 'cp -a /var/lib/acme/. /srv/chatmail/certs/ && cp -a /etc/dkimkeys/. /srv/chatmail/dkim/' || true
|
|
||||||
|
|
||||||
- name: generate and upload chatmail.ini
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
cmdeploy init ${HOST}
|
|
||||||
sed -i 's/#\s*mtail_address/mtail_address/' chatmail.ini
|
|
||||||
scp chatmail.ini root@${HOST}:/srv/chatmail/chatmail.ini
|
|
||||||
|
|
||||||
- name: deploy with Docker
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
GHCR_IMAGE="${{ needs.build-docker.outputs.image }}"
|
|
||||||
rsync -avz --exclude='.git' --exclude='venv' --exclude='__pycache__' ./ root@${HOST}:/srv/chatmail/relay/
|
|
||||||
# Login to GHCR on VPS and pull pre-built image
|
|
||||||
echo "${{ secrets.GITHUB_TOKEN }}" | ssh root@${HOST} 'docker login ghcr.io -u ${{ github.actor }} --password-stdin'
|
|
||||||
ssh root@${HOST} "docker pull ${GHCR_IMAGE}"
|
|
||||||
ssh root@${HOST} "cd /srv/chatmail/relay && CHATMAIL_IMAGE=${GHCR_IMAGE} MAIL_DOMAIN=${HOST} docker compose -f docker-compose.yaml -f docker/docker-compose.ci.yaml up -d"
|
|
||||||
|
|
||||||
- name: wait for container healthy
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
# Stream journald inside the container
|
|
||||||
ssh root@${HOST} 'docker exec chatmail journalctl -f --no-pager' &
|
|
||||||
LOG_PID=$!
|
|
||||||
trap "kill $LOG_PID 2>/dev/null || true" EXIT
|
|
||||||
for i in $(seq 1 60); do
|
|
||||||
status=$(ssh root@${HOST} 'docker inspect --format={{.State.Health.Status}} chatmail 2>/dev/null' || echo "missing")
|
|
||||||
echo " [$i/60] status=$status"
|
|
||||||
if [ "$status" = "healthy" ]; then
|
|
||||||
echo "Container is healthy."
|
|
||||||
exit 0
|
|
||||||
fi
|
|
||||||
if [ "$status" = "unhealthy" ]; then
|
|
||||||
echo "Container is unhealthy!"
|
|
||||||
break
|
|
||||||
fi
|
|
||||||
sleep 5
|
|
||||||
done
|
|
||||||
echo "Container did not become healthy."
|
|
||||||
kill $LOG_PID 2>/dev/null || true
|
|
||||||
echo "--- failed units ---"
|
|
||||||
ssh root@${HOST} 'docker exec chatmail systemctl --failed --no-pager' || true
|
|
||||||
echo "--- service logs ---"
|
|
||||||
ssh root@${HOST} 'docker exec chatmail journalctl -u dovecot -u postfix -u nginx -u unbound --no-pager -n 50' || true
|
|
||||||
echo "--- listening ports ---"
|
|
||||||
ssh root@${HOST} 'docker exec chatmail ss -tlnp' || true
|
|
||||||
echo "--- chatmail.ini ---"
|
|
||||||
ssh root@${HOST} 'docker exec chatmail cat /etc/chatmail/chatmail.ini' || true
|
|
||||||
exit 1
|
|
||||||
|
|
||||||
- name: show container state
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: |
|
|
||||||
echo "--- listening ports ---"
|
|
||||||
ssh root@${HOST} 'docker exec chatmail ss -tlnp'
|
|
||||||
echo "--- chatmail.ini ---"
|
|
||||||
ssh root@${HOST} 'docker exec chatmail cat /etc/chatmail/chatmail.ini'
|
|
||||||
|
|
||||||
- name: Docker offline tests
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: CHATMAIL_DOCKER=chatmail pytest --pyargs cmdeploy
|
|
||||||
|
|
||||||
- name: Docker DNS
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
ZONE: ${{ matrix.zone_file }}
|
|
||||||
run: |
|
|
||||||
# Reset zone file in case bare DNS already appended to it
|
|
||||||
git checkout .github/workflows/${ZONE}
|
|
||||||
ssh root@${HOST} 'docker exec chatmail chown opendkim:opendkim -R /etc/dkimkeys'
|
|
||||||
ssh root@${HOST} 'docker exec chatmail cmdeploy dns --ssh-host @local --zonefile /opt/chatmail/staging.zone --verbose'
|
|
||||||
ssh root@${HOST} 'docker cp chatmail:/opt/chatmail/staging.zone /tmp/staging.zone'
|
|
||||||
scp root@${HOST}:/tmp/staging.zone staging-generated.zone
|
|
||||||
cat staging-generated.zone >> .github/workflows/${ZONE}
|
|
||||||
cat .github/workflows/${ZONE}
|
|
||||||
scp .github/workflows/${ZONE} root@ns.testrun.org:/etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org nsd-checkzone ${HOST} /etc/nsd/${HOST}.zone
|
|
||||||
ssh root@ns.testrun.org systemctl reload nsd
|
|
||||||
|
|
||||||
- name: Docker integration tests
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: CHATMAIL_DOCKER=chatmail CHATMAIL_DOMAIN2=ci-chatmail.testrun.org cmdeploy test --slow
|
|
||||||
|
|
||||||
- name: Docker final DNS check
|
|
||||||
if: >-
|
|
||||||
!cancelled() && github.event_name == 'push'
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
env:
|
|
||||||
HOST: ${{ matrix.host }}
|
|
||||||
run: ssh root@${HOST} 'docker exec chatmail cmdeploy dns -v --ssh-host @local'
|
|
||||||
|
|
||||||
# --- Cleanup ---
|
|
||||||
|
|
||||||
- name: add SSH keys
|
|
||||||
if: >-
|
|
||||||
!cancelled() && matrix.add_ssh_keys
|
|
||||||
&& steps.wait-for-vps.outcome == 'success'
|
|
||||||
run: ssh root@${{ matrix.host }} 'curl -s https://github.com/hpk42.keys https://github.com/j4n.keys >> .ssh/authorized_keys'
|
|
||||||
53
.github/workflows/docs-preview.yaml
vendored
53
.github/workflows/docs-preview.yaml
vendored
@@ -1,53 +0,0 @@
|
|||||||
name: documentation preview
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- 'doc/**'
|
|
||||||
- 'scripts/build-docs.sh'
|
|
||||||
- '.github/workflows/docs-preview.yaml'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
scripts:
|
|
||||||
name: build
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 'staging.chatmail.at/doc/relay/'
|
|
||||||
url: https://staging.chatmail.at/doc/relay/${{ steps.prepare.outputs.prid }}
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: initenv
|
|
||||||
run: scripts/initenv.sh
|
|
||||||
|
|
||||||
- name: append venv/bin to PATH
|
|
||||||
run: echo `pwd`/venv/bin >>$GITHUB_PATH
|
|
||||||
|
|
||||||
- name: build documentation
|
|
||||||
working-directory: doc
|
|
||||||
run: sphinx-build source build
|
|
||||||
|
|
||||||
- name: build documentation second time (for TOC)
|
|
||||||
working-directory: doc
|
|
||||||
run: sphinx-build source build
|
|
||||||
|
|
||||||
- name: Get Pullrequest ID
|
|
||||||
id: prepare
|
|
||||||
run: |
|
|
||||||
export PULLREQUEST_ID=$(echo "${{ github.ref }}" | cut -d "/" -f3)
|
|
||||||
echo "prid=$PULLREQUEST_ID" >> $GITHUB_OUTPUT
|
|
||||||
if [ $(expr length "${{ secrets.USERNAME }}") -gt "1" ]; then echo "uploadtoserver=true" >> $GITHUB_OUTPUT; fi
|
|
||||||
- run: |
|
|
||||||
echo "baseurl: /${{ steps.prepare.outputs.prid }}" >> _config.yml
|
|
||||||
|
|
||||||
- name: Upload preview
|
|
||||||
run: |
|
|
||||||
mkdir -p "$HOME/.ssh"
|
|
||||||
echo "${{ secrets.CHATMAIL_STAGING_SSHKEY }}" > "$HOME/.ssh/key"
|
|
||||||
chmod 600 "$HOME/.ssh/key"
|
|
||||||
rsync -rILvh -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no" $GITHUB_WORKSPACE/doc/build/ "${{ secrets.USERNAME }}@chatmail.at:/var/www/html/staging.chatmail.at/doc/relay/${{ steps.prepare.outputs.prid }}/"
|
|
||||||
|
|
||||||
- name: check links
|
|
||||||
working-directory: doc
|
|
||||||
run: sphinx-build --builder linkcheck source build
|
|
||||||
|
|
||||||
47
.github/workflows/docs.yaml
vendored
47
.github/workflows/docs.yaml
vendored
@@ -1,47 +0,0 @@
|
|||||||
name: build and upload documentation
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
branches:
|
|
||||||
- main
|
|
||||||
- 'missytake/docs-ci'
|
|
||||||
paths:
|
|
||||||
- 'doc/**'
|
|
||||||
- 'scripts/build-docs.sh'
|
|
||||||
- '.github/workflows/docs.yaml'
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
scripts:
|
|
||||||
name: build
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
environment:
|
|
||||||
name: 'chatmail.at/doc/relay/'
|
|
||||||
url: https://chatmail.at/doc/relay/
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
|
|
||||||
- name: initenv
|
|
||||||
run: scripts/initenv.sh
|
|
||||||
|
|
||||||
- name: append venv/bin to PATH
|
|
||||||
run: echo `pwd`/venv/bin >>$GITHUB_PATH
|
|
||||||
|
|
||||||
- name: build documentation
|
|
||||||
working-directory: doc
|
|
||||||
run: sphinx-build source build
|
|
||||||
|
|
||||||
- name: build documentation second time (for TOC)
|
|
||||||
working-directory: doc
|
|
||||||
run: sphinx-build source build
|
|
||||||
|
|
||||||
- name: check links
|
|
||||||
working-directory: doc
|
|
||||||
run: sphinx-build --builder linkcheck source build
|
|
||||||
|
|
||||||
- name: upload documentation
|
|
||||||
run: |
|
|
||||||
mkdir -p "$HOME/.ssh"
|
|
||||||
echo "${{ secrets.CHATMAIL_STAGING_SSHKEY }}" > "$HOME/.ssh/key"
|
|
||||||
chmod 600 "$HOME/.ssh/key"
|
|
||||||
rsync -rILvh -e "ssh -i $HOME/.ssh/key -o StrictHostKeyChecking=no" $GITHUB_WORKSPACE/doc/build/ "${{ secrets.USERNAME }}@chatmail.at:/var/www/html/chatmail.at/doc/relay/"
|
|
||||||
|
|
||||||
98
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
Normal file
98
.github/workflows/test-and-deploy-ipv4only.yaml
vendored
Normal file
@@ -0,0 +1,98 @@
|
|||||||
|
name: deploy on staging-ipv4.testrun.org, and run tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
paths-ignore:
|
||||||
|
- 'scripts/**'
|
||||||
|
- '**/README.md'
|
||||||
|
- 'CHANGELOG.md'
|
||||||
|
- 'LICENSE'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
name: deploy on staging-ipv4.testrun.org, and run tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 30
|
||||||
|
concurrency:
|
||||||
|
group: ci-ipv4-${{ github.workflow }}-${{ github.ref }}
|
||||||
|
cancel-in-progress: ${{ !contains(github.ref, '$GITHUB_REF') }}
|
||||||
|
steps:
|
||||||
|
- uses: jsok/serialize-workflow-action@v1
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: prepare SSH
|
||||||
|
run: |
|
||||||
|
mkdir ~/.ssh
|
||||||
|
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
||||||
|
chmod 600 ~/.ssh/id_ed25519
|
||||||
|
ssh-keyscan staging-ipv4.testrun.org > ~/.ssh/known_hosts
|
||||||
|
# save previous acme & dkim state
|
||||||
|
rsync -avz root@staging-ipv4.testrun.org:/var/lib/acme acme-ipv4 || true
|
||||||
|
rsync -avz root@staging-ipv4.testrun.org:/etc/dkimkeys dkimkeys-ipv4 || true
|
||||||
|
# store previous acme & dkim state on ns.testrun.org, if it contains useful certs
|
||||||
|
if [ -f dkimkeys-ipv4/dkimkeys/opendkim.private ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" dkimkeys-ipv4 root@ns.testrun.org:/tmp/ || true; fi
|
||||||
|
if [ "$(ls -A acme-ipv4/acme/certs)" ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" acme-ipv4 root@ns.testrun.org:/tmp/ || true; fi
|
||||||
|
# make sure CAA record isn't set
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new root@ns.testrun.org sed -i '/CAA/d' /etc/nsd/staging-ipv4.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
|
- name: rebuild staging-ipv4.testrun.org to have a clean VPS
|
||||||
|
run: |
|
||||||
|
curl -X POST \
|
||||||
|
-H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"image":"debian-12"}' \
|
||||||
|
"https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_SERVER_ID }}/actions/rebuild"
|
||||||
|
|
||||||
|
- run: scripts/initenv.sh
|
||||||
|
|
||||||
|
- name: append venv/bin to PATH
|
||||||
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
|
- name: upload TLS cert after rebuilding
|
||||||
|
run: |
|
||||||
|
echo " --- wait until staging-ipv4.testrun.org VPS is rebuilt --- "
|
||||||
|
rm ~/.ssh/known_hosts
|
||||||
|
while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org id -u ; do sleep 1 ; done
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org id -u
|
||||||
|
# download acme & dkim state from ns.testrun.org
|
||||||
|
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme-ipv4 acme-restore || true
|
||||||
|
rsync -avz root@ns.testrun.org:/tmp/dkimkeys-ipv4 dkimkeys-restore || true
|
||||||
|
# restore acme & dkim state to staging2.testrun.org
|
||||||
|
rsync -avz acme-restore/acme-ipv4/acme root@staging-ipv4.testrun.org:/var/lib/acme || true
|
||||||
|
rsync -avz dkimkeys-restore/dkimkeys-ipv4/dkimkeys root@staging-ipv4.testrun.org:/etc/dkimkeys || true
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
|
- name: run formatting checks
|
||||||
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
|
- name: run deploy-chatmail offline tests
|
||||||
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
- run: |
|
||||||
|
cmdeploy init staging-ipv4.testrun.org
|
||||||
|
sed -i 's#disable_ipv6 = False#disable_ipv6 = True#' chatmail.ini
|
||||||
|
|
||||||
|
- run: cmdeploy run
|
||||||
|
|
||||||
|
- name: set DNS entries
|
||||||
|
run: |
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging-ipv4.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
||||||
|
cmdeploy dns --zonefile staging-generated.zone
|
||||||
|
cat staging-generated.zone >> .github/workflows/staging-ipv4.testrun.org-default.zone
|
||||||
|
cat .github/workflows/staging-ipv4.testrun.org-default.zone
|
||||||
|
scp .github/workflows/staging-ipv4.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging-ipv4.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org nsd-checkzone staging-ipv4.testrun.org /etc/nsd/staging-ipv4.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
|
- name: cmdeploy test
|
||||||
|
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
|
- name: cmdeploy dns (try 3 times)
|
||||||
|
run: cmdeploy dns || cmdeploy dns || cmdeploy dns
|
||||||
|
|
||||||
96
.github/workflows/test-and-deploy.yaml
vendored
Normal file
96
.github/workflows/test-and-deploy.yaml
vendored
Normal file
@@ -0,0 +1,96 @@
|
|||||||
|
name: deploy on staging2.testrun.org, and run tests
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
pull_request:
|
||||||
|
paths-ignore:
|
||||||
|
- 'scripts/**'
|
||||||
|
- '**/README.md'
|
||||||
|
- 'CHANGELOG.md'
|
||||||
|
- 'LICENSE'
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
name: deploy on staging2.testrun.org, and run tests
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
timeout-minutes: 30
|
||||||
|
concurrency:
|
||||||
|
group: ci-${{ github.workflow }}-${{ github.ref }}
|
||||||
|
cancel-in-progress: ${{ !contains(github.ref, '$GITHUB_REF') }}
|
||||||
|
steps:
|
||||||
|
- uses: jsok/serialize-workflow-action@v1
|
||||||
|
with:
|
||||||
|
github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: prepare SSH
|
||||||
|
run: |
|
||||||
|
mkdir ~/.ssh
|
||||||
|
echo "${{ secrets.STAGING_SSH_KEY }}" >> ~/.ssh/id_ed25519
|
||||||
|
chmod 600 ~/.ssh/id_ed25519
|
||||||
|
ssh-keyscan staging2.testrun.org > ~/.ssh/known_hosts
|
||||||
|
# save previous acme & dkim state
|
||||||
|
rsync -avz root@staging2.testrun.org:/var/lib/acme . || true
|
||||||
|
rsync -avz root@staging2.testrun.org:/etc/dkimkeys . || true
|
||||||
|
# store previous acme & dkim state on ns.testrun.org, if it contains useful certs
|
||||||
|
if [ -f dkimkeys/opendkim.private ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" dkimkeys root@ns.testrun.org:/tmp/ || true; fi
|
||||||
|
if [ "$(ls -A acme/certs)" ]; then rsync -avz -e "ssh -o StrictHostKeyChecking=accept-new" acme root@ns.testrun.org:/tmp/ || true; fi
|
||||||
|
# make sure CAA record isn't set
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new root@ns.testrun.org sed -i '/CAA/d' /etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
|
- name: rebuild staging2.testrun.org to have a clean VPS
|
||||||
|
run: |
|
||||||
|
curl -X POST \
|
||||||
|
-H "Authorization: Bearer ${{ secrets.HETZNER_API_TOKEN }}" \
|
||||||
|
-H "Content-Type: application/json" \
|
||||||
|
-d '{"image":"debian-12"}' \
|
||||||
|
"https://api.hetzner.cloud/v1/servers/${{ secrets.STAGING_SERVER_ID }}/actions/rebuild"
|
||||||
|
|
||||||
|
- run: scripts/initenv.sh
|
||||||
|
|
||||||
|
- name: append venv/bin to PATH
|
||||||
|
run: echo venv/bin >>$GITHUB_PATH
|
||||||
|
|
||||||
|
- name: upload TLS cert after rebuilding
|
||||||
|
run: |
|
||||||
|
echo " --- wait until staging2.testrun.org VPS is rebuilt --- "
|
||||||
|
rm ~/.ssh/known_hosts
|
||||||
|
while ! ssh -o ConnectTimeout=180 -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org id -u ; do sleep 1 ; done
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org id -u
|
||||||
|
# download acme & dkim state from ns.testrun.org
|
||||||
|
rsync -e "ssh -o StrictHostKeyChecking=accept-new" -avz root@ns.testrun.org:/tmp/acme acme-restore || true
|
||||||
|
rsync -avz root@ns.testrun.org:/tmp/dkimkeys dkimkeys-restore || true
|
||||||
|
# restore acme & dkim state to staging2.testrun.org
|
||||||
|
rsync -avz acme-restore/acme/ root@staging2.testrun.org:/var/lib/acme || true
|
||||||
|
rsync -avz dkimkeys-restore/dkimkeys/ root@staging2.testrun.org:/etc/dkimkeys || true
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new -v root@staging2.testrun.org chown root:root -R /var/lib/acme || true
|
||||||
|
|
||||||
|
- name: run formatting checks
|
||||||
|
run: cmdeploy fmt -v
|
||||||
|
|
||||||
|
- name: run deploy-chatmail offline tests
|
||||||
|
run: pytest --pyargs cmdeploy
|
||||||
|
|
||||||
|
- run: cmdeploy init staging2.testrun.org
|
||||||
|
|
||||||
|
- run: cmdeploy run --verbose
|
||||||
|
|
||||||
|
- name: set DNS entries
|
||||||
|
run: |
|
||||||
|
ssh -o StrictHostKeyChecking=accept-new root@staging2.testrun.org chown opendkim:opendkim -R /etc/dkimkeys
|
||||||
|
cmdeploy dns --zonefile staging-generated.zone --verbose
|
||||||
|
cat staging-generated.zone >> .github/workflows/staging.testrun.org-default.zone
|
||||||
|
cat .github/workflows/staging.testrun.org-default.zone
|
||||||
|
scp .github/workflows/staging.testrun.org-default.zone root@ns.testrun.org:/etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org nsd-checkzone staging2.testrun.org /etc/nsd/staging2.testrun.org.zone
|
||||||
|
ssh root@ns.testrun.org systemctl reload nsd
|
||||||
|
|
||||||
|
- name: cmdeploy test
|
||||||
|
run: CHATMAIL_DOMAIN2=nine.testrun.org cmdeploy test --slow
|
||||||
|
|
||||||
|
- name: cmdeploy dns (try 3 times)
|
||||||
|
run: cmdeploy dns -v || cmdeploy dns -v || cmdeploy dns -v
|
||||||
|
|
||||||
8
.gitignore
vendored
8
.gitignore
vendored
@@ -4,7 +4,7 @@ __pycache__/
|
|||||||
*$py.class
|
*$py.class
|
||||||
*.swp
|
*.swp
|
||||||
*qr-*.png
|
*qr-*.png
|
||||||
chatmail*.ini
|
chatmail.ini
|
||||||
|
|
||||||
|
|
||||||
# C extensions
|
# C extensions
|
||||||
@@ -164,9 +164,3 @@ cython_debug/
|
|||||||
#.idea/
|
#.idea/
|
||||||
|
|
||||||
chatmail.zone
|
chatmail.zone
|
||||||
|
|
||||||
# docker
|
|
||||||
/data/
|
|
||||||
/custom/
|
|
||||||
docker-compose.override.yaml
|
|
||||||
.env
|
|
||||||
|
|||||||
432
CHANGELOG.md
432
CHANGELOG.md
@@ -1,491 +1,185 @@
|
|||||||
# Changelog for chatmail deployment
|
# Changelog for chatmail deployment
|
||||||
|
|
||||||
## 1.9.0 2025-12-18
|
## untagged
|
||||||
|
|
||||||
### Documentation
|
|
||||||
|
|
||||||
- Add RELEASE.md and CONTRIBUTING.md
|
|
||||||
- README update, mention Chatmail Cookbook project
|
|
||||||
|
|
||||||
### Bug Fixes
|
|
||||||
|
|
||||||
- Expire messages also from IMAP subfolders
|
|
||||||
- Use absolute path instead of relative path in message expiration script
|
|
||||||
- Restart Postfix and Dovecot automatically on failure
|
|
||||||
- acmetool: Use a fixed name and `reconcile` instead of `want`
|
|
||||||
|
|
||||||
### Features
|
|
||||||
|
|
||||||
- Report DKIM error code in SMTP response
|
|
||||||
- Remove development notice from the web pages
|
|
||||||
|
|
||||||
### Miscellaneous Tasks
|
|
||||||
|
|
||||||
- Update the heading in the CHANGELOG.md
|
|
||||||
- Setup git-cliff
|
|
||||||
- Run tests against ci-chatmail.testrun.org instead of nine.testrun.org
|
|
||||||
- Cleanup remaining echobot code, remove echobot user from deployment and passthrough recipients
|
|
||||||
|
|
||||||
## 1.8.0 2025-12-12
|
|
||||||
|
|
||||||
- Add imap_compress option to chatmail.ini
|
|
||||||
([#760](https://github.com/chatmail/relay/pull/760))
|
|
||||||
|
|
||||||
- Remove echobot from relays
|
|
||||||
([#753](https://github.com/chatmail/relay/pull/753))
|
|
||||||
|
|
||||||
- Fix `cmdeploy webdev`
|
|
||||||
([#743](https://github.com/chatmail/relay/pull/743))
|
|
||||||
|
|
||||||
- Add robots.txt to exclude all web crawlers
|
|
||||||
([#732](https://github.com/chatmail/relay/pull/732))
|
|
||||||
|
|
||||||
- acmetool: accept new Let's Encrypt ToS: https://letsencrypt.org/documents/LE-SA-v1.6-August-18-2025.pdf
|
|
||||||
([#729](https://github.com/chatmail/relay/pull/729))
|
|
||||||
|
|
||||||
- Organized cmdeploy into install, configure, and activate stages
|
|
||||||
([#695](https://github.com/chatmail/relay/pull/695))
|
|
||||||
|
|
||||||
- docs: move readme.md docs to sphinx documentation rendered at https://chatmail.at/doc/relay
|
|
||||||
([#711](https://github.com/chatmail/relay/pull/711))
|
|
||||||
|
|
||||||
- acmetool: replace cronjob with a systemd timer
|
|
||||||
([#719](https://github.com/chatmail/relay/pull/719))
|
|
||||||
|
|
||||||
- remove xstore@testrun.org from default passthrough recipients
|
|
||||||
([#722](https://github.com/chatmail/relay/pull/722))
|
|
||||||
|
|
||||||
- don't deploy the website if there are merge conflicts in the www folder
|
|
||||||
([#714](https://github.com/chatmail/relay/pull/714))
|
|
||||||
|
|
||||||
- acmetool: use ECDSA keys instead of RSA
|
|
||||||
([#689](https://github.com/chatmail/relay/pull/689))
|
|
||||||
|
|
||||||
- Require TLS 1.2 for outgoing SMTP connections
|
|
||||||
([#685](https://github.com/chatmail/relay/pull/685), [#730](https://github.com/chatmail/relay/pull/730))
|
|
||||||
|
|
||||||
- require STARTTLS for incoming port 25 connections
|
|
||||||
([#684](https://github.com/chatmail/relay/pull/684), [#730](https://github.com/chatmail/relay/pull/730))
|
|
||||||
|
|
||||||
- filtermail: run CPU-intensive handle_DATA in a thread pool executor
|
|
||||||
([#676](https://github.com/chatmail/relay/pull/676))
|
|
||||||
|
|
||||||
- don't use the complicated logging module in filtermail to exclude a potential source of errors.
|
|
||||||
([#674](https://github.com/chatmail/relay/pull/674))
|
|
||||||
|
|
||||||
- Specify nginx.conf to only handle `mail_domain`, www, and mta-sts domains
|
|
||||||
([#636](https://github.com/chatmail/relay/pull/636))
|
|
||||||
|
|
||||||
- Setup TURN server
|
|
||||||
([#621](https://github.com/chatmail/relay/pull/621))
|
|
||||||
|
|
||||||
- cmdeploy: make --ssh-host work with localhost
|
|
||||||
([#659](https://github.com/chatmail/relay/pull/659))
|
|
||||||
|
|
||||||
- Update iroh-relay to 0.35.0
|
|
||||||
([#650](https://github.com/chatmail/relay/pull/650))
|
|
||||||
|
|
||||||
- filtermail: accept mails from Protonmail
|
|
||||||
([#616](https://github.com/chatmail/relay/pull/616))
|
|
||||||
|
|
||||||
- Ignore all RCPT TO: parameters
|
|
||||||
([#651](https://github.com/chatmail/relay/pull/651))
|
|
||||||
|
|
||||||
- Increase opendkim DNS Timeout from 5 to 60 seconds
|
|
||||||
([#672](https://github.com/chatmail/relay/pull/672))
|
|
||||||
|
|
||||||
- Add config parameter for Let's Encrypt ACME email
|
|
||||||
([#663](https://github.com/chatmail/relay/pull/663))
|
|
||||||
|
|
||||||
- Use max username length in newemail.py, not min
|
|
||||||
([#648](https://github.com/chatmail/relay/pull/648))
|
|
||||||
|
|
||||||
- Add startup for `fcgiwrap.service` because sometimes it did not start automatically.
|
|
||||||
([#657](https://github.com/chatmail/relay/pull/657))
|
|
||||||
|
|
||||||
- Add `cmdeploy init --force` command for recreating chatmail.ini
|
|
||||||
([#656](https://github.com/chatmail/relay/pull/656))
|
|
||||||
|
|
||||||
- Increase maxproc for reinjecting ports from 10 to 100
|
|
||||||
([#646](https://github.com/chatmail/relay/pull/646))
|
|
||||||
|
|
||||||
- Allow ports 143 and 993 to be used by `dovecot` process
|
|
||||||
([#639](https://github.com/chatmail/relay/pull/639))
|
|
||||||
|
|
||||||
- Add `--skip-dns-check` argument to `cmdeploy run` command, which disables DNS record checking before installation.
|
|
||||||
([#661](https://github.com/chatmail/relay/pull/661))
|
|
||||||
|
|
||||||
- Rework expiry of message files and mailboxes in Python
|
|
||||||
to only do a single iteration over sometimes millions of messages
|
|
||||||
instead of doing "find" commands that iterate 9 times over the messages.
|
|
||||||
Provide an "fsreport" CLI for more fine grained analysis of message files.
|
|
||||||
([#637](https://github.com/chatmail/relay/pull/637))
|
|
||||||
|
|
||||||
|
|
||||||
## 1.7.0 2025-09-11
|
|
||||||
|
|
||||||
- Make www upload path configurable
|
|
||||||
([#618](https://github.com/chatmail/relay/pull/618))
|
|
||||||
|
|
||||||
- Check whether GCC is installed in initenv.sh
|
|
||||||
([#608](https://github.com/chatmail/relay/pull/608))
|
|
||||||
|
|
||||||
- Expire push notification tokens after 90 days
|
|
||||||
([#583](https://github.com/chatmail/relay/pull/583))
|
|
||||||
|
|
||||||
- Use official `mtail` binary instead of `mtail` package
|
|
||||||
([#581](https://github.com/chatmail/relay/pull/581))
|
|
||||||
|
|
||||||
- dovecot: install from download.delta.chat instead of openSUSE Build Service
|
|
||||||
([#590](https://github.com/chatmail/relay/pull/590))
|
|
||||||
|
|
||||||
- Reconfigure Dovecot imap-login service to high-performance mode
|
|
||||||
([#578](https://github.com/chatmail/relay/pull/578))
|
|
||||||
|
|
||||||
- Set timezone to improve dovecot performance
|
|
||||||
([#584](https://github.com/chatmail/relay/pull/584))
|
|
||||||
|
|
||||||
- Increase nginx connection limits
|
|
||||||
([#576](https://github.com/chatmail/relay/pull/576))
|
|
||||||
|
|
||||||
- If `dns-utils` needs to be installed before cmdeploy run, apt update to make sure it works
|
|
||||||
([#560](https://github.com/chatmail/relay/pull/560))
|
|
||||||
|
|
||||||
- filtermail: respect config message size limit
|
|
||||||
([#572](https://github.com/chatmail/relay/pull/572))
|
|
||||||
|
|
||||||
- Don't deploy if one of the ports used for chatmail relay services is occupied by an unexpected process
|
|
||||||
([#568](https://github.com/chatmail/relay/pull/568))
|
|
||||||
|
|
||||||
- Add config value after how many days large files are deleted
|
|
||||||
([#555](https://github.com/chatmail/relay/pull/555))
|
|
||||||
|
|
||||||
- cmdeploy: push relay version to /etc/chatmail-version
|
|
||||||
([#573](https://github.com/chatmail/relay/pull/573))
|
|
||||||
|
|
||||||
- filtermail: allow partial body length in OpenPGP payloads
|
|
||||||
([#570](https://github.com/chatmail/relay/pull/570))
|
|
||||||
|
|
||||||
- chatmaild: allow echobot to receive unencrypted messages by default
|
|
||||||
([#556](https://github.com/chatmail/relay/pull/556))
|
|
||||||
|
|
||||||
|
|
||||||
## 1.6.0 2025-04-11
|
|
||||||
|
|
||||||
- Handle Port-25 connect errors more gracefully (common with VPNs)
|
|
||||||
([#552](https://github.com/chatmail/relay/pull/552))
|
|
||||||
|
|
||||||
- Avoid "acmetool not found" during initial run
|
|
||||||
([#550](https://github.com/chatmail/relay/pull/550))
|
|
||||||
|
|
||||||
- Fix timezone handling such that client/servers do not need to use
|
|
||||||
same timezone.
|
|
||||||
([#553](https://github.com/chatmail/relay/pull/553))
|
|
||||||
|
|
||||||
- Enforce end-to-end encryption for incoming messages.
|
|
||||||
New user address mailboxes now get a `enforceE2EEincoming` file
|
|
||||||
which prohibits incoming cleartext messages from other domains.
|
|
||||||
An outside MTA trying to submit a cleartext message will
|
|
||||||
get a "523 Encryption Needed" response, see RFC5248.
|
|
||||||
If the file does not exist (as it the case for all existing accounts)
|
|
||||||
incoming cleartext messages are accepted.
|
|
||||||
([#538](https://github.com/chatmail/server/pull/538))
|
|
||||||
|
|
||||||
- Enforce end-to-end encryption between local addresses
|
|
||||||
([#535](https://github.com/chatmail/server/pull/535))
|
|
||||||
|
|
||||||
- unbound: check that port 53 is not occupied by a different process
|
|
||||||
([#537](https://github.com/chatmail/server/pull/537))
|
|
||||||
|
|
||||||
- unbound: before unbound is there, use 9.9.9.9 for resolving
|
|
||||||
([#518](https://github.com/chatmail/relay/pull/518))
|
|
||||||
|
|
||||||
- Limit the bind for the HTTPS server on 8443 to 127.0.0.1
|
|
||||||
([#522](https://github.com/chatmail/server/pull/522))
|
|
||||||
([#532](https://github.com/chatmail/server/pull/532))
|
|
||||||
|
|
||||||
- Send SNI when connecting to outside servers
|
|
||||||
([#524](https://github.com/chatmail/server/pull/524))
|
|
||||||
|
|
||||||
- postfix master.cf: use 127.0.0.1 for consistency
|
|
||||||
([#544](https://github.com/chatmail/relay/pull/544))
|
|
||||||
|
|
||||||
- Pass through `original_content` instead of `content` in filtermail
|
|
||||||
([#509](https://github.com/chatmail/server/pull/509))
|
|
||||||
|
|
||||||
- Document TLS requirements in the readme
|
|
||||||
([#514](https://github.com/chatmail/server/pull/514))
|
|
||||||
|
|
||||||
- Remove cleanup service from submission ports
|
|
||||||
([#512](https://github.com/chatmail/server/pull/512))
|
|
||||||
|
|
||||||
- cmdeploy dovecot: delete big messages after 7 days
|
|
||||||
([#504](https://github.com/chatmail/server/pull/504))
|
|
||||||
|
|
||||||
- mtail: fix getting logs from STDIN
|
|
||||||
([#502](https://github.com/chatmail/server/pull/502))
|
|
||||||
|
|
||||||
- filtermail: don't require exactly 2 lines after openPGP payload
|
|
||||||
([#497](https://github.com/chatmail/server/pull/497))
|
|
||||||
|
|
||||||
- cmdeploy dns: offer alternative DKIM record format for some web interfaces
|
|
||||||
([#470](https://github.com/chatmail/server/pull/470))
|
|
||||||
|
|
||||||
- journald: remove old logs from disk
|
|
||||||
([#490](https://github.com/chatmail/server/pull/490))
|
|
||||||
|
|
||||||
- opendkim: restart once every day to mend RAM leaks
|
|
||||||
([#498](https://github.com/chatmail/server/pull/498)
|
|
||||||
|
|
||||||
- migration guide: let opendkim own the DKIM keys directory
|
|
||||||
([#468](https://github.com/chatmail/server/pull/468))
|
|
||||||
|
|
||||||
- improve secure-join message detection
|
|
||||||
([#473](https://github.com/chatmail/server/pull/473))
|
|
||||||
|
|
||||||
- use old crypt lib in python < 3.11
|
|
||||||
([#483](https://github.com/chatmail/server/pull/483))
|
|
||||||
|
|
||||||
- chatmaild: set umask to 0700 for doveauth + metadata
|
|
||||||
([#490](https://github.com/chatmail/server/pull/492))
|
|
||||||
|
|
||||||
- remove MTA-STS daemon
|
|
||||||
([#488](https://github.com/chatmail/server/pull/488))
|
|
||||||
|
|
||||||
- replace `Subject` with `[...]` for all outgoing mails.
|
|
||||||
([#481](https://github.com/chatmail/server/pull/481))
|
|
||||||
|
|
||||||
- opendkim: use su instead of sudo
|
|
||||||
([#491](https://github.com/chatmail/server/pull/491))
|
|
||||||
|
|
||||||
## 1.5.0 2024-12-20
|
|
||||||
|
|
||||||
- cmdeploy dns: always show recommended DNS records
|
|
||||||
([#463](https://github.com/chatmail/server/pull/463))
|
|
||||||
|
|
||||||
- add `--all` to `cmdeploy dns`
|
|
||||||
([#462](https://github.com/chatmail/server/pull/462))
|
|
||||||
|
|
||||||
- fix `_mta-sts` TXT DNS record
|
|
||||||
([#461](https://github.com/chatmail/server/pull/461)
|
|
||||||
|
|
||||||
- deploy `iroh-relay` and also update "realtime relay services" in privacy policy.
|
|
||||||
([#434](https://github.com/chatmail/server/pull/434))
|
|
||||||
([#451](https://github.com/chatmail/server/pull/451))
|
|
||||||
|
|
||||||
- add guide to migrate chatmail to a new server
|
|
||||||
([#429](https://github.com/chatmail/server/pull/429))
|
|
||||||
|
|
||||||
- disable anvil authentication penalty
|
|
||||||
([#414](https://github.com/chatmail/server/pull/444)
|
|
||||||
|
|
||||||
- increase `request_queue_size` for UNIX sockets to 1000.
|
|
||||||
([#437](https://github.com/chatmail/server/pull/437))
|
|
||||||
|
|
||||||
- add argument to `cmdeploy run` for specifying
|
|
||||||
a different SSH host than `mail_domain`
|
|
||||||
([#439](https://github.com/chatmail/server/pull/439))
|
|
||||||
|
|
||||||
- query autoritative nameserver to bypass DNS cache
|
|
||||||
([#424](https://github.com/chatmail/server/pull/424))
|
|
||||||
|
|
||||||
- add mtail support (new optional `mtail_address` ini value)
|
|
||||||
This defines the address on which [`mtail`](https://google.github.io/mtail/)
|
|
||||||
exposes its metrics collected from the logs.
|
|
||||||
If you want to collect the metrics with Prometheus,
|
|
||||||
setup a private network (e.g. WireGuard interface)
|
|
||||||
and assign an IP address from this network to the host.
|
|
||||||
If you do not plan to collect metrics,
|
|
||||||
keep this setting unset.
|
|
||||||
([#388](https://github.com/chatmail/server/pull/388))
|
|
||||||
|
|
||||||
- fix checking for required DNS records
|
- fix checking for required DNS records
|
||||||
([#412](https://github.com/chatmail/server/pull/412))
|
([#412](https://github.com/deltachat/chatmail/pull/412))
|
||||||
|
|
||||||
- add support for specifying whole domains for recipient passthrough list
|
|
||||||
([#408](https://github.com/chatmail/server/pull/408))
|
|
||||||
|
|
||||||
- add a paragraph about "account deletion" to info page
|
- add a paragraph about "account deletion" to info page
|
||||||
([#405](https://github.com/chatmail/server/pull/405))
|
([#405](https://github.com/deltachat/chatmail/pull/405))
|
||||||
|
|
||||||
- avoid nginx listening on ipv6 if v6 is dsiabled
|
- avoid nginx listening on ipv6 if v6 is dsiabled
|
||||||
([#402](https://github.com/chatmail/server/pull/402))
|
([#402](https://github.com/deltachat/chatmail/pull/402))
|
||||||
|
|
||||||
- refactor ssh-based execution to allow organizing remote functions in
|
- refactor ssh-based execution to allow organizing remote functions in
|
||||||
modules.
|
modules.
|
||||||
([#396](https://github.com/chatmail/server/pull/396))
|
([#396](https://github.com/deltachat/chatmail/pull/396))
|
||||||
|
|
||||||
- trigger "apt upgrade" during "cmdeploy run"
|
- trigger "apt upgrade" during "cmdeploy run"
|
||||||
([#398](https://github.com/chatmail/server/pull/398))
|
([#398](https://github.com/deltachat/chatmail/pull/398))
|
||||||
|
|
||||||
- drop hispanilandia passthrough address
|
- drop hispanilandia passthrough address
|
||||||
([#401](https://github.com/chatmail/server/pull/401))
|
([#401](https://github.com/deltachat/chatmail/pull/401))
|
||||||
|
|
||||||
- set CAA record flags to 0
|
- set CAA record flags to 0
|
||||||
|
|
||||||
- add IMAP capabilities instead of overwriting them
|
- add IMAP capabilities instead of overwriting them
|
||||||
([#413](https://github.com/chatmail/server/pull/413))
|
([#413](https://github.com/deltachat/chatmail/pull/413))
|
||||||
|
|
||||||
- fix OpenPGP payload check
|
|
||||||
([#435](https://github.com/chatmail/server/pull/435))
|
|
||||||
|
|
||||||
- fix Dovecot quota_max_mail_size to use max_message_size config value
|
|
||||||
([#438](https://github.com/chatmail/server/pull/438))
|
|
||||||
|
|
||||||
|
|
||||||
## 1.4.1 2024-07-31
|
## 1.4.1 2024-07-31
|
||||||
|
|
||||||
- fix metadata dictproxy which would confuse transactions
|
- fix metadata dictproxy which would confuse transactions
|
||||||
resulting in missed notifications and other issues.
|
resulting in missed notifications and other issues.
|
||||||
([#393](https://github.com/chatmail/server/pull/393))
|
([#393](https://github.com/deltachat/chatmail/pull/393))
|
||||||
([#394](https://github.com/chatmail/server/pull/394))
|
([#394](https://github.com/deltachat/chatmail/pull/394))
|
||||||
|
|
||||||
- add optional "imap_rawlog" config option. If true,
|
- add optional "imap_rawlog" config option. If true,
|
||||||
.in/.out files are created in user home dirs
|
.in/.out files are created in user home dirs
|
||||||
containing the imap protocol messages.
|
containing the imap protocol messages.
|
||||||
([#389](https://github.com/chatmail/server/pull/389))
|
([#389](https://github.com/deltachat/chatmail/pull/389))
|
||||||
|
|
||||||
## 1.4.0 2024-07-28
|
## 1.4.0 2024-07-28
|
||||||
|
|
||||||
- Add `disable_ipv6` config option to chatmail.ini.
|
- Add `disable_ipv6` config option to chatmail.ini.
|
||||||
Required if the server doesn't have IPv6 connectivity.
|
Required if the server doesn't have IPv6 connectivity.
|
||||||
([#312](https://github.com/chatmail/server/pull/312))
|
([#312](https://github.com/deltachat/chatmail/pull/312))
|
||||||
|
|
||||||
- allow current K9/Thunderbird-mail releases to send encrypted messages
|
- allow current K9/Thunderbird-mail releases to send encrypted messages
|
||||||
outside by accepting their localized "encrypted subject" strings.
|
outside by accepting their localized "encrypted subject" strings.
|
||||||
([#370](https://github.com/chatmail/server/pull/370))
|
([#370](https://github.com/deltachat/chatmail/pull/370))
|
||||||
|
|
||||||
- Migrate and remove sqlite database in favor of password/lastlogin tracking
|
- Migrate and remove sqlite database in favor of password/lastlogin tracking
|
||||||
in a user's maildir.
|
in a user's maildir.
|
||||||
([#379](https://github.com/chatmail/server/pull/379))
|
([#379](https://github.com/deltachat/chatmail/pull/379))
|
||||||
|
|
||||||
- Require pyinfra V3 installed on the client side,
|
- Require pyinfra V3 installed on the client side,
|
||||||
run `./scripts/initenv.sh` to upgrade locally.
|
run `./scripts/initenv.sh` to upgrade locally.
|
||||||
([#378](https://github.com/chatmail/server/pull/378))
|
([#378](https://github.com/deltachat/chatmail/pull/378))
|
||||||
|
|
||||||
- don't hardcode "/home/vmail" paths but rather set them
|
- don't hardcode "/home/vmail" paths but rather set them
|
||||||
once in the config object and use it everywhere else,
|
once in the config object and use it everywhere else,
|
||||||
thereby also improving testability.
|
thereby also improving testability.
|
||||||
([#351](https://github.com/chatmail/server/pull/351))
|
([#351](https://github.com/deltachat/chatmail/pull/351))
|
||||||
temporarily introduced obligatory "passdb_path" and "mailboxes_dir"
|
temporarily introduced obligatory "passdb_path" and "mailboxes_dir"
|
||||||
settings but they were removed/obsoleted in
|
settings but they were removed/obsoleted in
|
||||||
([#380](https://github.com/chatmail/server/pull/380))
|
([#380](https://github.com/deltachat/chatmail/pull/380))
|
||||||
|
|
||||||
- BREAKING: new required chatmail.ini value 'delete_inactive_users_after = 100'
|
- BREAKING: new required chatmail.ini value 'delete_inactive_users_after = 100'
|
||||||
which removes users from database and mails after 100 days without any login.
|
which removes users from database and mails after 100 days without any login.
|
||||||
([#350](https://github.com/chatmail/server/pull/350))
|
([#350](https://github.com/deltachat/chatmail/pull/350))
|
||||||
|
|
||||||
- Refine DNS checking to distinguish between "required" and "recommended" settings
|
- Refine DNS checking to distinguish between "required" and "recommended" settings
|
||||||
([#372](https://github.com/chatmail/server/pull/372))
|
([#372](https://github.com/deltachat/chatmail/pull/372))
|
||||||
|
|
||||||
- reload nginx in the acmetool cronjob
|
- reload nginx in the acmetool cronjob
|
||||||
([#360](https://github.com/chatmail/server/pull/360))
|
([#360](https://github.com/deltachat/chatmail/pull/360))
|
||||||
|
|
||||||
- remove checking of reverse-DNS PTR records. Chatmail-servers don't
|
- remove checking of reverse-DNS PTR records. Chatmail-servers don't
|
||||||
depend on it and even in the wider e-mail system it's not common anymore.
|
depend on it and even in the wider e-mail system it's not common anymore.
|
||||||
If it's an issue, a chatmail operator can still care to properly set reverse DNS.
|
If it's an issue, a chatmail operator can still care to properly set reverse DNS.
|
||||||
([#348](https://github.com/chatmail/server/pull/348))
|
([#348](https://github.com/deltachat/chatmail/pull/348))
|
||||||
|
|
||||||
- Make DNS-checking faster and more interactive, run it fully during "cmdeploy run",
|
- Make DNS-checking faster and more interactive, run it fully during "cmdeploy run",
|
||||||
also introducing a generic mechanism for rapid remote ssh-based python function execution.
|
also introducing a generic mechanism for rapid remote ssh-based python function execution.
|
||||||
([#346](https://github.com/chatmail/server/pull/346))
|
([#346](https://github.com/deltachat/chatmail/pull/346))
|
||||||
|
|
||||||
- Don't fix file owner ship of /home/vmail
|
- Don't fix file owner ship of /home/vmail
|
||||||
([#345](https://github.com/chatmail/server/pull/345))
|
([#345](https://github.com/deltachat/chatmail/pull/345))
|
||||||
|
|
||||||
- Support iterating over all users with doveadm commands
|
- Support iterating over all users with doveadm commands
|
||||||
([#344](https://github.com/chatmail/server/pull/344))
|
([#344](https://github.com/deltachat/chatmail/pull/344))
|
||||||
|
|
||||||
- Test and fix for attempts to create inadmissible accounts
|
- Test and fix for attempts to create inadmissible accounts
|
||||||
([#333](https://github.com/chatmail/server/pull/321))
|
([#333](https://github.com/deltachat/chatmail/pull/321))
|
||||||
|
|
||||||
- check that OpenPGP has only PKESK, SKESK and SEIPD packets
|
- check that OpenPGP has only PKESK, SKESK and SEIPD packets
|
||||||
([#323](https://github.com/chatmail/server/pull/323),
|
([#323](https://github.com/deltachat/chatmail/pull/323),
|
||||||
[#324](https://github.com/chatmail/server/pull/324))
|
[#324](https://github.com/deltachat/chatmail/pull/324))
|
||||||
|
|
||||||
- improve filtermail checks for encrypted messages and drop support for unencrypted MDNs
|
- improve filtermail checks for encrypted messages and drop support for unencrypted MDNs
|
||||||
([#320](https://github.com/chatmail/server/pull/320))
|
([#320](https://github.com/deltachat/chatmail/pull/320))
|
||||||
|
|
||||||
- replace `bash` with `/bin/sh`
|
- replace `bash` with `/bin/sh`
|
||||||
([#334](https://github.com/chatmail/server/pull/334))
|
([#334](https://github.com/deltachat/chatmail/pull/334))
|
||||||
|
|
||||||
- Increase number of logged in IMAP sessions to 50000
|
- Increase number of logged in IMAP sessions to 50000
|
||||||
([#335](https://github.com/chatmail/server/pull/335))
|
([#335](https://github.com/deltachat/chatmail/pull/335))
|
||||||
|
|
||||||
- filtermail: do not allow ASCII armor without actual payload
|
- filtermail: do not allow ASCII armor without actual payload
|
||||||
([#325](https://github.com/chatmail/server/pull/325))
|
([#325](https://github.com/deltachat/chatmail/pull/325))
|
||||||
|
|
||||||
- Remove sieve to enable hardlink deduplication in LMTP
|
- Remove sieve to enable hardlink deduplication in LMTP
|
||||||
([#343](https://github.com/chatmail/server/pull/343))
|
([#343](https://github.com/deltachat/chatmail/pull/343))
|
||||||
|
|
||||||
- dovecot: enable gzip compression on disk
|
- dovecot: enable gzip compression on disk
|
||||||
([#341](https://github.com/chatmail/server/pull/341))
|
([#341](https://github.com/deltachat/chatmail/pull/341))
|
||||||
|
|
||||||
- DKIM-sign Content-Type and oversign all signed headers
|
- DKIM-sign Content-Type and oversign all signed headers
|
||||||
([#296](https://github.com/chatmail/server/pull/296))
|
([#296](https://github.com/deltachat/chatmail/pull/296))
|
||||||
|
|
||||||
- Add nonci_accounts metric
|
- Add nonci_accounts metric
|
||||||
([#347](https://github.com/chatmail/server/pull/347))
|
([#347](https://github.com/deltachat/chatmail/pull/347))
|
||||||
|
|
||||||
- doveauth: log when a new account is created
|
- doveauth: log when a new account is created
|
||||||
([#349](https://github.com/chatmail/server/pull/349))
|
([#349](https://github.com/deltachat/chatmail/pull/349))
|
||||||
|
|
||||||
- Multiplex HTTPS, IMAP and SMTP on port 443
|
- Multiplex HTTPS, IMAP and SMTP on port 443
|
||||||
([#357](https://github.com/chatmail/server/pull/357))
|
([#357](https://github.com/deltachat/chatmail/pull/357))
|
||||||
|
|
||||||
## 1.3.0 - 2024-06-06
|
## 1.3.0 - 2024-06-06
|
||||||
|
|
||||||
- don't check necessary DNS records on cmdeploy init anymore
|
- don't check necessary DNS records on cmdeploy init anymore
|
||||||
([#316](https://github.com/chatmail/server/pull/316))
|
([#316](https://github.com/deltachat/chatmail/pull/316))
|
||||||
|
|
||||||
- ensure cron and acl are installed
|
- ensure cron and acl are installed
|
||||||
([#293](https://github.com/chatmail/server/pull/293),
|
([#293](https://github.com/deltachat/chatmail/pull/293),
|
||||||
[#310](https://github.com/chatmail/server/pull/310))
|
[#310](https://github.com/deltachat/chatmail/pull/310))
|
||||||
|
|
||||||
- change default for delete_mails_after from 40 to 20 days
|
- change default for delete_mails_after from 40 to 20 days
|
||||||
([#300](https://github.com/chatmail/server/pull/300))
|
([#300](https://github.com/deltachat/chatmail/pull/300))
|
||||||
|
|
||||||
- save journald logs only to memory and save nginx logs to journald instead of file
|
- save journald logs only to memory and save nginx logs to journald instead of file
|
||||||
([#299](https://github.com/chatmail/server/pull/299))
|
([#299](https://github.com/deltachat/chatmail/pull/299))
|
||||||
|
|
||||||
- fix writing of multiple obs repositories in `/etc/apt/sources.list`
|
- fix writing of multiple obs repositories in `/etc/apt/sources.list`
|
||||||
([#290](https://github.com/chatmail/server/pull/290))
|
([#290](https://github.com/deltachat/chatmail/pull/290))
|
||||||
|
|
||||||
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
- metadata: add support for `/shared/vendor/deltachat/irohrelay`
|
||||||
([#284](https://github.com/chatmail/server/pull/284))
|
([#284](https://github.com/deltachat/chatmail/pull/284))
|
||||||
|
|
||||||
- Emit "XCHATMAIL" capability from IMAP server
|
- Emit "XCHATMAIL" capability from IMAP server
|
||||||
([#278](https://github.com/chatmail/server/pull/278))
|
([#278](https://github.com/deltachat/chatmail/pull/278))
|
||||||
|
|
||||||
- Move echobot `into /var/lib/echobot`
|
- Move echobot `into /var/lib/echobot`
|
||||||
([#281](https://github.com/chatmail/server/pull/281))
|
([#281](https://github.com/deltachat/chatmail/pull/281))
|
||||||
|
|
||||||
- Accept Let's Encrypt's new Terms of Services
|
- Accept Let's Encrypt's new Terms of Services
|
||||||
([#275](https://github.com/chatmail/server/pull/276))
|
([#275](https://github.com/deltachat/chatmail/pull/276))
|
||||||
|
|
||||||
- Reload Dovecot and Postfix when TLS certificate updates
|
- Reload Dovecot and Postfix when TLS certificate updates
|
||||||
([#271](https://github.com/chatmail/server/pull/271))
|
([#271](https://github.com/deltachat/chatmail/pull/271))
|
||||||
|
|
||||||
- Use forked version of dovecot without hardcoded delays
|
- Use forked version of dovecot without hardcoded delays
|
||||||
([#270](https://github.com/chatmail/server/pull/270))
|
([#270](https://github.com/deltachat/chatmail/pull/270))
|
||||||
|
|
||||||
## 1.2.0 - 2024-04-04
|
## 1.2.0 - 2024-04-04
|
||||||
|
|
||||||
- Install dig on the server to resolve DNS records
|
- Install dig on the server to resolve DNS records
|
||||||
([#267](https://github.com/chatmail/server/pull/267))
|
([#267](https://github.com/deltachat/chatmail/pull/267))
|
||||||
|
|
||||||
- preserve notification order and exponentially backoff with
|
- preserve notification order and exponentially backoff with
|
||||||
retries for tokens where we didn't get a successful return
|
retries for tokens where we didn't get a successful return
|
||||||
([#265](https://github.com/chatmail/server/pull/263))
|
([#265](https://github.com/deltachat/chatmail/pull/263))
|
||||||
|
|
||||||
- Run chatmail-metadata and doveauth as vmail
|
- Run chatmail-metadata and doveauth as vmail
|
||||||
([#261](https://github.com/chatmail/server/pull/261))
|
([#261](https://github.com/deltachat/chatmail/pull/261))
|
||||||
|
|
||||||
- Apply systemd restrictions to echobot
|
- Apply systemd restrictions to echobot
|
||||||
([#259](https://github.com/chatmail/server/pull/259))
|
([#259](https://github.com/deltachat/chatmail/pull/259))
|
||||||
|
|
||||||
- re-enable running the CI in pull requests, but not concurrently
|
- re-enable running the CI in pull requests, but not concurrently
|
||||||
([#258](https://github.com/chatmail/server/pull/258))
|
([#258](https://github.com/deltachat/chatmail/pull/258))
|
||||||
|
|
||||||
|
|
||||||
## 1.1.0 - 2024-03-28
|
## 1.1.0 - 2024-03-28
|
||||||
@@ -493,27 +187,27 @@
|
|||||||
### The changelog starts to record changes from March 15th, 2024
|
### The changelog starts to record changes from March 15th, 2024
|
||||||
|
|
||||||
- Move systemd unit templates to cmdeploy package
|
- Move systemd unit templates to cmdeploy package
|
||||||
([#255](https://github.com/chatmail/server/pull/255))
|
([#255](https://github.com/deltachat/chatmail/pull/255))
|
||||||
|
|
||||||
- Persist push tokens and support multiple device per address
|
- Persist push tokens and support multiple device per address
|
||||||
([#254](https://github.com/chatmail/server/pull/254))
|
([#254](https://github.com/deltachat/chatmail/pull/254))
|
||||||
|
|
||||||
- Avoid warning for regular doveauth protocol's hello message.
|
- Avoid warning for regular doveauth protocol's hello message.
|
||||||
([#250](https://github.com/chatmail/server/pull/250))
|
([#250](https://github.com/deltachat/chatmail/pull/250))
|
||||||
|
|
||||||
- Fix various tests to pass again with "cmdeploy test".
|
- Fix various tests to pass again with "cmdeploy test".
|
||||||
([#245](https://github.com/chatmail/server/pull/245),
|
([#245](https://github.com/deltachat/chatmail/pull/245),
|
||||||
[#242](https://github.com/chatmail/server/pull/242)
|
[#242](https://github.com/deltachat/chatmail/pull/242)
|
||||||
|
|
||||||
- Ensure lets-encrypt certificates are reloaded after renewal
|
- Ensure lets-encrypt certificates are reloaded after renewal
|
||||||
([#244]) https://github.com/chatmail/server/pull/244
|
([#244]) https://github.com/deltachat/chatmail/pull/244
|
||||||
|
|
||||||
- Persist tokens to avoid iOS users loosing push-notifications when the
|
- Persist tokens to avoid iOS users loosing push-notifications when the
|
||||||
chatmail metadata service is restarted (happens regularly during deploys)
|
chatmail metadata service is restarted (happens regularly during deploys)
|
||||||
([#238](https://github.com/chatmail/server/pull/239)
|
([#238](https://github.com/deltachat/chatmail/pull/239)
|
||||||
|
|
||||||
- Fix failing sieve-script compile errors on incoming messages
|
- Fix failing sieve-script compile errors on incoming messages
|
||||||
([#237](https://github.com/chatmail/server/pull/239)
|
([#237](https://github.com/deltachat/chatmail/pull/239)
|
||||||
|
|
||||||
- Fix quota reporting after expunging of old mails
|
- Fix quota reporting after expunging of old mails
|
||||||
([#233](https://github.com/chatmail/server/pull/239)
|
([#233](https://github.com/deltachat/chatmail/pull/239)
|
||||||
|
|||||||
@@ -1,7 +0,0 @@
|
|||||||
# Contributing to the chatmail relay
|
|
||||||
|
|
||||||
Commit messages follow the [Conventional Commits] notation.
|
|
||||||
We use [git-cliff] to generate the changelog from commit messages before the release.
|
|
||||||
|
|
||||||
[Conventional Commits]: https://www.conventionalcommits.org/
|
|
||||||
[git-cliff]: https://git-cliff.org/
|
|
||||||
301
README.md
301
README.md
@@ -1,20 +1,299 @@
|
|||||||
|
|
||||||
# Chatmail relays for end-to-end encrypted email
|
<img width="800px" src="www/src/collage-top.png"/>
|
||||||
|
|
||||||
Chatmail relay servers are interoperable Mail Transport Agents (MTAs) designed for:
|
# Chatmail services optimized for Delta Chat apps
|
||||||
|
|
||||||
- **Zero State:** no private data or metadata collected, messages are auto-deleted, low disk usage
|
This repository helps to setup a ready-to-use chatmail server
|
||||||
|
comprised of a minimal setup of the battle-tested
|
||||||
|
[postfix smtp](https://www.postfix.org) and [dovecot imap](https://www.dovecot.org) services.
|
||||||
|
|
||||||
- **Instant/Realtime:** sub-second message delivery, realtime P2P
|
The setup is designed and optimized for providing chatmail accounts
|
||||||
streaming, privacy-preserving Push Notifications for Apple, Google, and Huawei;
|
for use by [Delta Chat apps](https://delta.chat).
|
||||||
|
|
||||||
- **Security Enforcement**: only strict TLS, DKIM and OpenPGP with minimized metadata accepted
|
Chatmail accounts are automatically created by a first login,
|
||||||
|
after which the initially specified password is required for using them.
|
||||||
|
|
||||||
- **Reliable Federation and Decentralization:** No spam or IP reputation checks, federating
|
## Deploying your own chatmail server
|
||||||
depends on established IETF standards and protocols.
|
|
||||||
|
|
||||||
This repository contains everything needed to setup a ready-to-use chatmail relay on an ssh-reachable host.
|
To deploy chatmail on your own server, you must have set-up ssh authentication and need to use an ed25519 key, due to an [upstream bug in paramiko](https://github.com/paramiko/paramiko/issues/2191). You also need to add your private key to the local ssh-agent, because you can't type in your password during deployment.
|
||||||
For getting started and more information please refer to the web version of this repositories' documentation at
|
|
||||||
|
|
||||||
[https://chatmail.at/doc/relay](https://chatmail.at/doc/relay)
|
We use `chat.example.org` as the chatmail domain in the following steps.
|
||||||
|
Please substitute it with your own domain.
|
||||||
|
|
||||||
|
1. Install the `cmdeploy` command in a virtualenv
|
||||||
|
|
||||||
|
```
|
||||||
|
git clone https://github.com/deltachat/chatmail
|
||||||
|
cd chatmail
|
||||||
|
scripts/initenv.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
2. Create chatmail configuration file `chatmail.ini`:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy init chat.example.org # <-- use your domain
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Point your domain to the server's IP address,
|
||||||
|
if you haven't done so already.
|
||||||
|
Verify that SSH root login works:
|
||||||
|
|
||||||
|
```
|
||||||
|
ssh root@chat.example.org # <-- use your domain
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Deploy to the remote chatmail server:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy run
|
||||||
|
```
|
||||||
|
This script will check that you have all necessary DNS records.
|
||||||
|
If DNS records are missing, it will recommend
|
||||||
|
which you should configure at your DNS provider
|
||||||
|
(it can take some time until they are public).
|
||||||
|
|
||||||
|
### Other helpful commands:
|
||||||
|
|
||||||
|
To check the status of your remotely running chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy status
|
||||||
|
```
|
||||||
|
|
||||||
|
To display and check all recommended DNS records:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy dns
|
||||||
|
```
|
||||||
|
|
||||||
|
To test whether your chatmail service is working correctly:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy test
|
||||||
|
```
|
||||||
|
|
||||||
|
To measure the performance of your chatmail service:
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy bench
|
||||||
|
```
|
||||||
|
|
||||||
|
## Overview of this repository
|
||||||
|
|
||||||
|
This repository drives the development of chatmail services,
|
||||||
|
comprised of minimal setups of
|
||||||
|
|
||||||
|
- [postfix smtp server](https://www.postfix.org)
|
||||||
|
- [dovecot imap server](https://www.dovecot.org)
|
||||||
|
|
||||||
|
as well as custom services that are integrated with these two:
|
||||||
|
|
||||||
|
- `chatmaild/src/chatmaild/doveauth.py` implements
|
||||||
|
create-on-login account creation semantics and is used
|
||||||
|
by Dovecot during login authentication and by Postfix
|
||||||
|
which in turn uses [Dovecot SASL](https://doc.dovecot.org/configuration_manual/authentication/dict/#complete-example-for-authenticating-via-a-unix-socket)
|
||||||
|
to authenticate users
|
||||||
|
to send mails for them.
|
||||||
|
|
||||||
|
- `chatmaild/src/chatmaild/filtermail.py` prevents
|
||||||
|
unencrypted e-mail from leaving the chatmail service
|
||||||
|
and is integrated into postfix's outbound mail pipelines.
|
||||||
|
|
||||||
|
There is also the `cmdeploy/src/cmdeploy/cmdeploy.py` command line tool
|
||||||
|
which helps with setting up and managing the chatmail service.
|
||||||
|
`cmdeploy run` uses [pyinfra-based scripting](https://pyinfra.com/)
|
||||||
|
in `cmdeploy/src/cmdeploy/__init__.py`
|
||||||
|
to automatically install all chatmail components on a server.
|
||||||
|
|
||||||
|
|
||||||
|
### Home page and getting started for users
|
||||||
|
|
||||||
|
`cmdeploy run` also creates default static Web pages and deploys them
|
||||||
|
to a nginx web server with:
|
||||||
|
|
||||||
|
- a default `index.html` along with a QR code that users can click to
|
||||||
|
create accounts on your chatmail provider,
|
||||||
|
|
||||||
|
- a default `info.html` that is linked from the home page,
|
||||||
|
|
||||||
|
- a default `policy.html` that is linked from the home page.
|
||||||
|
|
||||||
|
All `.html` files are generated
|
||||||
|
by the according markdown `.md` file in the `www/src` directory.
|
||||||
|
|
||||||
|
|
||||||
|
### Refining the web pages
|
||||||
|
|
||||||
|
|
||||||
|
```
|
||||||
|
scripts/cmdeploy webdev
|
||||||
|
```
|
||||||
|
|
||||||
|
This starts a local live development cycle for chatmail Web pages:
|
||||||
|
|
||||||
|
- uses the `www/src/page-layout.html` file for producing static
|
||||||
|
HTML pages from `www/src/*.md` files
|
||||||
|
|
||||||
|
- continously builds the web presence reading files from `www/src` directory
|
||||||
|
and generating html files and copying assets to the `www/build` directory.
|
||||||
|
|
||||||
|
- Starts a browser window automatically where you can "refresh" as needed.
|
||||||
|
|
||||||
|
|
||||||
|
## Emergency Commands to disable automatic account creation
|
||||||
|
|
||||||
|
If you need to stop account creation,
|
||||||
|
e.g. because some script is wildly creating accounts,
|
||||||
|
login to the server with ssh and run:
|
||||||
|
|
||||||
|
```
|
||||||
|
touch /etc/chatmail-nocreate
|
||||||
|
```
|
||||||
|
|
||||||
|
While this file is present, account creation will be blocked.
|
||||||
|
|
||||||
|
### Ports
|
||||||
|
|
||||||
|
[Postfix](http://www.postfix.org/) listens on ports 25 (smtp) and 587 (submission) and 465 (submissions).
|
||||||
|
[Dovecot](https://www.dovecot.org/) listens on ports 143 (imap) and 993 (imaps).
|
||||||
|
[nginx](https://www.nginx.com/) listens on port 8443 (https-alt) and 443 (https).
|
||||||
|
Port 443 multiplexes HTTPS, IMAP and SMTP using ALPN to redirect connections to ports 8443, 465 or 993.
|
||||||
|
[acmetool](https://hlandau.github.io/acmetool/) listens on port 80 (http).
|
||||||
|
|
||||||
|
Delta Chat apps will, however, discover all ports and configurations
|
||||||
|
automatically by reading the [autoconfig XML file](https://www.ietf.org/archive/id/draft-bucksch-autoconfig-00.html) from the chatmail service.
|
||||||
|
|
||||||
|
## Email authentication
|
||||||
|
|
||||||
|
chatmail servers rely on [DKIM](https://www.rfc-editor.org/rfc/rfc6376)
|
||||||
|
to authenticate incoming emails.
|
||||||
|
Incoming emails must have a valid DKIM signature with
|
||||||
|
Signing Domain Identifier (SDID, `d=` parameter in the DKIM-Signature header)
|
||||||
|
equal to the `From:` header domain.
|
||||||
|
This property is checked by OpenDKIM screen policy script
|
||||||
|
before validating the signatures.
|
||||||
|
This correpsonds to strict [DMARC](https://www.rfc-editor.org/rfc/rfc7489) alignment (`adkim=s`),
|
||||||
|
but chatmail does not rely on DMARC and does not consult the sender policy published in DMARC records.
|
||||||
|
Other legacy authentication mechanisms such as [iprev](https://www.rfc-editor.org/rfc/rfc8601#section-2.7.3)
|
||||||
|
and [SPF](https://www.rfc-editor.org/rfc/rfc7208) are also not taken into account.
|
||||||
|
If there is no valid DKIM signature on the incoming email,
|
||||||
|
the sender receives a "5.7.1 No valid DKIM signature found" error.
|
||||||
|
|
||||||
|
Outgoing emails must be sent over authenticated connection
|
||||||
|
with envelope MAIL FROM (return path) corresponding to the login.
|
||||||
|
This is ensured by Postfix which maps login username
|
||||||
|
to MAIL FROM with
|
||||||
|
[`smtpd_sender_login_maps`](https://www.postfix.org/postconf.5.html#smtpd_sender_login_maps)
|
||||||
|
and rejects incorrectly authenticated emails with [`reject_sender_login_mismatch`](reject_sender_login_mismatch) policy.
|
||||||
|
`From:` header must correspond to envelope MAIL FROM,
|
||||||
|
this is ensured by `filtermail` proxy.
|
||||||
|
|
||||||
|
## Migrating chatmail server to a new host
|
||||||
|
|
||||||
|
If you want to migrate your chatmail server to a new host,
|
||||||
|
follow these steps:
|
||||||
|
|
||||||
|
1. Block all ports except 80 and 22 with firewall on a new server.
|
||||||
|
|
||||||
|
To do this, add the following config to `/etc/nftables.conf`:
|
||||||
|
```
|
||||||
|
#!/usr/sbin/nft -f
|
||||||
|
|
||||||
|
flush ruleset
|
||||||
|
|
||||||
|
table inet filter {
|
||||||
|
chain input {
|
||||||
|
type filter hook input priority filter; policy drop;
|
||||||
|
|
||||||
|
# Accept ICMP.
|
||||||
|
# It is especially important to accept ICMPv6 ND messages,
|
||||||
|
# otherwise IPv6 connectivity breaks.
|
||||||
|
icmp type { echo-request } accept
|
||||||
|
icmpv6 type { echo-request, nd-neighbor-solicit, nd-router-advert, nd-neighbor-advert } accept
|
||||||
|
|
||||||
|
tcp dport { ssh, http } accept
|
||||||
|
|
||||||
|
ct state established accept
|
||||||
|
}
|
||||||
|
chain forward {
|
||||||
|
type filter hook forward priority filter;
|
||||||
|
}
|
||||||
|
chain output {
|
||||||
|
type filter hook output priority filter;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Then execute `nft -f /etc/nftables.conf` as root.
|
||||||
|
|
||||||
|
This will ensure users will not connect to the new server
|
||||||
|
and mails will not be delivered to the new server
|
||||||
|
before you finish the setup.
|
||||||
|
|
||||||
|
Port 22 is needed for SSH access
|
||||||
|
and port 80 is needed to get a TLS certificate.
|
||||||
|
They are not used by Delta Chat
|
||||||
|
or by other email servers trying to deliver the messages.
|
||||||
|
|
||||||
|
2. Point DNS to the new IP addresses.
|
||||||
|
|
||||||
|
You can already remove the old IP addresses from DNS.
|
||||||
|
Existing Delta Chat users will still be able to connect
|
||||||
|
to the old server, send and receive messages,
|
||||||
|
but new users will fail to create new profiles
|
||||||
|
with your chatmail server.
|
||||||
|
|
||||||
|
3. Setup the new server with `cmdeploy`.
|
||||||
|
|
||||||
|
This step is similar to initial setup.
|
||||||
|
However, because ports Delta Chat uses are blocked,
|
||||||
|
new server will not become usable immediately.
|
||||||
|
If other servers try to deliver messages to your new server they will fail,
|
||||||
|
but normally email servers will retry delivering messages
|
||||||
|
for at least a week, so messages will not be lost.
|
||||||
|
|
||||||
|
4. Firewall all ports except `ssh` (22) on the old server.
|
||||||
|
Existing users will not be able to connect from now on
|
||||||
|
and no more messages will be delivered to your old chatmail server.
|
||||||
|
|
||||||
|
Blocking users from connecting to the new server
|
||||||
|
until mailboxes are migrated is needed to avoid UID validity change.
|
||||||
|
If Delta Chat connects to the new server before it is fully set up,
|
||||||
|
it will lose track of the IMAP message UID
|
||||||
|
and miss messages that arrived during migration.
|
||||||
|
|
||||||
|
Same for SMTP port 25, you want it blocked during migration so no new mails arrive
|
||||||
|
while the server is moving.
|
||||||
|
|
||||||
|
5. Use `rsync -avz` over SSH to copy /home/vmail/mail from the old server to the new one
|
||||||
|
preserving file permissions and timestamps.
|
||||||
|
|
||||||
|
6. Unblock ports used by Delta Chat and SMTP message exchange.
|
||||||
|
For that you can modify `/etc/nftables.conf` as follows:
|
||||||
|
```
|
||||||
|
#!/usr/sbin/nft -f
|
||||||
|
|
||||||
|
flush ruleset
|
||||||
|
|
||||||
|
table inet filter {
|
||||||
|
chain input {
|
||||||
|
type filter hook input priority filter; policy drop;
|
||||||
|
|
||||||
|
# Accept ICMP.
|
||||||
|
# It is especially important to accept ICMPv6 ND messages,
|
||||||
|
# otherwise IPv6 connectivity breaks.
|
||||||
|
icmp type { echo-request } accept
|
||||||
|
icmpv6 type { echo-request, nd-neighbor-solicit, nd-router-advert, nd-neighbor-advert } accept
|
||||||
|
|
||||||
|
tcp dport { ssh, smtp, http, https, imap, imaps, submission, submissions } accept
|
||||||
|
|
||||||
|
ct state established accept
|
||||||
|
}
|
||||||
|
chain forward {
|
||||||
|
type filter hook forward priority filter;
|
||||||
|
}
|
||||||
|
chain output {
|
||||||
|
type filter hook output priority filter;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Execute `nft -f /etc/nftables.conf` as root to apply the changes.
|
||||||
|
|||||||
15
RELEASE.md
15
RELEASE.md
@@ -1,15 +0,0 @@
|
|||||||
# Releasing a new version of chatmail relay
|
|
||||||
|
|
||||||
For example, to release version 1.9.0 of chatmail relay, do the following steps.
|
|
||||||
|
|
||||||
1. Update the changelog: `git cliff --unreleased --tag 1.9.0 --prepend CHANGELOG.md` or `git cliff -u -t 1.9.0 -p CHANGELOG.md`.
|
|
||||||
|
|
||||||
2. Open the changelog in the editor, edit it if required.
|
|
||||||
|
|
||||||
3. Commit the changes to the changelog with a commit message `chore(release): prepare for 1.9.0`.
|
|
||||||
|
|
||||||
3. Tag the release: `git tag --annotate 1.9.0`.
|
|
||||||
|
|
||||||
4. Push the release tag: `git push origin 1.9.0`.
|
|
||||||
|
|
||||||
5. Create a GitHub release: `gh release create 1.9.0`.
|
|
||||||
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|||||||
|
|
||||||
[project]
|
[project]
|
||||||
name = "chatmaild"
|
name = "chatmaild"
|
||||||
version = "0.3"
|
version = "0.2"
|
||||||
dependencies = [
|
dependencies = [
|
||||||
"aiosmtpd",
|
"aiosmtpd",
|
||||||
"iniconfig",
|
"iniconfig",
|
||||||
@@ -12,7 +12,6 @@ dependencies = [
|
|||||||
"deltachat-rpc-client",
|
"deltachat-rpc-client",
|
||||||
"filelock",
|
"filelock",
|
||||||
"requests",
|
"requests",
|
||||||
"crypt-r >= 3.13.1 ; python_version >= '3.11'",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[tool.setuptools]
|
[tool.setuptools]
|
||||||
@@ -24,11 +23,11 @@ where = ['src']
|
|||||||
[project.scripts]
|
[project.scripts]
|
||||||
doveauth = "chatmaild.doveauth:main"
|
doveauth = "chatmaild.doveauth:main"
|
||||||
chatmail-metadata = "chatmaild.metadata:main"
|
chatmail-metadata = "chatmaild.metadata:main"
|
||||||
|
filtermail = "chatmaild.filtermail:main"
|
||||||
|
echobot = "chatmaild.echo:main"
|
||||||
chatmail-metrics = "chatmaild.metrics:main"
|
chatmail-metrics = "chatmaild.metrics:main"
|
||||||
chatmail-expire = "chatmaild.expire:main"
|
delete_inactive_users = "chatmaild.delete_inactive_users:main"
|
||||||
chatmail-fsreport = "chatmaild.fsreport:main"
|
|
||||||
lastlogin = "chatmaild.lastlogin:main"
|
lastlogin = "chatmaild.lastlogin:main"
|
||||||
turnserver = "chatmaild.turnserver:main"
|
|
||||||
|
|
||||||
[project.entry-points.pytest11]
|
[project.entry-points.pytest11]
|
||||||
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
"chatmaild.testplugin" = "chatmaild.tests.plugin"
|
||||||
@@ -48,9 +47,6 @@ lint.select = [
|
|||||||
"PLE", # Pylint Error
|
"PLE", # Pylint Error
|
||||||
"PLW", # Pylint Warning
|
"PLW", # Pylint Warning
|
||||||
]
|
]
|
||||||
lint.ignore = [
|
|
||||||
"PLC0415" # import-outside-top-level
|
|
||||||
]
|
|
||||||
|
|
||||||
[tool.tox]
|
[tool.tox]
|
||||||
legacy_tox_ini = """
|
legacy_tox_ini = """
|
||||||
@@ -70,7 +66,5 @@ commands =
|
|||||||
[testenv]
|
[testenv]
|
||||||
deps = pytest
|
deps = pytest
|
||||||
pdbpp
|
pdbpp
|
||||||
pytest-localserver
|
|
||||||
execnet
|
|
||||||
commands = pytest -v -rsXx {posargs}
|
commands = pytest -v -rsXx {posargs}
|
||||||
"""
|
"""
|
||||||
|
|||||||
59
chatmaild/src/chatmaild/common_encrypted_subjects.py
Normal file
59
chatmaild/src/chatmaild/common_encrypted_subjects.py
Normal file
@@ -0,0 +1,59 @@
|
|||||||
|
"""Generated from deltachat, draft-ietf-lamps-header-protection, and
|
||||||
|
encrypted_subject localizations in
|
||||||
|
https://github.com/thunderbird/thunderbird-android/
|
||||||
|
|
||||||
|
"""
|
||||||
|
|
||||||
|
common_encrypted_subjects = {
|
||||||
|
"...",
|
||||||
|
"[...]",
|
||||||
|
"암호화된 메시지",
|
||||||
|
"Ĉifrita mesaĝo",
|
||||||
|
"Courriel chiffré",
|
||||||
|
"Dulrituð skilaboð",
|
||||||
|
"Encrypted Message",
|
||||||
|
"Fersifere berjocht",
|
||||||
|
"Kemennadenn enrineget",
|
||||||
|
"Krüptitud kiri",
|
||||||
|
"Krypterat meddelande",
|
||||||
|
"Krypteret besked",
|
||||||
|
"Kryptert melding",
|
||||||
|
"Mensagem criptografada",
|
||||||
|
"Mensagem encriptada",
|
||||||
|
"Mensaje cifrado",
|
||||||
|
"Mensaxe cifrada",
|
||||||
|
"Mesaj Criptat",
|
||||||
|
"Mesazh i Fshehtëzuar",
|
||||||
|
"Messaggio criptato",
|
||||||
|
"Messaghju cifratu",
|
||||||
|
"Missatge encriptat",
|
||||||
|
"Neges wedi'i Hamgryptio",
|
||||||
|
"Pesan terenkripsi",
|
||||||
|
"Salattu viesti",
|
||||||
|
"Şifreli İleti",
|
||||||
|
"Šifrēta ziņa",
|
||||||
|
"Šifrirana poruka",
|
||||||
|
"Šifrirano sporočilo",
|
||||||
|
"Šifruotas laiškas",
|
||||||
|
"Tin nhắn được mã hóa",
|
||||||
|
"Titkosított üzenet",
|
||||||
|
"Verschlüsselte Nachricht",
|
||||||
|
"Versleuteld bericht",
|
||||||
|
"Zašifrovaná zpráva",
|
||||||
|
"Zaszyfrowana wiadomość",
|
||||||
|
"Zifratu mezua",
|
||||||
|
"Κρυπτογραφημένο μήνυμα",
|
||||||
|
"Зашифроване повідомлення",
|
||||||
|
"Зашифрованное сообщение",
|
||||||
|
"Зашыфраваны ліст",
|
||||||
|
"Криптирано съобщение",
|
||||||
|
"Шифрована порука",
|
||||||
|
"დაშიფრული წერილი",
|
||||||
|
"הודעה מוצפנת",
|
||||||
|
"پیام رمزنگاریشده",
|
||||||
|
"رسالة مشفّرة",
|
||||||
|
"എൻക്രിപ്റ്റുചെയ്ത സന്ദേശം",
|
||||||
|
"加密邮件",
|
||||||
|
"已加密的訊息",
|
||||||
|
"暗号化されたメッセージ",
|
||||||
|
}
|
||||||
@@ -1,90 +1,43 @@
|
|||||||
import os
|
|
||||||
from pathlib import Path
|
from pathlib import Path
|
||||||
|
|
||||||
import iniconfig
|
import iniconfig
|
||||||
|
|
||||||
from chatmaild.user import User
|
from chatmaild.user import User
|
||||||
|
|
||||||
|
echobot_password_path = Path("/run/echobot/password")
|
||||||
|
|
||||||
|
|
||||||
def read_config(inipath):
|
def read_config(inipath):
|
||||||
assert Path(inipath).exists(), inipath
|
assert Path(inipath).exists(), inipath
|
||||||
cfg = iniconfig.IniConfig(inipath)
|
cfg = iniconfig.IniConfig(inipath)
|
||||||
params = cfg.sections["params"]
|
params = cfg.sections["params"]
|
||||||
default_config_content = get_default_config_content(params["mail_domain"])
|
return Config(inipath, params=params)
|
||||||
df_params = iniconfig.IniConfig("ini", data=default_config_content)["params"]
|
|
||||||
new_params = dict(df_params.items())
|
|
||||||
new_params.update(params)
|
|
||||||
return Config(inipath, params=new_params)
|
|
||||||
|
|
||||||
|
|
||||||
class Config:
|
class Config:
|
||||||
def __init__(self, inipath, params):
|
def __init__(self, inipath, params):
|
||||||
self._inipath = inipath
|
self._inipath = inipath
|
||||||
self.mail_domain = params["mail_domain"]
|
self.mail_domain = params["mail_domain"]
|
||||||
self.max_user_send_per_minute = int(params.get("max_user_send_per_minute", 60))
|
self.max_user_send_per_minute = int(params["max_user_send_per_minute"])
|
||||||
self.max_user_send_burst_size = int(params.get("max_user_send_burst_size", 10))
|
|
||||||
self.max_mailbox_size = params["max_mailbox_size"]
|
self.max_mailbox_size = params["max_mailbox_size"]
|
||||||
self.max_message_size = int(params.get("max_message_size", "31457280"))
|
self.max_message_size = int(params.get("max_message_size", "31457280"))
|
||||||
self.delete_mails_after = params["delete_mails_after"]
|
self.delete_mails_after = params["delete_mails_after"]
|
||||||
self.delete_large_after = params["delete_large_after"]
|
|
||||||
self.delete_inactive_users_after = int(params["delete_inactive_users_after"])
|
self.delete_inactive_users_after = int(params["delete_inactive_users_after"])
|
||||||
self.username_min_length = int(params["username_min_length"])
|
self.username_min_length = int(params["username_min_length"])
|
||||||
self.username_max_length = int(params["username_max_length"])
|
self.username_max_length = int(params["username_max_length"])
|
||||||
self.password_min_length = int(params["password_min_length"])
|
self.password_min_length = int(params["password_min_length"])
|
||||||
self.passthrough_senders = params["passthrough_senders"].split()
|
self.passthrough_senders = params["passthrough_senders"].split()
|
||||||
self.passthrough_recipients = params["passthrough_recipients"].split()
|
self.passthrough_recipients = params["passthrough_recipients"].split()
|
||||||
self.www_folder = params.get("www_folder", "")
|
self.filtermail_smtp_port = int(params["filtermail_smtp_port"])
|
||||||
self.filtermail_smtp_port = int(params.get("filtermail_smtp_port", "10080"))
|
self.postfix_reinject_port = int(params["postfix_reinject_port"])
|
||||||
self.filtermail_smtp_port_incoming = int(
|
|
||||||
params.get("filtermail_smtp_port_incoming", "10081")
|
|
||||||
)
|
|
||||||
self.postfix_reinject_port = int(params.get("postfix_reinject_port", "10025"))
|
|
||||||
self.postfix_reinject_port_incoming = int(
|
|
||||||
params.get("postfix_reinject_port_incoming", "10026")
|
|
||||||
)
|
|
||||||
self.mtail_address = params.get("mtail_address")
|
|
||||||
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
self.disable_ipv6 = params.get("disable_ipv6", "false").lower() == "true"
|
||||||
self.addr_v4 = os.environ.get("CHATMAIL_ADDR_V4", "")
|
|
||||||
self.addr_v6 = os.environ.get("CHATMAIL_ADDR_V6", "")
|
|
||||||
self.acme_email = params.get("acme_email", "")
|
|
||||||
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
self.imap_rawlog = params.get("imap_rawlog", "false").lower() == "true"
|
||||||
self.imap_compress = params.get("imap_compress", "false").lower() == "true"
|
self.iroh_relay = params.get("iroh_relay")
|
||||||
if "iroh_relay" not in params:
|
|
||||||
self.iroh_relay = "https://" + params["mail_domain"]
|
|
||||||
self.enable_iroh_relay = True
|
|
||||||
else:
|
|
||||||
self.iroh_relay = params["iroh_relay"].strip()
|
|
||||||
self.enable_iroh_relay = False
|
|
||||||
self.privacy_postal = params.get("privacy_postal")
|
self.privacy_postal = params.get("privacy_postal")
|
||||||
self.privacy_mail = params.get("privacy_mail")
|
self.privacy_mail = params.get("privacy_mail")
|
||||||
self.privacy_pdo = params.get("privacy_pdo")
|
self.privacy_pdo = params.get("privacy_pdo")
|
||||||
self.privacy_supervisor = params.get("privacy_supervisor")
|
self.privacy_supervisor = params.get("privacy_supervisor")
|
||||||
|
|
||||||
# TLS certificate management.
|
|
||||||
# If tls_external_cert_and_key is set, use externally managed certs.
|
|
||||||
# Otherwise derived from the domain name:
|
|
||||||
# - Domains starting with "_" use self-signed certificates
|
|
||||||
# - All other domains use ACME.
|
|
||||||
external = params.get("tls_external_cert_and_key", "").strip()
|
|
||||||
|
|
||||||
if external:
|
|
||||||
parts = external.split()
|
|
||||||
if len(parts) != 2:
|
|
||||||
raise ValueError(
|
|
||||||
"tls_external_cert_and_key must have two space-separated"
|
|
||||||
" paths: CERT_PATH KEY_PATH"
|
|
||||||
)
|
|
||||||
self.tls_cert_mode = "external"
|
|
||||||
self.tls_cert_path, self.tls_key_path = parts
|
|
||||||
elif self.mail_domain.startswith("_"):
|
|
||||||
self.tls_cert_mode = "self"
|
|
||||||
self.tls_cert_path = "/etc/ssl/certs/mailserver.pem"
|
|
||||||
self.tls_key_path = "/etc/ssl/private/mailserver.key"
|
|
||||||
else:
|
|
||||||
self.tls_cert_mode = "acme"
|
|
||||||
self.tls_cert_path = f"/var/lib/acme/live/{self.mail_domain}/fullchain"
|
|
||||||
self.tls_key_path = f"/var/lib/acme/live/{self.mail_domain}/privkey"
|
|
||||||
|
|
||||||
# deprecated option
|
# deprecated option
|
||||||
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
mbdir = params.get("mailboxes_dir", f"/home/vmail/mail/{self.mail_domain}")
|
||||||
self.mailboxes_dir = Path(mbdir.strip())
|
self.mailboxes_dir = Path(mbdir.strip())
|
||||||
@@ -95,23 +48,21 @@ class Config:
|
|||||||
def _getbytefile(self):
|
def _getbytefile(self):
|
||||||
return open(self._inipath, "rb")
|
return open(self._inipath, "rb")
|
||||||
|
|
||||||
def get_user(self, addr) -> User:
|
def get_user(self, addr):
|
||||||
if not addr or "@" not in addr or "/" in addr:
|
if not addr or "@" not in addr or "/" in addr:
|
||||||
raise ValueError(f"invalid address {addr!r}")
|
raise ValueError(f"invalid address {addr!r}")
|
||||||
|
|
||||||
maildir = self.mailboxes_dir.joinpath(addr)
|
maildir = self.mailboxes_dir.joinpath(addr)
|
||||||
password_path = maildir.joinpath("password")
|
if addr.startswith("echo@"):
|
||||||
|
password_path = echobot_password_path
|
||||||
|
else:
|
||||||
|
password_path = maildir.joinpath("password")
|
||||||
|
|
||||||
return User(maildir, addr, password_path, uid="vmail", gid="vmail")
|
return User(maildir, addr, password_path, uid="vmail", gid="vmail")
|
||||||
|
|
||||||
|
|
||||||
def write_initial_config(inipath, mail_domain, overrides):
|
def write_initial_config(inipath, mail_domain, overrides):
|
||||||
"""Write out default config file, using the specified config value overrides."""
|
"""Write out default config file, using the specified config value overrides."""
|
||||||
content = get_default_config_content(mail_domain, **overrides)
|
|
||||||
inipath.write_text(content)
|
|
||||||
|
|
||||||
|
|
||||||
def get_default_config_content(mail_domain, **overrides):
|
|
||||||
from importlib.resources import files
|
from importlib.resources import files
|
||||||
|
|
||||||
inidir = files(__package__).joinpath("ini")
|
inidir = files(__package__).joinpath("ini")
|
||||||
@@ -143,7 +94,7 @@ def get_default_config_content(mail_domain, **overrides):
|
|||||||
lines = []
|
lines = []
|
||||||
for line in content.split("\n"):
|
for line in content.split("\n"):
|
||||||
for key, value in privacy.items():
|
for key, value in privacy.items():
|
||||||
value_lines = value.format(mail_domain=mail_domain).strip().split("\n")
|
value_lines = value.strip().split("\n")
|
||||||
if not line.startswith(f"{key} =") or not value_lines:
|
if not line.startswith(f"{key} =") or not value_lines:
|
||||||
continue
|
continue
|
||||||
if len(value_lines) == 1:
|
if len(value_lines) == 1:
|
||||||
@@ -156,4 +107,5 @@ def get_default_config_content(mail_domain, **overrides):
|
|||||||
else:
|
else:
|
||||||
lines.append(line)
|
lines.append(line)
|
||||||
content = "\n".join(lines)
|
content = "\n".join(lines)
|
||||||
return content
|
|
||||||
|
inipath.write_text(content)
|
||||||
|
|||||||
31
chatmaild/src/chatmaild/delete_inactive_users.py
Normal file
31
chatmaild/src/chatmaild/delete_inactive_users.py
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
"""
|
||||||
|
Remove inactive users
|
||||||
|
"""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import shutil
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
|
||||||
|
from .config import read_config
|
||||||
|
|
||||||
|
|
||||||
|
def delete_inactive_users(config):
|
||||||
|
cutoff_date = time.time() - config.delete_inactive_users_after * 86400
|
||||||
|
for addr in os.listdir(config.mailboxes_dir):
|
||||||
|
try:
|
||||||
|
user = config.get_user(addr)
|
||||||
|
except ValueError:
|
||||||
|
continue
|
||||||
|
|
||||||
|
read_timestamp = user.get_last_login_timestamp()
|
||||||
|
if read_timestamp and read_timestamp < cutoff_date:
|
||||||
|
path = config.mailboxes_dir.joinpath(addr)
|
||||||
|
assert path == user.maildir
|
||||||
|
shutil.rmtree(path, ignore_errors=True)
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
(cfgpath,) = sys.argv[1:]
|
||||||
|
config = read_config(cfgpath)
|
||||||
|
delete_inactive_users(config)
|
||||||
@@ -22,7 +22,7 @@ class DictProxy:
|
|||||||
wfile.flush()
|
wfile.flush()
|
||||||
|
|
||||||
def handle_dovecot_request(self, msg, transactions):
|
def handle_dovecot_request(self, msg, transactions):
|
||||||
# see https://doc.dovecot.org/2.3/developer_manual/design/dict_protocol/#dovecot-dict-protocol
|
# see https://doc.dovecot.org/developer_manual/design/dict_protocol/#dovecot-dict-protocol
|
||||||
short_command = msg[0]
|
short_command = msg[0]
|
||||||
parts = msg[1:].split("\t")
|
parts = msg[1:].split("\t")
|
||||||
|
|
||||||
@@ -87,12 +87,8 @@ class DictProxy:
|
|||||||
except FileNotFoundError:
|
except FileNotFoundError:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
with CustomThreadingUnixStreamServer(socket, Handler) as server:
|
with ThreadingUnixStreamServer(socket, Handler) as server:
|
||||||
try:
|
try:
|
||||||
server.serve_forever()
|
server.serve_forever()
|
||||||
except KeyboardInterrupt:
|
except KeyboardInterrupt:
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
class CustomThreadingUnixStreamServer(ThreadingUnixStreamServer):
|
|
||||||
request_queue_size = 1000
|
|
||||||
|
|||||||
@@ -1,13 +1,9 @@
|
|||||||
|
import crypt
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
try:
|
|
||||||
import crypt_r
|
|
||||||
except ImportError:
|
|
||||||
import crypt as crypt_r
|
|
||||||
|
|
||||||
from .config import Config, read_config
|
from .config import Config, read_config
|
||||||
from .dictproxy import DictProxy
|
from .dictproxy import DictProxy
|
||||||
from .migrate_db import migrate_from_db_to_maildir
|
from .migrate_db import migrate_from_db_to_maildir
|
||||||
@@ -16,8 +12,8 @@ NOCREATE_FILE = "/etc/chatmail-nocreate"
|
|||||||
|
|
||||||
|
|
||||||
def encrypt_password(password: str):
|
def encrypt_password(password: str):
|
||||||
# https://doc.dovecot.org/2.3/configuration_manual/authentication/password_schemes/
|
# https://doc.dovecot.org/configuration_manual/authentication/password_schemes/
|
||||||
passhash = crypt_r.crypt(password, crypt_r.METHOD_SHA512)
|
passhash = crypt.crypt(password, crypt.METHOD_SHA512)
|
||||||
return "{SHA512-CRYPT}" + passhash
|
return "{SHA512-CRYPT}" + passhash
|
||||||
|
|
||||||
|
|
||||||
@@ -40,6 +36,10 @@ def is_allowed_to_create(config: Config, user, cleartext_password) -> bool:
|
|||||||
return False
|
return False
|
||||||
localpart, domain = parts
|
localpart, domain = parts
|
||||||
|
|
||||||
|
if localpart == "echo":
|
||||||
|
# echobot account should not be created in the database
|
||||||
|
return False
|
||||||
|
|
||||||
if (
|
if (
|
||||||
len(localpart) > config.username_max_length
|
len(localpart) > config.username_max_length
|
||||||
or len(localpart) < config.username_min_length
|
or len(localpart) < config.username_min_length
|
||||||
|
|||||||
104
chatmaild/src/chatmaild/echo.py
Normal file
104
chatmaild/src/chatmaild/echo.py
Normal file
@@ -0,0 +1,104 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
"""Advanced echo bot example.
|
||||||
|
|
||||||
|
it will echo back any message that has non-empty text and also supports the /help command.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import logging
|
||||||
|
import os
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
|
||||||
|
from deltachat_rpc_client import Bot, DeltaChat, EventType, Rpc, events
|
||||||
|
|
||||||
|
from chatmaild.config import echobot_password_path, read_config
|
||||||
|
from chatmaild.doveauth import encrypt_password
|
||||||
|
from chatmaild.newemail import create_newemail_dict
|
||||||
|
|
||||||
|
hooks = events.HookCollection()
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.RawEvent)
|
||||||
|
def log_event(event):
|
||||||
|
if event.kind == EventType.INFO:
|
||||||
|
logging.info(event.msg)
|
||||||
|
elif event.kind == EventType.WARNING:
|
||||||
|
logging.warning(event.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.RawEvent(EventType.ERROR))
|
||||||
|
def log_error(event):
|
||||||
|
logging.error("%s", event.msg)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.MemberListChanged)
|
||||||
|
def on_memberlist_changed(event):
|
||||||
|
logging.info(
|
||||||
|
"member %s was %s", event.member, "added" if event.member_added else "removed"
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.GroupImageChanged)
|
||||||
|
def on_group_image_changed(event):
|
||||||
|
logging.info("group image %s", "deleted" if event.image_deleted else "changed")
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.GroupNameChanged)
|
||||||
|
def on_group_name_changed(event):
|
||||||
|
logging.info(f"group name changed, old name: {event.old_name}")
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.NewMessage(func=lambda e: not e.command))
|
||||||
|
def echo(event):
|
||||||
|
snapshot = event.message_snapshot
|
||||||
|
if snapshot.is_info:
|
||||||
|
# Ignore info messages
|
||||||
|
return
|
||||||
|
if snapshot.text or snapshot.file:
|
||||||
|
snapshot.chat.send_message(text=snapshot.text, file=snapshot.file)
|
||||||
|
|
||||||
|
|
||||||
|
@hooks.on(events.NewMessage(command="/help"))
|
||||||
|
def help_command(event):
|
||||||
|
snapshot = event.message_snapshot
|
||||||
|
snapshot.chat.send_text("Send me any message and I will echo it back")
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
logging.basicConfig(level=logging.INFO)
|
||||||
|
path = os.environ.get("PATH")
|
||||||
|
venv_path = sys.argv[0].strip("echobot")
|
||||||
|
os.environ["PATH"] = path + ":" + venv_path
|
||||||
|
with Rpc() as rpc:
|
||||||
|
deltachat = DeltaChat(rpc)
|
||||||
|
system_info = deltachat.get_system_info()
|
||||||
|
logging.info(f"Running deltachat core {system_info.deltachat_core_version}")
|
||||||
|
|
||||||
|
accounts = deltachat.get_all_accounts()
|
||||||
|
account = accounts[0] if accounts else deltachat.add_account()
|
||||||
|
|
||||||
|
bot = Bot(account, hooks)
|
||||||
|
|
||||||
|
config = read_config(sys.argv[1])
|
||||||
|
addr = "echo@" + config.mail_domain
|
||||||
|
|
||||||
|
# Create password file
|
||||||
|
if bot.is_configured():
|
||||||
|
password = bot.account.get_config("mail_pw")
|
||||||
|
else:
|
||||||
|
password = create_newemail_dict(config)["password"]
|
||||||
|
|
||||||
|
echobot_password_path.write_text(encrypt_password(password))
|
||||||
|
# Give the user which doveauth runs as access to the password file.
|
||||||
|
subprocess.check_call(
|
||||||
|
["/usr/bin/setfacl", "-m", "user:vmail:r", echobot_password_path],
|
||||||
|
)
|
||||||
|
|
||||||
|
if not bot.is_configured():
|
||||||
|
bot.configure(addr, password)
|
||||||
|
|
||||||
|
bot.run_forever()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
main()
|
||||||
@@ -1,206 +0,0 @@
|
|||||||
"""
|
|
||||||
Expire old messages and addresses.
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
import sys
|
|
||||||
import time
|
|
||||||
from argparse import ArgumentParser
|
|
||||||
from collections import namedtuple
|
|
||||||
from datetime import datetime
|
|
||||||
from stat import S_ISREG
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
|
|
||||||
FileEntry = namedtuple("FileEntry", ("path", "mtime", "size"))
|
|
||||||
|
|
||||||
|
|
||||||
def iter_mailboxes(basedir, maxnum):
|
|
||||||
if not os.path.exists(basedir):
|
|
||||||
print_info(f"no mailboxes found at: {basedir}")
|
|
||||||
return
|
|
||||||
|
|
||||||
for name in os_listdir_if_exists(basedir)[:maxnum]:
|
|
||||||
if "@" in name:
|
|
||||||
yield MailboxStat(basedir + "/" + name)
|
|
||||||
|
|
||||||
|
|
||||||
def get_file_entry(path):
|
|
||||||
"""return a FileEntry or None if the path does not exist or is not a regular file."""
|
|
||||||
try:
|
|
||||||
st = os.stat(path)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return None
|
|
||||||
if not S_ISREG(st.st_mode):
|
|
||||||
return None
|
|
||||||
return FileEntry(path, st.st_mtime, st.st_size)
|
|
||||||
|
|
||||||
|
|
||||||
def os_listdir_if_exists(path):
|
|
||||||
"""return a list of names obtained from os.listdir or an empty list if the path does not exist."""
|
|
||||||
try:
|
|
||||||
return os.listdir(path)
|
|
||||||
except FileNotFoundError:
|
|
||||||
return []
|
|
||||||
|
|
||||||
|
|
||||||
class MailboxStat:
|
|
||||||
last_login = None
|
|
||||||
|
|
||||||
def __init__(self, basedir):
|
|
||||||
self.basedir = str(basedir)
|
|
||||||
self.messages = []
|
|
||||||
self.extrafiles = []
|
|
||||||
self.scandir(self.basedir)
|
|
||||||
|
|
||||||
def scandir(self, folderdir):
|
|
||||||
for name in os_listdir_if_exists(folderdir):
|
|
||||||
path = f"{folderdir}/{name}"
|
|
||||||
if name in ("cur", "new", "tmp"):
|
|
||||||
for msg_name in os_listdir_if_exists(path):
|
|
||||||
entry = get_file_entry(f"{path}/{msg_name}")
|
|
||||||
if entry is not None:
|
|
||||||
self.messages.append(entry)
|
|
||||||
elif os.path.isdir(path):
|
|
||||||
self.scandir(path)
|
|
||||||
else:
|
|
||||||
entry = get_file_entry(path)
|
|
||||||
if entry is not None:
|
|
||||||
self.extrafiles.append(entry)
|
|
||||||
if name == "password":
|
|
||||||
self.last_login = entry.mtime
|
|
||||||
self.extrafiles.sort(key=lambda x: -x.size)
|
|
||||||
|
|
||||||
|
|
||||||
def print_info(msg):
|
|
||||||
print(msg, file=sys.stderr)
|
|
||||||
|
|
||||||
|
|
||||||
class Expiry:
|
|
||||||
def __init__(self, config, dry, now, verbose):
|
|
||||||
self.config = config
|
|
||||||
self.dry = dry
|
|
||||||
self.now = now
|
|
||||||
self.verbose = verbose
|
|
||||||
self.del_mboxes = 0
|
|
||||||
self.all_mboxes = 0
|
|
||||||
self.del_files = 0
|
|
||||||
self.all_files = 0
|
|
||||||
self.start = time.time()
|
|
||||||
|
|
||||||
def remove_mailbox(self, mboxdir):
|
|
||||||
if self.verbose:
|
|
||||||
print_info(f"removing {mboxdir}")
|
|
||||||
if not self.dry:
|
|
||||||
shutil.rmtree(mboxdir)
|
|
||||||
self.del_mboxes += 1
|
|
||||||
|
|
||||||
def remove_file(self, path, mtime=None):
|
|
||||||
if self.verbose:
|
|
||||||
if mtime is not None:
|
|
||||||
date = datetime.fromtimestamp(mtime).strftime("%b %d")
|
|
||||||
print_info(f"removing {date} {path}")
|
|
||||||
else:
|
|
||||||
print_info(f"removing {path}")
|
|
||||||
if not self.dry:
|
|
||||||
try:
|
|
||||||
os.unlink(path)
|
|
||||||
except FileNotFoundError:
|
|
||||||
print_info(f"file not found/vanished {path}")
|
|
||||||
self.del_files += 1
|
|
||||||
|
|
||||||
def process_mailbox_stat(self, mbox):
|
|
||||||
cutoff_without_login = (
|
|
||||||
self.now - int(self.config.delete_inactive_users_after) * 86400
|
|
||||||
)
|
|
||||||
cutoff_mails = self.now - int(self.config.delete_mails_after) * 86400
|
|
||||||
cutoff_large_mails = self.now - int(self.config.delete_large_after) * 86400
|
|
||||||
|
|
||||||
self.all_mboxes += 1
|
|
||||||
changed = False
|
|
||||||
if mbox.last_login and mbox.last_login < cutoff_without_login:
|
|
||||||
self.remove_mailbox(mbox.basedir)
|
|
||||||
return
|
|
||||||
|
|
||||||
mboxname = os.path.basename(mbox.basedir)
|
|
||||||
if self.verbose:
|
|
||||||
date = datetime.fromtimestamp(mbox.last_login) if mbox.last_login else None
|
|
||||||
if date:
|
|
||||||
print_info(f"checking mailbox {date.strftime('%b %d')} {mboxname}")
|
|
||||||
else:
|
|
||||||
print_info(f"checking mailbox (no last_login) {mboxname}")
|
|
||||||
self.all_files += len(mbox.messages)
|
|
||||||
for message in mbox.messages:
|
|
||||||
if message.mtime < cutoff_mails:
|
|
||||||
self.remove_file(message.path, mtime=message.mtime)
|
|
||||||
elif message.size > 200000 and message.mtime < cutoff_large_mails:
|
|
||||||
# we only remove noticed large files (not unnoticed ones in new/)
|
|
||||||
parts = message.path.split("/")
|
|
||||||
if len(parts) >= 2 and parts[-2] == "cur":
|
|
||||||
self.remove_file(message.path, mtime=message.mtime)
|
|
||||||
else:
|
|
||||||
continue
|
|
||||||
changed = True
|
|
||||||
if changed:
|
|
||||||
self.remove_file(f"{mbox.basedir}/maildirsize")
|
|
||||||
|
|
||||||
def get_summary(self):
|
|
||||||
return (
|
|
||||||
f"Removed {self.del_mboxes} out of {self.all_mboxes} mailboxes "
|
|
||||||
f"and {self.del_files} out of {self.all_files} files in existing mailboxes "
|
|
||||||
f"in {time.time() - self.start:2.2f} seconds"
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
|
||||||
"""Expire mailboxes and messages according to chatmail config"""
|
|
||||||
parser = ArgumentParser(description=main.__doc__)
|
|
||||||
ini = "/usr/local/lib/chatmaild/chatmail.ini"
|
|
||||||
parser.add_argument(
|
|
||||||
"chatmail_ini",
|
|
||||||
action="store",
|
|
||||||
nargs="?",
|
|
||||||
help=f"path pointing to chatmail.ini file, default: {ini}",
|
|
||||||
default=ini,
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--days", action="store", help="assume date to be days older than now"
|
|
||||||
)
|
|
||||||
|
|
||||||
parser.add_argument(
|
|
||||||
"--maxnum",
|
|
||||||
default=None,
|
|
||||||
action="store",
|
|
||||||
help="maximum number of mailboxes to iterate on",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"-v",
|
|
||||||
dest="verbose",
|
|
||||||
action="store_true",
|
|
||||||
help="print out removed files and mailboxes",
|
|
||||||
)
|
|
||||||
|
|
||||||
parser.add_argument(
|
|
||||||
"--remove",
|
|
||||||
dest="remove",
|
|
||||||
action="store_true",
|
|
||||||
help="actually remove all expired files and dirs",
|
|
||||||
)
|
|
||||||
args = parser.parse_args(args)
|
|
||||||
|
|
||||||
config = read_config(args.chatmail_ini)
|
|
||||||
now = datetime.utcnow().timestamp()
|
|
||||||
if args.days:
|
|
||||||
now = now - 86400 * int(args.days)
|
|
||||||
|
|
||||||
maxnum = int(args.maxnum) if args.maxnum else None
|
|
||||||
exp = Expiry(config, dry=not args.remove, now=now, verbose=args.verbose)
|
|
||||||
for mailbox in iter_mailboxes(str(config.mailboxes_dir), maxnum=maxnum):
|
|
||||||
exp.process_mailbox_stat(mailbox)
|
|
||||||
print(exp.get_summary())
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main(sys.argv[1:])
|
|
||||||
239
chatmaild/src/chatmaild/filtermail.py
Normal file
239
chatmaild/src/chatmaild/filtermail.py
Normal file
@@ -0,0 +1,239 @@
|
|||||||
|
#!/usr/bin/env python3
|
||||||
|
import asyncio
|
||||||
|
import base64
|
||||||
|
import binascii
|
||||||
|
import logging
|
||||||
|
import sys
|
||||||
|
import time
|
||||||
|
from email import policy
|
||||||
|
from email.parser import BytesParser
|
||||||
|
from email.utils import parseaddr
|
||||||
|
from smtplib import SMTP as SMTPClient
|
||||||
|
|
||||||
|
from aiosmtpd.controller import Controller
|
||||||
|
|
||||||
|
from .common_encrypted_subjects import common_encrypted_subjects
|
||||||
|
from .config import read_config
|
||||||
|
|
||||||
|
|
||||||
|
def check_openpgp_payload(payload: bytes):
|
||||||
|
"""Checks the OpenPGP payload.
|
||||||
|
|
||||||
|
OpenPGP payload must consist only of PKESK and SKESK packets
|
||||||
|
terminated by a single SEIPD packet.
|
||||||
|
|
||||||
|
Returns True if OpenPGP payload is correct,
|
||||||
|
False otherwise.
|
||||||
|
|
||||||
|
May raise IndexError while trying to read OpenPGP packet header
|
||||||
|
if it is truncated.
|
||||||
|
"""
|
||||||
|
i = 0
|
||||||
|
while i < len(payload):
|
||||||
|
# Only OpenPGP format is allowed.
|
||||||
|
if payload[i] & 0xC0 != 0xC0:
|
||||||
|
return False
|
||||||
|
|
||||||
|
packet_type_id = payload[i] & 0x3F
|
||||||
|
i += 1
|
||||||
|
if payload[i] < 192:
|
||||||
|
# One-octet length.
|
||||||
|
body_len = payload[i]
|
||||||
|
i += 1
|
||||||
|
elif payload[i] < 224:
|
||||||
|
# Two-octet length.
|
||||||
|
body_len = ((payload[i] - 192) << 8) + payload[i + 1] + 192
|
||||||
|
i += 2
|
||||||
|
elif payload[i] == 255:
|
||||||
|
# Five-octet length.
|
||||||
|
body_len = (
|
||||||
|
(payload[i + 1] << 24)
|
||||||
|
| (payload[i + 2] << 16)
|
||||||
|
| (payload[i + 3] << 8)
|
||||||
|
| payload[i + 4]
|
||||||
|
)
|
||||||
|
i += 5
|
||||||
|
else:
|
||||||
|
# Partial body length is not allowed.
|
||||||
|
return False
|
||||||
|
|
||||||
|
i += body_len
|
||||||
|
|
||||||
|
if i == len(payload):
|
||||||
|
if packet_type_id == 18:
|
||||||
|
# Last packet should be
|
||||||
|
# Symmetrically Encrypted and Integrity Protected Data Packet (SEIPD)
|
||||||
|
return True
|
||||||
|
elif packet_type_id not in [1, 3]:
|
||||||
|
# All packets except the last one must be either
|
||||||
|
# Public-Key Encrypted Session Key Packet (PKESK)
|
||||||
|
# or
|
||||||
|
# Symmetric-Key Encrypted Session Key Packet (SKESK)
|
||||||
|
return False
|
||||||
|
|
||||||
|
if i == 0:
|
||||||
|
return False
|
||||||
|
|
||||||
|
if i > len(payload):
|
||||||
|
# Payload is truncated.
|
||||||
|
return False
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
def check_armored_payload(payload: str):
|
||||||
|
prefix = "-----BEGIN PGP MESSAGE-----\r\n\r\n"
|
||||||
|
if not payload.startswith(prefix):
|
||||||
|
return False
|
||||||
|
payload = payload.removeprefix(prefix)
|
||||||
|
|
||||||
|
suffix = "-----END PGP MESSAGE-----\r\n\r\n"
|
||||||
|
if not payload.endswith(suffix):
|
||||||
|
return False
|
||||||
|
payload = payload.removesuffix(suffix)
|
||||||
|
|
||||||
|
# Remove CRC24.
|
||||||
|
payload = payload.rpartition("=")[0]
|
||||||
|
|
||||||
|
try:
|
||||||
|
payload = base64.b64decode(payload)
|
||||||
|
except binascii.Error:
|
||||||
|
return False
|
||||||
|
|
||||||
|
try:
|
||||||
|
return check_openpgp_payload(payload)
|
||||||
|
except IndexError:
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def check_encrypted(message):
|
||||||
|
"""Check that the message is an OpenPGP-encrypted message.
|
||||||
|
|
||||||
|
MIME structure of the message must correspond to <https://www.rfc-editor.org/rfc/rfc3156>.
|
||||||
|
"""
|
||||||
|
if not message.is_multipart():
|
||||||
|
return False
|
||||||
|
if message.get("subject") not in common_encrypted_subjects:
|
||||||
|
return False
|
||||||
|
if message.get_content_type() != "multipart/encrypted":
|
||||||
|
return False
|
||||||
|
parts_count = 0
|
||||||
|
for part in message.iter_parts():
|
||||||
|
# We explicitly check Content-Type of each part later,
|
||||||
|
# but this is to be absolutely sure `get_payload()` returns string and not list.
|
||||||
|
if part.is_multipart():
|
||||||
|
return False
|
||||||
|
|
||||||
|
if parts_count == 0:
|
||||||
|
if part.get_content_type() != "application/pgp-encrypted":
|
||||||
|
return False
|
||||||
|
|
||||||
|
payload = part.get_payload()
|
||||||
|
if payload.strip() != "Version: 1":
|
||||||
|
return False
|
||||||
|
elif parts_count == 1:
|
||||||
|
if part.get_content_type() != "application/octet-stream":
|
||||||
|
return False
|
||||||
|
|
||||||
|
if not check_armored_payload(part.get_payload()):
|
||||||
|
return False
|
||||||
|
else:
|
||||||
|
return False
|
||||||
|
parts_count += 1
|
||||||
|
return True
|
||||||
|
|
||||||
|
|
||||||
|
async def asyncmain_beforequeue(config):
|
||||||
|
port = config.filtermail_smtp_port
|
||||||
|
Controller(BeforeQueueHandler(config), hostname="127.0.0.1", port=port).start()
|
||||||
|
|
||||||
|
|
||||||
|
class BeforeQueueHandler:
|
||||||
|
def __init__(self, config):
|
||||||
|
self.config = config
|
||||||
|
self.send_rate_limiter = SendRateLimiter()
|
||||||
|
|
||||||
|
async def handle_MAIL(self, server, session, envelope, address, mail_options):
|
||||||
|
logging.info(f"handle_MAIL from {address}")
|
||||||
|
envelope.mail_from = address
|
||||||
|
max_sent = self.config.max_user_send_per_minute
|
||||||
|
if not self.send_rate_limiter.is_sending_allowed(address, max_sent):
|
||||||
|
return f"450 4.7.1: Too much mail from {address}"
|
||||||
|
|
||||||
|
parts = envelope.mail_from.split("@")
|
||||||
|
if len(parts) != 2:
|
||||||
|
return f"500 Invalid from address <{envelope.mail_from!r}>"
|
||||||
|
|
||||||
|
return "250 OK"
|
||||||
|
|
||||||
|
async def handle_DATA(self, server, session, envelope):
|
||||||
|
logging.info("handle_DATA before-queue")
|
||||||
|
error = self.check_DATA(envelope)
|
||||||
|
if error:
|
||||||
|
return error
|
||||||
|
logging.info("re-injecting the mail that passed checks")
|
||||||
|
client = SMTPClient("localhost", self.config.postfix_reinject_port)
|
||||||
|
client.sendmail(envelope.mail_from, envelope.rcpt_tos, envelope.content)
|
||||||
|
return "250 OK"
|
||||||
|
|
||||||
|
def check_DATA(self, envelope):
|
||||||
|
"""the central filtering function for e-mails."""
|
||||||
|
logging.info(f"Processing DATA message from {envelope.mail_from}")
|
||||||
|
|
||||||
|
message = BytesParser(policy=policy.default).parsebytes(envelope.content)
|
||||||
|
mail_encrypted = check_encrypted(message)
|
||||||
|
|
||||||
|
_, from_addr = parseaddr(message.get("from").strip())
|
||||||
|
logging.info(f"mime-from: {from_addr} envelope-from: {envelope.mail_from!r}")
|
||||||
|
if envelope.mail_from.lower() != from_addr.lower():
|
||||||
|
return f"500 Invalid FROM <{from_addr!r}> for <{envelope.mail_from!r}>"
|
||||||
|
|
||||||
|
if envelope.mail_from in self.config.passthrough_senders:
|
||||||
|
return
|
||||||
|
|
||||||
|
passthrough_recipients = self.config.passthrough_recipients
|
||||||
|
envelope_from_domain = from_addr.split("@").pop()
|
||||||
|
for recipient in envelope.rcpt_tos:
|
||||||
|
if envelope.mail_from == recipient:
|
||||||
|
# Always allow sending emails to self.
|
||||||
|
continue
|
||||||
|
if recipient in passthrough_recipients:
|
||||||
|
continue
|
||||||
|
res = recipient.split("@")
|
||||||
|
if len(res) != 2:
|
||||||
|
return f"500 Invalid address <{recipient}>"
|
||||||
|
_recipient_addr, recipient_domain = res
|
||||||
|
|
||||||
|
is_outgoing = recipient_domain != envelope_from_domain
|
||||||
|
if is_outgoing and not mail_encrypted:
|
||||||
|
is_securejoin = message.get("secure-join") in [
|
||||||
|
"vc-request",
|
||||||
|
"vg-request",
|
||||||
|
]
|
||||||
|
if not is_securejoin:
|
||||||
|
return f"500 Invalid unencrypted mail to <{recipient}>"
|
||||||
|
|
||||||
|
|
||||||
|
class SendRateLimiter:
|
||||||
|
def __init__(self):
|
||||||
|
self.addr2timestamps = {}
|
||||||
|
|
||||||
|
def is_sending_allowed(self, mail_from, max_send_per_minute):
|
||||||
|
last = self.addr2timestamps.setdefault(mail_from, [])
|
||||||
|
now = time.time()
|
||||||
|
last[:] = [ts for ts in last if ts >= (now - 60)]
|
||||||
|
if len(last) <= max_send_per_minute:
|
||||||
|
last.append(now)
|
||||||
|
return True
|
||||||
|
return False
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
args = sys.argv[1:]
|
||||||
|
assert len(args) == 1
|
||||||
|
config = read_config(args[0])
|
||||||
|
logging.basicConfig(level=logging.WARN)
|
||||||
|
loop = asyncio.new_event_loop()
|
||||||
|
asyncio.set_event_loop(loop)
|
||||||
|
task = asyncmain_beforequeue(config)
|
||||||
|
loop.create_task(task)
|
||||||
|
loop.run_forever()
|
||||||
@@ -1,287 +0,0 @@
|
|||||||
"""
|
|
||||||
command line tool to analyze mailbox message storage
|
|
||||||
|
|
||||||
example invocation:
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport /path/to/chatmail.ini
|
|
||||||
|
|
||||||
to show storage summaries for all "cur" folders
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport /path/to/chatmail.ini --mdir cur
|
|
||||||
|
|
||||||
to show storage summaries only for first 1000 mailboxes
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport /path/to/chatmail.ini --maxnum 1000
|
|
||||||
|
|
||||||
to write Prometheus textfile for node_exporter
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport --textfile /var/lib/prometheus/node-exporter/
|
|
||||||
|
|
||||||
writes to /var/lib/prometheus/node-exporter/fsreport.prom
|
|
||||||
|
|
||||||
to also write legacy metrics.py style output (default: /var/www/html/metrics):
|
|
||||||
|
|
||||||
python -m chatmaild.fsreport --textfile /var/lib/prometheus/node-exporter/ --legacy-metrics
|
|
||||||
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import tempfile
|
|
||||||
from argparse import ArgumentParser
|
|
||||||
from datetime import datetime
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
from chatmaild.expire import iter_mailboxes
|
|
||||||
|
|
||||||
DAYSECONDS = 24 * 60 * 60
|
|
||||||
MONTHSECONDS = DAYSECONDS * 30
|
|
||||||
|
|
||||||
|
|
||||||
def HSize(size: int):
|
|
||||||
"""Format a size integer as a Human-readable string Kilobyte, Megabyte or Gigabyte"""
|
|
||||||
if size < 10000:
|
|
||||||
return f"{size / 1000:5.2f}K"
|
|
||||||
if size < 1000 * 1000:
|
|
||||||
return f"{size / 1000:5.0f}K"
|
|
||||||
if size < 1000 * 1000 * 1000:
|
|
||||||
return f"{int(size / 1000000):5.0f}M"
|
|
||||||
return f"{size / 1000000000:5.2f}G"
|
|
||||||
|
|
||||||
|
|
||||||
class Report:
|
|
||||||
def __init__(self, now, min_login_age, mdir):
|
|
||||||
self.size_extra = 0
|
|
||||||
self.size_messages = 0
|
|
||||||
self.now = now
|
|
||||||
self.min_login_age = min_login_age
|
|
||||||
self.mdir = mdir
|
|
||||||
|
|
||||||
self.num_ci_logins = self.num_all_logins = 0
|
|
||||||
self.login_buckets = {x: 0 for x in (1, 10, 30, 40, 80, 100, 150)}
|
|
||||||
|
|
||||||
KiB = 1024
|
|
||||||
MiB = 1024 * KiB
|
|
||||||
self.message_size_thresholds = (
|
|
||||||
0,
|
|
||||||
100 * KiB,
|
|
||||||
MiB // 2,
|
|
||||||
1 * MiB,
|
|
||||||
2 * MiB,
|
|
||||||
5 * MiB,
|
|
||||||
10 * MiB,
|
|
||||||
)
|
|
||||||
self.message_buckets = {x: 0 for x in self.message_size_thresholds}
|
|
||||||
self.message_count_buckets = {x: 0 for x in self.message_size_thresholds}
|
|
||||||
|
|
||||||
def process_mailbox_stat(self, mailbox):
|
|
||||||
# categorize login times
|
|
||||||
last_login = mailbox.last_login
|
|
||||||
if last_login:
|
|
||||||
self.num_all_logins += 1
|
|
||||||
if os.path.basename(mailbox.basedir)[:3] == "ci-":
|
|
||||||
self.num_ci_logins += 1
|
|
||||||
else:
|
|
||||||
for days in self.login_buckets:
|
|
||||||
if last_login >= self.now - days * DAYSECONDS:
|
|
||||||
self.login_buckets[days] += 1
|
|
||||||
|
|
||||||
cutoff_login_date = self.now - self.min_login_age * DAYSECONDS
|
|
||||||
if last_login and last_login <= cutoff_login_date:
|
|
||||||
# categorize message sizes
|
|
||||||
for size in self.message_buckets:
|
|
||||||
for msg in mailbox.messages:
|
|
||||||
if msg.size >= size:
|
|
||||||
if self.mdir and f"/{self.mdir}/" not in msg.path:
|
|
||||||
continue
|
|
||||||
self.message_buckets[size] += msg.size
|
|
||||||
self.message_count_buckets[size] += 1
|
|
||||||
|
|
||||||
self.size_messages += sum(entry.size for entry in mailbox.messages)
|
|
||||||
self.size_extra += sum(entry.size for entry in mailbox.extrafiles)
|
|
||||||
|
|
||||||
def dump_summary(self):
|
|
||||||
all_messages = self.size_messages
|
|
||||||
print()
|
|
||||||
print("## Mailbox storage use analysis")
|
|
||||||
print(f"Mailbox data total size: {HSize(self.size_extra + all_messages)}")
|
|
||||||
print(f"Messages total size : {HSize(all_messages)}")
|
|
||||||
try:
|
|
||||||
percent = self.size_extra / (self.size_extra + all_messages) * 100
|
|
||||||
except ZeroDivisionError:
|
|
||||||
percent = 100
|
|
||||||
print(f"Extra files : {HSize(self.size_extra)} ({percent:.2f}%)")
|
|
||||||
|
|
||||||
print()
|
|
||||||
if self.min_login_age:
|
|
||||||
print(f"### Message storage for {self.min_login_age} days old logins")
|
|
||||||
|
|
||||||
pref = f"[{self.mdir}] " if self.mdir else ""
|
|
||||||
for minsize, sumsize in self.message_buckets.items():
|
|
||||||
count = self.message_count_buckets[minsize]
|
|
||||||
percent = (sumsize / all_messages * 100) if all_messages else 0
|
|
||||||
print(
|
|
||||||
f"{pref}larger than {HSize(minsize)}: {HSize(sumsize)} ({percent:.2f}%), {count} msgs"
|
|
||||||
)
|
|
||||||
|
|
||||||
user_logins = self.num_all_logins - self.num_ci_logins
|
|
||||||
|
|
||||||
def p(num):
|
|
||||||
return f"({num / user_logins * 100:2.2f}%)" if user_logins else "100%"
|
|
||||||
|
|
||||||
print()
|
|
||||||
print(f"## Login stats, from date reference {datetime.fromtimestamp(self.now)}")
|
|
||||||
print(f"all: {HSize(self.num_all_logins)}")
|
|
||||||
print(f"non-ci: {HSize(user_logins)}")
|
|
||||||
print(f"ci: {HSize(self.num_ci_logins)}")
|
|
||||||
for days, active in self.login_buckets.items():
|
|
||||||
print(f"last {days:3} days: {HSize(active)} {p(active)}")
|
|
||||||
|
|
||||||
def _write_atomic(self, filepath, content):
|
|
||||||
"""Atomically write content to filepath via tmp+rename."""
|
|
||||||
dirpath = os.path.dirname(os.path.abspath(filepath))
|
|
||||||
fd, tmppath = tempfile.mkstemp(dir=dirpath, suffix=".tmp")
|
|
||||||
try:
|
|
||||||
with os.fdopen(fd, "w") as f:
|
|
||||||
f.write(content)
|
|
||||||
os.chmod(tmppath, 0o644)
|
|
||||||
os.rename(tmppath, filepath)
|
|
||||||
except BaseException:
|
|
||||||
try:
|
|
||||||
os.unlink(tmppath)
|
|
||||||
except OSError:
|
|
||||||
pass
|
|
||||||
raise
|
|
||||||
|
|
||||||
def dump_textfile(self, filepath):
|
|
||||||
"""Dump metrics in Prometheus exposition format."""
|
|
||||||
lines = []
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_storage_bytes Mailbox storage in bytes.")
|
|
||||||
lines.append("# TYPE chatmail_storage_bytes gauge")
|
|
||||||
lines.append(f'chatmail_storage_bytes{{kind="messages"}} {self.size_messages}')
|
|
||||||
lines.append(f'chatmail_storage_bytes{{kind="extra"}} {self.size_extra}')
|
|
||||||
total = self.size_extra + self.size_messages
|
|
||||||
lines.append(f'chatmail_storage_bytes{{kind="total"}} {total}')
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_messages_bytes Sum of msg bytes >= threshold.")
|
|
||||||
lines.append("# TYPE chatmail_messages_bytes gauge")
|
|
||||||
for minsize, sumsize in self.message_buckets.items():
|
|
||||||
lines.append(f'chatmail_messages_bytes{{min_size="{minsize}"}} {sumsize}')
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_messages_count Number of msgs >= size threshold.")
|
|
||||||
lines.append("# TYPE chatmail_messages_count gauge")
|
|
||||||
for minsize, count in self.message_count_buckets.items():
|
|
||||||
lines.append(f'chatmail_messages_count{{min_size="{minsize}"}} {count}')
|
|
||||||
|
|
||||||
lines.append("# HELP chatmail_accounts Number of accounts.")
|
|
||||||
lines.append("# TYPE chatmail_accounts gauge")
|
|
||||||
user_logins = self.num_all_logins - self.num_ci_logins
|
|
||||||
lines.append(f'chatmail_accounts{{kind="all"}} {self.num_all_logins}')
|
|
||||||
lines.append(f'chatmail_accounts{{kind="ci"}} {self.num_ci_logins}')
|
|
||||||
lines.append(f'chatmail_accounts{{kind="user"}} {user_logins}')
|
|
||||||
|
|
||||||
lines.append(
|
|
||||||
"# HELP chatmail_accounts_active Non-CI accounts active within N days."
|
|
||||||
)
|
|
||||||
lines.append("# TYPE chatmail_accounts_active gauge")
|
|
||||||
for days, active in self.login_buckets.items():
|
|
||||||
lines.append(f'chatmail_accounts_active{{days="{days}"}} {active}')
|
|
||||||
|
|
||||||
self._write_atomic(filepath, "\n".join(lines) + "\n")
|
|
||||||
|
|
||||||
def dump_compat_textfile(self, filepath):
|
|
||||||
"""Dump legacy metrics.py style metrics."""
|
|
||||||
user_logins = self.num_all_logins - self.num_ci_logins
|
|
||||||
lines = [
|
|
||||||
"# HELP total number of accounts",
|
|
||||||
"# TYPE accounts gauge",
|
|
||||||
f"accounts {self.num_all_logins}",
|
|
||||||
"# HELP number of CI accounts",
|
|
||||||
"# TYPE ci_accounts gauge",
|
|
||||||
f"ci_accounts {self.num_ci_logins}",
|
|
||||||
"# HELP number of non-CI accounts",
|
|
||||||
"# TYPE nonci_accounts gauge",
|
|
||||||
f"nonci_accounts {user_logins}",
|
|
||||||
]
|
|
||||||
self._write_atomic(filepath, "\n".join(lines) + "\n")
|
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
|
||||||
"""Report about filesystem storage usage of all mailboxes and messages"""
|
|
||||||
parser = ArgumentParser(description=main.__doc__)
|
|
||||||
ini = "/usr/local/lib/chatmaild/chatmail.ini"
|
|
||||||
parser.add_argument(
|
|
||||||
"chatmail_ini",
|
|
||||||
action="store",
|
|
||||||
nargs="?",
|
|
||||||
help=f"path pointing to chatmail.ini file, default: {ini}",
|
|
||||||
default=ini,
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--days",
|
|
||||||
default=0,
|
|
||||||
action="store",
|
|
||||||
help="assume date to be DAYS older than now",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--min-login-age",
|
|
||||||
default=0,
|
|
||||||
metavar="DAYS",
|
|
||||||
dest="min_login_age",
|
|
||||||
action="store",
|
|
||||||
help="only sum up message size if last login is at least DAYS days old",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--mdir",
|
|
||||||
metavar="{cur,new,tmp}",
|
|
||||||
action="store",
|
|
||||||
help="only consider messages in specified Maildir subdirectory for summary",
|
|
||||||
)
|
|
||||||
|
|
||||||
parser.add_argument(
|
|
||||||
"--maxnum",
|
|
||||||
default=None,
|
|
||||||
action="store",
|
|
||||||
help="maximum number of mailboxes to iterate on",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--textfile",
|
|
||||||
metavar="PATH",
|
|
||||||
default=None,
|
|
||||||
help="write Prometheus textfile to PATH (directory or file); "
|
|
||||||
"if PATH is a directory, writes 'fsreport.prom' inside it",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--legacy-metrics",
|
|
||||||
metavar="FILENAME",
|
|
||||||
nargs="?",
|
|
||||||
const="/var/www/html/metrics",
|
|
||||||
default=None,
|
|
||||||
help="write legacy metrics.py textfile (default: /var/www/html/metrics)",
|
|
||||||
)
|
|
||||||
|
|
||||||
args = parser.parse_args(args)
|
|
||||||
|
|
||||||
config = read_config(args.chatmail_ini)
|
|
||||||
|
|
||||||
now = datetime.utcnow().timestamp()
|
|
||||||
if args.days:
|
|
||||||
now = now - 86400 * int(args.days)
|
|
||||||
|
|
||||||
maxnum = int(args.maxnum) if args.maxnum else None
|
|
||||||
rep = Report(now=now, min_login_age=int(args.min_login_age), mdir=args.mdir)
|
|
||||||
for mbox in iter_mailboxes(str(config.mailboxes_dir), maxnum=maxnum):
|
|
||||||
rep.process_mailbox_stat(mbox)
|
|
||||||
if args.textfile:
|
|
||||||
path = args.textfile
|
|
||||||
if os.path.isdir(path):
|
|
||||||
path = os.path.join(path, "fsreport.prom")
|
|
||||||
rep.dump_textfile(path)
|
|
||||||
if args.legacy_metrics:
|
|
||||||
rep.dump_compat_textfile(args.legacy_metrics)
|
|
||||||
if not args.textfile and not args.legacy_metrics:
|
|
||||||
rep.dump_summary()
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
|
||||||
main()
|
|
||||||
@@ -11,14 +11,11 @@ mail_domain = {mail_domain}
|
|||||||
# Restrictions on user addresses
|
# Restrictions on user addresses
|
||||||
#
|
#
|
||||||
|
|
||||||
# email sending rate per user and minute
|
# how many mails a user can send out per minute
|
||||||
max_user_send_per_minute = 60
|
max_user_send_per_minute = 60
|
||||||
|
|
||||||
# per-user max burst size for sending rate limiting (GCRA bucket capacity)
|
|
||||||
max_user_send_burst_size = 10
|
|
||||||
|
|
||||||
# maximum mailbox size of a chatmail address
|
# maximum mailbox size of a chatmail address
|
||||||
max_mailbox_size = 500M
|
max_mailbox_size = 100M
|
||||||
|
|
||||||
# maximum message size for an e-mail in bytes
|
# maximum message size for an e-mail in bytes
|
||||||
max_message_size = 31457280
|
max_message_size = 31457280
|
||||||
@@ -26,9 +23,6 @@ max_message_size = 31457280
|
|||||||
# days after which mails are unconditionally deleted
|
# days after which mails are unconditionally deleted
|
||||||
delete_mails_after = 20
|
delete_mails_after = 20
|
||||||
|
|
||||||
# days after which large messages (>200k) are unconditionally deleted
|
|
||||||
delete_large_after = 7
|
|
||||||
|
|
||||||
# days after which users without a successful login are deleted (database and mails)
|
# days after which users without a successful login are deleted (database and mails)
|
||||||
delete_inactive_users_after = 90
|
delete_inactive_users_after = 90
|
||||||
|
|
||||||
@@ -45,60 +39,22 @@ password_min_length = 9
|
|||||||
passthrough_senders =
|
passthrough_senders =
|
||||||
|
|
||||||
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
# list of e-mail recipients for which to accept outbound un-encrypted mails
|
||||||
# (space-separated, item may start with "@" to whitelist whole recipient domains)
|
# (space-separated)
|
||||||
passthrough_recipients =
|
passthrough_recipients = xstore@testrun.org
|
||||||
|
|
||||||
# Use externally managed TLS certificates instead of built-in acmetool.
|
|
||||||
# Paths refer to files on the deployment server (not the build machine).
|
|
||||||
# Both files must already exist before running cmdeploy.
|
|
||||||
# Certificate renewal is your responsibility; changed files are
|
|
||||||
# picked up automatically by all relay services.
|
|
||||||
# tls_external_cert_and_key = /path/to/fullchain.pem /path/to/privkey.pem
|
|
||||||
|
|
||||||
# path to www directory - documented here: https://chatmail.at/doc/relay/getting_started.html#custom-web-pages
|
|
||||||
#www_folder = www
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Deployment Details
|
# Deployment Details
|
||||||
#
|
#
|
||||||
|
|
||||||
# SMTP outgoing filtermail and reinjection
|
# where the filtermail SMTP service listens
|
||||||
filtermail_smtp_port = 10080
|
filtermail_smtp_port = 10080
|
||||||
postfix_reinject_port = 10025
|
|
||||||
|
|
||||||
# SMTP incoming filtermail and reinjection
|
# postfix accepts on the localhost reinject SMTP port
|
||||||
filtermail_smtp_port_incoming = 10081
|
postfix_reinject_port = 10025
|
||||||
postfix_reinject_port_incoming = 10026
|
|
||||||
|
|
||||||
# if set to "True" IPv6 is disabled
|
# if set to "True" IPv6 is disabled
|
||||||
disable_ipv6 = False
|
disable_ipv6 = False
|
||||||
|
|
||||||
# Your email adress, which will be used in acmetool to manage Let's Encrypt SSL certificates
|
|
||||||
acme_email =
|
|
||||||
|
|
||||||
# Defaults to https://iroh.{{mail_domain}} and running `iroh-relay` on the chatmail
|
|
||||||
# service.
|
|
||||||
# If you set it to anything else, the service will be disabled
|
|
||||||
# and users will be directed to use the given iroh relay URL.
|
|
||||||
# Set it to empty string if you want users to use their default iroh relay.
|
|
||||||
# iroh_relay =
|
|
||||||
|
|
||||||
# Address on which `mtail` listens,
|
|
||||||
# e.g. 127.0.0.1 or some private network
|
|
||||||
# address like 192.168.10.1.
|
|
||||||
# You can point Prometheus
|
|
||||||
# or some other OpenMetrics-compatible
|
|
||||||
# collector to
|
|
||||||
# http://{{mtail_address}}:3903/metrics
|
|
||||||
# and display collected metrics with Grafana.
|
|
||||||
#
|
|
||||||
# WARNING: do not expose this service
|
|
||||||
# to the public IP address.
|
|
||||||
#
|
|
||||||
# `mtail is not running if the setting is not set.
|
|
||||||
|
|
||||||
# mtail_address = 127.0.0.1
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Debugging options
|
# Debugging options
|
||||||
#
|
#
|
||||||
@@ -109,12 +65,6 @@ acme_email =
|
|||||||
# so use this option with caution on production servers.
|
# so use this option with caution on production servers.
|
||||||
imap_rawlog = false
|
imap_rawlog = false
|
||||||
|
|
||||||
# set to true if you want to enable the IMAP COMPRESS Extension,
|
|
||||||
# which allows IMAP connections to be efficiently compressed.
|
|
||||||
# WARNING: Enabling this makes it impossible to hibernate IMAP
|
|
||||||
# processes which will result in much higher memory/RAM usage.
|
|
||||||
imap_compress = false
|
|
||||||
|
|
||||||
|
|
||||||
#
|
#
|
||||||
# Privacy Policy
|
# Privacy Policy
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
|
|
||||||
[privacy]
|
[privacy]
|
||||||
|
|
||||||
passthrough_recipients = privacy@testrun.org echo@{mail_domain}
|
passthrough_recipients = privacy@testrun.org xstore@testrun.org
|
||||||
|
|
||||||
privacy_postal =
|
privacy_postal =
|
||||||
Merlinux GmbH, Represented by the managing director H. Krekel,
|
Merlinux GmbH, Represented by the managing director H. Krekel,
|
||||||
|
|||||||
@@ -13,6 +13,8 @@ class LastLoginDictProxy(DictProxy):
|
|||||||
keyname = parts[1].split("/")
|
keyname = parts[1].split("/")
|
||||||
value = parts[2] if len(parts) > 2 else ""
|
value = parts[2] if len(parts) > 2 else ""
|
||||||
if keyname[0] == "shared" and keyname[1] == "last-login":
|
if keyname[0] == "shared" and keyname[1] == "last-login":
|
||||||
|
if addr.startswith("echo@"):
|
||||||
|
return True
|
||||||
addr = keyname[2]
|
addr = keyname[2]
|
||||||
timestamp = int(value)
|
timestamp = int(value)
|
||||||
user = self.config.get_user(addr)
|
user = self.config.get_user(addr)
|
||||||
|
|||||||
@@ -1,24 +1,14 @@
|
|||||||
import logging
|
import logging
|
||||||
import sys
|
import sys
|
||||||
import time
|
|
||||||
from contextlib import contextmanager
|
|
||||||
|
|
||||||
from .config import read_config
|
from .config import read_config
|
||||||
from .dictproxy import DictProxy
|
from .dictproxy import DictProxy
|
||||||
from .filedict import FileDict
|
from .filedict import FileDict
|
||||||
from .notifier import Notifier
|
from .notifier import Notifier
|
||||||
from .turnserver import turn_credentials
|
|
||||||
|
|
||||||
|
|
||||||
def _is_valid_token_timestamp(timestamp, now):
|
|
||||||
# Token if invalid after 90 days
|
|
||||||
# or if the timestamp is in the future.
|
|
||||||
return timestamp > now - 3600 * 24 * 90 and timestamp < now + 60
|
|
||||||
|
|
||||||
|
|
||||||
class Metadata:
|
class Metadata:
|
||||||
# each SETMETADATA on this key appends to dictionary
|
# each SETMETADATA on this key appends to a list of unique device tokens
|
||||||
# mapping of unique device tokens
|
|
||||||
# which only ever get removed if the upstream indicates the token is invalid
|
# which only ever get removed if the upstream indicates the token is invalid
|
||||||
DEVICETOKEN_KEY = "devicetoken"
|
DEVICETOKEN_KEY = "devicetoken"
|
||||||
|
|
||||||
@@ -28,60 +18,29 @@ class Metadata:
|
|||||||
def get_metadata_dict(self, addr):
|
def get_metadata_dict(self, addr):
|
||||||
return FileDict(self.vmail_dir / addr / "metadata.json")
|
return FileDict(self.vmail_dir / addr / "metadata.json")
|
||||||
|
|
||||||
@contextmanager
|
|
||||||
def _modify_tokens(self, addr):
|
|
||||||
with self.get_metadata_dict(addr).modify() as data:
|
|
||||||
tokens = data.setdefault(self.DEVICETOKEN_KEY, {})
|
|
||||||
now = int(time.time())
|
|
||||||
if isinstance(tokens, list):
|
|
||||||
data[self.DEVICETOKEN_KEY] = tokens = {t: now for t in tokens}
|
|
||||||
|
|
||||||
expired_tokens = [
|
|
||||||
token
|
|
||||||
for token, timestamp in tokens.items()
|
|
||||||
if not _is_valid_token_timestamp(tokens[token], now)
|
|
||||||
]
|
|
||||||
for expired_token in expired_tokens:
|
|
||||||
del tokens[expired_token]
|
|
||||||
|
|
||||||
yield tokens
|
|
||||||
|
|
||||||
def add_token_to_addr(self, addr, token):
|
def add_token_to_addr(self, addr, token):
|
||||||
with self._modify_tokens(addr) as tokens:
|
with self.get_metadata_dict(addr).modify() as data:
|
||||||
tokens[token] = int(time.time())
|
tokens = data.setdefault(self.DEVICETOKEN_KEY, [])
|
||||||
|
if token not in tokens:
|
||||||
|
tokens.append(token)
|
||||||
|
|
||||||
def remove_token_from_addr(self, addr, token):
|
def remove_token_from_addr(self, addr, token):
|
||||||
with self._modify_tokens(addr) as tokens:
|
with self.get_metadata_dict(addr).modify() as data:
|
||||||
|
tokens = data.get(self.DEVICETOKEN_KEY, [])
|
||||||
if token in tokens:
|
if token in tokens:
|
||||||
del tokens[token]
|
tokens.remove(token)
|
||||||
|
|
||||||
def get_tokens_for_addr(self, addr):
|
def get_tokens_for_addr(self, addr):
|
||||||
mdict = self.get_metadata_dict(addr).read()
|
mdict = self.get_metadata_dict(addr).read()
|
||||||
tokens = mdict.get(self.DEVICETOKEN_KEY, {})
|
return mdict.get(self.DEVICETOKEN_KEY, [])
|
||||||
|
|
||||||
now = int(time.time())
|
|
||||||
if isinstance(tokens, dict):
|
|
||||||
token_list = [
|
|
||||||
token
|
|
||||||
for token, timestamp in tokens.items()
|
|
||||||
if _is_valid_token_timestamp(timestamp, now)
|
|
||||||
]
|
|
||||||
if len(token_list) < len(tokens):
|
|
||||||
# Some tokens have expired, remove them.
|
|
||||||
with self._modify_tokens(addr) as _tokens:
|
|
||||||
pass
|
|
||||||
else:
|
|
||||||
token_list = []
|
|
||||||
return token_list
|
|
||||||
|
|
||||||
|
|
||||||
class MetadataDictProxy(DictProxy):
|
class MetadataDictProxy(DictProxy):
|
||||||
def __init__(self, notifier, metadata, iroh_relay=None, turn_hostname=None):
|
def __init__(self, notifier, metadata, iroh_relay=None):
|
||||||
super().__init__()
|
super().__init__()
|
||||||
self.notifier = notifier
|
self.notifier = notifier
|
||||||
self.metadata = metadata
|
self.metadata = metadata
|
||||||
self.iroh_relay = iroh_relay
|
self.iroh_relay = iroh_relay
|
||||||
self.turn_hostname = turn_hostname
|
|
||||||
|
|
||||||
def handle_lookup(self, parts):
|
def handle_lookup(self, parts):
|
||||||
# Lpriv/43f5f508a7ea0366dff30200c15250e3/devicetoken\tlkj123poi@c2.testrun.org
|
# Lpriv/43f5f508a7ea0366dff30200c15250e3/devicetoken\tlkj123poi@c2.testrun.org
|
||||||
@@ -100,11 +59,6 @@ class MetadataDictProxy(DictProxy):
|
|||||||
):
|
):
|
||||||
# Handle `GETMETADATA "" /shared/vendor/deltachat/irohrelay`
|
# Handle `GETMETADATA "" /shared/vendor/deltachat/irohrelay`
|
||||||
return f"O{self.iroh_relay}\n"
|
return f"O{self.iroh_relay}\n"
|
||||||
elif keyname == "vendor/vendor.dovecot/pvt/server/vendor/deltachat/turn":
|
|
||||||
res = turn_credentials()
|
|
||||||
port = 3478
|
|
||||||
return f"O{self.turn_hostname}:{port}:{res}\n"
|
|
||||||
|
|
||||||
logging.warning(f"lookup ignored: {parts!r}")
|
logging.warning(f"lookup ignored: {parts!r}")
|
||||||
return "N\n"
|
return "N\n"
|
||||||
|
|
||||||
@@ -128,7 +82,6 @@ def main():
|
|||||||
|
|
||||||
config = read_config(config_path)
|
config = read_config(config_path)
|
||||||
iroh_relay = config.iroh_relay
|
iroh_relay = config.iroh_relay
|
||||||
mail_domain = config.mail_domain
|
|
||||||
|
|
||||||
vmail_dir = config.mailboxes_dir
|
vmail_dir = config.mailboxes_dir
|
||||||
if not vmail_dir.exists():
|
if not vmail_dir.exists():
|
||||||
@@ -142,10 +95,7 @@ def main():
|
|||||||
notifier.start_notification_threads(metadata.remove_token_from_addr)
|
notifier.start_notification_threads(metadata.remove_token_from_addr)
|
||||||
|
|
||||||
dictproxy = MetadataDictProxy(
|
dictproxy = MetadataDictProxy(
|
||||||
notifier=notifier,
|
notifier=notifier, metadata=metadata, iroh_relay=iroh_relay
|
||||||
metadata=metadata,
|
|
||||||
iroh_relay=iroh_relay,
|
|
||||||
turn_hostname=mail_domain,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
dictproxy.serve_forever_from_socket(socket)
|
dictproxy.serve_forever_from_socket(socket)
|
||||||
|
|||||||
@@ -11,8 +11,6 @@ def main(vmail_dir=None):
|
|||||||
ci_accounts = 0
|
ci_accounts = 0
|
||||||
|
|
||||||
for path in Path(vmail_dir).iterdir():
|
for path in Path(vmail_dir).iterdir():
|
||||||
if not path.joinpath("cur").is_dir():
|
|
||||||
continue
|
|
||||||
accounts += 1
|
accounts += 1
|
||||||
if path.name[:3] in ("ci-", "ac_"):
|
if path.name[:3] in ("ci-", "ac_"):
|
||||||
ci_accounts += 1
|
ci_accounts += 1
|
||||||
|
|||||||
@@ -32,7 +32,7 @@ def migrate_from_db_to_maildir(config, chunking=10000):
|
|||||||
# don't transfer special/CI accounts
|
# don't transfer special/CI accounts
|
||||||
rows = [row for row in all_rows if row[0][:3] not in ("ci-", "ac_")]
|
rows = [row for row in all_rows if row[0][:3] not in ("ci-", "ac_")]
|
||||||
|
|
||||||
logging.info(f"ignoring {len(all_rows) - len(rows)} CI accounts")
|
logging.info(f"ignoring {len(all_rows)-len(rows)} CI accounts")
|
||||||
logging.info(f"migrating {len(rows)} sqlite database passwords to user dirs")
|
logging.info(f"migrating {len(rows)} sqlite database passwords to user dirs")
|
||||||
|
|
||||||
for i, row in enumerate(rows):
|
for i, row in enumerate(rows):
|
||||||
|
|||||||
@@ -6,7 +6,6 @@ import json
|
|||||||
import random
|
import random
|
||||||
import secrets
|
import secrets
|
||||||
import string
|
import string
|
||||||
from urllib.parse import quote
|
|
||||||
|
|
||||||
from chatmaild.config import Config, read_config
|
from chatmaild.config import Config, read_config
|
||||||
|
|
||||||
@@ -16,7 +15,7 @@ ALPHANUMERIC_PUNCT = string.ascii_letters + string.digits + string.punctuation
|
|||||||
|
|
||||||
|
|
||||||
def create_newemail_dict(config: Config):
|
def create_newemail_dict(config: Config):
|
||||||
user = "".join(random.choices(ALPHANUMERIC, k=config.username_max_length))
|
user = "".join(random.choices(ALPHANUMERIC, k=config.username_min_length))
|
||||||
password = "".join(
|
password = "".join(
|
||||||
secrets.choice(ALPHANUMERIC_PUNCT)
|
secrets.choice(ALPHANUMERIC_PUNCT)
|
||||||
for _ in range(config.password_min_length + 3)
|
for _ in range(config.password_min_length + 3)
|
||||||
@@ -24,26 +23,13 @@ def create_newemail_dict(config: Config):
|
|||||||
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
return dict(email=f"{user}@{config.mail_domain}", password=f"{password}")
|
||||||
|
|
||||||
|
|
||||||
def create_dclogin_url(email, password):
|
|
||||||
"""Build a dclogin: URL with credentials and self-signed cert acceptance.
|
|
||||||
|
|
||||||
Uses ic=3 (AcceptInvalidCertificates) so chatmail clients
|
|
||||||
can connect to servers with self-signed TLS certificates.
|
|
||||||
"""
|
|
||||||
return f"dclogin:{quote(email, safe='@')}?p={quote(password, safe='')}&v=1&ic=3"
|
|
||||||
|
|
||||||
|
|
||||||
def print_new_account():
|
def print_new_account():
|
||||||
config = read_config(CONFIG_PATH)
|
config = read_config(CONFIG_PATH)
|
||||||
creds = create_newemail_dict(config)
|
creds = create_newemail_dict(config)
|
||||||
|
|
||||||
result = dict(email=creds["email"], password=creds["password"])
|
|
||||||
if config.tls_cert_mode == "self":
|
|
||||||
result["dclogin_url"] = create_dclogin_url(creds["email"], creds["password"])
|
|
||||||
|
|
||||||
print("Content-Type: application/json")
|
print("Content-Type: application/json")
|
||||||
print("")
|
print("")
|
||||||
print(json.dumps(result))
|
print(json.dumps(creds))
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
@@ -17,11 +17,11 @@ and which are scheduled for retry using exponential back-off timing.
|
|||||||
If a token notification would be scheduled more than DROP_DEADLINE seconds
|
If a token notification would be scheduled more than DROP_DEADLINE seconds
|
||||||
after its first attempt, it is dropped with a log error.
|
after its first attempt, it is dropped with a log error.
|
||||||
|
|
||||||
Note that tokens are opaque to the notification machinery here
|
Note that tokens are completely opaque to the notification machinery here
|
||||||
and are encrypted foreclosing all ability to distinguish
|
and will in the future be encrypted foreclosing all ability to distinguish
|
||||||
which device token ultimately goes to which phone-provider notification service,
|
which device token ultimately goes to which phone-provider notification service,
|
||||||
or to understand the relation of "device tokens" and chatmail addresses.
|
or to understand the relation of "device tokens" and chatmail addresses.
|
||||||
The meaning and format of tokens is basically a matter of chatmail Core and
|
The meaning and format of tokens is basically a matter of Delta-Chat Core and
|
||||||
the `notification.delta.chat` service.
|
the `notification.delta.chat` service.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
@@ -95,12 +95,7 @@ class Notifier:
|
|||||||
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
||||||
queue_path.unlink()
|
queue_path.unlink()
|
||||||
continue
|
continue
|
||||||
try:
|
queue_item = PersistentQueueItem.read_from_path(queue_path)
|
||||||
queue_item = PersistentQueueItem.read_from_path(queue_path)
|
|
||||||
except ValueError:
|
|
||||||
logging.warning(f"removing spurious queue item: {queue_path!r}")
|
|
||||||
queue_path.unlink()
|
|
||||||
continue
|
|
||||||
self.queue_for_retry(queue_item)
|
self.queue_for_retry(queue_item)
|
||||||
|
|
||||||
def queue_for_retry(self, queue_item, retry_num=0):
|
def queue_for_retry(self, queue_item, retry_num=0):
|
||||||
|
|||||||
@@ -1,56 +0,0 @@
|
|||||||
From: {from_addr}
|
|
||||||
To: {to_addr}
|
|
||||||
Autocrypt-Setup-Message: v1
|
|
||||||
Subject: Autocrypt Setup Message
|
|
||||||
Date: Tue, 22 Jan 2019 12:56:29 +0100
|
|
||||||
Content-type: multipart/mixed; boundary="Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ"
|
|
||||||
|
|
||||||
--Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ
|
|
||||||
Content-Type: text/plain
|
|
||||||
|
|
||||||
This message contains all information to transfer your Autocrypt
|
|
||||||
settings along with your secret key securely from your original
|
|
||||||
device.
|
|
||||||
|
|
||||||
To set up your new device for Autocrypt, please follow the
|
|
||||||
instuctions that should be presented by your new device.
|
|
||||||
|
|
||||||
You can keep this message and use it as a backup for your secret
|
|
||||||
key. If you want to do this, you should write down the Setup Code
|
|
||||||
and store it securely.
|
|
||||||
--Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ
|
|
||||||
Content-Type: application/autocrypt-setup
|
|
||||||
Content-Disposition: attachment; filename="autocrypt-setup-message.html"
|
|
||||||
|
|
||||||
<html><body>
|
|
||||||
<p>
|
|
||||||
This is the Autocrypt setup file used to transfer settings and
|
|
||||||
keys between clients. You can decrypt it using the Setup Code
|
|
||||||
presented on your old device, and then import the contained key
|
|
||||||
into your keyring.
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<pre>
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
|
||||||
Passphrase-Format: numeric9x4
|
|
||||||
Passphrase-Begin: 17
|
|
||||||
|
|
||||||
jA0EBwMCFAxADoCdzeX/0ukBlqI5+pfpKb751qd/7nLNbkpy3gVcaf1QwRPZYt40
|
|
||||||
Ynp08UqRQ2g48ZlnzHLSwlTGOPTuv2Jt8ka+pgZ45xzvJSG2gau03xP4VsC271kR
|
|
||||||
VmCjdb0Y6Rk96mAwfGzrkbaRQ9Z7fIoL866GOv6h9neiVIkp+JYlTV6ISD0ZQJ4Q
|
|
||||||
I6dOQkB/TWZyVjtiJDOQHdfNWliA6NtqaLq19wlu9L5xXjuNpY95KwR8EJXWe0+o
|
|
||||||
Y3d2U/KxOAkXKghP2Qg1GtlPVeGC5T4p03TGI6pzKT+kHX6Rrm9wK6sM9aTquMmF
|
|
||||||
Vok84Jg1DFnwivWC2RILR81rXi7k/+Y6MUbveFgJ9cQduqpxnmD7TjOblYu7M6zp
|
|
||||||
YGAUxh8DRKlIMn2QsA++DBYQ6ACZvwuY8qTDLkqPDo4WqM313dsMJbyGjDdVE7EM
|
|
||||||
PESS+RlABETpZXz8g/ycr6DIUNdlbPcmYlsBfHWDOuR2GFFTwmlv5slWS39dJv38
|
|
||||||
E0eIe1CwdxI801Se7t7dUUS/ZF8wb6GlmxOcqGbF8eko1Z0S64IAm7/h13MRQCxI
|
|
||||||
geQnHfGYVJ2FOimoCMEKwfa9x++RFTDW0u7spDC2uWvK/1viV8OfRppFhLr/kmKb
|
|
||||||
18lWXuAz80DAjUDUsVqEq2MvJBJGoCJUEyjuRsLkHYRM5jYk4v50LyyR0Om73nWF
|
|
||||||
nZBqmqNzdr7Xb9PHHdFhnEc0VvoYbrcM0RVYcEMW3YbmejM891j1d6Iv+/n/qND/
|
|
||||||
NdebGrfWJMmFLf/iEkzTZ3/v5inW9LpWoRc94ioCjJTaEo8Rib6ARRFaJVIsmNXi
|
|
||||||
YicFGO98D+zX+a2t9Yz6IpPajVslnOp6ScpmXgts/2XWD7oE+JgxSAqo/dLVsHgP
|
|
||||||
Ufo=
|
|
||||||
=pulM
|
|
||||||
-----END PGP MESSAGE-----
|
|
||||||
</pre></body></html>
|
|
||||||
--Y6fyGi9SoGeH8WwRaEdC6bbBcYOedDzrQ--
|
|
||||||
@@ -1,44 +1,44 @@
|
|||||||
From: {from_addr}
|
From: {from_addr}
|
||||||
To: {to_addr}
|
|
||||||
Subject: ...
|
To: {to_addr}
|
||||||
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
|
||||||
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
Subject: ...
|
||||||
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
Date: Sun, 15 Oct 2023 16:43:21 +0000
|
||||||
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
Message-ID: <Mr.UVyJWZmkCKM.hGzNc6glBE_@c2.testrun.org>
|
||||||
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
|
||||||
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
In-Reply-To: <Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
|
||||||
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
References: <Mr.3gckbNy5bch.uK3Hd2Ws6-w@c2.testrun.org>
|
||||||
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
|
||||||
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
<Mr.MvmCz-GQbi_.6FGRkhDf05c@c2.testrun.org>
|
||||||
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
|
||||||
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
Chat-Version: 1.0
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
Autocrypt: addr={from_addr}; prefer-encrypt=mutual;
|
||||||
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
|
||||||
|
keydata=xjMEZSwWjhYJKwYBBAHaRw8BAQdAQBEhqeJh0GueHB6kF/DUQqYCxARNBVokg/AzT+7LqH
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
rNFzxiYXJiYXpAYzIudGVzdHJ1bi5vcmc+wosEEBYIADMCGQEFAmUsFo4CGwMECwkIBwYVCAkKCwID
|
||||||
Content-Description: PGP/MIME version identification
|
|
||||||
Content-Type: application/pgp-encrypted
|
FgIBFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX9A4AEAnHWHp49eBCMHK5t66gYPiW
|
||||||
|
|
||||||
Version: 1
|
XQuB1mwUjzGfYWB+0RXUoA/0xcQ3FbUNlGKW7Blp6eMFfViv6Mv2d3kNSXACB6nmcMzjgEZSwWjhIK
|
||||||
|
|
||||||
|
KwYBBAGXVQEFAQEHQBpY5L2M1XHo0uxf8SX1wNLBp/OVvidoWHQF2Jz+kJsUAwEIB8J4BBgWCAAgBQ
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi
|
|
||||||
Content-Description: OpenPGP encrypted message
|
JlLBaOAhsMFiEEFTfUNvVnY3b9F7yHnmme1PfUhX8ACgkQnmme1PfUhX/INgEA37AJaNvruYsJVanP
|
||||||
Content-Disposition: inline; filename="encrypted.asc";
|
|
||||||
Content-Type: application/octet-stream; name="encrypted.asc"
|
IXnYw4CKd55UAwl8Zcy+M2diAbkA/0fHHcGV4r78hpbbL1Os52DPOdqYQRauIeJUeG+G6bQO
|
||||||
|
|
||||||
-----BEGIN PGP MESSAGE-----
|
MIME-Version: 1.0
|
||||||
|
|
||||||
yxJiAAAAAABIZWxsbyB3b3JsZCE=
|
Content-Type: multipart/encrypted; protocol="application/pgp-encrypted";
|
||||||
=1I/B
|
|
||||||
-----END PGP MESSAGE-----
|
boundary="YFrteb74qSXmggbOxZL9dRnhymywAi"
|
||||||
|
|
||||||
|
|
||||||
--YFrteb74qSXmggbOxZL9dRnhymywAi--
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -1,46 +0,0 @@
|
|||||||
Date: Fri, 8 Jul 1994 09:21:47 -0400
|
|
||||||
From: Mail Delivery Subsystem <MAILER-DAEMON@example.org>
|
|
||||||
Subject: Returned mail: User unknown
|
|
||||||
To: <owner-ups-mib@CS.UTK.EDU>
|
|
||||||
Auto-Submitted: auto-replied
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/report; report-type=delivery-status;
|
|
||||||
boundary="JAA13167.773673707/CS.UTK.EDU"
|
|
||||||
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU
|
|
||||||
content-type: text/plain; charset=us-ascii
|
|
||||||
|
|
||||||
----- The following addresses had delivery problems -----
|
|
||||||
<arathib@vnet.ibm.com> (unrecoverable error)
|
|
||||||
<wsnell@sdcc13.ucsd.edu> (unrecoverable error)
|
|
||||||
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU
|
|
||||||
content-type: message/delivery-status
|
|
||||||
|
|
||||||
Reporting-MTA: dns; cs.utk.edu
|
|
||||||
|
|
||||||
Original-Recipient: rfc822;arathib@vnet.ibm.com
|
|
||||||
Final-Recipient: rfc822;arathib@vnet.ibm.com
|
|
||||||
Action: failed
|
|
||||||
Status: 5.0.0 (permanent failure)
|
|
||||||
Diagnostic-Code: smtp;
|
|
||||||
550 'arathib@vnet.IBM.COM' is not a registered gateway user
|
|
||||||
Remote-MTA: dns; vnet.ibm.com
|
|
||||||
|
|
||||||
Original-Recipient: rfc822;johnh@hpnjld.njd.hp.com
|
|
||||||
Final-Recipient: rfc822;johnh@hpnjld.njd.hp.com
|
|
||||||
Action: delayed
|
|
||||||
Status: 4.0.0 (hpnjld.njd.jp.com: host name lookup failure)
|
|
||||||
|
|
||||||
Original-Recipient: rfc822;wsnell@sdcc13.ucsd.edu
|
|
||||||
Final-Recipient: rfc822;wsnell@sdcc13.ucsd.edu
|
|
||||||
Action: failed
|
|
||||||
Status: 5.0.0
|
|
||||||
Diagnostic-Code: smtp; 550 user unknown
|
|
||||||
Remote-MTA: dns; sdcc13.ucsd.edu
|
|
||||||
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU
|
|
||||||
content-type: message/rfc822
|
|
||||||
|
|
||||||
[original message goes here]
|
|
||||||
--JAA13167.773673707/CS.UTK.EDU--
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
Subject: Message from {from_addr}
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:25 +0000
|
|
||||||
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Secure-Join: vc-request
|
|
||||||
Secure-Join-Invitenumber: RANDOM-TOKEN
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/mixed; boundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
|
||||||
Content-Type: text/plain; charset=utf-8
|
|
||||||
|
|
||||||
Buy viagra!
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
Subject: Message from {from_addr}
|
|
||||||
From: <{from_addr}>
|
|
||||||
To: <{to_addr}>
|
|
||||||
Date: Sun, 15 Oct 2023 16:43:25 +0000
|
|
||||||
Message-ID: <Mr.78MWtlV7RAi.goCFzBhCYfy@c2.testrun.org>
|
|
||||||
Chat-Version: 1.0
|
|
||||||
Secure-Join: vc-request
|
|
||||||
Secure-Join-Invitenumber: RANDOM-TOKEN
|
|
||||||
MIME-Version: 1.0
|
|
||||||
Content-Type: multipart/mixed; boundary="Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi"
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi
|
|
||||||
Content-Type: text/plain; charset=utf-8
|
|
||||||
|
|
||||||
Secure-Join: vc-request
|
|
||||||
|
|
||||||
|
|
||||||
--Gl92xgZjOShJ5PGHntqYkoo2OK2Dvi--
|
|
||||||
|
|
||||||
|
|
||||||
@@ -69,11 +69,12 @@ def maildata(request):
|
|||||||
|
|
||||||
assert datadir.exists(), datadir
|
assert datadir.exists(), datadir
|
||||||
|
|
||||||
def maildata(name, from_addr, to_addr, subject="[...]"):
|
def maildata(name, from_addr, to_addr, subject="..."):
|
||||||
# Using `.read_bytes().decode()` instead of `.read_text()` to preserve newlines.
|
# Using `.read_bytes().decode()` instead of `.read_text()` to preserve newlines.
|
||||||
data = datadir.joinpath(name).read_bytes().decode()
|
data = datadir.joinpath(name).read_bytes().decode()
|
||||||
|
|
||||||
text = data.format(from_addr=from_addr, to_addr=to_addr, subject=subject)
|
text = data.format(from_addr=from_addr, to_addr=to_addr, subject=subject)
|
||||||
return BytesParser(policy=policy.SMTP).parsebytes(text.encode())
|
return BytesParser(policy=policy.default).parsebytes(text.encode())
|
||||||
|
|
||||||
return maildata
|
return maildata
|
||||||
|
|
||||||
|
|||||||
@@ -15,14 +15,6 @@ def test_read_config_basic(example_config):
|
|||||||
assert example_config.mail_domain == "chat.example.org"
|
assert example_config.mail_domain == "chat.example.org"
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_basic_using_defaults(tmp_path, maildomain):
|
|
||||||
inipath = tmp_path.joinpath("chatmail.ini")
|
|
||||||
inipath.write_text(f"[params]\nmail_domain = {maildomain}")
|
|
||||||
example_config = read_config(inipath)
|
|
||||||
assert example_config.max_user_send_per_minute == 60
|
|
||||||
assert example_config.filtermail_smtp_port_incoming == 10081
|
|
||||||
|
|
||||||
|
|
||||||
def test_read_config_testrun(make_config):
|
def test_read_config_testrun(make_config):
|
||||||
config = make_config("something.testrun.org")
|
config = make_config("something.testrun.org")
|
||||||
assert config.mail_domain == "something.testrun.org"
|
assert config.mail_domain == "something.testrun.org"
|
||||||
@@ -33,9 +25,8 @@ def test_read_config_testrun(make_config):
|
|||||||
assert config.filtermail_smtp_port == 10080
|
assert config.filtermail_smtp_port == 10080
|
||||||
assert config.postfix_reinject_port == 10025
|
assert config.postfix_reinject_port == 10025
|
||||||
assert config.max_user_send_per_minute == 60
|
assert config.max_user_send_per_minute == 60
|
||||||
assert config.max_mailbox_size == "500M"
|
assert config.max_mailbox_size == "100M"
|
||||||
assert config.delete_mails_after == "20"
|
assert config.delete_mails_after == "20"
|
||||||
assert config.delete_large_after == "7"
|
|
||||||
assert config.username_min_length == 9
|
assert config.username_min_length == 9
|
||||||
assert config.username_max_length == 9
|
assert config.username_max_length == 9
|
||||||
assert config.password_min_length == 9
|
assert config.password_min_length == 9
|
||||||
@@ -73,51 +64,3 @@ def test_config_userstate_paths(make_config, tmp_path):
|
|||||||
def test_config_max_message_size(make_config, tmp_path):
|
def test_config_max_message_size(make_config, tmp_path):
|
||||||
config = make_config("something.testrun.org", dict(max_message_size="10000"))
|
config = make_config("something.testrun.org", dict(max_message_size="10000"))
|
||||||
assert config.max_message_size == 10000
|
assert config.max_message_size == 10000
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_default_acme(make_config):
|
|
||||||
config = make_config("chat.example.org")
|
|
||||||
assert config.tls_cert_mode == "acme"
|
|
||||||
assert config.tls_cert_path == "/var/lib/acme/live/chat.example.org/fullchain"
|
|
||||||
assert config.tls_key_path == "/var/lib/acme/live/chat.example.org/privkey"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_self(make_config):
|
|
||||||
config = make_config("_test.example.org")
|
|
||||||
assert config.tls_cert_mode == "self"
|
|
||||||
assert config.tls_cert_path == "/etc/ssl/certs/mailserver.pem"
|
|
||||||
assert config.tls_key_path == "/etc/ssl/private/mailserver.key"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_external(make_config):
|
|
||||||
config = make_config(
|
|
||||||
"chat.example.org",
|
|
||||||
{
|
|
||||||
"tls_external_cert_and_key": "/custom/fullchain.pem /custom/privkey.pem",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert config.tls_cert_mode == "external"
|
|
||||||
assert config.tls_cert_path == "/custom/fullchain.pem"
|
|
||||||
assert config.tls_key_path == "/custom/privkey.pem"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_external_overrides_underscore(make_config):
|
|
||||||
config = make_config(
|
|
||||||
"_test.example.org",
|
|
||||||
{
|
|
||||||
"tls_external_cert_and_key": "/certs/fullchain.pem /certs/privkey.pem",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
assert config.tls_cert_mode == "external"
|
|
||||||
assert config.tls_cert_path == "/certs/fullchain.pem"
|
|
||||||
assert config.tls_key_path == "/certs/privkey.pem"
|
|
||||||
|
|
||||||
|
|
||||||
def test_config_tls_external_bad_format(make_config):
|
|
||||||
with pytest.raises(ValueError, match="two space-separated"):
|
|
||||||
make_config(
|
|
||||||
"chat.example.org",
|
|
||||||
{
|
|
||||||
"tls_external_cert_and_key": "/only/one/path.pem",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|||||||
@@ -1,7 +1,7 @@
|
|||||||
import time
|
import time
|
||||||
|
|
||||||
|
from chatmaild.delete_inactive_users import delete_inactive_users
|
||||||
from chatmaild.doveauth import AuthDictProxy
|
from chatmaild.doveauth import AuthDictProxy
|
||||||
from chatmaild.expire import main as main_expire
|
|
||||||
|
|
||||||
|
|
||||||
def test_login_timestamps(example_config):
|
def test_login_timestamps(example_config):
|
||||||
@@ -45,12 +45,7 @@ def test_delete_inactive_users(example_config):
|
|||||||
for addr in to_remove:
|
for addr in to_remove:
|
||||||
assert example_config.get_user(addr).maildir.exists()
|
assert example_config.get_user(addr).maildir.exists()
|
||||||
|
|
||||||
main_expire(
|
delete_inactive_users(example_config)
|
||||||
args=[
|
|
||||||
"--remove",
|
|
||||||
str(example_config._inipath),
|
|
||||||
]
|
|
||||||
)
|
|
||||||
|
|
||||||
for p in example_config.mailboxes_dir.iterdir():
|
for p in example_config.mailboxes_dir.iterdir():
|
||||||
assert not p.name.startswith("old")
|
assert not p.name.startswith("old")
|
||||||
|
|||||||
@@ -1,161 +0,0 @@
|
|||||||
import os
|
|
||||||
import random
|
|
||||||
from datetime import datetime
|
|
||||||
from fnmatch import fnmatch
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
from chatmaild.expire import (
|
|
||||||
FileEntry,
|
|
||||||
MailboxStat,
|
|
||||||
get_file_entry,
|
|
||||||
iter_mailboxes,
|
|
||||||
os_listdir_if_exists,
|
|
||||||
)
|
|
||||||
from chatmaild.expire import main as expiry_main
|
|
||||||
from chatmaild.fsreport import main as report_main
|
|
||||||
|
|
||||||
|
|
||||||
def fill_mbox(folderdir):
|
|
||||||
password = folderdir.joinpath("password")
|
|
||||||
password.write_text("xxx")
|
|
||||||
folderdir.joinpath("maildirsize").write_text("xxx")
|
|
||||||
|
|
||||||
garbagedir = folderdir.joinpath("garbagedir")
|
|
||||||
garbagedir.mkdir()
|
|
||||||
garbagedir.joinpath("bimbum").write_text("hello")
|
|
||||||
|
|
||||||
create_new_messages(folderdir, ["cur/msg1"], size=500)
|
|
||||||
create_new_messages(folderdir, ["new/msg2"], size=600)
|
|
||||||
|
|
||||||
|
|
||||||
def create_new_messages(basedir, relpaths, size=1000, days=0):
|
|
||||||
now = datetime.utcnow().timestamp()
|
|
||||||
|
|
||||||
for relpath in relpaths:
|
|
||||||
msg_path = Path(basedir).joinpath(relpath)
|
|
||||||
msg_path.parent.mkdir(parents=True, exist_ok=True)
|
|
||||||
msg_path.write_text("x" * size)
|
|
||||||
# accessed now, modified N days ago
|
|
||||||
os.utime(msg_path, (now, now - days * 86400))
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def mbox1(example_config):
|
|
||||||
mboxdir = example_config.mailboxes_dir.joinpath("mailbox1@example.org")
|
|
||||||
mboxdir.mkdir()
|
|
||||||
fill_mbox(mboxdir)
|
|
||||||
return MailboxStat(mboxdir)
|
|
||||||
|
|
||||||
|
|
||||||
def test_deltachat_folder(example_config):
|
|
||||||
"""Test old setups that might have a .DeltaChat folder where messages also need to get removed."""
|
|
||||||
mboxdir = example_config.mailboxes_dir.joinpath("mailbox1@example.org")
|
|
||||||
mboxdir.mkdir()
|
|
||||||
mbox2dir = mboxdir.joinpath(".DeltaChat")
|
|
||||||
mbox2dir.mkdir()
|
|
||||||
fill_mbox(mbox2dir)
|
|
||||||
mb = MailboxStat(mboxdir)
|
|
||||||
assert len(mb.messages) == 2
|
|
||||||
|
|
||||||
|
|
||||||
def test_filentry_ordering(tmp_path):
|
|
||||||
l = [FileEntry(f"x{i}", size=i + 10, mtime=1000 - i) for i in range(10)]
|
|
||||||
sorted = list(l)
|
|
||||||
random.shuffle(l)
|
|
||||||
l.sort(key=lambda x: x.size)
|
|
||||||
assert l == sorted
|
|
||||||
|
|
||||||
|
|
||||||
def test_no_mailbxoes(tmp_path, capsys):
|
|
||||||
assert [] == list(iter_mailboxes(str(tmp_path.joinpath("notexists")), maxnum=10))
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
assert "no mailboxes" in err
|
|
||||||
|
|
||||||
|
|
||||||
def test_stats_mailbox(mbox1):
|
|
||||||
password = Path(mbox1.basedir).joinpath("password")
|
|
||||||
assert mbox1.last_login == password.stat().st_mtime
|
|
||||||
assert len(mbox1.messages) == 2
|
|
||||||
|
|
||||||
msgs = list(sorted(mbox1.messages, key=lambda x: x.size))
|
|
||||||
assert len(msgs) == 2
|
|
||||||
assert msgs[0].size == 500 # cur
|
|
||||||
assert msgs[1].size == 600 # new
|
|
||||||
|
|
||||||
create_new_messages(mbox1.basedir, ["large-extra"], size=1000)
|
|
||||||
create_new_messages(mbox1.basedir, ["index-something"], size=3)
|
|
||||||
mbox2 = MailboxStat(mbox1.basedir)
|
|
||||||
assert len(mbox2.extrafiles) == 5
|
|
||||||
assert mbox2.extrafiles[0].size == 1000
|
|
||||||
|
|
||||||
# cope well with mailbox dirs that have no password (for whatever reason)
|
|
||||||
Path(mbox1.basedir).joinpath("password").unlink()
|
|
||||||
mbox3 = MailboxStat(mbox1.basedir)
|
|
||||||
assert mbox3.last_login is None
|
|
||||||
|
|
||||||
|
|
||||||
def test_report_no_mailboxes(example_config):
|
|
||||||
args = (str(example_config._inipath),)
|
|
||||||
report_main(args)
|
|
||||||
|
|
||||||
|
|
||||||
def test_report(mbox1, example_config):
|
|
||||||
args = (str(example_config._inipath),)
|
|
||||||
report_main(args)
|
|
||||||
args = list(args) + "--days 1".split()
|
|
||||||
report_main(args)
|
|
||||||
args = list(args) + "--min-login-age 1".split()
|
|
||||||
report_main(args)
|
|
||||||
args = list(args) + "--mdir cur".split()
|
|
||||||
report_main(args)
|
|
||||||
|
|
||||||
|
|
||||||
def test_expiry_cli_basic(example_config, mbox1):
|
|
||||||
args = (str(example_config._inipath),)
|
|
||||||
expiry_main(args)
|
|
||||||
|
|
||||||
|
|
||||||
def test_expiry_cli_old_files(capsys, example_config, mbox1):
|
|
||||||
relpaths_old = ["cur/msg_old1", "cur/msg_old1"]
|
|
||||||
cutoff_days = int(example_config.delete_mails_after) + 1
|
|
||||||
create_new_messages(mbox1.basedir, relpaths_old, size=1000, days=cutoff_days)
|
|
||||||
|
|
||||||
relpaths_large = ["cur/msg_old_large1", "new/msg_old_large2"]
|
|
||||||
cutoff_days = int(example_config.delete_large_after) + 1
|
|
||||||
create_new_messages(
|
|
||||||
mbox1.basedir, relpaths_large, size=1000 * 300, days=cutoff_days
|
|
||||||
)
|
|
||||||
|
|
||||||
create_new_messages(mbox1.basedir, ["cur/shouldstay"], size=1000 * 300, days=1)
|
|
||||||
|
|
||||||
args = str(example_config._inipath), "--remove", "-v"
|
|
||||||
expiry_main(args)
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
|
|
||||||
allpaths = relpaths_old + relpaths_large + ["maildirsize"]
|
|
||||||
for path in allpaths:
|
|
||||||
for line in err.split("\n"):
|
|
||||||
if fnmatch(line, f"removing*{path}"):
|
|
||||||
break
|
|
||||||
else:
|
|
||||||
if path != "new/msg_old_large2":
|
|
||||||
pytest.fail(f"failed to remove {path}\n{err}")
|
|
||||||
|
|
||||||
assert "shouldstay" not in err
|
|
||||||
|
|
||||||
|
|
||||||
def test_get_file_entry(tmp_path):
|
|
||||||
assert get_file_entry(str(tmp_path.joinpath("123123"))) is None
|
|
||||||
p = tmp_path.joinpath("x")
|
|
||||||
p.write_text("hello")
|
|
||||||
entry = get_file_entry(str(p))
|
|
||||||
assert entry.size == 5
|
|
||||||
assert entry.mtime
|
|
||||||
|
|
||||||
|
|
||||||
def test_os_listdir_if_exists(tmp_path):
|
|
||||||
tmp_path.joinpath("x").write_text("hello")
|
|
||||||
assert len(os_listdir_if_exists(str(tmp_path))) == 1
|
|
||||||
assert len(os_listdir_if_exists(str(tmp_path.joinpath("123123")))) == 0
|
|
||||||
193
chatmaild/src/chatmaild/tests/test_filtermail.py
Normal file
193
chatmaild/src/chatmaild/tests/test_filtermail.py
Normal file
@@ -0,0 +1,193 @@
|
|||||||
|
import pytest
|
||||||
|
|
||||||
|
from chatmaild.filtermail import (
|
||||||
|
BeforeQueueHandler,
|
||||||
|
SendRateLimiter,
|
||||||
|
check_armored_payload,
|
||||||
|
check_encrypted,
|
||||||
|
common_encrypted_subjects,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def maildomain():
|
||||||
|
# let's not depend on a real chatmail instance for the offline tests below
|
||||||
|
return "chatmail.example.org"
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.fixture
|
||||||
|
def handler(make_config, maildomain):
|
||||||
|
config = make_config(maildomain)
|
||||||
|
return BeforeQueueHandler(config)
|
||||||
|
|
||||||
|
|
||||||
|
def test_reject_forged_from(maildata, gencreds, handler):
|
||||||
|
class env:
|
||||||
|
mail_from = gencreds()[0]
|
||||||
|
rcpt_tos = [gencreds()[0]]
|
||||||
|
|
||||||
|
# test that the filter lets good mail through
|
||||||
|
to_addr = gencreds()[0]
|
||||||
|
env.content = maildata(
|
||||||
|
"plain.eml", from_addr=env.mail_from, to_addr=to_addr
|
||||||
|
).as_bytes()
|
||||||
|
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
|
# test that the filter rejects forged mail
|
||||||
|
env.content = maildata(
|
||||||
|
"plain.eml", from_addr="forged@c3.testrun.org", to_addr=to_addr
|
||||||
|
).as_bytes()
|
||||||
|
error = handler.check_DATA(envelope=env)
|
||||||
|
assert "500" in error
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_no_encryption_detection(maildata):
|
||||||
|
msg = maildata(
|
||||||
|
"plain.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
|
)
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
# https://xkcd.com/1181/
|
||||||
|
msg = maildata(
|
||||||
|
"fake-encrypted.eml", from_addr="some@example.org", to_addr="other@example.org"
|
||||||
|
)
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_encryption_detection(maildata):
|
||||||
|
for subject in common_encrypted_subjects:
|
||||||
|
msg = maildata(
|
||||||
|
"encrypted.eml",
|
||||||
|
from_addr="1@example.org",
|
||||||
|
to_addr="2@example.org",
|
||||||
|
subject=subject,
|
||||||
|
)
|
||||||
|
assert check_encrypted(msg)
|
||||||
|
|
||||||
|
# if the subject is not a known encrypted subject value, it is not considered ac-encrypted
|
||||||
|
msg.replace_header("Subject", "Click this link")
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_no_literal_packets(maildata):
|
||||||
|
"""Test that literal OpenPGP packet is not considered an encrypted mail."""
|
||||||
|
msg = maildata("literal.eml", from_addr="1@example.org", to_addr="2@example.org")
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filtermail_unencrypted_mdn(maildata, gencreds):
|
||||||
|
"""Unencrypted MDNs should not pass."""
|
||||||
|
from_addr = gencreds()[0]
|
||||||
|
to_addr = gencreds()[0] + ".other"
|
||||||
|
msg = maildata("mdn.eml", from_addr=from_addr, to_addr=to_addr)
|
||||||
|
|
||||||
|
assert not check_encrypted(msg)
|
||||||
|
|
||||||
|
|
||||||
|
def test_send_rate_limiter():
|
||||||
|
limiter = SendRateLimiter()
|
||||||
|
for i in range(100):
|
||||||
|
if limiter.is_sending_allowed("some@example.org", 10):
|
||||||
|
if i <= 10:
|
||||||
|
continue
|
||||||
|
pytest.fail("limiter didn't work")
|
||||||
|
else:
|
||||||
|
assert i == 11
|
||||||
|
break
|
||||||
|
|
||||||
|
|
||||||
|
def test_excempt_privacy(maildata, gencreds, handler):
|
||||||
|
from_addr = gencreds()[0]
|
||||||
|
to_addr = "privacy@testrun.org"
|
||||||
|
handler.config.passthrough_recipients = [to_addr]
|
||||||
|
false_to = "privacy@something.org"
|
||||||
|
|
||||||
|
msg = maildata("plain.eml", from_addr=from_addr, to_addr=to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
# assert that None/no error is returned
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
|
class env2:
|
||||||
|
mail_from = from_addr
|
||||||
|
rcpt_tos = [to_addr, false_to]
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
assert "500" in handler.check_DATA(envelope=env2)
|
||||||
|
|
||||||
|
|
||||||
|
def test_passthrough_senders(gencreds, handler, maildata):
|
||||||
|
acc1 = gencreds()[0]
|
||||||
|
to_addr = "recipient@something.org"
|
||||||
|
handler.config.passthrough_senders = [acc1]
|
||||||
|
|
||||||
|
msg = maildata("plain.eml", from_addr=acc1, to_addr=to_addr)
|
||||||
|
|
||||||
|
class env:
|
||||||
|
mail_from = acc1
|
||||||
|
rcpt_tos = to_addr
|
||||||
|
content = msg.as_bytes()
|
||||||
|
|
||||||
|
# assert that None/no error is returned
|
||||||
|
assert not handler.check_DATA(envelope=env)
|
||||||
|
|
||||||
|
|
||||||
|
def test_check_armored_payload():
|
||||||
|
payload = """-----BEGIN PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
wU4DSqFx0d1yqAoSAQdAYkX/ZN/Az4B0k7X47zKyWrXxlDEdS3WOy0Yf2+GJTFgg\r
|
||||||
|
Zk5ql0mLG8Ze+ZifCS0XMO4otlemSyJ0K1ZPdFMGzUDBTgNqzkFabxXoXRIBB0AM\r
|
||||||
|
755wlX41X6Ay3KhnwBq7yEqSykVH6F3x11iHPKraLCAGZoaS8bKKNy/zg5slda1X\r
|
||||||
|
pt14b4aC1VwtSnYhcRRELNLD/wE2TFif+g7poMmFY50VyMPLYjVP96Z5QCT4+z4H\r
|
||||||
|
Ikh/pRRN8S3JNMrRJHc6prooSJmLcx47Y5un7VFy390MsJ+LiUJuQMDdYWRAinfs\r
|
||||||
|
Ebm89Ezjm7F03qbFPXE0X4ZNzVXS/eKO0uhJQdiov/vmbn41rNtHmNpqjaO0vi5+\r
|
||||||
|
sS9tR7yDUrIXiCUCN78eBLVioxtktsPZm5cDORbQWzv+7nmCEz9/JowCUcBVdCGn\r
|
||||||
|
1ofOaH82JCAX/cRx08pLaDNj6iolVBsi56Dd+2bGxJOZOG2AMcEyz0pXY0dOAJCD\r
|
||||||
|
iUThcQeGIdRnU3j8UBcnIEsjLu2+C+rrwMZQESMWKnJ0rnqTk0pK5kXScr6F/L0L\r
|
||||||
|
UE49ccIexNm3xZvYr5drszr6wz3Tv5fdue87P4etBt90gF/Vzknck+g1LLlkzZkp\r
|
||||||
|
d8dI0k2tOSPjUbDPnSy1x+X73WGpPZmj0kWT+RGvq0nH6UkJj3AQTG2qf1T8jK+3\r
|
||||||
|
rTp3LR9vDkMwDjX4R8SA9c0wdnUzzr79OYQC9lTnzcx+fM6BBmgQ2GrS33jaFLp7\r
|
||||||
|
L6/DFpCl5zhnPjM/2dKvMkw/Kd6XS/vjwsO405FQdjSDiQEEAZA+ZvAfcjdccbbU\r
|
||||||
|
yCO+x0QNdeBsufDVnh3xvzuWy4CICdTQT4s1AWRPCzjOj+SGmx5WqCLWfsd8Ma0+\r
|
||||||
|
w/C7SfTYu1FDQILLM+llpq1M/9GPley4QZ8JQjo262AyPXsPF/OW48uuZz0Db1xT\r
|
||||||
|
Yh4iHBztj4VSdy7l2+IyaIf7cnL4EEBFxv/MwmVDXvDlxyvfAfIsd3D9SvJESzKZ\r
|
||||||
|
VWDYwaocgeCN+ojKu1p885lu1EfRbX3fr3YO02K5/c2JYDkc0Py0W3wUP/J1XUax\r
|
||||||
|
pbKpzwlkxEgtmzsGqsOfMJqBV3TNDrOA2uBsa+uBqP5MGYLZ49S/4v/bW9I01Cr1\r
|
||||||
|
D2ZkV510Y1Vgo66WlP8mRqOTyt/5WRhPD+MxXdk67BNN/PmO6tMlVoJDuk+XwWPR\r
|
||||||
|
t2TvNaND/yabT9eYI55Og4fzKD6RIjouUX8DvKLkm+7aXxVs2uuLQ3Jco3O82z55\r
|
||||||
|
dbShU1jYsrw9oouXUz06MHPbkdhNbF/2hfhZ2qA31sNeovJw65iUv7sDKX3LVWgJ\r
|
||||||
|
10jlywcDwqlU8CO7WC9lGixYTbnOkYZpXCGEl8e6Jbs79l42YFo4ogYpFK1NXFhV\r
|
||||||
|
kOXRmDf/wmfj+c/ld3L2PkvwlgofhCudOQknZbo3ub1gjiTn7L+lMGHIj/3suMIl\r
|
||||||
|
ID4EUxAXScIM1ZEz2fjtW5jATlqYcLjLTbf/olw6HFyPNH+9IssqXeZNKnGwPUB9\r
|
||||||
|
3lTXsg0tpzl+x7F/2WjEw1DSNhjC0KnHt1vEYNMkUGDGFdN9y3ERLqX/FIgiASUb\r
|
||||||
|
bTvAVupnAK3raBezGmhrs6LsQtLS9P0VvQiLU3uDhMqw8Z4SISLpcD+NnVBHzQqm\r
|
||||||
|
6W5Qn/8xsCL6av18yUVTi2G3igt3QCNoYx9evt2ZcIkNoyyagUVjfZe5GHXh8Dnz\r
|
||||||
|
GaBXW/hg3HlXLRGaQu4RYCzBMJILcO25OhZOg6jbkCLiEexQlm2e9krB5cXR49Al\r
|
||||||
|
UN4fiB0KR9JyG2ayUdNJVkXZSZLnHyRgiaadlpUo16LVvw==\r
|
||||||
|
=b5Kp\r
|
||||||
|
-----END PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
"""
|
||||||
|
|
||||||
|
assert check_armored_payload(payload) == True
|
||||||
|
|
||||||
|
payload = """-----BEGIN PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
HELLOWORLD
|
||||||
|
-----END PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
"""
|
||||||
|
assert check_armored_payload(payload) == False
|
||||||
|
|
||||||
|
payload = """-----BEGIN PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
=njUN
|
||||||
|
-----END PGP MESSAGE-----\r
|
||||||
|
\r
|
||||||
|
"""
|
||||||
|
assert check_armored_payload(payload) == False
|
||||||
@@ -1,90 +0,0 @@
|
|||||||
import shutil
|
|
||||||
import smtplib
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
|
|
||||||
import pytest
|
|
||||||
|
|
||||||
pytestmark = pytest.mark.skipif(
|
|
||||||
shutil.which("filtermail") is None,
|
|
||||||
reason="filtermail binary not found",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def smtpserver():
|
|
||||||
from pytest_localserver import smtp
|
|
||||||
|
|
||||||
server = smtp.Server("127.0.0.1")
|
|
||||||
server.start()
|
|
||||||
yield server
|
|
||||||
server.stop()
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
|
||||||
def make_popen(request):
|
|
||||||
def popen(cmdargs, stdout=subprocess.PIPE, stderr=subprocess.PIPE, **kw):
|
|
||||||
p = subprocess.Popen(
|
|
||||||
cmdargs,
|
|
||||||
stdout=subprocess.PIPE,
|
|
||||||
stderr=subprocess.PIPE,
|
|
||||||
)
|
|
||||||
|
|
||||||
def fin():
|
|
||||||
p.terminate()
|
|
||||||
out, err = p.communicate()
|
|
||||||
print(out.decode("ascii"))
|
|
||||||
print(err.decode("ascii"), file=sys.stderr)
|
|
||||||
|
|
||||||
request.addfinalizer(fin)
|
|
||||||
return p
|
|
||||||
|
|
||||||
return popen
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize("filtermail_mode", ["outgoing", "incoming"])
|
|
||||||
def test_one_mail(
|
|
||||||
make_config, make_popen, smtpserver, maildata, filtermail_mode, monkeypatch
|
|
||||||
):
|
|
||||||
monkeypatch.setenv("PYTHONUNBUFFERED", "1")
|
|
||||||
# DKIM is tested by cmdeploy tests.
|
|
||||||
monkeypatch.setenv("FILTERMAIL_SKIP_DKIM", "1")
|
|
||||||
smtp_inject_port = 20025
|
|
||||||
if filtermail_mode == "outgoing":
|
|
||||||
settings = dict(
|
|
||||||
postfix_reinject_port=smtpserver.port,
|
|
||||||
filtermail_smtp_port=smtp_inject_port,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
settings = dict(
|
|
||||||
postfix_reinject_port_incoming=smtpserver.port,
|
|
||||||
filtermail_smtp_port_incoming=smtp_inject_port,
|
|
||||||
)
|
|
||||||
|
|
||||||
config = make_config("example.org", settings=settings)
|
|
||||||
path = str(config._inipath)
|
|
||||||
|
|
||||||
popen = make_popen(["filtermail", path, filtermail_mode])
|
|
||||||
line = popen.stderr.readline().strip()
|
|
||||||
|
|
||||||
# skip a warning that FILTERMAIL_SKIP_DKIM shouldn't be used in prod
|
|
||||||
if b"DKIM verification DISABLED!" in line:
|
|
||||||
line = popen.stderr.readline().strip()
|
|
||||||
if b"loop" not in line:
|
|
||||||
print(line.decode("ascii"), file=sys.stderr)
|
|
||||||
pytest.fail("starting filtermail failed")
|
|
||||||
|
|
||||||
addr = f"user1@{config.mail_domain}"
|
|
||||||
config.get_user(addr).set_password("l1k2j3l1k2j3l")
|
|
||||||
|
|
||||||
# send encrypted mail
|
|
||||||
data = str(maildata("encrypted.eml", from_addr=addr, to_addr=addr))
|
|
||||||
client = smtplib.SMTP("localhost", smtp_inject_port)
|
|
||||||
client.sendmail(addr, [addr], data)
|
|
||||||
assert len(smtpserver.outbox) == 1
|
|
||||||
|
|
||||||
# send un-encrypted mail that errors
|
|
||||||
data = str(maildata("fake-encrypted.eml", from_addr=addr, to_addr=addr))
|
|
||||||
with pytest.raises(smtplib.SMTPDataError) as e:
|
|
||||||
client.sendmail(addr, [addr], data)
|
|
||||||
assert e.value.smtp_code == 523
|
|
||||||
@@ -36,3 +36,29 @@ def test_handle_dovecot_request_last_login(testaddr, example_config):
|
|||||||
res = dictproxy.handle_dovecot_request(msg, dictproxy_transactions)
|
res = dictproxy.handle_dovecot_request(msg, dictproxy_transactions)
|
||||||
assert res == "O\n"
|
assert res == "O\n"
|
||||||
assert len(dictproxy_transactions) == 0
|
assert len(dictproxy_transactions) == 0
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_dovecot_request_last_login_echobot(example_config):
|
||||||
|
dictproxy = LastLoginDictProxy(config=example_config)
|
||||||
|
|
||||||
|
authproxy = AuthDictProxy(config=example_config)
|
||||||
|
testaddr = f"echo@{example_config.mail_domain}"
|
||||||
|
authproxy.lookup_passdb(testaddr, "ignore")
|
||||||
|
user = dictproxy.config.get_user(testaddr)
|
||||||
|
|
||||||
|
transactions = {}
|
||||||
|
|
||||||
|
# set last-login info for user
|
||||||
|
tx = "1111"
|
||||||
|
msg = f"B{tx}\t{testaddr}"
|
||||||
|
res = dictproxy.handle_dovecot_request(msg, transactions)
|
||||||
|
assert not res
|
||||||
|
assert transactions == {tx: dict(addr=testaddr, res="O\n")}
|
||||||
|
|
||||||
|
timestamp = int(time.time())
|
||||||
|
msg = f"S{tx}\tshared/last-login/{testaddr}\t{timestamp}"
|
||||||
|
res = dictproxy.handle_dovecot_request(msg, transactions)
|
||||||
|
assert not res
|
||||||
|
assert len(transactions) == 1
|
||||||
|
read_timestamp = user.get_last_login_timestamp()
|
||||||
|
assert read_timestamp is None
|
||||||
|
|||||||
@@ -242,22 +242,6 @@ def test_requeue_removes_tmp_files(notifier, metadata, testaddr, caplog):
|
|||||||
assert queue_item.addr == testaddr
|
assert queue_item.addr == testaddr
|
||||||
|
|
||||||
|
|
||||||
def test_requeue_removes_invalid_files(notifier, metadata, testaddr, caplog):
|
|
||||||
metadata.add_token_to_addr(testaddr, "01234")
|
|
||||||
notifier.new_message_for_addr(testaddr, metadata)
|
|
||||||
# empty/invalid files should be ignored
|
|
||||||
p = notifier.queue_dir.joinpath("1203981203")
|
|
||||||
p.touch()
|
|
||||||
notifier2 = notifier.__class__(notifier.queue_dir)
|
|
||||||
notifier2.requeue_persistent_queue_items()
|
|
||||||
assert "spurious" in caplog.records[0].msg
|
|
||||||
assert not p.exists()
|
|
||||||
assert notifier2.retry_queues[0].qsize() == 1
|
|
||||||
when, queue_item = notifier2.retry_queues[0].get()
|
|
||||||
assert when <= int(time.time())
|
|
||||||
assert queue_item.addr == testaddr
|
|
||||||
|
|
||||||
|
|
||||||
def test_start_and_stop_notification_threads(notifier, testaddr):
|
def test_start_and_stop_notification_threads(notifier, testaddr):
|
||||||
threads = notifier.start_notification_threads(None)
|
threads = notifier.start_notification_threads(None)
|
||||||
for retry_num, threadlist in threads.items():
|
for retry_num, threadlist in threads.items():
|
||||||
|
|||||||
@@ -2,15 +2,8 @@ from chatmaild.metrics import main
|
|||||||
|
|
||||||
|
|
||||||
def test_main(tmp_path, capsys):
|
def test_main(tmp_path, capsys):
|
||||||
paths = []
|
|
||||||
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
for x in ("ci-asllkj", "ac_12l3kj", "qweqwe", "ci-l1k2j31l2k3"):
|
||||||
p = tmp_path.joinpath(x)
|
tmp_path.joinpath(x).mkdir()
|
||||||
p.mkdir()
|
|
||||||
p.joinpath("cur").mkdir()
|
|
||||||
paths.append(p)
|
|
||||||
|
|
||||||
tmp_path.joinpath("nomailbox").mkdir()
|
|
||||||
|
|
||||||
main(tmp_path)
|
main(tmp_path)
|
||||||
out, _ = capsys.readouterr()
|
out, _ = capsys.readouterr()
|
||||||
d = {}
|
d = {}
|
||||||
|
|||||||
@@ -1,11 +1,7 @@
|
|||||||
import json
|
import json
|
||||||
|
|
||||||
import chatmaild
|
import chatmaild
|
||||||
from chatmaild.newemail import (
|
from chatmaild.newemail import create_newemail_dict, print_new_account
|
||||||
create_dclogin_url,
|
|
||||||
create_newemail_dict,
|
|
||||||
print_new_account,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_create_newemail_dict(example_config):
|
def test_create_newemail_dict(example_config):
|
||||||
@@ -19,18 +15,6 @@ def test_create_newemail_dict(example_config):
|
|||||||
assert ac1["password"] != ac2["password"]
|
assert ac1["password"] != ac2["password"]
|
||||||
|
|
||||||
|
|
||||||
def test_create_dclogin_url():
|
|
||||||
url = create_dclogin_url("user@example.org", "p@ss w+rd")
|
|
||||||
assert url.startswith("dclogin:")
|
|
||||||
assert "v=1" in url
|
|
||||||
assert "ic=3" in url
|
|
||||||
|
|
||||||
assert "user@example.org" in url
|
|
||||||
# password special chars must be encoded
|
|
||||||
assert "p%40ss" in url
|
|
||||||
assert "w%2Brd" in url
|
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_config):
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(example_config._inipath))
|
||||||
print_new_account()
|
print_new_account()
|
||||||
@@ -41,20 +25,3 @@ def test_print_new_account(capsys, monkeypatch, maildomain, tmpdir, example_conf
|
|||||||
dic = json.loads(lines[2])
|
dic = json.loads(lines[2])
|
||||||
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
assert dic["email"].endswith(f"@{example_config.mail_domain}")
|
||||||
assert len(dic["password"]) >= 10
|
assert len(dic["password"]) >= 10
|
||||||
# default tls_cert=acme should not include dclogin_url
|
|
||||||
assert "dclogin_url" not in dic
|
|
||||||
|
|
||||||
|
|
||||||
def test_print_new_account_self_signed(capsys, monkeypatch, make_config):
|
|
||||||
config = make_config("_test.example.org")
|
|
||||||
monkeypatch.setattr(chatmaild.newemail, "CONFIG_PATH", str(config._inipath))
|
|
||||||
print_new_account()
|
|
||||||
out, err = capsys.readouterr()
|
|
||||||
lines = out.split("\n")
|
|
||||||
dic = json.loads(lines[2])
|
|
||||||
assert "dclogin_url" in dic
|
|
||||||
url = dic["dclogin_url"]
|
|
||||||
assert url.startswith("dclogin:")
|
|
||||||
assert "ic=3" in url
|
|
||||||
|
|
||||||
assert dic["email"].split("@")[0] in url
|
|
||||||
|
|||||||
@@ -40,17 +40,3 @@ def test_no_mailboxes_dir(testaddr, example_config, tmp_path):
|
|||||||
user.set_password("someeqkjwelkqwjleqwe")
|
user.set_password("someeqkjwelkqwjleqwe")
|
||||||
user.set_last_login_timestamp(100000)
|
user.set_last_login_timestamp(100000)
|
||||||
assert user.get_last_login_timestamp() == 86400
|
assert user.get_last_login_timestamp() == 86400
|
||||||
|
|
||||||
|
|
||||||
def test_set_get_cleartext_flag(testaddr, example_config, tmp_path):
|
|
||||||
p = tmp_path.joinpath("a", "mailboxes")
|
|
||||||
example_config.mailboxes_dir = p
|
|
||||||
|
|
||||||
user = example_config.get_user(testaddr)
|
|
||||||
user.set_password("someeqkjwelkqwjleqwe")
|
|
||||||
user.set_last_login_timestamp(100000)
|
|
||||||
assert user.get_last_login_timestamp() == 86400
|
|
||||||
|
|
||||||
assert not user.is_incoming_cleartext_ok()
|
|
||||||
user.allow_incoming_cleartext()
|
|
||||||
assert user.is_incoming_cleartext_ok()
|
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
#!/usr/bin/env python3
|
|
||||||
import socket
|
|
||||||
|
|
||||||
|
|
||||||
def turn_credentials() -> str:
|
|
||||||
with socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) as client_socket:
|
|
||||||
client_socket.connect("/run/chatmail-turn/turn.socket")
|
|
||||||
with client_socket.makefile("rb") as file:
|
|
||||||
return file.readline().decode("utf-8").strip()
|
|
||||||
@@ -13,13 +13,12 @@ class User:
|
|||||||
self.maildir = maildir
|
self.maildir = maildir
|
||||||
self.addr = addr
|
self.addr = addr
|
||||||
self.password_path = password_path
|
self.password_path = password_path
|
||||||
self.enforce_E2EE_path = maildir.joinpath("enforceE2EEincoming")
|
|
||||||
self.uid = uid
|
self.uid = uid
|
||||||
self.gid = gid
|
self.gid = gid
|
||||||
|
|
||||||
@property
|
@property
|
||||||
def can_track(self):
|
def can_track(self):
|
||||||
return "@" in self.addr
|
return "@" in self.addr and not self.addr.startswith("echo@")
|
||||||
|
|
||||||
def get_userdb_dict(self):
|
def get_userdb_dict(self):
|
||||||
"""Return a non-empty dovecot 'userdb' style dict
|
"""Return a non-empty dovecot 'userdb' style dict
|
||||||
@@ -36,13 +35,6 @@ class User:
|
|||||||
home = str(self.maildir)
|
home = str(self.maildir)
|
||||||
return dict(addr=self.addr, home=home, uid=self.uid, gid=self.gid, password=pw)
|
return dict(addr=self.addr, home=home, uid=self.uid, gid=self.gid, password=pw)
|
||||||
|
|
||||||
def is_incoming_cleartext_ok(self):
|
|
||||||
return not self.enforce_E2EE_path.exists()
|
|
||||||
|
|
||||||
def allow_incoming_cleartext(self):
|
|
||||||
if self.enforce_E2EE_path.exists():
|
|
||||||
self.enforce_E2EE_path.unlink()
|
|
||||||
|
|
||||||
def set_password(self, enc_password):
|
def set_password(self, enc_password):
|
||||||
"""Set the specified password for this user.
|
"""Set the specified password for this user.
|
||||||
|
|
||||||
@@ -55,9 +47,9 @@ class User:
|
|||||||
try:
|
try:
|
||||||
write_bytes_atomic(self.password_path, password)
|
write_bytes_atomic(self.password_path, password)
|
||||||
except PermissionError:
|
except PermissionError:
|
||||||
logging.error(f"could not write password for: {self.addr}")
|
if not self.addr.startswith("echo@"):
|
||||||
raise
|
logging.error(f"could not write password for: {self.addr}")
|
||||||
self.enforce_E2EE_path.touch()
|
raise
|
||||||
|
|
||||||
def set_last_login_timestamp(self, timestamp):
|
def set_last_login_timestamp(self, timestamp):
|
||||||
"""Track login time with daily granularity
|
"""Track login time with daily granularity
|
||||||
|
|||||||
94
cliff.toml
94
cliff.toml
@@ -1,94 +0,0 @@
|
|||||||
# git-cliff ~ configuration file
|
|
||||||
# https://git-cliff.org/docs/configuration
|
|
||||||
|
|
||||||
|
|
||||||
[changelog]
|
|
||||||
# A Tera template to be rendered for each release in the changelog.
|
|
||||||
# See https://keats.github.io/tera/docs/#introduction
|
|
||||||
body = """
|
|
||||||
{% if version %}\
|
|
||||||
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
|
|
||||||
{% else %}\
|
|
||||||
## [unreleased]
|
|
||||||
{% endif %}\
|
|
||||||
{% for group, commits in commits | group_by(attribute="group") %}
|
|
||||||
### {{ group | striptags | trim | upper_first }}
|
|
||||||
{% for commit in commits %}
|
|
||||||
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
|
|
||||||
{% if commit.breaking %}[**breaking**] {% endif %}\
|
|
||||||
{{ commit.message | upper_first }}\
|
|
||||||
{% endfor %}
|
|
||||||
{% endfor %}
|
|
||||||
"""
|
|
||||||
# Remove leading and trailing whitespaces from the changelog's body.
|
|
||||||
trim = true
|
|
||||||
# Render body even when there are no releases to process.
|
|
||||||
render_always = true
|
|
||||||
# An array of regex based postprocessors to modify the changelog.
|
|
||||||
postprocessors = [
|
|
||||||
# Replace the placeholder <REPO> with a URL.
|
|
||||||
#{ pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" },
|
|
||||||
]
|
|
||||||
# render body even when there are no releases to process
|
|
||||||
# render_always = true
|
|
||||||
# output file path
|
|
||||||
# output = "test.md"
|
|
||||||
|
|
||||||
[git]
|
|
||||||
# Parse commits according to the conventional commits specification.
|
|
||||||
# See https://www.conventionalcommits.org
|
|
||||||
conventional_commits = true
|
|
||||||
# Exclude commits that do not match the conventional commits specification.
|
|
||||||
filter_unconventional = true
|
|
||||||
# Require all commits to be conventional.
|
|
||||||
# Takes precedence over filter_unconventional.
|
|
||||||
require_conventional = false
|
|
||||||
# Split commits on newlines, treating each line as an individual commit.
|
|
||||||
split_commits = false
|
|
||||||
# An array of regex based parsers to modify commit messages prior to further processing.
|
|
||||||
commit_preprocessors = [
|
|
||||||
# Replace issue numbers with link templates to be updated in `changelog.postprocessors`.
|
|
||||||
#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
|
|
||||||
# Check spelling of the commit message using https://github.com/crate-ci/typos.
|
|
||||||
# If the spelling is incorrect, it will be fixed automatically.
|
|
||||||
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
|
|
||||||
]
|
|
||||||
# Prevent commits that are breaking from being excluded by commit parsers.
|
|
||||||
protect_breaking_commits = false
|
|
||||||
# An array of regex based parsers for extracting data from the commit message.
|
|
||||||
# Assigns commits to groups.
|
|
||||||
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
|
|
||||||
commit_parsers = [
|
|
||||||
{ message = "^feat", group = "Features" },
|
|
||||||
{ message = "^fix", group = "Bug Fixes" },
|
|
||||||
{ message = "^docs", group = "Documentation" },
|
|
||||||
{ message = "^perf", group = "Performance" },
|
|
||||||
{ message = "^refactor", group = "Refactor" },
|
|
||||||
{ message = "^style", group = "Styling" },
|
|
||||||
{ message = "^test", group = "Testing" },
|
|
||||||
{ message = "^chore\\(release\\): prepare for", skip = true },
|
|
||||||
{ message = "^chore\\(deps.*\\)", skip = true },
|
|
||||||
{ message = "^chore\\(pr\\)", skip = true },
|
|
||||||
{ message = "^chore\\(pull\\)", skip = true },
|
|
||||||
{ message = "^chore|^ci", group = "Miscellaneous Tasks" },
|
|
||||||
{ body = ".*security", group = "Security" },
|
|
||||||
{ message = "^revert", group = "Revert" },
|
|
||||||
{ message = ".*", group = "Other" },
|
|
||||||
]
|
|
||||||
# Exclude commits that are not matched by any commit parser.
|
|
||||||
filter_commits = false
|
|
||||||
# Fail on a commit that is not matched by any commit parser.
|
|
||||||
fail_on_unmatched_commit = false
|
|
||||||
# An array of link parsers for extracting external references, and turning them into URLs, using regex.
|
|
||||||
link_parsers = []
|
|
||||||
# Include only the tags that belong to the current branch.
|
|
||||||
use_branch_tags = false
|
|
||||||
# Order releases topologically instead of chronologically.
|
|
||||||
topo_order = false
|
|
||||||
# Order commits topologically instead of chronologically.
|
|
||||||
topo_order_commits = true
|
|
||||||
# Order of commits in each group/release within the changelog.
|
|
||||||
# Allowed values: newest, oldest
|
|
||||||
sort_commits = "oldest"
|
|
||||||
# Process submodules commits
|
|
||||||
recurse_submodules = false
|
|
||||||
@@ -20,7 +20,6 @@ dependencies = [
|
|||||||
"pytest-xdist",
|
"pytest-xdist",
|
||||||
"execnet",
|
"execnet",
|
||||||
"imap_tools",
|
"imap_tools",
|
||||||
"deltachat-rpc-client",
|
|
||||||
]
|
]
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
@@ -42,6 +41,3 @@ lint.select = [
|
|||||||
"PLE", # Pylint Error
|
"PLE", # Pylint Error
|
||||||
"PLW", # Pylint Warning
|
"PLW", # Pylint Warning
|
||||||
]
|
]
|
||||||
lint.ignore = [
|
|
||||||
"PLC0415" # import-outside-top-level
|
|
||||||
]
|
|
||||||
|
|||||||
638
cmdeploy/src/cmdeploy/__init__.py
Normal file
638
cmdeploy/src/cmdeploy/__init__.py
Normal file
@@ -0,0 +1,638 @@
|
|||||||
|
"""
|
||||||
|
Chat Mail pyinfra deploy.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import importlib.resources
|
||||||
|
import io
|
||||||
|
import shutil
|
||||||
|
import subprocess
|
||||||
|
import sys
|
||||||
|
from pathlib import Path
|
||||||
|
|
||||||
|
from chatmaild.config import Config, read_config
|
||||||
|
from pyinfra import host
|
||||||
|
from pyinfra.facts.files import File
|
||||||
|
from pyinfra.facts.systemd import SystemdEnabled
|
||||||
|
from pyinfra.operations import apt, files, pip, server, systemd
|
||||||
|
|
||||||
|
from .acmetool import deploy_acmetool
|
||||||
|
|
||||||
|
|
||||||
|
def _build_chatmaild(dist_dir) -> None:
|
||||||
|
dist_dir = Path(dist_dir).resolve()
|
||||||
|
if dist_dir.exists():
|
||||||
|
shutil.rmtree(dist_dir)
|
||||||
|
dist_dir.mkdir()
|
||||||
|
subprocess.check_output(
|
||||||
|
[sys.executable, "-m", "build", "-n"]
|
||||||
|
+ ["--sdist", "chatmaild", "--outdir", str(dist_dir)]
|
||||||
|
)
|
||||||
|
entries = list(dist_dir.iterdir())
|
||||||
|
assert len(entries) == 1
|
||||||
|
return entries[0]
|
||||||
|
|
||||||
|
|
||||||
|
def remove_legacy_artifacts():
|
||||||
|
# disable legacy doveauth-dictproxy.service
|
||||||
|
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
||||||
|
systemd.service(
|
||||||
|
name="Disable legacy doveauth-dictproxy.service",
|
||||||
|
service="doveauth-dictproxy.service",
|
||||||
|
running=False,
|
||||||
|
enabled=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _install_remote_venv_with_chatmaild(config) -> None:
|
||||||
|
remove_legacy_artifacts()
|
||||||
|
dist_file = _build_chatmaild(dist_dir=Path("chatmaild/dist"))
|
||||||
|
remote_base_dir = "/usr/local/lib/chatmaild"
|
||||||
|
remote_dist_file = f"{remote_base_dir}/dist/{dist_file.name}"
|
||||||
|
remote_venv_dir = f"{remote_base_dir}/venv"
|
||||||
|
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
||||||
|
root_owned = dict(user="root", group="root", mode="644")
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="apt install python3-virtualenv",
|
||||||
|
packages=["python3-virtualenv"],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name="Upload chatmaild source package",
|
||||||
|
src=dist_file.open("rb"),
|
||||||
|
dest=remote_dist_file,
|
||||||
|
create_remote_dir=True,
|
||||||
|
**root_owned,
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name=f"Upload {remote_chatmail_inipath}",
|
||||||
|
src=config._getbytefile(),
|
||||||
|
dest=remote_chatmail_inipath,
|
||||||
|
**root_owned,
|
||||||
|
)
|
||||||
|
|
||||||
|
pip.virtualenv(
|
||||||
|
name=f"chatmaild virtualenv {remote_venv_dir}",
|
||||||
|
path=remote_venv_dir,
|
||||||
|
always_copy=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name=f"forced pip-install {dist_file.name}",
|
||||||
|
commands=[
|
||||||
|
f"{remote_venv_dir}/bin/pip install --force-reinstall {remote_dist_file}"
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("metrics.cron.j2"),
|
||||||
|
dest="/etc/cron.d/chatmail-metrics",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={
|
||||||
|
"mailboxes_dir": config.mailboxes_dir,
|
||||||
|
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
# install systemd units
|
||||||
|
for fn in (
|
||||||
|
"doveauth",
|
||||||
|
"filtermail",
|
||||||
|
"echobot",
|
||||||
|
"chatmail-metadata",
|
||||||
|
"lastlogin",
|
||||||
|
):
|
||||||
|
params = dict(
|
||||||
|
execpath=f"{remote_venv_dir}/bin/{fn}",
|
||||||
|
config_path=remote_chatmail_inipath,
|
||||||
|
remote_venv_dir=remote_venv_dir,
|
||||||
|
mail_domain=config.mail_domain,
|
||||||
|
)
|
||||||
|
source_path = importlib.resources.files(__package__).joinpath(
|
||||||
|
"service", f"{fn}.service.f"
|
||||||
|
)
|
||||||
|
content = source_path.read_text().format(**params).encode()
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name=f"Upload {fn}.service",
|
||||||
|
src=io.BytesIO(content),
|
||||||
|
dest=f"/etc/systemd/system/{fn}.service",
|
||||||
|
**root_owned,
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name=f"Setup {fn} service",
|
||||||
|
service=f"{fn}.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=True,
|
||||||
|
daemon_reload=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_opendkim(domain: str, dkim_selector: str = "dkim") -> bool:
|
||||||
|
"""Configures OpenDKIM"""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/opendkim.conf"),
|
||||||
|
dest="/etc/opendkim.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
screen_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/screen.lua"),
|
||||||
|
dest="/etc/opendkim/screen.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= screen_script.changed
|
||||||
|
|
||||||
|
final_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/final.lua"),
|
||||||
|
dest="/etc/opendkim/final.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= final_script.changed
|
||||||
|
|
||||||
|
files.directory(
|
||||||
|
name="Add opendkim directory to /etc",
|
||||||
|
path="/etc/opendkim",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="750",
|
||||||
|
present=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
keytable = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/KeyTable"),
|
||||||
|
dest="/etc/dkimkeys/KeyTable",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
need_restart |= keytable.changed
|
||||||
|
|
||||||
|
signing_table = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("opendkim/SigningTable"),
|
||||||
|
dest="/etc/dkimkeys/SigningTable",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
||||||
|
)
|
||||||
|
need_restart |= signing_table.changed
|
||||||
|
files.directory(
|
||||||
|
name="Add opendkim socket directory to /var/spool/postfix",
|
||||||
|
path="/var/spool/postfix/opendkim",
|
||||||
|
user="opendkim",
|
||||||
|
group="opendkim",
|
||||||
|
mode="750",
|
||||||
|
present=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="apt install opendkim opendkim-tools",
|
||||||
|
packages=["opendkim", "opendkim-tools"],
|
||||||
|
)
|
||||||
|
|
||||||
|
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
||||||
|
server.shell(
|
||||||
|
name="Generate OpenDKIM domain keys",
|
||||||
|
commands=[
|
||||||
|
f"opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
||||||
|
],
|
||||||
|
_sudo=True,
|
||||||
|
_sudo_user="opendkim",
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _install_mta_sts_daemon() -> bool:
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
config = files.put(
|
||||||
|
name="upload postfix-mta-sts-resolver config",
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/mta-sts-daemon.yml"
|
||||||
|
),
|
||||||
|
dest="/etc/mta-sts-daemon.yml",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= config.changed
|
||||||
|
|
||||||
|
server.shell(
|
||||||
|
name="install postfix-mta-sts-resolver with pip",
|
||||||
|
commands=[
|
||||||
|
"python3 -m virtualenv /usr/local/lib/postfix-mta-sts-resolver",
|
||||||
|
"/usr/local/lib/postfix-mta-sts-resolver/bin/pip install postfix-mta-sts-resolver",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd_unit = files.put(
|
||||||
|
name="upload mta-sts-daemon systemd unit",
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/mta-sts-daemon.service"
|
||||||
|
),
|
||||||
|
dest="/etc/systemd/system/mta-sts-daemon.service",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= systemd_unit.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_postfix(config: Config, debug: bool = False) -> bool:
|
||||||
|
"""Configures Postfix SMTP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/main.cf.j2"),
|
||||||
|
dest="/etc/postfix/main.cf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config=config,
|
||||||
|
disable_ipv6=config.disable_ipv6,
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
master_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/master.cf.j2"),
|
||||||
|
dest="/etc/postfix/master.cf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
debug=debug,
|
||||||
|
config=config,
|
||||||
|
)
|
||||||
|
need_restart |= master_config.changed
|
||||||
|
|
||||||
|
header_cleanup = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"postfix/submission_header_cleanup"
|
||||||
|
),
|
||||||
|
dest="/etc/postfix/submission_header_cleanup",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= header_cleanup.changed
|
||||||
|
|
||||||
|
# Login map that 1:1 maps email address to login.
|
||||||
|
login_map = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("postfix/login_map"),
|
||||||
|
dest="/etc/postfix/login_map",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= login_map.changed
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_dovecot(config: Config, debug: bool = False) -> bool:
|
||||||
|
"""Configures Dovecot IMAP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/dovecot.conf.j2"),
|
||||||
|
dest="/etc/dovecot/dovecot.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config=config,
|
||||||
|
debug=debug,
|
||||||
|
disable_ipv6=config.disable_ipv6,
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
auth_config = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/auth.conf"),
|
||||||
|
dest="/etc/dovecot/auth.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= auth_config.changed
|
||||||
|
lua_push_notification_script = files.put(
|
||||||
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
|
"dovecot/push_notification.lua"
|
||||||
|
),
|
||||||
|
dest="/etc/dovecot/push_notification.lua",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
need_restart |= lua_push_notification_script.changed
|
||||||
|
|
||||||
|
files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("dovecot/expunge.cron.j2"),
|
||||||
|
dest="/etc/cron.d/expunge",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config=config,
|
||||||
|
)
|
||||||
|
|
||||||
|
# as per https://doc.dovecot.org/configuration_manual/os/
|
||||||
|
# it is recommended to set the following inotify limits
|
||||||
|
for name in ("max_user_instances", "max_user_watches"):
|
||||||
|
key = f"fs.inotify.{name}"
|
||||||
|
server.sysctl(
|
||||||
|
name=f"Change {key}",
|
||||||
|
key=key,
|
||||||
|
value=65535,
|
||||||
|
persist=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
||||||
|
"""Configures nginx HTTP server."""
|
||||||
|
need_restart = False
|
||||||
|
|
||||||
|
main_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("nginx/nginx.conf.j2"),
|
||||||
|
dest="/etc/nginx/nginx.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": config.mail_domain},
|
||||||
|
disable_ipv6=config.disable_ipv6,
|
||||||
|
)
|
||||||
|
need_restart |= main_config.changed
|
||||||
|
|
||||||
|
autoconfig = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("nginx/autoconfig.xml.j2"),
|
||||||
|
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": config.mail_domain},
|
||||||
|
)
|
||||||
|
need_restart |= autoconfig.changed
|
||||||
|
|
||||||
|
mta_sts_config = files.template(
|
||||||
|
src=importlib.resources.files(__package__).joinpath("nginx/mta-sts.txt.j2"),
|
||||||
|
dest="/var/www/html/.well-known/mta-sts.txt",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
config={"domain_name": config.mail_domain},
|
||||||
|
)
|
||||||
|
need_restart |= mta_sts_config.changed
|
||||||
|
|
||||||
|
# install CGI newemail script
|
||||||
|
#
|
||||||
|
cgi_dir = "/usr/lib/cgi-bin"
|
||||||
|
files.directory(
|
||||||
|
name=f"Ensure {cgi_dir} exists",
|
||||||
|
path=cgi_dir,
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
)
|
||||||
|
|
||||||
|
files.put(
|
||||||
|
name="Upload cgi newemail.py script",
|
||||||
|
src=importlib.resources.files("chatmaild").joinpath("newemail.py").open("rb"),
|
||||||
|
dest=f"{cgi_dir}/newemail.py",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="755",
|
||||||
|
)
|
||||||
|
|
||||||
|
return need_restart
|
||||||
|
|
||||||
|
|
||||||
|
def _remove_rspamd() -> None:
|
||||||
|
"""Remove rspamd"""
|
||||||
|
apt.packages(name="Remove rspamd", packages="rspamd", present=False)
|
||||||
|
|
||||||
|
|
||||||
|
def check_config(config):
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
||||||
|
blocked_words = "merlinux schmieder testrun.org".split()
|
||||||
|
for key in config.__dict__:
|
||||||
|
value = config.__dict__[key]
|
||||||
|
if key.startswith("privacy") and any(
|
||||||
|
x in str(value) for x in blocked_words
|
||||||
|
):
|
||||||
|
raise ValueError(
|
||||||
|
f"please set your own privacy contacts/addresses in {config._inipath}"
|
||||||
|
)
|
||||||
|
return config
|
||||||
|
|
||||||
|
|
||||||
|
def deploy_chatmail(config_path: Path) -> None:
|
||||||
|
"""Deploy a chat-mail instance.
|
||||||
|
|
||||||
|
:param config_path: path to chatmail.ini
|
||||||
|
"""
|
||||||
|
config = read_config(config_path)
|
||||||
|
check_config(config)
|
||||||
|
mail_domain = config.mail_domain
|
||||||
|
|
||||||
|
from .www import build_webpages
|
||||||
|
|
||||||
|
server.group(name="Create vmail group", group="vmail", system=True)
|
||||||
|
server.user(name="Create vmail user", user="vmail", group="vmail", system=True)
|
||||||
|
server.user(name="Create filtermail user", user="filtermail", system=True)
|
||||||
|
server.group(name="Create opendkim group", group="opendkim", system=True)
|
||||||
|
server.user(
|
||||||
|
name="Create opendkim user",
|
||||||
|
user="opendkim",
|
||||||
|
groups=["opendkim"],
|
||||||
|
system=True,
|
||||||
|
)
|
||||||
|
server.user(
|
||||||
|
name="Add postfix user to opendkim group for socket access",
|
||||||
|
user="postfix",
|
||||||
|
groups=["opendkim"],
|
||||||
|
system=True,
|
||||||
|
)
|
||||||
|
server.user(name="Create echobot user", user="echobot", system=True)
|
||||||
|
|
||||||
|
# Add our OBS repository for dovecot_no_delay
|
||||||
|
files.put(
|
||||||
|
name="Add Deltachat OBS GPG key to apt keyring",
|
||||||
|
src=importlib.resources.files(__package__).joinpath("obs-home-deltachat.gpg"),
|
||||||
|
dest="/etc/apt/keyrings/obs-home-deltachat.gpg",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
|
||||||
|
files.line(
|
||||||
|
name="Add DeltaChat OBS home repository to sources.list",
|
||||||
|
path="/etc/apt/sources.list",
|
||||||
|
line="deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./",
|
||||||
|
escape_regex_characters=True,
|
||||||
|
ensure_newline=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.update(name="apt update", cache_time=24 * 3600)
|
||||||
|
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install rsync",
|
||||||
|
packages=["rsync"],
|
||||||
|
)
|
||||||
|
|
||||||
|
# Run local DNS resolver `unbound`.
|
||||||
|
# `resolvconf` takes care of setting up /etc/resolv.conf
|
||||||
|
# to use 127.0.0.1 as the resolver.
|
||||||
|
apt.packages(
|
||||||
|
name="Install unbound",
|
||||||
|
packages=["unbound", "unbound-anchor", "dnsutils"],
|
||||||
|
)
|
||||||
|
server.shell(
|
||||||
|
name="Generate root keys for validating DNSSEC",
|
||||||
|
commands=[
|
||||||
|
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
||||||
|
"systemctl reset-failed unbound.service",
|
||||||
|
],
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable unbound",
|
||||||
|
service="unbound.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Deploy acmetool to have TLS certificates.
|
||||||
|
deploy_acmetool(
|
||||||
|
domains=[mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
# required for setfacl for echobot
|
||||||
|
name="Install acl",
|
||||||
|
packages="acl",
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install Postfix",
|
||||||
|
packages="postfix",
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install Dovecot",
|
||||||
|
packages=["dovecot-imapd", "dovecot-lmtpd"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install nginx",
|
||||||
|
packages=["nginx", "libnginx-mod-stream"],
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Install fcgiwrap",
|
||||||
|
packages=["fcgiwrap"],
|
||||||
|
)
|
||||||
|
|
||||||
|
www_path = importlib.resources.files(__package__).joinpath("../../../www").resolve()
|
||||||
|
|
||||||
|
build_dir = www_path.joinpath("build")
|
||||||
|
src_dir = www_path.joinpath("src")
|
||||||
|
build_webpages(src_dir, build_dir, config)
|
||||||
|
files.rsync(f"{build_dir}/", "/var/www/html", flags=["-avz"])
|
||||||
|
|
||||||
|
_install_remote_venv_with_chatmaild(config)
|
||||||
|
debug = False
|
||||||
|
dovecot_need_restart = _configure_dovecot(config, debug=debug)
|
||||||
|
postfix_need_restart = _configure_postfix(config, debug=debug)
|
||||||
|
mta_sts_need_restart = _install_mta_sts_daemon()
|
||||||
|
nginx_need_restart = _configure_nginx(config)
|
||||||
|
|
||||||
|
_remove_rspamd()
|
||||||
|
opendkim_need_restart = _configure_opendkim(mail_domain, "opendkim")
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable OpenDKIM",
|
||||||
|
service="opendkim.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=opendkim_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable MTA-STS daemon",
|
||||||
|
service="mta-sts-daemon.service",
|
||||||
|
daemon_reload=True,
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=mta_sts_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Dovecot should be started before Postfix
|
||||||
|
# because it creates authentication socket
|
||||||
|
# required by Postfix.
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Dovecot",
|
||||||
|
service="dovecot.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=dovecot_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable Postfix",
|
||||||
|
service="postfix.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=postfix_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable nginx",
|
||||||
|
service="nginx.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=nginx_need_restart,
|
||||||
|
)
|
||||||
|
|
||||||
|
# This file is used by auth proxy.
|
||||||
|
# https://wiki.debian.org/EtcMailName
|
||||||
|
server.shell(
|
||||||
|
name="Setup /etc/mailname",
|
||||||
|
commands=[f"echo {mail_domain} >/etc/mailname; chmod 644 /etc/mailname"],
|
||||||
|
)
|
||||||
|
|
||||||
|
journald_conf = files.put(
|
||||||
|
name="Configure journald",
|
||||||
|
src=importlib.resources.files(__package__).joinpath("journald.conf"),
|
||||||
|
dest="/etc/systemd/journald.conf",
|
||||||
|
user="root",
|
||||||
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
)
|
||||||
|
systemd.service(
|
||||||
|
name="Start and enable journald",
|
||||||
|
service="systemd-journald.service",
|
||||||
|
running=True,
|
||||||
|
enabled=True,
|
||||||
|
restarted=journald_conf.changed,
|
||||||
|
)
|
||||||
|
|
||||||
|
apt.packages(
|
||||||
|
name="Ensure cron is installed",
|
||||||
|
packages=["cron"],
|
||||||
|
)
|
||||||
@@ -1,141 +1,75 @@
|
|||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
|
||||||
|
from pyinfra import host
|
||||||
|
from pyinfra.facts.systemd import SystemdStatus
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
from pyinfra.operations import apt, files, server, systemd
|
||||||
|
|
||||||
from ..basedeploy import Deployer
|
|
||||||
|
|
||||||
|
def deploy_acmetool(email="", domains=[]):
|
||||||
|
"""Deploy acmetool."""
|
||||||
|
apt.packages(
|
||||||
|
name="Install acmetool",
|
||||||
|
packages=["acmetool"],
|
||||||
|
)
|
||||||
|
|
||||||
class AcmetoolDeployer(Deployer):
|
files.put(
|
||||||
def __init__(self, email, domains):
|
src=importlib.resources.files(__package__).joinpath("acmetool.cron").open("rb"),
|
||||||
self.domains = domains
|
dest="/etc/cron.d/acmetool",
|
||||||
self.email = email
|
user="root",
|
||||||
self.need_restart_redirector = False
|
group="root",
|
||||||
self.need_restart_reconcile_service = False
|
mode="644",
|
||||||
self.need_restart_reconcile_timer = False
|
)
|
||||||
|
|
||||||
def install(self):
|
files.put(
|
||||||
apt.packages(
|
src=importlib.resources.files(__package__).joinpath("acmetool.hook").open("rb"),
|
||||||
name="Install acmetool",
|
dest="/usr/lib/acme/hooks/nginx",
|
||||||
packages=["acmetool"],
|
user="root",
|
||||||
)
|
group="root",
|
||||||
|
mode="744",
|
||||||
|
)
|
||||||
|
|
||||||
files.file(
|
files.template(
|
||||||
name="Remove old acmetool cronjob, it is replaced with systemd timer.",
|
src=importlib.resources.files(__package__).joinpath("response-file.yaml.j2"),
|
||||||
path="/etc/cron.d/acmetool",
|
dest="/var/lib/acme/conf/responses",
|
||||||
present=False,
|
user="root",
|
||||||
)
|
group="root",
|
||||||
|
mode="644",
|
||||||
|
email=email,
|
||||||
|
)
|
||||||
|
|
||||||
files.put(
|
files.template(
|
||||||
name="Install acmetool hook.",
|
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
||||||
src=importlib.resources.files(__package__)
|
dest="/var/lib/acme/conf/target",
|
||||||
.joinpath("acmetool.hook")
|
user="root",
|
||||||
.open("rb"),
|
group="root",
|
||||||
dest="/etc/acme/hooks/nginx",
|
mode="644",
|
||||||
user="root",
|
)
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
files.file(
|
|
||||||
name="Remove acmetool hook from the wrong location where it was previously installed.",
|
|
||||||
path="/usr/lib/acme/hooks/nginx",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
service_file = files.put(
|
||||||
files.template(
|
src=importlib.resources.files(__package__).joinpath(
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
"acmetool-redirector.service"
|
||||||
"response-file.yaml.j2"
|
),
|
||||||
),
|
dest="/etc/systemd/system/acmetool-redirector.service",
|
||||||
dest="/var/lib/acme/conf/responses",
|
user="root",
|
||||||
user="root",
|
group="root",
|
||||||
group="root",
|
mode="644",
|
||||||
mode="644",
|
)
|
||||||
email=self.email,
|
if host.get_fact(SystemdStatus).get("nginx.service"):
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("target.yaml.j2"),
|
|
||||||
dest="/var/lib/acme/conf/target",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name=f"Remove old acmetool desired files for {self.domains[0]}",
|
|
||||||
commands=[f"rm -f /var/lib/acme/desired/{self.domains[0]}-*"],
|
|
||||||
)
|
|
||||||
files.template(
|
|
||||||
src=importlib.resources.files(__package__).joinpath("desired.yaml.j2"),
|
|
||||||
dest=f"/var/lib/acme/desired/{self.domains[0]}", # 0 is mailhost TLD
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
domains=self.domains,
|
|
||||||
)
|
|
||||||
|
|
||||||
service_file = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"acmetool-redirector.service"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/acmetool-redirector.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart_redirector = service_file.changed
|
|
||||||
|
|
||||||
reconcile_service_file = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"acmetool-reconcile.service"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/acmetool-reconcile.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart_reconcile_service = reconcile_service_file.changed
|
|
||||||
|
|
||||||
reconcile_timer_file = files.put(
|
|
||||||
src=importlib.resources.files(__package__).joinpath(
|
|
||||||
"acmetool-reconcile.timer"
|
|
||||||
),
|
|
||||||
dest="/etc/systemd/system/acmetool-reconcile.timer",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart_reconcile_timer = reconcile_timer_file.changed
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Setup acmetool-redirector service",
|
name="Stop nginx service to free port 80",
|
||||||
service="acmetool-redirector.service",
|
service="nginx",
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart_redirector,
|
|
||||||
)
|
|
||||||
self.need_restart_redirector = False
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Setup acmetool-reconcile service",
|
|
||||||
service="acmetool-reconcile.service",
|
|
||||||
running=False,
|
running=False,
|
||||||
enabled=False,
|
|
||||||
daemon_reload=self.need_restart_reconcile_service,
|
|
||||||
)
|
)
|
||||||
self.need_restart_reconcile_service = False
|
|
||||||
|
|
||||||
systemd.service(
|
systemd.service(
|
||||||
name="Setup acmetool-reconcile timer",
|
name="Setup acmetool-redirector service",
|
||||||
service="acmetool-reconcile.timer",
|
service="acmetool-redirector.service",
|
||||||
running=True,
|
running=True,
|
||||||
enabled=True,
|
enabled=True,
|
||||||
daemon_reload=self.need_restart_reconcile_timer,
|
restarted=service_file.changed,
|
||||||
)
|
)
|
||||||
self.need_restart_reconcile_timer = False
|
|
||||||
|
|
||||||
server.shell(
|
server.shell(
|
||||||
name=f"Reconcile certificates for: {', '.join(self.domains)}",
|
name=f"Request certificate for: { ', '.join(domains) }",
|
||||||
commands=["acmetool --batch --xlog.severity=debug reconcile"],
|
commands=[f"acmetool want --xlog.severity=debug { ' '.join(domains)}"],
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -1,8 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Renew TLS certificates with acmetool
|
|
||||||
After=network.target
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=oneshot
|
|
||||||
ExecStart=/usr/bin/acmetool --batch reconcile
|
|
||||||
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Renew TLS certificates with acmetool
|
|
||||||
|
|
||||||
[Timer]
|
|
||||||
OnCalendar=*-*-* 16:20:00
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=timers.target
|
|
||||||
@@ -3,7 +3,7 @@ Description=acmetool HTTP redirector
|
|||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
Type=notify
|
Type=notify
|
||||||
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon --bind=127.0.0.1:402
|
ExecStart=/usr/bin/acmetool redirector --service.uid=daemon
|
||||||
Restart=always
|
Restart=always
|
||||||
RestartSec=30
|
RestartSec=30
|
||||||
|
|
||||||
|
|||||||
4
cmdeploy/src/cmdeploy/acmetool/acmetool.cron
Normal file
4
cmdeploy/src/cmdeploy/acmetool/acmetool.cron
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
SHELL=/bin/sh
|
||||||
|
PATH=/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin
|
||||||
|
MAILTO=root
|
||||||
|
20 16 * * * root /usr/bin/acmetool --batch reconcile && systemctl reload dovecot && systemctl reload postfix && systemctl reload nginx
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
satisfy:
|
|
||||||
names:
|
|
||||||
{%- for domain in domains %}
|
|
||||||
- {{ domain }}
|
|
||||||
{%- endfor %}
|
|
||||||
|
|
||||||
@@ -1,2 +1,2 @@
|
|||||||
"acme-enter-email": "{{ email }}"
|
"acme-enter-email": "{{ email }}"
|
||||||
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.6-August-18-2025.pdf": true
|
"acme-agreement:https://letsencrypt.org/documents/LE-SA-v1.4-April-3-2024.pdf": true
|
||||||
|
|||||||
@@ -1,8 +1,7 @@
|
|||||||
request:
|
request:
|
||||||
provider: https://acme-v02.api.letsencrypt.org/directory
|
provider: https://acme-v02.api.letsencrypt.org/directory
|
||||||
key:
|
key:
|
||||||
type: ecdsa
|
type: rsa
|
||||||
ecdsa-curve: nistp256
|
|
||||||
challenge:
|
challenge:
|
||||||
webroot-paths:
|
webroot-paths:
|
||||||
- /var/www/html/.well-known/acme-challenge
|
- /var/www/html/.well-known/acme-challenge
|
||||||
|
|||||||
@@ -1,116 +0,0 @@
|
|||||||
import importlib.resources
|
|
||||||
import io
|
|
||||||
import os
|
|
||||||
|
|
||||||
from pyinfra.operations import files, server, systemd
|
|
||||||
|
|
||||||
|
|
||||||
def has_systemd():
|
|
||||||
"""Returns False during Docker image builds or any other non-systemd environment."""
|
|
||||||
return os.path.isdir("/run/systemd/system")
|
|
||||||
|
|
||||||
|
|
||||||
def get_resource(arg, pkg=__package__):
|
|
||||||
return importlib.resources.files(pkg).joinpath(arg)
|
|
||||||
|
|
||||||
|
|
||||||
def configure_remote_units(mail_domain, units) -> None:
|
|
||||||
remote_base_dir = "/usr/local/lib/chatmaild"
|
|
||||||
remote_venv_dir = f"{remote_base_dir}/venv"
|
|
||||||
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
|
||||||
root_owned = dict(user="root", group="root", mode="644")
|
|
||||||
|
|
||||||
# install systemd units
|
|
||||||
for fn in units:
|
|
||||||
params = dict(
|
|
||||||
execpath=f"{remote_venv_dir}/bin/{fn}",
|
|
||||||
config_path=remote_chatmail_inipath,
|
|
||||||
remote_venv_dir=remote_venv_dir,
|
|
||||||
mail_domain=mail_domain,
|
|
||||||
)
|
|
||||||
|
|
||||||
basename = fn if "." in fn else f"{fn}.service"
|
|
||||||
|
|
||||||
source_path = get_resource(f"service/{basename}.f")
|
|
||||||
content = source_path.read_text().format(**params).encode()
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name=f"Upload {basename}",
|
|
||||||
src=io.BytesIO(content),
|
|
||||||
dest=f"/etc/systemd/system/{basename}",
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def activate_remote_units(units) -> None:
|
|
||||||
# activate systemd units
|
|
||||||
for fn in units:
|
|
||||||
basename = fn if "." in fn else f"{fn}.service"
|
|
||||||
|
|
||||||
if fn == "chatmail-expire" or fn == "chatmail-fsreport":
|
|
||||||
# don't auto-start but let the corresponding timer trigger execution
|
|
||||||
enabled = False
|
|
||||||
else:
|
|
||||||
enabled = True
|
|
||||||
systemd.service(
|
|
||||||
name=f"Setup {basename}",
|
|
||||||
service=basename,
|
|
||||||
running=enabled,
|
|
||||||
enabled=enabled,
|
|
||||||
restarted=enabled,
|
|
||||||
daemon_reload=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class Deployment:
|
|
||||||
def install(self, deployer):
|
|
||||||
# optional 'required_users' contains a list of (user, group, secondary-group-list) tuples.
|
|
||||||
# If the group is None, no group is created corresponding to that user.
|
|
||||||
# If the secondary group list is not None, all listed groups are created as well.
|
|
||||||
required_users = getattr(deployer, "required_users", [])
|
|
||||||
for user, group, groups in required_users:
|
|
||||||
if group is not None:
|
|
||||||
server.group(
|
|
||||||
name="Create {} group".format(group), group=group, system=True
|
|
||||||
)
|
|
||||||
if groups is not None:
|
|
||||||
for group2 in groups:
|
|
||||||
server.group(
|
|
||||||
name="Create {} group".format(group2), group=group2, system=True
|
|
||||||
)
|
|
||||||
server.user(
|
|
||||||
name="Create {} user".format(user),
|
|
||||||
user=user,
|
|
||||||
group=group,
|
|
||||||
groups=groups,
|
|
||||||
system=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
deployer.install()
|
|
||||||
|
|
||||||
def configure(self, deployer):
|
|
||||||
deployer.configure()
|
|
||||||
|
|
||||||
def activate(self, deployer):
|
|
||||||
deployer.activate()
|
|
||||||
|
|
||||||
def perform_stages(self, deployers):
|
|
||||||
default_stages = "install,configure,activate"
|
|
||||||
stages = os.getenv("CMDEPLOY_STAGES", default_stages).split(",")
|
|
||||||
|
|
||||||
for stage in stages:
|
|
||||||
for deployer in deployers:
|
|
||||||
getattr(self, stage)(deployer)
|
|
||||||
|
|
||||||
|
|
||||||
class Deployer:
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
pass
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
pass
|
|
||||||
@@ -8,17 +8,15 @@
|
|||||||
{{ mail_domain }}. AAAA {{ AAAA }}
|
{{ mail_domain }}. AAAA {{ AAAA }}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
{{ mail_domain }}. MX 10 {{ mail_domain }}.
|
{{ mail_domain }}. MX 10 {{ mail_domain }}.
|
||||||
{% if strict_tls %}
|
|
||||||
_mta-sts.{{ mail_domain }}. TXT "v=STSv1; id={{ sts_id }}"
|
_mta-sts.{{ mail_domain }}. TXT "v=STSv1; id={{ sts_id }}"
|
||||||
mta-sts.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
mta-sts.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
||||||
{% endif %}
|
|
||||||
www.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
www.{{ mail_domain }}. CNAME {{ mail_domain }}.
|
||||||
{{ dkim_entry }}
|
{{ dkim_entry }}
|
||||||
|
|
||||||
;
|
;
|
||||||
; Recommended DNS entries for interoperability and security-hardening
|
; Recommended DNS entries for interoperability and security-hardening
|
||||||
;
|
;
|
||||||
{{ mail_domain }}. TXT "v=spf1 a ~all"
|
{{ mail_domain }}. TXT "v=spf1 a:{{ mail_domain }} ~all"
|
||||||
_dmarc.{{ mail_domain }}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
_dmarc.{{ mail_domain }}. TXT "v=DMARC1;p=reject;adkim=s;aspf=s"
|
||||||
|
|
||||||
{% if acme_account_url %}
|
{% if acme_account_url %}
|
||||||
|
|||||||
@@ -5,6 +5,7 @@ along with command line option and subcommand parsing.
|
|||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
import importlib.resources
|
import importlib.resources
|
||||||
|
import importlib.util
|
||||||
import os
|
import os
|
||||||
import pathlib
|
import pathlib
|
||||||
import shutil
|
import shutil
|
||||||
@@ -18,7 +19,7 @@ from packaging import version
|
|||||||
from termcolor import colored
|
from termcolor import colored
|
||||||
|
|
||||||
from . import dns, remote
|
from . import dns, remote
|
||||||
from .sshexec import LocalExec, SSHExec
|
from .sshexec import SSHExec
|
||||||
|
|
||||||
#
|
#
|
||||||
# cmdeploy sub commands and options
|
# cmdeploy sub commands and options
|
||||||
@@ -31,30 +32,17 @@ def init_cmd_options(parser):
|
|||||||
action="store",
|
action="store",
|
||||||
help="fully qualified DNS domain name for your chatmail instance",
|
help="fully qualified DNS domain name for your chatmail instance",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
|
||||||
"--force",
|
|
||||||
dest="recreate_ini",
|
|
||||||
action="store_true",
|
|
||||||
help="force reacreate ini file",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def init_cmd(args, out):
|
def init_cmd(args, out):
|
||||||
"""Initialize chatmail config file."""
|
"""Initialize chatmail config file."""
|
||||||
mail_domain = args.chatmail_domain
|
mail_domain = args.chatmail_domain
|
||||||
inipath = args.inipath
|
|
||||||
if args.inipath.exists():
|
if args.inipath.exists():
|
||||||
if not args.recreate_ini:
|
print(f"Path exists, not modifying: {args.inipath}")
|
||||||
print(f"[WARNING] Path exists, not modifying: {inipath}")
|
return 1
|
||||||
return 1
|
else:
|
||||||
else:
|
write_initial_config(args.inipath, mail_domain, overrides={})
|
||||||
print(
|
out.green(f"created config file for {mail_domain} in {args.inipath}")
|
||||||
f"[WARNING] Force argument was provided, deleting config file: {inipath}"
|
|
||||||
)
|
|
||||||
inipath.unlink()
|
|
||||||
|
|
||||||
write_initial_config(inipath, mail_domain, overrides={})
|
|
||||||
out.green(f"created config file for {mail_domain} in {inipath}")
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd_options(parser):
|
def run_cmd_options(parser):
|
||||||
@@ -64,75 +52,34 @@ def run_cmd_options(parser):
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="don't actually modify the server",
|
help="don't actually modify the server",
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
|
||||||
"--disable-mail",
|
|
||||||
dest="disable_mail",
|
|
||||||
action="store_true",
|
|
||||||
help="install/upgrade the server, but disable postfix & dovecot for now",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--website-only",
|
|
||||||
action="store_true",
|
|
||||||
help="only update/deploy the website, skipping full server upgrade/deployment, useful when you only changed/updated the web pages and don't need to re-run a full server upgrade",
|
|
||||||
)
|
|
||||||
parser.add_argument(
|
|
||||||
"--skip-dns-check",
|
|
||||||
dest="dns_check_disabled",
|
|
||||||
action="store_true",
|
|
||||||
help="disable checks nslookup for dns",
|
|
||||||
)
|
|
||||||
add_ssh_host_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def run_cmd(args, out):
|
def run_cmd(args, out):
|
||||||
"""Deploy chatmail services on the remote server."""
|
"""Deploy chatmail services on the remote server."""
|
||||||
|
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
sshexec = args.get_sshexec()
|
||||||
sshexec = get_sshexec(ssh_host)
|
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
||||||
require_iroh = args.config.enable_iroh_relay
|
if not dns.check_initial_remote_data(remote_data, print=out.red):
|
||||||
strict_tls = args.config.tls_cert_mode == "acme"
|
return 1
|
||||||
if not args.dns_check_disabled:
|
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
|
||||||
if not dns.check_initial_remote_data(remote_data, strict_tls=strict_tls, print=out.red):
|
|
||||||
return 1
|
|
||||||
|
|
||||||
env = os.environ.copy()
|
env = os.environ.copy()
|
||||||
env["CHATMAIL_INI"] = args.inipath
|
env["CHATMAIL_INI"] = args.inipath
|
||||||
env["CHATMAIL_WEBSITE_ONLY"] = "True" if args.website_only else ""
|
deploy_path = importlib.resources.files(__package__).joinpath("deploy.py").resolve()
|
||||||
env["CHATMAIL_DISABLE_MAIL"] = "True" if args.disable_mail else ""
|
|
||||||
env["CHATMAIL_REQUIRE_IROH"] = "True" if require_iroh else ""
|
|
||||||
if not args.dns_check_disabled:
|
|
||||||
env["CHATMAIL_ADDR_V4"] = remote_data.get("A") or ""
|
|
||||||
env["CHATMAIL_ADDR_V6"] = remote_data.get("AAAA") or ""
|
|
||||||
deploy_path = importlib.resources.files(__package__).joinpath("run.py").resolve()
|
|
||||||
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
pyinf = "pyinfra --dry" if args.dry_run else "pyinfra"
|
||||||
|
cmd = f"{pyinf} --ssh-user root {args.config.mail_domain} {deploy_path} -y"
|
||||||
cmd = f"{pyinf} --ssh-user root {ssh_host} {deploy_path} -y"
|
|
||||||
if ssh_host == "localhost":
|
|
||||||
cmd = f"{pyinf} @local {deploy_path} -y"
|
|
||||||
|
|
||||||
if version.parse(pyinfra.__version__) < version.parse("3"):
|
if version.parse(pyinfra.__version__) < version.parse("3"):
|
||||||
out.red("Please re-run scripts/initenv.sh to update pyinfra to version 3.")
|
out.red("Please re-run scripts/initenv.sh to update pyinfra to version 3.")
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
try:
|
retcode = out.check_call(cmd, env=env)
|
||||||
retcode = out.check_call(cmd, env=env)
|
if retcode == 0:
|
||||||
if args.website_only:
|
out.green("Deploy completed, call `cmdeploy dns` next.")
|
||||||
if retcode == 0:
|
elif not remote_data["acme_account_url"]:
|
||||||
out.green("Website deployment completed.")
|
out.red("Deploy completed but letsencrypt not configured")
|
||||||
else:
|
out.red("Run 'cmdeploy run' again")
|
||||||
out.red("Website deployment failed.")
|
retcode = 0
|
||||||
elif retcode == 0:
|
else:
|
||||||
out.green("Deploy completed, call `cmdeploy dns` next.")
|
|
||||||
elif not args.dns_check_disabled and strict_tls and not remote_data["acme_account_url"]:
|
|
||||||
out.red("Deploy completed but letsencrypt not configured")
|
|
||||||
out.red("Run 'cmdeploy run' again")
|
|
||||||
retcode = 0
|
|
||||||
else:
|
|
||||||
out.red("Deploy failed")
|
|
||||||
except subprocess.CalledProcessError:
|
|
||||||
out.red("Deploy failed")
|
out.red("Deploy failed")
|
||||||
retcode = 1
|
|
||||||
return retcode
|
return retcode
|
||||||
|
|
||||||
|
|
||||||
@@ -144,20 +91,16 @@ def dns_cmd_options(parser):
|
|||||||
default=None,
|
default=None,
|
||||||
help="write out a zonefile",
|
help="write out a zonefile",
|
||||||
)
|
)
|
||||||
add_ssh_host_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def dns_cmd(args, out):
|
def dns_cmd(args, out):
|
||||||
"""Check DNS entries and optionally generate dns zone file."""
|
"""Check DNS entries and optionally generate dns zone file."""
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
sshexec = args.get_sshexec()
|
||||||
sshexec = get_sshexec(ssh_host, verbose=args.verbose)
|
|
||||||
tls_cert_mode = args.config.tls_cert_mode
|
|
||||||
strict_tls = tls_cert_mode == "acme"
|
|
||||||
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
remote_data = dns.get_initial_remote_data(sshexec, args.config.mail_domain)
|
||||||
if not dns.check_initial_remote_data(remote_data, strict_tls=strict_tls):
|
if not remote_data:
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
if strict_tls and not remote_data["acme_account_url"]:
|
if not remote_data["acme_account_url"]:
|
||||||
out.red("could not get letsencrypt account url, please run 'cmdeploy run'")
|
out.red("could not get letsencrypt account url, please run 'cmdeploy run'")
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
@@ -165,7 +108,6 @@ def dns_cmd(args, out):
|
|||||||
out.red("could not determine dkim_entry, please run 'cmdeploy run'")
|
out.red("could not determine dkim_entry, please run 'cmdeploy run'")
|
||||||
return 1
|
return 1
|
||||||
|
|
||||||
remote_data["strict_tls"] = strict_tls
|
|
||||||
zonefile = dns.get_filled_zone_file(remote_data)
|
zonefile = dns.get_filled_zone_file(remote_data)
|
||||||
|
|
||||||
if args.zonefile:
|
if args.zonefile:
|
||||||
@@ -179,15 +121,10 @@ def dns_cmd(args, out):
|
|||||||
return retcode
|
return retcode
|
||||||
|
|
||||||
|
|
||||||
def status_cmd_options(parser):
|
|
||||||
add_ssh_host_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def status_cmd(args, out):
|
def status_cmd(args, out):
|
||||||
"""Display status for online chatmail instance."""
|
"""Display status for online chatmail instance."""
|
||||||
|
|
||||||
ssh_host = args.ssh_host if args.ssh_host else args.config.mail_domain
|
sshexec = args.get_sshexec()
|
||||||
sshexec = get_sshexec(ssh_host, verbose=args.verbose)
|
|
||||||
|
|
||||||
out.green(f"chatmail domain: {args.config.mail_domain}")
|
out.green(f"chatmail domain: {args.config.mail_domain}")
|
||||||
if args.config.privacy_mail:
|
if args.config.privacy_mail:
|
||||||
@@ -206,15 +143,17 @@ def test_cmd_options(parser):
|
|||||||
action="store_true",
|
action="store_true",
|
||||||
help="also run slow tests",
|
help="also run slow tests",
|
||||||
)
|
)
|
||||||
add_ssh_host_option(parser)
|
|
||||||
|
|
||||||
|
|
||||||
def test_cmd(args, out):
|
def test_cmd(args, out):
|
||||||
"""Run local and online tests for chatmail deployment."""
|
"""Run local and online tests for chatmail deployment.
|
||||||
|
|
||||||
env = os.environ.copy()
|
This will automatically pip-install 'deltachat' if it's not available.
|
||||||
if args.ssh_host:
|
"""
|
||||||
env["CHATMAIL_SSH"] = args.ssh_host
|
|
||||||
|
x = importlib.util.find_spec("deltachat")
|
||||||
|
if x is None:
|
||||||
|
out.check_call(f"{sys.executable} -m pip install deltachat")
|
||||||
|
|
||||||
pytest_path = shutil.which("pytest")
|
pytest_path = shutil.which("pytest")
|
||||||
pytest_args = [
|
pytest_args = [
|
||||||
@@ -228,7 +167,7 @@ def test_cmd(args, out):
|
|||||||
]
|
]
|
||||||
if args.slow:
|
if args.slow:
|
||||||
pytest_args.append("--slow")
|
pytest_args.append("--slow")
|
||||||
ret = out.run_ret(pytest_args, env=env)
|
ret = out.run_ret(pytest_args)
|
||||||
return ret
|
return ret
|
||||||
|
|
||||||
|
|
||||||
@@ -244,12 +183,7 @@ def fmt_cmd_options(parser):
|
|||||||
def fmt_cmd(args, out):
|
def fmt_cmd(args, out):
|
||||||
"""Run formattting fixes on all chatmail source code."""
|
"""Run formattting fixes on all chatmail source code."""
|
||||||
|
|
||||||
chatmaild_dir = importlib.resources.files("chatmaild").resolve()
|
sources = [str(importlib.resources.files(x)) for x in ("chatmaild", "cmdeploy")]
|
||||||
cmdeploy_dir = chatmaild_dir.joinpath(
|
|
||||||
"..", "..", "..", "cmdeploy", "src", "cmdeploy"
|
|
||||||
).resolve()
|
|
||||||
sources = [str(chatmaild_dir), str(cmdeploy_dir)]
|
|
||||||
|
|
||||||
format_args = [shutil.which("ruff"), "format"]
|
format_args = [shutil.which("ruff"), "format"]
|
||||||
check_args = [shutil.which("ruff"), "check"]
|
check_args = [shutil.which("ruff"), "check"]
|
||||||
|
|
||||||
@@ -315,21 +249,12 @@ class Out:
|
|||||||
return proc.returncode
|
return proc.returncode
|
||||||
|
|
||||||
|
|
||||||
def add_ssh_host_option(parser):
|
|
||||||
parser.add_argument(
|
|
||||||
"--ssh-host",
|
|
||||||
dest="ssh_host",
|
|
||||||
help="Run commands on 'localhost' or on a specific SSH host "
|
|
||||||
"instead of chatmail.ini's mail_domain.",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def add_config_option(parser):
|
def add_config_option(parser):
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--config",
|
"--config",
|
||||||
dest="inipath",
|
dest="inipath",
|
||||||
action="store",
|
action="store",
|
||||||
default=Path(os.environ.get("CHATMAIL_INI", "chatmail.ini")),
|
default=Path("chatmail.ini"),
|
||||||
type=Path,
|
type=Path,
|
||||||
help="path to the chatmail.ini file",
|
help="path to the chatmail.ini file",
|
||||||
)
|
)
|
||||||
@@ -379,14 +304,6 @@ def get_parser():
|
|||||||
return parser
|
return parser
|
||||||
|
|
||||||
|
|
||||||
def get_sshexec(ssh_host: str, verbose=True):
|
|
||||||
if ssh_host in ["localhost", "@local"]:
|
|
||||||
return LocalExec(verbose)
|
|
||||||
if verbose:
|
|
||||||
print(f"[ssh] login to {ssh_host}")
|
|
||||||
return SSHExec(ssh_host, verbose=verbose)
|
|
||||||
|
|
||||||
|
|
||||||
def main(args=None):
|
def main(args=None):
|
||||||
"""Provide main entry point for 'cmdeploy' CLI invocation."""
|
"""Provide main entry point for 'cmdeploy' CLI invocation."""
|
||||||
parser = get_parser()
|
parser = get_parser()
|
||||||
@@ -394,6 +311,12 @@ def main(args=None):
|
|||||||
if not hasattr(args, "func"):
|
if not hasattr(args, "func"):
|
||||||
return parser.parse_args(["-h"])
|
return parser.parse_args(["-h"])
|
||||||
|
|
||||||
|
def get_sshexec():
|
||||||
|
print(f"[ssh] login to {args.config.mail_domain}")
|
||||||
|
return SSHExec(args.config.mail_domain, verbose=args.verbose)
|
||||||
|
|
||||||
|
args.get_sshexec = get_sshexec
|
||||||
|
|
||||||
out = Out()
|
out = Out()
|
||||||
kwargs = {}
|
kwargs = {}
|
||||||
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
if args.func.__name__ not in ("init_cmd", "fmt_cmd"):
|
||||||
|
|||||||
19
cmdeploy/src/cmdeploy/deploy.py
Normal file
19
cmdeploy/src/cmdeploy/deploy.py
Normal file
@@ -0,0 +1,19 @@
|
|||||||
|
import importlib.resources
|
||||||
|
import os
|
||||||
|
|
||||||
|
import pyinfra
|
||||||
|
|
||||||
|
from cmdeploy import deploy_chatmail
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
|
config_path = os.getenv(
|
||||||
|
"CHATMAIL_INI",
|
||||||
|
importlib.resources.files("cmdeploy").joinpath("../../../chatmail.ini"),
|
||||||
|
)
|
||||||
|
|
||||||
|
deploy_chatmail(config_path)
|
||||||
|
|
||||||
|
|
||||||
|
if pyinfra.is_cli:
|
||||||
|
main()
|
||||||
@@ -1,652 +0,0 @@
|
|||||||
"""
|
|
||||||
Chat Mail pyinfra deploy.
|
|
||||||
"""
|
|
||||||
|
|
||||||
import os
|
|
||||||
import shutil
|
|
||||||
import subprocess
|
|
||||||
import sys
|
|
||||||
from io import StringIO
|
|
||||||
from pathlib import Path
|
|
||||||
|
|
||||||
from chatmaild.config import read_config
|
|
||||||
from pyinfra import facts, host, logger
|
|
||||||
from pyinfra.api import FactBase
|
|
||||||
from pyinfra.facts import hardware
|
|
||||||
from pyinfra.facts.files import Sha256File
|
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
|
||||||
from pyinfra.operations import apt, files, pip, server, systemd
|
|
||||||
|
|
||||||
from cmdeploy.cmdeploy import Out
|
|
||||||
|
|
||||||
from .acmetool import AcmetoolDeployer
|
|
||||||
from .basedeploy import (
|
|
||||||
Deployer,
|
|
||||||
Deployment,
|
|
||||||
activate_remote_units,
|
|
||||||
configure_remote_units,
|
|
||||||
get_resource,
|
|
||||||
has_systemd,
|
|
||||||
)
|
|
||||||
from .dovecot.deployer import DovecotDeployer
|
|
||||||
from .external.deployer import ExternalTlsDeployer
|
|
||||||
from .filtermail.deployer import FiltermailDeployer
|
|
||||||
from .mtail.deployer import MtailDeployer
|
|
||||||
from .nginx.deployer import NginxDeployer
|
|
||||||
from .opendkim.deployer import OpendkimDeployer
|
|
||||||
from .postfix.deployer import PostfixDeployer
|
|
||||||
from .selfsigned.deployer import SelfSignedTlsDeployer
|
|
||||||
from .www import build_webpages, find_merge_conflict, get_paths
|
|
||||||
|
|
||||||
|
|
||||||
class Port(FactBase):
|
|
||||||
"""
|
|
||||||
Returns the process occupying a port.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def command(self, port: int) -> str:
|
|
||||||
return (
|
|
||||||
"ss -lptn 'src :%d' | awk 'NR>1 {print $6,$7}' | sed 's/users:((\"//;s/\".*//'"
|
|
||||||
% (port,)
|
|
||||||
)
|
|
||||||
|
|
||||||
def process(self, output: [str]) -> str:
|
|
||||||
return output[0]
|
|
||||||
|
|
||||||
|
|
||||||
def _build_chatmaild(dist_dir) -> None:
|
|
||||||
dist_dir = Path(dist_dir).resolve()
|
|
||||||
if dist_dir.exists():
|
|
||||||
shutil.rmtree(dist_dir)
|
|
||||||
dist_dir.mkdir()
|
|
||||||
subprocess.check_output(
|
|
||||||
[sys.executable, "-m", "build", "-n"]
|
|
||||||
+ ["--sdist", "chatmaild", "--outdir", str(dist_dir)]
|
|
||||||
)
|
|
||||||
entries = list(dist_dir.iterdir())
|
|
||||||
assert len(entries) == 1
|
|
||||||
return entries[0]
|
|
||||||
|
|
||||||
|
|
||||||
def remove_legacy_artifacts():
|
|
||||||
if not has_systemd():
|
|
||||||
return
|
|
||||||
# disable legacy doveauth-dictproxy.service
|
|
||||||
if host.get_fact(SystemdEnabled).get("doveauth-dictproxy.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Disable legacy doveauth-dictproxy.service",
|
|
||||||
service="doveauth-dictproxy.service",
|
|
||||||
running=False,
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _install_remote_venv_with_chatmaild() -> None:
|
|
||||||
remove_legacy_artifacts()
|
|
||||||
dist_file = _build_chatmaild(dist_dir=Path("chatmaild/dist"))
|
|
||||||
remote_base_dir = "/usr/local/lib/chatmaild"
|
|
||||||
remote_dist_file = f"{remote_base_dir}/dist/{dist_file.name}"
|
|
||||||
remote_venv_dir = f"{remote_base_dir}/venv"
|
|
||||||
root_owned = dict(user="root", group="root", mode="644")
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="apt install python3-virtualenv",
|
|
||||||
packages=["python3-virtualenv"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="Upload chatmaild source package",
|
|
||||||
src=dist_file.open("rb"),
|
|
||||||
dest=remote_dist_file,
|
|
||||||
create_remote_dir=True,
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
pip.virtualenv(
|
|
||||||
name=f"chatmaild virtualenv {remote_venv_dir}",
|
|
||||||
path=remote_venv_dir,
|
|
||||||
always_copy=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="install gcc and headers to build crypt_r source package",
|
|
||||||
packages=["gcc", "python3-dev"],
|
|
||||||
)
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name=f"forced pip-install {dist_file.name}",
|
|
||||||
commands=[
|
|
||||||
f"{remote_venv_dir}/bin/pip install --force-reinstall {remote_dist_file}"
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_remote_venv_with_chatmaild(config) -> None:
|
|
||||||
remote_base_dir = "/usr/local/lib/chatmaild"
|
|
||||||
remote_venv_dir = f"{remote_base_dir}/venv"
|
|
||||||
remote_chatmail_inipath = f"{remote_base_dir}/chatmail.ini"
|
|
||||||
root_owned = dict(user="root", group="root", mode="644")
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name=f"Upload {remote_chatmail_inipath}",
|
|
||||||
src=config._getbytefile(),
|
|
||||||
dest=remote_chatmail_inipath,
|
|
||||||
**root_owned,
|
|
||||||
)
|
|
||||||
|
|
||||||
files.template(
|
|
||||||
src=get_resource("metrics.cron.j2"),
|
|
||||||
dest="/etc/cron.d/chatmail-metrics",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={
|
|
||||||
"mailboxes_dir": config.mailboxes_dir,
|
|
||||||
"execpath": f"{remote_venv_dir}/bin/chatmail-metrics",
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class UnboundDeployer(Deployer):
|
|
||||||
def __init__(self, config):
|
|
||||||
self.config = config
|
|
||||||
self.need_restart = False
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
# Run local DNS resolver `unbound`.
|
|
||||||
# `resolvconf` takes care of setting up /etc/resolv.conf
|
|
||||||
# to use 127.0.0.1 as the resolver.
|
|
||||||
|
|
||||||
#
|
|
||||||
# On an IPv4-only system, if unbound is started but not
|
|
||||||
# configured, it causes subsequent steps to fail to resolve hosts.
|
|
||||||
# Here, we use policy-rc.d to prevent unbound from starting up
|
|
||||||
# on initial install. Later, we will configure it and start it.
|
|
||||||
#
|
|
||||||
# For documentation about policy-rc.d, see:
|
|
||||||
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
|
|
||||||
#
|
|
||||||
files.put(
|
|
||||||
src=get_resource("policy-rc.d"),
|
|
||||||
dest="/usr/sbin/policy-rc.d",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install unbound",
|
|
||||||
packages=["unbound", "unbound-anchor", "dnsutils"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.file("/usr/sbin/policy-rc.d", present=False)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
server.shell(
|
|
||||||
name="Generate root keys for validating DNSSEC",
|
|
||||||
commands=[
|
|
||||||
"unbound-anchor -a /var/lib/unbound/root.key || true",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
if self.config.disable_ipv6:
|
|
||||||
files.directory(
|
|
||||||
path="/etc/unbound/unbound.conf.d",
|
|
||||||
present=True,
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
conf = files.put(
|
|
||||||
src=get_resource("unbound/unbound.conf.j2"),
|
|
||||||
dest="/etc/unbound/unbound.conf.d/chatmail.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
conf = files.file(
|
|
||||||
path="/etc/unbound/unbound.conf.d/chatmail.conf",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
self.need_restart |= conf.changed
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
server.shell(
|
|
||||||
name="Generate root keys for validating DNSSEC",
|
|
||||||
commands=[
|
|
||||||
"systemctl reset-failed unbound.service",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable unbound",
|
|
||||||
service="unbound.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class MtastsDeployer(Deployer):
|
|
||||||
def configure(self):
|
|
||||||
# Remove configuration.
|
|
||||||
files.file("/etc/mta-sts-daemon.yml", present=False)
|
|
||||||
files.directory("/usr/local/lib/postfix-mta-sts-resolver", present=False)
|
|
||||||
files.file("/etc/systemd/system/mta-sts-daemon.service", present=False)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Stop MTA-STS daemon",
|
|
||||||
service="mta-sts-daemon.service",
|
|
||||||
daemon_reload=True,
|
|
||||||
running=False,
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class WebsiteDeployer(Deployer):
|
|
||||||
def __init__(self, config):
|
|
||||||
self.config = config
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
files.directory(
|
|
||||||
name="Ensure /var/www exists",
|
|
||||||
path="/var/www",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
www_path, src_dir, build_dir = get_paths(self.config)
|
|
||||||
# if www_folder was set to a non-existing folder, skip upload
|
|
||||||
if not www_path.is_dir():
|
|
||||||
logger.warning("Building web pages is disabled in chatmail.ini, skipping")
|
|
||||||
elif (path := find_merge_conflict(src_dir)) is not None:
|
|
||||||
logger.warning(
|
|
||||||
f"Merge conflict found in {path}, skipping website deployment. Fix merge conflict if you want to upload your web page."
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
# if www_folder is a hugo page, build it
|
|
||||||
if build_dir:
|
|
||||||
www_path = build_webpages(src_dir, build_dir, self.config)
|
|
||||||
# if it is not a hugo page, upload it as is
|
|
||||||
files.rsync(
|
|
||||||
f"{www_path}/", "/var/www/html", flags=["-avz", "--chown=www-data"]
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class LegacyRemoveDeployer(Deployer):
|
|
||||||
def install(self):
|
|
||||||
apt.packages(name="Remove rspamd", packages="rspamd", present=False)
|
|
||||||
|
|
||||||
# remove historic expunge script
|
|
||||||
# which is now implemented through a systemd timer (chatmail-expire)
|
|
||||||
files.file(
|
|
||||||
path="/etc/cron.d/expunge",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
# Remove OBS repository key that is no longer used.
|
|
||||||
files.file("/etc/apt/keyrings/obs-home-deltachat.gpg", present=False)
|
|
||||||
files.line(
|
|
||||||
name="Remove DeltaChat OBS home repository from sources.list",
|
|
||||||
path="/etc/apt/sources.list",
|
|
||||||
line="deb [signed-by=/etc/apt/keyrings/obs-home-deltachat.gpg] https://download.opensuse.org/repositories/home:/deltachat/Debian_12/ ./",
|
|
||||||
escape_regex_characters=True,
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
# prior relay versions used filelogging
|
|
||||||
files.directory(
|
|
||||||
name="Ensure old logs on disk are deleted",
|
|
||||||
path="/var/log/journal/",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
# remove echobot if it is still running
|
|
||||||
if has_systemd() and host.get_fact(SystemdEnabled).get("echobot.service"):
|
|
||||||
systemd.service(
|
|
||||||
name="Disable echobot.service",
|
|
||||||
service="echobot.service",
|
|
||||||
running=False,
|
|
||||||
enabled=False,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def check_config(config):
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
if mail_domain != "testrun.org" and not mail_domain.endswith(".testrun.org"):
|
|
||||||
blocked_words = "merlinux schmieder testrun.org".split()
|
|
||||||
for key in config.__dict__:
|
|
||||||
value = config.__dict__[key]
|
|
||||||
if key.startswith("privacy") and any(
|
|
||||||
x in str(value) for x in blocked_words
|
|
||||||
):
|
|
||||||
raise ValueError(
|
|
||||||
f"please set your own privacy contacts/addresses in {config._inipath}"
|
|
||||||
)
|
|
||||||
return config
|
|
||||||
|
|
||||||
|
|
||||||
class TurnDeployer(Deployer):
|
|
||||||
def __init__(self, mail_domain):
|
|
||||||
self.mail_domain = mail_domain
|
|
||||||
self.units = ["turnserver"]
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
(url, sha256sum) = {
|
|
||||||
"x86_64": (
|
|
||||||
"https://github.com/chatmail/chatmail-turn/releases/download/v0.3/chatmail-turn-x86_64-linux",
|
|
||||||
"841e527c15fdc2940b0469e206188ea8f0af48533be12ecb8098520f813d41e4",
|
|
||||||
),
|
|
||||||
"aarch64": (
|
|
||||||
"https://github.com/chatmail/chatmail-turn/releases/download/v0.3/chatmail-turn-aarch64-linux",
|
|
||||||
"a5fc2d06d937b56a34e098d2cd72a82d3e89967518d159bf246dc69b65e81b42",
|
|
||||||
),
|
|
||||||
}[host.get_fact(facts.server.Arch)]
|
|
||||||
|
|
||||||
existing_sha256sum = host.get_fact(Sha256File, "/usr/local/bin/chatmail-turn")
|
|
||||||
if existing_sha256sum != sha256sum:
|
|
||||||
server.shell(
|
|
||||||
name="Download chatmail-turn",
|
|
||||||
commands=[
|
|
||||||
f"(curl -L {url} >/usr/local/bin/chatmail-turn.new && (echo '{sha256sum} /usr/local/bin/chatmail-turn.new' | sha256sum -c) && mv /usr/local/bin/chatmail-turn.new /usr/local/bin/chatmail-turn)",
|
|
||||||
"chmod 755 /usr/local/bin/chatmail-turn",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
configure_remote_units(self.mail_domain, self.units)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
activate_remote_units(self.units)
|
|
||||||
|
|
||||||
|
|
||||||
class IrohDeployer(Deployer):
|
|
||||||
def __init__(self, enable_iroh_relay):
|
|
||||||
self.enable_iroh_relay = enable_iroh_relay
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
(url, sha256sum) = {
|
|
||||||
"x86_64": (
|
|
||||||
"https://github.com/n0-computer/iroh/releases/download/v0.35.0/iroh-relay-v0.35.0-x86_64-unknown-linux-musl.tar.gz",
|
|
||||||
"45c81199dbd70f8c4c30fef7f3b9727ca6e3cea8f2831333eeaf8aa71bf0fac1",
|
|
||||||
),
|
|
||||||
"aarch64": (
|
|
||||||
"https://github.com/n0-computer/iroh/releases/download/v0.35.0/iroh-relay-v0.35.0-aarch64-unknown-linux-musl.tar.gz",
|
|
||||||
"f8ef27631fac213b3ef668d02acd5b3e215292746a3fc71d90c63115446008b1",
|
|
||||||
),
|
|
||||||
}[host.get_fact(facts.server.Arch)]
|
|
||||||
|
|
||||||
existing_sha256sum = host.get_fact(Sha256File, "/usr/local/bin/iroh-relay")
|
|
||||||
if existing_sha256sum != sha256sum:
|
|
||||||
server.shell(
|
|
||||||
name="Download iroh-relay",
|
|
||||||
commands=[
|
|
||||||
f"(curl -L {url} | gunzip | tar -x -f - ./iroh-relay -O >/usr/local/bin/iroh-relay.new && (echo '{sha256sum} /usr/local/bin/iroh-relay.new' | sha256sum -c) && mv /usr/local/bin/iroh-relay.new /usr/local/bin/iroh-relay)",
|
|
||||||
"chmod 755 /usr/local/bin/iroh-relay",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
self.need_restart = True
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
systemd_unit = files.put(
|
|
||||||
name="Upload iroh-relay systemd unit",
|
|
||||||
src=get_resource("iroh-relay.service"),
|
|
||||||
dest="/etc/systemd/system/iroh-relay.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart |= systemd_unit.changed
|
|
||||||
|
|
||||||
iroh_config = files.put(
|
|
||||||
name="Upload iroh-relay config",
|
|
||||||
src=get_resource("iroh-relay.toml"),
|
|
||||||
dest="/etc/iroh-relay.toml",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart |= iroh_config.changed
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable iroh-relay",
|
|
||||||
service="iroh-relay.service",
|
|
||||||
running=True,
|
|
||||||
enabled=self.enable_iroh_relay,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
|
|
||||||
|
|
||||||
class JournaldDeployer(Deployer):
|
|
||||||
def configure(self):
|
|
||||||
journald_conf = files.put(
|
|
||||||
name="Configure journald",
|
|
||||||
src=get_resource("journald.conf"),
|
|
||||||
dest="/etc/systemd/journald.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart = journald_conf.changed
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable journald",
|
|
||||||
service="systemd-journald.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
|
|
||||||
|
|
||||||
class ChatmailVenvDeployer(Deployer):
|
|
||||||
def __init__(self, config):
|
|
||||||
self.config = config
|
|
||||||
self.units = (
|
|
||||||
"chatmail-metadata",
|
|
||||||
"lastlogin",
|
|
||||||
"chatmail-expire",
|
|
||||||
"chatmail-expire.timer",
|
|
||||||
"chatmail-fsreport",
|
|
||||||
"chatmail-fsreport.timer",
|
|
||||||
)
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
_install_remote_venv_with_chatmaild()
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
_configure_remote_venv_with_chatmaild(self.config)
|
|
||||||
configure_remote_units(self.config.mail_domain, self.units)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
activate_remote_units(self.units)
|
|
||||||
|
|
||||||
|
|
||||||
class ChatmailDeployer(Deployer):
|
|
||||||
required_users = [
|
|
||||||
("vmail", "vmail", None),
|
|
||||||
("iroh", None, None),
|
|
||||||
]
|
|
||||||
|
|
||||||
def __init__(self, mail_domain):
|
|
||||||
self.mail_domain = mail_domain
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
apt.update(name="apt update", cache_time=24 * 3600)
|
|
||||||
apt.upgrade(name="upgrade apt packages", auto_remove=True)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install curl",
|
|
||||||
packages=["curl"],
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install rsync",
|
|
||||||
packages=["rsync"],
|
|
||||||
)
|
|
||||||
apt.packages(
|
|
||||||
name="Ensure cron is installed",
|
|
||||||
packages=["cron"],
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
# This file is used by auth proxy.
|
|
||||||
# https://wiki.debian.org/EtcMailName
|
|
||||||
server.shell(
|
|
||||||
name="Setup /etc/mailname",
|
|
||||||
commands=[
|
|
||||||
f"echo {self.mail_domain} >/etc/mailname; chmod 644 /etc/mailname"
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class FcgiwrapDeployer(Deployer):
|
|
||||||
def install(self):
|
|
||||||
apt.packages(
|
|
||||||
name="Install fcgiwrap",
|
|
||||||
packages=["fcgiwrap"],
|
|
||||||
)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable fcgiwrap",
|
|
||||||
service="fcgiwrap.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class GithashDeployer(Deployer):
|
|
||||||
def activate(self):
|
|
||||||
try:
|
|
||||||
git_hash = subprocess.check_output(["git", "rev-parse", "HEAD"]).decode()
|
|
||||||
except Exception:
|
|
||||||
git_hash = "unknown\n"
|
|
||||||
try:
|
|
||||||
git_diff = subprocess.check_output(["git", "diff"]).decode()
|
|
||||||
except Exception:
|
|
||||||
git_diff = ""
|
|
||||||
files.put(
|
|
||||||
name="Upload chatmail relay git commit hash",
|
|
||||||
src=StringIO(git_hash + git_diff),
|
|
||||||
dest="/etc/chatmail-version",
|
|
||||||
mode="700",
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def get_tls_deployer(config, mail_domain):
|
|
||||||
"""Select the appropriate TLS deployer based on config."""
|
|
||||||
tls_domains = [mail_domain, f"mta-sts.{mail_domain}", f"www.{mail_domain}"]
|
|
||||||
|
|
||||||
if config.tls_cert_mode == "acme":
|
|
||||||
return AcmetoolDeployer(config.acme_email, tls_domains)
|
|
||||||
elif config.tls_cert_mode == "self":
|
|
||||||
return SelfSignedTlsDeployer(mail_domain)
|
|
||||||
elif config.tls_cert_mode == "external":
|
|
||||||
return ExternalTlsDeployer(config.tls_cert_path, config.tls_key_path)
|
|
||||||
else:
|
|
||||||
raise ValueError(f"Unknown tls_cert_mode: {config.tls_cert_mode}")
|
|
||||||
|
|
||||||
|
|
||||||
def deploy_chatmail(config_path: Path, disable_mail: bool, website_only: bool) -> None:
|
|
||||||
"""Deploy a chat-mail instance.
|
|
||||||
|
|
||||||
:param config_path: path to chatmail.ini
|
|
||||||
:param disable_mail: whether to disable postfix & dovecot
|
|
||||||
:param website_only: if True, only deploy the website
|
|
||||||
"""
|
|
||||||
config = read_config(config_path)
|
|
||||||
check_config(config)
|
|
||||||
mail_domain = config.mail_domain
|
|
||||||
|
|
||||||
if website_only:
|
|
||||||
Deployment().perform_stages([WebsiteDeployer(config)])
|
|
||||||
return
|
|
||||||
|
|
||||||
if host.get_fact(Port, port=53) != "unbound":
|
|
||||||
files.line(
|
|
||||||
name="Add 9.9.9.9 to resolv.conf",
|
|
||||||
path="/etc/resolv.conf",
|
|
||||||
# Guard against resolv.conf missing a trailing newline (SolusVM bug).
|
|
||||||
line="\nnameserver 9.9.9.9",
|
|
||||||
)
|
|
||||||
|
|
||||||
# Check if mtail_address interface is available (if configured)
|
|
||||||
if config.mtail_address and config.mtail_address not in ('127.0.0.1', '::1', 'localhost'):
|
|
||||||
ipv4_addrs = host.get_fact(hardware.Ipv4Addrs)
|
|
||||||
all_addresses = [addr for addrs in ipv4_addrs.values() for addr in addrs]
|
|
||||||
if config.mtail_address not in all_addresses:
|
|
||||||
Out().red(f"Deploy failed: mtail_address {config.mtail_address} is not available (VPN up?).\n")
|
|
||||||
exit(1)
|
|
||||||
|
|
||||||
if not os.environ.get("CHATMAIL_NOPORTCHECK"):
|
|
||||||
port_services = [
|
|
||||||
(["master", "smtpd"], 25),
|
|
||||||
("unbound", 53),
|
|
||||||
]
|
|
||||||
if config.tls_cert_mode == "acme":
|
|
||||||
port_services.append(("acmetool", 402))
|
|
||||||
port_services += [
|
|
||||||
(["imap-login", "dovecot"], 143),
|
|
||||||
# acmetool previously listened on port 80,
|
|
||||||
# so don't complain during upgrade that moved it to port 402
|
|
||||||
# and gave the port to nginx.
|
|
||||||
(["acmetool", "nginx"], 80),
|
|
||||||
("nginx", 443),
|
|
||||||
(["master", "smtpd"], 465),
|
|
||||||
(["master", "smtpd"], 587),
|
|
||||||
(["imap-login", "dovecot"], 993),
|
|
||||||
("iroh-relay", 3340),
|
|
||||||
("mtail", 3903),
|
|
||||||
("stats", 3904),
|
|
||||||
("nginx", 8443),
|
|
||||||
(["master", "smtpd"], config.postfix_reinject_port),
|
|
||||||
(["master", "smtpd"], config.postfix_reinject_port_incoming),
|
|
||||||
("filtermail", config.filtermail_smtp_port),
|
|
||||||
("filtermail", config.filtermail_smtp_port_incoming),
|
|
||||||
]
|
|
||||||
for service, port in port_services:
|
|
||||||
print(f"Checking if port {port} is available for {service}...")
|
|
||||||
running_service = host.get_fact(Port, port=port)
|
|
||||||
services = [service] if isinstance(service, str) else service
|
|
||||||
if running_service:
|
|
||||||
if running_service not in services:
|
|
||||||
Out().red(
|
|
||||||
f"Deploy failed: port {port} is occupied by: {running_service}"
|
|
||||||
)
|
|
||||||
exit(1)
|
|
||||||
|
|
||||||
tls_deployer = get_tls_deployer(config, mail_domain)
|
|
||||||
|
|
||||||
all_deployers = [
|
|
||||||
ChatmailDeployer(mail_domain),
|
|
||||||
LegacyRemoveDeployer(),
|
|
||||||
FiltermailDeployer(),
|
|
||||||
JournaldDeployer(),
|
|
||||||
UnboundDeployer(config),
|
|
||||||
TurnDeployer(mail_domain),
|
|
||||||
IrohDeployer(config.enable_iroh_relay),
|
|
||||||
tls_deployer,
|
|
||||||
WebsiteDeployer(config),
|
|
||||||
ChatmailVenvDeployer(config),
|
|
||||||
MtastsDeployer(),
|
|
||||||
OpendkimDeployer(mail_domain),
|
|
||||||
# Dovecot should be started before Postfix
|
|
||||||
# because it creates authentication socket
|
|
||||||
# required by Postfix.
|
|
||||||
DovecotDeployer(config, disable_mail),
|
|
||||||
PostfixDeployer(config, disable_mail),
|
|
||||||
FcgiwrapDeployer(),
|
|
||||||
NginxDeployer(config),
|
|
||||||
MtailDeployer(config.mtail_address),
|
|
||||||
GithashDeployer(),
|
|
||||||
]
|
|
||||||
|
|
||||||
Deployment().perform_stages(all_deployers)
|
|
||||||
@@ -12,14 +12,14 @@ def get_initial_remote_data(sshexec, mail_domain):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def check_initial_remote_data(remote_data, *, strict_tls=True, print=print):
|
def check_initial_remote_data(remote_data, print=print):
|
||||||
mail_domain = remote_data["mail_domain"]
|
mail_domain = remote_data["mail_domain"]
|
||||||
if not remote_data["A"] and not remote_data["AAAA"]:
|
if not remote_data["A"] and not remote_data["AAAA"]:
|
||||||
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
print(f"Missing A and/or AAAA DNS records for {mail_domain}!")
|
||||||
elif strict_tls and remote_data["MTA_STS"] != f"{mail_domain}.":
|
elif remote_data["MTA_STS"] != f"{mail_domain}.":
|
||||||
print("Missing MTA-STS CNAME record:")
|
print("Missing MTA-STS CNAME record:")
|
||||||
print(f"mta-sts.{mail_domain}. CNAME {mail_domain}.")
|
print(f"mta-sts.{mail_domain}. CNAME {mail_domain}.")
|
||||||
elif strict_tls and remote_data["WWW"] != f"{mail_domain}.":
|
elif remote_data["WWW"] != f"{mail_domain}.":
|
||||||
print("Missing www CNAME record:")
|
print("Missing www CNAME record:")
|
||||||
print(f"www.{mail_domain}. CNAME {mail_domain}.")
|
print(f"www.{mail_domain}. CNAME {mail_domain}.")
|
||||||
else:
|
else:
|
||||||
@@ -29,7 +29,7 @@ def check_initial_remote_data(remote_data, *, strict_tls=True, print=print):
|
|||||||
def get_filled_zone_file(remote_data):
|
def get_filled_zone_file(remote_data):
|
||||||
sts_id = remote_data.get("sts_id")
|
sts_id = remote_data.get("sts_id")
|
||||||
if not sts_id:
|
if not sts_id:
|
||||||
remote_data["sts_id"] = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
sts_id = datetime.datetime.now().strftime("%Y%m%d%H%M")
|
||||||
|
|
||||||
template = importlib.resources.files(__package__).joinpath("chatmail.zone.j2")
|
template = importlib.resources.files(__package__).joinpath("chatmail.zone.j2")
|
||||||
content = template.read_text()
|
content = template.read_text()
|
||||||
@@ -46,26 +46,19 @@ def check_full_zone(sshexec, remote_data, out, zonefile) -> int:
|
|||||||
|
|
||||||
required_diff, recommended_diff = sshexec.logged(
|
required_diff, recommended_diff = sshexec.logged(
|
||||||
remote.rdns.check_zonefile,
|
remote.rdns.check_zonefile,
|
||||||
kwargs=dict(zonefile=zonefile, verbose=False),
|
kwargs=dict(zonefile=zonefile, mail_domain=remote_data["mail_domain"]),
|
||||||
)
|
)
|
||||||
|
|
||||||
returncode = 0
|
|
||||||
if required_diff:
|
if required_diff:
|
||||||
out.red("Please set required DNS entries at your DNS provider:\n")
|
out.red("Please set required DNS entries at your DNS provider:\n")
|
||||||
for line in required_diff:
|
for line in required_diff:
|
||||||
out(line)
|
out(line)
|
||||||
out("")
|
return 1
|
||||||
returncode = 1
|
elif recommended_diff:
|
||||||
if remote_data.get("dkim_entry") in required_diff:
|
|
||||||
out(
|
|
||||||
"If the DKIM entry above does not work with your DNS provider, you can try this one:\n"
|
|
||||||
)
|
|
||||||
out(remote_data.get("web_dkim_entry") + "\n")
|
|
||||||
if recommended_diff:
|
|
||||||
out("WARNING: these recommended DNS entries are not set:\n")
|
out("WARNING: these recommended DNS entries are not set:\n")
|
||||||
for line in recommended_diff:
|
for line in recommended_diff:
|
||||||
out(line)
|
out(line)
|
||||||
|
return 0
|
||||||
|
|
||||||
if not (recommended_diff or required_diff):
|
out.green("Great! All your DNS entries are verified and correct.")
|
||||||
out.green("Great! All your DNS entries are verified and correct.")
|
return 0
|
||||||
return returncode
|
|
||||||
|
|||||||
@@ -4,7 +4,7 @@ iterate_prefix = userdb/
|
|||||||
|
|
||||||
default_pass_scheme = plain
|
default_pass_scheme = plain
|
||||||
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
# %E escapes characters " (double quote), ' (single quote) and \ (backslash) with \ (backslash).
|
||||||
# See <https://doc.dovecot.org/2.3/configuration_manual/config_file/config_variables/#modifiers>
|
# See <https://doc.dovecot.org/configuration_manual/config_file/config_variables/#modifiers>
|
||||||
# for documentation.
|
# for documentation.
|
||||||
#
|
#
|
||||||
# We escape user-provided input and use double quote as a separator.
|
# We escape user-provided input and use double quote as a separator.
|
||||||
|
|||||||
@@ -1,170 +0,0 @@
|
|||||||
import os
|
|
||||||
import urllib.request
|
|
||||||
|
|
||||||
from chatmaild.config import Config
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.server import Arch, Sysctl
|
|
||||||
from pyinfra.facts.systemd import SystemdEnabled
|
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import (
|
|
||||||
Deployer,
|
|
||||||
activate_remote_units,
|
|
||||||
configure_remote_units,
|
|
||||||
get_resource,
|
|
||||||
has_systemd,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class DovecotDeployer(Deployer):
|
|
||||||
daemon_reload = False
|
|
||||||
|
|
||||||
def __init__(self, config, disable_mail):
|
|
||||||
self.config = config
|
|
||||||
self.disable_mail = disable_mail
|
|
||||||
self.units = ["doveauth"]
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
arch = host.get_fact(Arch)
|
|
||||||
if has_systemd() and "dovecot.service" in host.get_fact(SystemdEnabled):
|
|
||||||
return # already installed and running
|
|
||||||
_install_dovecot_package("core", arch)
|
|
||||||
_install_dovecot_package("imapd", arch)
|
|
||||||
_install_dovecot_package("lmtpd", arch)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
configure_remote_units(self.config.mail_domain, self.units)
|
|
||||||
self.need_restart, self.daemon_reload = _configure_dovecot(self.config)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
activate_remote_units(self.units)
|
|
||||||
|
|
||||||
restart = False if self.disable_mail else self.need_restart
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="Disable dovecot for now" if self.disable_mail else "Start and enable Dovecot",
|
|
||||||
service="dovecot.service",
|
|
||||||
running=False if self.disable_mail else True,
|
|
||||||
enabled=False if self.disable_mail else True,
|
|
||||||
restarted=restart,
|
|
||||||
daemon_reload=self.daemon_reload,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
|
|
||||||
|
|
||||||
def _pick_url(primary, fallback):
|
|
||||||
try:
|
|
||||||
req = urllib.request.Request(primary, method="HEAD")
|
|
||||||
urllib.request.urlopen(req, timeout=10)
|
|
||||||
return primary
|
|
||||||
except Exception:
|
|
||||||
return fallback
|
|
||||||
|
|
||||||
|
|
||||||
def _install_dovecot_package(package: str, arch: str):
|
|
||||||
arch = "amd64" if arch == "x86_64" else arch
|
|
||||||
arch = "arm64" if arch == "aarch64" else arch
|
|
||||||
primary_url = f"https://download.delta.chat/dovecot/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
|
||||||
fallback_url = f"https://github.com/chatmail/dovecot/releases/download/upstream%2F2.3.21%2Bdfsg1/dovecot-{package}_2.3.21%2Bdfsg1-3_{arch}.deb"
|
|
||||||
url = _pick_url(primary_url, fallback_url)
|
|
||||||
deb_filename = "/root/" + url.split("/")[-1]
|
|
||||||
|
|
||||||
match (package, arch):
|
|
||||||
case ("core", "amd64"):
|
|
||||||
sha256 = "dd060706f52a306fa863d874717210b9fe10536c824afe1790eec247ded5b27d"
|
|
||||||
case ("core", "arm64"):
|
|
||||||
sha256 = "e7548e8a82929722e973629ecc40fcfa886894cef3db88f23535149e7f730dc9"
|
|
||||||
case ("imapd", "amd64"):
|
|
||||||
sha256 = "8d8dc6fc00bbb6cdb25d345844f41ce2f1c53f764b79a838eb2a03103eebfa86"
|
|
||||||
case ("imapd", "arm64"):
|
|
||||||
sha256 = "178fa877ddd5df9930e8308b518f4b07df10e759050725f8217a0c1fb3fd707f"
|
|
||||||
case ("lmtpd", "amd64"):
|
|
||||||
sha256 = "2f69ba5e35363de50962d42cccbfe4ed8495265044e244007d7ccddad77513ab"
|
|
||||||
case ("lmtpd", "arm64"):
|
|
||||||
sha256 = "89f52fb36524f5877a177dff4a713ba771fd3f91f22ed0af7238d495e143b38f"
|
|
||||||
case _:
|
|
||||||
apt.packages(packages=[f"dovecot-{package}"])
|
|
||||||
return
|
|
||||||
|
|
||||||
files.download(
|
|
||||||
name=f"Download dovecot-{package}",
|
|
||||||
src=url,
|
|
||||||
dest=deb_filename,
|
|
||||||
sha256sum=sha256,
|
|
||||||
cache_time=60 * 60 * 24 * 365 * 10, # never redownload the package
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.deb(name=f"Install dovecot-{package}", src=deb_filename)
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_dovecot(config: Config, debug: bool = False) -> (bool, bool):
|
|
||||||
"""Configures Dovecot IMAP server."""
|
|
||||||
need_restart = False
|
|
||||||
daemon_reload = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=get_resource("dovecot/dovecot.conf.j2"),
|
|
||||||
dest="/etc/dovecot/dovecot.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
debug=debug,
|
|
||||||
disable_ipv6=config.disable_ipv6,
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
auth_config = files.put(
|
|
||||||
src=get_resource("dovecot/auth.conf"),
|
|
||||||
dest="/etc/dovecot/auth.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= auth_config.changed
|
|
||||||
lua_push_notification_script = files.put(
|
|
||||||
src=get_resource("dovecot/push_notification.lua"),
|
|
||||||
dest="/etc/dovecot/push_notification.lua",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= lua_push_notification_script.changed
|
|
||||||
|
|
||||||
# as per https://doc.dovecot.org/2.3/configuration_manual/os/
|
|
||||||
# it is recommended to set the following inotify limits
|
|
||||||
if not os.environ.get("CHATMAIL_NOSYSCTL"):
|
|
||||||
for name in ("max_user_instances", "max_user_watches"):
|
|
||||||
key = f"fs.inotify.{name}"
|
|
||||||
if host.get_fact(Sysctl)[key] > 65535:
|
|
||||||
# Skip updating limits if already sufficient
|
|
||||||
# (enables running in incus containers where sysctl readonly)
|
|
||||||
continue
|
|
||||||
server.sysctl(
|
|
||||||
name=f"Change {key}",
|
|
||||||
key=key,
|
|
||||||
value=65535,
|
|
||||||
persist=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
timezone_env = files.line(
|
|
||||||
name="Set TZ environment variable",
|
|
||||||
path="/etc/environment",
|
|
||||||
line="TZ=:/etc/localtime",
|
|
||||||
)
|
|
||||||
need_restart |= timezone_env.changed
|
|
||||||
|
|
||||||
restart_conf = files.put(
|
|
||||||
name="dovecot: restart automatically on failure",
|
|
||||||
src=get_resource("service/10_restart.conf"),
|
|
||||||
dest="/etc/systemd/system/dovecot.service.d/10_restart.conf",
|
|
||||||
)
|
|
||||||
daemon_reload |= restart_conf.changed
|
|
||||||
|
|
||||||
# Validate dovecot configuration before restart
|
|
||||||
if need_restart:
|
|
||||||
server.shell(
|
|
||||||
name="Validate dovecot configuration",
|
|
||||||
commands=["doveconf -n >/dev/null"],
|
|
||||||
)
|
|
||||||
|
|
||||||
return need_restart, daemon_reload
|
|
||||||
@@ -1,7 +1,7 @@
|
|||||||
## Dovecot configuration file
|
## Dovecot configuration file
|
||||||
|
|
||||||
{% if disable_ipv6 %}
|
{% if disable_ipv6 %}
|
||||||
listen = 0.0.0.0
|
listen = *
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
protocols = imap lmtp
|
protocols = imap lmtp
|
||||||
@@ -26,7 +26,7 @@ default_client_limit = 20000
|
|||||||
# Increase number of logged in IMAP connections.
|
# Increase number of logged in IMAP connections.
|
||||||
# Each connection is handled by a separate `imap` process.
|
# Each connection is handled by a separate `imap` process.
|
||||||
# `imap` process should have `client_limit=1` as described in
|
# `imap` process should have `client_limit=1` as described in
|
||||||
# <https://doc.dovecot.org/2.3/configuration_manual/service_configuration/#service-limits>
|
# <https://doc.dovecot.org/configuration_manual/service_configuration/#service-limits>
|
||||||
# so each logged in IMAP session will need its own `imap` process.
|
# so each logged in IMAP session will need its own `imap` process.
|
||||||
#
|
#
|
||||||
# If this limit is reached,
|
# If this limit is reached,
|
||||||
@@ -44,11 +44,11 @@ mail_server_comment = Chatmail server
|
|||||||
|
|
||||||
# `zlib` enables compressing messages stored in the maildir.
|
# `zlib` enables compressing messages stored in the maildir.
|
||||||
# See
|
# See
|
||||||
# <https://doc.dovecot.org/2.3/configuration_manual/zlib_plugin/>
|
# <https://doc.dovecot.org/configuration_manual/zlib_plugin/>
|
||||||
# for documentation.
|
# for documentation.
|
||||||
#
|
#
|
||||||
# quota plugin documentation:
|
# quota plugin documentation:
|
||||||
# <https://doc.dovecot.org/2.3/configuration_manual/quota_plugin/>
|
# <https://doc.dovecot.org/configuration_manual/quota_plugin/>
|
||||||
mail_plugins = zlib quota
|
mail_plugins = zlib quota
|
||||||
|
|
||||||
imap_capability = +XDELTAPUSH XCHATMAIL
|
imap_capability = +XDELTAPUSH XCHATMAIL
|
||||||
@@ -70,12 +70,6 @@ userdb {
|
|||||||
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
# Mailboxes are stored in the "mail" directory of the vmail user home.
|
||||||
mail_location = maildir:{{ config.mailboxes_dir }}/%u
|
mail_location = maildir:{{ config.mailboxes_dir }}/%u
|
||||||
|
|
||||||
# index/cache files are not very useful for chatmail relay operations
|
|
||||||
# but it's not clear how to disable them completely.
|
|
||||||
# According to https://doc.dovecot.org/2.3/settings/advanced/#core_setting-mail_cache_max_size
|
|
||||||
# if the cache file becomes larger than the specified size, it is truncated by dovecot
|
|
||||||
mail_cache_max_size = 500K
|
|
||||||
|
|
||||||
namespace inbox {
|
namespace inbox {
|
||||||
inbox = yes
|
inbox = yes
|
||||||
|
|
||||||
@@ -113,7 +107,7 @@ mail_attribute_dict = proxy:/run/chatmail-metadata/metadata.socket:metadata
|
|||||||
# `imap_zlib` enables IMAP COMPRESS (RFC 4978).
|
# `imap_zlib` enables IMAP COMPRESS (RFC 4978).
|
||||||
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
# <https://datatracker.ietf.org/doc/html/rfc4978.html>
|
||||||
protocol imap {
|
protocol imap {
|
||||||
mail_plugins = $mail_plugins imap_quota last_login {% if config.imap_compress %}imap_zlib{% endif %}
|
mail_plugins = $mail_plugins imap_zlib imap_quota last_login
|
||||||
imap_metadata = yes
|
imap_metadata = yes
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -125,13 +119,13 @@ plugin {
|
|||||||
|
|
||||||
protocol lmtp {
|
protocol lmtp {
|
||||||
# notify plugin is a dependency of push_notification plugin:
|
# notify plugin is a dependency of push_notification plugin:
|
||||||
# <https://doc.dovecot.org/2.3/settings/plugin/notify-plugin/>
|
# <https://doc.dovecot.org/settings/plugin/notify-plugin/>
|
||||||
#
|
#
|
||||||
# push_notification plugin documentation:
|
# push_notification plugin documentation:
|
||||||
# <https://doc.dovecot.org/2.3/configuration_manual/push_notification/>
|
# <https://doc.dovecot.org/configuration_manual/push_notification/>
|
||||||
#
|
#
|
||||||
# mail_lua and push_notification_lua are needed for Lua push notification handler.
|
# mail_lua and push_notification_lua are needed for Lua push notification handler.
|
||||||
# <https://doc.dovecot.org/2.3/configuration_manual/push_notification/#configuration>
|
# <https://doc.dovecot.org/configuration_manual/push_notification/#configuration>
|
||||||
mail_plugins = $mail_plugins mail_lua notify push_notification push_notification_lua
|
mail_plugins = $mail_plugins mail_lua notify push_notification push_notification_lua
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -147,14 +141,14 @@ plugin {
|
|||||||
# for now we define static quota-rules for all users
|
# for now we define static quota-rules for all users
|
||||||
quota = maildir:User quota
|
quota = maildir:User quota
|
||||||
quota_rule = *:storage={{ config.max_mailbox_size }}
|
quota_rule = *:storage={{ config.max_mailbox_size }}
|
||||||
quota_max_mail_size={{ config.max_message_size }}
|
quota_max_mail_size=30M
|
||||||
quota_grace = 0
|
quota_grace = 0
|
||||||
# quota_over_flag_value = TRUE
|
# quota_over_flag_value = TRUE
|
||||||
}
|
}
|
||||||
|
|
||||||
# push_notification configuration
|
# push_notification configuration
|
||||||
plugin {
|
plugin {
|
||||||
# <https://doc.dovecot.org/2.3/configuration_manual/push_notification/#lua-lua>
|
# <https://doc.dovecot.org/configuration_manual/push_notification/#lua-lua>
|
||||||
push_notification_driver = lua:file=/etc/dovecot/push_notification.lua
|
push_notification_driver = lua:file=/etc/dovecot/push_notification.lua
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -168,8 +162,6 @@ service lmtp {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
lmtp_add_received_header = no
|
|
||||||
|
|
||||||
service auth {
|
service auth {
|
||||||
unix_listener /var/spool/postfix/private/auth {
|
unix_listener /var/spool/postfix/private/auth {
|
||||||
mode = 0660
|
mode = 0660
|
||||||
@@ -185,53 +177,28 @@ service auth-worker {
|
|||||||
}
|
}
|
||||||
|
|
||||||
service imap-login {
|
service imap-login {
|
||||||
# High-performance mode as described in
|
# High-security mode.
|
||||||
# <https://doc.dovecot.org/2.3/admin_manual/login_processes/#high-performance-mode>
|
# Each process serves a single connection and exits afterwards.
|
||||||
#
|
# This is the default, but we set it explicitly to be sure.
|
||||||
# So-called high-security mode described in
|
# See <https://doc.dovecot.org/admin_manual/login_processes/#high-security-mode> for details.
|
||||||
# <https://doc.dovecot.org/2.3/admin_manual/login_processes/#high-security-mode>
|
service_count = 1
|
||||||
# and enabled by default with `service_count = 1` starts one process per connection
|
|
||||||
# and has problems logging in thousands of users after Dovecot restart.
|
|
||||||
service_count = 0
|
|
||||||
|
|
||||||
# Increase virtual memory size limit.
|
# Inrease the number of simultaneous connections.
|
||||||
# Since imap-login processes handle TLS connections
|
|
||||||
# even after logging users in
|
|
||||||
# and many connections are handled by each process,
|
|
||||||
# memory size limit should be increased.
|
|
||||||
#
|
#
|
||||||
# Otherwise the whole process eventually dies
|
# As of Dovecot 2.3.19.1 the default is 100 processes.
|
||||||
# with an error similar to
|
# Combined with `service_count = 1` it means only 100 connections
|
||||||
# imap-login: Fatal: master: service(imap-login):
|
# can be handled simultaneously.
|
||||||
# child 1422951 returned error 83
|
process_limit = 10000
|
||||||
# (Out of memory (service imap-login { vsz_limit=256 MB },
|
|
||||||
# you may need to increase it)
|
|
||||||
# and takes down all its TLS connections at once.
|
|
||||||
vsz_limit = 1G
|
|
||||||
|
|
||||||
# Avoid startup latency for new connections.
|
# Avoid startup latency for new connections.
|
||||||
#
|
|
||||||
# Should be set to at least the number of CPU cores
|
|
||||||
# according to the documentation.
|
|
||||||
process_min_avail = 10
|
process_min_avail = 10
|
||||||
}
|
}
|
||||||
|
|
||||||
service anvil {
|
|
||||||
# We are disabling anvil penalty on failed login attempts
|
|
||||||
# because it can only detect brute forcing by IP address
|
|
||||||
# not by username. As the correct IP address is not handed
|
|
||||||
# to dovecot anyway, it is more of hindrance than of use.
|
|
||||||
# See <https://www.dovecot.org/list/dovecot/2012-May/135485.html> for details.
|
|
||||||
unix_listener anvil-auth-penalty {
|
|
||||||
mode = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
ssl = required
|
ssl = required
|
||||||
ssl_cert = <{{ config.tls_cert_path }}
|
ssl_cert = </var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
ssl_key = <{{ config.tls_key_path }}
|
ssl_key = </var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
ssl_dh = </usr/share/dovecot/dh.pem
|
ssl_dh = </usr/share/dovecot/dh.pem
|
||||||
ssl_min_protocol = TLSv1.3
|
ssl_min_protocol = TLSv1.2
|
||||||
ssl_prefer_server_ciphers = yes
|
ssl_prefer_server_ciphers = yes
|
||||||
|
|
||||||
|
|
||||||
@@ -254,181 +221,3 @@ protocol imap {
|
|||||||
rawlog_dir = %h
|
rawlog_dir = %h
|
||||||
}
|
}
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if not config.imap_compress %}
|
|
||||||
# Hibernate IDLE users to save memory and CPU resources
|
|
||||||
# NOTE: this will have no effect if imap_zlib plugin is used
|
|
||||||
imap_hibernate_timeout = 30s
|
|
||||||
service imap {
|
|
||||||
# Note that this change will allow any process running as
|
|
||||||
# $default_internal_user (dovecot) to access mails as any other user.
|
|
||||||
# This may be insecure in some installations, which is why this isn't
|
|
||||||
# done by default.
|
|
||||||
unix_listener imap-master {
|
|
||||||
user = $default_internal_user
|
|
||||||
}
|
|
||||||
}
|
|
||||||
# The following is the default already in v2.3.1+:
|
|
||||||
service imap {
|
|
||||||
extra_groups = $default_internal_group
|
|
||||||
}
|
|
||||||
service imap-hibernate {
|
|
||||||
unix_listener imap-hibernate {
|
|
||||||
mode = 0660
|
|
||||||
group = $default_internal_group
|
|
||||||
}
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if config.mtail_address %}
|
|
||||||
#
|
|
||||||
# Dovecot Statistics
|
|
||||||
#
|
|
||||||
# OpenMetrics endpoint at http://{{- config.mtail_address}}:3904/metrics
|
|
||||||
service stats {
|
|
||||||
inet_listener http {
|
|
||||||
port = 3904
|
|
||||||
address = {{- config.mtail_address}}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
# IMAP Command Metrics
|
|
||||||
# - Bytes in/out for compression efficiency analysis
|
|
||||||
# - Lock wait time for contention debugging
|
|
||||||
# - Grouped by command name and reply state
|
|
||||||
metric imap_command {
|
|
||||||
filter = event=imap_command_finished
|
|
||||||
fields = bytes_in bytes_out lock_wait_usecs running_usecs
|
|
||||||
group_by = cmd_name tagged_reply_state
|
|
||||||
}
|
|
||||||
|
|
||||||
# Duration buckets for latency histograms (base 10: 10us, 100us, 1ms, 10ms, 100ms, 1s, 10s, 100s)
|
|
||||||
metric imap_command_duration {
|
|
||||||
filter = event=imap_command_finished
|
|
||||||
group_by = cmd_name duration:exponential:1:8:10
|
|
||||||
}
|
|
||||||
|
|
||||||
# Slow command outliers (>1 second = 1000000 usecs)
|
|
||||||
# Useful for alerting without high cardinality
|
|
||||||
metric imap_command_slow {
|
|
||||||
filter = event=imap_command_finished AND duration>1000000 AND NOT cmd_name=IDLE
|
|
||||||
group_by = cmd_name
|
|
||||||
}
|
|
||||||
|
|
||||||
# IDLE-specific Metrics
|
|
||||||
|
|
||||||
metric imap_idle {
|
|
||||||
filter = event=imap_command_finished AND cmd_name=IDLE
|
|
||||||
fields = bytes_in bytes_out running_usecs
|
|
||||||
group_by = tagged_reply_state
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_idle_duration {
|
|
||||||
filter = event=imap_command_finished AND cmd_name=IDLE
|
|
||||||
# Base 10: 100ms to 27h (covers short wakeups to long idle sessions)
|
|
||||||
group_by = duration:exponential:5:11:10
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_idle_commands {
|
|
||||||
filter = event=imap_command_finished AND cmd_name=IDLE
|
|
||||||
group_by = tagged_reply_state
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_idle_failed {
|
|
||||||
filter = event=imap_command_finished AND cmd_name=IDLE AND NOT tagged_reply_state=OK
|
|
||||||
}
|
|
||||||
|
|
||||||
# Hibernation Metrics (requires imap_hibernate_timeout)
|
|
||||||
|
|
||||||
metric imap_hibernated {
|
|
||||||
filter = event=imap_client_hibernated
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_hibernated_failed {
|
|
||||||
filter = event=imap_client_hibernated AND error=*
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_unhibernated {
|
|
||||||
filter = event=imap_client_unhibernated
|
|
||||||
fields = hibernation_usecs
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_unhibernated_reason {
|
|
||||||
filter = event=imap_client_unhibernated
|
|
||||||
group_by = reason
|
|
||||||
fields = hibernation_usecs
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_unhibernated_reason_sleep {
|
|
||||||
filter = event=imap_client_unhibernated
|
|
||||||
group_by = reason hibernation_usecs:exponential:4:8:10
|
|
||||||
}
|
|
||||||
|
|
||||||
metric imap_unhibernated_failed {
|
|
||||||
filter = event=imap_client_unhibernated AND error=*
|
|
||||||
}
|
|
||||||
|
|
||||||
# Hibernation duration buckets (how long clients stayed hibernated)
|
|
||||||
# Base 10: 100ms to 27h
|
|
||||||
metric imap_hibernation_duration {
|
|
||||||
filter = event=imap_client_unhibernated
|
|
||||||
group_by = reason duration:exponential:5:11:10
|
|
||||||
}
|
|
||||||
|
|
||||||
# Authentication / Login Metrics
|
|
||||||
|
|
||||||
metric auth_request {
|
|
||||||
filter = event=auth_request_finished
|
|
||||||
group_by = success
|
|
||||||
}
|
|
||||||
|
|
||||||
metric auth_request_duration {
|
|
||||||
filter = event=auth_request_finished
|
|
||||||
group_by = success duration:exponential:2:6:10
|
|
||||||
}
|
|
||||||
|
|
||||||
metric auth_failed {
|
|
||||||
filter = event=auth_request_finished AND success=no
|
|
||||||
}
|
|
||||||
|
|
||||||
# Passdb cache effectiveness
|
|
||||||
metric auth_passdb {
|
|
||||||
filter = event=auth_passdb_request_finished
|
|
||||||
group_by = result cache
|
|
||||||
}
|
|
||||||
|
|
||||||
# Master login (post-auth userdb lookup)
|
|
||||||
metric auth_master_login {
|
|
||||||
filter = event=auth_master_client_login_finished
|
|
||||||
}
|
|
||||||
|
|
||||||
metric auth_master_login_failed {
|
|
||||||
filter = event=auth_master_client_login_finished AND error=*
|
|
||||||
}
|
|
||||||
|
|
||||||
# Mail Delivery (LMTP) - affects IDLE wakeup latency
|
|
||||||
|
|
||||||
metric mail_delivery {
|
|
||||||
filter = event=mail_delivery_finished
|
|
||||||
}
|
|
||||||
|
|
||||||
metric mail_delivery_duration {
|
|
||||||
filter = event=mail_delivery_finished
|
|
||||||
group_by = duration:exponential:3:7:10
|
|
||||||
}
|
|
||||||
|
|
||||||
metric mail_delivery_failed {
|
|
||||||
filter = event=mail_delivery_finished AND error=*
|
|
||||||
}
|
|
||||||
|
|
||||||
# Connection Events
|
|
||||||
|
|
||||||
metric client_connected {
|
|
||||||
filter = event=client_connection_connected AND category="service:imap"
|
|
||||||
}
|
|
||||||
|
|
||||||
metric client_disconnected {
|
|
||||||
filter = event=client_connection_disconnected AND category="service:imap"
|
|
||||||
fields = bytes_in bytes_out
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
|
|||||||
12
cmdeploy/src/cmdeploy/dovecot/expunge.cron.j2
Normal file
12
cmdeploy/src/cmdeploy/dovecot/expunge.cron.j2
Normal file
@@ -0,0 +1,12 @@
|
|||||||
|
# delete all mails after {{ config.delete_mails_after }} days, in the Inbox
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# or in any IMAP subfolder
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/.*/cur/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# even if they are unseen
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/.*/new/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
# or only temporary (but then they shouldn't be around after {{ config.delete_mails_after }} days anyway).
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
2 0 * * * vmail find {{ config.mailboxes_dir }} -path '*/.*/tmp/*' -mtime +{{ config.delete_mails_after }} -type f -delete
|
||||||
|
3 0 * * * vmail find {{ config.mailboxes_dir }} -name 'maildirsize' -type f -delete
|
||||||
|
4 0 * * * vmail /usr/local/lib/chatmaild/venv/bin/delete_inactive_users /usr/local/lib/chatmaild/chatmail.ini
|
||||||
@@ -2,6 +2,15 @@ function dovecot_lua_notify_begin_txn(user)
|
|||||||
return user
|
return user
|
||||||
end
|
end
|
||||||
|
|
||||||
|
function contains(v, needle)
|
||||||
|
for _, keyword in ipairs(v) do
|
||||||
|
if keyword == needle then
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
end
|
||||||
|
return false
|
||||||
|
end
|
||||||
|
|
||||||
function dovecot_lua_notify_event_message_new(user, event)
|
function dovecot_lua_notify_event_message_new(user, event)
|
||||||
local mbox = user:mailbox(event.mailbox)
|
local mbox = user:mailbox(event.mailbox)
|
||||||
mbox:sync()
|
mbox:sync()
|
||||||
|
|||||||
67
cmdeploy/src/cmdeploy/external/deployer.py
vendored
67
cmdeploy/src/cmdeploy/external/deployer.py
vendored
@@ -1,67 +0,0 @@
|
|||||||
import io
|
|
||||||
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.files import File
|
|
||||||
from pyinfra.operations import files, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import Deployer, get_resource
|
|
||||||
|
|
||||||
|
|
||||||
class ExternalTlsDeployer(Deployer):
|
|
||||||
"""Expects TLS certificates to be managed on the server.
|
|
||||||
|
|
||||||
Validates that the configured certificate and key files
|
|
||||||
exist on the remote host. Installs a systemd path unit
|
|
||||||
that watches the certificate file and automatically
|
|
||||||
restarts/reloads affected services when it changes.
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, cert_path, key_path):
|
|
||||||
self.cert_path = cert_path
|
|
||||||
self.key_path = key_path
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
# Verify cert and key exist on the remote host using pyinfra facts.
|
|
||||||
for path in (self.cert_path, self.key_path):
|
|
||||||
info = host.get_fact(File, path=path)
|
|
||||||
if info is None:
|
|
||||||
raise Exception(f"External TLS file not found on server: {path}")
|
|
||||||
|
|
||||||
# Deploy the .path unit (templated with the cert path).
|
|
||||||
# pkg=__package__ is required here because the resource files
|
|
||||||
# live in cmdeploy.external, not the default cmdeploy package.
|
|
||||||
source = get_resource("tls-cert-reload.path.f", pkg=__package__)
|
|
||||||
content = source.read_text().format(cert_path=self.cert_path).encode()
|
|
||||||
|
|
||||||
path_unit = files.put(
|
|
||||||
name="Upload tls-cert-reload.path",
|
|
||||||
src=io.BytesIO(content),
|
|
||||||
dest="/etc/systemd/system/tls-cert-reload.path",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
service_unit = files.put(
|
|
||||||
name="Upload tls-cert-reload.service",
|
|
||||||
src=get_resource("tls-cert-reload.service", pkg=__package__),
|
|
||||||
dest="/etc/systemd/system/tls-cert-reload.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
|
|
||||||
if path_unit.changed or service_unit.changed:
|
|
||||||
self.need_restart = True
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Enable tls-cert-reload path watcher",
|
|
||||||
service="tls-cert-reload.path",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
daemon_reload=self.need_restart,
|
|
||||||
)
|
|
||||||
# No explicit reload needed here: dovecot/nginx read the cert
|
|
||||||
# on startup, and the .path watcher handles live changes.
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Watch the TLS certificate file for changes.
|
|
||||||
# When the cert is updated (e.g. renewed by an external process),
|
|
||||||
# this triggers tls-cert-reload.service to reload the affected services.
|
|
||||||
#
|
|
||||||
# NOTE: changes to the certificates are not detected if they cross bind-mount boundaries.
|
|
||||||
# After cert renewal, you must then trigger the reload explicitly:
|
|
||||||
# systemctl start tls-cert-reload.service
|
|
||||||
[Unit]
|
|
||||||
Description=Watch TLS certificate for changes
|
|
||||||
|
|
||||||
[Path]
|
|
||||||
PathChanged={cert_path}
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,15 +0,0 @@
|
|||||||
# Reload services that cache the TLS certificate.
|
|
||||||
#
|
|
||||||
# dovecot: caches the cert at startup; reload re-reads SSL certs
|
|
||||||
# without dropping existing connections.
|
|
||||||
# nginx: caches the cert at startup; reload gracefully picks up
|
|
||||||
# the new cert for new connections.
|
|
||||||
# postfix: reads the cert fresh on each TLS handshake,
|
|
||||||
# does NOT need a reload/restart.
|
|
||||||
[Unit]
|
|
||||||
Description=Reload TLS services after certificate change
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=oneshot
|
|
||||||
ExecStart=/bin/systemctl try-reload-or-restart dovecot
|
|
||||||
ExecStart=/bin/systemctl try-reload-or-restart nginx
|
|
||||||
@@ -1,52 +0,0 @@
|
|||||||
from pyinfra import facts, host
|
|
||||||
from pyinfra.operations import files, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import Deployer, get_resource
|
|
||||||
|
|
||||||
|
|
||||||
class FiltermailDeployer(Deployer):
|
|
||||||
services = ["filtermail", "filtermail-incoming"]
|
|
||||||
bin_path = "/usr/local/bin/filtermail"
|
|
||||||
config_path = "/usr/local/lib/chatmaild/chatmail.ini"
|
|
||||||
|
|
||||||
def __init__(self):
|
|
||||||
self.need_restart = False
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
arch = host.get_fact(facts.server.Arch)
|
|
||||||
url = f"https://github.com/chatmail/filtermail/releases/download/v0.5.2/filtermail-{arch}"
|
|
||||||
sha256sum = {
|
|
||||||
"x86_64": "ce24ca0075aa445510291d775fb3aea8f4411818c7b885ae51a0fe18c5f789ce",
|
|
||||||
"aarch64": "c5d783eefa5332db3d97a0e6a23917d72849e3eb45da3d16ce908a9b4e5a797d",
|
|
||||||
}[arch]
|
|
||||||
self.need_restart |= files.download(
|
|
||||||
name="Download filtermail",
|
|
||||||
src=url,
|
|
||||||
sha256sum=sha256sum,
|
|
||||||
dest=self.bin_path,
|
|
||||||
mode="755",
|
|
||||||
).changed
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
for service in self.services:
|
|
||||||
self.need_restart |= files.template(
|
|
||||||
src=get_resource(f"filtermail/{service}.service.j2"),
|
|
||||||
dest=f"/etc/systemd/system/{service}.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
bin_path=self.bin_path,
|
|
||||||
config_path=self.config_path,
|
|
||||||
).changed
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
for service in self.services:
|
|
||||||
systemd.service(
|
|
||||||
name=f"Start and enable {service}",
|
|
||||||
service=f"{service}.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
daemon_reload=True,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Incoming Chatmail Postfix before queue filter
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={{ bin_path }} {{ config_path }} incoming
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
User=vmail
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Outgoing Chatmail Postfix before queue filter
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart={{ bin_path }} {{ config_path }} outgoing
|
|
||||||
Restart=always
|
|
||||||
RestartSec=30
|
|
||||||
User=vmail
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=Iroh relay
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
ExecStart=/usr/local/bin/iroh-relay --config-path /etc/iroh-relay.toml
|
|
||||||
Restart=on-failure
|
|
||||||
RestartSec=5s
|
|
||||||
User=iroh
|
|
||||||
Group=iroh
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
enable_relay = true
|
|
||||||
http_bind_addr = "[::]:3340"
|
|
||||||
|
|
||||||
# Disable built-in STUN server in iroh-relay 0.35
|
|
||||||
# as we deploy our own TURN server instead.
|
|
||||||
# STUN server is going to be removed in iroh-relay 1.0
|
|
||||||
# and this line can be removed after upgrade.
|
|
||||||
enable_stun = false
|
|
||||||
|
|
||||||
enable_metrics = false
|
|
||||||
metrics_bind_addr = "127.0.0.1:9092"
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
counter delivered_mail
|
|
||||||
/saved mail to INBOX$/ {
|
|
||||||
delivered_mail++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter quota_exceeded
|
|
||||||
/Quota exceeded \(mailbox for user is full\)$/ {
|
|
||||||
quota_exceeded++
|
|
||||||
}
|
|
||||||
|
|
||||||
# Essentially the number of outgoing messages.
|
|
||||||
counter dkim_signed
|
|
||||||
/DKIM-Signature field added/ {
|
|
||||||
dkim_signed++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter created_accounts
|
|
||||||
counter created_ci_accounts
|
|
||||||
counter created_nonci_accounts
|
|
||||||
|
|
||||||
/: Created address: (?P<addr>.*)$/ {
|
|
||||||
created_accounts++
|
|
||||||
|
|
||||||
$addr =~ /ci-/ {
|
|
||||||
created_ci_accounts++
|
|
||||||
} else {
|
|
||||||
created_nonci_accounts++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
counter postfix_timeouts
|
|
||||||
/timeout after DATA/ {
|
|
||||||
postfix_timeouts++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter postfix_noqueue
|
|
||||||
/postfix\/.*NOQUEUE/ {
|
|
||||||
postfix_noqueue++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter warning_count
|
|
||||||
/warning/ {
|
|
||||||
warning_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
counter filtered_outgoing_mail_count
|
|
||||||
|
|
||||||
counter outgoing_encrypted_mail_count
|
|
||||||
/Outgoing: Filtering encrypted mail\./ {
|
|
||||||
outgoing_encrypted_mail_count++
|
|
||||||
filtered_outgoing_mail_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter outgoing_unencrypted_mail_count
|
|
||||||
/Outgoing: Filtering unencrypted mail\./ {
|
|
||||||
outgoing_unencrypted_mail_count++
|
|
||||||
filtered_outgoing_mail_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
counter filtered_incoming_mail_count
|
|
||||||
|
|
||||||
counter incoming_encrypted_mail_count
|
|
||||||
/Incoming: Filtering encrypted mail\./ {
|
|
||||||
incoming_encrypted_mail_count++
|
|
||||||
filtered_incoming_mail_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
counter incoming_unencrypted_mail_count
|
|
||||||
/Incoming: Filtering unencrypted mail\./ {
|
|
||||||
incoming_unencrypted_mail_count++
|
|
||||||
filtered_incoming_mail_count++
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
counter rejected_unencrypted_mail_count
|
|
||||||
/Rejected unencrypted mail/ {
|
|
||||||
rejected_unencrypted_mail_count++
|
|
||||||
}
|
|
||||||
@@ -1,68 +0,0 @@
|
|||||||
from pyinfra import facts, host
|
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import (
|
|
||||||
Deployer,
|
|
||||||
get_resource,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class MtailDeployer(Deployer):
|
|
||||||
def __init__(self, mtail_address):
|
|
||||||
self.mtail_address = mtail_address
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
# Uninstall mtail package to install a static binary.
|
|
||||||
apt.packages(name="Uninstall mtail", packages=["mtail"], present=False)
|
|
||||||
|
|
||||||
(url, sha256sum) = {
|
|
||||||
"x86_64": (
|
|
||||||
"https://github.com/google/mtail/releases/download/v3.0.8/mtail_3.0.8_linux_amd64.tar.gz",
|
|
||||||
"123c2ee5f48c3eff12ebccee38befd2233d715da736000ccde49e3d5607724e4",
|
|
||||||
),
|
|
||||||
"aarch64": (
|
|
||||||
"https://github.com/google/mtail/releases/download/v3.0.8/mtail_3.0.8_linux_arm64.tar.gz",
|
|
||||||
"aa04811c0929b6754408676de520e050c45dddeb3401881888a092c9aea89cae",
|
|
||||||
),
|
|
||||||
}[host.get_fact(facts.server.Arch)]
|
|
||||||
|
|
||||||
server.shell(
|
|
||||||
name="Download mtail",
|
|
||||||
commands=[
|
|
||||||
f"(echo '{sha256sum} /usr/local/bin/mtail' | sha256sum -c) || (curl -L {url} | gunzip | tar -x -f - mtail -O >/usr/local/bin/mtail.new && mv /usr/local/bin/mtail.new /usr/local/bin/mtail)",
|
|
||||||
"chmod 755 /usr/local/bin/mtail",
|
|
||||||
],
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
# Using our own systemd unit instead of `/usr/lib/systemd/system/mtail.service`.
|
|
||||||
# This allows to read from journalctl instead of log files.
|
|
||||||
files.template(
|
|
||||||
src=get_resource("mtail/mtail.service.j2"),
|
|
||||||
dest="/etc/systemd/system/mtail.service",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
address=self.mtail_address or "127.0.0.1",
|
|
||||||
port=3903,
|
|
||||||
)
|
|
||||||
|
|
||||||
mtail_conf = files.put(
|
|
||||||
name="Mtail configuration",
|
|
||||||
src=get_resource("mtail/delivered_mail.mtail"),
|
|
||||||
dest="/etc/mtail/delivered_mail.mtail",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
self.need_restart = mtail_conf.changed
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable mtail",
|
|
||||||
service="mtail.service",
|
|
||||||
running=bool(self.mtail_address),
|
|
||||||
enabled=bool(self.mtail_address),
|
|
||||||
restarted=self.need_restart,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
[Unit]
|
|
||||||
Description=mtail
|
|
||||||
|
|
||||||
[Service]
|
|
||||||
Type=simple
|
|
||||||
ExecStart=/bin/sh -c "journalctl -f -o short-iso -n 0 | /usr/local/bin/mtail --address={{ address }} --port={{ port }} --progs /etc/mtail --logtostderr --logs -"
|
|
||||||
Restart=on-failure
|
|
||||||
|
|
||||||
[Install]
|
|
||||||
WantedBy=multi-user.target
|
|
||||||
@@ -1,47 +1,47 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
<?xml version="1.0" encoding="UTF-8"?>
|
||||||
|
|
||||||
<clientConfig version="1.1">
|
<clientConfig version="1.1">
|
||||||
<emailProvider id="{{ config.mail_domain }}">
|
<emailProvider id="{{ config.domain_name }}">
|
||||||
<domain>{{ config.mail_domain }}</domain>
|
<domain>{{ config.domain_name }}</domain>
|
||||||
<displayName>{{ config.mail_domain }} chatmail</displayName>
|
<displayName>{{ config.domain_name }} chatmail</displayName>
|
||||||
<displayShortName>{{ config.mail_domain }}</displayShortName>
|
<displayShortName>{{ config.domain_name }}</displayShortName>
|
||||||
<incomingServer type="imap">
|
<incomingServer type="imap">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>993</port>
|
<port>993</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</incomingServer>
|
</incomingServer>
|
||||||
<incomingServer type="imap">
|
<incomingServer type="imap">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>143</port>
|
<port>143</port>
|
||||||
<socketType>STARTTLS</socketType>
|
<socketType>STARTTLS</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</incomingServer>
|
</incomingServer>
|
||||||
<incomingServer type="imap">
|
<incomingServer type="imap">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>443</port>
|
<port>443</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</incomingServer>
|
</incomingServer>
|
||||||
<outgoingServer type="smtp">
|
<outgoingServer type="smtp">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>465</port>
|
<port>465</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</outgoingServer>
|
</outgoingServer>
|
||||||
<outgoingServer type="smtp">
|
<outgoingServer type="smtp">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>587</port>
|
<port>587</port>
|
||||||
<socketType>STARTTLS</socketType>
|
<socketType>STARTTLS</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
<username>%EMAILADDRESS%</username>
|
<username>%EMAILADDRESS%</username>
|
||||||
</outgoingServer>
|
</outgoingServer>
|
||||||
<outgoingServer type="smtp">
|
<outgoingServer type="smtp">
|
||||||
<hostname>{{ config.mail_domain }}</hostname>
|
<hostname>{{ config.domain_name }}</hostname>
|
||||||
<port>443</port>
|
<port>443</port>
|
||||||
<socketType>SSL</socketType>
|
<socketType>SSL</socketType>
|
||||||
<authentication>password-cleartext</authentication>
|
<authentication>password-cleartext</authentication>
|
||||||
|
|||||||
@@ -1,117 +0,0 @@
|
|||||||
from chatmaild.config import Config
|
|
||||||
from pyinfra.operations import apt, files, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import (
|
|
||||||
Deployer,
|
|
||||||
get_resource,
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
class NginxDeployer(Deployer):
|
|
||||||
def __init__(self, config):
|
|
||||||
self.config = config
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
#
|
|
||||||
# If we allow nginx to start up on install, it will grab port
|
|
||||||
# 80, which then will block acmetool from listening on the port.
|
|
||||||
# That in turn prevents getting certificates, which then causes
|
|
||||||
# an error when we try to start nginx on the custom config
|
|
||||||
# that leaves port 80 open but also requires certificates to
|
|
||||||
# be present. To avoid getting into that interlocking mess,
|
|
||||||
# we use policy-rc.d to prevent nginx from starting up when it
|
|
||||||
# is installed.
|
|
||||||
#
|
|
||||||
# This approach allows us to avoid performing any explicit
|
|
||||||
# systemd operations during the install stage (as opposed to
|
|
||||||
# allowing it to start and then forcing it to stop), which allows
|
|
||||||
# the install stage to run in non-systemd environments like a
|
|
||||||
# container image build.
|
|
||||||
#
|
|
||||||
# For documentation about policy-rc.d, see:
|
|
||||||
# https://people.debian.org/~hmh/invokerc.d-policyrc.d-specification.txt
|
|
||||||
#
|
|
||||||
files.put(
|
|
||||||
src=get_resource("policy-rc.d"),
|
|
||||||
dest="/usr/sbin/policy-rc.d",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
|
|
||||||
apt.packages(
|
|
||||||
name="Install nginx",
|
|
||||||
packages=["nginx", "libnginx-mod-stream"],
|
|
||||||
)
|
|
||||||
|
|
||||||
files.file("/usr/sbin/policy-rc.d", present=False)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
self.need_restart = _configure_nginx(self.config)
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable nginx",
|
|
||||||
service="nginx.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
|
|
||||||
|
|
||||||
def _configure_nginx(config: Config, debug: bool = False) -> bool:
|
|
||||||
"""Configures nginx HTTP server."""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=get_resource("nginx/nginx.conf.j2"),
|
|
||||||
dest="/etc/nginx/nginx.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
disable_ipv6=config.disable_ipv6,
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
autoconfig = files.template(
|
|
||||||
src=get_resource("nginx/autoconfig.xml.j2"),
|
|
||||||
dest="/var/www/html/.well-known/autoconfig/mail/config-v1.1.xml",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
)
|
|
||||||
need_restart |= autoconfig.changed
|
|
||||||
|
|
||||||
mta_sts_config = files.template(
|
|
||||||
src=get_resource("nginx/mta-sts.txt.j2"),
|
|
||||||
dest="/var/www/html/.well-known/mta-sts.txt",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
)
|
|
||||||
need_restart |= mta_sts_config.changed
|
|
||||||
|
|
||||||
# install CGI newemail script
|
|
||||||
#
|
|
||||||
cgi_dir = "/usr/lib/cgi-bin"
|
|
||||||
files.directory(
|
|
||||||
name=f"Ensure {cgi_dir} exists",
|
|
||||||
path=cgi_dir,
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
)
|
|
||||||
|
|
||||||
files.put(
|
|
||||||
name="Upload cgi newemail.py script",
|
|
||||||
src=get_resource("newemail.py", pkg="chatmaild").open("rb"),
|
|
||||||
dest=f"{cgi_dir}/newemail.py",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="755",
|
|
||||||
)
|
|
||||||
|
|
||||||
return need_restart
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
version: STSv1
|
version: STSv1
|
||||||
mode: enforce
|
mode: enforce
|
||||||
mx: {{ config.mail_domain }}
|
mx: {{ config.domain_name }}
|
||||||
max_age: 2419200
|
max_age: 2419200
|
||||||
|
|||||||
@@ -2,25 +2,11 @@ load_module modules/ngx_stream_module.so;
|
|||||||
|
|
||||||
user www-data;
|
user www-data;
|
||||||
worker_processes auto;
|
worker_processes auto;
|
||||||
|
|
||||||
# Increase the number of connections
|
|
||||||
# that a worker process can open
|
|
||||||
# to avoid errors such as
|
|
||||||
# accept4() failed (24: Too many open files)
|
|
||||||
# and
|
|
||||||
# socket() failed (24: Too many open files) while connecting to upstream
|
|
||||||
# in the logs.
|
|
||||||
# <https://nginx.org/en/docs/ngx_core_module.html#worker_rlimit_nofile>
|
|
||||||
worker_rlimit_nofile 2048;
|
|
||||||
pid /run/nginx.pid;
|
pid /run/nginx.pid;
|
||||||
error_log syslog:server=unix:/dev/log,facility=local3;
|
error_log syslog:server=unix:/dev/log,facility=local3;
|
||||||
|
|
||||||
events {
|
events {
|
||||||
# Increase to avoid errors such as
|
worker_connections 768;
|
||||||
# 768 worker_connections are not enough while connecting to upstream
|
|
||||||
# in the logs.
|
|
||||||
# <https://nginx.org/en/docs/ngx_core_module.html#worker_connections>
|
|
||||||
worker_connections 2048;
|
|
||||||
# multi_accept on;
|
# multi_accept on;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -42,9 +28,6 @@ stream {
|
|||||||
}
|
}
|
||||||
|
|
||||||
http {
|
http {
|
||||||
{% if config.tls_cert_mode == "self" %}
|
|
||||||
limit_req_zone $binary_remote_addr zone=newaccount:10m rate=2r/s;
|
|
||||||
{% endif %}
|
|
||||||
sendfile on;
|
sendfile on;
|
||||||
tcp_nopush on;
|
tcp_nopush on;
|
||||||
|
|
||||||
@@ -56,20 +39,23 @@ http {
|
|||||||
|
|
||||||
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
|
||||||
ssl_prefer_server_ciphers on;
|
ssl_prefer_server_ciphers on;
|
||||||
ssl_certificate {{ config.tls_cert_path }};
|
ssl_certificate /var/lib/acme/live/{{ config.domain_name }}/fullchain;
|
||||||
ssl_certificate_key {{ config.tls_key_path }};
|
ssl_certificate_key /var/lib/acme/live/{{ config.domain_name }}/privkey;
|
||||||
|
|
||||||
gzip on;
|
gzip on;
|
||||||
|
|
||||||
server {
|
server {
|
||||||
|
|
||||||
listen 127.0.0.1:8443 ssl default_server;
|
listen 8443 ssl default_server;
|
||||||
|
{% if not disable_ipv6 %}
|
||||||
|
listen [::]:8443 ssl default_server;
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
root /var/www/html;
|
root /var/www/html;
|
||||||
|
|
||||||
index index.html index.htm;
|
index index.html index.htm;
|
||||||
|
|
||||||
server_name {{ config.mail_domain }} www.{{ config.mail_domain }} mta-sts.{{ config.mail_domain }};
|
server_name _;
|
||||||
|
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
access_log syslog:server=unix:/dev/log,facility=local7;
|
||||||
|
|
||||||
@@ -84,15 +70,11 @@ http {
|
|||||||
}
|
}
|
||||||
|
|
||||||
location /new {
|
location /new {
|
||||||
{% if config.tls_cert_mode != "self" %}
|
|
||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
# Redirect to Delta Chat,
|
# Redirect to Delta Chat,
|
||||||
# which will in turn do a POST request.
|
# which will in turn do a POST request.
|
||||||
return 301 dcaccount:https://{{ config.mail_domain }}/new;
|
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
||||||
}
|
}
|
||||||
{% else %}
|
|
||||||
limit_req zone=newaccount burst=5 nodelay;
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
include /etc/nginx/fastcgi_params;
|
include /etc/nginx/fastcgi_params;
|
||||||
@@ -106,64 +88,24 @@ http {
|
|||||||
#
|
#
|
||||||
# Redirects are only for browsers.
|
# Redirects are only for browsers.
|
||||||
location /cgi-bin/newemail.py {
|
location /cgi-bin/newemail.py {
|
||||||
{% if config.tls_cert_mode != "self" %}
|
|
||||||
if ($request_method = GET) {
|
if ($request_method = GET) {
|
||||||
return 301 dcaccount:https://{{ config.mail_domain }}/new;
|
return 301 dcaccount:https://{{ config.domain_name }}/new;
|
||||||
}
|
}
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
fastcgi_pass unix:/run/fcgiwrap.socket;
|
fastcgi_pass unix:/run/fcgiwrap.socket;
|
||||||
include /etc/nginx/fastcgi_params;
|
include /etc/nginx/fastcgi_params;
|
||||||
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
fastcgi_param SCRIPT_FILENAME /usr/lib/cgi-bin/newemail.py;
|
||||||
}
|
}
|
||||||
|
|
||||||
# Proxy to iroh-relay service.
|
|
||||||
location /relay {
|
|
||||||
proxy_pass http://127.0.0.1:3340;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
|
|
||||||
# Upgrade header is normally set to "iroh derp http" or "websocket".
|
|
||||||
proxy_set_header Upgrade $http_upgrade;
|
|
||||||
proxy_set_header Connection "upgrade";
|
|
||||||
}
|
|
||||||
|
|
||||||
location /relay/probe {
|
|
||||||
proxy_pass http://127.0.0.1:3340;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
}
|
|
||||||
|
|
||||||
location /generate_204 {
|
|
||||||
proxy_pass http://127.0.0.1:3340;
|
|
||||||
proxy_http_version 1.1;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# Redirect www. to non-www
|
# Redirect www. to non-www
|
||||||
server {
|
server {
|
||||||
listen 127.0.0.1:8443 ssl;
|
listen 8443 ssl;
|
||||||
server_name www.{{ config.mail_domain }};
|
{% if not disable_ipv6 %}
|
||||||
return 301 $scheme://{{ config.mail_domain }}$request_uri;
|
listen [::]:8443 ssl;
|
||||||
|
{% endif %}
|
||||||
|
server_name www.{{ config.domain_name }};
|
||||||
|
return 301 $scheme://{{ config.domain_name }}$request_uri;
|
||||||
access_log syslog:server=unix:/dev/log,facility=local7;
|
access_log syslog:server=unix:/dev/log,facility=local7;
|
||||||
}
|
}
|
||||||
|
|
||||||
server {
|
|
||||||
listen 80;
|
|
||||||
{% if not disable_ipv6 %}
|
|
||||||
listen [::]:80;
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if config.tls_cert_mode == "acme" %}
|
|
||||||
location /.well-known/acme-challenge/ {
|
|
||||||
proxy_pass http://acmetool;
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
return 301 https://$host$request_uri;
|
|
||||||
}
|
|
||||||
|
|
||||||
{% if config.tls_cert_mode == "acme" %}
|
|
||||||
upstream acmetool {
|
|
||||||
server 127.0.0.1:402;
|
|
||||||
}
|
|
||||||
{% endif %}
|
|
||||||
}
|
}
|
||||||
|
|||||||
BIN
cmdeploy/src/cmdeploy/obs-home-deltachat.gpg
Normal file
BIN
cmdeploy/src/cmdeploy/obs-home-deltachat.gpg
Normal file
Binary file not shown.
@@ -1,124 +0,0 @@
|
|||||||
"""
|
|
||||||
Installs OpenDKIM
|
|
||||||
"""
|
|
||||||
|
|
||||||
from pyinfra import host
|
|
||||||
from pyinfra.facts.files import File
|
|
||||||
from pyinfra.operations import apt, files, server, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import Deployer, get_resource
|
|
||||||
|
|
||||||
|
|
||||||
class OpendkimDeployer(Deployer):
|
|
||||||
required_users = [("opendkim", None, ["opendkim"])]
|
|
||||||
|
|
||||||
def __init__(self, mail_domain):
|
|
||||||
self.mail_domain = mail_domain
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
apt.packages(
|
|
||||||
name="apt install opendkim opendkim-tools",
|
|
||||||
packages=["opendkim", "opendkim-tools"],
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
domain = self.mail_domain
|
|
||||||
dkim_selector = "opendkim"
|
|
||||||
"""Configures OpenDKIM"""
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=get_resource("opendkim/opendkim.conf"),
|
|
||||||
dest="/etc/opendkim.conf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
screen_script = files.file(
|
|
||||||
path="/etc/opendkim/screen.lua",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
need_restart |= screen_script.changed
|
|
||||||
|
|
||||||
final_script = files.file(
|
|
||||||
path="/etc/opendkim/final.lua",
|
|
||||||
present=False,
|
|
||||||
)
|
|
||||||
need_restart |= final_script.changed
|
|
||||||
|
|
||||||
files.directory(
|
|
||||||
name="Add opendkim directory to /etc",
|
|
||||||
path="/etc/opendkim",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="750",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
keytable = files.template(
|
|
||||||
src=get_resource("opendkim/KeyTable"),
|
|
||||||
dest="/etc/dkimkeys/KeyTable",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
need_restart |= keytable.changed
|
|
||||||
|
|
||||||
signing_table = files.template(
|
|
||||||
src=get_resource("opendkim/SigningTable"),
|
|
||||||
dest="/etc/dkimkeys/SigningTable",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="644",
|
|
||||||
config={"domain_name": domain, "opendkim_selector": dkim_selector},
|
|
||||||
)
|
|
||||||
need_restart |= signing_table.changed
|
|
||||||
files.directory(
|
|
||||||
name="Add opendkim socket directory to /var/spool/postfix",
|
|
||||||
path="/var/spool/postfix/opendkim",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
mode="750",
|
|
||||||
present=True,
|
|
||||||
)
|
|
||||||
|
|
||||||
if not host.get_fact(File, f"/etc/dkimkeys/{dkim_selector}.private"):
|
|
||||||
server.shell(
|
|
||||||
name="Generate OpenDKIM domain keys",
|
|
||||||
commands=[
|
|
||||||
f"/usr/sbin/opendkim-genkey -D /etc/dkimkeys -d {domain} -s {dkim_selector}"
|
|
||||||
],
|
|
||||||
_use_su_login=True,
|
|
||||||
_su_user="opendkim",
|
|
||||||
)
|
|
||||||
|
|
||||||
service_file = files.put(
|
|
||||||
name="Configure opendkim to restart once a day",
|
|
||||||
src=get_resource("opendkim/systemd.conf"),
|
|
||||||
dest="/etc/systemd/system/opendkim.service.d/10-prevent-memory-leak.conf",
|
|
||||||
)
|
|
||||||
need_restart |= service_file.changed
|
|
||||||
|
|
||||||
files.file(
|
|
||||||
name="chown opendkim: /etc/dkimkeys/opendkim.private",
|
|
||||||
path="/etc/dkimkeys/opendkim.private",
|
|
||||||
user="opendkim",
|
|
||||||
group="opendkim",
|
|
||||||
)
|
|
||||||
|
|
||||||
self.need_restart = need_restart
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
systemd.service(
|
|
||||||
name="Start and enable OpenDKIM",
|
|
||||||
service="opendkim.service",
|
|
||||||
running=True,
|
|
||||||
enabled=True,
|
|
||||||
daemon_reload=self.need_restart,
|
|
||||||
restarted=self.need_restart,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
28
cmdeploy/src/cmdeploy/opendkim/final.lua
Normal file
28
cmdeploy/src/cmdeploy/opendkim/final.lua
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
if odkim.internal_ip(ctx) == 1 then
|
||||||
|
-- Outgoing message will be signed,
|
||||||
|
-- no need to look for signatures.
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
nsigs = odkim.get_sigcount(ctx)
|
||||||
|
if nsigs == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
for i = 1, nsigs do
|
||||||
|
sig = odkim.get_sighandle(ctx, i - 1)
|
||||||
|
sigres = odkim.sig_result(sig)
|
||||||
|
|
||||||
|
-- All signatures that do not correspond to From:
|
||||||
|
-- were ignored in screen.lua and return sigres -1.
|
||||||
|
--
|
||||||
|
-- Any valid signature that was not ignored like this
|
||||||
|
-- means the message is acceptable.
|
||||||
|
if sigres == 0 then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
odkim.set_reply(ctx, "554", "5.7.1", "No valid DKIM signature found")
|
||||||
|
odkim.set_result(ctx, SMFIS_REJECT)
|
||||||
|
return nil
|
||||||
@@ -13,7 +13,6 @@ OversignHeaders From
|
|||||||
On-BadSignature reject
|
On-BadSignature reject
|
||||||
On-KeyNotFound reject
|
On-KeyNotFound reject
|
||||||
On-NoSignature reject
|
On-NoSignature reject
|
||||||
DNSTimeout 60
|
|
||||||
|
|
||||||
# Signing domain, selector, and key (required). For example, perform signing
|
# Signing domain, selector, and key (required). For example, perform signing
|
||||||
# for domain "example.com" with selector "2020" (2020._domainkey.example.com),
|
# for domain "example.com" with selector "2020" (2020._domainkey.example.com),
|
||||||
@@ -45,6 +44,12 @@ SignHeaders *,+autocrypt,+content-type
|
|||||||
# Default is empty.
|
# Default is empty.
|
||||||
OversignHeaders from,reply-to,subject,date,to,cc,resent-date,resent-from,resent-sender,resent-to,resent-cc,in-reply-to,references,list-id,list-help,list-unsubscribe,list-subscribe,list-post,list-owner,list-archive,autocrypt
|
OversignHeaders from,reply-to,subject,date,to,cc,resent-date,resent-from,resent-sender,resent-to,resent-cc,in-reply-to,references,list-id,list-help,list-unsubscribe,list-subscribe,list-post,list-owner,list-archive,autocrypt
|
||||||
|
|
||||||
|
# Script to ignore signatures that do not correspond to the From: domain.
|
||||||
|
ScreenPolicyScript /etc/opendkim/screen.lua
|
||||||
|
|
||||||
|
# Script to reject mails without a valid DKIM signature.
|
||||||
|
FinalPolicyScript /etc/opendkim/final.lua
|
||||||
|
|
||||||
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
# In Debian, opendkim runs as user "opendkim". A umask of 007 is required when
|
||||||
# using a local socket with MTAs that access the socket as a non-privileged
|
# using a local socket with MTAs that access the socket as a non-privileged
|
||||||
# user (for example, Postfix). You may need to add user "postfix" to group
|
# user (for example, Postfix). You may need to add user "postfix" to group
|
||||||
@@ -59,9 +64,3 @@ PidFile /run/opendkim/opendkim.pid
|
|||||||
# The trust anchor enables DNSSEC. In Debian, the trust anchor file is provided
|
# The trust anchor enables DNSSEC. In Debian, the trust anchor file is provided
|
||||||
# by the package dns-root-data.
|
# by the package dns-root-data.
|
||||||
TrustAnchorFile /usr/share/dns/root.key
|
TrustAnchorFile /usr/share/dns/root.key
|
||||||
|
|
||||||
# Sign messages when `-o milter_macro_daemon_name=ORIGINATING` is set.
|
|
||||||
MTA ORIGINATING
|
|
||||||
|
|
||||||
# No hosts are treated as internal, ORIGINATING daemon name should be set explicitly.
|
|
||||||
InternalHosts -
|
|
||||||
|
|||||||
21
cmdeploy/src/cmdeploy/opendkim/screen.lua
Normal file
21
cmdeploy/src/cmdeploy/opendkim/screen.lua
Normal file
@@ -0,0 +1,21 @@
|
|||||||
|
-- Ignore signatures that do not correspond to the From: domain.
|
||||||
|
|
||||||
|
from_domain = odkim.get_fromdomain(ctx)
|
||||||
|
if from_domain == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
n = odkim.get_sigcount(ctx)
|
||||||
|
if n == nil then
|
||||||
|
return nil
|
||||||
|
end
|
||||||
|
|
||||||
|
for i = 1, n do
|
||||||
|
sig = odkim.get_sighandle(ctx, i - 1)
|
||||||
|
sig_domain = odkim.sig_getdomain(sig)
|
||||||
|
if from_domain ~= sig_domain then
|
||||||
|
odkim.sig_ignore(sig)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
return nil
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
[Service]
|
|
||||||
Restart=always
|
|
||||||
RuntimeMaxSec=1d
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
#!/bin/sh
|
|
||||||
echo "All runlevel operations denied by policy" >&2
|
|
||||||
exit 101
|
|
||||||
@@ -1,117 +0,0 @@
|
|||||||
from pyinfra.operations import apt, files, server, systemd
|
|
||||||
|
|
||||||
from cmdeploy.basedeploy import Deployer, get_resource
|
|
||||||
|
|
||||||
|
|
||||||
class PostfixDeployer(Deployer):
|
|
||||||
required_users = [("postfix", None, ["opendkim"])]
|
|
||||||
daemon_reload = False
|
|
||||||
|
|
||||||
def __init__(self, config, disable_mail):
|
|
||||||
self.config = config
|
|
||||||
self.disable_mail = disable_mail
|
|
||||||
|
|
||||||
def install(self):
|
|
||||||
apt.packages(
|
|
||||||
name="Install Postfix",
|
|
||||||
packages="postfix",
|
|
||||||
)
|
|
||||||
|
|
||||||
def configure(self):
|
|
||||||
config = self.config
|
|
||||||
need_restart = False
|
|
||||||
|
|
||||||
main_config = files.template(
|
|
||||||
src=get_resource("postfix/main.cf.j2"),
|
|
||||||
dest="/etc/postfix/main.cf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
config=config,
|
|
||||||
disable_ipv6=config.disable_ipv6,
|
|
||||||
)
|
|
||||||
need_restart |= main_config.changed
|
|
||||||
|
|
||||||
master_config = files.template(
|
|
||||||
src=get_resource("postfix/master.cf.j2"),
|
|
||||||
dest="/etc/postfix/master.cf",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
debug=False,
|
|
||||||
config=config,
|
|
||||||
)
|
|
||||||
need_restart |= master_config.changed
|
|
||||||
|
|
||||||
header_cleanup = files.put(
|
|
||||||
src=get_resource("postfix/submission_header_cleanup"),
|
|
||||||
dest="/etc/postfix/submission_header_cleanup",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= header_cleanup.changed
|
|
||||||
|
|
||||||
lmtp_header_cleanup = files.put(
|
|
||||||
src=get_resource("postfix/lmtp_header_cleanup"),
|
|
||||||
dest="/etc/postfix/lmtp_header_cleanup",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= lmtp_header_cleanup.changed
|
|
||||||
|
|
||||||
tls_policy_map = files.put(
|
|
||||||
name="Upload SMTP TLS Policy that accepts self-signed certificates for IP-only hosts",
|
|
||||||
src=get_resource("postfix/smtp_tls_policy_map"),
|
|
||||||
dest="/etc/postfix/smtp_tls_policy_map",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= tls_policy_map.changed
|
|
||||||
if tls_policy_map.changed:
|
|
||||||
server.shell(
|
|
||||||
commands=["postmap /etc/postfix/smtp_tls_policy_map"],
|
|
||||||
)
|
|
||||||
|
|
||||||
# Login map that 1:1 maps email address to login.
|
|
||||||
login_map = files.put(
|
|
||||||
src=get_resource("postfix/login_map"),
|
|
||||||
dest="/etc/postfix/login_map",
|
|
||||||
user="root",
|
|
||||||
group="root",
|
|
||||||
mode="644",
|
|
||||||
)
|
|
||||||
need_restart |= login_map.changed
|
|
||||||
|
|
||||||
restart_conf = files.put(
|
|
||||||
name="postfix: restart automatically on failure",
|
|
||||||
src=get_resource("service/10_restart.conf"),
|
|
||||||
dest="/etc/systemd/system/postfix@.service.d/10_restart.conf",
|
|
||||||
)
|
|
||||||
self.daemon_reload = restart_conf.changed
|
|
||||||
|
|
||||||
# Validate postfix configuration before restart
|
|
||||||
if need_restart:
|
|
||||||
server.shell(
|
|
||||||
name="Validate postfix configuration",
|
|
||||||
# Extract stderr and quit with error if non-zero
|
|
||||||
commands=["""bash -c 'w=$(postconf 2>&1 >/dev/null); [[ -z "$w" ]] || { echo "$w"; false; }'"""],
|
|
||||||
)
|
|
||||||
self.need_restart = need_restart
|
|
||||||
|
|
||||||
def activate(self):
|
|
||||||
restart = False if self.disable_mail else self.need_restart
|
|
||||||
|
|
||||||
systemd.service(
|
|
||||||
name="disable postfix for now"
|
|
||||||
if self.disable_mail
|
|
||||||
else "Start and enable Postfix",
|
|
||||||
service="postfix.service",
|
|
||||||
running=False if self.disable_mail else True,
|
|
||||||
enabled=False if self.disable_mail else True,
|
|
||||||
restarted=restart,
|
|
||||||
daemon_reload=self.daemon_reload,
|
|
||||||
)
|
|
||||||
self.need_restart = False
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
/^DKIM-Signature:/ IGNORE
|
|
||||||
/^Authentication-Results:/ IGNORE
|
|
||||||
/^Received:/ IGNORE
|
|
||||||
@@ -15,19 +15,15 @@ readme_directory = no
|
|||||||
compatibility_level = 3.6
|
compatibility_level = 3.6
|
||||||
|
|
||||||
# TLS parameters
|
# TLS parameters
|
||||||
smtpd_tls_cert_file={{ config.tls_cert_path }}
|
smtpd_tls_cert_file=/var/lib/acme/live/{{ config.mail_domain }}/fullchain
|
||||||
smtpd_tls_key_file={{ config.tls_key_path }}
|
smtpd_tls_key_file=/var/lib/acme/live/{{ config.mail_domain }}/privkey
|
||||||
smtpd_tls_security_level=may
|
smtpd_tls_security_level=may
|
||||||
|
|
||||||
smtp_tls_CApath=/etc/ssl/certs
|
smtp_tls_CApath=/etc/ssl/certs
|
||||||
smtp_tls_security_level={{ "verify" if config.tls_cert_mode == "acme" else "encrypt" }}
|
smtp_tls_security_level=may
|
||||||
# Send SNI extension when connecting to other servers.
|
|
||||||
# <https://www.postfix.org/postconf.5.html#smtp_tls_servername>
|
|
||||||
smtp_tls_servername = hostname
|
|
||||||
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
smtp_tls_session_cache_database = btree:${data_directory}/smtp_scache
|
||||||
smtp_tls_policy_maps = regexp:/etc/postfix/smtp_tls_policy_map
|
smtp_tls_policy_maps = socketmap:inet:127.0.0.1:8461:postfix
|
||||||
smtp_tls_protocols = >=TLSv1.2
|
smtpd_tls_protocols = >=TLSv1.2
|
||||||
smtp_tls_mandatory_protocols = >=TLSv1.2
|
|
||||||
|
|
||||||
# Disable anonymous cipher suites
|
# Disable anonymous cipher suites
|
||||||
# and known insecure algorithms.
|
# and known insecure algorithms.
|
||||||
@@ -64,20 +60,7 @@ alias_database = hash:/etc/aliases
|
|||||||
mydestination =
|
mydestination =
|
||||||
|
|
||||||
relayhost =
|
relayhost =
|
||||||
{% if disable_ipv6 %}
|
|
||||||
mynetworks = 127.0.0.0/8
|
|
||||||
{% else %}
|
|
||||||
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v4 %}
|
|
||||||
smtp_bind_address = {{ config.addr_v4 }}
|
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v6 %}
|
|
||||||
smtp_bind_address6 = {{ config.addr_v6 }}
|
|
||||||
{% endif %}
|
|
||||||
{% if config.addr_v4 or config.addr_v6 %}
|
|
||||||
smtp_bind_address_enforce = yes
|
|
||||||
{% endif %}
|
|
||||||
mailbox_size_limit = 0
|
mailbox_size_limit = 0
|
||||||
message_size_limit = {{config.max_message_size}}
|
message_size_limit = {{config.max_message_size}}
|
||||||
recipient_delimiter = +
|
recipient_delimiter = +
|
||||||
@@ -90,7 +73,6 @@ inet_protocols = all
|
|||||||
|
|
||||||
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
virtual_transport = lmtp:unix:private/dovecot-lmtp
|
||||||
virtual_mailbox_domains = {{ config.mail_domain }}
|
virtual_mailbox_domains = {{ config.mail_domain }}
|
||||||
lmtp_header_checks = regexp:/etc/postfix/lmtp_header_cleanup
|
|
||||||
|
|
||||||
mua_client_restrictions = permit_sasl_authenticated, reject
|
mua_client_restrictions = permit_sasl_authenticated, reject
|
||||||
mua_sender_restrictions = reject_sender_login_mismatch, permit_sasl_authenticated, reject
|
mua_sender_restrictions = reject_sender_login_mismatch, permit_sasl_authenticated, reject
|
||||||
|
|||||||
@@ -14,13 +14,10 @@ smtp inet n - y - - smtpd -v
|
|||||||
{%- else %}
|
{%- else %}
|
||||||
smtp inet n - y - - smtpd
|
smtp inet n - y - - smtpd
|
||||||
{%- endif %}
|
{%- endif %}
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
-o smtpd_tls_mandatory_protocols=>=TLSv1.2
|
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port_incoming }}
|
|
||||||
submission inet n - y - 5000 smtpd
|
submission inet n - y - 5000 smtpd
|
||||||
-o syslog_name=postfix/submission
|
-o syslog_name=postfix/submission
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
-o smtpd_tls_mandatory_protocols=>=TLSv1.3
|
|
||||||
-o smtpd_sasl_auth_enable=yes
|
-o smtpd_sasl_auth_enable=yes
|
||||||
-o smtpd_sasl_type=dovecot
|
-o smtpd_sasl_type=dovecot
|
||||||
-o smtpd_sasl_path=private/auth
|
-o smtpd_sasl_path=private/auth
|
||||||
@@ -31,13 +28,14 @@ submission inet n - y - 5000 smtpd
|
|||||||
-o smtpd_sender_restrictions=$mua_sender_restrictions
|
-o smtpd_sender_restrictions=$mua_sender_restrictions
|
||||||
-o smtpd_recipient_restrictions=
|
-o smtpd_recipient_restrictions=
|
||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
smtps inet n - y - 5000 smtpd
|
smtps inet n - y - 5000 smtpd
|
||||||
-o syslog_name=postfix/smtps
|
-o syslog_name=postfix/smtps
|
||||||
-o smtpd_tls_wrappermode=yes
|
-o smtpd_tls_wrappermode=yes
|
||||||
-o smtpd_tls_security_level=encrypt
|
-o smtpd_tls_security_level=encrypt
|
||||||
-o smtpd_tls_mandatory_protocols=>=TLSv1.3
|
|
||||||
-o smtpd_sasl_auth_enable=yes
|
-o smtpd_sasl_auth_enable=yes
|
||||||
-o smtpd_sasl_type=dovecot
|
-o smtpd_sasl_type=dovecot
|
||||||
-o smtpd_sasl_path=private/auth
|
-o smtpd_sasl_path=private/auth
|
||||||
@@ -48,7 +46,9 @@ smtps inet n - y - 5000 smtpd
|
|||||||
-o smtpd_recipient_restrictions=
|
-o smtpd_recipient_restrictions=
|
||||||
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
-o smtpd_relay_restrictions=permit_sasl_authenticated,reject
|
||||||
-o smtpd_client_connection_count_limit=1000
|
-o smtpd_client_connection_count_limit=1000
|
||||||
|
-o milter_macro_daemon_name=ORIGINATING
|
||||||
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
-o smtpd_proxy_filter=127.0.0.1:{{ config.filtermail_smtp_port }}
|
||||||
|
-o cleanup_service_name=authclean
|
||||||
#628 inet n - y - - qmqpd
|
#628 inet n - y - - qmqpd
|
||||||
pickup unix n - y 60 1 pickup
|
pickup unix n - y 60 1 pickup
|
||||||
cleanup unix n - y - 0 cleanup
|
cleanup unix n - y - 0 cleanup
|
||||||
@@ -76,27 +76,17 @@ anvil unix - - y - 1 anvil
|
|||||||
scache unix - - y - 1 scache
|
scache unix - - y - 1 scache
|
||||||
postlog unix-dgram n - n - 1 postlogd
|
postlog unix-dgram n - n - 1 postlogd
|
||||||
filter unix - n n - - lmtp
|
filter unix - n n - - lmtp
|
||||||
# Local SMTP server for reinjecting outgoing filtered mail.
|
# Local SMTP server for reinjecting filered mail.
|
||||||
127.0.0.1:{{ config.postfix_reinject_port }} inet n - n - 100 smtpd
|
localhost:{{ config.postfix_reinject_port }} inet n - n - 10 smtpd
|
||||||
-o syslog_name=postfix/reinject
|
-o syslog_name=postfix/reinject
|
||||||
-o milter_macro_daemon_name=ORIGINATING
|
|
||||||
-o smtpd_milters=unix:opendkim/opendkim.sock
|
-o smtpd_milters=unix:opendkim/opendkim.sock
|
||||||
-o cleanup_service_name=authclean
|
-o cleanup_service_name=authclean
|
||||||
|
|
||||||
# Local SMTP server for reinjecting incoming filtered mail
|
|
||||||
127.0.0.1:{{ config.postfix_reinject_port_incoming }} inet n - n - 100 smtpd
|
|
||||||
-o syslog_name=postfix/reinject_incoming
|
|
||||||
|
|
||||||
# Cleanup `Received` headers for authenticated mail
|
# Cleanup `Received` headers for authenticated mail
|
||||||
# to avoid leaking client IP.
|
# to avoid leaking client IP.
|
||||||
#
|
#
|
||||||
# We do not do this for received mails
|
# We do not do this for received mails
|
||||||
# as this will break DKIM signatures
|
# as this will break DKIM signatures
|
||||||
# if `Received` header is signed.
|
# if `Received` header is signed.
|
||||||
#
|
|
||||||
# This service also rewrites
|
|
||||||
# Subject with `[...]`
|
|
||||||
# to make sure the users
|
|
||||||
# cannot send unprotected Subject.
|
|
||||||
authclean unix n - - - 0 cleanup
|
authclean unix n - - - 0 cleanup
|
||||||
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
-o header_checks=regexp:/etc/postfix/submission_header_cleanup
|
||||||
|
|||||||
@@ -1,3 +0,0 @@
|
|||||||
/^\[[^]]+\]$/ encrypt
|
|
||||||
/^_/ encrypt
|
|
||||||
/^nauta\.cu$/ may
|
|
||||||
@@ -2,4 +2,3 @@
|
|||||||
/^X-Originating-IP:/ IGNORE
|
/^X-Originating-IP:/ IGNORE
|
||||||
/^X-Mailer:/ IGNORE
|
/^X-Mailer:/ IGNORE
|
||||||
/^User-Agent:/ IGNORE
|
/^User-Agent:/ IGNORE
|
||||||
/^Subject:/ REPLACE Subject: [...]
|
|
||||||
|
|||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user