Um öffentliche Anmeldungen auf einem selbst gehosteten Matrix-Homeserver mit Synapse zu deaktivieren, führen Sie die entsprechenden Einstellungen enable_registration: falseaus homeserver.yamlund starten Sie Synapse neu. Sollen eingeladene Personen selbst Konten erstellen können, lassen Sie die Registrierung aktiviert, verwenden Sie aber stattdessen Registrierungstoken. Beachten Sie die separate registration_shared_secretEinstellung: Jeder, der diese kennt, kann weiterhin Konten erstellen, einschließlich Serveradministratoren, selbst wenn die reguläre Registrierung deaktiviert ist.
Wählen Sie die richtige Registrierungsrichtlinie
Die richtige Einstellung hängt davon ab, wie neue Konten erstellt werden sollen:
- Privater Server, vom Administrator bereitgestellte Konten: Öffentliche Registrierung deaktivieren. Benutzer mit dem Synapse-
register_new_matrix_userBefehl oder einem anderen genehmigten administrativen Prozess erstellen.
- Server nur für Eingeladene, Benutzer registrieren sich über Element oder einen anderen Client: Registrierung aktivieren und Token anfordern. Jeder Person wird über einen privaten Kanal ein Token mit begrenzter Gültigkeit zugewiesen.
- Öffentlicher Server: Registrierungstoken, CAPTCHA oder verifizierte E-Mail-/Telefonnummern können automatisierten Missbrauch reduzieren, garantieren aber nicht, dass jedes Konto vertrauenswürdig ist.
Dieser Artikel behandelt Synapse, die am weitesten verbreitete selbstgehostete Matrix-Homeserver-Implementierung. Andere Homeserver-Software hat ihre eigene Konfiguration. Laut der aktuellen Konfigurationsdokumentation von Synapse ist die Registrierung standardmäßig deaktiviert, und Registrierungstoken funktionieren nur, wenn die Registrierung selbst aktiviert ist. Wenn Sie den Matrix Authentication Service (MAS) verwenden, konsultieren Sie dessen Dokumentation für die entsprechenden Registrierungseinstellungen. Die Admin-API für Registrierungstoken von Synapse ist deaktiviert, wenn die MAS-Integration aktiviert ist.
Öffentliche Registrierung auf Synapse deaktivieren
- Suchen Sie die aktive Konfigurationsdatei. Gängige Paketinstallationen verwenden `/usr/local /bin`
/etc/matrix-synapse/homeserver.yaml; Containerinstallationen binden die Datei oft unter `/usr/ local/bin` ein /data/homeserver.yaml. Verwenden Sie den für Ihren Dienst konfigurierten Pfad, anstatt von einem bestimmten Speicherort auszugehen.
- Sichern Sie die Datei und setzen Sie anschließend das Registrierungsflag. Fügen Sie in der YAML-Konfiguration der obersten Ebene die folgende Einstellung hinzu oder ändern Sie sie:
enable_registration: false
Existiert der Schlüssel bereits, bearbeiten Sie diesen Eintrag, anstatt ein Duplikat hinzuzufügen. YAML-Einrückungen und doppelte Schlüssel können zu Verwirrung führen. Belassen Sie die Einstellung daher auf oberster Ebene und erhalten Sie die bestehende Dateistruktur bei.
- Überprüfen Sie das gemeinsame Registrierungsgeheimnis. Synapse unterstützt das administrative Registrierungsskript. Die Installationsanleitung von
registration_shared_secretSynapse registration_shared_secret_pathwarnt davor, dass jemand mit diesem Geheimnis Standard- oder Administratorkonten erstellen kann, selbst wenn die öffentliche Registrierung deaktiviert ist. Bewahren Sie es geheim auf, beschränken Sie den Zugriff auf die zugehörige Datei und veröffentlichen Sie es nicht in einem öffentlichen Repository, einer Clientkonfiguration oder einer Nachricht an Eingeladene. Wenn Sie die Registrierung mit gemeinsamem Geheimnis nicht verwenden, entfernen Sie die Einstellung erst, nachdem Sie sichergestellt haben, dass keine Automatisierung davon abhängt. Alternativ können Sie Konten mithilfe eines anderen unterstützten Administrator-Workflows erstellen.
- Überprüfen und starten Sie Synapse neu. Verwenden Sie den Dienstmanager, die Container-Orchestrierung oder die Bereitstellungsmethode, die auf Ihrem Server ausgeführt wird. Für einen systemd-Dienst mit dem üblichen Namen
matrix-synapsekönnte ein Administrator beispielsweise Folgendes ausführen:
sudo systemctl restart matrix-synapse
sudo systemctl status matrix-synapse --no-pager
Der genaue Dienstname variiert je nach Paket- oder Containerbereitstellung. Überprüfen Sie die Protokolle, falls der Dienst nicht startet. Bearbeiten Sie die Konfigurationsdatei nicht wiederholt, ohne einen gemeldeten YAML- oder Konfigurationsfehler zu beheben.
Bestehende Konten und Raumzugänge werden durch die Deaktivierung der Registrierung nicht entfernt. Die Einstellung verhindert lediglich neue reguläre Registrierungen über den Client-Registrierungsprozess; sie dient nicht der Benutzerlöschung oder Serverdeaktivierung.
Anmeldungen nur mit Registrierungstoken zulassen
Verwenden Sie diese Option, wenn Eingeladene sich selbst anmelden sollen, aber keine offene Registrierungsseite gewünscht ist. homeserver.yamlKonfigurieren Sie dazu beide Einstellungen:
enable_registration: true
registration_requires_token: true
Starten Sie Synapse nach dem Speichern neu. Ein Token-Gate ist nicht dasselbe wie die Deaktivierung der Registrierung: Personen mit gültigen Tokens können Konten erstellen. Das Synapse-Konfigurationshandbuch empfiehlt Missbrauchsschutzmaßnahmen, wenn die Registrierung aktiviert ist. Wählen Sie eine Richtlinie, die Ihrer Zielgruppe und Ihren betrieblichen Kapazitäten entspricht.
Bei Synapse-Versionen, die die dokumentierte Admin-API für Registrierungstoken unterstützen, kann ein Administrator ein einmalig verwendbares Token erstellen. Das folgende Beispiel verwendet eine Platzhalter-URL und ein Platzhalter-Zugriffstoken. Führen Sie es nur in einer vertrauenswürdigen administrativen Umgebung aus, ersetzen Sie die Platzhalter-URL durch die öffentliche Basis-URL Ihres Homeservers und ein Administrator-Zugriffstoken und schützen Sie Shell-Verlauf und Protokolle.
curl -X POST "https://matrix.example.com/_synapse/admin/v1/registration_tokens/new" \
-H "Authorization: Bearer YOUR_SERVER_ADMIN_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
--data '{"uses_allowed":1}'
Die Antwort enthält das generierte Token. Teilen Sie diesen Wert vertraulich mit dem vorgesehenen Benutzer. Die Synapse-API unterstützt auch eine Ablaufzeit, gemessen in Millisekunden seit der Unix-Epoche. Verwenden Sie die offizielle API-Referenz, um die Ablaufzeit für Ihre Bereitstellung korrekt zu berechnen und festzulegen. Ein Token ohne Angabe eines Nutzungslimits oder Ablaufdatums ist standardmäßig unbegrenzt nutzbar und hat kein Ablaufdatum. Legen Sie daher Limits bewusst fest. Administratoren können Token über dieselbe API auflisten, aktualisieren oder löschen. Fügen Sie niemals ein tatsächliches Bearer-Token oder Registrierungstoken in eine öffentliche Meldung oder einen Artikel ein.
Die Tokenverwaltung ist versions- und bereitstellungsabhängig: Konsultieren Sie die Dokumentation der Admin-API, die zu Ihrer installierten Synapse-Version passt. Die aktuelle Dokumentation weist darauf hin, dass diese Synapse-API nicht verfügbar ist, wenn die MAS-Integration aktiviert ist; verwenden Sie in diesem Fall die MAS-Admin-API oder die CLI.
Häufige Konfigurationsfehler
- Falsche Datei geändert: Container lesen möglicherweise eine eingebundene Datei, während der Host über eine separate Kopie verfügt. Überprüfen Sie den Pfad, der vom laufenden Synapse-Prozess verwendet wird.
- Vergessen Sie den Neustart: Konfigurationsänderungen werden vom Dienst gelesen, daher beweist eine erfolgreiche Textbearbeitung allein nicht, dass die neue Richtlinie aktiv ist.
- Angenommen, die deaktivierte Registrierung blockiert jeden Weg: Ein konfiguriertes gemeinsames Geheimnis bleibt ein Pfad zur Kontoerstellung. Schützen oder entfernen Sie es je nachdem, ob die administrative Automatisierung es benötigt.
- Das Aktivieren von Tokens bei gleichzeitiger Deaktivierung der Registrierung
registration_requires_token führt nicht automatisch zur Aktivierung der Registrierung. Beide Flags müssen für den gewünschten Ablauf aktiviert sein.
- Angenommen, nur auf Einladung erhältliche Token verhindern jeglichen Missbrauch: Ein durchgesickerter, wiederverwendbarer Token kann von Unbefugten missbraucht werden. Beschränken Sie daher die Nutzung, legen Sie nach Möglichkeit ein Ablaufdatum fest und verteilen Sie die Token vertraulich.
Ergebnis überprüfen
Nach dem Neustart von Synapse öffnen Sie den Registrierungsprozess Ihres Homeservers in einem Matrix-Client mit einer abgemeldeten Sitzung. Bei einem geschlossenen Server sollte der Client keine erfolgreiche öffentliche Registrierung anbieten, während sich bestehende Benutzer weiterhin anmelden können. Bei tokenbasierter Registrierung testen Sie den Prozess zunächst ohne Token und prüfen Sie, ob ein Token angefordert wird. Verwenden Sie anschließend ein Testtoken in einem kontrollierten Testkonto und vergewissern Sie sich, dass die Registrierung erfolgreich ist. Falls das Ergebnis von Ihren Erwartungen abweicht, überprüfen Sie die Synapse-Protokolle und den Token-Status der Admin-API. Vermeiden Sie Tests mit dem echten Einladungstoken, falls dadurch dessen einzige zulässige Verwendung verbraucht würde.
Offizielle Referenzen