Das automx-Paket Die Einleitung Das automx-Paket ([1]https://automx.org/) stellt einen Webservice bereit, welcher vollautomatisch Provisionierungsanfragen ihrer E-Mail-Programme beantwortet. Anwender muessen nur ihren Namen, die E-Mail-Adresse und ihr Kennwort angeben, das E-Mail-Programm und automx erledigen den Rest. Aktuell werden die Provisionierungsstandards von Apple, Microsoft und Mozilla unterstuetzt. Die Funktionen Das automx-Paket besteht aus folgender Komponente: * automx - Der automx-Webservice. ([2]https://automx.org/) Die Voraussetzungen Zur Nutzung des Programms werden ein installiertes apache2-mod_wsgi- und diverse Python-Programmpakete benoetigt. Die Installation Das automx-Paket wird ueber das Setup-Menue installiert. Wird eine aeltere Paketversion vorgefunden, so wird diese deinstalliert bevor die neuen Programmdateien installiert werden. Das Menue im Setup-Programm Das Menue im Setup-Programm ist wie folgt aufgebaut: * View documentation: Anzeigen der Dokumentation * Edit configuration: Bearbeiten der Konfiguration * Check email account data: Pruefen von individuellen E-Mail-Daten * Check automx email configuration: Pruefen einer individuellen automx-Konfiguration * View log file: Die Logmeldungen anzeigen * Return: Untermenue verlassen Die Menuepunkte duerften selbsterklaerend sein, da sie keinerlei weitere Eingaben erwarten. Aus diesem Grund wird auf deren Funktion nicht weiter eingegangen. Die Aenderung der Konfiguration Die Konfiguration kann ueber den Menuepunkt 'Edit configuration' geaendert werden. Standardmaessig wird der Editor aufgerufen, der in der Environment-Konfiguration ueber die Variable 'EDITOR' festgelegt wurde. Nachdem der Editor beendet wurde wird abgefragt, ob die Konfiguration aktiviert werden soll. Wird dies bestaetigt, werden ueber ein Skript die Anpassungen umgehend wirksam gemacht. Die Konfigurationsdatei In der Konfigurationsdatei, die ueber das Menue zugaenglich ist, sind folgende Parameter vorhanden; wer sie von Hand editieren will findet sie unter /etc/config.d/automx. Die Parameter START_AUTOMX Fuer die Aktivierung des automx-Dienstes muss diese Variable lediglich auf den Wert `yes' gestellt werden. Die Einstellung 'no' deaktiviert den automx-Dienst. Gueltige Werte: yes, no Standardeinstellung: START_AUTOMX='no' AUTOMX_ORDER Ueber diesen Parameter wird eingestellt in welcher Reihenfolge die verschiedenen E-Mail-Services zur Konfiguration angeboten werden sollen. Gueltige Werte: imap-pop3-smtp, pop3-imap-smtp Standardeinstellung: AUTOMX_ORDER='imap-pop3-smtp' AUTOMX_ACCESS_CONTROL_IP (Optionaler Parameter) Ueber diesen Parameter legt man IP Adressen und/oder IP Netzwerke fest von bzw. aus denen ein Zugriff auf diesen Dienst zugelassen werden soll. Wird dieser Parameter nicht gesetzt, so werden standardmaessig die ueber die base-Konfiguration festgelegten Netzwerke (IP_ETH_x_NETWORK und IP_ETH_x_NETMASK) fuer den Zugriff freigeschaltet. Gueltige Werte: Eine oder mehrere IP Adressen oder IP Netzwerke Beispiel: AUTOMX_ACCESS_CONTROL_IP='192.168.0.0/24' AUTOMX_CERT_NAME Ueber diesen Parameter legt man das Serverzertifikat des automx-Dienstes fest, welcher E-Mail-Konfigurationsprofile bereitstellt. Gueltige Werte: Serverzertifikat Beispiel: AUTOMX_CERT_NAME='autoconfig.local.lan' AUTOMX_DOCUMENT_ROOT (Optionaler Parameter) Ueber diesen Parameter kann ein vom Standard abweichendes Dokumentenstammverzeichnis festgelegt werden. Wird dieser Parameter nicht gesetzt, so wird der folgende Verzeichnispfad verwendet: /var/www/htdocs/automx . Gueltige Werte: absolute Pfadangabe Beispiel: AUTOMX_DOCUMENT_ROOT='/srv/www/automx' AUTOMX_APACHE2_PREFIX (Optionaler Parameter) Ueber diesen Parameter kann auf Wunsch ein Dateinamensprefix fuer die Apache2-Konfigurationsdatei festgelegt werden, um so die Ladereihenfolge der virtuellen Hostkonfigurationen zu beeinflussen. Gueltige Werte: Text, bestehend aus den Zeichen a-z, 0-9, -, _, . Standardeinstellung: AUTOMX_APACHE2_PREFIX='' mathend000# AUTOMX_CALDAV_CARDDAV_SERVER (Optionaler Parameter) Ueber diesen Parameter legt man den zu verwendenden CalDAV/CardDAV-Server fest. Gueltige Werte: Nextcloud oder ownCloud Beispiel: AUTOMX_CALDAV_CARDDAV_SERVER='nextcloud' AUTOMX_CALDAV_ENABLED Ueber diesen kann auf Wunsch die Unterstuetzung fuer eine automatische CalDAV-Konfiguration aktiviert werden. Gueltige Werte: yes, no Standardeinstellung: AUTOMX_CALDAV_ENABLED='no' AUTOMX_CALDAV_URL Ueber diesen Parameter legt man die URL des CalDAV-Servers fest. Gueltige Werte: Server URL Beispiel: AUTOMX_CALDAV_URL='https://example.local.lan/' AUTOMX_CARDDAV_ENABLED Ueber diesen kann auf Wunsch die Unterstuetzung fuer eine automatische CardDAV-Konfiguration aktiviert werden. Gueltige Werte: yes, no Standardeinstellung: AUTOMX_CARDDAV_ENABLED='no' AUTOMX_CARDDAV_URL Ueber diesen Parameter legt man die URL des CardDAV-Servers fest. Gueltige Werte: Server URL Beispiel: AUTOMX_CARDDAV_URL='https://example.local.lan/' AUTOMX_LOG_COUNT Ueber diesen Parameter wird eingestellt, wie viele Logdateien vorgehalten werden sollen. Wird dieser Wert ueberschritten, so wird die aelteste Logdatei geloescht. Gueltige Werte: Zahl Standardeinstellung: AUTOMX_LOG_COUNT='10' AUTOMX_LOG_INTERVAL Ueber diesen Parameter wird eingestellt, in welchen Intervallen die Logdateien archiviert werden sollen. Zur Auswahl stehen die Schluesselwoerter `daily' - taeglich, `weekly' - woechentlich und `monthly - monatlich. Gueltige Werte: daily, weekly, monthly Standardeinstellung: AUTOMX_LOG_INTERVAL='weekly' Verschiedenes Um den automx-Webservice nutzen zu koennen, muessen sowohl virtuelle Webhosts, als auch zugehoerige DNS-Eintraege fuer die eigene Domain gesetzt werden. Die DNS-Konfiguration Im eigene DNS-Server sind Eintraege anzulegen ueber welche standardmaessig der Abruf der Konfiguration erfolgt. Fuer eine Domain `local.lan' wuerden die benoetigten Eintraege wie folgt lauten: autoconfig.local.lan A 192.168.6.11 autodiscover.local.lan CNAME autoconfig.local.lan dav.local.lan CNAME autoconfig.local.lan Hinweis Der Eintrag 'dav.local.lan' kann entfallen, wenn keine automatische CalDAV-/CardDAV-Konfiguration erfolgen soll Die folgenden DNS SRV-Eintraege sollten eingerichtet werden, um Programmen eine automatische Konfiguration zu erleichtern. Die genau Funktionsweise wird in RFC 2782 und auch RFC 6186 beschrieben. _autodiscover._tcp 86400 IN SRV 0 0 443 autodiscover.local.lan. _submission._tcp 86400 IN SRV 0 1 587 mail.local.lan. _imaps._tcp 86400 IN SRV 1 1 993 imap.local.lan. _imap._tcp 86400 IN SRV 2 1 143 imap.local.lan. _pop3s._tcp 86400 IN SRV 3 1 995 pop3.local.lan. _pop3._tcp 86400 IN SRV 4 1 110 pop3.local.lan. _caldavs._tcp 86400 IN SRV 0 1 443 dav.local.lan. _caldav._tcp 86400 IN SRV 1 1 80 dav.local.lan. _carddavs._tcp 86400 IN SRV 0 1 443 dav.local.lan. _carddav._tcp 86400 IN SRV 1 1 80 dav.local.lan. Hinweis Die Eintraege '_caldavs._tcp', '_caldav._tcp', '_carddavs._tcp' und '_carddav._tcp' koennen entfallen, wenn keine automatische CalDAV-/CardDAV-Konfiguration erfolgen soll Die Zertifikate Da E-Mail-Programme auf die Webservices ueblicherweise mittels https zugreifen ist ein entsprechendes Serverzertifikat zu erzeugen, welches auf die zuvor genannten Domainnamen ausgestellt wurde. Fuer eine Domain `local.lan' muesste das Zertifikat auf folgende Domains ausgestellt werden: autoconfig.local.lan autodiscover.local.lan dav.local.lan Hinweis Im certs-Paket muss man dazu im Common name-Feld "DNS:autoconfig.local.lan,DNS:autodiscover.local.lan" eingeben. ACHTUNG Bei Verwendung von selbst signierten Zertifikaten ist unbedingt sicher zu stellen, dass das eigene CA-Zertifikat in den Zertifikatsspeicher des E-Mail-Programms importiert wurde um eine fehlerfrei Pruefung des angebotenen Zertifikats zu ermoeglichen. Die Apache2-Konfiguration Um die korrekte Konfiguration der virtuellen Hosts sicher zu stellen, prueft man mittels eines Webbrowsers den https-Zugriff. Nur wenn keine Fehlermeldung angezeigt wird, sollte man davon ausgehen koennen, dass das korrekte Zertifikat verwendet wird. ACHTUNG Bei Verwendung von selbst signierten Zertifikaten ist unbedingt sicher zu stellen, dass das eigene CA-Zertifikat in den Zertifikatsspeicher des E-Mail-Programms importiert wurde um eine fehlerfrei Pruefung des angebotenen Zertifikats zu ermoeglichen. Der Test mittels eines Webbrowsers Um mittels eines Webbrowser die korrekte Programmfunktion zu testen, gibt man folgende URL, gefolgt von einer E-Mail-Adresse welche im lokalen mail-Paket eingerichtet wurde, ein: [3]https://autoconfig.cwlocal.lan/mail/config-v1.1.xml?emailaddr ess=john.doe@local.lan __________________________________________________________________ Juergen Edner 2018-03-18 References 1. https://automx.org/ 2. https://automx.org/ 3. https://autoconfig.cwlocal.lan/mail/config-v1.1.xml?emailaddress=john.doe@local.lan