Prosody: Chatserver mit Anbindung zu G+, FB, Twitter und IRC

Mittlerweile gibt es eine unüberschaubare Anzahl an Chat-Programmen und Chat-Anbietern. Um den Konversationen der Freunde folgen zu können müssen auf dem heimischen PC mehrere Programme installiert und auf dem Smartphone soll für jeden Anbieter eine eigene App installiert werden. Warum nicht einfacher? Einen eigenen Server aufsetzen, welcher das genormte Protokoll XMPP spricht und mit Gateways zu den entsprechenden Diensten erweitert werden kann: Prosody.

Server

Mir bekannt sind nur zwei Opensource-Alternativen der XMPP-Server: ejabberd und prosody. Mit ejabberd hatte ich schon vor Jahren Kontakt, konnte mich aber nicht wirklich mit ihm anfreunden. Konfigurationsschwierigkeiten und die damals mangelnde Anzahl an Modulen für Erweiterungen führten dazu, meinen ejabberd damals wieder abzuschalten. Frischen Wind in die Reiher der XMPP-Server bringt der lange Zeit unbekannte Prosody (erste Version von 2008). Er hat sich auf die Fahne geschrieben, besonder leichtgewichtig, ressourcenschonend und dabei noch mit einer Fülle von Erweiterungen ausgestattet zu sein, die ihn zu einem vollwertigen Mitglied der XMPP-Server-Familie werden lassen sollen. Die Installation ist einfach, die aktuelle Version ist in Debian bereits in den Paketquellen enthalten:

apt install prosody

Die Installation unter anderen OS-Versionen wird im Prosody-Wiki erklärt. Die folgende Installationsanleitung wird sich an den mit der Debian-Version vorgegebenen Pfaden orientieren.

Für Prosody gibt es mittlerweile eine lange Liste von Modulen, welche durch die Community beigesteuert werden. Wer mag, kann diese ebenfalls einfach aus den Paketquellen installieren:

apt install prosody-modules

Ich wollte etwas mehr "am Puls der Zeit" bleiben, und habe statt der Module aus der Paketverwaltung die aktuellen Entwicklungsstände der Module ausgecheckt:

cd /usr/local/lib
hg clone https://hg.prosody.im/prosody-modules/ prosody-modules

Anschließend muss Prosody mitgeteilt werden, wo es die Module finden kann. In der globalen Konfigurationsdatei /etc/prosody/prosody.cfg.lua wird dazu Folgendes eingetragen:

plugin_paths = { "/usr/local/lib/prosody-modules" }

Grundkonfiguration

In der gleichen Datei ist nun die Jabber-ID (JID) des späteren Admin-Users festzulegen. Wenn gewünscht, kann hier auch gleich die Speicherengine von Prosody festgelegt werden. Mit den Standardeinstellungen wird Sqlite3 verwendet. Wer MySQL bzw. MariaDB benutzen mag, stellt hier gleich

storage = "sql"

ein und entfernt die Kommentarzeichen bei der entsprechenden Konfigurationseinstellung für MySQL. Die dort eingetragene Datenbank muss nun mit ensprechenden Tools manuell erstellt und dem angegebenen Benutzer Rechte zum Zugriff auf die Datenbank gegeben werden. Anschließend erstellt man den Admin-User:

prosodyctl adduser admin@example.org

Virtuelle Hosts

Prosody unterstützt mehrere virtuelle Hosts in einer einzigen laufenden Instanz, ähnlich einem Webserver, der mehrere verschiedene Domains in einer Instanz hosten kann. Die Konfiguration der virtuellen XMPP-Hosts erfolgt in einer Datei pro Host unter /etc/prosody/conf.avail. Zum Einschalten eines virtuellen Hosts wird ein symbolischer Link in /etc/prosody/conf.d auf die entsprechende Konfigurationsdatei in ../conf.avail angelegt (ähnlich wie bei den Webservern Apache oder Nginx).

Virtuelle Hosts könnnen dazu benutzt werden, Jabber-IDs auf der "Hauptdomain" zu erstellen. Es ist dadurch möglich, Jabber-IDs mit dem Aufbau mustermann@example.org zu unterstützen, obwohl der echte Server z.B. auf jabber.example.org läuft.

Die simpelste Konfiguration eines virtuellen Hosts besteht dabei aus nur einer einzigen Zeile:

VirtualHost "example.org"

Um nun den Jabber-Clients und -Servern mitzuteilen, unter welcher IP der "echte" Jabber-Server erreichbar ist, sind zwei DNS-Einträge erforderlich:

_xmpp-client._tcp.example.org. 300 IN	SRV	0 5 5222 jabber.example.org.
_xmpp-server._tcp.example.org. 300 IN	SRV	0 5 5269 jabber.example.org.

Einzelheiten, was die Werte in dieser Zeile bedeuten können der Dokumentation zu DNS-SRV-Records und der Server-Dokumentation entnommen werden.

Verschlüsselung

Um eine verschlüsselte Übertragung der Chat-Nachrichten zwischen Client und Server als auch zwischen Server und Server zu erzwingen, ist zuerst ein von den beteiligten Seiten akzeptiertes Zertifikat erforderlich. Wenn auf dem Server, auf dem Prosody installiert wird kein anderer HTTP(S)-Server läuft, kann das Zertifikat, falls man nicht schon ein entsprechendes besitzt, einfach von Let's Encrypt angefordert werden:

certbot certonly --standalone -d example.org

Das Zertifikat und der zugehörige private Schlüssel liegen anschließend unter /etc/letsencrypt/live/example.org. Benötigt werden die Dateien fullchain.pem und privkey.pem. Diese habe ich der Einfachheit halber nach /etc/prosody/certs/ kopiert. Eine Anpassung der Rechte, damit Prosody die Dateien direkt aus dem Let's Encrypt Verzeichnis lesen kann, steht noch auf meiner TODO-Liste.

Anschließend wird das Zertifikat in der Konfigurationsdatei des virtuellen Hosts eingetragen (/etc/prosody/conf.avail/jabber.example.org) und gleichzeitig festgelegt, dass nur verschlüsselte Kommunikation erlaubt ist:

c2s_require_encryption = true
s2s_require_encryption = true
s2s_secure_auth = true
 
ssl = {
        key = "/etc/prosody/certs/privkey.pem";
        certificate = "/etc/prosody/certs/fullchain.pem";
        }

Weitere Module

In der Konfigurationsdatei des jeweiligen virtuellen Hosts können einfach durch Hinzufügen des Modulnamens in den Abschnitt

modules_enabled = {
  ...
}

weitere Module aktiviert werden.

announce

ermöglicht dem Administrator, eine Nachricht an alle Online-Benutzer zu senden

blocking

Modul, mit dem Benutzer Blockierlisten verwalten können

carbons

Synchronisieren des Chatverlaufs zwischen unterschiedlichend Clients

privacy

erlaubt dem Benutzer, einen Status für bestimmte Benutzer vorzugeben

watchregistrations

Sendet Nachrichten bei der Registrierung neuer Benutzer an konfigurierte Adressen

welcome

erlaubt dem Administrator, eine Willkommensnachricht einzustellen

http

der HTTP(S)-Server von Prosody, von dem z.B. http_upload abhängt

http_upload

ermöglicht den Upload von Dateien

log_auth

protokolliert die Anmeldeversuche

Die Dokumentation vieler weiterer Module kann auf einer entsprechenden Webseite eingesehen werden.

Wenn man die öffentliche Registrierung freigeschaltet hat, so möchte man vielleicht über neu registrierte Benutzer informiert werden. Verantwortlich dafür ist nach der Aktivierung der öffentlichen Registrierungsmöglichkeit das Modul watchregistrations:

registration_watchers = { "admin@example.org" }
registration_notification = "User $username just registered on $host from $ip"
 
welcome_message = "Hello $username, welcome to the $host IM server!"
 
allow_registration = true;

Für das Hochladen von Dateien muss noch eine entsprechende Komponentenkonfiguration  und evtl. eine maximal hochladbare Dateigröße festlegt werden:

Component "upload.example.org" "http_upload"
http_upload_file_size_limit = 2097152

Problematisch ist hier, dass der Dateiupload offensichlich nicht die oben angelegten DNS-SRV-Record beachtet, sondern einen Server unter upload.example.org erwartet. Dieser kann nach meinen bisherigen Tests auch nicht als weiterer virtueller Host angelegt werden sondern benutzt das Zertifikat, welches in der Hauptkonfigurationsdatei von Prosody in /etc/prosody/prosody.cfg.lua festgelegt worden ist. Man braucht also für http_upload unbedingt noch ein Zertifikat für upload.example.org, welches in der Hauptkonfigurationsdatei eingetragen werden muss.

Hochgeladene Dateien werden unter /var/lib/prosody/http_upload gespeichert.

Transports

In Jabber bzw. XMPP definierte Gateways zu anderen Netzen werden Transports genannt. Mit diesen Transports ist es z.B. möglich, über einen XMPP-Client Twitter-Nachrichten zu lesen und zu posten, mit Freunden auf Facebook in Kontakt zu bleiben, Nachrichten mit Nutzern von Google (ehemals GoogleTalk, jetzt Google Hangouts) ausztauschen oder am ältesten Chat im Internet, dem IRC, teilzunehmen.

Damit Transports sich in prodody registrieren können, muss zuerst deren Name und ein Password festgelegt werden. In der Konfigurationdatei des jweiligen virtuellen Hosts sind dazu folgende Einträge notwendig:

Component "dienstname.example.org"
        component_secret = "sehrgeheim"

Um nun die verschiedenen Transport-Module anschließen zu können ist erst einmal eine Software nötig, welche sich um den Start und die Kommunikation der einzelnen Transportmodule kümmert. Für prosody kann dazu Spectrum2 verwendet werden. Die recht einfache Installation unter Debian Jessie ist in einer Anleitung beschrieben.

Sofern ein Transport zu Facebook benötigt wird, kann seit Mitte 2015 leider nicht mehr das eingebaute XMPP verwendet werden. Facebook hat das entsprechende Gateway abgeschaltet und sich damit quasi isoliert. Um trotzdem Zugriff auf den Facebook-Chat zu bekommen, ist die Installation eines weiteren Modul erforderlich: purple-facebook. Eine entsprechende Installationsanleitung findet sich auf der Webseite des Maintainers.

Für die verschiedenen Netzwerke stehen anschließend folgende Module zur Verfügung:

spectrum2_libpurple_backend

Transport zu Facebook (protocol=prpl-facebook)

spectrum2_twitter_backend

Transport zu Twitter

spectrum2_swiften_backend

Transport zu Google (protocol=prpl-jabber)

spectrum2_libcommuni_backend

Transport zu IRC

Die Konfigurationsdateien der einzelnen Transports in Spectrum2 sind unter /etc/spectrum2/transports zu finden. Dort wird für jeden einzelnen Transport eine eigene Datei erstellt, z.B. google.cfg oder facebook.cfg. Eine entsprechende Vorlage ist in spectrum.cfg.example enthalten. Die Schritte zur Konfiguration sind folgende:

• Kopieren von spectrum.cfg.example auf dienstname.cfg
• Anpassung von jid, password (gleiches Passwort, wie in der prosody-Konfiguration unter component festgelegt), backend und evtl. protocol (entsprechend der obigen Auflistung)
• Festlegung des Namens des Transports
• evtl. Anpassung der Datenbank im Abschnitt [database]
• Starten des Transports mit spectrum2_manager dienstname.example.org start

Eine Konfigurationdatei für Facebook (facebook.cfg) könnte z.B. wie folgt aussehen:

In prosody muss dazu vorher folgende Definition beim virtuellen Host eingetragen worden sein:

Component "facebook.example.org"
        component_secret = "ComponentenPasswort"

Transports und Server starten und stoppen

Die einzelnen Dienste oder auch der XMPP-Server selbst können mit folgenden Kommandos gestartet oder gestoppt werden:

• prosodyctl start
• prosodyctl stop
• prosodyctl restart
• spectrum2_manager dienstname.example.org start
• spectrum2_manager dienstname.example.org stop
• spectrum2_manager dienstname.example.org restart

Logdateien zur Fehlersuche für prodody werden in /var/log/prosody geschrieben, Logdateien für Spectrum2 unter /var/log/spectrum2/TransportName/spectrum2.log und Logdateien für die einzelnen Transports unter /var/log/spectrum2/TransportName/backend/*.log.